123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490 |
- <?php
-
- /**
- * ownCloud
- *
- * @author Frank Karlitschek
- * @copyright 2010 Frank Karlitschek karlitschek@kde.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/>.
- *
- */
-
-
- /**
- * Class for abstraction of filesystem functions
- * This class won't call any filesystem functions for itself but but will pass them to the correct OC_Filestorage object
- * this class should also handle all the file premission related stuff
- *
- * Hooks provided:
- * read(path)
- * write(path, &run)
- * post_write(path)
- * create(path, &run) (when a file is created, both create and write will be emited in that order)
- * post_create(path)
- * delete(path, &run)
- * post_delete(path)
- * rename(oldpath,newpath, &run)
- * post_rename(oldpath,newpath)
- * copy(oldpath,newpath, &run) (if the newpath doesn't exists yes, copy, create and write will be emited in that order)
- * post_rename(oldpath,newpath)
- *
- * the &run parameter can be set to false to prevent the operation from occuring
- */
- class OC_Filesystem{
- static private $storages=array();
- static private $mounts=array();
- static private $fakeRoot='';
- static private $storageTypes=array();
-
-
- /**
- * register a storage type
- * @param string type
- * @param string classname
- * @param array arguments an associative array in the form of name=>type (eg array('datadir'=>'string'))
- */
- static public function registerStorageType($type,$classname,$arguments){
- self::$storageTypes[$type]=array('type'=>$type,'classname'=>$classname,'arguments'=>$arguments);
- }
-
- /**
- * check if the filesystem supports a specific storagetype
- * @param string type
- * @return bool
- */
- static public function hasStorageType($type){
- return isset(self::$storageTypes[$type]);
- }
-
- /**
- * get the list of names of storagetypes that the filesystem supports
- * @return array
- */
- static public function getStorageTypeNames(){
- return array_keys(self::$storageTypes);
- }
-
- /**
- * tear down the filesystem, removing all storage providers
- */
- static public function tearDown(){
- foreach(self::$storages as $mountpoint=>$storage){
- unset(self::$storages[$mountpoint]);
- }
- $fakeRoot='';
- }
-
- /**
- * create a new storage of a specific type
- * @param string type
- * @param array arguments
- * @return OC_Filestorage
- */
- static private function createStorage($type,$arguments){
- if(!self::hasStorageType($type)){
- return false;
- }
- $className=self::$storageTypes[$type]['classname'];
- if(class_exists($className)){
- return new $className($arguments);
- }else{
- return false;
- }
- }
-
- /**
- * change the root to a fake toor
- * @param string fakeRoot
- * @return bool
- */
- static public function chroot($fakeRoot){
- if(!$fakeRoot==''){
- if($fakeRoot[0]!=='/'){
- $fakeRoot='/'.$fakeRoot;
- }
- }
- self::$fakeRoot=$fakeRoot;
- }
-
- /**
- * get the part of the path relative to the mountpoint of the storage it's stored in
- * @param string path
- * @return bool
- */
- static public function getInternalPath($path){
- $mountPoint=self::getMountPoint($path);
- $path=self::$fakeRoot.$path;
- $internalPath=substr($path,strlen($mountPoint));
- return $internalPath;
- }
-
- /**
- * check if the current users has the right premissions to read a file
- * @param string path
- * @return bool
- */
- static private function canRead($path){
- if(substr($path,0,1)!=='/'){
- $path='/'.$path;
- }
- if(strstr($path,'/../') || strrchr($path, '/') === '/..' ){
- return false;
- }
- return true;//dummy untill premissions are correctly implemented, also the correcty value because for now users are locked in their seperate data dir and can read/write everything in there
- }
- /**
- * check if the current users has the right premissions to write a file
- * @param string path
- * @return bool
- */
- static private function canWrite($path){
- if(substr($path,0,1)!=='/'){
- $path='/'.$path;
- }
- if(strstr($path,'/../') || strrchr($path, '/') === '/..' ){
- return false;
- }
- return true;//dummy untill premissions are correctly implemented, also the correcty value because for now users are locked in their seperate data dir and can read/write everything in there
- }
-
- /**
- * mount an OC_Filestorage in our virtual filesystem
- * @param OC_Filestorage storage
- * @param string mountpoint
- */
- static public function mount($type,$arguments,$mountpoint){
- if(substr($mountpoint,0,1)!=='/'){
- $mountpoint='/'.$mountpoint;
- }
- self::$mounts[$mountpoint]=array('type'=>$type,'arguments'=>$arguments);
- }
-
- /**
- * get the storage object for a path
- * @param string path
- * @return OC_Filestorage
- */
- static public function getStorage($path){
- $mountpoint=self::getMountPoint($path);
- if($mountpoint){
- if(!isset(self::$storages[$mountpoint])){
- $mount=self::$mounts[$mountpoint];
- self::$storages[$mountpoint]=self::createStorage($mount['type'],$mount['arguments']);
- }
- return self::$storages[$mountpoint];
- }
- }
-
- /**
- * 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
- */
- static public function getMountPoint($path){
- if(!$path){
- $path='/';
- }
- if(substr($path,0,1)!=='/'){
- $path='/'.$path;
- }
- if(substr($path,-1)!=='/'){
- $path=$path.'/';
- }
- $path=self::$fakeRoot.$path;
- $foundMountPoint='';
- foreach(self::$mounts as $mountpoint=>$storage){
- if(substr($mountpoint,-1)!=='/'){
- $mountpoint=$mountpoint.'/';
- }
- if($mountpoint==$path){
- return $mountpoint;
- }
- if(strpos($path,$mountpoint)===0 and strlen($mountpoint)>strlen($foundMountPoint)){
- $foundMountPoint=$mountpoint;
- }
- }
- return $foundMountPoint;
- }
-
- /**
- * 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
- */
- static public function getLocalFile($path){
- $parent=substr($path,0,strrpos($path,'/'));
- if(self::canRead($parent) and $storage=self::getStorage($path)){
- return $storage->getLocalFile(self::getInternalPath($path));
- }
- }
-
- static public function mkdir($path){
- return self::basicOperation('mkdir',$path,array('create','write'));
- }
- static public function rmdir($path){
- return self::basicOperation('rmdir',$path,array('delete'));
- }
- static public function opendir($path){
- return self::basicOperation('opendir',$path,array('read'));
- }
- static public function is_dir($path){
- if($path=='/'){
- return true;
- }
- return self::basicOperation('is_dir',$path);
- }
- static public function is_file($path){
- if($path=='/'){
- return false;
- }
- return self::basicOperation('is_file',$path);
- }
- static public function stat($path){
- return self::basicOperation('stat',$path);
- }
- static public function filetype($path){
- return self::basicOperation('filetype',$path);
- }
- static public function filesize($path){
- return self::basicOperation('filesize',$path);
- }
- static public function readfile($path){
- return self::basicOperation('readfile',$path,array('read'));
- }
- static public function is_readable($path){
- return self::basicOperation('is_readable',$path);
- }
- static public function is_writeable($path){
- return self::basicOperation('is_writeable',$path);
- }
- static public function file_exists($path){
- if($path=='/'){
- return true;
- }
- return self::basicOperation('file_exists',$path);
- }
- static public function filectime($path){
- return self::basicOperation('filectime',$path);
- }
- static public function filemtime($path){
- return self::basicOperation('filemtime',$path);
- }
- static public function fileatime($path){
- return self::basicOperation('fileatime',$path);
- }
- static public function file_get_contents($path){
- return self::basicOperation('file_get_contents',$path,array('read'));
- }
- static public function file_put_contents($path,$data){
- return self::basicOperation('file_put_contents',$path,array('create','write'),$data);
- }
- static public function unlink($path){
- return self::basicOperation('unlink',$path,array('delete'));
- }
- static public function rename($path1,$path2){
- if(OC_FileProxy::runPreProxies('rename',$path1,$path2) and self::canWrite($path1) and self::canWrite($path2)){
- $run=true;
- OC_Hook::emit( 'OC_Filesystem', 'rename', array( 'oldpath' => $path1 ,'newpath'=>$path2, 'run' => &$run));
- if($run){
- $mp1=self::getMountPoint($path1);
- $mp2=self::getMountPoint($path2);
- if($mp1==$mp2){
- if($storage=self::getStorage($path1)){
- $result=$storage->rename(self::getInternalPath($path1),self::getInternalPath($path2));
- }
- }elseif($storage1=self::getStorage($path1) and $storage2=self::getStorage($path2)){
- $tmpFile=$storage1->toTmpFile(self::getInternalPath($path1));
- $result=$storage2->fromTmpFile($tmpFile,self::getInternalPath($path2));
- $storage1->unlink(self::getInternalPath($path1));
- }
- OC_Hook::emit( 'OC_Filesystem', 'post_rename', array( 'oldpath' => $path1, 'newpath'=>$path2));
- return $result;
- }
- }
- }
- static public function copy($path1,$path2){
- if(OC_FileProxy::runPreProxies('copy',$path1,$path2) and self::canRead($path1) and self::canWrite($path2)){
- $run=true;
- OC_Hook::emit( 'OC_Filesystem', 'copy', array( 'oldpath' => $path1 ,'newpath'=>$path2, 'run' => &$run));
- $exists=self::file_exists($path2);
- if($run and !$exists){
- OC_Hook::emit( 'OC_Filesystem', 'create', array( 'path' => $path2, 'run' => &$run));
- }
- if($run){
- OC_Hook::emit( 'OC_Filesystem', 'write', array( 'path' => $path2, 'run' => &$run));
- }
- if($run){
- $mp1=self::getMountPoint($path1);
- $mp2=self::getMountPoint($path2);
- if($mp1==$mp2){
- if($storage=self::getStorage($path1)){
- $result=$storage->copy(self::getInternalPath($path1),self::getInternalPath($path2));
- }
- }elseif($storage1=self::getStorage($path1) and $storage2=self::getStorage($path2)){
- $tmpFile=$storage1->toTmpFile(self::getInternalPath($path1));
- $result=$storage2->fromTmpFile($tmpFile,self::getInternalPath($path2));
- }
- OC_Hook::emit( 'OC_Filesystem', 'post_copy', array( 'oldpath' => $path1 ,'newpath'=>$path2));
- if(!$exists){
- OC_Hook::emit( 'OC_Filesystem', 'post_create', array( 'path' => $path2));
- }
- OC_Hook::emit( 'OC_Filesystem', 'post_write', array( 'path' => $path2));
- return $result;
- }
- }
- }
- static public function fopen($path,$mode){
- $hooks=array();
- switch($mode){
- case 'r':
- $hooks[]='read';
- break;
- case 'r+':
- case 'w+':
- case 'x+':
- case 'a+':
- $hooks[]='read';
- $hooks[]='write';
- break;
- case 'w':
- case 'x':
- case 'a':
- $hooks[]='write';
- break;
- }
-
- return self::basicOperation('fopen',$path,$hooks);
- }
- static public function toTmpFile($path){
- if(OC_FileProxy::runPreProxies('toTmpFile',$path) and self::canRead($path) and $storage=self::getStorage($path)){
- OC_Hook::emit( 'OC_Filesystem', 'read', array( 'path' => $path));
- return $storage->toTmpFile(self::getInternalPath($path));
- }
- }
- static public function fromTmpFile($tmpFile,$path){
- if(OC_FileProxy::runPreProxies('copy',$tmpFile,$path) and self::canWrite($path) and $storage=self::getStorage($path)){
- $run=true;
- $exists=self::file_exists($path);
- if(!$exists){
- OC_Hook::emit( 'OC_Filesystem', 'create', array( 'path' => $path, 'run' => &$run));
- }
- if($run){
- OC_Hook::emit( 'OC_Filesystem', 'write', array( 'path' => $path, 'run' => &$run));
- }
- if($run){
- $result=$storage->fromTmpFile($tmpFile,self::getInternalPath($path));
- if(!$exists){
- OC_Hook::emit( 'OC_Filesystem', 'post_create', array( 'path' => $path));
- }
- OC_Hook::emit( 'OC_Filesystem', 'post_write', array( 'path' => $path));
- return $result;
- }
- }
- }
- static public function fromUploadedFile($tmpFile,$path){
- if(OC_FileProxy::runPreProxies('fromUploadedFile',$tmpFile,$path) and self::canWrite($path) and $storage=self::getStorage($path)){
- $run=true;
- $exists=self::file_exists($path);
- if(!$exists){
- OC_Hook::emit( 'OC_Filesystem', 'create', array( 'path' => $path, 'run' => &$run));
- }
- if($run){
- OC_Hook::emit( 'OC_Filesystem', 'write', array( 'path' => $path, 'run' => &$run));
- }
- if($run){
- $result=$storage->fromUploadedFile($tmpFile,self::getInternalPath($path));
- if(!$exists){
- OC_Hook::emit( 'OC_Filesystem', 'post_create', array( 'path' => $path));
- }
- OC_Hook::emit( 'OC_Filesystem', 'post_write', array( 'path' => $path));
- return $result;
- }
- }
- }
- static public function getMimeType($path){
- return self::basicOperation('getMimeType',$path);
- }
- static public function hash($type,$path){
- return self::basicOperation('hash',$path,array('read'));
- }
-
- static public function free_space($path='/'){
- return self::basicOperation('free_space',$path);
- }
-
- static public function search($query){
- $files=array();
- $fakeRoot=self::$fakeRoot;
- $fakeRootLength=strlen($fakeRoot);
- foreach(self::$storages as $mountpoint=>$storage){
- $results=$storage->search($query);
- if(is_array($results)){
- foreach($results as $result){
- $file=str_replace('//','/',$mountpoint.$result);
- if(substr($file,0,$fakeRootLength)==$fakeRoot){
- $file=substr($file,$fakeRootLength);
- $files[]=$file;
- }
- }
- }
- }
- return $files;
-
- }
-
- static public function update_session_file_hash($sessionname,$sessionvalue){
- $_SESSION[$sessionname] = $sessionvalue;
- }
-
- /**
- * abstraction for running most basic operations
- * @param string $operation
- * @param string #path
- * @param array (optional) hooks
- * @param mixed (optional) $extraParam
- * @return mixed
- */
- private static function basicOperation($operation,$path,$hooks=array(),$extraParam=null){
- if(OC_FileProxy::runPreProxies($operation,$path, $extraParam) and self::canRead($path) and $storage=self::getStorage($path)){
- $interalPath=self::getInternalPath($path);
- $run=true;
- foreach($hooks as $hook){
- if($hook!='read'){
- OC_Hook::emit( 'OC_Filesystem', $hook, array( 'path' => $path, 'run' => &$run));
- }else{
- OC_Hook::emit( 'OC_Filesystem', $hook, array( 'path' => $path));
- }
- }
- if($run){
- if($extraParam){
- $result=$storage->$operation($interalPath,$extraParam);
- }else{
- $result=$storage->$operation($interalPath);
- }
- $result=OC_FileProxy::runPostProxies($operation,$path,$result);
- foreach($hooks as $hook){
- if($hook!='read'){
- OC_Hook::emit( 'OC_Filesystem', 'post_'.$hook, array( 'path' => $path));
- }
- }
- return $result;
- }
- }
- return null;
- }
- }
|