summaryrefslogtreecommitdiffstats
path: root/lib/private/Files/Node/Folder.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Files/Node/Folder.php')
-rw-r--r--lib/private/Files/Node/Folder.php360
1 files changed, 360 insertions, 0 deletions
diff --git a/lib/private/Files/Node/Folder.php b/lib/private/Files/Node/Folder.php
new file mode 100644
index 00000000000..f4d7dae20a3
--- /dev/null
+++ b/lib/private/Files/Node/Folder.php
@@ -0,0 +1,360 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ * @author Vincent Petry <pvince81@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, 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/>
+ *
+ */
+
+namespace OC\Files\Node;
+
+use OCP\Files\FileInfo;
+use OCP\Files\NotFoundException;
+use OCP\Files\NotPermittedException;
+
+class Folder extends Node implements \OCP\Files\Folder {
+ /**
+ * @param string $path path relative to the folder
+ * @return string
+ * @throws \OCP\Files\NotPermittedException
+ */
+ public function getFullPath($path) {
+ if (!$this->isValidPath($path)) {
+ throw new NotPermittedException();
+ }
+ return $this->path . $this->normalizePath($path);
+ }
+
+ /**
+ * @param string $path
+ * @return string
+ */
+ public function getRelativePath($path) {
+ if ($this->path === '' or $this->path === '/') {
+ return $this->normalizePath($path);
+ }
+ if ($path === $this->path) {
+ return '/';
+ } else if (strpos($path, $this->path . '/') !== 0) {
+ return null;
+ } else {
+ $path = substr($path, strlen($this->path));
+ return $this->normalizePath($path);
+ }
+ }
+
+ /**
+ * check if a node is a (grand-)child of the folder
+ *
+ * @param \OC\Files\Node\Node $node
+ * @return bool
+ */
+ public function isSubNode($node) {
+ return strpos($node->getPath(), $this->path . '/') === 0;
+ }
+
+ /**
+ * get the content of this directory
+ *
+ * @throws \OCP\Files\NotFoundException
+ * @return Node[]
+ */
+ public function getDirectoryListing() {
+ $folderContent = $this->view->getDirectoryContent($this->path);
+
+ return array_map(function(FileInfo $info) {
+ if ($info->getMimetype() === 'httpd/unix-directory') {
+ return new Folder($this->root, $this->view, $info->getPath(), $info);
+ } else {
+ return new File($this->root, $this->view, $info->getPath(), $info);
+ }
+ }, $folderContent);
+ }
+
+ /**
+ * @param string $path
+ * @param FileInfo $info
+ * @return File|Folder
+ */
+ protected function createNode($path, FileInfo $info = null) {
+ if (is_null($info)) {
+ $isDir = $this->view->is_dir($path);
+ } else {
+ $isDir = $info->getType() === FileInfo::TYPE_FOLDER;
+ }
+ if ($isDir) {
+ return new Folder($this->root, $this->view, $path, $info);
+ } else {
+ return new File($this->root, $this->view, $path, $info);
+ }
+ }
+
+ /**
+ * Get the node at $path
+ *
+ * @param string $path
+ * @return \OC\Files\Node\Node
+ * @throws \OCP\Files\NotFoundException
+ */
+ public function get($path) {
+ return $this->root->get($this->getFullPath($path));
+ }
+
+ /**
+ * @param string $path
+ * @return bool
+ */
+ public function nodeExists($path) {
+ try {
+ $this->get($path);
+ return true;
+ } catch (NotFoundException $e) {
+ return false;
+ }
+ }
+
+ /**
+ * @param string $path
+ * @return \OC\Files\Node\Folder
+ * @throws \OCP\Files\NotPermittedException
+ */
+ public function newFolder($path) {
+ if ($this->checkPermissions(\OCP\Constants::PERMISSION_CREATE)) {
+ $fullPath = $this->getFullPath($path);
+ $nonExisting = new NonExistingFolder($this->root, $this->view, $fullPath);
+ $this->root->emit('\OC\Files', 'preWrite', array($nonExisting));
+ $this->root->emit('\OC\Files', 'preCreate', array($nonExisting));
+ $this->view->mkdir($fullPath);
+ $node = new Folder($this->root, $this->view, $fullPath);
+ $this->root->emit('\OC\Files', 'postWrite', array($node));
+ $this->root->emit('\OC\Files', 'postCreate', array($node));
+ return $node;
+ } else {
+ throw new NotPermittedException();
+ }
+ }
+
+ /**
+ * @param string $path
+ * @return \OC\Files\Node\File
+ * @throws \OCP\Files\NotPermittedException
+ */
+ public function newFile($path) {
+ if ($this->checkPermissions(\OCP\Constants::PERMISSION_CREATE)) {
+ $fullPath = $this->getFullPath($path);
+ $nonExisting = new NonExistingFile($this->root, $this->view, $fullPath);
+ $this->root->emit('\OC\Files', 'preWrite', array($nonExisting));
+ $this->root->emit('\OC\Files', 'preCreate', array($nonExisting));
+ $this->view->touch($fullPath);
+ $node = new File($this->root, $this->view, $fullPath);
+ $this->root->emit('\OC\Files', 'postWrite', array($node));
+ $this->root->emit('\OC\Files', 'postCreate', array($node));
+ return $node;
+ } else {
+ throw new NotPermittedException();
+ }
+ }
+
+ /**
+ * search for files with the name matching $query
+ *
+ * @param string $query
+ * @return \OC\Files\Node\Node[]
+ */
+ public function search($query) {
+ return $this->searchCommon('search', array('%' . $query . '%'));
+ }
+
+ /**
+ * search for files by mimetype
+ *
+ * @param string $mimetype
+ * @return Node[]
+ */
+ public function searchByMime($mimetype) {
+ return $this->searchCommon('searchByMime', array($mimetype));
+ }
+
+ /**
+ * search for files by tag
+ *
+ * @param string|int $tag name or tag id
+ * @param string $userId owner of the tags
+ * @return Node[]
+ */
+ public function searchByTag($tag, $userId) {
+ return $this->searchCommon('searchByTag', array($tag, $userId));
+ }
+
+ /**
+ * @param string $method cache method
+ * @param array $args call args
+ * @return \OC\Files\Node\Node[]
+ */
+ private function searchCommon($method, $args) {
+ $files = array();
+ $rootLength = strlen($this->path);
+ $mount = $this->root->getMount($this->path);
+ $storage = $mount->getStorage();
+ $internalPath = $mount->getInternalPath($this->path);
+ $internalPath = rtrim($internalPath, '/');
+ if ($internalPath !== '') {
+ $internalPath = $internalPath . '/';
+ }
+ $internalRootLength = strlen($internalPath);
+
+ $cache = $storage->getCache('');
+
+ $results = call_user_func_array(array($cache, $method), $args);
+ foreach ($results as $result) {
+ if ($internalRootLength === 0 or substr($result['path'], 0, $internalRootLength) === $internalPath) {
+ $result['internalPath'] = $result['path'];
+ $result['path'] = substr($result['path'], $internalRootLength);
+ $result['storage'] = $storage;
+ $files[] = new \OC\Files\FileInfo($this->path . '/' . $result['path'], $storage, $result['internalPath'], $result, $mount);
+ }
+ }
+
+ $mounts = $this->root->getMountsIn($this->path);
+ foreach ($mounts as $mount) {
+ $storage = $mount->getStorage();
+ if ($storage) {
+ $cache = $storage->getCache('');
+
+ $relativeMountPoint = substr($mount->getMountPoint(), $rootLength);
+ $results = call_user_func_array(array($cache, $method), $args);
+ foreach ($results as $result) {
+ $result['internalPath'] = $result['path'];
+ $result['path'] = $relativeMountPoint . $result['path'];
+ $result['storage'] = $storage;
+ $files[] = new \OC\Files\FileInfo($this->path . '/' . $result['path'], $storage, $result['internalPath'], $result, $mount);
+ }
+ }
+ }
+
+ return array_map(function(FileInfo $file) {
+ return $this->createNode($file->getPath(), $file);
+ }, $files);
+ }
+
+ /**
+ * @param int $id
+ * @return \OC\Files\Node\Node[]
+ */
+ public function getById($id) {
+ $mounts = $this->root->getMountsIn($this->path);
+ $mounts[] = $this->root->getMount($this->path);
+ // 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);
+
+ $nodes = array();
+ 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))) {
+ $nodes[] = $this->get($path);
+ }
+ }
+ }
+ }
+ return $nodes;
+ }
+
+ public function getFreeSpace() {
+ return $this->view->free_space($this->path);
+ }
+
+ public function delete() {
+ if ($this->checkPermissions(\OCP\Constants::PERMISSION_DELETE)) {
+ $this->sendHooks(array('preDelete'));
+ $fileInfo = $this->getFileInfo();
+ $this->view->rmdir($this->path);
+ $nonExisting = new NonExistingFolder($this->root, $this->view, $this->path, $fileInfo);
+ $this->root->emit('\OC\Files', 'postDelete', array($nonExisting));
+ $this->exists = false;
+ } else {
+ throw new NotPermittedException();
+ }
+ }
+
+ /**
+ * @param string $targetPath
+ * @throws \OCP\Files\NotPermittedException
+ * @return \OC\Files\Node\Node
+ */
+ public function copy($targetPath) {
+ $targetPath = $this->normalizePath($targetPath);
+ $parent = $this->root->get(dirname($targetPath));
+ if ($parent instanceof Folder and $this->isValidPath($targetPath) and $parent->isCreatable()) {
+ $nonExisting = new NonExistingFolder($this->root, $this->view, $targetPath);
+ $this->root->emit('\OC\Files', 'preCopy', array($this, $nonExisting));
+ $this->root->emit('\OC\Files', 'preWrite', array($nonExisting));
+ $this->view->copy($this->path, $targetPath);
+ $targetNode = $this->root->get($targetPath);
+ $this->root->emit('\OC\Files', 'postCopy', array($this, $targetNode));
+ $this->root->emit('\OC\Files', 'postWrite', array($targetNode));
+ return $targetNode;
+ } else {
+ throw new NotPermittedException();
+ }
+ }
+
+ /**
+ * @param string $targetPath
+ * @throws \OCP\Files\NotPermittedException
+ * @return \OC\Files\Node\Node
+ */
+ public function move($targetPath) {
+ $targetPath = $this->normalizePath($targetPath);
+ $parent = $this->root->get(dirname($targetPath));
+ if ($parent instanceof Folder and $this->isValidPath($targetPath) and $parent->isCreatable()) {
+ $nonExisting = new NonExistingFolder($this->root, $this->view, $targetPath);
+ $this->root->emit('\OC\Files', 'preRename', array($this, $nonExisting));
+ $this->root->emit('\OC\Files', 'preWrite', array($nonExisting));
+ $this->view->rename($this->path, $targetPath);
+ $targetNode = $this->root->get($targetPath);
+ $this->root->emit('\OC\Files', 'postRename', array($this, $targetNode));
+ $this->root->emit('\OC\Files', 'postWrite', array($targetNode));
+ $this->path = $targetPath;
+ return $targetNode;
+ } else {
+ throw new NotPermittedException();
+ }
+ }
+
+ /**
+ * Add a suffix to the name in case the file exists
+ *
+ * @param string $name
+ * @return string
+ * @throws NotPermittedException
+ */
+ public function getNonExistingName($name) {
+ $uniqueName = \OC_Helper::buildNotExistingFileNameForView($this->getPath(), $name, $this->view);
+ return trim($this->getRelativePath($uniqueName), '/');
+ }
+}