2012-11-04 21:42:18 +04:00
|
|
|
|
<?php
|
|
|
|
|
/**
|
|
|
|
|
* Copyright (c) 2012 Frank Karlitschek <frank@owncloud.org>
|
|
|
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
|
|
|
* later.
|
|
|
|
|
* See the COPYING-README file.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Versions
|
|
|
|
|
*
|
|
|
|
|
* A class to handle the versioning of files.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
namespace OCA_Versions;
|
|
|
|
|
|
|
|
|
|
class Storage {
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// config.php configuration:
|
|
|
|
|
// - files_versions
|
|
|
|
|
// - files_versionsfolder
|
|
|
|
|
// - files_versionsmaxfilesize
|
|
|
|
|
//
|
|
|
|
|
// todo:
|
|
|
|
|
// - finish porting to OC_FilesystemView to enable network transparency
|
|
|
|
|
// - add transparent compression. first test if it´s worth it.
|
|
|
|
|
|
|
|
|
|
const DEFAULTENABLED=true;
|
2012-12-13 19:34:54 +04:00
|
|
|
|
const DEFAULTMAXFILESIZE=10485760; // 10MB
|
2012-11-04 21:42:18 +04:00
|
|
|
|
const DEFAULTMAXVERSIONS=50;
|
2012-12-17 16:28:40 +04:00
|
|
|
|
|
|
|
|
|
var $MAX_VERSIONS_PER_INTERVAL = array(1 => array('intervalEndsAfter' => 3600, //first hour, one version every 10sec
|
|
|
|
|
'step' => 10),
|
|
|
|
|
2 => array('intervalEndsAfter' => 86400, //next 24h, one version every hour
|
|
|
|
|
'step' => 3600),
|
|
|
|
|
3 => array('intervalEndsAfter' => -1, //until the end one version per day
|
|
|
|
|
'step' => 86400),
|
|
|
|
|
);
|
2012-11-04 21:42:18 +04:00
|
|
|
|
|
|
|
|
|
private static function getUidAndFilename($filename)
|
|
|
|
|
{
|
|
|
|
|
if (\OCP\App::isEnabled('files_sharing')
|
|
|
|
|
&& substr($filename, 0, 7) == '/Shared'
|
|
|
|
|
&& $source = \OCP\Share::getItemSharedWith('file',
|
|
|
|
|
substr($filename, 7),
|
|
|
|
|
\OC_Share_Backend_File::FORMAT_SHARED_STORAGE)) {
|
|
|
|
|
$filename = $source['path'];
|
|
|
|
|
$pos = strpos($filename, '/files', 1);
|
|
|
|
|
$uid = substr($filename, 1, $pos - 1);
|
|
|
|
|
$filename = substr($filename, $pos + 6);
|
|
|
|
|
} else {
|
|
|
|
|
$uid = \OCP\User::getUser();
|
|
|
|
|
}
|
|
|
|
|
return array($uid, $filename);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* store a new version of a file.
|
|
|
|
|
*/
|
|
|
|
|
public function store($filename) {
|
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
|
|
|
|
list($uid, $filename) = self::getUidAndFilename($filename);
|
2012-11-30 16:04:15 +04:00
|
|
|
|
$files_view = new \OC_FilesystemView('/'.$uid .'/files');
|
|
|
|
|
$users_view = new \OC_FilesystemView('/'.$uid);
|
2012-11-04 21:42:18 +04:00
|
|
|
|
|
|
|
|
|
//check if source file already exist as version to avoid recursions.
|
|
|
|
|
// todo does this check work?
|
|
|
|
|
if ($users_view->file_exists($filename)) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// check if filename is a directory
|
|
|
|
|
if($files_view->is_dir($filename)) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// we should have a source file to work with
|
|
|
|
|
if (!$files_view->file_exists($filename)) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// check filesize
|
|
|
|
|
if($files_view->filesize($filename)>\OCP\Config::getSystemValue('files_versionsmaxfilesize', Storage::DEFAULTMAXFILESIZE)) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// check mininterval if the file is being modified by the owner (all shared files should be versioned despite mininterval)
|
|
|
|
|
if ($uid == \OCP\User::getUser()) {
|
2012-12-02 15:50:07 +04:00
|
|
|
|
$versions_fileview = new \OC_FilesystemView('/'.$uid.'/files_versions');
|
2012-11-04 21:42:18 +04:00
|
|
|
|
$versionsName=\OCP\Config::getSystemValue('datadirectory').$versions_fileview->getAbsolutePath($filename);
|
|
|
|
|
$versionsFolderName=\OCP\Config::getSystemValue('datadirectory').$versions_fileview->getAbsolutePath('');
|
|
|
|
|
$matches=glob($versionsName.'.v*');
|
|
|
|
|
sort($matches);
|
|
|
|
|
$parts=explode('.v', end($matches));
|
2012-12-17 16:28:40 +04:00
|
|
|
|
if((end($parts)+Storage::$MAX_VERSIONS_PER_INTERVAL[1]['step'])>time()) {
|
2012-11-04 21:42:18 +04:00
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// create all parent folders
|
|
|
|
|
$info=pathinfo($filename);
|
|
|
|
|
if(!file_exists($versionsFolderName.'/'.$info['dirname'])) {
|
|
|
|
|
mkdir($versionsFolderName.'/'.$info['dirname'], 0750, true);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// store a new version of a file
|
|
|
|
|
$users_view->copy('files'.$filename, 'files_versions'.$filename.'.v'.time());
|
|
|
|
|
|
|
|
|
|
// expire old revisions if necessary
|
|
|
|
|
Storage::expire($filename);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* rollback to an old version of a file.
|
|
|
|
|
*/
|
|
|
|
|
public static function rollback($filename, $revision) {
|
|
|
|
|
|
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
|
|
|
|
list($uid, $filename) = self::getUidAndFilename($filename);
|
2012-11-30 16:04:15 +04:00
|
|
|
|
$users_view = new \OC_FilesystemView('/'.$uid);
|
2012-11-04 21:42:18 +04:00
|
|
|
|
|
|
|
|
|
// rollback
|
|
|
|
|
if( @$users_view->copy('files_versions'.$filename.'.v'.$revision, 'files'.$filename) ) {
|
|
|
|
|
|
|
|
|
|
return true;
|
|
|
|
|
|
|
|
|
|
}else{
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* check if old versions of a file exist.
|
|
|
|
|
*/
|
|
|
|
|
public static function isversioned($filename) {
|
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
|
|
|
|
list($uid, $filename) = self::getUidAndFilename($filename);
|
2012-11-30 16:04:15 +04:00
|
|
|
|
$versions_fileview = new \OC_FilesystemView('/'.$uid.'/files_versions');
|
2012-11-04 21:42:18 +04:00
|
|
|
|
|
|
|
|
|
$versionsName=\OCP\Config::getSystemValue('datadirectory').$versions_fileview->getAbsolutePath($filename);
|
|
|
|
|
|
|
|
|
|
// check for old versions
|
|
|
|
|
$matches=glob($versionsName.'.v*');
|
|
|
|
|
if(count($matches)>0) {
|
|
|
|
|
return true;
|
|
|
|
|
}else{
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}else{
|
|
|
|
|
return(false);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief get a list of all available versions of a file in descending chronological order
|
|
|
|
|
* @param $filename file to find versions of, relative to the user files dir
|
|
|
|
|
* @param $count number of versions to return
|
|
|
|
|
* @returns array
|
|
|
|
|
*/
|
|
|
|
|
public static function getVersions( $filename, $count = 0 ) {
|
|
|
|
|
if( \OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true' ) {
|
|
|
|
|
list($uid, $filename) = self::getUidAndFilename($filename);
|
2012-11-30 16:04:15 +04:00
|
|
|
|
$versions_fileview = new \OC_FilesystemView('/'.$uid.'/files_versions');
|
2012-11-04 21:42:18 +04:00
|
|
|
|
|
|
|
|
|
$versionsName = \OCP\Config::getSystemValue('datadirectory').$versions_fileview->getAbsolutePath($filename);
|
|
|
|
|
$versions = array();
|
|
|
|
|
// fetch for old versions
|
|
|
|
|
$matches = glob( $versionsName.'.v*' );
|
|
|
|
|
|
|
|
|
|
sort( $matches );
|
|
|
|
|
|
|
|
|
|
$i = 0;
|
|
|
|
|
|
2012-12-13 20:02:21 +04:00
|
|
|
|
$files_view = new \OC_FilesystemView('/'.$uid.'/files');
|
2012-11-04 21:42:18 +04:00
|
|
|
|
$local_file = $files_view->getLocalFile($filename);
|
2012-12-13 20:02:21 +04:00
|
|
|
|
$versions_fileview = \OCP\Files::getStorage('files_versions');
|
|
|
|
|
|
2012-11-04 21:42:18 +04:00
|
|
|
|
foreach( $matches as $ma ) {
|
|
|
|
|
|
|
|
|
|
$i++;
|
|
|
|
|
$versions[$i]['cur'] = 0;
|
|
|
|
|
$parts = explode( '.v', $ma );
|
2012-12-13 20:02:21 +04:00
|
|
|
|
$versions[$i]['version'] = ( end( $parts ) );
|
|
|
|
|
$versions[$i]['size'] = $versions_fileview->filesize($filename.'.v'.$versions[$i]['version']);
|
2012-11-04 21:42:18 +04:00
|
|
|
|
|
|
|
|
|
// if file with modified date exists, flag it in array as currently enabled version
|
|
|
|
|
( \md5_file( $ma ) == \md5_file( $local_file ) ? $versions[$i]['fileMatch'] = 1 : $versions[$i]['fileMatch'] = 0 );
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$versions = array_reverse( $versions );
|
|
|
|
|
|
|
|
|
|
foreach( $versions as $key => $value ) {
|
|
|
|
|
|
|
|
|
|
// flag the first matched file in array (which will have latest modification date) as current version
|
|
|
|
|
if ( $value['fileMatch'] ) {
|
|
|
|
|
|
|
|
|
|
$value['cur'] = 1;
|
|
|
|
|
break;
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$versions = array_reverse( $versions );
|
|
|
|
|
|
|
|
|
|
// only show the newest commits
|
|
|
|
|
if( $count != 0 and ( count( $versions )>$count ) ) {
|
|
|
|
|
|
|
|
|
|
$versions = array_slice( $versions, count( $versions ) - $count );
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return( $versions );
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
|
|
|
|
|
// if versioning isn't enabled then return an empty array
|
|
|
|
|
return( array() );
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief Erase a file's versions which exceed the set quota
|
|
|
|
|
*/
|
|
|
|
|
public static function expire($filename) {
|
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
|
|
|
|
list($uid, $filename) = self::getUidAndFilename($filename);
|
|
|
|
|
$versions_fileview = new \OC_FilesystemView('/'.$uid.'/files_versions');
|
2012-12-17 16:28:40 +04:00
|
|
|
|
|
|
|
|
|
// get available disk space for user
|
2012-12-13 19:34:54 +04:00
|
|
|
|
$quota = \OCP\Util::computerFileSize(\OC_Preferences::getValue($uid, 'files', 'quota'));
|
|
|
|
|
if ( $quota == null ) {
|
|
|
|
|
$quota = \OCP\Util::computerFileSize(\OC_Appconfig::getValue('files', 'default_quota'));
|
2012-12-17 16:28:40 +04:00
|
|
|
|
}
|
|
|
|
|
if ( $quota == null ) {
|
2012-12-13 19:34:54 +04:00
|
|
|
|
$quota = \OC_Filesystem::free_space('/');
|
|
|
|
|
}
|
|
|
|
|
|
2012-12-13 20:02:21 +04:00
|
|
|
|
$rootInfo = \OC_FileCache::get('', '/'. $uid . '/files');
|
2012-12-17 16:28:40 +04:00
|
|
|
|
$free = $quota-$rootInfo['size']; // remaining free space for user
|
|
|
|
|
|
2012-12-13 19:34:54 +04:00
|
|
|
|
if ( $free > 0 ) {
|
|
|
|
|
$availableSpace = 5000 / ($quota-$rootInfo['size']); // 50% of free space can be used for versions
|
2012-12-17 16:28:40 +04:00
|
|
|
|
} // otherwise available space negative and we need to reach at least 0 at the end of the expiration process;
|
|
|
|
|
|
|
|
|
|
$versions = Storage::getVersions($filename);
|
|
|
|
|
$versions = array_reverse($versions); // newest version first
|
|
|
|
|
|
|
|
|
|
$time = time();
|
|
|
|
|
$numOfVersions = count($versions);
|
|
|
|
|
|
|
|
|
|
$interval = 1;
|
|
|
|
|
$step = Storage::$MAX_VERSIONS_PER_INTERVAL[$interval]['step'];
|
|
|
|
|
if (Storage::$MAX_VERSIONS_PER_INTERVAL[$interval]['intervalEndsAfter'] == -1) {
|
|
|
|
|
$nextInterval = -1;
|
2012-12-13 19:34:54 +04:00
|
|
|
|
} else {
|
2012-12-17 16:28:40 +04:00
|
|
|
|
$nextInterval = $time - Storage::$MAX_VERSIONS_PER_INTERVAL[$interval]['intervalEndsAfter'];
|
2012-12-13 19:34:54 +04:00
|
|
|
|
}
|
2012-12-17 16:28:40 +04:00
|
|
|
|
|
|
|
|
|
$nextVersion = $versions[0]['versions'] - $step;
|
2012-12-13 19:34:54 +04:00
|
|
|
|
|
2012-12-17 16:28:40 +04:00
|
|
|
|
for ($i=1; $i<$numOfVersions; $i++) {
|
|
|
|
|
if ( $nextInterval == -1 || $versions[$i]['version'] >= $nextInterval ) {
|
|
|
|
|
if ( $versions[$i]['version'] > $nextVersion ) {
|
|
|
|
|
//distance between two version to small, delete version (TODO)
|
|
|
|
|
$availableSpace += $versions[$i]['size'];
|
|
|
|
|
} else {
|
|
|
|
|
$nextVersion = $versions[$i]['version'] - $step;
|
|
|
|
|
}
|
|
|
|
|
} else { // time to move on to the next interval
|
|
|
|
|
$interval++;
|
|
|
|
|
$step = Storage::$MAX_VERSIONS_PER_INTERVAL[$interval]['step'];
|
|
|
|
|
$nextVersion = $version[$i]['version'] - $step;
|
|
|
|
|
if ( Storage::$MAX_VERSIONS_PER_INTERVAL[$interval]['intervalEndsAfter'] == -1 ) {
|
|
|
|
|
$nextInterval = -1;
|
|
|
|
|
} else {
|
|
|
|
|
$nextInterval = $time - Storage::$MAX_VERSIONS_PER_INTERVAL[$interval]['intervalEndsAfter'];
|
|
|
|
|
}
|
2012-11-04 21:42:18 +04:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief Erase all old versions of all user files
|
|
|
|
|
* @return true/false
|
|
|
|
|
*/
|
|
|
|
|
public function expireAll() {
|
|
|
|
|
$view = \OCP\Files::getStorage('files_versions');
|
|
|
|
|
return $view->deleteAll('', true);
|
|
|
|
|
}
|
2012-10-27 19:05:00 +04:00
|
|
|
|
}
|