nextcloud/apps/files_versions/lib/Storage.php

833 lines
28 KiB
PHP
Raw Normal View History

<?php
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2016-05-26 20:56:05 +03:00
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
2016-07-21 17:49:16 +03:00
* @author Bjoern Schiessle <bjoern@schiessle.org>
2016-05-26 20:56:05 +03:00
* @author Björn Schießle <bjoern@schiessle.org>
2016-07-21 17:49:16 +03:00
* @author Carlos Damken <carlos@damken.com>
2015-03-26 13:44:34 +03:00
* @author Felix Moeller <mail@felixmoeller.de>
* @author Georg Ehrke <georg@owncloud.com>
2016-07-21 17:49:16 +03:00
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2015-03-26 13:44:34 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
2015-10-05 21:54:56 +03:00
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
2015-03-26 13:44:34 +03:00
* @author Vincent Petry <pvince81@owncloud.com>
*
* @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/>
*
*/
/**
* Versions
*
* A class to handle the versioning of files.
*/
namespace OCA\Files_Versions;
2015-12-10 16:14:54 +03:00
use OC\Files\Filesystem;
use OC\Files\View;
2015-08-17 21:40:03 +03:00
use OCA\Files_Versions\AppInfo\Application;
use OCA\Files_Versions\Command\Expire;
2016-04-25 14:22:54 +03:00
use OCP\Files\NotFoundException;
2015-10-02 18:08:39 +03:00
use OCP\Lock\ILockingProvider;
use OCP\User;
class Storage {
const DEFAULTENABLED=true;
const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
const VERSIONS_ROOT = 'files_versions/';
2013-02-22 20:21:57 +04:00
const DELETE_TRIGGER_MASTER_REMOVED = 0;
const DELETE_TRIGGER_RETENTION_CONSTRAINT = 1;
const DELETE_TRIGGER_QUOTA_EXCEEDED = 2;
// files for which we can remove the versions after the delete operation was successful
private static $deletedFiles = array();
private static $sourcePathAndUser = array();
private static $max_versions_per_interval = array(
2013-02-22 03:21:06 +04:00
//first 10sec, one version every 2sec
1 => array('intervalEndsAfter' => 10, 'step' => 2),
//next minute, one version every 10sec
2 => array('intervalEndsAfter' => 60, 'step' => 10),
//next hour, one version every minute
3 => array('intervalEndsAfter' => 3600, 'step' => 60),
//next 24h, one version every hour
4 => array('intervalEndsAfter' => 86400, 'step' => 3600),
//next 30days, one version per day
5 => array('intervalEndsAfter' => 2592000, 'step' => 86400),
//until the end one version per week
6 => array('intervalEndsAfter' => -1, 'step' => 604800),
);
2016-06-30 11:29:32 +03:00
2015-09-09 18:37:33 +03:00
/** @var \OCA\Files_Versions\AppInfo\Application */
private static $application;
/**
* get the UID of the owner of the file and the path to the file relative to
* owners files folder
*
* @param string $filename
* @return array
* @throws \OC\User\NoUserException
*/
public static function getUidAndFilename($filename) {
$uid = Filesystem::getOwner($filename);
$userManager = \OC::$server->getUserManager();
// if the user with the UID doesn't exists, e.g. because the UID points
// to a remote user with a federated cloud ID we use the current logged-in
// user. We need a valid local user to create the versions
if (!$userManager->userExists($uid)) {
$uid = User::getUser();
}
Filesystem::initMountPoints($uid);
if ( $uid != User::getUser() ) {
$info = Filesystem::getFileInfo($filename);
$ownerView = new View('/'.$uid.'/files');
try {
$filename = $ownerView->getPath($info['fileid']);
// make sure that the file name doesn't end with a trailing slash
// can for example happen single files shared across servers
$filename = rtrim($filename, '/');
} catch (NotFoundException $e) {
$filename = null;
}
}
return [$uid, $filename];
}
2013-02-22 20:21:57 +04:00
/**
2014-10-29 01:32:57 +03:00
* Remember the owner and the owner path of the source file
*
* @param string $source source path
*/
public static function setSourcePathAndUser($source) {
list($uid, $path) = self::getUidAndFilename($source);
self::$sourcePathAndUser[$source] = array('uid' => $uid, 'path' => $path);
}
/**
2014-10-29 01:32:57 +03:00
* Gets the owner and the owner path from the source path
*
* @param string $source source path
* @return array with user id and path
*/
public static function getSourcePathAndUser($source) {
if (isset(self::$sourcePathAndUser[$source])) {
$uid = self::$sourcePathAndUser[$source]['uid'];
$path = self::$sourcePathAndUser[$source]['path'];
unset(self::$sourcePathAndUser[$source]);
} else {
$uid = $path = false;
}
return array($uid, $path);
}
2013-02-21 15:20:29 +04:00
/**
* get current size of all versions from a given user
*
2014-05-13 15:29:25 +04:00
* @param string $user user who owns the versions
* @return int versions size
2013-02-21 15:20:29 +04:00
*/
private static function getVersionsSize($user) {
$view = new View('/' . $user);
$fileInfo = $view->getFileInfo('/files_versions');
return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
2013-02-21 15:20:29 +04:00
}
/**
* store a new version of a file.
*/
2013-02-14 17:26:49 +04:00
public static function store($filename) {
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
// if the file gets streamed we need to remove the .part extension
// to get the right target
$ext = pathinfo($filename, PATHINFO_EXTENSION);
if ($ext === 'part') {
$filename = substr($filename, 0, strlen($filename) - 5);
}
// we only handle existing files
if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
return false;
}
2012-09-19 22:54:03 +04:00
list($uid, $filename) = self::getUidAndFilename($filename);
2013-02-22 20:21:57 +04:00
$files_view = new View('/'.$uid .'/files');
$users_view = new View('/'.$uid);
// no use making versions for empty files
if ($files_view->filesize($filename) === 0) {
return false;
}
// create all parent folders
self::createMissingDirectories($filename, $users_view);
self::scheduleExpire($uid, $filename);
// store a new version of a file
$mtime = $users_view->filemtime('files/' . $filename);
$users_view->copy('files/' . $filename, 'files_versions/' . $filename . '.v' . $mtime);
// call getFileInfo to enforce a file cache entry for the new version
$users_view->getFileInfo('files_versions/' . $filename . '.v' . $mtime);
}
}
/**
* mark file as deleted so that we can remove the versions if the file is gone
* @param string $path
*/
public static function markDeletedFile($path) {
list($uid, $filename) = self::getUidAndFilename($path);
self::$deletedFiles[$path] = array(
'uid' => $uid,
'filename' => $filename);
}
2013-02-22 20:21:57 +04:00
2014-07-10 17:19:40 +04:00
/**
* delete the version from the storage and cache
*
* @param View $view
2014-07-10 17:19:40 +04:00
* @param string $path
*/
protected static function deleteVersion($view, $path) {
$view->unlink($path);
/**
* @var \OC\Files\Storage\Storage $storage
* @var string $internalPath
*/
list($storage, $internalPath) = $view->resolvePath($path);
$cache = $storage->getCache($internalPath);
$cache->remove($internalPath);
}
/**
* Delete versions of a file
*/
public static function delete($path) {
$deletedFile = self::$deletedFiles[$path];
$uid = $deletedFile['uid'];
$filename = $deletedFile['filename'];
if (!Filesystem::file_exists($path)) {
$view = new View('/' . $uid . '/files_versions');
2013-11-28 22:31:35 +04:00
$versions = self::getVersions($uid, $filename);
if (!empty($versions)) {
foreach ($versions as $v) {
\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
2014-07-10 17:19:40 +04:00
self::deleteVersion($view, $filename . '.v' . $v['version']);
\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
}
2013-01-15 17:57:23 +04:00
}
}
unset(self::$deletedFiles[$path]);
}
2013-02-22 20:21:57 +04:00
2013-01-15 17:57:23 +04:00
/**
* Rename or copy versions of a file of the given paths
*
* @param string $sourcePath source path of the file to move, relative to
* the currently logged in user's "files" folder
* @param string $targetPath target path of the file to move, relative to
* the currently logged in user's "files" folder
* @param string $operation can be 'copy' or 'rename'
2013-01-15 17:57:23 +04:00
*/
public static function renameOrCopy($sourcePath, $targetPath, $operation) {
list($sourceOwner, $sourcePath) = self::getSourcePathAndUser($sourcePath);
// it was a upload of a existing file if no old path exists
// in this case the pre-hook already called the store method and we can
// stop here
if ($sourcePath === false) {
return true;
}
list($targetOwner, $targetPath) = self::getUidAndFilename($targetPath);
$sourcePath = ltrim($sourcePath, '/');
$targetPath = ltrim($targetPath, '/');
$rootView = new View('');
// did we move a directory ?
if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
// does the directory exists for versions too ?
if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
// create missing dirs if necessary
self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
// move the directory containing the versions
$rootView->$operation(
'/' . $sourceOwner . '/files_versions/' . $sourcePath,
'/' . $targetOwner . '/files_versions/' . $targetPath
);
}
} else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
// create missing dirs if necessary
self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
2013-08-17 15:46:33 +04:00
foreach ($versions as $v) {
// move each version one by one to the target directory
$rootView->$operation(
'/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
'/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
);
2013-01-15 17:57:23 +04:00
}
}
// if we moved versions directly for a file, schedule expiration check for that file
if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
self::scheduleExpire($targetOwner, $targetPath);
}
}
2013-02-22 20:21:57 +04:00
/**
2015-04-08 18:56:20 +03:00
* Rollback to an old version of a file.
*
* @param string $file file name
* @param int $revision revision timestamp
* @return bool
*/
public static function rollback($file, $revision) {
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
2015-04-08 18:56:20 +03:00
// add expected leading slash
$file = '/' . ltrim($file, '/');
list($uid, $filename) = self::getUidAndFilename($file);
if ($uid === null || trim($filename, '/') === '') {
return false;
}
$users_view = new View('/'.$uid);
$files_view = new View('/'. User::getUser().'/files');
2013-01-16 13:18:40 +04:00
$versionCreated = false;
2013-02-22 20:21:57 +04:00
2016-06-30 11:29:32 +03:00
$fileInfo = $files_view->getFileInfo($file);
// check if user has the permissions to revert a version
if (!$fileInfo->isUpdateable()) {
return false;
}
//first create a new version
$version = 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename);
if (!$users_view->file_exists($version)) {
$users_view->copy('files'.$filename, 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename));
$versionCreated = true;
}
2013-02-22 20:21:57 +04:00
$fileToRestore = 'files_versions' . $filename . '.v' . $revision;
// Restore encrypted version of the old file for the newly restored file
// This has to happen manually here since the file is manually copied below
$oldVersion = $users_view->getFileInfo($fileToRestore)->getEncryptedVersion();
$oldFileInfo = $users_view->getFileInfo($fileToRestore);
2016-06-30 11:29:32 +03:00
$cache = $fileInfo->getStorage()->getCache();
$cache->update(
2016-06-30 11:29:32 +03:00
$fileInfo->getId(), [
'encrypted' => $oldVersion,
'encryptedVersion' => $oldVersion,
'size' => $oldFileInfo->getSize()
]
);
// rollback
if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
$files_view->touch($file, $revision);
Storage::scheduleExpire($uid, $file);
\OC_Hook::emit('\OCP\Versions', 'rollback', array(
'path' => $filename,
'revision' => $revision,
));
return true;
2015-04-08 18:56:20 +03:00
} else if ($versionCreated) {
2014-07-10 17:19:40 +04:00
self::deleteVersion($users_view, $version);
}
}
return false;
}
2015-04-08 18:56:20 +03:00
/**
* Stream copy file contents from $path1 to $path2
*
* @param View $view view to use for copying
2015-04-08 18:56:20 +03:00
* @param string $path1 source file to copy
* @param string $path2 target file
*
* @return bool true for success, false otherwise
*/
private static function copyFileContents($view, $path1, $path2) {
2015-10-02 18:08:39 +03:00
/** @var \OC\Files\Storage\Storage $storage1 */
2015-04-08 18:56:20 +03:00
list($storage1, $internalPath1) = $view->resolvePath($path1);
2015-10-02 18:08:39 +03:00
/** @var \OC\Files\Storage\Storage $storage2 */
2015-04-08 18:56:20 +03:00
list($storage2, $internalPath2) = $view->resolvePath($path2);
2015-10-02 18:08:39 +03:00
$view->lockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
$view->lockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
// TODO add a proper way of overwriting a file while maintaining file ids
if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
$source = $storage1->fopen($internalPath1, 'r');
$target = $storage2->fopen($internalPath2, 'w');
list(, $result) = \OC_Helper::streamCopy($source, $target);
fclose($source);
fclose($target);
if ($result !== false) {
$storage1->unlink($internalPath1);
}
} else {
$result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
}
2015-04-08 18:56:20 +03:00
2015-10-02 18:08:39 +03:00
$view->unlockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
$view->unlockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
2015-04-08 18:56:20 +03:00
return ($result !== false);
}
/**
* get a list of all available versions of a file in descending chronological order
* @param string $uid user id from the owner of the file
* @param string $filename file to find versions of, relative to the user files dir
* @param string $userFullPath
2014-05-13 14:36:01 +04:00
* @return array versions newest version first
*/
public static function getVersions($uid, $filename, $userFullPath = '') {
$versions = array();
if (empty($filename)) {
return $versions;
}
// fetch for old versions
$view = new View('/' . $uid . '/');
2013-10-10 22:06:42 +04:00
$pathinfo = pathinfo($filename);
$versionedFile = $pathinfo['basename'];
2013-10-10 22:06:42 +04:00
$dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
2013-10-10 22:06:42 +04:00
$dirContent = false;
if ($view->is_dir($dir)) {
$dirContent = $view->opendir($dir);
}
if ($dirContent === false) {
return $versions;
}
if (is_resource($dirContent)) {
while (($entryName = readdir($dirContent)) !== false) {
if (!Filesystem::isIgnoredDir($entryName)) {
$pathparts = pathinfo($entryName);
$filename = $pathparts['filename'];
if ($filename === $versionedFile) {
$pathparts = pathinfo($entryName);
$timestamp = substr($pathparts['extension'], 1);
$filename = $pathparts['filename'];
$key = $timestamp . '#' . $filename;
$versions[$key]['version'] = $timestamp;
$versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
if (empty($userFullPath)) {
$versions[$key]['preview'] = '';
} else {
$versions[$key]['preview'] = \OCP\Util::linkToRoute('core_ajax_versions_preview', array('file' => $userFullPath, 'version' => $timestamp));
}
$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
$versions[$key]['name'] = $versionedFile;
$versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
}
}
}
closedir($dirContent);
}
2013-10-10 22:06:42 +04:00
// sort with newest version first
krsort($versions);
2013-10-10 22:06:42 +04:00
return $versions;
}
2015-09-16 17:22:17 +03:00
/**
* Expire versions that older than max version retention time
* @param string $uid
*/
public static function expireOlderThanMaxForUser($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 View('/' . $uid . '/files_versions');
if (!empty($toDelete)) {
foreach ($toDelete as $version) {
\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
}
}
}
new version drop down Squashed commit of the following: commit 0dc404a557fa8253e3a87c7babefba6de8e6dab5 Author: Björn Schießle <schiessle@owncloud.com> Date: Thu Jul 25 10:26:48 2013 +0200 fix 'more versions' button for IE8 commit 5836e652857204d68dfdfa8b3318de8e2fe02493 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 16:56:46 2013 +0200 clean-up some unused code commit ac83e53fa24073783a165796fc3016dc7beca293 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 16:49:03 2013 +0200 fix order of the versions, newest version should come first commit f150a88843af316ff505728941287406f25a0751 Merge: bc713c7 b8e399b Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 16:19:36 2013 +0200 Merge branch 'new_versions_dropdown' of github.com:owncloud/core into new_versions_dropdown commit bc713c7b0c3207d00d2f19b10a905a82724c0709 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 16:11:07 2013 +0200 fix position of more versions button commit b8e399b1754ae7656c3cb8cef2c53f6976a83d61 Merge: 24825b0 7b6e39d Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 16:04:08 2013 +0200 Merge branch 'new_versions_dropdown' of github.com:owncloud/core into new_versions_dropdown commit 24825b02004efa953197e72b470b9b033030aeee Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 16:02:53 2013 +0200 umark previous row if a new row gets selected commit 7b6e39d2939f1b3bba4fff37ca9087dbc7795f03 Merge: 5bfb0ac 7b54644 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 15:37:19 2013 +0200 Merge branch 'new_versions_dropdown' of github.com:owncloud/core into new_versions_dropdown commit 5bfb0ac5c102bdfd3b27a37cea8c792f69b3b803 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 15:37:09 2013 +0200 more style adjustments for version dropdown commit 7b54644d3036ffba448f0525ca09f6e8898b9950 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 15:12:53 2013 +0200 remove debug output commit a75662bcfdce34d4f14020a539172c7ef1b894d3 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 15:12:26 2013 +0200 reword Revert to Restore commit e784644daeac12bc6fa6844f24214a039266ae86 Merge: d07abfd 9978c96 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 15:00:11 2013 +0200 Merge branch 'new_versions_dropdown' of github.com:owncloud/core into new_versions_dropdown commit d07abfdbb49778a8be30b2a6adbe326e1b1f238f Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 14:59:17 2013 +0200 if another drop-down is already open, always close it first commit 9978c967a6ecbd2d0e5003df3cf4cdba09dab468 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:49:47 2013 +0200 more style improvements for versions commit a13355f16e6172c02069930a60a49aba4ebfa227 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:44:13 2013 +0200 position fixes for versioning commit 02c1d6b5eabc4075749c2a7a852c9ed7bbb3644d Merge: c5a9462 203f544 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:31:16 2013 +0200 merge versions style changes commit c5a946231a3d011748248db13b6b95ce51eb3e4c Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:29:56 2013 +0200 bigger clickable area for versions commit 203f544825bd49b168f2316cf2a04caca75438c8 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 14:15:38 2013 +0200 changes visual changes, as suggested by Jan commit 90b1e93676d235a61f318768661b25e5815a9784 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:12:23 2013 +0200 remove superfluous selector from ID commit 9768254fe3b2469293fca23151e54cde69bd4661 Merge: c961278 b91c682 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 12:28:06 2013 +0200 Merge branch 'master' into new_versions_dropdown commit c9612781e10a4de9e9405244f87c4e29428a0d3f Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 11:05:25 2013 +0200 replace modal dialog with a OC.Notification commit 3dc7508a4c271818247afbaed0ce0b03706a8db6 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 10:33:05 2013 +0200 use image path without extension for proper svg to png fallback commit 23ea7ad46c73fa4b86021070eb58a3b92bc8362e Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 17:53:58 2013 +0200 some css fixes commit 8d01499ae17e43a7d7960841a7c2127fa6de5a56 Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 17:40:16 2013 +0200 small fixes and improvements according to @Kondou-ger comments commit 985b6461e81035967959659fab8ea59c733e00eb Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 15:58:19 2013 +0200 replace == with === commit bc8fc3b4a664db2d819e0a7091f31207ffcfe44a Merge: c1da183 a94c55b Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 13:55:45 2013 +0200 Merge branch 'master' into new_versions_dropdown commit c1da183d13b8098eb33e708d4fdd04111bdc33a5 Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 13:53:37 2013 +0200 translate timestamps into strings like "X minutes ago" for the versions drop-down commit c78d2b4bfb0a6800ab8516ac115ba42268be019a Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 12:52:44 2013 +0200 download versions directly from the versions drop-down commit 14aaf9907625fc76bc153cd846704b7efd15db46 Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 11:01:21 2013 +0200 only show 'more versions' button of necessary commit a0d8cb46b2255be3d9b3f9bd5f835a173c9665b8 Author: Björn Schießle <schiessle@owncloud.com> Date: Mon Jul 22 17:49:17 2013 +0200 remove unneeded code commit 47eec0679ce16ece0b7890e9b41bf28d7613b131 Author: Björn Schießle <schiessle@owncloud.com> Date: Mon Jul 22 17:44:58 2013 +0200 add title for revert and download action commit df87ccb24327b5c2770f7c23c97e41b143d65ec3 Author: Björn Schießle <schiessle@owncloud.com> Date: Mon Jul 22 17:36:40 2013 +0200 add download button to versions drop-down commit 622c87ec37c14b7b3237bc9ca980b7f35689a933 Author: Björn Schießle <schiessle@owncloud.com> Date: Mon Jul 22 17:36:08 2013 +0200 adapt css file for the new versions drop-down commit 300699024fe74a9f0f998c1cce4024484311f50c Author: Björn Schießle <schiessle@owncloud.com> Date: Fri Jun 7 17:28:34 2013 +0200 revert on click commit 6673ae6ed45bbda1e0d962e9b32e943afc7123c0 Author: Björn Schießle <schiessle@owncloud.com> Date: Fri Jun 7 16:50:08 2013 +0200 new versions list, show the latest 5 with a button to retrieve more versions if needed
2013-07-25 12:35:19 +04:00
/**
* translate a timestamp into a string like "5 days ago"
new version drop down Squashed commit of the following: commit 0dc404a557fa8253e3a87c7babefba6de8e6dab5 Author: Björn Schießle <schiessle@owncloud.com> Date: Thu Jul 25 10:26:48 2013 +0200 fix 'more versions' button for IE8 commit 5836e652857204d68dfdfa8b3318de8e2fe02493 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 16:56:46 2013 +0200 clean-up some unused code commit ac83e53fa24073783a165796fc3016dc7beca293 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 16:49:03 2013 +0200 fix order of the versions, newest version should come first commit f150a88843af316ff505728941287406f25a0751 Merge: bc713c7 b8e399b Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 16:19:36 2013 +0200 Merge branch 'new_versions_dropdown' of github.com:owncloud/core into new_versions_dropdown commit bc713c7b0c3207d00d2f19b10a905a82724c0709 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 16:11:07 2013 +0200 fix position of more versions button commit b8e399b1754ae7656c3cb8cef2c53f6976a83d61 Merge: 24825b0 7b6e39d Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 16:04:08 2013 +0200 Merge branch 'new_versions_dropdown' of github.com:owncloud/core into new_versions_dropdown commit 24825b02004efa953197e72b470b9b033030aeee Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 16:02:53 2013 +0200 umark previous row if a new row gets selected commit 7b6e39d2939f1b3bba4fff37ca9087dbc7795f03 Merge: 5bfb0ac 7b54644 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 15:37:19 2013 +0200 Merge branch 'new_versions_dropdown' of github.com:owncloud/core into new_versions_dropdown commit 5bfb0ac5c102bdfd3b27a37cea8c792f69b3b803 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 15:37:09 2013 +0200 more style adjustments for version dropdown commit 7b54644d3036ffba448f0525ca09f6e8898b9950 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 15:12:53 2013 +0200 remove debug output commit a75662bcfdce34d4f14020a539172c7ef1b894d3 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 15:12:26 2013 +0200 reword Revert to Restore commit e784644daeac12bc6fa6844f24214a039266ae86 Merge: d07abfd 9978c96 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 15:00:11 2013 +0200 Merge branch 'new_versions_dropdown' of github.com:owncloud/core into new_versions_dropdown commit d07abfdbb49778a8be30b2a6adbe326e1b1f238f Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 14:59:17 2013 +0200 if another drop-down is already open, always close it first commit 9978c967a6ecbd2d0e5003df3cf4cdba09dab468 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:49:47 2013 +0200 more style improvements for versions commit a13355f16e6172c02069930a60a49aba4ebfa227 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:44:13 2013 +0200 position fixes for versioning commit 02c1d6b5eabc4075749c2a7a852c9ed7bbb3644d Merge: c5a9462 203f544 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:31:16 2013 +0200 merge versions style changes commit c5a946231a3d011748248db13b6b95ce51eb3e4c Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:29:56 2013 +0200 bigger clickable area for versions commit 203f544825bd49b168f2316cf2a04caca75438c8 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 14:15:38 2013 +0200 changes visual changes, as suggested by Jan commit 90b1e93676d235a61f318768661b25e5815a9784 Author: Jan-Christoph Borchardt <hey@jancborchardt.net> Date: Wed Jul 24 14:12:23 2013 +0200 remove superfluous selector from ID commit 9768254fe3b2469293fca23151e54cde69bd4661 Merge: c961278 b91c682 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 12:28:06 2013 +0200 Merge branch 'master' into new_versions_dropdown commit c9612781e10a4de9e9405244f87c4e29428a0d3f Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 11:05:25 2013 +0200 replace modal dialog with a OC.Notification commit 3dc7508a4c271818247afbaed0ce0b03706a8db6 Author: Björn Schießle <schiessle@owncloud.com> Date: Wed Jul 24 10:33:05 2013 +0200 use image path without extension for proper svg to png fallback commit 23ea7ad46c73fa4b86021070eb58a3b92bc8362e Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 17:53:58 2013 +0200 some css fixes commit 8d01499ae17e43a7d7960841a7c2127fa6de5a56 Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 17:40:16 2013 +0200 small fixes and improvements according to @Kondou-ger comments commit 985b6461e81035967959659fab8ea59c733e00eb Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 15:58:19 2013 +0200 replace == with === commit bc8fc3b4a664db2d819e0a7091f31207ffcfe44a Merge: c1da183 a94c55b Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 13:55:45 2013 +0200 Merge branch 'master' into new_versions_dropdown commit c1da183d13b8098eb33e708d4fdd04111bdc33a5 Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 13:53:37 2013 +0200 translate timestamps into strings like "X minutes ago" for the versions drop-down commit c78d2b4bfb0a6800ab8516ac115ba42268be019a Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 12:52:44 2013 +0200 download versions directly from the versions drop-down commit 14aaf9907625fc76bc153cd846704b7efd15db46 Author: Björn Schießle <schiessle@owncloud.com> Date: Tue Jul 23 11:01:21 2013 +0200 only show 'more versions' button of necessary commit a0d8cb46b2255be3d9b3f9bd5f835a173c9665b8 Author: Björn Schießle <schiessle@owncloud.com> Date: Mon Jul 22 17:49:17 2013 +0200 remove unneeded code commit 47eec0679ce16ece0b7890e9b41bf28d7613b131 Author: Björn Schießle <schiessle@owncloud.com> Date: Mon Jul 22 17:44:58 2013 +0200 add title for revert and download action commit df87ccb24327b5c2770f7c23c97e41b143d65ec3 Author: Björn Schießle <schiessle@owncloud.com> Date: Mon Jul 22 17:36:40 2013 +0200 add download button to versions drop-down commit 622c87ec37c14b7b3237bc9ca980b7f35689a933 Author: Björn Schießle <schiessle@owncloud.com> Date: Mon Jul 22 17:36:08 2013 +0200 adapt css file for the new versions drop-down commit 300699024fe74a9f0f998c1cce4024484311f50c Author: Björn Schießle <schiessle@owncloud.com> Date: Fri Jun 7 17:28:34 2013 +0200 revert on click commit 6673ae6ed45bbda1e0d962e9b32e943afc7123c0 Author: Björn Schießle <schiessle@owncloud.com> Date: Fri Jun 7 16:50:08 2013 +0200 new versions list, show the latest 5 with a button to retrieve more versions if needed
2013-07-25 12:35:19 +04:00
* @param int $timestamp
* @return string for example "5 days ago"
*/
private static function getHumanReadableTimestamp($timestamp) {
$diff = time() - $timestamp;
if ($diff < 60) { // first minute
return $diff . " seconds ago";
} elseif ($diff < 3600) { //first hour
return round($diff / 60) . " minutes ago";
} elseif ($diff < 86400) { // first day
return round($diff / 3600) . " hours ago";
} elseif ($diff < 604800) { //first week
return round($diff / 86400) . " days ago";
} elseif ($diff < 2419200) { //first month
return round($diff / 604800) . " weeks ago";
} elseif ($diff < 29030400) { // first year
return round($diff / 2419200) . " months ago";
} else {
return round($diff / 29030400) . " years ago";
}
}
/**
* returns all stored file versions from a given user
* @param string $uid id of the user
* @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
*/
private static function getAllVersions($uid) {
$view = new View('/' . $uid . '/');
$dirs = array(self::VERSIONS_ROOT);
2014-06-18 15:23:53 +04:00
$versions = array();
while (!empty($dirs)) {
$dir = array_pop($dirs);
$files = $view->getDirectoryContent($dir);
foreach ($files as $file) {
$fileData = $file->getData();
$filePath = $dir . '/' . $fileData['name'];
if ($file['type'] === 'dir') {
array_push($dirs, $filePath);
} else {
$versionsBegin = strrpos($filePath, '.v');
2013-10-11 12:34:34 +04:00
$relPathStart = strlen(self::VERSIONS_ROOT);
$version = substr($filePath, $versionsBegin + 2);
$relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
$key = $version . '#' . $relpath;
$versions[$key] = array('path' => $relpath, 'timestamp' => $version);
}
2013-01-15 17:57:23 +04:00
}
}
2013-02-22 20:21:57 +04:00
2014-01-22 14:13:15 +04:00
// newest version first
krsort($versions);
2013-02-22 20:21:57 +04:00
$result = array();
2013-02-22 20:21:57 +04:00
foreach ($versions as $key => $value) {
$size = $view->filesize(self::VERSIONS_ROOT.'/'.$value['path'].'.v'.$value['timestamp']);
$filename = $value['path'];
2013-02-22 20:21:57 +04:00
$result['all'][$key]['version'] = $value['timestamp'];
$result['all'][$key]['path'] = $filename;
$result['all'][$key]['size'] = $size;
2013-02-22 20:21:57 +04:00
$result['by_file'][$filename][$key]['version'] = $value['timestamp'];
$result['by_file'][$filename][$key]['path'] = $filename;
$result['by_file'][$filename][$key]['size'] = $size;
}
return $result;
}
/**
* get list of files we want to expire
* @param array $versions list of versions
* @param integer $time
2015-08-20 18:32:41 +03:00
* @param bool $quotaExceeded is versions storage limit reached
* @return array containing the list of to deleted versions and the size of them
*/
2015-08-19 00:00:18 +03:00
protected static function getExpireList($time, $versions, $quotaExceeded = false) {
2015-08-20 18:32:41 +03:00
$expiration = self::getExpiration();
2015-08-17 21:40:03 +03:00
if ($expiration->shouldAutoExpire()) {
2015-08-19 00:00:18 +03:00
list($toDelete, $size) = self::getAutoExpireList($time, $versions);
} else {
$size = 0;
$toDelete = []; // versions we want to delete
2015-08-17 21:40:03 +03:00
}
foreach ($versions as $key => $version) {
2015-08-19 00:00:18 +03:00
if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
2015-08-17 21:40:03 +03:00
$size += $version['size'];
2015-08-19 00:00:18 +03:00
$toDelete[$key] = $version['path'] . '.v' . $version['version'];
2015-08-17 21:40:03 +03:00
}
}
2015-08-19 00:00:18 +03:00
return [$toDelete, $size];
2015-08-17 21:40:03 +03:00
}
/**
* get list of files we want to expire
* @param array $versions list of versions
* @param integer $time
* @return array containing the list of to deleted versions and the size of them
*/
protected static function getAutoExpireList($time, $versions) {
$size = 0;
$toDelete = array(); // versions we want to delete
$interval = 1;
$step = Storage::$max_versions_per_interval[$interval]['step'];
if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] == -1) {
$nextInterval = -1;
} else {
$nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
}
$firstVersion = reset($versions);
$firstKey = key($versions);
$prevTimestamp = $firstVersion['version'];
$nextVersion = $firstVersion['version'] - $step;
unset($versions[$firstKey]);
foreach ($versions as $key => $version) {
$newInterval = true;
while ($newInterval) {
if ($nextInterval == -1 || $prevTimestamp > $nextInterval) {
if ($version['version'] > $nextVersion) {
//distance between two version too small, mark to delete
$toDelete[$key] = $version['path'] . '.v' . $version['version'];
$size += $version['size'];
\OCP\Util::writeLog('files_versions', 'Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, \OCP\Util::INFO);
} else {
$nextVersion = $version['version'] - $step;
$prevTimestamp = $version['version'];
}
$newInterval = false; // version checked so we can move to the next one
} else { // time to move on to the next interval
$interval++;
$step = Storage::$max_versions_per_interval[$interval]['step'];
$nextVersion = $prevTimestamp - $step;
if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] == -1) {
$nextInterval = -1;
} else {
$nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
}
$newInterval = true; // we changed the interval -> check same version with new interval
}
}
}
return array($toDelete, $size);
}
/**
* Schedule versions expiration for the given file
*
* @param string $uid owner of the file
* @param string $fileName file/folder for which to schedule expiration
*/
private static function scheduleExpire($uid, $fileName) {
2015-08-17 21:40:03 +03:00
// let the admin disable auto expire
2015-08-20 18:32:41 +03:00
$expiration = self::getExpiration();
2015-08-17 21:40:03 +03:00
if ($expiration->isEnabled()) {
$command = new Expire($uid, $fileName);
2015-08-17 21:40:03 +03:00
\OC::$server->getCommandBus()->push($command);
}
}
/**
* Expire versions which exceed the quota
*
* @param string $filename
* @return bool|int|null
*/
public static function expire($filename) {
$config = \OC::$server->getConfig();
2015-08-20 18:32:41 +03:00
$expiration = self::getExpiration();
2016-06-30 11:29:32 +03:00
2015-08-17 21:40:03 +03:00
if($config->getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true' && $expiration->isEnabled()) {
if (!Filesystem::file_exists($filename)) {
return false;
}
2013-02-22 20:21:57 +04:00
list($uid, $filename) = self::getUidAndFilename($filename);
if (empty($filename)) {
// file maybe renamed or deleted
return false;
}
$versionsFileview = new View('/'.$uid.'/files_versions');
2013-02-22 20:21:57 +04:00
// get available disk space for user
$user = \OC::$server->getUserManager()->get($uid);
$softQuota = true;
$quota = $user->getQuota();
2013-03-04 15:33:16 +04:00
if ( $quota === null || $quota === 'none' ) {
$quota = Filesystem::free_space('/');
$softQuota = false;
2013-02-25 19:12:44 +04:00
} else {
$quota = \OCP\Util::computerFileSize($quota);
2012-12-13 19:34:54 +04:00
}
// make sure that we have the current size of the version history
$versionsSize = self::getVersionsSize($uid);
2013-01-15 17:57:23 +04:00
// calculate available space for version history
// subtract size of files and current versions size from quota
if ($quota >= 0) {
if ($softQuota) {
$files_view = new View('/' . $uid . '/files');
$rootInfo = $files_view->getFileInfo('/', false);
$free = $quota - $rootInfo['size']; // remaining free space for user
if ($free > 0) {
$availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $versionsSize; // how much space can be used for versions
} else {
$availableSpace = $free - $versionsSize;
}
} else {
$availableSpace = $quota;
}
} else {
$availableSpace = PHP_INT_MAX;
2013-02-22 20:21:57 +04:00
}
$allVersions = Storage::getVersions($uid, $filename);
2013-02-22 20:21:57 +04:00
$time = time();
2015-08-19 00:00:18 +03:00
list($toDelete, $sizeOfDeletedVersions) = self::getExpireList($time, $allVersions, $availableSpace <= 0);
$availableSpace = $availableSpace + $sizeOfDeletedVersions;
$versionsSize = $versionsSize - $sizeOfDeletedVersions;
2013-02-22 20:21:57 +04:00
// if still not enough free space we rearrange the versions from all files
if ($availableSpace <= 0) {
$result = Storage::getAllVersions($uid);
$allVersions = $result['all'];
2013-02-22 20:21:57 +04:00
foreach ($result['by_file'] as $versions) {
2015-08-19 00:00:18 +03:00
list($toDeleteNew, $size) = self::getExpireList($time, $versions, $availableSpace <= 0);
$toDelete = array_merge($toDelete, $toDeleteNew);
$sizeOfDeletedVersions += $size;
}
$availableSpace = $availableSpace + $sizeOfDeletedVersions;
$versionsSize = $versionsSize - $sizeOfDeletedVersions;
}
2013-02-22 20:21:57 +04:00
foreach($toDelete as $key => $path) {
\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
2014-07-10 17:19:40 +04:00
self::deleteVersion($versionsFileview, $path);
\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
unset($allVersions[$key]); // update array with the versions we keep
\OCP\Util::writeLog('files_versions', "Expire: " . $path, \OCP\Util::INFO);
}
2013-03-04 20:20:14 +04:00
// Check if enough space is available after versions are rearranged.
// If not we delete the oldest versions until we meet the size limit for versions,
// but always keep the two latest versions
$numOfVersions = count($allVersions) -2 ;
2013-02-22 20:21:57 +04:00
$i = 0;
// sort oldest first and make sure that we start at the first element
ksort($allVersions);
reset($allVersions);
2013-03-04 20:20:14 +04:00
while ($availableSpace < 0 && $i < $numOfVersions) {
$version = current($allVersions);
\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
2014-07-10 17:19:40 +04:00
self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
\OCP\Util::writeLog('files_versions', 'running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'] , \OCP\Util::INFO);
$versionsSize -= $version['size'];
$availableSpace += $version['size'];
next($allVersions);
$i++;
}
2013-02-22 20:21:57 +04:00
return $versionsSize; // finally return the new size of the version history
}
2013-02-22 20:21:57 +04:00
2013-01-11 14:12:32 +04:00
return false;
}
/**
* Create recursively missing directories inside of files_versions
* that match the given path to a file.
*
* @param string $filename $path to a file, relative to the user's
* "files" folder
* @param View $view view on data/user/
*/
private static function createMissingDirectories($filename, $view) {
$dirname = Filesystem::normalizePath(dirname($filename));
$dirParts = explode('/', $dirname);
$dir = "/files_versions";
foreach ($dirParts as $part) {
$dir = $dir . '/' . $part;
if (!$view->file_exists($dir)) {
$view->mkdir($dir);
}
}
}
2015-08-20 18:32:41 +03:00
/**
* Static workaround
* @return Expiration
*/
protected static function getExpiration(){
2015-09-09 18:37:33 +03:00
if (is_null(self::$application)) {
self::$application = new Application();
}
return self::$application->getContainer()->query('Expiration');
2015-08-20 18:32:41 +03:00
}
}