nextcloud/lib/private/files/view.php

1606 lines
45 KiB
PHP
Raw Normal View History

2012-01-20 03:40:52 +04:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Arthur Schiwon <blizzz@owncloud.com>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Björn Schießle <schiessle@owncloud.com>
* @author cmeh <cmeh@users.noreply.github.com>
* @author Florin Peter <github@florin-peter.de>
* @author Jesus Macias <jmacias@full-on-net.com>
* @author Joas Schilling <nickvergessen@owncloud.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Klaas Freitag <freitag@owncloud.com>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Luke Policinski <lpolicinski@gmail.com>
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
* @author Roman Geber <rgeber@owncloudapps.com>
* @author Sam Tuke <mail@samtuke.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Thomas Tanghus <thomas@tanghus.net>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
2015-02-18 18:08:30 +03:00
namespace OC\Files;
use OC\Files\Cache\Updater;
use OC\Files\Mount\MoveableMount;
use OCP\Files\FileNameTooLongException;
use OCP\Files\InvalidCharacterInPathException;
use OCP\Files\InvalidPathException;
use OCP\Files\ReservedWordException;
2015-02-18 18:08:30 +03:00
/**
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
* OC_Filesystem are merely a wrapper for OC\Files\View).
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-10-10 13:54:44 +04:00
class View {
/** @var string */
2012-10-10 13:54:44 +04:00
private $fakeRoot = '';
/** @var \OC\Files\Cache\Updater */
protected $updater;
/**
* @param string $root
* @throws \Exception If $root contains an invalid path
*/
public function __construct($root = '') {
if(!Filesystem::isValidPath($root)) {
throw new \Exception();
}
2012-10-10 13:54:44 +04:00
$this->fakeRoot = $root;
$this->updater = new Updater($this);
2012-01-20 03:40:52 +04:00
}
2012-11-07 20:18:56 +04:00
public function getAbsolutePath($path = '/') {
$this->assertPathLength($path);
if ($path === '') {
2012-10-10 13:54:44 +04:00
$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
* @return boolean|null
2012-10-10 13:54:44 +04:00
*/
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) {
$this->assertPathLength($path);
2012-10-10 13:54:44 +04:00
if ($this->fakeRoot == '') {
2012-06-09 19:33:57 +04:00
return $path;
}
if (rtrim($path,'/') === rtrim($this->fakeRoot, '/')) {
return '/';
}
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 does not 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
}
2014-12-16 16:24:48 +03: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 does not take the chroot into account )
2014-12-16 16:24:48 +03:00
*
* @param string $path
* @return \OCP\Files\Mount\IMountPoint
*/
public function getMount($path) {
return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
}
2012-11-08 20:42:26 +04:00
/**
* resolve a path to a storage and internal path
*
* @param string $path
2014-05-11 21:13:51 +04:00
* @return array an array consisting of the storage and the internal path
2012-11-08 20:42:26 +04:00
*/
public function resolvePath($path) {
$a = $this->getAbsolutePath($path);
$p = Filesystem::normalizePath($a);
return Filesystem::resolvePath($p);
2012-11-08 20:42:26 +04:00
}
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) {
2014-08-05 17:12:20 +04:00
return $this->basicOperation('mkdir', $path, array('create', 'write'));
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
/**
* remove mount point
*
* @param \OC\Files\Mount\MoveableMount $mount
* @param string $path relative to data/
* @return boolean
*/
protected function removeMount($mount, $path) {
if ($mount instanceof MoveableMount) {
// cut of /user/files to get the relative path to data/user/files
$pathParts = explode('/', $path, 4);
$relPath = '/' . $pathParts[3];
\OC_Hook::emit(
Filesystem::CLASSNAME, "umount",
array(Filesystem::signal_param_path => $relPath)
);
$result = $mount->removeMount();
if ($result) {
\OC_Hook::emit(
Filesystem::CLASSNAME, "post_umount",
array(Filesystem::signal_param_path => $relPath)
);
}
return $result;
} else {
// do not allow deleting the storage's root / the mount point
// because for some storages it might delete the whole contents
// but isn't supposed to work that way
return false;
}
}
2015-01-13 16:51:37 +03:00
/**
* @param string $path
* @return bool|mixed
*/
2012-07-21 23:44:10 +04:00
public function rmdir($path) {
$absolutePath = $this->getAbsolutePath($path);
$mount = Filesystem::getMountManager()->find($absolutePath);
if ($mount->getInternalPath($absolutePath) === '') {
return $this->removeMount($mount, $path);
}
if ($this->is_dir($path)) {
2014-08-05 17:12:20 +04:00
return $this->basicOperation('rmdir', $path, array('delete'));
} else {
return false;
}
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2014-05-13 02:56:31 +04:00
/**
* @param string $path
* @return resource
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param $handle
* @return mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return bool|mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return bool|mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return bool|mixed
* @throws \OCP\Files\InvalidPathException
*/
2012-07-21 23:44:10 +04:00
public function readfile($path) {
$this->assertPathLength($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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
public function isCreatable($path) {
return $this->basicOperation('isCreatable', $path);
}
2012-10-10 13:54:44 +04:00
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
public function isReadable($path) {
return $this->basicOperation('isReadable', $path);
}
2012-10-10 13:54:44 +04:00
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
public function isUpdatable($path) {
return $this->basicOperation('isUpdatable', $path);
}
2012-10-10 13:54:44 +04:00
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return bool|mixed
*/
public function isDeletable($path) {
$absolutePath = $this->getAbsolutePath($path);
$mount = Filesystem::getMountManager()->find($absolutePath);
if ($mount->getInternalPath($absolutePath) === '') {
return $mount instanceof MoveableMount;
}
return $this->basicOperation('isDeletable', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return bool|mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @param int|string $mtime
* @return bool
*/
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[] = 'create';
2013-03-07 18:51:44 +04:00
$hooks[] = 'write';
}
$result = $this->basicOperation('touch', $path, $hooks, $mtime);
2014-09-03 20:20:09 +04:00
if (!$result) {
2014-09-03 20:12:36 +04:00
// If create file fails because of permissions on external storage like SMB folders,
2014-09-03 20:20:09 +04:00
// check file exists and return false if not.
if (!$this->file_exists($path)) {
2014-09-03 20:20:09 +04:00
return false;
}
if (is_null($mtime)) {
$mtime = time();
}
2014-09-03 20:20:09 +04:00
//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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param bool $exists
* @param string $path
* @param bool $run
*/
2014-04-28 19:45:03 +04:00
protected function emit_file_hooks_pre($exists, $path, &$run) {
if (!$exists) {
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, array(
Filesystem::signal_param_path => $this->getHookPath($path),
Filesystem::signal_param_run => &$run,
));
} else {
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, array(
Filesystem::signal_param_path => $this->getHookPath($path),
Filesystem::signal_param_run => &$run,
));
}
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, array(
Filesystem::signal_param_path => $this->getHookPath($path),
Filesystem::signal_param_run => &$run,
));
}
2015-02-18 18:08:30 +03:00
/**
* @param bool $exists
* @param string $path
*/
2014-04-28 19:45:03 +04:00
protected function emit_file_hooks_post($exists, $path) {
if (!$exists) {
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, array(
Filesystem::signal_param_path => $this->getHookPath($path),
));
} else {
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_update, array(
Filesystem::signal_param_path => $this->getHookPath($path),
));
}
\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_write, array(
Filesystem::signal_param_path => $this->getHookPath($path),
));
}
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @param mixed $data
* @return bool|mixed
*/
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));
2015-03-30 23:45:58 +03:00
if (Filesystem::isValidPath($path)
and !Filesystem::isFileBlacklisted($path)
) {
$path = $this->getRelativePath($absolutePath);
$exists = $this->file_exists($path);
$run = true;
if ($this->shouldEmitHooks($path)) {
2014-04-28 19:45:03 +04:00
$this->emit_file_hooks_pre($exists, $path, $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);
$this->updater->update($path);
if ($this->shouldEmitHooks($path) && $result !== false) {
2014-04-28 19:45:03 +04:00
$this->emit_file_hooks_post($exists, $path);
}
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 {
$hooks = ($this->file_exists($path)) ? array('update', 'write') : array('create', 'write');
2014-08-05 17:12:20 +04:00
return $this->basicOperation('file_put_contents', $path, $hooks, $data);
}
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return bool|mixed
*/
2012-07-21 23:44:10 +04:00
public function unlink($path) {
if ($path === '' || $path === '/') {
// do not allow deleting the root
return false;
}
$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
$mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
2014-08-05 17:12:20 +04:00
if ($mount and $mount->getInternalPath($absolutePath) === '') {
return $this->removeMount($mount, $absolutePath);
}
2014-08-05 17:12:20 +04:00
return $this->basicOperation('unlink', $path, array('delete'));
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
/**
* @param string $directory
2015-01-13 16:51:37 +03:00
* @return bool|mixed
*/
2015-01-13 18:56:15 +03:00
public function deleteAll($directory) {
return $this->rmdir($directory);
}
2012-10-10 13:54:44 +04:00
2015-01-13 16:51:37 +03:00
/**
* Rename/move a file or folder from the source path to target path.
*
* @param string $path1 source path
* @param string $path2 target path
*
2015-01-13 16:51:37 +03:00
* @return bool|mixed
*/
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 (
2015-03-30 23:45:58 +03:00
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);
$exists = $this->file_exists($path2);
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->shouldEmitHooks() && (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
2014-04-28 19:45:03 +04:00
$this->emit_file_hooks_pre($exists, $path2, $run);
} elseif ($this->shouldEmitHooks()) {
\OC_Hook::emit(
Filesystem::CLASSNAME, Filesystem::signal_rename,
2012-10-10 13:54:44 +04:00
array(
Filesystem::signal_param_oldpath => $this->getHookPath($path1),
Filesystem::signal_param_newpath => $this->getHookPath($path2),
Filesystem::signal_param_run => &$run
2012-10-10 13:54:44 +04:00
)
);
}
2012-10-10 13:54:44 +04:00
if ($run) {
$this->verifyPath(dirname($path2), basename($path2));
2012-10-10 13:54:44 +04:00
$mp1 = $this->getMountPoint($path1 . $postFix1);
$mp2 = $this->getMountPoint($path2 . $postFix2);
$manager = Filesystem::getMountManager();
$mount = $manager->find($absolutePath1 . $postFix1);
$storage1 = $mount->getStorage();
$internalPath1 = $mount->getInternalPath($absolutePath1 . $postFix1);
list($storage2, $internalPath2) = Filesystem::resolvePath($absolutePath2 . $postFix2);
2014-05-28 15:52:18 +04:00
if ($internalPath1 === '' and $mount instanceof MoveableMount) {
if ($this->isTargetAllowed($absolutePath2)) {
/**
* @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount
*/
$sourceMountPoint = $mount->getMountPoint();
$result = $mount->moveMount($absolutePath2);
$manager->moveMount($sourceMountPoint, $mount->getMountPoint());
} else {
$result = false;
}
} elseif ($mp1 == $mp2) {
if ($storage1) {
$result = $storage1->rename($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)) {
$result = $this->copy($path1, $path2, true);
if ($result === true) {
$result = $storage1->rmdir($internalPath1);
}
} else {
$source = $this->fopen($path1 . $postFix1, 'r');
$target = $this->fopen($path2 . $postFix2, 'w');
list(, $result) = \OC_Helper::streamCopy($source, $target);
if ($result !== false) {
$this->touch($path2, $this->filemtime($path1));
}
// 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) {
$result &= $storage1->unlink($internalPath1);
} else {
// delete partially written target file
$storage2->unlink($internalPath2);
// delete cache entry that was created by fopen
$storage2->getCache()->remove($internalPath2);
}
}
2012-08-29 10:38:33 +04:00
}
if ((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
$this->updater->update($path2);
if ($this->shouldEmitHooks()) {
$this->emit_file_hooks_post($exists, $path2);
}
} elseif ($result) {
$this->updater->rename($path1, $path2);
if ($this->shouldEmitHooks($path1) and $this->shouldEmitHooks($path2)) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_post_rename,
array(
Filesystem::signal_param_oldpath => $this->getHookPath($path1),
Filesystem::signal_param_newpath => $this->getHookPath($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
2015-02-18 18:08:30 +03:00
/**
* Copy a file/folder from the source path to target path
*
* @param string $path1 source path
* @param string $path2 target path
* @param bool $preserveMtime whether to preserve mtime on the copy
*
2015-02-18 18:08:30 +03:00
* @return bool|mixed
*/
public function copy($path1, $path2, $preserveMtime = false) {
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 (
2015-03-30 23:45:58 +03:00
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->shouldEmitHooks()) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_copy,
2012-07-21 23:44:10 +04:00
array(
Filesystem::signal_param_oldpath => $this->getHookPath($path1),
Filesystem::signal_param_newpath => $this->getHookPath($path2),
Filesystem::signal_param_run => &$run
2012-07-21 23:44:10 +04:00
)
);
2014-04-28 19:45:03 +04:00
$this->emit_file_hooks_pre($exists, $path2, $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);
if (!$result) {
// delete partially written target file
$storage->unlink($internalPath2);
$storage->getCache()->remove($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);
if ($preserveMtime) {
$this->touch($path2, $this->filemtime($path1));
}
if (is_resource($dh)) {
while (($file = readdir($dh)) !== false) {
if (!Filesystem::isIgnoredDir($file)) {
2015-04-09 16:37:00 +03:00
if (!$this->copy($path1 . '/' . $file, $path2 . '/' . $file, $preserveMtime)) {
$result = false;
}
}
}
}
} else {
list($storage2, $internalPath2) = Filesystem::resolvePath($absolutePath2 . $postFix2);
$source = $this->fopen($path1 . $postFix1, 'r');
$target = $this->fopen($path2 . $postFix2, 'w');
list(, $result) = \OC_Helper::streamCopy($source, $target);
if($result && $preserveMtime) {
$this->touch($path2, $this->filemtime($path1));
}
fclose($source);
fclose($target);
if (!$result) {
// delete partially written target file
$storage2->unlink($internalPath2);
$storage2->getCache()->remove($internalPath2);
}
}
2012-01-20 03:40:52 +04:00
}
$this->updater->update($path2);
if ($this->shouldEmitHooks() && $result !== false) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_post_copy,
array(
Filesystem::signal_param_oldpath => $this->getHookPath($path1),
Filesystem::signal_param_newpath => $this->getHookPath($path2)
)
);
2014-04-28 19:45:03 +04:00
$this->emit_file_hooks_post($exists, $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
2014-05-13 02:27:36 +04:00
/**
* @param string $path
* @param string $mode
* @return resource
*/
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
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return bool|string
* @throws \OCP\Files\InvalidPathException
*/
2012-07-21 23:44:10 +04:00
public function toTmpFile($path) {
$this->assertPathLength($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
2015-02-18 18:08:30 +03:00
/**
* @param string $tmpFile
* @param string $path
* @return bool|mixed
* @throws \OCP\Files\InvalidPathException
*/
2012-07-21 23:44:10 +04:00
public function fromTmpFile($tmpFile, $path) {
$this->assertPathLength($path);
if (Filesystem::isValidPath($path)) {
// Get directory that the file is going into
$filePath = dirname($path);
// Create the directories if any
if (!$this->file_exists($filePath)) {
$this->mkdir($filePath);
}
2012-10-10 13:54:44 +04:00
$source = fopen($tmpFile, 'r');
if ($source) {
2014-12-08 17:25:21 +03:00
$result = $this->file_put_contents($path, $source);
// $this->file_put_contents() might have already closed
// the resource, so we check it, before trying to close it
// to avoid messages in the error log.
if (is_resource($source)) {
fclose($source);
}
unlink($tmpFile);
2014-12-08 17:25:21 +03:00
return $result;
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
}
}
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
* @throws \OCP\Files\InvalidPathException
*/
2012-07-21 23:44:10 +04:00
public function getMimeType($path) {
$this->assertPathLength($path);
2012-07-21 23:44:10 +04:00
return $this->basicOperation('getMimeType', $path);
2012-01-20 03:40:52 +04:00
}
2012-10-10 13:54:44 +04:00
2015-02-18 18:08:30 +03:00
/**
* @param string $type
* @param string $path
* @param bool $raw
* @return bool|null|string
*/
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));
2015-03-30 23:45:58 +03:00
if (Filesystem::isValidPath($path)) {
$path = $this->getRelativePath($absolutePath);
if ($path == null) {
return false;
}
if ($this->shouldEmitHooks($path)) {
\OC_Hook::emit(
Filesystem::CLASSNAME,
Filesystem::signal_read,
array(Filesystem::signal_param_path => $this->getHookPath($path))
);
}
list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
if ($storage) {
$result = $storage->hash($type, $internalPath, $raw);
return $result;
}
}
return null;
2012-01-20 03:40:52 +04:00
}
2015-02-18 18:08:30 +03:00
/**
* @param string $path
* @return mixed
* @throws \OCP\Files\InvalidPathException
*/
2012-10-10 13:54:44 +04:00
public function free_space($path = '/') {
$this->assertPathLength($path);
2012-07-21 23:44:10 +04:00
return $this->basicOperation('free_space', $path);
2012-01-20 03:40:52 +04:00
}
/**
* 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));
2015-03-30 23:45:58 +03:00
if (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
}
2014-08-05 17:12:20 +04:00
if (in_array('delete', $hooks) and $result) {
2014-08-05 17:12:20 +04:00
$this->updater->remove($path);
}
2015-02-02 19:35:22 +03:00
if (in_array('write', $hooks) and $operation !== 'fopen') {
2014-08-05 17:12:20 +04:00
$this->updater->update($path);
}
if (in_array('touch', $hooks)) {
2014-08-12 15:59:06 +04:00
$this->updater->update($path, $extraParam);
2014-08-05 17:12:20 +04:00
}
if ($this->shouldEmitHooks($path) && $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;
}
/**
* get the path relative to the default root for hook usage
*
* @param string $path
* @return string
*/
private function getHookPath($path) {
if (!Filesystem::getView()) {
return $path;
}
return Filesystem::getView()->getRelativePath($this->getAbsolutePath($path));
}
private function shouldEmitHooks($path = '') {
if ($path && Cache\Scanner::isPartialFile($path)) {
return false;
}
if (!Filesystem::$loaded) {
return false;
}
$defaultRoot = Filesystem::getRoot();
2014-06-06 12:50:58 +04:00
if ($defaultRoot === null) {
return false;
}
if ($this->fakeRoot === $defaultRoot) {
return true;
}
return (strlen($this->fakeRoot) > strlen($defaultRoot)) && (substr($this->fakeRoot, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
}
/**
* @param string[] $hooks
* @param string $path
* @param bool $post
* @return bool
*/
2012-10-10 13:54:44 +04:00
private function runHooks($hooks, $path, $post = false) {
$path = $this->getHookPath($path);
2012-10-10 13:54:44 +04:00
$prefix = ($post) ? 'post_' : '';
$run = true;
if ($this->shouldEmitHooks($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
* @param boolean|string $includeMountPoints true to add mountpoint sizes,
* 'ext' to add only ext storage mount point sizes. Defaults to true.
* defaults to true
2014-05-11 21:28:45 +04:00
* @return \OC\Files\FileInfo|false
*/
public function getFileInfo($path, $includeMountPoints = true) {
$this->assertPathLength($path);
2012-11-25 01:42:54 +04:00
$data = array();
if (!Filesystem::isValidPath($path)) {
return $data;
}
if (Cache\Scanner::isPartialFile($path)) {
return $this->getPartFileInfo($path);
}
2012-10-26 15:23:15 +04:00
$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
$mount = Filesystem::getMountManager()->find($path);
$storage = $mount->getStorage();
$internalPath = $mount->getInternalPath($path);
$data = null;
2012-11-25 01:42:54 +04:00
if ($storage) {
$cache = $storage->getCache($internalPath);
$data = $cache->get($internalPath);
$watcher = $storage->getWatcher($internalPath);
// if the file is not in the cache or needs to be updated, trigger the scanner and reload the data
if (!$data) {
if (!$storage->file_exists($internalPath)) {
return false;
}
$scanner = $storage->getScanner($internalPath);
2012-11-25 01:42:54 +04:00
$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
$data = $cache->get($internalPath);
2014-10-30 12:51:25 +03:00
} else if (!Cache\Scanner::isPartialFile($internalPath) && $watcher->checkUpdate($internalPath, $data)) {
$this->updater->propagate($path);
$data = $cache->get($internalPath);
}
2014-03-06 17:23:27 +04:00
if ($data and isset($data['fileid'])) {
// upgrades from oc6 or lower might not have the permissions set in the file cache
if ($data['permissions'] === 0) {
$data['permissions'] = $storage->getPermissions($data['path']);
$cache->update($data['fileid'], array('permissions' => $data['permissions']));
}
if ($includeMountPoints and $data['mimetype'] === 'httpd/unix-directory') {
//add the sizes of other mount points to the folder
$extOnly = ($includeMountPoints === 'ext');
$mountPoints = Filesystem::getMountPoints($path);
foreach ($mountPoints as $mountPoint) {
$subStorage = Filesystem::getStorage($mountPoint);
2012-12-16 02:16:26 +04:00
if ($subStorage) {
// exclude shared storage ?
if ($extOnly && $subStorage instanceof \OC\Files\Storage\Shared) {
continue;
}
2014-06-24 20:53:51 +04:00
$subCache = $subStorage->getCache('');
$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
}
}
2012-11-25 01:42:54 +04:00
}
if (!$data) {
return false;
}
if ($mount instanceof MoveableMount && $internalPath === '') {
$data['permissions'] |= \OCP\Constants::PERMISSION_DELETE;
}
2014-12-16 16:24:48 +03:00
return new FileInfo($path, $storage, $internalPath, $data, $mount);
}
/**
* 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 FileInfo[]
*/
public function getDirectoryContent($directory, $mimetype_filter = '') {
$this->assertPathLength($directory);
2012-11-25 01:42:54 +04:00
$result = array();
2013-02-04 16:28:31 +04:00
if (!Filesystem::isValidPath($directory)) {
return $result;
}
$path = $this->getAbsolutePath($directory);
2014-12-16 16:24:48 +03:00
$path = Filesystem::normalizePath($path);
$mount = $this->getMount($directory);
$storage = $mount->getStorage();
$internalPath = $mount->getInternalPath($path);
2012-11-25 01:42:54 +04:00
if ($storage) {
$cache = $storage->getCache($internalPath);
$user = \OC_User::getUser();
$data = $cache->get($internalPath);
$watcher = $storage->getWatcher($internalPath);
if (!$data or $data['size'] === -1) {
if (!$storage->file_exists($internalPath)) {
return array();
}
$scanner = $storage->getScanner($internalPath);
2012-11-25 01:42:54 +04:00
$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
$data = $cache->get($internalPath);
} else if ($watcher->checkUpdate($internalPath, $data)) {
$this->updater->propagate($path);
$data = $cache->get($internalPath);
2012-11-25 01:42:54 +04:00
}
$folderId = $data['fileid'];
/**
* @var \OC\Files\FileInfo[] $files
*/
$files = array();
$contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
foreach ($contents as $content) {
if ($content['permissions'] === 0) {
$content['permissions'] = $storage->getPermissions($content['path']);
$cache->update($content['fileid'], array('permissions' => $content['permissions']));
}
// if sharing was disabled for the user we remove the share permissions
if (\OCP\Util::isSharingDisabledForUser()) {
$content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
}
2014-12-16 16:24:48 +03:00
$files[] = new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount);
}
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
$mounts = Filesystem::getMountManager()->findIn($path);
2012-11-25 01:42:54 +04:00
$dirLength = strlen($path);
foreach ($mounts as $mount) {
$mountPoint = $mount->getMountPoint();
2014-12-16 16:24:48 +03:00
$subStorage = $mount->getStorage();
2012-11-25 01:42:54 +04:00
if ($subStorage) {
$subCache = $subStorage->getCache('');
2012-11-25 01:42:54 +04:00
if ($subCache->getStatus('') === Cache\Cache::NOT_FOUND) {
$subScanner = $subStorage->getScanner('');
try {
$subScanner->scanFile('');
} catch (\OCP\Files\StorageNotAvailableException $e) {
continue;
} catch (\OCP\Files\StorageInvalidException $e) {
continue;
} catch (\Exception $e) {
// sometimes when the storage is not available it can be any exception
\OCP\Util::writeLog(
'core',
'Exception while scanning storage "' . $subStorage->getId() . '": ' .
get_class($e) . ': ' . $e->getMessage(),
\OCP\Util::ERROR
);
continue;
}
}
$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';
$permissions = $rootEntry['permissions'];
// do not allow renaming/deleting the mount point if they are not shared files/folders
// for shared files/folders we use the permissions given by the owner
if ($mount instanceof MoveableMount) {
$rootEntry['permissions'] = $permissions | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE;
} else {
$rootEntry['permissions'] = $permissions & (\OCP\Constants::PERMISSION_ALL - (\OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE));
}
//remove any existing entry with the same name
foreach ($files as $i => $file) {
if ($file['name'] === $rootEntry['name']) {
unset($files[$i]);
break;
}
}
$rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
// if sharing was disabled for the user we remove the share permissions
if (\OCP\Util::isSharingDisabledForUser()) {
$content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
}
2014-12-16 16:24:48 +03:00
$files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount);
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
2014-05-11 21:28:45 +04:00
* @param array|\OCP\Files\FileInfo $data
* @return int
*
* returns the fileid of the updated file
*/
public function putFileInfo($path, $data) {
$this->assertPathLength($path);
if ($data instanceof FileInfo) {
$data = $data->getData();
}
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 FileInfo[]
2012-10-26 15:23:15 +04:00
*/
public function search($query) {
return $this->searchCommon('search', array('%' . $query . '%'));
2012-10-27 12:34:25 +04:00
}
/**
* search for files with the name matching $query
*
* @param string $query
* @return FileInfo[]
*/
public function searchRaw($query) {
return $this->searchCommon('search', array($query));
}
2012-10-27 12:34:25 +04:00
/**
* search for files by mimetype
*
* @param string $mimetype
* @return FileInfo[]
2012-10-27 12:34:25 +04:00
*/
public function searchByMime($mimetype) {
return $this->searchCommon('searchByMime', array($mimetype));
2012-10-27 12:34:25 +04:00
}
/**
* search for files by tag
*
* @param string|int $tag name or tag id
* @param string $userId owner of the tags
* @return FileInfo[]
*/
public function searchByTag($tag, $userId) {
return $this->searchCommon('searchByTag', array($tag, $userId));
}
2012-10-27 12:34:25 +04:00
/**
* @param string $method cache method
* @param array $args
* @return FileInfo[]
2012-10-27 12:34:25 +04:00
*/
private function searchCommon($method, $args) {
2012-10-26 15:23:15 +04:00
$files = array();
$rootLength = strlen($this->fakeRoot);
2014-12-16 16:24:48 +03:00
$mount = $this->getMount('');
$mountPoint = $mount->getMountPoint();
$storage = $mount->getStorage();
2012-11-25 01:42:54 +04:00
if ($storage) {
$cache = $storage->getCache('');
2012-10-26 15:23:15 +04:00
$results = call_user_func_array(array($cache, $method), $args);
2012-10-26 15:23:15 +04:00
foreach ($results as $result) {
if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
$internalPath = $result['path'];
$path = $mountPoint . $result['path'];
2012-11-25 01:42:54 +04:00
$result['path'] = substr($mountPoint . $result['path'], $rootLength);
2014-12-16 16:24:48 +03:00
$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount);
2012-11-25 01:42:54 +04:00
}
2012-10-26 15:23:15 +04:00
}
2014-12-16 16:24:48 +03:00
$mounts = Filesystem::getMountManager()->findIn($this->fakeRoot);
foreach ($mounts as $mount) {
$mountPoint = $mount->getMountPoint();
$storage = $mount->getStorage();
2012-11-25 01:42:54 +04:00
if ($storage) {
$cache = $storage->getCache('');
2012-11-25 01:42:54 +04:00
$relativeMountPoint = substr($mountPoint, $rootLength);
$results = call_user_func_array(array($cache, $method), $args);
if ($results) {
foreach ($results as $result) {
$internalPath = $result['path'];
$result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
$path = rtrim($mountPoint . $internalPath, '/');
2014-12-16 16:24:48 +03:00
$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount);
}
2012-11-25 01:42:54 +04:00
}
}
}
}
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
2014-06-06 11:44:34 +04:00
* @return string|null
*/
public function getPath($id) {
$id = (int)$id;
$manager = Filesystem::getMountManager();
$mounts = $manager->findIn($this->fakeRoot);
$mounts[] = $manager->find($this->fakeRoot);
// reverse the array so we start with the storage this view is in
// which is the most likely to contain the file we're looking for
$mounts = array_reverse($mounts);
foreach ($mounts as $mount) {
/**
* @var \OC\Files\Mount\MountPoint $mount
*/
if ($mount->getStorage()) {
$cache = $mount->getStorage()->getCache();
$internalPath = $cache->getPathById($id);
if (is_string($internalPath)) {
$fullPath = $mount->getMountPoint() . $internalPath;
if (!is_null($path = $this->getRelativePath($fullPath))) {
return $path;
}
}
}
}
return null;
}
private function assertPathLength($path) {
$maxLen = min(PHP_MAXPATHLEN, 4000);
// Check for the string length - performed using isset() instead of strlen()
// because isset() is about 5x-40x faster.
if (isset($path[$maxLen])) {
$pathLen = strlen($path);
throw new \OCP\Files\InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
}
}
/**
* check if it is allowed to move a mount point to a given target.
* It is not allowed to move a mount point into a different mount point
*
* @param string $target path
* @return boolean
*/
private function isTargetAllowed($target) {
$result = false;
list($targetStorage,) = \OC\Files\Filesystem::resolvePath($target);
if ($targetStorage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
$result = true;
} else {
\OCP\Util::writeLog('files',
'It is not allowed to move one mount point into another one',
\OCP\Util::DEBUG);
}
return $result;
}
/**
* Get a fileinfo object for files that are ignored in the cache (part files)
*
* @param string $path
* @return \OCP\Files\FileInfo
*/
private function getPartFileInfo($path) {
$mount = $this->getMount($path);
$storage = $mount->getStorage();
$internalPath = $mount->getInternalPath($this->getAbsolutePath($path));
return new FileInfo(
$this->getAbsolutePath($path),
$storage,
$internalPath,
[
'fileid' => null,
'mimetype' => $storage->getMimeType($internalPath),
'name' => basename($path),
'etag' => null,
'size' => $storage->filesize($internalPath),
'mtime' => $storage->filemtime($internalPath),
'encrypted' => false,
'permissions' => \OCP\Constants::PERMISSION_ALL
],
$mount
);
}
2015-02-27 16:14:42 +03:00
/**
* @return Updater
*/
public function getUpdater() {
2015-02-27 16:14:42 +03:00
return $this->updater;
}
2015-02-18 20:28:24 +03:00
/**
* @param string $path
* @param string $fileName
* @throws InvalidPathException
*/
public function verifyPath($path, $fileName) {
2015-02-24 19:20:59 +03:00
$l10n = \OC::$server->getL10N('lib');
// verify empty and dot files
$trimmed = trim($fileName);
if ($trimmed === '') {
2015-02-24 19:20:59 +03:00
throw new InvalidPathException($l10n->t('Empty filename is not allowed'));
}
if ($trimmed === '.' || $trimmed === '..') {
2015-02-24 19:20:59 +03:00
throw new InvalidPathException($l10n->t('Dot files are not allowed'));
}
// verify database - e.g. mysql only 3-byte chars
if (preg_match('%^(?:
\xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
| [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
| \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
)*$%xs', $fileName)) {
2015-02-24 19:20:59 +03:00
throw new InvalidPathException($l10n->t('4-byte characters are not supported in file names'));
}
try {
/** @type \OCP\Files\Storage $storage */
list($storage, $internalPath) = $this->resolvePath($path);
$storage->verifyPath($internalPath, $fileName);
} catch (ReservedWordException $ex) {
throw new InvalidPathException($l10n->t('File name is a reserved word'));
} catch (InvalidCharacterInPathException $ex) {
throw new InvalidPathException($l10n->t('File name contains at least one invalid character'));
} catch (FileNameTooLongException $ex) {
throw new InvalidPathException($l10n->t('File name is too long'));
}
}
2012-01-20 03:40:52 +04:00
}