nextcloud/lib/files/view.php

1049 lines
29 KiB
PHP
Raw Normal View History

2012-01-20 03:40:52 +04:00
<?php
/**
2012-10-10 13:54:44 +04:00
* 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.
*/
/**
2012-07-21 23:44:10 +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
2012-05-31 20:32:34 +04:00
* OC_Filesystem are merely a wrapper for OC_FilesystemView).
2012-07-21 23:44:10 +04:00
*
2012-05-31 20:32:34 +04:00
* 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
2012-07-21 23:44:10 +04:00
* built-in file manipulation functions. This will ensure all hooks and proxies
2012-05-31 20:32:34 +04:00
* are triggered correctly.
2012-05-31 20:57:34 +04:00
*
2012-07-21 23:44:10 +04:00
* Filesystem functions are not called directly; they are passed to the correct
2012-09-07 20:30:48 +04:00
* \OC\Files\Storage\Storage object
*/
2012-01-20 03:40:52 +04:00
2012-10-10 13:54:44 +04:00
namespace OC\Files;
class View {
private $fakeRoot = '';
private $internal_path_cache = array();
private $storage_cache = array();
2012-07-21 23:44:10 +04:00
public function __construct($root) {
2012-10-10 13:54:44 +04:00
$this->fakeRoot = $root;
2012-01-20 03:40:52 +04:00
}
2012-11-07 20:18:56 +04:00
public function getAbsolutePath($path = '/') {
2012-10-10 13:54:44 +04:00
if (!$path) {
$path = '/';
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
if ($path[0] !== '/') {
$path = '/' . $path;
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
return $this->fakeRoot . $path;
2012-01-20 03:40:52 +04:00
}
2012-08-29 10:38:33 +04:00
2012-01-20 03:40:52 +04:00
/**
* change the root to a fake root
2012-10-10 13:54:44 +04:00
*
* @param string $fakeRoot
2012-10-10 13:54:44 +04:00
* @return bool
*/
2012-07-21 23:44:10 +04:00
public function chroot($fakeRoot) {
2012-10-10 13:54:44 +04:00
if (!$fakeRoot == '') {
if ($fakeRoot[0] !== '/') {
$fakeRoot = '/' . $fakeRoot;
2012-01-20 03:40:52 +04:00
}
}
2012-10-10 13:54:44 +04:00
$this->fakeRoot = $fakeRoot;
2012-01-20 03:40:52 +04:00
}
/**
* get the fake root
2012-10-10 13:54:44 +04:00
*
2012-01-20 03:40:52 +04:00
* @return string
*/
2012-07-21 23:44:10 +04:00
public function getRoot() {
2012-01-20 03:40:52 +04:00
return $this->fakeRoot;
}
2012-06-09 19:33:57 +04:00
/**
* get path relative to the root of the view
2012-10-10 13:54:44 +04:00
*
* @param string $path
2012-06-09 19:33:57 +04:00
* @return string
*/
2012-07-21 23:44:10 +04:00
public function getRelativePath($path) {
2012-10-10 13:54:44 +04:00
if ($this->fakeRoot == '') {
2012-06-09 19:33:57 +04:00
return $path;
}
2012-10-10 13:54:44 +04:00
if (strpos($path, $this->fakeRoot) !== 0) {
2012-06-09 19:33:57 +04:00
return null;
2012-10-10 13:54:44 +04:00
} else {
$path = substr($path, strlen($this->fakeRoot));
if (strlen($path) === 0) {
return '/';
2012-10-10 13:54:44 +04:00
} else {
return $path;
}
2012-06-09 19:33:57 +04:00
}
}
2012-07-21 23:44:10 +04:00
2012-01-20 03:40:52 +04:00
/**
2012-10-10 13:54:44 +04:00
* get the mountpoint of the storage object for a path
2013-02-11 20:44:02 +04:00
* ( 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 )
2012-10-10 13:54:44 +04:00
*
* @param string $path
2012-10-10 13:54:44 +04:00
* @return string
*/
2012-07-21 23:44:10 +04:00
public function getMountPoint($path) {
return Filesystem::getMountPoint($this->getAbsolutePath($path));
2012-01-20 03:40:52 +04:00
}
2012-11-08 20:42:26 +04:00
/**
* resolve a path to a storage and internal path
*
* @param string $path
* @return array consisting of the storage and the internal path
*/
public function resolvePath($path) {
return Filesystem::resolvePath($this->getAbsolutePath($path));
}
2012-01-20 03:40:52 +04:00
/**
2012-10-10 13:54:44 +04:00
* return the path to a local version of the file
2013-02-11 20:44:02 +04:00
* 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
2012-10-10 13:54:44 +04:00
*
* @param string $path
2012-10-10 13:54:44 +04:00
* @return string
*/
2012-07-21 23:44:10 +04:00
public function getLocalFile($path) {
2012-10-10 13:54:44 +04:00
$parent = substr($path, 0, strrpos($path, '/'));
$path = $this->getAbsolutePath($path);
2012-10-26 15:23:15 +04:00
list($storage, $internalPath) = Filesystem::resolvePath($path);
if (Filesystem::isValidPath($parent) and $storage) {
return $storage->getLocalFile($internalPath);
} else {
return null;
2012-01-20 03:40:52 +04:00
}
}
2012-10-10 13:54:44 +04:00
/**
* @param string $path
* @return string
*/
public function getLocalFolder($path) {
2012-10-10 13:54:44 +04:00
$parent = substr($path, 0, strrpos($path, '/'));
$path = $this->getAbsolutePath($path);
2012-10-26 15:23:15 +04:00
list($storage, $internalPath) = Filesystem::resolvePath($path);
if (Filesystem::isValidPath($parent) and $storage) {
return $storage->getLocalFolder($internalPath);
} else {
return null;
}
}
2012-01-20 03:40:52 +04:00
/**
2012-07-21 23:44:10 +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
2012-09-07 20:30:48 +04:00
* for \OC\Files\Storage\Storage via basicOperation().
2012-01-20 03:40:52 +04:00
*/
2012-07-21 23:44:10 +04:00
public function mkdir($path) {
return $this->basicOperation('mkdir', $path, array('create', 'write'));
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function rmdir($path) {
return $this->basicOperation('rmdir', $path, array('delete'));
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function opendir($path) {
return $this->basicOperation('opendir', $path, array('read'));
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function readdir($handle) {
2012-10-26 15:23:15 +04:00
$fsLocal = new Storage\Local(array('datadir' => '/'));
2012-10-10 13:54:44 +04:00
return $fsLocal->readdir($handle);
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function is_dir($path) {
2012-10-10 13:54:44 +04:00
if ($path == '/') {
2012-01-20 03:40:52 +04:00
return true;
}
2012-07-21 23:44:10 +04:00
return $this->basicOperation('is_dir', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function is_file($path) {
2012-10-10 13:54:44 +04:00
if ($path == '/') {
2012-01-20 03:40:52 +04:00
return false;
}
2012-07-21 23:44:10 +04:00
return $this->basicOperation('is_file', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function stat($path) {
return $this->basicOperation('stat', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function filetype($path) {
return $this->basicOperation('filetype', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function filesize($path) {
return $this->basicOperation('filesize', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function readfile($path) {
@ob_end_clean();
2012-10-10 13:54:44 +04:00
$handle = $this->fopen($path, 'rb');
if ($handle) {
$chunkSize = 8192; // 8 kB chunks
while (!feof($handle)) {
echo fread($handle, $chunkSize);
flush();
}
2012-10-10 13:54:44 +04:00
$size = $this->filesize($path);
return $size;
}
return false;
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
public function isCreatable($path) {
return $this->basicOperation('isCreatable', $path);
}
2012-10-10 13:54:44 +04:00
public function isReadable($path) {
return $this->basicOperation('isReadable', $path);
}
2012-10-10 13:54:44 +04:00
public function isUpdatable($path) {
return $this->basicOperation('isUpdatable', $path);
}
2012-10-10 13:54:44 +04:00
public function isDeletable($path) {
return $this->basicOperation('isDeletable', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
public function isSharable($path) {
return $this->basicOperation('isSharable', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function file_exists($path) {
2012-10-10 13:54:44 +04:00
if ($path == '/') {
2012-01-20 03:40:52 +04:00
return true;
}
2012-07-21 23:44:10 +04:00
return $this->basicOperation('file_exists', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function filemtime($path) {
return $this->basicOperation('filemtime', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
public function touch($path, $mtime = null) {
if (!is_null($mtime) and !is_numeric($mtime)) {
$mtime = strtotime($mtime);
}
2013-03-07 18:51:44 +04:00
$hooks = array('touch');
2013-03-07 18:51:44 +04:00
if (!$this->file_exists($path)) {
$hooks[] = 'write';
}
$result = $this->basicOperation('touch', $path, $hooks, $mtime);
if (!$result) { //if native touch fails, we emulate it by changing the mtime in the cache
$this->putFileInfo($path, array('mtime' => $mtime));
}
return true;
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function file_get_contents($path) {
return $this->basicOperation('file_get_contents', $path, array('read'));
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function file_put_contents($path, $data) {
2012-10-10 13:54:44 +04:00
if (is_resource($data)) { //not having to deal with streams in file_put_contents makes life easier
$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
2013-02-11 20:44:02 +04:00
if (\OC_FileProxy::runPreProxies('file_put_contents', $absolutePath, $data)
and Filesystem::isValidPath($path)
and !Filesystem::isFileBlacklisted($path)
) {
$path = $this->getRelativePath($absolutePath);
$exists = $this->file_exists($path);
$run = true;
if ($this->fakeRoot == Filesystem::getRoot() && !Cache\Scanner::isPartialFile($path)) {
2012-10-10 13:54:44 +04:00
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
)
);
}
2012-10-10 13:54:44 +04:00
if (!$run) {
return false;
}
2012-10-10 13:54:44 +04:00
$target = $this->fopen($path, 'w');
if ($target) {
list ($count, $result) = \OC_Helper::streamCopy($data, $target);
fclose($target);
fclose($data);
if ($this->fakeRoot == Filesystem::getRoot() && !Cache\Scanner::isPartialFile($path) && $result !== false) {
2012-10-10 13:54:44 +04:00
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 $result;
2012-10-10 13:54:44 +04:00
} else {
return false;
}
} else {
return false;
}
2012-10-10 13:54:44 +04:00
} else {
2012-07-21 23:44:10 +04:00
return $this->basicOperation('file_put_contents', $path, array('create', 'write'), $data);
}
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function unlink($path) {
return $this->basicOperation('unlink', $path, array('delete'));
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
public function deleteAll($directory, $empty = false) {
return $this->basicOperation('deleteAll', $directory, array('delete'), $empty);
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function rename($path1, $path2) {
2012-10-10 13:54:44 +04:00
$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)
and Filesystem::isValidPath($path1)
and !Filesystem::isFileBlacklisted($path2)
) {
2012-07-21 23:44:10 +04:00
$path1 = $this->getRelativePath($absolutePath1);
$path2 = $this->getRelativePath($absolutePath2);
2012-08-29 10:38:33 +04:00
2012-10-10 13:54:44 +04:00
if ($path1 == null or $path2 == null) {
2012-06-09 19:33:57 +04:00
return false;
}
2012-10-10 13:54:44 +04:00
$run = true;
if ($this->fakeRoot == Filesystem::getRoot() && (Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2))) {
// if it was a rename from a part file to a regular file it was a write and not a rename operation
\OC_Hook::emit(
Filesystem::CLASSNAME, Filesystem::signal_write,
array(
Filesystem::signal_param_path => $path2,
Filesystem::signal_param_run => &$run
)
);
} elseif ($this->fakeRoot == Filesystem::getRoot()) {
\OC_Hook::emit(
Filesystem::CLASSNAME, Filesystem::signal_rename,
2012-10-10 13:54:44 +04:00
array(
Filesystem::signal_param_oldpath => $path1,
Filesystem::signal_param_newpath => $path2,
Filesystem::signal_param_run => &$run
2012-10-10 13:54:44 +04:00
)
);
}
2012-10-10 13:54:44 +04:00
if ($run) {
$mp1 = $this->getMountPoint($path1 . $postFix1);
$mp2 = $this->getMountPoint($path2 . $postFix2);
if ($mp1 == $mp2) {
list($storage, $internalPath1) = Filesystem::resolvePath($absolutePath1 . $postFix1);
list(, $internalPath2) = Filesystem::resolvePath($absolutePath2 . $postFix2);
if ($storage) {
$result = $storage->rename($internalPath1, $internalPath2);
\OC_FileProxy::runPostProxies('rename', $absolutePath1, $absolutePath2);
} else {
$result = false;
2012-01-20 03:40:52 +04:00
}
2012-07-21 23:44:10 +04:00
} else {
if ($this->is_dir($path1)) {
$result = $this->copy($path1, $path2);
if ($result === true) {
list($storage1, $internalPath1) = Filesystem::resolvePath($absolutePath1 . $postFix1);
$result = $storage1->deleteAll($internalPath1);
}
} else {
$source = $this->fopen($path1 . $postFix1, 'r');
$target = $this->fopen($path2 . $postFix2, 'w');
list($count, $result) = \OC_Helper::streamCopy($source, $target);
// close open handle - especially $source is necessary because unlink below will
// throw an exception on windows because the file is locked
fclose($source);
fclose($target);
if ($result !== false) {
list($storage1, $internalPath1) = Filesystem::resolvePath($absolutePath1 . $postFix1);
$storage1->unlink($internalPath1);
}
}
2012-08-29 10:38:33 +04:00
}
if ($this->fakeRoot == Filesystem::getRoot() && (Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
// if it was a rename from a part file to a regular file it was a write and not a rename operation
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_post_write,
array(
Filesystem::signal_param_path => $path2,
)
);
} elseif ($this->fakeRoot == Filesystem::getRoot() && $result !== false) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_post_rename,
array(
Filesystem::signal_param_oldpath => $path1,
Filesystem::signal_param_newpath => $path2
)
);
}
2012-01-20 03:40:52 +04:00
return $result;
} else {
return false;
2012-01-20 03:40:52 +04:00
}
} else {
return false;
2012-01-20 03:40:52 +04:00
}
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function copy($path1, $path2) {
2012-10-10 13:54:44 +04:00
$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)
and Filesystem::isValidPath($path1)
and !Filesystem::isFileBlacklisted($path2)
) {
2012-07-21 23:44:10 +04:00
$path1 = $this->getRelativePath($absolutePath1);
$path2 = $this->getRelativePath($absolutePath2);
2012-08-29 10:38:33 +04:00
2012-10-10 13:54:44 +04:00
if ($path1 == null or $path2 == null) {
2012-06-09 19:33:57 +04:00
return false;
}
2012-10-10 13:54:44 +04:00
$run = true;
$exists = $this->file_exists($path2);
if ($this->fakeRoot == Filesystem::getRoot()) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_copy,
2012-07-21 23:44:10 +04:00
array(
Filesystem::signal_param_oldpath => $path1,
Filesystem::signal_param_newpath => $path2,
Filesystem::signal_param_run => &$run
2012-07-21 23:44:10 +04:00
)
);
2012-10-10 13:54:44 +04:00
if ($run and !$exists) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_create,
array(
Filesystem::signal_param_path => $path2,
Filesystem::signal_param_run => &$run
)
);
}
2012-10-10 13:54:44 +04:00
if ($run) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_write,
array(
Filesystem::signal_param_path => $path2,
Filesystem::signal_param_run => &$run
)
);
}
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
if ($run) {
$mp1 = $this->getMountPoint($path1 . $postFix1);
$mp2 = $this->getMountPoint($path2 . $postFix2);
if ($mp1 == $mp2) {
list($storage, $internalPath1) = Filesystem::resolvePath($absolutePath1 . $postFix1);
list(, $internalPath2) = Filesystem::resolvePath($absolutePath2 . $postFix2);
if ($storage) {
$result = $storage->copy($internalPath1, $internalPath2);
} else {
$result = false;
2012-01-20 03:40:52 +04:00
}
2012-07-21 23:44:10 +04:00
} else {
if ($this->is_dir($path1) && ($dh = $this->opendir($path1))) {
$result = $this->mkdir($path2);
while ($file = readdir($dh)) {
if (!Filesystem::isIgnoredDir($file)) {
$result = $this->copy($path1 . '/' . $file, $path2 . '/' . $file);
}
}
} else {
$source = $this->fopen($path1 . $postFix1, 'r');
$target = $this->fopen($path2 . $postFix2, 'w');
list($count, $result) = \OC_Helper::streamCopy($source, $target);
}
2012-01-20 03:40:52 +04:00
}
if ($this->fakeRoot == Filesystem::getRoot() && $result !== false) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_post_copy,
array(
Filesystem::signal_param_oldpath => $path1,
Filesystem::signal_param_newpath => $path2
)
);
2012-10-10 13:54:44 +04:00
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)
2012-07-21 23:44:10 +04:00
);
2012-01-20 03:40:52 +04:00
}
return $result;
} else {
return false;
2012-01-20 03:40:52 +04:00
}
} else {
return false;
2012-01-20 03:40:52 +04:00
}
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function fopen($path, $mode) {
2012-10-10 13:54:44 +04:00
$hooks = array();
switch ($mode) {
2012-01-20 03:40:52 +04:00
case 'r':
2012-02-26 18:32:58 +04:00
case 'rb':
2012-10-10 13:54:44 +04:00
$hooks[] = 'read';
2012-01-20 03:40:52 +04:00
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-10-10 13:54:44 +04:00
$hooks[] = 'read';
$hooks[] = 'write';
2012-01-20 03:40:52 +04:00
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-10-10 13:54:44 +04:00
$hooks[] = 'write';
2012-01-20 03:40:52 +04:00
break;
default:
\OC_Log::write('core', 'invalid mode (' . $mode . ') for ' . $path, \OC_Log::ERROR);
2012-01-20 03:40:52 +04:00
}
2012-07-21 23:44:10 +04:00
return $this->basicOperation('fopen', $path, $hooks, $mode);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function toTmpFile($path) {
if (Filesystem::isValidPath($path)) {
2012-07-21 23:44:10 +04:00
$source = $this->fopen($path, 'r');
2012-10-10 13:54:44 +04:00
if ($source) {
$extension = pathinfo($path, PATHINFO_EXTENSION);
$tmpFile = \OC_Helper::tmpFile($extension);
2012-07-21 23:44:10 +04:00
file_put_contents($tmpFile, $source);
return $tmpFile;
} else {
return false;
}
} else {
return false;
2012-01-20 03:40:52 +04:00
}
}
2012-10-10 13:54:44 +04:00
2012-07-21 23:44:10 +04:00
public function fromTmpFile($tmpFile, $path) {
if (Filesystem::isValidPath($path)) {
2012-10-10 13:54:44 +04:00
if (!$tmpFile) {
debug_print_backtrace();
}
2012-10-10 13:54:44 +04:00
$source = fopen($tmpFile, 'r');
if ($source) {
2012-07-21 23:44:10 +04:00
$this->file_put_contents($path, $source);
unlink($tmpFile);
return true;
2012-07-21 23:44:10 +04:00
} else {
return false;
2012-01-20 03:40:52 +04:00
}
2012-07-21 23:44:10 +04:00
} else {
return false;
2012-01-20 03:40:52 +04:00
}
}
2012-07-21 23:44:10 +04:00
public function getMimeType($path) {
return $this->basicOperation('getMimeType', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
public function hash($type, $path, $raw = false) {
2012-10-10 13:54:44 +04:00
$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) = Filesystem::resolvePath($absolutePath . $postFix);
if ($storage) {
$result = $storage->hash($type, $internalPath, $raw);
$result = \OC_FileProxy::runPostProxies('hash', $absolutePath, $result);
return $result;
}
}
return null;
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
public function free_space($path = '/') {
2012-07-21 23:44:10 +04:00
return $this->basicOperation('free_space', $path);
2012-01-20 03:40:52 +04:00
}
/**
2012-09-07 20:30:48 +04:00
* @brief abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
2012-01-20 03:40:52 +04:00
* @param string $operation
* @param string $path
* @param array $hooks (optional)
* @param mixed $extraParam (optional)
2012-01-20 03:40:52 +04:00
* @return mixed
2012-07-21 23:44:10 +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
2012-09-07 20:30:48 +04:00
* \OC\Files\Storage\Storage for delegation to a storage backend for execution
2012-01-20 03:40:52 +04:00
*/
2012-10-10 13:54:44 +04:00
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)
and !Filesystem::isFileBlacklisted($path)
) {
2012-07-21 23:44:10 +04:00
$path = $this->getRelativePath($absolutePath);
2012-10-10 13:54:44 +04:00
if ($path == null) {
2012-06-09 19:33:57 +04:00
return false;
}
2012-10-10 13:54:44 +04:00
$run = $this->runHooks($hooks, $path);
list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
if ($run and $storage) {
2012-10-10 13:54:44 +04:00
if (!is_null($extraParam)) {
2012-07-21 23:44:10 +04:00
$result = $storage->$operation($internalPath, $extraParam);
} else {
$result = $storage->$operation($internalPath);
2012-01-20 03:40:52 +04:00
}
$result = \OC_FileProxy::runPostProxies($operation, $this->getAbsolutePath($path), $result);
if (Filesystem::$loaded and $this->fakeRoot == Filesystem::getRoot() && $result !== false) {
2012-10-10 13:54:44 +04:00
if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open
$this->runHooks($hooks, $path, true);
2012-01-20 03:40:52 +04:00
}
}
return $result;
}
}
return null;
}
2012-10-10 13:54:44 +04:00
private function runHooks($hooks, $path, $post = false) {
$prefix = ($post) ? 'post_' : '';
$run = true;
2013-07-01 19:00:17 +04:00
if (Filesystem::$loaded and $this->fakeRoot == Filesystem::getRoot() && !Cache\Scanner::isPartialFile($path)) {
2012-10-10 13:54:44 +04:00
foreach ($hooks as $hook) {
if ($hook != 'read') {
\OC_Hook::emit(
Filesystem::CLASSNAME,
2012-10-10 13:54:44 +04:00
$prefix . $hook,
2012-08-17 03:22:26 +04:00
array(
Filesystem::signal_param_run => &$run,
Filesystem::signal_param_path => $path
2012-08-17 03:22:26 +04:00
)
);
2012-10-10 13:54:44 +04:00
} elseif (!$post) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
2012-10-10 13:54:44 +04:00
$prefix . $hook,
2012-08-17 03:22:26 +04:00
array(
Filesystem::signal_param_path => $path
2012-08-17 03:22:26 +04:00
)
);
}
}
}
return $run;
}
/**
* check if a file or folder has been updated since $time
2012-10-10 13:54:44 +04:00
*
* @param string $path
* @param int $time
* @return bool
*/
2012-07-21 23:44:10 +04:00
public function hasUpdated($path, $time) {
return $this->basicOperation('hasUpdated', $path, array(), $time);
}
/**
* get the filesystem info
*
* @param string $path
* @return array
*
* returns an associative array with the following keys:
* - size
* - mtime
* - mimetype
* - encrypted
* - versioned
*/
public function getFileInfo($path) {
2012-11-25 01:42:54 +04:00
$data = array();
if (!Filesystem::isValidPath($path)) {
return $data;
}
2012-10-26 15:23:15 +04:00
$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
/**
* @var \OC\Files\Storage\Storage $storage
* @var string $internalPath
*/
2012-10-26 15:23:15 +04:00
list($storage, $internalPath) = Filesystem::resolvePath($path);
2012-11-25 01:42:54 +04:00
if ($storage) {
$cache = $storage->getCache($internalPath);
$permissionsCache = $storage->getPermissionsCache($internalPath);
$user = \OC_User::getUser();
2012-11-25 01:42:54 +04:00
if (!$cache->inCache($internalPath)) {
$scanner = $storage->getScanner($internalPath);
2012-11-25 01:42:54 +04:00
$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
} else {
$watcher = $storage->getWatcher($internalPath);
2012-11-25 01:42:54 +04:00
$watcher->checkUpdate($internalPath);
}
2012-11-25 01:42:54 +04:00
$data = $cache->get($internalPath);
2013-01-07 04:40:09 +04:00
if ($data and $data['fileid']) {
if ($data['mimetype'] === 'httpd/unix-directory') {
//add the sizes of other mountpoints to the folder
$mountPoints = Filesystem::getMountPoints($path);
foreach ($mountPoints as $mountPoint) {
$subStorage = Filesystem::getStorage($mountPoint);
2012-12-16 02:16:26 +04:00
if ($subStorage) {
$subCache = $subStorage->getCache('');
2012-12-16 02:16:26 +04:00
$rootEntry = $subCache->get('');
2013-06-25 14:24:14 +04:00
$data['size'] += isset($rootEntry['size']) ? $rootEntry['size'] : 0;
2012-12-16 02:16:26 +04:00
}
}
2012-11-25 01:42:54 +04:00
}
$permissions = $permissionsCache->get($data['fileid'], $user);
if ($permissions === -1) {
$permissions = $storage->getPermissions($internalPath);
$permissionsCache->set($data['fileid'], $user, $permissions);
}
$data['permissions'] = $permissions;
}
2012-11-25 01:42:54 +04:00
}
$data = \OC_FileProxy::runPostProxies('getFileInfo', $path, $data);
return $data;
}
/**
* get the content of a directory
*
* @param string $directory path under datadirectory
* @param string $mimetype_filter limit returned content to this mimetype or mimepart
* @return array
*/
public function getDirectoryContent($directory, $mimetype_filter = '') {
2012-11-25 01:42:54 +04:00
$result = array();
2013-02-04 16:28:31 +04:00
if (!Filesystem::isValidPath($directory)) {
return $result;
}
2012-10-26 15:23:15 +04:00
$path = Filesystem::normalizePath($this->fakeRoot . '/' . $directory);
/**
* @var \OC\Files\Storage\Storage $storage
* @var string $internalPath
*/
2012-10-26 15:23:15 +04:00
list($storage, $internalPath) = Filesystem::resolvePath($path);
2012-11-25 01:42:54 +04:00
if ($storage) {
$cache = $storage->getCache($internalPath);
$permissionsCache = $storage->getPermissionsCache($internalPath);
$user = \OC_User::getUser();
if ($cache->getStatus($internalPath) < Cache\Cache::COMPLETE) {
$scanner = $storage->getScanner($internalPath);
2012-11-25 01:42:54 +04:00
$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
} else {
$watcher = $storage->getWatcher($internalPath);
2012-11-25 01:42:54 +04:00
$watcher->checkUpdate($internalPath);
}
$files = $cache->getFolderContents($internalPath); //TODO: mimetype_filter
$permissions = $permissionsCache->getDirectoryPermissions($cache->getId($internalPath), $user);
$ids = array();
foreach ($files as $i => $file) {
$files[$i]['type'] = $file['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file';
$ids[] = $file['fileid'];
if (!isset($permissions[$file['fileid']])) {
$permissions[$file['fileid']] = $storage->getPermissions($file['path']);
$permissionsCache->set($file['fileid'], $user, $permissions[$file['fileid']]);
}
$files[$i]['permissions'] = $permissions[$file['fileid']];
}
2012-11-25 01:42:54 +04:00
//add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
$mountPoints = Filesystem::getMountPoints($path);
$dirLength = strlen($path);
foreach ($mountPoints as $mountPoint) {
$subStorage = Filesystem::getStorage($mountPoint);
if ($subStorage) {
$subCache = $subStorage->getCache('');
2012-11-25 01:42:54 +04:00
if ($subCache->getStatus('') === Cache\Cache::NOT_FOUND) {
$subScanner = $subStorage->getScanner('');
$subScanner->scanFile('');
}
$rootEntry = $subCache->get('');
if ($rootEntry) {
$relativePath = trim(substr($mountPoint, $dirLength), '/');
2013-02-11 20:44:02 +04:00
if ($pos = strpos($relativePath, '/')) {
//mountpoint inside subfolder add size to the correct folder
$entryName = substr($relativePath, 0, $pos);
foreach ($files as &$entry) {
if ($entry['name'] === $entryName) {
$entry['size'] += $rootEntry['size'];
}
2012-11-25 01:42:54 +04:00
}
} else { //mountpoint in this folder, add an entry for it
$rootEntry['name'] = $relativePath;
$rootEntry['type'] = $rootEntry['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file';
$subPermissionsCache = $subStorage->getPermissionsCache('');
$permissions = $subPermissionsCache->get($rootEntry['fileid'], $user);
if ($permissions === -1) {
$permissions = $subStorage->getPermissions($rootEntry['path']);
$subPermissionsCache->set($rootEntry['fileid'], $user, $permissions);
}
$rootEntry['permissions'] = $permissions;
//remove any existing entry with the same name
foreach ($files as $i => $file) {
if ($file['name'] === $rootEntry['name']) {
unset($files[$i]);
break;
}
}
$files[] = $rootEntry;
2012-11-25 01:42:54 +04:00
}
}
}
}
2012-11-25 01:42:54 +04:00
if ($mimetype_filter) {
foreach ($files as $file) {
if (strpos($mimetype_filter, '/')) {
if ($file['mimetype'] === $mimetype_filter) {
$result[] = $file;
}
} else {
if ($file['mimepart'] === $mimetype_filter) {
$result[] = $file;
}
}
}
2012-11-25 01:42:54 +04:00
} else {
$result = $files;
}
}
return $result;
}
/**
* change file metadata
*
* @param string $path
* @param array $data
* @return int
*
* returns the fileid of the updated file
*/
public function putFileInfo($path, $data) {
2012-10-26 15:23:15 +04:00
$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
/**
* @var \OC\Files\Storage\Storage $storage
* @var string $internalPath
*/
2012-10-26 15:23:15 +04:00
list($storage, $internalPath) = Filesystem::resolvePath($path);
2012-11-25 01:42:54 +04:00
if ($storage) {
$cache = $storage->getCache($path);
2012-11-25 01:42:54 +04:00
if (!$cache->inCache($internalPath)) {
$scanner = $storage->getScanner($internalPath);
2012-11-25 01:42:54 +04:00
$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
}
2012-11-25 01:42:54 +04:00
return $cache->put($internalPath, $data);
} else {
return -1;
}
}
2012-10-26 15:23:15 +04:00
/**
* search for files with the name matching $query
*
* @param string $query
* @return array
*/
public function search($query) {
2012-10-27 12:34:25 +04:00
return $this->searchCommon('%' . $query . '%', 'search');
}
/**
* search for files by mimetype
*
* @param string $query
* @return array
*/
public function searchByMime($mimetype) {
return $this->searchCommon($mimetype, 'searchByMime');
}
/**
* @param string $query
* @param string $method
* @return array
*/
private function searchCommon($query, $method) {
2012-10-26 15:23:15 +04:00
$files = array();
$rootLength = strlen($this->fakeRoot);
$mountPoint = Filesystem::getMountPoint($this->fakeRoot);
$storage = Filesystem::getStorage($mountPoint);
2012-11-25 01:42:54 +04:00
if ($storage) {
$cache = $storage->getCache('');
2012-10-26 15:23:15 +04:00
2012-10-27 12:34:25 +04:00
$results = $cache->$method($query);
2012-10-26 15:23:15 +04:00
foreach ($results as $result) {
2012-11-25 01:42:54 +04:00
if (substr($mountPoint . $result['path'], 0, $rootLength) === $this->fakeRoot) {
$result['path'] = substr($mountPoint . $result['path'], $rootLength);
$files[] = $result;
}
2012-10-26 15:23:15 +04:00
}
2012-11-25 01:42:54 +04:00
$mountPoints = Filesystem::getMountPoints($this->fakeRoot);
foreach ($mountPoints as $mountPoint) {
$storage = Filesystem::getStorage($mountPoint);
if ($storage) {
$cache = $storage->getCache('');
2012-11-25 01:42:54 +04:00
$relativeMountPoint = substr($mountPoint, $rootLength);
$results = $cache->$method($query);
foreach ($results as $result) {
$result['path'] = $relativeMountPoint . $result['path'];
$files[] = $result;
}
}
}
}
2012-10-26 15:23:15 +04:00
return $files;
}
/**
* Get the owner for a file or folder
*
* @param string $path
* @return string
*/
public function getOwner($path) {
return $this->basicOperation('getOwner', $path);
}
/**
* get the ETag for a file or folder
*
* @param string $path
* @return string
*/
public function getETag($path) {
/**
* @var Storage\Storage $storage
* @var string $internalPath
*/
list($storage, $internalPath) = $this->resolvePath($path);
2012-11-25 01:42:54 +04:00
if ($storage) {
return $storage->getETag($internalPath);
} else {
return null;
}
}
/**
* Get the path of a file by id, relative to the view
*
* Note that the resulting path is not guarantied to be unique for the id, multiple paths can point to the same file
*
* @param int $id
* @return string
*/
public function getPath($id) {
list($storage, $internalPath) = Cache\Cache::getById($id);
$mounts = Filesystem::getMountByStorageId($storage);
foreach ($mounts as $mount) {
/**
* @var \OC\Files\Mount $mount
*/
$fullPath = $mount->getMountPoint() . $internalPath;
if (!is_null($path = $this->getRelativePath($fullPath))) {
return $path;
}
}
return null;
}
2012-01-20 03:40:52 +04:00
}