nextcloud / server

apps/files_sharing/lib/MountProvider.php

Indentation +200 added lines, -200 removed lines

@@ -40,204 +40,204 @@
 use OCP\Share\IShare;
 
 class MountProvider implements IMountProvider {
-	/**
-	 * @var \OCP\IConfig
-	 */
-	protected $config;
-
-	/**
-	 * @var IManager
-	 */
-	protected $shareManager;
-
-	/**
-	 * @var ILogger
-	 */
-	protected $logger;
-
-	/**
-	 * @param \OCP\IConfig $config
-	 * @param IManager $shareManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(IConfig $config, IManager $shareManager, ILogger $logger) {
-		$this->config = $config;
-		$this->shareManager = $shareManager;
-		$this->logger = $logger;
-	}
-
-
-	/**
-	 * Get all mountpoints applicable for the user and check for shares where we need to update the etags
-	 *
-	 * @param \OCP\IUser $user
-	 * @param \OCP\Files\Storage\IStorageFactory $loader
-	 * @return \OCP\Files\Mount\IMountPoint[]
-	 */
-	public function getMountsForUser(IUser $user, IStorageFactory $loader) {
-		$shares = $this->shareManager->getSharedWith($user->getUID(), IShare::TYPE_USER, null, -1);
-		$shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), IShare::TYPE_GROUP, null, -1));
-		$shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), IShare::TYPE_CIRCLE, null, -1));
-		$shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), IShare::TYPE_ROOM, null, -1));
-
-		// filter out excluded shares and group shares that includes self
-		$shares = array_filter($shares, function (\OCP\Share\IShare $share) use ($user) {
-			return $share->getPermissions() > 0 && $share->getShareOwner() !== $user->getUID();
-		});
-
-		$superShares = $this->buildSuperShares($shares, $user);
-
-		$mounts = [];
-		$view = new View('/' . $user->getUID() . '/files');
-		$ownerViews = [];
-		$sharingDisabledForUser = $this->shareManager->sharingDisabledForUser($user->getUID());
-		$foldersExistCache = new CappedMemoryCache();
-		foreach ($superShares as $share) {
-			try {
-				/** @var \OCP\Share\IShare $parentShare */
-				$parentShare = $share[0];
-
-				if ($parentShare->getStatus() !== IShare::STATUS_ACCEPTED &&
-					($parentShare->getShareType() === IShare::TYPE_GROUP ||
-						$parentShare->getShareType() === IShare::TYPE_USERGROUP ||
-						$parentShare->getShareType() === IShare::TYPE_USER)) {
-					continue;
-				}
-
-				$owner = $parentShare->getShareOwner();
-				if (!isset($ownerViews[$owner])) {
-					$ownerViews[$owner] = new View('/' . $parentShare->getShareOwner() . '/files');
-				}
-				$mount = new SharedMount(
-					'\OCA\Files_Sharing\SharedStorage',
-					$mounts,
-					[
-						'user' => $user->getUID(),
-						// parent share
-						'superShare' => $parentShare,
-						// children/component of the superShare
-						'groupedShares' => $share[1],
-						'ownerView' => $ownerViews[$owner],
-						'sharingDisabledForUser' => $sharingDisabledForUser
-					],
-					$loader,
-					$view,
-					$foldersExistCache
-				);
-				$mounts[$mount->getMountPoint()] = $mount;
-			} catch (\Exception $e) {
-				$this->logger->logException($e);
-				$this->logger->error('Error while trying to create shared mount');
-			}
-		}
-
-		// array_filter removes the null values from the array
-		return array_values(array_filter($mounts));
-	}
-
-	/**
-	 * Groups shares by path (nodeId) and target path
-	 *
-	 * @param \OCP\Share\IShare[] $shares
-	 * @return \OCP\Share\IShare[][] array of grouped shares, each element in the
-	 * array is a group which itself is an array of shares
-	 */
-	private function groupShares(array $shares) {
-		$tmp = [];
-
-		foreach ($shares as $share) {
-			if (!isset($tmp[$share->getNodeId()])) {
-				$tmp[$share->getNodeId()] = [];
-			}
-			$tmp[$share->getNodeId()][] = $share;
-		}
-
-		$result = [];
-		// sort by stime, the super share will be based on the least recent share
-		foreach ($tmp as &$tmp2) {
-			@usort($tmp2, function ($a, $b) {
-				$aTime = $a->getShareTime()->getTimestamp();
-				$bTime = $b->getShareTime()->getTimestamp();
-				if ($aTime === $bTime) {
-					return $a->getId() < $b->getId() ? -1 : 1;
-				}
-				return $aTime < $bTime ? -1 : 1;
-			});
-			$result[] = $tmp2;
-		}
-
-		return array_values($result);
-	}
-
-	/**
-	 * Build super shares (virtual share) by grouping them by node id and target,
-	 * then for each group compute the super share and return it along with the matching
-	 * grouped shares. The most permissive permissions are used based on the permissions
-	 * of all shares within the group.
-	 *
-	 * @param \OCP\Share\IShare[] $allShares
-	 * @param \OCP\IUser $user user
-	 * @return array Tuple of [superShare, groupedShares]
-	 */
-	private function buildSuperShares(array $allShares, \OCP\IUser $user) {
-		$result = [];
-
-		$groupedShares = $this->groupShares($allShares);
-
-		/** @var \OCP\Share\IShare[] $shares */
-		foreach ($groupedShares as $shares) {
-			if (count($shares) === 0) {
-				continue;
-			}
-
-			$superShare = $this->shareManager->newShare();
-
-			// compute super share based on first entry of the group
-			$superShare->setId($shares[0]->getId())
-				->setShareOwner($shares[0]->getShareOwner())
-				->setNodeId($shares[0]->getNodeId())
-				->setShareType($shares[0]->getShareType())
-				->setTarget($shares[0]->getTarget());
-
-			// use most permissive permissions
-			$permissions = 0;
-			$status = IShare::STATUS_PENDING;
-			foreach ($shares as $share) {
-				$permissions |= $share->getPermissions();
-				$status = max($status, $share->getStatus());
-
-				if ($share->getTarget() !== $superShare->getTarget()) {
-					// adjust target, for database consistency
-					$share->setTarget($superShare->getTarget());
-					try {
-						$this->shareManager->moveShare($share, $user->getUID());
-					} catch (\InvalidArgumentException $e) {
-						// ignore as it is not important and we don't want to
-						// block FS setup
-
-						// the subsequent code anyway only uses the target of the
-						// super share
-
-						// such issue can usually happen when dealing with
-						// null groups which usually appear with group backend
-						// caching inconsistencies
-						$this->logger->debug(
-							'Could not adjust share target for share ' . $share->getId() . ' to make it consistent: ' . $e->getMessage(),
-							['app' => 'files_sharing']
-						);
-					}
-				}
-				if (!is_null($share->getNodeCacheEntry())) {
-					$superShare->setNodeCacheEntry($share->getNodeCacheEntry());
-				}
-			}
-
-			$superShare->setPermissions($permissions)
-				->setStatus($status);
-
-			$result[] = [$superShare, $shares];
-		}
-
-		return $result;
-	}
+    /**
+     * @var \OCP\IConfig
+     */
+    protected $config;
+
+    /**
+     * @var IManager
+     */
+    protected $shareManager;
+
+    /**
+     * @var ILogger
+     */
+    protected $logger;
+
+    /**
+     * @param \OCP\IConfig $config
+     * @param IManager $shareManager
+     * @param ILogger $logger
+     */
+    public function __construct(IConfig $config, IManager $shareManager, ILogger $logger) {
+        $this->config = $config;
+        $this->shareManager = $shareManager;
+        $this->logger = $logger;
+    }
+
+
+    /**
+     * Get all mountpoints applicable for the user and check for shares where we need to update the etags
+     *
+     * @param \OCP\IUser $user
+     * @param \OCP\Files\Storage\IStorageFactory $loader
+     * @return \OCP\Files\Mount\IMountPoint[]
+     */
+    public function getMountsForUser(IUser $user, IStorageFactory $loader) {
+        $shares = $this->shareManager->getSharedWith($user->getUID(), IShare::TYPE_USER, null, -1);
+        $shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), IShare::TYPE_GROUP, null, -1));
+        $shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), IShare::TYPE_CIRCLE, null, -1));
+        $shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), IShare::TYPE_ROOM, null, -1));
+
+        // filter out excluded shares and group shares that includes self
+        $shares = array_filter($shares, function (\OCP\Share\IShare $share) use ($user) {
+            return $share->getPermissions() > 0 && $share->getShareOwner() !== $user->getUID();
+        });
+
+        $superShares = $this->buildSuperShares($shares, $user);
+
+        $mounts = [];
+        $view = new View('/' . $user->getUID() . '/files');
+        $ownerViews = [];
+        $sharingDisabledForUser = $this->shareManager->sharingDisabledForUser($user->getUID());
+        $foldersExistCache = new CappedMemoryCache();
+        foreach ($superShares as $share) {
+            try {
+                /** @var \OCP\Share\IShare $parentShare */
+                $parentShare = $share[0];
+
+                if ($parentShare->getStatus() !== IShare::STATUS_ACCEPTED &&
+                    ($parentShare->getShareType() === IShare::TYPE_GROUP ||
+                        $parentShare->getShareType() === IShare::TYPE_USERGROUP ||
+                        $parentShare->getShareType() === IShare::TYPE_USER)) {
+                    continue;
+                }
+
+                $owner = $parentShare->getShareOwner();
+                if (!isset($ownerViews[$owner])) {
+                    $ownerViews[$owner] = new View('/' . $parentShare->getShareOwner() . '/files');
+                }
+                $mount = new SharedMount(
+                    '\OCA\Files_Sharing\SharedStorage',
+                    $mounts,
+                    [
+                        'user' => $user->getUID(),
+                        // parent share
+                        'superShare' => $parentShare,
+                        // children/component of the superShare
+                        'groupedShares' => $share[1],
+                        'ownerView' => $ownerViews[$owner],
+                        'sharingDisabledForUser' => $sharingDisabledForUser
+                    ],
+                    $loader,
+                    $view,
+                    $foldersExistCache
+                );
+                $mounts[$mount->getMountPoint()] = $mount;
+            } catch (\Exception $e) {
+                $this->logger->logException($e);
+                $this->logger->error('Error while trying to create shared mount');
+            }
+        }
+
+        // array_filter removes the null values from the array
+        return array_values(array_filter($mounts));
+    }
+
+    /**
+     * Groups shares by path (nodeId) and target path
+     *
+     * @param \OCP\Share\IShare[] $shares
+     * @return \OCP\Share\IShare[][] array of grouped shares, each element in the
+     * array is a group which itself is an array of shares
+     */
+    private function groupShares(array $shares) {
+        $tmp = [];
+
+        foreach ($shares as $share) {
+            if (!isset($tmp[$share->getNodeId()])) {
+                $tmp[$share->getNodeId()] = [];
+            }
+            $tmp[$share->getNodeId()][] = $share;
+        }
+
+        $result = [];
+        // sort by stime, the super share will be based on the least recent share
+        foreach ($tmp as &$tmp2) {
+            @usort($tmp2, function ($a, $b) {
+                $aTime = $a->getShareTime()->getTimestamp();
+                $bTime = $b->getShareTime()->getTimestamp();
+                if ($aTime === $bTime) {
+                    return $a->getId() < $b->getId() ? -1 : 1;
+                }
+                return $aTime < $bTime ? -1 : 1;
+            });
+            $result[] = $tmp2;
+        }
+
+        return array_values($result);
+    }
+
+    /**
+     * Build super shares (virtual share) by grouping them by node id and target,
+     * then for each group compute the super share and return it along with the matching
+     * grouped shares. The most permissive permissions are used based on the permissions
+     * of all shares within the group.
+     *
+     * @param \OCP\Share\IShare[] $allShares
+     * @param \OCP\IUser $user user
+     * @return array Tuple of [superShare, groupedShares]
+     */
+    private function buildSuperShares(array $allShares, \OCP\IUser $user) {
+        $result = [];
+
+        $groupedShares = $this->groupShares($allShares);
+
+        /** @var \OCP\Share\IShare[] $shares */
+        foreach ($groupedShares as $shares) {
+            if (count($shares) === 0) {
+                continue;
+            }
+
+            $superShare = $this->shareManager->newShare();
+
+            // compute super share based on first entry of the group
+            $superShare->setId($shares[0]->getId())
+                ->setShareOwner($shares[0]->getShareOwner())
+                ->setNodeId($shares[0]->getNodeId())
+                ->setShareType($shares[0]->getShareType())
+                ->setTarget($shares[0]->getTarget());
+
+            // use most permissive permissions
+            $permissions = 0;
+            $status = IShare::STATUS_PENDING;
+            foreach ($shares as $share) {
+                $permissions |= $share->getPermissions();
+                $status = max($status, $share->getStatus());
+
+                if ($share->getTarget() !== $superShare->getTarget()) {
+                    // adjust target, for database consistency
+                    $share->setTarget($superShare->getTarget());
+                    try {
+                        $this->shareManager->moveShare($share, $user->getUID());
+                    } catch (\InvalidArgumentException $e) {
+                        // ignore as it is not important and we don't want to
+                        // block FS setup
+
+                        // the subsequent code anyway only uses the target of the
+                        // super share
+
+                        // such issue can usually happen when dealing with
+                        // null groups which usually appear with group backend
+                        // caching inconsistencies
+                        $this->logger->debug(
+                            'Could not adjust share target for share ' . $share->getId() . ' to make it consistent: ' . $e->getMessage(),
+                            ['app' => 'files_sharing']
+                        );
+                    }
+                }
+                if (!is_null($share->getNodeCacheEntry())) {
+                    $superShare->setNodeCacheEntry($share->getNodeCacheEntry());
+                }
+            }
+
+            $superShare->setPermissions($permissions)
+                ->setStatus($status);
+
+            $result[] = [$superShare, $shares];
+        }
+
+        return $result;
+    }
 }

lib/private/Authentication/Token/IProvider.php

Indentation +146 added lines, -146 removed lines

@@ -38,150 +38,150 @@
 interface IProvider {
 
 
-	/**
-	 * Create and persist a new token
-	 *
-	 * @param string $token
-	 * @param string $uid
-	 * @param string $loginName
-	 * @param string|null $password
-	 * @param string $name
-	 * @param int $type token type
-	 * @param int $remember whether the session token should be used for remember-me
-	 * @return IToken
-	 * @throws \RuntimeException when OpenSSL reports a problem
-	 */
-	public function generateToken(string $token,
-								  string $uid,
-								  string $loginName,
-								  $password,
-								  string $name,
-								  int $type = IToken::TEMPORARY_TOKEN,
-								  int $remember = IToken::DO_NOT_REMEMBER): IToken;
-
-	/**
-	 * Get a token by token id
-	 *
-	 * @param string $tokenId
-	 * @throws InvalidTokenException
-	 * @throws ExpiredTokenException
-	 * @throws WipeTokenException
-	 * @return IToken
-	 */
-	public function getToken(string $tokenId): IToken;
-
-	/**
-	 * Get a token by token id
-	 *
-	 * @param int $tokenId
-	 * @throws InvalidTokenException
-	 * @throws ExpiredTokenException
-	 * @throws WipeTokenException
-	 * @return IToken
-	 */
-	public function getTokenById(int $tokenId): IToken;
-
-	/**
-	 * Duplicate an existing session token
-	 *
-	 * @param string $oldSessionId
-	 * @param string $sessionId
-	 * @throws InvalidTokenException
-	 * @throws \RuntimeException when OpenSSL reports a problem
-	 * @return IToken The new token
-	 */
-	public function renewSessionToken(string $oldSessionId, string $sessionId): IToken;
-
-	/**
-	 * Invalidate (delete) the given session token
-	 *
-	 * @param string $token
-	 */
-	public function invalidateToken(string $token);
-
-	/**
-	 * Invalidate (delete) the given token
-	 *
-	 * @param string $uid
-	 * @param int $id
-	 */
-	public function invalidateTokenById(string $uid, int $id);
-
-	/**
-	 * Invalidate (delete) old session tokens
-	 */
-	public function invalidateOldTokens();
-
-	/**
-	 * Save the updated token
-	 *
-	 * @param IToken $token
-	 */
-	public function updateToken(IToken $token);
-
-	/**
-	 * Update token activity timestamp
-	 *
-	 * @param IToken $token
-	 */
-	public function updateTokenActivity(IToken $token);
-
-	/**
-	 * Get all tokens of a user
-	 *
-	 * The provider may limit the number of result rows in case of an abuse
-	 * where a high number of (session) tokens is generated
-	 *
-	 * @param string $uid
-	 * @return IToken[]
-	 */
-	public function getTokenByUser(string $uid): array;
-
-	/**
-	 * Get the (unencrypted) password of the given token
-	 *
-	 * @param IToken $savedToken
-	 * @param string $tokenId
-	 * @throws InvalidTokenException
-	 * @throws PasswordlessTokenException
-	 * @return string
-	 */
-	public function getPassword(IToken $savedToken, string $tokenId): string;
-
-	/**
-	 * Encrypt and set the password of the given token
-	 *
-	 * @param IToken $token
-	 * @param string $tokenId
-	 * @param string $password
-	 * @throws InvalidTokenException
-	 */
-	public function setPassword(IToken $token, string $tokenId, string $password);
-
-	/**
-	 * Rotate the token. Usefull for for example oauth tokens
-	 *
-	 * @param IToken $token
-	 * @param string $oldTokenId
-	 * @param string $newTokenId
-	 * @return IToken
-	 * @throws \RuntimeException when OpenSSL reports a problem
-	 */
-	public function rotate(IToken $token, string $oldTokenId, string $newTokenId): IToken;
-
-	/**
-	 * Marks a token as having an invalid password.
-	 *
-	 * @param IToken $token
-	 * @param string $tokenId
-	 */
-	public function markPasswordInvalid(IToken $token, string $tokenId);
-
-	/**
-	 * Update all the passwords of $uid if required
-	 *
-	 * @param string $uid
-	 * @param string $password
-	 */
-	public function updatePasswords(string $uid, string $password);
+    /**
+     * Create and persist a new token
+     *
+     * @param string $token
+     * @param string $uid
+     * @param string $loginName
+     * @param string|null $password
+     * @param string $name
+     * @param int $type token type
+     * @param int $remember whether the session token should be used for remember-me
+     * @return IToken
+     * @throws \RuntimeException when OpenSSL reports a problem
+     */
+    public function generateToken(string $token,
+                                    string $uid,
+                                    string $loginName,
+                                    $password,
+                                    string $name,
+                                    int $type = IToken::TEMPORARY_TOKEN,
+                                    int $remember = IToken::DO_NOT_REMEMBER): IToken;
+
+    /**
+     * Get a token by token id
+     *
+     * @param string $tokenId
+     * @throws InvalidTokenException
+     * @throws ExpiredTokenException
+     * @throws WipeTokenException
+     * @return IToken
+     */
+    public function getToken(string $tokenId): IToken;
+
+    /**
+     * Get a token by token id
+     *
+     * @param int $tokenId
+     * @throws InvalidTokenException
+     * @throws ExpiredTokenException
+     * @throws WipeTokenException
+     * @return IToken
+     */
+    public function getTokenById(int $tokenId): IToken;
+
+    /**
+     * Duplicate an existing session token
+     *
+     * @param string $oldSessionId
+     * @param string $sessionId
+     * @throws InvalidTokenException
+     * @throws \RuntimeException when OpenSSL reports a problem
+     * @return IToken The new token
+     */
+    public function renewSessionToken(string $oldSessionId, string $sessionId): IToken;
+
+    /**
+     * Invalidate (delete) the given session token
+     *
+     * @param string $token
+     */
+    public function invalidateToken(string $token);
+
+    /**
+     * Invalidate (delete) the given token
+     *
+     * @param string $uid
+     * @param int $id
+     */
+    public function invalidateTokenById(string $uid, int $id);
+
+    /**
+     * Invalidate (delete) old session tokens
+     */
+    public function invalidateOldTokens();
+
+    /**
+     * Save the updated token
+     *
+     * @param IToken $token
+     */
+    public function updateToken(IToken $token);
+
+    /**
+     * Update token activity timestamp
+     *
+     * @param IToken $token
+     */
+    public function updateTokenActivity(IToken $token);
+
+    /**
+     * Get all tokens of a user
+     *
+     * The provider may limit the number of result rows in case of an abuse
+     * where a high number of (session) tokens is generated
+     *
+     * @param string $uid
+     * @return IToken[]
+     */
+    public function getTokenByUser(string $uid): array;
+
+    /**
+     * Get the (unencrypted) password of the given token
+     *
+     * @param IToken $savedToken
+     * @param string $tokenId
+     * @throws InvalidTokenException
+     * @throws PasswordlessTokenException
+     * @return string
+     */
+    public function getPassword(IToken $savedToken, string $tokenId): string;
+
+    /**
+     * Encrypt and set the password of the given token
+     *
+     * @param IToken $token
+     * @param string $tokenId
+     * @param string $password
+     * @throws InvalidTokenException
+     */
+    public function setPassword(IToken $token, string $tokenId, string $password);
+
+    /**
+     * Rotate the token. Usefull for for example oauth tokens
+     *
+     * @param IToken $token
+     * @param string $oldTokenId
+     * @param string $newTokenId
+     * @return IToken
+     * @throws \RuntimeException when OpenSSL reports a problem
+     */
+    public function rotate(IToken $token, string $oldTokenId, string $newTokenId): IToken;
+
+    /**
+     * Marks a token as having an invalid password.
+     *
+     * @param IToken $token
+     * @param string $tokenId
+     */
+    public function markPasswordInvalid(IToken $token, string $tokenId);
+
+    /**
+     * Update all the passwords of $uid if required
+     *
+     * @param string $uid
+     * @param string $password
+     */
+    public function updatePasswords(string $uid, string $password);
 }

lib/private/Authentication/Token/PublicKeyTokenProvider.php

Indentation +388 added lines, -388 removed lines

@@ -42,392 +42,392 @@
 use OCP\Security\ICrypto;
 
 class PublicKeyTokenProvider implements IProvider {
-	/** @var PublicKeyTokenMapper */
-	private $mapper;
-
-	/** @var ICrypto */
-	private $crypto;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var ILogger $logger */
-	private $logger;
-
-	/** @var ITimeFactory $time */
-	private $time;
-
-	/** @var CappedMemoryCache */
-	private $cache;
-
-	public function __construct(PublicKeyTokenMapper $mapper,
-								ICrypto $crypto,
-								IConfig $config,
-								ILogger $logger,
-								ITimeFactory $time) {
-		$this->mapper = $mapper;
-		$this->crypto = $crypto;
-		$this->config = $config;
-		$this->logger = $logger;
-		$this->time = $time;
-
-		$this->cache = new CappedMemoryCache();
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	public function generateToken(string $token,
-								  string $uid,
-								  string $loginName,
-								  $password,
-								  string $name,
-								  int $type = IToken::TEMPORARY_TOKEN,
-								  int $remember = IToken::DO_NOT_REMEMBER): IToken {
-		$dbToken = $this->newToken($token, $uid, $loginName, $password, $name, $type, $remember);
-		$this->mapper->insert($dbToken);
-
-		// Add the token to the cache
-		$this->cache[$dbToken->getToken()] = $dbToken;
-
-		return $dbToken;
-	}
-
-	public function getToken(string $tokenId): IToken {
-		$tokenHash = $this->hashToken($tokenId);
-
-		if (isset($this->cache[$tokenHash])) {
-			$token = $this->cache[$tokenHash];
-		} else {
-			try {
-				$token = $this->mapper->getToken($this->hashToken($tokenId));
-				$this->cache[$token->getToken()] = $token;
-			} catch (DoesNotExistException $ex) {
-				throw new InvalidTokenException("Token does not exist: " . $ex->getMessage(), 0, $ex);
-			}
-		}
-
-		if ((int)$token->getExpires() !== 0 && $token->getExpires() < $this->time->getTime()) {
-			throw new ExpiredTokenException($token);
-		}
-
-		if ($token->getType() === IToken::WIPE_TOKEN) {
-			throw new WipeTokenException($token);
-		}
-
-		if ($token->getPasswordInvalid() === true) {
-			//The password is invalid we should throw an TokenPasswordExpiredException
-			throw new TokenPasswordExpiredException($token);
-		}
-
-		return $token;
-	}
-
-	public function getTokenById(int $tokenId): IToken {
-		try {
-			$token = $this->mapper->getTokenById($tokenId);
-		} catch (DoesNotExistException $ex) {
-			throw new InvalidTokenException("Token with ID $tokenId does not exist: " . $ex->getMessage(), 0, $ex);
-		}
-
-		if ((int)$token->getExpires() !== 0 && $token->getExpires() < $this->time->getTime()) {
-			throw new ExpiredTokenException($token);
-		}
-
-		if ($token->getType() === IToken::WIPE_TOKEN) {
-			throw new WipeTokenException($token);
-		}
-
-		if ($token->getPasswordInvalid() === true) {
-			//The password is invalid we should throw an TokenPasswordExpiredException
-			throw new TokenPasswordExpiredException($token);
-		}
-
-		return $token;
-	}
-
-	public function renewSessionToken(string $oldSessionId, string $sessionId): IToken {
-		$this->cache->clear();
-
-		$token = $this->getToken($oldSessionId);
-
-		if (!($token instanceof PublicKeyToken)) {
-			throw new InvalidTokenException("Invalid token type");
-		}
-
-		$password = null;
-		if (!is_null($token->getPassword())) {
-			$privateKey = $this->decrypt($token->getPrivateKey(), $oldSessionId);
-			$password = $this->decryptPassword($token->getPassword(), $privateKey);
-		}
-
-		$newToken = $this->generateToken(
-			$sessionId,
-			$token->getUID(),
-			$token->getLoginName(),
-			$password,
-			$token->getName(),
-			IToken::TEMPORARY_TOKEN,
-			$token->getRemember()
-		);
-
-		$this->mapper->delete($token);
-
-		return $newToken;
-	}
-
-	public function invalidateToken(string $token) {
-		$this->cache->clear();
-
-		$this->mapper->invalidate($this->hashToken($token));
-	}
-
-	public function invalidateTokenById(string $uid, int $id) {
-		$this->cache->clear();
-
-		$this->mapper->deleteById($uid, $id);
-	}
-
-	public function invalidateOldTokens() {
-		$this->cache->clear();
-
-		$olderThan = $this->time->getTime() - (int) $this->config->getSystemValue('session_lifetime', 60 * 60 * 24);
-		$this->logger->debug('Invalidating session tokens older than ' . date('c', $olderThan), ['app' => 'cron']);
-		$this->mapper->invalidateOld($olderThan, IToken::DO_NOT_REMEMBER);
-		$rememberThreshold = $this->time->getTime() - (int) $this->config->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
-		$this->logger->debug('Invalidating remembered session tokens older than ' . date('c', $rememberThreshold), ['app' => 'cron']);
-		$this->mapper->invalidateOld($rememberThreshold, IToken::REMEMBER);
-	}
-
-	public function updateToken(IToken $token) {
-		$this->cache->clear();
-
-		if (!($token instanceof PublicKeyToken)) {
-			throw new InvalidTokenException("Invalid token type");
-		}
-		$this->mapper->update($token);
-	}
-
-	public function updateTokenActivity(IToken $token) {
-		$this->cache->clear();
-
-		if (!($token instanceof PublicKeyToken)) {
-			throw new InvalidTokenException("Invalid token type");
-		}
-		/** @var DefaultToken $token */
-		$now = $this->time->getTime();
-		if ($token->getLastActivity() < ($now - 60)) {
-			// Update token only once per minute
-			$token->setLastActivity($now);
-			$this->mapper->update($token);
-		}
-	}
-
-	public function getTokenByUser(string $uid): array {
-		return $this->mapper->getTokenByUser($uid);
-	}
-
-	public function getPassword(IToken $savedToken, string $tokenId): string {
-		if (!($savedToken instanceof PublicKeyToken)) {
-			throw new InvalidTokenException("Invalid token type");
-		}
-
-		if ($savedToken->getPassword() === null) {
-			throw new PasswordlessTokenException();
-		}
-
-		// Decrypt private key with tokenId
-		$privateKey = $this->decrypt($savedToken->getPrivateKey(), $tokenId);
-
-		// Decrypt password with private key
-		return $this->decryptPassword($savedToken->getPassword(), $privateKey);
-	}
-
-	public function setPassword(IToken $token, string $tokenId, string $password) {
-		$this->cache->clear();
-
-		if (!($token instanceof PublicKeyToken)) {
-			throw new InvalidTokenException("Invalid token type");
-		}
-
-		// When changing passwords all temp tokens are deleted
-		$this->mapper->deleteTempToken($token);
-
-		// Update the password for all tokens
-		$tokens = $this->mapper->getTokenByUser($token->getUID());
-		foreach ($tokens as $t) {
-			$publicKey = $t->getPublicKey();
-			$t->setPassword($this->encryptPassword($password, $publicKey));
-			$this->updateToken($t);
-		}
-	}
-
-	public function rotate(IToken $token, string $oldTokenId, string $newTokenId): IToken {
-		$this->cache->clear();
-
-		if (!($token instanceof PublicKeyToken)) {
-			throw new InvalidTokenException("Invalid token type");
-		}
-
-		// Decrypt private key with oldTokenId
-		$privateKey = $this->decrypt($token->getPrivateKey(), $oldTokenId);
-		// Encrypt with the new token
-		$token->setPrivateKey($this->encrypt($privateKey, $newTokenId));
-
-		$token->setToken($this->hashToken($newTokenId));
-		$this->updateToken($token);
-
-		return $token;
-	}
-
-	private function encrypt(string $plaintext, string $token): string {
-		$secret = $this->config->getSystemValue('secret');
-		return $this->crypto->encrypt($plaintext, $token . $secret);
-	}
-
-	/**
-	 * @throws InvalidTokenException
-	 */
-	private function decrypt(string $cipherText, string $token): string {
-		$secret = $this->config->getSystemValue('secret');
-		try {
-			return $this->crypto->decrypt($cipherText, $token . $secret);
-		} catch (\Exception $ex) {
-			// Delete the invalid token
-			$this->invalidateToken($token);
-			throw new InvalidTokenException("Could not decrypt token password: " . $ex->getMessage(), 0, $ex);
-		}
-	}
-
-	private function encryptPassword(string $password, string $publicKey): string {
-		openssl_public_encrypt($password, $encryptedPassword, $publicKey, OPENSSL_PKCS1_OAEP_PADDING);
-		$encryptedPassword = base64_encode($encryptedPassword);
-
-		return $encryptedPassword;
-	}
-
-	private function decryptPassword(string $encryptedPassword, string $privateKey): string {
-		$encryptedPassword = base64_decode($encryptedPassword);
-		openssl_private_decrypt($encryptedPassword, $password, $privateKey, OPENSSL_PKCS1_OAEP_PADDING);
-
-		return $password;
-	}
-
-	private function hashToken(string $token): string {
-		$secret = $this->config->getSystemValue('secret');
-		return hash('sha512', $token . $secret);
-	}
-
-	/**
-	 * Convert a DefaultToken to a publicKeyToken
-	 * This will also be updated directly in the Database
-	 * @throws \RuntimeException when OpenSSL reports a problem
-	 */
-	public function convertToken(DefaultToken $defaultToken, string $token, $password): PublicKeyToken {
-		$this->cache->clear();
-
-		$pkToken = $this->newToken(
-			$token,
-			$defaultToken->getUID(),
-			$defaultToken->getLoginName(),
-			$password,
-			$defaultToken->getName(),
-			$defaultToken->getType(),
-			$defaultToken->getRemember()
-		);
-
-		$pkToken->setExpires($defaultToken->getExpires());
-		$pkToken->setId($defaultToken->getId());
-
-		return $this->mapper->update($pkToken);
-	}
-
-	/**
-	 * @throws \RuntimeException when OpenSSL reports a problem
-	 */
-	private function newToken(string $token,
-							  string $uid,
-							  string $loginName,
-							  $password,
-							  string $name,
-							  int $type,
-							  int $remember): PublicKeyToken {
-		$dbToken = new PublicKeyToken();
-		$dbToken->setUid($uid);
-		$dbToken->setLoginName($loginName);
-
-		$config = array_merge([
-			'digest_alg' => 'sha512',
-			'private_key_bits' => 2048,
-		], $this->config->getSystemValue('openssl', []));
-
-		// Generate new key
-		$res = openssl_pkey_new($config);
-		if ($res === false) {
-			$this->logOpensslError();
-			throw new \RuntimeException('OpenSSL reported a problem');
-		}
-
-		if (openssl_pkey_export($res, $privateKey, null, $config) === false) {
-			$this->logOpensslError();
-			throw new \RuntimeException('OpenSSL reported a problem');
-		}
-
-		// Extract the public key from $res to $pubKey
-		$publicKey = openssl_pkey_get_details($res);
-		$publicKey = $publicKey['key'];
-
-		$dbToken->setPublicKey($publicKey);
-		$dbToken->setPrivateKey($this->encrypt($privateKey, $token));
-
-		if (!is_null($password)) {
-			$dbToken->setPassword($this->encryptPassword($password, $publicKey));
-		}
-
-		$dbToken->setName($name);
-		$dbToken->setToken($this->hashToken($token));
-		$dbToken->setType($type);
-		$dbToken->setRemember($remember);
-		$dbToken->setLastActivity($this->time->getTime());
-		$dbToken->setLastCheck($this->time->getTime());
-		$dbToken->setVersion(PublicKeyToken::VERSION);
-
-		return $dbToken;
-	}
-
-	public function markPasswordInvalid(IToken $token, string $tokenId) {
-		$this->cache->clear();
-
-		if (!($token instanceof PublicKeyToken)) {
-			throw new InvalidTokenException("Invalid token type");
-		}
-
-		$token->setPasswordInvalid(true);
-		$this->mapper->update($token);
-	}
-
-	public function updatePasswords(string $uid, string $password) {
-		$this->cache->clear();
-
-		if (!$this->mapper->hasExpiredTokens($uid)) {
-			// Nothing to do here
-			return;
-		}
-
-		// Update the password for all tokens
-		$tokens = $this->mapper->getTokenByUser($uid);
-		foreach ($tokens as $t) {
-			$publicKey = $t->getPublicKey();
-			$t->setPassword($this->encryptPassword($password, $publicKey));
-			$this->updateToken($t);
-		}
-	}
-
-	private function logOpensslError() {
-		$errors = [];
-		while ($error = openssl_error_string()) {
-			$errors[] = $error;
-		}
-		$this->logger->critical('Something is wrong with your openssl setup: ' . implode(', ', $errors));
-	}
+    /** @var PublicKeyTokenMapper */
+    private $mapper;
+
+    /** @var ICrypto */
+    private $crypto;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var ILogger $logger */
+    private $logger;
+
+    /** @var ITimeFactory $time */
+    private $time;
+
+    /** @var CappedMemoryCache */
+    private $cache;
+
+    public function __construct(PublicKeyTokenMapper $mapper,
+                                ICrypto $crypto,
+                                IConfig $config,
+                                ILogger $logger,
+                                ITimeFactory $time) {
+        $this->mapper = $mapper;
+        $this->crypto = $crypto;
+        $this->config = $config;
+        $this->logger = $logger;
+        $this->time = $time;
+
+        $this->cache = new CappedMemoryCache();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function generateToken(string $token,
+                                    string $uid,
+                                    string $loginName,
+                                    $password,
+                                    string $name,
+                                    int $type = IToken::TEMPORARY_TOKEN,
+                                    int $remember = IToken::DO_NOT_REMEMBER): IToken {
+        $dbToken = $this->newToken($token, $uid, $loginName, $password, $name, $type, $remember);
+        $this->mapper->insert($dbToken);
+
+        // Add the token to the cache
+        $this->cache[$dbToken->getToken()] = $dbToken;
+
+        return $dbToken;
+    }
+
+    public function getToken(string $tokenId): IToken {
+        $tokenHash = $this->hashToken($tokenId);
+
+        if (isset($this->cache[$tokenHash])) {
+            $token = $this->cache[$tokenHash];
+        } else {
+            try {
+                $token = $this->mapper->getToken($this->hashToken($tokenId));
+                $this->cache[$token->getToken()] = $token;
+            } catch (DoesNotExistException $ex) {
+                throw new InvalidTokenException("Token does not exist: " . $ex->getMessage(), 0, $ex);
+            }
+        }
+
+        if ((int)$token->getExpires() !== 0 && $token->getExpires() < $this->time->getTime()) {
+            throw new ExpiredTokenException($token);
+        }
+
+        if ($token->getType() === IToken::WIPE_TOKEN) {
+            throw new WipeTokenException($token);
+        }
+
+        if ($token->getPasswordInvalid() === true) {
+            //The password is invalid we should throw an TokenPasswordExpiredException
+            throw new TokenPasswordExpiredException($token);
+        }
+
+        return $token;
+    }
+
+    public function getTokenById(int $tokenId): IToken {
+        try {
+            $token = $this->mapper->getTokenById($tokenId);
+        } catch (DoesNotExistException $ex) {
+            throw new InvalidTokenException("Token with ID $tokenId does not exist: " . $ex->getMessage(), 0, $ex);
+        }
+
+        if ((int)$token->getExpires() !== 0 && $token->getExpires() < $this->time->getTime()) {
+            throw new ExpiredTokenException($token);
+        }
+
+        if ($token->getType() === IToken::WIPE_TOKEN) {
+            throw new WipeTokenException($token);
+        }
+
+        if ($token->getPasswordInvalid() === true) {
+            //The password is invalid we should throw an TokenPasswordExpiredException
+            throw new TokenPasswordExpiredException($token);
+        }
+
+        return $token;
+    }
+
+    public function renewSessionToken(string $oldSessionId, string $sessionId): IToken {
+        $this->cache->clear();
+
+        $token = $this->getToken($oldSessionId);
+
+        if (!($token instanceof PublicKeyToken)) {
+            throw new InvalidTokenException("Invalid token type");
+        }
+
+        $password = null;
+        if (!is_null($token->getPassword())) {
+            $privateKey = $this->decrypt($token->getPrivateKey(), $oldSessionId);
+            $password = $this->decryptPassword($token->getPassword(), $privateKey);
+        }
+
+        $newToken = $this->generateToken(
+            $sessionId,
+            $token->getUID(),
+            $token->getLoginName(),
+            $password,
+            $token->getName(),
+            IToken::TEMPORARY_TOKEN,
+            $token->getRemember()
+        );
+
+        $this->mapper->delete($token);
+
+        return $newToken;
+    }
+
+    public function invalidateToken(string $token) {
+        $this->cache->clear();
+
+        $this->mapper->invalidate($this->hashToken($token));
+    }
+
+    public function invalidateTokenById(string $uid, int $id) {
+        $this->cache->clear();
+
+        $this->mapper->deleteById($uid, $id);
+    }
+
+    public function invalidateOldTokens() {
+        $this->cache->clear();
+
+        $olderThan = $this->time->getTime() - (int) $this->config->getSystemValue('session_lifetime', 60 * 60 * 24);
+        $this->logger->debug('Invalidating session tokens older than ' . date('c', $olderThan), ['app' => 'cron']);
+        $this->mapper->invalidateOld($olderThan, IToken::DO_NOT_REMEMBER);
+        $rememberThreshold = $this->time->getTime() - (int) $this->config->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
+        $this->logger->debug('Invalidating remembered session tokens older than ' . date('c', $rememberThreshold), ['app' => 'cron']);
+        $this->mapper->invalidateOld($rememberThreshold, IToken::REMEMBER);
+    }
+
+    public function updateToken(IToken $token) {
+        $this->cache->clear();
+
+        if (!($token instanceof PublicKeyToken)) {
+            throw new InvalidTokenException("Invalid token type");
+        }
+        $this->mapper->update($token);
+    }
+
+    public function updateTokenActivity(IToken $token) {
+        $this->cache->clear();
+
+        if (!($token instanceof PublicKeyToken)) {
+            throw new InvalidTokenException("Invalid token type");
+        }
+        /** @var DefaultToken $token */
+        $now = $this->time->getTime();
+        if ($token->getLastActivity() < ($now - 60)) {
+            // Update token only once per minute
+            $token->setLastActivity($now);
+            $this->mapper->update($token);
+        }
+    }
+
+    public function getTokenByUser(string $uid): array {
+        return $this->mapper->getTokenByUser($uid);
+    }
+
+    public function getPassword(IToken $savedToken, string $tokenId): string {
+        if (!($savedToken instanceof PublicKeyToken)) {
+            throw new InvalidTokenException("Invalid token type");
+        }
+
+        if ($savedToken->getPassword() === null) {
+            throw new PasswordlessTokenException();
+        }
+
+        // Decrypt private key with tokenId
+        $privateKey = $this->decrypt($savedToken->getPrivateKey(), $tokenId);
+
+        // Decrypt password with private key
+        return $this->decryptPassword($savedToken->getPassword(), $privateKey);
+    }
+
+    public function setPassword(IToken $token, string $tokenId, string $password) {
+        $this->cache->clear();
+
+        if (!($token instanceof PublicKeyToken)) {
+            throw new InvalidTokenException("Invalid token type");
+        }
+
+        // When changing passwords all temp tokens are deleted
+        $this->mapper->deleteTempToken($token);
+
+        // Update the password for all tokens
+        $tokens = $this->mapper->getTokenByUser($token->getUID());
+        foreach ($tokens as $t) {
+            $publicKey = $t->getPublicKey();
+            $t->setPassword($this->encryptPassword($password, $publicKey));
+            $this->updateToken($t);
+        }
+    }
+
+    public function rotate(IToken $token, string $oldTokenId, string $newTokenId): IToken {
+        $this->cache->clear();
+
+        if (!($token instanceof PublicKeyToken)) {
+            throw new InvalidTokenException("Invalid token type");
+        }
+
+        // Decrypt private key with oldTokenId
+        $privateKey = $this->decrypt($token->getPrivateKey(), $oldTokenId);
+        // Encrypt with the new token
+        $token->setPrivateKey($this->encrypt($privateKey, $newTokenId));
+
+        $token->setToken($this->hashToken($newTokenId));
+        $this->updateToken($token);
+
+        return $token;
+    }
+
+    private function encrypt(string $plaintext, string $token): string {
+        $secret = $this->config->getSystemValue('secret');
+        return $this->crypto->encrypt($plaintext, $token . $secret);
+    }
+
+    /**
+     * @throws InvalidTokenException
+     */
+    private function decrypt(string $cipherText, string $token): string {
+        $secret = $this->config->getSystemValue('secret');
+        try {
+            return $this->crypto->decrypt($cipherText, $token . $secret);
+        } catch (\Exception $ex) {
+            // Delete the invalid token
+            $this->invalidateToken($token);
+            throw new InvalidTokenException("Could not decrypt token password: " . $ex->getMessage(), 0, $ex);
+        }
+    }
+
+    private function encryptPassword(string $password, string $publicKey): string {
+        openssl_public_encrypt($password, $encryptedPassword, $publicKey, OPENSSL_PKCS1_OAEP_PADDING);
+        $encryptedPassword = base64_encode($encryptedPassword);
+
+        return $encryptedPassword;
+    }
+
+    private function decryptPassword(string $encryptedPassword, string $privateKey): string {
+        $encryptedPassword = base64_decode($encryptedPassword);
+        openssl_private_decrypt($encryptedPassword, $password, $privateKey, OPENSSL_PKCS1_OAEP_PADDING);
+
+        return $password;
+    }
+
+    private function hashToken(string $token): string {
+        $secret = $this->config->getSystemValue('secret');
+        return hash('sha512', $token . $secret);
+    }
+
+    /**
+     * Convert a DefaultToken to a publicKeyToken
+     * This will also be updated directly in the Database
+     * @throws \RuntimeException when OpenSSL reports a problem
+     */
+    public function convertToken(DefaultToken $defaultToken, string $token, $password): PublicKeyToken {
+        $this->cache->clear();
+
+        $pkToken = $this->newToken(
+            $token,
+            $defaultToken->getUID(),
+            $defaultToken->getLoginName(),
+            $password,
+            $defaultToken->getName(),
+            $defaultToken->getType(),
+            $defaultToken->getRemember()
+        );
+
+        $pkToken->setExpires($defaultToken->getExpires());
+        $pkToken->setId($defaultToken->getId());
+
+        return $this->mapper->update($pkToken);
+    }
+
+    /**
+     * @throws \RuntimeException when OpenSSL reports a problem
+     */
+    private function newToken(string $token,
+                                string $uid,
+                                string $loginName,
+                                $password,
+                                string $name,
+                                int $type,
+                                int $remember): PublicKeyToken {
+        $dbToken = new PublicKeyToken();
+        $dbToken->setUid($uid);
+        $dbToken->setLoginName($loginName);
+
+        $config = array_merge([
+            'digest_alg' => 'sha512',
+            'private_key_bits' => 2048,
+        ], $this->config->getSystemValue('openssl', []));
+
+        // Generate new key
+        $res = openssl_pkey_new($config);
+        if ($res === false) {
+            $this->logOpensslError();
+            throw new \RuntimeException('OpenSSL reported a problem');
+        }
+
+        if (openssl_pkey_export($res, $privateKey, null, $config) === false) {
+            $this->logOpensslError();
+            throw new \RuntimeException('OpenSSL reported a problem');
+        }
+
+        // Extract the public key from $res to $pubKey
+        $publicKey = openssl_pkey_get_details($res);
+        $publicKey = $publicKey['key'];
+
+        $dbToken->setPublicKey($publicKey);
+        $dbToken->setPrivateKey($this->encrypt($privateKey, $token));
+
+        if (!is_null($password)) {
+            $dbToken->setPassword($this->encryptPassword($password, $publicKey));
+        }
+
+        $dbToken->setName($name);
+        $dbToken->setToken($this->hashToken($token));
+        $dbToken->setType($type);
+        $dbToken->setRemember($remember);
+        $dbToken->setLastActivity($this->time->getTime());
+        $dbToken->setLastCheck($this->time->getTime());
+        $dbToken->setVersion(PublicKeyToken::VERSION);
+
+        return $dbToken;
+    }
+
+    public function markPasswordInvalid(IToken $token, string $tokenId) {
+        $this->cache->clear();
+
+        if (!($token instanceof PublicKeyToken)) {
+            throw new InvalidTokenException("Invalid token type");
+        }
+
+        $token->setPasswordInvalid(true);
+        $this->mapper->update($token);
+    }
+
+    public function updatePasswords(string $uid, string $password) {
+        $this->cache->clear();
+
+        if (!$this->mapper->hasExpiredTokens($uid)) {
+            // Nothing to do here
+            return;
+        }
+
+        // Update the password for all tokens
+        $tokens = $this->mapper->getTokenByUser($uid);
+        foreach ($tokens as $t) {
+            $publicKey = $t->getPublicKey();
+            $t->setPassword($this->encryptPassword($password, $publicKey));
+            $this->updateToken($t);
+        }
+    }
+
+    private function logOpensslError() {
+        $errors = [];
+        while ($error = openssl_error_string()) {
+            $errors[] = $error;
+        }
+        $this->logger->critical('Something is wrong with your openssl setup: ' . implode(', ', $errors));
+    }
 }

lib/private/URLGenerator.php

Indentation +197 added lines, -197 removed lines

@@ -50,226 +50,226 @@
  * Class to generate URLs
  */
 class URLGenerator implements IURLGenerator {
-	/** @var IConfig */
-	private $config;
-	/** @var ICacheFactory */
-	private $cacheFactory;
-	/** @var IRequest */
-	private $request;
+    /** @var IConfig */
+    private $config;
+    /** @var ICacheFactory */
+    private $cacheFactory;
+    /** @var IRequest */
+    private $request;
 
-	/**
-	 * @param IConfig $config
-	 * @param ICacheFactory $cacheFactory
-	 * @param IRequest $request
-	 */
-	public function __construct(IConfig $config,
-								ICacheFactory $cacheFactory,
-								IRequest $request) {
-		$this->config = $config;
-		$this->cacheFactory = $cacheFactory;
-		$this->request = $request;
-	}
+    /**
+     * @param IConfig $config
+     * @param ICacheFactory $cacheFactory
+     * @param IRequest $request
+     */
+    public function __construct(IConfig $config,
+                                ICacheFactory $cacheFactory,
+                                IRequest $request) {
+        $this->config = $config;
+        $this->cacheFactory = $cacheFactory;
+        $this->request = $request;
+    }
 
-	/**
-	 * Creates an url using a defined route
-	 *
-	 * @param string $routeName
-	 * @param array $arguments args with param=>value, will be appended to the returned url
-	 * @return string the url
-	 *
-	 * Returns a url to the given route.
-	 */
-	public function linkToRoute(string $routeName, array $arguments = []): string {
-		// TODO: mock router
-		return \OC::$server->getRouter()->generate($routeName, $arguments);
-	}
+    /**
+     * Creates an url using a defined route
+     *
+     * @param string $routeName
+     * @param array $arguments args with param=>value, will be appended to the returned url
+     * @return string the url
+     *
+     * Returns a url to the given route.
+     */
+    public function linkToRoute(string $routeName, array $arguments = []): string {
+        // TODO: mock router
+        return \OC::$server->getRouter()->generate($routeName, $arguments);
+    }
 
-	/**
-	 * Creates an absolute url using a defined route
-	 * @param string $routeName
-	 * @param array $arguments args with param=>value, will be appended to the returned url
-	 * @return string the url
-	 *
-	 * Returns an absolute url to the given route.
-	 */
-	public function linkToRouteAbsolute(string $routeName, array $arguments = []): string {
-		return $this->getAbsoluteURL($this->linkToRoute($routeName, $arguments));
-	}
+    /**
+     * Creates an absolute url using a defined route
+     * @param string $routeName
+     * @param array $arguments args with param=>value, will be appended to the returned url
+     * @return string the url
+     *
+     * Returns an absolute url to the given route.
+     */
+    public function linkToRouteAbsolute(string $routeName, array $arguments = []): string {
+        return $this->getAbsoluteURL($this->linkToRoute($routeName, $arguments));
+    }
 
-	public function linkToOCSRouteAbsolute(string $routeName, array $arguments = []): string {
-		$route = \OC::$server->getRouter()->generate('ocs.'.$routeName, $arguments, false);
+    public function linkToOCSRouteAbsolute(string $routeName, array $arguments = []): string {
+        $route = \OC::$server->getRouter()->generate('ocs.'.$routeName, $arguments, false);
 
-		$indexPhpPos = strpos($route, '/index.php/');
-		if ($indexPhpPos !== false) {
-			$route = substr($route, $indexPhpPos + 10);
-		}
+        $indexPhpPos = strpos($route, '/index.php/');
+        if ($indexPhpPos !== false) {
+            $route = substr($route, $indexPhpPos + 10);
+        }
 
-		$route = substr($route, 7);
-		$route = '/ocs/v2.php' . $route;
+        $route = substr($route, 7);
+        $route = '/ocs/v2.php' . $route;
 
-		return $this->getAbsoluteURL($route);
-	}
+        return $this->getAbsoluteURL($route);
+    }
 
-	/**
-	 * Creates an url
-	 *
-	 * @param string $appName app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 *    The value of $args will be urlencoded
-	 * @return string the url
-	 *
-	 * Returns a url to the given app and file.
-	 */
-	public function linkTo(string $appName, string $file, array $args = []): string {
-		$frontControllerActive = ($this->config->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true');
+    /**
+     * Creates an url
+     *
+     * @param string $appName app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     *    The value of $args will be urlencoded
+     * @return string the url
+     *
+     * Returns a url to the given app and file.
+     */
+    public function linkTo(string $appName, string $file, array $args = []): string {
+        $frontControllerActive = ($this->config->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true');
 
-		if ($appName !== '') {
-			$app_path = \OC_App::getAppPath($appName);
-			// Check if the app is in the app folder
-			if ($app_path && file_exists($app_path . '/' . $file)) {
-				if (substr($file, -3) === 'php') {
-					$urlLinkTo = \OC::$WEBROOT . '/index.php/apps/' . $appName;
-					if ($frontControllerActive) {
-						$urlLinkTo = \OC::$WEBROOT . '/apps/' . $appName;
-					}
-					$urlLinkTo .= ($file !== 'index.php') ? '/' . $file : '';
-				} else {
-					$urlLinkTo = \OC_App::getAppWebPath($appName) . '/' . $file;
-				}
-			} else {
-				$urlLinkTo = \OC::$WEBROOT . '/' . $appName . '/' . $file;
-			}
-		} else {
-			if (file_exists(\OC::$SERVERROOT . '/core/' . $file)) {
-				$urlLinkTo = \OC::$WEBROOT . '/core/' . $file;
-			} else {
-				if ($frontControllerActive && $file === 'index.php') {
-					$urlLinkTo = \OC::$WEBROOT . '/';
-				} else {
-					$urlLinkTo = \OC::$WEBROOT . '/' . $file;
-				}
-			}
-		}
+        if ($appName !== '') {
+            $app_path = \OC_App::getAppPath($appName);
+            // Check if the app is in the app folder
+            if ($app_path && file_exists($app_path . '/' . $file)) {
+                if (substr($file, -3) === 'php') {
+                    $urlLinkTo = \OC::$WEBROOT . '/index.php/apps/' . $appName;
+                    if ($frontControllerActive) {
+                        $urlLinkTo = \OC::$WEBROOT . '/apps/' . $appName;
+                    }
+                    $urlLinkTo .= ($file !== 'index.php') ? '/' . $file : '';
+                } else {
+                    $urlLinkTo = \OC_App::getAppWebPath($appName) . '/' . $file;
+                }
+            } else {
+                $urlLinkTo = \OC::$WEBROOT . '/' . $appName . '/' . $file;
+            }
+        } else {
+            if (file_exists(\OC::$SERVERROOT . '/core/' . $file)) {
+                $urlLinkTo = \OC::$WEBROOT . '/core/' . $file;
+            } else {
+                if ($frontControllerActive && $file === 'index.php') {
+                    $urlLinkTo = \OC::$WEBROOT . '/';
+                } else {
+                    $urlLinkTo = \OC::$WEBROOT . '/' . $file;
+                }
+            }
+        }
 
-		if ($args && $query = http_build_query($args, '', '&')) {
-			$urlLinkTo .= '?' . $query;
-		}
+        if ($args && $query = http_build_query($args, '', '&')) {
+            $urlLinkTo .= '?' . $query;
+        }
 
-		return $urlLinkTo;
-	}
+        return $urlLinkTo;
+    }
 
-	/**
-	 * Creates path to an image
-	 *
-	 * @param string $appName app
-	 * @param string $file image name
-	 * @throws \RuntimeException If the image does not exist
-	 * @return string the url
-	 *
-	 * Returns the path to the image.
-	 */
-	public function imagePath(string $appName, string $file): string {
-		$cache = $this->cacheFactory->createDistributed('imagePath-'.md5($this->getBaseUrl()).'-');
-		$cacheKey = $appName.'-'.$file;
-		if ($key = $cache->get($cacheKey)) {
-			return $key;
-		}
+    /**
+     * Creates path to an image
+     *
+     * @param string $appName app
+     * @param string $file image name
+     * @throws \RuntimeException If the image does not exist
+     * @return string the url
+     *
+     * Returns the path to the image.
+     */
+    public function imagePath(string $appName, string $file): string {
+        $cache = $this->cacheFactory->createDistributed('imagePath-'.md5($this->getBaseUrl()).'-');
+        $cacheKey = $appName.'-'.$file;
+        if ($key = $cache->get($cacheKey)) {
+            return $key;
+        }
 
-		// Read the selected theme from the config file
-		$theme = \OC_Util::getTheme();
+        // Read the selected theme from the config file
+        $theme = \OC_Util::getTheme();
 
-		//if a theme has a png but not an svg always use the png
-		$basename = substr(basename($file),0,-4);
+        //if a theme has a png but not an svg always use the png
+        $basename = substr(basename($file),0,-4);
 
-		$appPath = \OC_App::getAppPath($appName);
+        $appPath = \OC_App::getAppPath($appName);
 
-		// Check if the app is in the app folder
-		$path = '';
-		$themingEnabled = $this->config->getSystemValue('installed', false) && \OCP\App::isEnabled('theming') && \OC_App::isAppLoaded('theming');
-		$themingImagePath = false;
-		if ($themingEnabled) {
-			$themingDefaults = \OC::$server->getThemingDefaults();
-			if ($themingDefaults instanceof ThemingDefaults) {
-				$themingImagePath = $themingDefaults->replaceImagePath($appName, $file);
-			}
-		}
+        // Check if the app is in the app folder
+        $path = '';
+        $themingEnabled = $this->config->getSystemValue('installed', false) && \OCP\App::isEnabled('theming') && \OC_App::isAppLoaded('theming');
+        $themingImagePath = false;
+        if ($themingEnabled) {
+            $themingDefaults = \OC::$server->getThemingDefaults();
+            if ($themingDefaults instanceof ThemingDefaults) {
+                $themingImagePath = $themingDefaults->replaceImagePath($appName, $file);
+            }
+        }
 
-		if (file_exists(\OC::$SERVERROOT . "/themes/$theme/apps/$appName/img/$file")) {
-			$path = \OC::$WEBROOT . "/themes/$theme/apps/$appName/img/$file";
-		} elseif (!file_exists(\OC::$SERVERROOT . "/themes/$theme/apps/$appName/img/$basename.svg")
-			&& file_exists(\OC::$SERVERROOT . "/themes/$theme/apps/$appName/img/$basename.png")) {
-			$path =  \OC::$WEBROOT . "/themes/$theme/apps/$appName/img/$basename.png";
-		} elseif (!empty($appName) and file_exists(\OC::$SERVERROOT . "/themes/$theme/$appName/img/$file")) {
-			$path =  \OC::$WEBROOT . "/themes/$theme/$appName/img/$file";
-		} elseif (!empty($appName) and (!file_exists(\OC::$SERVERROOT . "/themes/$theme/$appName/img/$basename.svg")
-			&& file_exists(\OC::$SERVERROOT . "/themes/$theme/$appName/img/$basename.png"))) {
-			$path =  \OC::$WEBROOT . "/themes/$theme/$appName/img/$basename.png";
-		} elseif (file_exists(\OC::$SERVERROOT . "/themes/$theme/core/img/$file")) {
-			$path =  \OC::$WEBROOT . "/themes/$theme/core/img/$file";
-		} elseif (!file_exists(\OC::$SERVERROOT . "/themes/$theme/core/img/$basename.svg")
-			&& file_exists(\OC::$SERVERROOT . "/themes/$theme/core/img/$basename.png")) {
-			$path =  \OC::$WEBROOT . "/themes/$theme/core/img/$basename.png";
-		} elseif ($themingEnabled && $themingImagePath) {
-			$path = $themingImagePath;
-		} elseif ($appPath && file_exists($appPath . "/img/$file")) {
-			$path =  \OC_App::getAppWebPath($appName) . "/img/$file";
-		} elseif ($appPath && !file_exists($appPath . "/img/$basename.svg")
-			&& file_exists($appPath . "/img/$basename.png")) {
-			$path =  \OC_App::getAppWebPath($appName) . "/img/$basename.png";
-		} elseif (!empty($appName) and file_exists(\OC::$SERVERROOT . "/$appName/img/$file")) {
-			$path =  \OC::$WEBROOT . "/$appName/img/$file";
-		} elseif (!empty($appName) and (!file_exists(\OC::$SERVERROOT . "/$appName/img/$basename.svg")
-				&& file_exists(\OC::$SERVERROOT . "/$appName/img/$basename.png"))) {
-			$path =  \OC::$WEBROOT . "/$appName/img/$basename.png";
-		} elseif (file_exists(\OC::$SERVERROOT . "/core/img/$file")) {
-			$path =  \OC::$WEBROOT . "/core/img/$file";
-		} elseif (!file_exists(\OC::$SERVERROOT . "/core/img/$basename.svg")
-			&& file_exists(\OC::$SERVERROOT . "/core/img/$basename.png")) {
-			$path =  \OC::$WEBROOT . "/themes/$theme/core/img/$basename.png";
-		}
+        if (file_exists(\OC::$SERVERROOT . "/themes/$theme/apps/$appName/img/$file")) {
+            $path = \OC::$WEBROOT . "/themes/$theme/apps/$appName/img/$file";
+        } elseif (!file_exists(\OC::$SERVERROOT . "/themes/$theme/apps/$appName/img/$basename.svg")
+            && file_exists(\OC::$SERVERROOT . "/themes/$theme/apps/$appName/img/$basename.png")) {
+            $path =  \OC::$WEBROOT . "/themes/$theme/apps/$appName/img/$basename.png";
+        } elseif (!empty($appName) and file_exists(\OC::$SERVERROOT . "/themes/$theme/$appName/img/$file")) {
+            $path =  \OC::$WEBROOT . "/themes/$theme/$appName/img/$file";
+        } elseif (!empty($appName) and (!file_exists(\OC::$SERVERROOT . "/themes/$theme/$appName/img/$basename.svg")
+            && file_exists(\OC::$SERVERROOT . "/themes/$theme/$appName/img/$basename.png"))) {
+            $path =  \OC::$WEBROOT . "/themes/$theme/$appName/img/$basename.png";
+        } elseif (file_exists(\OC::$SERVERROOT . "/themes/$theme/core/img/$file")) {
+            $path =  \OC::$WEBROOT . "/themes/$theme/core/img/$file";
+        } elseif (!file_exists(\OC::$SERVERROOT . "/themes/$theme/core/img/$basename.svg")
+            && file_exists(\OC::$SERVERROOT . "/themes/$theme/core/img/$basename.png")) {
+            $path =  \OC::$WEBROOT . "/themes/$theme/core/img/$basename.png";
+        } elseif ($themingEnabled && $themingImagePath) {
+            $path = $themingImagePath;
+        } elseif ($appPath && file_exists($appPath . "/img/$file")) {
+            $path =  \OC_App::getAppWebPath($appName) . "/img/$file";
+        } elseif ($appPath && !file_exists($appPath . "/img/$basename.svg")
+            && file_exists($appPath . "/img/$basename.png")) {
+            $path =  \OC_App::getAppWebPath($appName) . "/img/$basename.png";
+        } elseif (!empty($appName) and file_exists(\OC::$SERVERROOT . "/$appName/img/$file")) {
+            $path =  \OC::$WEBROOT . "/$appName/img/$file";
+        } elseif (!empty($appName) and (!file_exists(\OC::$SERVERROOT . "/$appName/img/$basename.svg")
+                && file_exists(\OC::$SERVERROOT . "/$appName/img/$basename.png"))) {
+            $path =  \OC::$WEBROOT . "/$appName/img/$basename.png";
+        } elseif (file_exists(\OC::$SERVERROOT . "/core/img/$file")) {
+            $path =  \OC::$WEBROOT . "/core/img/$file";
+        } elseif (!file_exists(\OC::$SERVERROOT . "/core/img/$basename.svg")
+            && file_exists(\OC::$SERVERROOT . "/core/img/$basename.png")) {
+            $path =  \OC::$WEBROOT . "/themes/$theme/core/img/$basename.png";
+        }
 
-		if ($path !== '') {
-			$cache->set($cacheKey, $path);
-			return $path;
-		}
+        if ($path !== '') {
+            $cache->set($cacheKey, $path);
+            return $path;
+        }
 
-		throw new RuntimeException('image not found: image:' . $file . ' webroot:' . \OC::$WEBROOT . ' serverroot:' . \OC::$SERVERROOT);
-	}
+        throw new RuntimeException('image not found: image:' . $file . ' webroot:' . \OC::$WEBROOT . ' serverroot:' . \OC::$SERVERROOT);
+    }
 
 
-	/**
-	 * Makes an URL absolute
-	 * @param string $url the url in the ownCloud host
-	 * @return string the absolute version of the url
-	 */
-	public function getAbsoluteURL(string $url): string {
-		$separator = strpos($url, '/') === 0 ? '' : '/';
+    /**
+     * Makes an URL absolute
+     * @param string $url the url in the ownCloud host
+     * @return string the absolute version of the url
+     */
+    public function getAbsoluteURL(string $url): string {
+        $separator = strpos($url, '/') === 0 ? '' : '/';
 
-		if (\OC::$CLI && !\defined('PHPUNIT_RUN')) {
-			return rtrim($this->config->getSystemValue('overwrite.cli.url'), '/') . '/' . ltrim($url, '/');
-		}
-		// The ownCloud web root can already be prepended.
-		if (\OC::$WEBROOT !== '' && strpos($url, \OC::$WEBROOT) === 0) {
-			$url = substr($url, \strlen(\OC::$WEBROOT));
-		}
+        if (\OC::$CLI && !\defined('PHPUNIT_RUN')) {
+            return rtrim($this->config->getSystemValue('overwrite.cli.url'), '/') . '/' . ltrim($url, '/');
+        }
+        // The ownCloud web root can already be prepended.
+        if (\OC::$WEBROOT !== '' && strpos($url, \OC::$WEBROOT) === 0) {
+            $url = substr($url, \strlen(\OC::$WEBROOT));
+        }
 
-		return $this->getBaseUrl() . $separator . $url;
-	}
+        return $this->getBaseUrl() . $separator . $url;
+    }
 
-	/**
-	 * @param string $key
-	 * @return string url to the online documentation
-	 */
-	public function linkToDocs(string $key): string {
-		$theme = \OC::$server->getThemingDefaults();
-		return $theme->buildDocLinkToKey($key);
-	}
+    /**
+     * @param string $key
+     * @return string url to the online documentation
+     */
+    public function linkToDocs(string $key): string {
+        $theme = \OC::$server->getThemingDefaults();
+        return $theme->buildDocLinkToKey($key);
+    }
 
-	/**
-	 * @return string base url of the current request
-	 */
-	public function getBaseUrl(): string {
-		return $this->request->getServerProtocol() . '://' . $this->request->getServerHost() . \OC::$WEBROOT;
-	}
+    /**
+     * @return string base url of the current request
+     */
+    public function getBaseUrl(): string {
+        return $this->request->getServerProtocol() . '://' . $this->request->getServerHost() . \OC::$WEBROOT;
+    }
 }

lib/private/User/Database.php

Indentation +418 added lines, -418 removed lines

@@ -77,422 +77,422 @@
  * Class for user management in a SQL Database (e.g. MySQL, SQLite)
  */
 class Database extends ABackend implements
-	ICreateUserBackend,
-			   ISetPasswordBackend,
-			   ISetDisplayNameBackend,
-			   IGetDisplayNameBackend,
-			   ICheckPasswordBackend,
-			   IGetHomeBackend,
-			   ICountUsersBackend,
-			   IGetRealUIDBackend {
-	/** @var CappedMemoryCache */
-	private $cache;
-
-	/** @var IEventDispatcher */
-	private $eventDispatcher;
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/** @var string */
-	private $table;
-
-	/**
-	 * \OC\User\Database constructor.
-	 *
-	 * @param IEventDispatcher $eventDispatcher
-	 * @param string $table
-	 */
-	public function __construct($eventDispatcher = null, $table = 'users') {
-		$this->cache = new CappedMemoryCache();
-		$this->table = $table;
-		$this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OC::$server->query(IEventDispatcher::class);
-	}
-
-	/**
-	 * FIXME: This function should not be required!
-	 */
-	private function fixDI() {
-		if ($this->dbConn === null) {
-			$this->dbConn = \OC::$server->getDatabaseConnection();
-		}
-	}
-
-	/**
-	 * Create a new user
-	 *
-	 * @param string $uid The username of the user to create
-	 * @param string $password The password of the new user
-	 * @return bool
-	 *
-	 * Creates a new user. Basic checking of username is done in OC_User
-	 * itself, not in its subclasses.
-	 */
-	public function createUser(string $uid, string $password): bool {
-		$this->fixDI();
-
-		if (!$this->userExists($uid)) {
-			$this->eventDispatcher->dispatchTyped(new ValidatePasswordPolicyEvent($password));
-
-			$qb = $this->dbConn->getQueryBuilder();
-			$qb->insert($this->table)
-				->values([
-					'uid' => $qb->createNamedParameter($uid),
-					'password' => $qb->createNamedParameter(\OC::$server->getHasher()->hash($password)),
-					'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
-				]);
-
-			$result = $qb->execute();
-
-			// Clear cache
-			unset($this->cache[$uid]);
-
-			return $result ? true : false;
-		}
-
-		return false;
-	}
-
-	/**
-	 * delete a user
-	 *
-	 * @param string $uid The username of the user to delete
-	 * @return bool
-	 *
-	 * Deletes a user
-	 */
-	public function deleteUser($uid) {
-		$this->fixDI();
-
-		// Delete user-group-relation
-		$query = $this->dbConn->getQueryBuilder();
-		$query->delete($this->table)
-			->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
-		$result = $query->execute();
-
-		if (isset($this->cache[$uid])) {
-			unset($this->cache[$uid]);
-		}
-
-		return $result ? true : false;
-	}
-
-	private function updatePassword(string $uid, string $passwordHash): bool {
-		$query = $this->dbConn->getQueryBuilder();
-		$query->update($this->table)
-			->set('password', $query->createNamedParameter($passwordHash))
-			->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
-		$result = $query->execute();
-
-		return $result ? true : false;
-	}
-
-	/**
-	 * Set password
-	 *
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @return bool
-	 *
-	 * Change the password of a user
-	 */
-	public function setPassword(string $uid, string $password): bool {
-		$this->fixDI();
-
-		if ($this->userExists($uid)) {
-			$this->eventDispatcher->dispatchTyped(new ValidatePasswordPolicyEvent($password));
-
-			$hasher = \OC::$server->getHasher();
-			$hashedPassword = $hasher->hash($password);
-
-			return $this->updatePassword($uid, $hashedPassword);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Set display name
-	 *
-	 * @param string $uid The username
-	 * @param string $displayName The new display name
-	 * @return bool
-	 *
-	 * Change the display name of a user
-	 */
-	public function setDisplayName(string $uid, string $displayName): bool {
-		$this->fixDI();
-
-		if ($this->userExists($uid)) {
-			$query = $this->dbConn->getQueryBuilder();
-			$query->update($this->table)
-				->set('displayname', $query->createNamedParameter($displayName))
-				->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
-			$query->execute();
-
-			$this->cache[$uid]['displayname'] = $displayName;
-
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get display name of the user
-	 *
-	 * @param string $uid user ID of the user
-	 * @return string display name
-	 */
-	public function getDisplayName($uid): string {
-		$uid = (string)$uid;
-		$this->loadUser($uid);
-		return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
-	}
-
-	/**
-	 * Get a list of all display names and user ids.
-	 *
-	 * @param string $search
-	 * @param string|null $limit
-	 * @param string|null $offset
-	 * @return array an array of all displayNames (value) and the corresponding uids (key)
-	 */
-	public function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$limit = $this->fixLimit($limit);
-
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-
-		$query->select('uid', 'displayname')
-			->from($this->table, 'u')
-			->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
-				$query->expr()->eq('userid', 'uid'),
-				$query->expr()->eq('appid', $query->expr()->literal('settings')),
-				$query->expr()->eq('configkey', $query->expr()->literal('email')))
-			)
-			// sqlite doesn't like re-using a single named parameter here
-			->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
-			->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
-			->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
-			->orderBy($query->func()->lower('displayname'), 'ASC')
-			->orderBy('uid_lower', 'ASC')
-			->setMaxResults($limit)
-			->setFirstResult($offset);
-
-		$result = $query->execute();
-		$displayNames = [];
-		while ($row = $result->fetch()) {
-			$displayNames[(string)$row['uid']] = (string)$row['displayname'];
-		}
-
-		return $displayNames;
-	}
-
-	/**
-	 * Check if the password is correct
-	 *
-	 * @param string $loginName The loginname
-	 * @param string $password The password
-	 * @return string
-	 *
-	 * Check if the password is correct without logging in the user
-	 * returns the user id or false
-	 */
-	public function checkPassword(string $loginName, string $password) {
-		$this->fixDI();
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->select('uid', 'password')
-			->from($this->table)
-			->where(
-				$qb->expr()->eq(
-					'uid_lower', $qb->createNamedParameter(mb_strtolower($loginName))
-				)
-			);
-		$result = $qb->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			$storedHash = $row['password'];
-			$newHash = '';
-			if (\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) {
-				if (!empty($newHash)) {
-					$this->updatePassword($loginName, $newHash);
-				}
-				return (string)$row['uid'];
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Load an user in the cache
-	 *
-	 * @param string $uid the username
-	 * @return boolean true if user was found, false otherwise
-	 */
-	private function loadUser($uid) {
-		$this->fixDI();
-
-		$uid = (string)$uid;
-		if (!isset($this->cache[$uid])) {
-			//guests $uid could be NULL or ''
-			if ($uid === '') {
-				$this->cache[$uid] = false;
-				return true;
-			}
-
-			$qb = $this->dbConn->getQueryBuilder();
-			$qb->select('uid', 'displayname')
-				->from($this->table)
-				->where(
-					$qb->expr()->eq(
-						'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
-					)
-				);
-			$result = $qb->execute();
-			$row = $result->fetch();
-			$result->closeCursor();
-
-			$this->cache[$uid] = false;
-
-			// "uid" is primary key, so there can only be a single result
-			if ($row !== false) {
-				$this->cache[$uid]['uid'] = (string)$row['uid'];
-				$this->cache[$uid]['displayname'] = (string)$row['displayname'];
-			} else {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get a list of all users
-	 *
-	 * @param string $search
-	 * @param null|int $limit
-	 * @param null|int $offset
-	 * @return string[] an array of all uids
-	 */
-	public function getUsers($search = '', $limit = null, $offset = null) {
-		$limit = $this->fixLimit($limit);
-
-		$users = $this->getDisplayNames($search, $limit, $offset);
-		$userIds = array_map(function ($uid) {
-			return (string)$uid;
-		}, array_keys($users));
-		sort($userIds, SORT_STRING | SORT_FLAG_CASE);
-		return $userIds;
-	}
-
-	/**
-	 * check if a user exists
-	 *
-	 * @param string $uid the username
-	 * @return boolean
-	 */
-	public function userExists($uid) {
-		$this->loadUser($uid);
-		return $this->cache[$uid] !== false;
-	}
-
-	/**
-	 * get the user's home directory
-	 *
-	 * @param string $uid the username
-	 * @return string|false
-	 */
-	public function getHome(string $uid) {
-		if ($this->userExists($uid)) {
-			return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
-		}
-
-		return false;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function hasUserListings() {
-		return true;
-	}
-
-	/**
-	 * counts the users in the database
-	 *
-	 * @return int|bool
-	 */
-	public function countUsers() {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->func()->count('uid'))
-			->from($this->table);
-		$result = $query->execute();
-
-		return $result->fetchColumn();
-	}
-
-	/**
-	 * returns the username for the given login name in the correct casing
-	 *
-	 * @param string $loginName
-	 * @return string|false
-	 */
-	public function loginName2UserName($loginName) {
-		if ($this->userExists($loginName)) {
-			return $this->cache[$loginName]['uid'];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Backend name to be shown in user management
-	 *
-	 * @return string the name of the backend to be shown
-	 */
-	public function getBackendName() {
-		return 'Database';
-	}
-
-	public static function preLoginNameUsedAsUserName($param) {
-		if (!isset($param['uid'])) {
-			throw new \Exception('key uid is expected to be set in $param');
-		}
-
-		$backends = \OC::$server->getUserManager()->getBackends();
-		foreach ($backends as $backend) {
-			if ($backend instanceof Database) {
-				/** @var \OC\User\Database $backend */
-				$uid = $backend->loginName2UserName($param['uid']);
-				if ($uid !== false) {
-					$param['uid'] = $uid;
-					return;
-				}
-			}
-		}
-	}
-
-	public function getRealUID(string $uid): string {
-		if (!$this->userExists($uid)) {
-			throw new \RuntimeException($uid . ' does not exist');
-		}
-
-		return $this->cache[$uid]['uid'];
-	}
-
-	private function fixLimit($limit) {
-		if (is_int($limit) && $limit >= 0) {
-			return $limit;
-		}
-
-		return null;
-	}
+    ICreateUserBackend,
+                ISetPasswordBackend,
+                ISetDisplayNameBackend,
+                IGetDisplayNameBackend,
+                ICheckPasswordBackend,
+                IGetHomeBackend,
+                ICountUsersBackend,
+                IGetRealUIDBackend {
+    /** @var CappedMemoryCache */
+    private $cache;
+
+    /** @var IEventDispatcher */
+    private $eventDispatcher;
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /** @var string */
+    private $table;
+
+    /**
+     * \OC\User\Database constructor.
+     *
+     * @param IEventDispatcher $eventDispatcher
+     * @param string $table
+     */
+    public function __construct($eventDispatcher = null, $table = 'users') {
+        $this->cache = new CappedMemoryCache();
+        $this->table = $table;
+        $this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OC::$server->query(IEventDispatcher::class);
+    }
+
+    /**
+     * FIXME: This function should not be required!
+     */
+    private function fixDI() {
+        if ($this->dbConn === null) {
+            $this->dbConn = \OC::$server->getDatabaseConnection();
+        }
+    }
+
+    /**
+     * Create a new user
+     *
+     * @param string $uid The username of the user to create
+     * @param string $password The password of the new user
+     * @return bool
+     *
+     * Creates a new user. Basic checking of username is done in OC_User
+     * itself, not in its subclasses.
+     */
+    public function createUser(string $uid, string $password): bool {
+        $this->fixDI();
+
+        if (!$this->userExists($uid)) {
+            $this->eventDispatcher->dispatchTyped(new ValidatePasswordPolicyEvent($password));
+
+            $qb = $this->dbConn->getQueryBuilder();
+            $qb->insert($this->table)
+                ->values([
+                    'uid' => $qb->createNamedParameter($uid),
+                    'password' => $qb->createNamedParameter(\OC::$server->getHasher()->hash($password)),
+                    'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
+                ]);
+
+            $result = $qb->execute();
+
+            // Clear cache
+            unset($this->cache[$uid]);
+
+            return $result ? true : false;
+        }
+
+        return false;
+    }
+
+    /**
+     * delete a user
+     *
+     * @param string $uid The username of the user to delete
+     * @return bool
+     *
+     * Deletes a user
+     */
+    public function deleteUser($uid) {
+        $this->fixDI();
+
+        // Delete user-group-relation
+        $query = $this->dbConn->getQueryBuilder();
+        $query->delete($this->table)
+            ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
+        $result = $query->execute();
+
+        if (isset($this->cache[$uid])) {
+            unset($this->cache[$uid]);
+        }
+
+        return $result ? true : false;
+    }
+
+    private function updatePassword(string $uid, string $passwordHash): bool {
+        $query = $this->dbConn->getQueryBuilder();
+        $query->update($this->table)
+            ->set('password', $query->createNamedParameter($passwordHash))
+            ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
+        $result = $query->execute();
+
+        return $result ? true : false;
+    }
+
+    /**
+     * Set password
+     *
+     * @param string $uid The username
+     * @param string $password The new password
+     * @return bool
+     *
+     * Change the password of a user
+     */
+    public function setPassword(string $uid, string $password): bool {
+        $this->fixDI();
+
+        if ($this->userExists($uid)) {
+            $this->eventDispatcher->dispatchTyped(new ValidatePasswordPolicyEvent($password));
+
+            $hasher = \OC::$server->getHasher();
+            $hashedPassword = $hasher->hash($password);
+
+            return $this->updatePassword($uid, $hashedPassword);
+        }
+
+        return false;
+    }
+
+    /**
+     * Set display name
+     *
+     * @param string $uid The username
+     * @param string $displayName The new display name
+     * @return bool
+     *
+     * Change the display name of a user
+     */
+    public function setDisplayName(string $uid, string $displayName): bool {
+        $this->fixDI();
+
+        if ($this->userExists($uid)) {
+            $query = $this->dbConn->getQueryBuilder();
+            $query->update($this->table)
+                ->set('displayname', $query->createNamedParameter($displayName))
+                ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
+            $query->execute();
+
+            $this->cache[$uid]['displayname'] = $displayName;
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * get display name of the user
+     *
+     * @param string $uid user ID of the user
+     * @return string display name
+     */
+    public function getDisplayName($uid): string {
+        $uid = (string)$uid;
+        $this->loadUser($uid);
+        return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
+    }
+
+    /**
+     * Get a list of all display names and user ids.
+     *
+     * @param string $search
+     * @param string|null $limit
+     * @param string|null $offset
+     * @return array an array of all displayNames (value) and the corresponding uids (key)
+     */
+    public function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $limit = $this->fixLimit($limit);
+
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+
+        $query->select('uid', 'displayname')
+            ->from($this->table, 'u')
+            ->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
+                $query->expr()->eq('userid', 'uid'),
+                $query->expr()->eq('appid', $query->expr()->literal('settings')),
+                $query->expr()->eq('configkey', $query->expr()->literal('email')))
+            )
+            // sqlite doesn't like re-using a single named parameter here
+            ->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
+            ->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
+            ->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
+            ->orderBy($query->func()->lower('displayname'), 'ASC')
+            ->orderBy('uid_lower', 'ASC')
+            ->setMaxResults($limit)
+            ->setFirstResult($offset);
+
+        $result = $query->execute();
+        $displayNames = [];
+        while ($row = $result->fetch()) {
+            $displayNames[(string)$row['uid']] = (string)$row['displayname'];
+        }
+
+        return $displayNames;
+    }
+
+    /**
+     * Check if the password is correct
+     *
+     * @param string $loginName The loginname
+     * @param string $password The password
+     * @return string
+     *
+     * Check if the password is correct without logging in the user
+     * returns the user id or false
+     */
+    public function checkPassword(string $loginName, string $password) {
+        $this->fixDI();
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->select('uid', 'password')
+            ->from($this->table)
+            ->where(
+                $qb->expr()->eq(
+                    'uid_lower', $qb->createNamedParameter(mb_strtolower($loginName))
+                )
+            );
+        $result = $qb->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            $storedHash = $row['password'];
+            $newHash = '';
+            if (\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) {
+                if (!empty($newHash)) {
+                    $this->updatePassword($loginName, $newHash);
+                }
+                return (string)$row['uid'];
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Load an user in the cache
+     *
+     * @param string $uid the username
+     * @return boolean true if user was found, false otherwise
+     */
+    private function loadUser($uid) {
+        $this->fixDI();
+
+        $uid = (string)$uid;
+        if (!isset($this->cache[$uid])) {
+            //guests $uid could be NULL or ''
+            if ($uid === '') {
+                $this->cache[$uid] = false;
+                return true;
+            }
+
+            $qb = $this->dbConn->getQueryBuilder();
+            $qb->select('uid', 'displayname')
+                ->from($this->table)
+                ->where(
+                    $qb->expr()->eq(
+                        'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
+                    )
+                );
+            $result = $qb->execute();
+            $row = $result->fetch();
+            $result->closeCursor();
+
+            $this->cache[$uid] = false;
+
+            // "uid" is primary key, so there can only be a single result
+            if ($row !== false) {
+                $this->cache[$uid]['uid'] = (string)$row['uid'];
+                $this->cache[$uid]['displayname'] = (string)$row['displayname'];
+            } else {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Get a list of all users
+     *
+     * @param string $search
+     * @param null|int $limit
+     * @param null|int $offset
+     * @return string[] an array of all uids
+     */
+    public function getUsers($search = '', $limit = null, $offset = null) {
+        $limit = $this->fixLimit($limit);
+
+        $users = $this->getDisplayNames($search, $limit, $offset);
+        $userIds = array_map(function ($uid) {
+            return (string)$uid;
+        }, array_keys($users));
+        sort($userIds, SORT_STRING | SORT_FLAG_CASE);
+        return $userIds;
+    }
+
+    /**
+     * check if a user exists
+     *
+     * @param string $uid the username
+     * @return boolean
+     */
+    public function userExists($uid) {
+        $this->loadUser($uid);
+        return $this->cache[$uid] !== false;
+    }
+
+    /**
+     * get the user's home directory
+     *
+     * @param string $uid the username
+     * @return string|false
+     */
+    public function getHome(string $uid) {
+        if ($this->userExists($uid)) {
+            return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
+        }
+
+        return false;
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasUserListings() {
+        return true;
+    }
+
+    /**
+     * counts the users in the database
+     *
+     * @return int|bool
+     */
+    public function countUsers() {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->func()->count('uid'))
+            ->from($this->table);
+        $result = $query->execute();
+
+        return $result->fetchColumn();
+    }
+
+    /**
+     * returns the username for the given login name in the correct casing
+     *
+     * @param string $loginName
+     * @return string|false
+     */
+    public function loginName2UserName($loginName) {
+        if ($this->userExists($loginName)) {
+            return $this->cache[$loginName]['uid'];
+        }
+
+        return false;
+    }
+
+    /**
+     * Backend name to be shown in user management
+     *
+     * @return string the name of the backend to be shown
+     */
+    public function getBackendName() {
+        return 'Database';
+    }
+
+    public static function preLoginNameUsedAsUserName($param) {
+        if (!isset($param['uid'])) {
+            throw new \Exception('key uid is expected to be set in $param');
+        }
+
+        $backends = \OC::$server->getUserManager()->getBackends();
+        foreach ($backends as $backend) {
+            if ($backend instanceof Database) {
+                /** @var \OC\User\Database $backend */
+                $uid = $backend->loginName2UserName($param['uid']);
+                if ($uid !== false) {
+                    $param['uid'] = $uid;
+                    return;
+                }
+            }
+        }
+    }
+
+    public function getRealUID(string $uid): string {
+        if (!$this->userExists($uid)) {
+            throw new \RuntimeException($uid . ' does not exist');
+        }
+
+        return $this->cache[$uid]['uid'];
+    }
+
+    private function fixLimit($limit) {
+        if (is_int($limit) && $limit >= 0) {
+            return $limit;
+        }
+
+        return null;
+    }
 }

lib/private/SystemTag/SystemTagManager.php

Indentation +385 added lines, -385 removed lines

@@ -45,389 +45,389 @@
  * Manager class for system tags
  */
 class SystemTagManager implements ISystemTagManager {
-	public const TAG_TABLE = 'systemtag';
-	public const TAG_GROUP_TABLE = 'systemtag_group';
-
-	/** @var IDBConnection */
-	protected $connection;
-
-	/** @var EventDispatcherInterface */
-	protected $dispatcher;
-
-	/** @var IGroupManager */
-	protected $groupManager;
-
-	/**
-	 * Prepared query for selecting tags directly
-	 *
-	 * @var \OCP\DB\QueryBuilder\IQueryBuilder
-	 */
-	private $selectTagQuery;
-
-	/**
-	 * Constructor.
-	 *
-	 * @param IDBConnection $connection database connection
-	 * @param IGroupManager $groupManager
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(
-		IDBConnection $connection,
-		IGroupManager $groupManager,
-		EventDispatcherInterface $dispatcher
-	) {
-		$this->connection = $connection;
-		$this->groupManager = $groupManager;
-		$this->dispatcher = $dispatcher;
-
-		$query = $this->connection->getQueryBuilder();
-		$this->selectTagQuery = $query->select('*')
-			->from(self::TAG_TABLE)
-			->where($query->expr()->eq('name', $query->createParameter('name')))
-			->andWhere($query->expr()->eq('visibility', $query->createParameter('visibility')))
-			->andWhere($query->expr()->eq('editable', $query->createParameter('editable')));
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getTagsByIds($tagIds): array {
-		if (!\is_array($tagIds)) {
-			$tagIds = [$tagIds];
-		}
-
-		$tags = [];
-
-		// note: not all databases will fail if it's a string or starts with a number
-		foreach ($tagIds as $tagId) {
-			if (!is_numeric($tagId)) {
-				throw new \InvalidArgumentException('Tag id must be integer');
-			}
-		}
-
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from(self::TAG_TABLE)
-			->where($query->expr()->in('id', $query->createParameter('tagids')))
-			->addOrderBy('name', 'ASC')
-			->addOrderBy('visibility', 'ASC')
-			->addOrderBy('editable', 'ASC')
-			->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY);
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$tags[$row['id']] = $this->createSystemTagFromRow($row);
-		}
-
-		$result->closeCursor();
-
-		if (\count($tags) !== \count($tagIds)) {
-			throw new TagNotFoundException(
-				'Tag id(s) not found', 0, null, array_diff($tagIds, array_keys($tags))
-			);
-		}
-
-		return $tags;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getAllTags($visibilityFilter = null, $nameSearchPattern = null): array {
-		$tags = [];
-
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from(self::TAG_TABLE);
-
-		if (!\is_null($visibilityFilter)) {
-			$query->andWhere($query->expr()->eq('visibility', $query->createNamedParameter((int)$visibilityFilter)));
-		}
-
-		if (!empty($nameSearchPattern)) {
-			$query->andWhere(
-				$query->expr()->like(
-					'name',
-					$query->createNamedParameter('%' . $this->connection->escapeLikeParameter($nameSearchPattern). '%')
-				)
-			);
-		}
-
-		$query
-			->addOrderBy('name', 'ASC')
-			->addOrderBy('visibility', 'ASC')
-			->addOrderBy('editable', 'ASC');
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$tags[$row['id']] = $this->createSystemTagFromRow($row);
-		}
-
-		$result->closeCursor();
-
-		return $tags;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag {
-		$result = $this->selectTagQuery
-			->setParameter('name', $tagName)
-			->setParameter('visibility', $userVisible ? 1 : 0)
-			->setParameter('editable', $userAssignable ? 1 : 0)
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if (!$row) {
-			throw new TagNotFoundException(
-				'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') does not exist'
-			);
-		}
-
-		return $this->createSystemTagFromRow($row);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function createTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag {
-		$query = $this->connection->getQueryBuilder();
-		$query->insert(self::TAG_TABLE)
-			->values([
-				'name' => $query->createNamedParameter($tagName),
-				'visibility' => $query->createNamedParameter($userVisible ? 1 : 0),
-				'editable' => $query->createNamedParameter($userAssignable ? 1 : 0),
-			]);
-
-		try {
-			$query->execute();
-		} catch (UniqueConstraintViolationException $e) {
-			throw new TagAlreadyExistsException(
-				'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') already exists',
-				0,
-				$e
-			);
-		}
-
-		$tagId = $query->getLastInsertId();
-
-		$tag = new SystemTag(
-			(string)$tagId,
-			$tagName,
-			$userVisible,
-			$userAssignable
-		);
-
-		$this->dispatcher->dispatch(ManagerEvent::EVENT_CREATE, new ManagerEvent(
-			ManagerEvent::EVENT_CREATE, $tag
-		));
-
-		return $tag;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function updateTag(string $tagId, string $newName, bool $userVisible, bool $userAssignable) {
-		try {
-			$tags = $this->getTagsByIds($tagId);
-		} catch (TagNotFoundException $e) {
-			throw new TagNotFoundException(
-				'Tag does not exist', 0, null, [$tagId]
-			);
-		}
-
-		$beforeUpdate = array_shift($tags);
-		$afterUpdate = new SystemTag(
-			$tagId,
-			$newName,
-			$userVisible,
-			$userAssignable
-		);
-
-		$query = $this->connection->getQueryBuilder();
-		$query->update(self::TAG_TABLE)
-			->set('name', $query->createParameter('name'))
-			->set('visibility', $query->createParameter('visibility'))
-			->set('editable', $query->createParameter('editable'))
-			->where($query->expr()->eq('id', $query->createParameter('tagid')))
-			->setParameter('name', $newName)
-			->setParameter('visibility', $userVisible ? 1 : 0)
-			->setParameter('editable', $userAssignable ? 1 : 0)
-			->setParameter('tagid', $tagId);
-
-		try {
-			if ($query->execute() === 0) {
-				throw new TagNotFoundException(
-					'Tag does not exist', 0, null, [$tagId]
-				);
-			}
-		} catch (UniqueConstraintViolationException $e) {
-			throw new TagAlreadyExistsException(
-				'Tag ("' . $newName . '", '. $userVisible . ', ' . $userAssignable . ') already exists',
-				0,
-				$e
-			);
-		}
-
-		$this->dispatcher->dispatch(ManagerEvent::EVENT_UPDATE, new ManagerEvent(
-			ManagerEvent::EVENT_UPDATE, $afterUpdate, $beforeUpdate
-		));
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function deleteTags($tagIds) {
-		if (!\is_array($tagIds)) {
-			$tagIds = [$tagIds];
-		}
-
-		$tagNotFoundException = null;
-		$tags = [];
-		try {
-			$tags = $this->getTagsByIds($tagIds);
-		} catch (TagNotFoundException $e) {
-			$tagNotFoundException = $e;
-
-			// Get existing tag objects for the hooks later
-			$existingTags = array_diff($tagIds, $tagNotFoundException->getMissingTags());
-			if (!empty($existingTags)) {
-				try {
-					$tags = $this->getTagsByIds($existingTags);
-				} catch (TagNotFoundException $e) {
-					// Ignore further errors...
-				}
-			}
-		}
-
-		// delete relationships first
-		$query = $this->connection->getQueryBuilder();
-		$query->delete(SystemTagObjectMapper::RELATION_TABLE)
-			->where($query->expr()->in('systemtagid', $query->createParameter('tagids')))
-			->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY)
-			->execute();
-
-		$query = $this->connection->getQueryBuilder();
-		$query->delete(self::TAG_TABLE)
-			->where($query->expr()->in('id', $query->createParameter('tagids')))
-			->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY)
-			->execute();
-
-		foreach ($tags as $tag) {
-			$this->dispatcher->dispatch(ManagerEvent::EVENT_DELETE, new ManagerEvent(
-				ManagerEvent::EVENT_DELETE, $tag
-			));
-		}
-
-		if ($tagNotFoundException !== null) {
-			throw new TagNotFoundException(
-				'Tag id(s) not found', 0, $tagNotFoundException, $tagNotFoundException->getMissingTags()
-			);
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function canUserAssignTag(ISystemTag $tag, IUser $user): bool {
-		// early check to avoid unneeded group lookups
-		if ($tag->isUserAssignable() && $tag->isUserVisible()) {
-			return true;
-		}
-
-		if ($this->groupManager->isAdmin($user->getUID())) {
-			return true;
-		}
-
-		if (!$tag->isUserVisible()) {
-			return false;
-		}
-
-		$groupIds = $this->groupManager->getUserGroupIds($user);
-		if (!empty($groupIds)) {
-			$matchingGroups = array_intersect($groupIds, $this->getTagGroups($tag));
-			if (!empty($matchingGroups)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function canUserSeeTag(ISystemTag $tag, IUser $user): bool {
-		if ($tag->isUserVisible()) {
-			return true;
-		}
-
-		if ($this->groupManager->isAdmin($user->getUID())) {
-			return true;
-		}
-
-		return false;
-	}
-
-	private function createSystemTagFromRow($row) {
-		return new SystemTag((string)$row['id'], $row['name'], (bool)$row['visibility'], (bool)$row['editable']);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function setTagGroups(ISystemTag $tag, array $groupIds) {
-		// delete relationships first
-		$this->connection->beginTransaction();
-		try {
-			$query = $this->connection->getQueryBuilder();
-			$query->delete(self::TAG_GROUP_TABLE)
-				->where($query->expr()->eq('systemtagid', $query->createNamedParameter($tag->getId())))
-				->execute();
-
-			// add each group id
-			$query = $this->connection->getQueryBuilder();
-			$query->insert(self::TAG_GROUP_TABLE)
-				->values([
-					'systemtagid' => $query->createNamedParameter($tag->getId()),
-					'gid' => $query->createParameter('gid'),
-				]);
-			foreach ($groupIds as $groupId) {
-				if ($groupId === '') {
-					continue;
-				}
-				$query->setParameter('gid', $groupId);
-				$query->execute();
-			}
-
-			$this->connection->commit();
-		} catch (\Exception $e) {
-			$this->connection->rollBack();
-			throw $e;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getTagGroups(ISystemTag $tag): array {
-		$groupIds = [];
-		$query = $this->connection->getQueryBuilder();
-		$query->select('gid')
-			->from(self::TAG_GROUP_TABLE)
-			->where($query->expr()->eq('systemtagid', $query->createNamedParameter($tag->getId())))
-			->orderBy('gid');
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$groupIds[] = $row['gid'];
-		}
-
-		$result->closeCursor();
-
-		return $groupIds;
-	}
+    public const TAG_TABLE = 'systemtag';
+    public const TAG_GROUP_TABLE = 'systemtag_group';
+
+    /** @var IDBConnection */
+    protected $connection;
+
+    /** @var EventDispatcherInterface */
+    protected $dispatcher;
+
+    /** @var IGroupManager */
+    protected $groupManager;
+
+    /**
+     * Prepared query for selecting tags directly
+     *
+     * @var \OCP\DB\QueryBuilder\IQueryBuilder
+     */
+    private $selectTagQuery;
+
+    /**
+     * Constructor.
+     *
+     * @param IDBConnection $connection database connection
+     * @param IGroupManager $groupManager
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(
+        IDBConnection $connection,
+        IGroupManager $groupManager,
+        EventDispatcherInterface $dispatcher
+    ) {
+        $this->connection = $connection;
+        $this->groupManager = $groupManager;
+        $this->dispatcher = $dispatcher;
+
+        $query = $this->connection->getQueryBuilder();
+        $this->selectTagQuery = $query->select('*')
+            ->from(self::TAG_TABLE)
+            ->where($query->expr()->eq('name', $query->createParameter('name')))
+            ->andWhere($query->expr()->eq('visibility', $query->createParameter('visibility')))
+            ->andWhere($query->expr()->eq('editable', $query->createParameter('editable')));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTagsByIds($tagIds): array {
+        if (!\is_array($tagIds)) {
+            $tagIds = [$tagIds];
+        }
+
+        $tags = [];
+
+        // note: not all databases will fail if it's a string or starts with a number
+        foreach ($tagIds as $tagId) {
+            if (!is_numeric($tagId)) {
+                throw new \InvalidArgumentException('Tag id must be integer');
+            }
+        }
+
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from(self::TAG_TABLE)
+            ->where($query->expr()->in('id', $query->createParameter('tagids')))
+            ->addOrderBy('name', 'ASC')
+            ->addOrderBy('visibility', 'ASC')
+            ->addOrderBy('editable', 'ASC')
+            ->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY);
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $tags[$row['id']] = $this->createSystemTagFromRow($row);
+        }
+
+        $result->closeCursor();
+
+        if (\count($tags) !== \count($tagIds)) {
+            throw new TagNotFoundException(
+                'Tag id(s) not found', 0, null, array_diff($tagIds, array_keys($tags))
+            );
+        }
+
+        return $tags;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAllTags($visibilityFilter = null, $nameSearchPattern = null): array {
+        $tags = [];
+
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from(self::TAG_TABLE);
+
+        if (!\is_null($visibilityFilter)) {
+            $query->andWhere($query->expr()->eq('visibility', $query->createNamedParameter((int)$visibilityFilter)));
+        }
+
+        if (!empty($nameSearchPattern)) {
+            $query->andWhere(
+                $query->expr()->like(
+                    'name',
+                    $query->createNamedParameter('%' . $this->connection->escapeLikeParameter($nameSearchPattern). '%')
+                )
+            );
+        }
+
+        $query
+            ->addOrderBy('name', 'ASC')
+            ->addOrderBy('visibility', 'ASC')
+            ->addOrderBy('editable', 'ASC');
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $tags[$row['id']] = $this->createSystemTagFromRow($row);
+        }
+
+        $result->closeCursor();
+
+        return $tags;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag {
+        $result = $this->selectTagQuery
+            ->setParameter('name', $tagName)
+            ->setParameter('visibility', $userVisible ? 1 : 0)
+            ->setParameter('editable', $userAssignable ? 1 : 0)
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if (!$row) {
+            throw new TagNotFoundException(
+                'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') does not exist'
+            );
+        }
+
+        return $this->createSystemTagFromRow($row);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createTag(string $tagName, bool $userVisible, bool $userAssignable): ISystemTag {
+        $query = $this->connection->getQueryBuilder();
+        $query->insert(self::TAG_TABLE)
+            ->values([
+                'name' => $query->createNamedParameter($tagName),
+                'visibility' => $query->createNamedParameter($userVisible ? 1 : 0),
+                'editable' => $query->createNamedParameter($userAssignable ? 1 : 0),
+            ]);
+
+        try {
+            $query->execute();
+        } catch (UniqueConstraintViolationException $e) {
+            throw new TagAlreadyExistsException(
+                'Tag ("' . $tagName . '", '. $userVisible . ', ' . $userAssignable . ') already exists',
+                0,
+                $e
+            );
+        }
+
+        $tagId = $query->getLastInsertId();
+
+        $tag = new SystemTag(
+            (string)$tagId,
+            $tagName,
+            $userVisible,
+            $userAssignable
+        );
+
+        $this->dispatcher->dispatch(ManagerEvent::EVENT_CREATE, new ManagerEvent(
+            ManagerEvent::EVENT_CREATE, $tag
+        ));
+
+        return $tag;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function updateTag(string $tagId, string $newName, bool $userVisible, bool $userAssignable) {
+        try {
+            $tags = $this->getTagsByIds($tagId);
+        } catch (TagNotFoundException $e) {
+            throw new TagNotFoundException(
+                'Tag does not exist', 0, null, [$tagId]
+            );
+        }
+
+        $beforeUpdate = array_shift($tags);
+        $afterUpdate = new SystemTag(
+            $tagId,
+            $newName,
+            $userVisible,
+            $userAssignable
+        );
+
+        $query = $this->connection->getQueryBuilder();
+        $query->update(self::TAG_TABLE)
+            ->set('name', $query->createParameter('name'))
+            ->set('visibility', $query->createParameter('visibility'))
+            ->set('editable', $query->createParameter('editable'))
+            ->where($query->expr()->eq('id', $query->createParameter('tagid')))
+            ->setParameter('name', $newName)
+            ->setParameter('visibility', $userVisible ? 1 : 0)
+            ->setParameter('editable', $userAssignable ? 1 : 0)
+            ->setParameter('tagid', $tagId);
+
+        try {
+            if ($query->execute() === 0) {
+                throw new TagNotFoundException(
+                    'Tag does not exist', 0, null, [$tagId]
+                );
+            }
+        } catch (UniqueConstraintViolationException $e) {
+            throw new TagAlreadyExistsException(
+                'Tag ("' . $newName . '", '. $userVisible . ', ' . $userAssignable . ') already exists',
+                0,
+                $e
+            );
+        }
+
+        $this->dispatcher->dispatch(ManagerEvent::EVENT_UPDATE, new ManagerEvent(
+            ManagerEvent::EVENT_UPDATE, $afterUpdate, $beforeUpdate
+        ));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function deleteTags($tagIds) {
+        if (!\is_array($tagIds)) {
+            $tagIds = [$tagIds];
+        }
+
+        $tagNotFoundException = null;
+        $tags = [];
+        try {
+            $tags = $this->getTagsByIds($tagIds);
+        } catch (TagNotFoundException $e) {
+            $tagNotFoundException = $e;
+
+            // Get existing tag objects for the hooks later
+            $existingTags = array_diff($tagIds, $tagNotFoundException->getMissingTags());
+            if (!empty($existingTags)) {
+                try {
+                    $tags = $this->getTagsByIds($existingTags);
+                } catch (TagNotFoundException $e) {
+                    // Ignore further errors...
+                }
+            }
+        }
+
+        // delete relationships first
+        $query = $this->connection->getQueryBuilder();
+        $query->delete(SystemTagObjectMapper::RELATION_TABLE)
+            ->where($query->expr()->in('systemtagid', $query->createParameter('tagids')))
+            ->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY)
+            ->execute();
+
+        $query = $this->connection->getQueryBuilder();
+        $query->delete(self::TAG_TABLE)
+            ->where($query->expr()->in('id', $query->createParameter('tagids')))
+            ->setParameter('tagids', $tagIds, IQueryBuilder::PARAM_INT_ARRAY)
+            ->execute();
+
+        foreach ($tags as $tag) {
+            $this->dispatcher->dispatch(ManagerEvent::EVENT_DELETE, new ManagerEvent(
+                ManagerEvent::EVENT_DELETE, $tag
+            ));
+        }
+
+        if ($tagNotFoundException !== null) {
+            throw new TagNotFoundException(
+                'Tag id(s) not found', 0, $tagNotFoundException, $tagNotFoundException->getMissingTags()
+            );
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function canUserAssignTag(ISystemTag $tag, IUser $user): bool {
+        // early check to avoid unneeded group lookups
+        if ($tag->isUserAssignable() && $tag->isUserVisible()) {
+            return true;
+        }
+
+        if ($this->groupManager->isAdmin($user->getUID())) {
+            return true;
+        }
+
+        if (!$tag->isUserVisible()) {
+            return false;
+        }
+
+        $groupIds = $this->groupManager->getUserGroupIds($user);
+        if (!empty($groupIds)) {
+            $matchingGroups = array_intersect($groupIds, $this->getTagGroups($tag));
+            if (!empty($matchingGroups)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function canUserSeeTag(ISystemTag $tag, IUser $user): bool {
+        if ($tag->isUserVisible()) {
+            return true;
+        }
+
+        if ($this->groupManager->isAdmin($user->getUID())) {
+            return true;
+        }
+
+        return false;
+    }
+
+    private function createSystemTagFromRow($row) {
+        return new SystemTag((string)$row['id'], $row['name'], (bool)$row['visibility'], (bool)$row['editable']);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setTagGroups(ISystemTag $tag, array $groupIds) {
+        // delete relationships first
+        $this->connection->beginTransaction();
+        try {
+            $query = $this->connection->getQueryBuilder();
+            $query->delete(self::TAG_GROUP_TABLE)
+                ->where($query->expr()->eq('systemtagid', $query->createNamedParameter($tag->getId())))
+                ->execute();
+
+            // add each group id
+            $query = $this->connection->getQueryBuilder();
+            $query->insert(self::TAG_GROUP_TABLE)
+                ->values([
+                    'systemtagid' => $query->createNamedParameter($tag->getId()),
+                    'gid' => $query->createParameter('gid'),
+                ]);
+            foreach ($groupIds as $groupId) {
+                if ($groupId === '') {
+                    continue;
+                }
+                $query->setParameter('gid', $groupId);
+                $query->execute();
+            }
+
+            $this->connection->commit();
+        } catch (\Exception $e) {
+            $this->connection->rollBack();
+            throw $e;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTagGroups(ISystemTag $tag): array {
+        $groupIds = [];
+        $query = $this->connection->getQueryBuilder();
+        $query->select('gid')
+            ->from(self::TAG_GROUP_TABLE)
+            ->where($query->expr()->eq('systemtagid', $query->createNamedParameter($tag->getId())))
+            ->orderBy('gid');
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $groupIds[] = $row['gid'];
+        }
+
+        $result->closeCursor();
+
+        return $groupIds;
+    }
 }

lib/private/Files/ObjectStore/NoopScanner.php

Indentation +44 added lines, -44 removed lines

@@ -31,52 +31,52 @@
 use OC\Files\Storage\Storage;
 
 class NoopScanner extends Scanner {
-	public function __construct(Storage $storage) {
-		//we don't need the storage, so do nothing here
-	}
+    public function __construct(Storage $storage) {
+        //we don't need the storage, so do nothing here
+    }
 
-	/**
-	 * scan a single file and store it in the cache
-	 *
-	 * @param string $file
-	 * @param int $reuseExisting
-	 * @param int $parentId
-	 * @param array|null $cacheData existing data in the cache for the file to be scanned
-	 * @return array an array of metadata of the scanned file
-	 */
-	public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true, $data = null) {
-		return [];
-	}
+    /**
+     * scan a single file and store it in the cache
+     *
+     * @param string $file
+     * @param int $reuseExisting
+     * @param int $parentId
+     * @param array|null $cacheData existing data in the cache for the file to be scanned
+     * @return array an array of metadata of the scanned file
+     */
+    public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true, $data = null) {
+        return [];
+    }
 
-	/**
-	 * scan a folder and all it's children
-	 *
-	 * @param string $path
-	 * @param bool $recursive
-	 * @param int $reuse
-	 * @return array with the meta data of the scanned file or folder
-	 */
-	public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) {
-		return [];
-	}
+    /**
+     * scan a folder and all it's children
+     *
+     * @param string $path
+     * @param bool $recursive
+     * @param int $reuse
+     * @return array with the meta data of the scanned file or folder
+     */
+    public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) {
+        return [];
+    }
 
-	/**
-	 * scan all the files and folders in a folder
-	 *
-	 * @param string $path
-	 * @param bool $recursive
-	 * @param int $reuse
-	 * @param array $folderData existing cache data for the folder to be scanned
-	 * @return int the size of the scanned folder or -1 if the size is unknown at this stage
-	 */
-	protected function scanChildren($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $folderId = null, $lock = true) {
-		return 0;
-	}
+    /**
+     * scan all the files and folders in a folder
+     *
+     * @param string $path
+     * @param bool $recursive
+     * @param int $reuse
+     * @param array $folderData existing cache data for the folder to be scanned
+     * @return int the size of the scanned folder or -1 if the size is unknown at this stage
+     */
+    protected function scanChildren($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $folderId = null, $lock = true) {
+        return 0;
+    }
 
-	/**
-	 * walk over any folders that are not fully scanned yet and scan them
-	 */
-	public function backgroundScan() {
-		//noop
-	}
+    /**
+     * walk over any folders that are not fully scanned yet and scan them
+     */
+    public function backgroundScan() {
+        //noop
+    }
 }

lib/private/Files/Cache/Wrapper/CacheJail.php

Indentation +291 added lines, -291 removed lines

@@ -38,295 +38,295 @@
  * Jail to a subdirectory of the wrapped cache
  */
 class CacheJail extends CacheWrapper {
-	/**
-	 * @var string
-	 */
-	protected $root;
-
-	/**
-	 * @param \OCP\Files\Cache\ICache $cache
-	 * @param string $root
-	 */
-	public function __construct($cache, $root) {
-		parent::__construct($cache);
-		$this->root = $root;
-	}
-
-	protected function getRoot() {
-		return $this->root;
-	}
-
-	protected function getSourcePath($path) {
-		if ($path === '') {
-			return $this->getRoot();
-		} else {
-			return $this->getRoot() . '/' . ltrim($path, '/');
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return null|string the jailed path or null if the path is outside the jail
-	 */
-	protected function getJailedPath($path) {
-		if ($this->getRoot() === '') {
-			return $path;
-		}
-		$rootLength = strlen($this->getRoot()) + 1;
-		if ($path === $this->getRoot()) {
-			return '';
-		} elseif (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
-			return substr($path, $rootLength);
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @param ICacheEntry|array $entry
-	 * @return array
-	 */
-	protected function formatCacheEntry($entry) {
-		if (isset($entry['path'])) {
-			$entry['path'] = $this->getJailedPath($entry['path']);
-		}
-		return $entry;
-	}
-
-	protected function filterCacheEntry($entry) {
-		$rootLength = strlen($this->getRoot()) + 1;
-		return $rootLength === 1 || ($entry['path'] === $this->getRoot()) || (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
-	}
-
-	/**
-	 * get the stored metadata of a file or folder
-	 *
-	 * @param string /int $file
-	 * @return ICacheEntry|false
-	 */
-	public function get($file) {
-		if (is_string($file) or $file == '') {
-			$file = $this->getSourcePath($file);
-		}
-		return parent::get($file);
-	}
-
-	/**
-	 * insert meta data for a new file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 */
-	public function insert($file, array $data) {
-		return $this->getCache()->insert($this->getSourcePath($file), $data);
-	}
-
-	/**
-	 * update the metadata in the cache
-	 *
-	 * @param int $id
-	 * @param array $data
-	 */
-	public function update($id, array $data) {
-		$this->getCache()->update($id, $data);
-	}
-
-	/**
-	 * get the file id for a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getId($file) {
-		return $this->getCache()->getId($this->getSourcePath($file));
-	}
-
-	/**
-	 * get the id of the parent folder of a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getParentId($file) {
-		return $this->getCache()->getParentId($this->getSourcePath($file));
-	}
-
-	/**
-	 * check if a file is available in the cache
-	 *
-	 * @param string $file
-	 * @return bool
-	 */
-	public function inCache($file) {
-		return $this->getCache()->inCache($this->getSourcePath($file));
-	}
-
-	/**
-	 * remove a file or folder from the cache
-	 *
-	 * @param string $file
-	 */
-	public function remove($file) {
-		$this->getCache()->remove($this->getSourcePath($file));
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param string $source
-	 * @param string $target
-	 */
-	public function move($source, $target) {
-		$this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
-	}
-
-	/**
-	 * Get the storage id and path needed for a move
-	 *
-	 * @param string $path
-	 * @return array [$storageId, $internalPath]
-	 */
-	protected function getMoveInfo($path) {
-		return [$this->getNumericStorageId(), $this->getSourcePath($path)];
-	}
-
-	/**
-	 * remove all entries for files that are stored on the storage from the cache
-	 */
-	public function clear() {
-		$this->getCache()->remove($this->getRoot());
-	}
-
-	/**
-	 * @param string $file
-	 *
-	 * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
-	 */
-	public function getStatus($file) {
-		return $this->getCache()->getStatus($this->getSourcePath($file));
-	}
-
-	private function formatSearchResults($results) {
-		$results = array_filter($results, [$this, 'filterCacheEntry']);
-		$results = array_values($results);
-		return array_map([$this, 'formatCacheEntry'], $results);
-	}
-
-	/**
-	 * search for files matching $pattern
-	 *
-	 * @param string $pattern
-	 * @return array an array of file data
-	 */
-	public function search($pattern) {
-		$results = $this->getCache()->search($pattern);
-		return $this->formatSearchResults($results);
-	}
-
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype
-	 * @return array
-	 */
-	public function searchByMime($mimetype) {
-		$results = $this->getCache()->searchByMime($mimetype);
-		return $this->formatSearchResults($results);
-	}
-
-	public function searchQuery(ISearchQuery $query) {
-		$simpleQuery = new SearchQuery($query->getSearchOperation(), 0, 0, $query->getOrder(), $query->getUser());
-		$results = $this->getCache()->searchQuery($simpleQuery);
-		$results = $this->formatSearchResults($results);
-
-		$limit = $query->getLimit() === 0 ? null : $query->getLimit();
-		$results = array_slice($results, $query->getOffset(), $limit);
-
-		return $results;
-	}
-
-	/**
-	 * update the folder size and the size of all parent folders
-	 *
-	 * @param string|boolean $path
-	 * @param array $data (optional) meta data of the folder
-	 */
-	public function correctFolderSize($path, $data = null, $isBackgroundScan = false) {
-		if ($this->getCache() instanceof Cache) {
-			$this->getCache()->correctFolderSize($this->getSourcePath($path), $data, $isBackgroundScan);
-		}
-	}
-
-	/**
-	 * get the size of a folder and set it in the cache
-	 *
-	 * @param string $path
-	 * @param array $entry (optional) meta data of the folder
-	 * @return int
-	 */
-	public function calculateFolderSize($path, $entry = null) {
-		if ($this->getCache() instanceof Cache) {
-			return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
-		} else {
-			return 0;
-		}
-	}
-
-	/**
-	 * get all file ids on the files on the storage
-	 *
-	 * @return int[]
-	 */
-	public function getAll() {
-		// not supported
-		return [];
-	}
-
-	/**
-	 * find a folder in the cache which has not been fully scanned
-	 *
-	 * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
-	 * likely the folder where we stopped scanning previously
-	 *
-	 * @return string|bool the path of the folder or false when no folder matched
-	 */
-	public function getIncomplete() {
-		// not supported
-		return false;
-	}
-
-	/**
-	 * get the path of a file on this storage by it's id
-	 *
-	 * @param int $id
-	 * @return string|null
-	 */
-	public function getPathById($id) {
-		$path = $this->getCache()->getPathById($id);
-		if ($path === null) {
-			return null;
-		}
-
-		return $this->getJailedPath($path);
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * Note that this should make sure the entries are removed from the source cache
-	 *
-	 * @param \OCP\Files\Cache\ICache $sourceCache
-	 * @param string $sourcePath
-	 * @param string $targetPath
-	 */
-	public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
-		if ($sourceCache === $this) {
-			return $this->move($sourcePath, $targetPath);
-		}
-		return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
-	}
+    /**
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * @param \OCP\Files\Cache\ICache $cache
+     * @param string $root
+     */
+    public function __construct($cache, $root) {
+        parent::__construct($cache);
+        $this->root = $root;
+    }
+
+    protected function getRoot() {
+        return $this->root;
+    }
+
+    protected function getSourcePath($path) {
+        if ($path === '') {
+            return $this->getRoot();
+        } else {
+            return $this->getRoot() . '/' . ltrim($path, '/');
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return null|string the jailed path or null if the path is outside the jail
+     */
+    protected function getJailedPath($path) {
+        if ($this->getRoot() === '') {
+            return $path;
+        }
+        $rootLength = strlen($this->getRoot()) + 1;
+        if ($path === $this->getRoot()) {
+            return '';
+        } elseif (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
+            return substr($path, $rootLength);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @param ICacheEntry|array $entry
+     * @return array
+     */
+    protected function formatCacheEntry($entry) {
+        if (isset($entry['path'])) {
+            $entry['path'] = $this->getJailedPath($entry['path']);
+        }
+        return $entry;
+    }
+
+    protected function filterCacheEntry($entry) {
+        $rootLength = strlen($this->getRoot()) + 1;
+        return $rootLength === 1 || ($entry['path'] === $this->getRoot()) || (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
+    }
+
+    /**
+     * get the stored metadata of a file or folder
+     *
+     * @param string /int $file
+     * @return ICacheEntry|false
+     */
+    public function get($file) {
+        if (is_string($file) or $file == '') {
+            $file = $this->getSourcePath($file);
+        }
+        return parent::get($file);
+    }
+
+    /**
+     * insert meta data for a new file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     */
+    public function insert($file, array $data) {
+        return $this->getCache()->insert($this->getSourcePath($file), $data);
+    }
+
+    /**
+     * update the metadata in the cache
+     *
+     * @param int $id
+     * @param array $data
+     */
+    public function update($id, array $data) {
+        $this->getCache()->update($id, $data);
+    }
+
+    /**
+     * get the file id for a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getId($file) {
+        return $this->getCache()->getId($this->getSourcePath($file));
+    }
+
+    /**
+     * get the id of the parent folder of a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getParentId($file) {
+        return $this->getCache()->getParentId($this->getSourcePath($file));
+    }
+
+    /**
+     * check if a file is available in the cache
+     *
+     * @param string $file
+     * @return bool
+     */
+    public function inCache($file) {
+        return $this->getCache()->inCache($this->getSourcePath($file));
+    }
+
+    /**
+     * remove a file or folder from the cache
+     *
+     * @param string $file
+     */
+    public function remove($file) {
+        $this->getCache()->remove($this->getSourcePath($file));
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param string $source
+     * @param string $target
+     */
+    public function move($source, $target) {
+        $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
+    }
+
+    /**
+     * Get the storage id and path needed for a move
+     *
+     * @param string $path
+     * @return array [$storageId, $internalPath]
+     */
+    protected function getMoveInfo($path) {
+        return [$this->getNumericStorageId(), $this->getSourcePath($path)];
+    }
+
+    /**
+     * remove all entries for files that are stored on the storage from the cache
+     */
+    public function clear() {
+        $this->getCache()->remove($this->getRoot());
+    }
+
+    /**
+     * @param string $file
+     *
+     * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
+     */
+    public function getStatus($file) {
+        return $this->getCache()->getStatus($this->getSourcePath($file));
+    }
+
+    private function formatSearchResults($results) {
+        $results = array_filter($results, [$this, 'filterCacheEntry']);
+        $results = array_values($results);
+        return array_map([$this, 'formatCacheEntry'], $results);
+    }
+
+    /**
+     * search for files matching $pattern
+     *
+     * @param string $pattern
+     * @return array an array of file data
+     */
+    public function search($pattern) {
+        $results = $this->getCache()->search($pattern);
+        return $this->formatSearchResults($results);
+    }
+
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype
+     * @return array
+     */
+    public function searchByMime($mimetype) {
+        $results = $this->getCache()->searchByMime($mimetype);
+        return $this->formatSearchResults($results);
+    }
+
+    public function searchQuery(ISearchQuery $query) {
+        $simpleQuery = new SearchQuery($query->getSearchOperation(), 0, 0, $query->getOrder(), $query->getUser());
+        $results = $this->getCache()->searchQuery($simpleQuery);
+        $results = $this->formatSearchResults($results);
+
+        $limit = $query->getLimit() === 0 ? null : $query->getLimit();
+        $results = array_slice($results, $query->getOffset(), $limit);
+
+        return $results;
+    }
+
+    /**
+     * update the folder size and the size of all parent folders
+     *
+     * @param string|boolean $path
+     * @param array $data (optional) meta data of the folder
+     */
+    public function correctFolderSize($path, $data = null, $isBackgroundScan = false) {
+        if ($this->getCache() instanceof Cache) {
+            $this->getCache()->correctFolderSize($this->getSourcePath($path), $data, $isBackgroundScan);
+        }
+    }
+
+    /**
+     * get the size of a folder and set it in the cache
+     *
+     * @param string $path
+     * @param array $entry (optional) meta data of the folder
+     * @return int
+     */
+    public function calculateFolderSize($path, $entry = null) {
+        if ($this->getCache() instanceof Cache) {
+            return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
+        } else {
+            return 0;
+        }
+    }
+
+    /**
+     * get all file ids on the files on the storage
+     *
+     * @return int[]
+     */
+    public function getAll() {
+        // not supported
+        return [];
+    }
+
+    /**
+     * find a folder in the cache which has not been fully scanned
+     *
+     * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
+     * use the one with the highest id gives the best result with the background scanner, since that is most
+     * likely the folder where we stopped scanning previously
+     *
+     * @return string|bool the path of the folder or false when no folder matched
+     */
+    public function getIncomplete() {
+        // not supported
+        return false;
+    }
+
+    /**
+     * get the path of a file on this storage by it's id
+     *
+     * @param int $id
+     * @return string|null
+     */
+    public function getPathById($id) {
+        $path = $this->getCache()->getPathById($id);
+        if ($path === null) {
+            return null;
+        }
+
+        return $this->getJailedPath($path);
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * Note that this should make sure the entries are removed from the source cache
+     *
+     * @param \OCP\Files\Cache\ICache $sourceCache
+     * @param string $sourcePath
+     * @param string $targetPath
+     */
+    public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
+        if ($sourceCache === $this) {
+            return $this->move($sourcePath, $targetPath);
+        }
+        return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
+    }
 }

lib/private/ContactsManager.php

Indentation +173 added lines, -173 removed lines

@@ -37,177 +37,177 @@
 
 class ContactsManager implements IManager {
 
-	/**
-	 * This function is used to search and find contacts within the users address books.
-	 * In case $pattern is empty all contacts will be returned.
-	 *
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @param array $options = array() to define the search behavior
-	 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
-	 * 	- 'limit' - Set a numeric limit for the search results
-	 * 	- 'offset' - Set the offset for the limited search results
-	 * @return array an array of contacts which are arrays of key-value-pairs
-	 */
-	public function search($pattern, $searchProperties = [], $options = []) {
-		$this->loadAddressBooks();
-		$result = [];
-		foreach ($this->addressBooks as $addressBook) {
-			$r = $addressBook->search($pattern, $searchProperties, $options);
-			$contacts = [];
-			foreach ($r as $c) {
-				$c['addressbook-key'] = $addressBook->getKey();
-				$contacts[] = $c;
-			}
-			$result = array_merge($result, $contacts);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * This function can be used to delete the contact identified by the given id
-	 *
-	 * @param object $id the unique identifier to a contact
-	 * @param string $address_book_key identifier of the address book in which the contact shall be deleted
-	 * @return bool successful or not
-	 */
-	public function delete($id, $address_book_key) {
-		$addressBook = $this->getAddressBook($address_book_key);
-		if (!$addressBook) {
-			return null;
-		}
-
-		if ($addressBook->getPermissions() & Constants::PERMISSION_DELETE) {
-			return $addressBook->delete($id);
-		}
-
-		return null;
-	}
-
-	/**
-	 * This function is used to create a new contact if 'id' is not given or not present.
-	 * Otherwise the contact will be updated by replacing the entire data set.
-	 *
-	 * @param array $properties this array if key-value-pairs defines a contact
-	 * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
-	 * @return array representing the contact just created or updated
-	 */
-	public function createOrUpdate($properties, $address_book_key) {
-		$addressBook = $this->getAddressBook($address_book_key);
-		if (!$addressBook) {
-			return null;
-		}
-
-		if ($addressBook->getPermissions() & Constants::PERMISSION_CREATE) {
-			return $addressBook->createOrUpdate($properties);
-		}
-
-		return null;
-	}
-
-	/**
-	 * Check if contacts are available (e.g. contacts app enabled)
-	 *
-	 * @return bool true if enabled, false if not
-	 */
-	public function isEnabled() {
-		return !empty($this->addressBooks) || !empty($this->addressBookLoaders);
-	}
-
-	/**
-	 * @param IAddressBook $addressBook
-	 */
-	public function registerAddressBook(IAddressBook $addressBook) {
-		$this->addressBooks[$addressBook->getKey()] = $addressBook;
-	}
-
-	/**
-	 * @param IAddressBook $addressBook
-	 */
-	public function unregisterAddressBook(IAddressBook $addressBook) {
-		unset($this->addressBooks[$addressBook->getKey()]);
-	}
-
-	/**
-	 * Return a list of the user's addressbooks display names
-	 * ! The addressBook displayName are not unique, please use getUserAddressBooks
-	 *
-	 * @return IAddressBook[]
-	 * @since 6.0.0
-	 * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
-	 */
-	public function getAddressBooks() {
-		$this->loadAddressBooks();
-		$result = [];
-		foreach ($this->addressBooks as $addressBook) {
-			$result[$addressBook->getKey()] = $addressBook->getDisplayName();
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Return a list of the user's addressbooks
-	 *
-	 * @return IAddressBook[]
-	 * @since 16.0.0
-	 */
-	public function getUserAddressBooks(): array {
-		$this->loadAddressBooks();
-		return $this->addressBooks;
-	}
-
-	/**
-	 * removes all registered address book instances
-	 */
-	public function clear() {
-		$this->addressBooks = [];
-		$this->addressBookLoaders = [];
-	}
-
-	/**
-	 * @var IAddressBook[] which holds all registered address books
-	 */
-	private $addressBooks = [];
-
-	/**
-	 * @var \Closure[] to call to load/register address books
-	 */
-	private $addressBookLoaders = [];
-
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * address books are actually requested
-	 *
-	 * @param \Closure $callable
-	 */
-	public function register(\Closure $callable) {
-		$this->addressBookLoaders[] = $callable;
-	}
-
-	/**
-	 * Get (and load when needed) the address book for $key
-	 *
-	 * @param string $addressBookKey
-	 * @return IAddressBook
-	 */
-	protected function getAddressBook($addressBookKey) {
-		$this->loadAddressBooks();
-		if (!array_key_exists($addressBookKey, $this->addressBooks)) {
-			return null;
-		}
-
-		return $this->addressBooks[$addressBookKey];
-	}
-
-	/**
-	 * Load all address books registered with 'register'
-	 */
-	protected function loadAddressBooks() {
-		foreach ($this->addressBookLoaders as $callable) {
-			$callable($this);
-		}
-		$this->addressBookLoaders = [];
-	}
+    /**
+     * This function is used to search and find contacts within the users address books.
+     * In case $pattern is empty all contacts will be returned.
+     *
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @param array $options = array() to define the search behavior
+     * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
+     * 	- 'limit' - Set a numeric limit for the search results
+     * 	- 'offset' - Set the offset for the limited search results
+     * @return array an array of contacts which are arrays of key-value-pairs
+     */
+    public function search($pattern, $searchProperties = [], $options = []) {
+        $this->loadAddressBooks();
+        $result = [];
+        foreach ($this->addressBooks as $addressBook) {
+            $r = $addressBook->search($pattern, $searchProperties, $options);
+            $contacts = [];
+            foreach ($r as $c) {
+                $c['addressbook-key'] = $addressBook->getKey();
+                $contacts[] = $c;
+            }
+            $result = array_merge($result, $contacts);
+        }
+
+        return $result;
+    }
+
+    /**
+     * This function can be used to delete the contact identified by the given id
+     *
+     * @param object $id the unique identifier to a contact
+     * @param string $address_book_key identifier of the address book in which the contact shall be deleted
+     * @return bool successful or not
+     */
+    public function delete($id, $address_book_key) {
+        $addressBook = $this->getAddressBook($address_book_key);
+        if (!$addressBook) {
+            return null;
+        }
+
+        if ($addressBook->getPermissions() & Constants::PERMISSION_DELETE) {
+            return $addressBook->delete($id);
+        }
+
+        return null;
+    }
+
+    /**
+     * This function is used to create a new contact if 'id' is not given or not present.
+     * Otherwise the contact will be updated by replacing the entire data set.
+     *
+     * @param array $properties this array if key-value-pairs defines a contact
+     * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
+     * @return array representing the contact just created or updated
+     */
+    public function createOrUpdate($properties, $address_book_key) {
+        $addressBook = $this->getAddressBook($address_book_key);
+        if (!$addressBook) {
+            return null;
+        }
+
+        if ($addressBook->getPermissions() & Constants::PERMISSION_CREATE) {
+            return $addressBook->createOrUpdate($properties);
+        }
+
+        return null;
+    }
+
+    /**
+     * Check if contacts are available (e.g. contacts app enabled)
+     *
+     * @return bool true if enabled, false if not
+     */
+    public function isEnabled() {
+        return !empty($this->addressBooks) || !empty($this->addressBookLoaders);
+    }
+
+    /**
+     * @param IAddressBook $addressBook
+     */
+    public function registerAddressBook(IAddressBook $addressBook) {
+        $this->addressBooks[$addressBook->getKey()] = $addressBook;
+    }
+
+    /**
+     * @param IAddressBook $addressBook
+     */
+    public function unregisterAddressBook(IAddressBook $addressBook) {
+        unset($this->addressBooks[$addressBook->getKey()]);
+    }
+
+    /**
+     * Return a list of the user's addressbooks display names
+     * ! The addressBook displayName are not unique, please use getUserAddressBooks
+     *
+     * @return IAddressBook[]
+     * @since 6.0.0
+     * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
+     */
+    public function getAddressBooks() {
+        $this->loadAddressBooks();
+        $result = [];
+        foreach ($this->addressBooks as $addressBook) {
+            $result[$addressBook->getKey()] = $addressBook->getDisplayName();
+        }
+
+        return $result;
+    }
+
+    /**
+     * Return a list of the user's addressbooks
+     *
+     * @return IAddressBook[]
+     * @since 16.0.0
+     */
+    public function getUserAddressBooks(): array {
+        $this->loadAddressBooks();
+        return $this->addressBooks;
+    }
+
+    /**
+     * removes all registered address book instances
+     */
+    public function clear() {
+        $this->addressBooks = [];
+        $this->addressBookLoaders = [];
+    }
+
+    /**
+     * @var IAddressBook[] which holds all registered address books
+     */
+    private $addressBooks = [];
+
+    /**
+     * @var \Closure[] to call to load/register address books
+     */
+    private $addressBookLoaders = [];
+
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * address books are actually requested
+     *
+     * @param \Closure $callable
+     */
+    public function register(\Closure $callable) {
+        $this->addressBookLoaders[] = $callable;
+    }
+
+    /**
+     * Get (and load when needed) the address book for $key
+     *
+     * @param string $addressBookKey
+     * @return IAddressBook
+     */
+    protected function getAddressBook($addressBookKey) {
+        $this->loadAddressBooks();
+        if (!array_key_exists($addressBookKey, $this->addressBooks)) {
+            return null;
+        }
+
+        return $this->addressBooks[$addressBookKey];
+    }
+
+    /**
+     * Load all address books registered with 'register'
+     */
+    protected function loadAddressBooks() {
+        foreach ($this->addressBookLoaders as $callable) {
+            $callable($this);
+        }
+        $this->addressBookLoaders = [];
+    }
 }