From 0cefbd76b9369135075fda8c210dfa9ff88a264c Mon Sep 17 00:00:00 2001 From: Victor Dubiniuk Date: Mon, 31 Aug 2015 23:52:00 +0300 Subject: [PATCH] Add expiration for versions older than max --- apps/files_versions/appinfo/app.php | 8 +- apps/files_versions/appinfo/install.php | 23 ++++ apps/files_versions/appinfo/update.php | 3 + .../lib/backgroundjob/expireversions.php | 106 ++++++++++++++++++ apps/files_versions/lib/expiration.php | 13 +++ apps/files_versions/lib/storage.php | 28 +++++ 6 files changed, 180 insertions(+), 1 deletion(-) create mode 100644 apps/files_versions/appinfo/install.php create mode 100644 apps/files_versions/lib/backgroundjob/expireversions.php diff --git a/apps/files_versions/appinfo/app.php b/apps/files_versions/appinfo/app.php index 967f2e73a3..218d535115 100644 --- a/apps/files_versions/appinfo/app.php +++ b/apps/files_versions/appinfo/app.php @@ -19,6 +19,12 @@ * along with this program. If not, see * */ -OCP\Util::addStyle('files_versions', 'versions'); + +namespace OCA\Files_Versions\AppInfo; + +$app = new Application(); +$container = $app->getContainer(); + +\OCP\Util::addStyle('files_versions', 'versions'); \OCA\Files_Versions\Hooks::connectHooks(); diff --git a/apps/files_versions/appinfo/install.php b/apps/files_versions/appinfo/install.php new file mode 100644 index 0000000000..d72ba2f56e --- /dev/null +++ b/apps/files_versions/appinfo/install.php @@ -0,0 +1,23 @@ + + * + * @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 + * + */ + +// Cron job for deleting expired trash items +\OC::$server->getJobList()->add('OCA\Files_Versions\BackgroundJob\ExpireVersions'); diff --git a/apps/files_versions/appinfo/update.php b/apps/files_versions/appinfo/update.php index 524f9bd153..687e5d3b5d 100644 --- a/apps/files_versions/appinfo/update.php +++ b/apps/files_versions/appinfo/update.php @@ -24,3 +24,6 @@ $installedVersion=OCP\Config::getAppValue('files_versions', 'installed_version') if (version_compare($installedVersion, '1.0.4', '<')) { \OC_DB::dropTable("files_versions"); } + +// Cron job for deleting expired trash items +\OC::$server->getJobList()->add('OCA\Files_Versions\BackgroundJob\ExpireVersions'); diff --git a/apps/files_versions/lib/backgroundjob/expireversions.php b/apps/files_versions/lib/backgroundjob/expireversions.php new file mode 100644 index 0000000000..8aa1fcb063 --- /dev/null +++ b/apps/files_versions/lib/backgroundjob/expireversions.php @@ -0,0 +1,106 @@ + + * + * @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 + * + */ + +namespace OCA\Files_Versions\BackgroundJob; + +use OCP\IDBConnection; +use OCP\IUserManager; +use OCA\Files_Versions\AppInfo\Application; +use OCA\Files_Versions\Storage; +use OCA\Files_Versions\Expiration; + +class ExpireVersions extends \OC\BackgroundJob\TimedJob { + + const ITEMS_PER_SESSION = 1000; + + /** + * @var Expiration + */ + private $expiration; + + /** + * @var IDBConnection + */ + private $dbConnection; + + /** + * @var IUserManager + */ + private $userManager; + + public function __construct(IDBConnection $dbConnection = null, IUserManager $userManager = null, Expiration $expiration = null) { + // Run once per 30 minutes + $this->setInterval(60 * 30); + + if (is_null($expiration) || is_null($userManager) || is_null($dbConnection)) { + $this->fixDIForJobs(); + } else { + $this->dbConnection = $dbConnection; + $this->expiration = $expiration; + $this->userManager = $userManager; + } + } + + protected function fixDIForJobs() { + $application = new Application(); + $this->dbConnection = \OC::$server->getDatabaseConnection(); + $this->expiration = $application->getContainer()->query('Expiration'); + $this->userManager = \OC::$server->getUserManager(); + } + + protected function run($argument) { + $maxAge = $this->expiration->getMaxAgeAsTimestamp(); + if (!$maxAge) { + return; + } + + $users = $this->userManager->search(''); + $isFSready = false; + foreach ($users as $user) { + $uid = $user->getUID(); + if (!$isFSready) { + if (!$this->setupFS($uid)) { + continue; + } + $isFSready = true; + } + Storage::expireOlderThan($uid); + } + + \OC_Util::tearDownFS(); + } + + /** + * Act on behalf on trash item owner + * @param string $user + * @return boolean + */ + private function setupFS($user){ + if (!$this->userManager->userExists($user)) { + return false; + } + + \OC_Util::tearDownFS(); + \OC_Util::setupFS($user); + + return true; + } +} \ No newline at end of file diff --git a/apps/files_versions/lib/expiration.php b/apps/files_versions/lib/expiration.php index d42c62f0ee..fba705251e 100644 --- a/apps/files_versions/lib/expiration.php +++ b/apps/files_versions/lib/expiration.php @@ -112,6 +112,19 @@ class Expiration { return $isOlderThanMax || $isMinReached; } + /** + * Get maximal retention obligation as a timestamp + * @return int + */ + public function getMaxAgeAsTimestamp(){ + $maxAge = false; + if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) { + $time = $this->timeFactory->getTime(); + $maxAge = $time - ($this->maxAge * 86400); + } + return $maxAge; + } + /** * Read versions_retention_obligation, validate it * and set private members accordingly diff --git a/apps/files_versions/lib/storage.php b/apps/files_versions/lib/storage.php index ba2b78ff4d..1f9d0fa04a 100644 --- a/apps/files_versions/lib/storage.php +++ b/apps/files_versions/lib/storage.php @@ -403,6 +403,34 @@ class Storage { return $versions; } + public static function expireOlderThan($uid){ + $expiration = self::getExpiration(); + $threshold = $expiration->getMaxAgeAsTimestamp(); + $versions = self::getAllVersions($uid); + if (!$threshold || !array_key_exists('all', $versions)) { + return; + } + + $toDelete = []; + foreach (array_reverse($versions['all']) as $key => $version) { + if (intval($version['version'])<$threshold) { + $toDelete[$key] = $version; + } else { + //Versions are sorted by time - nothing mo to iterate. + break; + } + } + + $view = new \OC\Files\View('/' . $uid . '/files_versions'); + if (!empty($toDelete)) { + foreach ($toDelete as $version) { + \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'])); + self::deleteVersion($view, $version['path'] . '.v' . $version['version']); + \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'])); + } + } + } + /** * translate a timestamp into a string like "5 days ago" * @param int $timestamp