1 files changed, 264 insertions, 0 deletions
diff --git a/apps/files_trashbin/lib/trash.php b/apps/files_trashbin/lib/trash.php
new file mode 100644
index 00000000000..a7eff3d44e0
--- /dev/null
+++ b/apps/files_trashbin/lib/trash.php
@@ -0,0 +1,264 @@
+<?php
+/**
+ * ownCloud - trash bin
+ *
+ * @author Bjoern Schiessle
+ * @copyright 2013 Bjoern Schiessle schiessle@owncloud.com
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA_Trash;
+
+class Trashbin {
+	
+	const DEFAULT_RETENTION_OBLIGATION=180; // how long do we keep files in the trash bin if no other value is defined in the config file (unit: days)
+	/**
+	 * move file to the trash bin
+	 * 
+	 * @param $file_path path to the deleted file/directory relative to the files root directory
+	 */
+	public static function move2trash($file_path) {
+		$user = \OCP\User::getUser();
+		$view = new \OC_FilesystemView('/'. $user);
+		if (!$view->is_dir('files_trashbin')) {
+			$view->mkdir('files_trashbin');
+			$view->mkdir("versions_trashbin");
+		}
+
+		$path_parts = pathinfo($file_path);
+
+		$deleted = $path_parts['basename'];
+		$location = $path_parts['dirname'];
+		$timestamp = time();
+		$mime = $view->getMimeType('files'.$file_path);
+
+		if ( $view->is_dir('files'.$file_path) ) {
+			$type = 'dir';
+		} else {
+			$type = 'file';
+		}
+
+		self::copy_recursive($file_path, 'files_trashbin/'.$deleted.'.d'.$timestamp, $view);
+		
+		if ( $view->file_exists('files_trashbin/'.$deleted.'.d'.$timestamp) ) {
+			$query = \OC_DB::prepare("INSERT INTO *PREFIX*files_trash (id,timestamp,location,type,mime,user) VALUES (?,?,?,?,?,?)");
+			$result = $query->execute(array($deleted, $timestamp, $location, $type, $mime, $user));
+			if ( !$result ) { // if file couldn't be added to the database than also don't store it in the trash bin.
+				$view->deleteAll('files_trashbin/'.$deleted.'.d'.$timestamp);
+				\OC_Log::write('files_trashbin', 'trash bin database couldn\'t be updated', \OC_log::ERROR);
+				return;
+			}
+	
+			if ( \OCP\App::isEnabled('files_versions') ) {
+				if ( $view->is_dir('files_versions'.$file_path) ) {
+					$view->rename('files_versions'.$file_path, 'versions_trashbin/'. $deleted.'.d'.$timestamp);
+				} else if ( $versions = \OCA_Versions\Storage::getVersions($file_path) ) {
+					foreach ($versions as $v) {
+						$view->rename('files_versions'.$v['path'].'.v'.$v['version'], 'versions_trashbin/'. $deleted.'.v'.$v['version'].'.d'.$timestamp);
+					}
+				}
+			}
+		} else {
+			\OC_Log::write('files_trashbin', 'Couldn\'t move '.$file_path.' to the trash bin' , \OC_log::ERROR);
+		}
+		
+		self::expire();
+	}
+	
+	
+	/**
+	 * restore files from trash bin
+	 * @param $file path to the deleted file
+	 * @param $filename name of the file
+	 * @param $timestamp time when the file was deleted
+	 */
+	public static function restore($file, $filename, $timestamp) {
+
+		$user = \OCP\User::getUser();
+		$view = new \OC_FilesystemView('/'.$user);
+		
+		if ( $timestamp ) {
+			$query = \OC_DB::prepare('SELECT location,type FROM *PREFIX*files_trash WHERE user=? AND id=? AND timestamp=?');
+			$result = $query->execute(array($user,$filename,$timestamp))->fetchAll();
+			if ( count($result) != 1 ) {
+				\OC_Log::write('files_trashbin', 'trash bin database inconsistent!', \OC_Log::ERROR);
+				return false;
+			}
+			
+			// if location no longer exists, restore file in the root directory
+			$location = $result[0]['location'];
+			if ( $result[0]['location'] != '/' && 
+				 (!$view->is_dir('files'.$result[0]['location']) ||
+				 !$view->isUpdatable('files'.$result[0]['location'])) ) {
+				$location = '';
+			}
+		} else {
+			$path_parts = pathinfo($filename);
+			$result[] = array(
+					'location' => $path_parts['dirname'],
+					'type' => $view->is_dir('/files_trashbin/'.$file) ? 'dir' : 'files',
+					);
+			$location = '';
+		}
+		
+		$source = \OC_Filesystem::normalizePath('files_trashbin/'.$file);
+		$target = \OC_Filesystem::normalizePath('files/'.$location.'/'.$filename);
+		
+		// we need a  extension in case a file/dir with the same name already exists
+		$ext = self::getUniqueExtension($location, $filename, $view);
+		$mtime = $view->filemtime($source);
+		if( $view->rename($source, $target.$ext) ) {
+			$view->touch($target.$ext, $mtime);
+			// if versioning app is enabled, copy versions from the trash bin back to the original location
+			if ( \OCP\App::isEnabled('files_versions') ) {
+				if ( $result[0]['type'] == 'dir' ) {
+					$view->rename(\OC_Filesystem::normalizePath('versions_trashbin/'. $file), \OC_Filesystem::normalizePath('files_versions/'.$location.'/'.$filename.$ext));
+				} else if ( $versions = self::getVersionsFromTrash($file, $timestamp) ) {
+					foreach ($versions as $v) {
+						if ($timestamp ) {
+							$view->rename('versions_trashbin/'.$filename.'.v'.$v.'.d'.$timestamp, 'files_versions/'.$location.'/'.$filename.$ext.'.v'.$v);
+						} else {
+							$view->rename('versions_trashbin/'.$file.'.v'.$v, 'files_versions/'.$location.'/'.$filename.$ext.'.v'.$v);
+						}
+					}
+				}
+			}
+
+			if ( $timestamp ) {
+				$query = \OC_DB::prepare('DELETE FROM *PREFIX*files_trash WHERE user=? AND id=? AND timestamp=?');
+				$query->execute(array($user,$filename,$timestamp));
+			}
+
+			return true;
+		} else {
+			\OC_Log::write('files_trashbin', 'Couldn\'t restore file from trash bin, '.$filename , \OC_log::ERROR);
+		}
+
+		return false;
+	}
+	
+	/**
+	 * clean up the trash bin
+	 */
+	private static function expire() {
+		
+		$view = new \OC_FilesystemView('/'.\OCP\User::getUser());
+		$user = \OCP\User::getUser();
+		
+		$query = \OC_DB::prepare('SELECT location,type,id,timestamp FROM *PREFIX*files_trash WHERE user=?');
+		$result = $query->execute(array($user))->fetchAll();
+		
+		$retention_obligation = \OC_Config::getValue('trashbin_retention_obligation', self::DEFAULT_RETENTION_OBLIGATION);
+		
+		$limit = time() - ($retention_obligation * 86400);
+
+		foreach ( $result as $r ) {
+			$timestamp = $r['timestamp'];
+			$filename = $r['id'];
+			if ( $r['timestamp'] < $limit ) {
+				$view->unlink('files_trashbin/'.$filename.'.d'.$timestamp);
+				if ($r['type'] == 'dir') {
+					$view->unlink('versions_trashbin/'.$filename.'.d'.$timestamp);
+				} else if ( $versions = self::getVersionsFromTrash($filename, $timestamp) ) {
+					foreach ($versions as $v) {
+						$view->unlink('versions_trashbin/'.$filename.'.v'.$v.'.d'.$timestamp);
+					}			
+				}
+			}
+		}
+		
+		$query = \OC_DB::prepare('DELETE FROM *PREFIX*files_trash WHERE user=? AND timestamp<?');
+		$query->execute(array($user,$limit));
+	}
+	
+	/**
+	 * recursive copy to copy a whole directory
+	 * 
+	 * @param $source source path, relative to the users files directory
+	 * @param $destination destination path relative to the users root directoy
+	 * @param $view file view for the users root directory
+	 */
+	private static function copy_recursive( $source, $destination, $view ) {
+		if ( $view->is_dir( 'files'.$source ) ) {
+			$view->mkdir( $destination );
+			$view->touch($destination,  $view->filemtime('files'.$source));
+			foreach ( \OC_Files::getDirectoryContent($source) as $i ) {
+				$pathDir = $source.'/'.$i['name'];
+				if ( $view->is_dir('files'.$pathDir) ) {
+					self::copy_recursive($pathDir, $destination.'/'.$i['name'], $view);
+				} else {
+					$view->copy( 'files'.$pathDir, $destination . '/' . $i['name'] );
+					$view->touch($destination . '/' . $i['name'], $view->filemtime('files'.$pathDir));
+				}
+			}
+		} else {
+			$view->copy( 'files'.$source, $destination );
+			$view->touch($destination, $view->filemtime('files'.$source));
+		}
+	}
+	
+	/**
+	 * find all versions which belong to the file we want to restore
+	 * @param $filename name of the file which should be restored
+	 * @param $timestamp timestamp when the file was deleted
+	 */
+	private static function getVersionsFromTrash($filename, $timestamp) {
+		$view = new \OC_FilesystemView('/'.\OCP\User::getUser().'/versions_trashbin');
+		$versionsName = \OCP\Config::getSystemValue('datadirectory').$view->getAbsolutePath($filename);
+		$versions = array();
+		
+		if ($timestamp ) {
+		// fetch for old versions
+			$matches = glob( $versionsName.'.v*.d'.$timestamp );
+			$offset = -strlen($timestamp)-2;
+		} else {
+			$matches = glob( $versionsName.'.v*' );
+		}
+		
+		foreach( $matches as $ma ) {
+			if ( $timestamp ) {
+				$parts = explode( '.v', substr($ma, 0, $offset) );
+				$versions[] = ( end( $parts ) );
+			} else {
+				$parts = explode( '.v', $ma );
+				$versions[] = ( end( $parts ) );
+			}
+		}
+		return $versions;
+	}
+	
+	/**
+	 * find unique extension for restored file if a file with the same name already exists
+	 * @param $location where the file should be restored
+	 * @param $filename name of the file
+	 * @param $view filesystem view relative to users root directory
+	 * @return string with unique extension
+	 */
+	private static function getUniqueExtension($location, $filename, $view) {
+		$ext = '';
+		if ( $view->file_exists('files'.$location.'/'.$filename) ) {
+			$tmpext = '.restored';
+			$ext = $tmpext;
+			$i = 1;
+			while ( $view->file_exists('files'.$location.'/'.$filename.$ext) ) {
+				$ext = $tmpext.$i;
+				$i++;
+			}
+		}
+		return $ext;
+	}
+
+}