nextcloud/lib/private/files/storage/common.php

540 lines
13 KiB
PHP
Raw Normal View History

<?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.
2012-09-07 20:30:48 +04:00
*/
2012-09-07 20:30:48 +04:00
namespace OC\Files\Storage;
use OC\Files\Cache\Cache;
use OC\Files\Cache\Scanner;
use OC\Files\Cache\Storage;
2014-05-23 14:46:12 +04:00
use OC\Files\Filesystem;
use OC\Files\Cache\Watcher;
use OCP\Files\FileNameTooLongException;
use OCP\Files\InvalidCharacterInPathException;
use OCP\Files\InvalidPathException;
use OCP\Files\ReservedWordException;
/**
2012-08-29 10:38:33 +04:00
* Storage backend class for providing common filesystem operation methods
* which are not storage-backend specific.
*
2012-09-07 20:30:48 +04:00
* \OC\Files\Storage\Common is never used directly; it is extended by all other
2012-08-29 10:38:33 +04:00
* storage backends, where its methods may be overridden, and additional
* (backend-specific) methods are defined.
*
2012-09-07 20:30:48 +04:00
* Some \OC\Files\Storage\Common methods call functions which are first defined
* in classes which extend it, e.g. $this->stat() .
*/
abstract class Common implements \OC\Files\Storage\Storage {
protected $cache;
protected $scanner;
protected $watcher;
protected $storageCache;
2015-03-05 19:22:48 +03:00
protected $mountOptions = [];
/**
* @var string[]
*/
protected $cachedFiles = array();
2013-02-26 05:51:57 +04:00
public function __construct($parameters) {
}
2014-05-23 14:46:12 +04:00
/**
* Remove a file or folder
2014-05-23 14:46:12 +04:00
*
* @param string $path
* @return bool
*/
protected function remove($path) {
if ($this->is_dir($path)) {
return $this->rmdir($path);
} else if ($this->is_file($path)) {
2014-05-23 14:46:12 +04:00
return $this->unlink($path);
} else {
return false;
}
}
2012-09-07 17:22:01 +04:00
public function is_dir($path) {
2014-10-01 15:14:08 +04:00
return $this->filetype($path) === 'dir';
}
2013-02-26 05:51:57 +04:00
2012-09-07 17:22:01 +04:00
public function is_file($path) {
2014-10-01 15:14:08 +04:00
return $this->filetype($path) === 'file';
}
2013-02-26 05:51:57 +04:00
public function filesize($path) {
2013-02-26 05:51:57 +04:00
if ($this->is_dir($path)) {
return 0; //by definition
} else {
$stat = $this->stat($path);
if (isset($stat['size'])) {
return $stat['size'];
} else {
return 0;
}
}
}
2013-02-26 05:51:57 +04:00
public function isReadable($path) {
// at least check whether it exists
// subclasses might want to implement this more thoroughly
return $this->file_exists($path);
}
public function isUpdatable($path) {
// at least check whether it exists
// subclasses might want to implement this more thoroughly
// a non-existing file/folder isn't updatable
return $this->file_exists($path);
}
public function isCreatable($path) {
2012-12-27 00:36:50 +04:00
if ($this->is_dir($path) && $this->isUpdatable($path)) {
return true;
}
return false;
}
2013-02-26 05:51:57 +04:00
public function isDeletable($path) {
if ($path === '' || $path === '/') {
return false;
}
$parent = dirname($path);
2014-09-17 13:36:08 +04:00
return $this->isUpdatable($parent) && $this->isUpdatable($path);
}
2013-02-26 05:51:57 +04:00
public function isSharable($path) {
if (\OC_Util::isSharingDisabledForUser()) {
return false;
}
return $this->isReadable($path);
}
2013-02-26 05:51:57 +04:00
public function getPermissions($path) {
$permissions = 0;
2013-02-26 05:51:57 +04:00
if ($this->isCreatable($path)) {
$permissions |= \OCP\Constants::PERMISSION_CREATE;
}
2013-02-26 05:51:57 +04:00
if ($this->isReadable($path)) {
$permissions |= \OCP\Constants::PERMISSION_READ;
}
2013-02-26 05:51:57 +04:00
if ($this->isUpdatable($path)) {
$permissions |= \OCP\Constants::PERMISSION_UPDATE;
}
2013-02-26 05:51:57 +04:00
if ($this->isDeletable($path)) {
$permissions |= \OCP\Constants::PERMISSION_DELETE;
}
2013-02-26 05:51:57 +04:00
if ($this->isSharable($path)) {
$permissions |= \OCP\Constants::PERMISSION_SHARE;
}
return $permissions;
}
2013-02-26 05:51:57 +04:00
public function filemtime($path) {
$stat = $this->stat($path);
if (isset($stat['mtime']) && $stat['mtime'] > 0) {
return $stat['mtime'];
} else {
return 0;
}
}
2013-02-26 05:51:57 +04:00
public function file_get_contents($path) {
$handle = $this->fopen($path, "r");
2013-02-26 05:51:57 +04:00
if (!$handle) {
return false;
}
$data = stream_get_contents($handle);
fclose($handle);
return $data;
}
2013-02-26 05:51:57 +04:00
public function file_put_contents($path, $data) {
$handle = $this->fopen($path, "w");
$this->removeCachedFile($path);
$count = fwrite($handle, $data);
fclose($handle);
return $count;
}
2013-02-26 05:51:57 +04:00
public function rename($path1, $path2) {
2014-05-23 14:46:12 +04:00
$this->remove($path2);
$this->removeCachedFile($path1);
2014-05-23 14:46:12 +04:00
return $this->copy($path1, $path2) and $this->remove($path1);
}
2013-02-26 05:51:57 +04:00
public function copy($path1, $path2) {
if ($this->is_dir($path1)) {
2014-05-23 14:46:12 +04:00
$this->remove($path2);
$dir = $this->opendir($path1);
$this->mkdir($path2);
while ($file = readdir($dir)) {
2014-05-23 14:46:12 +04:00
if (!Filesystem::isIgnoredDir($file)) {
if (!$this->copy($path1 . '/' . $file, $path2 . '/' . $file)) {
return false;
}
}
}
closedir($dir);
return true;
} else {
$source = $this->fopen($path1, 'r');
$target = $this->fopen($path2, 'w');
list(, $result) = \OC_Helper::streamCopy($source, $target);
$this->removeCachedFile($path2);
return $result;
}
}
2012-09-07 17:22:01 +04:00
public function getMimeType($path) {
2013-02-26 05:51:57 +04:00
if ($this->is_dir($path)) {
return 'httpd/unix-directory';
} elseif ($this->file_exists($path)) {
return \OC_Helper::getFileNameMimeType($path);
2013-02-26 05:51:57 +04:00
} else {
return false;
}
}
2013-02-26 05:51:57 +04:00
public function hash($type, $path, $raw = false) {
2014-03-20 19:45:24 +04:00
$fh = $this->fopen($path, 'rb');
$ctx = hash_init($type);
hash_update_stream($ctx, $fh);
fclose($fh);
return hash_final($ctx, $raw);
}
2013-02-26 05:51:57 +04:00
2012-09-07 17:22:01 +04:00
public function search($query) {
return $this->searchInDir($query);
}
2013-02-26 05:51:57 +04:00
2012-09-07 17:22:01 +04:00
public function getLocalFile($path) {
return $this->getCachedFile($path);
}
2013-02-26 05:51:57 +04:00
/**
* @param string $path
* @return string
*/
protected function toTmpFile($path) { //no longer in the storage api, still useful here
2013-02-26 05:51:57 +04:00
$source = $this->fopen($path, 'r');
if (!$source) {
return false;
}
2013-02-26 05:51:57 +04:00
if ($pos = strrpos($path, '.')) {
$extension = substr($path, $pos);
} else {
$extension = '';
}
2013-02-26 05:51:57 +04:00
$tmpFile = \OC_Helper::tmpFile($extension);
$target = fopen($tmpFile, 'w');
\OC_Helper::streamCopy($source, $target);
fclose($target);
return $tmpFile;
}
2013-02-26 05:51:57 +04:00
2012-09-07 17:22:01 +04:00
public function getLocalFolder($path) {
2013-02-26 05:51:57 +04:00
$baseDir = \OC_Helper::tmpFolder();
$this->addLocalFolder($path, $baseDir);
2012-08-19 04:30:33 +04:00
return $baseDir;
}
2013-02-26 05:51:57 +04:00
/**
* @param string $path
* @param string $target
*/
private function addLocalFolder($path, $target) {
$dh = $this->opendir($path);
if (is_resource($dh)) {
while (($file = readdir($dh)) !== false) {
2013-02-26 05:51:57 +04:00
if ($file !== '.' and $file !== '..') {
if ($this->is_dir($path . '/' . $file)) {
mkdir($target . '/' . $file);
$this->addLocalFolder($path . '/' . $file, $target . '/' . $file);
} else {
$tmp = $this->toTmpFile($path . '/' . $file);
rename($tmp, $target . '/' . $file);
2012-08-19 04:30:33 +04:00
}
}
}
}
}
/**
* @param string $query
*/
2013-02-26 05:51:57 +04:00
protected function searchInDir($query, $dir = '') {
$files = array();
$dh = $this->opendir($dir);
if (is_resource($dh)) {
while (($item = readdir($dh)) !== false) {
if ($item == '.' || $item == '..') continue;
2013-02-26 05:51:57 +04:00
if (strstr(strtolower($item), strtolower($query)) !== false) {
$files[] = $dir . '/' . $item;
}
2013-02-26 05:51:57 +04:00
if ($this->is_dir($dir . '/' . $item)) {
$files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item));
}
}
}
2014-12-11 14:58:22 +03:00
closedir($dh);
return $files;
}
2012-06-15 18:43:24 +04:00
/**
* check if a file or folder has been updated since $time
2013-02-26 05:51:57 +04:00
*
* The method is only used to check if the cache needs to be updated. Storage backends that don't support checking
* the mtime should always return false here. As a result storage implementations that always return false expect
* exclusive access to the backend and will not pick up files that have been added in a way that circumvents
* ownClouds filesystem.
*
2012-10-23 18:16:46 +04:00
* @param string $path
2012-06-15 18:43:24 +04:00
* @param int $time
* @return bool
*/
public function hasUpdated($path, $time) {
2013-02-26 05:51:57 +04:00
return $this->filemtime($path) > $time;
2012-06-15 18:43:24 +04:00
}
2012-07-06 14:22:21 +04:00
public function getCache($path = '', $storage = null) {
if (!$storage) {
$storage = $this;
}
if (!isset($this->cache)) {
$this->cache = new Cache($storage);
}
return $this->cache;
}
public function getScanner($path = '', $storage = null) {
if (!$storage) {
$storage = $this;
}
if (!isset($this->scanner)) {
$this->scanner = new Scanner($storage);
}
return $this->scanner;
}
2012-10-23 18:16:46 +04:00
public function getWatcher($path = '', $storage = null) {
if (!$storage) {
$storage = $this;
}
if (!isset($this->watcher)) {
$this->watcher = new Watcher($storage);
$globalPolicy = \OC::$server->getConfig()->getSystemValue('filesystem_check_changes', Watcher::CHECK_ONCE);
$this->watcher->setPolicy($this->getMountOption('filesystem_check_changes', $globalPolicy));
}
return $this->watcher;
}
public function getStorageCache($storage = null) {
if (!$storage) {
$storage = $this;
}
if (!isset($this->storageCache)) {
$this->storageCache = new Storage($storage);
}
return $this->storageCache;
}
2012-07-06 14:22:21 +04:00
/**
* get the owner of a path
2013-02-26 05:51:57 +04:00
*
2012-10-23 18:16:46 +04:00
* @param string $path The path to get the owner
2015-01-16 21:31:15 +03:00
* @return string|false uid or false
2012-07-06 14:22:21 +04:00
*/
public function getOwner($path) {
2012-10-23 18:16:46 +04:00
return \OC_User::getUser();
2012-07-06 14:22:21 +04:00
}
/**
* get the ETag for a file or folder
*
* @param string $path
2015-01-16 21:31:15 +03:00
* @return string|false
*/
2013-02-26 05:51:57 +04:00
public function getETag($path) {
$ETagFunction = \OC\Connector\Sabre\Node::$ETagFunction;
2013-02-26 05:51:57 +04:00
if ($ETagFunction) {
$hash = call_user_func($ETagFunction, $path);
return $hash;
2013-02-26 05:51:57 +04:00
} else {
2013-01-12 05:56:36 +04:00
return uniqid();
}
2012-07-06 14:22:21 +04:00
}
2013-02-22 20:21:57 +04:00
/**
* clean a path, i.e. remove all redundant '.' and '..'
* making sure that it can't point to higher than '/'
2013-02-26 05:51:57 +04:00
*
* @param string $path The path to clean
* @return string cleaned path
*/
public function cleanPath($path) {
if (strlen($path) == 0 or $path[0] != '/') {
$path = '/' . $path;
}
2013-02-22 20:21:57 +04:00
$output = array();
foreach (explode('/', $path) as $chunk) {
if ($chunk == '..') {
array_pop($output);
} else if ($chunk == '.') {
} else {
$output[] = $chunk;
}
}
return implode('/', $output);
}
public function test() {
if ($this->stat('')) {
return true;
}
return false;
}
/**
* get the free space in the storage
2013-02-26 05:51:57 +04:00
*
* @param string $path
2015-01-16 21:31:15 +03:00
* @return int|false
*/
2013-02-26 05:51:57 +04:00
public function free_space($path) {
2014-08-19 16:05:08 +04:00
return \OCP\Files\FileInfo::SPACE_UNKNOWN;
}
/**
* {@inheritdoc}
*/
public function isLocal() {
// the common implementation returns a temporary file by
// default, which is not local
return false;
}
/**
* @param string $path
*/
protected function getCachedFile($path) {
if (!isset($this->cachedFiles[$path])) {
$this->cachedFiles[$path] = $this->toTmpFile($path);
}
return $this->cachedFiles[$path];
}
protected function removeCachedFile($path) {
unset($this->cachedFiles[$path]);
}
/**
* Check if the storage is an instance of $class or is a wrapper for a storage that is an instance of $class
*
* @param string $class
* @return bool
*/
public function instanceOfStorage($class) {
return is_a($this, $class);
}
/**
* A custom storage implementation can return an url for direct download of a give file.
*
* For now the returned array can hold the parameter url - in future more attributes might follow.
*
* @param string $path
2015-01-16 21:31:15 +03:00
* @return array|false
*/
public function getDirectDownload($path) {
return [];
}
/**
* @inheritdoc
*/
public function verifyPath($path, $fileName) {
if (isset($fileName[255])) {
throw new FileNameTooLongException();
}
// NOTE: $path will remain unverified for now
if (\OC_Util::runningOnWindows()) {
$this->verifyWindowsPath($fileName);
} else {
$this->verifyPosixPath($fileName);
}
}
/**
* https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx
* @param string $fileName
* @throws InvalidPathException
*/
2015-02-24 19:20:59 +03:00
protected function verifyWindowsPath($fileName) {
$fileName = trim($fileName);
$this->scanForInvalidCharacters($fileName, "\\/<>:\"|?*");
$reservedNames = ['CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9'];
if (in_array(strtoupper($fileName), $reservedNames)) {
throw new ReservedWordException();
}
}
/**
* @param string $fileName
* @throws InvalidPathException
*/
2015-02-24 19:20:59 +03:00
protected function verifyPosixPath($fileName) {
$fileName = trim($fileName);
$this->scanForInvalidCharacters($fileName, "\\/");
$reservedNames = ['*'];
if (in_array($fileName, $reservedNames)) {
throw new ReservedWordException();
}
}
/**
2015-02-20 20:19:14 +03:00
* @param string $fileName
* @param string $invalidChars
* @throws InvalidPathException
*/
private function scanForInvalidCharacters($fileName, $invalidChars) {
2015-02-20 20:19:14 +03:00
foreach(str_split($invalidChars) as $char) {
if (strpos($fileName, $char) !== false) {
throw new InvalidCharacterInPathException();
}
}
2015-02-20 20:19:14 +03:00
$sanitizedFileName = filter_var($fileName, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW);
2015-02-20 20:19:14 +03:00
if($sanitizedFileName !== $fileName) {
throw new InvalidCharacterInPathException();
2015-02-20 20:19:14 +03:00
}
}
2015-03-05 19:22:48 +03:00
/**
* @param array $options
*/
public function setMountOptions(array $options) {
$this->mountOptions = $options;
}
/**
* @param string $name
* @param mixed $default
* @return mixed
*/
public function getMountOption($name, $default = null) {
return isset($this->mountOptions[$name]) ? $this->mountOptions[$name] : $default;
}
}