nextcloud / server

lib/private/SubAdmin.php

Indentation +246 added lines, -246 removed lines

@@ -39,252 +39,252 @@
 
 class SubAdmin extends PublicEmitter implements ISubAdmin {
 
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/**
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param IDBConnection $dbConn
-	 */
-	public function __construct(IUserManager $userManager,
-								IGroupManager $groupManager,
-								IDBConnection $dbConn) {
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->dbConn = $dbConn;
-
-		$this->userManager->listen('\OC\User', 'postDelete', function($user) {
-			$this->post_deleteUser($user);
-		});
-		$this->groupManager->listen('\OC\Group', 'postDelete', function($group) {
-			$this->post_deleteGroup($group);
-		});
-	}
-
-	/**
-	 * add a SubAdmin
-	 * @param IUser $user user to be SubAdmin
-	 * @param IGroup $group group $user becomes subadmin of
-	 */
-	public function createSubAdmin(IUser $user, IGroup $group): void {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->insert('group_admin')
-			->values([
-				'gid' => $qb->createNamedParameter($group->getGID()),
-				'uid' => $qb->createNamedParameter($user->getUID())
-			])
-			->execute();
-
-		$this->emit('\OC\SubAdmin', 'postCreateSubAdmin', [$user, $group]);
-		\OC_Hook::emit("OC_SubAdmin", "post_createSubAdmin", ["gid" => $group->getGID()]);
-	}
-
-	/**
-	 * delete a SubAdmin
-	 * @param IUser $user the user that is the SubAdmin
-	 * @param IGroup $group the group
-	 */
-	public function deleteSubAdmin(IUser $user, IGroup $group): void {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$this->emit('\OC\SubAdmin', 'postDeleteSubAdmin', [$user, $group]);
-		\OC_Hook::emit("OC_SubAdmin", "post_deleteSubAdmin", ["gid" => $group->getGID()]);
-	}
-
-	/**
-	 * get groups of a SubAdmin
-	 * @param IUser $user the SubAdmin
-	 * @return IGroup[]
-	 */
-	public function getSubAdminsGroups(IUser $user): array {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('gid')
-			->from('group_admin')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$groups = [];
-		while($row = $result->fetch()) {
-			$group = $this->groupManager->get($row['gid']);
-			if(!is_null($group)) {
-				$groups[$group->getGID()] = $group;
-			}
-		}
-		$result->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * get an array of groupid and displayName for a user
-	 * @param IUser $user
-	 * @return array ['displayName' => displayname]
-	 */
-	public function getSubAdminsGroupsName(IUser $user): array {
-		return array_map(function($group) {
-			return ['displayName' => $group->getDisplayName()];
-		}, $this->getSubAdminsGroups($user));
-	}
-
-	/**
-	 * get SubAdmins of a group
-	 * @param IGroup $group the group
-	 * @return IUser[]
-	 */
-	public function getGroupsSubAdmins(IGroup $group): array {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('uid')
-			->from('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->execute();
-
-		$users = [];
-		while($row = $result->fetch()) {
-			$user = $this->userManager->get($row['uid']);
-			if(!is_null($user)) {
-				$users[] = $user;
-			}
-		}
-		$result->closeCursor();
-
-		return $users;
-	}
-
-	/**
-	 * get all SubAdmins
-	 * @return array
-	 */
-	public function getAllSubAdmins(): array {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('*')
-			->from('group_admin')
-			->execute();
-
-		$subadmins = [];
-		while($row = $result->fetch()) {
-			$user = $this->userManager->get($row['uid']);
-			$group = $this->groupManager->get($row['gid']);
-			if(!is_null($user) && !is_null($group)) {
-				$subadmins[] = [
-					'user'  => $user,
-					'group' => $group
-				];
-			}
-		}
-		$result->closeCursor();
-
-		return $subadmins;
-	}
-
-	/**
-	 * checks if a user is a SubAdmin of a group
-	 * @param IUser $user
-	 * @param IGroup $group
-	 * @return bool
-	 */
-	public function isSubAdminOfGroup(IUser $user, IGroup $group): bool {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		/*
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /**
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param IDBConnection $dbConn
+     */
+    public function __construct(IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                IDBConnection $dbConn) {
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->dbConn = $dbConn;
+
+        $this->userManager->listen('\OC\User', 'postDelete', function($user) {
+            $this->post_deleteUser($user);
+        });
+        $this->groupManager->listen('\OC\Group', 'postDelete', function($group) {
+            $this->post_deleteGroup($group);
+        });
+    }
+
+    /**
+     * add a SubAdmin
+     * @param IUser $user user to be SubAdmin
+     * @param IGroup $group group $user becomes subadmin of
+     */
+    public function createSubAdmin(IUser $user, IGroup $group): void {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->insert('group_admin')
+            ->values([
+                'gid' => $qb->createNamedParameter($group->getGID()),
+                'uid' => $qb->createNamedParameter($user->getUID())
+            ])
+            ->execute();
+
+        $this->emit('\OC\SubAdmin', 'postCreateSubAdmin', [$user, $group]);
+        \OC_Hook::emit("OC_SubAdmin", "post_createSubAdmin", ["gid" => $group->getGID()]);
+    }
+
+    /**
+     * delete a SubAdmin
+     * @param IUser $user the user that is the SubAdmin
+     * @param IGroup $group the group
+     */
+    public function deleteSubAdmin(IUser $user, IGroup $group): void {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $this->emit('\OC\SubAdmin', 'postDeleteSubAdmin', [$user, $group]);
+        \OC_Hook::emit("OC_SubAdmin", "post_deleteSubAdmin", ["gid" => $group->getGID()]);
+    }
+
+    /**
+     * get groups of a SubAdmin
+     * @param IUser $user the SubAdmin
+     * @return IGroup[]
+     */
+    public function getSubAdminsGroups(IUser $user): array {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('gid')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $groups = [];
+        while($row = $result->fetch()) {
+            $group = $this->groupManager->get($row['gid']);
+            if(!is_null($group)) {
+                $groups[$group->getGID()] = $group;
+            }
+        }
+        $result->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * get an array of groupid and displayName for a user
+     * @param IUser $user
+     * @return array ['displayName' => displayname]
+     */
+    public function getSubAdminsGroupsName(IUser $user): array {
+        return array_map(function($group) {
+            return ['displayName' => $group->getDisplayName()];
+        }, $this->getSubAdminsGroups($user));
+    }
+
+    /**
+     * get SubAdmins of a group
+     * @param IGroup $group the group
+     * @return IUser[]
+     */
+    public function getGroupsSubAdmins(IGroup $group): array {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('uid')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->execute();
+
+        $users = [];
+        while($row = $result->fetch()) {
+            $user = $this->userManager->get($row['uid']);
+            if(!is_null($user)) {
+                $users[] = $user;
+            }
+        }
+        $result->closeCursor();
+
+        return $users;
+    }
+
+    /**
+     * get all SubAdmins
+     * @return array
+     */
+    public function getAllSubAdmins(): array {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('*')
+            ->from('group_admin')
+            ->execute();
+
+        $subadmins = [];
+        while($row = $result->fetch()) {
+            $user = $this->userManager->get($row['uid']);
+            $group = $this->groupManager->get($row['gid']);
+            if(!is_null($user) && !is_null($group)) {
+                $subadmins[] = [
+                    'user'  => $user,
+                    'group' => $group
+                ];
+            }
+        }
+        $result->closeCursor();
+
+        return $subadmins;
+    }
+
+    /**
+     * checks if a user is a SubAdmin of a group
+     * @param IUser $user
+     * @param IGroup $group
+     * @return bool
+     */
+    public function isSubAdminOfGroup(IUser $user, IGroup $group): bool {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        /*
 		 * Primary key is ('gid', 'uid') so max 1 result possible here
 		 */
-		$result = $qb->select('*')
-			->from('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-
-		$fetch =  $result->fetch();
-		$result->closeCursor();
-		$result = !empty($fetch) ? true : false;
-
-		return $result;
-	}
-
-	/**
-	 * checks if a user is a SubAdmin
-	 * @param IUser $user
-	 * @return bool
-	 */
-	public function isSubAdmin(IUser $user): bool {
-		// Check if the user is already an admin
-		if ($this->groupManager->isAdmin($user->getUID())) {
-			return true;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$result = $qb->select('gid')
-			->from('group_admin')
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->setMaxResults(1)
-			->execute();
-
-		$isSubAdmin = $result->fetch();
-		$result->closeCursor();
-
-		return $isSubAdmin !== false;
-	}
-
-	/**
-	 * checks if a user is a accessible by a subadmin
-	 * @param IUser $subadmin
-	 * @param IUser $user
-	 * @return bool
-	 */
-	public function isUserAccessible(IUser $subadmin, IUser $user): bool {
-		if(!$this->isSubAdmin($subadmin)) {
-			return false;
-		}
-		if($this->groupManager->isAdmin($user->getUID())) {
-			return false;
-		}
-		$accessibleGroups = $this->getSubAdminsGroups($subadmin);
-		foreach($accessibleGroups as $accessibleGroup) {
-			if($accessibleGroup->inGroup($user)) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * delete all SubAdmins by $user
-	 * @param IUser $user
-	 */
-	private function post_deleteUser(IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
-			->execute();
-	}
-
-	/**
-	 * delete all SubAdmins by $group
-	 * @param IGroup $group
-	 */
-	private function post_deleteGroup(IGroup $group) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
-			->execute();
-	}
+        $result = $qb->select('*')
+            ->from('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+
+        $fetch =  $result->fetch();
+        $result->closeCursor();
+        $result = !empty($fetch) ? true : false;
+
+        return $result;
+    }
+
+    /**
+     * checks if a user is a SubAdmin
+     * @param IUser $user
+     * @return bool
+     */
+    public function isSubAdmin(IUser $user): bool {
+        // Check if the user is already an admin
+        if ($this->groupManager->isAdmin($user->getUID())) {
+            return true;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $result = $qb->select('gid')
+            ->from('group_admin')
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->setMaxResults(1)
+            ->execute();
+
+        $isSubAdmin = $result->fetch();
+        $result->closeCursor();
+
+        return $isSubAdmin !== false;
+    }
+
+    /**
+     * checks if a user is a accessible by a subadmin
+     * @param IUser $subadmin
+     * @param IUser $user
+     * @return bool
+     */
+    public function isUserAccessible(IUser $subadmin, IUser $user): bool {
+        if(!$this->isSubAdmin($subadmin)) {
+            return false;
+        }
+        if($this->groupManager->isAdmin($user->getUID())) {
+            return false;
+        }
+        $accessibleGroups = $this->getSubAdminsGroups($subadmin);
+        foreach($accessibleGroups as $accessibleGroup) {
+            if($accessibleGroup->inGroup($user)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * delete all SubAdmins by $user
+     * @param IUser $user
+     */
+    private function post_deleteUser(IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID())))
+            ->execute();
+    }
+
+    /**
+     * delete all SubAdmins by $group
+     * @param IGroup $group
+     */
+    private function post_deleteGroup(IGroup $group) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($group->getGID())))
+            ->execute();
+    }
 }

lib/private/Share/Share.php

Indentation +1496 added lines, -1496 removed lines

@@ -49,1500 +49,1500 @@
  */
 class Share extends Constants {
 
-	/** CRUDS permissions (Create, Read, Update, Delete, Share) using a bitmask
-	 * Construct permissions for share() and setPermissions with Or (|) e.g.
-	 * Give user read and update permissions: PERMISSION_READ | PERMISSION_UPDATE
-	 *
-	 * Check if permission is granted with And (&) e.g. Check if delete is
-	 * granted: if ($permissions & PERMISSION_DELETE)
-	 *
-	 * Remove permissions with And (&) and Not (~) e.g. Remove the update
-	 * permission: $permissions &= ~PERMISSION_UPDATE
-	 *
-	 * Apps are required to handle permissions on their own, this class only
-	 * stores and manages the permissions of shares
-	 * @see lib/public/constants.php
-	 */
-
-	/**
-	 * Register a sharing backend class that implements OCP\Share_Backend for an item type
-	 * @param string $itemType Item type
-	 * @param string $class Backend class
-	 * @param string $collectionOf (optional) Depends on item type
-	 * @param array $supportedFileExtensions (optional) List of supported file extensions if this item type depends on files
-	 * @return boolean true if backend is registered or false if error
-	 */
-	public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
-		if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_enabled', 'yes') == 'yes') {
-			if (!isset(self::$backendTypes[$itemType])) {
-				self::$backendTypes[$itemType] = [
-					'class' => $class,
-					'collectionOf' => $collectionOf,
-					'supportedFileExtensions' => $supportedFileExtensions
-				];
-				return true;
-			}
-			\OCP\Util::writeLog('OCP\Share',
-				'Sharing backend '.$class.' not registered, '.self::$backendTypes[$itemType]['class']
-				.' is already registered for '.$itemType,
-				ILogger::WARN);
-		}
-		return false;
-	}
-
-	/**
-	 * Get the items of item type shared with the current user
-	 * @param string $itemType
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters (optional)
-	 * @param int $limit Number of items to return (optional) Returns all by default
-	 * @param boolean $includeCollections (optional)
-	 * @return mixed Return depends on format
-	 * @deprecated TESTS ONLY - this methods is only used by tests
-	 * called like this:
-	 * \OC\Share\Share::getItemsSharedWith('folder'); (apps/files_sharing/tests/UpdaterTest.php)
-	 */
-	public static function getItemsSharedWith() {
-		return self::getItems('folder', null, self::$shareTypeUserAndGroups, \OC_User::getUser(), null, self::FORMAT_NONE,
-			null, -1, false);
-	}
-
-	/**
-	 * Get the items of item type shared with a user
-	 * @param string $itemType
-	 * @param string $user id for which user we want the shares
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters (optional)
-	 * @param int $limit Number of items to return (optional) Returns all by default
-	 * @param boolean $includeCollections (optional)
-	 * @return mixed Return depends on format
-	 */
-	public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
-												  $parameters = null, $limit = -1, $includeCollections = false) {
-		return self::getItems($itemType, null, self::$shareTypeUserAndGroups, $user, null, $format,
-			$parameters, $limit, $includeCollections);
-	}
-
-	/**
-	 * Get the item of item type shared with a given user by source
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param string $user User to whom the item was shared
-	 * @param string $owner Owner of the share
-	 * @param int $shareType only look for a specific share type
-	 * @return array Return list of items with file_target, permissions and expiration
-	 */
-	public static function getItemSharedWithUser($itemType, $itemSource, $user, $owner = null, $shareType = null) {
-		$shares = [];
-		$fileDependent = false;
-
-		$where = 'WHERE';
-		$fileDependentWhere = '';
-		if ($itemType === 'file' || $itemType === 'folder') {
-			$fileDependent = true;
-			$column = 'file_source';
-			$fileDependentWhere = 'INNER JOIN `*PREFIX*filecache` ON `file_source` = `*PREFIX*filecache`.`fileid` ';
-			$fileDependentWhere .= 'INNER JOIN `*PREFIX*storages` ON `numeric_id` = `*PREFIX*filecache`.`storage` ';
-		} else {
-			$column = 'item_source';
-		}
-
-		$select = self::createSelectStatement(self::FORMAT_NONE, $fileDependent);
-
-		$where .= ' `' . $column . '` = ? AND `item_type` = ? ';
-		$arguments = [$itemSource, $itemType];
-		// for link shares $user === null
-		if ($user !== null) {
-			$where .= ' AND `share_with` = ? ';
-			$arguments[] = $user;
-		}
-
-		if ($shareType !== null) {
-			$where .= ' AND `share_type` = ? ';
-			$arguments[] = $shareType;
-		}
-
-		if ($owner !== null) {
-			$where .= ' AND `uid_owner` = ? ';
-			$arguments[] = $owner;
-		}
-
-		$query = \OC_DB::prepare('SELECT ' . $select . ' FROM `*PREFIX*share` '. $fileDependentWhere . $where);
-
-		$result = \OC_DB::executeAudited($query, $arguments);
-
-		while ($row = $result->fetchRow()) {
-			if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
-				continue;
-			}
-			if ($fileDependent && (int)$row['file_parent'] === -1) {
-				// if it is a mount point we need to get the path from the mount manager
-				$mountManager = \OC\Files\Filesystem::getMountManager();
-				$mountPoint = $mountManager->findByStorageId($row['storage_id']);
-				if (!empty($mountPoint)) {
-					$path = $mountPoint[0]->getMountPoint();
-					$path = trim($path, '/');
-					$path = substr($path, strlen($owner) + 1); //normalize path to 'files/foo.txt`
-					$row['path'] = $path;
-				} else {
-					\OC::$server->getLogger()->warning(
-						'Could not resolve mount point for ' . $row['storage_id'],
-						['app' => 'OCP\Share']
-					);
-				}
-			}
-			$shares[] = $row;
-		}
-
-		//if didn't found a result than let's look for a group share.
-		if(empty($shares) && $user !== null) {
-			$userObject = \OC::$server->getUserManager()->get($user);
-			$groups = [];
-			if ($userObject) {
-				$groups = \OC::$server->getGroupManager()->getUserGroupIds($userObject);
-			}
-
-			if (!empty($groups)) {
-				$where = $fileDependentWhere . ' WHERE `' . $column . '` = ? AND `item_type` = ? AND `share_with` in (?)';
-				$arguments = [$itemSource, $itemType, $groups];
-				$types = [null, null, IQueryBuilder::PARAM_STR_ARRAY];
-
-				if ($owner !== null) {
-					$where .= ' AND `uid_owner` = ?';
-					$arguments[] = $owner;
-					$types[] = null;
-				}
-
-				// TODO: inject connection, hopefully one day in the future when this
-				// class isn't static anymore...
-				$conn = \OC::$server->getDatabaseConnection();
-				$result = $conn->executeQuery(
-					'SELECT ' . $select . ' FROM `*PREFIX*share` ' . $where,
-					$arguments,
-					$types
-				);
-
-				while ($row = $result->fetch()) {
-					$shares[] = $row;
-				}
-			}
-		}
-
-		return $shares;
-
-	}
-
-	/**
-	 * Get the item of item type shared with the current user by source
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters
-	 * @param boolean $includeCollections
-	 * @param string $shareWith (optional) define against which user should be checked, default: current user
-	 * @return array
-	 */
-	public static function getItemSharedWithBySource($itemType, $itemSource, $format = self::FORMAT_NONE,
-													 $parameters = null, $includeCollections = false, $shareWith = null) {
-		$shareWith = ($shareWith === null) ? \OC_User::getUser() : $shareWith;
-		return self::getItems($itemType, $itemSource, self::$shareTypeUserAndGroups, $shareWith, null, $format,
-			$parameters, 1, $includeCollections, true);
-	}
-
-	/**
-	 * Get the shared item of item type owned by the current user
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters
-	 * @param boolean $includeCollections
-	 * @return mixed Return depends on format
-	 */
-	public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
-										 $parameters = null, $includeCollections = false) {
-		return self::getItems($itemType, $itemSource, null, null, \OC_User::getUser(), $format,
-			$parameters, -1, $includeCollections);
-	}
-
-	/**
-	 * Share an item with a user, group, or via private link
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
-	 * @param string $shareWith User or group the item is being shared with
-	 * @param int $permissions CRUDS
-	 * @param string $itemSourceName
-	 * @param \DateTime|null $expirationDate
-	 * @return boolean|string Returns true on success or false on failure, Returns token on success for links
-	 * @throws \OC\HintException when the share type is remote and the shareWith is invalid
-	 * @throws \Exception
-	 * @since 5.0.0 - parameter $itemSourceName was added in 6.0.0, parameter $expirationDate was added in 7.0.0, parameter $passwordChanged added in 9.0.0
-	 * @deprecated 14.0.0 TESTS ONLY - this methods is as of 2018-06 only used by tests
-	 * called like this:
-	 * \OC\Share\Share::shareItem('test', 1, \OCP\Share::SHARE_TYPE_USER, $otherUserId, \OCP\Constants::PERMISSION_READ);
-	 */
-	public static function shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions) {
-		$backend = self::getBackend($itemType);
-
-		if ($backend->isShareTypeAllowed($shareType) === false) {
-			$message = 'Sharing failed, because the backend does not allow shares from type %i';
-			throw new \Exception(sprintf($message, $shareType));
-		}
-
-		$uidOwner = \OC_User::getUser();
-
-		// Verify share type and sharing conditions are met
-		if ($shareType === self::SHARE_TYPE_USER) {
-			if ($shareWith == $uidOwner) {
-				$message = 'Sharing failed, because you can not share with yourself';
-				throw new \Exception($message);
-			}
-			if (!\OC::$server->getUserManager()->userExists($shareWith)) {
-				$message = 'Sharing failed, because the user %s does not exist';
-				throw new \Exception(sprintf($message, $shareWith));
-			}
-			// Check if the item source is already shared with the user, either from the same owner or a different user
-			if ($checkExists = self::getItems($itemType, $itemSource, self::$shareTypeUserAndGroups,
-				$shareWith, null, self::FORMAT_NONE, null, 1, true, true)) {
-				// Only allow the same share to occur again if it is the same
-				// owner and is not a user share, this use case is for increasing
-				// permissions for a specific user
-				if ($checkExists['uid_owner'] != $uidOwner || $checkExists['share_type'] == $shareType) {
-					$message = 'Sharing failed, because this item is already shared with %s';
-					throw new \Exception(sprintf($message, $shareWith));
-				}
-			}
-			if ($checkExists = self::getItems($itemType, $itemSource, self::SHARE_TYPE_USER,
-				$shareWith, null, self::FORMAT_NONE, null, 1, true, true)) {
-				// Only allow the same share to occur again if it is the same
-				// owner and is not a user share, this use case is for increasing
-				// permissions for a specific user
-				if ($checkExists['uid_owner'] != $uidOwner || $checkExists['share_type'] == $shareType) {
-					$message = 'Sharing failed, because this item is already shared with user %s';
-					throw new \Exception(sprintf($message, $shareWith));
-				}
-			}
-		}
-
-		// Put the item into the database
-		$result = self::put('test', $itemSource, self::SHARE_TYPE_USER, $shareWith, $uidOwner, $permissions);
-
-		return $result ? true : false;
-	}
-
-	/**
-	 * Unshare an item from a user, group, or delete a private link
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
-	 * @param string $shareWith User or group the item is being shared with
-	 * @param string $owner owner of the share, if null the current user is used
-	 * @return boolean true on success or false on failure
-	 */
-	public static function unshare($itemType, $itemSource, $shareType, $shareWith, $owner = null) {
-
-		// check if it is a valid itemType
-		self::getBackend($itemType);
-
-		$items = self::getItemSharedWithUser($itemType, $itemSource, $shareWith, $owner, $shareType);
-
-		$toDelete = [];
-		$newParent = null;
-		$currentUser = $owner ? $owner : \OC_User::getUser();
-		foreach ($items as $item) {
-			// delete the item with the expected share_type and owner
-			if ((int)$item['share_type'] === (int)$shareType && $item['uid_owner'] === $currentUser) {
-				$toDelete = $item;
-				// if there is more then one result we don't have to delete the children
-				// but update their parent. For group shares the new parent should always be
-				// the original group share and not the db entry with the unique name
-			} else if ((int)$item['share_type'] === self::$shareTypeGroupUserUnique) {
-				$newParent = $item['parent'];
-			} else {
-				$newParent = $item['id'];
-			}
-		}
-
-		if (!empty($toDelete)) {
-			self::unshareItem($toDelete, $newParent);
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Checks whether a share has expired, calls unshareItem() if yes.
-	 * @param array $item Share data (usually database row)
-	 * @return boolean True if item was expired, false otherwise.
-	 */
-	protected static function expireItem(array $item) {
-
-		$result = false;
-
-		// only use default expiration date for link shares
-		if ((int) $item['share_type'] === self::SHARE_TYPE_LINK) {
-
-			// calculate expiration date
-			if (!empty($item['expiration'])) {
-				$userDefinedExpire = new \DateTime($item['expiration']);
-				$expires = $userDefinedExpire->getTimestamp();
-			} else {
-				$expires = null;
-			}
-
-
-			// get default expiration settings
-			$defaultSettings = Helper::getDefaultExpireSetting();
-			$expires = Helper::calculateExpireDate($defaultSettings, $item['stime'], $expires);
-
-
-			if (is_int($expires)) {
-				$now = time();
-				if ($now > $expires) {
-					self::unshareItem($item);
-					$result = true;
-				}
-			}
-		}
-		return $result;
-	}
-
-	/**
-	 * Unshares a share given a share data array
-	 * @param array $item Share data (usually database row)
-	 * @param int $newParent parent ID
-	 * @return null
-	 */
-	protected static function unshareItem(array $item, $newParent = null) {
-
-		$shareType = (int)$item['share_type'];
-		$shareWith = null;
-		if ($shareType !== \OCP\Share::SHARE_TYPE_LINK) {
-			$shareWith = $item['share_with'];
-		}
-
-		// Pass all the vars we have for now, they may be useful
-		$hookParams = [
-			'id'            => $item['id'],
-			'itemType'      => $item['item_type'],
-			'itemSource'    => $item['item_source'],
-			'shareType'     => $shareType,
-			'shareWith'     => $shareWith,
-			'itemParent'    => $item['parent'],
-			'uidOwner'      => $item['uid_owner'],
-		];
-		if($item['item_type'] === 'file' || $item['item_type'] === 'folder') {
-			$hookParams['fileSource'] = $item['file_source'];
-			$hookParams['fileTarget'] = $item['file_target'];
-		}
-
-		\OC_Hook::emit(\OCP\Share::class, 'pre_unshare', $hookParams);
-		$deletedShares = Helper::delete($item['id'], false, null, $newParent);
-		$deletedShares[] = $hookParams;
-		$hookParams['deletedShares'] = $deletedShares;
-		\OC_Hook::emit(\OCP\Share::class, 'post_unshare', $hookParams);
-		if ((int)$item['share_type'] === \OCP\Share::SHARE_TYPE_REMOTE && \OC::$server->getUserSession()->getUser()) {
-			list(, $remote) = Helper::splitUserRemote($item['share_with']);
-			self::sendRemoteUnshare($remote, $item['id'], $item['token']);
-		}
-	}
-
-	/**
-	 * Get the backend class for the specified item type
-	 * @param string $itemType
-	 * @throws \Exception
-	 * @return \OCP\Share_Backend
-	 */
-	public static function getBackend($itemType) {
-		$l = \OC::$server->getL10N('lib');
-		if (isset(self::$backends[$itemType])) {
-			return self::$backends[$itemType];
-		} else if (isset(self::$backendTypes[$itemType]['class'])) {
-			$class = self::$backendTypes[$itemType]['class'];
-			if (class_exists($class)) {
-				self::$backends[$itemType] = new $class;
-				if (!(self::$backends[$itemType] instanceof \OCP\Share_Backend)) {
-					$message = 'Sharing backend %s must implement the interface OCP\Share_Backend';
-					$message_t = $l->t('Sharing backend %s must implement the interface OCP\Share_Backend', [$class]);
-					\OCP\Util::writeLog('OCP\Share', sprintf($message, $class), ILogger::ERROR);
-					throw new \Exception($message_t);
-				}
-				return self::$backends[$itemType];
-			} else {
-				$message = 'Sharing backend %s not found';
-				$message_t = $l->t('Sharing backend %s not found', [$class]);
-				\OCP\Util::writeLog('OCP\Share', sprintf($message, $class), ILogger::ERROR);
-				throw new \Exception($message_t);
-			}
-		}
-		$message = 'Sharing backend for %s not found';
-		$message_t = $l->t('Sharing backend for %s not found', [$itemType]);
-		\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemType), ILogger::ERROR);
-		throw new \Exception($message_t);
-	}
-
-	/**
-	 * Check if resharing is allowed
-	 * @return boolean true if allowed or false
-	 *
-	 * Resharing is allowed by default if not configured
-	 */
-	public static function isResharingAllowed() {
-		if (!isset(self::$isResharingAllowed)) {
-			if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_allow_resharing', 'yes') == 'yes') {
-				self::$isResharingAllowed = true;
-			} else {
-				self::$isResharingAllowed = false;
-			}
-		}
-		return self::$isResharingAllowed;
-	}
-
-	/**
-	 * Get a list of collection item types for the specified item type
-	 * @param string $itemType
-	 * @return array
-	 */
-	private static function getCollectionItemTypes($itemType) {
-		$collectionTypes = [$itemType];
-		foreach (self::$backendTypes as $type => $backend) {
-			if (in_array($backend['collectionOf'], $collectionTypes)) {
-				$collectionTypes[] = $type;
-			}
-		}
-		// TODO Add option for collections to be collection of themselves, only 'folder' does it now...
-		if (isset(self::$backendTypes[$itemType]) && (!self::getBackend($itemType) instanceof \OCP\Share_Backend_Collection || $itemType != 'folder')) {
-			unset($collectionTypes[0]);
-		}
-		// Return array if collections were found or the item type is a
-		// collection itself - collections can be inside collections
-		if (count($collectionTypes) > 0) {
-			return $collectionTypes;
-		}
-		return false;
-	}
-
-	/**
-	 * Get the owners of items shared with a user.
-	 *
-	 * @param string $user The user the items are shared with.
-	 * @param string $type The type of the items shared with the user.
-	 * @param boolean $includeCollections Include collection item types (optional)
-	 * @param boolean $includeOwner include owner in the list of users the item is shared with (optional)
-	 * @return array
-	 * @deprecated TESTS ONLY - this methods is only used by tests
-	 * called like this:
-	 * \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true)
-	 */
-	public static function getSharedItemsOwners($user, $type, $includeCollections = false, $includeOwner = false) {
-		// First, we find out if $type is part of a collection (and if that collection is part of
-		// another one and so on).
-		$collectionTypes = [];
-		if (!$includeCollections || !$collectionTypes = self::getCollectionItemTypes($type)) {
-			$collectionTypes[] = $type;
-		}
-
-		// Of these collection types, along with our original $type, we make a
-		// list of the ones for which a sharing backend has been registered.
-		// FIXME: Ideally, we wouldn't need to nest getItemsSharedWith in this loop but just call it
-		// with its $includeCollections parameter set to true. Unfortunately, this fails currently.
-		$allMaybeSharedItems = [];
-		foreach ($collectionTypes as $collectionType) {
-			if (isset(self::$backends[$collectionType])) {
-				$allMaybeSharedItems[$collectionType] = self::getItemsSharedWithUser(
-					$collectionType,
-					$user,
-					self::FORMAT_NONE
-				);
-			}
-		}
-
-		$owners = [];
-		if ($includeOwner) {
-			$owners[] = $user;
-		}
-
-		// We take a look at all shared items of the given $type (or of the collections it is part of)
-		// and find out their owners. Then, we gather the tags for the original $type from all owners,
-		// and return them as elements of a list that look like "Tag (owner)".
-		foreach ($allMaybeSharedItems as $collectionType => $maybeSharedItems) {
-			foreach ($maybeSharedItems as $sharedItem) {
-				if (isset($sharedItem['id'])) { //workaround for https://github.com/owncloud/core/issues/2814
-					$owners[] = $sharedItem['uid_owner'];
-				}
-			}
-		}
-
-		return $owners;
-	}
-
-	/**
-	 * Get shared items from the database
-	 * @param string $itemType
-	 * @param string $item Item source or target (optional)
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique
-	 * @param string $shareWith User or group the item is being shared with
-	 * @param string $uidOwner User that is the owner of shared items (optional)
-	 * @param int $format Format to convert items to with formatItems() (optional)
-	 * @param mixed $parameters to pass to formatItems() (optional)
-	 * @param int $limit Number of items to return, -1 to return all matches (optional)
-	 * @param boolean $includeCollections Include collection item types (optional)
-	 * @param boolean $itemShareWithBySource (optional)
-	 * @param boolean $checkExpireDate
-	 * @return array
-	 *
-	 * See public functions getItem(s)... for parameter usage
-	 *
-	 */
-	public static function getItems($itemType, $item = null, $shareType = null, $shareWith = null,
-									$uidOwner = null, $format = self::FORMAT_NONE, $parameters = null, $limit = -1,
-									$includeCollections = false, $itemShareWithBySource = false, $checkExpireDate  = true) {
-		if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_enabled', 'yes') != 'yes') {
-			return [];
-		}
-		$backend = self::getBackend($itemType);
-		$collectionTypes = false;
-		// Get filesystem root to add it to the file target and remove from the
-		// file source, match file_source with the file cache
-		if ($itemType == 'file' || $itemType == 'folder') {
-			if(!is_null($uidOwner)) {
-				$root = \OC\Files\Filesystem::getRoot();
-			} else {
-				$root = '';
-			}
-			$where = 'INNER JOIN `*PREFIX*filecache` ON `file_source` = `*PREFIX*filecache`.`fileid` ';
-			if (!isset($item)) {
-				$where .= ' AND `file_target` IS NOT NULL ';
-			}
-			$where .= 'INNER JOIN `*PREFIX*storages` ON `numeric_id` = `*PREFIX*filecache`.`storage` ';
-			$fileDependent = true;
-			$queryArgs = [];
-		} else {
-			$fileDependent = false;
-			$root = '';
-			$collectionTypes = self::getCollectionItemTypes($itemType);
-			if ($includeCollections && !isset($item) && $collectionTypes) {
-				// If includeCollections is true, find collections of this item type, e.g. a music album contains songs
-				if (!in_array($itemType, $collectionTypes)) {
-					$itemTypes = array_merge([$itemType], $collectionTypes);
-				} else {
-					$itemTypes = $collectionTypes;
-				}
-				$placeholders = implode(',', array_fill(0, count($itemTypes), '?'));
-				$where = ' WHERE `item_type` IN ('.$placeholders.'))';
-				$queryArgs = $itemTypes;
-			} else {
-				$where = ' WHERE `item_type` = ?';
-				$queryArgs = [$itemType];
-			}
-		}
-		if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_allow_links', 'yes') !== 'yes') {
-			$where .= ' AND `share_type` != ?';
-			$queryArgs[] = self::SHARE_TYPE_LINK;
-		}
-		if (isset($shareType)) {
-			// Include all user and group items
-			if ($shareType == self::$shareTypeUserAndGroups && isset($shareWith)) {
-				$where .= ' AND ((`share_type` in (?, ?) AND `share_with` = ?) ';
-				$queryArgs[] = self::SHARE_TYPE_USER;
-				$queryArgs[] = self::$shareTypeGroupUserUnique;
-				$queryArgs[] = $shareWith;
-
-				$user = \OC::$server->getUserManager()->get($shareWith);
-				$groups = [];
-				if ($user) {
-					$groups = \OC::$server->getGroupManager()->getUserGroupIds($user);
-				}
-				if (!empty($groups)) {
-					$placeholders = implode(',', array_fill(0, count($groups), '?'));
-					$where .= ' OR (`share_type` = ? AND `share_with` IN ('.$placeholders.')) ';
-					$queryArgs[] = self::SHARE_TYPE_GROUP;
-					$queryArgs = array_merge($queryArgs, $groups);
-				}
-				$where .= ')';
-				// Don't include own group shares
-				$where .= ' AND `uid_owner` != ?';
-				$queryArgs[] = $shareWith;
-			} else {
-				$where .= ' AND `share_type` = ?';
-				$queryArgs[] = $shareType;
-				if (isset($shareWith)) {
-					$where .= ' AND `share_with` = ?';
-					$queryArgs[] = $shareWith;
-				}
-			}
-		}
-		if (isset($uidOwner)) {
-			$where .= ' AND `uid_owner` = ?';
-			$queryArgs[] = $uidOwner;
-			if (!isset($shareType)) {
-				// Prevent unique user targets for group shares from being selected
-				$where .= ' AND `share_type` != ?';
-				$queryArgs[] = self::$shareTypeGroupUserUnique;
-			}
-			if ($fileDependent) {
-				$column = 'file_source';
-			} else {
-				$column = 'item_source';
-			}
-		} else {
-			if ($fileDependent) {
-				$column = 'file_target';
-			} else {
-				$column = 'item_target';
-			}
-		}
-		if (isset($item)) {
-			$collectionTypes = self::getCollectionItemTypes($itemType);
-			if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
-				$where .= ' AND (';
-			} else {
-				$where .= ' AND';
-			}
-			// If looking for own shared items, check item_source else check item_target
-			if (isset($uidOwner) || $itemShareWithBySource) {
-				// If item type is a file, file source needs to be checked in case the item was converted
-				if ($fileDependent) {
-					$where .= ' `file_source` = ?';
-					$column = 'file_source';
-				} else {
-					$where .= ' `item_source` = ?';
-					$column = 'item_source';
-				}
-			} else {
-				if ($fileDependent) {
-					$where .= ' `file_target` = ?';
-					$item = \OC\Files\Filesystem::normalizePath($item);
-				} else {
-					$where .= ' `item_target` = ?';
-				}
-			}
-			$queryArgs[] = $item;
-			if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
-				$placeholders = implode(',', array_fill(0, count($collectionTypes), '?'));
-				$where .= ' OR `item_type` IN ('.$placeholders.'))';
-				$queryArgs = array_merge($queryArgs, $collectionTypes);
-			}
-		}
-
-		if ($shareType == self::$shareTypeUserAndGroups && $limit === 1) {
-			// Make sure the unique user target is returned if it exists,
-			// unique targets should follow the group share in the database
-			// If the limit is not 1, the filtering can be done later
-			$where .= ' ORDER BY `*PREFIX*share`.`id` DESC';
-		} else {
-			$where .= ' ORDER BY `*PREFIX*share`.`id` ASC';
-		}
-
-		if ($limit != -1 && !$includeCollections) {
-			// The limit must be at least 3, because filtering needs to be done
-			if ($limit < 3) {
-				$queryLimit = 3;
-			} else {
-				$queryLimit = $limit;
-			}
-		} else {
-			$queryLimit = null;
-		}
-		$select = self::createSelectStatement($format, $fileDependent, $uidOwner);
-		$root = strlen($root);
-		$query = \OC_DB::prepare('SELECT '.$select.' FROM `*PREFIX*share` '.$where, $queryLimit);
-		$result = $query->execute($queryArgs);
-		if ($result === false) {
-			\OCP\Util::writeLog('OCP\Share',
-				\OC_DB::getErrorMessage() . ', select=' . $select . ' where=',
-				ILogger::ERROR);
-		}
-		$items = [];
-		$targets = [];
-		$switchedItems = [];
-		$mounts = [];
-		while ($row = $result->fetchRow()) {
-			self::transformDBResults($row);
-			// Filter out duplicate group shares for users with unique targets
-			if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
-				continue;
-			}
-			if ($row['share_type'] == self::$shareTypeGroupUserUnique && isset($items[$row['parent']])) {
-				$row['share_type'] = self::SHARE_TYPE_GROUP;
-				$row['unique_name'] = true; // remember that we use a unique name for this user
-				$row['share_with'] = $items[$row['parent']]['share_with'];
-				// if the group share was unshared from the user we keep the permission, otherwise
-				// we take the permission from the parent because this is always the up-to-date
-				// permission for the group share
-				if ($row['permissions'] > 0) {
-					$row['permissions'] = $items[$row['parent']]['permissions'];
-				}
-				// Remove the parent group share
-				unset($items[$row['parent']]);
-				if ($row['permissions'] == 0) {
-					continue;
-				}
-			} else if (!isset($uidOwner)) {
-				// Check if the same target already exists
-				if (isset($targets[$row['id']])) {
-					// Check if the same owner shared with the user twice
-					// through a group and user share - this is allowed
-					$id = $targets[$row['id']];
-					if (isset($items[$id]) && $items[$id]['uid_owner'] == $row['uid_owner']) {
-						// Switch to group share type to ensure resharing conditions aren't bypassed
-						if ($items[$id]['share_type'] != self::SHARE_TYPE_GROUP) {
-							$items[$id]['share_type'] = self::SHARE_TYPE_GROUP;
-							$items[$id]['share_with'] = $row['share_with'];
-						}
-						// Switch ids if sharing permission is granted on only
-						// one share to ensure correct parent is used if resharing
-						if (~(int)$items[$id]['permissions'] & \OCP\Constants::PERMISSION_SHARE
-							&& (int)$row['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
-							$items[$row['id']] = $items[$id];
-							$switchedItems[$id] = $row['id'];
-							unset($items[$id]);
-							$id = $row['id'];
-						}
-						$items[$id]['permissions'] |= (int)$row['permissions'];
-
-					}
-					continue;
-				} elseif (!empty($row['parent'])) {
-					$targets[$row['parent']] = $row['id'];
-				}
-			}
-			// Remove root from file source paths if retrieving own shared items
-			if (isset($uidOwner) && isset($row['path'])) {
-				if (isset($row['parent'])) {
-					$query = \OC_DB::prepare('SELECT `file_target` FROM `*PREFIX*share` WHERE `id` = ?');
-					$parentResult = $query->execute([$row['parent']]);
-					if ($result === false) {
-						\OCP\Util::writeLog('OCP\Share', 'Can\'t select parent: ' .
-							\OC_DB::getErrorMessage() . ', select=' . $select . ' where=' . $where,
-							ILogger::ERROR);
-					} else {
-						$parentRow = $parentResult->fetchRow();
-						$tmpPath = $parentRow['file_target'];
-						// find the right position where the row path continues from the target path
-						$pos = strrpos($row['path'], $parentRow['file_target']);
-						$subPath = substr($row['path'], $pos);
-						$splitPath = explode('/', $subPath);
-						foreach (array_slice($splitPath, 2) as $pathPart) {
-							$tmpPath = $tmpPath . '/' . $pathPart;
-						}
-						$row['path'] = $tmpPath;
-					}
-				} else {
-					if (!isset($mounts[$row['storage']])) {
-						$mountPoints = \OC\Files\Filesystem::getMountByNumericId($row['storage']);
-						if (is_array($mountPoints) && !empty($mountPoints)) {
-							$mounts[$row['storage']] = current($mountPoints);
-						}
-					}
-					if (!empty($mounts[$row['storage']])) {
-						$path = $mounts[$row['storage']]->getMountPoint().$row['path'];
-						$relPath = substr($path, $root); // path relative to data/user
-						$row['path'] = rtrim($relPath, '/');
-					}
-				}
-			}
-
-			if($checkExpireDate) {
-				if (self::expireItem($row)) {
-					continue;
-				}
-			}
-			// Check if resharing is allowed, if not remove share permission
-			if (isset($row['permissions']) && (!self::isResharingAllowed() | \OCP\Util::isSharingDisabledForUser())) {
-				$row['permissions'] &= ~\OCP\Constants::PERMISSION_SHARE;
-			}
-			// Add display names to result
-			$row['share_with_displayname'] = $row['share_with'];
-			if ( isset($row['share_with']) && $row['share_with'] != '' &&
-				$row['share_type'] === self::SHARE_TYPE_USER) {
-				$shareWithUser = \OC::$server->getUserManager()->get($row['share_with']);
-				$row['share_with_displayname'] = $shareWithUser === null ? $row['share_with'] : $shareWithUser->getDisplayName();
-			} else if(isset($row['share_with']) && $row['share_with'] != '' &&
-				$row['share_type'] === self::SHARE_TYPE_REMOTE) {
-				$addressBookEntries = \OC::$server->getContactsManager()->search($row['share_with'], ['CLOUD']);
-				foreach ($addressBookEntries as $entry) {
-					foreach ($entry['CLOUD'] as $cloudID) {
-						if ($cloudID === $row['share_with']) {
-							$row['share_with_displayname'] = $entry['FN'];
-						}
-					}
-				}
-			}
-			if ( isset($row['uid_owner']) && $row['uid_owner'] != '') {
-				$ownerUser = \OC::$server->getUserManager()->get($row['uid_owner']);
-				$row['displayname_owner'] = $ownerUser === null ? $row['uid_owner'] : $ownerUser->getDisplayName();
-			}
-
-			if ($row['permissions'] > 0) {
-				$items[$row['id']] = $row;
-			}
-
-		}
-
-		// group items if we are looking for items shared with the current user
-		if (isset($shareWith) && $shareWith === \OCP\User::getUser()) {
-			$items = self::groupItems($items, $itemType);
-		}
-
-		if (!empty($items)) {
-			$collectionItems = [];
-			foreach ($items as &$row) {
-				// Return only the item instead of a 2-dimensional array
-				if ($limit == 1 && $row[$column] == $item && ($row['item_type'] == $itemType || $itemType == 'file')) {
-					if ($format == self::FORMAT_NONE) {
-						return $row;
-					} else {
-						break;
-					}
-				}
-				// Check if this is a collection of the requested item type
-				if ($includeCollections && $collectionTypes && $row['item_type'] !== 'folder' && in_array($row['item_type'], $collectionTypes)) {
-					if (($collectionBackend = self::getBackend($row['item_type']))
-						&& $collectionBackend instanceof \OCP\Share_Backend_Collection) {
-						// Collections can be inside collections, check if the item is a collection
-						if (isset($item) && $row['item_type'] == $itemType && $row[$column] == $item) {
-							$collectionItems[] = $row;
-						} else {
-							$collection = [];
-							$collection['item_type'] = $row['item_type'];
-							if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
-								$collection['path'] = basename($row['path']);
-							}
-							$row['collection'] = $collection;
-							// Fetch all of the children sources
-							$children = $collectionBackend->getChildren($row[$column]);
-							foreach ($children as $child) {
-								$childItem = $row;
-								$childItem['item_type'] = $itemType;
-								if ($row['item_type'] != 'file' && $row['item_type'] != 'folder') {
-									$childItem['item_source'] = $child['source'];
-									$childItem['item_target'] = $child['target'];
-								}
-								if ($backend instanceof \OCP\Share_Backend_File_Dependent) {
-									if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
-										$childItem['file_source'] = $child['source'];
-									} else { // TODO is this really needed if we already know that we use the file backend?
-										$meta = \OC\Files\Filesystem::getFileInfo($child['file_path']);
-										$childItem['file_source'] = $meta['fileid'];
-									}
-									$childItem['file_target'] =
-										\OC\Files\Filesystem::normalizePath($child['file_path']);
-								}
-								if (isset($item)) {
-									if ($childItem[$column] == $item) {
-										// Return only the item instead of a 2-dimensional array
-										if ($limit == 1) {
-											if ($format == self::FORMAT_NONE) {
-												return $childItem;
-											} else {
-												// Unset the items array and break out of both loops
-												$items = [];
-												$items[] = $childItem;
-												break 2;
-											}
-										} else {
-											$collectionItems[] = $childItem;
-										}
-									}
-								} else {
-									$collectionItems[] = $childItem;
-								}
-							}
-						}
-					}
-					// Remove collection item
-					$toRemove = $row['id'];
-					if (array_key_exists($toRemove, $switchedItems)) {
-						$toRemove = $switchedItems[$toRemove];
-					}
-					unset($items[$toRemove]);
-				} elseif ($includeCollections && $collectionTypes && in_array($row['item_type'], $collectionTypes)) {
-					// FIXME: Thats a dirty hack to improve file sharing performance,
-					// see github issue #10588 for more details
-					// Need to find a solution which works for all back-ends
-					$collectionBackend = self::getBackend($row['item_type']);
-					$sharedParents = $collectionBackend->getParents($row['item_source']);
-					foreach ($sharedParents as $parent) {
-						$collectionItems[] = $parent;
-					}
-				}
-			}
-			if (!empty($collectionItems)) {
-				$collectionItems = array_unique($collectionItems, SORT_REGULAR);
-				$items = array_merge($items, $collectionItems);
-			}
-
-			// filter out invalid items, these can appear when subshare entries exist
-			// for a group in which the requested user isn't a member any more
-			$items = array_filter($items, function($item) {
-				return $item['share_type'] !== self::$shareTypeGroupUserUnique;
-			});
-
-			return self::formatResult($items, $column, $backend, $format, $parameters);
-		} elseif ($includeCollections && $collectionTypes && in_array('folder', $collectionTypes)) {
-			// FIXME: Thats a dirty hack to improve file sharing performance,
-			// see github issue #10588 for more details
-			// Need to find a solution which works for all back-ends
-			$collectionItems = [];
-			$collectionBackend = self::getBackend('folder');
-			$sharedParents = $collectionBackend->getParents($item, $shareWith, $uidOwner);
-			foreach ($sharedParents as $parent) {
-				$collectionItems[] = $parent;
-			}
-			if ($limit === 1) {
-				return reset($collectionItems);
-			}
-			return self::formatResult($collectionItems, $column, $backend, $format, $parameters);
-		}
-
-		return [];
-	}
-
-	/**
-	 * group items with link to the same source
-	 *
-	 * @param array $items
-	 * @param string $itemType
-	 * @return array of grouped items
-	 */
-	protected static function groupItems($items, $itemType) {
-
-		$fileSharing = $itemType === 'file' || $itemType === 'folder';
-
-		$result = [];
-
-		foreach ($items as $item) {
-			$grouped = false;
-			foreach ($result as $key => $r) {
-				// for file/folder shares we need to compare file_source, otherwise we compare item_source
-				// only group shares if they already point to the same target, otherwise the file where shared
-				// before grouping of shares was added. In this case we don't group them toi avoid confusions
-				if (( $fileSharing && $item['file_source'] === $r['file_source'] && $item['file_target'] === $r['file_target']) ||
-					(!$fileSharing && $item['item_source'] === $r['item_source'] && $item['item_target'] === $r['item_target'])) {
-					// add the first item to the list of grouped shares
-					if (!isset($result[$key]['grouped'])) {
-						$result[$key]['grouped'][] = $result[$key];
-					}
-					$result[$key]['permissions'] = (int) $item['permissions'] | (int) $r['permissions'];
-					$result[$key]['grouped'][] = $item;
-					$grouped = true;
-					break;
-				}
-			}
-
-			if (!$grouped) {
-				$result[] = $item;
-			}
-
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Put shared item into the database
-	 * @param string $itemType Item type
-	 * @param string $itemSource Item source
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
-	 * @param string $shareWith User or group the item is being shared with
-	 * @param string $uidOwner User that is the owner of shared item
-	 * @param int $permissions CRUDS permissions
-	 * @throws \Exception
-	 * @return mixed id of the new share or false
-	 * @deprecated TESTS ONLY - this methods is only used by tests
-	 * called like this:
-	 * self::put('test', $itemSource, self::SHARE_TYPE_USER, $shareWith, $uidOwner, $permissions);
-	 */
-	private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
-								$permissions) {
-
-		$queriesToExecute = [];
-		$suggestedItemTarget = null;
-		$groupFileTarget = $fileTarget = $suggestedFileTarget = $filePath = '';
-		$groupItemTarget = $itemTarget = $fileSource = $parent = 0;
-
-		$result = self::checkReshare('test', $itemSource, self::SHARE_TYPE_USER, $shareWith, $uidOwner, $permissions, null, null);
-		if(!empty($result)) {
-			$parent = $result['parent'];
-			$itemSource = $result['itemSource'];
-			$fileSource = $result['fileSource'];
-			$suggestedItemTarget = $result['suggestedItemTarget'];
-			$suggestedFileTarget = $result['suggestedFileTarget'];
-			$filePath = $result['filePath'];
-		}
-
-		$isGroupShare = false;
-			$users = [$shareWith];
-			$itemTarget = Helper::generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
-				$suggestedItemTarget);
-
-		$run = true;
-		$error = '';
-		$preHookData = [
-			'itemType' => $itemType,
-			'itemSource' => $itemSource,
-			'shareType' => $shareType,
-			'uidOwner' => $uidOwner,
-			'permissions' => $permissions,
-			'fileSource' => $fileSource,
-			'expiration' => null,
-			'token' => null,
-			'run' => &$run,
-			'error' => &$error
-		];
-
-		$preHookData['itemTarget'] = $itemTarget;
-		$preHookData['shareWith'] = $shareWith;
-
-		\OC_Hook::emit(\OCP\Share::class, 'pre_shared', $preHookData);
-
-		if ($run === false) {
-			throw new \Exception($error);
-		}
-
-		foreach ($users as $user) {
-			$sourceId = ($itemType === 'file' || $itemType === 'folder') ? $fileSource : $itemSource;
-			$sourceExists = self::getItemSharedWithBySource($itemType, $sourceId, self::FORMAT_NONE, null, true, $user);
-
-			$userShareType = $shareType;
-
-			if ($sourceExists && $sourceExists['item_source'] === $itemSource) {
-				$fileTarget = $sourceExists['file_target'];
-				$itemTarget = $sourceExists['item_target'];
-
-			} elseif(!$sourceExists)  {
-
-				$itemTarget = Helper::generateTarget($itemType, $itemSource, $userShareType, $user,
-					$uidOwner, $suggestedItemTarget, $parent);
-				if (isset($fileSource)) {
-						$fileTarget = Helper::generateTarget('file', $filePath, $userShareType,
-							$user, $uidOwner, $suggestedFileTarget, $parent);
-				} else {
-					$fileTarget = null;
-				}
-
-			} else {
-
-				// group share which doesn't exists until now, check if we need a unique target for this user
-
-				$itemTarget = Helper::generateTarget($itemType, $itemSource, self::SHARE_TYPE_USER, $user,
-					$uidOwner, $suggestedItemTarget, $parent);
-
-				// do we also need a file target
-				if (isset($fileSource)) {
-					$fileTarget = Helper::generateTarget('file', $filePath, self::SHARE_TYPE_USER, $user,
-						$uidOwner, $suggestedFileTarget, $parent);
-				} else {
-					$fileTarget = null;
-				}
-
-				if (($itemTarget === $groupItemTarget) &&
-					(!isset($fileSource) || $fileTarget === $groupFileTarget)) {
-					continue;
-				}
-			}
-
-			$queriesToExecute[] = [
-				'itemType'			=> $itemType,
-				'itemSource'		=> $itemSource,
-				'itemTarget'		=> $itemTarget,
-				'shareType'			=> $userShareType,
-				'shareWith'			=> $user,
-				'uidOwner'			=> $uidOwner,
-				'permissions'		=> $permissions,
-				'shareTime'			=> time(),
-				'fileSource'		=> $fileSource,
-				'fileTarget'		=> $fileTarget,
-				'token'				=> null,
-				'parent'			=> $parent,
-				'expiration'		=> null,
-			];
-
-		}
-
-		$id = false;
-
-		foreach ($queriesToExecute as $shareQuery) {
-			$shareQuery['parent'] = $parent;
-			$id = self::insertShare($shareQuery);
-		}
-
-		$postHookData = [
-			'itemType' => $itemType,
-			'itemSource' => $itemSource,
-			'parent' => $parent,
-			'shareType' => $shareType,
-			'uidOwner' => $uidOwner,
-			'permissions' => $permissions,
-			'fileSource' => $fileSource,
-			'id' => $parent,
-			'token' => null,
-			'expirationDate' => null,
-		];
-
-		$postHookData['shareWith'] = $isGroupShare ? $shareWith['group'] : $shareWith;
-		$postHookData['itemTarget'] = $isGroupShare ? $groupItemTarget : $itemTarget;
-		$postHookData['fileTarget'] = $isGroupShare ? $groupFileTarget : $fileTarget;
-
-		\OC_Hook::emit(\OCP\Share::class, 'post_shared', $postHookData);
-
-
-		return $id ? $id : false;
-	}
-
-	/**
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $shareType
-	 * @param string $shareWith
-	 * @param string $uidOwner
-	 * @param int $permissions
-	 * @param string|null $itemSourceName
-	 * @param null|\DateTime $expirationDate
-	 * @deprecated TESTS ONLY - this methods is only used by tests
-	 * called like this:
-	 * self::checkReshare('test', $itemSource, self::SHARE_TYPE_USER, $shareWith, $uidOwner, $permissions, null, null);
-	 */
-	private static function checkReshare($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions, $itemSourceName, $expirationDate) {
-		$backend = self::getBackend($itemType);
-
-		$result = [];
-
-		$column = ($itemType === 'file' || $itemType === 'folder') ? 'file_source' : 'item_source';
-
-		$checkReshare = self::getItemSharedWithBySource($itemType, $itemSource, self::FORMAT_NONE, null, true);
-		if ($checkReshare) {
-			// Check if attempting to share back to owner
-			if ($checkReshare['uid_owner'] == $shareWith) {
-				$message = 'Sharing %1$s failed, because the user %2$s is the original sharer';
-				throw new \Exception(sprintf($message, $itemSourceName, $shareWith));
-			}
-		}
-
-		if ($checkReshare && $checkReshare['uid_owner'] !== \OC_User::getUser()) {
-			// Check if share permissions is granted
-			if (self::isResharingAllowed() && (int)$checkReshare['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
-				if (~(int)$checkReshare['permissions'] & $permissions) {
-					$message = 'Sharing %1$s failed, because the permissions exceed permissions granted to %2$s';
-					throw new \Exception(sprintf($message, $itemSourceName, $uidOwner));
-				} else {
-					// TODO Don't check if inside folder
-					$result['parent'] = $checkReshare['id'];
-
-					$result['expirationDate'] = $expirationDate;
-					// $checkReshare['expiration'] could be null and then is always less than any value
-					if(isset($checkReshare['expiration']) && $checkReshare['expiration'] < $expirationDate) {
-						$result['expirationDate'] = $checkReshare['expiration'];
-					}
-
-					// only suggest the same name as new target if it is a reshare of the
-					// same file/folder and not the reshare of a child
-					if ($checkReshare[$column] === $itemSource) {
-						$result['filePath'] = $checkReshare['file_target'];
-						$result['itemSource'] = $checkReshare['item_source'];
-						$result['fileSource'] = $checkReshare['file_source'];
-						$result['suggestedItemTarget'] = $checkReshare['item_target'];
-						$result['suggestedFileTarget'] = $checkReshare['file_target'];
-					} else {
-						$result['filePath'] = ($backend instanceof \OCP\Share_Backend_File_Dependent) ? $backend->getFilePath($itemSource, $uidOwner) : null;
-						$result['suggestedItemTarget'] = null;
-						$result['suggestedFileTarget'] = null;
-						$result['itemSource'] = $itemSource;
-						$result['fileSource'] = ($backend instanceof \OCP\Share_Backend_File_Dependent) ? $itemSource : null;
-					}
-				}
-			} else {
-				$message = 'Sharing %s failed, because resharing is not allowed';
-				throw new \Exception(sprintf($message, $itemSourceName));
-			}
-		} else {
-			$result['parent'] = null;
-			$result['suggestedItemTarget'] = null;
-			$result['suggestedFileTarget'] = null;
-			$result['itemSource'] = $itemSource;
-			$result['expirationDate'] = $expirationDate;
-			if (!$backend->isValidSource($itemSource, $uidOwner)) {
-				$message = 'Sharing %1$s failed, because the sharing backend for '
-					.'%2$s could not find its source';
-				throw new \Exception(sprintf($message, $itemSource, $itemType));
-			}
-			if ($backend instanceof \OCP\Share_Backend_File_Dependent) {
-				$result['filePath'] = $backend->getFilePath($itemSource, $uidOwner);
-					$meta = \OC\Files\Filesystem::getFileInfo($result['filePath']);
-					$result['fileSource'] = $meta['fileid'];
-				if ($result['fileSource'] == -1) {
-					$message = 'Sharing %s failed, because the file could not be found in the file cache';
-					throw new \Exception(sprintf($message, $itemSource));
-				}
-			} else {
-				$result['filePath'] = null;
-				$result['fileSource'] = null;
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 *
-	 * @param array $shareData
-	 * @return mixed false in case of a failure or the id of the new share
-	 */
-	private static function insertShare(array $shareData) {
-
-		$query = \OC_DB::prepare('INSERT INTO `*PREFIX*share` ('
-			.' `item_type`, `item_source`, `item_target`, `share_type`,'
-			.' `share_with`, `uid_owner`, `permissions`, `stime`, `file_source`,'
-			.' `file_target`, `token`, `parent`, `expiration`) VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)');
-		$query->bindValue(1, $shareData['itemType']);
-		$query->bindValue(2, $shareData['itemSource']);
-		$query->bindValue(3, $shareData['itemTarget']);
-		$query->bindValue(4, $shareData['shareType']);
-		$query->bindValue(5, $shareData['shareWith']);
-		$query->bindValue(6, $shareData['uidOwner']);
-		$query->bindValue(7, $shareData['permissions']);
-		$query->bindValue(8, $shareData['shareTime']);
-		$query->bindValue(9, $shareData['fileSource']);
-		$query->bindValue(10, $shareData['fileTarget']);
-		$query->bindValue(11, $shareData['token']);
-		$query->bindValue(12, $shareData['parent']);
-		$query->bindValue(13, $shareData['expiration'], 'datetime');
-		$result = $query->execute();
-
-		$id = false;
-		if ($result) {
-			$id =  \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share');
-		}
-
-		return $id;
-
-	}
-
-	/**
-	 * construct select statement
-	 * @param int $format
-	 * @param boolean $fileDependent ist it a file/folder share or a generla share
-	 * @param string $uidOwner
-	 * @return string select statement
-	 */
-	private static function createSelectStatement($format, $fileDependent, $uidOwner = null) {
-		$select = '*';
-		if ($format == self::FORMAT_STATUSES) {
-			if ($fileDependent) {
-				$select = '`*PREFIX*share`.`id`, `*PREFIX*share`.`parent`, `share_type`, `path`, `storage`, '
-					. '`share_with`, `uid_owner` , `file_source`, `stime`, `*PREFIX*share`.`permissions`, '
-					. '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`, '
-					. '`uid_initiator`';
-			} else {
-				$select = '`id`, `parent`, `share_type`, `share_with`, `uid_owner`, `item_source`, `stime`, `*PREFIX*share`.`permissions`';
-			}
-		} else {
-			if (isset($uidOwner)) {
-				if ($fileDependent) {
-					$select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `*PREFIX*share`.`parent`,'
-						. ' `share_type`, `share_with`, `file_source`, `file_target`, `path`, `*PREFIX*share`.`permissions`, `stime`,'
-						. ' `expiration`, `token`, `storage`, `mail_send`, `uid_owner`, '
-						. '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`';
-				} else {
-					$select = '`id`, `item_type`, `item_source`, `parent`, `share_type`, `share_with`, `*PREFIX*share`.`permissions`,'
-						. ' `stime`, `file_source`, `expiration`, `token`, `mail_send`, `uid_owner`';
-				}
-			} else {
-				if ($fileDependent) {
-					if ($format == \OCA\Files_Sharing\ShareBackend\File::FORMAT_GET_FOLDER_CONTENTS || $format == \OCA\Files_Sharing\ShareBackend\File::FORMAT_FILE_APP_ROOT) {
-						$select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `*PREFIX*share`.`parent`, `uid_owner`, '
-							. '`share_type`, `share_with`, `file_source`, `path`, `file_target`, `stime`, '
-							. '`*PREFIX*share`.`permissions`, `expiration`, `storage`, `*PREFIX*filecache`.`parent` as `file_parent`, '
-							. '`name`, `mtime`, `mimetype`, `mimepart`, `size`, `encrypted`, `etag`, `mail_send`';
-					} else {
-						$select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `item_target`,'
-							. '`*PREFIX*share`.`parent`, `share_type`, `share_with`, `uid_owner`,'
-							. '`file_source`, `path`, `file_target`, `*PREFIX*share`.`permissions`,'
-							. '`stime`, `expiration`, `token`, `storage`, `mail_send`,'
-							. '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`';
-					}
-				}
-			}
-		}
-		return $select;
-	}
-
-
-	/**
-	 * transform db results
-	 * @param array $row result
-	 */
-	private static function transformDBResults(&$row) {
-		if (isset($row['id'])) {
-			$row['id'] = (int) $row['id'];
-		}
-		if (isset($row['share_type'])) {
-			$row['share_type'] = (int) $row['share_type'];
-		}
-		if (isset($row['parent'])) {
-			$row['parent'] = (int) $row['parent'];
-		}
-		if (isset($row['file_parent'])) {
-			$row['file_parent'] = (int) $row['file_parent'];
-		}
-		if (isset($row['file_source'])) {
-			$row['file_source'] = (int) $row['file_source'];
-		}
-		if (isset($row['permissions'])) {
-			$row['permissions'] = (int) $row['permissions'];
-		}
-		if (isset($row['storage'])) {
-			$row['storage'] = (int) $row['storage'];
-		}
-		if (isset($row['stime'])) {
-			$row['stime'] = (int) $row['stime'];
-		}
-		if (isset($row['expiration']) && $row['share_type'] !== self::SHARE_TYPE_LINK) {
-			// discard expiration date for non-link shares, which might have been
-			// set by ancient bugs
-			$row['expiration'] = null;
-		}
-	}
-
-	/**
-	 * format result
-	 * @param array $items result
-	 * @param string $column is it a file share or a general share ('file_target' or 'item_target')
-	 * @param \OCP\Share_Backend $backend sharing backend
-	 * @param int $format
-	 * @param array $parameters additional format parameters
-	 * @return array format result
-	 */
-	private static function formatResult($items, $column, $backend, $format = self::FORMAT_NONE , $parameters = null) {
-		if ($format === self::FORMAT_NONE) {
-			return $items;
-		} else if ($format === self::FORMAT_STATUSES) {
-			$statuses = [];
-			foreach ($items as $item) {
-				if ($item['share_type'] === self::SHARE_TYPE_LINK) {
-					if ($item['uid_initiator'] !== \OC::$server->getUserSession()->getUser()->getUID()) {
-						continue;
-					}
-					$statuses[$item[$column]]['link'] = true;
-				} else if (!isset($statuses[$item[$column]])) {
-					$statuses[$item[$column]]['link'] = false;
-				}
-				if (!empty($item['file_target'])) {
-					$statuses[$item[$column]]['path'] = $item['path'];
-				}
-			}
-			return $statuses;
-		} else {
-			return $backend->formatItems($items, $format, $parameters);
-		}
-	}
-
-	/**
-	 * remove protocol from URL
-	 *
-	 * @param string $url
-	 * @return string
-	 */
-	public static function removeProtocolFromUrl($url) {
-		if (strpos($url, 'https://') === 0) {
-			return substr($url, strlen('https://'));
-		} else if (strpos($url, 'http://') === 0) {
-			return substr($url, strlen('http://'));
-		}
-
-		return $url;
-	}
-
-	/**
-	 * try http post first with https and then with http as a fallback
-	 *
-	 * @param string $remoteDomain
-	 * @param string $urlSuffix
-	 * @param array $fields post parameters
-	 * @return array
-	 */
-	private static function tryHttpPostToShareEndpoint($remoteDomain, $urlSuffix, array $fields) {
-		$protocol = 'https://';
-		$result = [
-			'success' => false,
-			'result' => '',
-		];
-		$try = 0;
-		$discoveryService = \OC::$server->query(\OCP\OCS\IDiscoveryService::class);
-		while ($result['success'] === false && $try < 2) {
-			$federationEndpoints = $discoveryService->discover($protocol . $remoteDomain, 'FEDERATED_SHARING');
-			$endpoint = isset($federationEndpoints['share']) ? $federationEndpoints['share'] : '/ocs/v2.php/cloud/shares';
-			$client = \OC::$server->getHTTPClientService()->newClient();
-
-			try {
-				$response = $client->post(
-					$protocol . $remoteDomain . $endpoint . $urlSuffix . '?format=' . self::RESPONSE_FORMAT,
-					[
-						'body' => $fields,
-						'connect_timeout' => 10,
-					]
-				);
-
-				$result = ['success' => true, 'result' => $response->getBody()];
-			} catch (\Exception $e) {
-				$result = ['success' => false, 'result' => $e->getMessage()];
-			}
-
-			$try++;
-			$protocol = 'http://';
-		}
-
-		return $result;
-	}
-
-	/**
-	 * send server-to-server unshare to remote server
-	 *
-	 * @param string $remote url
-	 * @param int $id share id
-	 * @param string $token
-	 * @return bool
-	 */
-	private static function sendRemoteUnshare($remote, $id, $token) {
-		$url = rtrim($remote, '/');
-		$fields = ['token' => $token, 'format' => 'json'];
-		$url = self::removeProtocolFromUrl($url);
-		$result = self::tryHttpPostToShareEndpoint($url, '/'.$id.'/unshare', $fields);
-		$status = json_decode($result['result'], true);
-
-		return ($result['success'] && ($status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200));
-	}
-
-	/**
-	 * @return int
-	 */
-	public static function getExpireInterval() {
-		return (int)\OC::$server->getConfig()->getAppValue('core', 'shareapi_expire_after_n_days', '7');
-	}
-
-	/**
-	 * Checks whether the given path is reachable for the given owner
-	 *
-	 * @param string $path path relative to files
-	 * @param string $ownerStorageId storage id of the owner
-	 *
-	 * @return boolean true if file is reachable, false otherwise
-	 */
-	private static function isFileReachable($path, $ownerStorageId) {
-		// if outside the home storage, file is always considered reachable
-		if (!(substr($ownerStorageId, 0, 6) === 'home::' ||
-			substr($ownerStorageId, 0, 13) === 'object::user:'
-		)) {
-			return true;
-		}
-
-		// if inside the home storage, the file has to be under "/files/"
-		$path = ltrim($path, '/');
-		if (substr($path, 0, 6) === 'files/') {
-			return true;
-		}
-
-		return false;
-	}
+    /** CRUDS permissions (Create, Read, Update, Delete, Share) using a bitmask
+     * Construct permissions for share() and setPermissions with Or (|) e.g.
+     * Give user read and update permissions: PERMISSION_READ | PERMISSION_UPDATE
+     *
+     * Check if permission is granted with And (&) e.g. Check if delete is
+     * granted: if ($permissions & PERMISSION_DELETE)
+     *
+     * Remove permissions with And (&) and Not (~) e.g. Remove the update
+     * permission: $permissions &= ~PERMISSION_UPDATE
+     *
+     * Apps are required to handle permissions on their own, this class only
+     * stores and manages the permissions of shares
+     * @see lib/public/constants.php
+     */
+
+    /**
+     * Register a sharing backend class that implements OCP\Share_Backend for an item type
+     * @param string $itemType Item type
+     * @param string $class Backend class
+     * @param string $collectionOf (optional) Depends on item type
+     * @param array $supportedFileExtensions (optional) List of supported file extensions if this item type depends on files
+     * @return boolean true if backend is registered or false if error
+     */
+    public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
+        if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_enabled', 'yes') == 'yes') {
+            if (!isset(self::$backendTypes[$itemType])) {
+                self::$backendTypes[$itemType] = [
+                    'class' => $class,
+                    'collectionOf' => $collectionOf,
+                    'supportedFileExtensions' => $supportedFileExtensions
+                ];
+                return true;
+            }
+            \OCP\Util::writeLog('OCP\Share',
+                'Sharing backend '.$class.' not registered, '.self::$backendTypes[$itemType]['class']
+                .' is already registered for '.$itemType,
+                ILogger::WARN);
+        }
+        return false;
+    }
+
+    /**
+     * Get the items of item type shared with the current user
+     * @param string $itemType
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters (optional)
+     * @param int $limit Number of items to return (optional) Returns all by default
+     * @param boolean $includeCollections (optional)
+     * @return mixed Return depends on format
+     * @deprecated TESTS ONLY - this methods is only used by tests
+     * called like this:
+     * \OC\Share\Share::getItemsSharedWith('folder'); (apps/files_sharing/tests/UpdaterTest.php)
+     */
+    public static function getItemsSharedWith() {
+        return self::getItems('folder', null, self::$shareTypeUserAndGroups, \OC_User::getUser(), null, self::FORMAT_NONE,
+            null, -1, false);
+    }
+
+    /**
+     * Get the items of item type shared with a user
+     * @param string $itemType
+     * @param string $user id for which user we want the shares
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters (optional)
+     * @param int $limit Number of items to return (optional) Returns all by default
+     * @param boolean $includeCollections (optional)
+     * @return mixed Return depends on format
+     */
+    public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
+                                                    $parameters = null, $limit = -1, $includeCollections = false) {
+        return self::getItems($itemType, null, self::$shareTypeUserAndGroups, $user, null, $format,
+            $parameters, $limit, $includeCollections);
+    }
+
+    /**
+     * Get the item of item type shared with a given user by source
+     * @param string $itemType
+     * @param string $itemSource
+     * @param string $user User to whom the item was shared
+     * @param string $owner Owner of the share
+     * @param int $shareType only look for a specific share type
+     * @return array Return list of items with file_target, permissions and expiration
+     */
+    public static function getItemSharedWithUser($itemType, $itemSource, $user, $owner = null, $shareType = null) {
+        $shares = [];
+        $fileDependent = false;
+
+        $where = 'WHERE';
+        $fileDependentWhere = '';
+        if ($itemType === 'file' || $itemType === 'folder') {
+            $fileDependent = true;
+            $column = 'file_source';
+            $fileDependentWhere = 'INNER JOIN `*PREFIX*filecache` ON `file_source` = `*PREFIX*filecache`.`fileid` ';
+            $fileDependentWhere .= 'INNER JOIN `*PREFIX*storages` ON `numeric_id` = `*PREFIX*filecache`.`storage` ';
+        } else {
+            $column = 'item_source';
+        }
+
+        $select = self::createSelectStatement(self::FORMAT_NONE, $fileDependent);
+
+        $where .= ' `' . $column . '` = ? AND `item_type` = ? ';
+        $arguments = [$itemSource, $itemType];
+        // for link shares $user === null
+        if ($user !== null) {
+            $where .= ' AND `share_with` = ? ';
+            $arguments[] = $user;
+        }
+
+        if ($shareType !== null) {
+            $where .= ' AND `share_type` = ? ';
+            $arguments[] = $shareType;
+        }
+
+        if ($owner !== null) {
+            $where .= ' AND `uid_owner` = ? ';
+            $arguments[] = $owner;
+        }
+
+        $query = \OC_DB::prepare('SELECT ' . $select . ' FROM `*PREFIX*share` '. $fileDependentWhere . $where);
+
+        $result = \OC_DB::executeAudited($query, $arguments);
+
+        while ($row = $result->fetchRow()) {
+            if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
+                continue;
+            }
+            if ($fileDependent && (int)$row['file_parent'] === -1) {
+                // if it is a mount point we need to get the path from the mount manager
+                $mountManager = \OC\Files\Filesystem::getMountManager();
+                $mountPoint = $mountManager->findByStorageId($row['storage_id']);
+                if (!empty($mountPoint)) {
+                    $path = $mountPoint[0]->getMountPoint();
+                    $path = trim($path, '/');
+                    $path = substr($path, strlen($owner) + 1); //normalize path to 'files/foo.txt`
+                    $row['path'] = $path;
+                } else {
+                    \OC::$server->getLogger()->warning(
+                        'Could not resolve mount point for ' . $row['storage_id'],
+                        ['app' => 'OCP\Share']
+                    );
+                }
+            }
+            $shares[] = $row;
+        }
+
+        //if didn't found a result than let's look for a group share.
+        if(empty($shares) && $user !== null) {
+            $userObject = \OC::$server->getUserManager()->get($user);
+            $groups = [];
+            if ($userObject) {
+                $groups = \OC::$server->getGroupManager()->getUserGroupIds($userObject);
+            }
+
+            if (!empty($groups)) {
+                $where = $fileDependentWhere . ' WHERE `' . $column . '` = ? AND `item_type` = ? AND `share_with` in (?)';
+                $arguments = [$itemSource, $itemType, $groups];
+                $types = [null, null, IQueryBuilder::PARAM_STR_ARRAY];
+
+                if ($owner !== null) {
+                    $where .= ' AND `uid_owner` = ?';
+                    $arguments[] = $owner;
+                    $types[] = null;
+                }
+
+                // TODO: inject connection, hopefully one day in the future when this
+                // class isn't static anymore...
+                $conn = \OC::$server->getDatabaseConnection();
+                $result = $conn->executeQuery(
+                    'SELECT ' . $select . ' FROM `*PREFIX*share` ' . $where,
+                    $arguments,
+                    $types
+                );
+
+                while ($row = $result->fetch()) {
+                    $shares[] = $row;
+                }
+            }
+        }
+
+        return $shares;
+
+    }
+
+    /**
+     * Get the item of item type shared with the current user by source
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters
+     * @param boolean $includeCollections
+     * @param string $shareWith (optional) define against which user should be checked, default: current user
+     * @return array
+     */
+    public static function getItemSharedWithBySource($itemType, $itemSource, $format = self::FORMAT_NONE,
+                                                        $parameters = null, $includeCollections = false, $shareWith = null) {
+        $shareWith = ($shareWith === null) ? \OC_User::getUser() : $shareWith;
+        return self::getItems($itemType, $itemSource, self::$shareTypeUserAndGroups, $shareWith, null, $format,
+            $parameters, 1, $includeCollections, true);
+    }
+
+    /**
+     * Get the shared item of item type owned by the current user
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters
+     * @param boolean $includeCollections
+     * @return mixed Return depends on format
+     */
+    public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
+                                            $parameters = null, $includeCollections = false) {
+        return self::getItems($itemType, $itemSource, null, null, \OC_User::getUser(), $format,
+            $parameters, -1, $includeCollections);
+    }
+
+    /**
+     * Share an item with a user, group, or via private link
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
+     * @param string $shareWith User or group the item is being shared with
+     * @param int $permissions CRUDS
+     * @param string $itemSourceName
+     * @param \DateTime|null $expirationDate
+     * @return boolean|string Returns true on success or false on failure, Returns token on success for links
+     * @throws \OC\HintException when the share type is remote and the shareWith is invalid
+     * @throws \Exception
+     * @since 5.0.0 - parameter $itemSourceName was added in 6.0.0, parameter $expirationDate was added in 7.0.0, parameter $passwordChanged added in 9.0.0
+     * @deprecated 14.0.0 TESTS ONLY - this methods is as of 2018-06 only used by tests
+     * called like this:
+     * \OC\Share\Share::shareItem('test', 1, \OCP\Share::SHARE_TYPE_USER, $otherUserId, \OCP\Constants::PERMISSION_READ);
+     */
+    public static function shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions) {
+        $backend = self::getBackend($itemType);
+
+        if ($backend->isShareTypeAllowed($shareType) === false) {
+            $message = 'Sharing failed, because the backend does not allow shares from type %i';
+            throw new \Exception(sprintf($message, $shareType));
+        }
+
+        $uidOwner = \OC_User::getUser();
+
+        // Verify share type and sharing conditions are met
+        if ($shareType === self::SHARE_TYPE_USER) {
+            if ($shareWith == $uidOwner) {
+                $message = 'Sharing failed, because you can not share with yourself';
+                throw new \Exception($message);
+            }
+            if (!\OC::$server->getUserManager()->userExists($shareWith)) {
+                $message = 'Sharing failed, because the user %s does not exist';
+                throw new \Exception(sprintf($message, $shareWith));
+            }
+            // Check if the item source is already shared with the user, either from the same owner or a different user
+            if ($checkExists = self::getItems($itemType, $itemSource, self::$shareTypeUserAndGroups,
+                $shareWith, null, self::FORMAT_NONE, null, 1, true, true)) {
+                // Only allow the same share to occur again if it is the same
+                // owner and is not a user share, this use case is for increasing
+                // permissions for a specific user
+                if ($checkExists['uid_owner'] != $uidOwner || $checkExists['share_type'] == $shareType) {
+                    $message = 'Sharing failed, because this item is already shared with %s';
+                    throw new \Exception(sprintf($message, $shareWith));
+                }
+            }
+            if ($checkExists = self::getItems($itemType, $itemSource, self::SHARE_TYPE_USER,
+                $shareWith, null, self::FORMAT_NONE, null, 1, true, true)) {
+                // Only allow the same share to occur again if it is the same
+                // owner and is not a user share, this use case is for increasing
+                // permissions for a specific user
+                if ($checkExists['uid_owner'] != $uidOwner || $checkExists['share_type'] == $shareType) {
+                    $message = 'Sharing failed, because this item is already shared with user %s';
+                    throw new \Exception(sprintf($message, $shareWith));
+                }
+            }
+        }
+
+        // Put the item into the database
+        $result = self::put('test', $itemSource, self::SHARE_TYPE_USER, $shareWith, $uidOwner, $permissions);
+
+        return $result ? true : false;
+    }
+
+    /**
+     * Unshare an item from a user, group, or delete a private link
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
+     * @param string $shareWith User or group the item is being shared with
+     * @param string $owner owner of the share, if null the current user is used
+     * @return boolean true on success or false on failure
+     */
+    public static function unshare($itemType, $itemSource, $shareType, $shareWith, $owner = null) {
+
+        // check if it is a valid itemType
+        self::getBackend($itemType);
+
+        $items = self::getItemSharedWithUser($itemType, $itemSource, $shareWith, $owner, $shareType);
+
+        $toDelete = [];
+        $newParent = null;
+        $currentUser = $owner ? $owner : \OC_User::getUser();
+        foreach ($items as $item) {
+            // delete the item with the expected share_type and owner
+            if ((int)$item['share_type'] === (int)$shareType && $item['uid_owner'] === $currentUser) {
+                $toDelete = $item;
+                // if there is more then one result we don't have to delete the children
+                // but update their parent. For group shares the new parent should always be
+                // the original group share and not the db entry with the unique name
+            } else if ((int)$item['share_type'] === self::$shareTypeGroupUserUnique) {
+                $newParent = $item['parent'];
+            } else {
+                $newParent = $item['id'];
+            }
+        }
+
+        if (!empty($toDelete)) {
+            self::unshareItem($toDelete, $newParent);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Checks whether a share has expired, calls unshareItem() if yes.
+     * @param array $item Share data (usually database row)
+     * @return boolean True if item was expired, false otherwise.
+     */
+    protected static function expireItem(array $item) {
+
+        $result = false;
+
+        // only use default expiration date for link shares
+        if ((int) $item['share_type'] === self::SHARE_TYPE_LINK) {
+
+            // calculate expiration date
+            if (!empty($item['expiration'])) {
+                $userDefinedExpire = new \DateTime($item['expiration']);
+                $expires = $userDefinedExpire->getTimestamp();
+            } else {
+                $expires = null;
+            }
+
+
+            // get default expiration settings
+            $defaultSettings = Helper::getDefaultExpireSetting();
+            $expires = Helper::calculateExpireDate($defaultSettings, $item['stime'], $expires);
+
+
+            if (is_int($expires)) {
+                $now = time();
+                if ($now > $expires) {
+                    self::unshareItem($item);
+                    $result = true;
+                }
+            }
+        }
+        return $result;
+    }
+
+    /**
+     * Unshares a share given a share data array
+     * @param array $item Share data (usually database row)
+     * @param int $newParent parent ID
+     * @return null
+     */
+    protected static function unshareItem(array $item, $newParent = null) {
+
+        $shareType = (int)$item['share_type'];
+        $shareWith = null;
+        if ($shareType !== \OCP\Share::SHARE_TYPE_LINK) {
+            $shareWith = $item['share_with'];
+        }
+
+        // Pass all the vars we have for now, they may be useful
+        $hookParams = [
+            'id'            => $item['id'],
+            'itemType'      => $item['item_type'],
+            'itemSource'    => $item['item_source'],
+            'shareType'     => $shareType,
+            'shareWith'     => $shareWith,
+            'itemParent'    => $item['parent'],
+            'uidOwner'      => $item['uid_owner'],
+        ];
+        if($item['item_type'] === 'file' || $item['item_type'] === 'folder') {
+            $hookParams['fileSource'] = $item['file_source'];
+            $hookParams['fileTarget'] = $item['file_target'];
+        }
+
+        \OC_Hook::emit(\OCP\Share::class, 'pre_unshare', $hookParams);
+        $deletedShares = Helper::delete($item['id'], false, null, $newParent);
+        $deletedShares[] = $hookParams;
+        $hookParams['deletedShares'] = $deletedShares;
+        \OC_Hook::emit(\OCP\Share::class, 'post_unshare', $hookParams);
+        if ((int)$item['share_type'] === \OCP\Share::SHARE_TYPE_REMOTE && \OC::$server->getUserSession()->getUser()) {
+            list(, $remote) = Helper::splitUserRemote($item['share_with']);
+            self::sendRemoteUnshare($remote, $item['id'], $item['token']);
+        }
+    }
+
+    /**
+     * Get the backend class for the specified item type
+     * @param string $itemType
+     * @throws \Exception
+     * @return \OCP\Share_Backend
+     */
+    public static function getBackend($itemType) {
+        $l = \OC::$server->getL10N('lib');
+        if (isset(self::$backends[$itemType])) {
+            return self::$backends[$itemType];
+        } else if (isset(self::$backendTypes[$itemType]['class'])) {
+            $class = self::$backendTypes[$itemType]['class'];
+            if (class_exists($class)) {
+                self::$backends[$itemType] = new $class;
+                if (!(self::$backends[$itemType] instanceof \OCP\Share_Backend)) {
+                    $message = 'Sharing backend %s must implement the interface OCP\Share_Backend';
+                    $message_t = $l->t('Sharing backend %s must implement the interface OCP\Share_Backend', [$class]);
+                    \OCP\Util::writeLog('OCP\Share', sprintf($message, $class), ILogger::ERROR);
+                    throw new \Exception($message_t);
+                }
+                return self::$backends[$itemType];
+            } else {
+                $message = 'Sharing backend %s not found';
+                $message_t = $l->t('Sharing backend %s not found', [$class]);
+                \OCP\Util::writeLog('OCP\Share', sprintf($message, $class), ILogger::ERROR);
+                throw new \Exception($message_t);
+            }
+        }
+        $message = 'Sharing backend for %s not found';
+        $message_t = $l->t('Sharing backend for %s not found', [$itemType]);
+        \OCP\Util::writeLog('OCP\Share', sprintf($message, $itemType), ILogger::ERROR);
+        throw new \Exception($message_t);
+    }
+
+    /**
+     * Check if resharing is allowed
+     * @return boolean true if allowed or false
+     *
+     * Resharing is allowed by default if not configured
+     */
+    public static function isResharingAllowed() {
+        if (!isset(self::$isResharingAllowed)) {
+            if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_allow_resharing', 'yes') == 'yes') {
+                self::$isResharingAllowed = true;
+            } else {
+                self::$isResharingAllowed = false;
+            }
+        }
+        return self::$isResharingAllowed;
+    }
+
+    /**
+     * Get a list of collection item types for the specified item type
+     * @param string $itemType
+     * @return array
+     */
+    private static function getCollectionItemTypes($itemType) {
+        $collectionTypes = [$itemType];
+        foreach (self::$backendTypes as $type => $backend) {
+            if (in_array($backend['collectionOf'], $collectionTypes)) {
+                $collectionTypes[] = $type;
+            }
+        }
+        // TODO Add option for collections to be collection of themselves, only 'folder' does it now...
+        if (isset(self::$backendTypes[$itemType]) && (!self::getBackend($itemType) instanceof \OCP\Share_Backend_Collection || $itemType != 'folder')) {
+            unset($collectionTypes[0]);
+        }
+        // Return array if collections were found or the item type is a
+        // collection itself - collections can be inside collections
+        if (count($collectionTypes) > 0) {
+            return $collectionTypes;
+        }
+        return false;
+    }
+
+    /**
+     * Get the owners of items shared with a user.
+     *
+     * @param string $user The user the items are shared with.
+     * @param string $type The type of the items shared with the user.
+     * @param boolean $includeCollections Include collection item types (optional)
+     * @param boolean $includeOwner include owner in the list of users the item is shared with (optional)
+     * @return array
+     * @deprecated TESTS ONLY - this methods is only used by tests
+     * called like this:
+     * \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true)
+     */
+    public static function getSharedItemsOwners($user, $type, $includeCollections = false, $includeOwner = false) {
+        // First, we find out if $type is part of a collection (and if that collection is part of
+        // another one and so on).
+        $collectionTypes = [];
+        if (!$includeCollections || !$collectionTypes = self::getCollectionItemTypes($type)) {
+            $collectionTypes[] = $type;
+        }
+
+        // Of these collection types, along with our original $type, we make a
+        // list of the ones for which a sharing backend has been registered.
+        // FIXME: Ideally, we wouldn't need to nest getItemsSharedWith in this loop but just call it
+        // with its $includeCollections parameter set to true. Unfortunately, this fails currently.
+        $allMaybeSharedItems = [];
+        foreach ($collectionTypes as $collectionType) {
+            if (isset(self::$backends[$collectionType])) {
+                $allMaybeSharedItems[$collectionType] = self::getItemsSharedWithUser(
+                    $collectionType,
+                    $user,
+                    self::FORMAT_NONE
+                );
+            }
+        }
+
+        $owners = [];
+        if ($includeOwner) {
+            $owners[] = $user;
+        }
+
+        // We take a look at all shared items of the given $type (or of the collections it is part of)
+        // and find out their owners. Then, we gather the tags for the original $type from all owners,
+        // and return them as elements of a list that look like "Tag (owner)".
+        foreach ($allMaybeSharedItems as $collectionType => $maybeSharedItems) {
+            foreach ($maybeSharedItems as $sharedItem) {
+                if (isset($sharedItem['id'])) { //workaround for https://github.com/owncloud/core/issues/2814
+                    $owners[] = $sharedItem['uid_owner'];
+                }
+            }
+        }
+
+        return $owners;
+    }
+
+    /**
+     * Get shared items from the database
+     * @param string $itemType
+     * @param string $item Item source or target (optional)
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique
+     * @param string $shareWith User or group the item is being shared with
+     * @param string $uidOwner User that is the owner of shared items (optional)
+     * @param int $format Format to convert items to with formatItems() (optional)
+     * @param mixed $parameters to pass to formatItems() (optional)
+     * @param int $limit Number of items to return, -1 to return all matches (optional)
+     * @param boolean $includeCollections Include collection item types (optional)
+     * @param boolean $itemShareWithBySource (optional)
+     * @param boolean $checkExpireDate
+     * @return array
+     *
+     * See public functions getItem(s)... for parameter usage
+     *
+     */
+    public static function getItems($itemType, $item = null, $shareType = null, $shareWith = null,
+                                    $uidOwner = null, $format = self::FORMAT_NONE, $parameters = null, $limit = -1,
+                                    $includeCollections = false, $itemShareWithBySource = false, $checkExpireDate  = true) {
+        if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_enabled', 'yes') != 'yes') {
+            return [];
+        }
+        $backend = self::getBackend($itemType);
+        $collectionTypes = false;
+        // Get filesystem root to add it to the file target and remove from the
+        // file source, match file_source with the file cache
+        if ($itemType == 'file' || $itemType == 'folder') {
+            if(!is_null($uidOwner)) {
+                $root = \OC\Files\Filesystem::getRoot();
+            } else {
+                $root = '';
+            }
+            $where = 'INNER JOIN `*PREFIX*filecache` ON `file_source` = `*PREFIX*filecache`.`fileid` ';
+            if (!isset($item)) {
+                $where .= ' AND `file_target` IS NOT NULL ';
+            }
+            $where .= 'INNER JOIN `*PREFIX*storages` ON `numeric_id` = `*PREFIX*filecache`.`storage` ';
+            $fileDependent = true;
+            $queryArgs = [];
+        } else {
+            $fileDependent = false;
+            $root = '';
+            $collectionTypes = self::getCollectionItemTypes($itemType);
+            if ($includeCollections && !isset($item) && $collectionTypes) {
+                // If includeCollections is true, find collections of this item type, e.g. a music album contains songs
+                if (!in_array($itemType, $collectionTypes)) {
+                    $itemTypes = array_merge([$itemType], $collectionTypes);
+                } else {
+                    $itemTypes = $collectionTypes;
+                }
+                $placeholders = implode(',', array_fill(0, count($itemTypes), '?'));
+                $where = ' WHERE `item_type` IN ('.$placeholders.'))';
+                $queryArgs = $itemTypes;
+            } else {
+                $where = ' WHERE `item_type` = ?';
+                $queryArgs = [$itemType];
+            }
+        }
+        if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_allow_links', 'yes') !== 'yes') {
+            $where .= ' AND `share_type` != ?';
+            $queryArgs[] = self::SHARE_TYPE_LINK;
+        }
+        if (isset($shareType)) {
+            // Include all user and group items
+            if ($shareType == self::$shareTypeUserAndGroups && isset($shareWith)) {
+                $where .= ' AND ((`share_type` in (?, ?) AND `share_with` = ?) ';
+                $queryArgs[] = self::SHARE_TYPE_USER;
+                $queryArgs[] = self::$shareTypeGroupUserUnique;
+                $queryArgs[] = $shareWith;
+
+                $user = \OC::$server->getUserManager()->get($shareWith);
+                $groups = [];
+                if ($user) {
+                    $groups = \OC::$server->getGroupManager()->getUserGroupIds($user);
+                }
+                if (!empty($groups)) {
+                    $placeholders = implode(',', array_fill(0, count($groups), '?'));
+                    $where .= ' OR (`share_type` = ? AND `share_with` IN ('.$placeholders.')) ';
+                    $queryArgs[] = self::SHARE_TYPE_GROUP;
+                    $queryArgs = array_merge($queryArgs, $groups);
+                }
+                $where .= ')';
+                // Don't include own group shares
+                $where .= ' AND `uid_owner` != ?';
+                $queryArgs[] = $shareWith;
+            } else {
+                $where .= ' AND `share_type` = ?';
+                $queryArgs[] = $shareType;
+                if (isset($shareWith)) {
+                    $where .= ' AND `share_with` = ?';
+                    $queryArgs[] = $shareWith;
+                }
+            }
+        }
+        if (isset($uidOwner)) {
+            $where .= ' AND `uid_owner` = ?';
+            $queryArgs[] = $uidOwner;
+            if (!isset($shareType)) {
+                // Prevent unique user targets for group shares from being selected
+                $where .= ' AND `share_type` != ?';
+                $queryArgs[] = self::$shareTypeGroupUserUnique;
+            }
+            if ($fileDependent) {
+                $column = 'file_source';
+            } else {
+                $column = 'item_source';
+            }
+        } else {
+            if ($fileDependent) {
+                $column = 'file_target';
+            } else {
+                $column = 'item_target';
+            }
+        }
+        if (isset($item)) {
+            $collectionTypes = self::getCollectionItemTypes($itemType);
+            if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
+                $where .= ' AND (';
+            } else {
+                $where .= ' AND';
+            }
+            // If looking for own shared items, check item_source else check item_target
+            if (isset($uidOwner) || $itemShareWithBySource) {
+                // If item type is a file, file source needs to be checked in case the item was converted
+                if ($fileDependent) {
+                    $where .= ' `file_source` = ?';
+                    $column = 'file_source';
+                } else {
+                    $where .= ' `item_source` = ?';
+                    $column = 'item_source';
+                }
+            } else {
+                if ($fileDependent) {
+                    $where .= ' `file_target` = ?';
+                    $item = \OC\Files\Filesystem::normalizePath($item);
+                } else {
+                    $where .= ' `item_target` = ?';
+                }
+            }
+            $queryArgs[] = $item;
+            if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
+                $placeholders = implode(',', array_fill(0, count($collectionTypes), '?'));
+                $where .= ' OR `item_type` IN ('.$placeholders.'))';
+                $queryArgs = array_merge($queryArgs, $collectionTypes);
+            }
+        }
+
+        if ($shareType == self::$shareTypeUserAndGroups && $limit === 1) {
+            // Make sure the unique user target is returned if it exists,
+            // unique targets should follow the group share in the database
+            // If the limit is not 1, the filtering can be done later
+            $where .= ' ORDER BY `*PREFIX*share`.`id` DESC';
+        } else {
+            $where .= ' ORDER BY `*PREFIX*share`.`id` ASC';
+        }
+
+        if ($limit != -1 && !$includeCollections) {
+            // The limit must be at least 3, because filtering needs to be done
+            if ($limit < 3) {
+                $queryLimit = 3;
+            } else {
+                $queryLimit = $limit;
+            }
+        } else {
+            $queryLimit = null;
+        }
+        $select = self::createSelectStatement($format, $fileDependent, $uidOwner);
+        $root = strlen($root);
+        $query = \OC_DB::prepare('SELECT '.$select.' FROM `*PREFIX*share` '.$where, $queryLimit);
+        $result = $query->execute($queryArgs);
+        if ($result === false) {
+            \OCP\Util::writeLog('OCP\Share',
+                \OC_DB::getErrorMessage() . ', select=' . $select . ' where=',
+                ILogger::ERROR);
+        }
+        $items = [];
+        $targets = [];
+        $switchedItems = [];
+        $mounts = [];
+        while ($row = $result->fetchRow()) {
+            self::transformDBResults($row);
+            // Filter out duplicate group shares for users with unique targets
+            if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
+                continue;
+            }
+            if ($row['share_type'] == self::$shareTypeGroupUserUnique && isset($items[$row['parent']])) {
+                $row['share_type'] = self::SHARE_TYPE_GROUP;
+                $row['unique_name'] = true; // remember that we use a unique name for this user
+                $row['share_with'] = $items[$row['parent']]['share_with'];
+                // if the group share was unshared from the user we keep the permission, otherwise
+                // we take the permission from the parent because this is always the up-to-date
+                // permission for the group share
+                if ($row['permissions'] > 0) {
+                    $row['permissions'] = $items[$row['parent']]['permissions'];
+                }
+                // Remove the parent group share
+                unset($items[$row['parent']]);
+                if ($row['permissions'] == 0) {
+                    continue;
+                }
+            } else if (!isset($uidOwner)) {
+                // Check if the same target already exists
+                if (isset($targets[$row['id']])) {
+                    // Check if the same owner shared with the user twice
+                    // through a group and user share - this is allowed
+                    $id = $targets[$row['id']];
+                    if (isset($items[$id]) && $items[$id]['uid_owner'] == $row['uid_owner']) {
+                        // Switch to group share type to ensure resharing conditions aren't bypassed
+                        if ($items[$id]['share_type'] != self::SHARE_TYPE_GROUP) {
+                            $items[$id]['share_type'] = self::SHARE_TYPE_GROUP;
+                            $items[$id]['share_with'] = $row['share_with'];
+                        }
+                        // Switch ids if sharing permission is granted on only
+                        // one share to ensure correct parent is used if resharing
+                        if (~(int)$items[$id]['permissions'] & \OCP\Constants::PERMISSION_SHARE
+                            && (int)$row['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
+                            $items[$row['id']] = $items[$id];
+                            $switchedItems[$id] = $row['id'];
+                            unset($items[$id]);
+                            $id = $row['id'];
+                        }
+                        $items[$id]['permissions'] |= (int)$row['permissions'];
+
+                    }
+                    continue;
+                } elseif (!empty($row['parent'])) {
+                    $targets[$row['parent']] = $row['id'];
+                }
+            }
+            // Remove root from file source paths if retrieving own shared items
+            if (isset($uidOwner) && isset($row['path'])) {
+                if (isset($row['parent'])) {
+                    $query = \OC_DB::prepare('SELECT `file_target` FROM `*PREFIX*share` WHERE `id` = ?');
+                    $parentResult = $query->execute([$row['parent']]);
+                    if ($result === false) {
+                        \OCP\Util::writeLog('OCP\Share', 'Can\'t select parent: ' .
+                            \OC_DB::getErrorMessage() . ', select=' . $select . ' where=' . $where,
+                            ILogger::ERROR);
+                    } else {
+                        $parentRow = $parentResult->fetchRow();
+                        $tmpPath = $parentRow['file_target'];
+                        // find the right position where the row path continues from the target path
+                        $pos = strrpos($row['path'], $parentRow['file_target']);
+                        $subPath = substr($row['path'], $pos);
+                        $splitPath = explode('/', $subPath);
+                        foreach (array_slice($splitPath, 2) as $pathPart) {
+                            $tmpPath = $tmpPath . '/' . $pathPart;
+                        }
+                        $row['path'] = $tmpPath;
+                    }
+                } else {
+                    if (!isset($mounts[$row['storage']])) {
+                        $mountPoints = \OC\Files\Filesystem::getMountByNumericId($row['storage']);
+                        if (is_array($mountPoints) && !empty($mountPoints)) {
+                            $mounts[$row['storage']] = current($mountPoints);
+                        }
+                    }
+                    if (!empty($mounts[$row['storage']])) {
+                        $path = $mounts[$row['storage']]->getMountPoint().$row['path'];
+                        $relPath = substr($path, $root); // path relative to data/user
+                        $row['path'] = rtrim($relPath, '/');
+                    }
+                }
+            }
+
+            if($checkExpireDate) {
+                if (self::expireItem($row)) {
+                    continue;
+                }
+            }
+            // Check if resharing is allowed, if not remove share permission
+            if (isset($row['permissions']) && (!self::isResharingAllowed() | \OCP\Util::isSharingDisabledForUser())) {
+                $row['permissions'] &= ~\OCP\Constants::PERMISSION_SHARE;
+            }
+            // Add display names to result
+            $row['share_with_displayname'] = $row['share_with'];
+            if ( isset($row['share_with']) && $row['share_with'] != '' &&
+                $row['share_type'] === self::SHARE_TYPE_USER) {
+                $shareWithUser = \OC::$server->getUserManager()->get($row['share_with']);
+                $row['share_with_displayname'] = $shareWithUser === null ? $row['share_with'] : $shareWithUser->getDisplayName();
+            } else if(isset($row['share_with']) && $row['share_with'] != '' &&
+                $row['share_type'] === self::SHARE_TYPE_REMOTE) {
+                $addressBookEntries = \OC::$server->getContactsManager()->search($row['share_with'], ['CLOUD']);
+                foreach ($addressBookEntries as $entry) {
+                    foreach ($entry['CLOUD'] as $cloudID) {
+                        if ($cloudID === $row['share_with']) {
+                            $row['share_with_displayname'] = $entry['FN'];
+                        }
+                    }
+                }
+            }
+            if ( isset($row['uid_owner']) && $row['uid_owner'] != '') {
+                $ownerUser = \OC::$server->getUserManager()->get($row['uid_owner']);
+                $row['displayname_owner'] = $ownerUser === null ? $row['uid_owner'] : $ownerUser->getDisplayName();
+            }
+
+            if ($row['permissions'] > 0) {
+                $items[$row['id']] = $row;
+            }
+
+        }
+
+        // group items if we are looking for items shared with the current user
+        if (isset($shareWith) && $shareWith === \OCP\User::getUser()) {
+            $items = self::groupItems($items, $itemType);
+        }
+
+        if (!empty($items)) {
+            $collectionItems = [];
+            foreach ($items as &$row) {
+                // Return only the item instead of a 2-dimensional array
+                if ($limit == 1 && $row[$column] == $item && ($row['item_type'] == $itemType || $itemType == 'file')) {
+                    if ($format == self::FORMAT_NONE) {
+                        return $row;
+                    } else {
+                        break;
+                    }
+                }
+                // Check if this is a collection of the requested item type
+                if ($includeCollections && $collectionTypes && $row['item_type'] !== 'folder' && in_array($row['item_type'], $collectionTypes)) {
+                    if (($collectionBackend = self::getBackend($row['item_type']))
+                        && $collectionBackend instanceof \OCP\Share_Backend_Collection) {
+                        // Collections can be inside collections, check if the item is a collection
+                        if (isset($item) && $row['item_type'] == $itemType && $row[$column] == $item) {
+                            $collectionItems[] = $row;
+                        } else {
+                            $collection = [];
+                            $collection['item_type'] = $row['item_type'];
+                            if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
+                                $collection['path'] = basename($row['path']);
+                            }
+                            $row['collection'] = $collection;
+                            // Fetch all of the children sources
+                            $children = $collectionBackend->getChildren($row[$column]);
+                            foreach ($children as $child) {
+                                $childItem = $row;
+                                $childItem['item_type'] = $itemType;
+                                if ($row['item_type'] != 'file' && $row['item_type'] != 'folder') {
+                                    $childItem['item_source'] = $child['source'];
+                                    $childItem['item_target'] = $child['target'];
+                                }
+                                if ($backend instanceof \OCP\Share_Backend_File_Dependent) {
+                                    if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
+                                        $childItem['file_source'] = $child['source'];
+                                    } else { // TODO is this really needed if we already know that we use the file backend?
+                                        $meta = \OC\Files\Filesystem::getFileInfo($child['file_path']);
+                                        $childItem['file_source'] = $meta['fileid'];
+                                    }
+                                    $childItem['file_target'] =
+                                        \OC\Files\Filesystem::normalizePath($child['file_path']);
+                                }
+                                if (isset($item)) {
+                                    if ($childItem[$column] == $item) {
+                                        // Return only the item instead of a 2-dimensional array
+                                        if ($limit == 1) {
+                                            if ($format == self::FORMAT_NONE) {
+                                                return $childItem;
+                                            } else {
+                                                // Unset the items array and break out of both loops
+                                                $items = [];
+                                                $items[] = $childItem;
+                                                break 2;
+                                            }
+                                        } else {
+                                            $collectionItems[] = $childItem;
+                                        }
+                                    }
+                                } else {
+                                    $collectionItems[] = $childItem;
+                                }
+                            }
+                        }
+                    }
+                    // Remove collection item
+                    $toRemove = $row['id'];
+                    if (array_key_exists($toRemove, $switchedItems)) {
+                        $toRemove = $switchedItems[$toRemove];
+                    }
+                    unset($items[$toRemove]);
+                } elseif ($includeCollections && $collectionTypes && in_array($row['item_type'], $collectionTypes)) {
+                    // FIXME: Thats a dirty hack to improve file sharing performance,
+                    // see github issue #10588 for more details
+                    // Need to find a solution which works for all back-ends
+                    $collectionBackend = self::getBackend($row['item_type']);
+                    $sharedParents = $collectionBackend->getParents($row['item_source']);
+                    foreach ($sharedParents as $parent) {
+                        $collectionItems[] = $parent;
+                    }
+                }
+            }
+            if (!empty($collectionItems)) {
+                $collectionItems = array_unique($collectionItems, SORT_REGULAR);
+                $items = array_merge($items, $collectionItems);
+            }
+
+            // filter out invalid items, these can appear when subshare entries exist
+            // for a group in which the requested user isn't a member any more
+            $items = array_filter($items, function($item) {
+                return $item['share_type'] !== self::$shareTypeGroupUserUnique;
+            });
+
+            return self::formatResult($items, $column, $backend, $format, $parameters);
+        } elseif ($includeCollections && $collectionTypes && in_array('folder', $collectionTypes)) {
+            // FIXME: Thats a dirty hack to improve file sharing performance,
+            // see github issue #10588 for more details
+            // Need to find a solution which works for all back-ends
+            $collectionItems = [];
+            $collectionBackend = self::getBackend('folder');
+            $sharedParents = $collectionBackend->getParents($item, $shareWith, $uidOwner);
+            foreach ($sharedParents as $parent) {
+                $collectionItems[] = $parent;
+            }
+            if ($limit === 1) {
+                return reset($collectionItems);
+            }
+            return self::formatResult($collectionItems, $column, $backend, $format, $parameters);
+        }
+
+        return [];
+    }
+
+    /**
+     * group items with link to the same source
+     *
+     * @param array $items
+     * @param string $itemType
+     * @return array of grouped items
+     */
+    protected static function groupItems($items, $itemType) {
+
+        $fileSharing = $itemType === 'file' || $itemType === 'folder';
+
+        $result = [];
+
+        foreach ($items as $item) {
+            $grouped = false;
+            foreach ($result as $key => $r) {
+                // for file/folder shares we need to compare file_source, otherwise we compare item_source
+                // only group shares if they already point to the same target, otherwise the file where shared
+                // before grouping of shares was added. In this case we don't group them toi avoid confusions
+                if (( $fileSharing && $item['file_source'] === $r['file_source'] && $item['file_target'] === $r['file_target']) ||
+                    (!$fileSharing && $item['item_source'] === $r['item_source'] && $item['item_target'] === $r['item_target'])) {
+                    // add the first item to the list of grouped shares
+                    if (!isset($result[$key]['grouped'])) {
+                        $result[$key]['grouped'][] = $result[$key];
+                    }
+                    $result[$key]['permissions'] = (int) $item['permissions'] | (int) $r['permissions'];
+                    $result[$key]['grouped'][] = $item;
+                    $grouped = true;
+                    break;
+                }
+            }
+
+            if (!$grouped) {
+                $result[] = $item;
+            }
+
+        }
+
+        return $result;
+    }
+
+    /**
+     * Put shared item into the database
+     * @param string $itemType Item type
+     * @param string $itemSource Item source
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
+     * @param string $shareWith User or group the item is being shared with
+     * @param string $uidOwner User that is the owner of shared item
+     * @param int $permissions CRUDS permissions
+     * @throws \Exception
+     * @return mixed id of the new share or false
+     * @deprecated TESTS ONLY - this methods is only used by tests
+     * called like this:
+     * self::put('test', $itemSource, self::SHARE_TYPE_USER, $shareWith, $uidOwner, $permissions);
+     */
+    private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
+                                $permissions) {
+
+        $queriesToExecute = [];
+        $suggestedItemTarget = null;
+        $groupFileTarget = $fileTarget = $suggestedFileTarget = $filePath = '';
+        $groupItemTarget = $itemTarget = $fileSource = $parent = 0;
+
+        $result = self::checkReshare('test', $itemSource, self::SHARE_TYPE_USER, $shareWith, $uidOwner, $permissions, null, null);
+        if(!empty($result)) {
+            $parent = $result['parent'];
+            $itemSource = $result['itemSource'];
+            $fileSource = $result['fileSource'];
+            $suggestedItemTarget = $result['suggestedItemTarget'];
+            $suggestedFileTarget = $result['suggestedFileTarget'];
+            $filePath = $result['filePath'];
+        }
+
+        $isGroupShare = false;
+            $users = [$shareWith];
+            $itemTarget = Helper::generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
+                $suggestedItemTarget);
+
+        $run = true;
+        $error = '';
+        $preHookData = [
+            'itemType' => $itemType,
+            'itemSource' => $itemSource,
+            'shareType' => $shareType,
+            'uidOwner' => $uidOwner,
+            'permissions' => $permissions,
+            'fileSource' => $fileSource,
+            'expiration' => null,
+            'token' => null,
+            'run' => &$run,
+            'error' => &$error
+        ];
+
+        $preHookData['itemTarget'] = $itemTarget;
+        $preHookData['shareWith'] = $shareWith;
+
+        \OC_Hook::emit(\OCP\Share::class, 'pre_shared', $preHookData);
+
+        if ($run === false) {
+            throw new \Exception($error);
+        }
+
+        foreach ($users as $user) {
+            $sourceId = ($itemType === 'file' || $itemType === 'folder') ? $fileSource : $itemSource;
+            $sourceExists = self::getItemSharedWithBySource($itemType, $sourceId, self::FORMAT_NONE, null, true, $user);
+
+            $userShareType = $shareType;
+
+            if ($sourceExists && $sourceExists['item_source'] === $itemSource) {
+                $fileTarget = $sourceExists['file_target'];
+                $itemTarget = $sourceExists['item_target'];
+
+            } elseif(!$sourceExists)  {
+
+                $itemTarget = Helper::generateTarget($itemType, $itemSource, $userShareType, $user,
+                    $uidOwner, $suggestedItemTarget, $parent);
+                if (isset($fileSource)) {
+                        $fileTarget = Helper::generateTarget('file', $filePath, $userShareType,
+                            $user, $uidOwner, $suggestedFileTarget, $parent);
+                } else {
+                    $fileTarget = null;
+                }
+
+            } else {
+
+                // group share which doesn't exists until now, check if we need a unique target for this user
+
+                $itemTarget = Helper::generateTarget($itemType, $itemSource, self::SHARE_TYPE_USER, $user,
+                    $uidOwner, $suggestedItemTarget, $parent);
+
+                // do we also need a file target
+                if (isset($fileSource)) {
+                    $fileTarget = Helper::generateTarget('file', $filePath, self::SHARE_TYPE_USER, $user,
+                        $uidOwner, $suggestedFileTarget, $parent);
+                } else {
+                    $fileTarget = null;
+                }
+
+                if (($itemTarget === $groupItemTarget) &&
+                    (!isset($fileSource) || $fileTarget === $groupFileTarget)) {
+                    continue;
+                }
+            }
+
+            $queriesToExecute[] = [
+                'itemType'			=> $itemType,
+                'itemSource'		=> $itemSource,
+                'itemTarget'		=> $itemTarget,
+                'shareType'			=> $userShareType,
+                'shareWith'			=> $user,
+                'uidOwner'			=> $uidOwner,
+                'permissions'		=> $permissions,
+                'shareTime'			=> time(),
+                'fileSource'		=> $fileSource,
+                'fileTarget'		=> $fileTarget,
+                'token'				=> null,
+                'parent'			=> $parent,
+                'expiration'		=> null,
+            ];
+
+        }
+
+        $id = false;
+
+        foreach ($queriesToExecute as $shareQuery) {
+            $shareQuery['parent'] = $parent;
+            $id = self::insertShare($shareQuery);
+        }
+
+        $postHookData = [
+            'itemType' => $itemType,
+            'itemSource' => $itemSource,
+            'parent' => $parent,
+            'shareType' => $shareType,
+            'uidOwner' => $uidOwner,
+            'permissions' => $permissions,
+            'fileSource' => $fileSource,
+            'id' => $parent,
+            'token' => null,
+            'expirationDate' => null,
+        ];
+
+        $postHookData['shareWith'] = $isGroupShare ? $shareWith['group'] : $shareWith;
+        $postHookData['itemTarget'] = $isGroupShare ? $groupItemTarget : $itemTarget;
+        $postHookData['fileTarget'] = $isGroupShare ? $groupFileTarget : $fileTarget;
+
+        \OC_Hook::emit(\OCP\Share::class, 'post_shared', $postHookData);
+
+
+        return $id ? $id : false;
+    }
+
+    /**
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $shareType
+     * @param string $shareWith
+     * @param string $uidOwner
+     * @param int $permissions
+     * @param string|null $itemSourceName
+     * @param null|\DateTime $expirationDate
+     * @deprecated TESTS ONLY - this methods is only used by tests
+     * called like this:
+     * self::checkReshare('test', $itemSource, self::SHARE_TYPE_USER, $shareWith, $uidOwner, $permissions, null, null);
+     */
+    private static function checkReshare($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions, $itemSourceName, $expirationDate) {
+        $backend = self::getBackend($itemType);
+
+        $result = [];
+
+        $column = ($itemType === 'file' || $itemType === 'folder') ? 'file_source' : 'item_source';
+
+        $checkReshare = self::getItemSharedWithBySource($itemType, $itemSource, self::FORMAT_NONE, null, true);
+        if ($checkReshare) {
+            // Check if attempting to share back to owner
+            if ($checkReshare['uid_owner'] == $shareWith) {
+                $message = 'Sharing %1$s failed, because the user %2$s is the original sharer';
+                throw new \Exception(sprintf($message, $itemSourceName, $shareWith));
+            }
+        }
+
+        if ($checkReshare && $checkReshare['uid_owner'] !== \OC_User::getUser()) {
+            // Check if share permissions is granted
+            if (self::isResharingAllowed() && (int)$checkReshare['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
+                if (~(int)$checkReshare['permissions'] & $permissions) {
+                    $message = 'Sharing %1$s failed, because the permissions exceed permissions granted to %2$s';
+                    throw new \Exception(sprintf($message, $itemSourceName, $uidOwner));
+                } else {
+                    // TODO Don't check if inside folder
+                    $result['parent'] = $checkReshare['id'];
+
+                    $result['expirationDate'] = $expirationDate;
+                    // $checkReshare['expiration'] could be null and then is always less than any value
+                    if(isset($checkReshare['expiration']) && $checkReshare['expiration'] < $expirationDate) {
+                        $result['expirationDate'] = $checkReshare['expiration'];
+                    }
+
+                    // only suggest the same name as new target if it is a reshare of the
+                    // same file/folder and not the reshare of a child
+                    if ($checkReshare[$column] === $itemSource) {
+                        $result['filePath'] = $checkReshare['file_target'];
+                        $result['itemSource'] = $checkReshare['item_source'];
+                        $result['fileSource'] = $checkReshare['file_source'];
+                        $result['suggestedItemTarget'] = $checkReshare['item_target'];
+                        $result['suggestedFileTarget'] = $checkReshare['file_target'];
+                    } else {
+                        $result['filePath'] = ($backend instanceof \OCP\Share_Backend_File_Dependent) ? $backend->getFilePath($itemSource, $uidOwner) : null;
+                        $result['suggestedItemTarget'] = null;
+                        $result['suggestedFileTarget'] = null;
+                        $result['itemSource'] = $itemSource;
+                        $result['fileSource'] = ($backend instanceof \OCP\Share_Backend_File_Dependent) ? $itemSource : null;
+                    }
+                }
+            } else {
+                $message = 'Sharing %s failed, because resharing is not allowed';
+                throw new \Exception(sprintf($message, $itemSourceName));
+            }
+        } else {
+            $result['parent'] = null;
+            $result['suggestedItemTarget'] = null;
+            $result['suggestedFileTarget'] = null;
+            $result['itemSource'] = $itemSource;
+            $result['expirationDate'] = $expirationDate;
+            if (!$backend->isValidSource($itemSource, $uidOwner)) {
+                $message = 'Sharing %1$s failed, because the sharing backend for '
+                    .'%2$s could not find its source';
+                throw new \Exception(sprintf($message, $itemSource, $itemType));
+            }
+            if ($backend instanceof \OCP\Share_Backend_File_Dependent) {
+                $result['filePath'] = $backend->getFilePath($itemSource, $uidOwner);
+                    $meta = \OC\Files\Filesystem::getFileInfo($result['filePath']);
+                    $result['fileSource'] = $meta['fileid'];
+                if ($result['fileSource'] == -1) {
+                    $message = 'Sharing %s failed, because the file could not be found in the file cache';
+                    throw new \Exception(sprintf($message, $itemSource));
+                }
+            } else {
+                $result['filePath'] = null;
+                $result['fileSource'] = null;
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     *
+     * @param array $shareData
+     * @return mixed false in case of a failure or the id of the new share
+     */
+    private static function insertShare(array $shareData) {
+
+        $query = \OC_DB::prepare('INSERT INTO `*PREFIX*share` ('
+            .' `item_type`, `item_source`, `item_target`, `share_type`,'
+            .' `share_with`, `uid_owner`, `permissions`, `stime`, `file_source`,'
+            .' `file_target`, `token`, `parent`, `expiration`) VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)');
+        $query->bindValue(1, $shareData['itemType']);
+        $query->bindValue(2, $shareData['itemSource']);
+        $query->bindValue(3, $shareData['itemTarget']);
+        $query->bindValue(4, $shareData['shareType']);
+        $query->bindValue(5, $shareData['shareWith']);
+        $query->bindValue(6, $shareData['uidOwner']);
+        $query->bindValue(7, $shareData['permissions']);
+        $query->bindValue(8, $shareData['shareTime']);
+        $query->bindValue(9, $shareData['fileSource']);
+        $query->bindValue(10, $shareData['fileTarget']);
+        $query->bindValue(11, $shareData['token']);
+        $query->bindValue(12, $shareData['parent']);
+        $query->bindValue(13, $shareData['expiration'], 'datetime');
+        $result = $query->execute();
+
+        $id = false;
+        if ($result) {
+            $id =  \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share');
+        }
+
+        return $id;
+
+    }
+
+    /**
+     * construct select statement
+     * @param int $format
+     * @param boolean $fileDependent ist it a file/folder share or a generla share
+     * @param string $uidOwner
+     * @return string select statement
+     */
+    private static function createSelectStatement($format, $fileDependent, $uidOwner = null) {
+        $select = '*';
+        if ($format == self::FORMAT_STATUSES) {
+            if ($fileDependent) {
+                $select = '`*PREFIX*share`.`id`, `*PREFIX*share`.`parent`, `share_type`, `path`, `storage`, '
+                    . '`share_with`, `uid_owner` , `file_source`, `stime`, `*PREFIX*share`.`permissions`, '
+                    . '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`, '
+                    . '`uid_initiator`';
+            } else {
+                $select = '`id`, `parent`, `share_type`, `share_with`, `uid_owner`, `item_source`, `stime`, `*PREFIX*share`.`permissions`';
+            }
+        } else {
+            if (isset($uidOwner)) {
+                if ($fileDependent) {
+                    $select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `*PREFIX*share`.`parent`,'
+                        . ' `share_type`, `share_with`, `file_source`, `file_target`, `path`, `*PREFIX*share`.`permissions`, `stime`,'
+                        . ' `expiration`, `token`, `storage`, `mail_send`, `uid_owner`, '
+                        . '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`';
+                } else {
+                    $select = '`id`, `item_type`, `item_source`, `parent`, `share_type`, `share_with`, `*PREFIX*share`.`permissions`,'
+                        . ' `stime`, `file_source`, `expiration`, `token`, `mail_send`, `uid_owner`';
+                }
+            } else {
+                if ($fileDependent) {
+                    if ($format == \OCA\Files_Sharing\ShareBackend\File::FORMAT_GET_FOLDER_CONTENTS || $format == \OCA\Files_Sharing\ShareBackend\File::FORMAT_FILE_APP_ROOT) {
+                        $select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `*PREFIX*share`.`parent`, `uid_owner`, '
+                            . '`share_type`, `share_with`, `file_source`, `path`, `file_target`, `stime`, '
+                            . '`*PREFIX*share`.`permissions`, `expiration`, `storage`, `*PREFIX*filecache`.`parent` as `file_parent`, '
+                            . '`name`, `mtime`, `mimetype`, `mimepart`, `size`, `encrypted`, `etag`, `mail_send`';
+                    } else {
+                        $select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `item_target`,'
+                            . '`*PREFIX*share`.`parent`, `share_type`, `share_with`, `uid_owner`,'
+                            . '`file_source`, `path`, `file_target`, `*PREFIX*share`.`permissions`,'
+                            . '`stime`, `expiration`, `token`, `storage`, `mail_send`,'
+                            . '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`';
+                    }
+                }
+            }
+        }
+        return $select;
+    }
+
+
+    /**
+     * transform db results
+     * @param array $row result
+     */
+    private static function transformDBResults(&$row) {
+        if (isset($row['id'])) {
+            $row['id'] = (int) $row['id'];
+        }
+        if (isset($row['share_type'])) {
+            $row['share_type'] = (int) $row['share_type'];
+        }
+        if (isset($row['parent'])) {
+            $row['parent'] = (int) $row['parent'];
+        }
+        if (isset($row['file_parent'])) {
+            $row['file_parent'] = (int) $row['file_parent'];
+        }
+        if (isset($row['file_source'])) {
+            $row['file_source'] = (int) $row['file_source'];
+        }
+        if (isset($row['permissions'])) {
+            $row['permissions'] = (int) $row['permissions'];
+        }
+        if (isset($row['storage'])) {
+            $row['storage'] = (int) $row['storage'];
+        }
+        if (isset($row['stime'])) {
+            $row['stime'] = (int) $row['stime'];
+        }
+        if (isset($row['expiration']) && $row['share_type'] !== self::SHARE_TYPE_LINK) {
+            // discard expiration date for non-link shares, which might have been
+            // set by ancient bugs
+            $row['expiration'] = null;
+        }
+    }
+
+    /**
+     * format result
+     * @param array $items result
+     * @param string $column is it a file share or a general share ('file_target' or 'item_target')
+     * @param \OCP\Share_Backend $backend sharing backend
+     * @param int $format
+     * @param array $parameters additional format parameters
+     * @return array format result
+     */
+    private static function formatResult($items, $column, $backend, $format = self::FORMAT_NONE , $parameters = null) {
+        if ($format === self::FORMAT_NONE) {
+            return $items;
+        } else if ($format === self::FORMAT_STATUSES) {
+            $statuses = [];
+            foreach ($items as $item) {
+                if ($item['share_type'] === self::SHARE_TYPE_LINK) {
+                    if ($item['uid_initiator'] !== \OC::$server->getUserSession()->getUser()->getUID()) {
+                        continue;
+                    }
+                    $statuses[$item[$column]]['link'] = true;
+                } else if (!isset($statuses[$item[$column]])) {
+                    $statuses[$item[$column]]['link'] = false;
+                }
+                if (!empty($item['file_target'])) {
+                    $statuses[$item[$column]]['path'] = $item['path'];
+                }
+            }
+            return $statuses;
+        } else {
+            return $backend->formatItems($items, $format, $parameters);
+        }
+    }
+
+    /**
+     * remove protocol from URL
+     *
+     * @param string $url
+     * @return string
+     */
+    public static function removeProtocolFromUrl($url) {
+        if (strpos($url, 'https://') === 0) {
+            return substr($url, strlen('https://'));
+        } else if (strpos($url, 'http://') === 0) {
+            return substr($url, strlen('http://'));
+        }
+
+        return $url;
+    }
+
+    /**
+     * try http post first with https and then with http as a fallback
+     *
+     * @param string $remoteDomain
+     * @param string $urlSuffix
+     * @param array $fields post parameters
+     * @return array
+     */
+    private static function tryHttpPostToShareEndpoint($remoteDomain, $urlSuffix, array $fields) {
+        $protocol = 'https://';
+        $result = [
+            'success' => false,
+            'result' => '',
+        ];
+        $try = 0;
+        $discoveryService = \OC::$server->query(\OCP\OCS\IDiscoveryService::class);
+        while ($result['success'] === false && $try < 2) {
+            $federationEndpoints = $discoveryService->discover($protocol . $remoteDomain, 'FEDERATED_SHARING');
+            $endpoint = isset($federationEndpoints['share']) ? $federationEndpoints['share'] : '/ocs/v2.php/cloud/shares';
+            $client = \OC::$server->getHTTPClientService()->newClient();
+
+            try {
+                $response = $client->post(
+                    $protocol . $remoteDomain . $endpoint . $urlSuffix . '?format=' . self::RESPONSE_FORMAT,
+                    [
+                        'body' => $fields,
+                        'connect_timeout' => 10,
+                    ]
+                );
+
+                $result = ['success' => true, 'result' => $response->getBody()];
+            } catch (\Exception $e) {
+                $result = ['success' => false, 'result' => $e->getMessage()];
+            }
+
+            $try++;
+            $protocol = 'http://';
+        }
+
+        return $result;
+    }
+
+    /**
+     * send server-to-server unshare to remote server
+     *
+     * @param string $remote url
+     * @param int $id share id
+     * @param string $token
+     * @return bool
+     */
+    private static function sendRemoteUnshare($remote, $id, $token) {
+        $url = rtrim($remote, '/');
+        $fields = ['token' => $token, 'format' => 'json'];
+        $url = self::removeProtocolFromUrl($url);
+        $result = self::tryHttpPostToShareEndpoint($url, '/'.$id.'/unshare', $fields);
+        $status = json_decode($result['result'], true);
+
+        return ($result['success'] && ($status['ocs']['meta']['statuscode'] === 100 || $status['ocs']['meta']['statuscode'] === 200));
+    }
+
+    /**
+     * @return int
+     */
+    public static function getExpireInterval() {
+        return (int)\OC::$server->getConfig()->getAppValue('core', 'shareapi_expire_after_n_days', '7');
+    }
+
+    /**
+     * Checks whether the given path is reachable for the given owner
+     *
+     * @param string $path path relative to files
+     * @param string $ownerStorageId storage id of the owner
+     *
+     * @return boolean true if file is reachable, false otherwise
+     */
+    private static function isFileReachable($path, $ownerStorageId) {
+        // if outside the home storage, file is always considered reachable
+        if (!(substr($ownerStorageId, 0, 6) === 'home::' ||
+            substr($ownerStorageId, 0, 13) === 'object::user:'
+        )) {
+            return true;
+        }
+
+        // if inside the home storage, the file has to be under "/files/"
+        $path = ltrim($path, '/');
+        if (substr($path, 0, 6) === 'files/') {
+            return true;
+        }
+
+        return false;
+    }
 }

lib/private/AppFramework/Middleware/OCSMiddleware.php

Indentation +109 added lines, -109 removed lines

@@ -40,116 +40,116 @@
 
 class OCSMiddleware extends Middleware {
 
-	/** @var IRequest */
-	private $request;
-
-	/** @var int */
-	private $ocsVersion;
-
-	/**
-	 * @param IRequest $request
-	 */
-	public function __construct(IRequest $request) {
-		$this->request = $request;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param string $methodName
-	 */
-	public function beforeController($controller, $methodName) {
-		if ($controller instanceof OCSController) {
-			if (substr_compare($this->request->getScriptName(), '/ocs/v2.php', -strlen('/ocs/v2.php')) === 0) {
-				$this->ocsVersion = 2;
-			} else {
-				$this->ocsVersion = 1;
-			}
-			$controller->setOCSVersion($this->ocsVersion);
-		}
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param string $methodName
-	 * @param \Exception $exception
-	 * @throws \Exception
-	 * @return BaseResponse
-	 */
-	public function afterException($controller, $methodName, \Exception $exception) {
-		if ($controller instanceof OCSController && $exception instanceof OCSException) {
-			$code = $exception->getCode();
-			if ($code === 0) {
-				$code = API::RESPOND_UNKNOWN_ERROR;
-			}
-
-			return $this->buildNewResponse($controller, $code, $exception->getMessage());
-		}
-
-		throw $exception;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param string $methodName
-	 * @param Response $response
-	 * @return \OCP\AppFramework\Http\Response
-	 */
-	public function afterController($controller, $methodName, Response $response) {
-		/*
+    /** @var IRequest */
+    private $request;
+
+    /** @var int */
+    private $ocsVersion;
+
+    /**
+     * @param IRequest $request
+     */
+    public function __construct(IRequest $request) {
+        $this->request = $request;
+    }
+
+    /**
+     * @param Controller $controller
+     * @param string $methodName
+     */
+    public function beforeController($controller, $methodName) {
+        if ($controller instanceof OCSController) {
+            if (substr_compare($this->request->getScriptName(), '/ocs/v2.php', -strlen('/ocs/v2.php')) === 0) {
+                $this->ocsVersion = 2;
+            } else {
+                $this->ocsVersion = 1;
+            }
+            $controller->setOCSVersion($this->ocsVersion);
+        }
+    }
+
+    /**
+     * @param Controller $controller
+     * @param string $methodName
+     * @param \Exception $exception
+     * @throws \Exception
+     * @return BaseResponse
+     */
+    public function afterException($controller, $methodName, \Exception $exception) {
+        if ($controller instanceof OCSController && $exception instanceof OCSException) {
+            $code = $exception->getCode();
+            if ($code === 0) {
+                $code = API::RESPOND_UNKNOWN_ERROR;
+            }
+
+            return $this->buildNewResponse($controller, $code, $exception->getMessage());
+        }
+
+        throw $exception;
+    }
+
+    /**
+     * @param Controller $controller
+     * @param string $methodName
+     * @param Response $response
+     * @return \OCP\AppFramework\Http\Response
+     */
+    public function afterController($controller, $methodName, Response $response) {
+        /*
 		 * If a different middleware has detected that a request unauthorized or forbidden
 		 * we need to catch the response and convert it to a proper OCS response.
 		 */
-		if ($controller instanceof OCSController && !($response instanceof BaseResponse)) {
-			if ($response->getStatus() === Http::STATUS_UNAUTHORIZED ||
-				$response->getStatus() === Http::STATUS_FORBIDDEN) {
-
-				$message = '';
-				if ($response instanceof JSONResponse) {
-					/** @var DataResponse $response */
-					$message = $response->getData()['message'];
-				}
-
-				return $this->buildNewResponse($controller, API::RESPOND_UNAUTHORISED, $message);
-			}
-		}
-
-		return $response;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param int $code
-	 * @param string $message
-	 * @return V1Response|V2Response
-	 */
-	private function buildNewResponse(Controller $controller, $code, $message) {
-		$format = $this->getFormat($controller);
-
-		$data = new DataResponse();
-		$data->setStatus($code);
-		if ($this->ocsVersion === 1) {
-			$response = new V1Response($data, $format, $message);
-		} else {
-			$response = new V2Response($data, $format, $message);
-		}
-
-		return $response;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @return string
-	 */
-	private function getFormat(Controller $controller) {
-		// get format from the url format or request format parameter
-		$format = $this->request->getParam('format');
-
-		// if none is given try the first Accept header
-		if($format === null) {
-			$headers = $this->request->getHeader('Accept');
-			$format = $controller->getResponderByHTTPHeader($headers, 'xml');
-		}
-
-		return $format;
-	}
+        if ($controller instanceof OCSController && !($response instanceof BaseResponse)) {
+            if ($response->getStatus() === Http::STATUS_UNAUTHORIZED ||
+                $response->getStatus() === Http::STATUS_FORBIDDEN) {
+
+                $message = '';
+                if ($response instanceof JSONResponse) {
+                    /** @var DataResponse $response */
+                    $message = $response->getData()['message'];
+                }
+
+                return $this->buildNewResponse($controller, API::RESPOND_UNAUTHORISED, $message);
+            }
+        }
+
+        return $response;
+    }
+
+    /**
+     * @param Controller $controller
+     * @param int $code
+     * @param string $message
+     * @return V1Response|V2Response
+     */
+    private function buildNewResponse(Controller $controller, $code, $message) {
+        $format = $this->getFormat($controller);
+
+        $data = new DataResponse();
+        $data->setStatus($code);
+        if ($this->ocsVersion === 1) {
+            $response = new V1Response($data, $format, $message);
+        } else {
+            $response = new V2Response($data, $format, $message);
+        }
+
+        return $response;
+    }
+
+    /**
+     * @param Controller $controller
+     * @return string
+     */
+    private function getFormat(Controller $controller) {
+        // get format from the url format or request format parameter
+        $format = $this->request->getParam('format');
+
+        // if none is given try the first Accept header
+        if($format === null) {
+            $headers = $this->request->getHeader('Accept');
+            $format = $controller->getResponderByHTTPHeader($headers, 'xml');
+        }
+
+        return $format;
+    }
 }

lib/private/AppFramework/Middleware/Security/SecurityMiddleware.php

Indentation +167 added lines, -167 removed lines

@@ -67,103 +67,103 @@ 
  * check fails
  */
 class SecurityMiddleware extends Middleware {
-	/** @var INavigationManager */
-	private $navigationManager;
-	/** @var IRequest */
-	private $request;
-	/** @var ControllerMethodReflector */
-	private $reflector;
-	/** @var string */
-	private $appName;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var ILogger */
-	private $logger;
-	/** @var bool */
-	private $isLoggedIn;
-	/** @var bool */
-	private $isAdminUser;
-	/** @var bool */
-	private $isSubAdmin;
-	/** @var IAppManager */
-	private $appManager;
-	/** @var IL10N */
-	private $l10n;
-
-	public function __construct(IRequest $request,
-								ControllerMethodReflector $reflector,
-								INavigationManager $navigationManager,
-								IURLGenerator $urlGenerator,
-								ILogger $logger,
-								string $appName,
-								bool $isLoggedIn,
-								bool $isAdminUser,
-								bool $isSubAdmin,
-								IAppManager $appManager,
-								IL10N $l10n
-	) {
-		$this->navigationManager = $navigationManager;
-		$this->request = $request;
-		$this->reflector = $reflector;
-		$this->appName = $appName;
-		$this->urlGenerator = $urlGenerator;
-		$this->logger = $logger;
-		$this->isLoggedIn = $isLoggedIn;
-		$this->isAdminUser = $isAdminUser;
-		$this->isSubAdmin = $isSubAdmin;
-		$this->appManager = $appManager;
-		$this->l10n = $l10n;
-	}
-
-	/**
-	 * This runs all the security checks before a method call. The
-	 * security checks are determined by inspecting the controller method
-	 * annotations
-	 * @param Controller $controller the controller
-	 * @param string $methodName the name of the method
-	 * @throws SecurityException when a security check fails
-	 *
-	 * @suppress PhanUndeclaredClassConstant
-	 */
-	public function beforeController($controller, $methodName) {
-
-		// this will set the current navigation entry of the app, use this only
-		// for normal HTML requests and not for AJAX requests
-		$this->navigationManager->setActiveEntry($this->appName);
-
-		if (get_class($controller) === \OCA\Talk\Controller\PageController::class && $methodName === 'showCall') {
-			$this->navigationManager->setActiveEntry('spreed');
-		}
-
-		// security checks
-		$isPublicPage = $this->reflector->hasAnnotation('PublicPage');
-		if(!$isPublicPage) {
-			if(!$this->isLoggedIn) {
-				throw new NotLoggedInException();
-			}
-
-			if($this->reflector->hasAnnotation('SubAdminRequired')
-				&& !$this->isSubAdmin
-				&& !$this->isAdminUser) {
-				throw new NotAdminException($this->l10n->t('Logged in user must be an admin or sub admin'));
-			}
-			if(!$this->reflector->hasAnnotation('SubAdminRequired')
-				&& !$this->reflector->hasAnnotation('NoAdminRequired')
-				&& !$this->isAdminUser) {
-				throw new NotAdminException($this->l10n->t('Logged in user must be an admin'));
-			}
-		}
-
-		// Check for strict cookie requirement
-		if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
-			if(!$this->request->passesStrictCookieCheck()) {
-				throw new StrictCookieMissingException();
-			}
-		}
-		// CSRF check - also registers the CSRF token since the session may be closed later
-		Util::callRegister();
-		if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
-			/*
+    /** @var INavigationManager */
+    private $navigationManager;
+    /** @var IRequest */
+    private $request;
+    /** @var ControllerMethodReflector */
+    private $reflector;
+    /** @var string */
+    private $appName;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var ILogger */
+    private $logger;
+    /** @var bool */
+    private $isLoggedIn;
+    /** @var bool */
+    private $isAdminUser;
+    /** @var bool */
+    private $isSubAdmin;
+    /** @var IAppManager */
+    private $appManager;
+    /** @var IL10N */
+    private $l10n;
+
+    public function __construct(IRequest $request,
+                                ControllerMethodReflector $reflector,
+                                INavigationManager $navigationManager,
+                                IURLGenerator $urlGenerator,
+                                ILogger $logger,
+                                string $appName,
+                                bool $isLoggedIn,
+                                bool $isAdminUser,
+                                bool $isSubAdmin,
+                                IAppManager $appManager,
+                                IL10N $l10n
+    ) {
+        $this->navigationManager = $navigationManager;
+        $this->request = $request;
+        $this->reflector = $reflector;
+        $this->appName = $appName;
+        $this->urlGenerator = $urlGenerator;
+        $this->logger = $logger;
+        $this->isLoggedIn = $isLoggedIn;
+        $this->isAdminUser = $isAdminUser;
+        $this->isSubAdmin = $isSubAdmin;
+        $this->appManager = $appManager;
+        $this->l10n = $l10n;
+    }
+
+    /**
+     * This runs all the security checks before a method call. The
+     * security checks are determined by inspecting the controller method
+     * annotations
+     * @param Controller $controller the controller
+     * @param string $methodName the name of the method
+     * @throws SecurityException when a security check fails
+     *
+     * @suppress PhanUndeclaredClassConstant
+     */
+    public function beforeController($controller, $methodName) {
+
+        // this will set the current navigation entry of the app, use this only
+        // for normal HTML requests and not for AJAX requests
+        $this->navigationManager->setActiveEntry($this->appName);
+
+        if (get_class($controller) === \OCA\Talk\Controller\PageController::class && $methodName === 'showCall') {
+            $this->navigationManager->setActiveEntry('spreed');
+        }
+
+        // security checks
+        $isPublicPage = $this->reflector->hasAnnotation('PublicPage');
+        if(!$isPublicPage) {
+            if(!$this->isLoggedIn) {
+                throw new NotLoggedInException();
+            }
+
+            if($this->reflector->hasAnnotation('SubAdminRequired')
+                && !$this->isSubAdmin
+                && !$this->isAdminUser) {
+                throw new NotAdminException($this->l10n->t('Logged in user must be an admin or sub admin'));
+            }
+            if(!$this->reflector->hasAnnotation('SubAdminRequired')
+                && !$this->reflector->hasAnnotation('NoAdminRequired')
+                && !$this->isAdminUser) {
+                throw new NotAdminException($this->l10n->t('Logged in user must be an admin'));
+            }
+        }
+
+        // Check for strict cookie requirement
+        if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
+            if(!$this->request->passesStrictCookieCheck()) {
+                throw new StrictCookieMissingException();
+            }
+        }
+        // CSRF check - also registers the CSRF token since the session may be closed later
+        Util::callRegister();
+        if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
+            /*
 			 * Only allow the CSRF check to fail on OCS Requests. This kind of
 			 * hacks around that we have no full token auth in place yet and we
 			 * do want to offer CSRF checks for web requests.
@@ -171,75 +171,75 @@ 
 			 * Additionally we allow Bearer authenticated requests to pass on OCS routes.
 			 * This allows oauth apps (e.g. moodle) to use the OCS endpoints
 			 */
-			if(!$this->request->passesCSRFCheck() && !(
-					$controller instanceof OCSController && (
-						$this->request->getHeader('OCS-APIREQUEST') === 'true' ||
-						strpos($this->request->getHeader('Authorization'), 'Bearer ') === 0
-					)
-				)) {
-				throw new CrossSiteRequestForgeryException();
-			}
-		}
-
-		/**
-		 * Checks if app is enabled (also includes a check whether user is allowed to access the resource)
-		 * The getAppPath() check is here since components such as settings also use the AppFramework and
-		 * therefore won't pass this check.
-		 * If page is public, app does not need to be enabled for current user/visitor
-		 */
-		try {
-			$appPath = $this->appManager->getAppPath($this->appName);
-		} catch (AppPathNotFoundException $e) {
-			$appPath = false;
-		}
-
-		if ($appPath !== false && !$isPublicPage && !$this->appManager->isEnabledForUser($this->appName)) {
-			throw new AppNotEnabledException();
-		}
-	}
-
-	/**
-	 * If an SecurityException is being caught, ajax requests return a JSON error
-	 * response and non ajax requests redirect to the index
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param \Exception $exception the thrown exception
-	 * @throws \Exception the passed in exception if it can't handle it
-	 * @return Response a Response object or null in case that the exception could not be handled
-	 */
-	public function afterException($controller, $methodName, \Exception $exception): Response {
-		if($exception instanceof SecurityException) {
-			if($exception instanceof StrictCookieMissingException) {
-				return new RedirectResponse(\OC::$WEBROOT);
-			}
-			if (stripos($this->request->getHeader('Accept'),'html') === false) {
-				$response = new JSONResponse(
-					['message' => $exception->getMessage()],
-					$exception->getCode()
-				);
-			} else {
-				if($exception instanceof NotLoggedInException) {
-					$params = [];
-					if (isset($this->request->server['REQUEST_URI'])) {
-						$params['redirect_url'] = $this->request->server['REQUEST_URI'];
-					}
-					$url = $this->urlGenerator->linkToRoute('core.login.showLoginForm', $params);
-					$response = new RedirectResponse($url);
-				} else {
-					$response = new TemplateResponse('core', '403', ['message' => $exception->getMessage()], 'guest');
-					$response->setStatus($exception->getCode());
-				}
-			}
-
-			$this->logger->logException($exception, [
-				'level' => ILogger::DEBUG,
-				'app' => 'core',
-			]);
-			return $response;
-		}
-
-		throw $exception;
-	}
+            if(!$this->request->passesCSRFCheck() && !(
+                    $controller instanceof OCSController && (
+                        $this->request->getHeader('OCS-APIREQUEST') === 'true' ||
+                        strpos($this->request->getHeader('Authorization'), 'Bearer ') === 0
+                    )
+                )) {
+                throw new CrossSiteRequestForgeryException();
+            }
+        }
+
+        /**
+         * Checks if app is enabled (also includes a check whether user is allowed to access the resource)
+         * The getAppPath() check is here since components such as settings also use the AppFramework and
+         * therefore won't pass this check.
+         * If page is public, app does not need to be enabled for current user/visitor
+         */
+        try {
+            $appPath = $this->appManager->getAppPath($this->appName);
+        } catch (AppPathNotFoundException $e) {
+            $appPath = false;
+        }
+
+        if ($appPath !== false && !$isPublicPage && !$this->appManager->isEnabledForUser($this->appName)) {
+            throw new AppNotEnabledException();
+        }
+    }
+
+    /**
+     * If an SecurityException is being caught, ajax requests return a JSON error
+     * response and non ajax requests redirect to the index
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @param \Exception $exception the thrown exception
+     * @throws \Exception the passed in exception if it can't handle it
+     * @return Response a Response object or null in case that the exception could not be handled
+     */
+    public function afterException($controller, $methodName, \Exception $exception): Response {
+        if($exception instanceof SecurityException) {
+            if($exception instanceof StrictCookieMissingException) {
+                return new RedirectResponse(\OC::$WEBROOT);
+            }
+            if (stripos($this->request->getHeader('Accept'),'html') === false) {
+                $response = new JSONResponse(
+                    ['message' => $exception->getMessage()],
+                    $exception->getCode()
+                );
+            } else {
+                if($exception instanceof NotLoggedInException) {
+                    $params = [];
+                    if (isset($this->request->server['REQUEST_URI'])) {
+                        $params['redirect_url'] = $this->request->server['REQUEST_URI'];
+                    }
+                    $url = $this->urlGenerator->linkToRoute('core.login.showLoginForm', $params);
+                    $response = new RedirectResponse($url);
+                } else {
+                    $response = new TemplateResponse('core', '403', ['message' => $exception->getMessage()], 'guest');
+                    $response->setStatus($exception->getCode());
+                }
+            }
+
+            $this->logger->logException($exception, [
+                'level' => ILogger::DEBUG,
+                'app' => 'core',
+            ]);
+            return $response;
+        }
+
+        throw $exception;
+    }
 
 }

Spacing +12 added lines, -12 removed lines

@@ -137,17 +137,17 @@ 
 
 		// security checks
 		$isPublicPage = $this->reflector->hasAnnotation('PublicPage');
-		if(!$isPublicPage) {
-			if(!$this->isLoggedIn) {
+		if (!$isPublicPage) {
+			if (!$this->isLoggedIn) {
 				throw new NotLoggedInException();
 			}
 
-			if($this->reflector->hasAnnotation('SubAdminRequired')
+			if ($this->reflector->hasAnnotation('SubAdminRequired')
 				&& !$this->isSubAdmin
 				&& !$this->isAdminUser) {
 				throw new NotAdminException($this->l10n->t('Logged in user must be an admin or sub admin'));
 			}
-			if(!$this->reflector->hasAnnotation('SubAdminRequired')
+			if (!$this->reflector->hasAnnotation('SubAdminRequired')
 				&& !$this->reflector->hasAnnotation('NoAdminRequired')
 				&& !$this->isAdminUser) {
 				throw new NotAdminException($this->l10n->t('Logged in user must be an admin'));
@@ -155,14 +155,14 @@ 
 		}
 
 		// Check for strict cookie requirement
-		if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
-			if(!$this->request->passesStrictCookieCheck()) {
+		if ($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
+			if (!$this->request->passesStrictCookieCheck()) {
 				throw new StrictCookieMissingException();
 			}
 		}
 		// CSRF check - also registers the CSRF token since the session may be closed later
 		Util::callRegister();
-		if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
+		if (!$this->reflector->hasAnnotation('NoCSRFRequired')) {
 			/*
 			 * Only allow the CSRF check to fail on OCS Requests. This kind of
 			 * hacks around that we have no full token auth in place yet and we
@@ -171,7 +171,7 @@ 
 			 * Additionally we allow Bearer authenticated requests to pass on OCS routes.
 			 * This allows oauth apps (e.g. moodle) to use the OCS endpoints
 			 */
-			if(!$this->request->passesCSRFCheck() && !(
+			if (!$this->request->passesCSRFCheck() && !(
 					$controller instanceof OCSController && (
 						$this->request->getHeader('OCS-APIREQUEST') === 'true' ||
 						strpos($this->request->getHeader('Authorization'), 'Bearer ') === 0
@@ -209,17 +209,17 @@ 
 	 * @return Response a Response object or null in case that the exception could not be handled
 	 */
 	public function afterException($controller, $methodName, \Exception $exception): Response {
-		if($exception instanceof SecurityException) {
-			if($exception instanceof StrictCookieMissingException) {
+		if ($exception instanceof SecurityException) {
+			if ($exception instanceof StrictCookieMissingException) {
 				return new RedirectResponse(\OC::$WEBROOT);
 			}
-			if (stripos($this->request->getHeader('Accept'),'html') === false) {
+			if (stripos($this->request->getHeader('Accept'), 'html') === false) {
 				$response = new JSONResponse(
 					['message' => $exception->getMessage()],
 					$exception->getCode()
 				);
 			} else {
-				if($exception instanceof NotLoggedInException) {
+				if ($exception instanceof NotLoggedInException) {
 					$params = [];
 					if (isset($this->request->server['REQUEST_URI'])) {
 						$params['redirect_url'] = $this->request->server['REQUEST_URI'];

lib/private/AppFramework/Http.php

Indentation +115 added lines, -115 removed lines

@@ -34,121 +34,121 @@
 
 class Http extends BaseHttp {
 
-	private $server;
-	private $protocolVersion;
-	protected $headers;
-
-	/**
-	 * @param array $server $_SERVER
-	 * @param string $protocolVersion the http version to use defaults to HTTP/1.1
-	 */
-	public function __construct($server, $protocolVersion='HTTP/1.1') {
-		$this->server = $server;
-		$this->protocolVersion = $protocolVersion;
-
-		$this->headers = [
-			self::STATUS_CONTINUE => 'Continue',
-			self::STATUS_SWITCHING_PROTOCOLS => 'Switching Protocols',
-			self::STATUS_PROCESSING => 'Processing',
-			self::STATUS_OK => 'OK',
-			self::STATUS_CREATED => 'Created',
-			self::STATUS_ACCEPTED => 'Accepted',
-			self::STATUS_NON_AUTHORATIVE_INFORMATION => 'Non-Authorative Information',
-			self::STATUS_NO_CONTENT => 'No Content',
-			self::STATUS_RESET_CONTENT => 'Reset Content',
-			self::STATUS_PARTIAL_CONTENT => 'Partial Content',
-			self::STATUS_MULTI_STATUS => 'Multi-Status', // RFC 4918
-			self::STATUS_ALREADY_REPORTED => 'Already Reported', // RFC 5842
-			self::STATUS_IM_USED => 'IM Used', // RFC 3229
-			self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices',
-			self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently',
-			self::STATUS_FOUND => 'Found',
-			self::STATUS_SEE_OTHER => 'See Other',
-			self::STATUS_NOT_MODIFIED => 'Not Modified',
-			self::STATUS_USE_PROXY => 'Use Proxy',
-			self::STATUS_RESERVED => 'Reserved',
-			self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect',
-			self::STATUS_BAD_REQUEST => 'Bad request',
-			self::STATUS_UNAUTHORIZED => 'Unauthorized',
-			self::STATUS_PAYMENT_REQUIRED => 'Payment Required',
-			self::STATUS_FORBIDDEN => 'Forbidden',
-			self::STATUS_NOT_FOUND => 'Not Found',
-			self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed',
-			self::STATUS_NOT_ACCEPTABLE => 'Not Acceptable',
-			self::STATUS_PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required',
-			self::STATUS_REQUEST_TIMEOUT => 'Request Timeout',
-			self::STATUS_CONFLICT => 'Conflict',
-			self::STATUS_GONE => 'Gone',
-			self::STATUS_LENGTH_REQUIRED => 'Length Required',
-			self::STATUS_PRECONDITION_FAILED => 'Precondition failed',
-			self::STATUS_REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large',
-			self::STATUS_REQUEST_URI_TOO_LONG => 'Request-URI Too Long',
-			self::STATUS_UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type',
-			self::STATUS_REQUEST_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable',
-			self::STATUS_EXPECTATION_FAILED => 'Expectation Failed',
-			self::STATUS_IM_A_TEAPOT => 'I\'m a teapot', // RFC 2324
-			self::STATUS_UNPROCESSABLE_ENTITY => 'Unprocessable Entity', // RFC 4918
-			self::STATUS_LOCKED => 'Locked', // RFC 4918
-			self::STATUS_FAILED_DEPENDENCY => 'Failed Dependency', // RFC 4918
-			self::STATUS_UPGRADE_REQUIRED => 'Upgrade required',
-			self::STATUS_PRECONDITION_REQUIRED => 'Precondition required', // draft-nottingham-http-new-status
-			self::STATUS_TOO_MANY_REQUESTS => 'Too Many Requests', // draft-nottingham-http-new-status
-			self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE => 'Request Header Fields Too Large', // draft-nottingham-http-new-status
-			self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error',
-			self::STATUS_NOT_IMPLEMENTED => 'Not Implemented',
-			self::STATUS_BAD_GATEWAY => 'Bad Gateway',
-			self::STATUS_SERVICE_UNAVAILABLE => 'Service Unavailable',
-			self::STATUS_GATEWAY_TIMEOUT => 'Gateway Timeout',
-			self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version not supported',
-			self::STATUS_VARIANT_ALSO_NEGOTIATES => 'Variant Also Negotiates',
-			self::STATUS_INSUFFICIENT_STORAGE => 'Insufficient Storage', // RFC 4918
-			self::STATUS_LOOP_DETECTED => 'Loop Detected', // RFC 5842
-			self::STATUS_BANDWIDTH_LIMIT_EXCEEDED => 'Bandwidth Limit Exceeded', // non-standard
-			self::STATUS_NOT_EXTENDED => 'Not extended',
-			self::STATUS_NETWORK_AUTHENTICATION_REQUIRED => 'Network Authentication Required', // draft-nottingham-http-new-status
-		];
-	}
-
-
-	/**
-	 * Gets the correct header
-	 * @param int Http::CONSTANT $status the constant from the Http class
-	 * @param \DateTime $lastModified formatted last modified date
-	 * @param string $ETag the etag
-	 * @return string
-	 */
-	public function getStatusHeader($status, \DateTime $lastModified=null, 
-									$ETag=null) {
-
-		if(!is_null($lastModified)) {
-			$lastModified = $lastModified->format(\DateTime::RFC2822);
-		}
-
-		// if etag or lastmodified have not changed, return a not modified
-		if ((isset($this->server['HTTP_IF_NONE_MATCH'])
-			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
-
-			||
-
-			(isset($this->server['HTTP_IF_MODIFIED_SINCE'])
-			&& trim($this->server['HTTP_IF_MODIFIED_SINCE']) === 
-				$lastModified)) {
-
-			$status = self::STATUS_NOT_MODIFIED;
-		}
-
-		// we have one change currently for the http 1.0 header that differs
-		// from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
-		// if this differs any more, we want to create childclasses for this
-		if($status === self::STATUS_TEMPORARY_REDIRECT 
-			&& $this->protocolVersion === 'HTTP/1.0') {
-
-			$status = self::STATUS_FOUND;
-		}
-
-		return $this->protocolVersion . ' ' . $status . ' ' . 
-			$this->headers[$status];
-	}
+    private $server;
+    private $protocolVersion;
+    protected $headers;
+
+    /**
+     * @param array $server $_SERVER
+     * @param string $protocolVersion the http version to use defaults to HTTP/1.1
+     */
+    public function __construct($server, $protocolVersion='HTTP/1.1') {
+        $this->server = $server;
+        $this->protocolVersion = $protocolVersion;
+
+        $this->headers = [
+            self::STATUS_CONTINUE => 'Continue',
+            self::STATUS_SWITCHING_PROTOCOLS => 'Switching Protocols',
+            self::STATUS_PROCESSING => 'Processing',
+            self::STATUS_OK => 'OK',
+            self::STATUS_CREATED => 'Created',
+            self::STATUS_ACCEPTED => 'Accepted',
+            self::STATUS_NON_AUTHORATIVE_INFORMATION => 'Non-Authorative Information',
+            self::STATUS_NO_CONTENT => 'No Content',
+            self::STATUS_RESET_CONTENT => 'Reset Content',
+            self::STATUS_PARTIAL_CONTENT => 'Partial Content',
+            self::STATUS_MULTI_STATUS => 'Multi-Status', // RFC 4918
+            self::STATUS_ALREADY_REPORTED => 'Already Reported', // RFC 5842
+            self::STATUS_IM_USED => 'IM Used', // RFC 3229
+            self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices',
+            self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently',
+            self::STATUS_FOUND => 'Found',
+            self::STATUS_SEE_OTHER => 'See Other',
+            self::STATUS_NOT_MODIFIED => 'Not Modified',
+            self::STATUS_USE_PROXY => 'Use Proxy',
+            self::STATUS_RESERVED => 'Reserved',
+            self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect',
+            self::STATUS_BAD_REQUEST => 'Bad request',
+            self::STATUS_UNAUTHORIZED => 'Unauthorized',
+            self::STATUS_PAYMENT_REQUIRED => 'Payment Required',
+            self::STATUS_FORBIDDEN => 'Forbidden',
+            self::STATUS_NOT_FOUND => 'Not Found',
+            self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed',
+            self::STATUS_NOT_ACCEPTABLE => 'Not Acceptable',
+            self::STATUS_PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required',
+            self::STATUS_REQUEST_TIMEOUT => 'Request Timeout',
+            self::STATUS_CONFLICT => 'Conflict',
+            self::STATUS_GONE => 'Gone',
+            self::STATUS_LENGTH_REQUIRED => 'Length Required',
+            self::STATUS_PRECONDITION_FAILED => 'Precondition failed',
+            self::STATUS_REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large',
+            self::STATUS_REQUEST_URI_TOO_LONG => 'Request-URI Too Long',
+            self::STATUS_UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type',
+            self::STATUS_REQUEST_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable',
+            self::STATUS_EXPECTATION_FAILED => 'Expectation Failed',
+            self::STATUS_IM_A_TEAPOT => 'I\'m a teapot', // RFC 2324
+            self::STATUS_UNPROCESSABLE_ENTITY => 'Unprocessable Entity', // RFC 4918
+            self::STATUS_LOCKED => 'Locked', // RFC 4918
+            self::STATUS_FAILED_DEPENDENCY => 'Failed Dependency', // RFC 4918
+            self::STATUS_UPGRADE_REQUIRED => 'Upgrade required',
+            self::STATUS_PRECONDITION_REQUIRED => 'Precondition required', // draft-nottingham-http-new-status
+            self::STATUS_TOO_MANY_REQUESTS => 'Too Many Requests', // draft-nottingham-http-new-status
+            self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE => 'Request Header Fields Too Large', // draft-nottingham-http-new-status
+            self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error',
+            self::STATUS_NOT_IMPLEMENTED => 'Not Implemented',
+            self::STATUS_BAD_GATEWAY => 'Bad Gateway',
+            self::STATUS_SERVICE_UNAVAILABLE => 'Service Unavailable',
+            self::STATUS_GATEWAY_TIMEOUT => 'Gateway Timeout',
+            self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version not supported',
+            self::STATUS_VARIANT_ALSO_NEGOTIATES => 'Variant Also Negotiates',
+            self::STATUS_INSUFFICIENT_STORAGE => 'Insufficient Storage', // RFC 4918
+            self::STATUS_LOOP_DETECTED => 'Loop Detected', // RFC 5842
+            self::STATUS_BANDWIDTH_LIMIT_EXCEEDED => 'Bandwidth Limit Exceeded', // non-standard
+            self::STATUS_NOT_EXTENDED => 'Not extended',
+            self::STATUS_NETWORK_AUTHENTICATION_REQUIRED => 'Network Authentication Required', // draft-nottingham-http-new-status
+        ];
+    }
+
+
+    /**
+     * Gets the correct header
+     * @param int Http::CONSTANT $status the constant from the Http class
+     * @param \DateTime $lastModified formatted last modified date
+     * @param string $ETag the etag
+     * @return string
+     */
+    public function getStatusHeader($status, \DateTime $lastModified=null, 
+                                    $ETag=null) {
+
+        if(!is_null($lastModified)) {
+            $lastModified = $lastModified->format(\DateTime::RFC2822);
+        }
+
+        // if etag or lastmodified have not changed, return a not modified
+        if ((isset($this->server['HTTP_IF_NONE_MATCH'])
+            && trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
+
+            ||
+
+            (isset($this->server['HTTP_IF_MODIFIED_SINCE'])
+            && trim($this->server['HTTP_IF_MODIFIED_SINCE']) === 
+                $lastModified)) {
+
+            $status = self::STATUS_NOT_MODIFIED;
+        }
+
+        // we have one change currently for the http 1.0 header that differs
+        // from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
+        // if this differs any more, we want to create childclasses for this
+        if($status === self::STATUS_TEMPORARY_REDIRECT 
+            && $this->protocolVersion === 'HTTP/1.0') {
+
+            $status = self::STATUS_FOUND;
+        }
+
+        return $this->protocolVersion . ' ' . $status . ' ' . 
+            $this->headers[$status];
+    }
 
 
 }

Spacing +7 added lines, -7 removed lines

@@ -42,7 +42,7 @@ 
 	 * @param array $server $_SERVER
 	 * @param string $protocolVersion the http version to use defaults to HTTP/1.1
 	 */
-	public function __construct($server, $protocolVersion='HTTP/1.1') {
+	public function __construct($server, $protocolVersion = 'HTTP/1.1') {
 		$this->server = $server;
 		$this->protocolVersion = $protocolVersion;
 
@@ -117,16 +117,16 @@ 
 	 * @param string $ETag the etag
 	 * @return string
 	 */
-	public function getStatusHeader($status, \DateTime $lastModified=null, 
-									$ETag=null) {
+	public function getStatusHeader($status, \DateTime $lastModified = null, 
+									$ETag = null) {
 
-		if(!is_null($lastModified)) {
+		if (!is_null($lastModified)) {
 			$lastModified = $lastModified->format(\DateTime::RFC2822);
 		}
 
 		// if etag or lastmodified have not changed, return a not modified
 		if ((isset($this->server['HTTP_IF_NONE_MATCH'])
-			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
+			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string) $ETag)
 
 			||
 
@@ -140,13 +140,13 @@ 
 		// we have one change currently for the http 1.0 header that differs
 		// from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
 		// if this differs any more, we want to create childclasses for this
-		if($status === self::STATUS_TEMPORARY_REDIRECT 
+		if ($status === self::STATUS_TEMPORARY_REDIRECT 
 			&& $this->protocolVersion === 'HTTP/1.0') {
 
 			$status = self::STATUS_FOUND;
 		}
 
-		return $this->protocolVersion . ' ' . $status . ' ' . 
+		return $this->protocolVersion.' '.$status.' '. 
 			$this->headers[$status];
 	}
 

lib/private/legacy/OC_Defaults.php

Indentation +265 added lines, -265 removed lines

@@ -37,298 +37,298 @@
  */
 class OC_Defaults {
 
-	private $theme;
+    private $theme;
 
-	private $defaultEntity;
-	private $defaultName;
-	private $defaultTitle;
-	private $defaultBaseUrl;
-	private $defaultSyncClientUrl;
-	private $defaultiOSClientUrl;
-	private $defaultiTunesAppId;
-	private $defaultAndroidClientUrl;
-	private $defaultDocBaseUrl;
-	private $defaultDocVersion;
-	private $defaultSlogan;
-	private $defaultColorPrimary;
-	private $defaultTextColorPrimary;
+    private $defaultEntity;
+    private $defaultName;
+    private $defaultTitle;
+    private $defaultBaseUrl;
+    private $defaultSyncClientUrl;
+    private $defaultiOSClientUrl;
+    private $defaultiTunesAppId;
+    private $defaultAndroidClientUrl;
+    private $defaultDocBaseUrl;
+    private $defaultDocVersion;
+    private $defaultSlogan;
+    private $defaultColorPrimary;
+    private $defaultTextColorPrimary;
 
-	public function __construct() {
-		$config = \OC::$server->getConfig();
+    public function __construct() {
+        $config = \OC::$server->getConfig();
 
-		$this->defaultEntity = 'Nextcloud'; /* e.g. company name, used for footers and copyright notices */
-		$this->defaultName = 'Nextcloud'; /* short name, used when referring to the software */
-		$this->defaultTitle = 'Nextcloud'; /* can be a longer name, for titles */
-		$this->defaultBaseUrl = 'https://nextcloud.com';
-		$this->defaultSyncClientUrl = $config->getSystemValue('customclient_desktop', 'https://nextcloud.com/install/#install-clients');
-		$this->defaultiOSClientUrl = $config->getSystemValue('customclient_ios', 'https://geo.itunes.apple.com/us/app/nextcloud/id1125420102?mt=8');
-		$this->defaultiTunesAppId = $config->getSystemValue('customclient_ios_appid', '1125420102');
-		$this->defaultAndroidClientUrl = $config->getSystemValue('customclient_android', 'https://play.google.com/store/apps/details?id=com.nextcloud.client');
-		$this->defaultDocBaseUrl = 'https://docs.nextcloud.com';
-		$this->defaultDocVersion = \OC_Util::getVersion()[0]; // used to generate doc links
-		$this->defaultColorPrimary = '#0082c9';
-		$this->defaultTextColorPrimary = '#ffffff';
+        $this->defaultEntity = 'Nextcloud'; /* e.g. company name, used for footers and copyright notices */
+        $this->defaultName = 'Nextcloud'; /* short name, used when referring to the software */
+        $this->defaultTitle = 'Nextcloud'; /* can be a longer name, for titles */
+        $this->defaultBaseUrl = 'https://nextcloud.com';
+        $this->defaultSyncClientUrl = $config->getSystemValue('customclient_desktop', 'https://nextcloud.com/install/#install-clients');
+        $this->defaultiOSClientUrl = $config->getSystemValue('customclient_ios', 'https://geo.itunes.apple.com/us/app/nextcloud/id1125420102?mt=8');
+        $this->defaultiTunesAppId = $config->getSystemValue('customclient_ios_appid', '1125420102');
+        $this->defaultAndroidClientUrl = $config->getSystemValue('customclient_android', 'https://play.google.com/store/apps/details?id=com.nextcloud.client');
+        $this->defaultDocBaseUrl = 'https://docs.nextcloud.com';
+        $this->defaultDocVersion = \OC_Util::getVersion()[0]; // used to generate doc links
+        $this->defaultColorPrimary = '#0082c9';
+        $this->defaultTextColorPrimary = '#ffffff';
 
-		$themePath = OC::$SERVERROOT . '/themes/' . OC_Util::getTheme() . '/defaults.php';
-		if (file_exists($themePath)) {
-			// prevent defaults.php from printing output
-			ob_start();
-			require_once $themePath;
-			ob_end_clean();
-			if (class_exists('OC_Theme')) {
-				$this->theme = new OC_Theme();
-			}
-		}
-	}
+        $themePath = OC::$SERVERROOT . '/themes/' . OC_Util::getTheme() . '/defaults.php';
+        if (file_exists($themePath)) {
+            // prevent defaults.php from printing output
+            ob_start();
+            require_once $themePath;
+            ob_end_clean();
+            if (class_exists('OC_Theme')) {
+                $this->theme = new OC_Theme();
+            }
+        }
+    }
 
-	/**
-	 * @param string $method
-	 */
-	private function themeExist($method) {
-		if (isset($this->theme) && method_exists($this->theme, $method)) {
-			return true;
-		}
-		return false;
-	}
+    /**
+     * @param string $method
+     */
+    private function themeExist($method) {
+        if (isset($this->theme) && method_exists($this->theme, $method)) {
+            return true;
+        }
+        return false;
+    }
 
-	/**
-	 * Returns the base URL
-	 * @return string URL
-	 */
-	public function getBaseUrl() {
-		if ($this->themeExist('getBaseUrl')) {
-			return $this->theme->getBaseUrl();
-		} else {
-			return $this->defaultBaseUrl;
-		}
-	}
+    /**
+     * Returns the base URL
+     * @return string URL
+     */
+    public function getBaseUrl() {
+        if ($this->themeExist('getBaseUrl')) {
+            return $this->theme->getBaseUrl();
+        } else {
+            return $this->defaultBaseUrl;
+        }
+    }
 
-	/**
-	 * Returns the URL where the sync clients are listed
-	 * @return string URL
-	 */
-	public function getSyncClientUrl() {
-		if ($this->themeExist('getSyncClientUrl')) {
-			return $this->theme->getSyncClientUrl();
-		} else {
-			return $this->defaultSyncClientUrl;
-		}
-	}
+    /**
+     * Returns the URL where the sync clients are listed
+     * @return string URL
+     */
+    public function getSyncClientUrl() {
+        if ($this->themeExist('getSyncClientUrl')) {
+            return $this->theme->getSyncClientUrl();
+        } else {
+            return $this->defaultSyncClientUrl;
+        }
+    }
 
-	/**
-	 * Returns the URL to the App Store for the iOS Client
-	 * @return string URL
-	 */
-	public function getiOSClientUrl() {
-		if ($this->themeExist('getiOSClientUrl')) {
-			return $this->theme->getiOSClientUrl();
-		} else {
-			return $this->defaultiOSClientUrl;
-		}
-	}
+    /**
+     * Returns the URL to the App Store for the iOS Client
+     * @return string URL
+     */
+    public function getiOSClientUrl() {
+        if ($this->themeExist('getiOSClientUrl')) {
+            return $this->theme->getiOSClientUrl();
+        } else {
+            return $this->defaultiOSClientUrl;
+        }
+    }
 
-	/**
-	 * Returns the AppId for the App Store for the iOS Client
-	 * @return string AppId
-	 */
-	public function getiTunesAppId() {
-		if ($this->themeExist('getiTunesAppId')) {
-			return $this->theme->getiTunesAppId();
-		} else {
-			return $this->defaultiTunesAppId;
-		}
-	}
+    /**
+     * Returns the AppId for the App Store for the iOS Client
+     * @return string AppId
+     */
+    public function getiTunesAppId() {
+        if ($this->themeExist('getiTunesAppId')) {
+            return $this->theme->getiTunesAppId();
+        } else {
+            return $this->defaultiTunesAppId;
+        }
+    }
 
-	/**
-	 * Returns the URL to Google Play for the Android Client
-	 * @return string URL
-	 */
-	public function getAndroidClientUrl() {
-		if ($this->themeExist('getAndroidClientUrl')) {
-			return $this->theme->getAndroidClientUrl();
-		} else {
-			return $this->defaultAndroidClientUrl;
-		}
-	}
+    /**
+     * Returns the URL to Google Play for the Android Client
+     * @return string URL
+     */
+    public function getAndroidClientUrl() {
+        if ($this->themeExist('getAndroidClientUrl')) {
+            return $this->theme->getAndroidClientUrl();
+        } else {
+            return $this->defaultAndroidClientUrl;
+        }
+    }
 
-	/**
-	 * Returns the documentation URL
-	 * @return string URL
-	 */
-	public function getDocBaseUrl() {
-		if ($this->themeExist('getDocBaseUrl')) {
-			return $this->theme->getDocBaseUrl();
-		} else {
-			return $this->defaultDocBaseUrl;
-		}
-	}
+    /**
+     * Returns the documentation URL
+     * @return string URL
+     */
+    public function getDocBaseUrl() {
+        if ($this->themeExist('getDocBaseUrl')) {
+            return $this->theme->getDocBaseUrl();
+        } else {
+            return $this->defaultDocBaseUrl;
+        }
+    }
 
-	/**
-	 * Returns the title
-	 * @return string title
-	 */
-	public function getTitle() {
-		if ($this->themeExist('getTitle')) {
-			return $this->theme->getTitle();
-		} else {
-			return $this->defaultTitle;
-		}
-	}
+    /**
+     * Returns the title
+     * @return string title
+     */
+    public function getTitle() {
+        if ($this->themeExist('getTitle')) {
+            return $this->theme->getTitle();
+        } else {
+            return $this->defaultTitle;
+        }
+    }
 
-	/**
-	 * Returns the short name of the software
-	 * @return string title
-	 */
-	public function getName() {
-		if ($this->themeExist('getName')) {
-			return $this->theme->getName();
-		} else {
-			return $this->defaultName;
-		}
-	}
+    /**
+     * Returns the short name of the software
+     * @return string title
+     */
+    public function getName() {
+        if ($this->themeExist('getName')) {
+            return $this->theme->getName();
+        } else {
+            return $this->defaultName;
+        }
+    }
 
-	/**
-	 * Returns the short name of the software containing HTML strings
-	 * @return string title
-	 */
-	public function getHTMLName() {
-		if ($this->themeExist('getHTMLName')) {
-			return $this->theme->getHTMLName();
-		} else {
-			return $this->defaultName;
-		}
-	}
+    /**
+     * Returns the short name of the software containing HTML strings
+     * @return string title
+     */
+    public function getHTMLName() {
+        if ($this->themeExist('getHTMLName')) {
+            return $this->theme->getHTMLName();
+        } else {
+            return $this->defaultName;
+        }
+    }
 
-	/**
-	 * Returns entity (e.g. company name) - used for footer, copyright
-	 * @return string entity name
-	 */
-	public function getEntity() {
-		if ($this->themeExist('getEntity')) {
-			return $this->theme->getEntity();
-		} else {
-			return $this->defaultEntity;
-		}
-	}
+    /**
+     * Returns entity (e.g. company name) - used for footer, copyright
+     * @return string entity name
+     */
+    public function getEntity() {
+        if ($this->themeExist('getEntity')) {
+            return $this->theme->getEntity();
+        } else {
+            return $this->defaultEntity;
+        }
+    }
 
-	/**
-	 * Returns slogan
-	 * @return string slogan
-	 */
-	public function getSlogan() {
-		if ($this->themeExist('getSlogan')) {
-			return $this->theme->getSlogan();
-		} else {
-			if ($this->defaultSlogan === null) {
-				$l10n = \OC::$server->getL10N('lib');
-				$this->defaultSlogan = $l10n->t('a safe home for all your data');
-			}
-			return $this->defaultSlogan;
-		}
-	}
+    /**
+     * Returns slogan
+     * @return string slogan
+     */
+    public function getSlogan() {
+        if ($this->themeExist('getSlogan')) {
+            return $this->theme->getSlogan();
+        } else {
+            if ($this->defaultSlogan === null) {
+                $l10n = \OC::$server->getL10N('lib');
+                $this->defaultSlogan = $l10n->t('a safe home for all your data');
+            }
+            return $this->defaultSlogan;
+        }
+    }
 
-	/**
-	 * Returns logo claim
-	 * @return string logo claim
-	 * @deprecated 13.0.0
-	 */
-	public function getLogoClaim() {
-		return '';
-	}
+    /**
+     * Returns logo claim
+     * @return string logo claim
+     * @deprecated 13.0.0
+     */
+    public function getLogoClaim() {
+        return '';
+    }
 
-	/**
-	 * Returns short version of the footer
-	 * @return string short footer
-	 */
-	public function getShortFooter() {
-		if ($this->themeExist('getShortFooter')) {
-			$footer = $this->theme->getShortFooter();
-		} else {
-			$footer = '<a href="'. $this->getBaseUrl() . '" target="_blank"' .
-				' rel="noreferrer noopener">' .$this->getEntity() . '</a>'.
-				' – ' . $this->getSlogan();
-		}
+    /**
+     * Returns short version of the footer
+     * @return string short footer
+     */
+    public function getShortFooter() {
+        if ($this->themeExist('getShortFooter')) {
+            $footer = $this->theme->getShortFooter();
+        } else {
+            $footer = '<a href="'. $this->getBaseUrl() . '" target="_blank"' .
+                ' rel="noreferrer noopener">' .$this->getEntity() . '</a>'.
+                ' – ' . $this->getSlogan();
+        }
 
-		return $footer;
-	}
+        return $footer;
+    }
 
-	/**
-	 * Returns long version of the footer
-	 * @return string long footer
-	 */
-	public function getLongFooter() {
-		if ($this->themeExist('getLongFooter')) {
-			$footer = $this->theme->getLongFooter();
-		} else {
-			$footer = $this->getShortFooter();
-		}
+    /**
+     * Returns long version of the footer
+     * @return string long footer
+     */
+    public function getLongFooter() {
+        if ($this->themeExist('getLongFooter')) {
+            $footer = $this->theme->getLongFooter();
+        } else {
+            $footer = $this->getShortFooter();
+        }
 
-		return $footer;
-	}
+        return $footer;
+    }
 
-	/**
-	 * @param string $key
-	 * @return string URL to doc with key
-	 */
-	public function buildDocLinkToKey($key) {
-		if ($this->themeExist('buildDocLinkToKey')) {
-			return $this->theme->buildDocLinkToKey($key);
-		}
-		return $this->getDocBaseUrl() . '/server/' . $this->defaultDocVersion . '/go.php?to=' . $key;
-	}
+    /**
+     * @param string $key
+     * @return string URL to doc with key
+     */
+    public function buildDocLinkToKey($key) {
+        if ($this->themeExist('buildDocLinkToKey')) {
+            return $this->theme->buildDocLinkToKey($key);
+        }
+        return $this->getDocBaseUrl() . '/server/' . $this->defaultDocVersion . '/go.php?to=' . $key;
+    }
 
-	/**
-	 * Returns primary color
-	 * @return string
-	 */
-	public function getColorPrimary() {
+    /**
+     * Returns primary color
+     * @return string
+     */
+    public function getColorPrimary() {
 
-		if ($this->themeExist('getColorPrimary')) {
-			return $this->theme->getColorPrimary();
-		}
-		if ($this->themeExist('getMailHeaderColor')) {
-			return $this->theme->getMailHeaderColor();
-		}
-		return $this->defaultColorPrimary;
-	}
+        if ($this->themeExist('getColorPrimary')) {
+            return $this->theme->getColorPrimary();
+        }
+        if ($this->themeExist('getMailHeaderColor')) {
+            return $this->theme->getMailHeaderColor();
+        }
+        return $this->defaultColorPrimary;
+    }
 
-	/**
-	 * @return array scss variables to overwrite
-	 */
-	public function getScssVariables() {
-		if($this->themeExist('getScssVariables')) {
-			return $this->theme->getScssVariables();
-		}
-		return [];
-	}
+    /**
+     * @return array scss variables to overwrite
+     */
+    public function getScssVariables() {
+        if($this->themeExist('getScssVariables')) {
+            return $this->theme->getScssVariables();
+        }
+        return [];
+    }
 
-	public function shouldReplaceIcons() {
-		return false;
-	}
+    public function shouldReplaceIcons() {
+        return false;
+    }
 
-	/**
-	 * Themed logo url
-	 *
-	 * @param bool $useSvg Whether to point to the SVG image or a fallback
-	 * @return string
-	 */
-	public function getLogo($useSvg = true) {
-		if ($this->themeExist('getLogo')) {
-			return $this->theme->getLogo($useSvg);
-		}
+    /**
+     * Themed logo url
+     *
+     * @param bool $useSvg Whether to point to the SVG image or a fallback
+     * @return string
+     */
+    public function getLogo($useSvg = true) {
+        if ($this->themeExist('getLogo')) {
+            return $this->theme->getLogo($useSvg);
+        }
 
-		if($useSvg) {
-			$logo = \OC::$server->getURLGenerator()->imagePath('core', 'logo/logo.svg');
-		} else {
-			$logo = \OC::$server->getURLGenerator()->imagePath('core', 'logo/logo.png');
-		}
-		return $logo . '?v=' . hash('sha1', implode('.', \OCP\Util::getVersion()));
-	}
+        if($useSvg) {
+            $logo = \OC::$server->getURLGenerator()->imagePath('core', 'logo/logo.svg');
+        } else {
+            $logo = \OC::$server->getURLGenerator()->imagePath('core', 'logo/logo.png');
+        }
+        return $logo . '?v=' . hash('sha1', implode('.', \OCP\Util::getVersion()));
+    }
 
-	public function getTextColorPrimary() {
-		if ($this->themeExist('getTextColorPrimary')) {
-			return $this->theme->getTextColorPrimary();
-		}
-		return $this->defaultTextColorPrimary;
-	}
+    public function getTextColorPrimary() {
+        if ($this->themeExist('getTextColorPrimary')) {
+            return $this->theme->getTextColorPrimary();
+        }
+        return $this->defaultTextColorPrimary;
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -69,7 +69,7 @@ 
 		$this->defaultColorPrimary = '#0082c9';
 		$this->defaultTextColorPrimary = '#ffffff';
 
-		$themePath = OC::$SERVERROOT . '/themes/' . OC_Util::getTheme() . '/defaults.php';
+		$themePath = OC::$SERVERROOT.'/themes/'.OC_Util::getTheme().'/defaults.php';
 		if (file_exists($themePath)) {
 			// prevent defaults.php from printing output
 			ob_start();
@@ -244,9 +244,9 @@ 
 		if ($this->themeExist('getShortFooter')) {
 			$footer = $this->theme->getShortFooter();
 		} else {
-			$footer = '<a href="'. $this->getBaseUrl() . '" target="_blank"' .
-				' rel="noreferrer noopener">' .$this->getEntity() . '</a>'.
-				' – ' . $this->getSlogan();
+			$footer = '<a href="'.$this->getBaseUrl().'" target="_blank"'.
+				' rel="noreferrer noopener">'.$this->getEntity().'</a>'.
+				' – '.$this->getSlogan();
 		}
 
 		return $footer;
@@ -274,7 +274,7 @@ 
 		if ($this->themeExist('buildDocLinkToKey')) {
 			return $this->theme->buildDocLinkToKey($key);
 		}
-		return $this->getDocBaseUrl() . '/server/' . $this->defaultDocVersion . '/go.php?to=' . $key;
+		return $this->getDocBaseUrl().'/server/'.$this->defaultDocVersion.'/go.php?to='.$key;
 	}
 
 	/**
@@ -296,7 +296,7 @@ 
 	 * @return array scss variables to overwrite
 	 */
 	public function getScssVariables() {
-		if($this->themeExist('getScssVariables')) {
+		if ($this->themeExist('getScssVariables')) {
 			return $this->theme->getScssVariables();
 		}
 		return [];
@@ -317,12 +317,12 @@ 
 			return $this->theme->getLogo($useSvg);
 		}
 
-		if($useSvg) {
+		if ($useSvg) {
 			$logo = \OC::$server->getURLGenerator()->imagePath('core', 'logo/logo.svg');
 		} else {
 			$logo = \OC::$server->getURLGenerator()->imagePath('core', 'logo/logo.png');
 		}
-		return $logo . '?v=' . hash('sha1', implode('.', \OCP\Util::getVersion()));
+		return $logo.'?v='.hash('sha1', implode('.', \OCP\Util::getVersion()));
 	}
 
 	public function getTextColorPrimary() {

lib/private/legacy/OC_Files.php

Indentation +380 added lines, -380 removed lines

@@ -50,385 +50,385 @@
  *
  */
 class OC_Files {
-	const FILE = 1;
-	const ZIP_FILES = 2;
-	const ZIP_DIR = 3;
-
-	const UPLOAD_MIN_LIMIT_BYTES = 1048576; // 1 MiB
-
-
-	private static $multipartBoundary = '';
-
-	/**
-	 * @return string
-	 */
-	private static function getBoundary() {
-		if (empty(self::$multipartBoundary)) {
-			self::$multipartBoundary = md5(mt_rand());
-		}
-		return self::$multipartBoundary;
-	}
-
-	/**
-	 * @param string $filename
-	 * @param string $name
-	 * @param array $rangeArray ('from'=>int,'to'=>int), ...
-	 */
-	private static function sendHeaders($filename, $name, array $rangeArray) {
-		OC_Response::setContentDispositionHeader($name, 'attachment');
-		header('Content-Transfer-Encoding: binary', true);
-		header('Pragma: public');// enable caching in IE
-		header('Expires: 0');
-		header("Cache-Control: must-revalidate, post-check=0, pre-check=0");
-		$fileSize = \OC\Files\Filesystem::filesize($filename);
-		$type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
-		if ($fileSize > -1) {
-			if (!empty($rangeArray)) {
-				http_response_code(206);
-				header('Accept-Ranges: bytes', true);
-				if (count($rangeArray) > 1) {
-				$type = 'multipart/byteranges; boundary='.self::getBoundary();
-				// no Content-Length header here
-				}
-				else {
-				header(sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true);
-				OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1);
-				}
-			}
-			else {
-				OC_Response::setContentLengthHeader($fileSize);
-			}
-		}
-		header('Content-Type: '.$type, true);
-	}
-
-	/**
-	 * return the content of a file or return a zip file containing multiple files
-	 *
-	 * @param string $dir
-	 * @param string $files ; separated list of files to download
-	 * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
-	 */
-	public static function get($dir, $files, $params = null) {
-
-		$view = \OC\Files\Filesystem::getView();
-		$getType = self::FILE;
-		$filename = $dir;
-		try {
-
-			if (is_array($files) && count($files) === 1) {
-				$files = $files[0];
-			}
-
-			if (!is_array($files)) {
-				$filename = $dir . '/' . $files;
-				if (!$view->is_dir($filename)) {
-					self::getSingleFile($view, $dir, $files, is_null($params) ? [] : $params);
-					return;
-				}
-			}
-
-			$name = 'download';
-			if (is_array($files)) {
-				$getType = self::ZIP_FILES;
-				$basename = basename($dir);
-				if ($basename) {
-					$name = $basename;
-				}
-
-				$filename = $dir . '/' . $name;
-			} else {
-				$filename = $dir . '/' . $files;
-				$getType = self::ZIP_DIR;
-				// downloading root ?
-				if ($files !== '') {
-					$name = $files;
-				}
-			}
-
-			self::lockFiles($view, $dir, $files);
-
-			/* Calculate filesize and number of files */
-			if ($getType === self::ZIP_FILES) {
-				$fileInfos = [];
-				$fileSize = 0;
-				foreach ($files as $file) {
-					$fileInfo = \OC\Files\Filesystem::getFileInfo($dir . '/' . $file);
-					$fileSize += $fileInfo->getSize();
-					$fileInfos[] = $fileInfo;
-				}
-				$numberOfFiles = self::getNumberOfFiles($fileInfos);
-			} elseif ($getType === self::ZIP_DIR) {
-				$fileInfo = \OC\Files\Filesystem::getFileInfo($dir . '/' . $files);
-				$fileSize = $fileInfo->getSize();
-				$numberOfFiles = self::getNumberOfFiles([$fileInfo]);
-			}
-
-			$streamer = new Streamer(\OC::$server->getRequest(), $fileSize, $numberOfFiles);
-			OC_Util::obEnd();
-
-			$streamer->sendHeaders($name);
-			$executionTime = (int)OC::$server->getIniWrapper()->getNumeric('max_execution_time');
-			if (strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
-				@set_time_limit(0);
-			}
-			ignore_user_abort(true);
-
-			if ($getType === self::ZIP_FILES) {
-				foreach ($files as $file) {
-					$file = $dir . '/' . $file;
-					if (\OC\Files\Filesystem::is_file($file)) {
-						$userFolder = \OC::$server->getRootFolder()->get(\OC\Files\Filesystem::getRoot());
-						$file = $userFolder->get($file);
-						if($file instanceof \OC\Files\Node\File) {
-							try {
-								$fh = $file->fopen('r');
-							} catch (\OCP\Files\NotPermittedException $e) {
-								continue;
-							}
-							$fileSize = $file->getSize();
-							$fileTime = $file->getMTime();
-						} else {
-							// File is not a file? …
-							\OC::$server->getLogger()->debug(
-								'File given, but no Node available. Name {file}',
-								[ 'app' => 'files', 'file' => $file ]
-							);
-							continue;
-						}
-						$streamer->addFileFromStream($fh, $file->getName(), $fileSize, $fileTime);
-						fclose($fh);
-					} elseif (\OC\Files\Filesystem::is_dir($file)) {
-						$streamer->addDirRecursive($file);
-					}
-				}
-			} elseif ($getType === self::ZIP_DIR) {
-				$file = $dir . '/' . $files;
-				$streamer->addDirRecursive($file);
-			}
-			$streamer->finalize();
-			set_time_limit($executionTime);
-			self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
-		} catch (\OCP\Lock\LockedException $ex) {
-			self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
-			OC::$server->getLogger()->logException($ex);
-			$l = \OC::$server->getL10N('core');
-			$hint = method_exists($ex, 'getHint') ? $ex->getHint() : '';
-			\OC_Template::printErrorPage($l->t('File is currently busy, please try again later'), $hint, 200);
-		} catch (\OCP\Files\ForbiddenException $ex) {
-			self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
-			OC::$server->getLogger()->logException($ex);
-			$l = \OC::$server->getL10N('core');
-			\OC_Template::printErrorPage($l->t('Can\'t read file'), $ex->getMessage(), 200);
-		} catch (\Exception $ex) {
-			self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
-			OC::$server->getLogger()->logException($ex);
-			$l = \OC::$server->getL10N('core');
-			$hint = method_exists($ex, 'getHint') ? $ex->getHint() : '';
-			\OC_Template::printErrorPage($l->t('Can\'t read file'), $hint, 200);
-		}
-	}
-
-	/**
-	 * @param string $rangeHeaderPos
-	 * @param int $fileSize
-	 * @return array $rangeArray ('from'=>int,'to'=>int), ...
-	 */
-	private static function parseHttpRangeHeader($rangeHeaderPos, $fileSize) {
-		$rArray=explode(',', $rangeHeaderPos);
-		$minOffset = 0;
-		$ind = 0;
-
-		$rangeArray = [];
-
-		foreach ($rArray as $value) {
-			$ranges = explode('-', $value);
-			if (is_numeric($ranges[0])) {
-				if ($ranges[0] < $minOffset) { // case: bytes=500-700,601-999
-					$ranges[0] = $minOffset;
-				}
-				if ($ind > 0 && $rangeArray[$ind-1]['to']+1 == $ranges[0]) { // case: bytes=500-600,601-999
-					$ind--;
-					$ranges[0] = $rangeArray[$ind]['from'];
-				}
-			}
-
-			if (is_numeric($ranges[0]) && is_numeric($ranges[1]) && $ranges[0] < $fileSize && $ranges[0] <= $ranges[1]) {
-				// case: x-x
-				if ($ranges[1] >= $fileSize) {
-					$ranges[1] = $fileSize-1;
-				}
-				$rangeArray[$ind++] = [ 'from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize ];
-				$minOffset = $ranges[1] + 1;
-				if ($minOffset >= $fileSize) {
-					break;
-				}
-			}
-			elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) {
-				// case: x-
-				$rangeArray[$ind++] = [ 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize ];
-				break;
-			}
-			elseif (is_numeric($ranges[1])) {
-				// case: -x
-				if ($ranges[1] > $fileSize) {
-					$ranges[1] = $fileSize;
-				}
-				$rangeArray[$ind++] = [ 'from' => $fileSize-$ranges[1], 'to' => $fileSize-1, 'size' => $fileSize ];
-				break;
-			}
-		}
-		return $rangeArray;
-	}
-
-	/**
-	 * @param View $view
-	 * @param string $name
-	 * @param string $dir
-	 * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
-	 */
-	private static function getSingleFile($view, $dir, $name, $params) {
-		$filename = $dir . '/' . $name;
-		$file = null;
-
-		try {
-			$userFolder = \OC::$server->getRootFolder()->get(\OC\Files\Filesystem::getRoot());
-			$file = $userFolder->get($filename);
-			if(!$file instanceof \OC\Files\Node\File || !$file->isReadable()) {
-				http_response_code(403);
-				die('403 Forbidden');
-			}
-			$fileSize = $file->getSize();
-		} catch (\OCP\Files\NotPermittedException $e) {
-			http_response_code(403);
-			die('403 Forbidden');
-		} catch (\OCP\Files\InvalidPathException $e) {
-			http_response_code(403);
-			die('403 Forbidden');
-		} catch (\OCP\Files\NotFoundException $e) {
-			http_response_code(404);
-			$tmpl = new OC_Template('', '404', 'guest');
-			$tmpl->printPage();
-			exit();
-		}
-
-		OC_Util::obEnd();
-		$view->lockFile($filename, ILockingProvider::LOCK_SHARED);
-
-		$rangeArray = [];
-
-		if (isset($params['range']) && substr($params['range'], 0, 6) === 'bytes=') {
-			$rangeArray = self::parseHttpRangeHeader(substr($params['range'], 6), $fileSize);
-		}
-
-		self::sendHeaders($filename, $name, $rangeArray);
-
-		if (isset($params['head']) && $params['head']) {
-			return;
-		}
-
-		if (!empty($rangeArray)) {
-			try {
-				if (count($rangeArray) == 1) {
-				$view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']);
-				}
-				else {
-				// check if file is seekable (if not throw UnseekableException)
-				// we have to check it before body contents
-				$view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']);
-
-				$type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
-
-				foreach ($rangeArray as $range) {
-					echo "\r\n--".self::getBoundary()."\r\n".
-						 "Content-type: ".$type."\r\n".
-						 "Content-range: bytes ".$range['from']."-".$range['to']."/".$range['size']."\r\n\r\n";
-					$view->readfilePart($filename, $range['from'], $range['to']);
-				}
-				echo "\r\n--".self::getBoundary()."--\r\n";
-				}
-			} catch (\OCP\Files\UnseekableException $ex) {
-				// file is unseekable
-				header_remove('Accept-Ranges');
-				header_remove('Content-Range');
-				http_response_code(200);
-				self::sendHeaders($filename, $name, []);
-				$view->readfile($filename);
-			}
-		}
-		else {
-			$view->readfile($filename);
-		}
-	}
-
-	/**
-	 * Returns the total (recursive) number of files and folders in the given
-	 * FileInfos.
-	 *
-	 * @param \OCP\Files\FileInfo[] $fileInfos the FileInfos to count
-	 * @return int the total number of files and folders
-	 */
-	private static function getNumberOfFiles($fileInfos) {
-		$numberOfFiles = 0;
-
-		$view = new View();
-
-		while ($fileInfo = array_pop($fileInfos)) {
-			$numberOfFiles++;
-
-			if ($fileInfo->getType() === \OCP\Files\FileInfo::TYPE_FOLDER) {
-				$fileInfos = array_merge($fileInfos, $view->getDirectoryContent($fileInfo->getPath()));
-			}
-		}
-
-		return $numberOfFiles;
-	}
-
-	/**
-	 * @param View $view
-	 * @param string $dir
-	 * @param string[]|string $files
-	 */
-	public static function lockFiles($view, $dir, $files) {
-		if (!is_array($files)) {
-			$file = $dir . '/' . $files;
-			$files = [$file];
-		}
-		foreach ($files as $file) {
-			$file = $dir . '/' . $file;
-			$view->lockFile($file, ILockingProvider::LOCK_SHARED);
-			if ($view->is_dir($file)) {
-				$contents = $view->getDirectoryContent($file);
-				$contents = array_map(function($fileInfo) use ($file) {
-					/** @var \OCP\Files\FileInfo $fileInfo */
-					return $file . '/' . $fileInfo->getName();
-				}, $contents);
-				self::lockFiles($view, $dir, $contents);
-			}
-		}
-	}
-
-	/**
-	 * @param string $dir
-	 * @param $files
-	 * @param integer $getType
-	 * @param View $view
-	 * @param string $filename
-	 */
-	private static function unlockAllTheFiles($dir, $files, $getType, $view, $filename) {
-		if ($getType === self::FILE) {
-			$view->unlockFile($filename, ILockingProvider::LOCK_SHARED);
-		}
-		if ($getType === self::ZIP_FILES) {
-			foreach ($files as $file) {
-				$file = $dir . '/' . $file;
-				$view->unlockFile($file, ILockingProvider::LOCK_SHARED);
-			}
-		}
-		if ($getType === self::ZIP_DIR) {
-			$file = $dir . '/' . $files;
-			$view->unlockFile($file, ILockingProvider::LOCK_SHARED);
-		}
-	}
+    const FILE = 1;
+    const ZIP_FILES = 2;
+    const ZIP_DIR = 3;
+
+    const UPLOAD_MIN_LIMIT_BYTES = 1048576; // 1 MiB
+
+
+    private static $multipartBoundary = '';
+
+    /**
+     * @return string
+     */
+    private static function getBoundary() {
+        if (empty(self::$multipartBoundary)) {
+            self::$multipartBoundary = md5(mt_rand());
+        }
+        return self::$multipartBoundary;
+    }
+
+    /**
+     * @param string $filename
+     * @param string $name
+     * @param array $rangeArray ('from'=>int,'to'=>int), ...
+     */
+    private static function sendHeaders($filename, $name, array $rangeArray) {
+        OC_Response::setContentDispositionHeader($name, 'attachment');
+        header('Content-Transfer-Encoding: binary', true);
+        header('Pragma: public');// enable caching in IE
+        header('Expires: 0');
+        header("Cache-Control: must-revalidate, post-check=0, pre-check=0");
+        $fileSize = \OC\Files\Filesystem::filesize($filename);
+        $type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
+        if ($fileSize > -1) {
+            if (!empty($rangeArray)) {
+                http_response_code(206);
+                header('Accept-Ranges: bytes', true);
+                if (count($rangeArray) > 1) {
+                $type = 'multipart/byteranges; boundary='.self::getBoundary();
+                // no Content-Length header here
+                }
+                else {
+                header(sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true);
+                OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1);
+                }
+            }
+            else {
+                OC_Response::setContentLengthHeader($fileSize);
+            }
+        }
+        header('Content-Type: '.$type, true);
+    }
+
+    /**
+     * return the content of a file or return a zip file containing multiple files
+     *
+     * @param string $dir
+     * @param string $files ; separated list of files to download
+     * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
+     */
+    public static function get($dir, $files, $params = null) {
+
+        $view = \OC\Files\Filesystem::getView();
+        $getType = self::FILE;
+        $filename = $dir;
+        try {
+
+            if (is_array($files) && count($files) === 1) {
+                $files = $files[0];
+            }
+
+            if (!is_array($files)) {
+                $filename = $dir . '/' . $files;
+                if (!$view->is_dir($filename)) {
+                    self::getSingleFile($view, $dir, $files, is_null($params) ? [] : $params);
+                    return;
+                }
+            }
+
+            $name = 'download';
+            if (is_array($files)) {
+                $getType = self::ZIP_FILES;
+                $basename = basename($dir);
+                if ($basename) {
+                    $name = $basename;
+                }
+
+                $filename = $dir . '/' . $name;
+            } else {
+                $filename = $dir . '/' . $files;
+                $getType = self::ZIP_DIR;
+                // downloading root ?
+                if ($files !== '') {
+                    $name = $files;
+                }
+            }
+
+            self::lockFiles($view, $dir, $files);
+
+            /* Calculate filesize and number of files */
+            if ($getType === self::ZIP_FILES) {
+                $fileInfos = [];
+                $fileSize = 0;
+                foreach ($files as $file) {
+                    $fileInfo = \OC\Files\Filesystem::getFileInfo($dir . '/' . $file);
+                    $fileSize += $fileInfo->getSize();
+                    $fileInfos[] = $fileInfo;
+                }
+                $numberOfFiles = self::getNumberOfFiles($fileInfos);
+            } elseif ($getType === self::ZIP_DIR) {
+                $fileInfo = \OC\Files\Filesystem::getFileInfo($dir . '/' . $files);
+                $fileSize = $fileInfo->getSize();
+                $numberOfFiles = self::getNumberOfFiles([$fileInfo]);
+            }
+
+            $streamer = new Streamer(\OC::$server->getRequest(), $fileSize, $numberOfFiles);
+            OC_Util::obEnd();
+
+            $streamer->sendHeaders($name);
+            $executionTime = (int)OC::$server->getIniWrapper()->getNumeric('max_execution_time');
+            if (strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
+                @set_time_limit(0);
+            }
+            ignore_user_abort(true);
+
+            if ($getType === self::ZIP_FILES) {
+                foreach ($files as $file) {
+                    $file = $dir . '/' . $file;
+                    if (\OC\Files\Filesystem::is_file($file)) {
+                        $userFolder = \OC::$server->getRootFolder()->get(\OC\Files\Filesystem::getRoot());
+                        $file = $userFolder->get($file);
+                        if($file instanceof \OC\Files\Node\File) {
+                            try {
+                                $fh = $file->fopen('r');
+                            } catch (\OCP\Files\NotPermittedException $e) {
+                                continue;
+                            }
+                            $fileSize = $file->getSize();
+                            $fileTime = $file->getMTime();
+                        } else {
+                            // File is not a file? …
+                            \OC::$server->getLogger()->debug(
+                                'File given, but no Node available. Name {file}',
+                                [ 'app' => 'files', 'file' => $file ]
+                            );
+                            continue;
+                        }
+                        $streamer->addFileFromStream($fh, $file->getName(), $fileSize, $fileTime);
+                        fclose($fh);
+                    } elseif (\OC\Files\Filesystem::is_dir($file)) {
+                        $streamer->addDirRecursive($file);
+                    }
+                }
+            } elseif ($getType === self::ZIP_DIR) {
+                $file = $dir . '/' . $files;
+                $streamer->addDirRecursive($file);
+            }
+            $streamer->finalize();
+            set_time_limit($executionTime);
+            self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
+        } catch (\OCP\Lock\LockedException $ex) {
+            self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
+            OC::$server->getLogger()->logException($ex);
+            $l = \OC::$server->getL10N('core');
+            $hint = method_exists($ex, 'getHint') ? $ex->getHint() : '';
+            \OC_Template::printErrorPage($l->t('File is currently busy, please try again later'), $hint, 200);
+        } catch (\OCP\Files\ForbiddenException $ex) {
+            self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
+            OC::$server->getLogger()->logException($ex);
+            $l = \OC::$server->getL10N('core');
+            \OC_Template::printErrorPage($l->t('Can\'t read file'), $ex->getMessage(), 200);
+        } catch (\Exception $ex) {
+            self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
+            OC::$server->getLogger()->logException($ex);
+            $l = \OC::$server->getL10N('core');
+            $hint = method_exists($ex, 'getHint') ? $ex->getHint() : '';
+            \OC_Template::printErrorPage($l->t('Can\'t read file'), $hint, 200);
+        }
+    }
+
+    /**
+     * @param string $rangeHeaderPos
+     * @param int $fileSize
+     * @return array $rangeArray ('from'=>int,'to'=>int), ...
+     */
+    private static function parseHttpRangeHeader($rangeHeaderPos, $fileSize) {
+        $rArray=explode(',', $rangeHeaderPos);
+        $minOffset = 0;
+        $ind = 0;
+
+        $rangeArray = [];
+
+        foreach ($rArray as $value) {
+            $ranges = explode('-', $value);
+            if (is_numeric($ranges[0])) {
+                if ($ranges[0] < $minOffset) { // case: bytes=500-700,601-999
+                    $ranges[0] = $minOffset;
+                }
+                if ($ind > 0 && $rangeArray[$ind-1]['to']+1 == $ranges[0]) { // case: bytes=500-600,601-999
+                    $ind--;
+                    $ranges[0] = $rangeArray[$ind]['from'];
+                }
+            }
+
+            if (is_numeric($ranges[0]) && is_numeric($ranges[1]) && $ranges[0] < $fileSize && $ranges[0] <= $ranges[1]) {
+                // case: x-x
+                if ($ranges[1] >= $fileSize) {
+                    $ranges[1] = $fileSize-1;
+                }
+                $rangeArray[$ind++] = [ 'from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize ];
+                $minOffset = $ranges[1] + 1;
+                if ($minOffset >= $fileSize) {
+                    break;
+                }
+            }
+            elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) {
+                // case: x-
+                $rangeArray[$ind++] = [ 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize ];
+                break;
+            }
+            elseif (is_numeric($ranges[1])) {
+                // case: -x
+                if ($ranges[1] > $fileSize) {
+                    $ranges[1] = $fileSize;
+                }
+                $rangeArray[$ind++] = [ 'from' => $fileSize-$ranges[1], 'to' => $fileSize-1, 'size' => $fileSize ];
+                break;
+            }
+        }
+        return $rangeArray;
+    }
+
+    /**
+     * @param View $view
+     * @param string $name
+     * @param string $dir
+     * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
+     */
+    private static function getSingleFile($view, $dir, $name, $params) {
+        $filename = $dir . '/' . $name;
+        $file = null;
+
+        try {
+            $userFolder = \OC::$server->getRootFolder()->get(\OC\Files\Filesystem::getRoot());
+            $file = $userFolder->get($filename);
+            if(!$file instanceof \OC\Files\Node\File || !$file->isReadable()) {
+                http_response_code(403);
+                die('403 Forbidden');
+            }
+            $fileSize = $file->getSize();
+        } catch (\OCP\Files\NotPermittedException $e) {
+            http_response_code(403);
+            die('403 Forbidden');
+        } catch (\OCP\Files\InvalidPathException $e) {
+            http_response_code(403);
+            die('403 Forbidden');
+        } catch (\OCP\Files\NotFoundException $e) {
+            http_response_code(404);
+            $tmpl = new OC_Template('', '404', 'guest');
+            $tmpl->printPage();
+            exit();
+        }
+
+        OC_Util::obEnd();
+        $view->lockFile($filename, ILockingProvider::LOCK_SHARED);
+
+        $rangeArray = [];
+
+        if (isset($params['range']) && substr($params['range'], 0, 6) === 'bytes=') {
+            $rangeArray = self::parseHttpRangeHeader(substr($params['range'], 6), $fileSize);
+        }
+
+        self::sendHeaders($filename, $name, $rangeArray);
+
+        if (isset($params['head']) && $params['head']) {
+            return;
+        }
+
+        if (!empty($rangeArray)) {
+            try {
+                if (count($rangeArray) == 1) {
+                $view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']);
+                }
+                else {
+                // check if file is seekable (if not throw UnseekableException)
+                // we have to check it before body contents
+                $view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']);
+
+                $type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
+
+                foreach ($rangeArray as $range) {
+                    echo "\r\n--".self::getBoundary()."\r\n".
+                            "Content-type: ".$type."\r\n".
+                            "Content-range: bytes ".$range['from']."-".$range['to']."/".$range['size']."\r\n\r\n";
+                    $view->readfilePart($filename, $range['from'], $range['to']);
+                }
+                echo "\r\n--".self::getBoundary()."--\r\n";
+                }
+            } catch (\OCP\Files\UnseekableException $ex) {
+                // file is unseekable
+                header_remove('Accept-Ranges');
+                header_remove('Content-Range');
+                http_response_code(200);
+                self::sendHeaders($filename, $name, []);
+                $view->readfile($filename);
+            }
+        }
+        else {
+            $view->readfile($filename);
+        }
+    }
+
+    /**
+     * Returns the total (recursive) number of files and folders in the given
+     * FileInfos.
+     *
+     * @param \OCP\Files\FileInfo[] $fileInfos the FileInfos to count
+     * @return int the total number of files and folders
+     */
+    private static function getNumberOfFiles($fileInfos) {
+        $numberOfFiles = 0;
+
+        $view = new View();
+
+        while ($fileInfo = array_pop($fileInfos)) {
+            $numberOfFiles++;
+
+            if ($fileInfo->getType() === \OCP\Files\FileInfo::TYPE_FOLDER) {
+                $fileInfos = array_merge($fileInfos, $view->getDirectoryContent($fileInfo->getPath()));
+            }
+        }
+
+        return $numberOfFiles;
+    }
+
+    /**
+     * @param View $view
+     * @param string $dir
+     * @param string[]|string $files
+     */
+    public static function lockFiles($view, $dir, $files) {
+        if (!is_array($files)) {
+            $file = $dir . '/' . $files;
+            $files = [$file];
+        }
+        foreach ($files as $file) {
+            $file = $dir . '/' . $file;
+            $view->lockFile($file, ILockingProvider::LOCK_SHARED);
+            if ($view->is_dir($file)) {
+                $contents = $view->getDirectoryContent($file);
+                $contents = array_map(function($fileInfo) use ($file) {
+                    /** @var \OCP\Files\FileInfo $fileInfo */
+                    return $file . '/' . $fileInfo->getName();
+                }, $contents);
+                self::lockFiles($view, $dir, $contents);
+            }
+        }
+    }
+
+    /**
+     * @param string $dir
+     * @param $files
+     * @param integer $getType
+     * @param View $view
+     * @param string $filename
+     */
+    private static function unlockAllTheFiles($dir, $files, $getType, $view, $filename) {
+        if ($getType === self::FILE) {
+            $view->unlockFile($filename, ILockingProvider::LOCK_SHARED);
+        }
+        if ($getType === self::ZIP_FILES) {
+            foreach ($files as $file) {
+                $file = $dir . '/' . $file;
+                $view->unlockFile($file, ILockingProvider::LOCK_SHARED);
+            }
+        }
+        if ($getType === self::ZIP_DIR) {
+            $file = $dir . '/' . $files;
+            $view->unlockFile($file, ILockingProvider::LOCK_SHARED);
+        }
+    }
 
 }

Braces +6 added lines, -12 removed lines

@@ -89,13 +89,11 @@ 
 				if (count($rangeArray) > 1) {
 				$type = 'multipart/byteranges; boundary='.self::getBoundary();
 				// no Content-Length header here
-				}
-				else {
+				} else {
 				header(sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true);
 				OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1);
 				}
-			}
-			else {
+			} else {
 				OC_Response::setContentLengthHeader($fileSize);
 			}
 		}
@@ -263,13 +261,11 @@ 
 				if ($minOffset >= $fileSize) {
 					break;
 				}
-			}
-			elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) {
+			} elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) {
 				// case: x-
 				$rangeArray[$ind++] = [ 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize ];
 				break;
-			}
-			elseif (is_numeric($ranges[1])) {
+			} elseif (is_numeric($ranges[1])) {
 				// case: -x
 				if ($ranges[1] > $fileSize) {
 					$ranges[1] = $fileSize;
@@ -331,8 +327,7 @@ 
 			try {
 				if (count($rangeArray) == 1) {
 				$view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']);
-				}
-				else {
+				} else {
 				// check if file is seekable (if not throw UnseekableException)
 				// we have to check it before body contents
 				$view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']);
@@ -355,8 +350,7 @@ 
 				self::sendHeaders($filename, $name, []);
 				$view->readfile($filename);
 			}
-		}
-		else {
+		} else {
 			$view->readfile($filename);
 		}
 	}

lib/private/legacy/OC_Hook.php

Indentation +103 added lines, -103 removed lines

@@ -34,118 +34,118 @@
  * @deprecated 18.0.0 use events and the \OCP\EventDispatcher\IEventDispatcher service
  */
 class OC_Hook {
-	public static $thrownExceptions = [];
+    public static $thrownExceptions = [];
 
-	static private $registered = [];
+    static private $registered = [];
 
-	/**
-	 * 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
-	 */
-	static public function connect($signalClass, $signalName, $slotClass, $slotName ) {
-		// If we're trying to connect to an emitting class that isn't
-		// yet registered, register it
-		if( !array_key_exists($signalClass, self::$registered )) {
-			self::$registered[$signalClass] = [];
-		}
-		// If we're trying to connect to an emitting method that isn't
-		// yet registered, register it with the emitting class
-		if( !array_key_exists( $signalName, self::$registered[$signalClass] )) {
-			self::$registered[$signalClass][$signalName] = [];
-		}
+    /**
+     * 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
+     */
+    static public function connect($signalClass, $signalName, $slotClass, $slotName ) {
+        // If we're trying to connect to an emitting class that isn't
+        // yet registered, register it
+        if( !array_key_exists($signalClass, self::$registered )) {
+            self::$registered[$signalClass] = [];
+        }
+        // If we're trying to connect to an emitting method that isn't
+        // yet registered, register it with the emitting class
+        if( !array_key_exists( $signalName, self::$registered[$signalClass] )) {
+            self::$registered[$signalClass][$signalName] = [];
+        }
 
-		// don't connect hooks twice
-		foreach (self::$registered[$signalClass][$signalName] as $hook) {
-			if ($hook['class'] === $slotClass and $hook['name'] === $slotName) {
-				return false;
-			}
-		}
-		// Connect the hook handler to the requested emitter
-		self::$registered[$signalClass][$signalName][] = [
-			"class" => $slotClass,
-			"name" => $slotName
-		];
+        // don't connect hooks twice
+        foreach (self::$registered[$signalClass][$signalName] as $hook) {
+            if ($hook['class'] === $slotClass and $hook['name'] === $slotName) {
+                return false;
+            }
+        }
+        // Connect the hook handler to the requested emitter
+        self::$registered[$signalClass][$signalName][] = [
+            "class" => $slotClass,
+            "name" => $slotName
+        ];
 
-		// No chance for failure ;-)
-		return true;
-	}
+        // No chance for failure ;-)
+        return true;
+    }
 
-	/**
-	 * emits a signal
-	 *
-	 * @param string $signalClass class name of emitter
-	 * @param string $signalName name of signal
-	 * @param mixed $params default: array() array with additional data
-	 * @return bool true if slots exists or false if not
-	 * @throws \OC\HintException
-	 * @throws \OC\ServerNotAvailableException Emits a signal. To get data from the slot use references!
-	 *
-	 * TODO: write example
-	 */
-	static public function emit($signalClass, $signalName, $params = []) {
+    /**
+     * emits a signal
+     *
+     * @param string $signalClass class name of emitter
+     * @param string $signalName name of signal
+     * @param mixed $params default: array() array with additional data
+     * @return bool true if slots exists or false if not
+     * @throws \OC\HintException
+     * @throws \OC\ServerNotAvailableException Emits a signal. To get data from the slot use references!
+     *
+     * TODO: write example
+     */
+    static public function emit($signalClass, $signalName, $params = []) {
 
-		// Return false if no hook handlers are listening to this
-		// emitting class
-		if( !array_key_exists($signalClass, self::$registered )) {
-			return false;
-		}
+        // Return false if no hook handlers are listening to this
+        // emitting class
+        if( !array_key_exists($signalClass, self::$registered )) {
+            return false;
+        }
 
-		// Return false if no hook handlers are listening to this
-		// emitting method
-		if( !array_key_exists( $signalName, self::$registered[$signalClass] )) {
-			return false;
-		}
+        // Return false if no hook handlers are listening to this
+        // emitting method
+        if( !array_key_exists( $signalName, self::$registered[$signalClass] )) {
+            return false;
+        }
 
-		// Call all slots
-		foreach( self::$registered[$signalClass][$signalName] as $i ) {
-			try {
-				call_user_func( [ $i["class"], $i["name"] ], $params );
-			} catch (Exception $e){
-				self::$thrownExceptions[] = $e;
-				\OC::$server->getLogger()->logException($e);
-				if($e instanceof \OC\HintException) {
-					throw $e;
-				}
-				if($e instanceof \OC\ServerNotAvailableException) {
-					throw $e;
-				}
-			}
-		}
+        // Call all slots
+        foreach( self::$registered[$signalClass][$signalName] as $i ) {
+            try {
+                call_user_func( [ $i["class"], $i["name"] ], $params );
+            } catch (Exception $e){
+                self::$thrownExceptions[] = $e;
+                \OC::$server->getLogger()->logException($e);
+                if($e instanceof \OC\HintException) {
+                    throw $e;
+                }
+                if($e instanceof \OC\ServerNotAvailableException) {
+                    throw $e;
+                }
+            }
+        }
 
-		return true;
-	}
+        return true;
+    }
 
-	/**
-	 * clear hooks
-	 * @param string $signalClass
-	 * @param string $signalName
-	 */
-	static public function clear($signalClass='', $signalName='') {
-		if ($signalClass) {
-			if ($signalName) {
-				self::$registered[$signalClass][$signalName]=[];
-			}else{
-				self::$registered[$signalClass]=[];
-			}
-		}else{
-			self::$registered=[];
-		}
-	}
+    /**
+     * clear hooks
+     * @param string $signalClass
+     * @param string $signalName
+     */
+    static public function clear($signalClass='', $signalName='') {
+        if ($signalClass) {
+            if ($signalName) {
+                self::$registered[$signalClass][$signalName]=[];
+            }else{
+                self::$registered[$signalClass]=[];
+            }
+        }else{
+            self::$registered=[];
+        }
+    }
 
-	/**
-	 * DO NOT USE!
-	 * For unit tests ONLY!
-	 */
-	static public function getHooks() {
-		return self::$registered;
-	}
+    /**
+     * DO NOT USE!
+     * For unit tests ONLY!
+     */
+    static public function getHooks() {
+        return self::$registered;
+    }
 }

apps/user_ldap/lib/Connection.php

Indentation +616 added lines, -616 removed lines

@@ -69,621 +69,621 @@
  * @property string ldapGroupDisplayName
  */
 class Connection extends LDAPUtility {
-	private $ldapConnectionRes = null;
-	private $configPrefix;
-	private $configID;
-	private $configured = false;
-	//whether connection should be kept on __destruct
-	private $dontDestruct = false;
-
-	/**
-	 * @var bool runtime flag that indicates whether supported primary groups are available
-	 */
-	public $hasPrimaryGroups = true;
-
-	/**
-	 * @var bool runtime flag that indicates whether supported POSIX gidNumber are available
-	 */
-	public $hasGidNumber = true;
-
-	//cache handler
-	protected $cache;
-
-	/** @var Configuration settings handler **/
-	protected $configuration;
-
-	protected $doNotValidate = false;
-
-	protected $ignoreValidation = false;
-
-	protected $bindResult = [];
-
-	/**
-	 * Constructor
-	 * @param ILDAPWrapper $ldap
-	 * @param string $configPrefix a string with the prefix for the configkey column (appconfig table)
-	 * @param string|null $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections
-	 */
-	public function __construct(ILDAPWrapper $ldap, $configPrefix = '', $configID = 'user_ldap') {
-		parent::__construct($ldap);
-		$this->configPrefix = $configPrefix;
-		$this->configID = $configID;
-		$this->configuration = new Configuration($configPrefix,
-												 !is_null($configID));
-		$memcache = \OC::$server->getMemCacheFactory();
-		if($memcache->isAvailable()) {
-			$this->cache = $memcache->createDistributed();
-		}
-		$helper = new Helper(\OC::$server->getConfig());
-		$this->doNotValidate = !in_array($this->configPrefix,
-			$helper->getServerConfigurationPrefixes());
-	}
-
-	public function __destruct() {
-		if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) {
-			@$this->ldap->unbind($this->ldapConnectionRes);
-			$this->bindResult = [];
-		}
-	}
-
-	/**
-	 * defines behaviour when the instance is cloned
-	 */
-	public function __clone() {
-		$this->configuration = new Configuration($this->configPrefix,
-												 !is_null($this->configID));
-		if(count($this->bindResult) !== 0 && $this->bindResult['result'] === true) {
-			$this->bindResult = [];
-		}
-		$this->ldapConnectionRes = null;
-		$this->dontDestruct = true;
-	}
-
-	/**
-	 * @param string $name
-	 * @return bool|mixed
-	 */
-	public function __get($name) {
-		if(!$this->configured) {
-			$this->readConfiguration();
-		}
-
-		return $this->configuration->$name;
-	}
-
-	/**
-	 * @param string $name
-	 * @param mixed $value
-	 */
-	public function __set($name, $value) {
-		$this->doNotValidate = false;
-		$before = $this->configuration->$name;
-		$this->configuration->$name = $value;
-		$after = $this->configuration->$name;
-		if($before !== $after) {
-			if ($this->configID !== '' && $this->configID !== null) {
-				$this->configuration->saveConfiguration();
-			}
-			$this->validateConfiguration();
-		}
-	}
-
-	/**
-	 * @param string $rule
-	 * @return array
-	 * @throws \RuntimeException
-	 */
-	public function resolveRule($rule) {
-		return $this->configuration->resolveRule($rule);
-	}
-
-	/**
-	 * sets whether the result of the configuration validation shall
-	 * be ignored when establishing the connection. Used by the Wizard
-	 * in early configuration state.
-	 * @param bool $state
-	 */
-	public function setIgnoreValidation($state) {
-		$this->ignoreValidation = (bool)$state;
-	}
-
-	/**
-	 * initializes the LDAP backend
-	 * @param bool $force read the config settings no matter what
-	 */
-	public function init($force = false) {
-		$this->readConfiguration($force);
-		$this->establishConnection();
-	}
-
-	/**
-	 * Returns the LDAP handler
-	 */
-	public function getConnectionResource() {
-		if(!$this->ldapConnectionRes) {
-			$this->init();
-		} else if(!$this->ldap->isResource($this->ldapConnectionRes)) {
-			$this->ldapConnectionRes = null;
-			$this->establishConnection();
-		}
-		if(is_null($this->ldapConnectionRes)) {
-			\OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, ILogger::ERROR);
-			throw new ServerNotAvailableException('Connection to LDAP server could not be established');
-		}
-		return $this->ldapConnectionRes;
-	}
-
-	/**
-	 * resets the connection resource
-	 */
-	public function resetConnectionResource() {
-		if(!is_null($this->ldapConnectionRes)) {
-			@$this->ldap->unbind($this->ldapConnectionRes);
-			$this->ldapConnectionRes = null;
-			$this->bindResult = [];
-		}
-	}
-
-	/**
-	 * @param string|null $key
-	 * @return string
-	 */
-	private function getCacheKey($key) {
-		$prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
-		if(is_null($key)) {
-			return $prefix;
-		}
-		return $prefix.hash('sha256', $key);
-	}
-
-	/**
-	 * @param string $key
-	 * @return mixed|null
-	 */
-	public function getFromCache($key) {
-		if(!$this->configured) {
-			$this->readConfiguration();
-		}
-		if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) {
-			return null;
-		}
-		$key = $this->getCacheKey($key);
-
-		return json_decode(base64_decode($this->cache->get($key)), true);
-	}
-
-	/**
-	 * @param string $key
-	 * @param mixed $value
-	 *
-	 * @return string
-	 */
-	public function writeToCache($key, $value) {
-		if(!$this->configured) {
-			$this->readConfiguration();
-		}
-		if(is_null($this->cache)
-			|| !$this->configuration->ldapCacheTTL
-			|| !$this->configuration->ldapConfigurationActive) {
-			return null;
-		}
-		$key   = $this->getCacheKey($key);
-		$value = base64_encode(json_encode($value));
-		$this->cache->set($key, $value, $this->configuration->ldapCacheTTL);
-	}
-
-	public function clearCache() {
-		if(!is_null($this->cache)) {
-			$this->cache->clear($this->getCacheKey(null));
-		}
-	}
-
-	/**
-	 * Caches the general LDAP configuration.
-	 * @param bool $force optional. true, if the re-read should be forced. defaults
-	 * to false.
-	 * @return null
-	 */
-	private function readConfiguration($force = false) {
-		if((!$this->configured || $force) && !is_null($this->configID)) {
-			$this->configuration->readConfiguration();
-			$this->configured = $this->validateConfiguration();
-		}
-	}
-
-	/**
-	 * set LDAP configuration with values delivered by an array, not read from configuration
-	 * @param array $config array that holds the config parameters in an associated array
-	 * @param array &$setParameters optional; array where the set fields will be given to
-	 * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
-	 */
-	public function setConfiguration($config, &$setParameters = null) {
-		if(is_null($setParameters)) {
-			$setParameters = [];
-		}
-		$this->doNotValidate = false;
-		$this->configuration->setConfiguration($config, $setParameters);
-		if(count($setParameters) > 0) {
-			$this->configured = $this->validateConfiguration();
-		}
-
-
-		return $this->configured;
-	}
-
-	/**
-	 * saves the current Configuration in the database and empties the
-	 * cache
-	 * @return null
-	 */
-	public function saveConfiguration() {
-		$this->configuration->saveConfiguration();
-		$this->clearCache();
-	}
-
-	/**
-	 * get the current LDAP configuration
-	 * @return array
-	 */
-	public function getConfiguration() {
-		$this->readConfiguration();
-		$config = $this->configuration->getConfiguration();
-		$cta = $this->configuration->getConfigTranslationArray();
-		$result = [];
-		foreach($cta as $dbkey => $configkey) {
-			switch($configkey) {
-				case 'homeFolderNamingRule':
-					if(strpos($config[$configkey], 'attr:') === 0) {
-						$result[$dbkey] = substr($config[$configkey], 5);
-					} else {
-						$result[$dbkey] = '';
-					}
-					break;
-				case 'ldapBase':
-				case 'ldapBaseUsers':
-				case 'ldapBaseGroups':
-				case 'ldapAttributesForUserSearch':
-				case 'ldapAttributesForGroupSearch':
-					if(is_array($config[$configkey])) {
-						$result[$dbkey] = implode("\n", $config[$configkey]);
-						break;
-					} //else follows default
-				default:
-					$result[$dbkey] = $config[$configkey];
-			}
-		}
-		return $result;
-	}
-
-	private function doSoftValidation() {
-		//if User or Group Base are not set, take over Base DN setting
-		foreach(['ldapBaseUsers', 'ldapBaseGroups'] as $keyBase) {
-			$val = $this->configuration->$keyBase;
-			if(empty($val)) {
-				$this->configuration->$keyBase = $this->configuration->ldapBase;
-			}
-		}
-
-		foreach(['ldapExpertUUIDUserAttr'  => 'ldapUuidUserAttribute',
-			'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute']
-				as $expertSetting => $effectiveSetting) {
-			$uuidOverride = $this->configuration->$expertSetting;
-			if(!empty($uuidOverride)) {
-				$this->configuration->$effectiveSetting = $uuidOverride;
-			} else {
-				$uuidAttributes = Access::UUID_ATTRIBUTES;
-				array_unshift($uuidAttributes, 'auto');
-				if(!in_array($this->configuration->$effectiveSetting,
-							$uuidAttributes)
-					&& (!is_null($this->configID))) {
-					$this->configuration->$effectiveSetting = 'auto';
-					$this->configuration->saveConfiguration();
-					\OCP\Util::writeLog('user_ldap',
-										'Illegal value for the '.
-										$effectiveSetting.', '.'reset to '.
-										'autodetect.', ILogger::INFO);
-				}
-
-			}
-		}
-
-		$backupPort = (int)$this->configuration->ldapBackupPort;
-		if ($backupPort <= 0) {
-			$this->configuration->backupPort = $this->configuration->ldapPort;
-		}
-
-		//make sure empty search attributes are saved as simple, empty array
-		$saKeys = ['ldapAttributesForUserSearch',
-			'ldapAttributesForGroupSearch'];
-		foreach($saKeys as $key) {
-			$val = $this->configuration->$key;
-			if(is_array($val) && count($val) === 1 && empty($val[0])) {
-				$this->configuration->$key = [];
-			}
-		}
-
-		if((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
-			&& $this->configuration->ldapTLS) {
-			$this->configuration->ldapTLS = false;
-			\OCP\Util::writeLog(
-				'user_ldap',
-				'LDAPS (already using secure connection) and TLS do not work together. Switched off TLS.',
-				ILogger::INFO
-			);
-		}
-	}
-
-	/**
-	 * @return bool
-	 */
-	private function doCriticalValidation() {
-		$configurationOK = true;
-		$errorStr = 'Configuration Error (prefix '.
-			(string)$this->configPrefix .'): ';
-
-		//options that shall not be empty
-		$options = ['ldapHost', 'ldapPort', 'ldapUserDisplayName',
-			'ldapGroupDisplayName', 'ldapLoginFilter'];
-		foreach($options as $key) {
-			$val = $this->configuration->$key;
-			if(empty($val)) {
-				switch($key) {
-					case 'ldapHost':
-						$subj = 'LDAP Host';
-						break;
-					case 'ldapPort':
-						$subj = 'LDAP Port';
-						break;
-					case 'ldapUserDisplayName':
-						$subj = 'LDAP User Display Name';
-						break;
-					case 'ldapGroupDisplayName':
-						$subj = 'LDAP Group Display Name';
-						break;
-					case 'ldapLoginFilter':
-						$subj = 'LDAP Login Filter';
-						break;
-					default:
-						$subj = $key;
-						break;
-				}
-				$configurationOK = false;
-				\OCP\Util::writeLog(
-					'user_ldap',
-					$errorStr.'No '.$subj.' given!',
-					ILogger::WARN
-				);
-			}
-		}
-
-		//combinations
-		$agent = $this->configuration->ldapAgentName;
-		$pwd = $this->configuration->ldapAgentPassword;
-		if (
-			($agent === ''  && $pwd !== '')
-			|| ($agent !== '' && $pwd === '')
-		) {
-			\OCP\Util::writeLog(
-				'user_ldap',
-				$errorStr.'either no password is given for the user ' .
-					'agent or a password is given, but not an LDAP agent.',
-				ILogger::WARN);
-			$configurationOK = false;
-		}
-
-		$base = $this->configuration->ldapBase;
-		$baseUsers = $this->configuration->ldapBaseUsers;
-		$baseGroups = $this->configuration->ldapBaseGroups;
-
-		if(empty($base) && empty($baseUsers) && empty($baseGroups)) {
-			\OCP\Util::writeLog(
-				'user_ldap',
-				$errorStr.'Not a single Base DN given.',
-				ILogger::WARN
-			);
-			$configurationOK = false;
-		}
-
-		if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
-		   === false) {
-			\OCP\Util::writeLog(
-				'user_ldap',
-				$errorStr.'login filter does not contain %uid place holder.',
-				ILogger::WARN
-			);
-			$configurationOK = false;
-		}
-
-		return $configurationOK;
-	}
-
-	/**
-	 * Validates the user specified configuration
-	 * @return bool true if configuration seems OK, false otherwise
-	 */
-	private function validateConfiguration() {
-
-		if($this->doNotValidate) {
-			//don't do a validation if it is a new configuration with pure
-			//default values. Will be allowed on changes via __set or
-			//setConfiguration
-			return false;
-		}
-
-		// first step: "soft" checks: settings that are not really
-		// necessary, but advisable. If left empty, give an info message
-		$this->doSoftValidation();
-
-		//second step: critical checks. If left empty or filled wrong, mark as
-		//not configured and give a warning.
-		return $this->doCriticalValidation();
-	}
-
-
-	/**
-	 * Connects and Binds to LDAP
-	 *
-	 * @throws ServerNotAvailableException
-	 */
-	private function establishConnection() {
-		if(!$this->configuration->ldapConfigurationActive) {
-			return null;
-		}
-		static $phpLDAPinstalled = true;
-		if(!$phpLDAPinstalled) {
-			return false;
-		}
-		if(!$this->ignoreValidation && !$this->configured) {
-			\OCP\Util::writeLog(
-				'user_ldap',
-				'Configuration is invalid, cannot connect',
-				ILogger::WARN
-			);
-			return false;
-		}
-		if(!$this->ldapConnectionRes) {
-			if(!$this->ldap->areLDAPFunctionsAvailable()) {
-				$phpLDAPinstalled = false;
-				\OCP\Util::writeLog(
-					'user_ldap',
-					'function ldap_connect is not available. Make sure that the PHP ldap module is installed.',
-					ILogger::ERROR
-				);
-
-				return false;
-			}
-			if($this->configuration->turnOffCertCheck) {
-				if(putenv('LDAPTLS_REQCERT=never')) {
-					\OCP\Util::writeLog('user_ldap',
-						'Turned off SSL certificate validation successfully.',
-						ILogger::DEBUG);
-				} else {
-					\OCP\Util::writeLog(
-						'user_ldap',
-						'Could not turn off SSL certificate validation.',
-						ILogger::WARN
-					);
-				}
-			}
-
-			$isOverrideMainServer = ($this->configuration->ldapOverrideMainServer
-				|| $this->getFromCache('overrideMainServer'));
-			$isBackupHost = (trim($this->configuration->ldapBackupHost) !== "");
-			$bindStatus = false;
-			try {
-				if (!$isOverrideMainServer) {
-					$this->doConnect($this->configuration->ldapHost,
-						$this->configuration->ldapPort);
-					return $this->bind();
-				}
-			} catch (ServerNotAvailableException $e) {
-				if(!$isBackupHost) {
-					throw $e;
-				}
-			}
-
-			//if LDAP server is not reachable, try the Backup (Replica!) Server
-			if($isBackupHost || $isOverrideMainServer) {
-				$this->doConnect($this->configuration->ldapBackupHost,
-								 $this->configuration->ldapBackupPort);
-				$this->bindResult = [];
-				$bindStatus = $this->bind();
-				$error = $this->ldap->isResource($this->ldapConnectionRes) ?
-					$this->ldap->errno($this->ldapConnectionRes) : -1;
-				if($bindStatus && $error === 0 && !$this->getFromCache('overrideMainServer')) {
-					//when bind to backup server succeeded and failed to main server,
-					//skip contacting him until next cache refresh
-					$this->writeToCache('overrideMainServer', true);
-				}
-			}
-
-			return $bindStatus;
-		}
-		return null;
-	}
-
-	/**
-	 * @param string $host
-	 * @param string $port
-	 * @return bool
-	 * @throws \OC\ServerNotAvailableException
-	 */
-	private function doConnect($host, $port) {
-		if ($host === '') {
-			return false;
-		}
-
-		$this->ldapConnectionRes = $this->ldap->connect($host, $port);
-
-		if(!$this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) {
-			throw new ServerNotAvailableException('Could not set required LDAP Protocol version.');
-		}
-
-		if(!$this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) {
-			throw new ServerNotAvailableException('Could not disable LDAP referrals.');
-		}
-
-		if($this->configuration->ldapTLS) {
-			if(!$this->ldap->startTls($this->ldapConnectionRes)) {
-				throw new ServerNotAvailableException('Start TLS failed, when connecting to LDAP host ' . $host . '.');
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Binds to LDAP
-	 */
-	public function bind() {
-		if(!$this->configuration->ldapConfigurationActive) {
-			return false;
-		}
-		$cr = $this->ldapConnectionRes;
-		if(!$this->ldap->isResource($cr)) {
-			$cr = $this->getConnectionResource();
-		}
-
-		if(
-			count($this->bindResult) !== 0
-			&& $this->bindResult['dn'] === $this->configuration->ldapAgentName
-			&& \OC::$server->getHasher()->verify(
-				$this->configPrefix . $this->configuration->ldapAgentPassword,
-				$this->bindResult['hash']
-			)
-		) {
-			// don't attempt to bind again with the same data as before
-			// bind might have been invoked via getConnectionResource(),
-			// but we need results specifically for e.g. user login
-			return $this->bindResult['result'];
-		}
-
-		$ldapLogin = @$this->ldap->bind($cr,
-										$this->configuration->ldapAgentName,
-										$this->configuration->ldapAgentPassword);
-
-		$this->bindResult = [
-			'dn' => $this->configuration->ldapAgentName,
-			'hash' => \OC::$server->getHasher()->hash($this->configPrefix . $this->configuration->ldapAgentPassword),
-			'result' => $ldapLogin,
-		];
-
-		if(!$ldapLogin) {
-			$errno = $this->ldap->errno($cr);
-
-			\OCP\Util::writeLog('user_ldap',
-				'Bind failed: ' . $errno . ': ' . $this->ldap->error($cr),
-				ILogger::WARN);
-
-			// Set to failure mode, if LDAP error code is not LDAP_SUCCESS or LDAP_INVALID_CREDENTIALS
-			// or (needed for Apple Open Directory:) LDAP_INSUFFICIENT_ACCESS
-			if($errno !== 0 && $errno !== 49 && $errno !== 50) {
-				$this->ldapConnectionRes = null;
-			}
-
-			return false;
-		}
-		return true;
-	}
+    private $ldapConnectionRes = null;
+    private $configPrefix;
+    private $configID;
+    private $configured = false;
+    //whether connection should be kept on __destruct
+    private $dontDestruct = false;
+
+    /**
+     * @var bool runtime flag that indicates whether supported primary groups are available
+     */
+    public $hasPrimaryGroups = true;
+
+    /**
+     * @var bool runtime flag that indicates whether supported POSIX gidNumber are available
+     */
+    public $hasGidNumber = true;
+
+    //cache handler
+    protected $cache;
+
+    /** @var Configuration settings handler **/
+    protected $configuration;
+
+    protected $doNotValidate = false;
+
+    protected $ignoreValidation = false;
+
+    protected $bindResult = [];
+
+    /**
+     * Constructor
+     * @param ILDAPWrapper $ldap
+     * @param string $configPrefix a string with the prefix for the configkey column (appconfig table)
+     * @param string|null $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections
+     */
+    public function __construct(ILDAPWrapper $ldap, $configPrefix = '', $configID = 'user_ldap') {
+        parent::__construct($ldap);
+        $this->configPrefix = $configPrefix;
+        $this->configID = $configID;
+        $this->configuration = new Configuration($configPrefix,
+                                                    !is_null($configID));
+        $memcache = \OC::$server->getMemCacheFactory();
+        if($memcache->isAvailable()) {
+            $this->cache = $memcache->createDistributed();
+        }
+        $helper = new Helper(\OC::$server->getConfig());
+        $this->doNotValidate = !in_array($this->configPrefix,
+            $helper->getServerConfigurationPrefixes());
+    }
+
+    public function __destruct() {
+        if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) {
+            @$this->ldap->unbind($this->ldapConnectionRes);
+            $this->bindResult = [];
+        }
+    }
+
+    /**
+     * defines behaviour when the instance is cloned
+     */
+    public function __clone() {
+        $this->configuration = new Configuration($this->configPrefix,
+                                                    !is_null($this->configID));
+        if(count($this->bindResult) !== 0 && $this->bindResult['result'] === true) {
+            $this->bindResult = [];
+        }
+        $this->ldapConnectionRes = null;
+        $this->dontDestruct = true;
+    }
+
+    /**
+     * @param string $name
+     * @return bool|mixed
+     */
+    public function __get($name) {
+        if(!$this->configured) {
+            $this->readConfiguration();
+        }
+
+        return $this->configuration->$name;
+    }
+
+    /**
+     * @param string $name
+     * @param mixed $value
+     */
+    public function __set($name, $value) {
+        $this->doNotValidate = false;
+        $before = $this->configuration->$name;
+        $this->configuration->$name = $value;
+        $after = $this->configuration->$name;
+        if($before !== $after) {
+            if ($this->configID !== '' && $this->configID !== null) {
+                $this->configuration->saveConfiguration();
+            }
+            $this->validateConfiguration();
+        }
+    }
+
+    /**
+     * @param string $rule
+     * @return array
+     * @throws \RuntimeException
+     */
+    public function resolveRule($rule) {
+        return $this->configuration->resolveRule($rule);
+    }
+
+    /**
+     * sets whether the result of the configuration validation shall
+     * be ignored when establishing the connection. Used by the Wizard
+     * in early configuration state.
+     * @param bool $state
+     */
+    public function setIgnoreValidation($state) {
+        $this->ignoreValidation = (bool)$state;
+    }
+
+    /**
+     * initializes the LDAP backend
+     * @param bool $force read the config settings no matter what
+     */
+    public function init($force = false) {
+        $this->readConfiguration($force);
+        $this->establishConnection();
+    }
+
+    /**
+     * Returns the LDAP handler
+     */
+    public function getConnectionResource() {
+        if(!$this->ldapConnectionRes) {
+            $this->init();
+        } else if(!$this->ldap->isResource($this->ldapConnectionRes)) {
+            $this->ldapConnectionRes = null;
+            $this->establishConnection();
+        }
+        if(is_null($this->ldapConnectionRes)) {
+            \OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, ILogger::ERROR);
+            throw new ServerNotAvailableException('Connection to LDAP server could not be established');
+        }
+        return $this->ldapConnectionRes;
+    }
+
+    /**
+     * resets the connection resource
+     */
+    public function resetConnectionResource() {
+        if(!is_null($this->ldapConnectionRes)) {
+            @$this->ldap->unbind($this->ldapConnectionRes);
+            $this->ldapConnectionRes = null;
+            $this->bindResult = [];
+        }
+    }
+
+    /**
+     * @param string|null $key
+     * @return string
+     */
+    private function getCacheKey($key) {
+        $prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
+        if(is_null($key)) {
+            return $prefix;
+        }
+        return $prefix.hash('sha256', $key);
+    }
+
+    /**
+     * @param string $key
+     * @return mixed|null
+     */
+    public function getFromCache($key) {
+        if(!$this->configured) {
+            $this->readConfiguration();
+        }
+        if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) {
+            return null;
+        }
+        $key = $this->getCacheKey($key);
+
+        return json_decode(base64_decode($this->cache->get($key)), true);
+    }
+
+    /**
+     * @param string $key
+     * @param mixed $value
+     *
+     * @return string
+     */
+    public function writeToCache($key, $value) {
+        if(!$this->configured) {
+            $this->readConfiguration();
+        }
+        if(is_null($this->cache)
+            || !$this->configuration->ldapCacheTTL
+            || !$this->configuration->ldapConfigurationActive) {
+            return null;
+        }
+        $key   = $this->getCacheKey($key);
+        $value = base64_encode(json_encode($value));
+        $this->cache->set($key, $value, $this->configuration->ldapCacheTTL);
+    }
+
+    public function clearCache() {
+        if(!is_null($this->cache)) {
+            $this->cache->clear($this->getCacheKey(null));
+        }
+    }
+
+    /**
+     * Caches the general LDAP configuration.
+     * @param bool $force optional. true, if the re-read should be forced. defaults
+     * to false.
+     * @return null
+     */
+    private function readConfiguration($force = false) {
+        if((!$this->configured || $force) && !is_null($this->configID)) {
+            $this->configuration->readConfiguration();
+            $this->configured = $this->validateConfiguration();
+        }
+    }
+
+    /**
+     * set LDAP configuration with values delivered by an array, not read from configuration
+     * @param array $config array that holds the config parameters in an associated array
+     * @param array &$setParameters optional; array where the set fields will be given to
+     * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
+     */
+    public function setConfiguration($config, &$setParameters = null) {
+        if(is_null($setParameters)) {
+            $setParameters = [];
+        }
+        $this->doNotValidate = false;
+        $this->configuration->setConfiguration($config, $setParameters);
+        if(count($setParameters) > 0) {
+            $this->configured = $this->validateConfiguration();
+        }
+
+
+        return $this->configured;
+    }
+
+    /**
+     * saves the current Configuration in the database and empties the
+     * cache
+     * @return null
+     */
+    public function saveConfiguration() {
+        $this->configuration->saveConfiguration();
+        $this->clearCache();
+    }
+
+    /**
+     * get the current LDAP configuration
+     * @return array
+     */
+    public function getConfiguration() {
+        $this->readConfiguration();
+        $config = $this->configuration->getConfiguration();
+        $cta = $this->configuration->getConfigTranslationArray();
+        $result = [];
+        foreach($cta as $dbkey => $configkey) {
+            switch($configkey) {
+                case 'homeFolderNamingRule':
+                    if(strpos($config[$configkey], 'attr:') === 0) {
+                        $result[$dbkey] = substr($config[$configkey], 5);
+                    } else {
+                        $result[$dbkey] = '';
+                    }
+                    break;
+                case 'ldapBase':
+                case 'ldapBaseUsers':
+                case 'ldapBaseGroups':
+                case 'ldapAttributesForUserSearch':
+                case 'ldapAttributesForGroupSearch':
+                    if(is_array($config[$configkey])) {
+                        $result[$dbkey] = implode("\n", $config[$configkey]);
+                        break;
+                    } //else follows default
+                default:
+                    $result[$dbkey] = $config[$configkey];
+            }
+        }
+        return $result;
+    }
+
+    private function doSoftValidation() {
+        //if User or Group Base are not set, take over Base DN setting
+        foreach(['ldapBaseUsers', 'ldapBaseGroups'] as $keyBase) {
+            $val = $this->configuration->$keyBase;
+            if(empty($val)) {
+                $this->configuration->$keyBase = $this->configuration->ldapBase;
+            }
+        }
+
+        foreach(['ldapExpertUUIDUserAttr'  => 'ldapUuidUserAttribute',
+            'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute']
+                as $expertSetting => $effectiveSetting) {
+            $uuidOverride = $this->configuration->$expertSetting;
+            if(!empty($uuidOverride)) {
+                $this->configuration->$effectiveSetting = $uuidOverride;
+            } else {
+                $uuidAttributes = Access::UUID_ATTRIBUTES;
+                array_unshift($uuidAttributes, 'auto');
+                if(!in_array($this->configuration->$effectiveSetting,
+                            $uuidAttributes)
+                    && (!is_null($this->configID))) {
+                    $this->configuration->$effectiveSetting = 'auto';
+                    $this->configuration->saveConfiguration();
+                    \OCP\Util::writeLog('user_ldap',
+                                        'Illegal value for the '.
+                                        $effectiveSetting.', '.'reset to '.
+                                        'autodetect.', ILogger::INFO);
+                }
+
+            }
+        }
+
+        $backupPort = (int)$this->configuration->ldapBackupPort;
+        if ($backupPort <= 0) {
+            $this->configuration->backupPort = $this->configuration->ldapPort;
+        }
+
+        //make sure empty search attributes are saved as simple, empty array
+        $saKeys = ['ldapAttributesForUserSearch',
+            'ldapAttributesForGroupSearch'];
+        foreach($saKeys as $key) {
+            $val = $this->configuration->$key;
+            if(is_array($val) && count($val) === 1 && empty($val[0])) {
+                $this->configuration->$key = [];
+            }
+        }
+
+        if((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
+            && $this->configuration->ldapTLS) {
+            $this->configuration->ldapTLS = false;
+            \OCP\Util::writeLog(
+                'user_ldap',
+                'LDAPS (already using secure connection) and TLS do not work together. Switched off TLS.',
+                ILogger::INFO
+            );
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    private function doCriticalValidation() {
+        $configurationOK = true;
+        $errorStr = 'Configuration Error (prefix '.
+            (string)$this->configPrefix .'): ';
+
+        //options that shall not be empty
+        $options = ['ldapHost', 'ldapPort', 'ldapUserDisplayName',
+            'ldapGroupDisplayName', 'ldapLoginFilter'];
+        foreach($options as $key) {
+            $val = $this->configuration->$key;
+            if(empty($val)) {
+                switch($key) {
+                    case 'ldapHost':
+                        $subj = 'LDAP Host';
+                        break;
+                    case 'ldapPort':
+                        $subj = 'LDAP Port';
+                        break;
+                    case 'ldapUserDisplayName':
+                        $subj = 'LDAP User Display Name';
+                        break;
+                    case 'ldapGroupDisplayName':
+                        $subj = 'LDAP Group Display Name';
+                        break;
+                    case 'ldapLoginFilter':
+                        $subj = 'LDAP Login Filter';
+                        break;
+                    default:
+                        $subj = $key;
+                        break;
+                }
+                $configurationOK = false;
+                \OCP\Util::writeLog(
+                    'user_ldap',
+                    $errorStr.'No '.$subj.' given!',
+                    ILogger::WARN
+                );
+            }
+        }
+
+        //combinations
+        $agent = $this->configuration->ldapAgentName;
+        $pwd = $this->configuration->ldapAgentPassword;
+        if (
+            ($agent === ''  && $pwd !== '')
+            || ($agent !== '' && $pwd === '')
+        ) {
+            \OCP\Util::writeLog(
+                'user_ldap',
+                $errorStr.'either no password is given for the user ' .
+                    'agent or a password is given, but not an LDAP agent.',
+                ILogger::WARN);
+            $configurationOK = false;
+        }
+
+        $base = $this->configuration->ldapBase;
+        $baseUsers = $this->configuration->ldapBaseUsers;
+        $baseGroups = $this->configuration->ldapBaseGroups;
+
+        if(empty($base) && empty($baseUsers) && empty($baseGroups)) {
+            \OCP\Util::writeLog(
+                'user_ldap',
+                $errorStr.'Not a single Base DN given.',
+                ILogger::WARN
+            );
+            $configurationOK = false;
+        }
+
+        if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
+            === false) {
+            \OCP\Util::writeLog(
+                'user_ldap',
+                $errorStr.'login filter does not contain %uid place holder.',
+                ILogger::WARN
+            );
+            $configurationOK = false;
+        }
+
+        return $configurationOK;
+    }
+
+    /**
+     * Validates the user specified configuration
+     * @return bool true if configuration seems OK, false otherwise
+     */
+    private function validateConfiguration() {
+
+        if($this->doNotValidate) {
+            //don't do a validation if it is a new configuration with pure
+            //default values. Will be allowed on changes via __set or
+            //setConfiguration
+            return false;
+        }
+
+        // first step: "soft" checks: settings that are not really
+        // necessary, but advisable. If left empty, give an info message
+        $this->doSoftValidation();
+
+        //second step: critical checks. If left empty or filled wrong, mark as
+        //not configured and give a warning.
+        return $this->doCriticalValidation();
+    }
+
+
+    /**
+     * Connects and Binds to LDAP
+     *
+     * @throws ServerNotAvailableException
+     */
+    private function establishConnection() {
+        if(!$this->configuration->ldapConfigurationActive) {
+            return null;
+        }
+        static $phpLDAPinstalled = true;
+        if(!$phpLDAPinstalled) {
+            return false;
+        }
+        if(!$this->ignoreValidation && !$this->configured) {
+            \OCP\Util::writeLog(
+                'user_ldap',
+                'Configuration is invalid, cannot connect',
+                ILogger::WARN
+            );
+            return false;
+        }
+        if(!$this->ldapConnectionRes) {
+            if(!$this->ldap->areLDAPFunctionsAvailable()) {
+                $phpLDAPinstalled = false;
+                \OCP\Util::writeLog(
+                    'user_ldap',
+                    'function ldap_connect is not available. Make sure that the PHP ldap module is installed.',
+                    ILogger::ERROR
+                );
+
+                return false;
+            }
+            if($this->configuration->turnOffCertCheck) {
+                if(putenv('LDAPTLS_REQCERT=never')) {
+                    \OCP\Util::writeLog('user_ldap',
+                        'Turned off SSL certificate validation successfully.',
+                        ILogger::DEBUG);
+                } else {
+                    \OCP\Util::writeLog(
+                        'user_ldap',
+                        'Could not turn off SSL certificate validation.',
+                        ILogger::WARN
+                    );
+                }
+            }
+
+            $isOverrideMainServer = ($this->configuration->ldapOverrideMainServer
+                || $this->getFromCache('overrideMainServer'));
+            $isBackupHost = (trim($this->configuration->ldapBackupHost) !== "");
+            $bindStatus = false;
+            try {
+                if (!$isOverrideMainServer) {
+                    $this->doConnect($this->configuration->ldapHost,
+                        $this->configuration->ldapPort);
+                    return $this->bind();
+                }
+            } catch (ServerNotAvailableException $e) {
+                if(!$isBackupHost) {
+                    throw $e;
+                }
+            }
+
+            //if LDAP server is not reachable, try the Backup (Replica!) Server
+            if($isBackupHost || $isOverrideMainServer) {
+                $this->doConnect($this->configuration->ldapBackupHost,
+                                    $this->configuration->ldapBackupPort);
+                $this->bindResult = [];
+                $bindStatus = $this->bind();
+                $error = $this->ldap->isResource($this->ldapConnectionRes) ?
+                    $this->ldap->errno($this->ldapConnectionRes) : -1;
+                if($bindStatus && $error === 0 && !$this->getFromCache('overrideMainServer')) {
+                    //when bind to backup server succeeded and failed to main server,
+                    //skip contacting him until next cache refresh
+                    $this->writeToCache('overrideMainServer', true);
+                }
+            }
+
+            return $bindStatus;
+        }
+        return null;
+    }
+
+    /**
+     * @param string $host
+     * @param string $port
+     * @return bool
+     * @throws \OC\ServerNotAvailableException
+     */
+    private function doConnect($host, $port) {
+        if ($host === '') {
+            return false;
+        }
+
+        $this->ldapConnectionRes = $this->ldap->connect($host, $port);
+
+        if(!$this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) {
+            throw new ServerNotAvailableException('Could not set required LDAP Protocol version.');
+        }
+
+        if(!$this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) {
+            throw new ServerNotAvailableException('Could not disable LDAP referrals.');
+        }
+
+        if($this->configuration->ldapTLS) {
+            if(!$this->ldap->startTls($this->ldapConnectionRes)) {
+                throw new ServerNotAvailableException('Start TLS failed, when connecting to LDAP host ' . $host . '.');
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Binds to LDAP
+     */
+    public function bind() {
+        if(!$this->configuration->ldapConfigurationActive) {
+            return false;
+        }
+        $cr = $this->ldapConnectionRes;
+        if(!$this->ldap->isResource($cr)) {
+            $cr = $this->getConnectionResource();
+        }
+
+        if(
+            count($this->bindResult) !== 0
+            && $this->bindResult['dn'] === $this->configuration->ldapAgentName
+            && \OC::$server->getHasher()->verify(
+                $this->configPrefix . $this->configuration->ldapAgentPassword,
+                $this->bindResult['hash']
+            )
+        ) {
+            // don't attempt to bind again with the same data as before
+            // bind might have been invoked via getConnectionResource(),
+            // but we need results specifically for e.g. user login
+            return $this->bindResult['result'];
+        }
+
+        $ldapLogin = @$this->ldap->bind($cr,
+                                        $this->configuration->ldapAgentName,
+                                        $this->configuration->ldapAgentPassword);
+
+        $this->bindResult = [
+            'dn' => $this->configuration->ldapAgentName,
+            'hash' => \OC::$server->getHasher()->hash($this->configPrefix . $this->configuration->ldapAgentPassword),
+            'result' => $ldapLogin,
+        ];
+
+        if(!$ldapLogin) {
+            $errno = $this->ldap->errno($cr);
+
+            \OCP\Util::writeLog('user_ldap',
+                'Bind failed: ' . $errno . ': ' . $this->ldap->error($cr),
+                ILogger::WARN);
+
+            // Set to failure mode, if LDAP error code is not LDAP_SUCCESS or LDAP_INVALID_CREDENTIALS
+            // or (needed for Apple Open Directory:) LDAP_INSUFFICIENT_ACCESS
+            if($errno !== 0 && $errno !== 49 && $errno !== 50) {
+                $this->ldapConnectionRes = null;
+            }
+
+            return false;
+        }
+        return true;
+    }
 
 }

Spacing +65 added lines, -65 removed lines

@@ -111,7 +111,7 @@ 
 		$this->configuration = new Configuration($configPrefix,
 												 !is_null($configID));
 		$memcache = \OC::$server->getMemCacheFactory();
-		if($memcache->isAvailable()) {
+		if ($memcache->isAvailable()) {
 			$this->cache = $memcache->createDistributed();
 		}
 		$helper = new Helper(\OC::$server->getConfig());
@@ -120,7 +120,7 @@ 
 	}
 
 	public function __destruct() {
-		if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) {
+		if (!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) {
 			@$this->ldap->unbind($this->ldapConnectionRes);
 			$this->bindResult = [];
 		}
@@ -132,7 +132,7 @@ 
 	public function __clone() {
 		$this->configuration = new Configuration($this->configPrefix,
 												 !is_null($this->configID));
-		if(count($this->bindResult) !== 0 && $this->bindResult['result'] === true) {
+		if (count($this->bindResult) !== 0 && $this->bindResult['result'] === true) {
 			$this->bindResult = [];
 		}
 		$this->ldapConnectionRes = null;
@@ -144,7 +144,7 @@ 
 	 * @return bool|mixed
 	 */
 	public function __get($name) {
-		if(!$this->configured) {
+		if (!$this->configured) {
 			$this->readConfiguration();
 		}
 
@@ -160,7 +160,7 @@ 
 		$before = $this->configuration->$name;
 		$this->configuration->$name = $value;
 		$after = $this->configuration->$name;
-		if($before !== $after) {
+		if ($before !== $after) {
 			if ($this->configID !== '' && $this->configID !== null) {
 				$this->configuration->saveConfiguration();
 			}
@@ -184,7 +184,7 @@ 
 	 * @param bool $state
 	 */
 	public function setIgnoreValidation($state) {
-		$this->ignoreValidation = (bool)$state;
+		$this->ignoreValidation = (bool) $state;
 	}
 
 	/**
@@ -200,14 +200,14 @@ 
 	 * Returns the LDAP handler
 	 */
 	public function getConnectionResource() {
-		if(!$this->ldapConnectionRes) {
+		if (!$this->ldapConnectionRes) {
 			$this->init();
-		} else if(!$this->ldap->isResource($this->ldapConnectionRes)) {
+		} else if (!$this->ldap->isResource($this->ldapConnectionRes)) {
 			$this->ldapConnectionRes = null;
 			$this->establishConnection();
 		}
-		if(is_null($this->ldapConnectionRes)) {
-			\OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, ILogger::ERROR);
+		if (is_null($this->ldapConnectionRes)) {
+			\OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server '.$this->configuration->ldapHost, ILogger::ERROR);
 			throw new ServerNotAvailableException('Connection to LDAP server could not be established');
 		}
 		return $this->ldapConnectionRes;
@@ -217,7 +217,7 @@ 
 	 * resets the connection resource
 	 */
 	public function resetConnectionResource() {
-		if(!is_null($this->ldapConnectionRes)) {
+		if (!is_null($this->ldapConnectionRes)) {
 			@$this->ldap->unbind($this->ldapConnectionRes);
 			$this->ldapConnectionRes = null;
 			$this->bindResult = [];
@@ -230,7 +230,7 @@ 
 	 */
 	private function getCacheKey($key) {
 		$prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
-		if(is_null($key)) {
+		if (is_null($key)) {
 			return $prefix;
 		}
 		return $prefix.hash('sha256', $key);
@@ -241,10 +241,10 @@ 
 	 * @return mixed|null
 	 */
 	public function getFromCache($key) {
-		if(!$this->configured) {
+		if (!$this->configured) {
 			$this->readConfiguration();
 		}
-		if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) {
+		if (is_null($this->cache) || !$this->configuration->ldapCacheTTL) {
 			return null;
 		}
 		$key = $this->getCacheKey($key);
@@ -259,10 +259,10 @@ 
 	 * @return string
 	 */
 	public function writeToCache($key, $value) {
-		if(!$this->configured) {
+		if (!$this->configured) {
 			$this->readConfiguration();
 		}
-		if(is_null($this->cache)
+		if (is_null($this->cache)
 			|| !$this->configuration->ldapCacheTTL
 			|| !$this->configuration->ldapConfigurationActive) {
 			return null;
@@ -273,7 +273,7 @@ 
 	}
 
 	public function clearCache() {
-		if(!is_null($this->cache)) {
+		if (!is_null($this->cache)) {
 			$this->cache->clear($this->getCacheKey(null));
 		}
 	}
@@ -285,7 +285,7 @@ 
 	 * @return null
 	 */
 	private function readConfiguration($force = false) {
-		if((!$this->configured || $force) && !is_null($this->configID)) {
+		if ((!$this->configured || $force) && !is_null($this->configID)) {
 			$this->configuration->readConfiguration();
 			$this->configured = $this->validateConfiguration();
 		}
@@ -298,12 +298,12 @@ 
 	 * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
 	 */
 	public function setConfiguration($config, &$setParameters = null) {
-		if(is_null($setParameters)) {
+		if (is_null($setParameters)) {
 			$setParameters = [];
 		}
 		$this->doNotValidate = false;
 		$this->configuration->setConfiguration($config, $setParameters);
-		if(count($setParameters) > 0) {
+		if (count($setParameters) > 0) {
 			$this->configured = $this->validateConfiguration();
 		}
 
@@ -330,10 +330,10 @@ 
 		$config = $this->configuration->getConfiguration();
 		$cta = $this->configuration->getConfigTranslationArray();
 		$result = [];
-		foreach($cta as $dbkey => $configkey) {
-			switch($configkey) {
+		foreach ($cta as $dbkey => $configkey) {
+			switch ($configkey) {
 				case 'homeFolderNamingRule':
-					if(strpos($config[$configkey], 'attr:') === 0) {
+					if (strpos($config[$configkey], 'attr:') === 0) {
 						$result[$dbkey] = substr($config[$configkey], 5);
 					} else {
 						$result[$dbkey] = '';
@@ -344,7 +344,7 @@ 
 				case 'ldapBaseGroups':
 				case 'ldapAttributesForUserSearch':
 				case 'ldapAttributesForGroupSearch':
-					if(is_array($config[$configkey])) {
+					if (is_array($config[$configkey])) {
 						$result[$dbkey] = implode("\n", $config[$configkey]);
 						break;
 					} //else follows default
@@ -357,23 +357,23 @@ 
 
 	private function doSoftValidation() {
 		//if User or Group Base are not set, take over Base DN setting
-		foreach(['ldapBaseUsers', 'ldapBaseGroups'] as $keyBase) {
+		foreach (['ldapBaseUsers', 'ldapBaseGroups'] as $keyBase) {
 			$val = $this->configuration->$keyBase;
-			if(empty($val)) {
+			if (empty($val)) {
 				$this->configuration->$keyBase = $this->configuration->ldapBase;
 			}
 		}
 
-		foreach(['ldapExpertUUIDUserAttr'  => 'ldapUuidUserAttribute',
+		foreach (['ldapExpertUUIDUserAttr'  => 'ldapUuidUserAttribute',
 			'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute']
 				as $expertSetting => $effectiveSetting) {
 			$uuidOverride = $this->configuration->$expertSetting;
-			if(!empty($uuidOverride)) {
+			if (!empty($uuidOverride)) {
 				$this->configuration->$effectiveSetting = $uuidOverride;
 			} else {
 				$uuidAttributes = Access::UUID_ATTRIBUTES;
 				array_unshift($uuidAttributes, 'auto');
-				if(!in_array($this->configuration->$effectiveSetting,
+				if (!in_array($this->configuration->$effectiveSetting,
 							$uuidAttributes)
 					&& (!is_null($this->configID))) {
 					$this->configuration->$effectiveSetting = 'auto';
@@ -387,7 +387,7 @@ 
 			}
 		}
 
-		$backupPort = (int)$this->configuration->ldapBackupPort;
+		$backupPort = (int) $this->configuration->ldapBackupPort;
 		if ($backupPort <= 0) {
 			$this->configuration->backupPort = $this->configuration->ldapPort;
 		}
@@ -395,14 +395,14 @@ 
 		//make sure empty search attributes are saved as simple, empty array
 		$saKeys = ['ldapAttributesForUserSearch',
 			'ldapAttributesForGroupSearch'];
-		foreach($saKeys as $key) {
+		foreach ($saKeys as $key) {
 			$val = $this->configuration->$key;
-			if(is_array($val) && count($val) === 1 && empty($val[0])) {
+			if (is_array($val) && count($val) === 1 && empty($val[0])) {
 				$this->configuration->$key = [];
 			}
 		}
 
-		if((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
+		if ((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
 			&& $this->configuration->ldapTLS) {
 			$this->configuration->ldapTLS = false;
 			\OCP\Util::writeLog(
@@ -419,15 +419,15 @@ 
 	private function doCriticalValidation() {
 		$configurationOK = true;
 		$errorStr = 'Configuration Error (prefix '.
-			(string)$this->configPrefix .'): ';
+			(string) $this->configPrefix.'): ';
 
 		//options that shall not be empty
 		$options = ['ldapHost', 'ldapPort', 'ldapUserDisplayName',
 			'ldapGroupDisplayName', 'ldapLoginFilter'];
-		foreach($options as $key) {
+		foreach ($options as $key) {
 			$val = $this->configuration->$key;
-			if(empty($val)) {
-				switch($key) {
+			if (empty($val)) {
+				switch ($key) {
 					case 'ldapHost':
 						$subj = 'LDAP Host';
 						break;
@@ -460,12 +460,12 @@ 
 		$agent = $this->configuration->ldapAgentName;
 		$pwd = $this->configuration->ldapAgentPassword;
 		if (
-			($agent === ''  && $pwd !== '')
+			($agent === '' && $pwd !== '')
 			|| ($agent !== '' && $pwd === '')
 		) {
 			\OCP\Util::writeLog(
 				'user_ldap',
-				$errorStr.'either no password is given for the user ' .
+				$errorStr.'either no password is given for the user '.
 					'agent or a password is given, but not an LDAP agent.',
 				ILogger::WARN);
 			$configurationOK = false;
@@ -475,7 +475,7 @@ 
 		$baseUsers = $this->configuration->ldapBaseUsers;
 		$baseGroups = $this->configuration->ldapBaseGroups;
 
-		if(empty($base) && empty($baseUsers) && empty($baseGroups)) {
+		if (empty($base) && empty($baseUsers) && empty($baseGroups)) {
 			\OCP\Util::writeLog(
 				'user_ldap',
 				$errorStr.'Not a single Base DN given.',
@@ -484,7 +484,7 @@ 
 			$configurationOK = false;
 		}
 
-		if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
+		if (mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
 		   === false) {
 			\OCP\Util::writeLog(
 				'user_ldap',
@@ -503,7 +503,7 @@ 
 	 */
 	private function validateConfiguration() {
 
-		if($this->doNotValidate) {
+		if ($this->doNotValidate) {
 			//don't do a validation if it is a new configuration with pure
 			//default values. Will be allowed on changes via __set or
 			//setConfiguration
@@ -526,14 +526,14 @@ 
 	 * @throws ServerNotAvailableException
 	 */
 	private function establishConnection() {
-		if(!$this->configuration->ldapConfigurationActive) {
+		if (!$this->configuration->ldapConfigurationActive) {
 			return null;
 		}
 		static $phpLDAPinstalled = true;
-		if(!$phpLDAPinstalled) {
+		if (!$phpLDAPinstalled) {
 			return false;
 		}
-		if(!$this->ignoreValidation && !$this->configured) {
+		if (!$this->ignoreValidation && !$this->configured) {
 			\OCP\Util::writeLog(
 				'user_ldap',
 				'Configuration is invalid, cannot connect',
@@ -541,8 +541,8 @@ 
 			);
 			return false;
 		}
-		if(!$this->ldapConnectionRes) {
-			if(!$this->ldap->areLDAPFunctionsAvailable()) {
+		if (!$this->ldapConnectionRes) {
+			if (!$this->ldap->areLDAPFunctionsAvailable()) {
 				$phpLDAPinstalled = false;
 				\OCP\Util::writeLog(
 					'user_ldap',
@@ -552,8 +552,8 @@ 
 
 				return false;
 			}
-			if($this->configuration->turnOffCertCheck) {
-				if(putenv('LDAPTLS_REQCERT=never')) {
+			if ($this->configuration->turnOffCertCheck) {
+				if (putenv('LDAPTLS_REQCERT=never')) {
 					\OCP\Util::writeLog('user_ldap',
 						'Turned off SSL certificate validation successfully.',
 						ILogger::DEBUG);
@@ -577,20 +577,20 @@ 
 					return $this->bind();
 				}
 			} catch (ServerNotAvailableException $e) {
-				if(!$isBackupHost) {
+				if (!$isBackupHost) {
 					throw $e;
 				}
 			}
 
 			//if LDAP server is not reachable, try the Backup (Replica!) Server
-			if($isBackupHost || $isOverrideMainServer) {
+			if ($isBackupHost || $isOverrideMainServer) {
 				$this->doConnect($this->configuration->ldapBackupHost,
 								 $this->configuration->ldapBackupPort);
 				$this->bindResult = [];
 				$bindStatus = $this->bind();
 				$error = $this->ldap->isResource($this->ldapConnectionRes) ?
 					$this->ldap->errno($this->ldapConnectionRes) : -1;
-				if($bindStatus && $error === 0 && !$this->getFromCache('overrideMainServer')) {
+				if ($bindStatus && $error === 0 && !$this->getFromCache('overrideMainServer')) {
 					//when bind to backup server succeeded and failed to main server,
 					//skip contacting him until next cache refresh
 					$this->writeToCache('overrideMainServer', true);
@@ -615,17 +615,17 @@ 
 
 		$this->ldapConnectionRes = $this->ldap->connect($host, $port);
 
-		if(!$this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) {
+		if (!$this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) {
 			throw new ServerNotAvailableException('Could not set required LDAP Protocol version.');
 		}
 
-		if(!$this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) {
+		if (!$this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) {
 			throw new ServerNotAvailableException('Could not disable LDAP referrals.');
 		}
 
-		if($this->configuration->ldapTLS) {
-			if(!$this->ldap->startTls($this->ldapConnectionRes)) {
-				throw new ServerNotAvailableException('Start TLS failed, when connecting to LDAP host ' . $host . '.');
+		if ($this->configuration->ldapTLS) {
+			if (!$this->ldap->startTls($this->ldapConnectionRes)) {
+				throw new ServerNotAvailableException('Start TLS failed, when connecting to LDAP host '.$host.'.');
 			}
 		}
 
@@ -636,19 +636,19 @@ 
 	 * Binds to LDAP
 	 */
 	public function bind() {
-		if(!$this->configuration->ldapConfigurationActive) {
+		if (!$this->configuration->ldapConfigurationActive) {
 			return false;
 		}
 		$cr = $this->ldapConnectionRes;
-		if(!$this->ldap->isResource($cr)) {
+		if (!$this->ldap->isResource($cr)) {
 			$cr = $this->getConnectionResource();
 		}
 
-		if(
+		if (
 			count($this->bindResult) !== 0
 			&& $this->bindResult['dn'] === $this->configuration->ldapAgentName
 			&& \OC::$server->getHasher()->verify(
-				$this->configPrefix . $this->configuration->ldapAgentPassword,
+				$this->configPrefix.$this->configuration->ldapAgentPassword,
 				$this->bindResult['hash']
 			)
 		) {
@@ -664,20 +664,20 @@ 
 
 		$this->bindResult = [
 			'dn' => $this->configuration->ldapAgentName,
-			'hash' => \OC::$server->getHasher()->hash($this->configPrefix . $this->configuration->ldapAgentPassword),
+			'hash' => \OC::$server->getHasher()->hash($this->configPrefix.$this->configuration->ldapAgentPassword),
 			'result' => $ldapLogin,
 		];
 
-		if(!$ldapLogin) {
+		if (!$ldapLogin) {
 			$errno = $this->ldap->errno($cr);
 
 			\OCP\Util::writeLog('user_ldap',
-				'Bind failed: ' . $errno . ': ' . $this->ldap->error($cr),
+				'Bind failed: '.$errno.': '.$this->ldap->error($cr),
 				ILogger::WARN);
 
 			// Set to failure mode, if LDAP error code is not LDAP_SUCCESS or LDAP_INVALID_CREDENTIALS
 			// or (needed for Apple Open Directory:) LDAP_INSUFFICIENT_ACCESS
-			if($errno !== 0 && $errno !== 49 && $errno !== 50) {
+			if ($errno !== 0 && $errno !== 49 && $errno !== 50) {
 				$this->ldapConnectionRes = null;
 			}