nextcloud / server

lib/private/Tags.php

Doc Comments +10 added lines, -2 removed lines

@@ -742,11 +742,19 @@ 
 	}
 
 	// case-insensitive array_search
+
+	/**
+	 * @param string $needle
+	 */
 	protected function array_searchi($needle, $haystack, $mem='getName') {
 		if(!is_array($haystack)) {
 			return false;
 		}
 		return array_search(strtolower($needle), array_map(
+
+			/**
+			 * @param string $tag
+			 */
 			function($tag) use($mem) {
 				return strtolower(call_user_func(array($tag, $mem)));
 			}, $haystack)
@@ -771,7 +779,7 @@ 
 	* Get a tag by its name.
 	*
 	* @param string $name The tag name.
-	* @return integer|bool The tag object's offset within the $this->tags
+	* @return \OCP\AppFramework\Db\Entity The tag object's offset within the $this->tags
 	*                      array or false if it doesn't exist.
 	*/
 	private function getTagByName($name) {
@@ -782,7 +790,7 @@ 
 	* Get a tag by its ID.
 	*
 	* @param string $id The tag ID to look for.
-	* @return integer|bool The tag object's offset within the $this->tags
+	* @return \OCP\AppFramework\Db\Entity The tag object's offset within the $this->tags
 	*                      array or false if it doesn't exist.
 	*/
 	private function getTagById($id) {

Indentation +757 added lines, -757 removed lines

@@ -48,761 +48,761 @@
 
 class Tags implements \OCP\ITags {
 
-	/**
-	 * Tags
-	 *
-	 * @var array
-	 */
-	private $tags = array();
-
-	/**
-	 * Used for storing objectid/categoryname pairs while rescanning.
-	 *
-	 * @var array
-	 */
-	private static $relations = array();
-
-	/**
-	 * Type
-	 *
-	 * @var string
-	 */
-	private $type;
-
-	/**
-	 * User
-	 *
-	 * @var string
-	 */
-	private $user;
-
-	/**
-	 * Are we including tags for shared items?
-	 *
-	 * @var bool
-	 */
-	private $includeShared = false;
-
-	/**
-	 * The current user, plus any owners of the items shared with the current
-	 * user, if $this->includeShared === true.
-	 *
-	 * @var array
-	 */
-	private $owners = array();
-
-	/**
-	 * The Mapper we're using to communicate our Tag objects to the database.
-	 *
-	 * @var TagMapper
-	 */
-	private $mapper;
-
-	/**
-	 * The sharing backend for objects of $this->type. Required if
-	 * $this->includeShared === true to determine ownership of items.
-	 *
-	 * @var \OCP\Share_Backend
-	 */
-	private $backend;
-
-	const TAG_TABLE = '*PREFIX*vcategory';
-	const RELATION_TABLE = '*PREFIX*vcategory_to_object';
-
-	const TAG_FAVORITE = '_$!<Favorite>!$_';
-
-	/**
-	* Constructor.
-	*
-	* @param TagMapper $mapper Instance of the TagMapper abstraction layer.
-	* @param string $user The user whose data the object will operate on.
-	* @param string $type The type of items for which tags will be loaded.
-	* @param array $defaultTags Tags that should be created at construction.
-	* @param boolean $includeShared Whether to include tags for items shared with this user by others.
-	*/
-	public function __construct(TagMapper $mapper, $user, $type, $defaultTags = array(), $includeShared = false) {
-		$this->mapper = $mapper;
-		$this->user = $user;
-		$this->type = $type;
-		$this->includeShared = $includeShared;
-		$this->owners = array($this->user);
-		if ($this->includeShared) {
-			$this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true));
-			$this->backend = \OC\Share\Share::getBackend($this->type);
-		}
-		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-
-		if(count($defaultTags) > 0 && count($this->tags) === 0) {
-			$this->addMultiple($defaultTags, true);
-		}
-	}
-
-	/**
-	* Check if any tags are saved for this type and user.
-	*
-	* @return boolean.
-	*/
-	public function isEmpty() {
-		return count($this->tags) === 0;
-	}
-
-	/**
-	* Returns an array mapping a given tag's properties to its values:
-	* ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	*
-	* @param string $id The ID of the tag that is going to be mapped
-	* @return array|false
-	*/
-	public function getTag($id) {
-		$key = $this->getTagById($id);
-		if ($key !== false) {
-			return $this->tagMap($this->tags[$key]);
-		}
-		return false;
-	}
-
-	/**
-	* Get the tags for a specific user.
-	*
-	* This returns an array with maps containing each tag's properties:
-	* [
-	* 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
-	* 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
-	* ]
-	*
-	* @return array
-	*/
-	public function getTags() {
-		if(!count($this->tags)) {
-			return array();
-		}
-
-		usort($this->tags, function($a, $b) {
-			return strnatcasecmp($a->getName(), $b->getName());
-		});
-		$tagMap = array();
-
-		foreach($this->tags as $tag) {
-			if($tag->getName() !== self::TAG_FAVORITE) {
-				$tagMap[] = $this->tagMap($tag);
-			}
-		}
-		return $tagMap;
-
-	}
-
-	/**
-	* Return only the tags owned by the given user, omitting any tags shared
-	* by other users.
-	*
-	* @param string $user The user whose tags are to be checked.
-	* @return array An array of Tag objects.
-	*/
-	public function getTagsForUser($user) {
-		return array_filter($this->tags,
-			function($tag) use($user) {
-				return $tag->getOwner() === $user;
-			}
-		);
-	}
-
-	/**
-	 * Get the list of tags for the given ids.
-	 *
-	 * @param array $objIds array of object ids
-	 * @return array|boolean of tags id as key to array of tag names
-	 * or false if an error occurred
-	 */
-	public function getTagsForObjects(array $objIds) {
-		$entries = array();
-
-		try {
-			$conn = \OC::$server->getDatabaseConnection();
-			$chunks = array_chunk($objIds, 900, false);
-			foreach ($chunks as $chunk) {
-				$result = $conn->executeQuery(
-					'SELECT `category`, `categoryid`, `objid` ' .
-					'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
-					'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
-					array($this->user, $this->type, $chunk),
-					array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
-				);
-				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
-					if (!isset($entries[$objId])) {
-						$entries[$objId] = array();
-					}
-					$entries[$objId][] = $row['category'];
-				}
-				if (\OCP\DB::isError($result)) {
-					\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-					return false;
-				}
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-
-		return $entries;
-	}
-
-	/**
-	* Get the a list if items tagged with $tag.
-	*
-	* Throws an exception if the tag could not be found.
-	*
-	* @param string $tag Tag id or name.
-	* @return array|false An array of object ids or false on error.
-	* @throws \Exception
-	*/
-	public function getIdsForTag($tag) {
-		$result = null;
-		$tagId = false;
-		if(is_numeric($tag)) {
-			$tagId = $tag;
-		} elseif(is_string($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
-				return false;
-			}
-			$tagId = $this->getTagId($tag);
-		}
-
-		if($tagId === false) {
-			$l10n = \OC::$server->getL10N('core');
-			throw new \Exception(
-				$l10n->t('Could not find category "%s"', [$tag])
-			);
-		}
-
-		$ids = array();
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
-			. '` WHERE `categoryid` = ?';
-
-		try {
-			$stmt = \OCP\DB::prepare($sql);
-			$result = $stmt->execute(array($tagId));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-				return false;
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-
-		if(!is_null($result)) {
-			while( $row = $result->fetchRow()) {
-				$id = (int)$row['objid'];
-
-				if ($this->includeShared) {
-					// We have to check if we are really allowed to access the
-					// items that are tagged with $tag. To that end, we ask the
-					// corresponding sharing backend if the item identified by $id
-					// is owned by any of $this->owners.
-					foreach ($this->owners as $owner) {
-						if ($this->backend->isValidSource($id, $owner)) {
-							$ids[] = $id;
-							break;
-						}
-					}
-				} else {
-					$ids[] = $id;
-				}
-			}
-		}
-
-		return $ids;
-	}
-
-	/**
-	* Checks whether a tag is saved for the given user,
-	* disregarding the ones shared with him or her.
-	*
-	* @param string $name The tag name to check for.
-	* @param string $user The user whose tags are to be checked.
-	* @return bool
-	*/
-	public function userHasTag($name, $user) {
-		$key = $this->array_searchi($name, $this->getTagsForUser($user));
-		return ($key !== false) ? $this->tags[$key]->getId() : false;
-	}
-
-	/**
-	* Checks whether a tag is saved for or shared with the current user.
-	*
-	* @param string $name The tag name to check for.
-	* @return bool
-	*/
-	public function hasTag($name) {
-		return $this->getTagId($name) !== false;
-	}
-
-	/**
-	* Add a new tag.
-	*
-	* @param string $name A string with a name of the tag
-	* @return false|int the id of the added tag or false on error.
-	*/
-	public function add($name) {
-		$name = trim($name);
-
-		if($name === '') {
-			\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
-			return false;
-		}
-		if($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
-			return false;
-		}
-		try {
-			$tag = new Tag($this->user, $this->type, $name);
-			$tag = $this->mapper->insert($tag);
-			$this->tags[] = $tag;
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		\OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
-		return $tag->getId();
-	}
-
-	/**
-	* Rename tag.
-	*
-	* @param string|integer $from The name or ID of the existing tag
-	* @param string $to The new name of the tag.
-	* @return bool
-	*/
-	public function rename($from, $to) {
-		$from = trim($from);
-		$to = trim($to);
-
-		if($to === '' || $from === '') {
-			\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
-			return false;
-		}
-
-		if (is_numeric($from)) {
-			$key = $this->getTagById($from);
-		} else {
-			$key = $this->getTagByName($from);
-		}
-		if($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
-			return false;
-		}
-		$tag = $this->tags[$key];
-
-		if($this->userHasTag($to, $tag->getOwner())) {
-			\OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
-			return false;
-		}
-
-		try {
-			$tag->setName($to);
-			$this->tags[$key] = $this->mapper->update($tag);
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Add a list of new tags.
-	*
-	* @param string[] $names A string with a name or an array of strings containing
-	* the name(s) of the tag(s) to add.
-	* @param bool $sync When true, save the tags
-	* @param int|null $id int Optional object id to add to this|these tag(s)
-	* @return bool Returns false on error.
-	*/
-	public function addMultiple($names, $sync=false, $id = null) {
-		if(!is_array($names)) {
-			$names = array($names);
-		}
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		$newones = array();
-		foreach($names as $name) {
-			if(!$this->hasTag($name) && $name !== '') {
-				$newones[] = new Tag($this->user, $this->type, $name);
-			}
-			if(!is_null($id) ) {
-				// Insert $objectid, $categoryid  pairs if not exist.
-				self::$relations[] = array('objid' => $id, 'tag' => $name);
-			}
-		}
-		$this->tags = array_merge($this->tags, $newones);
-		if($sync === true) {
-			$this->save();
-		}
-
-		return true;
-	}
-
-	/**
-	 * Save the list of tags and their object relations
-	 */
-	protected function save() {
-		if(is_array($this->tags)) {
-			foreach($this->tags as $tag) {
-				try {
-					if (!$this->mapper->tagExists($tag)) {
-						$this->mapper->insert($tag);
-					}
-				} catch(\Exception $e) {
-					\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-						\OCP\Util::ERROR);
-				}
-			}
-
-			// reload tags to get the proper ids.
-			$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-			\OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
-				\OCP\Util::DEBUG);
-			// Loop through temporarily cached objectid/tagname pairs
-			// and save relations.
-			$tags = $this->tags;
-			// For some reason this is needed or array_search(i) will return 0..?
-			ksort($tags);
-			foreach(self::$relations as $relation) {
-				$tagId = $this->getTagId($relation['tag']);
-				\OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
-				if($tagId) {
-					try {
-						\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
-							array(
-								'objid' => $relation['objid'],
-								'categoryid' => $tagId,
-								'type' => $this->type,
-								));
-					} catch(\Exception $e) {
-						\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-							\OCP\Util::ERROR);
-					}
-				}
-			}
-			self::$relations = array(); // reset
-		} else {
-			\OCP\Util::writeLog('core', __METHOD__.', $this->tags is not an array! '
-				. print_r($this->tags, true), \OCP\Util::ERROR);
-		}
-	}
-
-	/**
-	* Delete tags and tag/object relations for a user.
-	*
-	* For hooking up on post_deleteUser
-	*
-	* @param array $arguments
-	*/
-	public static function post_deleteUser($arguments) {
-		// Find all objectid/tagId pairs.
-		$result = null;
-		try {
-			$stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
-				. 'WHERE `uid` = ?');
-			$result = $stmt->execute(array($arguments['uid']));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-		}
-
-		if(!is_null($result)) {
-			try {
-				$stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
-					. 'WHERE `categoryid` = ?');
-				while( $row = $result->fetchRow()) {
-					try {
-						$stmt->execute(array($row['id']));
-					} catch(\Exception $e) {
-						\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-							\OCP\Util::ERROR);
-					}
-				}
-			} catch(\Exception $e) {
-				\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-					\OCP\Util::ERROR);
-			}
-		}
-		try {
-			$stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
-				. 'WHERE `uid` = ?');
-			$result = $stmt->execute(array($arguments['uid']));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__ . ', exception: '
-				. $e->getMessage(), \OCP\Util::ERROR);
-		}
-	}
-
-	/**
-	* Delete tag/object relations from the db
-	*
-	* @param array $ids The ids of the objects
-	* @return boolean Returns false on error.
-	*/
-	public function purgeObjects(array $ids) {
-		if(count($ids) === 0) {
-			// job done ;)
-			return true;
-		}
-		$updates = $ids;
-		try {
-			$query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
-			$query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
-			$query .= 'AND `type`= ?';
-			$updates[] = $this->type;
-			$stmt = \OCP\DB::prepare($query);
-			$result = $stmt->execute($updates);
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-				return false;
-			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Get favorites for an object type
-	*
-	* @return array|false An array of object ids.
-	*/
-	public function getFavorites() {
-		try {
-			return $this->getIdsForTag(self::TAG_FAVORITE);
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
-				\OCP\Util::DEBUG);
-			return array();
-		}
-	}
-
-	/**
-	* Add an object to favorites
-	*
-	* @param int $objid The id of the object
-	* @return boolean
-	*/
-	public function addToFavorites($objid) {
-		if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
-			$this->add(self::TAG_FAVORITE);
-		}
-		return $this->tagAs($objid, self::TAG_FAVORITE);
-	}
-
-	/**
-	* Remove an object from favorites
-	*
-	* @param int $objid The id of the object
-	* @return boolean
-	*/
-	public function removeFromFavorites($objid) {
-		return $this->unTag($objid, self::TAG_FAVORITE);
-	}
-
-	/**
-	* Creates a tag/object relation.
-	*
-	* @param int $objid The id of the object
-	* @param string $tag The id or name of the tag
-	* @return boolean Returns false on error.
-	*/
-	public function tagAs($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
-				return false;
-			}
-			if(!$this->hasTag($tag)) {
-				$this->add($tag);
-			}
-			$tagId =  $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-		try {
-			\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
-				array(
-					'objid' => $objid,
-					'categoryid' => $tagId,
-					'type' => $this->type,
-				));
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Delete single tag/object relation from the db
-	*
-	* @param int $objid The id of the object
-	* @param string $tag The id or name of the tag
-	* @return boolean
-	*/
-	public function unTag($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
-				return false;
-			}
-			$tagId =  $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-
-		try {
-			$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
-					. 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
-			$stmt = \OCP\DB::prepare($sql);
-			$stmt->execute(array($objid, $tagId, $this->type));
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-				\OCP\Util::ERROR);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Delete tags from the database.
-	*
-	* @param string[]|integer[] $names An array of tags (names or IDs) to delete
-	* @return bool Returns false on error
-	*/
-	public function delete($names) {
-		if(!is_array($names)) {
-			$names = array($names);
-		}
-
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		\OCP\Util::writeLog('core', __METHOD__ . ', before: '
-			. print_r($this->tags, true), \OCP\Util::DEBUG);
-		foreach($names as $name) {
-			$id = null;
-
-			if (is_numeric($name)) {
-				$key = $this->getTagById($name);
-			} else {
-				$key = $this->getTagByName($name);
-			}
-			if ($key !== false) {
-				$tag = $this->tags[$key];
-				$id = $tag->getId();
-				unset($this->tags[$key]);
-				$this->mapper->delete($tag);
-			} else {
-				\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
-					. ': not found.', \OCP\Util::ERROR);
-			}
-			if(!is_null($id) && $id !== false) {
-				try {
-					$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
-							. 'WHERE `categoryid` = ?';
-					$stmt = \OCP\DB::prepare($sql);
-					$result = $stmt->execute(array($id));
-					if (\OCP\DB::isError($result)) {
-						\OCP\Util::writeLog('core',
-							__METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
-							\OCP\Util::ERROR);
-						return false;
-					}
-				} catch(\Exception $e) {
-					\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
-						\OCP\Util::ERROR);
-					return false;
-				}
-			}
-		}
-		return true;
-	}
-
-	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem='getName') {
-		if(!is_array($haystack)) {
-			return false;
-		}
-		return array_search(strtolower($needle), array_map(
-			function($tag) use($mem) {
-				return strtolower(call_user_func(array($tag, $mem)));
-			}, $haystack)
-		);
-	}
-
-	/**
-	* Get a tag's ID.
-	*
-	* @param string $name The tag name to look for.
-	* @return string|bool The tag's id or false if no matching tag is found.
-	*/
-	private function getTagId($name) {
-		$key = $this->array_searchi($name, $this->tags);
-		if ($key !== false) {
-			return $this->tags[$key]->getId();
-		}
-		return false;
-	}
-
-	/**
-	* Get a tag by its name.
-	*
-	* @param string $name The tag name.
-	* @return integer|bool The tag object's offset within the $this->tags
-	*                      array or false if it doesn't exist.
-	*/
-	private function getTagByName($name) {
-		return $this->array_searchi($name, $this->tags, 'getName');
-	}
-
-	/**
-	* Get a tag by its ID.
-	*
-	* @param string $id The tag ID to look for.
-	* @return integer|bool The tag object's offset within the $this->tags
-	*                      array or false if it doesn't exist.
-	*/
-	private function getTagById($id) {
-		return $this->array_searchi($id, $this->tags, 'getId');
-	}
-
-	/**
-	* Returns an array mapping a given tag's properties to its values:
-	* ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	*
-	* @param Tag $tag The tag that is going to be mapped
-	* @return array
-	*/
-	private function tagMap(Tag $tag) {
-		return array(
-			'id'    => $tag->getId(),
-			'name'  => $tag->getName(),
-			'owner' => $tag->getOwner(),
-			'type'  => $tag->getType()
-		);
-	}
+    /**
+     * Tags
+     *
+     * @var array
+     */
+    private $tags = array();
+
+    /**
+     * Used for storing objectid/categoryname pairs while rescanning.
+     *
+     * @var array
+     */
+    private static $relations = array();
+
+    /**
+     * Type
+     *
+     * @var string
+     */
+    private $type;
+
+    /**
+     * User
+     *
+     * @var string
+     */
+    private $user;
+
+    /**
+     * Are we including tags for shared items?
+     *
+     * @var bool
+     */
+    private $includeShared = false;
+
+    /**
+     * The current user, plus any owners of the items shared with the current
+     * user, if $this->includeShared === true.
+     *
+     * @var array
+     */
+    private $owners = array();
+
+    /**
+     * The Mapper we're using to communicate our Tag objects to the database.
+     *
+     * @var TagMapper
+     */
+    private $mapper;
+
+    /**
+     * The sharing backend for objects of $this->type. Required if
+     * $this->includeShared === true to determine ownership of items.
+     *
+     * @var \OCP\Share_Backend
+     */
+    private $backend;
+
+    const TAG_TABLE = '*PREFIX*vcategory';
+    const RELATION_TABLE = '*PREFIX*vcategory_to_object';
+
+    const TAG_FAVORITE = '_$!<Favorite>!$_';
+
+    /**
+     * Constructor.
+     *
+     * @param TagMapper $mapper Instance of the TagMapper abstraction layer.
+     * @param string $user The user whose data the object will operate on.
+     * @param string $type The type of items for which tags will be loaded.
+     * @param array $defaultTags Tags that should be created at construction.
+     * @param boolean $includeShared Whether to include tags for items shared with this user by others.
+     */
+    public function __construct(TagMapper $mapper, $user, $type, $defaultTags = array(), $includeShared = false) {
+        $this->mapper = $mapper;
+        $this->user = $user;
+        $this->type = $type;
+        $this->includeShared = $includeShared;
+        $this->owners = array($this->user);
+        if ($this->includeShared) {
+            $this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true));
+            $this->backend = \OC\Share\Share::getBackend($this->type);
+        }
+        $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+
+        if(count($defaultTags) > 0 && count($this->tags) === 0) {
+            $this->addMultiple($defaultTags, true);
+        }
+    }
+
+    /**
+     * Check if any tags are saved for this type and user.
+     *
+     * @return boolean.
+     */
+    public function isEmpty() {
+        return count($this->tags) === 0;
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param string $id The ID of the tag that is going to be mapped
+     * @return array|false
+     */
+    public function getTag($id) {
+        $key = $this->getTagById($id);
+        if ($key !== false) {
+            return $this->tagMap($this->tags[$key]);
+        }
+        return false;
+    }
+
+    /**
+     * Get the tags for a specific user.
+     *
+     * This returns an array with maps containing each tag's properties:
+     * [
+     * 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
+     * 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
+     * ]
+     *
+     * @return array
+     */
+    public function getTags() {
+        if(!count($this->tags)) {
+            return array();
+        }
+
+        usort($this->tags, function($a, $b) {
+            return strnatcasecmp($a->getName(), $b->getName());
+        });
+        $tagMap = array();
+
+        foreach($this->tags as $tag) {
+            if($tag->getName() !== self::TAG_FAVORITE) {
+                $tagMap[] = $this->tagMap($tag);
+            }
+        }
+        return $tagMap;
+
+    }
+
+    /**
+     * Return only the tags owned by the given user, omitting any tags shared
+     * by other users.
+     *
+     * @param string $user The user whose tags are to be checked.
+     * @return array An array of Tag objects.
+     */
+    public function getTagsForUser($user) {
+        return array_filter($this->tags,
+            function($tag) use($user) {
+                return $tag->getOwner() === $user;
+            }
+        );
+    }
+
+    /**
+     * Get the list of tags for the given ids.
+     *
+     * @param array $objIds array of object ids
+     * @return array|boolean of tags id as key to array of tag names
+     * or false if an error occurred
+     */
+    public function getTagsForObjects(array $objIds) {
+        $entries = array();
+
+        try {
+            $conn = \OC::$server->getDatabaseConnection();
+            $chunks = array_chunk($objIds, 900, false);
+            foreach ($chunks as $chunk) {
+                $result = $conn->executeQuery(
+                    'SELECT `category`, `categoryid`, `objid` ' .
+                    'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
+                    'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
+                    array($this->user, $this->type, $chunk),
+                    array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
+                );
+                while ($row = $result->fetch()) {
+                    $objId = (int)$row['objid'];
+                    if (!isset($entries[$objId])) {
+                        $entries[$objId] = array();
+                    }
+                    $entries[$objId][] = $row['category'];
+                }
+                if (\OCP\DB::isError($result)) {
+                    \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                    return false;
+                }
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+
+        return $entries;
+    }
+
+    /**
+     * Get the a list if items tagged with $tag.
+     *
+     * Throws an exception if the tag could not be found.
+     *
+     * @param string $tag Tag id or name.
+     * @return array|false An array of object ids or false on error.
+     * @throws \Exception
+     */
+    public function getIdsForTag($tag) {
+        $result = null;
+        $tagId = false;
+        if(is_numeric($tag)) {
+            $tagId = $tag;
+        } elseif(is_string($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
+                return false;
+            }
+            $tagId = $this->getTagId($tag);
+        }
+
+        if($tagId === false) {
+            $l10n = \OC::$server->getL10N('core');
+            throw new \Exception(
+                $l10n->t('Could not find category "%s"', [$tag])
+            );
+        }
+
+        $ids = array();
+        $sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+            . '` WHERE `categoryid` = ?';
+
+        try {
+            $stmt = \OCP\DB::prepare($sql);
+            $result = $stmt->execute(array($tagId));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                return false;
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+
+        if(!is_null($result)) {
+            while( $row = $result->fetchRow()) {
+                $id = (int)$row['objid'];
+
+                if ($this->includeShared) {
+                    // We have to check if we are really allowed to access the
+                    // items that are tagged with $tag. To that end, we ask the
+                    // corresponding sharing backend if the item identified by $id
+                    // is owned by any of $this->owners.
+                    foreach ($this->owners as $owner) {
+                        if ($this->backend->isValidSource($id, $owner)) {
+                            $ids[] = $id;
+                            break;
+                        }
+                    }
+                } else {
+                    $ids[] = $id;
+                }
+            }
+        }
+
+        return $ids;
+    }
+
+    /**
+     * Checks whether a tag is saved for the given user,
+     * disregarding the ones shared with him or her.
+     *
+     * @param string $name The tag name to check for.
+     * @param string $user The user whose tags are to be checked.
+     * @return bool
+     */
+    public function userHasTag($name, $user) {
+        $key = $this->array_searchi($name, $this->getTagsForUser($user));
+        return ($key !== false) ? $this->tags[$key]->getId() : false;
+    }
+
+    /**
+     * Checks whether a tag is saved for or shared with the current user.
+     *
+     * @param string $name The tag name to check for.
+     * @return bool
+     */
+    public function hasTag($name) {
+        return $this->getTagId($name) !== false;
+    }
+
+    /**
+     * Add a new tag.
+     *
+     * @param string $name A string with a name of the tag
+     * @return false|int the id of the added tag or false on error.
+     */
+    public function add($name) {
+        $name = trim($name);
+
+        if($name === '') {
+            \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
+            return false;
+        }
+        if($this->userHasTag($name, $this->user)) {
+            \OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
+            return false;
+        }
+        try {
+            $tag = new Tag($this->user, $this->type, $name);
+            $tag = $this->mapper->insert($tag);
+            $this->tags[] = $tag;
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        \OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
+        return $tag->getId();
+    }
+
+    /**
+     * Rename tag.
+     *
+     * @param string|integer $from The name or ID of the existing tag
+     * @param string $to The new name of the tag.
+     * @return bool
+     */
+    public function rename($from, $to) {
+        $from = trim($from);
+        $to = trim($to);
+
+        if($to === '' || $from === '') {
+            \OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
+            return false;
+        }
+
+        if (is_numeric($from)) {
+            $key = $this->getTagById($from);
+        } else {
+            $key = $this->getTagByName($from);
+        }
+        if($key === false) {
+            \OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
+            return false;
+        }
+        $tag = $this->tags[$key];
+
+        if($this->userHasTag($to, $tag->getOwner())) {
+            \OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
+            return false;
+        }
+
+        try {
+            $tag->setName($to);
+            $this->tags[$key] = $this->mapper->update($tag);
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Add a list of new tags.
+     *
+     * @param string[] $names A string with a name or an array of strings containing
+     * the name(s) of the tag(s) to add.
+     * @param bool $sync When true, save the tags
+     * @param int|null $id int Optional object id to add to this|these tag(s)
+     * @return bool Returns false on error.
+     */
+    public function addMultiple($names, $sync=false, $id = null) {
+        if(!is_array($names)) {
+            $names = array($names);
+        }
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        $newones = array();
+        foreach($names as $name) {
+            if(!$this->hasTag($name) && $name !== '') {
+                $newones[] = new Tag($this->user, $this->type, $name);
+            }
+            if(!is_null($id) ) {
+                // Insert $objectid, $categoryid  pairs if not exist.
+                self::$relations[] = array('objid' => $id, 'tag' => $name);
+            }
+        }
+        $this->tags = array_merge($this->tags, $newones);
+        if($sync === true) {
+            $this->save();
+        }
+
+        return true;
+    }
+
+    /**
+     * Save the list of tags and their object relations
+     */
+    protected function save() {
+        if(is_array($this->tags)) {
+            foreach($this->tags as $tag) {
+                try {
+                    if (!$this->mapper->tagExists($tag)) {
+                        $this->mapper->insert($tag);
+                    }
+                } catch(\Exception $e) {
+                    \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                        \OCP\Util::ERROR);
+                }
+            }
+
+            // reload tags to get the proper ids.
+            $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+            \OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
+                \OCP\Util::DEBUG);
+            // Loop through temporarily cached objectid/tagname pairs
+            // and save relations.
+            $tags = $this->tags;
+            // For some reason this is needed or array_search(i) will return 0..?
+            ksort($tags);
+            foreach(self::$relations as $relation) {
+                $tagId = $this->getTagId($relation['tag']);
+                \OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
+                if($tagId) {
+                    try {
+                        \OCP\DB::insertIfNotExist(self::RELATION_TABLE,
+                            array(
+                                'objid' => $relation['objid'],
+                                'categoryid' => $tagId,
+                                'type' => $this->type,
+                                ));
+                    } catch(\Exception $e) {
+                        \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                            \OCP\Util::ERROR);
+                    }
+                }
+            }
+            self::$relations = array(); // reset
+        } else {
+            \OCP\Util::writeLog('core', __METHOD__.', $this->tags is not an array! '
+                . print_r($this->tags, true), \OCP\Util::ERROR);
+        }
+    }
+
+    /**
+     * Delete tags and tag/object relations for a user.
+     *
+     * For hooking up on post_deleteUser
+     *
+     * @param array $arguments
+     */
+    public static function post_deleteUser($arguments) {
+        // Find all objectid/tagId pairs.
+        $result = null;
+        try {
+            $stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
+                . 'WHERE `uid` = ?');
+            $result = $stmt->execute(array($arguments['uid']));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+        }
+
+        if(!is_null($result)) {
+            try {
+                $stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
+                    . 'WHERE `categoryid` = ?');
+                while( $row = $result->fetchRow()) {
+                    try {
+                        $stmt->execute(array($row['id']));
+                    } catch(\Exception $e) {
+                        \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                            \OCP\Util::ERROR);
+                    }
+                }
+            } catch(\Exception $e) {
+                \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                    \OCP\Util::ERROR);
+            }
+        }
+        try {
+            $stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
+                . 'WHERE `uid` = ?');
+            $result = $stmt->execute(array($arguments['uid']));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__ . ', exception: '
+                . $e->getMessage(), \OCP\Util::ERROR);
+        }
+    }
+
+    /**
+     * Delete tag/object relations from the db
+     *
+     * @param array $ids The ids of the objects
+     * @return boolean Returns false on error.
+     */
+    public function purgeObjects(array $ids) {
+        if(count($ids) === 0) {
+            // job done ;)
+            return true;
+        }
+        $updates = $ids;
+        try {
+            $query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
+            $query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
+            $query .= 'AND `type`= ?';
+            $updates[] = $this->type;
+            $stmt = \OCP\DB::prepare($query);
+            $result = $stmt->execute($updates);
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                return false;
+            }
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Get favorites for an object type
+     *
+     * @return array|false An array of object ids.
+     */
+    public function getFavorites() {
+        try {
+            return $this->getIdsForTag(self::TAG_FAVORITE);
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
+                \OCP\Util::DEBUG);
+            return array();
+        }
+    }
+
+    /**
+     * Add an object to favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function addToFavorites($objid) {
+        if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
+            $this->add(self::TAG_FAVORITE);
+        }
+        return $this->tagAs($objid, self::TAG_FAVORITE);
+    }
+
+    /**
+     * Remove an object from favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function removeFromFavorites($objid) {
+        return $this->unTag($objid, self::TAG_FAVORITE);
+    }
+
+    /**
+     * Creates a tag/object relation.
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean Returns false on error.
+     */
+    public function tagAs($objid, $tag) {
+        if(is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
+                return false;
+            }
+            if(!$this->hasTag($tag)) {
+                $this->add($tag);
+            }
+            $tagId =  $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+        try {
+            \OCP\DB::insertIfNotExist(self::RELATION_TABLE,
+                array(
+                    'objid' => $objid,
+                    'categoryid' => $tagId,
+                    'type' => $this->type,
+                ));
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Delete single tag/object relation from the db
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean
+     */
+    public function unTag($objid, $tag) {
+        if(is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
+                return false;
+            }
+            $tagId =  $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+
+        try {
+            $sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+                    . 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
+            $stmt = \OCP\DB::prepare($sql);
+            $stmt->execute(array($objid, $tagId, $this->type));
+        } catch(\Exception $e) {
+            \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                \OCP\Util::ERROR);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Delete tags from the database.
+     *
+     * @param string[]|integer[] $names An array of tags (names or IDs) to delete
+     * @return bool Returns false on error
+     */
+    public function delete($names) {
+        if(!is_array($names)) {
+            $names = array($names);
+        }
+
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        \OCP\Util::writeLog('core', __METHOD__ . ', before: '
+            . print_r($this->tags, true), \OCP\Util::DEBUG);
+        foreach($names as $name) {
+            $id = null;
+
+            if (is_numeric($name)) {
+                $key = $this->getTagById($name);
+            } else {
+                $key = $this->getTagByName($name);
+            }
+            if ($key !== false) {
+                $tag = $this->tags[$key];
+                $id = $tag->getId();
+                unset($this->tags[$key]);
+                $this->mapper->delete($tag);
+            } else {
+                \OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
+                    . ': not found.', \OCP\Util::ERROR);
+            }
+            if(!is_null($id) && $id !== false) {
+                try {
+                    $sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+                            . 'WHERE `categoryid` = ?';
+                    $stmt = \OCP\DB::prepare($sql);
+                    $result = $stmt->execute(array($id));
+                    if (\OCP\DB::isError($result)) {
+                        \OCP\Util::writeLog('core',
+                            __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
+                            \OCP\Util::ERROR);
+                        return false;
+                    }
+                } catch(\Exception $e) {
+                    \OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
+                        \OCP\Util::ERROR);
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    // case-insensitive array_search
+    protected function array_searchi($needle, $haystack, $mem='getName') {
+        if(!is_array($haystack)) {
+            return false;
+        }
+        return array_search(strtolower($needle), array_map(
+            function($tag) use($mem) {
+                return strtolower(call_user_func(array($tag, $mem)));
+            }, $haystack)
+        );
+    }
+
+    /**
+     * Get a tag's ID.
+     *
+     * @param string $name The tag name to look for.
+     * @return string|bool The tag's id or false if no matching tag is found.
+     */
+    private function getTagId($name) {
+        $key = $this->array_searchi($name, $this->tags);
+        if ($key !== false) {
+            return $this->tags[$key]->getId();
+        }
+        return false;
+    }
+
+    /**
+     * Get a tag by its name.
+     *
+     * @param string $name The tag name.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagByName($name) {
+        return $this->array_searchi($name, $this->tags, 'getName');
+    }
+
+    /**
+     * Get a tag by its ID.
+     *
+     * @param string $id The tag ID to look for.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagById($id) {
+        return $this->array_searchi($id, $this->tags, 'getId');
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param Tag $tag The tag that is going to be mapped
+     * @return array
+     */
+    private function tagMap(Tag $tag) {
+        return array(
+            'id'    => $tag->getId(),
+            'name'  => $tag->getName(),
+            'owner' => $tag->getOwner(),
+            'type'  => $tag->getType()
+        );
+    }
 }

Spacing +85 added lines, -85 removed lines

@@ -132,7 +132,7 @@ 
 		}
 		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
 
-		if(count($defaultTags) > 0 && count($this->tags) === 0) {
+		if (count($defaultTags) > 0 && count($this->tags) === 0) {
 			$this->addMultiple($defaultTags, true);
 		}
 	}
@@ -173,7 +173,7 @@ 
 	* @return array
 	*/
 	public function getTags() {
-		if(!count($this->tags)) {
+		if (!count($this->tags)) {
 			return array();
 		}
 
@@ -182,8 +182,8 @@ 
 		});
 		$tagMap = array();
 
-		foreach($this->tags as $tag) {
-			if($tag->getName() !== self::TAG_FAVORITE) {
+		foreach ($this->tags as $tag) {
+			if ($tag->getName() !== self::TAG_FAVORITE) {
 				$tagMap[] = $this->tagMap($tag);
 			}
 		}
@@ -221,25 +221,25 @@ 
 			$chunks = array_chunk($objIds, 900, false);
 			foreach ($chunks as $chunk) {
 				$result = $conn->executeQuery(
-					'SELECT `category`, `categoryid`, `objid` ' .
-					'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
+					'SELECT `category`, `categoryid`, `objid` '.
+					'FROM `'.self::RELATION_TABLE.'` r, `'.self::TAG_TABLE.'` '.
 					'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
 					array($this->user, $this->type, $chunk),
 					array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
 				);
 				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
+					$objId = (int) $row['objid'];
 					if (!isset($entries[$objId])) {
 						$entries[$objId] = array();
 					}
 					$entries[$objId][] = $row['category'];
 				}
 				if (\OCP\DB::isError($result)) {
-					\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+					\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 					return false;
 				}
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
@@ -260,18 +260,18 @@ 
 	public function getIdsForTag($tag) {
 		$result = null;
 		$tagId = false;
-		if(is_numeric($tag)) {
+		if (is_numeric($tag)) {
 			$tagId = $tag;
-		} elseif(is_string($tag)) {
+		} elseif (is_string($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
 				return false;
 			}
 			$tagId = $this->getTagId($tag);
 		}
 
-		if($tagId === false) {
+		if ($tagId === false) {
 			$l10n = \OC::$server->getL10N('core');
 			throw new \Exception(
 				$l10n->t('Could not find category "%s"', [$tag])
@@ -279,25 +279,25 @@ 
 		}
 
 		$ids = array();
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+		$sql = 'SELECT `objid` FROM `'.self::RELATION_TABLE
 			. '` WHERE `categoryid` = ?';
 
 		try {
 			$stmt = \OCP\DB::prepare($sql);
 			$result = $stmt->execute(array($tagId));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 				return false;
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
 		}
 
-		if(!is_null($result)) {
-			while( $row = $result->fetchRow()) {
-				$id = (int)$row['objid'];
+		if (!is_null($result)) {
+			while ($row = $result->fetchRow()) {
+				$id = (int) $row['objid'];
 
 				if ($this->includeShared) {
 					// We have to check if we are really allowed to access the
@@ -351,24 +351,24 @@ 
 	public function add($name) {
 		$name = trim($name);
 
-		if($name === '') {
+		if ($name === '') {
 			\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
 			return false;
 		}
-		if($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
+		if ($this->userHasTag($name, $this->user)) {
+			\OCP\Util::writeLog('core', __METHOD__.', name: '.$name.' exists already', \OCP\Util::DEBUG);
 			return false;
 		}
 		try {
 			$tag = new Tag($this->user, $this->type, $name);
 			$tag = $this->mapper->insert($tag);
 			$this->tags[] = $tag;
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
 		}
-		\OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
+		\OCP\Util::writeLog('core', __METHOD__.', id: '.$tag->getId(), \OCP\Util::DEBUG);
 		return $tag->getId();
 	}
 
@@ -383,7 +383,7 @@ 
 		$from = trim($from);
 		$to = trim($to);
 
-		if($to === '' || $from === '') {
+		if ($to === '' || $from === '') {
 			\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
 			return false;
 		}
@@ -393,21 +393,21 @@ 
 		} else {
 			$key = $this->getTagByName($from);
 		}
-		if($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
+		if ($key === false) {
+			\OCP\Util::writeLog('core', __METHOD__.', tag: '.$from.' does not exist', \OCP\Util::DEBUG);
 			return false;
 		}
 		$tag = $this->tags[$key];
 
-		if($this->userHasTag($to, $tag->getOwner())) {
-			\OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
+		if ($this->userHasTag($to, $tag->getOwner())) {
+			\OCP\Util::writeLog('core', __METHOD__.', A tag named '.$to.' already exists for user '.$tag->getOwner().'.', \OCP\Util::DEBUG);
 			return false;
 		}
 
 		try {
 			$tag->setName($to);
 			$this->tags[$key] = $this->mapper->update($tag);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
@@ -424,25 +424,25 @@ 
 	* @param int|null $id int Optional object id to add to this|these tag(s)
 	* @return bool Returns false on error.
 	*/
-	public function addMultiple($names, $sync=false, $id = null) {
-		if(!is_array($names)) {
+	public function addMultiple($names, $sync = false, $id = null) {
+		if (!is_array($names)) {
 			$names = array($names);
 		}
 		$names = array_map('trim', $names);
 		array_filter($names);
 
 		$newones = array();
-		foreach($names as $name) {
-			if(!$this->hasTag($name) && $name !== '') {
+		foreach ($names as $name) {
+			if (!$this->hasTag($name) && $name !== '') {
 				$newones[] = new Tag($this->user, $this->type, $name);
 			}
-			if(!is_null($id) ) {
+			if (!is_null($id)) {
 				// Insert $objectid, $categoryid  pairs if not exist.
 				self::$relations[] = array('objid' => $id, 'tag' => $name);
 			}
 		}
 		$this->tags = array_merge($this->tags, $newones);
-		if($sync === true) {
+		if ($sync === true) {
 			$this->save();
 		}
 
@@ -453,13 +453,13 @@ 
 	 * Save the list of tags and their object relations
 	 */
 	protected function save() {
-		if(is_array($this->tags)) {
-			foreach($this->tags as $tag) {
+		if (is_array($this->tags)) {
+			foreach ($this->tags as $tag) {
 				try {
 					if (!$this->mapper->tagExists($tag)) {
 						$this->mapper->insert($tag);
 					}
-				} catch(\Exception $e) {
+				} catch (\Exception $e) {
 					\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 						\OCP\Util::ERROR);
 				}
@@ -467,17 +467,17 @@ 
 
 			// reload tags to get the proper ids.
 			$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-			\OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
+			\OCP\Util::writeLog('core', __METHOD__.', tags: '.print_r($this->tags, true),
 				\OCP\Util::DEBUG);
 			// Loop through temporarily cached objectid/tagname pairs
 			// and save relations.
 			$tags = $this->tags;
 			// For some reason this is needed or array_search(i) will return 0..?
 			ksort($tags);
-			foreach(self::$relations as $relation) {
+			foreach (self::$relations as $relation) {
 				$tagId = $this->getTagId($relation['tag']);
-				\OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
-				if($tagId) {
+				\OCP\Util::writeLog('core', __METHOD__.'catid, '.$relation['tag'].' '.$tagId, \OCP\Util::DEBUG);
+				if ($tagId) {
 					try {
 						\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
 							array(
@@ -485,7 +485,7 @@ 
 								'categoryid' => $tagId,
 								'type' => $this->type,
 								));
-					} catch(\Exception $e) {
+					} catch (\Exception $e) {
 						\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 							\OCP\Util::ERROR);
 					}
@@ -509,43 +509,43 @@ 
 		// Find all objectid/tagId pairs.
 		$result = null;
 		try {
-			$stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
+			$stmt = \OCP\DB::prepare('SELECT `id` FROM `'.self::TAG_TABLE.'` '
 				. 'WHERE `uid` = ?');
 			$result = $stmt->execute(array($arguments['uid']));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 		}
 
-		if(!is_null($result)) {
+		if (!is_null($result)) {
 			try {
-				$stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
+				$stmt = \OCP\DB::prepare('DELETE FROM `'.self::RELATION_TABLE.'` '
 					. 'WHERE `categoryid` = ?');
-				while( $row = $result->fetchRow()) {
+				while ($row = $result->fetchRow()) {
 					try {
 						$stmt->execute(array($row['id']));
-					} catch(\Exception $e) {
+					} catch (\Exception $e) {
 						\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 							\OCP\Util::ERROR);
 					}
 				}
-			} catch(\Exception $e) {
+			} catch (\Exception $e) {
 				\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 					\OCP\Util::ERROR);
 			}
 		}
 		try {
-			$stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
+			$stmt = \OCP\DB::prepare('DELETE FROM `'.self::TAG_TABLE.'` '
 				. 'WHERE `uid` = ?');
 			$result = $stmt->execute(array($arguments['uid']));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.', DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__ . ', exception: '
+		} catch (\Exception $e) {
+			\OCP\Util::writeLog('core', __METHOD__.', exception: '
 				. $e->getMessage(), \OCP\Util::ERROR);
 		}
 	}
@@ -557,24 +557,24 @@ 
 	* @return boolean Returns false on error.
 	*/
 	public function purgeObjects(array $ids) {
-		if(count($ids) === 0) {
+		if (count($ids) === 0) {
 			// job done ;)
 			return true;
 		}
 		$updates = $ids;
 		try {
-			$query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
-			$query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
+			$query = 'DELETE FROM `'.self::RELATION_TABLE.'` ';
+			$query .= 'WHERE `objid` IN ('.str_repeat('?,', count($ids) - 1).'?) ';
 			$query .= 'AND `type`= ?';
 			$updates[] = $this->type;
 			$stmt = \OCP\DB::prepare($query);
 			$result = $stmt->execute($updates);
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 				return false;
 			}
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
+		} catch (\Exception $e) {
+			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
 		}
@@ -589,8 +589,8 @@ 
 	public function getFavorites() {
 		try {
 			return $this->getIdsForTag(self::TAG_FAVORITE);
-		} catch(\Exception $e) {
-			\OCP\Util::writeLog('core', __METHOD__.', exception: ' . $e->getMessage(),
+		} catch (\Exception $e) {
+			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::DEBUG);
 			return array();
 		}
@@ -603,7 +603,7 @@ 
 	* @return boolean
 	*/
 	public function addToFavorites($objid) {
-		if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
+		if (!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
 			$this->add(self::TAG_FAVORITE);
 		}
 		return $this->tagAs($objid, self::TAG_FAVORITE);
@@ -627,16 +627,16 @@ 
 	* @return boolean Returns false on error.
 	*/
 	public function tagAs($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
+		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
 				return false;
 			}
-			if(!$this->hasTag($tag)) {
+			if (!$this->hasTag($tag)) {
 				$this->add($tag);
 			}
-			$tagId =  $this->getTagId($tag);
+			$tagId = $this->getTagId($tag);
 		} else {
 			$tagId = $tag;
 		}
@@ -647,7 +647,7 @@ 
 					'categoryid' => $tagId,
 					'type' => $this->type,
 				));
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
@@ -663,23 +663,23 @@ 
 	* @return boolean
 	*/
 	public function unTag($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
+		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
 				return false;
 			}
-			$tagId =  $this->getTagId($tag);
+			$tagId = $this->getTagId($tag);
 		} else {
 			$tagId = $tag;
 		}
 
 		try {
-			$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+			$sql = 'DELETE FROM `'.self::RELATION_TABLE.'` '
 					. 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
 			$stmt = \OCP\DB::prepare($sql);
 			$stmt->execute(array($objid, $tagId, $this->type));
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 				\OCP\Util::ERROR);
 			return false;
@@ -694,16 +694,16 @@ 
 	* @return bool Returns false on error
 	*/
 	public function delete($names) {
-		if(!is_array($names)) {
+		if (!is_array($names)) {
 			$names = array($names);
 		}
 
 		$names = array_map('trim', $names);
 		array_filter($names);
 
-		\OCP\Util::writeLog('core', __METHOD__ . ', before: '
+		\OCP\Util::writeLog('core', __METHOD__.', before: '
 			. print_r($this->tags, true), \OCP\Util::DEBUG);
-		foreach($names as $name) {
+		foreach ($names as $name) {
 			$id = null;
 
 			if (is_numeric($name)) {
@@ -717,22 +717,22 @@ 
 				unset($this->tags[$key]);
 				$this->mapper->delete($tag);
 			} else {
-				\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
+				\OCP\Util::writeLog('core', __METHOD__.'Cannot delete tag '.$name
 					. ': not found.', \OCP\Util::ERROR);
 			}
-			if(!is_null($id) && $id !== false) {
+			if (!is_null($id) && $id !== false) {
 				try {
-					$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+					$sql = 'DELETE FROM `'.self::RELATION_TABLE.'` '
 							. 'WHERE `categoryid` = ?';
 					$stmt = \OCP\DB::prepare($sql);
 					$result = $stmt->execute(array($id));
 					if (\OCP\DB::isError($result)) {
 						\OCP\Util::writeLog('core',
-							__METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
+							__METHOD__.'DB error: '.\OCP\DB::getErrorMessage(),
 							\OCP\Util::ERROR);
 						return false;
 					}
-				} catch(\Exception $e) {
+				} catch (\Exception $e) {
 					\OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
 						\OCP\Util::ERROR);
 					return false;
@@ -743,8 +743,8 @@ 
 	}
 
 	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem='getName') {
-		if(!is_array($haystack)) {
+	protected function array_searchi($needle, $haystack, $mem = 'getName') {
+		if (!is_array($haystack)) {
 			return false;
 		}
 		return array_search(strtolower($needle), array_map(

lib/private/Template/Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
 	/**
 	 * Appends a variable
 	 * @param string $key key
-	 * @param mixed $value value
+	 * @param string $value value
 	 * @return boolean|null
 	 *
 	 * This function assigns a variable in an array context. If the key already

Braces +2 added lines, -4 removed lines

@@ -114,8 +114,7 @@ 
 	public function append( $key, $value ) {
 		if( array_key_exists( $key, $this->vars )) {
 			$this->vars[$key][] = $value;
-		}
-		else{
+		} else{
 			$this->vars[$key] = array( $value );
 		}
 	}
@@ -130,8 +129,7 @@ 
 		$data = $this->fetchPage();
 		if( $data === false ) {
 			return false;
-		}
-		else{
+		} else{
 			print $data;
 			return true;
 		}

Indentation +153 added lines, -153 removed lines

@@ -31,158 +31,158 @@
 use OCP\Defaults;
 
 class Base {
-	private $template; // The template
-	private $vars; // Vars
-
-	/** @var \OCP\IL10N */
-	private $l10n;
-
-	/** @var Defaults */
-	private $theme;
-
-	/**
-	 * @param string $template
-	 * @param string $requestToken
-	 * @param \OCP\IL10N $l10n
-	 * @param Defaults $theme
-	 */
-	public function __construct($template, $requestToken, $l10n, $theme ) {
-		$this->vars = array();
-		$this->vars['requesttoken'] = $requestToken;
-		$this->l10n = $l10n;
-		$this->template = $template;
-		$this->theme = $theme;
-	}
-
-	/**
-	 * @param string $serverRoot
-	 * @param string|false $app_dir
-	 * @param string $theme
-	 * @param string $app
-	 * @return string[]
-	 */
-	protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
-		// Check if the app is in the app folder or in the root
-		if( file_exists($app_dir.'/templates/' )) {
-			return [
-				$serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
-				$app_dir.'/templates/',
-			];
-		}
-		return [
-			$serverRoot.'/themes/'.$theme.'/'.$app.'/templates/',
-			$serverRoot.'/'.$app.'/templates/',
-		];
-	}
-
-	/**
-	 * @param string $serverRoot
-	 * @param string $theme
-	 * @return string[]
-	 */
-	protected function getCoreTemplateDirs($theme, $serverRoot) {
-		return [
-			$serverRoot.'/themes/'.$theme.'/core/templates/',
-			$serverRoot.'/core/templates/',
-		];
-	}
-
-	/**
-	 * Assign variables
-	 * @param string $key key
-	 * @param array|bool|integer|string $value value
-	 * @return bool
-	 *
-	 * This function assigns a variable. It can be accessed via $_[$key] in
-	 * the template.
-	 *
-	 * If the key existed before, it will be overwritten
-	 */
-	public function assign( $key, $value) {
-		$this->vars[$key] = $value;
-		return true;
-	}
-
-	/**
-	 * Appends a variable
-	 * @param string $key key
-	 * @param mixed $value value
-	 * @return boolean|null
-	 *
-	 * This function assigns a variable in an array context. If the key already
-	 * exists, the value will be appended. It can be accessed via
-	 * $_[$key][$position] in the template.
-	 */
-	public function append( $key, $value ) {
-		if( array_key_exists( $key, $this->vars )) {
-			$this->vars[$key][] = $value;
-		}
-		else{
-			$this->vars[$key] = array( $value );
-		}
-	}
-
-	/**
-	 * Prints the proceeded template
-	 * @return bool
-	 *
-	 * This function proceeds the template and prints its output.
-	 */
-	public function printPage() {
-		$data = $this->fetchPage();
-		if( $data === false ) {
-			return false;
-		}
-		else{
-			print $data;
-			return true;
-		}
-	}
-
-	/**
-	 * Process the template
-	 *
-	 * @param array|null $additionalParams
-	 * @return string This function processes the template.
-	 *
-	 * This function processes the template.
-	 */
-	public function fetchPage($additionalParams = null) {
-		return $this->load($this->template, $additionalParams);
-	}
-
-	/**
-	 * doing the actual work
-	 *
-	 * @param string $file
-	 * @param array|null $additionalParams
-	 * @return string content
-	 *
-	 * Includes the template file, fetches its output
-	 */
-	protected function load($file, $additionalParams = null) {
-		// Register the variables
-		$_ = $this->vars;
-		$l = $this->l10n;
-		$theme = $this->theme;
-
-		if( !is_null($additionalParams)) {
-			$_ = array_merge( $additionalParams, $this->vars );
-		}
-
-		// Include
-		ob_start();
-		try {
-			include $file;
-			$data = ob_get_contents();
-		} catch (\Exception $e) {
-			@ob_end_clean();
-			throw $e;
-		}
-		@ob_end_clean();
-
-		// Return data
-		return $data;
-	}
+    private $template; // The template
+    private $vars; // Vars
+
+    /** @var \OCP\IL10N */
+    private $l10n;
+
+    /** @var Defaults */
+    private $theme;
+
+    /**
+     * @param string $template
+     * @param string $requestToken
+     * @param \OCP\IL10N $l10n
+     * @param Defaults $theme
+     */
+    public function __construct($template, $requestToken, $l10n, $theme ) {
+        $this->vars = array();
+        $this->vars['requesttoken'] = $requestToken;
+        $this->l10n = $l10n;
+        $this->template = $template;
+        $this->theme = $theme;
+    }
+
+    /**
+     * @param string $serverRoot
+     * @param string|false $app_dir
+     * @param string $theme
+     * @param string $app
+     * @return string[]
+     */
+    protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
+        // Check if the app is in the app folder or in the root
+        if( file_exists($app_dir.'/templates/' )) {
+            return [
+                $serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
+                $app_dir.'/templates/',
+            ];
+        }
+        return [
+            $serverRoot.'/themes/'.$theme.'/'.$app.'/templates/',
+            $serverRoot.'/'.$app.'/templates/',
+        ];
+    }
+
+    /**
+     * @param string $serverRoot
+     * @param string $theme
+     * @return string[]
+     */
+    protected function getCoreTemplateDirs($theme, $serverRoot) {
+        return [
+            $serverRoot.'/themes/'.$theme.'/core/templates/',
+            $serverRoot.'/core/templates/',
+        ];
+    }
+
+    /**
+     * Assign variables
+     * @param string $key key
+     * @param array|bool|integer|string $value value
+     * @return bool
+     *
+     * This function assigns a variable. It can be accessed via $_[$key] in
+     * the template.
+     *
+     * If the key existed before, it will be overwritten
+     */
+    public function assign( $key, $value) {
+        $this->vars[$key] = $value;
+        return true;
+    }
+
+    /**
+     * Appends a variable
+     * @param string $key key
+     * @param mixed $value value
+     * @return boolean|null
+     *
+     * This function assigns a variable in an array context. If the key already
+     * exists, the value will be appended. It can be accessed via
+     * $_[$key][$position] in the template.
+     */
+    public function append( $key, $value ) {
+        if( array_key_exists( $key, $this->vars )) {
+            $this->vars[$key][] = $value;
+        }
+        else{
+            $this->vars[$key] = array( $value );
+        }
+    }
+
+    /**
+     * Prints the proceeded template
+     * @return bool
+     *
+     * This function proceeds the template and prints its output.
+     */
+    public function printPage() {
+        $data = $this->fetchPage();
+        if( $data === false ) {
+            return false;
+        }
+        else{
+            print $data;
+            return true;
+        }
+    }
+
+    /**
+     * Process the template
+     *
+     * @param array|null $additionalParams
+     * @return string This function processes the template.
+     *
+     * This function processes the template.
+     */
+    public function fetchPage($additionalParams = null) {
+        return $this->load($this->template, $additionalParams);
+    }
+
+    /**
+     * doing the actual work
+     *
+     * @param string $file
+     * @param array|null $additionalParams
+     * @return string content
+     *
+     * Includes the template file, fetches its output
+     */
+    protected function load($file, $additionalParams = null) {
+        // Register the variables
+        $_ = $this->vars;
+        $l = $this->l10n;
+        $theme = $this->theme;
+
+        if( !is_null($additionalParams)) {
+            $_ = array_merge( $additionalParams, $this->vars );
+        }
+
+        // Include
+        ob_start();
+        try {
+            include $file;
+            $data = ob_get_contents();
+        } catch (\Exception $e) {
+            @ob_end_clean();
+            throw $e;
+        }
+        @ob_end_clean();
+
+        // Return data
+        return $data;
+    }
 
 }

Spacing +11 added lines, -11 removed lines

@@ -46,7 +46,7 @@ 
 	 * @param \OCP\IL10N $l10n
 	 * @param Defaults $theme
 	 */
-	public function __construct($template, $requestToken, $l10n, $theme ) {
+	public function __construct($template, $requestToken, $l10n, $theme) {
 		$this->vars = array();
 		$this->vars['requesttoken'] = $requestToken;
 		$this->l10n = $l10n;
@@ -63,7 +63,7 @@ 
 	 */
 	protected function getAppTemplateDirs($theme, $app, $serverRoot, $app_dir) {
 		// Check if the app is in the app folder or in the root
-		if( file_exists($app_dir.'/templates/' )) {
+		if (file_exists($app_dir.'/templates/')) {
 			return [
 				$serverRoot.'/themes/'.$theme.'/apps/'.$app.'/templates/',
 				$app_dir.'/templates/',
@@ -98,7 +98,7 @@ 
 	 *
 	 * If the key existed before, it will be overwritten
 	 */
-	public function assign( $key, $value) {
+	public function assign($key, $value) {
 		$this->vars[$key] = $value;
 		return true;
 	}
@@ -113,12 +113,12 @@ 
 	 * exists, the value will be appended. It can be accessed via
 	 * $_[$key][$position] in the template.
 	 */
-	public function append( $key, $value ) {
-		if( array_key_exists( $key, $this->vars )) {
+	public function append($key, $value) {
+		if (array_key_exists($key, $this->vars)) {
 			$this->vars[$key][] = $value;
 		}
-		else{
-			$this->vars[$key] = array( $value );
+		else {
+			$this->vars[$key] = array($value);
 		}
 	}
 
@@ -130,10 +130,10 @@ 
 	 */
 	public function printPage() {
 		$data = $this->fetchPage();
-		if( $data === false ) {
+		if ($data === false) {
 			return false;
 		}
-		else{
+		else {
 			print $data;
 			return true;
 		}
@@ -166,8 +166,8 @@ 
 		$l = $this->l10n;
 		$theme = $this->theme;
 
-		if( !is_null($additionalParams)) {
-			$_ = array_merge( $additionalParams, $this->vars );
+		if (!is_null($additionalParams)) {
+			$_ = array_merge($additionalParams, $this->vars);
 		}
 
 		// Include

lib/public/AppFramework/Db/Mapper.php

Doc Comments +2 added lines, -1 removed lines

@@ -308,6 +308,7 @@ 
 	 * @param array $params the parameters of the sql query
 	 * @param int $limit the maximum number of rows
 	 * @param int $offset from which row we want to start
+	 * @param string $msg
 	 * @return string formatted error message string
 	 * @since 9.1.0
 	 */
@@ -360,7 +361,7 @@ 
 	 * Returns an db result and throws exceptions when there are more or less
 	 * results
 	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
+	 * @param string[] $params the parameters of the sql query
 	 * @param int $limit the maximum number of rows
 	 * @param int $offset from which row we want to start
 	 * @throws DoesNotExistException if the item does not exist

Indentation +321 added lines, -321 removed lines

@@ -37,327 +37,327 @@
  */
 abstract class Mapper {
 
-	protected $tableName;
-	protected $entityClass;
-	protected $db;
-
-	/**
-	 * @param IDBConnection $db Instance of the Db abstraction layer
-	 * @param string $tableName the name of the table. set this to allow entity
-	 * @param string $entityClass the name of the entity that the sql should be
-	 * mapped to queries without using sql
-	 * @since 7.0.0
-	 */
-	public function __construct(IDBConnection $db, $tableName, $entityClass=null){
-		$this->db = $db;
-		$this->tableName = '*PREFIX*' . $tableName;
-
-		// if not given set the entity name to the class without the mapper part
-		// cache it here for later use since reflection is slow
-		if($entityClass === null) {
-			$this->entityClass = str_replace('Mapper', '', get_class($this));
-		} else {
-			$this->entityClass = $entityClass;
-		}
-	}
-
-
-	/**
-	 * @return string the table name
-	 * @since 7.0.0
-	 */
-	public function getTableName(){
-		return $this->tableName;
-	}
-
-
-	/**
-	 * Deletes an entity from the table
-	 * @param Entity $entity the entity that should be deleted
-	 * @return Entity the deleted entity
-	 * @since 7.0.0 - return value added in 8.1.0
-	 */
-	public function delete(Entity $entity){
-		$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
-		$stmt = $this->execute($sql, [$entity->getId()]);
-		$stmt->closeCursor();
-		return $entity;
-	}
-
-
-	/**
-	 * Creates a new entry in the db from an entity
-	 * @param Entity $entity the entity that should be created
-	 * @return Entity the saved entity with the set id
-	 * @since 7.0.0
-	 */
-	public function insert(Entity $entity){
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		$properties = $entity->getUpdatedFields();
-		$values = '';
-		$columns = '';
-		$params = [];
-
-		// build the fields
-		$i = 0;
-		foreach($properties as $property => $updated) {
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-
-			$columns .= '`' . $column . '`';
-			$values .= '?';
-
-			// only append colon if there are more entries
-			if($i < count($properties)-1){
-				$columns .= ',';
-				$values .= ',';
-			}
-
-			$params[] = $entity->$getter();
-			$i++;
-
-		}
-
-		$sql = 'INSERT INTO `' . $this->tableName . '`(' .
-				$columns . ') VALUES(' . $values . ')';
-
-		$stmt = $this->execute($sql, $params);
-
-		$entity->setId((int) $this->db->lastInsertId($this->tableName));
-
-		$stmt->closeCursor();
-
-		return $entity;
-	}
-
-
-
-	/**
-	 * Updates an entry in the db from an entity
-	 * @throws \InvalidArgumentException if entity has no id
-	 * @param Entity $entity the entity that should be created
-	 * @return Entity the saved entity with the set id
-	 * @since 7.0.0 - return value was added in 8.0.0
-	 */
-	public function update(Entity $entity){
-		// if entity wasn't changed it makes no sense to run a db query
-		$properties = $entity->getUpdatedFields();
-		if(count($properties) === 0) {
-			return $entity;
-		}
-
-		// entity needs an id
-		$id = $entity->getId();
-		if($id === null){
-			throw new \InvalidArgumentException(
-				'Entity which should be updated has no id');
-		}
-
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		// do not update the id field
-		unset($properties['id']);
-
-		$columns = '';
-		$params = [];
-
-		// build the fields
-		$i = 0;
-		foreach($properties as $property => $updated) {
-
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-
-			$columns .= '`' . $column . '` = ?';
-
-			// only append colon if there are more entries
-			if($i < count($properties)-1){
-				$columns .= ',';
-			}
-
-			$params[] = $entity->$getter();
-			$i++;
-		}
-
-		$sql = 'UPDATE `' . $this->tableName . '` SET ' .
-				$columns . ' WHERE `id` = ?';
-		$params[] = $id;
-
-		$stmt = $this->execute($sql, $params);
-		$stmt->closeCursor();
-
-		return $entity;
-	}
-
-	/**
-	 * Checks if an array is associative
-	 * @param array $array
-	 * @return bool true if associative
-	 * @since 8.1.0
-	 */
-	private function isAssocArray(array $array) {
-		return array_values($array) !== $array;
-	}
-
-	/**
-	 * Returns the correct PDO constant based on the value type
-	 * @param $value
-	 * @return int PDO constant
-	 * @since 8.1.0
-	 */
-	private function getPDOType($value) {
-		switch (gettype($value)) {
-			case 'integer':
-				return \PDO::PARAM_INT;
-			case 'boolean':
-				return \PDO::PARAM_BOOL;
-			default:
-				return \PDO::PARAM_STR;
-		}
-	}
-
-
-	/**
-	 * Runs an sql query
-	 * @param string $sql the prepare string
-	 * @param array $params the params which should replace the ? in the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return \PDOStatement the database query result
-	 * @since 7.0.0
-	 */
-	protected function execute($sql, array $params=[], $limit=null, $offset=null){
-		$query = $this->db->prepare($sql, $limit, $offset);
-
-		if ($this->isAssocArray($params)) {
-			foreach ($params as $key => $param) {
-				$pdoConstant = $this->getPDOType($param);
-				$query->bindValue($key, $param, $pdoConstant);
-			}
-		} else {
-			$index = 1;  // bindParam is 1 indexed
-			foreach ($params as $param) {
-				$pdoConstant = $this->getPDOType($param);
-				$query->bindValue($index, $param, $pdoConstant);
-				$index++;
-			}
-		}
-
-		$result = $query->execute();
-
-		return $query;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 * @see findEntity
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return array the result as row
-	 * @since 7.0.0
-	 */
-	protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
-		$stmt = $this->execute($sql, $params, $limit, $offset);
-		$row = $stmt->fetch();
-
-		if($row === false || $row === null){
-			$stmt->closeCursor();
-			$msg = $this->buildDebugMessage(
-				'Did expect one result but found none when executing', $sql, $params, $limit, $offset
-			);
-			throw new DoesNotExistException($msg);
-		}
-		$row2 = $stmt->fetch();
-		$stmt->closeCursor();
-		//MDB2 returns null, PDO and doctrine false when no row is available
-		if( ! ($row2 === false || $row2 === null )) {
-			$msg = $this->buildDebugMessage(
-				'Did not expect more than one result when executing', $sql, $params, $limit, $offset
-			);
-			throw new MultipleObjectsReturnedException($msg);
-		} else {
-			return $row;
-		}
-	}
-
-	/**
-	 * Builds an error message by prepending the $msg to an error message which
-	 * has the parameters
-	 * @see findEntity
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return string formatted error message string
-	 * @since 9.1.0
-	 */
-	private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
-		return $msg .
-					': query "' .	$sql . '"; ' .
-					'parameters ' . print_r($params, true) . '; ' .
-					'limit "' . $limit . '"; '.
-					'offset "' . $offset . '"';
-	}
-
-
-	/**
-	 * Creates an entity from a row. Automatically determines the entity class
-	 * from the current mapper name (MyEntityMapper -> MyEntity)
-	 * @param array $row the row which should be converted to an entity
-	 * @return Entity the entity
-	 * @since 7.0.0
-	 */
-	protected function mapRowToEntity($row) {
-		return call_user_func($this->entityClass .'::fromRow', $row);
-	}
-
-
-	/**
-	 * Runs a sql query and returns an array of entities
-	 * @param string $sql the prepare string
-	 * @param array $params the params which should replace the ? in the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return array all fetched entities
-	 * @since 7.0.0
-	 */
-	protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
-		$stmt = $this->execute($sql, $params, $limit, $offset);
-
-		$entities = [];
-
-		while($row = $stmt->fetch()){
-			$entities[] = $this->mapRowToEntity($row);
-		}
-
-		$stmt->closeCursor();
-
-		return $entities;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return Entity the entity
-	 * @since 7.0.0
-	 */
-	protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
-		return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
-	}
+    protected $tableName;
+    protected $entityClass;
+    protected $db;
+
+    /**
+     * @param IDBConnection $db Instance of the Db abstraction layer
+     * @param string $tableName the name of the table. set this to allow entity
+     * @param string $entityClass the name of the entity that the sql should be
+     * mapped to queries without using sql
+     * @since 7.0.0
+     */
+    public function __construct(IDBConnection $db, $tableName, $entityClass=null){
+        $this->db = $db;
+        $this->tableName = '*PREFIX*' . $tableName;
+
+        // if not given set the entity name to the class without the mapper part
+        // cache it here for later use since reflection is slow
+        if($entityClass === null) {
+            $this->entityClass = str_replace('Mapper', '', get_class($this));
+        } else {
+            $this->entityClass = $entityClass;
+        }
+    }
+
+
+    /**
+     * @return string the table name
+     * @since 7.0.0
+     */
+    public function getTableName(){
+        return $this->tableName;
+    }
+
+
+    /**
+     * Deletes an entity from the table
+     * @param Entity $entity the entity that should be deleted
+     * @return Entity the deleted entity
+     * @since 7.0.0 - return value added in 8.1.0
+     */
+    public function delete(Entity $entity){
+        $sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
+        $stmt = $this->execute($sql, [$entity->getId()]);
+        $stmt->closeCursor();
+        return $entity;
+    }
+
+
+    /**
+     * Creates a new entry in the db from an entity
+     * @param Entity $entity the entity that should be created
+     * @return Entity the saved entity with the set id
+     * @since 7.0.0
+     */
+    public function insert(Entity $entity){
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        $properties = $entity->getUpdatedFields();
+        $values = '';
+        $columns = '';
+        $params = [];
+
+        // build the fields
+        $i = 0;
+        foreach($properties as $property => $updated) {
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+
+            $columns .= '`' . $column . '`';
+            $values .= '?';
+
+            // only append colon if there are more entries
+            if($i < count($properties)-1){
+                $columns .= ',';
+                $values .= ',';
+            }
+
+            $params[] = $entity->$getter();
+            $i++;
+
+        }
+
+        $sql = 'INSERT INTO `' . $this->tableName . '`(' .
+                $columns . ') VALUES(' . $values . ')';
+
+        $stmt = $this->execute($sql, $params);
+
+        $entity->setId((int) $this->db->lastInsertId($this->tableName));
+
+        $stmt->closeCursor();
+
+        return $entity;
+    }
+
+
+
+    /**
+     * Updates an entry in the db from an entity
+     * @throws \InvalidArgumentException if entity has no id
+     * @param Entity $entity the entity that should be created
+     * @return Entity the saved entity with the set id
+     * @since 7.0.0 - return value was added in 8.0.0
+     */
+    public function update(Entity $entity){
+        // if entity wasn't changed it makes no sense to run a db query
+        $properties = $entity->getUpdatedFields();
+        if(count($properties) === 0) {
+            return $entity;
+        }
+
+        // entity needs an id
+        $id = $entity->getId();
+        if($id === null){
+            throw new \InvalidArgumentException(
+                'Entity which should be updated has no id');
+        }
+
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        // do not update the id field
+        unset($properties['id']);
+
+        $columns = '';
+        $params = [];
+
+        // build the fields
+        $i = 0;
+        foreach($properties as $property => $updated) {
+
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+
+            $columns .= '`' . $column . '` = ?';
+
+            // only append colon if there are more entries
+            if($i < count($properties)-1){
+                $columns .= ',';
+            }
+
+            $params[] = $entity->$getter();
+            $i++;
+        }
+
+        $sql = 'UPDATE `' . $this->tableName . '` SET ' .
+                $columns . ' WHERE `id` = ?';
+        $params[] = $id;
+
+        $stmt = $this->execute($sql, $params);
+        $stmt->closeCursor();
+
+        return $entity;
+    }
+
+    /**
+     * Checks if an array is associative
+     * @param array $array
+     * @return bool true if associative
+     * @since 8.1.0
+     */
+    private function isAssocArray(array $array) {
+        return array_values($array) !== $array;
+    }
+
+    /**
+     * Returns the correct PDO constant based on the value type
+     * @param $value
+     * @return int PDO constant
+     * @since 8.1.0
+     */
+    private function getPDOType($value) {
+        switch (gettype($value)) {
+            case 'integer':
+                return \PDO::PARAM_INT;
+            case 'boolean':
+                return \PDO::PARAM_BOOL;
+            default:
+                return \PDO::PARAM_STR;
+        }
+    }
+
+
+    /**
+     * Runs an sql query
+     * @param string $sql the prepare string
+     * @param array $params the params which should replace the ? in the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return \PDOStatement the database query result
+     * @since 7.0.0
+     */
+    protected function execute($sql, array $params=[], $limit=null, $offset=null){
+        $query = $this->db->prepare($sql, $limit, $offset);
+
+        if ($this->isAssocArray($params)) {
+            foreach ($params as $key => $param) {
+                $pdoConstant = $this->getPDOType($param);
+                $query->bindValue($key, $param, $pdoConstant);
+            }
+        } else {
+            $index = 1;  // bindParam is 1 indexed
+            foreach ($params as $param) {
+                $pdoConstant = $this->getPDOType($param);
+                $query->bindValue($index, $param, $pdoConstant);
+                $index++;
+            }
+        }
+
+        $result = $query->execute();
+
+        return $query;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     * @see findEntity
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return array the result as row
+     * @since 7.0.0
+     */
+    protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
+        $stmt = $this->execute($sql, $params, $limit, $offset);
+        $row = $stmt->fetch();
+
+        if($row === false || $row === null){
+            $stmt->closeCursor();
+            $msg = $this->buildDebugMessage(
+                'Did expect one result but found none when executing', $sql, $params, $limit, $offset
+            );
+            throw new DoesNotExistException($msg);
+        }
+        $row2 = $stmt->fetch();
+        $stmt->closeCursor();
+        //MDB2 returns null, PDO and doctrine false when no row is available
+        if( ! ($row2 === false || $row2 === null )) {
+            $msg = $this->buildDebugMessage(
+                'Did not expect more than one result when executing', $sql, $params, $limit, $offset
+            );
+            throw new MultipleObjectsReturnedException($msg);
+        } else {
+            return $row;
+        }
+    }
+
+    /**
+     * Builds an error message by prepending the $msg to an error message which
+     * has the parameters
+     * @see findEntity
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return string formatted error message string
+     * @since 9.1.0
+     */
+    private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
+        return $msg .
+                    ': query "' .	$sql . '"; ' .
+                    'parameters ' . print_r($params, true) . '; ' .
+                    'limit "' . $limit . '"; '.
+                    'offset "' . $offset . '"';
+    }
+
+
+    /**
+     * Creates an entity from a row. Automatically determines the entity class
+     * from the current mapper name (MyEntityMapper -> MyEntity)
+     * @param array $row the row which should be converted to an entity
+     * @return Entity the entity
+     * @since 7.0.0
+     */
+    protected function mapRowToEntity($row) {
+        return call_user_func($this->entityClass .'::fromRow', $row);
+    }
+
+
+    /**
+     * Runs a sql query and returns an array of entities
+     * @param string $sql the prepare string
+     * @param array $params the params which should replace the ? in the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return array all fetched entities
+     * @since 7.0.0
+     */
+    protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
+        $stmt = $this->execute($sql, $params, $limit, $offset);
+
+        $entities = [];
+
+        while($row = $stmt->fetch()){
+            $entities[] = $this->mapRowToEntity($row);
+        }
+
+        $stmt->closeCursor();
+
+        return $entities;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return Entity the entity
+     * @since 7.0.0
+     */
+    protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
+        return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
+    }
 
 
 }

Spacing +37 added lines, -37 removed lines

@@ -48,13 +48,13 @@ 
 	 * mapped to queries without using sql
 	 * @since 7.0.0
 	 */
-	public function __construct(IDBConnection $db, $tableName, $entityClass=null){
+	public function __construct(IDBConnection $db, $tableName, $entityClass = null) {
 		$this->db = $db;
-		$this->tableName = '*PREFIX*' . $tableName;
+		$this->tableName = '*PREFIX*'.$tableName;
 
 		// if not given set the entity name to the class without the mapper part
 		// cache it here for later use since reflection is slow
-		if($entityClass === null) {
+		if ($entityClass === null) {
 			$this->entityClass = str_replace('Mapper', '', get_class($this));
 		} else {
 			$this->entityClass = $entityClass;
@@ -66,7 +66,7 @@ 
 	 * @return string the table name
 	 * @since 7.0.0
 	 */
-	public function getTableName(){
+	public function getTableName() {
 		return $this->tableName;
 	}
 
@@ -77,8 +77,8 @@ 
 	 * @return Entity the deleted entity
 	 * @since 7.0.0 - return value added in 8.1.0
 	 */
-	public function delete(Entity $entity){
-		$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
+	public function delete(Entity $entity) {
+		$sql = 'DELETE FROM `'.$this->tableName.'` WHERE `id` = ?';
 		$stmt = $this->execute($sql, [$entity->getId()]);
 		$stmt->closeCursor();
 		return $entity;
@@ -91,7 +91,7 @@ 
 	 * @return Entity the saved entity with the set id
 	 * @since 7.0.0
 	 */
-	public function insert(Entity $entity){
+	public function insert(Entity $entity) {
 		// get updated fields to save, fields have to be set using a setter to
 		// be saved
 		$properties = $entity->getUpdatedFields();
@@ -101,15 +101,15 @@ 
 
 		// build the fields
 		$i = 0;
-		foreach($properties as $property => $updated) {
+		foreach ($properties as $property => $updated) {
 			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
+			$getter = 'get'.ucfirst($property);
 
-			$columns .= '`' . $column . '`';
+			$columns .= '`'.$column.'`';
 			$values .= '?';
 
 			// only append colon if there are more entries
-			if($i < count($properties)-1){
+			if ($i < count($properties) - 1) {
 				$columns .= ',';
 				$values .= ',';
 			}
@@ -119,8 +119,8 @@ 
 
 		}
 
-		$sql = 'INSERT INTO `' . $this->tableName . '`(' .
-				$columns . ') VALUES(' . $values . ')';
+		$sql = 'INSERT INTO `'.$this->tableName.'`('.
+				$columns.') VALUES('.$values.')';
 
 		$stmt = $this->execute($sql, $params);
 
@@ -140,16 +140,16 @@ 
 	 * @return Entity the saved entity with the set id
 	 * @since 7.0.0 - return value was added in 8.0.0
 	 */
-	public function update(Entity $entity){
+	public function update(Entity $entity) {
 		// if entity wasn't changed it makes no sense to run a db query
 		$properties = $entity->getUpdatedFields();
-		if(count($properties) === 0) {
+		if (count($properties) === 0) {
 			return $entity;
 		}
 
 		// entity needs an id
 		$id = $entity->getId();
-		if($id === null){
+		if ($id === null) {
 			throw new \InvalidArgumentException(
 				'Entity which should be updated has no id');
 		}
@@ -164,15 +164,15 @@ 
 
 		// build the fields
 		$i = 0;
-		foreach($properties as $property => $updated) {
+		foreach ($properties as $property => $updated) {
 
 			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
+			$getter = 'get'.ucfirst($property);
 
-			$columns .= '`' . $column . '` = ?';
+			$columns .= '`'.$column.'` = ?';
 
 			// only append colon if there are more entries
-			if($i < count($properties)-1){
+			if ($i < count($properties) - 1) {
 				$columns .= ',';
 			}
 
@@ -180,8 +180,8 @@ 
 			$i++;
 		}
 
-		$sql = 'UPDATE `' . $this->tableName . '` SET ' .
-				$columns . ' WHERE `id` = ?';
+		$sql = 'UPDATE `'.$this->tableName.'` SET '.
+				$columns.' WHERE `id` = ?';
 		$params[] = $id;
 
 		$stmt = $this->execute($sql, $params);
@@ -227,7 +227,7 @@ 
 	 * @return \PDOStatement the database query result
 	 * @since 7.0.0
 	 */
-	protected function execute($sql, array $params=[], $limit=null, $offset=null){
+	protected function execute($sql, array $params = [], $limit = null, $offset = null) {
 		$query = $this->db->prepare($sql, $limit, $offset);
 
 		if ($this->isAssocArray($params)) {
@@ -236,7 +236,7 @@ 
 				$query->bindValue($key, $param, $pdoConstant);
 			}
 		} else {
-			$index = 1;  // bindParam is 1 indexed
+			$index = 1; // bindParam is 1 indexed
 			foreach ($params as $param) {
 				$pdoConstant = $this->getPDOType($param);
 				$query->bindValue($index, $param, $pdoConstant);
@@ -263,11 +263,11 @@ 
 	 * @return array the result as row
 	 * @since 7.0.0
 	 */
-	protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
+	protected function findOneQuery($sql, array $params = [], $limit = null, $offset = null) {
 		$stmt = $this->execute($sql, $params, $limit, $offset);
 		$row = $stmt->fetch();
 
-		if($row === false || $row === null){
+		if ($row === false || $row === null) {
 			$stmt->closeCursor();
 			$msg = $this->buildDebugMessage(
 				'Did expect one result but found none when executing', $sql, $params, $limit, $offset
@@ -277,7 +277,7 @@ 
 		$row2 = $stmt->fetch();
 		$stmt->closeCursor();
 		//MDB2 returns null, PDO and doctrine false when no row is available
-		if( ! ($row2 === false || $row2 === null )) {
+		if (!($row2 === false || $row2 === null)) {
 			$msg = $this->buildDebugMessage(
 				'Did not expect more than one result when executing', $sql, $params, $limit, $offset
 			);
@@ -298,12 +298,12 @@ 
 	 * @return string formatted error message string
 	 * @since 9.1.0
 	 */
-	private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
-		return $msg .
-					': query "' .	$sql . '"; ' .
-					'parameters ' . print_r($params, true) . '; ' .
-					'limit "' . $limit . '"; '.
-					'offset "' . $offset . '"';
+	private function buildDebugMessage($msg, $sql, array $params = [], $limit = null, $offset = null) {
+		return $msg.
+					': query "'.$sql.'"; '.
+					'parameters '.print_r($params, true).'; '.
+					'limit "'.$limit.'"; '.
+					'offset "'.$offset.'"';
 	}
 
 
@@ -315,7 +315,7 @@ 
 	 * @since 7.0.0
 	 */
 	protected function mapRowToEntity($row) {
-		return call_user_func($this->entityClass .'::fromRow', $row);
+		return call_user_func($this->entityClass.'::fromRow', $row);
 	}
 
 
@@ -328,12 +328,12 @@ 
 	 * @return array all fetched entities
 	 * @since 7.0.0
 	 */
-	protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
+	protected function findEntities($sql, array $params = [], $limit = null, $offset = null) {
 		$stmt = $this->execute($sql, $params, $limit, $offset);
 
 		$entities = [];
 
-		while($row = $stmt->fetch()){
+		while ($row = $stmt->fetch()) {
 			$entities[] = $this->mapRowToEntity($row);
 		}
 
@@ -355,7 +355,7 @@ 
 	 * @return Entity the entity
 	 * @since 7.0.0
 	 */
-	protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
+	protected function findEntity($sql, array $params = [], $limit = null, $offset = null) {
 		return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
 	}
 

lib/public/Migration/IOutput.php

Doc Comments +5 added lines, -1 removed lines

@@ -32,18 +32,21 @@ 
 	/**
 	 * @param string $message
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function info($message);
 
 	/**
 	 * @param string $message
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function warning($message);
 
 	/**
 	 * @param int $max
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function startProgress($max = 0);
 
@@ -51,12 +54,13 @@ 
 	 * @param int $step
 	 * @param string $description
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function advance($step = 1, $description = '');
 
 	/**
-	 * @param int $max
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function finishProgress();
 

Indentation +26 added lines, -26 removed lines

@@ -30,35 +30,35 @@
  */
 interface IOutput {
 
-	/**
-	 * @param string $message
-	 * @since 9.1.0
-	 */
-	public function info($message);
+    /**
+     * @param string $message
+     * @since 9.1.0
+     */
+    public function info($message);
 
-	/**
-	 * @param string $message
-	 * @since 9.1.0
-	 */
-	public function warning($message);
+    /**
+     * @param string $message
+     * @since 9.1.0
+     */
+    public function warning($message);
 
-	/**
-	 * @param int $max
-	 * @since 9.1.0
-	 */
-	public function startProgress($max = 0);
+    /**
+     * @param int $max
+     * @since 9.1.0
+     */
+    public function startProgress($max = 0);
 
-	/**
-	 * @param int $step
-	 * @param string $description
-	 * @since 9.1.0
-	 */
-	public function advance($step = 1, $description = '');
+    /**
+     * @param int $step
+     * @param string $description
+     * @since 9.1.0
+     */
+    public function advance($step = 1, $description = '');
 
-	/**
-	 * @param int $max
-	 * @since 9.1.0
-	 */
-	public function finishProgress();
+    /**
+     * @param int $max
+     * @since 9.1.0
+     */
+    public function finishProgress();
 
 }

lib/public/SystemTag/ISystemTagManager.php

Doc Comments +7 added lines, -4 removed lines

@@ -102,17 +102,19 @@ 
 	 * with the same attributes
 	 *
 	 * @since 9.0.0
+	 * @return void
 	 */
 	public function updateTag($tagId, $newName, $userVisible, $userAssignable);
 
 	/**
 	 * Delete the given tags from the database and all their relationships.
 	 *
-	 * @param string|array $tagIds array of tag ids
+	 * @param string $tagIds array of tag ids
 	 *
 	 * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
 	 *
 	 * @since 9.0.0
+	 * @return void
 	 */
 	public function deleteTags($tagIds);
 
@@ -123,7 +125,7 @@ 
 	 * @param ISystemTag $tag tag to check permission for
 	 * @param IUser $user user to check permission for
 	 *
-	 * @return true if the user is allowed to assign/unassign the tag, false otherwise
+	 * @return boolean if the user is allowed to assign/unassign the tag, false otherwise
 	 *
 	 * @since 9.1.0
 	 */
@@ -133,9 +135,9 @@ 
 	 * Checks whether the given user is allowed to see the tag with the given id.
 	 *
 	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
+	 * @param IUser $userId user to check permission for
 	 *
-	 * @return true if the user can see the tag, false otherwise
+	 * @return boolean if the user can see the tag, false otherwise
 	 *
 	 * @since 9.1.0
 	 */
@@ -148,6 +150,7 @@ 
 	 * @param string[] $groupIds group ids of groups that can assign/unassign the tag
 	 *
 	 * @since 9.1.0
+	 * @return void
 	 */
 	public function setTagGroups(ISystemTag $tag, $groupIds);
 

Indentation +120 added lines, -120 removed lines

@@ -33,133 +33,133 @@
  */
 interface ISystemTagManager {
 
-	/**
-	 * Returns the tag objects matching the given tag ids.
-	 *
-	 * @param array|string $tagIds id or array of unique ids of the tag to retrieve
-	 *
-	 * @return \OCP\SystemTag\ISystemTag[] array of system tags with tag id as key
-	 *
-	 * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.)
-	 * @throws \OCP\SystemTag\TagNotFoundException if at least one given tag ids did no exist
-	 * 			The message contains a json_encoded array of the ids that could not be found
-	 *
-	 * @since 9.0.0
-	 */
-	public function getTagsByIds($tagIds);
+    /**
+     * Returns the tag objects matching the given tag ids.
+     *
+     * @param array|string $tagIds id or array of unique ids of the tag to retrieve
+     *
+     * @return \OCP\SystemTag\ISystemTag[] array of system tags with tag id as key
+     *
+     * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.)
+     * @throws \OCP\SystemTag\TagNotFoundException if at least one given tag ids did no exist
+     * 			The message contains a json_encoded array of the ids that could not be found
+     *
+     * @since 9.0.0
+     */
+    public function getTagsByIds($tagIds);
 
-	/**
-	 * Returns the tag object matching the given attributes.
-	 *
-	 * @param string $tagName tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @return \OCP\SystemTag\ISystemTag system tag
-	 *
-	 * @throws \OCP\SystemTag\TagNotFoundException if tag does not exist
-	 *
-	 * @since 9.0.0
-	 */
-	public function getTag($tagName, $userVisible, $userAssignable);
+    /**
+     * Returns the tag object matching the given attributes.
+     *
+     * @param string $tagName tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @return \OCP\SystemTag\ISystemTag system tag
+     *
+     * @throws \OCP\SystemTag\TagNotFoundException if tag does not exist
+     *
+     * @since 9.0.0
+     */
+    public function getTag($tagName, $userVisible, $userAssignable);
 
-	/**
-	 * Creates the tag object using the given attributes.
-	 *
-	 * @param string $tagName tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @return \OCP\SystemTag\ISystemTag system tag
-	 *
-	 * @throws \OCP\SystemTag\TagAlreadyExistsException if tag already exists
-	 *
-	 * @since 9.0.0
-	 */
-	public function createTag($tagName, $userVisible, $userAssignable);
+    /**
+     * Creates the tag object using the given attributes.
+     *
+     * @param string $tagName tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @return \OCP\SystemTag\ISystemTag system tag
+     *
+     * @throws \OCP\SystemTag\TagAlreadyExistsException if tag already exists
+     *
+     * @since 9.0.0
+     */
+    public function createTag($tagName, $userVisible, $userAssignable);
 
-	/**
-	 * Returns all known tags, optionally filtered by visibility.
-	 *
-	 * @param bool|null $visibilityFilter filter by visibility if non-null
-	 * @param string $nameSearchPattern optional search pattern for the tag name
-	 *
-	 * @return \OCP\SystemTag\ISystemTag[] array of system tags or empty array if none found
-	 *
-	 * @since 9.0.0
-	 */
-	public function getAllTags($visibilityFilter = null, $nameSearchPattern = null);
+    /**
+     * Returns all known tags, optionally filtered by visibility.
+     *
+     * @param bool|null $visibilityFilter filter by visibility if non-null
+     * @param string $nameSearchPattern optional search pattern for the tag name
+     *
+     * @return \OCP\SystemTag\ISystemTag[] array of system tags or empty array if none found
+     *
+     * @since 9.0.0
+     */
+    public function getAllTags($visibilityFilter = null, $nameSearchPattern = null);
 
-	/**
-	 * Updates the given tag
-	 *
-	 * @param string $tagId tag id
-	 * @param string $newName the new tag name
-	 * @param bool $userVisible whether the tag is visible by users
-	 * @param bool $userAssignable whether the tag is assignable by users
-	 *
-	 * @throws \OCP\SystemTag\TagNotFoundException if tag with the given id does not exist
-	 * @throws \OCP\SystemTag\TagAlreadyExistsException if there is already another tag
-	 * with the same attributes
-	 *
-	 * @since 9.0.0
-	 */
-	public function updateTag($tagId, $newName, $userVisible, $userAssignable);
+    /**
+     * Updates the given tag
+     *
+     * @param string $tagId tag id
+     * @param string $newName the new tag name
+     * @param bool $userVisible whether the tag is visible by users
+     * @param bool $userAssignable whether the tag is assignable by users
+     *
+     * @throws \OCP\SystemTag\TagNotFoundException if tag with the given id does not exist
+     * @throws \OCP\SystemTag\TagAlreadyExistsException if there is already another tag
+     * with the same attributes
+     *
+     * @since 9.0.0
+     */
+    public function updateTag($tagId, $newName, $userVisible, $userAssignable);
 
-	/**
-	 * Delete the given tags from the database and all their relationships.
-	 *
-	 * @param string|array $tagIds array of tag ids
-	 *
-	 * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
-	 *
-	 * @since 9.0.0
-	 */
-	public function deleteTags($tagIds);
+    /**
+     * Delete the given tags from the database and all their relationships.
+     *
+     * @param string|array $tagIds array of tag ids
+     *
+     * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist
+     *
+     * @since 9.0.0
+     */
+    public function deleteTags($tagIds);
 
-	/**
-	 * Checks whether the given user is allowed to assign/unassign the tag with the
-	 * given id.
-	 *
-	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
-	 *
-	 * @return true if the user is allowed to assign/unassign the tag, false otherwise
-	 *
-	 * @since 9.1.0
-	 */
-	public function canUserAssignTag(ISystemTag $tag, IUser $user);
+    /**
+     * Checks whether the given user is allowed to assign/unassign the tag with the
+     * given id.
+     *
+     * @param ISystemTag $tag tag to check permission for
+     * @param IUser $user user to check permission for
+     *
+     * @return true if the user is allowed to assign/unassign the tag, false otherwise
+     *
+     * @since 9.1.0
+     */
+    public function canUserAssignTag(ISystemTag $tag, IUser $user);
 
-	/**
-	 * Checks whether the given user is allowed to see the tag with the given id.
-	 *
-	 * @param ISystemTag $tag tag to check permission for
-	 * @param IUser $user user to check permission for
-	 *
-	 * @return true if the user can see the tag, false otherwise
-	 *
-	 * @since 9.1.0
-	 */
-	public function canUserSeeTag(ISystemTag $tag, IUser $userId);
+    /**
+     * Checks whether the given user is allowed to see the tag with the given id.
+     *
+     * @param ISystemTag $tag tag to check permission for
+     * @param IUser $user user to check permission for
+     *
+     * @return true if the user can see the tag, false otherwise
+     *
+     * @since 9.1.0
+     */
+    public function canUserSeeTag(ISystemTag $tag, IUser $userId);
 
-	/**
-	 * Set groups that can assign a given tag.
-	 *
-	 * @param ISystemTag $tag tag for group assignment
-	 * @param string[] $groupIds group ids of groups that can assign/unassign the tag
-	 *
-	 * @since 9.1.0
-	 */
-	public function setTagGroups(ISystemTag $tag, $groupIds);
+    /**
+     * Set groups that can assign a given tag.
+     *
+     * @param ISystemTag $tag tag for group assignment
+     * @param string[] $groupIds group ids of groups that can assign/unassign the tag
+     *
+     * @since 9.1.0
+     */
+    public function setTagGroups(ISystemTag $tag, $groupIds);
 
-	/**
-	 * Get groups that can assign a given tag.
-	 *
-	 * @param ISystemTag $tag tag for group assignment
-	 *
-	 * @return string[] group ids of groups that can assign/unassign the tag
-	 *
-	 * @since 9.1.0
-	 */
-	public function getTagGroups(ISystemTag $tag);
+    /**
+     * Get groups that can assign a given tag.
+     *
+     * @param ISystemTag $tag tag for group assignment
+     *
+     * @return string[] group ids of groups that can assign/unassign the tag
+     *
+     * @since 9.1.0
+     */
+    public function getTagGroups(ISystemTag $tag);
 }

lib/public/Util.php

Doc Comments +1 added lines, -1 removed lines

@@ -544,7 +544,7 @@
 	 * @param array $input The array to work on
 	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
 	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
+	 * @return string
 	 * @since 4.5.0
 	 */
 	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {

Indentation +651 added lines, -651 removed lines

@@ -57,657 +57,657 @@
  * @since 4.0.0
  */
 class Util {
-	// consts for Logging
-	const DEBUG=0;
-	const INFO=1;
-	const WARN=2;
-	const ERROR=3;
-	const FATAL=4;
-
-	/** \OCP\Share\IManager */
-	private static $shareManager;
-
-	/**
-	 * get the current installed version of ownCloud
-	 * @return array
-	 * @since 4.0.0
-	 */
-	public static function getVersion() {
-		return \OC_Util::getVersion();
-	}
+    // consts for Logging
+    const DEBUG=0;
+    const INFO=1;
+    const WARN=2;
+    const ERROR=3;
+    const FATAL=4;
+
+    /** \OCP\Share\IManager */
+    private static $shareManager;
+
+    /**
+     * get the current installed version of ownCloud
+     * @return array
+     * @since 4.0.0
+     */
+    public static function getVersion() {
+        return \OC_Util::getVersion();
+    }
 	
-	/**
-	 * Set current update channel
-	 * @param string $channel
-	 * @since 8.1.0
-	 */
-	public static function setChannel($channel) {
-		\OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
-	}
+    /**
+     * Set current update channel
+     * @param string $channel
+     * @since 8.1.0
+     */
+    public static function setChannel($channel) {
+        \OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
+    }
 	
-	/**
-	 * Get current update channel
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public static function getChannel() {
-		return \OC_Util::getChannel();
-	}
-
-	/**
-	 * send an email
-	 * @param string $toaddress
-	 * @param string $toname
-	 * @param string $subject
-	 * @param string $mailtext
-	 * @param string $fromaddress
-	 * @param string $fromname
-	 * @param int $html
-	 * @param string $altbody
-	 * @param string $ccaddress
-	 * @param string $ccname
-	 * @param string $bcc
-	 * @deprecated 8.1.0 Use \OCP\Mail\IMailer instead
-	 * @since 4.0.0
-	 */
-	public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
-		$html = 0, $altbody = '', $ccaddress = '', $ccname = '', $bcc = '') {
-		$mailer = \OC::$server->getMailer();
-		$message = $mailer->createMessage();
-		$message->setTo([$toaddress => $toname]);
-		$message->setSubject($subject);
-		$message->setPlainBody($mailtext);
-		$message->setFrom([$fromaddress => $fromname]);
-		if($html === 1) {
-			$message->setHtmlBody($altbody);
-		}
-
-		if($altbody === '') {
-			$message->setHtmlBody($mailtext);
-			$message->setPlainBody('');
-		} else {
-			$message->setHtmlBody($mailtext);
-			$message->setPlainBody($altbody);
-		}
-
-		if(!empty($ccaddress)) {
-			if(!empty($ccname)) {
-				$message->setCc([$ccaddress => $ccname]);
-			} else {
-				$message->setCc([$ccaddress]);
-			}
-		}
-		if(!empty($bcc)) {
-			$message->setBcc([$bcc]);
-		}
-
-		$mailer->send($message);
-	}
-
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 * @since 4.0.0
-	 * @deprecated 13.0.0 use log of \OCP\ILogger
-	 */
-	public static function writeLog( $app, $message, $level ) {
-		$context = ['app' => $app];
-		\OC::$server->getLogger()->log($level, $message, $context);
-	}
-
-	/**
-	 * write exception into the log
-	 * @param string $app app name
-	 * @param \Exception $ex exception to log
-	 * @param int $level log level, defaults to \OCP\Util::FATAL
-	 * @since ....0.0 - parameter $level was added in 7.0.0
-	 * @deprecated 8.2.0 use logException of \OCP\ILogger
-	 */
-	public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
-		\OC::$server->getLogger()->logException($ex, ['app' => $app]);
-	}
-
-	/**
-	 * check if sharing is disabled for the current user
-	 *
-	 * @return boolean
-	 * @since 7.0.0
-	 * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
-	 */
-	public static function isSharingDisabledForUser() {
-		if (self::$shareManager === null) {
-			self::$shareManager = \OC::$server->getShareManager();
-		}
-
-		$user = \OC::$server->getUserSession()->getUser();
-		if ($user !== null) {
-			$user = $user->getUID();
-		}
-
-		return self::$shareManager->sharingDisabledForUser($user);
-	}
-
-	/**
-	 * get l10n object
-	 * @param string $application
-	 * @param string|null $language
-	 * @return \OCP\IL10N
-	 * @since 6.0.0 - parameter $language was added in 8.0.0
-	 */
-	public static function getL10N($application, $language = null) {
-		return \OC::$server->getL10N($application, $language);
-	}
-
-	/**
-	 * add a css file
-	 * @param string $application
-	 * @param string $file
-	 * @since 4.0.0
-	 */
-	public static function addStyle( $application, $file = null ) {
-		\OC_Util::addStyle( $application, $file );
-	}
-
-	/**
-	 * add a javascript file
-	 * @param string $application
-	 * @param string $file
-	 * @since 4.0.0
-	 */
-	public static function addScript( $application, $file = null ) {
-		\OC_Util::addScript( $application, $file );
-	}
-
-	/**
-	 * Add a translation JS file
-	 * @param string $application application id
-	 * @param string $languageCode language code, defaults to the current locale
-	 * @since 8.0.0
-	 */
-	public static function addTranslations($application, $languageCode = null) {
-		\OC_Util::addTranslations($application, $languageCode);
-	}
-
-	/**
-	 * Add a custom element to the header
-	 * If $text is null then the element will be written as empty element.
-	 * So use "" to get a closing tag.
-	 * @param string $tag tag name of the element
-	 * @param array $attributes array of attributes for the element
-	 * @param string $text the text content for the element
-	 * @since 4.0.0
-	 */
-	public static function addHeader($tag, $attributes, $text=null) {
-		\OC_Util::addHeader($tag, $attributes, $text);
-	}
-
-	/**
-	 * formats a timestamp in the "right" way
-	 * @param int $timestamp $timestamp
-	 * @param bool $dateOnly option to omit time from the result
-	 * @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
-	 * @return string timestamp
-	 *
-	 * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
-	 * @since 4.0.0
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
-		return \OC_Util::formatDate($timestamp, $dateOnly, $timeZone);
-	}
-
-	/**
-	 * check if some encrypted files are stored
-	 * @return bool
-	 *
-	 * @deprecated 8.1.0 No longer required
-	 * @since 6.0.0
-	 */
-	public static function encryptedFiles() {
-		return false;
-	}
-
-	/**
-	 * Creates an absolute url to the given app and file.
-	 * @param string $app app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 * 	The value of $args will be urlencoded
-	 * @return string the url
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
-	 */
-	public static function linkToAbsolute( $app, $file, $args = array() ) {
-		$urlGenerator = \OC::$server->getURLGenerator();
-		return $urlGenerator->getAbsoluteURL(
-			$urlGenerator->linkTo($app, $file, $args)
-		);
-	}
-
-	/**
-	 * Creates an absolute url for remote use.
-	 * @param string $service id
-	 * @return string the url
-	 * @since 4.0.0
-	 */
-	public static function linkToRemote( $service ) {
-		$urlGenerator = \OC::$server->getURLGenerator();
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
-		return $urlGenerator->getAbsoluteURL(
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
-		);
-	}
-
-	/**
-	 * Creates an absolute url for public use
-	 * @param string $service id
-	 * @return string the url
-	 * @since 4.5.0
-	 */
-	public static function linkToPublic($service) {
-		return \OC_Helper::linkToPublic($service);
-	}
-
-	/**
-	 * Creates an url using a defined route
-	 * @param string $route
-	 * @param array $parameters
-	 * @internal param array $args with param=>value, will be appended to the returned url
-	 * @return string the url
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
-	 * @since 5.0.0
-	 */
-	public static function linkToRoute( $route, $parameters = array() ) {
-		return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
-	}
-
-	/**
-	 * Creates an url to the given app and file
-	 * @param string $app app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 * 	The value of $args will be urlencoded
-	 * @return string the url
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
-	 */
-	public static function linkTo( $app, $file, $args = array() ) {
-		return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
-	}
-
-	/**
-	 * Returns the server host, even if the website uses one or more reverse proxy
-	 * @return string the server host
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getServerHost
-	 * @since 4.0.0
-	 */
-	public static function getServerHost() {
-		return \OC::$server->getRequest()->getServerHost();
-	}
-
-	/**
-	 * Returns the server host name without an eventual port number
-	 * @return string the server hostname
-	 * @since 5.0.0
-	 */
-	public static function getServerHostName() {
-		$host_name = \OC::$server->getRequest()->getServerHost();
-		// strip away port number (if existing)
-		$colon_pos = strpos($host_name, ':');
-		if ($colon_pos != FALSE) {
-			$host_name = substr($host_name, 0, $colon_pos);
-		}
-		return $host_name;
-	}
-
-	/**
-	 * Returns the default email address
-	 * @param string $user_part the user part of the address
-	 * @return string the default email address
-	 *
-	 * Assembles a default email address (using the server hostname
-	 * and the given user part, and returns it
-	 * Example: when given lostpassword-noreply as $user_part param,
-	 *     and is currently accessed via http(s)://example.com/,
-	 *     it would return 'lostpassword-noreply@example.com'
-	 *
-	 * If the configuration value 'mail_from_address' is set in
-	 * config.php, this value will override the $user_part that
-	 * is passed to this function
-	 * @since 5.0.0
-	 */
-	public static function getDefaultEmailAddress($user_part) {
-		$config = \OC::$server->getConfig();
-		$user_part = $config->getSystemValue('mail_from_address', $user_part);
-		$host_name = self::getServerHostName();
-		$host_name = $config->getSystemValue('mail_domain', $host_name);
-		$defaultEmailAddress = $user_part.'@'.$host_name;
-
-		$mailer = \OC::$server->getMailer();
-		if ($mailer->validateMailAddress($defaultEmailAddress)) {
-			return $defaultEmailAddress;
-		}
-
-		// in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
-		return $user_part.'@localhost.localdomain';
-	}
-
-	/**
-	 * Returns the server protocol. It respects reverse proxy servers and load balancers
-	 * @return string the server protocol
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getServerProtocol
-	 * @since 4.5.0
-	 */
-	public static function getServerProtocol() {
-		return \OC::$server->getRequest()->getServerProtocol();
-	}
-
-	/**
-	 * Returns the request uri, even if the website uses one or more reverse proxies
-	 * @return string the request uri
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getRequestUri
-	 * @since 5.0.0
-	 */
-	public static function getRequestUri() {
-		return \OC::$server->getRequest()->getRequestUri();
-	}
-
-	/**
-	 * Returns the script name, even if the website uses one or more reverse proxies
-	 * @return string the script name
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getScriptName
-	 * @since 5.0.0
-	 */
-	public static function getScriptName() {
-		return \OC::$server->getRequest()->getScriptName();
-	}
-
-	/**
-	 * Creates path to an image
-	 * @param string $app app
-	 * @param string $image image name
-	 * @return string the url
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
-	 * @since 4.0.0
-	 */
-	public static function imagePath( $app, $image ) {
-		return \OC::$server->getURLGenerator()->imagePath($app, $image);
-	}
-
-	/**
-	 * Make a human file size (2048 to 2 kB)
-	 * @param int $bytes file size in bytes
-	 * @return string a human readable file size
-	 * @since 4.0.0
-	 */
-	public static function humanFileSize($bytes) {
-		return \OC_Helper::humanFileSize($bytes);
-	}
-
-	/**
-	 * Make a computer file size (2 kB to 2048)
-	 * @param string $str file size in a fancy format
-	 * @return float a file size in bytes
-	 *
-	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
-	 * @since 4.0.0
-	 */
-	public static function computerFileSize($str) {
-		return \OC_Helper::computerFileSize($str);
-	}
-
-	/**
-	 * connects a function to a hook
-	 *
-	 * @param string $signalClass class name of emitter
-	 * @param string $signalName name of signal
-	 * @param string|object $slotClass class name of slot
-	 * @param string $slotName name of slot
-	 * @return bool
-	 *
-	 * This function makes it very easy to connect to use hooks.
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 */
-	static public function connectHook($signalClass, $signalName, $slotClass, $slotName) {
-		return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
-	}
-
-	/**
-	 * Emits a signal. To get data from the slot use references!
-	 * @param string $signalclass class name of emitter
-	 * @param string $signalname name of signal
-	 * @param array $params default: array() array with additional data
-	 * @return bool true if slots exists or false if not
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 */
-	static public function emitHook($signalclass, $signalname, $params = array()) {
-		return \OC_Hook::emit($signalclass, $signalname, $params);
-	}
-
-	/**
-	 * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
-	 * multiple OC_Template elements which invoke `callRegister`. If the value
-	 * would not be cached these unit-tests would fail.
-	 * @var string
-	 */
-	private static $token = '';
-
-	/**
-	 * Register an get/post call. This is important to prevent CSRF attacks
-	 * @since 4.5.0
-	 */
-	public static function callRegister() {
-		if(self::$token === '') {
-			self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
-		}
-		return self::$token;
-	}
-
-	/**
-	 * Check an ajax get/post call if the request token is valid. exit if not.
-	 * @since 4.5.0
-	 * @deprecated 9.0.0 Use annotations based on the app framework.
-	 */
-	public static function callCheck() {
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
-			header('Location: '.\OC::$WEBROOT);
-			exit();
-		}
-
-		if (!\OC::$server->getRequest()->passesCSRFCheck()) {
-			exit();
-		}
-	}
-
-	/**
-	 * Used to sanitize HTML
-	 *
-	 * This function is used to sanitize HTML and should be applied on any
-	 * string or array of strings before displaying it on a web page.
-	 *
-	 * @param string|array $value
-	 * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
-	 * @since 4.5.0
-	 */
-	public static function sanitizeHTML($value) {
-		return \OC_Util::sanitizeHTML($value);
-	}
-
-	/**
-	 * Public function to encode url parameters
-	 *
-	 * This function is used to encode path to file before output.
-	 * Encoding is done according to RFC 3986 with one exception:
-	 * Character '/' is preserved as is.
-	 *
-	 * @param string $component part of URI to encode
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public static function encodePath($component) {
-		return \OC_Util::encodePath($component);
-	}
-
-	/**
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 *
-	 * @param array $input The array to work on
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
-	 * @since 4.5.0
-	 */
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
-		return \OC_Helper::mb_array_change_key_case($input, $case, $encoding);
-	}
-
-	/**
-	 * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
-	 *
-	 * @param string $string The input string. Opposite to the PHP build-in function does not accept an array.
-	 * @param string $replacement The replacement string.
-	 * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
-	 * @param int $length Length of the part to be replaced
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return string
-	 * @since 4.5.0
-	 * @deprecated 8.2.0 Use substr_replace() instead.
-	 */
-	public static function mb_substr_replace($string, $replacement, $start, $length = null, $encoding = 'UTF-8') {
-		return substr_replace($string, $replacement, $start, $length);
-	}
-
-	/**
-	 * Replace all occurrences of the search string with the replacement string
-	 *
-	 * @param string $search The value being searched for, otherwise known as the needle. String.
-	 * @param string $replace The replacement string.
-	 * @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @param int $count If passed, this will be set to the number of replacements performed.
-	 * @return string
-	 * @since 4.5.0
-	 * @deprecated 8.2.0 Use str_replace() instead.
-	 */
-	public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
-		return str_replace($search, $replace, $subject, $count);
-	}
-
-	/**
-	 * performs a search in a nested array
-	 *
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param mixed $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 * @since 4.5.0
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int number of bytes representing
-	 * @since 5.0.0
-	 */
-	public static function maxUploadFilesize($dir, $free = null) {
-		return \OC_Helper::maxUploadFilesize($dir, $free);
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function freeSpace($dir) {
-		return \OC_Helper::freeSpace($dir);
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function uploadLimit() {
-		return \OC_Helper::uploadLimit();
-	}
-
-	/**
-	 * Returns whether the given file name is valid
-	 * @param string $file file name to check
-	 * @return bool true if the file name is valid, false otherwise
-	 * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
-	 * @since 7.0.0
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function isValidFileName($file) {
-		return \OC_Util::isValidFileName($file);
-	}
-
-	/**
-	 * Generates a cryptographic secure pseudo-random string
-	 * @param int $length of the random string
-	 * @return string
-	 * @deprecated 8.0.0 Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
-	 * @since 7.0.0
-	 */
-	public static function generateRandomBytes($length = 30) {
-		return \OC::$server->getSecureRandom()->generate($length, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
-	}
-
-	/**
-	 * Compare two strings to provide a natural sort
-	 * @param string $a first string to compare
-	 * @param string $b second string to compare
-	 * @return -1 if $b comes before $a, 1 if $a comes before $b
-	 * or 0 if the strings are identical
-	 * @since 7.0.0
-	 */
-	public static function naturalSortCompare($a, $b) {
-		return \OC\NaturalSort::getInstance()->compare($a, $b);
-	}
-
-	/**
-	 * check if a password is required for each public link
-	 * @return boolean
-	 * @since 7.0.0
-	 */
-	public static function isPublicLinkPasswordRequired() {
-		return \OC_Util::isPublicLinkPasswordRequired();
-	}
-
-	/**
-	 * check if share API enforces a default expire date
-	 * @return boolean
-	 * @since 8.0.0
-	 */
-	public static function isDefaultExpireDateEnforced() {
-		return \OC_Util::isDefaultExpireDateEnforced();
-	}
-
-	protected static $needUpgradeCache = null;
-
-	/**
-	 * Checks whether the current version needs upgrade.
-	 *
-	 * @return bool true if upgrade is needed, false otherwise
-	 * @since 7.0.0
-	 */
-	public static function needUpgrade() {
-		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getSystemConfig());
-		}		
-		return self::$needUpgradeCache;
-	}
+    /**
+     * Get current update channel
+     * @return string
+     * @since 8.1.0
+     */
+    public static function getChannel() {
+        return \OC_Util::getChannel();
+    }
+
+    /**
+     * send an email
+     * @param string $toaddress
+     * @param string $toname
+     * @param string $subject
+     * @param string $mailtext
+     * @param string $fromaddress
+     * @param string $fromname
+     * @param int $html
+     * @param string $altbody
+     * @param string $ccaddress
+     * @param string $ccname
+     * @param string $bcc
+     * @deprecated 8.1.0 Use \OCP\Mail\IMailer instead
+     * @since 4.0.0
+     */
+    public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
+        $html = 0, $altbody = '', $ccaddress = '', $ccname = '', $bcc = '') {
+        $mailer = \OC::$server->getMailer();
+        $message = $mailer->createMessage();
+        $message->setTo([$toaddress => $toname]);
+        $message->setSubject($subject);
+        $message->setPlainBody($mailtext);
+        $message->setFrom([$fromaddress => $fromname]);
+        if($html === 1) {
+            $message->setHtmlBody($altbody);
+        }
+
+        if($altbody === '') {
+            $message->setHtmlBody($mailtext);
+            $message->setPlainBody('');
+        } else {
+            $message->setHtmlBody($mailtext);
+            $message->setPlainBody($altbody);
+        }
+
+        if(!empty($ccaddress)) {
+            if(!empty($ccname)) {
+                $message->setCc([$ccaddress => $ccname]);
+            } else {
+                $message->setCc([$ccaddress]);
+            }
+        }
+        if(!empty($bcc)) {
+            $message->setBcc([$bcc]);
+        }
+
+        $mailer->send($message);
+    }
+
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     * @since 4.0.0
+     * @deprecated 13.0.0 use log of \OCP\ILogger
+     */
+    public static function writeLog( $app, $message, $level ) {
+        $context = ['app' => $app];
+        \OC::$server->getLogger()->log($level, $message, $context);
+    }
+
+    /**
+     * write exception into the log
+     * @param string $app app name
+     * @param \Exception $ex exception to log
+     * @param int $level log level, defaults to \OCP\Util::FATAL
+     * @since ....0.0 - parameter $level was added in 7.0.0
+     * @deprecated 8.2.0 use logException of \OCP\ILogger
+     */
+    public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
+        \OC::$server->getLogger()->logException($ex, ['app' => $app]);
+    }
+
+    /**
+     * check if sharing is disabled for the current user
+     *
+     * @return boolean
+     * @since 7.0.0
+     * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
+     */
+    public static function isSharingDisabledForUser() {
+        if (self::$shareManager === null) {
+            self::$shareManager = \OC::$server->getShareManager();
+        }
+
+        $user = \OC::$server->getUserSession()->getUser();
+        if ($user !== null) {
+            $user = $user->getUID();
+        }
+
+        return self::$shareManager->sharingDisabledForUser($user);
+    }
+
+    /**
+     * get l10n object
+     * @param string $application
+     * @param string|null $language
+     * @return \OCP\IL10N
+     * @since 6.0.0 - parameter $language was added in 8.0.0
+     */
+    public static function getL10N($application, $language = null) {
+        return \OC::$server->getL10N($application, $language);
+    }
+
+    /**
+     * add a css file
+     * @param string $application
+     * @param string $file
+     * @since 4.0.0
+     */
+    public static function addStyle( $application, $file = null ) {
+        \OC_Util::addStyle( $application, $file );
+    }
+
+    /**
+     * add a javascript file
+     * @param string $application
+     * @param string $file
+     * @since 4.0.0
+     */
+    public static function addScript( $application, $file = null ) {
+        \OC_Util::addScript( $application, $file );
+    }
+
+    /**
+     * Add a translation JS file
+     * @param string $application application id
+     * @param string $languageCode language code, defaults to the current locale
+     * @since 8.0.0
+     */
+    public static function addTranslations($application, $languageCode = null) {
+        \OC_Util::addTranslations($application, $languageCode);
+    }
+
+    /**
+     * Add a custom element to the header
+     * If $text is null then the element will be written as empty element.
+     * So use "" to get a closing tag.
+     * @param string $tag tag name of the element
+     * @param array $attributes array of attributes for the element
+     * @param string $text the text content for the element
+     * @since 4.0.0
+     */
+    public static function addHeader($tag, $attributes, $text=null) {
+        \OC_Util::addHeader($tag, $attributes, $text);
+    }
+
+    /**
+     * formats a timestamp in the "right" way
+     * @param int $timestamp $timestamp
+     * @param bool $dateOnly option to omit time from the result
+     * @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
+     * @return string timestamp
+     *
+     * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
+     * @since 4.0.0
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
+        return \OC_Util::formatDate($timestamp, $dateOnly, $timeZone);
+    }
+
+    /**
+     * check if some encrypted files are stored
+     * @return bool
+     *
+     * @deprecated 8.1.0 No longer required
+     * @since 6.0.0
+     */
+    public static function encryptedFiles() {
+        return false;
+    }
+
+    /**
+     * Creates an absolute url to the given app and file.
+     * @param string $app app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     * 	The value of $args will be urlencoded
+     * @return string the url
+     * @since 4.0.0 - parameter $args was added in 4.5.0
+     */
+    public static function linkToAbsolute( $app, $file, $args = array() ) {
+        $urlGenerator = \OC::$server->getURLGenerator();
+        return $urlGenerator->getAbsoluteURL(
+            $urlGenerator->linkTo($app, $file, $args)
+        );
+    }
+
+    /**
+     * Creates an absolute url for remote use.
+     * @param string $service id
+     * @return string the url
+     * @since 4.0.0
+     */
+    public static function linkToRemote( $service ) {
+        $urlGenerator = \OC::$server->getURLGenerator();
+        $remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
+        return $urlGenerator->getAbsoluteURL(
+            $remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
+        );
+    }
+
+    /**
+     * Creates an absolute url for public use
+     * @param string $service id
+     * @return string the url
+     * @since 4.5.0
+     */
+    public static function linkToPublic($service) {
+        return \OC_Helper::linkToPublic($service);
+    }
+
+    /**
+     * Creates an url using a defined route
+     * @param string $route
+     * @param array $parameters
+     * @internal param array $args with param=>value, will be appended to the returned url
+     * @return string the url
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
+     * @since 5.0.0
+     */
+    public static function linkToRoute( $route, $parameters = array() ) {
+        return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
+    }
+
+    /**
+     * Creates an url to the given app and file
+     * @param string $app app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     * 	The value of $args will be urlencoded
+     * @return string the url
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
+     * @since 4.0.0 - parameter $args was added in 4.5.0
+     */
+    public static function linkTo( $app, $file, $args = array() ) {
+        return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
+    }
+
+    /**
+     * Returns the server host, even if the website uses one or more reverse proxy
+     * @return string the server host
+     * @deprecated 8.1.0 Use \OCP\IRequest::getServerHost
+     * @since 4.0.0
+     */
+    public static function getServerHost() {
+        return \OC::$server->getRequest()->getServerHost();
+    }
+
+    /**
+     * Returns the server host name without an eventual port number
+     * @return string the server hostname
+     * @since 5.0.0
+     */
+    public static function getServerHostName() {
+        $host_name = \OC::$server->getRequest()->getServerHost();
+        // strip away port number (if existing)
+        $colon_pos = strpos($host_name, ':');
+        if ($colon_pos != FALSE) {
+            $host_name = substr($host_name, 0, $colon_pos);
+        }
+        return $host_name;
+    }
+
+    /**
+     * Returns the default email address
+     * @param string $user_part the user part of the address
+     * @return string the default email address
+     *
+     * Assembles a default email address (using the server hostname
+     * and the given user part, and returns it
+     * Example: when given lostpassword-noreply as $user_part param,
+     *     and is currently accessed via http(s)://example.com/,
+     *     it would return 'lostpassword-noreply@example.com'
+     *
+     * If the configuration value 'mail_from_address' is set in
+     * config.php, this value will override the $user_part that
+     * is passed to this function
+     * @since 5.0.0
+     */
+    public static function getDefaultEmailAddress($user_part) {
+        $config = \OC::$server->getConfig();
+        $user_part = $config->getSystemValue('mail_from_address', $user_part);
+        $host_name = self::getServerHostName();
+        $host_name = $config->getSystemValue('mail_domain', $host_name);
+        $defaultEmailAddress = $user_part.'@'.$host_name;
+
+        $mailer = \OC::$server->getMailer();
+        if ($mailer->validateMailAddress($defaultEmailAddress)) {
+            return $defaultEmailAddress;
+        }
+
+        // in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
+        return $user_part.'@localhost.localdomain';
+    }
+
+    /**
+     * Returns the server protocol. It respects reverse proxy servers and load balancers
+     * @return string the server protocol
+     * @deprecated 8.1.0 Use \OCP\IRequest::getServerProtocol
+     * @since 4.5.0
+     */
+    public static function getServerProtocol() {
+        return \OC::$server->getRequest()->getServerProtocol();
+    }
+
+    /**
+     * Returns the request uri, even if the website uses one or more reverse proxies
+     * @return string the request uri
+     * @deprecated 8.1.0 Use \OCP\IRequest::getRequestUri
+     * @since 5.0.0
+     */
+    public static function getRequestUri() {
+        return \OC::$server->getRequest()->getRequestUri();
+    }
+
+    /**
+     * Returns the script name, even if the website uses one or more reverse proxies
+     * @return string the script name
+     * @deprecated 8.1.0 Use \OCP\IRequest::getScriptName
+     * @since 5.0.0
+     */
+    public static function getScriptName() {
+        return \OC::$server->getRequest()->getScriptName();
+    }
+
+    /**
+     * Creates path to an image
+     * @param string $app app
+     * @param string $image image name
+     * @return string the url
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
+     * @since 4.0.0
+     */
+    public static function imagePath( $app, $image ) {
+        return \OC::$server->getURLGenerator()->imagePath($app, $image);
+    }
+
+    /**
+     * Make a human file size (2048 to 2 kB)
+     * @param int $bytes file size in bytes
+     * @return string a human readable file size
+     * @since 4.0.0
+     */
+    public static function humanFileSize($bytes) {
+        return \OC_Helper::humanFileSize($bytes);
+    }
+
+    /**
+     * Make a computer file size (2 kB to 2048)
+     * @param string $str file size in a fancy format
+     * @return float a file size in bytes
+     *
+     * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
+     * @since 4.0.0
+     */
+    public static function computerFileSize($str) {
+        return \OC_Helper::computerFileSize($str);
+    }
+
+    /**
+     * connects a function to a hook
+     *
+     * @param string $signalClass class name of emitter
+     * @param string $signalName name of signal
+     * @param string|object $slotClass class name of slot
+     * @param string $slotName name of slot
+     * @return bool
+     *
+     * This function makes it very easy to connect to use hooks.
+     *
+     * TODO: write example
+     * @since 4.0.0
+     */
+    static public function connectHook($signalClass, $signalName, $slotClass, $slotName) {
+        return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
+    }
+
+    /**
+     * Emits a signal. To get data from the slot use references!
+     * @param string $signalclass class name of emitter
+     * @param string $signalname name of signal
+     * @param array $params default: array() array with additional data
+     * @return bool true if slots exists or false if not
+     *
+     * TODO: write example
+     * @since 4.0.0
+     */
+    static public function emitHook($signalclass, $signalname, $params = array()) {
+        return \OC_Hook::emit($signalclass, $signalname, $params);
+    }
+
+    /**
+     * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
+     * multiple OC_Template elements which invoke `callRegister`. If the value
+     * would not be cached these unit-tests would fail.
+     * @var string
+     */
+    private static $token = '';
+
+    /**
+     * Register an get/post call. This is important to prevent CSRF attacks
+     * @since 4.5.0
+     */
+    public static function callRegister() {
+        if(self::$token === '') {
+            self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
+        }
+        return self::$token;
+    }
+
+    /**
+     * Check an ajax get/post call if the request token is valid. exit if not.
+     * @since 4.5.0
+     * @deprecated 9.0.0 Use annotations based on the app framework.
+     */
+    public static function callCheck() {
+        if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+            header('Location: '.\OC::$WEBROOT);
+            exit();
+        }
+
+        if (!\OC::$server->getRequest()->passesCSRFCheck()) {
+            exit();
+        }
+    }
+
+    /**
+     * Used to sanitize HTML
+     *
+     * This function is used to sanitize HTML and should be applied on any
+     * string or array of strings before displaying it on a web page.
+     *
+     * @param string|array $value
+     * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
+     * @since 4.5.0
+     */
+    public static function sanitizeHTML($value) {
+        return \OC_Util::sanitizeHTML($value);
+    }
+
+    /**
+     * Public function to encode url parameters
+     *
+     * This function is used to encode path to file before output.
+     * Encoding is done according to RFC 3986 with one exception:
+     * Character '/' is preserved as is.
+     *
+     * @param string $component part of URI to encode
+     * @return string
+     * @since 6.0.0
+     */
+    public static function encodePath($component) {
+        return \OC_Util::encodePath($component);
+    }
+
+    /**
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     *
+     * @param array $input The array to work on
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return array
+     * @since 4.5.0
+     */
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
+        return \OC_Helper::mb_array_change_key_case($input, $case, $encoding);
+    }
+
+    /**
+     * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
+     *
+     * @param string $string The input string. Opposite to the PHP build-in function does not accept an array.
+     * @param string $replacement The replacement string.
+     * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
+     * @param int $length Length of the part to be replaced
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return string
+     * @since 4.5.0
+     * @deprecated 8.2.0 Use substr_replace() instead.
+     */
+    public static function mb_substr_replace($string, $replacement, $start, $length = null, $encoding = 'UTF-8') {
+        return substr_replace($string, $replacement, $start, $length);
+    }
+
+    /**
+     * Replace all occurrences of the search string with the replacement string
+     *
+     * @param string $search The value being searched for, otherwise known as the needle. String.
+     * @param string $replace The replacement string.
+     * @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @param int $count If passed, this will be set to the number of replacements performed.
+     * @return string
+     * @since 4.5.0
+     * @deprecated 8.2.0 Use str_replace() instead.
+     */
+    public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
+        return str_replace($search, $replace, $subject, $count);
+    }
+
+    /**
+     * performs a search in a nested array
+     *
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param mixed $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     * @since 4.5.0
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int number of bytes representing
+     * @since 5.0.0
+     */
+    public static function maxUploadFilesize($dir, $free = null) {
+        return \OC_Helper::maxUploadFilesize($dir, $free);
+    }
+
+    /**
+     * Calculate free space left within user quota
+     * @param string $dir the current folder where the user currently operates
+     * @return int number of bytes representing
+     * @since 7.0.0
+     */
+    public static function freeSpace($dir) {
+        return \OC_Helper::freeSpace($dir);
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int number of bytes representing
+     * @since 7.0.0
+     */
+    public static function uploadLimit() {
+        return \OC_Helper::uploadLimit();
+    }
+
+    /**
+     * Returns whether the given file name is valid
+     * @param string $file file name to check
+     * @return bool true if the file name is valid, false otherwise
+     * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
+     * @since 7.0.0
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function isValidFileName($file) {
+        return \OC_Util::isValidFileName($file);
+    }
+
+    /**
+     * Generates a cryptographic secure pseudo-random string
+     * @param int $length of the random string
+     * @return string
+     * @deprecated 8.0.0 Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
+     * @since 7.0.0
+     */
+    public static function generateRandomBytes($length = 30) {
+        return \OC::$server->getSecureRandom()->generate($length, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
+    }
+
+    /**
+     * Compare two strings to provide a natural sort
+     * @param string $a first string to compare
+     * @param string $b second string to compare
+     * @return -1 if $b comes before $a, 1 if $a comes before $b
+     * or 0 if the strings are identical
+     * @since 7.0.0
+     */
+    public static function naturalSortCompare($a, $b) {
+        return \OC\NaturalSort::getInstance()->compare($a, $b);
+    }
+
+    /**
+     * check if a password is required for each public link
+     * @return boolean
+     * @since 7.0.0
+     */
+    public static function isPublicLinkPasswordRequired() {
+        return \OC_Util::isPublicLinkPasswordRequired();
+    }
+
+    /**
+     * check if share API enforces a default expire date
+     * @return boolean
+     * @since 8.0.0
+     */
+    public static function isDefaultExpireDateEnforced() {
+        return \OC_Util::isDefaultExpireDateEnforced();
+    }
+
+    protected static $needUpgradeCache = null;
+
+    /**
+     * Checks whether the current version needs upgrade.
+     *
+     * @return bool true if upgrade is needed, false otherwise
+     * @since 7.0.0
+     */
+    public static function needUpgrade() {
+        if (!isset(self::$needUpgradeCache)) {
+            self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getSystemConfig());
+        }		
+        return self::$needUpgradeCache;
+    }
 }

Spacing +28 added lines, -28 removed lines

@@ -58,11 +58,11 @@ 
  */
 class Util {
 	// consts for Logging
-	const DEBUG=0;
-	const INFO=1;
-	const WARN=2;
-	const ERROR=3;
-	const FATAL=4;
+	const DEBUG = 0;
+	const INFO = 1;
+	const WARN = 2;
+	const ERROR = 3;
+	const FATAL = 4;
 
 	/** \OCP\Share\IManager */
 	private static $shareManager;
@@ -118,11 +118,11 @@ 
 		$message->setSubject($subject);
 		$message->setPlainBody($mailtext);
 		$message->setFrom([$fromaddress => $fromname]);
-		if($html === 1) {
+		if ($html === 1) {
 			$message->setHtmlBody($altbody);
 		}
 
-		if($altbody === '') {
+		if ($altbody === '') {
 			$message->setHtmlBody($mailtext);
 			$message->setPlainBody('');
 		} else {
@@ -130,14 +130,14 @@ 
 			$message->setPlainBody($altbody);
 		}
 
-		if(!empty($ccaddress)) {
-			if(!empty($ccname)) {
+		if (!empty($ccaddress)) {
+			if (!empty($ccname)) {
 				$message->setCc([$ccaddress => $ccname]);
 			} else {
 				$message->setCc([$ccaddress]);
 			}
 		}
-		if(!empty($bcc)) {
+		if (!empty($bcc)) {
 			$message->setBcc([$bcc]);
 		}
 
@@ -152,7 +152,7 @@ 
 	 * @since 4.0.0
 	 * @deprecated 13.0.0 use log of \OCP\ILogger
 	 */
-	public static function writeLog( $app, $message, $level ) {
+	public static function writeLog($app, $message, $level) {
 		$context = ['app' => $app];
 		\OC::$server->getLogger()->log($level, $message, $context);
 	}
@@ -165,7 +165,7 @@ 
 	 * @since ....0.0 - parameter $level was added in 7.0.0
 	 * @deprecated 8.2.0 use logException of \OCP\ILogger
 	 */
-	public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
+	public static function logException($app, \Exception $ex, $level = \OCP\Util::FATAL) {
 		\OC::$server->getLogger()->logException($ex, ['app' => $app]);
 	}
 
@@ -206,8 +206,8 @@ 
 	 * @param string $file
 	 * @since 4.0.0
 	 */
-	public static function addStyle( $application, $file = null ) {
-		\OC_Util::addStyle( $application, $file );
+	public static function addStyle($application, $file = null) {
+		\OC_Util::addStyle($application, $file);
 	}
 
 	/**
@@ -216,8 +216,8 @@ 
 	 * @param string $file
 	 * @since 4.0.0
 	 */
-	public static function addScript( $application, $file = null ) {
-		\OC_Util::addScript( $application, $file );
+	public static function addScript($application, $file = null) {
+		\OC_Util::addScript($application, $file);
 	}
 
 	/**
@@ -239,7 +239,7 @@ 
 	 * @param string $text the text content for the element
 	 * @since 4.0.0
 	 */
-	public static function addHeader($tag, $attributes, $text=null) {
+	public static function addHeader($tag, $attributes, $text = null) {
 		\OC_Util::addHeader($tag, $attributes, $text);
 	}
 
@@ -254,7 +254,7 @@ 
 	 * @since 4.0.0
 	 * @suppress PhanDeprecatedFunction
 	 */
-	public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
+	public static function formatDate($timestamp, $dateOnly = false, $timeZone = null) {
 		return \OC_Util::formatDate($timestamp, $dateOnly, $timeZone);
 	}
 
@@ -278,7 +278,7 @@ 
 	 * @return string the url
 	 * @since 4.0.0 - parameter $args was added in 4.5.0
 	 */
-	public static function linkToAbsolute( $app, $file, $args = array() ) {
+	public static function linkToAbsolute($app, $file, $args = array()) {
 		$urlGenerator = \OC::$server->getURLGenerator();
 		return $urlGenerator->getAbsoluteURL(
 			$urlGenerator->linkTo($app, $file, $args)
@@ -291,11 +291,11 @@ 
 	 * @return string the url
 	 * @since 4.0.0
 	 */
-	public static function linkToRemote( $service ) {
+	public static function linkToRemote($service) {
 		$urlGenerator = \OC::$server->getURLGenerator();
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
+		$remoteBase = $urlGenerator->linkTo('', 'remote.php').'/'.$service;
 		return $urlGenerator->getAbsoluteURL(
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
+			$remoteBase.(($service[strlen($service) - 1] != '/') ? '/' : '')
 		);
 	}
 
@@ -318,7 +318,7 @@ 
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
 	 * @since 5.0.0
 	 */
-	public static function linkToRoute( $route, $parameters = array() ) {
+	public static function linkToRoute($route, $parameters = array()) {
 		return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
 	}
 
@@ -332,7 +332,7 @@ 
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
 	 * @since 4.0.0 - parameter $args was added in 4.5.0
 	 */
-	public static function linkTo( $app, $file, $args = array() ) {
+	public static function linkTo($app, $file, $args = array()) {
 		return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
 	}
 
@@ -431,7 +431,7 @@ 
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
 	 * @since 4.0.0
 	 */
-	public static function imagePath( $app, $image ) {
+	public static function imagePath($app, $image) {
 		return \OC::$server->getURLGenerator()->imagePath($app, $image);
 	}
 
@@ -502,7 +502,7 @@ 
 	 * @since 4.5.0
 	 */
 	public static function callRegister() {
-		if(self::$token === '') {
+		if (self::$token === '') {
 			self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
 		}
 		return self::$token;
@@ -514,7 +514,7 @@ 
 	 * @deprecated 9.0.0 Use annotations based on the app framework.
 	 */
 	public static function callCheck() {
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+		if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
 			header('Location: '.\OC::$WEBROOT);
 			exit();
 		}
@@ -706,7 +706,7 @@ 
 	 */
 	public static function needUpgrade() {
 		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getSystemConfig());
+			self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
 		}		
 		return self::$needUpgradeCache;
 	}

lib/private/Files/View.php

Doc Comments +4 added lines, -4 removed lines

@@ -200,7 +200,7 @@ 
 	 * and does not take the chroot into account )
 	 *
 	 * @param string $path
-	 * @return \OCP\Files\Mount\IMountPoint
+	 * @return Mount\MountPoint|null
 	 */
 	public function getMount($path) {
 		return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
@@ -963,7 +963,7 @@ 
 
 	/**
 	 * @param string $path
-	 * @return bool|string
+	 * @return string|false
 	 * @throws \OCP\Files\InvalidPathException
 	 */
 	public function toTmpFile($path) {
@@ -1078,7 +1078,7 @@ 
 	 * @param string $path
 	 * @param array $hooks (optional)
 	 * @param mixed $extraParam (optional)
-	 * @return mixed
+	 * @return string
 	 * @throws \Exception
 	 *
 	 * This method takes requests for basic filesystem functions (e.g. reading & writing
@@ -2086,7 +2086,7 @@ 
 
 	/**
 	 * @param string $filename
-	 * @return array
+	 * @return string[]
 	 * @throws \OC\User\NoUserException
 	 * @throws NotFoundException
 	 */

Spacing +39 added lines, -39 removed lines

@@ -125,9 +125,9 @@ 
 			$path = '/';
 		}
 		if ($path[0] !== '/') {
-			$path = '/' . $path;
+			$path = '/'.$path;
 		}
-		return $this->fakeRoot . $path;
+		return $this->fakeRoot.$path;
 	}
 
 	/**
@@ -139,7 +139,7 @@ 
 	public function chroot($fakeRoot) {
 		if (!$fakeRoot == '') {
 			if ($fakeRoot[0] !== '/') {
-				$fakeRoot = '/' . $fakeRoot;
+				$fakeRoot = '/'.$fakeRoot;
 			}
 		}
 		$this->fakeRoot = $fakeRoot;
@@ -171,7 +171,7 @@ 
 		}
 
 		// missing slashes can cause wrong matches!
-		$root = rtrim($this->fakeRoot, '/') . '/';
+		$root = rtrim($this->fakeRoot, '/').'/';
 
 		if (strpos($path, $root) !== 0) {
 			return null;
@@ -277,7 +277,7 @@ 
 		if ($mount instanceof MoveableMount) {
 			// cut of /user/files to get the relative path to data/user/files
 			$pathParts = explode('/', $path, 4);
-			$relPath = '/' . $pathParts[3];
+			$relPath = '/'.$pathParts[3];
 			$this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true);
 			\OC_Hook::emit(
 				Filesystem::CLASSNAME, "umount",
@@ -688,7 +688,7 @@ 
 		}
 		$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
 		$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
-		$mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
+		$mount = Filesystem::getMountManager()->find($absolutePath.$postFix);
 		if ($mount and $mount->getInternalPath($absolutePath) === '') {
 			return $this->removeMount($mount, $absolutePath);
 		}
@@ -954,7 +954,7 @@ 
 				$hooks[] = 'write';
 				break;
 			default:
-				\OCP\Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', 'invalid mode ('.$mode.') for '.$path, \OCP\Util::ERROR);
 		}
 
 		if ($mode !== 'r' && $mode !== 'w') {
@@ -1058,7 +1058,7 @@ 
 					array(Filesystem::signal_param_path => $this->getHookPath($path))
 				);
 			}
-			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
+			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath.$postFix);
 			if ($storage) {
 				$result = $storage->hash($type, $internalPath, $raw);
 				return $result;
@@ -1109,7 +1109,7 @@ 
 
 			$run = $this->runHooks($hooks, $path);
 			/** @var \OC\Files\Storage\Storage $storage */
-			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
+			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath.$postFix);
 			if ($run and $storage) {
 				if (in_array('write', $hooks) || in_array('delete', $hooks)) {
 					$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
@@ -1148,7 +1148,7 @@ 
 					$unlockLater = true;
 					// make sure our unlocking callback will still be called if connection is aborted
 					ignore_user_abort(true);
-					$result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) {
+					$result = CallbackWrapper::wrap($result, null, null, function() use ($hooks, $path) {
 						if (in_array('write', $hooks)) {
 							$this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
 						} else if (in_array('read', $hooks)) {
@@ -1209,7 +1209,7 @@ 
 			return true;
 		}
 
-		return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
+		return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot.'/');
 	}
 
 	/**
@@ -1228,7 +1228,7 @@ 
 				if ($hook != 'read') {
 					\OC_Hook::emit(
 						Filesystem::CLASSNAME,
-						$prefix . $hook,
+						$prefix.$hook,
 						array(
 							Filesystem::signal_param_run => &$run,
 							Filesystem::signal_param_path => $path
@@ -1237,7 +1237,7 @@ 
 				} elseif (!$post) {
 					\OC_Hook::emit(
 						Filesystem::CLASSNAME,
-						$prefix . $hook,
+						$prefix.$hook,
 						array(
 							Filesystem::signal_param_path => $path
 						)
@@ -1332,7 +1332,7 @@ 
 			return $this->getPartFileInfo($path);
 		}
 		$relativePath = $path;
-		$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
+		$path = Filesystem::normalizePath($this->fakeRoot.'/'.$path);
 
 		$mount = Filesystem::getMountManager()->find($path);
 		$storage = $mount->getStorage();
@@ -1356,7 +1356,7 @@ 
 					//add the sizes of other mount points to the folder
 					$extOnly = ($includeMountPoints === 'ext');
 					$mounts = Filesystem::getMountManager()->findIn($path);
-					$info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) {
+					$info->setSubMounts(array_filter($mounts, function(IMountPoint $mount) use ($extOnly) {
 						$subStorage = $mount->getStorage();
 						return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage);
 					}));
@@ -1403,12 +1403,12 @@ 
 			/**
 			 * @var \OC\Files\FileInfo[] $files
 			 */
-			$files = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
+			$files = array_map(function(ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
 				if ($sharingDisabled) {
 					$content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
 				}
 				$owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
-				return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
+				return new FileInfo($path.'/'.$content['name'], $storage, $content['path'], $content, $mount, $owner);
 			}, $contents);
 
 			//add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
@@ -1433,8 +1433,8 @@ 
 							// sometimes when the storage is not available it can be any exception
 							\OCP\Util::writeLog(
 								'core',
-								'Exception while scanning storage "' . $subStorage->getId() . '": ' .
-								get_class($e) . ': ' . $e->getMessage(),
+								'Exception while scanning storage "'.$subStorage->getId().'": '.
+								get_class($e).': '.$e->getMessage(),
 								\OCP\Util::ERROR
 							);
 							continue;
@@ -1471,7 +1471,7 @@ 
 									break;
 								}
 							}
-							$rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
+							$rootEntry['path'] = substr(Filesystem::normalizePath($path.'/'.$rootEntry['name']), strlen($user) + 2); // full path without /$user/
 
 							// if sharing was disabled for the user we remove the share permissions
 							if (\OCP\Util::isSharingDisabledForUser()) {
@@ -1479,14 +1479,14 @@ 
 							}
 
 							$owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
-							$files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
+							$files[] = new FileInfo($path.'/'.$rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
 						}
 					}
 				}
 			}
 
 			if ($mimetype_filter) {
-				$files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) {
+				$files = array_filter($files, function(FileInfo $file) use ($mimetype_filter) {
 					if (strpos($mimetype_filter, '/')) {
 						return $file->getMimetype() === $mimetype_filter;
 					} else {
@@ -1515,7 +1515,7 @@ 
 		if ($data instanceof FileInfo) {
 			$data = $data->getData();
 		}
-		$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
+		$path = Filesystem::normalizePath($this->fakeRoot.'/'.$path);
 		/**
 		 * @var \OC\Files\Storage\Storage $storage
 		 * @var string $internalPath
@@ -1542,7 +1542,7 @@ 
 	 * @return FileInfo[]
 	 */
 	public function search($query) {
-		return $this->searchCommon('search', array('%' . $query . '%'));
+		return $this->searchCommon('search', array('%'.$query.'%'));
 	}
 
 	/**
@@ -1593,10 +1593,10 @@ 
 
 			$results = call_user_func_array(array($cache, $method), $args);
 			foreach ($results as $result) {
-				if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
+				if (substr($mountPoint.$result['path'], 0, $rootLength + 1) === $this->fakeRoot.'/') {
 					$internalPath = $result['path'];
-					$path = $mountPoint . $result['path'];
-					$result['path'] = substr($mountPoint . $result['path'], $rootLength);
+					$path = $mountPoint.$result['path'];
+					$result['path'] = substr($mountPoint.$result['path'], $rootLength);
 					$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
 					$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
 				}
@@ -1614,8 +1614,8 @@ 
 					if ($results) {
 						foreach ($results as $result) {
 							$internalPath = $result['path'];
-							$result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
-							$path = rtrim($mountPoint . $internalPath, '/');
+							$result['path'] = rtrim($relativeMountPoint.$result['path'], '/');
+							$path = rtrim($mountPoint.$internalPath, '/');
 							$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
 							$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
 						}
@@ -1636,7 +1636,7 @@ 
 	public function getOwner($path) {
 		$info = $this->getFileInfo($path);
 		if (!$info) {
-			throw new NotFoundException($path . ' not found while trying to get owner');
+			throw new NotFoundException($path.' not found while trying to get owner');
 		}
 		return $info->getOwner()->getUID();
 	}
@@ -1670,7 +1670,7 @@ 
 	 * @return string
 	 */
 	public function getPath($id) {
-		$id = (int)$id;
+		$id = (int) $id;
 		$manager = Filesystem::getMountManager();
 		$mounts = $manager->findIn($this->fakeRoot);
 		$mounts[] = $manager->find($this->fakeRoot);
@@ -1685,7 +1685,7 @@ 
 				$cache = $mount->getStorage()->getCache();
 				$internalPath = $cache->getPathById($id);
 				if (is_string($internalPath)) {
-					$fullPath = $mount->getMountPoint() . $internalPath;
+					$fullPath = $mount->getMountPoint().$internalPath;
 					if (!is_null($path = $this->getRelativePath($fullPath))) {
 						return $path;
 					}
@@ -1728,10 +1728,10 @@ 
 		}
 
 		// note: cannot use the view because the target is already locked
-		$fileId = (int)$targetStorage->getCache()->getId($targetInternalPath);
+		$fileId = (int) $targetStorage->getCache()->getId($targetInternalPath);
 		if ($fileId === -1) {
 			// target might not exist, need to check parent instead
-			$fileId = (int)$targetStorage->getCache()->getId(dirname($targetInternalPath));
+			$fileId = (int) $targetStorage->getCache()->getId(dirname($targetInternalPath));
 		}
 
 		// check if any of the parents were shared by the current owner (include collections)
@@ -1831,7 +1831,7 @@ 
 		$resultPath = '';
 		foreach ($parts as $part) {
 			if ($part) {
-				$resultPath .= '/' . $part;
+				$resultPath .= '/'.$part;
 				$result[] = $resultPath;
 			}
 		}
@@ -2081,16 +2081,16 @@ 
 	public function getUidAndFilename($filename) {
 		$info = $this->getFileInfo($filename);
 		if (!$info instanceof \OCP\Files\FileInfo) {
-			throw new NotFoundException($this->getAbsolutePath($filename) . ' not found');
+			throw new NotFoundException($this->getAbsolutePath($filename).' not found');
 		}
 		$uid = $info->getOwner()->getUID();
 		if ($uid != \OCP\User::getUser()) {
 			Filesystem::initMountPoints($uid);
-			$ownerView = new View('/' . $uid . '/files');
+			$ownerView = new View('/'.$uid.'/files');
 			try {
 				$filename = $ownerView->getPath($info['fileid']);
 			} catch (NotFoundException $e) {
-				throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid);
+				throw new NotFoundException('File with id '.$info['fileid'].' not found for user '.$uid);
 			}
 		}
 		return [$uid, $filename];
@@ -2107,7 +2107,7 @@ 
 		$directoryParts = array_filter($directoryParts);
 		foreach ($directoryParts as $key => $part) {
 			$currentPathElements = array_slice($directoryParts, 0, $key);
-			$currentPath = '/' . implode('/', $currentPathElements);
+			$currentPath = '/'.implode('/', $currentPathElements);
 			if ($this->is_file($currentPath)) {
 				return false;
 			}

Indentation +2055 added lines, -2055 removed lines

@@ -82,2059 +82,2059 @@
  * \OC\Files\Storage\Storage object
  */
 class View {
-	/** @var string */
-	private $fakeRoot = '';
-
-	/**
-	 * @var \OCP\Lock\ILockingProvider
-	 */
-	protected $lockingProvider;
-
-	private $lockingEnabled;
-
-	private $updaterEnabled = true;
-
-	/** @var \OC\User\Manager */
-	private $userManager;
-
-	/** @var \OCP\ILogger */
-	private $logger;
-
-	/**
-	 * @param string $root
-	 * @throws \Exception If $root contains an invalid path
-	 */
-	public function __construct($root = '') {
-		if (is_null($root)) {
-			throw new \InvalidArgumentException('Root can\'t be null');
-		}
-		if (!Filesystem::isValidPath($root)) {
-			throw new \Exception();
-		}
-
-		$this->fakeRoot = $root;
-		$this->lockingProvider = \OC::$server->getLockingProvider();
-		$this->lockingEnabled = !($this->lockingProvider instanceof \OC\Lock\NoopLockingProvider);
-		$this->userManager = \OC::$server->getUserManager();
-		$this->logger = \OC::$server->getLogger();
-	}
-
-	public function getAbsolutePath($path = '/') {
-		if ($path === null) {
-			return null;
-		}
-		$this->assertPathLength($path);
-		if ($path === '') {
-			$path = '/';
-		}
-		if ($path[0] !== '/') {
-			$path = '/' . $path;
-		}
-		return $this->fakeRoot . $path;
-	}
-
-	/**
-	 * change the root to a fake root
-	 *
-	 * @param string $fakeRoot
-	 * @return boolean|null
-	 */
-	public function chroot($fakeRoot) {
-		if (!$fakeRoot == '') {
-			if ($fakeRoot[0] !== '/') {
-				$fakeRoot = '/' . $fakeRoot;
-			}
-		}
-		$this->fakeRoot = $fakeRoot;
-	}
-
-	/**
-	 * get the fake root
-	 *
-	 * @return string
-	 */
-	public function getRoot() {
-		return $this->fakeRoot;
-	}
-
-	/**
-	 * get path relative to the root of the view
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getRelativePath($path) {
-		$this->assertPathLength($path);
-		if ($this->fakeRoot == '') {
-			return $path;
-		}
-
-		if (rtrim($path, '/') === rtrim($this->fakeRoot, '/')) {
-			return '/';
-		}
-
-		// missing slashes can cause wrong matches!
-		$root = rtrim($this->fakeRoot, '/') . '/';
-
-		if (strpos($path, $root) !== 0) {
-			return null;
-		} else {
-			$path = substr($path, strlen($this->fakeRoot));
-			if (strlen($path) === 0) {
-				return '/';
-			} else {
-				return $path;
-			}
-		}
-	}
-
-	/**
-	 * get the mountpoint of the storage object for a path
-	 * ( note: because a storage is not always mounted inside the fakeroot, the
-	 * returned mountpoint is relative to the absolute root of the filesystem
-	 * and does not take the chroot into account )
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getMountPoint($path) {
-		return Filesystem::getMountPoint($this->getAbsolutePath($path));
-	}
-
-	/**
-	 * get the mountpoint of the storage object for a path
-	 * ( note: because a storage is not always mounted inside the fakeroot, the
-	 * returned mountpoint is relative to the absolute root of the filesystem
-	 * and does not take the chroot into account )
-	 *
-	 * @param string $path
-	 * @return \OCP\Files\Mount\IMountPoint
-	 */
-	public function getMount($path) {
-		return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
-	}
-
-	/**
-	 * resolve a path to a storage and internal path
-	 *
-	 * @param string $path
-	 * @return array an array consisting of the storage and the internal path
-	 */
-	public function resolvePath($path) {
-		$a = $this->getAbsolutePath($path);
-		$p = Filesystem::normalizePath($a);
-		return Filesystem::resolvePath($p);
-	}
-
-	/**
-	 * return the path to a local version of the file
-	 * we need this because we can't know if a file is stored local or not from
-	 * outside the filestorage and for some purposes a local file is needed
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getLocalFile($path) {
-		$parent = substr($path, 0, strrpos($path, '/'));
-		$path = $this->getAbsolutePath($path);
-		list($storage, $internalPath) = Filesystem::resolvePath($path);
-		if (Filesystem::isValidPath($parent) and $storage) {
-			return $storage->getLocalFile($internalPath);
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	public function getLocalFolder($path) {
-		$parent = substr($path, 0, strrpos($path, '/'));
-		$path = $this->getAbsolutePath($path);
-		list($storage, $internalPath) = Filesystem::resolvePath($path);
-		if (Filesystem::isValidPath($parent) and $storage) {
-			return $storage->getLocalFolder($internalPath);
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * the following functions operate with arguments and return values identical
-	 * to those of their PHP built-in equivalents. Mostly they are merely wrappers
-	 * for \OC\Files\Storage\Storage via basicOperation().
-	 */
-	public function mkdir($path) {
-		return $this->basicOperation('mkdir', $path, array('create', 'write'));
-	}
-
-	/**
-	 * remove mount point
-	 *
-	 * @param \OC\Files\Mount\MoveableMount $mount
-	 * @param string $path relative to data/
-	 * @return boolean
-	 */
-	protected function removeMount($mount, $path) {
-		if ($mount instanceof MoveableMount) {
-			// cut of /user/files to get the relative path to data/user/files
-			$pathParts = explode('/', $path, 4);
-			$relPath = '/' . $pathParts[3];
-			$this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true);
-			\OC_Hook::emit(
-				Filesystem::CLASSNAME, "umount",
-				array(Filesystem::signal_param_path => $relPath)
-			);
-			$this->changeLock($relPath, ILockingProvider::LOCK_EXCLUSIVE, true);
-			$result = $mount->removeMount();
-			$this->changeLock($relPath, ILockingProvider::LOCK_SHARED, true);
-			if ($result) {
-				\OC_Hook::emit(
-					Filesystem::CLASSNAME, "post_umount",
-					array(Filesystem::signal_param_path => $relPath)
-				);
-			}
-			$this->unlockFile($relPath, ILockingProvider::LOCK_SHARED, true);
-			return $result;
-		} else {
-			// do not allow deleting the storage's root / the mount point
-			// because for some storages it might delete the whole contents
-			// but isn't supposed to work that way
-			return false;
-		}
-	}
-
-	public function disableCacheUpdate() {
-		$this->updaterEnabled = false;
-	}
-
-	public function enableCacheUpdate() {
-		$this->updaterEnabled = true;
-	}
-
-	protected function writeUpdate(Storage $storage, $internalPath, $time = null) {
-		if ($this->updaterEnabled) {
-			if (is_null($time)) {
-				$time = time();
-			}
-			$storage->getUpdater()->update($internalPath, $time);
-		}
-	}
-
-	protected function removeUpdate(Storage $storage, $internalPath) {
-		if ($this->updaterEnabled) {
-			$storage->getUpdater()->remove($internalPath);
-		}
-	}
-
-	protected function renameUpdate(Storage $sourceStorage, Storage $targetStorage, $sourceInternalPath, $targetInternalPath) {
-		if ($this->updaterEnabled) {
-			$targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool|mixed
-	 */
-	public function rmdir($path) {
-		$absolutePath = $this->getAbsolutePath($path);
-		$mount = Filesystem::getMountManager()->find($absolutePath);
-		if ($mount->getInternalPath($absolutePath) === '') {
-			return $this->removeMount($mount, $absolutePath);
-		}
-		if ($this->is_dir($path)) {
-			$result = $this->basicOperation('rmdir', $path, array('delete'));
-		} else {
-			$result = false;
-		}
-
-		if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
-			$storage = $mount->getStorage();
-			$internalPath = $mount->getInternalPath($absolutePath);
-			$storage->getUpdater()->remove($internalPath);
-		}
-		return $result;
-	}
-
-	/**
-	 * @param string $path
-	 * @return resource
-	 */
-	public function opendir($path) {
-		return $this->basicOperation('opendir', $path, array('read'));
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool|mixed
-	 */
-	public function is_dir($path) {
-		if ($path == '/') {
-			return true;
-		}
-		return $this->basicOperation('is_dir', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool|mixed
-	 */
-	public function is_file($path) {
-		if ($path == '/') {
-			return false;
-		}
-		return $this->basicOperation('is_file', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function stat($path) {
-		return $this->basicOperation('stat', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function filetype($path) {
-		return $this->basicOperation('filetype', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function filesize($path) {
-		return $this->basicOperation('filesize', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool|mixed
-	 * @throws \OCP\Files\InvalidPathException
-	 */
-	public function readfile($path) {
-		$this->assertPathLength($path);
-		@ob_end_clean();
-		$handle = $this->fopen($path, 'rb');
-		if ($handle) {
-			$chunkSize = 8192; // 8 kB chunks
-			while (!feof($handle)) {
-				echo fread($handle, $chunkSize);
-				flush();
-			}
-			fclose($handle);
-			$size = $this->filesize($path);
-			return $size;
-		}
-		return false;
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $from
-	 * @param int $to
-	 * @return bool|mixed
-	 * @throws \OCP\Files\InvalidPathException
-	 * @throws \OCP\Files\UnseekableException
-	 */
-	public function readfilePart($path, $from, $to) {
-		$this->assertPathLength($path);
-		@ob_end_clean();
-		$handle = $this->fopen($path, 'rb');
-		if ($handle) {
-			if (fseek($handle, $from) === 0) {
-				$chunkSize = 8192; // 8 kB chunks
-				$end = $to + 1;
-				while (!feof($handle) && ftell($handle) < $end) {
-					$len = $end - ftell($handle);
-					if ($len > $chunkSize) {
-						$len = $chunkSize;
-					}
-					echo fread($handle, $len);
-					flush();
-				}
-				$size = ftell($handle) - $from;
-				return $size;
-			}
-
-			throw new \OCP\Files\UnseekableException('fseek error');
-		}
-		return false;
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function isCreatable($path) {
-		return $this->basicOperation('isCreatable', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function isReadable($path) {
-		return $this->basicOperation('isReadable', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function isUpdatable($path) {
-		return $this->basicOperation('isUpdatable', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool|mixed
-	 */
-	public function isDeletable($path) {
-		$absolutePath = $this->getAbsolutePath($path);
-		$mount = Filesystem::getMountManager()->find($absolutePath);
-		if ($mount->getInternalPath($absolutePath) === '') {
-			return $mount instanceof MoveableMount;
-		}
-		return $this->basicOperation('isDeletable', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function isSharable($path) {
-		return $this->basicOperation('isSharable', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool|mixed
-	 */
-	public function file_exists($path) {
-		if ($path == '/') {
-			return true;
-		}
-		return $this->basicOperation('file_exists', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function filemtime($path) {
-		return $this->basicOperation('filemtime', $path);
-	}
-
-	/**
-	 * @param string $path
-	 * @param int|string $mtime
-	 * @return bool
-	 */
-	public function touch($path, $mtime = null) {
-		if (!is_null($mtime) and !is_numeric($mtime)) {
-			$mtime = strtotime($mtime);
-		}
-
-		$hooks = array('touch');
-
-		if (!$this->file_exists($path)) {
-			$hooks[] = 'create';
-			$hooks[] = 'write';
-		}
-		$result = $this->basicOperation('touch', $path, $hooks, $mtime);
-		if (!$result) {
-			// If create file fails because of permissions on external storage like SMB folders,
-			// check file exists and return false if not.
-			if (!$this->file_exists($path)) {
-				return false;
-			}
-			if (is_null($mtime)) {
-				$mtime = time();
-			}
-			//if native touch fails, we emulate it by changing the mtime in the cache
-			$this->putFileInfo($path, array('mtime' => floor($mtime)));
-		}
-		return true;
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 */
-	public function file_get_contents($path) {
-		return $this->basicOperation('file_get_contents', $path, array('read'));
-	}
-
-	/**
-	 * @param bool $exists
-	 * @param string $path
-	 * @param bool $run
-	 */
-	protected function emit_file_hooks_pre($exists, $path, &$run) {
-		if (!$exists) {
-			\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, array(
-				Filesystem::signal_param_path => $this->getHookPath($path),
-				Filesystem::signal_param_run => &$run,
-			));
-		} else {
-			\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, array(
-				Filesystem::signal_param_path => $this->getHookPath($path),
-				Filesystem::signal_param_run => &$run,
-			));
-		}
-		\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, array(
-			Filesystem::signal_param_path => $this->getHookPath($path),
-			Filesystem::signal_param_run => &$run,
-		));
-	}
-
-	/**
-	 * @param bool $exists
-	 * @param string $path
-	 */
-	protected function emit_file_hooks_post($exists, $path) {
-		if (!$exists) {
-			\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, array(
-				Filesystem::signal_param_path => $this->getHookPath($path),
-			));
-		} else {
-			\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_update, array(
-				Filesystem::signal_param_path => $this->getHookPath($path),
-			));
-		}
-		\OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_write, array(
-			Filesystem::signal_param_path => $this->getHookPath($path),
-		));
-	}
-
-	/**
-	 * @param string $path
-	 * @param mixed $data
-	 * @return bool|mixed
-	 * @throws \Exception
-	 */
-	public function file_put_contents($path, $data) {
-		if (is_resource($data)) { //not having to deal with streams in file_put_contents makes life easier
-			$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
-			if (Filesystem::isValidPath($path)
-				and !Filesystem::isFileBlacklisted($path)
-			) {
-				$path = $this->getRelativePath($absolutePath);
-
-				$this->lockFile($path, ILockingProvider::LOCK_SHARED);
-
-				$exists = $this->file_exists($path);
-				$run = true;
-				if ($this->shouldEmitHooks($path)) {
-					$this->emit_file_hooks_pre($exists, $path, $run);
-				}
-				if (!$run) {
-					$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
-					return false;
-				}
-
-				$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
-
-				/** @var \OC\Files\Storage\Storage $storage */
-				list($storage, $internalPath) = $this->resolvePath($path);
-				$target = $storage->fopen($internalPath, 'w');
-				if ($target) {
-					list (, $result) = \OC_Helper::streamCopy($data, $target);
-					fclose($target);
-					fclose($data);
-
-					$this->writeUpdate($storage, $internalPath);
-
-					$this->changeLock($path, ILockingProvider::LOCK_SHARED);
-
-					if ($this->shouldEmitHooks($path) && $result !== false) {
-						$this->emit_file_hooks_post($exists, $path);
-					}
-					$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
-					return $result;
-				} else {
-					$this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
-					return false;
-				}
-			} else {
-				return false;
-			}
-		} else {
-			$hooks = ($this->file_exists($path)) ? array('update', 'write') : array('create', 'write');
-			return $this->basicOperation('file_put_contents', $path, $hooks, $data);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool|mixed
-	 */
-	public function unlink($path) {
-		if ($path === '' || $path === '/') {
-			// do not allow deleting the root
-			return false;
-		}
-		$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
-		$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
-		$mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
-		if ($mount and $mount->getInternalPath($absolutePath) === '') {
-			return $this->removeMount($mount, $absolutePath);
-		}
-		if ($this->is_dir($path)) {
-			$result = $this->basicOperation('rmdir', $path, ['delete']);
-		} else {
-			$result = $this->basicOperation('unlink', $path, ['delete']);
-		}
-		if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
-			$storage = $mount->getStorage();
-			$internalPath = $mount->getInternalPath($absolutePath);
-			$storage->getUpdater()->remove($internalPath);
-			return true;
-		} else {
-			return $result;
-		}
-	}
-
-	/**
-	 * @param string $directory
-	 * @return bool|mixed
-	 */
-	public function deleteAll($directory) {
-		return $this->rmdir($directory);
-	}
-
-	/**
-	 * Rename/move a file or folder from the source path to target path.
-	 *
-	 * @param string $path1 source path
-	 * @param string $path2 target path
-	 *
-	 * @return bool|mixed
-	 */
-	public function rename($path1, $path2) {
-		$absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
-		$absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
-		$result = false;
-		if (
-			Filesystem::isValidPath($path2)
-			and Filesystem::isValidPath($path1)
-			and !Filesystem::isFileBlacklisted($path2)
-		) {
-			$path1 = $this->getRelativePath($absolutePath1);
-			$path2 = $this->getRelativePath($absolutePath2);
-			$exists = $this->file_exists($path2);
-
-			if ($path1 == null or $path2 == null) {
-				return false;
-			}
-
-			$this->lockFile($path1, ILockingProvider::LOCK_SHARED, true);
-			try {
-				$this->lockFile($path2, ILockingProvider::LOCK_SHARED, true);
-			} catch (LockedException $e) {
-				$this->unlockFile($path1, ILockingProvider::LOCK_SHARED);
-				throw $e;
-			}
-
-			$run = true;
-			if ($this->shouldEmitHooks($path1) && (Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2))) {
-				// if it was a rename from a part file to a regular file it was a write and not a rename operation
-				$this->emit_file_hooks_pre($exists, $path2, $run);
-			} elseif ($this->shouldEmitHooks($path1)) {
-				\OC_Hook::emit(
-					Filesystem::CLASSNAME, Filesystem::signal_rename,
-					array(
-						Filesystem::signal_param_oldpath => $this->getHookPath($path1),
-						Filesystem::signal_param_newpath => $this->getHookPath($path2),
-						Filesystem::signal_param_run => &$run
-					)
-				);
-			}
-			if ($run) {
-				$this->verifyPath(dirname($path2), basename($path2));
-
-				$manager = Filesystem::getMountManager();
-				$mount1 = $this->getMount($path1);
-				$mount2 = $this->getMount($path2);
-				$storage1 = $mount1->getStorage();
-				$storage2 = $mount2->getStorage();
-				$internalPath1 = $mount1->getInternalPath($absolutePath1);
-				$internalPath2 = $mount2->getInternalPath($absolutePath2);
-
-				$this->changeLock($path1, ILockingProvider::LOCK_EXCLUSIVE, true);
-				$this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE, true);
-
-				if ($internalPath1 === '') {
-					if ($mount1 instanceof MoveableMount) {
-						if ($this->isTargetAllowed($absolutePath2)) {
-							/**
-							 * @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount1
-							 */
-							$sourceMountPoint = $mount1->getMountPoint();
-							$result = $mount1->moveMount($absolutePath2);
-							$manager->moveMount($sourceMountPoint, $mount1->getMountPoint());
-						} else {
-							$result = false;
-						}
-					} else {
-						$result = false;
-					}
-					// moving a file/folder within the same mount point
-				} elseif ($storage1 === $storage2) {
-					if ($storage1) {
-						$result = $storage1->rename($internalPath1, $internalPath2);
-					} else {
-						$result = false;
-					}
-					// moving a file/folder between storages (from $storage1 to $storage2)
-				} else {
-					$result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
-				}
-
-				if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
-					// if it was a rename from a part file to a regular file it was a write and not a rename operation
-
-					$this->writeUpdate($storage2, $internalPath2);
-				} else if ($result) {
-					if ($internalPath1 !== '') { // don't do a cache update for moved mounts
-						$this->renameUpdate($storage1, $storage2, $internalPath1, $internalPath2);
-					}
-				}
-
-				$this->changeLock($path1, ILockingProvider::LOCK_SHARED, true);
-				$this->changeLock($path2, ILockingProvider::LOCK_SHARED, true);
-
-				if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
-					if ($this->shouldEmitHooks()) {
-						$this->emit_file_hooks_post($exists, $path2);
-					}
-				} elseif ($result) {
-					if ($this->shouldEmitHooks($path1) and $this->shouldEmitHooks($path2)) {
-						\OC_Hook::emit(
-							Filesystem::CLASSNAME,
-							Filesystem::signal_post_rename,
-							array(
-								Filesystem::signal_param_oldpath => $this->getHookPath($path1),
-								Filesystem::signal_param_newpath => $this->getHookPath($path2)
-							)
-						);
-					}
-				}
-			}
-			$this->unlockFile($path1, ILockingProvider::LOCK_SHARED, true);
-			$this->unlockFile($path2, ILockingProvider::LOCK_SHARED, true);
-		}
-		return $result;
-	}
-
-	/**
-	 * Copy a file/folder from the source path to target path
-	 *
-	 * @param string $path1 source path
-	 * @param string $path2 target path
-	 * @param bool $preserveMtime whether to preserve mtime on the copy
-	 *
-	 * @return bool|mixed
-	 */
-	public function copy($path1, $path2, $preserveMtime = false) {
-		$absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
-		$absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
-		$result = false;
-		if (
-			Filesystem::isValidPath($path2)
-			and Filesystem::isValidPath($path1)
-			and !Filesystem::isFileBlacklisted($path2)
-		) {
-			$path1 = $this->getRelativePath($absolutePath1);
-			$path2 = $this->getRelativePath($absolutePath2);
-
-			if ($path1 == null or $path2 == null) {
-				return false;
-			}
-			$run = true;
-
-			$this->lockFile($path2, ILockingProvider::LOCK_SHARED);
-			$this->lockFile($path1, ILockingProvider::LOCK_SHARED);
-			$lockTypePath1 = ILockingProvider::LOCK_SHARED;
-			$lockTypePath2 = ILockingProvider::LOCK_SHARED;
-
-			try {
-
-				$exists = $this->file_exists($path2);
-				if ($this->shouldEmitHooks()) {
-					\OC_Hook::emit(
-						Filesystem::CLASSNAME,
-						Filesystem::signal_copy,
-						array(
-							Filesystem::signal_param_oldpath => $this->getHookPath($path1),
-							Filesystem::signal_param_newpath => $this->getHookPath($path2),
-							Filesystem::signal_param_run => &$run
-						)
-					);
-					$this->emit_file_hooks_pre($exists, $path2, $run);
-				}
-				if ($run) {
-					$mount1 = $this->getMount($path1);
-					$mount2 = $this->getMount($path2);
-					$storage1 = $mount1->getStorage();
-					$internalPath1 = $mount1->getInternalPath($absolutePath1);
-					$storage2 = $mount2->getStorage();
-					$internalPath2 = $mount2->getInternalPath($absolutePath2);
-
-					$this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE);
-					$lockTypePath2 = ILockingProvider::LOCK_EXCLUSIVE;
-
-					if ($mount1->getMountPoint() == $mount2->getMountPoint()) {
-						if ($storage1) {
-							$result = $storage1->copy($internalPath1, $internalPath2);
-						} else {
-							$result = false;
-						}
-					} else {
-						$result = $storage2->copyFromStorage($storage1, $internalPath1, $internalPath2);
-					}
-
-					$this->writeUpdate($storage2, $internalPath2);
-
-					$this->changeLock($path2, ILockingProvider::LOCK_SHARED);
-					$lockTypePath2 = ILockingProvider::LOCK_SHARED;
-
-					if ($this->shouldEmitHooks() && $result !== false) {
-						\OC_Hook::emit(
-							Filesystem::CLASSNAME,
-							Filesystem::signal_post_copy,
-							array(
-								Filesystem::signal_param_oldpath => $this->getHookPath($path1),
-								Filesystem::signal_param_newpath => $this->getHookPath($path2)
-							)
-						);
-						$this->emit_file_hooks_post($exists, $path2);
-					}
-
-				}
-			} catch (\Exception $e) {
-				$this->unlockFile($path2, $lockTypePath2);
-				$this->unlockFile($path1, $lockTypePath1);
-				throw $e;
-			}
-
-			$this->unlockFile($path2, $lockTypePath2);
-			$this->unlockFile($path1, $lockTypePath1);
-
-		}
-		return $result;
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $mode 'r' or 'w'
-	 * @return resource
-	 */
-	public function fopen($path, $mode) {
-		$mode = str_replace('b', '', $mode); // the binary flag is a windows only feature which we do not support
-		$hooks = array();
-		switch ($mode) {
-			case 'r':
-				$hooks[] = 'read';
-				break;
-			case 'r+':
-			case 'w+':
-			case 'x+':
-			case 'a+':
-				$hooks[] = 'read';
-				$hooks[] = 'write';
-				break;
-			case 'w':
-			case 'x':
-			case 'a':
-				$hooks[] = 'write';
-				break;
-			default:
-				\OCP\Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, \OCP\Util::ERROR);
-		}
-
-		if ($mode !== 'r' && $mode !== 'w') {
-			\OC::$server->getLogger()->info('Trying to open a file with a mode other than "r" or "w" can cause severe performance issues with some backends');
-		}
-
-		return $this->basicOperation('fopen', $path, $hooks, $mode);
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool|string
-	 * @throws \OCP\Files\InvalidPathException
-	 */
-	public function toTmpFile($path) {
-		$this->assertPathLength($path);
-		if (Filesystem::isValidPath($path)) {
-			$source = $this->fopen($path, 'r');
-			if ($source) {
-				$extension = pathinfo($path, PATHINFO_EXTENSION);
-				$tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension);
-				file_put_contents($tmpFile, $source);
-				return $tmpFile;
-			} else {
-				return false;
-			}
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $tmpFile
-	 * @param string $path
-	 * @return bool|mixed
-	 * @throws \OCP\Files\InvalidPathException
-	 */
-	public function fromTmpFile($tmpFile, $path) {
-		$this->assertPathLength($path);
-		if (Filesystem::isValidPath($path)) {
-
-			// Get directory that the file is going into
-			$filePath = dirname($path);
-
-			// Create the directories if any
-			if (!$this->file_exists($filePath)) {
-				$result = $this->createParentDirectories($filePath);
-				if ($result === false) {
-					return false;
-				}
-			}
-
-			$source = fopen($tmpFile, 'r');
-			if ($source) {
-				$result = $this->file_put_contents($path, $source);
-				// $this->file_put_contents() might have already closed
-				// the resource, so we check it, before trying to close it
-				// to avoid messages in the error log.
-				if (is_resource($source)) {
-					fclose($source);
-				}
-				unlink($tmpFile);
-				return $result;
-			} else {
-				return false;
-			}
-		} else {
-			return false;
-		}
-	}
-
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 * @throws \OCP\Files\InvalidPathException
-	 */
-	public function getMimeType($path) {
-		$this->assertPathLength($path);
-		return $this->basicOperation('getMimeType', $path);
-	}
-
-	/**
-	 * @param string $type
-	 * @param string $path
-	 * @param bool $raw
-	 * @return bool|null|string
-	 */
-	public function hash($type, $path, $raw = false) {
-		$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
-		$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
-		if (Filesystem::isValidPath($path)) {
-			$path = $this->getRelativePath($absolutePath);
-			if ($path == null) {
-				return false;
-			}
-			if ($this->shouldEmitHooks($path)) {
-				\OC_Hook::emit(
-					Filesystem::CLASSNAME,
-					Filesystem::signal_read,
-					array(Filesystem::signal_param_path => $this->getHookPath($path))
-				);
-			}
-			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
-			if ($storage) {
-				$result = $storage->hash($type, $internalPath, $raw);
-				return $result;
-			}
-		}
-		return null;
-	}
-
-	/**
-	 * @param string $path
-	 * @return mixed
-	 * @throws \OCP\Files\InvalidPathException
-	 */
-	public function free_space($path = '/') {
-		$this->assertPathLength($path);
-		$result = $this->basicOperation('free_space', $path);
-		if ($result === null) {
-			throw new InvalidPathException();
-		}
-		return $result;
-	}
-
-	/**
-	 * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
-	 *
-	 * @param string $operation
-	 * @param string $path
-	 * @param array $hooks (optional)
-	 * @param mixed $extraParam (optional)
-	 * @return mixed
-	 * @throws \Exception
-	 *
-	 * This method takes requests for basic filesystem functions (e.g. reading & writing
-	 * files), processes hooks and proxies, sanitises paths, and finally passes them on to
-	 * \OC\Files\Storage\Storage for delegation to a storage backend for execution
-	 */
-	private function basicOperation($operation, $path, $hooks = [], $extraParam = null) {
-		$postFix = (substr($path, -1, 1) === '/') ? '/' : '';
-		$absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
-		if (Filesystem::isValidPath($path)
-			and !Filesystem::isFileBlacklisted($path)
-		) {
-			$path = $this->getRelativePath($absolutePath);
-			if ($path == null) {
-				return false;
-			}
-
-			if (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks)) {
-				// always a shared lock during pre-hooks so the hook can read the file
-				$this->lockFile($path, ILockingProvider::LOCK_SHARED);
-			}
-
-			$run = $this->runHooks($hooks, $path);
-			/** @var \OC\Files\Storage\Storage $storage */
-			list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
-			if ($run and $storage) {
-				if (in_array('write', $hooks) || in_array('delete', $hooks)) {
-					$this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
-				}
-				try {
-					if (!is_null($extraParam)) {
-						$result = $storage->$operation($internalPath, $extraParam);
-					} else {
-						$result = $storage->$operation($internalPath);
-					}
-				} catch (\Exception $e) {
-					if (in_array('write', $hooks) || in_array('delete', $hooks)) {
-						$this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
-					} else if (in_array('read', $hooks)) {
-						$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
-					}
-					throw $e;
-				}
-
-				if ($result && in_array('delete', $hooks) and $result) {
-					$this->removeUpdate($storage, $internalPath);
-				}
-				if ($result && in_array('write', $hooks) and $operation !== 'fopen') {
-					$this->writeUpdate($storage, $internalPath);
-				}
-				if ($result && in_array('touch', $hooks)) {
-					$this->writeUpdate($storage, $internalPath, $extraParam);
-				}
-
-				if ((in_array('write', $hooks) || in_array('delete', $hooks)) && ($operation !== 'fopen' || $result === false)) {
-					$this->changeLock($path, ILockingProvider::LOCK_SHARED);
-				}
-
-				$unlockLater = false;
-				if ($this->lockingEnabled && $operation === 'fopen' && is_resource($result)) {
-					$unlockLater = true;
-					// make sure our unlocking callback will still be called if connection is aborted
-					ignore_user_abort(true);
-					$result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) {
-						if (in_array('write', $hooks)) {
-							$this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
-						} else if (in_array('read', $hooks)) {
-							$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
-						}
-					});
-				}
-
-				if ($this->shouldEmitHooks($path) && $result !== false) {
-					if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open
-						$this->runHooks($hooks, $path, true);
-					}
-				}
-
-				if (!$unlockLater
-					&& (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks))
-				) {
-					$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
-				}
-				return $result;
-			} else {
-				$this->unlockFile($path, ILockingProvider::LOCK_SHARED);
-			}
-		}
-		return null;
-	}
-
-	/**
-	 * get the path relative to the default root for hook usage
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	private function getHookPath($path) {
-		if (!Filesystem::getView()) {
-			return $path;
-		}
-		return Filesystem::getView()->getRelativePath($this->getAbsolutePath($path));
-	}
-
-	private function shouldEmitHooks($path = '') {
-		if ($path && Cache\Scanner::isPartialFile($path)) {
-			return false;
-		}
-		if (!Filesystem::$loaded) {
-			return false;
-		}
-		$defaultRoot = Filesystem::getRoot();
-		if ($defaultRoot === null) {
-			return false;
-		}
-		if ($this->fakeRoot === $defaultRoot) {
-			return true;
-		}
-		$fullPath = $this->getAbsolutePath($path);
-
-		if ($fullPath === $defaultRoot) {
-			return true;
-		}
-
-		return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
-	}
-
-	/**
-	 * @param string[] $hooks
-	 * @param string $path
-	 * @param bool $post
-	 * @return bool
-	 */
-	private function runHooks($hooks, $path, $post = false) {
-		$relativePath = $path;
-		$path = $this->getHookPath($path);
-		$prefix = ($post) ? 'post_' : '';
-		$run = true;
-		if ($this->shouldEmitHooks($relativePath)) {
-			foreach ($hooks as $hook) {
-				if ($hook != 'read') {
-					\OC_Hook::emit(
-						Filesystem::CLASSNAME,
-						$prefix . $hook,
-						array(
-							Filesystem::signal_param_run => &$run,
-							Filesystem::signal_param_path => $path
-						)
-					);
-				} elseif (!$post) {
-					\OC_Hook::emit(
-						Filesystem::CLASSNAME,
-						$prefix . $hook,
-						array(
-							Filesystem::signal_param_path => $path
-						)
-					);
-				}
-			}
-		}
-		return $run;
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 */
-	public function hasUpdated($path, $time) {
-		return $this->basicOperation('hasUpdated', $path, array(), $time);
-	}
-
-	/**
-	 * @param string $ownerId
-	 * @return \OC\User\User
-	 */
-	private function getUserObjectForOwner($ownerId) {
-		$owner = $this->userManager->get($ownerId);
-		if ($owner instanceof IUser) {
-			return $owner;
-		} else {
-			return new User($ownerId, null);
-		}
-	}
-
-	/**
-	 * Get file info from cache
-	 *
-	 * If the file is not in cached it will be scanned
-	 * If the file has changed on storage the cache will be updated
-	 *
-	 * @param \OC\Files\Storage\Storage $storage
-	 * @param string $internalPath
-	 * @param string $relativePath
-	 * @return ICacheEntry|bool
-	 */
-	private function getCacheEntry($storage, $internalPath, $relativePath) {
-		$cache = $storage->getCache($internalPath);
-		$data = $cache->get($internalPath);
-		$watcher = $storage->getWatcher($internalPath);
-
-		try {
-			// if the file is not in the cache or needs to be updated, trigger the scanner and reload the data
-			if (!$data || $data['size'] === -1) {
-				$this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
-				if (!$storage->file_exists($internalPath)) {
-					$this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
-					return false;
-				}
-				$scanner = $storage->getScanner($internalPath);
-				$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
-				$data = $cache->get($internalPath);
-				$this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
-			} else if (!Cache\Scanner::isPartialFile($internalPath) && $watcher->needsUpdate($internalPath, $data)) {
-				$this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
-				$watcher->update($internalPath, $data);
-				$storage->getPropagator()->propagateChange($internalPath, time());
-				$data = $cache->get($internalPath);
-				$this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
-			}
-		} catch (LockedException $e) {
-			// if the file is locked we just use the old cache info
-		}
-
-		return $data;
-	}
-
-	/**
-	 * get the filesystem info
-	 *
-	 * @param string $path
-	 * @param boolean|string $includeMountPoints true to add mountpoint sizes,
-	 * 'ext' to add only ext storage mount point sizes. Defaults to true.
-	 * defaults to true
-	 * @return \OC\Files\FileInfo|false False if file does not exist
-	 */
-	public function getFileInfo($path, $includeMountPoints = true) {
-		$this->assertPathLength($path);
-		if (!Filesystem::isValidPath($path)) {
-			return false;
-		}
-		if (Cache\Scanner::isPartialFile($path)) {
-			return $this->getPartFileInfo($path);
-		}
-		$relativePath = $path;
-		$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
-
-		$mount = Filesystem::getMountManager()->find($path);
-		$storage = $mount->getStorage();
-		$internalPath = $mount->getInternalPath($path);
-		if ($storage) {
-			$data = $this->getCacheEntry($storage, $internalPath, $relativePath);
-
-			if (!$data instanceof ICacheEntry) {
-				return false;
-			}
-
-			if ($mount instanceof MoveableMount && $internalPath === '') {
-				$data['permissions'] |= \OCP\Constants::PERMISSION_DELETE;
-			}
-
-			$owner = $this->getUserObjectForOwner($storage->getOwner($internalPath));
-			$info = new FileInfo($path, $storage, $internalPath, $data, $mount, $owner);
-
-			if ($data and isset($data['fileid'])) {
-				if ($includeMountPoints and $data['mimetype'] === 'httpd/unix-directory') {
-					//add the sizes of other mount points to the folder
-					$extOnly = ($includeMountPoints === 'ext');
-					$mounts = Filesystem::getMountManager()->findIn($path);
-					$info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) {
-						$subStorage = $mount->getStorage();
-						return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage);
-					}));
-				}
-			}
-
-			return $info;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get the content of a directory
-	 *
-	 * @param string $directory path under datadirectory
-	 * @param string $mimetype_filter limit returned content to this mimetype or mimepart
-	 * @return FileInfo[]
-	 */
-	public function getDirectoryContent($directory, $mimetype_filter = '') {
-		$this->assertPathLength($directory);
-		if (!Filesystem::isValidPath($directory)) {
-			return [];
-		}
-		$path = $this->getAbsolutePath($directory);
-		$path = Filesystem::normalizePath($path);
-		$mount = $this->getMount($directory);
-		$storage = $mount->getStorage();
-		$internalPath = $mount->getInternalPath($path);
-		if ($storage) {
-			$cache = $storage->getCache($internalPath);
-			$user = \OC_User::getUser();
-
-			$data = $this->getCacheEntry($storage, $internalPath, $directory);
-
-			if (!$data instanceof ICacheEntry || !isset($data['fileid']) || !($data->getPermissions() && Constants::PERMISSION_READ)) {
-				return [];
-			}
-
-			$folderId = $data['fileid'];
-			$contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
-
-			$sharingDisabled = \OCP\Util::isSharingDisabledForUser();
-			/**
-			 * @var \OC\Files\FileInfo[] $files
-			 */
-			$files = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
-				if ($sharingDisabled) {
-					$content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
-				}
-				$owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
-				return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
-			}, $contents);
-
-			//add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
-			$mounts = Filesystem::getMountManager()->findIn($path);
-			$dirLength = strlen($path);
-			foreach ($mounts as $mount) {
-				$mountPoint = $mount->getMountPoint();
-				$subStorage = $mount->getStorage();
-				if ($subStorage) {
-					$subCache = $subStorage->getCache('');
-
-					$rootEntry = $subCache->get('');
-					if (!$rootEntry) {
-						$subScanner = $subStorage->getScanner('');
-						try {
-							$subScanner->scanFile('');
-						} catch (\OCP\Files\StorageNotAvailableException $e) {
-							continue;
-						} catch (\OCP\Files\StorageInvalidException $e) {
-							continue;
-						} catch (\Exception $e) {
-							// sometimes when the storage is not available it can be any exception
-							\OCP\Util::writeLog(
-								'core',
-								'Exception while scanning storage "' . $subStorage->getId() . '": ' .
-								get_class($e) . ': ' . $e->getMessage(),
-								\OCP\Util::ERROR
-							);
-							continue;
-						}
-						$rootEntry = $subCache->get('');
-					}
-
-					if ($rootEntry && ($rootEntry->getPermissions() && Constants::PERMISSION_READ)) {
-						$relativePath = trim(substr($mountPoint, $dirLength), '/');
-						if ($pos = strpos($relativePath, '/')) {
-							//mountpoint inside subfolder add size to the correct folder
-							$entryName = substr($relativePath, 0, $pos);
-							foreach ($files as &$entry) {
-								if ($entry->getName() === $entryName) {
-									$entry->addSubEntry($rootEntry, $mountPoint);
-								}
-							}
-						} else { //mountpoint in this folder, add an entry for it
-							$rootEntry['name'] = $relativePath;
-							$rootEntry['type'] = $rootEntry['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file';
-							$permissions = $rootEntry['permissions'];
-							// do not allow renaming/deleting the mount point if they are not shared files/folders
-							// for shared files/folders we use the permissions given by the owner
-							if ($mount instanceof MoveableMount) {
-								$rootEntry['permissions'] = $permissions | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE;
-							} else {
-								$rootEntry['permissions'] = $permissions & (\OCP\Constants::PERMISSION_ALL - (\OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE));
-							}
-
-							//remove any existing entry with the same name
-							foreach ($files as $i => $file) {
-								if ($file['name'] === $rootEntry['name']) {
-									unset($files[$i]);
-									break;
-								}
-							}
-							$rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
-
-							// if sharing was disabled for the user we remove the share permissions
-							if (\OCP\Util::isSharingDisabledForUser()) {
-								$rootEntry['permissions'] = $rootEntry['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
-							}
-
-							$owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
-							$files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
-						}
-					}
-				}
-			}
-
-			if ($mimetype_filter) {
-				$files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) {
-					if (strpos($mimetype_filter, '/')) {
-						return $file->getMimetype() === $mimetype_filter;
-					} else {
-						return $file->getMimePart() === $mimetype_filter;
-					}
-				});
-			}
-
-			return $files;
-		} else {
-			return [];
-		}
-	}
-
-	/**
-	 * change file metadata
-	 *
-	 * @param string $path
-	 * @param array|\OCP\Files\FileInfo $data
-	 * @return int
-	 *
-	 * returns the fileid of the updated file
-	 */
-	public function putFileInfo($path, $data) {
-		$this->assertPathLength($path);
-		if ($data instanceof FileInfo) {
-			$data = $data->getData();
-		}
-		$path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
-		/**
-		 * @var \OC\Files\Storage\Storage $storage
-		 * @var string $internalPath
-		 */
-		list($storage, $internalPath) = Filesystem::resolvePath($path);
-		if ($storage) {
-			$cache = $storage->getCache($path);
-
-			if (!$cache->inCache($internalPath)) {
-				$scanner = $storage->getScanner($internalPath);
-				$scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
-			}
-
-			return $cache->put($internalPath, $data);
-		} else {
-			return -1;
-		}
-	}
-
-	/**
-	 * search for files with the name matching $query
-	 *
-	 * @param string $query
-	 * @return FileInfo[]
-	 */
-	public function search($query) {
-		return $this->searchCommon('search', array('%' . $query . '%'));
-	}
-
-	/**
-	 * search for files with the name matching $query
-	 *
-	 * @param string $query
-	 * @return FileInfo[]
-	 */
-	public function searchRaw($query) {
-		return $this->searchCommon('search', array($query));
-	}
-
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype
-	 * @return FileInfo[]
-	 */
-	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 FileInfo[]
-	 */
-	public function searchByTag($tag, $userId) {
-		return $this->searchCommon('searchByTag', array($tag, $userId));
-	}
-
-	/**
-	 * @param string $method cache method
-	 * @param array $args
-	 * @return FileInfo[]
-	 */
-	private function searchCommon($method, $args) {
-		$files = array();
-		$rootLength = strlen($this->fakeRoot);
-
-		$mount = $this->getMount('');
-		$mountPoint = $mount->getMountPoint();
-		$storage = $mount->getStorage();
-		if ($storage) {
-			$cache = $storage->getCache('');
-
-			$results = call_user_func_array(array($cache, $method), $args);
-			foreach ($results as $result) {
-				if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
-					$internalPath = $result['path'];
-					$path = $mountPoint . $result['path'];
-					$result['path'] = substr($mountPoint . $result['path'], $rootLength);
-					$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
-					$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
-				}
-			}
-
-			$mounts = Filesystem::getMountManager()->findIn($this->fakeRoot);
-			foreach ($mounts as $mount) {
-				$mountPoint = $mount->getMountPoint();
-				$storage = $mount->getStorage();
-				if ($storage) {
-					$cache = $storage->getCache('');
-
-					$relativeMountPoint = substr($mountPoint, $rootLength);
-					$results = call_user_func_array(array($cache, $method), $args);
-					if ($results) {
-						foreach ($results as $result) {
-							$internalPath = $result['path'];
-							$result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
-							$path = rtrim($mountPoint . $internalPath, '/');
-							$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
-							$files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
-						}
-					}
-				}
-			}
-		}
-		return $files;
-	}
-
-	/**
-	 * Get the owner for a file or folder
-	 *
-	 * @param string $path
-	 * @return string the user id of the owner
-	 * @throws NotFoundException
-	 */
-	public function getOwner($path) {
-		$info = $this->getFileInfo($path);
-		if (!$info) {
-			throw new NotFoundException($path . ' not found while trying to get owner');
-		}
-		return $info->getOwner()->getUID();
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getETag($path) {
-		/**
-		 * @var Storage\Storage $storage
-		 * @var string $internalPath
-		 */
-		list($storage, $internalPath) = $this->resolvePath($path);
-		if ($storage) {
-			return $storage->getETag($internalPath);
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Get the path of a file by id, relative to the view
-	 *
-	 * Note that the resulting path is not guarantied to be unique for the id, multiple paths can point to the same file
-	 *
-	 * @param int $id
-	 * @throws NotFoundException
-	 * @return string
-	 */
-	public function getPath($id) {
-		$id = (int)$id;
-		$manager = Filesystem::getMountManager();
-		$mounts = $manager->findIn($this->fakeRoot);
-		$mounts[] = $manager->find($this->fakeRoot);
-		// reverse the array so we start with the storage this view is in
-		// which is the most likely to contain the file we're looking for
-		$mounts = array_reverse($mounts);
-		foreach ($mounts as $mount) {
-			/**
-			 * @var \OC\Files\Mount\MountPoint $mount
-			 */
-			if ($mount->getStorage()) {
-				$cache = $mount->getStorage()->getCache();
-				$internalPath = $cache->getPathById($id);
-				if (is_string($internalPath)) {
-					$fullPath = $mount->getMountPoint() . $internalPath;
-					if (!is_null($path = $this->getRelativePath($fullPath))) {
-						return $path;
-					}
-				}
-			}
-		}
-		throw new NotFoundException(sprintf('File with id "%s" has not been found.', $id));
-	}
-
-	/**
-	 * @param string $path
-	 * @throws InvalidPathException
-	 */
-	private function assertPathLength($path) {
-		$maxLen = min(PHP_MAXPATHLEN, 4000);
-		// Check for the string length - performed using isset() instead of strlen()
-		// because isset() is about 5x-40x faster.
-		if (isset($path[$maxLen])) {
-			$pathLen = strlen($path);
-			throw new \OCP\Files\InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
-		}
-	}
-
-	/**
-	 * check if it is allowed to move a mount point to a given target.
-	 * It is not allowed to move a mount point into a different mount point or
-	 * into an already shared folder
-	 *
-	 * @param string $target path
-	 * @return boolean
-	 */
-	private function isTargetAllowed($target) {
-
-		list($targetStorage, $targetInternalPath) = \OC\Files\Filesystem::resolvePath($target);
-		if (!$targetStorage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
-			\OCP\Util::writeLog('files',
-				'It is not allowed to move one mount point into another one',
-				\OCP\Util::DEBUG);
-			return false;
-		}
-
-		// note: cannot use the view because the target is already locked
-		$fileId = (int)$targetStorage->getCache()->getId($targetInternalPath);
-		if ($fileId === -1) {
-			// target might not exist, need to check parent instead
-			$fileId = (int)$targetStorage->getCache()->getId(dirname($targetInternalPath));
-		}
-
-		// check if any of the parents were shared by the current owner (include collections)
-		$shares = \OCP\Share::getItemShared(
-			'folder',
-			$fileId,
-			\OCP\Share::FORMAT_NONE,
-			null,
-			true
-		);
-
-		if (count($shares) > 0) {
-			\OCP\Util::writeLog('files',
-				'It is not allowed to move one mount point into a shared folder',
-				\OCP\Util::DEBUG);
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get a fileinfo object for files that are ignored in the cache (part files)
-	 *
-	 * @param string $path
-	 * @return \OCP\Files\FileInfo
-	 */
-	private function getPartFileInfo($path) {
-		$mount = $this->getMount($path);
-		$storage = $mount->getStorage();
-		$internalPath = $mount->getInternalPath($this->getAbsolutePath($path));
-		$owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
-		return new FileInfo(
-			$this->getAbsolutePath($path),
-			$storage,
-			$internalPath,
-			[
-				'fileid' => null,
-				'mimetype' => $storage->getMimeType($internalPath),
-				'name' => basename($path),
-				'etag' => null,
-				'size' => $storage->filesize($internalPath),
-				'mtime' => $storage->filemtime($internalPath),
-				'encrypted' => false,
-				'permissions' => \OCP\Constants::PERMISSION_ALL
-			],
-			$mount,
-			$owner
-		);
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $fileName
-	 * @throws InvalidPathException
-	 */
-	public function verifyPath($path, $fileName) {
-		try {
-			/** @type \OCP\Files\Storage $storage */
-			list($storage, $internalPath) = $this->resolvePath($path);
-			$storage->verifyPath($internalPath, $fileName);
-		} catch (ReservedWordException $ex) {
-			$l = \OC::$server->getL10N('lib');
-			throw new InvalidPathException($l->t('File name is a reserved word'));
-		} catch (InvalidCharacterInPathException $ex) {
-			$l = \OC::$server->getL10N('lib');
-			throw new InvalidPathException($l->t('File name contains at least one invalid character'));
-		} catch (FileNameTooLongException $ex) {
-			$l = \OC::$server->getL10N('lib');
-			throw new InvalidPathException($l->t('File name is too long'));
-		} catch (InvalidDirectoryException $ex) {
-			$l = \OC::$server->getL10N('lib');
-			throw new InvalidPathException($l->t('Dot files are not allowed'));
-		} catch (EmptyFileNameException $ex) {
-			$l = \OC::$server->getL10N('lib');
-			throw new InvalidPathException($l->t('Empty filename is not allowed'));
-		}
-	}
-
-	/**
-	 * get all parent folders of $path
-	 *
-	 * @param string $path
-	 * @return string[]
-	 */
-	private function getParents($path) {
-		$path = trim($path, '/');
-		if (!$path) {
-			return [];
-		}
-
-		$parts = explode('/', $path);
-
-		// remove the single file
-		array_pop($parts);
-		$result = array('/');
-		$resultPath = '';
-		foreach ($parts as $part) {
-			if ($part) {
-				$resultPath .= '/' . $part;
-				$result[] = $resultPath;
-			}
-		}
-		return $result;
-	}
-
-	/**
-	 * Returns the mount point for which to lock
-	 *
-	 * @param string $absolutePath absolute path
-	 * @param bool $useParentMount true to return parent mount instead of whatever
-	 * is mounted directly on the given path, false otherwise
-	 * @return \OC\Files\Mount\MountPoint mount point for which to apply locks
-	 */
-	private function getMountForLock($absolutePath, $useParentMount = false) {
-		$results = [];
-		$mount = Filesystem::getMountManager()->find($absolutePath);
-		if (!$mount) {
-			return $results;
-		}
-
-		if ($useParentMount) {
-			// find out if something is mounted directly on the path
-			$internalPath = $mount->getInternalPath($absolutePath);
-			if ($internalPath === '') {
-				// resolve the parent mount instead
-				$mount = Filesystem::getMountManager()->find(dirname($absolutePath));
-			}
-		}
-
-		return $mount;
-	}
-
-	/**
-	 * Lock the given path
-	 *
-	 * @param string $path the path of the file to lock, relative to the view
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
-	 *
-	 * @return bool False if the path is excluded from locking, true otherwise
-	 * @throws \OCP\Lock\LockedException if the path is already locked
-	 */
-	private function lockPath($path, $type, $lockMountPoint = false) {
-		$absolutePath = $this->getAbsolutePath($path);
-		$absolutePath = Filesystem::normalizePath($absolutePath);
-		if (!$this->shouldLockFile($absolutePath)) {
-			return false;
-		}
-
-		$mount = $this->getMountForLock($absolutePath, $lockMountPoint);
-		if ($mount) {
-			try {
-				$storage = $mount->getStorage();
-				if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-					$storage->acquireLock(
-						$mount->getInternalPath($absolutePath),
-						$type,
-						$this->lockingProvider
-					);
-				}
-			} catch (\OCP\Lock\LockedException $e) {
-				// rethrow with the a human-readable path
-				throw new \OCP\Lock\LockedException(
-					$this->getPathRelativeToFiles($absolutePath),
-					$e
-				);
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Change the lock type
-	 *
-	 * @param string $path the path of the file to lock, relative to the view
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
-	 *
-	 * @return bool False if the path is excluded from locking, true otherwise
-	 * @throws \OCP\Lock\LockedException if the path is already locked
-	 */
-	public function changeLock($path, $type, $lockMountPoint = false) {
-		$path = Filesystem::normalizePath($path);
-		$absolutePath = $this->getAbsolutePath($path);
-		$absolutePath = Filesystem::normalizePath($absolutePath);
-		if (!$this->shouldLockFile($absolutePath)) {
-			return false;
-		}
-
-		$mount = $this->getMountForLock($absolutePath, $lockMountPoint);
-		if ($mount) {
-			try {
-				$storage = $mount->getStorage();
-				if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-					$storage->changeLock(
-						$mount->getInternalPath($absolutePath),
-						$type,
-						$this->lockingProvider
-					);
-				}
-			} catch (\OCP\Lock\LockedException $e) {
-				try {
-					// rethrow with the a human-readable path
-					throw new \OCP\Lock\LockedException(
-						$this->getPathRelativeToFiles($absolutePath),
-						$e
-					);
-				} catch (\InvalidArgumentException $e) {
-					throw new \OCP\Lock\LockedException(
-						$absolutePath,
-						$e
-					);
-				}
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Unlock the given path
-	 *
-	 * @param string $path the path of the file to unlock, relative to the view
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
-	 *
-	 * @return bool False if the path is excluded from locking, true otherwise
-	 */
-	private function unlockPath($path, $type, $lockMountPoint = false) {
-		$absolutePath = $this->getAbsolutePath($path);
-		$absolutePath = Filesystem::normalizePath($absolutePath);
-		if (!$this->shouldLockFile($absolutePath)) {
-			return false;
-		}
-
-		$mount = $this->getMountForLock($absolutePath, $lockMountPoint);
-		if ($mount) {
-			$storage = $mount->getStorage();
-			if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-				$storage->releaseLock(
-					$mount->getInternalPath($absolutePath),
-					$type,
-					$this->lockingProvider
-				);
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Lock a path and all its parents up to the root of the view
-	 *
-	 * @param string $path the path of the file to lock relative to the view
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
-	 *
-	 * @return bool False if the path is excluded from locking, true otherwise
-	 */
-	public function lockFile($path, $type, $lockMountPoint = false) {
-		$absolutePath = $this->getAbsolutePath($path);
-		$absolutePath = Filesystem::normalizePath($absolutePath);
-		if (!$this->shouldLockFile($absolutePath)) {
-			return false;
-		}
-
-		$this->lockPath($path, $type, $lockMountPoint);
-
-		$parents = $this->getParents($path);
-		foreach ($parents as $parent) {
-			$this->lockPath($parent, ILockingProvider::LOCK_SHARED);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Unlock a path and all its parents up to the root of the view
-	 *
-	 * @param string $path the path of the file to lock relative to the view
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
-	 *
-	 * @return bool False if the path is excluded from locking, true otherwise
-	 */
-	public function unlockFile($path, $type, $lockMountPoint = false) {
-		$absolutePath = $this->getAbsolutePath($path);
-		$absolutePath = Filesystem::normalizePath($absolutePath);
-		if (!$this->shouldLockFile($absolutePath)) {
-			return false;
-		}
-
-		$this->unlockPath($path, $type, $lockMountPoint);
-
-		$parents = $this->getParents($path);
-		foreach ($parents as $parent) {
-			$this->unlockPath($parent, ILockingProvider::LOCK_SHARED);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Only lock files in data/user/files/
-	 *
-	 * @param string $path Absolute path to the file/folder we try to (un)lock
-	 * @return bool
-	 */
-	protected function shouldLockFile($path) {
-		$path = Filesystem::normalizePath($path);
-
-		$pathSegments = explode('/', $path);
-		if (isset($pathSegments[2])) {
-			// E.g.: /username/files/path-to-file
-			return ($pathSegments[2] === 'files') && (count($pathSegments) > 3);
-		}
-
-		return strpos($path, '/appdata_') !== 0;
-	}
-
-	/**
-	 * Shortens the given absolute path to be relative to
-	 * "$user/files".
-	 *
-	 * @param string $absolutePath absolute path which is under "files"
-	 *
-	 * @return string path relative to "files" with trimmed slashes or null
-	 * if the path was NOT relative to files
-	 *
-	 * @throws \InvalidArgumentException if the given path was not under "files"
-	 * @since 8.1.0
-	 */
-	public function getPathRelativeToFiles($absolutePath) {
-		$path = Filesystem::normalizePath($absolutePath);
-		$parts = explode('/', trim($path, '/'), 3);
-		// "$user", "files", "path/to/dir"
-		if (!isset($parts[1]) || $parts[1] !== 'files') {
-			$this->logger->error(
-				'$absolutePath must be relative to "files", value is "%s"',
-				[
-					$absolutePath
-				]
-			);
-			throw new \InvalidArgumentException('$absolutePath must be relative to "files"');
-		}
-		if (isset($parts[2])) {
-			return $parts[2];
-		}
-		return '';
-	}
-
-	/**
-	 * @param string $filename
-	 * @return array
-	 * @throws \OC\User\NoUserException
-	 * @throws NotFoundException
-	 */
-	public function getUidAndFilename($filename) {
-		$info = $this->getFileInfo($filename);
-		if (!$info instanceof \OCP\Files\FileInfo) {
-			throw new NotFoundException($this->getAbsolutePath($filename) . ' not found');
-		}
-		$uid = $info->getOwner()->getUID();
-		if ($uid != \OCP\User::getUser()) {
-			Filesystem::initMountPoints($uid);
-			$ownerView = new View('/' . $uid . '/files');
-			try {
-				$filename = $ownerView->getPath($info['fileid']);
-			} catch (NotFoundException $e) {
-				throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid);
-			}
-		}
-		return [$uid, $filename];
-	}
-
-	/**
-	 * Creates parent non-existing folders
-	 *
-	 * @param string $filePath
-	 * @return bool
-	 */
-	private function createParentDirectories($filePath) {
-		$directoryParts = explode('/', $filePath);
-		$directoryParts = array_filter($directoryParts);
-		foreach ($directoryParts as $key => $part) {
-			$currentPathElements = array_slice($directoryParts, 0, $key);
-			$currentPath = '/' . implode('/', $currentPathElements);
-			if ($this->is_file($currentPath)) {
-				return false;
-			}
-			if (!$this->file_exists($currentPath)) {
-				$this->mkdir($currentPath);
-			}
-		}
-
-		return true;
-	}
+    /** @var string */
+    private $fakeRoot = '';
+
+    /**
+     * @var \OCP\Lock\ILockingProvider
+     */
+    protected $lockingProvider;
+
+    private $lockingEnabled;
+
+    private $updaterEnabled = true;
+
+    /** @var \OC\User\Manager */
+    private $userManager;
+
+    /** @var \OCP\ILogger */
+    private $logger;
+
+    /**
+     * @param string $root
+     * @throws \Exception If $root contains an invalid path
+     */
+    public function __construct($root = '') {
+        if (is_null($root)) {
+            throw new \InvalidArgumentException('Root can\'t be null');
+        }
+        if (!Filesystem::isValidPath($root)) {
+            throw new \Exception();
+        }
+
+        $this->fakeRoot = $root;
+        $this->lockingProvider = \OC::$server->getLockingProvider();
+        $this->lockingEnabled = !($this->lockingProvider instanceof \OC\Lock\NoopLockingProvider);
+        $this->userManager = \OC::$server->getUserManager();
+        $this->logger = \OC::$server->getLogger();
+    }
+
+    public function getAbsolutePath($path = '/') {
+        if ($path === null) {
+            return null;
+        }
+        $this->assertPathLength($path);
+        if ($path === '') {
+            $path = '/';
+        }
+        if ($path[0] !== '/') {
+            $path = '/' . $path;
+        }
+        return $this->fakeRoot . $path;
+    }
+
+    /**
+     * change the root to a fake root
+     *
+     * @param string $fakeRoot
+     * @return boolean|null
+     */
+    public function chroot($fakeRoot) {
+        if (!$fakeRoot == '') {
+            if ($fakeRoot[0] !== '/') {
+                $fakeRoot = '/' . $fakeRoot;
+            }
+        }
+        $this->fakeRoot = $fakeRoot;
+    }
+
+    /**
+     * get the fake root
+     *
+     * @return string
+     */
+    public function getRoot() {
+        return $this->fakeRoot;
+    }
+
+    /**
+     * get path relative to the root of the view
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getRelativePath($path) {
+        $this->assertPathLength($path);
+        if ($this->fakeRoot == '') {
+            return $path;
+        }
+
+        if (rtrim($path, '/') === rtrim($this->fakeRoot, '/')) {
+            return '/';
+        }
+
+        // missing slashes can cause wrong matches!
+        $root = rtrim($this->fakeRoot, '/') . '/';
+
+        if (strpos($path, $root) !== 0) {
+            return null;
+        } else {
+            $path = substr($path, strlen($this->fakeRoot));
+            if (strlen($path) === 0) {
+                return '/';
+            } else {
+                return $path;
+            }
+        }
+    }
+
+    /**
+     * get the mountpoint of the storage object for a path
+     * ( note: because a storage is not always mounted inside the fakeroot, the
+     * returned mountpoint is relative to the absolute root of the filesystem
+     * and does not take the chroot into account )
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getMountPoint($path) {
+        return Filesystem::getMountPoint($this->getAbsolutePath($path));
+    }
+
+    /**
+     * get the mountpoint of the storage object for a path
+     * ( note: because a storage is not always mounted inside the fakeroot, the
+     * returned mountpoint is relative to the absolute root of the filesystem
+     * and does not take the chroot into account )
+     *
+     * @param string $path
+     * @return \OCP\Files\Mount\IMountPoint
+     */
+    public function getMount($path) {
+        return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
+    }
+
+    /**
+     * resolve a path to a storage and internal path
+     *
+     * @param string $path
+     * @return array an array consisting of the storage and the internal path
+     */
+    public function resolvePath($path) {
+        $a = $this->getAbsolutePath($path);
+        $p = Filesystem::normalizePath($a);
+        return Filesystem::resolvePath($p);
+    }
+
+    /**
+     * return the path to a local version of the file
+     * we need this because we can't know if a file is stored local or not from
+     * outside the filestorage and for some purposes a local file is needed
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getLocalFile($path) {
+        $parent = substr($path, 0, strrpos($path, '/'));
+        $path = $this->getAbsolutePath($path);
+        list($storage, $internalPath) = Filesystem::resolvePath($path);
+        if (Filesystem::isValidPath($parent) and $storage) {
+            return $storage->getLocalFile($internalPath);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    public function getLocalFolder($path) {
+        $parent = substr($path, 0, strrpos($path, '/'));
+        $path = $this->getAbsolutePath($path);
+        list($storage, $internalPath) = Filesystem::resolvePath($path);
+        if (Filesystem::isValidPath($parent) and $storage) {
+            return $storage->getLocalFolder($internalPath);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * the following functions operate with arguments and return values identical
+     * to those of their PHP built-in equivalents. Mostly they are merely wrappers
+     * for \OC\Files\Storage\Storage via basicOperation().
+     */
+    public function mkdir($path) {
+        return $this->basicOperation('mkdir', $path, array('create', 'write'));
+    }
+
+    /**
+     * remove mount point
+     *
+     * @param \OC\Files\Mount\MoveableMount $mount
+     * @param string $path relative to data/
+     * @return boolean
+     */
+    protected function removeMount($mount, $path) {
+        if ($mount instanceof MoveableMount) {
+            // cut of /user/files to get the relative path to data/user/files
+            $pathParts = explode('/', $path, 4);
+            $relPath = '/' . $pathParts[3];
+            $this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true);
+            \OC_Hook::emit(
+                Filesystem::CLASSNAME, "umount",
+                array(Filesystem::signal_param_path => $relPath)
+            );
+            $this->changeLock($relPath, ILockingProvider::LOCK_EXCLUSIVE, true);
+            $result = $mount->removeMount();
+            $this->changeLock($relPath, ILockingProvider::LOCK_SHARED, true);
+            if ($result) {
+                \OC_Hook::emit(
+                    Filesystem::CLASSNAME, "post_umount",
+                    array(Filesystem::signal_param_path => $relPath)
+                );
+            }
+            $this->unlockFile($relPath, ILockingProvider::LOCK_SHARED, true);
+            return $result;
+        } else {
+            // do not allow deleting the storage's root / the mount point
+            // because for some storages it might delete the whole contents
+            // but isn't supposed to work that way
+            return false;
+        }
+    }
+
+    public function disableCacheUpdate() {
+        $this->updaterEnabled = false;
+    }
+
+    public function enableCacheUpdate() {
+        $this->updaterEnabled = true;
+    }
+
+    protected function writeUpdate(Storage $storage, $internalPath, $time = null) {
+        if ($this->updaterEnabled) {
+            if (is_null($time)) {
+                $time = time();
+            }
+            $storage->getUpdater()->update($internalPath, $time);
+        }
+    }
+
+    protected function removeUpdate(Storage $storage, $internalPath) {
+        if ($this->updaterEnabled) {
+            $storage->getUpdater()->remove($internalPath);
+        }
+    }
+
+    protected function renameUpdate(Storage $sourceStorage, Storage $targetStorage, $sourceInternalPath, $targetInternalPath) {
+        if ($this->updaterEnabled) {
+            $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return bool|mixed
+     */
+    public function rmdir($path) {
+        $absolutePath = $this->getAbsolutePath($path);
+        $mount = Filesystem::getMountManager()->find($absolutePath);
+        if ($mount->getInternalPath($absolutePath) === '') {
+            return $this->removeMount($mount, $absolutePath);
+        }
+        if ($this->is_dir($path)) {
+            $result = $this->basicOperation('rmdir', $path, array('delete'));
+        } else {
+            $result = false;
+        }
+
+        if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
+            $storage = $mount->getStorage();
+            $internalPath = $mount->getInternalPath($absolutePath);
+            $storage->getUpdater()->remove($internalPath);
+        }
+        return $result;
+    }
+
+    /**
+     * @param string $path
+     * @return resource
+     */
+    public function opendir($path) {
+        return $this->basicOperation('opendir', $path, array('read'));
+    }
+
+    /**
+     * @param string $path
+     * @return bool|mixed
+     */
+    public function is_dir($path) {
+        if ($path == '/') {
+            return true;
+        }
+        return $this->basicOperation('is_dir', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return bool|mixed
+     */
+    public function is_file($path) {
+        if ($path == '/') {
+            return false;
+        }
+        return $this->basicOperation('is_file', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function stat($path) {
+        return $this->basicOperation('stat', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function filetype($path) {
+        return $this->basicOperation('filetype', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function filesize($path) {
+        return $this->basicOperation('filesize', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return bool|mixed
+     * @throws \OCP\Files\InvalidPathException
+     */
+    public function readfile($path) {
+        $this->assertPathLength($path);
+        @ob_end_clean();
+        $handle = $this->fopen($path, 'rb');
+        if ($handle) {
+            $chunkSize = 8192; // 8 kB chunks
+            while (!feof($handle)) {
+                echo fread($handle, $chunkSize);
+                flush();
+            }
+            fclose($handle);
+            $size = $this->filesize($path);
+            return $size;
+        }
+        return false;
+    }
+
+    /**
+     * @param string $path
+     * @param int $from
+     * @param int $to
+     * @return bool|mixed
+     * @throws \OCP\Files\InvalidPathException
+     * @throws \OCP\Files\UnseekableException
+     */
+    public function readfilePart($path, $from, $to) {
+        $this->assertPathLength($path);
+        @ob_end_clean();
+        $handle = $this->fopen($path, 'rb');
+        if ($handle) {
+            if (fseek($handle, $from) === 0) {
+                $chunkSize = 8192; // 8 kB chunks
+                $end = $to + 1;
+                while (!feof($handle) && ftell($handle) < $end) {
+                    $len = $end - ftell($handle);
+                    if ($len > $chunkSize) {
+                        $len = $chunkSize;
+                    }
+                    echo fread($handle, $len);
+                    flush();
+                }
+                $size = ftell($handle) - $from;
+                return $size;
+            }
+
+            throw new \OCP\Files\UnseekableException('fseek error');
+        }
+        return false;
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function isCreatable($path) {
+        return $this->basicOperation('isCreatable', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function isReadable($path) {
+        return $this->basicOperation('isReadable', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function isUpdatable($path) {
+        return $this->basicOperation('isUpdatable', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return bool|mixed
+     */
+    public function isDeletable($path) {
+        $absolutePath = $this->getAbsolutePath($path);
+        $mount = Filesystem::getMountManager()->find($absolutePath);
+        if ($mount->getInternalPath($absolutePath) === '') {
+            return $mount instanceof MoveableMount;
+        }
+        return $this->basicOperation('isDeletable', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function isSharable($path) {
+        return $this->basicOperation('isSharable', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return bool|mixed
+     */
+    public function file_exists($path) {
+        if ($path == '/') {
+            return true;
+        }
+        return $this->basicOperation('file_exists', $path);
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function filemtime($path) {
+        return $this->basicOperation('filemtime', $path);
+    }
+
+    /**
+     * @param string $path
+     * @param int|string $mtime
+     * @return bool
+     */
+    public function touch($path, $mtime = null) {
+        if (!is_null($mtime) and !is_numeric($mtime)) {
+            $mtime = strtotime($mtime);
+        }
+
+        $hooks = array('touch');
+
+        if (!$this->file_exists($path)) {
+            $hooks[] = 'create';
+            $hooks[] = 'write';
+        }
+        $result = $this->basicOperation('touch', $path, $hooks, $mtime);
+        if (!$result) {
+            // If create file fails because of permissions on external storage like SMB folders,
+            // check file exists and return false if not.
+            if (!$this->file_exists($path)) {
+                return false;
+            }
+            if (is_null($mtime)) {
+                $mtime = time();
+            }
+            //if native touch fails, we emulate it by changing the mtime in the cache
+            $this->putFileInfo($path, array('mtime' => floor($mtime)));
+        }
+        return true;
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    public function file_get_contents($path) {
+        return $this->basicOperation('file_get_contents', $path, array('read'));
+    }
+
+    /**
+     * @param bool $exists
+     * @param string $path
+     * @param bool $run
+     */
+    protected function emit_file_hooks_pre($exists, $path, &$run) {
+        if (!$exists) {
+            \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, array(
+                Filesystem::signal_param_path => $this->getHookPath($path),
+                Filesystem::signal_param_run => &$run,
+            ));
+        } else {
+            \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, array(
+                Filesystem::signal_param_path => $this->getHookPath($path),
+                Filesystem::signal_param_run => &$run,
+            ));
+        }
+        \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, array(
+            Filesystem::signal_param_path => $this->getHookPath($path),
+            Filesystem::signal_param_run => &$run,
+        ));
+    }
+
+    /**
+     * @param bool $exists
+     * @param string $path
+     */
+    protected function emit_file_hooks_post($exists, $path) {
+        if (!$exists) {
+            \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, array(
+                Filesystem::signal_param_path => $this->getHookPath($path),
+            ));
+        } else {
+            \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_update, array(
+                Filesystem::signal_param_path => $this->getHookPath($path),
+            ));
+        }
+        \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_write, array(
+            Filesystem::signal_param_path => $this->getHookPath($path),
+        ));
+    }
+
+    /**
+     * @param string $path
+     * @param mixed $data
+     * @return bool|mixed
+     * @throws \Exception
+     */
+    public function file_put_contents($path, $data) {
+        if (is_resource($data)) { //not having to deal with streams in file_put_contents makes life easier
+            $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
+            if (Filesystem::isValidPath($path)
+                and !Filesystem::isFileBlacklisted($path)
+            ) {
+                $path = $this->getRelativePath($absolutePath);
+
+                $this->lockFile($path, ILockingProvider::LOCK_SHARED);
+
+                $exists = $this->file_exists($path);
+                $run = true;
+                if ($this->shouldEmitHooks($path)) {
+                    $this->emit_file_hooks_pre($exists, $path, $run);
+                }
+                if (!$run) {
+                    $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
+                    return false;
+                }
+
+                $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
+
+                /** @var \OC\Files\Storage\Storage $storage */
+                list($storage, $internalPath) = $this->resolvePath($path);
+                $target = $storage->fopen($internalPath, 'w');
+                if ($target) {
+                    list (, $result) = \OC_Helper::streamCopy($data, $target);
+                    fclose($target);
+                    fclose($data);
+
+                    $this->writeUpdate($storage, $internalPath);
+
+                    $this->changeLock($path, ILockingProvider::LOCK_SHARED);
+
+                    if ($this->shouldEmitHooks($path) && $result !== false) {
+                        $this->emit_file_hooks_post($exists, $path);
+                    }
+                    $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
+                    return $result;
+                } else {
+                    $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
+                    return false;
+                }
+            } else {
+                return false;
+            }
+        } else {
+            $hooks = ($this->file_exists($path)) ? array('update', 'write') : array('create', 'write');
+            return $this->basicOperation('file_put_contents', $path, $hooks, $data);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return bool|mixed
+     */
+    public function unlink($path) {
+        if ($path === '' || $path === '/') {
+            // do not allow deleting the root
+            return false;
+        }
+        $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
+        $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
+        $mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
+        if ($mount and $mount->getInternalPath($absolutePath) === '') {
+            return $this->removeMount($mount, $absolutePath);
+        }
+        if ($this->is_dir($path)) {
+            $result = $this->basicOperation('rmdir', $path, ['delete']);
+        } else {
+            $result = $this->basicOperation('unlink', $path, ['delete']);
+        }
+        if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
+            $storage = $mount->getStorage();
+            $internalPath = $mount->getInternalPath($absolutePath);
+            $storage->getUpdater()->remove($internalPath);
+            return true;
+        } else {
+            return $result;
+        }
+    }
+
+    /**
+     * @param string $directory
+     * @return bool|mixed
+     */
+    public function deleteAll($directory) {
+        return $this->rmdir($directory);
+    }
+
+    /**
+     * Rename/move a file or folder from the source path to target path.
+     *
+     * @param string $path1 source path
+     * @param string $path2 target path
+     *
+     * @return bool|mixed
+     */
+    public function rename($path1, $path2) {
+        $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
+        $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
+        $result = false;
+        if (
+            Filesystem::isValidPath($path2)
+            and Filesystem::isValidPath($path1)
+            and !Filesystem::isFileBlacklisted($path2)
+        ) {
+            $path1 = $this->getRelativePath($absolutePath1);
+            $path2 = $this->getRelativePath($absolutePath2);
+            $exists = $this->file_exists($path2);
+
+            if ($path1 == null or $path2 == null) {
+                return false;
+            }
+
+            $this->lockFile($path1, ILockingProvider::LOCK_SHARED, true);
+            try {
+                $this->lockFile($path2, ILockingProvider::LOCK_SHARED, true);
+            } catch (LockedException $e) {
+                $this->unlockFile($path1, ILockingProvider::LOCK_SHARED);
+                throw $e;
+            }
+
+            $run = true;
+            if ($this->shouldEmitHooks($path1) && (Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2))) {
+                // if it was a rename from a part file to a regular file it was a write and not a rename operation
+                $this->emit_file_hooks_pre($exists, $path2, $run);
+            } elseif ($this->shouldEmitHooks($path1)) {
+                \OC_Hook::emit(
+                    Filesystem::CLASSNAME, Filesystem::signal_rename,
+                    array(
+                        Filesystem::signal_param_oldpath => $this->getHookPath($path1),
+                        Filesystem::signal_param_newpath => $this->getHookPath($path2),
+                        Filesystem::signal_param_run => &$run
+                    )
+                );
+            }
+            if ($run) {
+                $this->verifyPath(dirname($path2), basename($path2));
+
+                $manager = Filesystem::getMountManager();
+                $mount1 = $this->getMount($path1);
+                $mount2 = $this->getMount($path2);
+                $storage1 = $mount1->getStorage();
+                $storage2 = $mount2->getStorage();
+                $internalPath1 = $mount1->getInternalPath($absolutePath1);
+                $internalPath2 = $mount2->getInternalPath($absolutePath2);
+
+                $this->changeLock($path1, ILockingProvider::LOCK_EXCLUSIVE, true);
+                $this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE, true);
+
+                if ($internalPath1 === '') {
+                    if ($mount1 instanceof MoveableMount) {
+                        if ($this->isTargetAllowed($absolutePath2)) {
+                            /**
+                             * @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount1
+                             */
+                            $sourceMountPoint = $mount1->getMountPoint();
+                            $result = $mount1->moveMount($absolutePath2);
+                            $manager->moveMount($sourceMountPoint, $mount1->getMountPoint());
+                        } else {
+                            $result = false;
+                        }
+                    } else {
+                        $result = false;
+                    }
+                    // moving a file/folder within the same mount point
+                } elseif ($storage1 === $storage2) {
+                    if ($storage1) {
+                        $result = $storage1->rename($internalPath1, $internalPath2);
+                    } else {
+                        $result = false;
+                    }
+                    // moving a file/folder between storages (from $storage1 to $storage2)
+                } else {
+                    $result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
+                }
+
+                if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
+                    // if it was a rename from a part file to a regular file it was a write and not a rename operation
+
+                    $this->writeUpdate($storage2, $internalPath2);
+                } else if ($result) {
+                    if ($internalPath1 !== '') { // don't do a cache update for moved mounts
+                        $this->renameUpdate($storage1, $storage2, $internalPath1, $internalPath2);
+                    }
+                }
+
+                $this->changeLock($path1, ILockingProvider::LOCK_SHARED, true);
+                $this->changeLock($path2, ILockingProvider::LOCK_SHARED, true);
+
+                if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
+                    if ($this->shouldEmitHooks()) {
+                        $this->emit_file_hooks_post($exists, $path2);
+                    }
+                } elseif ($result) {
+                    if ($this->shouldEmitHooks($path1) and $this->shouldEmitHooks($path2)) {
+                        \OC_Hook::emit(
+                            Filesystem::CLASSNAME,
+                            Filesystem::signal_post_rename,
+                            array(
+                                Filesystem::signal_param_oldpath => $this->getHookPath($path1),
+                                Filesystem::signal_param_newpath => $this->getHookPath($path2)
+                            )
+                        );
+                    }
+                }
+            }
+            $this->unlockFile($path1, ILockingProvider::LOCK_SHARED, true);
+            $this->unlockFile($path2, ILockingProvider::LOCK_SHARED, true);
+        }
+        return $result;
+    }
+
+    /**
+     * Copy a file/folder from the source path to target path
+     *
+     * @param string $path1 source path
+     * @param string $path2 target path
+     * @param bool $preserveMtime whether to preserve mtime on the copy
+     *
+     * @return bool|mixed
+     */
+    public function copy($path1, $path2, $preserveMtime = false) {
+        $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
+        $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
+        $result = false;
+        if (
+            Filesystem::isValidPath($path2)
+            and Filesystem::isValidPath($path1)
+            and !Filesystem::isFileBlacklisted($path2)
+        ) {
+            $path1 = $this->getRelativePath($absolutePath1);
+            $path2 = $this->getRelativePath($absolutePath2);
+
+            if ($path1 == null or $path2 == null) {
+                return false;
+            }
+            $run = true;
+
+            $this->lockFile($path2, ILockingProvider::LOCK_SHARED);
+            $this->lockFile($path1, ILockingProvider::LOCK_SHARED);
+            $lockTypePath1 = ILockingProvider::LOCK_SHARED;
+            $lockTypePath2 = ILockingProvider::LOCK_SHARED;
+
+            try {
+
+                $exists = $this->file_exists($path2);
+                if ($this->shouldEmitHooks()) {
+                    \OC_Hook::emit(
+                        Filesystem::CLASSNAME,
+                        Filesystem::signal_copy,
+                        array(
+                            Filesystem::signal_param_oldpath => $this->getHookPath($path1),
+                            Filesystem::signal_param_newpath => $this->getHookPath($path2),
+                            Filesystem::signal_param_run => &$run
+                        )
+                    );
+                    $this->emit_file_hooks_pre($exists, $path2, $run);
+                }
+                if ($run) {
+                    $mount1 = $this->getMount($path1);
+                    $mount2 = $this->getMount($path2);
+                    $storage1 = $mount1->getStorage();
+                    $internalPath1 = $mount1->getInternalPath($absolutePath1);
+                    $storage2 = $mount2->getStorage();
+                    $internalPath2 = $mount2->getInternalPath($absolutePath2);
+
+                    $this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE);
+                    $lockTypePath2 = ILockingProvider::LOCK_EXCLUSIVE;
+
+                    if ($mount1->getMountPoint() == $mount2->getMountPoint()) {
+                        if ($storage1) {
+                            $result = $storage1->copy($internalPath1, $internalPath2);
+                        } else {
+                            $result = false;
+                        }
+                    } else {
+                        $result = $storage2->copyFromStorage($storage1, $internalPath1, $internalPath2);
+                    }
+
+                    $this->writeUpdate($storage2, $internalPath2);
+
+                    $this->changeLock($path2, ILockingProvider::LOCK_SHARED);
+                    $lockTypePath2 = ILockingProvider::LOCK_SHARED;
+
+                    if ($this->shouldEmitHooks() && $result !== false) {
+                        \OC_Hook::emit(
+                            Filesystem::CLASSNAME,
+                            Filesystem::signal_post_copy,
+                            array(
+                                Filesystem::signal_param_oldpath => $this->getHookPath($path1),
+                                Filesystem::signal_param_newpath => $this->getHookPath($path2)
+                            )
+                        );
+                        $this->emit_file_hooks_post($exists, $path2);
+                    }
+
+                }
+            } catch (\Exception $e) {
+                $this->unlockFile($path2, $lockTypePath2);
+                $this->unlockFile($path1, $lockTypePath1);
+                throw $e;
+            }
+
+            $this->unlockFile($path2, $lockTypePath2);
+            $this->unlockFile($path1, $lockTypePath1);
+
+        }
+        return $result;
+    }
+
+    /**
+     * @param string $path
+     * @param string $mode 'r' or 'w'
+     * @return resource
+     */
+    public function fopen($path, $mode) {
+        $mode = str_replace('b', '', $mode); // the binary flag is a windows only feature which we do not support
+        $hooks = array();
+        switch ($mode) {
+            case 'r':
+                $hooks[] = 'read';
+                break;
+            case 'r+':
+            case 'w+':
+            case 'x+':
+            case 'a+':
+                $hooks[] = 'read';
+                $hooks[] = 'write';
+                break;
+            case 'w':
+            case 'x':
+            case 'a':
+                $hooks[] = 'write';
+                break;
+            default:
+                \OCP\Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, \OCP\Util::ERROR);
+        }
+
+        if ($mode !== 'r' && $mode !== 'w') {
+            \OC::$server->getLogger()->info('Trying to open a file with a mode other than "r" or "w" can cause severe performance issues with some backends');
+        }
+
+        return $this->basicOperation('fopen', $path, $hooks, $mode);
+    }
+
+    /**
+     * @param string $path
+     * @return bool|string
+     * @throws \OCP\Files\InvalidPathException
+     */
+    public function toTmpFile($path) {
+        $this->assertPathLength($path);
+        if (Filesystem::isValidPath($path)) {
+            $source = $this->fopen($path, 'r');
+            if ($source) {
+                $extension = pathinfo($path, PATHINFO_EXTENSION);
+                $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension);
+                file_put_contents($tmpFile, $source);
+                return $tmpFile;
+            } else {
+                return false;
+            }
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $tmpFile
+     * @param string $path
+     * @return bool|mixed
+     * @throws \OCP\Files\InvalidPathException
+     */
+    public function fromTmpFile($tmpFile, $path) {
+        $this->assertPathLength($path);
+        if (Filesystem::isValidPath($path)) {
+
+            // Get directory that the file is going into
+            $filePath = dirname($path);
+
+            // Create the directories if any
+            if (!$this->file_exists($filePath)) {
+                $result = $this->createParentDirectories($filePath);
+                if ($result === false) {
+                    return false;
+                }
+            }
+
+            $source = fopen($tmpFile, 'r');
+            if ($source) {
+                $result = $this->file_put_contents($path, $source);
+                // $this->file_put_contents() might have already closed
+                // the resource, so we check it, before trying to close it
+                // to avoid messages in the error log.
+                if (is_resource($source)) {
+                    fclose($source);
+                }
+                unlink($tmpFile);
+                return $result;
+            } else {
+                return false;
+            }
+        } else {
+            return false;
+        }
+    }
+
+
+    /**
+     * @param string $path
+     * @return mixed
+     * @throws \OCP\Files\InvalidPathException
+     */
+    public function getMimeType($path) {
+        $this->assertPathLength($path);
+        return $this->basicOperation('getMimeType', $path);
+    }
+
+    /**
+     * @param string $type
+     * @param string $path
+     * @param bool $raw
+     * @return bool|null|string
+     */
+    public function hash($type, $path, $raw = false) {
+        $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
+        $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
+        if (Filesystem::isValidPath($path)) {
+            $path = $this->getRelativePath($absolutePath);
+            if ($path == null) {
+                return false;
+            }
+            if ($this->shouldEmitHooks($path)) {
+                \OC_Hook::emit(
+                    Filesystem::CLASSNAME,
+                    Filesystem::signal_read,
+                    array(Filesystem::signal_param_path => $this->getHookPath($path))
+                );
+            }
+            list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
+            if ($storage) {
+                $result = $storage->hash($type, $internalPath, $raw);
+                return $result;
+            }
+        }
+        return null;
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     * @throws \OCP\Files\InvalidPathException
+     */
+    public function free_space($path = '/') {
+        $this->assertPathLength($path);
+        $result = $this->basicOperation('free_space', $path);
+        if ($result === null) {
+            throw new InvalidPathException();
+        }
+        return $result;
+    }
+
+    /**
+     * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
+     *
+     * @param string $operation
+     * @param string $path
+     * @param array $hooks (optional)
+     * @param mixed $extraParam (optional)
+     * @return mixed
+     * @throws \Exception
+     *
+     * This method takes requests for basic filesystem functions (e.g. reading & writing
+     * files), processes hooks and proxies, sanitises paths, and finally passes them on to
+     * \OC\Files\Storage\Storage for delegation to a storage backend for execution
+     */
+    private function basicOperation($operation, $path, $hooks = [], $extraParam = null) {
+        $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
+        $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
+        if (Filesystem::isValidPath($path)
+            and !Filesystem::isFileBlacklisted($path)
+        ) {
+            $path = $this->getRelativePath($absolutePath);
+            if ($path == null) {
+                return false;
+            }
+
+            if (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks)) {
+                // always a shared lock during pre-hooks so the hook can read the file
+                $this->lockFile($path, ILockingProvider::LOCK_SHARED);
+            }
+
+            $run = $this->runHooks($hooks, $path);
+            /** @var \OC\Files\Storage\Storage $storage */
+            list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
+            if ($run and $storage) {
+                if (in_array('write', $hooks) || in_array('delete', $hooks)) {
+                    $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
+                }
+                try {
+                    if (!is_null($extraParam)) {
+                        $result = $storage->$operation($internalPath, $extraParam);
+                    } else {
+                        $result = $storage->$operation($internalPath);
+                    }
+                } catch (\Exception $e) {
+                    if (in_array('write', $hooks) || in_array('delete', $hooks)) {
+                        $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
+                    } else if (in_array('read', $hooks)) {
+                        $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
+                    }
+                    throw $e;
+                }
+
+                if ($result && in_array('delete', $hooks) and $result) {
+                    $this->removeUpdate($storage, $internalPath);
+                }
+                if ($result && in_array('write', $hooks) and $operation !== 'fopen') {
+                    $this->writeUpdate($storage, $internalPath);
+                }
+                if ($result && in_array('touch', $hooks)) {
+                    $this->writeUpdate($storage, $internalPath, $extraParam);
+                }
+
+                if ((in_array('write', $hooks) || in_array('delete', $hooks)) && ($operation !== 'fopen' || $result === false)) {
+                    $this->changeLock($path, ILockingProvider::LOCK_SHARED);
+                }
+
+                $unlockLater = false;
+                if ($this->lockingEnabled && $operation === 'fopen' && is_resource($result)) {
+                    $unlockLater = true;
+                    // make sure our unlocking callback will still be called if connection is aborted
+                    ignore_user_abort(true);
+                    $result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) {
+                        if (in_array('write', $hooks)) {
+                            $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
+                        } else if (in_array('read', $hooks)) {
+                            $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
+                        }
+                    });
+                }
+
+                if ($this->shouldEmitHooks($path) && $result !== false) {
+                    if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open
+                        $this->runHooks($hooks, $path, true);
+                    }
+                }
+
+                if (!$unlockLater
+                    && (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks))
+                ) {
+                    $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
+                }
+                return $result;
+            } else {
+                $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
+            }
+        }
+        return null;
+    }
+
+    /**
+     * get the path relative to the default root for hook usage
+     *
+     * @param string $path
+     * @return string
+     */
+    private function getHookPath($path) {
+        if (!Filesystem::getView()) {
+            return $path;
+        }
+        return Filesystem::getView()->getRelativePath($this->getAbsolutePath($path));
+    }
+
+    private function shouldEmitHooks($path = '') {
+        if ($path && Cache\Scanner::isPartialFile($path)) {
+            return false;
+        }
+        if (!Filesystem::$loaded) {
+            return false;
+        }
+        $defaultRoot = Filesystem::getRoot();
+        if ($defaultRoot === null) {
+            return false;
+        }
+        if ($this->fakeRoot === $defaultRoot) {
+            return true;
+        }
+        $fullPath = $this->getAbsolutePath($path);
+
+        if ($fullPath === $defaultRoot) {
+            return true;
+        }
+
+        return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
+    }
+
+    /**
+     * @param string[] $hooks
+     * @param string $path
+     * @param bool $post
+     * @return bool
+     */
+    private function runHooks($hooks, $path, $post = false) {
+        $relativePath = $path;
+        $path = $this->getHookPath($path);
+        $prefix = ($post) ? 'post_' : '';
+        $run = true;
+        if ($this->shouldEmitHooks($relativePath)) {
+            foreach ($hooks as $hook) {
+                if ($hook != 'read') {
+                    \OC_Hook::emit(
+                        Filesystem::CLASSNAME,
+                        $prefix . $hook,
+                        array(
+                            Filesystem::signal_param_run => &$run,
+                            Filesystem::signal_param_path => $path
+                        )
+                    );
+                } elseif (!$post) {
+                    \OC_Hook::emit(
+                        Filesystem::CLASSNAME,
+                        $prefix . $hook,
+                        array(
+                            Filesystem::signal_param_path => $path
+                        )
+                    );
+                }
+            }
+        }
+        return $run;
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     */
+    public function hasUpdated($path, $time) {
+        return $this->basicOperation('hasUpdated', $path, array(), $time);
+    }
+
+    /**
+     * @param string $ownerId
+     * @return \OC\User\User
+     */
+    private function getUserObjectForOwner($ownerId) {
+        $owner = $this->userManager->get($ownerId);
+        if ($owner instanceof IUser) {
+            return $owner;
+        } else {
+            return new User($ownerId, null);
+        }
+    }
+
+    /**
+     * Get file info from cache
+     *
+     * If the file is not in cached it will be scanned
+     * If the file has changed on storage the cache will be updated
+     *
+     * @param \OC\Files\Storage\Storage $storage
+     * @param string $internalPath
+     * @param string $relativePath
+     * @return ICacheEntry|bool
+     */
+    private function getCacheEntry($storage, $internalPath, $relativePath) {
+        $cache = $storage->getCache($internalPath);
+        $data = $cache->get($internalPath);
+        $watcher = $storage->getWatcher($internalPath);
+
+        try {
+            // if the file is not in the cache or needs to be updated, trigger the scanner and reload the data
+            if (!$data || $data['size'] === -1) {
+                $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
+                if (!$storage->file_exists($internalPath)) {
+                    $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
+                    return false;
+                }
+                $scanner = $storage->getScanner($internalPath);
+                $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
+                $data = $cache->get($internalPath);
+                $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
+            } else if (!Cache\Scanner::isPartialFile($internalPath) && $watcher->needsUpdate($internalPath, $data)) {
+                $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
+                $watcher->update($internalPath, $data);
+                $storage->getPropagator()->propagateChange($internalPath, time());
+                $data = $cache->get($internalPath);
+                $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
+            }
+        } catch (LockedException $e) {
+            // if the file is locked we just use the old cache info
+        }
+
+        return $data;
+    }
+
+    /**
+     * get the filesystem info
+     *
+     * @param string $path
+     * @param boolean|string $includeMountPoints true to add mountpoint sizes,
+     * 'ext' to add only ext storage mount point sizes. Defaults to true.
+     * defaults to true
+     * @return \OC\Files\FileInfo|false False if file does not exist
+     */
+    public function getFileInfo($path, $includeMountPoints = true) {
+        $this->assertPathLength($path);
+        if (!Filesystem::isValidPath($path)) {
+            return false;
+        }
+        if (Cache\Scanner::isPartialFile($path)) {
+            return $this->getPartFileInfo($path);
+        }
+        $relativePath = $path;
+        $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
+
+        $mount = Filesystem::getMountManager()->find($path);
+        $storage = $mount->getStorage();
+        $internalPath = $mount->getInternalPath($path);
+        if ($storage) {
+            $data = $this->getCacheEntry($storage, $internalPath, $relativePath);
+
+            if (!$data instanceof ICacheEntry) {
+                return false;
+            }
+
+            if ($mount instanceof MoveableMount && $internalPath === '') {
+                $data['permissions'] |= \OCP\Constants::PERMISSION_DELETE;
+            }
+
+            $owner = $this->getUserObjectForOwner($storage->getOwner($internalPath));
+            $info = new FileInfo($path, $storage, $internalPath, $data, $mount, $owner);
+
+            if ($data and isset($data['fileid'])) {
+                if ($includeMountPoints and $data['mimetype'] === 'httpd/unix-directory') {
+                    //add the sizes of other mount points to the folder
+                    $extOnly = ($includeMountPoints === 'ext');
+                    $mounts = Filesystem::getMountManager()->findIn($path);
+                    $info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) {
+                        $subStorage = $mount->getStorage();
+                        return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage);
+                    }));
+                }
+            }
+
+            return $info;
+        }
+
+        return false;
+    }
+
+    /**
+     * get the content of a directory
+     *
+     * @param string $directory path under datadirectory
+     * @param string $mimetype_filter limit returned content to this mimetype or mimepart
+     * @return FileInfo[]
+     */
+    public function getDirectoryContent($directory, $mimetype_filter = '') {
+        $this->assertPathLength($directory);
+        if (!Filesystem::isValidPath($directory)) {
+            return [];
+        }
+        $path = $this->getAbsolutePath($directory);
+        $path = Filesystem::normalizePath($path);
+        $mount = $this->getMount($directory);
+        $storage = $mount->getStorage();
+        $internalPath = $mount->getInternalPath($path);
+        if ($storage) {
+            $cache = $storage->getCache($internalPath);
+            $user = \OC_User::getUser();
+
+            $data = $this->getCacheEntry($storage, $internalPath, $directory);
+
+            if (!$data instanceof ICacheEntry || !isset($data['fileid']) || !($data->getPermissions() && Constants::PERMISSION_READ)) {
+                return [];
+            }
+
+            $folderId = $data['fileid'];
+            $contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
+
+            $sharingDisabled = \OCP\Util::isSharingDisabledForUser();
+            /**
+             * @var \OC\Files\FileInfo[] $files
+             */
+            $files = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
+                if ($sharingDisabled) {
+                    $content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
+                }
+                $owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
+                return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
+            }, $contents);
+
+            //add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
+            $mounts = Filesystem::getMountManager()->findIn($path);
+            $dirLength = strlen($path);
+            foreach ($mounts as $mount) {
+                $mountPoint = $mount->getMountPoint();
+                $subStorage = $mount->getStorage();
+                if ($subStorage) {
+                    $subCache = $subStorage->getCache('');
+
+                    $rootEntry = $subCache->get('');
+                    if (!$rootEntry) {
+                        $subScanner = $subStorage->getScanner('');
+                        try {
+                            $subScanner->scanFile('');
+                        } catch (\OCP\Files\StorageNotAvailableException $e) {
+                            continue;
+                        } catch (\OCP\Files\StorageInvalidException $e) {
+                            continue;
+                        } catch (\Exception $e) {
+                            // sometimes when the storage is not available it can be any exception
+                            \OCP\Util::writeLog(
+                                'core',
+                                'Exception while scanning storage "' . $subStorage->getId() . '": ' .
+                                get_class($e) . ': ' . $e->getMessage(),
+                                \OCP\Util::ERROR
+                            );
+                            continue;
+                        }
+                        $rootEntry = $subCache->get('');
+                    }
+
+                    if ($rootEntry && ($rootEntry->getPermissions() && Constants::PERMISSION_READ)) {
+                        $relativePath = trim(substr($mountPoint, $dirLength), '/');
+                        if ($pos = strpos($relativePath, '/')) {
+                            //mountpoint inside subfolder add size to the correct folder
+                            $entryName = substr($relativePath, 0, $pos);
+                            foreach ($files as &$entry) {
+                                if ($entry->getName() === $entryName) {
+                                    $entry->addSubEntry($rootEntry, $mountPoint);
+                                }
+                            }
+                        } else { //mountpoint in this folder, add an entry for it
+                            $rootEntry['name'] = $relativePath;
+                            $rootEntry['type'] = $rootEntry['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file';
+                            $permissions = $rootEntry['permissions'];
+                            // do not allow renaming/deleting the mount point if they are not shared files/folders
+                            // for shared files/folders we use the permissions given by the owner
+                            if ($mount instanceof MoveableMount) {
+                                $rootEntry['permissions'] = $permissions | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE;
+                            } else {
+                                $rootEntry['permissions'] = $permissions & (\OCP\Constants::PERMISSION_ALL - (\OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE));
+                            }
+
+                            //remove any existing entry with the same name
+                            foreach ($files as $i => $file) {
+                                if ($file['name'] === $rootEntry['name']) {
+                                    unset($files[$i]);
+                                    break;
+                                }
+                            }
+                            $rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
+
+                            // if sharing was disabled for the user we remove the share permissions
+                            if (\OCP\Util::isSharingDisabledForUser()) {
+                                $rootEntry['permissions'] = $rootEntry['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
+                            }
+
+                            $owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
+                            $files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
+                        }
+                    }
+                }
+            }
+
+            if ($mimetype_filter) {
+                $files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) {
+                    if (strpos($mimetype_filter, '/')) {
+                        return $file->getMimetype() === $mimetype_filter;
+                    } else {
+                        return $file->getMimePart() === $mimetype_filter;
+                    }
+                });
+            }
+
+            return $files;
+        } else {
+            return [];
+        }
+    }
+
+    /**
+     * change file metadata
+     *
+     * @param string $path
+     * @param array|\OCP\Files\FileInfo $data
+     * @return int
+     *
+     * returns the fileid of the updated file
+     */
+    public function putFileInfo($path, $data) {
+        $this->assertPathLength($path);
+        if ($data instanceof FileInfo) {
+            $data = $data->getData();
+        }
+        $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
+        /**
+         * @var \OC\Files\Storage\Storage $storage
+         * @var string $internalPath
+         */
+        list($storage, $internalPath) = Filesystem::resolvePath($path);
+        if ($storage) {
+            $cache = $storage->getCache($path);
+
+            if (!$cache->inCache($internalPath)) {
+                $scanner = $storage->getScanner($internalPath);
+                $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
+            }
+
+            return $cache->put($internalPath, $data);
+        } else {
+            return -1;
+        }
+    }
+
+    /**
+     * search for files with the name matching $query
+     *
+     * @param string $query
+     * @return FileInfo[]
+     */
+    public function search($query) {
+        return $this->searchCommon('search', array('%' . $query . '%'));
+    }
+
+    /**
+     * search for files with the name matching $query
+     *
+     * @param string $query
+     * @return FileInfo[]
+     */
+    public function searchRaw($query) {
+        return $this->searchCommon('search', array($query));
+    }
+
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype
+     * @return FileInfo[]
+     */
+    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 FileInfo[]
+     */
+    public function searchByTag($tag, $userId) {
+        return $this->searchCommon('searchByTag', array($tag, $userId));
+    }
+
+    /**
+     * @param string $method cache method
+     * @param array $args
+     * @return FileInfo[]
+     */
+    private function searchCommon($method, $args) {
+        $files = array();
+        $rootLength = strlen($this->fakeRoot);
+
+        $mount = $this->getMount('');
+        $mountPoint = $mount->getMountPoint();
+        $storage = $mount->getStorage();
+        if ($storage) {
+            $cache = $storage->getCache('');
+
+            $results = call_user_func_array(array($cache, $method), $args);
+            foreach ($results as $result) {
+                if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
+                    $internalPath = $result['path'];
+                    $path = $mountPoint . $result['path'];
+                    $result['path'] = substr($mountPoint . $result['path'], $rootLength);
+                    $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
+                    $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
+                }
+            }
+
+            $mounts = Filesystem::getMountManager()->findIn($this->fakeRoot);
+            foreach ($mounts as $mount) {
+                $mountPoint = $mount->getMountPoint();
+                $storage = $mount->getStorage();
+                if ($storage) {
+                    $cache = $storage->getCache('');
+
+                    $relativeMountPoint = substr($mountPoint, $rootLength);
+                    $results = call_user_func_array(array($cache, $method), $args);
+                    if ($results) {
+                        foreach ($results as $result) {
+                            $internalPath = $result['path'];
+                            $result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
+                            $path = rtrim($mountPoint . $internalPath, '/');
+                            $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
+                            $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
+                        }
+                    }
+                }
+            }
+        }
+        return $files;
+    }
+
+    /**
+     * Get the owner for a file or folder
+     *
+     * @param string $path
+     * @return string the user id of the owner
+     * @throws NotFoundException
+     */
+    public function getOwner($path) {
+        $info = $this->getFileInfo($path);
+        if (!$info) {
+            throw new NotFoundException($path . ' not found while trying to get owner');
+        }
+        return $info->getOwner()->getUID();
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getETag($path) {
+        /**
+         * @var Storage\Storage $storage
+         * @var string $internalPath
+         */
+        list($storage, $internalPath) = $this->resolvePath($path);
+        if ($storage) {
+            return $storage->getETag($internalPath);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get the path of a file by id, relative to the view
+     *
+     * Note that the resulting path is not guarantied to be unique for the id, multiple paths can point to the same file
+     *
+     * @param int $id
+     * @throws NotFoundException
+     * @return string
+     */
+    public function getPath($id) {
+        $id = (int)$id;
+        $manager = Filesystem::getMountManager();
+        $mounts = $manager->findIn($this->fakeRoot);
+        $mounts[] = $manager->find($this->fakeRoot);
+        // reverse the array so we start with the storage this view is in
+        // which is the most likely to contain the file we're looking for
+        $mounts = array_reverse($mounts);
+        foreach ($mounts as $mount) {
+            /**
+             * @var \OC\Files\Mount\MountPoint $mount
+             */
+            if ($mount->getStorage()) {
+                $cache = $mount->getStorage()->getCache();
+                $internalPath = $cache->getPathById($id);
+                if (is_string($internalPath)) {
+                    $fullPath = $mount->getMountPoint() . $internalPath;
+                    if (!is_null($path = $this->getRelativePath($fullPath))) {
+                        return $path;
+                    }
+                }
+            }
+        }
+        throw new NotFoundException(sprintf('File with id "%s" has not been found.', $id));
+    }
+
+    /**
+     * @param string $path
+     * @throws InvalidPathException
+     */
+    private function assertPathLength($path) {
+        $maxLen = min(PHP_MAXPATHLEN, 4000);
+        // Check for the string length - performed using isset() instead of strlen()
+        // because isset() is about 5x-40x faster.
+        if (isset($path[$maxLen])) {
+            $pathLen = strlen($path);
+            throw new \OCP\Files\InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
+        }
+    }
+
+    /**
+     * check if it is allowed to move a mount point to a given target.
+     * It is not allowed to move a mount point into a different mount point or
+     * into an already shared folder
+     *
+     * @param string $target path
+     * @return boolean
+     */
+    private function isTargetAllowed($target) {
+
+        list($targetStorage, $targetInternalPath) = \OC\Files\Filesystem::resolvePath($target);
+        if (!$targetStorage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
+            \OCP\Util::writeLog('files',
+                'It is not allowed to move one mount point into another one',
+                \OCP\Util::DEBUG);
+            return false;
+        }
+
+        // note: cannot use the view because the target is already locked
+        $fileId = (int)$targetStorage->getCache()->getId($targetInternalPath);
+        if ($fileId === -1) {
+            // target might not exist, need to check parent instead
+            $fileId = (int)$targetStorage->getCache()->getId(dirname($targetInternalPath));
+        }
+
+        // check if any of the parents were shared by the current owner (include collections)
+        $shares = \OCP\Share::getItemShared(
+            'folder',
+            $fileId,
+            \OCP\Share::FORMAT_NONE,
+            null,
+            true
+        );
+
+        if (count($shares) > 0) {
+            \OCP\Util::writeLog('files',
+                'It is not allowed to move one mount point into a shared folder',
+                \OCP\Util::DEBUG);
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Get a fileinfo object for files that are ignored in the cache (part files)
+     *
+     * @param string $path
+     * @return \OCP\Files\FileInfo
+     */
+    private function getPartFileInfo($path) {
+        $mount = $this->getMount($path);
+        $storage = $mount->getStorage();
+        $internalPath = $mount->getInternalPath($this->getAbsolutePath($path));
+        $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
+        return new FileInfo(
+            $this->getAbsolutePath($path),
+            $storage,
+            $internalPath,
+            [
+                'fileid' => null,
+                'mimetype' => $storage->getMimeType($internalPath),
+                'name' => basename($path),
+                'etag' => null,
+                'size' => $storage->filesize($internalPath),
+                'mtime' => $storage->filemtime($internalPath),
+                'encrypted' => false,
+                'permissions' => \OCP\Constants::PERMISSION_ALL
+            ],
+            $mount,
+            $owner
+        );
+    }
+
+    /**
+     * @param string $path
+     * @param string $fileName
+     * @throws InvalidPathException
+     */
+    public function verifyPath($path, $fileName) {
+        try {
+            /** @type \OCP\Files\Storage $storage */
+            list($storage, $internalPath) = $this->resolvePath($path);
+            $storage->verifyPath($internalPath, $fileName);
+        } catch (ReservedWordException $ex) {
+            $l = \OC::$server->getL10N('lib');
+            throw new InvalidPathException($l->t('File name is a reserved word'));
+        } catch (InvalidCharacterInPathException $ex) {
+            $l = \OC::$server->getL10N('lib');
+            throw new InvalidPathException($l->t('File name contains at least one invalid character'));
+        } catch (FileNameTooLongException $ex) {
+            $l = \OC::$server->getL10N('lib');
+            throw new InvalidPathException($l->t('File name is too long'));
+        } catch (InvalidDirectoryException $ex) {
+            $l = \OC::$server->getL10N('lib');
+            throw new InvalidPathException($l->t('Dot files are not allowed'));
+        } catch (EmptyFileNameException $ex) {
+            $l = \OC::$server->getL10N('lib');
+            throw new InvalidPathException($l->t('Empty filename is not allowed'));
+        }
+    }
+
+    /**
+     * get all parent folders of $path
+     *
+     * @param string $path
+     * @return string[]
+     */
+    private function getParents($path) {
+        $path = trim($path, '/');
+        if (!$path) {
+            return [];
+        }
+
+        $parts = explode('/', $path);
+
+        // remove the single file
+        array_pop($parts);
+        $result = array('/');
+        $resultPath = '';
+        foreach ($parts as $part) {
+            if ($part) {
+                $resultPath .= '/' . $part;
+                $result[] = $resultPath;
+            }
+        }
+        return $result;
+    }
+
+    /**
+     * Returns the mount point for which to lock
+     *
+     * @param string $absolutePath absolute path
+     * @param bool $useParentMount true to return parent mount instead of whatever
+     * is mounted directly on the given path, false otherwise
+     * @return \OC\Files\Mount\MountPoint mount point for which to apply locks
+     */
+    private function getMountForLock($absolutePath, $useParentMount = false) {
+        $results = [];
+        $mount = Filesystem::getMountManager()->find($absolutePath);
+        if (!$mount) {
+            return $results;
+        }
+
+        if ($useParentMount) {
+            // find out if something is mounted directly on the path
+            $internalPath = $mount->getInternalPath($absolutePath);
+            if ($internalPath === '') {
+                // resolve the parent mount instead
+                $mount = Filesystem::getMountManager()->find(dirname($absolutePath));
+            }
+        }
+
+        return $mount;
+    }
+
+    /**
+     * Lock the given path
+     *
+     * @param string $path the path of the file to lock, relative to the view
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
+     *
+     * @return bool False if the path is excluded from locking, true otherwise
+     * @throws \OCP\Lock\LockedException if the path is already locked
+     */
+    private function lockPath($path, $type, $lockMountPoint = false) {
+        $absolutePath = $this->getAbsolutePath($path);
+        $absolutePath = Filesystem::normalizePath($absolutePath);
+        if (!$this->shouldLockFile($absolutePath)) {
+            return false;
+        }
+
+        $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
+        if ($mount) {
+            try {
+                $storage = $mount->getStorage();
+                if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                    $storage->acquireLock(
+                        $mount->getInternalPath($absolutePath),
+                        $type,
+                        $this->lockingProvider
+                    );
+                }
+            } catch (\OCP\Lock\LockedException $e) {
+                // rethrow with the a human-readable path
+                throw new \OCP\Lock\LockedException(
+                    $this->getPathRelativeToFiles($absolutePath),
+                    $e
+                );
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Change the lock type
+     *
+     * @param string $path the path of the file to lock, relative to the view
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
+     *
+     * @return bool False if the path is excluded from locking, true otherwise
+     * @throws \OCP\Lock\LockedException if the path is already locked
+     */
+    public function changeLock($path, $type, $lockMountPoint = false) {
+        $path = Filesystem::normalizePath($path);
+        $absolutePath = $this->getAbsolutePath($path);
+        $absolutePath = Filesystem::normalizePath($absolutePath);
+        if (!$this->shouldLockFile($absolutePath)) {
+            return false;
+        }
+
+        $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
+        if ($mount) {
+            try {
+                $storage = $mount->getStorage();
+                if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                    $storage->changeLock(
+                        $mount->getInternalPath($absolutePath),
+                        $type,
+                        $this->lockingProvider
+                    );
+                }
+            } catch (\OCP\Lock\LockedException $e) {
+                try {
+                    // rethrow with the a human-readable path
+                    throw new \OCP\Lock\LockedException(
+                        $this->getPathRelativeToFiles($absolutePath),
+                        $e
+                    );
+                } catch (\InvalidArgumentException $e) {
+                    throw new \OCP\Lock\LockedException(
+                        $absolutePath,
+                        $e
+                    );
+                }
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Unlock the given path
+     *
+     * @param string $path the path of the file to unlock, relative to the view
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
+     *
+     * @return bool False if the path is excluded from locking, true otherwise
+     */
+    private function unlockPath($path, $type, $lockMountPoint = false) {
+        $absolutePath = $this->getAbsolutePath($path);
+        $absolutePath = Filesystem::normalizePath($absolutePath);
+        if (!$this->shouldLockFile($absolutePath)) {
+            return false;
+        }
+
+        $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
+        if ($mount) {
+            $storage = $mount->getStorage();
+            if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                $storage->releaseLock(
+                    $mount->getInternalPath($absolutePath),
+                    $type,
+                    $this->lockingProvider
+                );
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Lock a path and all its parents up to the root of the view
+     *
+     * @param string $path the path of the file to lock relative to the view
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
+     *
+     * @return bool False if the path is excluded from locking, true otherwise
+     */
+    public function lockFile($path, $type, $lockMountPoint = false) {
+        $absolutePath = $this->getAbsolutePath($path);
+        $absolutePath = Filesystem::normalizePath($absolutePath);
+        if (!$this->shouldLockFile($absolutePath)) {
+            return false;
+        }
+
+        $this->lockPath($path, $type, $lockMountPoint);
+
+        $parents = $this->getParents($path);
+        foreach ($parents as $parent) {
+            $this->lockPath($parent, ILockingProvider::LOCK_SHARED);
+        }
+
+        return true;
+    }
+
+    /**
+     * Unlock a path and all its parents up to the root of the view
+     *
+     * @param string $path the path of the file to lock relative to the view
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
+     *
+     * @return bool False if the path is excluded from locking, true otherwise
+     */
+    public function unlockFile($path, $type, $lockMountPoint = false) {
+        $absolutePath = $this->getAbsolutePath($path);
+        $absolutePath = Filesystem::normalizePath($absolutePath);
+        if (!$this->shouldLockFile($absolutePath)) {
+            return false;
+        }
+
+        $this->unlockPath($path, $type, $lockMountPoint);
+
+        $parents = $this->getParents($path);
+        foreach ($parents as $parent) {
+            $this->unlockPath($parent, ILockingProvider::LOCK_SHARED);
+        }
+
+        return true;
+    }
+
+    /**
+     * Only lock files in data/user/files/
+     *
+     * @param string $path Absolute path to the file/folder we try to (un)lock
+     * @return bool
+     */
+    protected function shouldLockFile($path) {
+        $path = Filesystem::normalizePath($path);
+
+        $pathSegments = explode('/', $path);
+        if (isset($pathSegments[2])) {
+            // E.g.: /username/files/path-to-file
+            return ($pathSegments[2] === 'files') && (count($pathSegments) > 3);
+        }
+
+        return strpos($path, '/appdata_') !== 0;
+    }
+
+    /**
+     * Shortens the given absolute path to be relative to
+     * "$user/files".
+     *
+     * @param string $absolutePath absolute path which is under "files"
+     *
+     * @return string path relative to "files" with trimmed slashes or null
+     * if the path was NOT relative to files
+     *
+     * @throws \InvalidArgumentException if the given path was not under "files"
+     * @since 8.1.0
+     */
+    public function getPathRelativeToFiles($absolutePath) {
+        $path = Filesystem::normalizePath($absolutePath);
+        $parts = explode('/', trim($path, '/'), 3);
+        // "$user", "files", "path/to/dir"
+        if (!isset($parts[1]) || $parts[1] !== 'files') {
+            $this->logger->error(
+                '$absolutePath must be relative to "files", value is "%s"',
+                [
+                    $absolutePath
+                ]
+            );
+            throw new \InvalidArgumentException('$absolutePath must be relative to "files"');
+        }
+        if (isset($parts[2])) {
+            return $parts[2];
+        }
+        return '';
+    }
+
+    /**
+     * @param string $filename
+     * @return array
+     * @throws \OC\User\NoUserException
+     * @throws NotFoundException
+     */
+    public function getUidAndFilename($filename) {
+        $info = $this->getFileInfo($filename);
+        if (!$info instanceof \OCP\Files\FileInfo) {
+            throw new NotFoundException($this->getAbsolutePath($filename) . ' not found');
+        }
+        $uid = $info->getOwner()->getUID();
+        if ($uid != \OCP\User::getUser()) {
+            Filesystem::initMountPoints($uid);
+            $ownerView = new View('/' . $uid . '/files');
+            try {
+                $filename = $ownerView->getPath($info['fileid']);
+            } catch (NotFoundException $e) {
+                throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid);
+            }
+        }
+        return [$uid, $filename];
+    }
+
+    /**
+     * Creates parent non-existing folders
+     *
+     * @param string $filePath
+     * @return bool
+     */
+    private function createParentDirectories($filePath) {
+        $directoryParts = explode('/', $filePath);
+        $directoryParts = array_filter($directoryParts);
+        foreach ($directoryParts as $key => $part) {
+            $currentPathElements = array_slice($directoryParts, 0, $key);
+            $currentPath = '/' . implode('/', $currentPathElements);
+            if ($this->is_file($currentPath)) {
+                return false;
+            }
+            if (!$this->file_exists($currentPath)) {
+                $this->mkdir($currentPath);
+            }
+        }
+
+        return true;
+    }
 }

apps/files_sharing/lib/Helper.php

Doc Comments +1 added lines

@@ -303,6 +303,7 @@
 	 * get default share folder
 	 *
 	 * @param \OC\Files\View
+	 * @param View $view
 	 * @return string
 	 */
 	public static function getShareFolder($view = null) {

Indentation +237 added lines, -237 removed lines

@@ -36,242 +36,242 @@
 
 class Helper {
 
-	public static function registerHooks() {
-		\OCP\Util::connectHook('OC_Filesystem', 'post_rename', '\OCA\Files_Sharing\Updater', 'renameHook');
-		\OCP\Util::connectHook('OC_Filesystem', 'post_delete', '\OCA\Files_Sharing\Hooks', 'unshareChildren');
-
-		\OCP\Util::connectHook('OC_User', 'post_deleteUser', '\OCA\Files_Sharing\Hooks', 'deleteUser');
-	}
-
-	/**
-	 * Sets up the filesystem and user for public sharing
-	 * @param string $token string share token
-	 * @param string $relativePath optional path relative to the share
-	 * @param string $password optional password
-	 * @return array
-	 */
-	public static function setupFromToken($token, $relativePath = null, $password = null) {
-		\OC_User::setIncognitoMode(true);
-
-		$shareManager = \OC::$server->getShareManager();
-
-		try {
-			$share = $shareManager->getShareByToken($token);
-		} catch (ShareNotFound $e) {
-			\OC_Response::setStatus(404);
-			\OCP\Util::writeLog('core-preview', 'Passed token parameter is not valid', \OCP\Util::DEBUG);
-			exit;
-		}
-
-		\OCP\JSON::checkUserExists($share->getShareOwner());
-		\OC_Util::tearDownFS();
-		\OC_Util::setupFS($share->getShareOwner());
-
-
-		try {
-			$path = Filesystem::getPath($share->getNodeId());
-		} catch (NotFoundException $e) {
-			\OCP\Util::writeLog('share', 'could not resolve linkItem', \OCP\Util::DEBUG);
-			\OC_Response::setStatus(404);
-			\OCP\JSON::error(array('success' => false));
-			exit();
-		}
-
-		if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK && $share->getPassword() !== null) {
-			if (!self::authenticate($share, $password)) {
-				\OC_Response::setStatus(403);
-				\OCP\JSON::error(array('success' => false));
-				exit();
-			}
-		}
-
-		$basePath = $path;
-
-		if ($relativePath !== null && Filesystem::isReadable($basePath . $relativePath)) {
-			$path .= Filesystem::normalizePath($relativePath);
-		}
-
-		return array(
-			'share' => $share,
-			'basePath' => $basePath,
-			'realPath' => $path
-		);
-	}
-
-	/**
-	 * Authenticate link item with the given password
-	 * or with the session if no password was given.
-	 * @param \OCP\Share\IShare $share
-	 * @param string $password optional password
-	 *
-	 * @return boolean true if authorized, false otherwise
-	 */
-	public static function authenticate($share, $password = null) {
-		$shareManager = \OC::$server->getShareManager();
-
-		if ($password !== null) {
-			if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
-				if ($shareManager->checkPassword($share, $password)) {
-					\OC::$server->getSession()->set('public_link_authenticated', (string)$share->getId());
-					return true;
-				}
-			}
-		} else {
-			// not authenticated ?
-			if (\OC::$server->getSession()->exists('public_link_authenticated')
-				&& \OC::$server->getSession()->get('public_link_authenticated') !== (string)$share->getId()) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	public static function getSharesFromItem($target) {
-		$result = array();
-		$owner = Filesystem::getOwner($target);
-		Filesystem::initMountPoints($owner);
-		$info = Filesystem::getFileInfo($target);
-		$ownerView = new View('/'.$owner.'/files');
-		if ( $owner !== User::getUser() ) {
-			$path = $ownerView->getPath($info['fileid']);
-		} else {
-			$path = $target;
-		}
-
-
-		$ids = array();
-		while ($path !== dirname($path)) {
-			$info = $ownerView->getFileInfo($path);
-			if ($info instanceof \OC\Files\FileInfo) {
-				$ids[] = $info['fileid'];
-			} else {
-				\OCP\Util::writeLog('sharing', 'No fileinfo available for: ' . $path, \OCP\Util::WARN);
-			}
-			$path = dirname($path);
-		}
-
-		if (!empty($ids)) {
-
-			$idList = array_chunk($ids, 99, true);
-
-			foreach ($idList as $subList) {
-				$statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (" . implode(',', $subList) . ") AND `share_type` IN (0, 1, 2)";
-				$query = \OCP\DB::prepare($statement);
-				$r = $query->execute();
-				$result = array_merge($result, $r->fetchAll());
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * get the UID of the owner of the file and the path to the file relative to
-	 * owners files folder
-	 *
-	 * @param $filename
-	 * @return array
-	 * @throws \OC\User\NoUserException
-	 */
-	public static function getUidAndFilename($filename) {
-		$uid = Filesystem::getOwner($filename);
-		$userManager = \OC::$server->getUserManager();
-		// if the user with the UID doesn't exists, e.g. because the UID points
-		// to a remote user with a federated cloud ID we use the current logged-in
-		// user. We need a valid local user to create the share
-		if (!$userManager->userExists($uid)) {
-			$uid = User::getUser();
-		}
-		Filesystem::initMountPoints($uid);
-		if ( $uid !== User::getUser() ) {
-			$info = Filesystem::getFileInfo($filename);
-			$ownerView = new View('/'.$uid.'/files');
-			try {
-				$filename = $ownerView->getPath($info['fileid']);
-			} catch (NotFoundException $e) {
-				$filename = null;
-			}
-		}
-		return [$uid, $filename];
-	}
-
-	/**
-	 * Format a path to be relative to the /user/files/ directory
-	 * @param string $path the absolute path
-	 * @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
-	 */
-	public static function stripUserFilesPath($path) {
-		$trimmed = ltrim($path, '/');
-		$split = explode('/', $trimmed);
-
-		// it is not a file relative to data/user/files
-		if (count($split) < 3 || $split[1] !== 'files') {
-			return false;
-		}
-
-		$sliced = array_slice($split, 2);
-		$relPath = implode('/', $sliced);
-
-		return $relPath;
-	}
-
-	/**
-	 * check if file name already exists and generate unique target
-	 *
-	 * @param string $path
-	 * @param array $excludeList
-	 * @param View $view
-	 * @return string $path
-	 */
-	public static function generateUniqueTarget($path, $excludeList, $view) {
-		$pathinfo = pathinfo($path);
-		$ext = (isset($pathinfo['extension'])) ? '.'.$pathinfo['extension'] : '';
-		$name = $pathinfo['filename'];
-		$dir = $pathinfo['dirname'];
-		$i = 2;
-		while ($view->file_exists($path) || in_array($path, $excludeList)) {
-			$path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
-			$i++;
-		}
-
-		return $path;
-	}
-
-	/**
-	 * get default share folder
-	 *
-	 * @param \OC\Files\View
-	 * @return string
-	 */
-	public static function getShareFolder($view = null) {
-		if ($view === null) {
-			$view = Filesystem::getView();
-		}
-		$shareFolder = \OC::$server->getConfig()->getSystemValue('share_folder', '/');
-		$shareFolder = Filesystem::normalizePath($shareFolder);
-
-		if (!$view->file_exists($shareFolder)) {
-			$dir = '';
-			$subdirs = explode('/', $shareFolder);
-			foreach ($subdirs as $subdir) {
-				$dir = $dir . '/' . $subdir;
-				if (!$view->is_dir($dir)) {
-					$view->mkdir($dir);
-				}
-			}
-		}
-
-		return $shareFolder;
-
-	}
-
-	/**
-	 * set default share folder
-	 *
-	 * @param string $shareFolder
-	 */
-	public static function setShareFolder($shareFolder) {
-		\OC::$server->getConfig()->setSystemValue('share_folder', $shareFolder);
-	}
+    public static function registerHooks() {
+        \OCP\Util::connectHook('OC_Filesystem', 'post_rename', '\OCA\Files_Sharing\Updater', 'renameHook');
+        \OCP\Util::connectHook('OC_Filesystem', 'post_delete', '\OCA\Files_Sharing\Hooks', 'unshareChildren');
+
+        \OCP\Util::connectHook('OC_User', 'post_deleteUser', '\OCA\Files_Sharing\Hooks', 'deleteUser');
+    }
+
+    /**
+     * Sets up the filesystem and user for public sharing
+     * @param string $token string share token
+     * @param string $relativePath optional path relative to the share
+     * @param string $password optional password
+     * @return array
+     */
+    public static function setupFromToken($token, $relativePath = null, $password = null) {
+        \OC_User::setIncognitoMode(true);
+
+        $shareManager = \OC::$server->getShareManager();
+
+        try {
+            $share = $shareManager->getShareByToken($token);
+        } catch (ShareNotFound $e) {
+            \OC_Response::setStatus(404);
+            \OCP\Util::writeLog('core-preview', 'Passed token parameter is not valid', \OCP\Util::DEBUG);
+            exit;
+        }
+
+        \OCP\JSON::checkUserExists($share->getShareOwner());
+        \OC_Util::tearDownFS();
+        \OC_Util::setupFS($share->getShareOwner());
+
+
+        try {
+            $path = Filesystem::getPath($share->getNodeId());
+        } catch (NotFoundException $e) {
+            \OCP\Util::writeLog('share', 'could not resolve linkItem', \OCP\Util::DEBUG);
+            \OC_Response::setStatus(404);
+            \OCP\JSON::error(array('success' => false));
+            exit();
+        }
+
+        if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK && $share->getPassword() !== null) {
+            if (!self::authenticate($share, $password)) {
+                \OC_Response::setStatus(403);
+                \OCP\JSON::error(array('success' => false));
+                exit();
+            }
+        }
+
+        $basePath = $path;
+
+        if ($relativePath !== null && Filesystem::isReadable($basePath . $relativePath)) {
+            $path .= Filesystem::normalizePath($relativePath);
+        }
+
+        return array(
+            'share' => $share,
+            'basePath' => $basePath,
+            'realPath' => $path
+        );
+    }
+
+    /**
+     * Authenticate link item with the given password
+     * or with the session if no password was given.
+     * @param \OCP\Share\IShare $share
+     * @param string $password optional password
+     *
+     * @return boolean true if authorized, false otherwise
+     */
+    public static function authenticate($share, $password = null) {
+        $shareManager = \OC::$server->getShareManager();
+
+        if ($password !== null) {
+            if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
+                if ($shareManager->checkPassword($share, $password)) {
+                    \OC::$server->getSession()->set('public_link_authenticated', (string)$share->getId());
+                    return true;
+                }
+            }
+        } else {
+            // not authenticated ?
+            if (\OC::$server->getSession()->exists('public_link_authenticated')
+                && \OC::$server->getSession()->get('public_link_authenticated') !== (string)$share->getId()) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    public static function getSharesFromItem($target) {
+        $result = array();
+        $owner = Filesystem::getOwner($target);
+        Filesystem::initMountPoints($owner);
+        $info = Filesystem::getFileInfo($target);
+        $ownerView = new View('/'.$owner.'/files');
+        if ( $owner !== User::getUser() ) {
+            $path = $ownerView->getPath($info['fileid']);
+        } else {
+            $path = $target;
+        }
+
+
+        $ids = array();
+        while ($path !== dirname($path)) {
+            $info = $ownerView->getFileInfo($path);
+            if ($info instanceof \OC\Files\FileInfo) {
+                $ids[] = $info['fileid'];
+            } else {
+                \OCP\Util::writeLog('sharing', 'No fileinfo available for: ' . $path, \OCP\Util::WARN);
+            }
+            $path = dirname($path);
+        }
+
+        if (!empty($ids)) {
+
+            $idList = array_chunk($ids, 99, true);
+
+            foreach ($idList as $subList) {
+                $statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (" . implode(',', $subList) . ") AND `share_type` IN (0, 1, 2)";
+                $query = \OCP\DB::prepare($statement);
+                $r = $query->execute();
+                $result = array_merge($result, $r->fetchAll());
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * get the UID of the owner of the file and the path to the file relative to
+     * owners files folder
+     *
+     * @param $filename
+     * @return array
+     * @throws \OC\User\NoUserException
+     */
+    public static function getUidAndFilename($filename) {
+        $uid = Filesystem::getOwner($filename);
+        $userManager = \OC::$server->getUserManager();
+        // if the user with the UID doesn't exists, e.g. because the UID points
+        // to a remote user with a federated cloud ID we use the current logged-in
+        // user. We need a valid local user to create the share
+        if (!$userManager->userExists($uid)) {
+            $uid = User::getUser();
+        }
+        Filesystem::initMountPoints($uid);
+        if ( $uid !== User::getUser() ) {
+            $info = Filesystem::getFileInfo($filename);
+            $ownerView = new View('/'.$uid.'/files');
+            try {
+                $filename = $ownerView->getPath($info['fileid']);
+            } catch (NotFoundException $e) {
+                $filename = null;
+            }
+        }
+        return [$uid, $filename];
+    }
+
+    /**
+     * Format a path to be relative to the /user/files/ directory
+     * @param string $path the absolute path
+     * @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
+     */
+    public static function stripUserFilesPath($path) {
+        $trimmed = ltrim($path, '/');
+        $split = explode('/', $trimmed);
+
+        // it is not a file relative to data/user/files
+        if (count($split) < 3 || $split[1] !== 'files') {
+            return false;
+        }
+
+        $sliced = array_slice($split, 2);
+        $relPath = implode('/', $sliced);
+
+        return $relPath;
+    }
+
+    /**
+     * check if file name already exists and generate unique target
+     *
+     * @param string $path
+     * @param array $excludeList
+     * @param View $view
+     * @return string $path
+     */
+    public static function generateUniqueTarget($path, $excludeList, $view) {
+        $pathinfo = pathinfo($path);
+        $ext = (isset($pathinfo['extension'])) ? '.'.$pathinfo['extension'] : '';
+        $name = $pathinfo['filename'];
+        $dir = $pathinfo['dirname'];
+        $i = 2;
+        while ($view->file_exists($path) || in_array($path, $excludeList)) {
+            $path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
+            $i++;
+        }
+
+        return $path;
+    }
+
+    /**
+     * get default share folder
+     *
+     * @param \OC\Files\View
+     * @return string
+     */
+    public static function getShareFolder($view = null) {
+        if ($view === null) {
+            $view = Filesystem::getView();
+        }
+        $shareFolder = \OC::$server->getConfig()->getSystemValue('share_folder', '/');
+        $shareFolder = Filesystem::normalizePath($shareFolder);
+
+        if (!$view->file_exists($shareFolder)) {
+            $dir = '';
+            $subdirs = explode('/', $shareFolder);
+            foreach ($subdirs as $subdir) {
+                $dir = $dir . '/' . $subdir;
+                if (!$view->is_dir($dir)) {
+                    $view->mkdir($dir);
+                }
+            }
+        }
+
+        return $shareFolder;
+
+    }
+
+    /**
+     * set default share folder
+     *
+     * @param string $shareFolder
+     */
+    public static function setShareFolder($shareFolder) {
+        \OC::$server->getConfig()->setSystemValue('share_folder', $shareFolder);
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -87,7 +87,7 @@ 
 
 		$basePath = $path;
 
-		if ($relativePath !== null && Filesystem::isReadable($basePath . $relativePath)) {
+		if ($relativePath !== null && Filesystem::isReadable($basePath.$relativePath)) {
 			$path .= Filesystem::normalizePath($relativePath);
 		}
 
@@ -112,14 +112,14 @@ 
 		if ($password !== null) {
 			if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
 				if ($shareManager->checkPassword($share, $password)) {
-					\OC::$server->getSession()->set('public_link_authenticated', (string)$share->getId());
+					\OC::$server->getSession()->set('public_link_authenticated', (string) $share->getId());
 					return true;
 				}
 			}
 		} else {
 			// not authenticated ?
 			if (\OC::$server->getSession()->exists('public_link_authenticated')
-				&& \OC::$server->getSession()->get('public_link_authenticated') !== (string)$share->getId()) {
+				&& \OC::$server->getSession()->get('public_link_authenticated') !== (string) $share->getId()) {
 				return true;
 			}
 		}
@@ -132,7 +132,7 @@ 
 		Filesystem::initMountPoints($owner);
 		$info = Filesystem::getFileInfo($target);
 		$ownerView = new View('/'.$owner.'/files');
-		if ( $owner !== User::getUser() ) {
+		if ($owner !== User::getUser()) {
 			$path = $ownerView->getPath($info['fileid']);
 		} else {
 			$path = $target;
@@ -145,7 +145,7 @@ 
 			if ($info instanceof \OC\Files\FileInfo) {
 				$ids[] = $info['fileid'];
 			} else {
-				\OCP\Util::writeLog('sharing', 'No fileinfo available for: ' . $path, \OCP\Util::WARN);
+				\OCP\Util::writeLog('sharing', 'No fileinfo available for: '.$path, \OCP\Util::WARN);
 			}
 			$path = dirname($path);
 		}
@@ -155,7 +155,7 @@ 
 			$idList = array_chunk($ids, 99, true);
 
 			foreach ($idList as $subList) {
-				$statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (" . implode(',', $subList) . ") AND `share_type` IN (0, 1, 2)";
+				$statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (".implode(',', $subList).") AND `share_type` IN (0, 1, 2)";
 				$query = \OCP\DB::prepare($statement);
 				$r = $query->execute();
 				$result = array_merge($result, $r->fetchAll());
@@ -183,7 +183,7 @@ 
 			$uid = User::getUser();
 		}
 		Filesystem::initMountPoints($uid);
-		if ( $uid !== User::getUser() ) {
+		if ($uid !== User::getUser()) {
 			$info = Filesystem::getFileInfo($filename);
 			$ownerView = new View('/'.$uid.'/files');
 			try {
@@ -230,7 +230,7 @@ 
 		$dir = $pathinfo['dirname'];
 		$i = 2;
 		while ($view->file_exists($path) || in_array($path, $excludeList)) {
-			$path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
+			$path = Filesystem::normalizePath($dir.'/'.$name.' ('.$i.')'.$ext);
 			$i++;
 		}
 
@@ -254,7 +254,7 @@ 
 			$dir = '';
 			$subdirs = explode('/', $shareFolder);
 			foreach ($subdirs as $subdir) {
-				$dir = $dir . '/' . $subdir;
+				$dir = $dir.'/'.$subdir;
 				if (!$view->is_dir($dir)) {
 					$view->mkdir($dir);
 				}

apps/dav/lib/SystemTag/SystemTagsObjectMappingCollection.php

Doc Comments +3 added lines

@@ -89,6 +89,9 @@
 		$this->user = $user;
 	}
 
+	/**
+	 * @param string $tagId
+	 */
 	function createFile($tagId, $data = null) {
 		try {
 			$tags = $this->tagManager->getTagsByIds([$tagId]);

Indentation +165 added lines, -165 removed lines

@@ -39,169 +39,169 @@
  */
 class SystemTagsObjectMappingCollection implements ICollection {
 
-	/**
-	 * @var string
-	 */
-	private $objectId;
-
-	/**
-	 * @var string
-	 */
-	private $objectType;
-
-	/**
-	 * @var ISystemTagManager
-	 */
-	private $tagManager;
-
-	/**
-	 * @var ISystemTagObjectMapper
-	 */
-	private $tagMapper;
-
-	/**
-	 * User
-	 *
-	 * @var IUser
-	 */
-	private $user;
-
-
-	/**
-	 * Constructor
-	 *
-	 * @param string $objectId object id
-	 * @param string $objectType object type
-	 * @param IUser $user user
-	 * @param ISystemTagManager $tagManager tag manager
-	 * @param ISystemTagObjectMapper $tagMapper tag mapper
-	 */
-	public function __construct(
-		$objectId,
-		$objectType,
-		IUser $user,
-		ISystemTagManager $tagManager,
-		ISystemTagObjectMapper $tagMapper
-	) {
-		$this->tagManager = $tagManager;
-		$this->tagMapper = $tagMapper;
-		$this->objectId = $objectId;
-		$this->objectType = $objectType;
-		$this->user = $user;
-	}
-
-	function createFile($tagId, $data = null) {
-		try {
-			$tags = $this->tagManager->getTagsByIds([$tagId]);
-			$tag = current($tags);
-			if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
-				throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
-			}
-			if (!$this->tagManager->canUserAssignTag($tag, $this->user)) {
-				throw new Forbidden('No permission to assign tag ' . $tagId);
-			}
-
-			$this->tagMapper->assignTags($this->objectId, $this->objectType, $tagId);
-		} catch (TagNotFoundException $e) {
-			throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
-		}
-	}
-
-	function createDirectory($name) {
-		throw new Forbidden('Permission denied to create collections');
-	}
-
-	function getChild($tagId) {
-		try {
-			if ($this->tagMapper->haveTag([$this->objectId], $this->objectType, $tagId, true)) {
-				$tag = $this->tagManager->getTagsByIds([$tagId]);
-				$tag = current($tag);
-				if ($this->tagManager->canUserSeeTag($tag, $this->user)) {
-					return $this->makeNode($tag);
-				}
-			}
-			throw new NotFound('Tag with id ' . $tagId . ' not present for object ' . $this->objectId);
-		} catch (\InvalidArgumentException $e) {
-			throw new BadRequest('Invalid tag id', 0, $e);
-		} catch (TagNotFoundException $e) {
-			throw new NotFound('Tag with id ' . $tagId . ' not found', 0, $e);
-		}
-	}
-
-	function getChildren() {
-		$tagIds = current($this->tagMapper->getTagIdsForObjects([$this->objectId], $this->objectType));
-		if (empty($tagIds)) {
-			return [];
-		}
-		$tags = $this->tagManager->getTagsByIds($tagIds);
-
-		// filter out non-visible tags
-		$tags = array_filter($tags, function($tag) {
-			return $this->tagManager->canUserSeeTag($tag, $this->user);
-		});
-
-		return array_values(array_map(function($tag) {
-			return $this->makeNode($tag);
-		}, $tags));
-	}
-
-	function childExists($tagId) {
-		try {
-			$result = ($this->tagMapper->haveTag([$this->objectId], $this->objectType, $tagId, true));
-
-			if ($result) {
-				$tags = $this->tagManager->getTagsByIds([$tagId]);
-				$tag = current($tags);
-				if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
-					return false;
-				}
-			}
-
-			return $result;
-		} catch (\InvalidArgumentException $e) {
-			throw new BadRequest('Invalid tag id', 0, $e);
-		} catch (TagNotFoundException $e) {
-			return false;
-		}
-	}
-
-	function delete() {
-		throw new Forbidden('Permission denied to delete this collection');
-	}
-
-	function getName() {
-		return $this->objectId;
-	}
-
-	function setName($name) {
-		throw new Forbidden('Permission denied to rename this collection');
-	}
-
-	/**
-	 * Returns the last modification time, as a unix timestamp
-	 *
-	 * @return int
-	 */
-	function getLastModified() {
-		return null;
-	}
-
-	/**
-	 * Create a sabre node for the mapping of the 
-	 * given system tag to the collection's object
-	 *
-	 * @param ISystemTag $tag
-	 *
-	 * @return SystemTagMappingNode
-	 */
-	private function makeNode(ISystemTag $tag) {
-		return new SystemTagMappingNode(
-			$tag,
-			$this->objectId,
-			$this->objectType,
-			$this->user,
-			$this->tagManager,
-			$this->tagMapper
-		);
-	}
+    /**
+     * @var string
+     */
+    private $objectId;
+
+    /**
+     * @var string
+     */
+    private $objectType;
+
+    /**
+     * @var ISystemTagManager
+     */
+    private $tagManager;
+
+    /**
+     * @var ISystemTagObjectMapper
+     */
+    private $tagMapper;
+
+    /**
+     * User
+     *
+     * @var IUser
+     */
+    private $user;
+
+
+    /**
+     * Constructor
+     *
+     * @param string $objectId object id
+     * @param string $objectType object type
+     * @param IUser $user user
+     * @param ISystemTagManager $tagManager tag manager
+     * @param ISystemTagObjectMapper $tagMapper tag mapper
+     */
+    public function __construct(
+        $objectId,
+        $objectType,
+        IUser $user,
+        ISystemTagManager $tagManager,
+        ISystemTagObjectMapper $tagMapper
+    ) {
+        $this->tagManager = $tagManager;
+        $this->tagMapper = $tagMapper;
+        $this->objectId = $objectId;
+        $this->objectType = $objectType;
+        $this->user = $user;
+    }
+
+    function createFile($tagId, $data = null) {
+        try {
+            $tags = $this->tagManager->getTagsByIds([$tagId]);
+            $tag = current($tags);
+            if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
+                throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
+            }
+            if (!$this->tagManager->canUserAssignTag($tag, $this->user)) {
+                throw new Forbidden('No permission to assign tag ' . $tagId);
+            }
+
+            $this->tagMapper->assignTags($this->objectId, $this->objectType, $tagId);
+        } catch (TagNotFoundException $e) {
+            throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
+        }
+    }
+
+    function createDirectory($name) {
+        throw new Forbidden('Permission denied to create collections');
+    }
+
+    function getChild($tagId) {
+        try {
+            if ($this->tagMapper->haveTag([$this->objectId], $this->objectType, $tagId, true)) {
+                $tag = $this->tagManager->getTagsByIds([$tagId]);
+                $tag = current($tag);
+                if ($this->tagManager->canUserSeeTag($tag, $this->user)) {
+                    return $this->makeNode($tag);
+                }
+            }
+            throw new NotFound('Tag with id ' . $tagId . ' not present for object ' . $this->objectId);
+        } catch (\InvalidArgumentException $e) {
+            throw new BadRequest('Invalid tag id', 0, $e);
+        } catch (TagNotFoundException $e) {
+            throw new NotFound('Tag with id ' . $tagId . ' not found', 0, $e);
+        }
+    }
+
+    function getChildren() {
+        $tagIds = current($this->tagMapper->getTagIdsForObjects([$this->objectId], $this->objectType));
+        if (empty($tagIds)) {
+            return [];
+        }
+        $tags = $this->tagManager->getTagsByIds($tagIds);
+
+        // filter out non-visible tags
+        $tags = array_filter($tags, function($tag) {
+            return $this->tagManager->canUserSeeTag($tag, $this->user);
+        });
+
+        return array_values(array_map(function($tag) {
+            return $this->makeNode($tag);
+        }, $tags));
+    }
+
+    function childExists($tagId) {
+        try {
+            $result = ($this->tagMapper->haveTag([$this->objectId], $this->objectType, $tagId, true));
+
+            if ($result) {
+                $tags = $this->tagManager->getTagsByIds([$tagId]);
+                $tag = current($tags);
+                if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
+                    return false;
+                }
+            }
+
+            return $result;
+        } catch (\InvalidArgumentException $e) {
+            throw new BadRequest('Invalid tag id', 0, $e);
+        } catch (TagNotFoundException $e) {
+            return false;
+        }
+    }
+
+    function delete() {
+        throw new Forbidden('Permission denied to delete this collection');
+    }
+
+    function getName() {
+        return $this->objectId;
+    }
+
+    function setName($name) {
+        throw new Forbidden('Permission denied to rename this collection');
+    }
+
+    /**
+     * Returns the last modification time, as a unix timestamp
+     *
+     * @return int
+     */
+    function getLastModified() {
+        return null;
+    }
+
+    /**
+     * Create a sabre node for the mapping of the 
+     * given system tag to the collection's object
+     *
+     * @param ISystemTag $tag
+     *
+     * @return SystemTagMappingNode
+     */
+    private function makeNode(ISystemTag $tag) {
+        return new SystemTagMappingNode(
+            $tag,
+            $this->objectId,
+            $this->objectType,
+            $this->user,
+            $this->tagManager,
+            $this->tagMapper
+        );
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -95,15 +95,15 @@ 
 			$tags = $this->tagManager->getTagsByIds([$tagId]);
 			$tag = current($tags);
 			if (!$this->tagManager->canUserSeeTag($tag, $this->user)) {
-				throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
+				throw new PreconditionFailed('Tag with id '.$tagId.' does not exist, cannot assign');
 			}
 			if (!$this->tagManager->canUserAssignTag($tag, $this->user)) {
-				throw new Forbidden('No permission to assign tag ' . $tagId);
+				throw new Forbidden('No permission to assign tag '.$tagId);
 			}
 
 			$this->tagMapper->assignTags($this->objectId, $this->objectType, $tagId);
 		} catch (TagNotFoundException $e) {
-			throw new PreconditionFailed('Tag with id ' . $tagId . ' does not exist, cannot assign');
+			throw new PreconditionFailed('Tag with id '.$tagId.' does not exist, cannot assign');
 		}
 	}
 
@@ -120,11 +120,11 @@ 
 					return $this->makeNode($tag);
 				}
 			}
-			throw new NotFound('Tag with id ' . $tagId . ' not present for object ' . $this->objectId);
+			throw new NotFound('Tag with id '.$tagId.' not present for object '.$this->objectId);
 		} catch (\InvalidArgumentException $e) {
 			throw new BadRequest('Invalid tag id', 0, $e);
 		} catch (TagNotFoundException $e) {
-			throw new NotFound('Tag with id ' . $tagId . ' not found', 0, $e);
+			throw new NotFound('Tag with id '.$tagId.' not found', 0, $e);
 		}
 	}