664 lines
18 KiB
PHP
664 lines
18 KiB
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.
|
|
*/
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* Filesystem functions are not called directly; they are passed to the correct
|
|
* \OC\Files\Storage\Storage object
|
|
*/
|
|
|
|
namespace OC\Files;
|
|
|
|
class View {
|
|
private $fakeRoot = '';
|
|
private $internal_path_cache = array();
|
|
private $storage_cache = array();
|
|
|
|
public function __construct($root) {
|
|
$this->fakeRoot = $root;
|
|
}
|
|
|
|
public function getAbsolutePath($path) {
|
|
if (!$path) {
|
|
$path = '/';
|
|
}
|
|
if ($path[0] !== '/') {
|
|
$path = '/' . $path;
|
|
}
|
|
return $this->fakeRoot . $path;
|
|
}
|
|
|
|
/**
|
|
* change the root to a fake root
|
|
*
|
|
* @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 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 {
|
|
$path = substr($path, strlen($this->fakeRoot));
|
|
if (strlen($path) === 0) {
|
|
return '/';
|
|
} else {
|
|
return $path;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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 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, '/'));
|
|
list($storage, $internalPath)=\OC\Files\Filesystem::resolvePath($path);
|
|
if (Filesystem::isValidPath($parent) and $storage) {
|
|
return $storage->getLocalFile($internalPath);
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $path
|
|
* @return string
|
|
*/
|
|
public function getLocalFolder($path) {
|
|
$parent = substr($path, 0, strrpos($path, '/'));
|
|
list($storage, $internalPath)=\OC\Files\Filesystem::resolvePath($path);
|
|
if (Filesystem::isValidPath($parent) and $storage) {
|
|
return $storage->getLocalFolder($internalPath);
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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\Files\Storage\Storage via basicOperation().
|
|
*/
|
|
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\Files\Storage\Local(array('datadir' => '/'));
|
|
return $fsLocal->readdir($handle);
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* @deprecated Replaced by isReadable() as part of CRUDS
|
|
*/
|
|
public function is_readable($path) {
|
|
return $this->basicOperation('isReadable', $path);
|
|
}
|
|
|
|
/**
|
|
* @deprecated Replaced by isCreatable(), isUpdatable(), isDeletable() as part of CRUDS
|
|
*/
|
|
public function is_writable($path) {
|
|
return $this->basicOperation('isUpdatable', $path);
|
|
}
|
|
|
|
public function isCreatable($path) {
|
|
return $this->basicOperation('isCreatable', $path);
|
|
}
|
|
|
|
public function isReadable($path) {
|
|
return $this->basicOperation('isReadable', $path);
|
|
}
|
|
|
|
public function isUpdatable($path) {
|
|
return $this->basicOperation('isUpdatable', $path);
|
|
}
|
|
|
|
public function isDeletable($path) {
|
|
return $this->basicOperation('isDeletable', $path);
|
|
}
|
|
|
|
public function isSharable($path) {
|
|
return $this->basicOperation('isSharable', $path);
|
|
}
|
|
|
|
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);
|
|
}
|
|
|
|
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
|
|
$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
|
|
if (\OC_FileProxy::runPreProxies('file_put_contents', $absolutePath, $data) && Filesystem::isValidPath($path)) {
|
|
$path = $this->getRelativePath($absolutePath);
|
|
$exists = $this->file_exists($path);
|
|
$run = true;
|
|
if ($this->fakeRoot == Filesystem::getRoot()) {
|
|
if (!$exists) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_create,
|
|
array(
|
|
Filesystem::signal_param_path => $path,
|
|
Filesystem::signal_param_run => &$run
|
|
)
|
|
);
|
|
}
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_write,
|
|
array(
|
|
Filesystem::signal_param_path => $path,
|
|
Filesystem::signal_param_run => &$run
|
|
)
|
|
);
|
|
}
|
|
if (!$run) {
|
|
return false;
|
|
}
|
|
$target = $this->fopen($path, 'w');
|
|
if ($target) {
|
|
$count = \OC_Helper::streamCopy($data, $target);
|
|
fclose($target);
|
|
fclose($data);
|
|
if ($this->fakeRoot == Filesystem::getRoot()) {
|
|
if (!$exists) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_post_create,
|
|
array(Filesystem::signal_param_path => $path)
|
|
);
|
|
}
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_post_write,
|
|
array(Filesystem::signal_param_path => $path)
|
|
);
|
|
}
|
|
\OC_FileProxy::runPostProxies('file_put_contents', $absolutePath, $count);
|
|
return $count > 0;
|
|
} else {
|
|
return false;
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
} else {
|
|
return $this->basicOperation('file_put_contents', $path, array('create', 'write'), $data);
|
|
}
|
|
}
|
|
|
|
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);
|
|
}
|
|
|
|
public function rename($path1, $path2) {
|
|
$postFix1 = (substr($path1, -1, 1) === '/') ? '/' : '';
|
|
$postFix2 = (substr($path2, -1, 1) === '/') ? '/' : '';
|
|
$absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
|
|
$absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
|
|
if (\OC_FileProxy::runPreProxies('rename', $absolutePath1, $absolutePath2) and Filesystem::isValidPath($path2)) {
|
|
$path1 = $this->getRelativePath($absolutePath1);
|
|
$path2 = $this->getRelativePath($absolutePath2);
|
|
|
|
if ($path1 == null or $path2 == null) {
|
|
return false;
|
|
}
|
|
$run = true;
|
|
if ($this->fakeRoot == Filesystem::getRoot()) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME, Filesystem::signal_rename,
|
|
array(
|
|
Filesystem::signal_param_oldpath => $path1,
|
|
Filesystem::signal_param_newpath => $path2,
|
|
Filesystem::signal_param_run => &$run
|
|
)
|
|
);
|
|
}
|
|
if ($run) {
|
|
$mp1 = $this->getMountPoint($path1 . $postFix1);
|
|
$mp2 = $this->getMountPoint($path2 . $postFix2);
|
|
if ($mp1 == $mp2) {
|
|
list($storage, $internalPath1)=\OC\Files\Filesystem::resolvePath($path1 . $postFix1);
|
|
list( , $internalPath2)=\OC\Files\Filesystem::resolvePath($path2 . $postFix2);
|
|
if ($storage) {
|
|
$result = $storage->rename($internalPath1, $internalPath2);
|
|
} else {
|
|
$result = false;
|
|
}
|
|
} else {
|
|
$source = $this->fopen($path1 . $postFix1, 'r');
|
|
$target = $this->fopen($path2 . $postFix2, 'w');
|
|
$count = \OC_Helper::streamCopy($source, $target);
|
|
list($storage1, $internalPath1)=\OC\Files\Filesystem::resolvePath($path1 . $postFix1);
|
|
$storage1->unlink($internalPath1);
|
|
$result = $count > 0;
|
|
}
|
|
if ($this->fakeRoot == Filesystem::getRoot()) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_post_rename,
|
|
array(
|
|
Filesystem::signal_param_oldpath => $path1,
|
|
Filesystem::signal_param_newpath => $path2
|
|
)
|
|
);
|
|
}
|
|
return $result;
|
|
} else {
|
|
return false;
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function copy($path1, $path2) {
|
|
$postFix1 = (substr($path1, -1, 1) === '/') ? '/' : '';
|
|
$postFix2 = (substr($path2, -1, 1) === '/') ? '/' : '';
|
|
$absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
|
|
$absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
|
|
if (\OC_FileProxy::runPreProxies('copy', $absolutePath1, $absolutePath2) and Filesystem::isValidPath($path2)) {
|
|
$path1 = $this->getRelativePath($absolutePath1);
|
|
$path2 = $this->getRelativePath($absolutePath2);
|
|
|
|
if ($path1 == null or $path2 == null) {
|
|
return false;
|
|
}
|
|
$run = true;
|
|
$exists = $this->file_exists($path2);
|
|
if ($this->fakeRoot == Filesystem::getRoot()) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_copy,
|
|
array(
|
|
Filesystem::signal_param_oldpath => $path1,
|
|
Filesystem::signal_param_newpath => $path2,
|
|
Filesystem::signal_param_run => &$run
|
|
)
|
|
);
|
|
if ($run and !$exists) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_create,
|
|
array(
|
|
Filesystem::signal_param_path => $path2,
|
|
Filesystem::signal_param_run => &$run
|
|
)
|
|
);
|
|
}
|
|
if ($run) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_write,
|
|
array(
|
|
Filesystem::signal_param_path => $path2,
|
|
Filesystem::signal_param_run => &$run
|
|
)
|
|
);
|
|
}
|
|
}
|
|
if ($run) {
|
|
$mp1 = $this->getMountPoint($path1 . $postFix1);
|
|
$mp2 = $this->getMountPoint($path2 . $postFix2);
|
|
if ($mp1 == $mp2) {
|
|
list($storage, $internalPath1)=\OC\Files\Filesystem::resolvePath($path1 . $postFix1);
|
|
list( , $internalPath2)=\OC\Files\Filesystem::resolvePath($path2 . $postFix2);
|
|
if ($storage) {
|
|
$result = $storage->copy($internalPath1, $internalPath2);
|
|
} else {
|
|
$result = false;
|
|
}
|
|
} else {
|
|
$source = $this->fopen($path1 . $postFix1, 'r');
|
|
$target = $this->fopen($path2 . $postFix2, 'w');
|
|
$result = \OC_Helper::streamCopy($source, $target);
|
|
}
|
|
if ($this->fakeRoot == Filesystem::getRoot()) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_post_copy,
|
|
array(
|
|
Filesystem::signal_param_oldpath => $path1,
|
|
Filesystem::signal_param_newpath => $path2
|
|
)
|
|
);
|
|
if (!$exists) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_post_create,
|
|
array(Filesystem::signal_param_path => $path2)
|
|
);
|
|
}
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_post_write,
|
|
array(Filesystem::signal_param_path => $path2)
|
|
);
|
|
} else { // no real copy, file comes from somewhere else, e.g. version rollback -> just update the file cache and the webdav properties without all the other post_write actions
|
|
// OC_FileCache_Update::update($path2, $this->fakeRoot);
|
|
Filesystem::removeETagHook(array("path" => $path2), $this->fakeRoot);
|
|
}
|
|
return $result;
|
|
} else {
|
|
return false;
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function fopen($path, $mode) {
|
|
$hooks = array();
|
|
switch ($mode) {
|
|
case 'r':
|
|
case 'rb':
|
|
$hooks[] = 'read';
|
|
break;
|
|
case 'r+':
|
|
case 'rb+':
|
|
case 'w+':
|
|
case 'wb+':
|
|
case 'x+':
|
|
case 'xb+':
|
|
case 'a+':
|
|
case 'ab+':
|
|
$hooks[] = 'read';
|
|
$hooks[] = 'write';
|
|
break;
|
|
case 'w':
|
|
case 'wb':
|
|
case 'x':
|
|
case 'xb':
|
|
case 'a':
|
|
case 'ab':
|
|
$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 (Filesystem::isValidPath($path)) {
|
|
$source = $this->fopen($path, 'r');
|
|
if ($source) {
|
|
$extension = '';
|
|
$extOffset = strpos($path, '.');
|
|
if ($extOffset !== false) {
|
|
$extension = substr($path, strrpos($path, '.'));
|
|
}
|
|
$tmpFile = \OC_Helper::tmpFile($extension);
|
|
file_put_contents($tmpFile, $source);
|
|
return $tmpFile;
|
|
} else {
|
|
return false;
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function fromTmpFile($tmpFile, $path) {
|
|
if (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 {
|
|
return false;
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function getMimeType($path) {
|
|
return $this->basicOperation('getMimeType', $path);
|
|
}
|
|
|
|
public function hash($type, $path, $raw = false) {
|
|
$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
|
|
$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
|
|
if (\OC_FileProxy::runPreProxies('hash', $absolutePath) && Filesystem::isValidPath($path)) {
|
|
$path = $this->getRelativePath($absolutePath);
|
|
if ($path == null) {
|
|
return false;
|
|
}
|
|
if (Filesystem::$loaded && $this->fakeRoot == Filesystem::getRoot()) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
Filesystem::signal_read,
|
|
array(Filesystem::signal_param_path => $path)
|
|
);
|
|
}
|
|
list($storage, $internalPath)=\OC\Files\Filesystem::resolvePath($path . $postFix);
|
|
if ($storage) {
|
|
$result = $storage->hash($type, $internalPath, $raw);
|
|
$result = \OC_FileProxy::runPostProxies('hash', $absolutePath, $result);
|
|
return $result;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
public function free_space($path = '/') {
|
|
return $this->basicOperation('free_space', $path);
|
|
}
|
|
|
|
/**
|
|
* @brief abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
|
|
* @param string $operation
|
|
* @param string $path
|
|
* @param array $hooks (optional)
|
|
* @param mixed $extraParam (optional)
|
|
* @return mixed
|
|
*
|
|
* 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\Files\Storage\Storage for delegation to a storage backend for execution
|
|
*/
|
|
private function basicOperation($operation, $path, $hooks = array(), $extraParam = null) {
|
|
$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
|
|
$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
|
|
if (\OC_FileProxy::runPreProxies($operation, $absolutePath, $extraParam) and Filesystem::isValidPath($path)) {
|
|
$path = $this->getRelativePath($absolutePath);
|
|
if ($path == null) {
|
|
return false;
|
|
}
|
|
$run = $this->runHooks($hooks, $path);
|
|
list($storage, $internalPath)=\OC\Files\Filesystem::resolvePath($path . $postFix);
|
|
if ($run and $storage) {
|
|
if (!is_null($extraParam)) {
|
|
$result = $storage->$operation($internalPath, $extraParam);
|
|
} else {
|
|
$result = $storage->$operation($internalPath);
|
|
}
|
|
$result = \OC_FileProxy::runPostProxies($operation, $this->getAbsolutePath($path), $result);
|
|
if (Filesystem::$loaded and $this->fakeRoot == Filesystem::getRoot()) {
|
|
if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open
|
|
$this->runHooks($hooks, $path, true);
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
private function runHooks($hooks, $path, $post = false) {
|
|
$prefix = ($post) ? 'post_' : '';
|
|
$run = true;
|
|
if (Filesystem::$loaded and $this->fakeRoot == Filesystem::getRoot()) {
|
|
foreach ($hooks as $hook) {
|
|
if ($hook != 'read') {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
$prefix . $hook,
|
|
array(
|
|
Filesystem::signal_param_run => &$run,
|
|
Filesystem::signal_param_path => $path
|
|
)
|
|
);
|
|
} elseif (!$post) {
|
|
\OC_Hook::emit(
|
|
Filesystem::CLASSNAME,
|
|
$prefix . $hook,
|
|
array(
|
|
Filesystem::signal_param_path => $path
|
|
)
|
|
);
|
|
}
|
|
}
|
|
}
|
|
return $run;
|
|
}
|
|
|
|
/**
|
|
* 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->basicOperation('hasUpdated', $path, array(), $time);
|
|
}
|
|
}
|