2012-04-24 01:54:49 +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_versionsblacklist
|
|
|
|
|
// - files_versionsmaxfilesize
|
|
|
|
|
// - files_versionsinterval
|
|
|
|
|
// - files_versionmaxversions
|
|
|
|
|
//
|
|
|
|
|
// todo:
|
|
|
|
|
// - port to oc_filesystem to enable network transparency
|
|
|
|
|
// - check if it works well together with encryption
|
|
|
|
|
// - implement expire all function. And find a place to call it ;-)
|
|
|
|
|
// - add transparent compression. first test if it´s worth it.
|
|
|
|
|
|
|
|
|
|
const DEFAULTENABLED=true;
|
|
|
|
|
const DEFAULTFOLDER='versions';
|
2012-05-14 12:51:41 +04:00
|
|
|
|
const DEFAULTBLACKLIST='avi mp3 mpg mp4 ctmp';
|
2012-04-24 01:54:49 +04:00
|
|
|
|
const DEFAULTMAXFILESIZE=1048576; // 10MB
|
2012-04-27 16:19:16 +04:00
|
|
|
|
const DEFAULTMININTERVAL=120; // 2 min
|
2012-04-24 01:54:49 +04:00
|
|
|
|
const DEFAULTMAXVERSIONS=50;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* init the versioning and create the versions folder.
|
|
|
|
|
*/
|
|
|
|
|
public static function init() {
|
2012-05-02 15:28:56 +04:00
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
2012-04-24 01:54:49 +04:00
|
|
|
|
// create versions folder
|
2012-05-02 15:28:56 +04:00
|
|
|
|
$foldername=\OCP\Config::getSystemValue('datadirectory').'/'. \OCP\USER::getUser() .'/'.\OCP\Config::getSystemValue('files_versionsfolder', Storage::DEFAULTFOLDER);
|
2012-04-24 01:54:49 +04:00
|
|
|
|
if(!is_dir($foldername)){
|
|
|
|
|
mkdir($foldername);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* listen to write event.
|
|
|
|
|
*/
|
|
|
|
|
public static function write_hook($params) {
|
2012-05-02 15:28:56 +04:00
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
2012-04-24 01:54:49 +04:00
|
|
|
|
$path = $params[\OC_Filesystem::signal_param_path];
|
|
|
|
|
if($path<>'') Storage::store($path);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* store a new version of a file.
|
|
|
|
|
*/
|
|
|
|
|
public static function store($filename) {
|
2012-05-02 15:28:56 +04:00
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
2012-05-19 06:01:47 +04:00
|
|
|
|
if (\OCP\App::isEnabled('files_sharing') && $source = \OC_Share::getSource('/'.\OCP\User::getUser().'/files'.$filename)) {
|
|
|
|
|
$pos = strpos($source, '/files', 1);
|
|
|
|
|
$uid = substr($source, 1, $pos - 1);
|
|
|
|
|
$filename = substr($source, $pos + 6);
|
|
|
|
|
} else {
|
|
|
|
|
$uid = \OCP\User::getUser();
|
|
|
|
|
}
|
|
|
|
|
$versionsfoldername=\OCP\Config::getSystemValue('datadirectory').'/'. $uid .'/'.\OCP\Config::getSystemValue('files_versionsfolder', Storage::DEFAULTFOLDER);
|
|
|
|
|
$filesfoldername=\OCP\Config::getSystemValue('datadirectory').'/'. $uid .'/files';
|
2012-04-24 01:54:49 +04:00
|
|
|
|
Storage::init();
|
|
|
|
|
|
|
|
|
|
// check if filename is a directory
|
|
|
|
|
if(is_dir($filesfoldername.$filename)){
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// check filetype blacklist
|
2012-05-02 15:28:56 +04:00
|
|
|
|
$blacklist=explode(' ',\OCP\Config::getSystemValue('files_versionsblacklist', Storage::DEFAULTBLACKLIST));
|
2012-04-24 01:54:49 +04:00
|
|
|
|
foreach($blacklist as $bl) {
|
|
|
|
|
$parts=explode('.', $filename);
|
|
|
|
|
$ext=end($parts);
|
|
|
|
|
if(strtolower($ext)==$bl) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// check filesize
|
2012-05-31 23:10:03 +04:00
|
|
|
|
if(filesize($filesfoldername.'/'.$filename)>\OCP\Config::getSystemValue('files_versionsmaxfilesize', Storage::DEFAULTMAXFILESIZE)){
|
2012-04-24 01:54:49 +04:00
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
2012-05-19 06:27:43 +04:00
|
|
|
|
// 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-05-31 23:10:03 +04:00
|
|
|
|
$matches=glob($versionsfoldername.'/'.$filename.'.v*');
|
2012-05-19 06:01:47 +04:00
|
|
|
|
sort($matches);
|
|
|
|
|
$parts=explode('.v',end($matches));
|
|
|
|
|
if((end($parts)+Storage::DEFAULTMININTERVAL)>time()){
|
|
|
|
|
return false;
|
|
|
|
|
}
|
2012-04-24 01:54:49 +04:00
|
|
|
|
}
|
2012-05-19 06:01:47 +04:00
|
|
|
|
|
2012-04-24 01:54:49 +04:00
|
|
|
|
|
|
|
|
|
// create all parent folders
|
|
|
|
|
$info=pathinfo($filename);
|
2012-05-31 23:10:03 +04:00
|
|
|
|
if(!file_exists($versionsfoldername.'/'.$info['dirname'])) mkdir($versionsfoldername.'/'.$info['dirname'],0700,true);
|
2012-04-24 01:54:49 +04:00
|
|
|
|
|
|
|
|
|
// store a new version of a file
|
2012-05-31 23:10:03 +04:00
|
|
|
|
copy($filesfoldername.'/'.$filename,$versionsfoldername.'/'.$filename.'.v'.time());
|
2012-04-24 01:54:49 +04:00
|
|
|
|
|
|
|
|
|
// expire old revisions
|
|
|
|
|
Storage::expire($filename);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* rollback to an old version of a file.
|
|
|
|
|
*/
|
|
|
|
|
public static function rollback($filename,$revision) {
|
2012-04-27 16:19:16 +04:00
|
|
|
|
|
2012-05-02 15:28:56 +04:00
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
2012-05-19 06:01:47 +04:00
|
|
|
|
if (\OCP\App::isEnabled('files_sharing') && $source = \OC_Share::getSource('/'.\OCP\User::getUser().'/files'.$filename)) {
|
|
|
|
|
$pos = strpos($source, '/files', 1);
|
|
|
|
|
$uid = substr($source, 1, $pos - 1);
|
|
|
|
|
$filename = substr($source, $pos + 6);
|
|
|
|
|
} else {
|
|
|
|
|
$uid = \OCP\User::getUser();
|
|
|
|
|
}
|
|
|
|
|
$versionsfoldername=\OCP\Config::getSystemValue('datadirectory').'/'.$uid .'/'.\OCP\Config::getSystemValue('files_versionsfolder', Storage::DEFAULTFOLDER);
|
2012-04-27 16:19:16 +04:00
|
|
|
|
|
2012-05-19 06:01:47 +04:00
|
|
|
|
$filesfoldername=\OCP\Config::getSystemValue('datadirectory').'/'. $uid .'/files';
|
2012-04-27 16:19:16 +04:00
|
|
|
|
|
2012-04-24 01:54:49 +04:00
|
|
|
|
// rollback
|
2012-05-31 23:10:03 +04:00
|
|
|
|
if ( @copy($versionsfoldername.'/'.$filename.'.v'.$revision,$filesfoldername.$filename) ) {
|
2012-04-27 16:19:16 +04:00
|
|
|
|
|
|
|
|
|
return true;
|
|
|
|
|
|
|
|
|
|
}else{
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
2012-04-24 01:54:49 +04:00
|
|
|
|
}
|
2012-04-27 16:19:16 +04:00
|
|
|
|
|
2012-04-24 01:54:49 +04:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* check if old versions of a file exist.
|
|
|
|
|
*/
|
|
|
|
|
public static function isversioned($filename) {
|
2012-05-02 15:28:56 +04:00
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
2012-05-19 06:01:47 +04:00
|
|
|
|
if (\OCP\App::isEnabled('files_sharing') && $source = \OC_Share::getSource('/'.\OCP\User::getUser().'/files'.$filename)) {
|
|
|
|
|
$pos = strpos($source, '/files', 1);
|
|
|
|
|
$uid = substr($source, 1, $pos - 1);
|
|
|
|
|
$filename = substr($source, $pos + 6);
|
|
|
|
|
} else {
|
|
|
|
|
$uid = \OCP\User::getUser();
|
|
|
|
|
}
|
|
|
|
|
$versionsfoldername=\OCP\Config::getSystemValue('datadirectory').'/'. $uid .'/'.\OCP\Config::getSystemValue('files_versionsfolder', Storage::DEFAULTFOLDER);
|
2012-04-24 01:54:49 +04:00
|
|
|
|
|
|
|
|
|
// check for old versions
|
2012-05-31 23:10:03 +04:00
|
|
|
|
$matches=glob($versionsfoldername.'/'.$filename.'.v*');
|
2012-04-24 01:54:49 +04:00
|
|
|
|
if(count($matches)>1){
|
|
|
|
|
return true;
|
|
|
|
|
}else{
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}else{
|
|
|
|
|
return(false);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* get a list of old versions of a file.
|
|
|
|
|
*/
|
|
|
|
|
public static function getversions($filename,$count=0) {
|
2012-05-02 15:28:56 +04:00
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
2012-05-19 06:01:47 +04:00
|
|
|
|
if (\OCP\App::isEnabled('files_sharing') && $source = \OC_Share::getSource('/'.\OCP\User::getUser().'/files'.$filename)) {
|
|
|
|
|
$pos = strpos($source, '/files', 1);
|
|
|
|
|
$uid = substr($source, 1, $pos - 1);
|
|
|
|
|
$filename = substr($source, $pos + 6);
|
|
|
|
|
} else {
|
|
|
|
|
$uid = \OCP\User::getUser();
|
|
|
|
|
}
|
|
|
|
|
$versionsfoldername=\OCP\Config::getSystemValue('datadirectory').'/'. $uid .'/'.\OCP\Config::getSystemValue('files_versionsfolder', Storage::DEFAULTFOLDER);
|
2012-04-24 01:54:49 +04:00
|
|
|
|
$versions=array();
|
|
|
|
|
|
|
|
|
|
// fetch for old versions
|
2012-05-31 23:10:03 +04:00
|
|
|
|
$matches=glob($versionsfoldername.'/'.$filename.'.v*');
|
2012-04-24 01:54:49 +04:00
|
|
|
|
sort($matches);
|
|
|
|
|
foreach($matches as $ma) {
|
|
|
|
|
$parts=explode('.v',$ma);
|
|
|
|
|
$versions[]=(end($parts));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// only show the newest commits
|
|
|
|
|
if($count<>0 and (count($versions)>$count)) {
|
|
|
|
|
$versions=array_slice($versions,count($versions)-$count);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return($versions);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
}else{
|
|
|
|
|
return(array());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* expire old versions of a file.
|
|
|
|
|
*/
|
|
|
|
|
public static function expire($filename) {
|
2012-05-02 15:28:56 +04:00
|
|
|
|
if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') {
|
2012-05-19 06:01:47 +04:00
|
|
|
|
if (\OCP\App::isEnabled('files_sharing') && $source = \OC_Share::getSource('/'.\OCP\User::getUser().'/files'.$filename)) {
|
|
|
|
|
$pos = strpos($source, '/files', 1);
|
|
|
|
|
$uid = substr($source, 1, $pos - 1);
|
|
|
|
|
$filename = substr($source, $pos + 6);
|
|
|
|
|
} else {
|
|
|
|
|
$uid = \OCP\User::getUser();
|
|
|
|
|
}
|
|
|
|
|
$versionsfoldername=\OCP\Config::getSystemValue('datadirectory').'/'. $uid .'/'.\OCP\Config::getSystemValue('files_versionsfolder', Storage::DEFAULTFOLDER);
|
2012-04-24 01:54:49 +04:00
|
|
|
|
|
|
|
|
|
// check for old versions
|
2012-05-31 23:10:03 +04:00
|
|
|
|
$matches=glob($versionsfoldername.'/'.$filename.'.v*');
|
2012-05-02 15:28:56 +04:00
|
|
|
|
if(count($matches)>\OCP\Config::getSystemValue('files_versionmaxversions', Storage::DEFAULTMAXVERSIONS)){
|
|
|
|
|
$numbertodelete=count($matches-\OCP\Config::getSystemValue('files_versionmaxversions', Storage::DEFAULTMAXVERSIONS));
|
2012-04-24 01:54:49 +04:00
|
|
|
|
|
|
|
|
|
// delete old versions of a file
|
|
|
|
|
$deleteitems=array_slice($matches,0,$numbertodelete);
|
|
|
|
|
foreach($deleteitems as $de){
|
2012-05-31 23:10:03 +04:00
|
|
|
|
unlink($versionsfoldername.'/'.$filename.'.v'.$de);
|
2012-04-24 01:54:49 +04:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* expire all old versions.
|
|
|
|
|
*/
|
|
|
|
|
public static function expireall($filename) {
|
|
|
|
|
// todo this should go through all the versions directories and delete all the not needed files and not needed directories.
|
|
|
|
|
// useful to be included in a cleanup cronjob.
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
}
|