[Pkg-owncloud-commits] [owncloud] 190/223: fix trash bin expire operation and add unit tests
David Prévot
taffit at moszumanska.debian.org
Sun Jun 22 01:54:24 UTC 2014
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch master
in repository owncloud.
commit b486f48fbca0d8659d720bd37d6422d01bc09420
Author: Bjoern Schiessle <schiessle at owncloud.com>
Date: Tue Jun 17 13:51:49 2014 +0200
fix trash bin expire operation and add unit tests
---
apps/files_trashbin/lib/trashbin.php | 77 +++++++++----
apps/files_trashbin/tests/trashbin.php | 198 +++++++++++++++++++++++++++++++++
tests/enable_all.php | 1 +
3 files changed, 254 insertions(+), 22 deletions(-)
diff --git a/apps/files_trashbin/lib/trashbin.php b/apps/files_trashbin/lib/trashbin.php
index 1838c48..7683f97 100644
--- a/apps/files_trashbin/lib/trashbin.php
+++ b/apps/files_trashbin/lib/trashbin.php
@@ -725,8 +725,6 @@ class Trashbin {
*/
private static function expire($trashbinSize, $user) {
- $view = new \OC\Files\View('/' . $user . '/files_trashbin');
-
// let the admin disable auto expire
$autoExpire = \OC_Config::getValue('trashbin_auto_expire', true);
if ($autoExpire === false) {
@@ -741,34 +739,69 @@ class Trashbin {
$limit = time() - ($retention_obligation * 86400);
- $dirContent = $view->getDirectoryContent('/files');
+ $dirContent = Helper::getTrashFiles('/', 'mtime');
+
+ // delete all files older then $retention_obligation
+ list($delSize, $count) = self::deleteExpiredFiles($dirContent, $limit, $retention_obligation);
+
+ $size += $delSize;
+ $availableSpace += $size;
+
+ // delete files from trash until we meet the trash bin size limit again
+ $size += self::deleteFiles(array_slice($dirContent, $count), $availableSpace);
+
+ return $size;
+ }
- foreach ($dirContent as $file) {
+ /**
+ * if the size limit for the trash bin is reached, we delete the oldest
+ * files in the trash bin until we meet the limit again
+ * @param array $files
+ * @param init $availableSpace available disc space
+ * @return int size of deleted files
+ */
+ protected function deleteFiles($files, $availableSpace) {
+ $size = 0;
+
+ if ($availableSpace < 0) {
+ foreach ($files as $file) {
+ if ($availableSpace < 0) {
+ $tmp = self::delete($file['name'], $file['mtime']);
+ \OC_Log::write('files_trashbin', 'remove "' . $file['name'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OC_log::INFO);
+ $availableSpace += $tmp;
+ $size += $tmp;
+ } else {
+ break;
+ }
+ }
+ }
+ return $size;
+ }
+
+ /**
+ * delete files older then max storage time
+ *
+ * @param array $files list of files sorted by mtime
+ * @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, $limit, $retention_obligation) {
+ $size = 0;
+ $count = 0;
+ foreach ($files as $file) {
$timestamp = $file['mtime'];
- $filename = pathinfo($file['name'], PATHINFO_FILENAME);
+ $filename = $file['name'];
if ($timestamp < $limit) {
+ $count++;
$size += self::delete($filename, $timestamp);
\OC_Log::write('files_trashbin', 'remove "' . $filename . '" from trash bin because it is older than ' . $retention_obligation, \OC_log::INFO);
- }
- }
- $availableSpace += $size;
- // if size limit for trash bin reached, delete oldest files in trash bin
- if ($availableSpace < 0) {
- $query = \OC_DB::prepare('SELECT `location`,`type`,`id`,`timestamp` FROM `*PREFIX*files_trash`'
- . ' WHERE `user`=? ORDER BY `timestamp` ASC');
- $result = $query->execute(array($user))->fetchAll();
- $length = count($result);
- $i = 0;
- while ($i < $length && $availableSpace < 0) {
- $tmp = self::delete($result[$i]['id'], $result[$i]['timestamp']);
- \OC_Log::write('files_trashbin', 'remove "' . $result[$i]['id'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OC_log::INFO);
- $availableSpace += $tmp;
- $size += $tmp;
- $i++;
+ } else {
+ break;
}
}
- return $size;
+ return array($size, $count);
}
/**
diff --git a/apps/files_trashbin/tests/trashbin.php b/apps/files_trashbin/tests/trashbin.php
new file mode 100644
index 0000000..9e29d84
--- /dev/null
+++ b/apps/files_trashbin/tests/trashbin.php
@@ -0,0 +1,198 @@
+<?php
+/**
+ * ownCloud
+ *
+ * @author Bjoern Schiessle
+ * @copyright 2014 Bjoern Schiessle <schiessle at owncloud.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or any later version.
+ *
+ * This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+require_once __DIR__ . '/../../../lib/base.php';
+
+use OCA\Files_Trashbin;
+
+/**
+ * Class Test_Encryption_Crypt
+ */
+class Test_Trashbin extends \PHPUnit_Framework_TestCase {
+
+ const TEST_TRASHBIN_USER1 = "test-trashbin-user1";
+
+ private $trashRoot;
+
+ /**
+ * @var \OC\Files\View
+ */
+ private $rootView;
+
+ public static function setUpBeforeClass() {
+ // reset backend
+ \OC_User::clearBackends();
+ \OC_User::useBackend('database');
+
+ // register hooks
+ Files_Trashbin\Trashbin::registerHooks();
+
+ // create test user
+ self::loginHelper(self::TEST_TRASHBIN_USER1, true);
+ }
+
+
+
+ public static function tearDownAfterClass() {
+ // cleanup test user
+ \OC_User::deleteUser(self::TEST_TRASHBIN_USER1);
+
+ \OC_Hook::clear();
+ }
+
+ public function setUp() {
+ $this->trashRoot = '/' . self::TEST_TRASHBIN_USER1 . '/files_trashbin';
+ $this->rootView = new \OC\Files\View();
+ }
+
+ public function tearDown() {
+ $this->rootView->deleteAll($this->trashRoot);
+ }
+
+ /**
+ * test expiration of files older then the max storage time defined for the trash
+ */
+ public function testExpireOldFiles() {
+
+ $currentTime = time();
+ $expireAt = $currentTime - 2*24*60*60;
+ $expiredDate = $currentTime - 3*24*60*60;
+
+ // create some files
+ \OC\Files\Filesystem::file_put_contents('file1.txt', 'file1');
+ \OC\Files\Filesystem::file_put_contents('file2.txt', 'file2');
+ \OC\Files\Filesystem::file_put_contents('file3.txt', 'file3');
+
+ // delete them so that they end up in the trash bin
+ \OC\Files\Filesystem::unlink('file1.txt');
+ \OC\Files\Filesystem::unlink('file2.txt');
+ \OC\Files\Filesystem::unlink('file3.txt');
+
+ //make sure that files are in the trash bin
+ $filesInTrash = OCA\Files_Trashbin\Helper::getTrashFiles('/');
+ $this->assertSame(3, count($filesInTrash));
+
+ $manipulatedList = $this->manipulateDeleteTime($filesInTrash, $expiredDate);
+
+ $testClass = new TrashbinForTesting();
+ list($sizeOfDeletedFiles, $count) = $testClass->dummyDeleteExpiredFiles($manipulatedList, $expireAt);
+
+ $this->assertSame(10, $sizeOfDeletedFiles);
+ $this->assertSame(2, $count);
+
+ // only file2.txt should be left
+ $remainingFiles = array_slice($manipulatedList, $count);
+ $this->assertSame(1, count($remainingFiles));
+ $remainingFile = reset($remainingFiles);
+ $this->assertSame('file2.txt', $remainingFile['name']);
+
+ // check that file1.txt and file3.txt was really deleted
+ $newTrashContent = OCA\Files_Trashbin\Helper::getTrashFiles('/');
+ $this->assertSame(1, count($newTrashContent));
+ $element = reset($newTrashContent);
+ $this->assertSame('file2.txt', $element['name']);
+ }
+
+ private function manipulateDeleteTime($files, $expireDate) {
+ $counter = 0;
+ foreach ($files as &$file) {
+ // modify every second file
+ $counter = ($counter + 1) % 2;
+ if ($counter === 1) {
+ $source = $this->trashRoot . '/files/' . $file['name'].'.d'.$file['mtime'];
+ $target = \OC\Files\Filesystem::normalizePath($this->trashRoot . '/files/' . $file['name'] . '.d' . $expireDate);
+ $this->rootView->rename($source, $target);
+ $file['mtime'] = $expireDate;
+ }
+ }
+ return \OCA\Files\Helper::sortFiles($files, 'mtime');
+ }
+
+
+ /**
+ * test expiration of old files in the trash bin until the max size
+ * of the trash bin is met again
+ */
+ public function testExpireOldFilesUtilLimitsAreMet() {
+
+ // create some files
+ \OC\Files\Filesystem::file_put_contents('file1.txt', 'file1');
+ \OC\Files\Filesystem::file_put_contents('file2.txt', 'file2');
+ \OC\Files\Filesystem::file_put_contents('file3.txt', 'file3');
+
+ // delete them so that they end up in the trash bin
+ \OC\Files\Filesystem::unlink('file3.txt');
+ sleep(1); // make sure that every file has a unique mtime
+ \OC\Files\Filesystem::unlink('file2.txt');
+ sleep(1); // make sure that every file has a unique mtime
+ \OC\Files\Filesystem::unlink('file1.txt');
+
+ //make sure that files are in the trash bin
+ $filesInTrash = OCA\Files_Trashbin\Helper::getTrashFiles('/', 'mtime');
+ $this->assertSame(3, count($filesInTrash));
+
+ $testClass = new TrashbinForTesting();
+ $sizeOfDeletedFiles = $testClass->dummyDeleteFiles($filesInTrash, -8);
+
+ // the two oldest files (file3.txt and file2.txt) should be deleted
+ $this->assertSame(10, $sizeOfDeletedFiles);
+
+ $newTrashContent = OCA\Files_Trashbin\Helper::getTrashFiles('/');
+ $this->assertSame(1, count($newTrashContent));
+ $element = reset($newTrashContent);
+ $this->assertSame('file1.txt', $element['name']);
+ }
+
+ /**
+ * @param string $user
+ * @param bool $create
+ * @param bool $password
+ */
+ public static function loginHelper($user, $create = false) {
+ if ($create) {
+ try {
+ \OC_User::createUser($user, $user);
+ } catch(\Exception $e) { // catch username is already being used from previous aborted runs
+
+ }
+ }
+
+ \OC_Util::tearDownFS();
+ \OC_User::setUserId('');
+ \OC\Files\Filesystem::tearDown();
+ \OC_User::setUserId($user);
+ \OC_Util::setupFS($user);
+ }
+}
+
+
+// just a dummy class to make protected methods available for testing
+class TrashbinForTesting extends Files_Trashbin\Trashbin {
+ public function dummyDeleteExpiredFiles($files, $limit) {
+ // dummy value for $retention_obligation because it is not needed here
+ return parent::deleteExpiredFiles($files, $limit, 0);
+ }
+
+ public function dummyDeleteFiles($files, $availableSpace) {
+ return parent::deleteFiles($files, $availableSpace);
+ }
+}
diff --git a/tests/enable_all.php b/tests/enable_all.php
index 386ae20..2368a19 100644
--- a/tests/enable_all.php
+++ b/tests/enable_all.php
@@ -17,6 +17,7 @@ function enableApp($app) {
}
enableApp('files_sharing');
+enableApp('files_trashbin');
enableApp('files_encryption');
enableApp('files_external');
enableApp('user_ldap');
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud.git
More information about the Pkg-owncloud-commits
mailing list