Enhance trashbin expiration settings

2 files changed, 166 insertions, 18 deletions

diff --git a/apps/files_trashbin/lib/expiration.php b/apps/files_trashbin/lib/expiration.php
new file mode 100644
index 00000000000..3b57c067ae7
--- /dev/null
+++ b/apps/files_trashbin/lib/expiration.php
@@ -0,0 +1,153 @@
+<?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->getValue('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;
+		}
+	}
+}
diff --git a/apps/files_trashbin/lib/trashbin.php b/apps/files_trashbin/lib/trashbin.php
index 8b666c56c66..2719eece2a8 100644
--- a/apps/files_trashbin/lib/trashbin.php
+++ b/apps/files_trashbin/lib/trashbin.php
@@ -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,11 +646,11 @@ 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));
 		}
-		\OC::$server->getCommandBus()->push(new Expire($user, $trashBinSize));
 	}
 
 	/**
@@ -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;
 			}