nextcloud/lib/filesystemview.php

467 lines
15 KiB
PHP
Raw Normal View History

2012-01-20 03:40:52 +04:00
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* 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/>.
*/
/**
2012-05-31 20:32:34 +04:00
* Class to provide access to ownCloud filesystem via a "view", and methods for
* working with files within that view (e.g. read, write, delete, etc.). Each
* view is restricted to a set of directories via a virtual root. The default view
* uses the currently logged in user's data directory as root (parts of
* OC_Filesystem are merely a wrapper for OC_FilesystemView).
*
* Apps that need to access files outside of the user data folders (to modify files
* belonging to a user other than the one currently logged in, for example) should
* use this class directly rather than using OC_Filesystem, or making use of PHP's
* built-in file manipulation functions. This will ensure all hooks and proxies
* are triggered correctly.
2012-05-31 20:57:34 +04:00
*
* Filesystem functions are not called directly; they are passed to the correct
* OC_Filestorage object
*/
2012-01-20 03:40:52 +04:00
/**
* @note default root (if $root is empty or '/') is /data/[user]/
*/
2012-01-20 03:40:52 +04:00
class OC_FilesystemView {
private $fakeRoot='';
private $internal_path_cache=array();
private $storage_cache=array();
2012-01-20 03:40:52 +04:00
public function __construct($root){
$this->fakeRoot=$root;
}
2012-01-20 03:40:52 +04:00
public function getAbsolutePath($path){
if(!$path){
$path='/';
}
if($path[0]!=='/'){
2012-01-20 03:40:52 +04:00
$path='/'.$path;
}
return $this->fakeRoot.$path;
}
/**
* change the root to a fake toor
* @param string fakeRoot
* @return bool
*/
public function chroot($fakeRoot){
if(!$fakeRoot==''){
if($fakeRoot[0]!=='/'){
$fakeRoot='/'.$fakeRoot;
}
}
$this->fakeRoot=$fakeRoot;
}
/**
* get the fake root
* @return string
*/
public function getRoot(){
return $this->fakeRoot;
}
/**
* get the part of the path relative to the mountpoint of the storage it's stored in
* @param string path
* @return bool
*/
public function getInternalPath($path){
if (!isset($this->internal_path_cache[$path])) {
$this->internal_path_cache[$path] = OC_Filesystem::getInternalPath($this->getAbsolutePath($path));
}
return $this->internal_path_cache[$path];
2012-01-20 03:40:52 +04:00
}
2012-06-09 19:33:57 +04:00
/**
* get path relative to the root of the view
* @param string path
* @return string
*/
public function getRelativePath($path){
if($this->fakeRoot==''){
return $path;
}
if(strpos($path,$this->fakeRoot)!==0){
return null;
}else{
return substr($path,strlen($this->fakeRoot));
}
}
2012-01-20 03:40:52 +04:00
/**
* get the storage object for a path
* @param string path
* @return OC_Filestorage
*/
public function getStorage($path){
if (!isset($this->storage_cache[$path])) {
$this->storage_cache[$path] = OC_Filesystem::getStorage($this->getAbsolutePath($path));
}
return $this->storage_cache[$path];
2012-01-20 03:40:52 +04:00
}
/**
* get the mountpoint of the storage object for a path
( note: because a storage is not always mounted inside the fakeroot, the returned mountpoint is relative to the absolute root of the filesystem and doesn't take the chroot into account
*
* @param string path
* @return string
*/
public function getMountPoint($path){
return OC_Filesystem::getMountPoint($this->getAbsolutePath($path));
}
/**
* return the path to a local version of the file
* we need this because we can't know if a file is stored local or not from outside the filestorage and for some purposes a local file is needed
* @param string path
* @return string
*/
public function getLocalFile($path){
$parent=substr($path,0,strrpos($path,'/'));
if(OC_Filesystem::isValidPath($parent) and $storage=$this->getStorage($path)){
return $storage->getLocalFile($this->getInternalPath($path));
}
}
/**
2012-05-31 20:57:34 +04:00
* the following functions operate with arguments and return values identical
* to those of their PHP built-in equivalents. Mostly they are merely wrappers
* for OC_Filestorage via basicOperation().
2012-01-20 03:40:52 +04:00
*/
public function mkdir($path){
return $this->basicOperation('mkdir',$path,array('create','write'));
}
public function rmdir($path){
return $this->basicOperation('rmdir',$path,array('delete'));
}
public function opendir($path){
return $this->basicOperation('opendir',$path,array('read'));
}
public function readdir($handle){
$fsLocal= new OC_Filestorage_Local( array( 'datadir' => '/' ) );
return $fsLocal->readdir( $handle );
}
2012-01-20 03:40:52 +04:00
public function is_dir($path){
if($path=='/'){
return true;
}
return $this->basicOperation('is_dir',$path);
}
public function is_file($path){
if($path=='/'){
return false;
}
return $this->basicOperation('is_file',$path);
}
public function stat($path){
return $this->basicOperation('stat',$path);
}
public function filetype($path){
return $this->basicOperation('filetype',$path);
}
public function filesize($path){
return $this->basicOperation('filesize',$path);
}
public function readfile($path){
@ob_end_clean();
$handle=$this->fopen($path,'rb');
if ($handle) {
$chunkSize = 8192;// 8 MB chunks
while (!feof($handle)) {
echo fread($handle, $chunkSize);
flush();
}
$size=$this->filesize($path);
return $size;
}
return false;
2012-01-20 03:40:52 +04:00
}
public function is_readable($path){
return $this->basicOperation('is_readable',$path);
}
2012-02-05 17:00:49 +04:00
public function is_writable($path){
return $this->basicOperation('is_writable',$path);
2012-01-20 03:40:52 +04:00
}
public function file_exists($path){
if($path=='/'){
return true;
}
return $this->basicOperation('file_exists',$path);
}
public function filectime($path){
return $this->basicOperation('filectime',$path);
}
public function filemtime($path){
return $this->basicOperation('filemtime',$path);
}
public function touch($path, $mtime=null){
return $this->basicOperation('touch', $path, array('write'), $mtime);
}
2012-01-20 03:40:52 +04:00
public function file_get_contents($path){
return $this->basicOperation('file_get_contents',$path,array('read'));
}
public function file_put_contents($path,$data){
if(is_resource($data)){//not having to deal with streams in file_put_contents makes life easier
$exists=$this->file_exists($path);
$run=true;
if(!$exists){
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_create, array( OC_Filesystem::signal_param_path => $path, OC_Filesystem::signal_param_run => &$run));
}
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_write, array( OC_Filesystem::signal_param_path => $path, OC_Filesystem::signal_param_run => &$run));
if(!$run){
return false;
}
$target=$this->fopen($path,'w');
if($target){
2012-02-27 15:20:37 +04:00
$count=OC_Helper::streamCopy($data,$target);
fclose($target);
fclose($data);
if(!$exists){
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_post_create, array( OC_Filesystem::signal_param_path => $path));
}
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_post_write, array( OC_Filesystem::signal_param_path => $path));
2012-02-27 15:20:37 +04:00
return $count>0;
}else{
return false;
}
}else{
return $this->basicOperation('file_put_contents',$path,array('create','write'),$data);
}
2012-01-20 03:40:52 +04:00
}
public function unlink($path){
return $this->basicOperation('unlink',$path,array('delete'));
}
public function deleteAll( $directory, $empty = false ) {
return $this->basicOperation( 'deleteAll', $directory, array('delete'), $empty );
}
2012-01-20 03:40:52 +04:00
public function rename($path1,$path2){
2012-06-09 19:33:57 +04:00
$absolutePath1=$this->getAbsolutePath($path1);
$absolutePath2=$this->getAbsolutePath($path2);
if(OC_FileProxy::runPreProxies('rename',$absolutePath1,$absolutePath2) and OC_Filesystem::isValidPath($path2)){
$path1=$this->getRelativePath($absolutePath1);
$path2=$this->getRelativePath($absolutePath2);
if($path1==null or $path2==null){
return false;
}
2012-01-20 03:40:52 +04:00
$run=true;
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_rename, array( OC_Filesystem::signal_param_oldpath => $path1 , OC_Filesystem::signal_param_newpath=>$path2, OC_Filesystem::signal_param_run => &$run));
if($run){
$mp1=$this->getMountPoint($path1);
$mp2=$this->getMountPoint($path2);
if($mp1==$mp2){
if($storage=$this->getStorage($path1)){
$result=$storage->rename($this->getInternalPath($path1),$this->getInternalPath($path2));
}
}else{
$source=$this->fopen($path1,'r');
$target=$this->fopen($path2,'w');
2012-07-03 18:43:57 +04:00
$count=OC_Helper::streamCopy($source,$target);
$storage1=$this->getStorage($path1);
2012-01-20 03:40:52 +04:00
$storage1->unlink($this->getInternalPath($path1));
$result=$count>0;
2012-01-20 03:40:52 +04:00
}
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_post_rename, array( OC_Filesystem::signal_param_oldpath => $path1, OC_Filesystem::signal_param_newpath=>$path2));
return $result;
}
}
}
public function copy($path1,$path2){
2012-06-09 19:33:57 +04:00
$absolutePath1=$this->getAbsolutePath($path1);
$absolutePath2=$this->getAbsolutePath($path2);
if(OC_FileProxy::runPreProxies('copy',$absolutePath1,$absolutePath2) and OC_Filesystem::isValidPath($path2)){
$path1=$this->getRelativePath($absolutePath1);
$path2=$this->getRelativePath($absolutePath2);
if($path1==null or $path2==null){
return false;
}
2012-01-20 03:40:52 +04:00
$run=true;
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_copy, array( OC_Filesystem::signal_param_oldpath => $path1 , OC_Filesystem::signal_param_newpath=>$path2, OC_Filesystem::signal_param_run => &$run));
$exists=$this->file_exists($path2);
if($run and !$exists){
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_create, array( OC_Filesystem::signal_param_path => $path2, OC_Filesystem::signal_param_run => &$run));
}
if($run){
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_write, array( OC_Filesystem::signal_param_path => $path2, OC_Filesystem::signal_param_run => &$run));
}
if($run){
$mp1=$this->getMountPoint($path1);
$mp2=$this->getMountPoint($path2);
if($mp1==$mp2){
if($storage=$this->getStorage($path1)){
$result=$storage->copy($this->getInternalPath($path1),$this->getInternalPath($path2));
}
}else{
$source=$this->fopen($path1,'r');
$target=$this->fopen($path2,'w');
$result=OC_Helper::streamCopy($source,$target);
2012-01-20 03:40:52 +04:00
}
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_post_copy, array( OC_Filesystem::signal_param_oldpath => $path1 , OC_Filesystem::signal_param_newpath=>$path2));
if(!$exists){
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_post_create, array( OC_Filesystem::signal_param_path => $path2));
}
OC_Hook::emit( OC_Filesystem::CLASSNAME, OC_Filesystem::signal_post_write, array( OC_Filesystem::signal_param_path => $path2));
return $result;
}
}
}
public function fopen($path,$mode){
$hooks=array();
switch($mode){
case 'r':
2012-02-26 18:32:58 +04:00
case 'rb':
2012-01-20 03:40:52 +04:00
$hooks[]='read';
break;
case 'r+':
2012-02-26 18:32:58 +04:00
case 'rb+':
2012-01-20 03:40:52 +04:00
case 'w+':
2012-02-26 18:32:58 +04:00
case 'wb+':
2012-01-20 03:40:52 +04:00
case 'x+':
2012-02-26 18:32:58 +04:00
case 'xb+':
2012-01-20 03:40:52 +04:00
case 'a+':
2012-02-26 18:32:58 +04:00
case 'ab+':
2012-01-20 03:40:52 +04:00
$hooks[]='read';
$hooks[]='write';
break;
case 'w':
2012-02-26 18:32:58 +04:00
case 'wb':
2012-01-20 03:40:52 +04:00
case 'x':
2012-02-26 18:32:58 +04:00
case 'xb':
2012-01-20 03:40:52 +04:00
case 'a':
2012-02-26 18:32:58 +04:00
case 'ab':
2012-01-20 03:40:52 +04:00
$hooks[]='write';
break;
default:
OC_Log::write('core','invalid mode ('.$mode.') for '.$path,OC_Log::ERROR);
}
return $this->basicOperation('fopen',$path,$hooks,$mode);
}
public function toTmpFile($path){
if(OC_Filesystem::isValidPath($path)){
$source=$this->fopen($path,'r');
if($source){
2012-04-14 01:02:29 +04:00
$extension='';
2012-04-14 01:01:37 +04:00
$extOffset=strpos($path,'.');
if($extOffset !== false) {
2012-04-14 01:02:29 +04:00
$extension=substr($path,strrpos($path,'.'));
2012-04-14 01:01:37 +04:00
}
2012-04-14 01:02:29 +04:00
$tmpFile=OC_Helper::tmpFile($extension);
file_put_contents($tmpFile,$source);
return $tmpFile;
}
2012-01-20 03:40:52 +04:00
}
}
public function fromTmpFile($tmpFile,$path){
if(OC_Filesystem::isValidPath($path)){
if(!$tmpFile){
debug_print_backtrace();
}
$source=fopen($tmpFile,'r');
if($source){
$this->file_put_contents($path,$source);
unlink($tmpFile);
return true;
}else{
2012-01-20 03:40:52 +04:00
}
}else{
return false;
2012-01-20 03:40:52 +04:00
}
}
public function getMimeType($path){
return $this->basicOperation('getMimeType',$path);
}
public function hash($type,$path){
return $this->basicOperation('hash',$path,array('read'));
}
public function free_space($path='/'){
return $this->basicOperation('free_space',$path);
}
/**
2012-05-31 20:57:34 +04:00
* @brief abstraction layer for basic filesystem functions: wrapper for OC_Filestorage
2012-01-20 03:40:52 +04:00
* @param string $operation
* @param string #path
* @param array (optional) hooks
* @param mixed (optional) $extraParam
* @return mixed
2012-05-31 20:57:34 +04:00
*
* This method takes requests for basic filesystem functions (e.g. reading & writing
* files), processes hooks and proxies, sanitises paths, and finally passes them on to
* OC_Filestorage for delegation to a storage backend for execution
2012-01-20 03:40:52 +04:00
*/
private function basicOperation($operation,$path,$hooks=array(),$extraParam=null){
2012-06-09 19:33:57 +04:00
$absolutePath=$this->getAbsolutePath($path);
if(OC_FileProxy::runPreProxies($operation,$absolutePath, $extraParam) and OC_Filesystem::isValidPath($path)){
$path=$this->getRelativePath($absolutePath);
if($path==null){
return false;
}
2012-05-31 17:53:52 +04:00
$internalPath=$this->getInternalPath($path);
2012-01-20 03:40:52 +04:00
$run=true;
if(OC_Filesystem::$loaded and $this->fakeRoot==OC_Filesystem::getRoot()){
foreach($hooks as $hook){
if($hook!='read'){
OC_Hook::emit( OC_Filesystem::CLASSNAME, $hook, array( OC_Filesystem::signal_param_path => $path, OC_Filesystem::signal_param_run => &$run));
}else{
OC_Hook::emit( OC_Filesystem::CLASSNAME, $hook, array( OC_Filesystem::signal_param_path => $path));
}
2012-01-20 03:40:52 +04:00
}
}
if($run and $storage=$this->getStorage($path)){
2011-10-21 19:02:11 +04:00
if(!is_null($extraParam)){
2012-05-31 17:53:52 +04:00
$result=$storage->$operation($internalPath,$extraParam);
2012-01-20 03:40:52 +04:00
}else{
2012-05-31 17:53:52 +04:00
$result=$storage->$operation($internalPath);
2012-01-20 03:40:52 +04:00
}
2012-06-09 19:33:57 +04:00
$result=OC_FileProxy::runPostProxies($operation,$this->getAbsolutePath($path),$result);
if(OC_Filesystem::$loaded and $this->fakeRoot==OC_Filesystem::getRoot()){
if($operation!='fopen'){//no post hooks for fopen, the file stream is still open
foreach($hooks as $hook){
if($hook!='read'){
OC_Hook::emit( OC_Filesystem::CLASSNAME, 'post_'.$hook, array( OC_Filesystem::signal_param_path => $path));
}
2012-02-05 23:50:35 +04:00
}
2012-01-20 03:40:52 +04:00
}
}
return $result;
}
}
return null;
}
/**
* check if a file or folder has been updated since $time
* @param int $time
* @return bool
*/
public function hasUpdated($path,$time){
return $this->basicOperation('hasUpdated',$path,array(),$time);
}
2012-01-20 03:40:52 +04:00
}