2012-09-07 16:09:41 +04:00
< ? php
/**
2015-03-26 13:44:34 +03:00
* @ author Bart Visscher < bartv @ thisnet . nl >
* @ author Björn Schießle < schiessle @ owncloud . com >
* @ author Felix Moeller < mail @ felixmoeller . de >
* @ author Florin Peter < github @ florin - peter . de >
* @ author Georg Ehrke < georg @ owncloud . com >
2015-06-25 12:43:55 +03:00
* @ author Joas Schilling < nickvergessen @ owncloud . com >
2015-03-26 13:44:34 +03:00
* @ author Jörn Friedrich Dreyer < jfd @ butonic . de >
* @ author Lukas Reschke < lukas @ owncloud . com >
* @ author Morris Jobke < hey @ morrisjobke . de >
* @ author Robin Appelman < icewind @ owncloud . com >
* @ author Robin McCorkell < rmccorkell @ karoshi . org . uk >
* @ author Scrutinizer Auto - Fixer < auto - fixer @ scrutinizer - ci . com >
* @ author Thomas Müller < thomas . mueller @ tmit . eu >
* @ author Vincent Petry < pvince81 @ 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 />
*
2015-02-26 13:37:37 +03:00
*/
/**
* Versions
2012-09-07 16:09:41 +04:00
*
2015-02-26 13:37:37 +03:00
* A class to handle the versioning of files .
2012-09-07 16:09:41 +04:00
*/
2015-02-26 13:37:37 +03:00
2012-09-19 22:59:57 +04:00
namespace OCA\Files_Versions ;
2012-09-07 16:09:41 +04:00
2015-08-17 21:40:03 +03:00
use OCA\Files_Versions\AppInfo\Application ;
2015-03-23 15:07:40 +03:00
use OCA\Files_Versions\Command\Expire ;
2012-09-07 16:09:41 +04:00
class Storage {
const DEFAULTENABLED = true ;
2012-12-18 15:57:28 +04:00
const DEFAULTMAXSIZE = 50 ; // unit: percentage; 50% of available disk space/quota
2013-10-10 22:09:38 +04:00
const VERSIONS_ROOT = 'files_versions/' ;
2013-02-22 20:21:57 +04:00
2013-11-28 16:17:19 +04:00
// files for which we can remove the versions after the delete operation was successful
private static $deletedFiles = array ();
2014-10-28 17:57:08 +03:00
private static $sourcePathAndUser = array ();
2013-01-11 17:23:28 +04:00
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 ),
);
2012-09-07 16:09:41 +04:00
2013-02-21 17:40:16 +04:00
public static function getUidAndFilename ( $filename ) {
2013-02-18 14:19:40 +04:00
$uid = \OC\Files\Filesystem :: getOwner ( $filename );
2013-02-22 16:15:47 +04:00
\OC\Files\Filesystem :: initMountPoints ( $uid );
2013-02-18 14:19:40 +04:00
if ( $uid != \OCP\User :: getUser () ) {
$info = \OC\Files\Filesystem :: getFileInfo ( $filename );
$ownerView = new \OC\Files\View ( '/' . $uid . '/files' );
$filename = $ownerView -> getPath ( $info [ 'fileid' ]);
2012-09-07 16:09:41 +04:00
}
2012-09-19 22:54:03 +04:00
return array ( $uid , $filename );
2012-09-07 16:09:41 +04:00
}
2013-02-22 20:21:57 +04:00
2014-10-28 17:57:08 +03:00
/**
2014-10-29 01:32:57 +03:00
* Remember the owner and the owner path of the source file
2014-10-28 17:57:08 +03:00
*
* @ 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
2014-10-28 17:57:08 +03:00
*
* @ 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
2013-08-17 13:57:50 +04:00
*
2014-05-13 15:29:25 +04:00
* @ param string $user user who owns the versions
2014-05-06 15:55:26 +04:00
* @ return int versions size
2013-02-21 15:20:29 +04:00
*/
private static function getVersionsSize ( $user ) {
2014-05-06 15:55:26 +04:00
$view = new \OC\Files\View ( '/' . $user );
$fileInfo = $view -> getFileInfo ( '/files_versions' );
return isset ( $fileInfo [ 'size' ]) ? $fileInfo [ 'size' ] : 0 ;
2013-02-21 15:20:29 +04:00
}
2013-08-17 13:57:50 +04:00
2012-09-07 16:09:41 +04:00
/**
* store a new version of a file .
*/
2013-02-14 17:26:49 +04:00
public static function store ( $filename ) {
2012-09-07 16:09:41 +04:00
if ( \OCP\Config :: getSystemValue ( 'files_versions' , Storage :: DEFAULTENABLED ) == 'true' ) {
2013-08-17 13:57:50 +04:00
2013-03-08 14:27:25 +04:00
// 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 );
}
2013-08-17 13:57:50 +04:00
2012-09-19 22:54:03 +04:00
list ( $uid , $filename ) = self :: getUidAndFilename ( $filename );
2013-02-22 20:21:57 +04:00
2013-02-14 14:56:41 +04:00
$files_view = new \OC\Files\View ( '/' . $uid . '/files' );
$users_view = new \OC\Files\View ( '/' . $uid );
2012-09-07 16:09:41 +04:00
// check if filename is a directory
2012-09-07 17:22:01 +04:00
if ( $files_view -> is_dir ( $filename )) {
2012-09-07 16:09:41 +04:00
return false ;
}
2013-07-30 18:01:27 +04:00
// we should have a source file to work with, and the file shouldn't
// be empty
$fileExists = $files_view -> file_exists ( $filename );
2013-08-17 13:57:50 +04:00
if ( ! ( $fileExists && $files_view -> filesize ( $filename ) > 0 )) {
2012-09-17 19:29:34 +04:00
return false ;
}
2012-09-07 16:09:41 +04:00
// create all parent folders
2013-08-17 15:28:35 +04:00
self :: createMissingDirectories ( $filename , $users_view );
2012-09-07 16:09:41 +04:00
2013-06-25 11:39:01 +04:00
$versionsSize = self :: getVersionsSize ( $uid );
2013-06-27 12:49:13 +04:00
// assumption: we need filesize($filename) for the new version +
2013-06-25 11:39:01 +04:00
// some more free space for the modified file which might be
// 1.5 times as large as the current version -> 2.5
$neededSpace = $files_view -> filesize ( $filename ) * 2.5 ;
2015-05-13 19:40:35 +03:00
self :: scheduleExpire ( $uid , $filename , $versionsSize , $neededSpace );
2013-06-25 11:39:01 +04:00
2012-09-07 16:09:41 +04:00
// store a new version of a file
2015-01-08 22:57:49 +03:00
$mtime = $users_view -> filemtime ( 'files/' . $filename );
$users_view -> copy ( 'files/' . $filename , 'files_versions/' . $filename . '.v' . $mtime );
2014-01-15 14:37:47 +04:00
// call getFileInfo to enforce a file cache entry for the new version
2015-01-08 22:57:49 +03:00
$users_view -> getFileInfo ( 'files_versions/' . $filename . '.v' . $mtime );
2012-09-07 16:09:41 +04:00
}
}
2013-01-10 21:04:30 +04:00
/**
2014-05-19 19:50:53 +04:00
* mark file as deleted so that we can remove the versions if the file is gone
2013-11-28 16:17:19 +04:00
* @ param string $path
2013-01-10 21:04:30 +04:00
*/
2013-11-28 16:17:19 +04:00
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 \OC\Files\View $view
* @ 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 );
}
2013-11-28 16:17:19 +04:00
/**
* Delete versions of a file
*/
public static function delete ( $path ) {
$deletedFile = self :: $deletedFiles [ $path ];
$uid = $deletedFile [ 'uid' ];
$filename = $deletedFile [ 'filename' ];
if ( ! \OC\Files\Filesystem :: file_exists ( $path )) {
2014-07-04 19:57:43 +04:00
$view = new \OC\Files\View ( '/' . $uid . '/files_versions' );
2013-11-28 16:17:19 +04:00
2013-11-28 22:31:35 +04:00
$versions = self :: getVersions ( $uid , $filename );
if ( ! empty ( $versions )) {
2013-11-28 16:17:19 +04:00
foreach ( $versions as $v ) {
2014-07-04 19:57:43 +04:00
\OC_Hook :: emit ( '\OCP\Versions' , 'preDelete' , array ( 'path' => $path . $v [ 'version' ]));
2014-07-10 17:19:40 +04:00
self :: deleteVersion ( $view , $filename . '.v' . $v [ 'version' ]);
2014-07-04 19:57:43 +04:00
\OC_Hook :: emit ( '\OCP\Versions' , 'delete' , array ( 'path' => $path . $v [ 'version' ]));
2013-11-28 16:17:19 +04:00
}
2013-01-15 17:57:23 +04:00
}
2013-01-10 21:04:30 +04:00
}
2013-11-28 16:17:19 +04:00
unset ( self :: $deletedFiles [ $path ]);
2013-01-10 21:04:30 +04:00
}
2013-02-22 20:21:57 +04:00
2013-01-15 17:57:23 +04:00
/**
2015-04-27 13:51:17 +03: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
2014-07-24 17:30:00 +04:00
* @ param string $operation can be 'copy' or 'rename'
2013-01-15 17:57:23 +04:00
*/
2015-04-27 13:51:17 +03:00
public static function renameOrCopy ( $sourcePath , $targetPath , $operation ) {
list ( $sourceOwner , $sourcePath ) = self :: getSourcePathAndUser ( $sourcePath );
2014-10-28 17:57:08 +03:00
// 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
2015-04-27 13:51:17 +03:00
if ( $sourcePath === false ) {
2014-10-28 17:57:08 +03:00
return true ;
}
2015-04-27 13:51:17 +03:00
list ( $targetOwner , $targetPath ) = self :: getUidAndFilename ( $targetPath );
$sourcePath = ltrim ( $sourcePath , '/' );
$targetPath = ltrim ( $targetPath , '/' );
2013-08-17 13:57:50 +04:00
2015-04-27 13:51:17 +03:00
$rootView = new \OC\Files\View ( '' );
2014-10-28 17:57:08 +03:00
2015-04-27 13:51:17 +03:00
// 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 \OC\Files\View ( '/' . $targetOwner ));
2013-06-25 11:39:01 +04:00
2015-04-27 13:51:17 +03:00
// move the directory containing the versions
$rootView -> $operation (
'/' . $sourceOwner . '/files_versions/' . $sourcePath ,
'/' . $targetOwner . '/files_versions/' . $targetPath
);
}
} else if ( $versions = Storage :: getVersions ( $sourceOwner , '/' . $sourcePath )) {
2013-08-14 22:51:36 +04:00
// create missing dirs if necessary
2015-04-27 13:51:17 +03:00
self :: createMissingDirectories ( $targetPath , new \OC\Files\View ( '/' . $targetOwner ));
2013-08-17 15:46:33 +04:00
2013-01-11 17:23:28 +04:00
foreach ( $versions as $v ) {
2015-04-27 13:51:17 +03:00
// 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
}
}
2014-07-24 20:54:12 +04:00
2015-04-27 13:51:17 +03:00
// if we moved versions directly for a file, schedule expiration check for that file
if ( ! $rootView -> is_dir ( '/' . $targetOwner . '/files/' . $targetPath )) {
2015-05-13 19:40:35 +03:00
self :: scheduleExpire ( $targetOwner , $targetPath );
2014-07-24 20:54:12 +04:00
}
2013-01-11 17:23:28 +04:00
}
2013-02-22 20:21:57 +04:00
2012-09-07 16:09:41 +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
2012-09-07 16:09:41 +04:00
*/
2013-05-08 17:05:03 +04:00
public static function rollback ( $file , $revision ) {
2012-09-07 16:09:41 +04:00
if ( \OCP\Config :: getSystemValue ( 'files_versions' , Storage :: DEFAULTENABLED ) == 'true' ) {
2015-04-08 18:56:20 +03:00
// add expected leading slash
$file = '/' . ltrim ( $file , '/' );
2013-05-08 17:05:03 +04:00
list ( $uid , $filename ) = self :: getUidAndFilename ( $file );
2013-01-16 22:04:50 +04:00
$users_view = new \OC\Files\View ( '/' . $uid );
2013-05-08 17:05:03 +04:00
$files_view = new \OC\Files\View ( '/' . \OCP\User :: getUser () . '/files' );
2013-01-16 13:18:40 +04:00
$versionCreated = false ;
2013-02-22 20:21:57 +04:00
2012-12-17 21:00:11 +04:00
//first create a new version
2013-01-11 17:23:28 +04:00
$version = 'files_versions' . $filename . '.v' . $users_view -> filemtime ( 'files' . $filename );
if ( ! $users_view -> file_exists ( $version )) {
2013-05-31 00:05:52 +04:00
2012-12-17 21:00:11 +04:00
$users_view -> copy ( 'files' . $filename , 'files_versions' . $filename . '.v' . $users_view -> filemtime ( 'files' . $filename ));
2013-05-31 00:05:52 +04:00
2013-01-11 17:23:28 +04:00
$versionCreated = true ;
2012-12-17 21:00:11 +04:00
}
2013-02-22 20:21:57 +04:00
2012-09-07 16:09:41 +04:00
// rollback
2015-04-08 18:56:20 +03:00
if ( self :: copyFileContents ( $users_view , 'files_versions' . $filename . '.v' . $revision , 'files' . $filename )) {
2013-05-08 17:05:03 +04:00
$files_view -> touch ( $file , $revision );
2015-05-13 19:40:35 +03:00
Storage :: scheduleExpire ( $uid , $file );
2012-09-07 16:09:41 +04:00
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 );
2012-09-07 16:09:41 +04:00
}
}
2013-01-11 17:23:28 +04:00
return false ;
2012-09-07 16:09:41 +04:00
}
2015-04-08 18:56:20 +03:00
/**
* Stream copy file contents from $path1 to $path2
*
* @ param \OC\Files\View $view view to use for copying
* @ 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 ) {
list ( $storage1 , $internalPath1 ) = $view -> resolvePath ( $path1 );
list ( $storage2 , $internalPath2 ) = $view -> resolvePath ( $path2 );
2015-04-30 17:14:29 +03:00
$result = $storage2 -> moveFromStorage ( $storage1 , $internalPath1 , $internalPath2 );
2015-04-08 18:56:20 +03:00
return ( $result !== false );
}
2012-09-07 16:09:41 +04:00
/**
2014-05-19 19:50:53 +04:00
* get a list of all available versions of a file in descending chronological order
2014-01-21 16:50:56 +04:00
* @ 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
2012-09-07 16:09:41 +04:00
*/
2014-01-21 16:50:56 +04:00
public static function getVersions ( $uid , $filename , $userFullPath = '' ) {
2013-10-10 16:43:40 +04:00
$versions = array ();
2015-05-29 14:15:12 +03:00
if ( empty ( $filename )) {
2015-05-07 15:31:21 +03:00
return $versions ;
}
2013-10-10 16:43:40 +04:00
// fetch for old versions
2014-07-24 20:54:12 +04:00
$view = new \OC\Files\View ( '/' . $uid . '/' );
2013-10-10 16:43:40 +04:00
2013-10-10 22:06:42 +04:00
$pathinfo = pathinfo ( $filename );
2014-07-24 20:54:12 +04:00
$versionedFile = $pathinfo [ 'basename' ];
2013-10-10 22:06:42 +04:00
2014-08-05 19:25:55 +04:00
$dir = \OC\Files\Filesystem :: normalizePath ( self :: VERSIONS_ROOT . '/' . $pathinfo [ 'dirname' ]);
2013-10-10 22:06:42 +04:00
2014-07-24 20:54:12 +04:00
$dirContent = false ;
if ( $view -> is_dir ( $dir )) {
$dirContent = $view -> opendir ( $dir );
}
if ( $dirContent === false ) {
return $versions ;
}
2013-10-10 16:43:40 +04:00
2014-07-24 20:54:12 +04:00
if ( is_resource ( $dirContent )) {
while (( $entryName = readdir ( $dirContent )) !== false ) {
if ( ! \OC\Files\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 ));
}
2015-01-14 23:06:26 +03:00
$versions [ $key ][ 'path' ] = \OC\Files\Filesystem :: normalizePath ( $pathinfo [ 'dirname' ] . '/' . $filename );
2014-07-24 20:54:12 +04:00
$versions [ $key ][ 'name' ] = $versionedFile ;
$versions [ $key ][ 'size' ] = $view -> filesize ( $dir . '/' . $entryName );
2014-01-21 16:50:56 +04:00
}
2012-09-07 16:09:41 +04:00
}
}
2014-07-24 20:54:12 +04:00
closedir ( $dirContent );
2012-09-07 16:09:41 +04:00
}
2013-10-10 22:06:42 +04:00
// sort with newest version first
krsort ( $versions );
2013-10-10 16:43:40 +04:00
2013-10-10 22:06:42 +04:00
return $versions ;
2012-09-07 16:09:41 +04:00
}
2013-07-25 12:35:19 +04:00
/**
2014-05-19 19:50:53 +04:00
* translate a timestamp into a string like " 5 days ago "
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 " ;
}
}
2013-04-11 14:36:08 +04:00
2013-01-09 20:11:46 +04:00
/**
2014-05-19 19:50:53 +04:00
* returns all stored file versions from a given user
2014-02-06 19:30:58 +04:00
* @ param string $uid id of the user
2013-01-09 20:11:46 +04:00
* @ 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 ) {
2013-10-10 16:43:40 +04:00
$view = new \OC\Files\View ( '/' . $uid . '/' );
2013-10-10 22:09:38 +04:00
$dirs = array ( self :: VERSIONS_ROOT );
2014-06-18 15:23:53 +04:00
$versions = array ();
2013-10-10 16:43:40 +04:00
while ( ! empty ( $dirs )) {
$dir = array_pop ( $dirs );
$files = $view -> getDirectoryContent ( $dir );
foreach ( $files as $file ) {
if ( $file [ 'type' ] === 'dir' ) {
array_push ( $dirs , $file [ 'path' ]);
} else {
$versionsBegin = strrpos ( $file [ 'path' ], '.v' );
2013-10-11 12:34:34 +04:00
$relPathStart = strlen ( self :: VERSIONS_ROOT );
2013-10-10 16:43:40 +04:00
$version = substr ( $file [ 'path' ], $versionsBegin + 2 );
$relpath = substr ( $file [ 'path' ], $relPathStart , $versionsBegin - $relPathStart );
$key = $version . '#' . $relpath ;
$versions [ $key ] = array ( 'path' => $relpath , 'timestamp' => $version );
2013-01-09 20:11:46 +04:00
}
2013-01-15 17:57:23 +04:00
}
2013-10-10 16:43:40 +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
2013-10-10 16:43:40 +04:00
$result = array ();
2013-02-22 20:21:57 +04:00
2013-10-10 16:43:40 +04:00
foreach ( $versions as $key => $value ) {
2014-01-22 14:10:23 +04:00
$size = $view -> filesize ( self :: VERSIONS_ROOT . '/' . $value [ 'path' ] . '.v' . $value [ 'timestamp' ]);
2013-10-10 16:43:40 +04:00
$filename = $value [ 'path' ];
2013-02-22 20:21:57 +04:00
2013-10-10 16:43:40 +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
2013-10-10 16:43:40 +04:00
$result [ 'by_file' ][ $filename ][ $key ][ 'version' ] = $value [ 'timestamp' ];
$result [ 'by_file' ][ $filename ][ $key ][ 'path' ] = $filename ;
$result [ 'by_file' ][ $filename ][ $key ][ 'size' ] = $size ;
2012-09-07 16:09:41 +04:00
}
2013-10-10 16:43:40 +04:00
return $result ;
2012-09-07 16:09:41 +04:00
}
2014-01-20 19:03:26 +04:00
/**
2014-05-19 19:50:53 +04:00
* get list of files we want to expire
2014-01-20 19:03:26 +04:00
* @ param array $versions list of versions
2014-02-19 12:31:54 +04:00
* @ param integer $time
2014-01-20 19:03:26 +04:00
* @ 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-17 21:40:03 +03:00
$application = new Application ();
$expiration = $application -> getContainer () -> query ( 'Expiration' );
2014-01-20 19:03:26 +04:00
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 ) {
2014-01-20 19:03:26 +04:00
$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 :: DEBUG );
} 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 );
}
2012-09-07 16:09:41 +04:00
/**
2015-05-13 19:40:35 +03:00
* Schedule versions expiration for the given file
*
* @ param string $uid owner of the file
* @ param string $fileName file / folder for which to schedule expiration
* @ param int | null $versionsSize current versions size
* @ param int $neededSpace requested versions size
2015-03-23 15:07:40 +03:00
*/
2015-05-13 19:40:35 +03:00
private static function scheduleExpire ( $uid , $fileName , $versionsSize = null , $neededSpace = 0 ) {
2015-08-17 21:40:03 +03:00
// let the admin disable auto expire
$application = new Application ();
$expiration = $application -> getContainer () -> query ( 'Expiration' );
if ( $expiration -> isEnabled ()) {
$command = new Expire ( $uid , $fileName , $versionsSize , $neededSpace );
\OC :: $server -> getCommandBus () -> push ( $command );
}
2015-03-23 15:07:40 +03:00
}
/**
* Expire versions which exceed the quota
*
* @ param $filename
* @ param int | null $versionsSize
* @ param int $offset
* @ return bool | int | null
2012-09-07 16:09:41 +04:00
*/
2015-03-23 15:07:40 +03:00
public static function expire ( $filename , $versionsSize = null , $offset = 0 ) {
2014-12-04 18:48:07 +03:00
$config = \OC :: $server -> getConfig ();
2015-08-17 21:40:03 +03:00
$application = new Application ();
$expiration = $application -> getContainer () -> query ( 'Expiration' );
if ( $config -> getSystemValue ( 'files_versions' , Storage :: DEFAULTENABLED ) == 'true' && $expiration -> isEnabled ()) {
2013-02-22 20:21:57 +04:00
list ( $uid , $filename ) = self :: getUidAndFilename ( $filename );
2015-05-29 14:15:12 +03:00
if ( empty ( $filename )) {
// file maybe renamed or deleted
return false ;
}
2013-06-28 22:31:33 +04:00
$versionsFileview = new \OC\Files\View ( '/' . $uid . '/files_versions' );
2013-02-22 20:21:57 +04:00
2012-12-17 16:28:40 +04:00
// get available disk space for user
2013-04-16 15:52:46 +04:00
$softQuota = true ;
2014-12-04 18:48:07 +03:00
$quota = $config -> getUserValue ( $uid , 'files' , 'quota' , null );
2013-03-04 15:17:57 +04:00
if ( $quota === null || $quota === 'default' ) {
2014-12-04 18:48:07 +03:00
$quota = $config -> getAppValue ( 'files' , 'default_quota' , null );
2012-12-17 16:28:40 +04:00
}
2013-03-04 15:33:16 +04:00
if ( $quota === null || $quota === 'none' ) {
2013-04-16 15:52:46 +04:00
$quota = \OC\Files\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
}
2013-08-17 13:57:50 +04:00
2013-01-11 22:33:54 +04:00
// make sure that we have the current size of the version history
2013-01-10 21:04:30 +04:00
if ( $versionsSize === null ) {
2013-02-21 15:20:29 +04:00
$versionsSize = self :: getVersionsSize ( $uid );
2013-01-10 21:04:30 +04:00
}
2013-01-11 22:33:54 +04:00
2013-01-15 17:57:23 +04:00
// calculate available space for version history
2013-04-16 15:52:46 +04:00
// subtract size of files and current versions size from quota
if ( $softQuota ) {
$files_view = new \OC\Files\View ( '/' . $uid . '/files' );
2014-01-20 20:10:09 +04:00
$rootInfo = $files_view -> getFileInfo ( '/' , false );
2013-04-16 15:52:46 +04:00
$free = $quota - $rootInfo [ 'size' ]; // remaining free space for user
if ( $free > 0 ) {
2013-06-25 11:39:01 +04:00
$availableSpace = ( $free * self :: DEFAULTMAXSIZE / 100 ) - ( $versionsSize + $offset ); // how much space can be used for versions
2013-04-16 15:52:46 +04:00
} else {
2013-06-25 11:39:01 +04:00
$availableSpace = $free - $versionsSize - $offset ;
2013-04-16 15:52:46 +04:00
}
2013-01-10 21:04:30 +04:00
} else {
2013-06-25 11:39:01 +04:00
$availableSpace = $quota - $offset ;
2013-02-22 20:21:57 +04:00
}
2013-01-09 20:11:46 +04:00
2013-06-28 22:31:33 +04:00
$allVersions = Storage :: getVersions ( $uid , $filename );
2013-02-22 20:21:57 +04:00
2014-01-20 19:03:26 +04:00
$time = time ();
2015-08-19 00:00:18 +03:00
list ( $toDelete , $sizeOfDeletedVersions ) = self :: getExpireList ( $time , $allVersions , $availableSpace <= 0 );
2014-01-20 19:03:26 +04:00
2013-06-25 11:39:01 +04:00
$availableSpace = $availableSpace + $sizeOfDeletedVersions ;
$versionsSize = $versionsSize - $sizeOfDeletedVersions ;
2013-02-22 20:21:57 +04:00
2013-06-25 11:39:01 +04:00
// if still not enough free space we rearrange the versions from all files
2014-01-20 19:03:26 +04:00
if ( $availableSpace <= 0 ) {
2013-06-25 11:39:01 +04:00
$result = Storage :: getAllVersions ( $uid );
2013-06-28 22:31:33 +04:00
$allVersions = $result [ 'all' ];
2013-02-22 20:21:57 +04:00
2014-01-20 19:03:26 +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 );
2014-01-20 19:03:26 +04:00
$toDelete = array_merge ( $toDelete , $toDeleteNew );
$sizeOfDeletedVersions += $size ;
}
2013-06-25 11:39:01 +04:00
$availableSpace = $availableSpace + $sizeOfDeletedVersions ;
$versionsSize = $versionsSize - $sizeOfDeletedVersions ;
2012-11-04 21:42:18 +04:00
}
2013-02-22 20:21:57 +04:00
2014-01-20 19:03:26 +04:00
foreach ( $toDelete as $key => $path ) {
2014-03-11 17:17:08 +04:00
\OC_Hook :: emit ( '\OCP\Versions' , 'preDelete' , array ( 'path' => $path ));
2014-07-10 17:19:40 +04:00
self :: deleteVersion ( $versionsFileview , $path );
2014-03-11 17:17:08 +04:00
\OC_Hook :: emit ( '\OCP\Versions' , 'delete' , array ( 'path' => $path ));
2014-01-20 19:03:26 +04:00
unset ( $allVersions [ $key ]); // update array with the versions we keep
\OCP\Util :: writeLog ( 'files_versions' , " Expire: " . $path , \OCP\Util :: DEBUG );
}
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
2013-06-28 22:31:33 +04:00
$numOfVersions = count ( $allVersions ) - 2 ;
2013-02-22 20:21:57 +04:00
$i = 0 ;
2014-10-09 21:15:58 +04:00
// 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 ) {
2013-06-28 22:31:33 +04:00
$version = current ( $allVersions );
2014-03-11 17:17:08 +04:00
\OC_Hook :: emit ( '\OCP\Versions' , 'preDelete' , array ( 'path' => $version [ 'path' ] . '.v' . $version [ 'version' ]));
2014-07-10 17:19:40 +04:00
self :: deleteVersion ( $versionsFileview , $version [ 'path' ] . '.v' . $version [ 'version' ]);
2013-11-12 17:06:32 +04:00
\OC_Hook :: emit ( '\OCP\Versions' , 'delete' , array ( 'path' => $version [ 'path' ] . '.v' . $version [ 'version' ]));
2014-01-20 19:03:26 +04:00
\OCP\Util :: writeLog ( 'files_versions' , 'running out of space! Delete oldest version: ' . $version [ 'path' ] . '.v' . $version [ 'version' ] , \OCP\Util :: DEBUG );
2013-06-28 22:31:33 +04:00
$versionsSize -= $version [ 'size' ];
$availableSpace += $version [ 'size' ];
next ( $allVersions );
2012-12-17 19:32:09 +04:00
$i ++ ;
}
2013-02-22 20:21:57 +04:00
2013-01-11 22:33:54 +04:00
return $versionsSize ; // finally return the new size of the version history
2012-11-04 21:42:18 +04:00
}
2013-02-22 20:21:57 +04:00
2013-01-11 14:12:32 +04:00
return false ;
2012-09-07 16:09:41 +04:00
}
2013-06-25 11:39:01 +04:00
2013-08-17 15:28:35 +04:00
/**
2015-04-27 13:51:17 +03:00
* 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
2013-08-17 15:46:33 +04:00
* @ param \OC\Files\View $view view on data / user /
2013-08-17 15:28:35 +04:00
*/
private static function createMissingDirectories ( $filename , $view ) {
2014-05-12 18:20:07 +04:00
$dirname = \OC\Files\Filesystem :: normalizePath ( dirname ( $filename ));
2013-08-17 15:28:35 +04:00
$dirParts = explode ( '/' , $dirname );
$dir = " /files_versions " ;
foreach ( $dirParts as $part ) {
$dir = $dir . '/' . $part ;
if ( ! $view -> file_exists ( $dir )) {
$view -> mkdir ( $dir );
}
}
}
2012-09-07 16:09:41 +04:00
}