Merge pull request #18943 from owncloud/trashbin-expiration-cronjob-no-db

Add Trashbin expiration cronjob

apps/files_trashbin/appinfo/app.php

@@ -23,6 +23,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>
  *
  */
+
 $l = \OC::$server->getL10N('files_trashbin');
 
 // register hooks

apps/files_trashbin/appinfo/install.php

@@ -0,0 +1,23 @@
+<?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/>
+ *
+ */
+
+ // Cron job for deleting expired trash items
+\OC::$server->getJobList()->add('OCA\Files_Trashbin\BackgroundJob\ExpireTrash');

apps/files_trashbin/appinfo/update.php

@@ -46,3 +46,6 @@ if (version_compare($installedVersion, '0.6.4', '<')) {
 	$config->setSystemValue('trashbin_retention_obligation', $newObligation);
 	$config->deleteSystemValue('trashbin_auto_expire');
 }
+
+// Cron job for deleting expired trash items
+\OC::$server->getJobList()->add('OCA\Files_Trashbin\BackgroundJob\ExpireTrash');

apps/files_trashbin/lib/backgroundjob/expiretrash.php

@@ -0,0 +1,127 @@
+<?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\BackgroundJob;
+
+use OCP\IConfig;
+use OCP\IUserManager;
+use OCA\Files_Trashbin\AppInfo\Application;
+use OCA\Files_Trashbin\Expiration;
+use OCA\Files_Trashbin\Helper;
+use OCA\Files_Trashbin\Trashbin;
+
+class ExpireTrash extends \OC\BackgroundJob\TimedJob {
+
+	const ITEMS_PER_SESSION = 1000;
+
+	/**
+	 * @var Expiration
+	 */
+	private $expiration;
+
+	/**
+	 * @var IConfig
+	 */
+	private $config;
+	
+	/**
+	 * @var IUserManager
+	 */
+	private $userManager;
+	
+	const USERS_PER_SESSION = 1000;
+
+	/**
+	 * @param IConfig|null $config
+	 * @param IUserManager|null $userManager
+	 * @param Expiration|null $expiration
+	 */
+	public function __construct(IConfig $config = 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($config)) {
+			$this->fixDIForJobs();
+		} else {
+			$this->config = $config;
+			$this->userManager = $userManager;
+			$this->expiration = $expiration;
+		}
+	}
+
+	protected function fixDIForJobs() {
+		$application = new Application();
+		$this->config = \OC::$server->getConfig();
+		$this->userManager = \OC::$server->getUserManager();
+		$this->expiration = $application->getContainer()->query('Expiration');
+	}
+
+	/**
+	 * @param $argument
+	 * @throws \Exception
+	 */
+	protected function run($argument) {
+		$maxAge = $this->expiration->getMaxAgeAsTimestamp();
+		if (!$maxAge) {
+			return;
+		}
+		
+		$offset = $this->config->getAppValue('files_trashbin', 'cronjob_user_offset', 0);
+		$users = $this->userManager->search('', self::USERS_PER_SESSION, $offset);
+		if (!count($users)) {
+			// No users found, reset offset and retry
+			$offset = 0;
+			$users = $this->userManager->search('', self::USERS_PER_SESSION);
+		}
+		
+		$offset += self::USERS_PER_SESSION;
+		$this->config->setAppValue('files_trashbin', 'cronjob_user_offset', $offset);
+		
+		foreach ($users as $user) {
+			$uid = $user->getUID();
+			if (!$this->setupFS($uid)) {
+				continue;
+			}
+			$dirContent = Helper::getTrashFiles('/', $uid, 'mtime');
+			Trashbin::deleteExpiredFiles($dirContent, $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;
+	}
+}

apps/files_trashbin/lib/expiration.php

@@ -105,6 +105,18 @@ class Expiration {
 		return $isOlderThanMax || $isMinReached;
 	}
 
+	/**
+	 * @return bool|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;
+	}
+
 	private function parseRetentionObligation(){
 		$splitValues = explode(',', $this->retentionObligation);
 		if (!isset($splitValues[0])) {

apps/files_trashbin/lib/trashbin.php

@@ -689,7 +689,7 @@ class Trashbin {
 	 * @param string $user
 	 * @return array size of deleted files and number of deleted files
 	 */
-	protected static function deleteExpiredFiles($files, $user) {
+	public static function deleteExpiredFiles($files, $user) {
 		$application = new Application();
 		$expiration = $application->getContainer()->query('Expiration');
 		$size = 0;
@@ -700,6 +700,10 @@ class Trashbin {
 			if ($expiration->isExpired($timestamp)) {
 				$count++;
 				$size += self::delete($filename, $user, $timestamp);
+				\OC::$server->getLogger()->info(
+					'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.',
+					['app' => 'files_trashbin']
+				);
 			} else {
 				break;
 			}

apps/files_trashbin/tests/backgroundjob/expiretrash.php

@@ -0,0 +1,40 @@
+<?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\Tests\BackgroundJob\ExpireTrash;
+ 
+use \OCA\Files_Trashbin\BackgroundJob\ExpireTrash;
+
+class ExpireTrash_Test extends \Test\TestCase {
+	public function testConstructAndRun() {
+		$backgroundJob = new ExpireTrash(
+			$this->getMock('OCP\IConfig'),
+			$this->getMock('OCP\IUserManager'),
+			$this->getMockBuilder('OCA\Files_Trashbin\Expiration')->disableOriginalConstructor()->getMock()
+		);
+
+		$jobList = $this->getMock('\OCP\BackgroundJob\IJobList');
+
+		/** @var \OC\BackgroundJob\JobList $jobList */
+		$backgroundJob->execute($jobList);
+		$this->assertTrue(true);
+	}
+}

apps/files_trashbin/tests/expiration.php

@@ -24,6 +24,8 @@ use \OCA\Files_Trashbin\Expiration;
 class Expiration_Test extends \PHPUnit_Framework_TestCase {
 	const SECONDS_PER_DAY = 86400; //60*60*24
 
+	const FAKE_TIME_NOW = 1000000;
+
 	public function expirationData(){
 		$today = 100*self::SECONDS_PER_DAY;
 		$back10Days = (100-10)*self::SECONDS_PER_DAY;
@@ -142,6 +144,38 @@ class Expiration_Test extends \PHPUnit_Framework_TestCase {
 		$this->assertAttributeEquals($expectedCanPurgeToSaveSpace, 'canPurgeToSaveSpace', $expiration);
 	}
 
+
+	public function timestampTestData(){
+		return [
+			[ 'disabled', false],
+			[ 'auto', false ],
+			[ 'auto,auto', false ],
+			[ 'auto, auto', false ],
+			[ 'auto, 3',  self::FAKE_TIME_NOW - (3*self::SECONDS_PER_DAY) ],
+			[ '5, auto', false ],
+			[ '3, 5', self::FAKE_TIME_NOW - (5*self::SECONDS_PER_DAY) ],
+			[ '10, 3', self::FAKE_TIME_NOW - (10*self::SECONDS_PER_DAY) ],
+		];
+	}
+
+
+	/**
+	 * @dataProvider timestampTestData
+	 *
+	 * @param string $configValue
+	 * @param int $expectedMaxAgeTimestamp
+	 */
+	public function testGetMaxAgeAsTimestamp($configValue, $expectedMaxAgeTimestamp){
+		$mockedConfig = $this->getMockedConfig($configValue);
+		$mockedTimeFactory = $this->getMockedTimeFactory(
+				self::FAKE_TIME_NOW
+		);
+
+		$expiration = new Expiration($mockedConfig, $mockedTimeFactory);
+		$actualTimestamp = $expiration->getMaxAgeAsTimestamp();
+		$this->assertEquals($expectedMaxAgeTimestamp, $actualTimestamp);
+	}
+
 	/**
 	 *
 	 * @param int $time