nextcloud / server

apps/dav/lib/Server.php

Indentation +183 added lines, -183 removed lines

@@ -55,187 +55,187 @@
 
 class Server {
 
-	/** @var IRequest */
-	private $request;
-
-	/** @var  string */
-	private $baseUri;
-
-	/** @var Connector\Sabre\Server  */
-	private $server;
-
-	public function __construct(IRequest $request, $baseUri) {
-		$this->request = $request;
-		$this->baseUri = $baseUri;
-		$logger = \OC::$server->getLogger();
-		$mailer = \OC::$server->getMailer();
-		$dispatcher = \OC::$server->getEventDispatcher();
-
-		$root = new RootCollection();
-		$this->server = new \OCA\DAV\Connector\Sabre\Server($root);
-
-		// Backends
-		$authBackend = new Auth(
-			\OC::$server->getSession(),
-			\OC::$server->getUserSession(),
-			\OC::$server->getRequest(),
-			\OC::$server->getTwoFactorAuthManager(),
-			\OC::$server->getBruteForceThrottler()
-		);
-
-		// Set URL explicitly due to reverse-proxy situations
-		$this->server->httpRequest->setUrl($this->request->getRequestUri());
-		$this->server->setBaseUri($this->baseUri);
-
-		$this->server->addPlugin(new BlockLegacyClientPlugin(\OC::$server->getConfig()));
-		$authPlugin = new Plugin();
-		$authPlugin->addBackend(new PublicAuth());
-		$this->server->addPlugin($authPlugin);
-
-		// allow setup of additional auth backends
-		$event = new SabrePluginEvent($this->server);
-		$dispatcher->dispatch('OCA\DAV\Connector\Sabre::authInit', $event);
-
-		// because we are throwing exceptions this plugin has to be the last one
-		$authPlugin->addBackend($authBackend);
-
-		// debugging
-		if(\OC::$server->getConfig()->getSystemValue('debug', false)) {
-			$this->server->addPlugin(new \Sabre\DAV\Browser\Plugin());
-		} else {
-			$this->server->addPlugin(new DummyGetResponsePlugin());
-		}
-
-		$this->server->addPlugin(new \OCA\DAV\Connector\Sabre\ExceptionLoggerPlugin('webdav', $logger));
-		$this->server->addPlugin(new \OCA\DAV\Connector\Sabre\LockPlugin());
-		$this->server->addPlugin(new \Sabre\DAV\Sync\Plugin());
-
-		// acl
-		$acl = new DavAclPlugin();
-		$acl->principalCollectionSet = [
-			'principals/users', 'principals/groups'
-		];
-		$acl->defaultUsernamePath = 'principals/users';
-		$this->server->addPlugin($acl);
-
-		// calendar plugins
-		$this->server->addPlugin(new \OCA\DAV\CalDAV\Plugin());
-		$this->server->addPlugin(new \Sabre\CalDAV\ICSExportPlugin());
-		$this->server->addPlugin(new \OCA\DAV\CalDAV\Schedule\Plugin());
-		$this->server->addPlugin(new IMipPlugin($mailer, $logger));
-		$this->server->addPlugin(new \Sabre\CalDAV\Subscriptions\Plugin());
-		$this->server->addPlugin(new \Sabre\CalDAV\Notifications\Plugin());
-		$this->server->addPlugin(new DAV\Sharing\Plugin($authBackend, \OC::$server->getRequest()));
-		$this->server->addPlugin(new \OCA\DAV\CalDAV\Publishing\PublishPlugin(
-			\OC::$server->getConfig(),
-			\OC::$server->getURLGenerator()
-		));
-
-		// addressbook plugins
-		$this->server->addPlugin(new \OCA\DAV\CardDAV\Plugin());
-		$this->server->addPlugin(new VCFExportPlugin());
-		$this->server->addPlugin(new ImageExportPlugin(\OC::$server->getLogger()));
-
-		// system tags plugins
-		$this->server->addPlugin(new SystemTagPlugin(
-			\OC::$server->getSystemTagManager(),
-			\OC::$server->getGroupManager(),
-			\OC::$server->getUserSession()
-		));
-
-		// comments plugin
-		$this->server->addPlugin(new CommentsPlugin(
-			\OC::$server->getCommentsManager(),
-			\OC::$server->getUserSession()
-		));
-
-		$this->server->addPlugin(new CopyEtagHeaderPlugin());
-
-		// Some WebDAV clients do require Class 2 WebDAV support (locking), since
-		// we do not provide locking we emulate it using a fake locking plugin.
-		if($request->isUserAgent([
-			'/WebDAVFS/',
-			'/Microsoft Office OneNote 2013/',
-		])) {
-			$this->server->addPlugin(new FakeLockerPlugin());
-		}
-
-		if (BrowserErrorPagePlugin::isBrowserRequest($request)) {
-			$this->server->addPlugin(new BrowserErrorPagePlugin());
-		}
-
-		// wait with registering these until auth is handled and the filesystem is setup
-		$this->server->on('beforeMethod', function () {
-			// custom properties plugin must be the last one
-			$userSession = \OC::$server->getUserSession();
-			$user = $userSession->getUser();
-			if ($user !== null) {
-				$view = \OC\Files\Filesystem::getView();
-				$this->server->addPlugin(
-					new FilesPlugin(
-						$this->server->tree,
-						\OC::$server->getConfig(),
-						$this->request,
-						\OC::$server->getPreviewManager(),
-						false,
-						!\OC::$server->getConfig()->getSystemValue('debug', false)
-					)
-				);
-
-				$this->server->addPlugin(
-					new \Sabre\DAV\PropertyStorage\Plugin(
-						new CustomPropertiesBackend(
-							$this->server->tree,
-							\OC::$server->getDatabaseConnection(),
-							\OC::$server->getUserSession()->getUser()
-						)
-					)
-				);
-				if ($view !== null) {
-					$this->server->addPlugin(
-						new QuotaPlugin($view));
-				}
-				$this->server->addPlugin(
-					new TagsPlugin(
-						$this->server->tree, \OC::$server->getTagManager()
-					)
-				);
-				// TODO: switch to LazyUserFolder
-				$userFolder = \OC::$server->getUserFolder();
-				$this->server->addPlugin(new SharesPlugin(
-					$this->server->tree,
-					$userSession,
-					$userFolder,
-					\OC::$server->getShareManager()
-				));
-				$this->server->addPlugin(new CommentPropertiesPlugin(
-					\OC::$server->getCommentsManager(),
-					$userSession
-				));
-				if ($view !== null) {
-					$this->server->addPlugin(new FilesReportPlugin(
-						$this->server->tree,
-						$view,
-						\OC::$server->getSystemTagManager(),
-						\OC::$server->getSystemTagObjectMapper(),
-						\OC::$server->getTagManager(),
-						$userSession,
-						\OC::$server->getGroupManager(),
-						$userFolder
-					));
-					$this->server->addPlugin(new SearchPlugin(new \OCA\DAV\Files\FileSearchBackend(
-						$this->server->tree,
-						$user,
-						\OC::$server->getRootFolder(),
-						\OC::$server->getShareManager(),
-						$view
-					)));
-				}
-			}
-		});
-	}
-
-	public function exec() {
-		$this->server->exec();
-	}
+    /** @var IRequest */
+    private $request;
+
+    /** @var  string */
+    private $baseUri;
+
+    /** @var Connector\Sabre\Server  */
+    private $server;
+
+    public function __construct(IRequest $request, $baseUri) {
+        $this->request = $request;
+        $this->baseUri = $baseUri;
+        $logger = \OC::$server->getLogger();
+        $mailer = \OC::$server->getMailer();
+        $dispatcher = \OC::$server->getEventDispatcher();
+
+        $root = new RootCollection();
+        $this->server = new \OCA\DAV\Connector\Sabre\Server($root);
+
+        // Backends
+        $authBackend = new Auth(
+            \OC::$server->getSession(),
+            \OC::$server->getUserSession(),
+            \OC::$server->getRequest(),
+            \OC::$server->getTwoFactorAuthManager(),
+            \OC::$server->getBruteForceThrottler()
+        );
+
+        // Set URL explicitly due to reverse-proxy situations
+        $this->server->httpRequest->setUrl($this->request->getRequestUri());
+        $this->server->setBaseUri($this->baseUri);
+
+        $this->server->addPlugin(new BlockLegacyClientPlugin(\OC::$server->getConfig()));
+        $authPlugin = new Plugin();
+        $authPlugin->addBackend(new PublicAuth());
+        $this->server->addPlugin($authPlugin);
+
+        // allow setup of additional auth backends
+        $event = new SabrePluginEvent($this->server);
+        $dispatcher->dispatch('OCA\DAV\Connector\Sabre::authInit', $event);
+
+        // because we are throwing exceptions this plugin has to be the last one
+        $authPlugin->addBackend($authBackend);
+
+        // debugging
+        if(\OC::$server->getConfig()->getSystemValue('debug', false)) {
+            $this->server->addPlugin(new \Sabre\DAV\Browser\Plugin());
+        } else {
+            $this->server->addPlugin(new DummyGetResponsePlugin());
+        }
+
+        $this->server->addPlugin(new \OCA\DAV\Connector\Sabre\ExceptionLoggerPlugin('webdav', $logger));
+        $this->server->addPlugin(new \OCA\DAV\Connector\Sabre\LockPlugin());
+        $this->server->addPlugin(new \Sabre\DAV\Sync\Plugin());
+
+        // acl
+        $acl = new DavAclPlugin();
+        $acl->principalCollectionSet = [
+            'principals/users', 'principals/groups'
+        ];
+        $acl->defaultUsernamePath = 'principals/users';
+        $this->server->addPlugin($acl);
+
+        // calendar plugins
+        $this->server->addPlugin(new \OCA\DAV\CalDAV\Plugin());
+        $this->server->addPlugin(new \Sabre\CalDAV\ICSExportPlugin());
+        $this->server->addPlugin(new \OCA\DAV\CalDAV\Schedule\Plugin());
+        $this->server->addPlugin(new IMipPlugin($mailer, $logger));
+        $this->server->addPlugin(new \Sabre\CalDAV\Subscriptions\Plugin());
+        $this->server->addPlugin(new \Sabre\CalDAV\Notifications\Plugin());
+        $this->server->addPlugin(new DAV\Sharing\Plugin($authBackend, \OC::$server->getRequest()));
+        $this->server->addPlugin(new \OCA\DAV\CalDAV\Publishing\PublishPlugin(
+            \OC::$server->getConfig(),
+            \OC::$server->getURLGenerator()
+        ));
+
+        // addressbook plugins
+        $this->server->addPlugin(new \OCA\DAV\CardDAV\Plugin());
+        $this->server->addPlugin(new VCFExportPlugin());
+        $this->server->addPlugin(new ImageExportPlugin(\OC::$server->getLogger()));
+
+        // system tags plugins
+        $this->server->addPlugin(new SystemTagPlugin(
+            \OC::$server->getSystemTagManager(),
+            \OC::$server->getGroupManager(),
+            \OC::$server->getUserSession()
+        ));
+
+        // comments plugin
+        $this->server->addPlugin(new CommentsPlugin(
+            \OC::$server->getCommentsManager(),
+            \OC::$server->getUserSession()
+        ));
+
+        $this->server->addPlugin(new CopyEtagHeaderPlugin());
+
+        // Some WebDAV clients do require Class 2 WebDAV support (locking), since
+        // we do not provide locking we emulate it using a fake locking plugin.
+        if($request->isUserAgent([
+            '/WebDAVFS/',
+            '/Microsoft Office OneNote 2013/',
+        ])) {
+            $this->server->addPlugin(new FakeLockerPlugin());
+        }
+
+        if (BrowserErrorPagePlugin::isBrowserRequest($request)) {
+            $this->server->addPlugin(new BrowserErrorPagePlugin());
+        }
+
+        // wait with registering these until auth is handled and the filesystem is setup
+        $this->server->on('beforeMethod', function () {
+            // custom properties plugin must be the last one
+            $userSession = \OC::$server->getUserSession();
+            $user = $userSession->getUser();
+            if ($user !== null) {
+                $view = \OC\Files\Filesystem::getView();
+                $this->server->addPlugin(
+                    new FilesPlugin(
+                        $this->server->tree,
+                        \OC::$server->getConfig(),
+                        $this->request,
+                        \OC::$server->getPreviewManager(),
+                        false,
+                        !\OC::$server->getConfig()->getSystemValue('debug', false)
+                    )
+                );
+
+                $this->server->addPlugin(
+                    new \Sabre\DAV\PropertyStorage\Plugin(
+                        new CustomPropertiesBackend(
+                            $this->server->tree,
+                            \OC::$server->getDatabaseConnection(),
+                            \OC::$server->getUserSession()->getUser()
+                        )
+                    )
+                );
+                if ($view !== null) {
+                    $this->server->addPlugin(
+                        new QuotaPlugin($view));
+                }
+                $this->server->addPlugin(
+                    new TagsPlugin(
+                        $this->server->tree, \OC::$server->getTagManager()
+                    )
+                );
+                // TODO: switch to LazyUserFolder
+                $userFolder = \OC::$server->getUserFolder();
+                $this->server->addPlugin(new SharesPlugin(
+                    $this->server->tree,
+                    $userSession,
+                    $userFolder,
+                    \OC::$server->getShareManager()
+                ));
+                $this->server->addPlugin(new CommentPropertiesPlugin(
+                    \OC::$server->getCommentsManager(),
+                    $userSession
+                ));
+                if ($view !== null) {
+                    $this->server->addPlugin(new FilesReportPlugin(
+                        $this->server->tree,
+                        $view,
+                        \OC::$server->getSystemTagManager(),
+                        \OC::$server->getSystemTagObjectMapper(),
+                        \OC::$server->getTagManager(),
+                        $userSession,
+                        \OC::$server->getGroupManager(),
+                        $userFolder
+                    ));
+                    $this->server->addPlugin(new SearchPlugin(new \OCA\DAV\Files\FileSearchBackend(
+                        $this->server->tree,
+                        $user,
+                        \OC::$server->getRootFolder(),
+                        \OC::$server->getShareManager(),
+                        $view
+                    )));
+                }
+            }
+        });
+    }
+
+    public function exec() {
+        $this->server->exec();
+    }
 }

lib/public/Files/Search/ISearchOrder.php

Indentation +16 added lines, -16 removed lines

@@ -25,22 +25,22 @@
  * @since 12.0.0
  */
 interface ISearchOrder {
-	const DIRECTION_ASCENDING = 'asc';
-	const DIRECTION_DESCENDING = 'desc';
+    const DIRECTION_ASCENDING = 'asc';
+    const DIRECTION_DESCENDING = 'desc';
 
-	/**
-	 * The direction to sort in, either ISearchOrder::DIRECTION_ASCENDING or ISearchOrder::DIRECTION_DESCENDING
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getDirection();
+    /**
+     * The direction to sort in, either ISearchOrder::DIRECTION_ASCENDING or ISearchOrder::DIRECTION_DESCENDING
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getDirection();
 
-	/**
-	 * The field to sort on
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getField();
+    /**
+     * The field to sort on
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getField();
 }

lib/public/Files/Search/ISearchComparison.php

Indentation +29 added lines, -29 removed lines

@@ -25,36 +25,36 @@
  * @since 12.0.0
  */
 interface ISearchComparison extends ISearchOperator {
-	const COMPARE_EQUAL = 'eq';
-	const COMPARE_GREATER_THAN = 'gt';
-	const COMPARE_GREATER_THAN_EQUAL = 'gte';
-	const COMPARE_LESS_THAN = 'lt';
-	const COMPARE_LESS_THAN_EQUAL = 'lte';
-	const COMPARE_LIKE = 'like';
+    const COMPARE_EQUAL = 'eq';
+    const COMPARE_GREATER_THAN = 'gt';
+    const COMPARE_GREATER_THAN_EQUAL = 'gte';
+    const COMPARE_LESS_THAN = 'lt';
+    const COMPARE_LESS_THAN_EQUAL = 'lte';
+    const COMPARE_LIKE = 'like';
 
-	/**
-	 * Get the type of comparison, one of the ISearchComparison::COMPARE_* constants
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getType();
+    /**
+     * Get the type of comparison, one of the ISearchComparison::COMPARE_* constants
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getType();
 
-	/**
-	 * Get the name of the field to compare with
-	 *
-	 * i.e. 'size', 'name' or 'mimetype'
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getField();
+    /**
+     * Get the name of the field to compare with
+     *
+     * i.e. 'size', 'name' or 'mimetype'
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getField();
 
-	/**
-	 * Get the value to compare the field with
-	 *
-	 * @return string|integer|\DateTime
-	 * @since 12.0.0
-	 */
-	public function getValue();
+    /**
+     * Get the value to compare the field with
+     *
+     * @return string|integer|\DateTime
+     * @since 12.0.0
+     */
+    public function getValue();
 }

lib/public/Files/Search/ISearchQuery.php

Indentation +26 added lines, -26 removed lines

@@ -25,33 +25,33 @@
  * @since 12.0.0
  */
 interface ISearchQuery {
-	/**
-	 * @return ISearchOperator
-	 * @since 12.0.0
-	 */
-	public function getSearchOperation();
+    /**
+     * @return ISearchOperator
+     * @since 12.0.0
+     */
+    public function getSearchOperation();
 
-	/**
-	 * Get the maximum number of results to return
-	 *
-	 * @return integer
-	 * @since 12.0.0
-	 */
-	public function getLimit();
+    /**
+     * Get the maximum number of results to return
+     *
+     * @return integer
+     * @since 12.0.0
+     */
+    public function getLimit();
 
-	/**
-	 * Get the offset for returned results
-	 *
-	 * @return integer
-	 * @since 12.0.0
-	 */
-	public function getOffset();
+    /**
+     * Get the offset for returned results
+     *
+     * @return integer
+     * @since 12.0.0
+     */
+    public function getOffset();
 
-	/**
-	 * The fields and directions to order by
-	 *
-	 * @return ISearchOrder[]
-	 * @since 12.0.0
-	 */
-	public function getOrder();
+    /**
+     * The fields and directions to order by
+     *
+     * @return ISearchOrder[]
+     * @since 12.0.0
+     */
+    public function getOrder();
 }

lib/public/Files/Search/ISearchBinaryOperator.php

Indentation +21 added lines, -21 removed lines

@@ -25,27 +25,27 @@
  * @since 12.0.0
  */
 interface ISearchBinaryOperator extends ISearchOperator {
-	const OPERATOR_AND = 'and';
-	const OPERATOR_OR = 'or';
-	const OPERATOR_NOT = 'not';
+    const OPERATOR_AND = 'and';
+    const OPERATOR_OR = 'or';
+    const OPERATOR_NOT = 'not';
 
-	/**
-	 * The type of binary operator
-	 *
-	 * One of the ISearchBinaryOperator::OPERATOR_* constants
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getType();
+    /**
+     * The type of binary operator
+     *
+     * One of the ISearchBinaryOperator::OPERATOR_* constants
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getType();
 
-	/**
-	 * The arguments for the binary operator
-	 *
-	 * One argument for the 'not' operator and two for 'and' and 'or'
-	 *
-	 * @return ISearchOperator[]
-	 * @since 12.0.0
-	 */
-	public function getArguments();
+    /**
+     * The arguments for the binary operator
+     *
+     * One argument for the 'not' operator and two for 'and' and 'or'
+     *
+     * @return ISearchOperator[]
+     * @since 12.0.0
+     */
+    public function getArguments();
 }

lib/public/Files/Folder.php

Indentation +148 added lines, -148 removed lines

@@ -36,152 +36,152 @@
  * @since 6.0.0
  */
 interface Folder extends Node {
-	/**
-	 * Get the full path of an item in the folder within owncloud's filesystem
-	 *
-	 * @param string $path relative path of an item in the folder
-	 * @return string
-	 * @throws \OCP\Files\NotPermittedException
-	 * @since 6.0.0
-	 */
-	public function getFullPath($path);
-
-	/**
-	 * Get the path of an item in the folder relative to the folder
-	 *
-	 * @param string $path absolute path of an item in the folder
-	 * @throws \OCP\Files\NotFoundException
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function getRelativePath($path);
-
-	/**
-	 * check if a node is a (grand-)child of the folder
-	 *
-	 * @param \OCP\Files\Node $node
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isSubNode($node);
-
-	/**
-	 * get the content of this directory
-	 *
-	 * @throws \OCP\Files\NotFoundException
-	 * @return \OCP\Files\Node[]
-	 * @since 6.0.0
-	 */
-	public function getDirectoryListing();
-
-	/**
-	 * Get the node at $path
-	 *
-	 * @param string $path relative path of the file or folder
-	 * @return \OCP\Files\Node
-	 * @throws \OCP\Files\NotFoundException
-	 * @since 6.0.0
-	 */
-	public function get($path);
-
-	/**
-	 * Check if a file or folder exists in the folder
-	 *
-	 * @param string $path relative path of the file or folder
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function nodeExists($path);
-
-	/**
-	 * Create a new folder
-	 *
-	 * @param string $path relative path of the new folder
-	 * @return \OCP\Files\Folder
-	 * @throws \OCP\Files\NotPermittedException
-	 * @since 6.0.0
-	 */
-	public function newFolder($path);
-
-	/**
-	 * Create a new file
-	 *
-	 * @param string $path relative path of the new file
-	 * @return \OCP\Files\File
-	 * @throws \OCP\Files\NotPermittedException
-	 * @since 6.0.0
-	 */
-	public function newFile($path);
-
-	/**
-	 * search for files with the name matching $query
-	 *
-	 * @param string|ISearchQuery $query
-	 * @return \OCP\Files\Node[]
-	 * @since 6.0.0
-	 */
-	public function search($query);
-
-	/**
-	 * search for files by mimetype
-	 * $mimetype can either be a full mimetype (image/png) or a wildcard mimetype (image)
-	 *
-	 * @param string $mimetype
-	 * @return \OCP\Files\Node[]
-	 * @since 6.0.0
-	 */
-	public function searchByMime($mimetype);
-
-	/**
-	 * search for files by tag
-	 *
-	 * @param string|int $tag tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return \OCP\Files\Node[]
-	 * @since 8.0.0
-	 */
-	public function searchByTag($tag, $userId);
-
-	/**
-	 * get a file or folder inside the folder by it's internal id
-	 *
-	 * @param int $id
-	 * @return \OCP\Files\Node[]
-	 * @since 6.0.0
-	 */
-	public function getById($id);
-
-	/**
-	 * Get the amount of free space inside the folder
-	 *
-	 * @return int
-	 * @since 6.0.0
-	 */
-	public function getFreeSpace();
-
-	/**
-	 * Check if new files or folders can be created within the folder
-	 *
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function isCreatable();
-
-	/**
-	 * Add a suffix to the name in case the file exists
-	 *
-	 * @param string $name
-	 * @return string
-	 * @throws NotPermittedException
-	 * @since 8.1.0
-	 */
-	public function getNonExistingName($name);
-
-	/**
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\Files\Node[]
-	 * @since 9.1.0
-	 */
-	public function getRecent($limit, $offset = 0);
+    /**
+     * Get the full path of an item in the folder within owncloud's filesystem
+     *
+     * @param string $path relative path of an item in the folder
+     * @return string
+     * @throws \OCP\Files\NotPermittedException
+     * @since 6.0.0
+     */
+    public function getFullPath($path);
+
+    /**
+     * Get the path of an item in the folder relative to the folder
+     *
+     * @param string $path absolute path of an item in the folder
+     * @throws \OCP\Files\NotFoundException
+     * @return string
+     * @since 6.0.0
+     */
+    public function getRelativePath($path);
+
+    /**
+     * check if a node is a (grand-)child of the folder
+     *
+     * @param \OCP\Files\Node $node
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isSubNode($node);
+
+    /**
+     * get the content of this directory
+     *
+     * @throws \OCP\Files\NotFoundException
+     * @return \OCP\Files\Node[]
+     * @since 6.0.0
+     */
+    public function getDirectoryListing();
+
+    /**
+     * Get the node at $path
+     *
+     * @param string $path relative path of the file or folder
+     * @return \OCP\Files\Node
+     * @throws \OCP\Files\NotFoundException
+     * @since 6.0.0
+     */
+    public function get($path);
+
+    /**
+     * Check if a file or folder exists in the folder
+     *
+     * @param string $path relative path of the file or folder
+     * @return bool
+     * @since 6.0.0
+     */
+    public function nodeExists($path);
+
+    /**
+     * Create a new folder
+     *
+     * @param string $path relative path of the new folder
+     * @return \OCP\Files\Folder
+     * @throws \OCP\Files\NotPermittedException
+     * @since 6.0.0
+     */
+    public function newFolder($path);
+
+    /**
+     * Create a new file
+     *
+     * @param string $path relative path of the new file
+     * @return \OCP\Files\File
+     * @throws \OCP\Files\NotPermittedException
+     * @since 6.0.0
+     */
+    public function newFile($path);
+
+    /**
+     * search for files with the name matching $query
+     *
+     * @param string|ISearchQuery $query
+     * @return \OCP\Files\Node[]
+     * @since 6.0.0
+     */
+    public function search($query);
+
+    /**
+     * search for files by mimetype
+     * $mimetype can either be a full mimetype (image/png) or a wildcard mimetype (image)
+     *
+     * @param string $mimetype
+     * @return \OCP\Files\Node[]
+     * @since 6.0.0
+     */
+    public function searchByMime($mimetype);
+
+    /**
+     * search for files by tag
+     *
+     * @param string|int $tag tag name or tag id
+     * @param string $userId owner of the tags
+     * @return \OCP\Files\Node[]
+     * @since 8.0.0
+     */
+    public function searchByTag($tag, $userId);
+
+    /**
+     * get a file or folder inside the folder by it's internal id
+     *
+     * @param int $id
+     * @return \OCP\Files\Node[]
+     * @since 6.0.0
+     */
+    public function getById($id);
+
+    /**
+     * Get the amount of free space inside the folder
+     *
+     * @return int
+     * @since 6.0.0
+     */
+    public function getFreeSpace();
+
+    /**
+     * Check if new files or folders can be created within the folder
+     *
+     * @return bool
+     * @since 6.0.0
+     */
+    public function isCreatable();
+
+    /**
+     * Add a suffix to the name in case the file exists
+     *
+     * @param string $name
+     * @return string
+     * @throws NotPermittedException
+     * @since 8.1.0
+     */
+    public function getNonExistingName($name);
+
+    /**
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\Files\Node[]
+     * @since 9.1.0
+     */
+    public function getRecent($limit, $offset = 0);
 }

lib/public/Files/Cache/ICache.php

Indentation +208 added lines, -208 removed lines

@@ -37,233 +37,233 @@
  * @since 9.0.0
  */
 interface ICache {
-	const NOT_FOUND = 0;
-	const PARTIAL = 1; //only partial data available, file not cached in the database
-	const SHALLOW = 2; //folder in cache, but not all child files are completely scanned
-	const COMPLETE = 3;
+    const NOT_FOUND = 0;
+    const PARTIAL = 1; //only partial data available, file not cached in the database
+    const SHALLOW = 2; //folder in cache, but not all child files are completely scanned
+    const COMPLETE = 3;
 
-	/**
-	 * Get the numeric storage id for this cache's storage
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getNumericStorageId();
+    /**
+     * Get the numeric storage id for this cache's storage
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getNumericStorageId();
 
-	/**
-	 * get the stored metadata of a file or folder
-	 *
-	 * @param string | int $file either the path of a file or folder or the file id for a file or folder
-	 * @return ICacheEntry|false the cache entry or false if the file is not found in the cache
-	 * @since 9.0.0
-	 */
-	public function get($file);
+    /**
+     * get the stored metadata of a file or folder
+     *
+     * @param string | int $file either the path of a file or folder or the file id for a file or folder
+     * @return ICacheEntry|false the cache entry or false if the file is not found in the cache
+     * @since 9.0.0
+     */
+    public function get($file);
 
-	/**
-	 * get the metadata of all files stored in $folder
-	 *
-	 * Only returns files one level deep, no recursion
-	 *
-	 * @param string $folder
-	 * @return ICacheEntry[]
-	 * @since 9.0.0
-	 */
-	public function getFolderContents($folder);
+    /**
+     * get the metadata of all files stored in $folder
+     *
+     * Only returns files one level deep, no recursion
+     *
+     * @param string $folder
+     * @return ICacheEntry[]
+     * @since 9.0.0
+     */
+    public function getFolderContents($folder);
 
-	/**
-	 * get the metadata of all files stored in $folder
-	 *
-	 * Only returns files one level deep, no recursion
-	 *
-	 * @param int $fileId the file id of the folder
-	 * @return ICacheEntry[]
-	 * @since 9.0.0
-	 */
-	public function getFolderContentsById($fileId);
+    /**
+     * get the metadata of all files stored in $folder
+     *
+     * Only returns files one level deep, no recursion
+     *
+     * @param int $fileId the file id of the folder
+     * @return ICacheEntry[]
+     * @since 9.0.0
+     */
+    public function getFolderContentsById($fileId);
 
-	/**
-	 * store meta data for a file or folder
-	 * This will automatically call either insert or update depending on if the file exists
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 * @since 9.0.0
-	 */
-	public function put($file, array $data);
+    /**
+     * store meta data for a file or folder
+     * This will automatically call either insert or update depending on if the file exists
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     * @since 9.0.0
+     */
+    public function put($file, array $data);
 
-	/**
-	 * insert meta data for a new file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 * @since 9.0.0
-	 */
-	public function insert($file, array $data);
+    /**
+     * insert meta data for a new file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     * @since 9.0.0
+     */
+    public function insert($file, array $data);
 
-	/**
-	 * update the metadata of an existing file or folder in the cache
-	 *
-	 * @param int $id the fileid of the existing file or folder
-	 * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged
-	 * @since 9.0.0
-	 */
-	public function update($id, array $data);
+    /**
+     * update the metadata of an existing file or folder in the cache
+     *
+     * @param int $id the fileid of the existing file or folder
+     * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged
+     * @since 9.0.0
+     */
+    public function update($id, array $data);
 
-	/**
-	 * get the file id for a file
-	 *
-	 * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file
-	 *
-	 * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing
-	 *
-	 * @param string $file
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getId($file);
+    /**
+     * get the file id for a file
+     *
+     * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file
+     *
+     * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing
+     *
+     * @param string $file
+     * @return int
+     * @since 9.0.0
+     */
+    public function getId($file);
 
-	/**
-	 * get the id of the parent folder of a file
-	 *
-	 * @param string $file
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getParentId($file);
+    /**
+     * get the id of the parent folder of a file
+     *
+     * @param string $file
+     * @return int
+     * @since 9.0.0
+     */
+    public function getParentId($file);
 
-	/**
-	 * check if a file is available in the cache
-	 *
-	 * @param string $file
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function inCache($file);
+    /**
+     * check if a file is available in the cache
+     *
+     * @param string $file
+     * @return bool
+     * @since 9.0.0
+     */
+    public function inCache($file);
 
-	/**
-	 * remove a file or folder from the cache
-	 *
-	 * when removing a folder from the cache all files and folders inside the folder will be removed as well
-	 *
-	 * @param string $file
-	 * @since 9.0.0
-	 */
-	public function remove($file);
+    /**
+     * remove a file or folder from the cache
+     *
+     * when removing a folder from the cache all files and folders inside the folder will be removed as well
+     *
+     * @param string $file
+     * @since 9.0.0
+     */
+    public function remove($file);
 
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @since 9.0.0
-	 */
-	public function move($source, $target);
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param string $source
+     * @param string $target
+     * @since 9.0.0
+     */
+    public function move($source, $target);
 
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * Note that this should make sure the entries are removed from the source cache
-	 *
-	 * @param \OCP\Files\Cache\ICache $sourceCache
-	 * @param string $sourcePath
-	 * @param string $targetPath
-	 * @throws \OC\DatabaseException
-	 * @since 9.0.0
-	 */
-	public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath);
+    /**
+     * Move a file or folder in the cache
+     *
+     * Note that this should make sure the entries are removed from the source cache
+     *
+     * @param \OCP\Files\Cache\ICache $sourceCache
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws \OC\DatabaseException
+     * @since 9.0.0
+     */
+    public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath);
 
-	/**
-	 * Get the scan status of a file
-	 *
-	 * - ICache::NOT_FOUND: File is not in the cache
-	 * - ICache::PARTIAL: File is not stored in the cache but some incomplete data is known
-	 * - ICache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned
-	 * - ICache::COMPLETE: The file or folder, with all it's children) are fully scanned
-	 *
-	 * @param string $file
-	 *
-	 * @return int ICache::NOT_FOUND, ICache::PARTIAL, ICache::SHALLOW or ICache::COMPLETE
-	 * @since 9.0.0
-	 */
-	public function getStatus($file);
+    /**
+     * Get the scan status of a file
+     *
+     * - ICache::NOT_FOUND: File is not in the cache
+     * - ICache::PARTIAL: File is not stored in the cache but some incomplete data is known
+     * - ICache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned
+     * - ICache::COMPLETE: The file or folder, with all it's children) are fully scanned
+     *
+     * @param string $file
+     *
+     * @return int ICache::NOT_FOUND, ICache::PARTIAL, ICache::SHALLOW or ICache::COMPLETE
+     * @since 9.0.0
+     */
+    public function getStatus($file);
 
-	/**
-	 * search for files matching $pattern, files are matched if their filename matches the search pattern
-	 *
-	 * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
-	 * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
-	 * @since 9.0.0
-	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
-	 */
-	public function search($pattern);
+    /**
+     * search for files matching $pattern, files are matched if their filename matches the search pattern
+     *
+     * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
+     * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
+     * @since 9.0.0
+     * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
+     */
+    public function search($pattern);
 
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image')
-	 *        where it will search for all mimetypes in the group ('image/*')
-	 * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
-	 * @since 9.0.0
-	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
-	 */
-	public function searchByMime($mimetype);
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image')
+     *        where it will search for all mimetypes in the group ('image/*')
+     * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
+     * @since 9.0.0
+     * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
+     */
+    public function searchByMime($mimetype);
 
-	/**
-	 * Search for files with a flexible query
-	 *
-	 * @param ISearchQuery $query
-	 * @return ICacheEntry[]
-	 * @throw \InvalidArgumentException if the cache is unable to perform the query
-	 * @since 12.0.0
-	 */
-	public function searchQuery(ISearchQuery $query);
+    /**
+     * Search for files with a flexible query
+     *
+     * @param ISearchQuery $query
+     * @return ICacheEntry[]
+     * @throw \InvalidArgumentException if the cache is unable to perform the query
+     * @since 12.0.0
+     */
+    public function searchQuery(ISearchQuery $query);
 
-	/**
-	 * Search for files by tag of a given users.
-	 *
-	 * Note that every user can tag files differently.
-	 *
-	 * @param string|int $tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return ICacheEntry[] file data
-	 * @since 9.0.0
-	 * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
-	 */
-	public function searchByTag($tag, $userId);
+    /**
+     * Search for files by tag of a given users.
+     *
+     * Note that every user can tag files differently.
+     *
+     * @param string|int $tag name or tag id
+     * @param string $userId owner of the tags
+     * @return ICacheEntry[] file data
+     * @since 9.0.0
+     * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this
+     */
+    public function searchByTag($tag, $userId);
 
-	/**
-	 * find a folder in the cache which has not been fully scanned
-	 *
-	 * If multiple incomplete folders are in the cache, the one with the highest id will be returned,
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
-	 * likely the folder where we stopped scanning previously
-	 *
-	 * @return string|bool the path of the folder or false when no folder matched
-	 * @since 9.0.0
-	 */
-	public function getIncomplete();
+    /**
+     * find a folder in the cache which has not been fully scanned
+     *
+     * If multiple incomplete folders are in the cache, the one with the highest id will be returned,
+     * use the one with the highest id gives the best result with the background scanner, since that is most
+     * likely the folder where we stopped scanning previously
+     *
+     * @return string|bool the path of the folder or false when no folder matched
+     * @since 9.0.0
+     */
+    public function getIncomplete();
 
-	/**
-	 * get the path of a file on this storage by it's file id
-	 *
-	 * @param int $id the file id of the file or folder to search
-	 * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache
-	 * @since 9.0.0
-	 */
-	public function getPathById($id);
+    /**
+     * get the path of a file on this storage by it's file id
+     *
+     * @param int $id the file id of the file or folder to search
+     * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache
+     * @since 9.0.0
+     */
+    public function getPathById($id);
 
-	/**
-	 * normalize the given path for usage in the cache
-	 *
-	 * @param string $path
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function normalize($path);
+    /**
+     * normalize the given path for usage in the cache
+     *
+     * @param string $path
+     * @return string
+     * @since 9.0.0
+     */
+    public function normalize($path);
 }

lib/private/Files/Node/Folder.php

Indentation +390 added lines, -390 removed lines

@@ -36,394 +36,394 @@
 use OCP\Files\Search\ISearchOperator;
 
 class Folder extends Node implements \OCP\Files\Folder {
-	/**
-	 * Creates a Folder that represents a non-existing path
-	 *
-	 * @param string $path path
-	 * @return string non-existing node class
-	 */
-	protected function createNonExistingNode($path) {
-		return new NonExistingFolder($this->root, $this->view, $path);
-	}
-
-	/**
-	 * @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('Invalid path');
-		}
-		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('No create permission for folder');
-		}
-	}
-
-	/**
-	 * @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('No create permission for path');
-		}
-	}
-
-	/**
-	 * search for files with the name matching $query
-	 *
-	 * @param string|ISearchOperator $query
-	 * @return \OC\Files\Node\Node[]
-	 */
-	public function search($query) {
-		if (is_string($query)) {
-			return $this->searchCommon('search', array('%' . $query . '%'));
-		} else {
-			return $this->searchCommon('searchQuery', 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) {
-		$mountCache = $this->root->getUserMountCache();
-		$mountsContainingFile = $mountCache->getMountsForFileId((int)$id);
-		$mounts = $this->root->getMountsIn($this->path);
-		$mounts[] = $this->root->getMount($this->path);
-		/** @var IMountPoint[] $folderMounts */
-		$folderMounts = array_combine(array_map(function (IMountPoint $mountPoint) {
-			return $mountPoint->getMountPoint();
-		}, $mounts), $mounts);
-
-		/** @var ICachedMountInfo[] $mountsContainingFile */
-		$mountsContainingFile = array_values(array_filter($mountsContainingFile, function (ICachedMountInfo $cachedMountInfo) use ($folderMounts) {
-			return isset($folderMounts[$cachedMountInfo->getMountPoint()]);
-		}));
-
-		if (count($mountsContainingFile) === 0) {
-			return [];
-		}
-
-		// we only need to get the cache info once, since all mounts we found point to the same storage
-
-		$mount = $folderMounts[$mountsContainingFile[0]->getMountPoint()];
-		$cacheEntry = $mount->getStorage()->getCache()->get((int)$id);
-		if (!$cacheEntry) {
-			return [];
-		}
-		// cache jails will hide the "true" internal path
-		$internalPath = ltrim($mountsContainingFile[0]->getRootInternalPath() . '/' . $cacheEntry->getPath(), '/');
-
-		$nodes = array_map(function (ICachedMountInfo $cachedMountInfo) use ($cacheEntry, $folderMounts, $internalPath) {
-			$mount = $folderMounts[$cachedMountInfo->getMountPoint()];
-			$pathRelativeToMount = substr($internalPath, strlen($cachedMountInfo->getRootInternalPath()));
-			$pathRelativeToMount = ltrim($pathRelativeToMount, '/');
-			$absolutePath = $cachedMountInfo->getMountPoint() . $pathRelativeToMount;
-			return $this->root->createNode($absolutePath, new \OC\Files\FileInfo(
-				$absolutePath, $mount->getStorage(), $cacheEntry->getPath(), $cacheEntry, $mount,
-				\OC::$server->getUserManager()->get($mount->getStorage()->getOwner($pathRelativeToMount))
-			));
-		}, $mountsContainingFile);
-
-		return array_filter($nodes, function (Node $node) {
-			return $this->getRelativePath($node->getPath());
-		});
-	}
-
-	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('No delete permission for path');
-		}
-	}
-
-	/**
-	 * 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), '/');
-	}
-
-	/**
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\Files\Node[]
-	 */
-	public function getRecent($limit, $offset = 0) {
-		$mimetypeLoader = \OC::$server->getMimeTypeLoader();
-		$mounts = $this->root->getMountsIn($this->path);
-		$mounts[] = $this->getMountPoint();
-
-		$mounts = array_filter($mounts, function (IMountPoint $mount) {
-			return $mount->getStorage();
-		});
-		$storageIds = array_map(function (IMountPoint $mount) {
-			return $mount->getStorage()->getCache()->getNumericStorageId();
-		}, $mounts);
-		/** @var IMountPoint[] $mountMap */
-		$mountMap = array_combine($storageIds, $mounts);
-		$folderMimetype = $mimetypeLoader->getId(FileInfo::MIMETYPE_FOLDER);
-
-		//todo look into options of filtering path based on storage id (only search in files/ for home storage, filter by share root for shared, etc)
-
-		$builder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
-		$query = $builder
-			->select('f.*')
-			->from('filecache', 'f')
-			->andWhere($builder->expr()->in('f.storage', $builder->createNamedParameter($storageIds, IQueryBuilder::PARAM_INT_ARRAY)))
-			->andWhere($builder->expr()->orX(
-			// handle non empty folders separate
-				$builder->expr()->neq('f.mimetype', $builder->createNamedParameter($folderMimetype, IQueryBuilder::PARAM_INT)),
-				$builder->expr()->eq('f.size', new Literal(0))
-			))
-			->orderBy('f.mtime', 'DESC')
-			->setMaxResults($limit)
-			->setFirstResult($offset);
-
-		$result = $query->execute()->fetchAll();
-
-		$files = array_filter(array_map(function (array $entry) use ($mountMap, $mimetypeLoader) {
-			$mount = $mountMap[$entry['storage']];
-			$entry['internalPath'] = $entry['path'];
-			$entry['mimetype'] = $mimetypeLoader->getMimetypeById($entry['mimetype']);
-			$entry['mimepart'] = $mimetypeLoader->getMimetypeById($entry['mimepart']);
-			$path = $this->getAbsolutePath($mount, $entry['path']);
-			if (is_null($path)) {
-				return null;
-			}
-			$fileInfo = new \OC\Files\FileInfo($path, $mount->getStorage(), $entry['internalPath'], $entry, $mount);
-			return $this->root->createNode($fileInfo->getPath(), $fileInfo);
-		}, $result));
-
-		return array_values(array_filter($files, function (Node $node) {
-			$relative = $this->getRelativePath($node->getPath());
-			return $relative !== null && $relative !== '/';
-		}));
-	}
-
-	private function getAbsolutePath(IMountPoint $mount, $path) {
-		$storage = $mount->getStorage();
-		if ($storage->instanceOfStorage('\OC\Files\Storage\Wrapper\Jail')) {
-			/** @var \OC\Files\Storage\Wrapper\Jail $storage */
-			$jailRoot = $storage->getSourcePath('');
-			$rootLength = strlen($jailRoot) + 1;
-			if ($path === $jailRoot) {
-				return $mount->getMountPoint();
-			} else if (substr($path, 0, $rootLength) === $jailRoot . '/') {
-				return $mount->getMountPoint() . substr($path, $rootLength);
-			} else {
-				return null;
-			}
-		} else {
-			return $mount->getMountPoint() . $path;
-		}
-	}
+    /**
+     * Creates a Folder that represents a non-existing path
+     *
+     * @param string $path path
+     * @return string non-existing node class
+     */
+    protected function createNonExistingNode($path) {
+        return new NonExistingFolder($this->root, $this->view, $path);
+    }
+
+    /**
+     * @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('Invalid path');
+        }
+        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('No create permission for folder');
+        }
+    }
+
+    /**
+     * @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('No create permission for path');
+        }
+    }
+
+    /**
+     * search for files with the name matching $query
+     *
+     * @param string|ISearchOperator $query
+     * @return \OC\Files\Node\Node[]
+     */
+    public function search($query) {
+        if (is_string($query)) {
+            return $this->searchCommon('search', array('%' . $query . '%'));
+        } else {
+            return $this->searchCommon('searchQuery', 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) {
+        $mountCache = $this->root->getUserMountCache();
+        $mountsContainingFile = $mountCache->getMountsForFileId((int)$id);
+        $mounts = $this->root->getMountsIn($this->path);
+        $mounts[] = $this->root->getMount($this->path);
+        /** @var IMountPoint[] $folderMounts */
+        $folderMounts = array_combine(array_map(function (IMountPoint $mountPoint) {
+            return $mountPoint->getMountPoint();
+        }, $mounts), $mounts);
+
+        /** @var ICachedMountInfo[] $mountsContainingFile */
+        $mountsContainingFile = array_values(array_filter($mountsContainingFile, function (ICachedMountInfo $cachedMountInfo) use ($folderMounts) {
+            return isset($folderMounts[$cachedMountInfo->getMountPoint()]);
+        }));
+
+        if (count($mountsContainingFile) === 0) {
+            return [];
+        }
+
+        // we only need to get the cache info once, since all mounts we found point to the same storage
+
+        $mount = $folderMounts[$mountsContainingFile[0]->getMountPoint()];
+        $cacheEntry = $mount->getStorage()->getCache()->get((int)$id);
+        if (!$cacheEntry) {
+            return [];
+        }
+        // cache jails will hide the "true" internal path
+        $internalPath = ltrim($mountsContainingFile[0]->getRootInternalPath() . '/' . $cacheEntry->getPath(), '/');
+
+        $nodes = array_map(function (ICachedMountInfo $cachedMountInfo) use ($cacheEntry, $folderMounts, $internalPath) {
+            $mount = $folderMounts[$cachedMountInfo->getMountPoint()];
+            $pathRelativeToMount = substr($internalPath, strlen($cachedMountInfo->getRootInternalPath()));
+            $pathRelativeToMount = ltrim($pathRelativeToMount, '/');
+            $absolutePath = $cachedMountInfo->getMountPoint() . $pathRelativeToMount;
+            return $this->root->createNode($absolutePath, new \OC\Files\FileInfo(
+                $absolutePath, $mount->getStorage(), $cacheEntry->getPath(), $cacheEntry, $mount,
+                \OC::$server->getUserManager()->get($mount->getStorage()->getOwner($pathRelativeToMount))
+            ));
+        }, $mountsContainingFile);
+
+        return array_filter($nodes, function (Node $node) {
+            return $this->getRelativePath($node->getPath());
+        });
+    }
+
+    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('No delete permission for path');
+        }
+    }
+
+    /**
+     * 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), '/');
+    }
+
+    /**
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\Files\Node[]
+     */
+    public function getRecent($limit, $offset = 0) {
+        $mimetypeLoader = \OC::$server->getMimeTypeLoader();
+        $mounts = $this->root->getMountsIn($this->path);
+        $mounts[] = $this->getMountPoint();
+
+        $mounts = array_filter($mounts, function (IMountPoint $mount) {
+            return $mount->getStorage();
+        });
+        $storageIds = array_map(function (IMountPoint $mount) {
+            return $mount->getStorage()->getCache()->getNumericStorageId();
+        }, $mounts);
+        /** @var IMountPoint[] $mountMap */
+        $mountMap = array_combine($storageIds, $mounts);
+        $folderMimetype = $mimetypeLoader->getId(FileInfo::MIMETYPE_FOLDER);
+
+        //todo look into options of filtering path based on storage id (only search in files/ for home storage, filter by share root for shared, etc)
+
+        $builder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+        $query = $builder
+            ->select('f.*')
+            ->from('filecache', 'f')
+            ->andWhere($builder->expr()->in('f.storage', $builder->createNamedParameter($storageIds, IQueryBuilder::PARAM_INT_ARRAY)))
+            ->andWhere($builder->expr()->orX(
+            // handle non empty folders separate
+                $builder->expr()->neq('f.mimetype', $builder->createNamedParameter($folderMimetype, IQueryBuilder::PARAM_INT)),
+                $builder->expr()->eq('f.size', new Literal(0))
+            ))
+            ->orderBy('f.mtime', 'DESC')
+            ->setMaxResults($limit)
+            ->setFirstResult($offset);
+
+        $result = $query->execute()->fetchAll();
+
+        $files = array_filter(array_map(function (array $entry) use ($mountMap, $mimetypeLoader) {
+            $mount = $mountMap[$entry['storage']];
+            $entry['internalPath'] = $entry['path'];
+            $entry['mimetype'] = $mimetypeLoader->getMimetypeById($entry['mimetype']);
+            $entry['mimepart'] = $mimetypeLoader->getMimetypeById($entry['mimepart']);
+            $path = $this->getAbsolutePath($mount, $entry['path']);
+            if (is_null($path)) {
+                return null;
+            }
+            $fileInfo = new \OC\Files\FileInfo($path, $mount->getStorage(), $entry['internalPath'], $entry, $mount);
+            return $this->root->createNode($fileInfo->getPath(), $fileInfo);
+        }, $result));
+
+        return array_values(array_filter($files, function (Node $node) {
+            $relative = $this->getRelativePath($node->getPath());
+            return $relative !== null && $relative !== '/';
+        }));
+    }
+
+    private function getAbsolutePath(IMountPoint $mount, $path) {
+        $storage = $mount->getStorage();
+        if ($storage->instanceOfStorage('\OC\Files\Storage\Wrapper\Jail')) {
+            /** @var \OC\Files\Storage\Wrapper\Jail $storage */
+            $jailRoot = $storage->getSourcePath('');
+            $rootLength = strlen($jailRoot) + 1;
+            if ($path === $jailRoot) {
+                return $mount->getMountPoint();
+            } else if (substr($path, 0, $rootLength) === $jailRoot . '/') {
+                return $mount->getMountPoint() . substr($path, $rootLength);
+            } else {
+                return null;
+            }
+        } else {
+            return $mount->getMountPoint() . $path;
+        }
+    }
 }

lib/private/Files/Search/SearchQuery.php

Indentation +46 added lines, -46 removed lines

@@ -26,55 +26,55 @@
 use OCP\Files\Search\ISearchQuery;
 
 class SearchQuery implements ISearchQuery {
-	/** @var  ISearchOperator */
-	private $searchOperation;
-	/** @var  integer */
-	private $limit;
-	/** @var  integer */
-	private $offset;
-	/** @var  ISearchOrder[] */
-	private $order;
+    /** @var  ISearchOperator */
+    private $searchOperation;
+    /** @var  integer */
+    private $limit;
+    /** @var  integer */
+    private $offset;
+    /** @var  ISearchOrder[] */
+    private $order;
 
-	/**
-	 * SearchQuery constructor.
-	 *
-	 * @param ISearchOperator $searchOperation
-	 * @param int $limit
-	 * @param int $offset
-	 * @param array $order
-	 */
-	public function __construct(ISearchOperator $searchOperation, $limit, $offset, array $order) {
-		$this->searchOperation = $searchOperation;
-		$this->limit = $limit;
-		$this->offset = $offset;
-		$this->order = $order;
-	}
+    /**
+     * SearchQuery constructor.
+     *
+     * @param ISearchOperator $searchOperation
+     * @param int $limit
+     * @param int $offset
+     * @param array $order
+     */
+    public function __construct(ISearchOperator $searchOperation, $limit, $offset, array $order) {
+        $this->searchOperation = $searchOperation;
+        $this->limit = $limit;
+        $this->offset = $offset;
+        $this->order = $order;
+    }
 
-	/**
-	 * @return ISearchOperator
-	 */
-	public function getSearchOperation() {
-		return $this->searchOperation;
-	}
+    /**
+     * @return ISearchOperator
+     */
+    public function getSearchOperation() {
+        return $this->searchOperation;
+    }
 
-	/**
-	 * @return int
-	 */
-	public function getLimit() {
-		return $this->limit;
-	}
+    /**
+     * @return int
+     */
+    public function getLimit() {
+        return $this->limit;
+    }
 
-	/**
-	 * @return int
-	 */
-	public function getOffset() {
-		return $this->offset;
-	}
+    /**
+     * @return int
+     */
+    public function getOffset() {
+        return $this->offset;
+    }
 
-	/**
-	 * @return ISearchOrder[]
-	 */
-	public function getOrder() {
-		return $this->order;
-	}
+    /**
+     * @return ISearchOrder[]
+     */
+    public function getOrder() {
+        return $this->order;
+    }
 }