mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #18065 from owncloud/new-trashbin-retention 

New trashbin retention
This commit is contained in:
Thomas Müller 2015-08-12 13:13:45 +02:00
parent abd3d5c6a5 b9f655d8ad
commit 326de6f9b4
7 changed files with 427 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
apps/files_trashbin/appinfo/application.php
View File

@ -1,6 +1,7 @@
<?php
/**
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
@ -22,16 +23,26 @@
namespace OCA\Files_Trashbin\AppInfo;
use OCP\AppFramework\App;
use OCA\Files_Trashbin\Expiration;
class Application extends App {
public function __construct(array $urlParams = array()) {
public function __construct (array $urlParams = []) {
parent::__construct('files_trashbin', $urlParams);
$container = $this->getContainer();
/*
* Register capabilities
*/
$container->registerCapability('OCA\Files_Trashbin\Capabilities');
/*
* Register expiration
*/
$container->registerService('Expiration', function($c) {
return new Expiration(
$c->query('ServerContainer')->getConfig(),
$c->query('OCP\AppFramework\Utility\ITimeFactory')
);
});
}
}

21
apps/files_trashbin/appinfo/update.php
View File

@ -20,10 +20,29 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
$installedVersion=OCP\Config::getAppValue('files_trashbin', 'installed_version');
$config = \OC::$server->getConfig();
$installedVersion = $config->getAppValue('files_trashbin', 'installed_version');
if (version_compare($installedVersion, '0.6', '<')) {
//size of the trash bin could be incorrect, remove it for all users to
//enforce a recalculation during next usage.
\OC_DB::dropTable('files_trashsize');
}
if (version_compare($installedVersion, '0.6.4', '<')) {
$isExpirationEnabled = $config->getSystemValue('trashbin_auto_expire', true);
$oldObligation = $config->getSystemValue('trashbin_retention_obligation', null);
$newObligation = 'auto';
if ($isExpirationEnabled) {
if (!is_null($oldObligation)) {
$newObligation = strval($oldObligation) . ', auto';
}
} else {
$newObligation = 'disabled';
}
$config->setSystemValue('trashbin_retention_obligation', $newObligation);
$config->deleteSystemValue('trashbin_auto_expire');
}

152
apps/files_trashbin/lib/expiration.php Normal file
View File

@ -0,0 +1,152 @@
<?php
/**
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCA\Files_Trashbin;
use \OCP\IConfig;
use \OCP\AppFramework\Utility\ITimeFactory;
class Expiration {
// how long do we keep files in the trash bin if no other value is defined in the config file (unit: days)
const DEFAULT_RETENTION_OBLIGATION = 30;
const NO_OBLIGATION = -1;
/** @var ITimeFactory */
private $timeFactory;
/** @var string */
private $retentionObligation;
/** @var int */
private $minAge;
/** @var int */
private $maxAge;
/** @var bool */
private $canPurgeToSaveSpace;
public function __construct(IConfig $config,ITimeFactory $timeFactory){
$this->timeFactory = $timeFactory;
$this->retentionObligation = $config->getSystemValue('trashbin_retention_obligation', 'auto');
if ($this->retentionObligation !== 'disabled') {
$this->parseRetentionObligation();
}
}
/**
* Is trashbin expiration enabled
* @return bool
*/
public function isEnabled(){
return $this->retentionObligation !== 'disabled';
}
/**
* Check if given timestamp in expiration range
* @param int $timestamp
* @param bool $quotaExceeded
* @return bool
*/
public function isExpired($timestamp, $quotaExceeded = false){
// No expiration if disabled
if (!$this->isEnabled()) {
return false;
}
// Purge to save space (if allowed)
if ($quotaExceeded && $this->canPurgeToSaveSpace) {
return true;
}
$time = $this->timeFactory->getTime();
// Never expire dates in future e.g. misconfiguration or negative time
// adjustment
if ($time<$timestamp) {
return false;
}
// Purge as too old
if ($this->maxAge !== self::NO_OBLIGATION) {
$maxTimestamp = $time - ($this->maxAge * 86400);
$isOlderThanMax = $timestamp < $maxTimestamp;
} else {
$isOlderThanMax = false;
}
if ($this->minAge !== self::NO_OBLIGATION) {
// older than Min obligation and we are running out of quota?
$minTimestamp = $time - ($this->minAge * 86400);
$isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded;
} else {
$isMinReached = false;
}
return $isOlderThanMax || $isMinReached;
}
private function parseRetentionObligation(){
$splitValues = explode(',', $this->retentionObligation);
if (!isset($splitValues[0])) {
$minValue = self::DEFAULT_RETENTION_OBLIGATION;
} else {
$minValue = trim($splitValues[0]);
}
if (!isset($splitValues[1]) && $minValue === 'auto') {
$maxValue = 'auto';
} elseif (!isset($splitValues[1])) {
$maxValue = self::DEFAULT_RETENTION_OBLIGATION;
} else {
$maxValue = trim($splitValues[1]);
}
if ($minValue === 'auto' && $maxValue === 'auto') {
// Default: Keep for 30 days but delete anytime if space needed
$this->minAge = self::DEFAULT_RETENTION_OBLIGATION;
$this->maxAge = self::NO_OBLIGATION;
$this->canPurgeToSaveSpace = true;
} elseif ($minValue !== 'auto' && $maxValue === 'auto') {
// Keep for X days but delete anytime if space needed
$this->minAge = intval($minValue);
$this->maxAge = self::NO_OBLIGATION;
$this->canPurgeToSaveSpace = true;
} elseif ($minValue === 'auto' && $maxValue !== 'auto') {
// Delete anytime if space needed, Delete all older than max automatically
$this->minAge = self::NO_OBLIGATION;
$this->maxAge = intval($maxValue);
$this->canPurgeToSaveSpace = true;
} elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
// Delete all older than max OR older than min if space needed
// Max < Min as per https://github.com/owncloud/core/issues/16300
if ($maxValue < $minValue) {
$maxValue = $minValue;
}
$this->minAge = intval($minValue);
$this->maxAge = intval($maxValue);
$this->canPurgeToSaveSpace = false;
}
}
}

31
apps/files_trashbin/lib/trashbin.php
View File

@ -38,12 +38,10 @@ namespace OCA\Files_Trashbin;
use OC\Files\Filesystem;
use OC\Files\View;
use OCA\Files_Trashbin\AppInfo\Application;
use OCA\Files_Trashbin\Command\Expire;
class Trashbin {
// how long do we keep files in the trash bin if no other value is defined in the config file (unit: days)
const DEFAULT_RETENTION_OBLIGATION = 30;
// unit: percentage; 50% of available disk space/quota
const DEFAULTMAXSIZE = 50;
@ -631,14 +629,10 @@ class Trashbin {
$availableSpace = self::calculateFreeSpace($trashBinSize, $user);
$size = 0;
$retention_obligation = \OC_Config::getValue('trashbin_retention_obligation', self::DEFAULT_RETENTION_OBLIGATION);
$limit = time() - ($retention_obligation * 86400);
$dirContent = Helper::getTrashFiles('/', $user, 'mtime');
// delete all files older then $retention_obligation
list($delSize, $count) = self::deleteExpiredFiles($dirContent, $user, $limit, $retention_obligation);
list($delSize, $count) = self::deleteExpiredFiles($dirContent, $user);
$size += $delSize;
$availableSpace += $size;
@ -652,12 +646,12 @@ class Trashbin {
*/
private static function scheduleExpire($trashBinSize, $user) {
// let the admin disable auto expire
$autoExpire = \OC_Config::getValue('trashbin_auto_expire', true);
if ($autoExpire === false) {
return;
}
$application = new Application();
$expiration = $application->getContainer()->query('Expiration');
if ($expiration->isEnabled()) {
\OC::$server->getCommandBus()->push(new Expire($user, $trashBinSize));
}
}
/**
* if the size limit for the trash bin is reached, we delete the oldest
@ -669,11 +663,13 @@ class Trashbin {
* @return int size of deleted files
*/
protected static function deleteFiles($files, $user, $availableSpace) {
$application = new Application();
$expiration = $application->getContainer()->query('Expiration');
$size = 0;
if ($availableSpace < 0) {
foreach ($files as $file) {
if ($availableSpace < 0) {
if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) {
$tmp = self::delete($file['name'], $user, $file['mtime']);
\OCP\Util::writeLog('files_trashbin', 'remove "' . $file['name'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO);
$availableSpace += $tmp;
@ -691,20 +687,19 @@ class Trashbin {
*
* @param array $files list of files sorted by mtime
* @param string $user
* @param int $limit files older then limit should be deleted
* @param int $retention_obligation max age of file in days
* @return array size of deleted files and number of deleted files
*/
protected static function deleteExpiredFiles($files, $user, $limit, $retention_obligation) {
protected static function deleteExpiredFiles($files, $user) {
$application = new Application();
$expiration = $application->getContainer()->query('Expiration');
$size = 0;
$count = 0;
foreach ($files as $file) {
$timestamp = $file['mtime'];
$filename = $file['name'];
if ($timestamp <= $limit) {
if ($expiration->isExpired($timestamp)) {
$count++;
$size += self::delete($filename, $user, $timestamp);
\OCP\Util::writeLog('files_trashbin', 'remove "' . $filename . '" from trash bin because it is older than ' . $retention_obligation, \OCP\Util::INFO);
} else {
break;
}

200
apps/files_trashbin/tests/expiration.php Normal file
View File

@ -0,0 +1,200 @@
<?php
/**
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
use \OCA\Files_Trashbin\Expiration;
class Expiration_Test extends \PHPUnit_Framework_TestCase {
const SECONDS_PER_DAY = 86400; //60*60*24
public function expirationData(){
$today = 100*self::SECONDS_PER_DAY;
$back10Days = (100-10)*self::SECONDS_PER_DAY;
$back20Days = (100-20)*self::SECONDS_PER_DAY;
$back30Days = (100-30)*self::SECONDS_PER_DAY;
$back35Days = (100-35)*self::SECONDS_PER_DAY;
// it should never happen, but who knows :/
$ahead100Days = (100+100)*self::SECONDS_PER_DAY;
return [
// Expiration is disabled - always should return false
[ 'disabled', $today, $back10Days, false, false],
[ 'disabled', $today, $back10Days, true, false],
[ 'disabled', $today, $ahead100Days, true, false],
// Default: expire in 30 days or earlier when quota requirements are met
[ 'auto', $today, $back10Days, false, false],
[ 'auto', $today, $back35Days, false, false],
[ 'auto', $today, $back10Days, true, true],
[ 'auto', $today, $back35Days, true, true],
[ 'auto', $today, $ahead100Days, true, true],
// The same with 'auto'
[ 'auto, auto', $today, $back10Days, false, false],
[ 'auto, auto', $today, $back35Days, false, false],
[ 'auto, auto', $today, $back10Days, true, true],
[ 'auto, auto', $today, $back35Days, true, true],
// Keep for 15 days but expire anytime if space needed
[ '15, auto', $today, $back10Days, false, false],
[ '15, auto', $today, $back20Days, false, false],
[ '15, auto', $today, $back10Days, true, true],
[ '15, auto', $today, $back20Days, true, true],
[ '15, auto', $today, $ahead100Days, true, true],
// Expire anytime if space needed, Expire all older than max
[ 'auto, 15', $today, $back10Days, false, false],
[ 'auto, 15', $today, $back20Days, false, true],
[ 'auto, 15', $today, $back10Days, true, true],
[ 'auto, 15', $today, $back20Days, true, true],
[ 'auto, 15', $today, $ahead100Days, true, true],
// Expire all older than max OR older than min if space needed
[ '15, 25', $today, $back10Days, false, false],
[ '15, 25', $today, $back20Days, false, false],
[ '15, 25', $today, $back30Days, false, true],
[ '15, 25', $today, $back10Days, false, false],
[ '15, 25', $today, $back20Days, true, true],
[ '15, 25', $today, $back30Days, true, true],
[ '15, 25', $today, $ahead100Days, true, false],
// Expire all older than max OR older than min if space needed
// Max<Min case
[ '25, 15', $today, $back10Days, false, false],
[ '25, 15', $today, $back20Days, false, false],
[ '25, 15', $today, $back30Days, false, true],
[ '25, 15', $today, $back10Days, false, false],
[ '25, 15', $today, $back20Days, true, false],
[ '25, 15', $today, $back30Days, true, true],
[ '25, 15', $today, $ahead100Days, true, false],
];
}
/**
* @dataProvider expirationData
*
* @param string $retentionObligation
* @param int $timeNow
* @param int $timestamp
* @param bool $quotaExceeded
* @param string $expectedResult
*/
public function testExpiration($retentionObligation, $timeNow, $timestamp, $quotaExceeded, $expectedResult){
$mockedConfig = $this->getMockedConfig($retentionObligation);
$mockedTimeFactory = $this->getMockedTimeFactory($timeNow);
$expiration = new Expiration($mockedConfig, $mockedTimeFactory);
$actualResult = $expiration->isExpired($timestamp, $quotaExceeded);
$this->assertEquals($expectedResult, $actualResult);
}
public function configData(){
return [
[ 'disabled', null, null, null],
[ 'auto', Expiration::DEFAULT_RETENTION_OBLIGATION, Expiration::NO_OBLIGATION, true ],
[ 'auto,auto', Expiration::DEFAULT_RETENTION_OBLIGATION, Expiration::NO_OBLIGATION, true ],
[ 'auto, auto', Expiration::DEFAULT_RETENTION_OBLIGATION, Expiration::NO_OBLIGATION, true ],
[ 'auto, 3', Expiration::NO_OBLIGATION, 3, true ],
[ '5, auto', 5, Expiration::NO_OBLIGATION, true ],
[ '3, 5', 3, 5, false ],
[ '10, 3', 10, 10, false ],
];
}
/**
* @dataProvider configData
*
* @param string $configValue
* @param int $expectedMinAge
* @param int $expectedMaxAge
* @param bool $expectedCanPurgeToSaveSpace
*/
public function testParseRetentionObligation($configValue, $expectedMinAge, $expectedMaxAge, $expectedCanPurgeToSaveSpace){
$mockedConfig = $this->getMockedConfig($configValue);
$mockedTimeFactory = $this->getMockedTimeFactory(
time()
);
$expiration = new Expiration($mockedConfig, $mockedTimeFactory);
$this->assertAttributeEquals($expectedMinAge, 'minAge', $expiration);
$this->assertAttributeEquals($expectedMaxAge, 'maxAge', $expiration);
$this->assertAttributeEquals($expectedCanPurgeToSaveSpace, 'canPurgeToSaveSpace', $expiration);
}
/**
*
* @param int $time
* @return \OCP\AppFramework\Utility\ITimeFactory
*/
private function getMockedTimeFactory($time){
$mockedTimeFactory = $this->getMockBuilder('\OCP\AppFramework\Utility\ITimeFactory')
->disableOriginalConstructor()
->setMethods(['getTime'])
->getMock()
;
$mockedTimeFactory->expects($this->any())->method('getTime')->will(
$this->returnValue($time)
);
return $mockedTimeFactory;
}
/**
*
* @param string $returnValue
* @return \OCP\IConfig
*/
private function getMockedConfig($returnValue){
$mockedConfig = $this->getMockBuilder('\OCP\IConfig')
->disableOriginalConstructor()
->setMethods(
[
'setSystemValues',
'setSystemValue',
'getSystemValue',
'deleteSystemValue',
'getAppKeys',
'setAppValue',
'getAppValue',
'deleteAppValue',
'deleteAppValues',
'setUserValue',
'getUserValue',
'getUserValueForUsers',
'getUserKeys',
'deleteUserValue',
'deleteAllUserValues',
'deleteAppFromAllUsers',
'getUsersForUserValue'
]
)
->getMock()
;
$mockedConfig->expects($this->any())->method('getSystemValue')->will(
$this->returnValue($returnValue)
);
return $mockedConfig;
}
}

15
apps/files_trashbin/tests/trashbin.php
View File

@ -38,7 +38,6 @@ class Test_Trashbin extends \Test\TestCase {
private $trashRoot2;
private static $rememberRetentionObligation;
private static $rememberAutoExpire;
/**
* @var bool
@ -71,11 +70,8 @@ class Test_Trashbin extends \Test\TestCase {
\OC_App::disable('encryption');
//configure trashbin
self::$rememberRetentionObligation = \OC_Config::getValue('trashbin_retention_obligation', Files_Trashbin\Trashbin::DEFAULT_RETENTION_OBLIGATION);
\OC_Config::setValue('trashbin_retention_obligation', 2);
self::$rememberAutoExpire = \OC_Config::getValue('trashbin_auto_expire', true);
\OC_Config::setValue('trashbin_auto_expire', true);
self::$rememberRetentionObligation = \OC_Config::getValue('trashbin_retention_obligation', Files_Trashbin\Expiration::DEFAULT_RETENTION_OBLIGATION);
\OC_Config::setValue('trashbin_retention_obligation', 'auto, 2');
// register hooks
Files_Trashbin\Trashbin::registerHooks();
@ -92,7 +88,6 @@ class Test_Trashbin extends \Test\TestCase {
\OC_User::deleteUser(self::TEST_TRASHBIN_USER1);
\OC_Config::setValue('trashbin_retention_obligation', self::$rememberRetentionObligation);
\OC_Config::setValue('trashbin_auto_expire', self::$rememberAutoExpire);
\OC_Hook::clear();
@ -636,12 +631,6 @@ class Test_Trashbin extends \Test\TestCase {
}
}
$storage = new \ReflectionClass('\OC\Files\Storage\Shared');
$isInitialized = $storage->getProperty('isInitialized');
$isInitialized->setAccessible(true);
$isInitialized->setValue(array());
$isInitialized->setAccessible(false);
\OC_Util::tearDownFS();
\OC_User::setUserId('');
\OC\Files\Filesystem::tearDown();

36
config/config.sample.php
View File

@ -399,16 +399,34 @@ $CONFIG = array(
*/
/**
* When the trash bin app is enabled (default), this is the number of days a
* file will be kept in the trash bin. Default is 30 days.
* If the trash bin app is enabled (default), this setting defines the policy
* for when files and folders in the trash bin will be permanently deleted.
* The app allows for two settings, a minimum time for trash bin retention,
* and a maximum time for trash bin retention.
* Minimum time is the number of days a file will be kept, after which it
* may be deleted. Maximum time is the number of days at which it is guaranteed
* to be deleted.
* Both minimum and maximum times can be set together to explicitly define
* file and folder deletion. For migration purposes, this setting is installed
* initially set to "auto", which is equivalent to the default setting in
* ownCloud 8.1 and before.
*
* Available values:
* ``auto`` default setting. keeps files and folders in the trash bin
* for 30 days and automatically deletes anytime after that
* if space is needed (note: files may not be deleted if space
* is not needed).
* ``D, auto`` keeps files and folders in the trash bin for D+ days,
* delete anytime if space needed (note: files may not be deleted
* if space is not needed)
* * ``auto, D`` delete all files in the trash bin that are older than D days
* automatically, delete other files anytime if space needed
* * ``D1, D2`` keep files and folders the in trash bin for at least D1 days
* and delete when exceeds D2 days
* ``disabled`` trash bin auto clean disabled, files and folders will be
* kept forever
*/
'trashbin_retention_obligation' => 30,
/**
* Disable or enable auto-expiration for the trash bin. By default
* auto-expiration is enabled.
*/
'trashbin_auto_expire' => true,
'trashbin_retention_obligation' => 'auto',
/**