nextcloud/lib/files/storage/mappedlocal.php

<?php
/**
 * Copyright (c) 2012 Robin Appelman <icewind@owncloud.com>
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 * See the COPYING-README file.
 */
namespace OC\Files\Storage;

/**
 * for local filestore, we only have to map the paths
 */
class MappedLocal extends \OC\Files\Storage\Common{
	protected $datadir;
	private $mapper;

	public function __construct($arguments) {
		$this->datadir=$arguments['datadir'];
		if(substr($this->datadir, -1)!=='/') {
			$this->datadir.='/';
		}

		$this->mapper= new \OC\Files\Mapper($this->datadir);
	}
	public function __destruct() {
		if (defined('PHPUNIT_RUN')) {
			$this->mapper->removePath($this->datadir, true, true);
		}
	}
	public function getId(){
		return 'local::'.$this->datadir;
	}
	public function mkdir($path) {
		return @mkdir($this->buildPath($path));
	}
	public function rmdir($path) {
		try {
			$it = new \RecursiveIteratorIterator(
				new \RecursiveDirectoryIterator($this->buildPath($path)),
				\RecursiveIteratorIterator::CHILD_FIRST
			);
			foreach ($it as $file) {
				/**
				 * @var \SplFileInfo $file
				 */
				if (in_array($file->getBasename(), array('.', '..'))) {
					continue;
				} elseif ($file->isDir()) {
					rmdir($file->getPathname());
				} elseif ($file->isFile() || $file->isLink()) {
					unlink($file->getPathname());
				}
			}
			if ($result = @rmdir($this->buildPath($path))) {
				$this->cleanMapper($path);
			}
			return $result;
		} catch (\UnexpectedValueException $e) {
			return false;
		}
	}
	public function opendir($path) {
		$files = array('.', '..');
		$physicalPath= $this->buildPath($path);

		$logicalPath = $this->mapper->physicalToLogic($physicalPath);
		$dh = opendir($physicalPath);
		if(is_resource($dh)) {
			while (($file = readdir($dh)) !== false) {
				if ($file === '.' or $file === '..') {
					continue;
				}

				$logicalFilePath = $this->mapper->physicalToLogic($physicalPath.'/'.$file);

				$file= $this->mapper->stripRootFolder($logicalFilePath, $logicalPath);
				$file = $this->stripLeading($file);
				$files[]= $file;
			}
		}

		\OC\Files\Stream\Dir::register('local-win32'.$path, $files);
		return opendir('fakedir://local-win32'.$path);
	}
	public function is_dir($path) {
		if(substr($path, -1)=='/') {
			$path=substr($path, 0, -1);
		}
		return is_dir($this->buildPath($path));
	}
	public function is_file($path) {
		return is_file($this->buildPath($path));
	}
	public function stat($path) {
		$fullPath = $this->buildPath($path);
		$statResult = stat($fullPath);

		if ($statResult['size'] < 0) {
			$size = self::getFileSizeFromOS($fullPath);
			$statResult['size'] = $size;
			$statResult[7] = $size;
		}
		return $statResult;
	}
	public function filetype($path) {
		$filetype=filetype($this->buildPath($path));
		if($filetype=='link') {
			$filetype=filetype(realpath($this->buildPath($path)));
		}
		return $filetype;
	}
	public function filesize($path) {
		if($this->is_dir($path)) {
			return 0;
		}else{
			$fullPath = $this->buildPath($path);
			$fileSize = filesize($fullPath);
			if ($fileSize < 0) {
				return self::getFileSizeFromOS($fullPath);
			}

			return $fileSize;
		}
	}
	public function isReadable($path) {
		return is_readable($this->buildPath($path));
	}
	public function isUpdatable($path) {
		return is_writable($this->buildPath($path));
	}
	public function file_exists($path) {
		return file_exists($this->buildPath($path));
	}
	public function filemtime($path) {
		return filemtime($this->buildPath($path));
	}
	public function touch($path, $mtime=null) {
		// sets the modification time of the file to the given value.
		// If mtime is nil the current time is set.
		// note that the access time of the file always changes to the current time.
		if(!is_null($mtime)) {
			$result=touch( $this->buildPath($path), $mtime );
		}else{
			$result=touch( $this->buildPath($path));
		}
		if( $result ) {
			clearstatcache( true, $this->buildPath($path) );
		}

		return $result;
	}
	public function file_get_contents($path) {
		return file_get_contents($this->buildPath($path));
	}
	public function file_put_contents($path, $data) {
		return file_put_contents($this->buildPath($path), $data);
	}
	public function unlink($path) {
		return $this->delTree($path);
	}
	public function rename($path1, $path2) {
		if (!$this->isUpdatable($path1)) {
			\OC_Log::write('core', 'unable to rename, file is not writable : '.$path1, \OC_Log::ERROR);
			return false;
		}
		if(! $this->file_exists($path1)) {
			\OC_Log::write('core', 'unable to rename, file does not exists : '.$path1, \OC_Log::ERROR);
			return false;
		}

		$physicPath1 = $this->buildPath($path1);
		$physicPath2 = $this->buildPath($path2);
		if($return=rename($physicPath1, $physicPath2)) {
			// mapper needs to create copies or all children
			$this->copyMapping($path1, $path2);
			$this->cleanMapper($physicPath1, false, true);
		}
		return $return;
	}
	public function copy($path1, $path2) {
		if($this->is_dir($path2)) {
			if(!$this->file_exists($path2)) {
				$this->mkdir($path2);
			}
			$source=substr($path1, strrpos($path1, '/')+1);
			$path2.=$source;
		}
		if($return=copy($this->buildPath($path1), $this->buildPath($path2))) {
			// mapper needs to create copies or all children
			$this->copyMapping($path1, $path2);
		}
		return $return;
	}
	public function fopen($path, $mode) {
		if($return=fopen($this->buildPath($path), $mode)) {
			switch($mode) {
				case 'r':
					break;
				case 'r+':
				case 'w+':
				case 'x+':
				case 'a+':
					break;
				case 'w':
				case 'x':
				case 'a':
					break;
			}
		}
		return $return;
	}

	public function getMimeType($path) {
		if($this->isReadable($path)) {
			return \OC_Helper::getMimeType($this->buildPath($path));
		}else{
			return false;
		}
	}

	private function delTree($dir, $isLogicPath=true) {
		$dirRelative=$dir;
		if ($isLogicPath) {
			$dir=$this->buildPath($dir);
		}
		if (!file_exists($dir)) {
			return true;
		}
		if (!is_dir($dir) || is_link($dir)) {
			if($return=unlink($dir)) {
				$this->cleanMapper($dir, false);
				return $return;
			}
		}
		foreach (scandir($dir) as $item) {
			if ($item == '.' || $item == '..') {
				continue;
			}
			if(is_file($dir.'/'.$item)) {
				if(unlink($dir.'/'.$item)) {
					$this->cleanMapper($dir.'/'.$item, false);
				}
			}elseif(is_dir($dir.'/'.$item)) {
				if (!$this->delTree($dir. "/" . $item, false)) {
					return false;
				};
			}
		}
		if($return=rmdir($dir)) {
			$this->cleanMapper($dir, false);
		}
		return $return;
	}

	private static function getFileSizeFromOS($fullPath) {
		$name = strtolower(php_uname('s'));
		// Windows OS: we use COM to access the filesystem
		if (strpos($name, 'win') !== false) {
			if (class_exists('COM')) {
				$fsobj = new \COM("Scripting.FileSystemObject");
				$f = $fsobj->GetFile($fullPath);
				return $f->Size;
			}
		} else if (strpos($name, 'bsd') !== false) {
			if (\OC_Helper::is_function_enabled('exec')) {
				return (float)exec('stat -f %z ' . escapeshellarg($fullPath));
			}
		} else if (strpos($name, 'linux') !== false) {
			if (\OC_Helper::is_function_enabled('exec')) {
				return (float)exec('stat -c %s ' . escapeshellarg($fullPath));
			}
		} else {
			\OC_Log::write('core',
				'Unable to determine file size of "'.$fullPath.'". Unknown OS: '.$name,
				\OC_Log::ERROR);
		}

		return 0;
	}

	public function hash($path, $type, $raw=false) {
		return hash_file($type, $this->buildPath($path), $raw);
	}

	public function free_space($path) {
		return @disk_free_space($this->buildPath($path));
	}

	public function search($query) {
		return $this->searchInDir($query);
	}
	public function getLocalFile($path) {
		return $this->buildPath($path);
	}
	public function getLocalFolder($path) {
		return $this->buildPath($path);
	}

	protected function searchInDir($query, $dir='') {
		$files=array();
		$physicalDir = $this->buildPath($dir);
		foreach (scandir($physicalDir) as $item) {
			if ($item == '.' || $item == '..')
				continue;
			$physicalItem = $this->mapper->physicalToLogic($physicalDir.'/'.$item);
			$item = substr($physicalItem, strlen($physicalDir)+1);

			if(strstr(strtolower($item), strtolower($query)) !== false) {
				$files[]=$dir.'/'.$item;
			}
			if(is_dir($physicalItem)) {
				$files=array_merge($files, $this->searchInDir($query, $dir.'/'.$item));
			}
		}
		return $files;
	}

	/**
	 * check if a file or folder has been updated since $time
	 * @param string $path
	 * @param int $time
	 * @return bool
	 */
	public function hasUpdated($path, $time) {
		return $this->filemtime($path)>$time;
	}

	private function buildPath($path, $create=true) {
		$path = $this->stripLeading($path);
		$fullPath = $this->datadir.$path;
		return $this->mapper->logicToPhysical($fullPath, $create);
	}

	private function cleanMapper($path, $isLogicPath=true, $recursive=true) {
		$fullPath = $path;
		if ($isLogicPath) {
			$fullPath = $this->datadir.$path;
		}
		$this->mapper->removePath($fullPath, $isLogicPath, $recursive);
	}

	private function copyMapping($path1, $path2) {
		$path1 = $this->stripLeading($path1);
		$path2 = $this->stripLeading($path2);

		$fullPath1 = $this->datadir.$path1;
		$fullPath2 = $this->datadir.$path2;

		$this->mapper->copy($fullPath1, $fullPath2);
	}

	private function stripLeading($path) {
		if(strpos($path, '/') === 0) {
			$path = substr($path, 1);
		}
		if(strpos($path, '\\') === 0) {
			$path = substr($path, 1);
		}
		if ($path === false) {
			return '';
		}

		return $path;
	}
}