nextcloud / server

lib/private/Share/Share.php

Indentation +933 added lines, -933 removed lines

@@ -50,937 +50,937 @@
  *  - post_shared
  */
 class Share extends Constants {
-	/** CRUDS permissions (Create, Read, Update, Delete, Share) using a bitmask
-	 * Construct permissions for share() and setPermissions with Or (|) e.g.
-	 * Give user read and update permissions: PERMISSION_READ | PERMISSION_UPDATE
-	 *
-	 * Check if permission is granted with And (&) e.g. Check if delete is
-	 * granted: if ($permissions & PERMISSION_DELETE)
-	 *
-	 * Remove permissions with And (&) and Not (~) e.g. Remove the update
-	 * permission: $permissions &= ~PERMISSION_UPDATE
-	 *
-	 * Apps are required to handle permissions on their own, this class only
-	 * stores and manages the permissions of shares
-	 *
-	 * @see lib/public/Constants.php
-	 */
-
-	/**
-	 * Register a sharing backend class that implements OCP\Share_Backend for an item type
-	 *
-	 * @param string $itemType Item type
-	 * @param string $class Backend class
-	 * @param string $collectionOf (optional) Depends on item type
-	 * @param array $supportedFileExtensions (optional) List of supported file extensions if this item type depends on files
-	 * @return boolean true if backend is registered or false if error
-	 */
-	public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
-		if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_enabled', 'yes') == 'yes') {
-			if (!isset(self::$backendTypes[$itemType])) {
-				self::$backendTypes[$itemType] = [
-					'class' => $class,
-					'collectionOf' => $collectionOf,
-					'supportedFileExtensions' => $supportedFileExtensions
-				];
-				return true;
-			}
-			\OC::$server->get(LoggerInterface::class)->warning(
-				'Sharing backend '.$class.' not registered, '.self::$backendTypes[$itemType]['class']
-				.' is already registered for '.$itemType,
-				['app' => 'files_sharing']);
-		}
-		return false;
-	}
-
-	/**
-	 * Get the items of item type shared with the current user
-	 *
-	 * @param string $itemType
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters (optional)
-	 * @param int $limit Number of items to return (optional) Returns all by default
-	 * @param boolean $includeCollections (optional)
-	 * @return mixed Return depends on format
-	 * @deprecated TESTS ONLY - this methods is only used by tests
-	 * called like this:
-	 * \OC\Share\Share::getItemsSharedWith('folder'); (apps/files_sharing/tests/UpdaterTest.php)
-	 */
-	public static function getItemsSharedWith() {
-		return self::getItems('folder', null, self::$shareTypeUserAndGroups, \OC_User::getUser());
-	}
-
-	/**
-	 * Get the items of item type shared with a user
-	 *
-	 * @param string $itemType
-	 * @param string $user id for which user we want the shares
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters (optional)
-	 * @param int $limit Number of items to return (optional) Returns all by default
-	 * @param boolean $includeCollections (optional)
-	 * @return mixed Return depends on format
-	 * @deprecated TESTS ONLY - this methods is only used by tests
-	 * called like this:
-	 * \OC\Share\Share::getItemsSharedWithUser('test', $shareWith); (tests/lib/Share/Backend.php)
-	 */
-	public static function getItemsSharedWithUser($itemType, $user) {
-		return self::getItems('test', null, self::$shareTypeUserAndGroups, $user);
-	}
-
-	/**
-	 * Get the item of item type shared with a given user by source
-	 *
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param ?string $user User to whom the item was shared
-	 * @param ?string $owner Owner of the share
-	 * @param ?int $shareType only look for a specific share type
-	 * @return array Return list of items with file_target, permissions and expiration
-	 * @throws Exception
-	 */
-	public static function getItemSharedWithUser(string $itemType, string $itemSource, ?string $user = null, ?string $owner = null, ?int $shareType = null) {
-		$shares = [];
-		$fileDependent = $itemType === 'file' || $itemType === 'folder';
-		$qb = self::getSelectStatement(self::FORMAT_NONE, $fileDependent);
-		$qb->from('share', 's');
-		if ($fileDependent) {
-			$qb->innerJoin('s', 'filecache', 'f', $qb->expr()->eq('file_source', 'f.fileid'));
-			$qb->innerJoin('s', 'storages', 'st', $qb->expr()->eq('numeric_id', 'f.storage'));
-			$column = 'file_source';
-		} else {
-			$column = 'item_source';
-		}
-
-		$qb->where($qb->expr()->eq($column, $qb->createNamedParameter($itemSource)))
-			->andWhere($qb->expr()->eq('item_type', $qb->createNamedParameter($itemType)));
-
-		// for link shares $user === null
-		if ($user !== null) {
-			$qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($user)));
-		}
-
-		if ($shareType !== null) {
-			$qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter($shareType, IQueryBuilder::PARAM_INT)));
-		}
-
-		if ($owner !== null) {
-			$qb->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($owner)));
-		}
-
-		$result = $qb->executeQuery();
-		while ($row = $result->fetch()) {
-			if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
-				continue;
-			}
-			if ($fileDependent && (int)$row['file_parent'] === -1) {
-				// if it is a mount point we need to get the path from the mount manager
-				$mountManager = \OC\Files\Filesystem::getMountManager();
-				$mountPoint = $mountManager->findByStorageId($row['storage_id']);
-				if (!empty($mountPoint)) {
-					$path = $mountPoint[0]->getMountPoint();
-					$path = trim($path, '/');
-					$path = substr($path, strlen($owner) + 1); //normalize path to 'files/foo.txt`
-					$row['path'] = $path;
-				} else {
-					\OC::$server->get(LoggerInterface::class)->warning(
-						'Could not resolve mount point for ' . $row['storage_id'],
-						['app' => 'OCP\Share']
-					);
-				}
-			}
-			$shares[] = $row;
-		}
-		$result->closeCursor();
-
-		// if we didn't found a result then let's look for a group share.
-		if (empty($shares) && $user !== null) {
-			$userObject = \OC::$server->getUserManager()->get($user);
-			$groups = [];
-			if ($userObject) {
-				$groups = \OC::$server->getGroupManager()->getUserGroupIds($userObject);
-			}
-
-			if (!empty($groups)) {
-				$qb = self::getSelectStatement(self::FORMAT_NONE, $fileDependent);
-				$qb->from('share', 's');
-
-				if ($fileDependent) {
-					$qb->innerJoin('s', 'filecache', 'f', $qb->expr()->eq('file_source', 'f.fileid'))
-						->innerJoin('s', 'storages', 'st', $qb->expr()->eq('numeric_id', 'f.storage'));
-				}
-
-				$qb->where($qb->expr()->eq($column, $qb->createNamedParameter($itemSource)))
-					->andWhere($qb->expr()->eq('item_type', $qb->createNamedParameter($itemType, IQueryBuilder::PARAM_STR)))
-					->andWhere($qb->expr()->in('share_with', $qb->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY)));
-
-				if ($owner !== null) {
-					$qb->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($owner)));
-				}
-				$result = $qb->executeQuery();
-
-				while ($row = $result->fetch()) {
-					$shares[] = $row;
-				}
-				$result->closeCursor();
-			}
-		}
-
-		return $shares;
-	}
-
-	/**
-	 * Get the shared item of item type owned by the current user
-	 *
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters
-	 * @param boolean $includeCollections
-	 * @return mixed Return depends on format
-	 *
-	 * Refactoring notes:
-	 *   * defacto $parameters and $format is always the default and therefore is removed in the subsequent call
-	 */
-	public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
-										 $parameters = null, $includeCollections = false) {
-		return self::getItems($itemType, $itemSource, null, null, \OC_User::getUser(), self::FORMAT_NONE,
-			null, -1, $includeCollections);
-	}
-
-	/**
-	 * Get the backend class for the specified item type
-	 *
-	 * @param string $itemType
-	 * @return \OCP\Share_Backend
-	 * @throws \Exception
-	 */
-	public static function getBackend($itemType) {
-		$l = \OC::$server->getL10N('lib');
-		$logger = \OC::$server->get(LoggerInterface::class);
-		if (isset(self::$backends[$itemType])) {
-			return self::$backends[$itemType];
-		} elseif (isset(self::$backendTypes[$itemType]['class'])) {
-			$class = self::$backendTypes[$itemType]['class'];
-			if (class_exists($class)) {
-				self::$backends[$itemType] = new $class;
-				if (!(self::$backends[$itemType] instanceof \OCP\Share_Backend)) {
-					$message = 'Sharing backend %s must implement the interface OCP\Share_Backend';
-					$message_t = $l->t('Sharing backend %s must implement the interface OCP\Share_Backend', [$class]);
-					$logger->error(sprintf($message, $class), ['app' => 'OCP\Share']);
-					throw new \Exception($message_t);
-				}
-				return self::$backends[$itemType];
-			} else {
-				$message = 'Sharing backend %s not found';
-				$message_t = $l->t('Sharing backend %s not found', [$class]);
-				$logger->error(sprintf($message, $class), ['app' => 'OCP\Share']);
-				throw new \Exception($message_t);
-			}
-		}
-		$message = 'Sharing backend for %s not found';
-		$message_t = $l->t('Sharing backend for %s not found', [$itemType]);
-		$logger->error(sprintf($message, $itemType), ['app' => 'OCP\Share']);
-		throw new \Exception($message_t);
-	}
-
-	/**
-	 * Check if resharing is allowed
-	 *
-	 * @return boolean true if allowed or false
-	 *
-	 * Resharing is allowed by default if not configured
-	 */
-	public static function isResharingAllowed() {
-		if (!isset(self::$isResharingAllowed)) {
-			if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_allow_resharing', 'yes') == 'yes') {
-				self::$isResharingAllowed = true;
-			} else {
-				self::$isResharingAllowed = false;
-			}
-		}
-		return self::$isResharingAllowed;
-	}
-
-	/**
-	 * Get a list of collection item types for the specified item type
-	 *
-	 * @param string $itemType
-	 * @return array|false
-	 */
-	private static function getCollectionItemTypes(string $itemType) {
-		$collectionTypes = [$itemType];
-		foreach (self::$backendTypes as $type => $backend) {
-			if (in_array($backend['collectionOf'], $collectionTypes)) {
-				$collectionTypes[] = $type;
-			}
-		}
-		// TODO Add option for collections to be collection of themselves, only 'folder' does it now...
-		if (isset(self::$backendTypes[$itemType]) && (!self::getBackend($itemType) instanceof \OCP\Share_Backend_Collection || $itemType != 'folder')) {
-			unset($collectionTypes[0]);
-		}
-		// Return array if collections were found or the item type is a
-		// collection itself - collections can be inside collections
-		if (count($collectionTypes) > 0) {
-			return $collectionTypes;
-		}
-		return false;
-	}
-
-	/**
-	 * Get shared items from the database
-	 *
-	 * @param string $itemType
-	 * @param string $item Item source or target (optional)
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique
-	 * @param string $shareWith User or group the item is being shared with
-	 * @param string $uidOwner User that is the owner of shared items (optional)
-	 * @param int $format Format to convert items to with formatItems() (optional)
-	 * @param mixed $parameters to pass to formatItems() (optional)
-	 * @param int $limit Number of items to return, -1 to return all matches (optional)
-	 * @param boolean $includeCollections Include collection item types (optional)
-	 * @param boolean $itemShareWithBySource (optional)
-	 * @param boolean $checkExpireDate
-	 * @return array
-	 *
-	 * See public functions getItem(s)... for parameter usage
-	 *
-	 * Refactoring notes:
-	 *   * defacto $limit, $itemsShareWithBySource, $checkExpireDate, $parameters and $format is always the default and therefore is removed in the subsequent call
-	 */
-	public static function getItems($itemType, ?string $item = null, ?int $shareType = null, $shareWith = null,
-									$uidOwner = null, $format = self::FORMAT_NONE, $parameters = null, $limit = -1,
-									$includeCollections = false, $itemShareWithBySource = false, $checkExpireDate = true) {
-		if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_enabled', 'yes') != 'yes') {
-			return [];
-		}
-		$fileDependent = $itemType == 'file' || $itemType == 'folder';
-		$qb = self::getSelectStatement(self::FORMAT_NONE, $fileDependent, $uidOwner);
-		$qb->from('share', 's');
-
-		$backend = self::getBackend($itemType);
-		$collectionTypes = false;
-		// Get filesystem root to add it to the file target and remove from the
-		// file source, match file_source with the file cache
-		if ($fileDependent) {
-			if (!is_null($uidOwner)) {
-				$root = \OC\Files\Filesystem::getRoot();
-			} else {
-				$root = '';
-			}
-			if (isset($item)) {
-				$qb->innerJoin('s', 'filecache', 'f', $qb->expr()->eq('file_source', 'f.fileid'));
-			} else {
-				$qb->innerJoin('s', 'filecache', 'f', $qb->expr()->andX(
-					$qb->expr()->eq('file_source', 'f.fileid'),
-					$qb->expr()->isNotNull('file_target')
-				));
-			}
-			$qb->innerJoin('s', 'storages', 'st', $qb->expr()->eq('numeric_id', 'f.storage'));
-		} else {
-			$root = '';
-			$collectionTypes = self::getCollectionItemTypes($itemType);
-			if ($includeCollections && !isset($item) && $collectionTypes) {
-				// If includeCollections is true, find collections of this item type, e.g. a music album contains songs
-				if (!in_array($itemType, $collectionTypes)) {
-					$itemTypes = array_merge([$itemType], $collectionTypes);
-				} else {
-					$itemTypes = $collectionTypes;
-				}
-				$qb->where($qb->expr()->in('item_type', $qb->createNamedParameter($itemTypes, IQueryBuilder::PARAM_STR_ARRAY)));
-			} else {
-				$qb->where($qb->expr()->eq('item_type', $qb->createNamedParameter($itemType)));
-			}
-		}
-		if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_allow_links', 'yes') !== 'yes') {
-			$qb->andWhere($qb->expr()->neq('share_type', $qb->createNamedParameter(IShare::TYPE_LINK, IQueryBuilder::PARAM_INT)));
-		}
-		if (isset($shareType)) {
-			// Include all user and group items
-			if ($shareType === self::$shareTypeUserAndGroups && isset($shareWith)) {
-				$qb->andWhere($qb->expr()->andX(
-					$qb->expr()->in('share_type', $qb->createNamedParameter([IShare::TYPE_USER, self::$shareTypeGroupUserUnique], IQueryBuilder::PARAM_INT_ARRAY)),
-					$qb->expr()->eq('share_with', $qb->createNamedParameter($shareWith))
-				));
-
-				$user = \OC::$server->getUserManager()->get($shareWith);
-				$groups = [];
-				if ($user) {
-					$groups = \OC::$server->getGroupManager()->getUserGroupIds($user);
-				}
-				if (!empty($groups)) {
-					$qb->orWhere($qb->expr()->andX(
-						$qb->expr()->eq('share_type', $qb->createNamedParameter(IShare::TYPE_GROUP, IQueryBuilder::PARAM_INT)),
-						$qb->expr()->in('share_with', $qb->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY))
-					));
-				}
-
-				// Don't include own group shares
-				$qb->andWhere($qb->expr()->neq('uid_owner', $qb->createNamedParameter($shareWith)));
-			} else {
-				$qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter($shareType, IQueryBuilder::PARAM_INT)));
-				if (isset($shareWith)) {
-					$qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($shareWith, IQueryBuilder::PARAM_STR)));
-				}
-			}
-		}
-		if (isset($uidOwner)) {
-			$qb->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($uidOwner)));
-			if (!isset($shareType)) {
-				// Prevent unique user targets for group shares from being selected
-				$qb->andWhere($qb->expr()->neq('share_type', $qb->createNamedParameter(self::$shareTypeGroupUserUnique, IQueryBuilder::PARAM_INT)));
-			}
-			if ($fileDependent) {
-				$column = 'file_source';
-			} else {
-				$column = 'item_source';
-			}
-		} else {
-			if ($fileDependent) {
-				$column = 'file_target';
-			} else {
-				$column = 'item_target';
-			}
-		}
-		if (isset($item)) {
-			$collectionTypes = self::getCollectionItemTypes($itemType);
-			// If looking for own shared items, check item_source else check item_target
-			if (isset($uidOwner)) {
-				// If item type is a file, file source needs to be checked in case the item was converted
-				if ($fileDependent) {
-					$expr = $qb->expr()->eq('file_source', $qb->createNamedParameter($item));
-					$column = 'file_source';
-				} else {
-					$expr = $qb->expr()->eq('item_source', $qb->createNamedParameter($item));
-					$column = 'item_source';
-				}
-			} else {
-				if ($fileDependent) {
-					$item = \OC\Files\Filesystem::normalizePath($item);
-					$expr = $qb->expr()->eq('file_target', $qb->createNamedParameter($item));
-				} else {
-					$expr = $qb->expr()->eq('item_target', $qb->createNamedParameter($item));
-				}
-			}
-			if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
-				$qb->andWhere($qb->expr()->orX(
-					$expr,
-					$qb->expr()->in('item_type', $qb->createNamedParameter($collectionTypes, IQueryBuilder::PARAM_STR_ARRAY))
-				));
-			} else {
-				$qb->andWhere($expr);
-			}
-		}
-		$qb->orderBy('s.id', 'ASC');
-		try {
-			$result = $qb->executeQuery();
-		} catch (\Exception $e) {
-			\OCP\Server::get(LoggerInterface::class)->error(
-				'Error while selecting shares: ' . $qb->getSQL(),
-				[
-					'app' => 'files_sharing',
-					'exception' => $e
-				]);
-			throw new \RuntimeException('Wrong SQL query', 500, $e);
-		}
-
-		$root = strlen($root);
-		$items = [];
-		$targets = [];
-		$switchedItems = [];
-		$mounts = [];
-		while ($row = $result->fetch()) {
-			//var_dump($row);
-			self::transformDBResults($row);
-			// Filter out duplicate group shares for users with unique targets
-			if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
-				continue;
-			}
-			if ($row['share_type'] == self::$shareTypeGroupUserUnique && isset($items[$row['parent']])) {
-				$row['share_type'] = IShare::TYPE_GROUP;
-				$row['unique_name'] = true; // remember that we use a unique name for this user
-				$row['share_with'] = $items[$row['parent']]['share_with'];
-				// if the group share was unshared from the user we keep the permission, otherwise
-				// we take the permission from the parent because this is always the up-to-date
-				// permission for the group share
-				if ($row['permissions'] > 0) {
-					$row['permissions'] = $items[$row['parent']]['permissions'];
-				}
-				// Remove the parent group share
-				unset($items[$row['parent']]);
-				if ($row['permissions'] == 0) {
-					continue;
-				}
-			} elseif (!isset($uidOwner)) {
-				// Check if the same target already exists
-				if (isset($targets[$row['id']])) {
-					// Check if the same owner shared with the user twice
-					// through a group and user share - this is allowed
-					$id = $targets[$row['id']];
-					if (isset($items[$id]) && $items[$id]['uid_owner'] == $row['uid_owner']) {
-						// Switch to group share type to ensure resharing conditions aren't bypassed
-						if ($items[$id]['share_type'] != IShare::TYPE_GROUP) {
-							$items[$id]['share_type'] = IShare::TYPE_GROUP;
-							$items[$id]['share_with'] = $row['share_with'];
-						}
-						// Switch ids if sharing permission is granted on only
-						// one share to ensure correct parent is used if resharing
-						if (~(int)$items[$id]['permissions'] & \OCP\Constants::PERMISSION_SHARE
-							&& (int)$row['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
-							$items[$row['id']] = $items[$id];
-							$switchedItems[$id] = $row['id'];
-							unset($items[$id]);
-							$id = $row['id'];
-						}
-						$items[$id]['permissions'] |= (int)$row['permissions'];
-					}
-					continue;
-				} elseif (!empty($row['parent'])) {
-					$targets[$row['parent']] = $row['id'];
-				}
-			}
-			// Remove root from file source paths if retrieving own shared items
-			if (isset($uidOwner) && isset($row['path'])) {
-				if (isset($row['parent'])) {
-					$query = \OC::$server->getDatabaseConnection()->getQueryBuilder();
-					$query->select('file_target')
-						->from('share')
-						->where($query->expr()->eq('id', $query->createNamedParameter($row['parent'])));
-
-					$parentRow = false;
-					try {
-						$parentResult = $query->executeQuery();
-						$parentRow = $parentResult->fetchOne();
-						$parentResult->closeCursor();
-
-						$tmpPath = $parentRow['file_target'];
-						// find the right position where the row path continues from the target path
-						$pos = strrpos($row['path'], $parentRow['file_target']);
-						$subPath = substr($row['path'], $pos);
-						$splitPath = explode('/', $subPath);
-						foreach (array_slice($splitPath, 2) as $pathPart) {
-							$tmpPath = $tmpPath . '/' . $pathPart;
-						}
-						$row['path'] = $tmpPath;
-					} catch (Exception $e) {
-						\OCP\Server::get(LoggerInterface::class)
-							->error('Can\'t select parent :' . $e->getMessage() . ' query=' . $query->getSQL(), [
-								'exception' => $e,
-								'app' => 'core'
-							]);
-					}
-				} else {
-					if (!isset($mounts[$row['storage']])) {
-						$mountPoints = \OC\Files\Filesystem::getMountByNumericId($row['storage']);
-						if (is_array($mountPoints) && !empty($mountPoints)) {
-							$mounts[$row['storage']] = current($mountPoints);
-						}
-					}
-					if (!empty($mounts[$row['storage']])) {
-						$path = $mounts[$row['storage']]->getMountPoint() . $row['path'];
-						$relPath = substr($path, $root); // path relative to data/user
-						$row['path'] = rtrim($relPath, '/');
-					}
-				}
-			}
-
-			// Check if resharing is allowed, if not remove share permission
-			if (isset($row['permissions']) && (!self::isResharingAllowed() | \OCP\Util::isSharingDisabledForUser())) {
-				$row['permissions'] &= ~\OCP\Constants::PERMISSION_SHARE;
-			}
-			// Add display names to result
-			$row['share_with_displayname'] = $row['share_with'];
-			if (isset($row['share_with']) && $row['share_with'] != '' &&
-				$row['share_type'] === IShare::TYPE_USER) {
-				$shareWithUser = \OC::$server->getUserManager()->get($row['share_with']);
-				$row['share_with_displayname'] = $shareWithUser === null ? $row['share_with'] : $shareWithUser->getDisplayName();
-			} elseif (isset($row['share_with']) && $row['share_with'] != '' &&
-				$row['share_type'] === IShare::TYPE_REMOTE) {
-				$addressBookEntries = \OC::$server->getContactsManager()->search($row['share_with'], ['CLOUD'], [
-					'limit' => 1,
-					'enumeration' => false,
-					'fullmatch' => false,
-					'strict_search' => true,
-				]);
-				foreach ($addressBookEntries as $entry) {
-					foreach ($entry['CLOUD'] as $cloudID) {
-						if ($cloudID === $row['share_with']) {
-							$row['share_with_displayname'] = $entry['FN'];
-						}
-					}
-				}
-			}
-			if (isset($row['uid_owner']) && $row['uid_owner'] != '') {
-				$ownerUser = \OC::$server->getUserManager()->get($row['uid_owner']);
-				$row['displayname_owner'] = $ownerUser === null ? $row['uid_owner'] : $ownerUser->getDisplayName();
-			}
-
-			if ($row['permissions'] > 0) {
-				$items[$row['id']] = $row;
-			}
-		}
-		$result->closeCursor();
-
-		// group items if we are looking for items shared with the current user
-		if (isset($shareWith) && $shareWith === \OC_User::getUser()) {
-			$items = self::groupItems($items, $itemType);
-		}
-
-		if (!empty($items)) {
-			$collectionItems = [];
-			foreach ($items as &$row) {
-				// Check if this is a collection of the requested item type
-				if ($includeCollections && $collectionTypes && $row['item_type'] !== 'folder' && in_array($row['item_type'], $collectionTypes)) {
-					if (($collectionBackend = self::getBackend($row['item_type']))
-						&& $collectionBackend instanceof \OCP\Share_Backend_Collection) {
-						// Collections can be inside collections, check if the item is a collection
-						if (isset($item) && $row['item_type'] == $itemType && $row[$column] == $item) {
-							$collectionItems[] = $row;
-						} else {
-							$collection = [];
-							$collection['item_type'] = $row['item_type'];
-							if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
-								$collection['path'] = basename($row['path']);
-							}
-							$row['collection'] = $collection;
-							// Fetch all the children sources
-							$children = $collectionBackend->getChildren($row[$column]);
-							foreach ($children as $child) {
-								$childItem = $row;
-								$childItem['item_type'] = $itemType;
-								if ($row['item_type'] != 'file' && $row['item_type'] != 'folder') {
-									$childItem['item_source'] = $child['source'];
-									$childItem['item_target'] = $child['target'];
-								}
-								if ($backend instanceof \OCP\Share_Backend_File_Dependent) {
-									if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
-										$childItem['file_source'] = $child['source'];
-									} else { // TODO is this really needed if we already know that we use the file backend?
-										$meta = \OC\Files\Filesystem::getFileInfo($child['file_path']);
-										$childItem['file_source'] = $meta['fileid'];
-									}
-									$childItem['file_target'] =
-										\OC\Files\Filesystem::normalizePath($child['file_path']);
-								}
-								if (isset($item)) {
-									if ($childItem[$column] == $item) {
-										$collectionItems[] = $childItem;
-									}
-								} else {
-									$collectionItems[] = $childItem;
-								}
-							}
-						}
-					}
-					// Remove collection item
-					$toRemove = $row['id'];
-					if (array_key_exists($toRemove, $switchedItems)) {
-						$toRemove = $switchedItems[$toRemove];
-					}
-					unset($items[$toRemove]);
-				} elseif ($includeCollections && $collectionTypes && in_array($row['item_type'], $collectionTypes)) {
-					// FIXME: Thats a dirty hack to improve file sharing performance,
-					// see github issue #10588 for more details
-					// Need to find a solution which works for all back-ends
-					$collectionBackend = self::getBackend($row['item_type']);
-					$sharedParents = $collectionBackend->getParents($row['item_source']);
-					foreach ($sharedParents as $parent) {
-						$collectionItems[] = $parent;
-					}
-				}
-			}
-			if (!empty($collectionItems)) {
-				$collectionItems = array_unique($collectionItems, SORT_REGULAR);
-				$items = array_merge($items, $collectionItems);
-			}
-
-			// filter out invalid items, these can appear when subshare entries exist
-			// for a group in which the requested user isn't a member any more
-			$items = array_filter($items, function ($item) {
-				return $item['share_type'] !== self::$shareTypeGroupUserUnique;
-			});
-
-			return self::formatResult($items, $column, $backend);
-		} elseif ($includeCollections && $collectionTypes && in_array('folder', $collectionTypes)) {
-			// FIXME: Thats a dirty hack to improve file sharing performance,
-			// see github issue #10588 for more details
-			// Need to find a solution which works for all back-ends
-			$collectionItems = [];
-			$collectionBackend = self::getBackend('folder');
-			$sharedParents = $collectionBackend->getParents($item, $shareWith, $uidOwner);
-			foreach ($sharedParents as $parent) {
-				$collectionItems[] = $parent;
-			}
-			return self::formatResult($collectionItems, $column, $backend);
-		}
-
-		return [];
-	}
-
-	/**
-	 * group items with link to the same source
-	 *
-	 * @param array $items
-	 * @param string $itemType
-	 * @return array of grouped items
-	 */
-	protected static function groupItems($items, $itemType) {
-		$fileSharing = $itemType === 'file' || $itemType === 'folder';
-
-		$result = [];
-
-		foreach ($items as $item) {
-			$grouped = false;
-			foreach ($result as $key => $r) {
-				// for file/folder shares we need to compare file_source, otherwise we compare item_source
-				// only group shares if they already point to the same target, otherwise the file where shared
-				// before grouping of shares was added. In this case we don't group them to avoid confusions
-				if (($fileSharing && $item['file_source'] === $r['file_source'] && $item['file_target'] === $r['file_target']) ||
-					(!$fileSharing && $item['item_source'] === $r['item_source'] && $item['item_target'] === $r['item_target'])) {
-					// add the first item to the list of grouped shares
-					if (!isset($result[$key]['grouped'])) {
-						$result[$key]['grouped'][] = $result[$key];
-					}
-					$result[$key]['permissions'] = (int)$item['permissions'] | (int)$r['permissions'];
-					$result[$key]['grouped'][] = $item;
-					$grouped = true;
-					break;
-				}
-			}
-
-			if (!$grouped) {
-				$result[] = $item;
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Construct select statement
-	 *
-	 * @param bool $fileDependent ist it a file/folder share or a general share
-	 */
-	private static function getSelectStatement(int $format, bool $fileDependent, ?string $uidOwner = null): IQueryBuilder {
-		/** @var IDBConnection $connection */
-		$connection = \OC::$server->get(IDBConnection::class);
-		$qb = $connection->getQueryBuilder();
-		if ($format == self::FORMAT_STATUSES) {
-			if ($fileDependent) {
-				return $qb->select(
-					's.id',
-					's.parent',
-					'share_type',
-					'path',
-					'storage',
-					'share_with',
-					'uid_owner',
-					'file_source',
-					'stime',
-					's.permissions',
-					'uid_initiator'
-				)->selectAlias('st.id', 'storage_id')
-					->selectAlias('f.parent', 'file_parent');
-			}
-			return $qb->select('id', 'parent', 'share_type', 'share_with', 'uid_owner', 'item_source', 'stime', 's.permissions');
-		}
-
-		if (isset($uidOwner)) {
-			if ($fileDependent) {
-				return $qb->select(
-					's.id',
-					'item_type',
-					'item_source',
-					's.parent',
-					'share_type',
-					'share_with',
-					'file_source',
-					'file_target',
-					'path',
-					's.permissions',
-					'stime',
-					'expiration',
-					'token',
-					'storage',
-					'mail_send',
-					'uid_owner',
-					'uid_initiator'
-				)->selectAlias('st.id', 'storage_id')
-					->selectAlias('f.parent', 'file_parent');
-			}
-			return $qb->select('id', 'item_type', 'item_source', 'parent', 'share_type',
-				'share_with', 'uid_owner', 'file_source', 'stime', 's.permissions',
-				'expiration', 'token', 'mail_send');
-		}
-
-		if ($fileDependent) {
-			if ($format == File::FORMAT_GET_FOLDER_CONTENTS || $format == File::FORMAT_FILE_APP_ROOT) {
-				return $qb->select(
-					's.id',
-					'item_type',
-					'item_source',
-					's.parent',
-					'uid_owner',
-					'share_type',
-					'share_with',
-					'file_source',
-					'path',
-					'file_target',
-					's.permissions',
-					'stime',
-					'expiration',
-					'storage',
-					'name',
-					'mtime',
-					'mimepart',
-					'size',
-					'encrypted',
-					'etag',
-					'mail_send'
-				)->selectAlias('f.parent', 'file_parent');
-			}
-			return $qb->select(
-				's.id',
-				'item_type',
-				'item_source',
-				'item_target',
-				's.parent',
-				'share_type',
-				'share_with',
-				'uid_owner',
-				'file_source',
-				'path',
-				'file_target',
-				's.permissions',
-				'stime',
-				'expiration',
-				'token',
-				'storage',
-				'mail_send',
-			)->selectAlias('f.parent', 'file_parent')
-				->selectAlias('st.id', 'storage_id');
-		}
-		return $qb->select('*');
-	}
-
-
-	/**
-	 * transform db results
-	 *
-	 * @param array $row result
-	 */
-	private static function transformDBResults(&$row) {
-		if (isset($row['id'])) {
-			$row['id'] = (int)$row['id'];
-		}
-		if (isset($row['share_type'])) {
-			$row['share_type'] = (int)$row['share_type'];
-		}
-		if (isset($row['parent'])) {
-			$row['parent'] = (int)$row['parent'];
-		}
-		if (isset($row['file_parent'])) {
-			$row['file_parent'] = (int)$row['file_parent'];
-		}
-		if (isset($row['file_source'])) {
-			$row['file_source'] = (int)$row['file_source'];
-		}
-		if (isset($row['permissions'])) {
-			$row['permissions'] = (int)$row['permissions'];
-		}
-		if (isset($row['storage'])) {
-			$row['storage'] = (int)$row['storage'];
-		}
-		if (isset($row['stime'])) {
-			$row['stime'] = (int)$row['stime'];
-		}
-		if (isset($row['expiration']) && $row['share_type'] !== IShare::TYPE_LINK) {
-			// discard expiration date for non-link shares, which might have been
-			// set by ancient bugs
-			$row['expiration'] = null;
-		}
-	}
-
-	/**
-	 * format result
-	 *
-	 * @param array $items result
-	 * @param string $column is it a file share or a general share ('file_target' or 'item_target')
-	 * @param \OCP\Share_Backend $backend sharing backend
-	 * @param int $format
-	 * @param array $parameters additional format parameters
-	 * @return array format result
-	 */
-	private static function formatResult($items, $column, $backend, $format = self::FORMAT_NONE, $parameters = null) {
-		if ($format === self::FORMAT_NONE) {
-			return $items;
-		} elseif ($format === self::FORMAT_STATUSES) {
-			$statuses = [];
-			foreach ($items as $item) {
-				if ($item['share_type'] === IShare::TYPE_LINK) {
-					if ($item['uid_initiator'] !== \OC::$server->getUserSession()->getUser()->getUID()) {
-						continue;
-					}
-					$statuses[$item[$column]]['link'] = true;
-				} elseif (!isset($statuses[$item[$column]])) {
-					$statuses[$item[$column]]['link'] = false;
-				}
-				if (!empty($item['file_target'])) {
-					$statuses[$item[$column]]['path'] = $item['path'];
-				}
-			}
-			return $statuses;
-		} else {
-			return $backend->formatItems($items, $format, $parameters);
-		}
-	}
-
-	/**
-	 * remove protocol from URL
-	 *
-	 * @param string $url
-	 * @return string
-	 */
-	public static function removeProtocolFromUrl($url) {
-		if (str_starts_with($url, 'https://')) {
-			return substr($url, strlen('https://'));
-		} elseif (str_starts_with($url, 'http://')) {
-			return substr($url, strlen('http://'));
-		}
-
-		return $url;
-	}
-
-
-	/**
-	 * @return int
-	 */
-	public static function getExpireInterval() {
-		return (int)\OC::$server->getConfig()->getAppValue('core', 'shareapi_expire_after_n_days', '7');
-	}
-
-	/**
-	 * Checks whether the given path is reachable for the given owner
-	 *
-	 * @param string $path path relative to files
-	 * @param string $ownerStorageId storage id of the owner
-	 *
-	 * @return boolean true if file is reachable, false otherwise
-	 */
-	private static function isFileReachable($path, $ownerStorageId) {
-		// if outside the home storage, file is always considered reachable
-		if (!(substr($ownerStorageId, 0, 6) === 'home::' ||
-			substr($ownerStorageId, 0, 13) === 'object::user:'
-		)) {
-			return true;
-		}
-
-		// if inside the home storage, the file has to be under "/files/"
-		$path = ltrim($path, '/');
-		if (substr($path, 0, 6) === 'files/') {
-			return true;
-		}
-
-		return false;
-	}
+    /** CRUDS permissions (Create, Read, Update, Delete, Share) using a bitmask
+     * Construct permissions for share() and setPermissions with Or (|) e.g.
+     * Give user read and update permissions: PERMISSION_READ | PERMISSION_UPDATE
+     *
+     * Check if permission is granted with And (&) e.g. Check if delete is
+     * granted: if ($permissions & PERMISSION_DELETE)
+     *
+     * Remove permissions with And (&) and Not (~) e.g. Remove the update
+     * permission: $permissions &= ~PERMISSION_UPDATE
+     *
+     * Apps are required to handle permissions on their own, this class only
+     * stores and manages the permissions of shares
+     *
+     * @see lib/public/Constants.php
+     */
+
+    /**
+     * Register a sharing backend class that implements OCP\Share_Backend for an item type
+     *
+     * @param string $itemType Item type
+     * @param string $class Backend class
+     * @param string $collectionOf (optional) Depends on item type
+     * @param array $supportedFileExtensions (optional) List of supported file extensions if this item type depends on files
+     * @return boolean true if backend is registered or false if error
+     */
+    public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
+        if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_enabled', 'yes') == 'yes') {
+            if (!isset(self::$backendTypes[$itemType])) {
+                self::$backendTypes[$itemType] = [
+                    'class' => $class,
+                    'collectionOf' => $collectionOf,
+                    'supportedFileExtensions' => $supportedFileExtensions
+                ];
+                return true;
+            }
+            \OC::$server->get(LoggerInterface::class)->warning(
+                'Sharing backend '.$class.' not registered, '.self::$backendTypes[$itemType]['class']
+                .' is already registered for '.$itemType,
+                ['app' => 'files_sharing']);
+        }
+        return false;
+    }
+
+    /**
+     * Get the items of item type shared with the current user
+     *
+     * @param string $itemType
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters (optional)
+     * @param int $limit Number of items to return (optional) Returns all by default
+     * @param boolean $includeCollections (optional)
+     * @return mixed Return depends on format
+     * @deprecated TESTS ONLY - this methods is only used by tests
+     * called like this:
+     * \OC\Share\Share::getItemsSharedWith('folder'); (apps/files_sharing/tests/UpdaterTest.php)
+     */
+    public static function getItemsSharedWith() {
+        return self::getItems('folder', null, self::$shareTypeUserAndGroups, \OC_User::getUser());
+    }
+
+    /**
+     * Get the items of item type shared with a user
+     *
+     * @param string $itemType
+     * @param string $user id for which user we want the shares
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters (optional)
+     * @param int $limit Number of items to return (optional) Returns all by default
+     * @param boolean $includeCollections (optional)
+     * @return mixed Return depends on format
+     * @deprecated TESTS ONLY - this methods is only used by tests
+     * called like this:
+     * \OC\Share\Share::getItemsSharedWithUser('test', $shareWith); (tests/lib/Share/Backend.php)
+     */
+    public static function getItemsSharedWithUser($itemType, $user) {
+        return self::getItems('test', null, self::$shareTypeUserAndGroups, $user);
+    }
+
+    /**
+     * Get the item of item type shared with a given user by source
+     *
+     * @param string $itemType
+     * @param string $itemSource
+     * @param ?string $user User to whom the item was shared
+     * @param ?string $owner Owner of the share
+     * @param ?int $shareType only look for a specific share type
+     * @return array Return list of items with file_target, permissions and expiration
+     * @throws Exception
+     */
+    public static function getItemSharedWithUser(string $itemType, string $itemSource, ?string $user = null, ?string $owner = null, ?int $shareType = null) {
+        $shares = [];
+        $fileDependent = $itemType === 'file' || $itemType === 'folder';
+        $qb = self::getSelectStatement(self::FORMAT_NONE, $fileDependent);
+        $qb->from('share', 's');
+        if ($fileDependent) {
+            $qb->innerJoin('s', 'filecache', 'f', $qb->expr()->eq('file_source', 'f.fileid'));
+            $qb->innerJoin('s', 'storages', 'st', $qb->expr()->eq('numeric_id', 'f.storage'));
+            $column = 'file_source';
+        } else {
+            $column = 'item_source';
+        }
+
+        $qb->where($qb->expr()->eq($column, $qb->createNamedParameter($itemSource)))
+            ->andWhere($qb->expr()->eq('item_type', $qb->createNamedParameter($itemType)));
+
+        // for link shares $user === null
+        if ($user !== null) {
+            $qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($user)));
+        }
+
+        if ($shareType !== null) {
+            $qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter($shareType, IQueryBuilder::PARAM_INT)));
+        }
+
+        if ($owner !== null) {
+            $qb->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($owner)));
+        }
+
+        $result = $qb->executeQuery();
+        while ($row = $result->fetch()) {
+            if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
+                continue;
+            }
+            if ($fileDependent && (int)$row['file_parent'] === -1) {
+                // if it is a mount point we need to get the path from the mount manager
+                $mountManager = \OC\Files\Filesystem::getMountManager();
+                $mountPoint = $mountManager->findByStorageId($row['storage_id']);
+                if (!empty($mountPoint)) {
+                    $path = $mountPoint[0]->getMountPoint();
+                    $path = trim($path, '/');
+                    $path = substr($path, strlen($owner) + 1); //normalize path to 'files/foo.txt`
+                    $row['path'] = $path;
+                } else {
+                    \OC::$server->get(LoggerInterface::class)->warning(
+                        'Could not resolve mount point for ' . $row['storage_id'],
+                        ['app' => 'OCP\Share']
+                    );
+                }
+            }
+            $shares[] = $row;
+        }
+        $result->closeCursor();
+
+        // if we didn't found a result then let's look for a group share.
+        if (empty($shares) && $user !== null) {
+            $userObject = \OC::$server->getUserManager()->get($user);
+            $groups = [];
+            if ($userObject) {
+                $groups = \OC::$server->getGroupManager()->getUserGroupIds($userObject);
+            }
+
+            if (!empty($groups)) {
+                $qb = self::getSelectStatement(self::FORMAT_NONE, $fileDependent);
+                $qb->from('share', 's');
+
+                if ($fileDependent) {
+                    $qb->innerJoin('s', 'filecache', 'f', $qb->expr()->eq('file_source', 'f.fileid'))
+                        ->innerJoin('s', 'storages', 'st', $qb->expr()->eq('numeric_id', 'f.storage'));
+                }
+
+                $qb->where($qb->expr()->eq($column, $qb->createNamedParameter($itemSource)))
+                    ->andWhere($qb->expr()->eq('item_type', $qb->createNamedParameter($itemType, IQueryBuilder::PARAM_STR)))
+                    ->andWhere($qb->expr()->in('share_with', $qb->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY)));
+
+                if ($owner !== null) {
+                    $qb->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($owner)));
+                }
+                $result = $qb->executeQuery();
+
+                while ($row = $result->fetch()) {
+                    $shares[] = $row;
+                }
+                $result->closeCursor();
+            }
+        }
+
+        return $shares;
+    }
+
+    /**
+     * Get the shared item of item type owned by the current user
+     *
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters
+     * @param boolean $includeCollections
+     * @return mixed Return depends on format
+     *
+     * Refactoring notes:
+     *   * defacto $parameters and $format is always the default and therefore is removed in the subsequent call
+     */
+    public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
+                                            $parameters = null, $includeCollections = false) {
+        return self::getItems($itemType, $itemSource, null, null, \OC_User::getUser(), self::FORMAT_NONE,
+            null, -1, $includeCollections);
+    }
+
+    /**
+     * Get the backend class for the specified item type
+     *
+     * @param string $itemType
+     * @return \OCP\Share_Backend
+     * @throws \Exception
+     */
+    public static function getBackend($itemType) {
+        $l = \OC::$server->getL10N('lib');
+        $logger = \OC::$server->get(LoggerInterface::class);
+        if (isset(self::$backends[$itemType])) {
+            return self::$backends[$itemType];
+        } elseif (isset(self::$backendTypes[$itemType]['class'])) {
+            $class = self::$backendTypes[$itemType]['class'];
+            if (class_exists($class)) {
+                self::$backends[$itemType] = new $class;
+                if (!(self::$backends[$itemType] instanceof \OCP\Share_Backend)) {
+                    $message = 'Sharing backend %s must implement the interface OCP\Share_Backend';
+                    $message_t = $l->t('Sharing backend %s must implement the interface OCP\Share_Backend', [$class]);
+                    $logger->error(sprintf($message, $class), ['app' => 'OCP\Share']);
+                    throw new \Exception($message_t);
+                }
+                return self::$backends[$itemType];
+            } else {
+                $message = 'Sharing backend %s not found';
+                $message_t = $l->t('Sharing backend %s not found', [$class]);
+                $logger->error(sprintf($message, $class), ['app' => 'OCP\Share']);
+                throw new \Exception($message_t);
+            }
+        }
+        $message = 'Sharing backend for %s not found';
+        $message_t = $l->t('Sharing backend for %s not found', [$itemType]);
+        $logger->error(sprintf($message, $itemType), ['app' => 'OCP\Share']);
+        throw new \Exception($message_t);
+    }
+
+    /**
+     * Check if resharing is allowed
+     *
+     * @return boolean true if allowed or false
+     *
+     * Resharing is allowed by default if not configured
+     */
+    public static function isResharingAllowed() {
+        if (!isset(self::$isResharingAllowed)) {
+            if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_allow_resharing', 'yes') == 'yes') {
+                self::$isResharingAllowed = true;
+            } else {
+                self::$isResharingAllowed = false;
+            }
+        }
+        return self::$isResharingAllowed;
+    }
+
+    /**
+     * Get a list of collection item types for the specified item type
+     *
+     * @param string $itemType
+     * @return array|false
+     */
+    private static function getCollectionItemTypes(string $itemType) {
+        $collectionTypes = [$itemType];
+        foreach (self::$backendTypes as $type => $backend) {
+            if (in_array($backend['collectionOf'], $collectionTypes)) {
+                $collectionTypes[] = $type;
+            }
+        }
+        // TODO Add option for collections to be collection of themselves, only 'folder' does it now...
+        if (isset(self::$backendTypes[$itemType]) && (!self::getBackend($itemType) instanceof \OCP\Share_Backend_Collection || $itemType != 'folder')) {
+            unset($collectionTypes[0]);
+        }
+        // Return array if collections were found or the item type is a
+        // collection itself - collections can be inside collections
+        if (count($collectionTypes) > 0) {
+            return $collectionTypes;
+        }
+        return false;
+    }
+
+    /**
+     * Get shared items from the database
+     *
+     * @param string $itemType
+     * @param string $item Item source or target (optional)
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique
+     * @param string $shareWith User or group the item is being shared with
+     * @param string $uidOwner User that is the owner of shared items (optional)
+     * @param int $format Format to convert items to with formatItems() (optional)
+     * @param mixed $parameters to pass to formatItems() (optional)
+     * @param int $limit Number of items to return, -1 to return all matches (optional)
+     * @param boolean $includeCollections Include collection item types (optional)
+     * @param boolean $itemShareWithBySource (optional)
+     * @param boolean $checkExpireDate
+     * @return array
+     *
+     * See public functions getItem(s)... for parameter usage
+     *
+     * Refactoring notes:
+     *   * defacto $limit, $itemsShareWithBySource, $checkExpireDate, $parameters and $format is always the default and therefore is removed in the subsequent call
+     */
+    public static function getItems($itemType, ?string $item = null, ?int $shareType = null, $shareWith = null,
+                                    $uidOwner = null, $format = self::FORMAT_NONE, $parameters = null, $limit = -1,
+                                    $includeCollections = false, $itemShareWithBySource = false, $checkExpireDate = true) {
+        if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_enabled', 'yes') != 'yes') {
+            return [];
+        }
+        $fileDependent = $itemType == 'file' || $itemType == 'folder';
+        $qb = self::getSelectStatement(self::FORMAT_NONE, $fileDependent, $uidOwner);
+        $qb->from('share', 's');
+
+        $backend = self::getBackend($itemType);
+        $collectionTypes = false;
+        // Get filesystem root to add it to the file target and remove from the
+        // file source, match file_source with the file cache
+        if ($fileDependent) {
+            if (!is_null($uidOwner)) {
+                $root = \OC\Files\Filesystem::getRoot();
+            } else {
+                $root = '';
+            }
+            if (isset($item)) {
+                $qb->innerJoin('s', 'filecache', 'f', $qb->expr()->eq('file_source', 'f.fileid'));
+            } else {
+                $qb->innerJoin('s', 'filecache', 'f', $qb->expr()->andX(
+                    $qb->expr()->eq('file_source', 'f.fileid'),
+                    $qb->expr()->isNotNull('file_target')
+                ));
+            }
+            $qb->innerJoin('s', 'storages', 'st', $qb->expr()->eq('numeric_id', 'f.storage'));
+        } else {
+            $root = '';
+            $collectionTypes = self::getCollectionItemTypes($itemType);
+            if ($includeCollections && !isset($item) && $collectionTypes) {
+                // If includeCollections is true, find collections of this item type, e.g. a music album contains songs
+                if (!in_array($itemType, $collectionTypes)) {
+                    $itemTypes = array_merge([$itemType], $collectionTypes);
+                } else {
+                    $itemTypes = $collectionTypes;
+                }
+                $qb->where($qb->expr()->in('item_type', $qb->createNamedParameter($itemTypes, IQueryBuilder::PARAM_STR_ARRAY)));
+            } else {
+                $qb->where($qb->expr()->eq('item_type', $qb->createNamedParameter($itemType)));
+            }
+        }
+        if (\OC::$server->getConfig()->getAppValue('core', 'shareapi_allow_links', 'yes') !== 'yes') {
+            $qb->andWhere($qb->expr()->neq('share_type', $qb->createNamedParameter(IShare::TYPE_LINK, IQueryBuilder::PARAM_INT)));
+        }
+        if (isset($shareType)) {
+            // Include all user and group items
+            if ($shareType === self::$shareTypeUserAndGroups && isset($shareWith)) {
+                $qb->andWhere($qb->expr()->andX(
+                    $qb->expr()->in('share_type', $qb->createNamedParameter([IShare::TYPE_USER, self::$shareTypeGroupUserUnique], IQueryBuilder::PARAM_INT_ARRAY)),
+                    $qb->expr()->eq('share_with', $qb->createNamedParameter($shareWith))
+                ));
+
+                $user = \OC::$server->getUserManager()->get($shareWith);
+                $groups = [];
+                if ($user) {
+                    $groups = \OC::$server->getGroupManager()->getUserGroupIds($user);
+                }
+                if (!empty($groups)) {
+                    $qb->orWhere($qb->expr()->andX(
+                        $qb->expr()->eq('share_type', $qb->createNamedParameter(IShare::TYPE_GROUP, IQueryBuilder::PARAM_INT)),
+                        $qb->expr()->in('share_with', $qb->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY))
+                    ));
+                }
+
+                // Don't include own group shares
+                $qb->andWhere($qb->expr()->neq('uid_owner', $qb->createNamedParameter($shareWith)));
+            } else {
+                $qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter($shareType, IQueryBuilder::PARAM_INT)));
+                if (isset($shareWith)) {
+                    $qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($shareWith, IQueryBuilder::PARAM_STR)));
+                }
+            }
+        }
+        if (isset($uidOwner)) {
+            $qb->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($uidOwner)));
+            if (!isset($shareType)) {
+                // Prevent unique user targets for group shares from being selected
+                $qb->andWhere($qb->expr()->neq('share_type', $qb->createNamedParameter(self::$shareTypeGroupUserUnique, IQueryBuilder::PARAM_INT)));
+            }
+            if ($fileDependent) {
+                $column = 'file_source';
+            } else {
+                $column = 'item_source';
+            }
+        } else {
+            if ($fileDependent) {
+                $column = 'file_target';
+            } else {
+                $column = 'item_target';
+            }
+        }
+        if (isset($item)) {
+            $collectionTypes = self::getCollectionItemTypes($itemType);
+            // If looking for own shared items, check item_source else check item_target
+            if (isset($uidOwner)) {
+                // If item type is a file, file source needs to be checked in case the item was converted
+                if ($fileDependent) {
+                    $expr = $qb->expr()->eq('file_source', $qb->createNamedParameter($item));
+                    $column = 'file_source';
+                } else {
+                    $expr = $qb->expr()->eq('item_source', $qb->createNamedParameter($item));
+                    $column = 'item_source';
+                }
+            } else {
+                if ($fileDependent) {
+                    $item = \OC\Files\Filesystem::normalizePath($item);
+                    $expr = $qb->expr()->eq('file_target', $qb->createNamedParameter($item));
+                } else {
+                    $expr = $qb->expr()->eq('item_target', $qb->createNamedParameter($item));
+                }
+            }
+            if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
+                $qb->andWhere($qb->expr()->orX(
+                    $expr,
+                    $qb->expr()->in('item_type', $qb->createNamedParameter($collectionTypes, IQueryBuilder::PARAM_STR_ARRAY))
+                ));
+            } else {
+                $qb->andWhere($expr);
+            }
+        }
+        $qb->orderBy('s.id', 'ASC');
+        try {
+            $result = $qb->executeQuery();
+        } catch (\Exception $e) {
+            \OCP\Server::get(LoggerInterface::class)->error(
+                'Error while selecting shares: ' . $qb->getSQL(),
+                [
+                    'app' => 'files_sharing',
+                    'exception' => $e
+                ]);
+            throw new \RuntimeException('Wrong SQL query', 500, $e);
+        }
+
+        $root = strlen($root);
+        $items = [];
+        $targets = [];
+        $switchedItems = [];
+        $mounts = [];
+        while ($row = $result->fetch()) {
+            //var_dump($row);
+            self::transformDBResults($row);
+            // Filter out duplicate group shares for users with unique targets
+            if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
+                continue;
+            }
+            if ($row['share_type'] == self::$shareTypeGroupUserUnique && isset($items[$row['parent']])) {
+                $row['share_type'] = IShare::TYPE_GROUP;
+                $row['unique_name'] = true; // remember that we use a unique name for this user
+                $row['share_with'] = $items[$row['parent']]['share_with'];
+                // if the group share was unshared from the user we keep the permission, otherwise
+                // we take the permission from the parent because this is always the up-to-date
+                // permission for the group share
+                if ($row['permissions'] > 0) {
+                    $row['permissions'] = $items[$row['parent']]['permissions'];
+                }
+                // Remove the parent group share
+                unset($items[$row['parent']]);
+                if ($row['permissions'] == 0) {
+                    continue;
+                }
+            } elseif (!isset($uidOwner)) {
+                // Check if the same target already exists
+                if (isset($targets[$row['id']])) {
+                    // Check if the same owner shared with the user twice
+                    // through a group and user share - this is allowed
+                    $id = $targets[$row['id']];
+                    if (isset($items[$id]) && $items[$id]['uid_owner'] == $row['uid_owner']) {
+                        // Switch to group share type to ensure resharing conditions aren't bypassed
+                        if ($items[$id]['share_type'] != IShare::TYPE_GROUP) {
+                            $items[$id]['share_type'] = IShare::TYPE_GROUP;
+                            $items[$id]['share_with'] = $row['share_with'];
+                        }
+                        // Switch ids if sharing permission is granted on only
+                        // one share to ensure correct parent is used if resharing
+                        if (~(int)$items[$id]['permissions'] & \OCP\Constants::PERMISSION_SHARE
+                            && (int)$row['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
+                            $items[$row['id']] = $items[$id];
+                            $switchedItems[$id] = $row['id'];
+                            unset($items[$id]);
+                            $id = $row['id'];
+                        }
+                        $items[$id]['permissions'] |= (int)$row['permissions'];
+                    }
+                    continue;
+                } elseif (!empty($row['parent'])) {
+                    $targets[$row['parent']] = $row['id'];
+                }
+            }
+            // Remove root from file source paths if retrieving own shared items
+            if (isset($uidOwner) && isset($row['path'])) {
+                if (isset($row['parent'])) {
+                    $query = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+                    $query->select('file_target')
+                        ->from('share')
+                        ->where($query->expr()->eq('id', $query->createNamedParameter($row['parent'])));
+
+                    $parentRow = false;
+                    try {
+                        $parentResult = $query->executeQuery();
+                        $parentRow = $parentResult->fetchOne();
+                        $parentResult->closeCursor();
+
+                        $tmpPath = $parentRow['file_target'];
+                        // find the right position where the row path continues from the target path
+                        $pos = strrpos($row['path'], $parentRow['file_target']);
+                        $subPath = substr($row['path'], $pos);
+                        $splitPath = explode('/', $subPath);
+                        foreach (array_slice($splitPath, 2) as $pathPart) {
+                            $tmpPath = $tmpPath . '/' . $pathPart;
+                        }
+                        $row['path'] = $tmpPath;
+                    } catch (Exception $e) {
+                        \OCP\Server::get(LoggerInterface::class)
+                            ->error('Can\'t select parent :' . $e->getMessage() . ' query=' . $query->getSQL(), [
+                                'exception' => $e,
+                                'app' => 'core'
+                            ]);
+                    }
+                } else {
+                    if (!isset($mounts[$row['storage']])) {
+                        $mountPoints = \OC\Files\Filesystem::getMountByNumericId($row['storage']);
+                        if (is_array($mountPoints) && !empty($mountPoints)) {
+                            $mounts[$row['storage']] = current($mountPoints);
+                        }
+                    }
+                    if (!empty($mounts[$row['storage']])) {
+                        $path = $mounts[$row['storage']]->getMountPoint() . $row['path'];
+                        $relPath = substr($path, $root); // path relative to data/user
+                        $row['path'] = rtrim($relPath, '/');
+                    }
+                }
+            }
+
+            // Check if resharing is allowed, if not remove share permission
+            if (isset($row['permissions']) && (!self::isResharingAllowed() | \OCP\Util::isSharingDisabledForUser())) {
+                $row['permissions'] &= ~\OCP\Constants::PERMISSION_SHARE;
+            }
+            // Add display names to result
+            $row['share_with_displayname'] = $row['share_with'];
+            if (isset($row['share_with']) && $row['share_with'] != '' &&
+                $row['share_type'] === IShare::TYPE_USER) {
+                $shareWithUser = \OC::$server->getUserManager()->get($row['share_with']);
+                $row['share_with_displayname'] = $shareWithUser === null ? $row['share_with'] : $shareWithUser->getDisplayName();
+            } elseif (isset($row['share_with']) && $row['share_with'] != '' &&
+                $row['share_type'] === IShare::TYPE_REMOTE) {
+                $addressBookEntries = \OC::$server->getContactsManager()->search($row['share_with'], ['CLOUD'], [
+                    'limit' => 1,
+                    'enumeration' => false,
+                    'fullmatch' => false,
+                    'strict_search' => true,
+                ]);
+                foreach ($addressBookEntries as $entry) {
+                    foreach ($entry['CLOUD'] as $cloudID) {
+                        if ($cloudID === $row['share_with']) {
+                            $row['share_with_displayname'] = $entry['FN'];
+                        }
+                    }
+                }
+            }
+            if (isset($row['uid_owner']) && $row['uid_owner'] != '') {
+                $ownerUser = \OC::$server->getUserManager()->get($row['uid_owner']);
+                $row['displayname_owner'] = $ownerUser === null ? $row['uid_owner'] : $ownerUser->getDisplayName();
+            }
+
+            if ($row['permissions'] > 0) {
+                $items[$row['id']] = $row;
+            }
+        }
+        $result->closeCursor();
+
+        // group items if we are looking for items shared with the current user
+        if (isset($shareWith) && $shareWith === \OC_User::getUser()) {
+            $items = self::groupItems($items, $itemType);
+        }
+
+        if (!empty($items)) {
+            $collectionItems = [];
+            foreach ($items as &$row) {
+                // Check if this is a collection of the requested item type
+                if ($includeCollections && $collectionTypes && $row['item_type'] !== 'folder' && in_array($row['item_type'], $collectionTypes)) {
+                    if (($collectionBackend = self::getBackend($row['item_type']))
+                        && $collectionBackend instanceof \OCP\Share_Backend_Collection) {
+                        // Collections can be inside collections, check if the item is a collection
+                        if (isset($item) && $row['item_type'] == $itemType && $row[$column] == $item) {
+                            $collectionItems[] = $row;
+                        } else {
+                            $collection = [];
+                            $collection['item_type'] = $row['item_type'];
+                            if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
+                                $collection['path'] = basename($row['path']);
+                            }
+                            $row['collection'] = $collection;
+                            // Fetch all the children sources
+                            $children = $collectionBackend->getChildren($row[$column]);
+                            foreach ($children as $child) {
+                                $childItem = $row;
+                                $childItem['item_type'] = $itemType;
+                                if ($row['item_type'] != 'file' && $row['item_type'] != 'folder') {
+                                    $childItem['item_source'] = $child['source'];
+                                    $childItem['item_target'] = $child['target'];
+                                }
+                                if ($backend instanceof \OCP\Share_Backend_File_Dependent) {
+                                    if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
+                                        $childItem['file_source'] = $child['source'];
+                                    } else { // TODO is this really needed if we already know that we use the file backend?
+                                        $meta = \OC\Files\Filesystem::getFileInfo($child['file_path']);
+                                        $childItem['file_source'] = $meta['fileid'];
+                                    }
+                                    $childItem['file_target'] =
+                                        \OC\Files\Filesystem::normalizePath($child['file_path']);
+                                }
+                                if (isset($item)) {
+                                    if ($childItem[$column] == $item) {
+                                        $collectionItems[] = $childItem;
+                                    }
+                                } else {
+                                    $collectionItems[] = $childItem;
+                                }
+                            }
+                        }
+                    }
+                    // Remove collection item
+                    $toRemove = $row['id'];
+                    if (array_key_exists($toRemove, $switchedItems)) {
+                        $toRemove = $switchedItems[$toRemove];
+                    }
+                    unset($items[$toRemove]);
+                } elseif ($includeCollections && $collectionTypes && in_array($row['item_type'], $collectionTypes)) {
+                    // FIXME: Thats a dirty hack to improve file sharing performance,
+                    // see github issue #10588 for more details
+                    // Need to find a solution which works for all back-ends
+                    $collectionBackend = self::getBackend($row['item_type']);
+                    $sharedParents = $collectionBackend->getParents($row['item_source']);
+                    foreach ($sharedParents as $parent) {
+                        $collectionItems[] = $parent;
+                    }
+                }
+            }
+            if (!empty($collectionItems)) {
+                $collectionItems = array_unique($collectionItems, SORT_REGULAR);
+                $items = array_merge($items, $collectionItems);
+            }
+
+            // filter out invalid items, these can appear when subshare entries exist
+            // for a group in which the requested user isn't a member any more
+            $items = array_filter($items, function ($item) {
+                return $item['share_type'] !== self::$shareTypeGroupUserUnique;
+            });
+
+            return self::formatResult($items, $column, $backend);
+        } elseif ($includeCollections && $collectionTypes && in_array('folder', $collectionTypes)) {
+            // FIXME: Thats a dirty hack to improve file sharing performance,
+            // see github issue #10588 for more details
+            // Need to find a solution which works for all back-ends
+            $collectionItems = [];
+            $collectionBackend = self::getBackend('folder');
+            $sharedParents = $collectionBackend->getParents($item, $shareWith, $uidOwner);
+            foreach ($sharedParents as $parent) {
+                $collectionItems[] = $parent;
+            }
+            return self::formatResult($collectionItems, $column, $backend);
+        }
+
+        return [];
+    }
+
+    /**
+     * group items with link to the same source
+     *
+     * @param array $items
+     * @param string $itemType
+     * @return array of grouped items
+     */
+    protected static function groupItems($items, $itemType) {
+        $fileSharing = $itemType === 'file' || $itemType === 'folder';
+
+        $result = [];
+
+        foreach ($items as $item) {
+            $grouped = false;
+            foreach ($result as $key => $r) {
+                // for file/folder shares we need to compare file_source, otherwise we compare item_source
+                // only group shares if they already point to the same target, otherwise the file where shared
+                // before grouping of shares was added. In this case we don't group them to avoid confusions
+                if (($fileSharing && $item['file_source'] === $r['file_source'] && $item['file_target'] === $r['file_target']) ||
+                    (!$fileSharing && $item['item_source'] === $r['item_source'] && $item['item_target'] === $r['item_target'])) {
+                    // add the first item to the list of grouped shares
+                    if (!isset($result[$key]['grouped'])) {
+                        $result[$key]['grouped'][] = $result[$key];
+                    }
+                    $result[$key]['permissions'] = (int)$item['permissions'] | (int)$r['permissions'];
+                    $result[$key]['grouped'][] = $item;
+                    $grouped = true;
+                    break;
+                }
+            }
+
+            if (!$grouped) {
+                $result[] = $item;
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * Construct select statement
+     *
+     * @param bool $fileDependent ist it a file/folder share or a general share
+     */
+    private static function getSelectStatement(int $format, bool $fileDependent, ?string $uidOwner = null): IQueryBuilder {
+        /** @var IDBConnection $connection */
+        $connection = \OC::$server->get(IDBConnection::class);
+        $qb = $connection->getQueryBuilder();
+        if ($format == self::FORMAT_STATUSES) {
+            if ($fileDependent) {
+                return $qb->select(
+                    's.id',
+                    's.parent',
+                    'share_type',
+                    'path',
+                    'storage',
+                    'share_with',
+                    'uid_owner',
+                    'file_source',
+                    'stime',
+                    's.permissions',
+                    'uid_initiator'
+                )->selectAlias('st.id', 'storage_id')
+                    ->selectAlias('f.parent', 'file_parent');
+            }
+            return $qb->select('id', 'parent', 'share_type', 'share_with', 'uid_owner', 'item_source', 'stime', 's.permissions');
+        }
+
+        if (isset($uidOwner)) {
+            if ($fileDependent) {
+                return $qb->select(
+                    's.id',
+                    'item_type',
+                    'item_source',
+                    's.parent',
+                    'share_type',
+                    'share_with',
+                    'file_source',
+                    'file_target',
+                    'path',
+                    's.permissions',
+                    'stime',
+                    'expiration',
+                    'token',
+                    'storage',
+                    'mail_send',
+                    'uid_owner',
+                    'uid_initiator'
+                )->selectAlias('st.id', 'storage_id')
+                    ->selectAlias('f.parent', 'file_parent');
+            }
+            return $qb->select('id', 'item_type', 'item_source', 'parent', 'share_type',
+                'share_with', 'uid_owner', 'file_source', 'stime', 's.permissions',
+                'expiration', 'token', 'mail_send');
+        }
+
+        if ($fileDependent) {
+            if ($format == File::FORMAT_GET_FOLDER_CONTENTS || $format == File::FORMAT_FILE_APP_ROOT) {
+                return $qb->select(
+                    's.id',
+                    'item_type',
+                    'item_source',
+                    's.parent',
+                    'uid_owner',
+                    'share_type',
+                    'share_with',
+                    'file_source',
+                    'path',
+                    'file_target',
+                    's.permissions',
+                    'stime',
+                    'expiration',
+                    'storage',
+                    'name',
+                    'mtime',
+                    'mimepart',
+                    'size',
+                    'encrypted',
+                    'etag',
+                    'mail_send'
+                )->selectAlias('f.parent', 'file_parent');
+            }
+            return $qb->select(
+                's.id',
+                'item_type',
+                'item_source',
+                'item_target',
+                's.parent',
+                'share_type',
+                'share_with',
+                'uid_owner',
+                'file_source',
+                'path',
+                'file_target',
+                's.permissions',
+                'stime',
+                'expiration',
+                'token',
+                'storage',
+                'mail_send',
+            )->selectAlias('f.parent', 'file_parent')
+                ->selectAlias('st.id', 'storage_id');
+        }
+        return $qb->select('*');
+    }
+
+
+    /**
+     * transform db results
+     *
+     * @param array $row result
+     */
+    private static function transformDBResults(&$row) {
+        if (isset($row['id'])) {
+            $row['id'] = (int)$row['id'];
+        }
+        if (isset($row['share_type'])) {
+            $row['share_type'] = (int)$row['share_type'];
+        }
+        if (isset($row['parent'])) {
+            $row['parent'] = (int)$row['parent'];
+        }
+        if (isset($row['file_parent'])) {
+            $row['file_parent'] = (int)$row['file_parent'];
+        }
+        if (isset($row['file_source'])) {
+            $row['file_source'] = (int)$row['file_source'];
+        }
+        if (isset($row['permissions'])) {
+            $row['permissions'] = (int)$row['permissions'];
+        }
+        if (isset($row['storage'])) {
+            $row['storage'] = (int)$row['storage'];
+        }
+        if (isset($row['stime'])) {
+            $row['stime'] = (int)$row['stime'];
+        }
+        if (isset($row['expiration']) && $row['share_type'] !== IShare::TYPE_LINK) {
+            // discard expiration date for non-link shares, which might have been
+            // set by ancient bugs
+            $row['expiration'] = null;
+        }
+    }
+
+    /**
+     * format result
+     *
+     * @param array $items result
+     * @param string $column is it a file share or a general share ('file_target' or 'item_target')
+     * @param \OCP\Share_Backend $backend sharing backend
+     * @param int $format
+     * @param array $parameters additional format parameters
+     * @return array format result
+     */
+    private static function formatResult($items, $column, $backend, $format = self::FORMAT_NONE, $parameters = null) {
+        if ($format === self::FORMAT_NONE) {
+            return $items;
+        } elseif ($format === self::FORMAT_STATUSES) {
+            $statuses = [];
+            foreach ($items as $item) {
+                if ($item['share_type'] === IShare::TYPE_LINK) {
+                    if ($item['uid_initiator'] !== \OC::$server->getUserSession()->getUser()->getUID()) {
+                        continue;
+                    }
+                    $statuses[$item[$column]]['link'] = true;
+                } elseif (!isset($statuses[$item[$column]])) {
+                    $statuses[$item[$column]]['link'] = false;
+                }
+                if (!empty($item['file_target'])) {
+                    $statuses[$item[$column]]['path'] = $item['path'];
+                }
+            }
+            return $statuses;
+        } else {
+            return $backend->formatItems($items, $format, $parameters);
+        }
+    }
+
+    /**
+     * remove protocol from URL
+     *
+     * @param string $url
+     * @return string
+     */
+    public static function removeProtocolFromUrl($url) {
+        if (str_starts_with($url, 'https://')) {
+            return substr($url, strlen('https://'));
+        } elseif (str_starts_with($url, 'http://')) {
+            return substr($url, strlen('http://'));
+        }
+
+        return $url;
+    }
+
+
+    /**
+     * @return int
+     */
+    public static function getExpireInterval() {
+        return (int)\OC::$server->getConfig()->getAppValue('core', 'shareapi_expire_after_n_days', '7');
+    }
+
+    /**
+     * Checks whether the given path is reachable for the given owner
+     *
+     * @param string $path path relative to files
+     * @param string $ownerStorageId storage id of the owner
+     *
+     * @return boolean true if file is reachable, false otherwise
+     */
+    private static function isFileReachable($path, $ownerStorageId) {
+        // if outside the home storage, file is always considered reachable
+        if (!(substr($ownerStorageId, 0, 6) === 'home::' ||
+            substr($ownerStorageId, 0, 13) === 'object::user:'
+        )) {
+            return true;
+        }
+
+        // if inside the home storage, the file has to be under "/files/"
+        $path = ltrim($path, '/');
+        if (substr($path, 0, 6) === 'files/') {
+            return true;
+        }
+
+        return false;
+    }
 }

lib/private/Preview/Generator.php

Indentation +601 added lines, -601 removed lines

@@ -48,619 +48,619 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class Generator {
-	public const SEMAPHORE_ID_ALL = 0x0a11;
-	public const SEMAPHORE_ID_NEW = 0x07ea;
-
-	/** @var IPreview */
-	private $previewManager;
-	/** @var IConfig */
-	private $config;
-	/** @var IAppData */
-	private $appData;
-	/** @var GeneratorHelper */
-	private $helper;
-	/** @var EventDispatcherInterface */
-	private $legacyEventDispatcher;
-	/** @var IEventDispatcher */
-	private $eventDispatcher;
-
-	public function __construct(
-		IConfig $config,
-		IPreview $previewManager,
-		IAppData $appData,
-		GeneratorHelper $helper,
-		EventDispatcherInterface $legacyEventDispatcher,
-		IEventDispatcher $eventDispatcher
-	) {
-		$this->config = $config;
-		$this->previewManager = $previewManager;
-		$this->appData = $appData;
-		$this->helper = $helper;
-		$this->legacyEventDispatcher = $legacyEventDispatcher;
-		$this->eventDispatcher = $eventDispatcher;
-	}
-
-	/**
-	 * Returns a preview of a file
-	 *
-	 * The cache is searched first and if nothing usable was found then a preview is
-	 * generated by one of the providers
-	 *
-	 * @param File $file
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param string $mode
-	 * @param string $mimeType
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 */
-	public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
-		$specification = [
-			'width' => $width,
-			'height' => $height,
-			'crop' => $crop,
-			'mode' => $mode,
-		];
-
-		$this->legacyEventDispatcher->dispatch(
-			IPreview::EVENT,
-			new GenericEvent($file, $specification)
-		);
-		$this->eventDispatcher->dispatchTyped(new BeforePreviewFetchedEvent(
-			$file
-		));
-
-		// since we only ask for one preview, and the generate method return the last one it created, it returns the one we want
-		return $this->generatePreviews($file, [$specification], $mimeType);
-	}
-
-	/**
-	 * Generates previews of a file
-	 *
-	 * @param File $file
-	 * @param non-empty-array $specifications
-	 * @param string $mimeType
-	 * @return ISimpleFile the last preview that was generated
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 */
-	public function generatePreviews(File $file, array $specifications, $mimeType = null) {
-		//Make sure that we can read the file
-		if (!$file->isReadable()) {
-			throw new NotFoundException('Cannot read file');
-		}
-
-		if ($mimeType === null) {
-			$mimeType = $file->getMimeType();
-		}
-
-		$previewFolder = $this->getPreviewFolder($file);
-		// List every existing preview first instead of trying to find them one by one
-		$previewFiles = $previewFolder->getDirectoryListing();
-
-		$previewVersion = '';
-		if ($file instanceof IVersionedPreviewFile) {
-			$previewVersion = $file->getPreviewVersion() . '-';
-		}
-
-		// If imaginary is enabled, and we request a small thumbnail,
-		// let's not generate the max preview for performance reasons
-		if (count($specifications) === 1
-			&& ($specifications[0]['width'] <= 256 || $specifications[0]['height'] <= 256)
-			&& preg_match(Imaginary::supportedMimeTypes(), $mimeType)
-			&& $this->config->getSystemValueString('preview_imaginary_url', 'invalid') !== 'invalid') {
-			$crop = $specifications[0]['crop'] ?? false;
-			$preview = $this->getSmallImagePreview($previewFolder, $previewFiles, $file, $mimeType, $previewVersion, $crop);
-
-			if ($preview->getSize() === 0) {
-				$preview->delete();
-				throw new NotFoundException('Cached preview size 0, invalid!');
-			}
-
-			return $preview;
-		}
-
-		// Get the max preview and infer the max preview sizes from that
-		$maxPreview = $this->getMaxPreview($previewFolder, $previewFiles, $file, $mimeType, $previewVersion);
-		$maxPreviewImage = null; // only load the image when we need it
-		if ($maxPreview->getSize() === 0) {
-			$maxPreview->delete();
-			throw new NotFoundException('Max preview size 0, invalid!');
-		}
-
-		[$maxWidth, $maxHeight] = $this->getPreviewSize($maxPreview, $previewVersion);
-
-		if ($maxWidth <= 0 || $maxHeight <= 0) {
-			throw new NotFoundException('The maximum preview sizes are zero or less pixels');
-		}
-
-		$preview = null;
-
-		foreach ($specifications as $specification) {
-			$width = $specification['width'] ?? -1;
-			$height = $specification['height'] ?? -1;
-			$crop = $specification['crop'] ?? false;
-			$mode = $specification['mode'] ?? IPreview::MODE_FILL;
-
-			// If both width and height are -1 we just want the max preview
-			if ($width === -1 && $height === -1) {
-				$width = $maxWidth;
-				$height = $maxHeight;
-			}
-
-			// Calculate the preview size
-			[$width, $height] = $this->calculateSize($width, $height, $crop, $mode, $maxWidth, $maxHeight);
-
-			// No need to generate a preview that is just the max preview
-			if ($width === $maxWidth && $height === $maxHeight) {
-				// ensure correct return value if this was the last one
-				$preview = $maxPreview;
-				continue;
-			}
-
-			// Try to get a cached preview. Else generate (and store) one
-			try {
-				try {
-					$preview = $this->getCachedPreview($previewFiles, $width, $height, $crop, $maxPreview->getMimeType(), $previewVersion);
-				} catch (NotFoundException $e) {
-					if (!$this->previewManager->isMimeSupported($mimeType)) {
-						throw new NotFoundException();
-					}
-
-					if ($maxPreviewImage === null) {
-						$maxPreviewImage = $this->helper->getImage($maxPreview);
-					}
-
-					$preview = $this->generatePreview($previewFolder, $maxPreviewImage, $width, $height, $crop, $maxWidth, $maxHeight, $previewVersion);
-					// New file, augment our array
-					$previewFiles[] = $preview;
-				}
-			} catch (\InvalidArgumentException $e) {
-				throw new NotFoundException("", 0, $e);
-			}
-
-			if ($preview->getSize() === 0) {
-				$preview->delete();
-				throw new NotFoundException('Cached preview size 0, invalid!');
-			}
-		}
-		assert($preview !== null);
-
-		// Free memory being used by the embedded image resource.  Without this the image is kept in memory indefinitely.
-		// Garbage Collection does NOT free this memory.  We have to do it ourselves.
-		if ($maxPreviewImage instanceof \OCP\Image) {
-			$maxPreviewImage->destroy();
-		}
-
-		return $preview;
-	}
-
-	/**
-	 * Generate a small image straight away without generating a max preview first
-	 * Preview generated is 256x256
-	 *
-	 * @param ISimpleFile[] $previewFiles
-	 *
-	 * @throws NotFoundException
-	 */
-	private function getSmallImagePreview(ISimpleFolder $previewFolder, array $previewFiles, File $file, string $mimeType, string $prefix, bool $crop): ISimpleFile {
-		$width = 256;
-		$height = 256;
-
-		try {
-			return $this->getCachedPreview($previewFiles, $width, $height, $crop, $mimeType, $prefix);
-		} catch (NotFoundException $e) {
-			return $this->generateProviderPreview($previewFolder, $file, $width, $height, $crop, false, $mimeType, $prefix);
-		}
-	}
-
-	/**
-	 * Acquire a semaphore of the specified id and concurrency, blocking if necessary.
-	 * Return an identifier of the semaphore on success, which can be used to release it via
-	 * {@see Generator::unguardWithSemaphore()}.
-	 *
-	 * @param int $semId
-	 * @param int $concurrency
-	 * @return false|resource the semaphore on success or false on failure
-	 */
-	public static function guardWithSemaphore(int $semId, int $concurrency) {
-		if (!extension_loaded('sysvsem')) {
-			return false;
-		}
-		$sem = sem_get($semId, $concurrency);
-		if ($sem === false) {
-			return false;
-		}
-		if (!sem_acquire($sem)) {
-			return false;
-		}
-		return $sem;
-	}
-
-	/**
-	 * Releases the semaphore acquired from {@see Generator::guardWithSemaphore()}.
-	 *
-	 * @param resource|bool $semId the semaphore identifier returned by guardWithSemaphore
-	 * @return bool
-	 */
-	public static function unguardWithSemaphore($semId): bool {
-		if (!is_resource($semId) || !extension_loaded('sysvsem')) {
-			return false;
-		}
-		return sem_release($semId);
-	}
-
-	/**
-	 * Get the number of concurrent threads supported by the host.
-	 *
-	 * @return int number of concurrent threads, or 0 if it cannot be determined
-	 */
-	public static function getHardwareConcurrency(): int {
-		static $width;
-		if (!isset($width)) {
-			if (is_file("/proc/cpuinfo")) {
-				$width = substr_count(file_get_contents("/proc/cpuinfo"), "processor");
-			} else {
-				$width = 0;
-			}
-		}
-		return $width;
-	}
-
-	/**
-	 * Get number of concurrent preview generations from system config
-	 *
-	 * Two config entries, `preview_concurrency_new` and `preview_concurrency_all`,
-	 * are available. If not set, the default values are determined with the hardware concurrency
-	 * of the host. In case the hardware concurrency cannot be determined, or the user sets an
-	 * invalid value, fallback values are:
-	 * For new images whose previews do not exist and need to be generated, 4;
-	 * For all preview generation requests, 8.
-	 * Value of `preview_concurrency_all` should be greater than or equal to that of
-	 * `preview_concurrency_new`, otherwise, the latter is returned.
-	 *
-	 * @param string $type either `preview_concurrency_new` or `preview_concurrency_all`
-	 * @return int number of concurrent preview generations, or -1 if $type is invalid
-	 */
-	public function getNumConcurrentPreviews(string $type): int {
-		static $cached = array();
-		if (array_key_exists($type, $cached)) {
-			return $cached[$type];
-		}
-
-		$hardwareConcurrency = self::getHardwareConcurrency();
-		switch ($type) {
-			case "preview_concurrency_all":
-				$fallback = $hardwareConcurrency > 0 ? $hardwareConcurrency * 2 : 8;
-				$concurrency_all = $this->config->getSystemValueInt($type, $fallback);
-				$concurrency_new = $this->getNumConcurrentPreviews("preview_concurrency_new");
-				$cached[$type] = max($concurrency_all, $concurrency_new);
-				break;
-			case "preview_concurrency_new":
-				$fallback = $hardwareConcurrency > 0 ? $hardwareConcurrency : 4;
-				$cached[$type] = $this->config->getSystemValueInt($type, $fallback);
-				break;
-			default:
-				return -1;
-		}
-		return $cached[$type];
-	}
-
-	/**
-	 * @param ISimpleFolder $previewFolder
-	 * @param ISimpleFile[] $previewFiles
-	 * @param File $file
-	 * @param string $mimeType
-	 * @param string $prefix
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 */
-	private function getMaxPreview(ISimpleFolder $previewFolder, array $previewFiles, File $file, $mimeType, $prefix) {
-		// We don't know the max preview size, so we can't use getCachedPreview.
-		// It might have been generated with a higher resolution than the current value.
-		foreach ($previewFiles as $node) {
-			$name = $node->getName();
-			if (($prefix === '' || str_starts_with($name, $prefix)) && strpos($name, 'max')) {
-				return $node;
-			}
-		}
-
-		$maxWidth = $this->config->getSystemValueInt('preview_max_x', 4096);
-		$maxHeight = $this->config->getSystemValueInt('preview_max_y', 4096);
-
-		return $this->generateProviderPreview($previewFolder, $file, $maxWidth, $maxHeight, false, true, $mimeType, $prefix);
-	}
-
-	private function generateProviderPreview(ISimpleFolder $previewFolder, File $file, int $width, int $height, bool $crop, bool $max, string $mimeType, string $prefix) {
-		$previewProviders = $this->previewManager->getProviders();
-		foreach ($previewProviders as $supportedMimeType => $providers) {
-			// Filter out providers that does not support this mime
-			if (!preg_match($supportedMimeType, $mimeType)) {
-				continue;
-			}
-
-			foreach ($providers as $providerClosure) {
-				$provider = $this->helper->getProvider($providerClosure);
-				if (!($provider instanceof IProviderV2)) {
-					continue;
-				}
-
-				if (!$provider->isAvailable($file)) {
-					continue;
-				}
-
-				$previewConcurrency = $this->getNumConcurrentPreviews('preview_concurrency_new');
-				$sem = self::guardWithSemaphore(self::SEMAPHORE_ID_NEW, $previewConcurrency);
-				try {
-					$preview = $this->helper->getThumbnail($provider, $file, $width, $height);
-				} finally {
-					self::unguardWithSemaphore($sem);
-				}
-
-				if (!($preview instanceof IImage)) {
-					continue;
-				}
-
-				$path = $this->generatePath($preview->width(), $preview->height(), $crop, $max, $preview->dataMimeType(), $prefix);
-				try {
-					$file = $previewFolder->newFile($path);
-					if ($preview instanceof IStreamImage) {
-						$file->putContent($preview->resource());
-					} else {
-						$file->putContent($preview->data());
-					}
-				} catch (NotPermittedException $e) {
-					throw new NotFoundException();
-				}
-
-				return $file;
-			}
-		}
-
-		throw new NotFoundException('No provider successfully handled the preview generation');
-	}
-
-	/**
-	 * @param ISimpleFile $file
-	 * @param string $prefix
-	 * @return int[]
-	 */
-	private function getPreviewSize(ISimpleFile $file, string $prefix = '') {
-		$size = explode('-', substr($file->getName(), strlen($prefix)));
-		return [(int)$size[0], (int)$size[1]];
-	}
-
-	/**
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param bool $max
-	 * @param string $mimeType
-	 * @param string $prefix
-	 * @return string
-	 */
-	private function generatePath($width, $height, $crop, $max, $mimeType, $prefix) {
-		$path = $prefix . (string)$width . '-' . (string)$height;
-		if ($crop) {
-			$path .= '-crop';
-		}
-		if ($max) {
-			$path .= '-max';
-		}
-
-		$ext = $this->getExtension($mimeType);
-		$path .= '.' . $ext;
-		return $path;
-	}
-
-
-	/**
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param string $mode
-	 * @param int $maxWidth
-	 * @param int $maxHeight
-	 * @return int[]
-	 */
-	private function calculateSize($width, $height, $crop, $mode, $maxWidth, $maxHeight) {
-		/*
+    public const SEMAPHORE_ID_ALL = 0x0a11;
+    public const SEMAPHORE_ID_NEW = 0x07ea;
+
+    /** @var IPreview */
+    private $previewManager;
+    /** @var IConfig */
+    private $config;
+    /** @var IAppData */
+    private $appData;
+    /** @var GeneratorHelper */
+    private $helper;
+    /** @var EventDispatcherInterface */
+    private $legacyEventDispatcher;
+    /** @var IEventDispatcher */
+    private $eventDispatcher;
+
+    public function __construct(
+        IConfig $config,
+        IPreview $previewManager,
+        IAppData $appData,
+        GeneratorHelper $helper,
+        EventDispatcherInterface $legacyEventDispatcher,
+        IEventDispatcher $eventDispatcher
+    ) {
+        $this->config = $config;
+        $this->previewManager = $previewManager;
+        $this->appData = $appData;
+        $this->helper = $helper;
+        $this->legacyEventDispatcher = $legacyEventDispatcher;
+        $this->eventDispatcher = $eventDispatcher;
+    }
+
+    /**
+     * Returns a preview of a file
+     *
+     * The cache is searched first and if nothing usable was found then a preview is
+     * generated by one of the providers
+     *
+     * @param File $file
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param string $mode
+     * @param string $mimeType
+     * @return ISimpleFile
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     */
+    public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
+        $specification = [
+            'width' => $width,
+            'height' => $height,
+            'crop' => $crop,
+            'mode' => $mode,
+        ];
+
+        $this->legacyEventDispatcher->dispatch(
+            IPreview::EVENT,
+            new GenericEvent($file, $specification)
+        );
+        $this->eventDispatcher->dispatchTyped(new BeforePreviewFetchedEvent(
+            $file
+        ));
+
+        // since we only ask for one preview, and the generate method return the last one it created, it returns the one we want
+        return $this->generatePreviews($file, [$specification], $mimeType);
+    }
+
+    /**
+     * Generates previews of a file
+     *
+     * @param File $file
+     * @param non-empty-array $specifications
+     * @param string $mimeType
+     * @return ISimpleFile the last preview that was generated
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     */
+    public function generatePreviews(File $file, array $specifications, $mimeType = null) {
+        //Make sure that we can read the file
+        if (!$file->isReadable()) {
+            throw new NotFoundException('Cannot read file');
+        }
+
+        if ($mimeType === null) {
+            $mimeType = $file->getMimeType();
+        }
+
+        $previewFolder = $this->getPreviewFolder($file);
+        // List every existing preview first instead of trying to find them one by one
+        $previewFiles = $previewFolder->getDirectoryListing();
+
+        $previewVersion = '';
+        if ($file instanceof IVersionedPreviewFile) {
+            $previewVersion = $file->getPreviewVersion() . '-';
+        }
+
+        // If imaginary is enabled, and we request a small thumbnail,
+        // let's not generate the max preview for performance reasons
+        if (count($specifications) === 1
+            && ($specifications[0]['width'] <= 256 || $specifications[0]['height'] <= 256)
+            && preg_match(Imaginary::supportedMimeTypes(), $mimeType)
+            && $this->config->getSystemValueString('preview_imaginary_url', 'invalid') !== 'invalid') {
+            $crop = $specifications[0]['crop'] ?? false;
+            $preview = $this->getSmallImagePreview($previewFolder, $previewFiles, $file, $mimeType, $previewVersion, $crop);
+
+            if ($preview->getSize() === 0) {
+                $preview->delete();
+                throw new NotFoundException('Cached preview size 0, invalid!');
+            }
+
+            return $preview;
+        }
+
+        // Get the max preview and infer the max preview sizes from that
+        $maxPreview = $this->getMaxPreview($previewFolder, $previewFiles, $file, $mimeType, $previewVersion);
+        $maxPreviewImage = null; // only load the image when we need it
+        if ($maxPreview->getSize() === 0) {
+            $maxPreview->delete();
+            throw new NotFoundException('Max preview size 0, invalid!');
+        }
+
+        [$maxWidth, $maxHeight] = $this->getPreviewSize($maxPreview, $previewVersion);
+
+        if ($maxWidth <= 0 || $maxHeight <= 0) {
+            throw new NotFoundException('The maximum preview sizes are zero or less pixels');
+        }
+
+        $preview = null;
+
+        foreach ($specifications as $specification) {
+            $width = $specification['width'] ?? -1;
+            $height = $specification['height'] ?? -1;
+            $crop = $specification['crop'] ?? false;
+            $mode = $specification['mode'] ?? IPreview::MODE_FILL;
+
+            // If both width and height are -1 we just want the max preview
+            if ($width === -1 && $height === -1) {
+                $width = $maxWidth;
+                $height = $maxHeight;
+            }
+
+            // Calculate the preview size
+            [$width, $height] = $this->calculateSize($width, $height, $crop, $mode, $maxWidth, $maxHeight);
+
+            // No need to generate a preview that is just the max preview
+            if ($width === $maxWidth && $height === $maxHeight) {
+                // ensure correct return value if this was the last one
+                $preview = $maxPreview;
+                continue;
+            }
+
+            // Try to get a cached preview. Else generate (and store) one
+            try {
+                try {
+                    $preview = $this->getCachedPreview($previewFiles, $width, $height, $crop, $maxPreview->getMimeType(), $previewVersion);
+                } catch (NotFoundException $e) {
+                    if (!$this->previewManager->isMimeSupported($mimeType)) {
+                        throw new NotFoundException();
+                    }
+
+                    if ($maxPreviewImage === null) {
+                        $maxPreviewImage = $this->helper->getImage($maxPreview);
+                    }
+
+                    $preview = $this->generatePreview($previewFolder, $maxPreviewImage, $width, $height, $crop, $maxWidth, $maxHeight, $previewVersion);
+                    // New file, augment our array
+                    $previewFiles[] = $preview;
+                }
+            } catch (\InvalidArgumentException $e) {
+                throw new NotFoundException("", 0, $e);
+            }
+
+            if ($preview->getSize() === 0) {
+                $preview->delete();
+                throw new NotFoundException('Cached preview size 0, invalid!');
+            }
+        }
+        assert($preview !== null);
+
+        // Free memory being used by the embedded image resource.  Without this the image is kept in memory indefinitely.
+        // Garbage Collection does NOT free this memory.  We have to do it ourselves.
+        if ($maxPreviewImage instanceof \OCP\Image) {
+            $maxPreviewImage->destroy();
+        }
+
+        return $preview;
+    }
+
+    /**
+     * Generate a small image straight away without generating a max preview first
+     * Preview generated is 256x256
+     *
+     * @param ISimpleFile[] $previewFiles
+     *
+     * @throws NotFoundException
+     */
+    private function getSmallImagePreview(ISimpleFolder $previewFolder, array $previewFiles, File $file, string $mimeType, string $prefix, bool $crop): ISimpleFile {
+        $width = 256;
+        $height = 256;
+
+        try {
+            return $this->getCachedPreview($previewFiles, $width, $height, $crop, $mimeType, $prefix);
+        } catch (NotFoundException $e) {
+            return $this->generateProviderPreview($previewFolder, $file, $width, $height, $crop, false, $mimeType, $prefix);
+        }
+    }
+
+    /**
+     * Acquire a semaphore of the specified id and concurrency, blocking if necessary.
+     * Return an identifier of the semaphore on success, which can be used to release it via
+     * {@see Generator::unguardWithSemaphore()}.
+     *
+     * @param int $semId
+     * @param int $concurrency
+     * @return false|resource the semaphore on success or false on failure
+     */
+    public static function guardWithSemaphore(int $semId, int $concurrency) {
+        if (!extension_loaded('sysvsem')) {
+            return false;
+        }
+        $sem = sem_get($semId, $concurrency);
+        if ($sem === false) {
+            return false;
+        }
+        if (!sem_acquire($sem)) {
+            return false;
+        }
+        return $sem;
+    }
+
+    /**
+     * Releases the semaphore acquired from {@see Generator::guardWithSemaphore()}.
+     *
+     * @param resource|bool $semId the semaphore identifier returned by guardWithSemaphore
+     * @return bool
+     */
+    public static function unguardWithSemaphore($semId): bool {
+        if (!is_resource($semId) || !extension_loaded('sysvsem')) {
+            return false;
+        }
+        return sem_release($semId);
+    }
+
+    /**
+     * Get the number of concurrent threads supported by the host.
+     *
+     * @return int number of concurrent threads, or 0 if it cannot be determined
+     */
+    public static function getHardwareConcurrency(): int {
+        static $width;
+        if (!isset($width)) {
+            if (is_file("/proc/cpuinfo")) {
+                $width = substr_count(file_get_contents("/proc/cpuinfo"), "processor");
+            } else {
+                $width = 0;
+            }
+        }
+        return $width;
+    }
+
+    /**
+     * Get number of concurrent preview generations from system config
+     *
+     * Two config entries, `preview_concurrency_new` and `preview_concurrency_all`,
+     * are available. If not set, the default values are determined with the hardware concurrency
+     * of the host. In case the hardware concurrency cannot be determined, or the user sets an
+     * invalid value, fallback values are:
+     * For new images whose previews do not exist and need to be generated, 4;
+     * For all preview generation requests, 8.
+     * Value of `preview_concurrency_all` should be greater than or equal to that of
+     * `preview_concurrency_new`, otherwise, the latter is returned.
+     *
+     * @param string $type either `preview_concurrency_new` or `preview_concurrency_all`
+     * @return int number of concurrent preview generations, or -1 if $type is invalid
+     */
+    public function getNumConcurrentPreviews(string $type): int {
+        static $cached = array();
+        if (array_key_exists($type, $cached)) {
+            return $cached[$type];
+        }
+
+        $hardwareConcurrency = self::getHardwareConcurrency();
+        switch ($type) {
+            case "preview_concurrency_all":
+                $fallback = $hardwareConcurrency > 0 ? $hardwareConcurrency * 2 : 8;
+                $concurrency_all = $this->config->getSystemValueInt($type, $fallback);
+                $concurrency_new = $this->getNumConcurrentPreviews("preview_concurrency_new");
+                $cached[$type] = max($concurrency_all, $concurrency_new);
+                break;
+            case "preview_concurrency_new":
+                $fallback = $hardwareConcurrency > 0 ? $hardwareConcurrency : 4;
+                $cached[$type] = $this->config->getSystemValueInt($type, $fallback);
+                break;
+            default:
+                return -1;
+        }
+        return $cached[$type];
+    }
+
+    /**
+     * @param ISimpleFolder $previewFolder
+     * @param ISimpleFile[] $previewFiles
+     * @param File $file
+     * @param string $mimeType
+     * @param string $prefix
+     * @return ISimpleFile
+     * @throws NotFoundException
+     */
+    private function getMaxPreview(ISimpleFolder $previewFolder, array $previewFiles, File $file, $mimeType, $prefix) {
+        // We don't know the max preview size, so we can't use getCachedPreview.
+        // It might have been generated with a higher resolution than the current value.
+        foreach ($previewFiles as $node) {
+            $name = $node->getName();
+            if (($prefix === '' || str_starts_with($name, $prefix)) && strpos($name, 'max')) {
+                return $node;
+            }
+        }
+
+        $maxWidth = $this->config->getSystemValueInt('preview_max_x', 4096);
+        $maxHeight = $this->config->getSystemValueInt('preview_max_y', 4096);
+
+        return $this->generateProviderPreview($previewFolder, $file, $maxWidth, $maxHeight, false, true, $mimeType, $prefix);
+    }
+
+    private function generateProviderPreview(ISimpleFolder $previewFolder, File $file, int $width, int $height, bool $crop, bool $max, string $mimeType, string $prefix) {
+        $previewProviders = $this->previewManager->getProviders();
+        foreach ($previewProviders as $supportedMimeType => $providers) {
+            // Filter out providers that does not support this mime
+            if (!preg_match($supportedMimeType, $mimeType)) {
+                continue;
+            }
+
+            foreach ($providers as $providerClosure) {
+                $provider = $this->helper->getProvider($providerClosure);
+                if (!($provider instanceof IProviderV2)) {
+                    continue;
+                }
+
+                if (!$provider->isAvailable($file)) {
+                    continue;
+                }
+
+                $previewConcurrency = $this->getNumConcurrentPreviews('preview_concurrency_new');
+                $sem = self::guardWithSemaphore(self::SEMAPHORE_ID_NEW, $previewConcurrency);
+                try {
+                    $preview = $this->helper->getThumbnail($provider, $file, $width, $height);
+                } finally {
+                    self::unguardWithSemaphore($sem);
+                }
+
+                if (!($preview instanceof IImage)) {
+                    continue;
+                }
+
+                $path = $this->generatePath($preview->width(), $preview->height(), $crop, $max, $preview->dataMimeType(), $prefix);
+                try {
+                    $file = $previewFolder->newFile($path);
+                    if ($preview instanceof IStreamImage) {
+                        $file->putContent($preview->resource());
+                    } else {
+                        $file->putContent($preview->data());
+                    }
+                } catch (NotPermittedException $e) {
+                    throw new NotFoundException();
+                }
+
+                return $file;
+            }
+        }
+
+        throw new NotFoundException('No provider successfully handled the preview generation');
+    }
+
+    /**
+     * @param ISimpleFile $file
+     * @param string $prefix
+     * @return int[]
+     */
+    private function getPreviewSize(ISimpleFile $file, string $prefix = '') {
+        $size = explode('-', substr($file->getName(), strlen($prefix)));
+        return [(int)$size[0], (int)$size[1]];
+    }
+
+    /**
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param bool $max
+     * @param string $mimeType
+     * @param string $prefix
+     * @return string
+     */
+    private function generatePath($width, $height, $crop, $max, $mimeType, $prefix) {
+        $path = $prefix . (string)$width . '-' . (string)$height;
+        if ($crop) {
+            $path .= '-crop';
+        }
+        if ($max) {
+            $path .= '-max';
+        }
+
+        $ext = $this->getExtension($mimeType);
+        $path .= '.' . $ext;
+        return $path;
+    }
+
+
+    /**
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param string $mode
+     * @param int $maxWidth
+     * @param int $maxHeight
+     * @return int[]
+     */
+    private function calculateSize($width, $height, $crop, $mode, $maxWidth, $maxHeight) {
+        /*
 		 * If we are not cropping we have to make sure the requested image
 		 * respects the aspect ratio of the original.
 		 */
-		if (!$crop) {
-			$ratio = $maxHeight / $maxWidth;
+        if (!$crop) {
+            $ratio = $maxHeight / $maxWidth;
 
-			if ($width === -1) {
-				$width = $height / $ratio;
-			}
-			if ($height === -1) {
-				$height = $width * $ratio;
-			}
+            if ($width === -1) {
+                $width = $height / $ratio;
+            }
+            if ($height === -1) {
+                $height = $width * $ratio;
+            }
 
-			$ratioH = $height / $maxHeight;
-			$ratioW = $width / $maxWidth;
+            $ratioH = $height / $maxHeight;
+            $ratioW = $width / $maxWidth;
 
-			/*
+            /*
 			 * Fill means that the $height and $width are the max
 			 * Cover means min.
 			 */
-			if ($mode === IPreview::MODE_FILL) {
-				if ($ratioH > $ratioW) {
-					$height = $width * $ratio;
-				} else {
-					$width = $height / $ratio;
-				}
-			} elseif ($mode === IPreview::MODE_COVER) {
-				if ($ratioH > $ratioW) {
-					$width = $height / $ratio;
-				} else {
-					$height = $width * $ratio;
-				}
-			}
-		}
-
-		if ($height !== $maxHeight && $width !== $maxWidth) {
-			/*
+            if ($mode === IPreview::MODE_FILL) {
+                if ($ratioH > $ratioW) {
+                    $height = $width * $ratio;
+                } else {
+                    $width = $height / $ratio;
+                }
+            } elseif ($mode === IPreview::MODE_COVER) {
+                if ($ratioH > $ratioW) {
+                    $width = $height / $ratio;
+                } else {
+                    $height = $width * $ratio;
+                }
+            }
+        }
+
+        if ($height !== $maxHeight && $width !== $maxWidth) {
+            /*
 			 * Scale to the nearest power of four
 			 */
-			$pow4height = 4 ** ceil(log($height) / log(4));
-			$pow4width = 4 ** ceil(log($width) / log(4));
-
-			// Minimum size is 64
-			$pow4height = max($pow4height, 64);
-			$pow4width = max($pow4width, 64);
-
-			$ratioH = $height / $pow4height;
-			$ratioW = $width / $pow4width;
-
-			if ($ratioH < $ratioW) {
-				$width = $pow4width;
-				$height /= $ratioW;
-			} else {
-				$height = $pow4height;
-				$width /= $ratioH;
-			}
-		}
-
-		/*
+            $pow4height = 4 ** ceil(log($height) / log(4));
+            $pow4width = 4 ** ceil(log($width) / log(4));
+
+            // Minimum size is 64
+            $pow4height = max($pow4height, 64);
+            $pow4width = max($pow4width, 64);
+
+            $ratioH = $height / $pow4height;
+            $ratioW = $width / $pow4width;
+
+            if ($ratioH < $ratioW) {
+                $width = $pow4width;
+                $height /= $ratioW;
+            } else {
+                $height = $pow4height;
+                $width /= $ratioH;
+            }
+        }
+
+        /*
 		 * Make sure the requested height and width fall within the max
 		 * of the preview.
 		 */
-		if ($height > $maxHeight) {
-			$ratio = $height / $maxHeight;
-			$height = $maxHeight;
-			$width /= $ratio;
-		}
-		if ($width > $maxWidth) {
-			$ratio = $width / $maxWidth;
-			$width = $maxWidth;
-			$height /= $ratio;
-		}
-
-		return [(int)round($width), (int)round($height)];
-	}
-
-	/**
-	 * @param ISimpleFolder $previewFolder
-	 * @param ISimpleFile $maxPreview
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param int $maxWidth
-	 * @param int $maxHeight
-	 * @param string $prefix
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 */
-	private function generatePreview(ISimpleFolder $previewFolder, IImage $maxPreview, $width, $height, $crop, $maxWidth, $maxHeight, $prefix) {
-		$preview = $maxPreview;
-		if (!$preview->valid()) {
-			throw new \InvalidArgumentException('Failed to generate preview, failed to load image');
-		}
-
-		$previewConcurrency = $this->getNumConcurrentPreviews('preview_concurrency_new');
-		$sem = self::guardWithSemaphore(self::SEMAPHORE_ID_NEW, $previewConcurrency);
-		try {
-			if ($crop) {
-				if ($height !== $preview->height() && $width !== $preview->width()) {
-					//Resize
-					$widthR = $preview->width() / $width;
-					$heightR = $preview->height() / $height;
-
-					if ($widthR > $heightR) {
-						$scaleH = $height;
-						$scaleW = $maxWidth / $heightR;
-					} else {
-						$scaleH = $maxHeight / $widthR;
-						$scaleW = $width;
-					}
-					$preview = $preview->preciseResizeCopy((int)round($scaleW), (int)round($scaleH));
-				}
-				$cropX = (int)floor(abs($width - $preview->width()) * 0.5);
-				$cropY = (int)floor(abs($height - $preview->height()) * 0.5);
-				$preview = $preview->cropCopy($cropX, $cropY, $width, $height);
-			} else {
-				$preview = $maxPreview->resizeCopy(max($width, $height));
-			}
-		} finally {
-			self::unguardWithSemaphore($sem);
-		}
-
-
-		$path = $this->generatePath($width, $height, $crop, false, $preview->dataMimeType(), $prefix);
-		try {
-			$file = $previewFolder->newFile($path);
-			$file->putContent($preview->data());
-		} catch (NotPermittedException $e) {
-			throw new NotFoundException();
-		}
-
-		return $file;
-	}
-
-	/**
-	 * @param ISimpleFile[] $files Array of FileInfo, as the result of getDirectoryListing()
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param string $mimeType
-	 * @param string $prefix
-	 * @return ISimpleFile
-	 *
-	 * @throws NotFoundException
-	 */
-	private function getCachedPreview($files, $width, $height, $crop, $mimeType, $prefix) {
-		$path = $this->generatePath($width, $height, $crop, false, $mimeType, $prefix);
-		foreach ($files as $file) {
-			if ($file->getName() === $path) {
-				return $file;
-			}
-		}
-		throw new NotFoundException();
-	}
-
-	/**
-	 * Get the specific preview folder for this file
-	 *
-	 * @param File $file
-	 * @return ISimpleFolder
-	 *
-	 * @throws InvalidPathException
-	 * @throws NotFoundException
-	 * @throws NotPermittedException
-	 */
-	private function getPreviewFolder(File $file) {
-		// Obtain file id outside of try catch block to prevent the creation of an existing folder
-		$fileId = (string)$file->getId();
-
-		try {
-			$folder = $this->appData->getFolder($fileId);
-		} catch (NotFoundException $e) {
-			$folder = $this->appData->newFolder($fileId);
-		}
-
-		return $folder;
-	}
-
-	/**
-	 * @param string $mimeType
-	 * @return null|string
-	 * @throws \InvalidArgumentException
-	 */
-	private function getExtension($mimeType) {
-		switch ($mimeType) {
-			case 'image/png':
-				return 'png';
-			case 'image/jpeg':
-				return 'jpg';
-			case 'image/gif':
-				return 'gif';
-			default:
-				throw new \InvalidArgumentException('Not a valid mimetype: "' . $mimeType . '"');
-		}
-	}
+        if ($height > $maxHeight) {
+            $ratio = $height / $maxHeight;
+            $height = $maxHeight;
+            $width /= $ratio;
+        }
+        if ($width > $maxWidth) {
+            $ratio = $width / $maxWidth;
+            $width = $maxWidth;
+            $height /= $ratio;
+        }
+
+        return [(int)round($width), (int)round($height)];
+    }
+
+    /**
+     * @param ISimpleFolder $previewFolder
+     * @param ISimpleFile $maxPreview
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param int $maxWidth
+     * @param int $maxHeight
+     * @param string $prefix
+     * @return ISimpleFile
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     */
+    private function generatePreview(ISimpleFolder $previewFolder, IImage $maxPreview, $width, $height, $crop, $maxWidth, $maxHeight, $prefix) {
+        $preview = $maxPreview;
+        if (!$preview->valid()) {
+            throw new \InvalidArgumentException('Failed to generate preview, failed to load image');
+        }
+
+        $previewConcurrency = $this->getNumConcurrentPreviews('preview_concurrency_new');
+        $sem = self::guardWithSemaphore(self::SEMAPHORE_ID_NEW, $previewConcurrency);
+        try {
+            if ($crop) {
+                if ($height !== $preview->height() && $width !== $preview->width()) {
+                    //Resize
+                    $widthR = $preview->width() / $width;
+                    $heightR = $preview->height() / $height;
+
+                    if ($widthR > $heightR) {
+                        $scaleH = $height;
+                        $scaleW = $maxWidth / $heightR;
+                    } else {
+                        $scaleH = $maxHeight / $widthR;
+                        $scaleW = $width;
+                    }
+                    $preview = $preview->preciseResizeCopy((int)round($scaleW), (int)round($scaleH));
+                }
+                $cropX = (int)floor(abs($width - $preview->width()) * 0.5);
+                $cropY = (int)floor(abs($height - $preview->height()) * 0.5);
+                $preview = $preview->cropCopy($cropX, $cropY, $width, $height);
+            } else {
+                $preview = $maxPreview->resizeCopy(max($width, $height));
+            }
+        } finally {
+            self::unguardWithSemaphore($sem);
+        }
+
+
+        $path = $this->generatePath($width, $height, $crop, false, $preview->dataMimeType(), $prefix);
+        try {
+            $file = $previewFolder->newFile($path);
+            $file->putContent($preview->data());
+        } catch (NotPermittedException $e) {
+            throw new NotFoundException();
+        }
+
+        return $file;
+    }
+
+    /**
+     * @param ISimpleFile[] $files Array of FileInfo, as the result of getDirectoryListing()
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param string $mimeType
+     * @param string $prefix
+     * @return ISimpleFile
+     *
+     * @throws NotFoundException
+     */
+    private function getCachedPreview($files, $width, $height, $crop, $mimeType, $prefix) {
+        $path = $this->generatePath($width, $height, $crop, false, $mimeType, $prefix);
+        foreach ($files as $file) {
+            if ($file->getName() === $path) {
+                return $file;
+            }
+        }
+        throw new NotFoundException();
+    }
+
+    /**
+     * Get the specific preview folder for this file
+     *
+     * @param File $file
+     * @return ISimpleFolder
+     *
+     * @throws InvalidPathException
+     * @throws NotFoundException
+     * @throws NotPermittedException
+     */
+    private function getPreviewFolder(File $file) {
+        // Obtain file id outside of try catch block to prevent the creation of an existing folder
+        $fileId = (string)$file->getId();
+
+        try {
+            $folder = $this->appData->getFolder($fileId);
+        } catch (NotFoundException $e) {
+            $folder = $this->appData->newFolder($fileId);
+        }
+
+        return $folder;
+    }
+
+    /**
+     * @param string $mimeType
+     * @return null|string
+     * @throws \InvalidArgumentException
+     */
+    private function getExtension($mimeType) {
+        switch ($mimeType) {
+            case 'image/png':
+                return 'png';
+            case 'image/jpeg':
+                return 'jpg';
+            case 'image/gif':
+                return 'gif';
+            default:
+                throw new \InvalidArgumentException('Not a valid mimetype: "' . $mimeType . '"');
+        }
+    }
 }

lib/private/App/DependencyAnalyzer.php

Indentation +367 added lines, -367 removed lines

@@ -33,371 +33,371 @@
 use OCP\IL10N;
 
 class DependencyAnalyzer {
-	/** @var Platform */
-	private $platform;
-	/** @var \OCP\IL10N */
-	private $l;
-	/** @var array */
-	private $appInfo;
-
-	/**
-	 * @param Platform $platform
-	 * @param \OCP\IL10N $l
-	 */
-	public function __construct(Platform $platform, IL10N $l) {
-		$this->platform = $platform;
-		$this->l = $l;
-	}
-
-	/**
-	 * @param array $app
-	 * @returns array of missing dependencies
-	 */
-	public function analyze(array $app, bool $ignoreMax = false) {
-		$this->appInfo = $app;
-		if (isset($app['dependencies'])) {
-			$dependencies = $app['dependencies'];
-		} else {
-			$dependencies = [];
-		}
-
-		return array_merge(
-			$this->analyzeArchitecture($dependencies),
-			$this->analyzePhpVersion($dependencies),
-			$this->analyzeDatabases($dependencies),
-			$this->analyzeCommands($dependencies),
-			$this->analyzeLibraries($dependencies),
-			$this->analyzeOS($dependencies),
-			$this->analyzeOC($dependencies, $app, $ignoreMax)
-		);
-	}
-
-	public function isMarkedCompatible(array $app): bool {
-		if (isset($app['dependencies'])) {
-			$dependencies = $app['dependencies'];
-		} else {
-			$dependencies = [];
-		}
-
-		$maxVersion = $this->getMaxVersion($dependencies, $app);
-		if ($maxVersion === null) {
-			return true;
-		}
-		return !$this->compareBigger($this->platform->getOcVersion(), $maxVersion);
-	}
-
-	/**
-	 * Truncates both versions to the lowest common version, e.g.
-	 * 5.1.2.3 and 5.1 will be turned into 5.1 and 5.1,
-	 * 5.2.6.5 and 5.1 will be turned into 5.2 and 5.1
-	 * @param string $first
-	 * @param string $second
-	 * @return string[] first element is the first version, second element is the
-	 * second version
-	 */
-	private function normalizeVersions($first, $second) {
-		$first = explode('.', $first);
-		$second = explode('.', $second);
-
-		// get both arrays to the same minimum size
-		$length = min(count($second), count($first));
-		$first = array_slice($first, 0, $length);
-		$second = array_slice($second, 0, $length);
-
-		return [implode('.', $first), implode('.', $second)];
-	}
-
-	/**
-	 * Parameters will be normalized and then passed into version_compare
-	 * in the same order they are specified in the method header
-	 * @param string $first
-	 * @param string $second
-	 * @param string $operator
-	 * @return bool result similar to version_compare
-	 */
-	private function compare($first, $second, $operator) {
-		// we can't normalize versions if one of the given parameters is not a
-		// version string but null. In case one parameter is null normalization
-		// will therefore be skipped
-		if ($first !== null && $second !== null) {
-			[$first, $second] = $this->normalizeVersions($first, $second);
-		}
-
-		return version_compare($first, $second, $operator);
-	}
-
-	/**
-	 * Checks if a version is bigger than another version
-	 * @param string $first
-	 * @param string $second
-	 * @return bool true if the first version is bigger than the second
-	 */
-	private function compareBigger($first, $second) {
-		return $this->compare($first, $second, '>');
-	}
-
-	/**
-	 * Checks if a version is smaller than another version
-	 * @param string $first
-	 * @param string $second
-	 * @return bool true if the first version is smaller than the second
-	 */
-	private function compareSmaller($first, $second) {
-		return $this->compare($first, $second, '<');
-	}
-
-	/**
-	 * @param array $dependencies
-	 * @return array
-	 */
-	private function analyzePhpVersion(array $dependencies) {
-		$missing = [];
-		if (isset($dependencies['php']['@attributes']['min-version'])) {
-			$minVersion = $dependencies['php']['@attributes']['min-version'];
-			if ($this->compareSmaller($this->platform->getPhpVersion(), $minVersion)) {
-				$missing[] = $this->l->t('PHP %s or higher is required.', [$minVersion]);
-			}
-		}
-		if (isset($dependencies['php']['@attributes']['max-version'])) {
-			$maxVersion = $dependencies['php']['@attributes']['max-version'];
-			if ($this->compareBigger($this->platform->getPhpVersion(), $maxVersion)) {
-				$missing[] = $this->l->t('PHP with a version lower than %s is required.', [$maxVersion]);
-			}
-		}
-		if (isset($dependencies['php']['@attributes']['min-int-size'])) {
-			$intSize = $dependencies['php']['@attributes']['min-int-size'];
-			if ($intSize > $this->platform->getIntSize() * 8) {
-				$missing[] = $this->l->t('%sbit or higher PHP required.', [$intSize]);
-			}
-		}
-		return $missing;
-	}
-
-	private function analyzeArchitecture(array $dependencies) {
-		$missing = [];
-		if (!isset($dependencies['architecture'])) {
-			return $missing;
-		}
-
-		$supportedArchitectures = $dependencies['architecture'];
-		if (empty($supportedArchitectures)) {
-			return $missing;
-		}
-		if (!is_array($supportedArchitectures)) {
-			$supportedArchitectures = [$supportedArchitectures];
-		}
-		$supportedArchitectures = array_map(function ($architecture) {
-			return $this->getValue($architecture);
-		}, $supportedArchitectures);
-		$currentArchitecture = $this->platform->getArchitecture();
-		if (!in_array($currentArchitecture, $supportedArchitectures, true)) {
-			$missing[] = $this->l->t('The following architectures are supported: %s', [implode(', ', $supportedArchitectures)]);
-		}
-		return $missing;
-	}
-
-	/**
-	 * @param array $dependencies
-	 * @return array
-	 */
-	private function analyzeDatabases(array $dependencies) {
-		$missing = [];
-		if (!isset($dependencies['database'])) {
-			return $missing;
-		}
-
-		$supportedDatabases = $dependencies['database'];
-		if (empty($supportedDatabases)) {
-			return $missing;
-		}
-		if (!is_array($supportedDatabases)) {
-			$supportedDatabases = [$supportedDatabases];
-		}
-		$supportedDatabases = array_map(function ($db) {
-			return $this->getValue($db);
-		}, $supportedDatabases);
-		$currentDatabase = $this->platform->getDatabase();
-		if (!in_array($currentDatabase, $supportedDatabases)) {
-			$missing[] = $this->l->t('The following databases are supported: %s', [implode(', ', $supportedDatabases)]);
-		}
-		return $missing;
-	}
-
-	/**
-	 * @param array $dependencies
-	 * @return array
-	 */
-	private function analyzeCommands(array $dependencies) {
-		$missing = [];
-		if (!isset($dependencies['command'])) {
-			return $missing;
-		}
-
-		$commands = $dependencies['command'];
-		if (!is_array($commands)) {
-			$commands = [$commands];
-		}
-		if (isset($commands['@value'])) {
-			$commands = [$commands];
-		}
-		$os = $this->platform->getOS();
-		foreach ($commands as $command) {
-			if (isset($command['@attributes']['os']) && $command['@attributes']['os'] !== $os) {
-				continue;
-			}
-			$commandName = $this->getValue($command);
-			if (!$this->platform->isCommandKnown($commandName)) {
-				$missing[] = $this->l->t('The command line tool %s could not be found', [$commandName]);
-			}
-		}
-		return $missing;
-	}
-
-	/**
-	 * @param array $dependencies
-	 * @return array
-	 */
-	private function analyzeLibraries(array $dependencies) {
-		$missing = [];
-		if (!isset($dependencies['lib'])) {
-			return $missing;
-		}
-
-		$libs = $dependencies['lib'];
-		if (!is_array($libs)) {
-			$libs = [$libs];
-		}
-		if (isset($libs['@value'])) {
-			$libs = [$libs];
-		}
-		foreach ($libs as $lib) {
-			$libName = $this->getValue($lib);
-			$libVersion = $this->platform->getLibraryVersion($libName);
-			if (is_null($libVersion)) {
-				$missing[] = $this->l->t('The library %s is not available.', [$libName]);
-				continue;
-			}
-
-			if (is_array($lib)) {
-				if (isset($lib['@attributes']['min-version'])) {
-					$minVersion = $lib['@attributes']['min-version'];
-					if ($this->compareSmaller($libVersion, $minVersion)) {
-						$missing[] = $this->l->t('Library %1$s with a version higher than %2$s is required - available version %3$s.',
-							[$libName, $minVersion, $libVersion]);
-					}
-				}
-				if (isset($lib['@attributes']['max-version'])) {
-					$maxVersion = $lib['@attributes']['max-version'];
-					if ($this->compareBigger($libVersion, $maxVersion)) {
-						$missing[] = $this->l->t('Library %1$s with a version lower than %2$s is required - available version %3$s.',
-							[$libName, $maxVersion, $libVersion]);
-					}
-				}
-			}
-		}
-		return $missing;
-	}
-
-	/**
-	 * @param array $dependencies
-	 * @return array
-	 */
-	private function analyzeOS(array $dependencies) {
-		$missing = [];
-		if (!isset($dependencies['os'])) {
-			return $missing;
-		}
-
-		$oss = $dependencies['os'];
-		if (empty($oss)) {
-			return $missing;
-		}
-		if (is_array($oss)) {
-			$oss = array_map(function ($os) {
-				return $this->getValue($os);
-			}, $oss);
-		} else {
-			$oss = [$oss];
-		}
-		$currentOS = $this->platform->getOS();
-		if (!in_array($currentOS, $oss)) {
-			$missing[] = $this->l->t('The following platforms are supported: %s', [implode(', ', $oss)]);
-		}
-		return $missing;
-	}
-
-	/**
-	 * @param array $dependencies
-	 * @param array $appInfo
-	 * @return array
-	 */
-	private function analyzeOC(array $dependencies, array $appInfo, bool $ignoreMax) {
-		$missing = [];
-		$minVersion = null;
-		if (isset($dependencies['nextcloud']['@attributes']['min-version'])) {
-			$minVersion = $dependencies['nextcloud']['@attributes']['min-version'];
-		} elseif (isset($dependencies['owncloud']['@attributes']['min-version'])) {
-			$minVersion = $dependencies['owncloud']['@attributes']['min-version'];
-		} elseif (isset($appInfo['requiremin'])) {
-			$minVersion = $appInfo['requiremin'];
-		} elseif (isset($appInfo['require'])) {
-			$minVersion = $appInfo['require'];
-		}
-		$maxVersion = $this->getMaxVersion($dependencies, $appInfo);
-
-		if (!is_null($minVersion)) {
-			if ($this->compareSmaller($this->platform->getOcVersion(), $minVersion)) {
-				$missing[] = $this->l->t('Server version %s or higher is required.', [$this->toVisibleVersion($minVersion)]);
-			}
-		}
-		if (!$ignoreMax && !is_null($maxVersion)) {
-			if ($this->compareBigger($this->platform->getOcVersion(), $maxVersion)) {
-				$missing[] = $this->l->t('Server version %s or lower is required.', [$this->toVisibleVersion($maxVersion)]);
-			}
-		}
-		return $missing;
-	}
-
-	private function getMaxVersion(array $dependencies, array $appInfo): ?string {
-		if (isset($dependencies['nextcloud']['@attributes']['max-version'])) {
-			return $dependencies['nextcloud']['@attributes']['max-version'];
-		}
-		if (isset($dependencies['owncloud']['@attributes']['max-version'])) {
-			return $dependencies['owncloud']['@attributes']['max-version'];
-		}
-		if (isset($appInfo['requiremax'])) {
-			return $appInfo['requiremax'];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Map the internal version number to the Nextcloud version
-	 *
-	 * @param string $version
-	 * @return string
-	 */
-	protected function toVisibleVersion($version) {
-		switch ($version) {
-			case '9.1':
-				return '10';
-			default:
-				if (str_starts_with($version, '9.1.')) {
-					$version = '10.0.' . substr($version, 4);
-				}
-				return $version;
-		}
-	}
-
-	/**
-	 * @param $element
-	 * @return mixed
-	 */
-	private function getValue($element) {
-		if (isset($element['@value'])) {
-			return $element['@value'];
-		}
-		return (string)$element;
-	}
+    /** @var Platform */
+    private $platform;
+    /** @var \OCP\IL10N */
+    private $l;
+    /** @var array */
+    private $appInfo;
+
+    /**
+     * @param Platform $platform
+     * @param \OCP\IL10N $l
+     */
+    public function __construct(Platform $platform, IL10N $l) {
+        $this->platform = $platform;
+        $this->l = $l;
+    }
+
+    /**
+     * @param array $app
+     * @returns array of missing dependencies
+     */
+    public function analyze(array $app, bool $ignoreMax = false) {
+        $this->appInfo = $app;
+        if (isset($app['dependencies'])) {
+            $dependencies = $app['dependencies'];
+        } else {
+            $dependencies = [];
+        }
+
+        return array_merge(
+            $this->analyzeArchitecture($dependencies),
+            $this->analyzePhpVersion($dependencies),
+            $this->analyzeDatabases($dependencies),
+            $this->analyzeCommands($dependencies),
+            $this->analyzeLibraries($dependencies),
+            $this->analyzeOS($dependencies),
+            $this->analyzeOC($dependencies, $app, $ignoreMax)
+        );
+    }
+
+    public function isMarkedCompatible(array $app): bool {
+        if (isset($app['dependencies'])) {
+            $dependencies = $app['dependencies'];
+        } else {
+            $dependencies = [];
+        }
+
+        $maxVersion = $this->getMaxVersion($dependencies, $app);
+        if ($maxVersion === null) {
+            return true;
+        }
+        return !$this->compareBigger($this->platform->getOcVersion(), $maxVersion);
+    }
+
+    /**
+     * Truncates both versions to the lowest common version, e.g.
+     * 5.1.2.3 and 5.1 will be turned into 5.1 and 5.1,
+     * 5.2.6.5 and 5.1 will be turned into 5.2 and 5.1
+     * @param string $first
+     * @param string $second
+     * @return string[] first element is the first version, second element is the
+     * second version
+     */
+    private function normalizeVersions($first, $second) {
+        $first = explode('.', $first);
+        $second = explode('.', $second);
+
+        // get both arrays to the same minimum size
+        $length = min(count($second), count($first));
+        $first = array_slice($first, 0, $length);
+        $second = array_slice($second, 0, $length);
+
+        return [implode('.', $first), implode('.', $second)];
+    }
+
+    /**
+     * Parameters will be normalized and then passed into version_compare
+     * in the same order they are specified in the method header
+     * @param string $first
+     * @param string $second
+     * @param string $operator
+     * @return bool result similar to version_compare
+     */
+    private function compare($first, $second, $operator) {
+        // we can't normalize versions if one of the given parameters is not a
+        // version string but null. In case one parameter is null normalization
+        // will therefore be skipped
+        if ($first !== null && $second !== null) {
+            [$first, $second] = $this->normalizeVersions($first, $second);
+        }
+
+        return version_compare($first, $second, $operator);
+    }
+
+    /**
+     * Checks if a version is bigger than another version
+     * @param string $first
+     * @param string $second
+     * @return bool true if the first version is bigger than the second
+     */
+    private function compareBigger($first, $second) {
+        return $this->compare($first, $second, '>');
+    }
+
+    /**
+     * Checks if a version is smaller than another version
+     * @param string $first
+     * @param string $second
+     * @return bool true if the first version is smaller than the second
+     */
+    private function compareSmaller($first, $second) {
+        return $this->compare($first, $second, '<');
+    }
+
+    /**
+     * @param array $dependencies
+     * @return array
+     */
+    private function analyzePhpVersion(array $dependencies) {
+        $missing = [];
+        if (isset($dependencies['php']['@attributes']['min-version'])) {
+            $minVersion = $dependencies['php']['@attributes']['min-version'];
+            if ($this->compareSmaller($this->platform->getPhpVersion(), $minVersion)) {
+                $missing[] = $this->l->t('PHP %s or higher is required.', [$minVersion]);
+            }
+        }
+        if (isset($dependencies['php']['@attributes']['max-version'])) {
+            $maxVersion = $dependencies['php']['@attributes']['max-version'];
+            if ($this->compareBigger($this->platform->getPhpVersion(), $maxVersion)) {
+                $missing[] = $this->l->t('PHP with a version lower than %s is required.', [$maxVersion]);
+            }
+        }
+        if (isset($dependencies['php']['@attributes']['min-int-size'])) {
+            $intSize = $dependencies['php']['@attributes']['min-int-size'];
+            if ($intSize > $this->platform->getIntSize() * 8) {
+                $missing[] = $this->l->t('%sbit or higher PHP required.', [$intSize]);
+            }
+        }
+        return $missing;
+    }
+
+    private function analyzeArchitecture(array $dependencies) {
+        $missing = [];
+        if (!isset($dependencies['architecture'])) {
+            return $missing;
+        }
+
+        $supportedArchitectures = $dependencies['architecture'];
+        if (empty($supportedArchitectures)) {
+            return $missing;
+        }
+        if (!is_array($supportedArchitectures)) {
+            $supportedArchitectures = [$supportedArchitectures];
+        }
+        $supportedArchitectures = array_map(function ($architecture) {
+            return $this->getValue($architecture);
+        }, $supportedArchitectures);
+        $currentArchitecture = $this->platform->getArchitecture();
+        if (!in_array($currentArchitecture, $supportedArchitectures, true)) {
+            $missing[] = $this->l->t('The following architectures are supported: %s', [implode(', ', $supportedArchitectures)]);
+        }
+        return $missing;
+    }
+
+    /**
+     * @param array $dependencies
+     * @return array
+     */
+    private function analyzeDatabases(array $dependencies) {
+        $missing = [];
+        if (!isset($dependencies['database'])) {
+            return $missing;
+        }
+
+        $supportedDatabases = $dependencies['database'];
+        if (empty($supportedDatabases)) {
+            return $missing;
+        }
+        if (!is_array($supportedDatabases)) {
+            $supportedDatabases = [$supportedDatabases];
+        }
+        $supportedDatabases = array_map(function ($db) {
+            return $this->getValue($db);
+        }, $supportedDatabases);
+        $currentDatabase = $this->platform->getDatabase();
+        if (!in_array($currentDatabase, $supportedDatabases)) {
+            $missing[] = $this->l->t('The following databases are supported: %s', [implode(', ', $supportedDatabases)]);
+        }
+        return $missing;
+    }
+
+    /**
+     * @param array $dependencies
+     * @return array
+     */
+    private function analyzeCommands(array $dependencies) {
+        $missing = [];
+        if (!isset($dependencies['command'])) {
+            return $missing;
+        }
+
+        $commands = $dependencies['command'];
+        if (!is_array($commands)) {
+            $commands = [$commands];
+        }
+        if (isset($commands['@value'])) {
+            $commands = [$commands];
+        }
+        $os = $this->platform->getOS();
+        foreach ($commands as $command) {
+            if (isset($command['@attributes']['os']) && $command['@attributes']['os'] !== $os) {
+                continue;
+            }
+            $commandName = $this->getValue($command);
+            if (!$this->platform->isCommandKnown($commandName)) {
+                $missing[] = $this->l->t('The command line tool %s could not be found', [$commandName]);
+            }
+        }
+        return $missing;
+    }
+
+    /**
+     * @param array $dependencies
+     * @return array
+     */
+    private function analyzeLibraries(array $dependencies) {
+        $missing = [];
+        if (!isset($dependencies['lib'])) {
+            return $missing;
+        }
+
+        $libs = $dependencies['lib'];
+        if (!is_array($libs)) {
+            $libs = [$libs];
+        }
+        if (isset($libs['@value'])) {
+            $libs = [$libs];
+        }
+        foreach ($libs as $lib) {
+            $libName = $this->getValue($lib);
+            $libVersion = $this->platform->getLibraryVersion($libName);
+            if (is_null($libVersion)) {
+                $missing[] = $this->l->t('The library %s is not available.', [$libName]);
+                continue;
+            }
+
+            if (is_array($lib)) {
+                if (isset($lib['@attributes']['min-version'])) {
+                    $minVersion = $lib['@attributes']['min-version'];
+                    if ($this->compareSmaller($libVersion, $minVersion)) {
+                        $missing[] = $this->l->t('Library %1$s with a version higher than %2$s is required - available version %3$s.',
+                            [$libName, $minVersion, $libVersion]);
+                    }
+                }
+                if (isset($lib['@attributes']['max-version'])) {
+                    $maxVersion = $lib['@attributes']['max-version'];
+                    if ($this->compareBigger($libVersion, $maxVersion)) {
+                        $missing[] = $this->l->t('Library %1$s with a version lower than %2$s is required - available version %3$s.',
+                            [$libName, $maxVersion, $libVersion]);
+                    }
+                }
+            }
+        }
+        return $missing;
+    }
+
+    /**
+     * @param array $dependencies
+     * @return array
+     */
+    private function analyzeOS(array $dependencies) {
+        $missing = [];
+        if (!isset($dependencies['os'])) {
+            return $missing;
+        }
+
+        $oss = $dependencies['os'];
+        if (empty($oss)) {
+            return $missing;
+        }
+        if (is_array($oss)) {
+            $oss = array_map(function ($os) {
+                return $this->getValue($os);
+            }, $oss);
+        } else {
+            $oss = [$oss];
+        }
+        $currentOS = $this->platform->getOS();
+        if (!in_array($currentOS, $oss)) {
+            $missing[] = $this->l->t('The following platforms are supported: %s', [implode(', ', $oss)]);
+        }
+        return $missing;
+    }
+
+    /**
+     * @param array $dependencies
+     * @param array $appInfo
+     * @return array
+     */
+    private function analyzeOC(array $dependencies, array $appInfo, bool $ignoreMax) {
+        $missing = [];
+        $minVersion = null;
+        if (isset($dependencies['nextcloud']['@attributes']['min-version'])) {
+            $minVersion = $dependencies['nextcloud']['@attributes']['min-version'];
+        } elseif (isset($dependencies['owncloud']['@attributes']['min-version'])) {
+            $minVersion = $dependencies['owncloud']['@attributes']['min-version'];
+        } elseif (isset($appInfo['requiremin'])) {
+            $minVersion = $appInfo['requiremin'];
+        } elseif (isset($appInfo['require'])) {
+            $minVersion = $appInfo['require'];
+        }
+        $maxVersion = $this->getMaxVersion($dependencies, $appInfo);
+
+        if (!is_null($minVersion)) {
+            if ($this->compareSmaller($this->platform->getOcVersion(), $minVersion)) {
+                $missing[] = $this->l->t('Server version %s or higher is required.', [$this->toVisibleVersion($minVersion)]);
+            }
+        }
+        if (!$ignoreMax && !is_null($maxVersion)) {
+            if ($this->compareBigger($this->platform->getOcVersion(), $maxVersion)) {
+                $missing[] = $this->l->t('Server version %s or lower is required.', [$this->toVisibleVersion($maxVersion)]);
+            }
+        }
+        return $missing;
+    }
+
+    private function getMaxVersion(array $dependencies, array $appInfo): ?string {
+        if (isset($dependencies['nextcloud']['@attributes']['max-version'])) {
+            return $dependencies['nextcloud']['@attributes']['max-version'];
+        }
+        if (isset($dependencies['owncloud']['@attributes']['max-version'])) {
+            return $dependencies['owncloud']['@attributes']['max-version'];
+        }
+        if (isset($appInfo['requiremax'])) {
+            return $appInfo['requiremax'];
+        }
+
+        return null;
+    }
+
+    /**
+     * Map the internal version number to the Nextcloud version
+     *
+     * @param string $version
+     * @return string
+     */
+    protected function toVisibleVersion($version) {
+        switch ($version) {
+            case '9.1':
+                return '10';
+            default:
+                if (str_starts_with($version, '9.1.')) {
+                    $version = '10.0.' . substr($version, 4);
+                }
+                return $version;
+        }
+    }
+
+    /**
+     * @param $element
+     * @return mixed
+     */
+    private function getValue($element) {
+        if (isset($element['@value'])) {
+            return $element['@value'];
+        }
+        return (string)$element;
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -186,7 +186,7 @@ 
 		if (!is_array($supportedArchitectures)) {
 			$supportedArchitectures = [$supportedArchitectures];
 		}
-		$supportedArchitectures = array_map(function ($architecture) {
+		$supportedArchitectures = array_map(function($architecture) {
 			return $this->getValue($architecture);
 		}, $supportedArchitectures);
 		$currentArchitecture = $this->platform->getArchitecture();
@@ -213,7 +213,7 @@ 
 		if (!is_array($supportedDatabases)) {
 			$supportedDatabases = [$supportedDatabases];
 		}
-		$supportedDatabases = array_map(function ($db) {
+		$supportedDatabases = array_map(function($db) {
 			return $this->getValue($db);
 		}, $supportedDatabases);
 		$currentDatabase = $this->platform->getDatabase();
@@ -313,7 +313,7 @@ 
 			return $missing;
 		}
 		if (is_array($oss)) {
-			$oss = array_map(function ($os) {
+			$oss = array_map(function($os) {
 				return $this->getValue($os);
 			}, $oss);
 		} else {
@@ -384,7 +384,7 @@ 
 				return '10';
 			default:
 				if (str_starts_with($version, '9.1.')) {
-					$version = '10.0.' . substr($version, 4);
+					$version = '10.0.'.substr($version, 4);
 				}
 				return $version;
 		}
@@ -398,6 +398,6 @@ 
 		if (isset($element['@value'])) {
 			return $element['@value'];
 		}
-		return (string)$element;
+		return (string) $element;
 	}
 }

lib/private/App/AppStore/Fetcher/AppFetcher.php

Indentation +157 added lines, -157 removed lines

@@ -39,161 +39,161 @@
 use Psr\Log\LoggerInterface;
 
 class AppFetcher extends Fetcher {
-	/** @var CompareVersion */
-	private $compareVersion;
-
-	/** @var IRegistry */
-	protected $registry;
-
-	/** @var bool */
-	private $ignoreMaxVersion;
-
-	public function __construct(Factory $appDataFactory,
-								IClientService $clientService,
-								ITimeFactory $timeFactory,
-								IConfig $config,
-								CompareVersion $compareVersion,
-								LoggerInterface $logger,
-								IRegistry $registry) {
-		parent::__construct(
-			$appDataFactory,
-			$clientService,
-			$timeFactory,
-			$config,
-			$logger,
-			$registry
-		);
-
-		$this->compareVersion = $compareVersion;
-		$this->registry = $registry;
-
-		$this->fileName = 'apps.json';
-		$this->endpointName = 'apps.json';
-		$this->ignoreMaxVersion = true;
-	}
-
-	/**
-	 * Only returns the latest compatible app release in the releases array
-	 *
-	 * @param string $ETag
-	 * @param string $content
-	 * @param bool [$allowUnstable] Allow unstable releases
-	 *
-	 * @return array
-	 */
-	protected function fetch($ETag, $content, $allowUnstable = false) {
-		/** @var mixed[] $response */
-		$response = parent::fetch($ETag, $content);
-
-		if (empty($response)) {
-			return [];
-		}
-
-		$allowPreReleases = $allowUnstable || $this->getChannel() === 'beta' || $this->getChannel() === 'daily' || $this->getChannel() === 'git';
-		$allowNightly = $allowUnstable || $this->getChannel() === 'daily' || $this->getChannel() === 'git';
-
-		foreach ($response['data'] as $dataKey => $app) {
-			$releases = [];
-
-			// Filter all compatible releases
-			foreach ($app['releases'] as $release) {
-				// Exclude all nightly and pre-releases if required
-				if (($allowNightly || $release['isNightly'] === false)
-					&& ($allowPreReleases || !str_contains($release['version'], '-'))) {
-					// Exclude all versions not compatible with the current version
-					try {
-						$versionParser = new VersionParser();
-						$serverVersion = $versionParser->getVersion($release['rawPlatformVersionSpec']);
-						$ncVersion = $this->getVersion();
-						$minServerVersion = $serverVersion->getMinimumVersion();
-						$maxServerVersion = $serverVersion->getMaximumVersion();
-						$minFulfilled = $this->compareVersion->isCompatible($ncVersion, $minServerVersion, '>=');
-						$maxFulfilled = $maxServerVersion !== '' &&
-							$this->compareVersion->isCompatible($ncVersion, $maxServerVersion, '<=');
-						$isPhpCompatible = true;
-						if (($release['rawPhpVersionSpec'] ?? '*') !== '*') {
-							$phpVersion = $versionParser->getVersion($release['rawPhpVersionSpec']);
-							$minPhpVersion = $phpVersion->getMinimumVersion();
-							$maxPhpVersion = $phpVersion->getMaximumVersion();
-							$minPhpFulfilled = $minPhpVersion === '' || $this->compareVersion->isCompatible(
-								PHP_VERSION,
-								$minPhpVersion,
-								'>='
-							);
-							$maxPhpFulfilled = $maxPhpVersion === '' || $this->compareVersion->isCompatible(
-								PHP_VERSION,
-								$maxPhpVersion,
-								'<='
-							);
-
-							$isPhpCompatible = $minPhpFulfilled && $maxPhpFulfilled;
-						}
-						if ($minFulfilled && ($this->ignoreMaxVersion || $maxFulfilled) && $isPhpCompatible) {
-							$releases[] = $release;
-						}
-					} catch (\InvalidArgumentException $e) {
-						$this->logger->warning($e->getMessage(), [
-							'exception' => $e,
-						]);
-					}
-				}
-			}
-
-			if (empty($releases)) {
-				// Remove apps that don't have a matching release
-				$response['data'][$dataKey] = [];
-				continue;
-			}
-
-			// Get the highest version
-			$versions = [];
-			foreach ($releases as $release) {
-				$versions[] = $release['version'];
-			}
-			usort($versions, function ($version1, $version2) {
-				return version_compare($version1, $version2);
-			});
-			$versions = array_reverse($versions);
-			if (isset($versions[0])) {
-				$highestVersion = $versions[0];
-				foreach ($releases as $release) {
-					if ((string)$release['version'] === (string)$highestVersion) {
-						$response['data'][$dataKey]['releases'] = [$release];
-						break;
-					}
-				}
-			}
-		}
-
-		$response['data'] = array_values(array_filter($response['data']));
-		return $response;
-	}
-
-	/**
-	 * @param string $version
-	 * @param string $fileName
-	 * @param bool $ignoreMaxVersion
-	 */
-	public function setVersion(string $version, string $fileName = 'apps.json', bool $ignoreMaxVersion = true) {
-		parent::setVersion($version);
-		$this->fileName = $fileName;
-		$this->ignoreMaxVersion = $ignoreMaxVersion;
-	}
-
-
-	public function get($allowUnstable = false) {
-		$allowPreReleases = $allowUnstable || $this->getChannel() === 'beta' || $this->getChannel() === 'daily' || $this->getChannel() === 'git';
-
-		$apps = parent::get($allowPreReleases);
-		$allowList = $this->config->getSystemValue('appsallowlist');
-
-		// If the admin specified a allow list, filter apps from the appstore
-		if (is_array($allowList) && $this->registry->delegateHasValidSubscription()) {
-			return array_filter($apps, function ($app) use ($allowList) {
-				return in_array($app['id'], $allowList);
-			});
-		}
-
-		return $apps;
-	}
+    /** @var CompareVersion */
+    private $compareVersion;
+
+    /** @var IRegistry */
+    protected $registry;
+
+    /** @var bool */
+    private $ignoreMaxVersion;
+
+    public function __construct(Factory $appDataFactory,
+                                IClientService $clientService,
+                                ITimeFactory $timeFactory,
+                                IConfig $config,
+                                CompareVersion $compareVersion,
+                                LoggerInterface $logger,
+                                IRegistry $registry) {
+        parent::__construct(
+            $appDataFactory,
+            $clientService,
+            $timeFactory,
+            $config,
+            $logger,
+            $registry
+        );
+
+        $this->compareVersion = $compareVersion;
+        $this->registry = $registry;
+
+        $this->fileName = 'apps.json';
+        $this->endpointName = 'apps.json';
+        $this->ignoreMaxVersion = true;
+    }
+
+    /**
+     * Only returns the latest compatible app release in the releases array
+     *
+     * @param string $ETag
+     * @param string $content
+     * @param bool [$allowUnstable] Allow unstable releases
+     *
+     * @return array
+     */
+    protected function fetch($ETag, $content, $allowUnstable = false) {
+        /** @var mixed[] $response */
+        $response = parent::fetch($ETag, $content);
+
+        if (empty($response)) {
+            return [];
+        }
+
+        $allowPreReleases = $allowUnstable || $this->getChannel() === 'beta' || $this->getChannel() === 'daily' || $this->getChannel() === 'git';
+        $allowNightly = $allowUnstable || $this->getChannel() === 'daily' || $this->getChannel() === 'git';
+
+        foreach ($response['data'] as $dataKey => $app) {
+            $releases = [];
+
+            // Filter all compatible releases
+            foreach ($app['releases'] as $release) {
+                // Exclude all nightly and pre-releases if required
+                if (($allowNightly || $release['isNightly'] === false)
+                    && ($allowPreReleases || !str_contains($release['version'], '-'))) {
+                    // Exclude all versions not compatible with the current version
+                    try {
+                        $versionParser = new VersionParser();
+                        $serverVersion = $versionParser->getVersion($release['rawPlatformVersionSpec']);
+                        $ncVersion = $this->getVersion();
+                        $minServerVersion = $serverVersion->getMinimumVersion();
+                        $maxServerVersion = $serverVersion->getMaximumVersion();
+                        $minFulfilled = $this->compareVersion->isCompatible($ncVersion, $minServerVersion, '>=');
+                        $maxFulfilled = $maxServerVersion !== '' &&
+                            $this->compareVersion->isCompatible($ncVersion, $maxServerVersion, '<=');
+                        $isPhpCompatible = true;
+                        if (($release['rawPhpVersionSpec'] ?? '*') !== '*') {
+                            $phpVersion = $versionParser->getVersion($release['rawPhpVersionSpec']);
+                            $minPhpVersion = $phpVersion->getMinimumVersion();
+                            $maxPhpVersion = $phpVersion->getMaximumVersion();
+                            $minPhpFulfilled = $minPhpVersion === '' || $this->compareVersion->isCompatible(
+                                PHP_VERSION,
+                                $minPhpVersion,
+                                '>='
+                            );
+                            $maxPhpFulfilled = $maxPhpVersion === '' || $this->compareVersion->isCompatible(
+                                PHP_VERSION,
+                                $maxPhpVersion,
+                                '<='
+                            );
+
+                            $isPhpCompatible = $minPhpFulfilled && $maxPhpFulfilled;
+                        }
+                        if ($minFulfilled && ($this->ignoreMaxVersion || $maxFulfilled) && $isPhpCompatible) {
+                            $releases[] = $release;
+                        }
+                    } catch (\InvalidArgumentException $e) {
+                        $this->logger->warning($e->getMessage(), [
+                            'exception' => $e,
+                        ]);
+                    }
+                }
+            }
+
+            if (empty($releases)) {
+                // Remove apps that don't have a matching release
+                $response['data'][$dataKey] = [];
+                continue;
+            }
+
+            // Get the highest version
+            $versions = [];
+            foreach ($releases as $release) {
+                $versions[] = $release['version'];
+            }
+            usort($versions, function ($version1, $version2) {
+                return version_compare($version1, $version2);
+            });
+            $versions = array_reverse($versions);
+            if (isset($versions[0])) {
+                $highestVersion = $versions[0];
+                foreach ($releases as $release) {
+                    if ((string)$release['version'] === (string)$highestVersion) {
+                        $response['data'][$dataKey]['releases'] = [$release];
+                        break;
+                    }
+                }
+            }
+        }
+
+        $response['data'] = array_values(array_filter($response['data']));
+        return $response;
+    }
+
+    /**
+     * @param string $version
+     * @param string $fileName
+     * @param bool $ignoreMaxVersion
+     */
+    public function setVersion(string $version, string $fileName = 'apps.json', bool $ignoreMaxVersion = true) {
+        parent::setVersion($version);
+        $this->fileName = $fileName;
+        $this->ignoreMaxVersion = $ignoreMaxVersion;
+    }
+
+
+    public function get($allowUnstable = false) {
+        $allowPreReleases = $allowUnstable || $this->getChannel() === 'beta' || $this->getChannel() === 'daily' || $this->getChannel() === 'git';
+
+        $apps = parent::get($allowPreReleases);
+        $allowList = $this->config->getSystemValue('appsallowlist');
+
+        // If the admin specified a allow list, filter apps from the appstore
+        if (is_array($allowList) && $this->registry->delegateHasValidSubscription()) {
+            return array_filter($apps, function ($app) use ($allowList) {
+                return in_array($app['id'], $allowList);
+            });
+        }
+
+        return $apps;
+    }
 }

lib/private/App/AppStore/Version/VersionParser.php

Indentation +48 added lines, -48 removed lines

@@ -30,56 +30,56 @@
  * @package OC\App\AppStore
  */
 class VersionParser {
-	/**
-	 * @param string $versionString
-	 * @return bool
-	 */
-	private function isValidVersionString($versionString) {
-		return (bool)preg_match('/^[0-9.]+$/', $versionString);
-	}
+    /**
+     * @param string $versionString
+     * @return bool
+     */
+    private function isValidVersionString($versionString) {
+        return (bool)preg_match('/^[0-9.]+$/', $versionString);
+    }
 
-	/**
-	 * Returns the version for a version string
-	 *
-	 * @param string $versionSpec
-	 * @return Version
-	 * @throws \Exception If the version cannot be parsed
-	 */
-	public function getVersion($versionSpec) {
-		// * indicates that the version is compatible with all versions
-		if ($versionSpec === '*') {
-			return new Version('', '');
-		}
+    /**
+     * Returns the version for a version string
+     *
+     * @param string $versionSpec
+     * @return Version
+     * @throws \Exception If the version cannot be parsed
+     */
+    public function getVersion($versionSpec) {
+        // * indicates that the version is compatible with all versions
+        if ($versionSpec === '*') {
+            return new Version('', '');
+        }
 
-		// Count the amount of =, if it is one then it's either maximum or minimum
-		// version. If it is two then it is maximum and minimum.
-		$versionElements = explode(' ', $versionSpec);
-		$firstVersion = isset($versionElements[0]) ? $versionElements[0] : '';
-		$firstVersionNumber = substr($firstVersion, 2);
-		$secondVersion = isset($versionElements[1]) ? $versionElements[1] : '';
-		$secondVersionNumber = substr($secondVersion, 2);
+        // Count the amount of =, if it is one then it's either maximum or minimum
+        // version. If it is two then it is maximum and minimum.
+        $versionElements = explode(' ', $versionSpec);
+        $firstVersion = isset($versionElements[0]) ? $versionElements[0] : '';
+        $firstVersionNumber = substr($firstVersion, 2);
+        $secondVersion = isset($versionElements[1]) ? $versionElements[1] : '';
+        $secondVersionNumber = substr($secondVersion, 2);
 
-		switch (count($versionElements)) {
-			case 1:
-				if (!$this->isValidVersionString($firstVersionNumber)) {
-					break;
-				}
-				if (str_starts_with($firstVersion, '>')) {
-					return new Version($firstVersionNumber, '');
-				}
-				return new Version('', $firstVersionNumber);
-			case 2:
-				if (!$this->isValidVersionString($firstVersionNumber) || !$this->isValidVersionString($secondVersionNumber)) {
-					break;
-				}
-				return new Version($firstVersionNumber, $secondVersionNumber);
-		}
+        switch (count($versionElements)) {
+            case 1:
+                if (!$this->isValidVersionString($firstVersionNumber)) {
+                    break;
+                }
+                if (str_starts_with($firstVersion, '>')) {
+                    return new Version($firstVersionNumber, '');
+                }
+                return new Version('', $firstVersionNumber);
+            case 2:
+                if (!$this->isValidVersionString($firstVersionNumber) || !$this->isValidVersionString($secondVersionNumber)) {
+                    break;
+                }
+                return new Version($firstVersionNumber, $secondVersionNumber);
+        }
 
-		throw new \Exception(
-			sprintf(
-				'Version cannot be parsed: %s',
-				$versionSpec
-			)
-		);
-	}
+        throw new \Exception(
+            sprintf(
+                'Version cannot be parsed: %s',
+                $versionSpec
+            )
+        );
+    }
 }

lib/private/L10N/Factory.php

Indentation +626 added lines, -626 removed lines

@@ -54,630 +54,630 @@
  * A factory that generates language instances
  */
 class Factory implements IFactory {
-	/** @var string */
-	protected $requestLanguage = '';
-
-	/**
-	 * cached instances
-	 * @var array Structure: Lang => App => \OCP\IL10N
-	 */
-	protected $instances = [];
-
-	/**
-	 * @var array Structure: App => string[]
-	 */
-	protected $availableLanguages = [];
-
-	/**
-	 * @var array
-	 */
-	protected $localeCache = [];
-
-	/**
-	 * @var array
-	 */
-	protected $availableLocales = [];
-
-	/**
-	 * @var array Structure: string => callable
-	 */
-	protected $pluralFunctions = [];
-
-	public const COMMON_LANGUAGE_CODES = [
-		'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
-		'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
-	];
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IRequest */
-	protected $request;
-
-	/** @var IUserSession */
-	protected IUserSession $userSession;
-
-	private ICache $cache;
-
-	/** @var string */
-	protected $serverRoot;
-
-	/**
-	 * @param IConfig $config
-	 * @param IRequest $request
-	 * @param IUserSession $userSession
-	 * @param string $serverRoot
-	 */
-	public function __construct(
-		IConfig $config,
-		IRequest $request,
-		IUserSession $userSession,
-		ICacheFactory $cacheFactory,
-		$serverRoot
-	) {
-		$this->config = $config;
-		$this->request = $request;
-		$this->userSession = $userSession;
-		$this->cache = $cacheFactory->createLocal('L10NFactory');
-		$this->serverRoot = $serverRoot;
-	}
-
-	/**
-	 * Get a language instance
-	 *
-	 * @param string $app
-	 * @param string|null $lang
-	 * @param string|null $locale
-	 * @return \OCP\IL10N
-	 */
-	public function get($app, $lang = null, $locale = null) {
-		return new LazyL10N(function () use ($app, $lang, $locale) {
-			$app = \OC_App::cleanAppId($app);
-			if ($lang !== null) {
-				$lang = str_replace(['\0', '/', '\\', '..'], '', $lang);
-			}
-
-			$forceLang = $this->config->getSystemValue('force_language', false);
-			if (is_string($forceLang)) {
-				$lang = $forceLang;
-			}
-
-			$forceLocale = $this->config->getSystemValue('force_locale', false);
-			if (is_string($forceLocale)) {
-				$locale = $forceLocale;
-			}
-
-			if ($lang === null || !$this->languageExists($app, $lang)) {
-				$lang = $this->findLanguage($app);
-			}
-
-			if ($locale === null || !$this->localeExists($locale)) {
-				$locale = $this->findLocale($lang);
-			}
-
-			if (!isset($this->instances[$lang][$app])) {
-				$this->instances[$lang][$app] = new L10N(
-					$this,
-					$app,
-					$lang,
-					$locale,
-					$this->getL10nFilesForApp($app, $lang)
-				);
-			}
-
-			return $this->instances[$lang][$app];
-		});
-	}
-
-	/**
-	 * Find the best language
-	 *
-	 * @param string|null $appId App id or null for core
-	 *
-	 * @return string language If nothing works it returns 'en'
-	 */
-	public function findLanguage(?string $appId = null): string {
-		// Step 1: Forced language always has precedence over anything else
-		$forceLang = $this->config->getSystemValue('force_language', false);
-		if (is_string($forceLang)) {
-			$this->requestLanguage = $forceLang;
-		}
-
-		// Step 2: Return cached language
-		if ($this->requestLanguage !== '' && $this->languageExists($appId, $this->requestLanguage)) {
-			return $this->requestLanguage;
-		}
-
-		/**
-		 * Step 3: At this point Nextcloud might not yet be installed and thus the lookup
-		 * in the preferences table might fail. For this reason we need to check
-		 * whether the instance has already been installed
-		 *
-		 * @link https://github.com/owncloud/core/issues/21955
-		 */
-		if ($this->config->getSystemValueBool('installed', false)) {
-			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
-			if (!is_null($userId)) {
-				$userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
-			} else {
-				$userLang = null;
-			}
-		} else {
-			$userId = null;
-			$userLang = null;
-		}
-		if ($userLang) {
-			$this->requestLanguage = $userLang;
-			if ($this->languageExists($appId, $userLang)) {
-				return $userLang;
-			}
-		}
-
-		// Step 4: Check the request headers
-		try {
-			// Try to get the language from the Request
-			$lang = $this->getLanguageFromRequest($appId);
-			if ($userId !== null && $appId === null && !$userLang) {
-				$this->config->setUserValue($userId, 'core', 'lang', $lang);
-			}
-			return $lang;
-		} catch (LanguageNotFoundException $e) {
-			// Finding language from request failed fall back to default language
-			$defaultLanguage = $this->config->getSystemValue('default_language', false);
-			if ($defaultLanguage !== false && $this->languageExists($appId, $defaultLanguage)) {
-				return $defaultLanguage;
-			}
-		}
-
-		// Step 5: fall back to English
-		return 'en';
-	}
-
-	public function findGenericLanguage(string $appId = null): string {
-		// Step 1: Forced language always has precedence over anything else
-		$forcedLanguage = $this->config->getSystemValue('force_language', false);
-		if ($forcedLanguage !== false) {
-			return $forcedLanguage;
-		}
-
-		// Step 2: Check if we have a default language
-		$defaultLanguage = $this->config->getSystemValue('default_language', false);
-		if ($defaultLanguage !== false && $this->languageExists($appId, $defaultLanguage)) {
-			return $defaultLanguage;
-		}
-
-		// Step 3.1: Check if Nextcloud is already installed before we try to access user info
-		if (!$this->config->getSystemValueBool('installed', false)) {
-			return 'en';
-		}
-		// Step 3.2: Check the current user (if any) for their preferred language
-		$user = $this->userSession->getUser();
-		if ($user !== null) {
-			$userLang = $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
-			if ($userLang !== null) {
-				return $userLang;
-			}
-		}
-
-		// Step 4: Check the request headers
-		try {
-			return $this->getLanguageFromRequest($appId);
-		} catch (LanguageNotFoundException $e) {
-			// Ignore and continue
-		}
-
-		// Step 5: fall back to English
-		return 'en';
-	}
-
-	/**
-	 * find the best locale
-	 *
-	 * @param string $lang
-	 * @return null|string
-	 */
-	public function findLocale($lang = null) {
-		$forceLocale = $this->config->getSystemValue('force_locale', false);
-		if (is_string($forceLocale) && $this->localeExists($forceLocale)) {
-			return $forceLocale;
-		}
-
-		if ($this->config->getSystemValueBool('installed', false)) {
-			$userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() :  null;
-			$userLocale = null;
-			if (null !== $userId) {
-				$userLocale = $this->config->getUserValue($userId, 'core', 'locale', null);
-			}
-		} else {
-			$userId = null;
-			$userLocale = null;
-		}
-
-		if ($userLocale && $this->localeExists($userLocale)) {
-			return $userLocale;
-		}
-
-		// Default : use system default locale
-		$defaultLocale = $this->config->getSystemValue('default_locale', false);
-		if ($defaultLocale !== false && $this->localeExists($defaultLocale)) {
-			return $defaultLocale;
-		}
-
-		// If no user locale set, use lang as locale
-		if (null !== $lang && $this->localeExists($lang)) {
-			return $lang;
-		}
-
-		// At last, return USA
-		return 'en_US';
-	}
-
-	/**
-	 * find the matching lang from the locale
-	 *
-	 * @param string $app
-	 * @param string $locale
-	 * @return null|string
-	 */
-	public function findLanguageFromLocale(string $app = 'core', string $locale = null) {
-		if ($this->languageExists($app, $locale)) {
-			return $locale;
-		}
-
-		// Try to split e.g: fr_FR => fr
-		$locale = explode('_', $locale)[0];
-		if ($this->languageExists($app, $locale)) {
-			return $locale;
-		}
-	}
-
-	/**
-	 * Find all available languages for an app
-	 *
-	 * @param string|null $app App id or null for core
-	 * @return string[] an array of available languages
-	 */
-	public function findAvailableLanguages($app = null): array {
-		$key = $app;
-		if ($key === null) {
-			$key = 'null';
-		}
-
-		if ($availableLanguages = $this->cache->get($key)) {
-			$this->availableLanguages[$key] = $availableLanguages;
-		}
-
-		// also works with null as key
-		if (!empty($this->availableLanguages[$key])) {
-			return $this->availableLanguages[$key];
-		}
-
-		$available = ['en']; //english is always available
-		$dir = $this->findL10nDir($app);
-		if (is_dir($dir)) {
-			$files = scandir($dir);
-			if ($files !== false) {
-				foreach ($files as $file) {
-					if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
-						$available[] = substr($file, 0, -5);
-					}
-				}
-			}
-		}
-
-		// merge with translations from theme
-		$theme = $this->config->getSystemValueString('theme');
-		if (!empty($theme)) {
-			$themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
-
-			if (is_dir($themeDir)) {
-				$files = scandir($themeDir);
-				if ($files !== false) {
-					foreach ($files as $file) {
-						if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
-							$available[] = substr($file, 0, -5);
-						}
-					}
-				}
-			}
-		}
-
-		$this->availableLanguages[$key] = $available;
-		$this->cache->set($key, $available, 60);
-		return $available;
-	}
-
-	/**
-	 * @return array|mixed
-	 */
-	public function findAvailableLocales() {
-		if (!empty($this->availableLocales)) {
-			return $this->availableLocales;
-		}
-
-		$localeData = file_get_contents(\OC::$SERVERROOT . '/resources/locales.json');
-		$this->availableLocales = \json_decode($localeData, true);
-
-		return $this->availableLocales;
-	}
-
-	/**
-	 * @param string|null $app App id or null for core
-	 * @param string $lang
-	 * @return bool
-	 */
-	public function languageExists($app, $lang) {
-		if ($lang === 'en') { //english is always available
-			return true;
-		}
-
-		$languages = $this->findAvailableLanguages($app);
-		return in_array($lang, $languages);
-	}
-
-	public function getLanguageIterator(IUser $user = null): ILanguageIterator {
-		$user = $user ?? $this->userSession->getUser();
-		if ($user === null) {
-			throw new \RuntimeException('Failed to get an IUser instance');
-		}
-		return new LanguageIterator($user, $this->config);
-	}
-
-	/**
-	 * Return the language to use when sending something to a user
-	 *
-	 * @param IUser|null $user
-	 * @return string
-	 * @since 20.0.0
-	 */
-	public function getUserLanguage(IUser $user = null): string {
-		$language = $this->config->getSystemValue('force_language', false);
-		if ($language !== false) {
-			return $language;
-		}
-
-		if ($user instanceof IUser) {
-			$language = $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
-			if ($language !== null) {
-				return $language;
-			}
-
-			// Use language from request
-			if ($this->userSession->getUser() instanceof IUser &&
-				$user->getUID() === $this->userSession->getUser()->getUID()) {
-				try {
-					return $this->getLanguageFromRequest();
-				} catch (LanguageNotFoundException $e) {
-				}
-			}
-		}
-
-		return $this->config->getSystemValueString('default_language', 'en');
-	}
-
-	/**
-	 * @param string $locale
-	 * @return bool
-	 */
-	public function localeExists($locale) {
-		if ($locale === 'en') { //english is always available
-			return true;
-		}
-
-		if ($this->localeCache === []) {
-			$locales = $this->findAvailableLocales();
-			foreach ($locales as $l) {
-				$this->localeCache[$l['code']] = true;
-			}
-		}
-
-		return isset($this->localeCache[$locale]);
-	}
-
-	/**
-	 * @throws LanguageNotFoundException
-	 */
-	private function getLanguageFromRequest(?string $app = null): string {
-		$header = $this->request->getHeader('ACCEPT_LANGUAGE');
-		if ($header !== '') {
-			$available = $this->findAvailableLanguages($app);
-
-			// E.g. make sure that 'de' is before 'de_DE'.
-			sort($available);
-
-			$preferences = preg_split('/,\s*/', strtolower($header));
-			foreach ($preferences as $preference) {
-				[$preferred_language] = explode(';', $preference);
-				$preferred_language = str_replace('-', '_', $preferred_language);
-
-				foreach ($available as $available_language) {
-					if ($preferred_language === strtolower($available_language)) {
-						return $this->respectDefaultLanguage($app, $available_language);
-					}
-				}
-
-				// Fallback from de_De to de
-				foreach ($available as $available_language) {
-					if (substr($preferred_language, 0, 2) === $available_language) {
-						return $available_language;
-					}
-				}
-			}
-		}
-
-		throw new LanguageNotFoundException();
-	}
-
-	/**
-	 * if default language is set to de_DE (formal German) this should be
-	 * preferred to 'de' (non-formal German) if possible
-	 */
-	protected function respectDefaultLanguage(?string $app, string $lang): string {
-		$result = $lang;
-		$defaultLanguage = $this->config->getSystemValue('default_language', false);
-
-		// use formal version of german ("Sie" instead of "Du") if the default
-		// language is set to 'de_DE' if possible
-		if (
-			is_string($defaultLanguage) &&
-			strtolower($lang) === 'de' &&
-			strtolower($defaultLanguage) === 'de_de' &&
-			$this->languageExists($app, 'de_DE')
-		) {
-			$result = 'de_DE';
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Checks if $sub is a subdirectory of $parent
-	 *
-	 * @param string $sub
-	 * @param string $parent
-	 * @return bool
-	 */
-	private function isSubDirectory($sub, $parent) {
-		// Check whether $sub contains no ".."
-		if (str_contains($sub, '..')) {
-			return false;
-		}
-
-		// Check whether $sub is a subdirectory of $parent
-		if (str_starts_with($sub, $parent)) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get a list of language files that should be loaded
-	 *
-	 * @param string $app
-	 * @param string $lang
-	 * @return string[]
-	 */
-	// FIXME This method is only public, until OC_L10N does not need it anymore,
-	// FIXME This is also the reason, why it is not in the public interface
-	public function getL10nFilesForApp($app, $lang) {
-		$languageFiles = [];
-
-		$i18nDir = $this->findL10nDir($app);
-		$transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
-
-		if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
-				|| $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
-				|| $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/'))
-			&& file_exists($transFile)
-		) {
-			// load the translations file
-			$languageFiles[] = $transFile;
-		}
-
-		// merge with translations from theme
-		$theme = $this->config->getSystemValueString('theme');
-		if (!empty($theme)) {
-			$transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
-			if (file_exists($transFile)) {
-				$languageFiles[] = $transFile;
-			}
-		}
-
-		return $languageFiles;
-	}
-
-	/**
-	 * find the l10n directory
-	 *
-	 * @param string $app App id or empty string for core
-	 * @return string directory
-	 */
-	protected function findL10nDir($app = null) {
-		if (in_array($app, ['core', 'lib'])) {
-			if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
-				return $this->serverRoot . '/' . $app . '/l10n/';
-			}
-		} elseif ($app && \OC_App::getAppPath($app) !== false) {
-			// Check if the app is in the app folder
-			return \OC_App::getAppPath($app) . '/l10n/';
-		}
-		return $this->serverRoot . '/core/l10n/';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getLanguages(): array {
-		$forceLanguage = $this->config->getSystemValue('force_language', false);
-		if ($forceLanguage !== false) {
-			$l = $this->get('lib', $forceLanguage);
-			$potentialName = $l->t('__language_name__');
-
-			return [
-				'commonLanguages' => [[
-					'code' => $forceLanguage,
-					'name' => $potentialName,
-				]],
-				'otherLanguages' => [],
-			];
-		}
-
-		$languageCodes = $this->findAvailableLanguages();
-
-		$commonLanguages = [];
-		$otherLanguages = [];
-
-		foreach ($languageCodes as $lang) {
-			$l = $this->get('lib', $lang);
-			// TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
-			$potentialName = $l->t('__language_name__');
-			if ($l->getLanguageCode() === $lang && $potentialName[0] !== '_') { //first check if the language name is in the translation file
-				$ln = [
-					'code' => $lang,
-					'name' => $potentialName
-				];
-			} elseif ($lang === 'en') {
-				$ln = [
-					'code' => $lang,
-					'name' => 'English (US)'
-				];
-			} else { //fallback to language code
-				$ln = [
-					'code' => $lang,
-					'name' => $lang
-				];
-			}
-
-			// put appropriate languages into appropriate arrays, to print them sorted
-			// common languages -> divider -> other languages
-			if (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
-				$commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)] = $ln;
-			} else {
-				$otherLanguages[] = $ln;
-			}
-		}
-
-		ksort($commonLanguages);
-
-		// sort now by displayed language not the iso-code
-		usort($otherLanguages, function ($a, $b) {
-			if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
-				// If a doesn't have a name, but b does, list b before a
-				return 1;
-			}
-			if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
-				// If a does have a name, but b doesn't, list a before b
-				return -1;
-			}
-			// Otherwise compare the names
-			return strcmp($a['name'], $b['name']);
-		});
-
-		return [
-			// reset indexes
-			'commonLanguages' => array_values($commonLanguages),
-			'otherLanguages' => $otherLanguages
-		];
-	}
+    /** @var string */
+    protected $requestLanguage = '';
+
+    /**
+     * cached instances
+     * @var array Structure: Lang => App => \OCP\IL10N
+     */
+    protected $instances = [];
+
+    /**
+     * @var array Structure: App => string[]
+     */
+    protected $availableLanguages = [];
+
+    /**
+     * @var array
+     */
+    protected $localeCache = [];
+
+    /**
+     * @var array
+     */
+    protected $availableLocales = [];
+
+    /**
+     * @var array Structure: string => callable
+     */
+    protected $pluralFunctions = [];
+
+    public const COMMON_LANGUAGE_CODES = [
+        'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
+        'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
+    ];
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IRequest */
+    protected $request;
+
+    /** @var IUserSession */
+    protected IUserSession $userSession;
+
+    private ICache $cache;
+
+    /** @var string */
+    protected $serverRoot;
+
+    /**
+     * @param IConfig $config
+     * @param IRequest $request
+     * @param IUserSession $userSession
+     * @param string $serverRoot
+     */
+    public function __construct(
+        IConfig $config,
+        IRequest $request,
+        IUserSession $userSession,
+        ICacheFactory $cacheFactory,
+        $serverRoot
+    ) {
+        $this->config = $config;
+        $this->request = $request;
+        $this->userSession = $userSession;
+        $this->cache = $cacheFactory->createLocal('L10NFactory');
+        $this->serverRoot = $serverRoot;
+    }
+
+    /**
+     * Get a language instance
+     *
+     * @param string $app
+     * @param string|null $lang
+     * @param string|null $locale
+     * @return \OCP\IL10N
+     */
+    public function get($app, $lang = null, $locale = null) {
+        return new LazyL10N(function () use ($app, $lang, $locale) {
+            $app = \OC_App::cleanAppId($app);
+            if ($lang !== null) {
+                $lang = str_replace(['\0', '/', '\\', '..'], '', $lang);
+            }
+
+            $forceLang = $this->config->getSystemValue('force_language', false);
+            if (is_string($forceLang)) {
+                $lang = $forceLang;
+            }
+
+            $forceLocale = $this->config->getSystemValue('force_locale', false);
+            if (is_string($forceLocale)) {
+                $locale = $forceLocale;
+            }
+
+            if ($lang === null || !$this->languageExists($app, $lang)) {
+                $lang = $this->findLanguage($app);
+            }
+
+            if ($locale === null || !$this->localeExists($locale)) {
+                $locale = $this->findLocale($lang);
+            }
+
+            if (!isset($this->instances[$lang][$app])) {
+                $this->instances[$lang][$app] = new L10N(
+                    $this,
+                    $app,
+                    $lang,
+                    $locale,
+                    $this->getL10nFilesForApp($app, $lang)
+                );
+            }
+
+            return $this->instances[$lang][$app];
+        });
+    }
+
+    /**
+     * Find the best language
+     *
+     * @param string|null $appId App id or null for core
+     *
+     * @return string language If nothing works it returns 'en'
+     */
+    public function findLanguage(?string $appId = null): string {
+        // Step 1: Forced language always has precedence over anything else
+        $forceLang = $this->config->getSystemValue('force_language', false);
+        if (is_string($forceLang)) {
+            $this->requestLanguage = $forceLang;
+        }
+
+        // Step 2: Return cached language
+        if ($this->requestLanguage !== '' && $this->languageExists($appId, $this->requestLanguage)) {
+            return $this->requestLanguage;
+        }
+
+        /**
+         * Step 3: At this point Nextcloud might not yet be installed and thus the lookup
+         * in the preferences table might fail. For this reason we need to check
+         * whether the instance has already been installed
+         *
+         * @link https://github.com/owncloud/core/issues/21955
+         */
+        if ($this->config->getSystemValueBool('installed', false)) {
+            $userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
+            if (!is_null($userId)) {
+                $userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
+            } else {
+                $userLang = null;
+            }
+        } else {
+            $userId = null;
+            $userLang = null;
+        }
+        if ($userLang) {
+            $this->requestLanguage = $userLang;
+            if ($this->languageExists($appId, $userLang)) {
+                return $userLang;
+            }
+        }
+
+        // Step 4: Check the request headers
+        try {
+            // Try to get the language from the Request
+            $lang = $this->getLanguageFromRequest($appId);
+            if ($userId !== null && $appId === null && !$userLang) {
+                $this->config->setUserValue($userId, 'core', 'lang', $lang);
+            }
+            return $lang;
+        } catch (LanguageNotFoundException $e) {
+            // Finding language from request failed fall back to default language
+            $defaultLanguage = $this->config->getSystemValue('default_language', false);
+            if ($defaultLanguage !== false && $this->languageExists($appId, $defaultLanguage)) {
+                return $defaultLanguage;
+            }
+        }
+
+        // Step 5: fall back to English
+        return 'en';
+    }
+
+    public function findGenericLanguage(string $appId = null): string {
+        // Step 1: Forced language always has precedence over anything else
+        $forcedLanguage = $this->config->getSystemValue('force_language', false);
+        if ($forcedLanguage !== false) {
+            return $forcedLanguage;
+        }
+
+        // Step 2: Check if we have a default language
+        $defaultLanguage = $this->config->getSystemValue('default_language', false);
+        if ($defaultLanguage !== false && $this->languageExists($appId, $defaultLanguage)) {
+            return $defaultLanguage;
+        }
+
+        // Step 3.1: Check if Nextcloud is already installed before we try to access user info
+        if (!$this->config->getSystemValueBool('installed', false)) {
+            return 'en';
+        }
+        // Step 3.2: Check the current user (if any) for their preferred language
+        $user = $this->userSession->getUser();
+        if ($user !== null) {
+            $userLang = $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
+            if ($userLang !== null) {
+                return $userLang;
+            }
+        }
+
+        // Step 4: Check the request headers
+        try {
+            return $this->getLanguageFromRequest($appId);
+        } catch (LanguageNotFoundException $e) {
+            // Ignore and continue
+        }
+
+        // Step 5: fall back to English
+        return 'en';
+    }
+
+    /**
+     * find the best locale
+     *
+     * @param string $lang
+     * @return null|string
+     */
+    public function findLocale($lang = null) {
+        $forceLocale = $this->config->getSystemValue('force_locale', false);
+        if (is_string($forceLocale) && $this->localeExists($forceLocale)) {
+            return $forceLocale;
+        }
+
+        if ($this->config->getSystemValueBool('installed', false)) {
+            $userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() :  null;
+            $userLocale = null;
+            if (null !== $userId) {
+                $userLocale = $this->config->getUserValue($userId, 'core', 'locale', null);
+            }
+        } else {
+            $userId = null;
+            $userLocale = null;
+        }
+
+        if ($userLocale && $this->localeExists($userLocale)) {
+            return $userLocale;
+        }
+
+        // Default : use system default locale
+        $defaultLocale = $this->config->getSystemValue('default_locale', false);
+        if ($defaultLocale !== false && $this->localeExists($defaultLocale)) {
+            return $defaultLocale;
+        }
+
+        // If no user locale set, use lang as locale
+        if (null !== $lang && $this->localeExists($lang)) {
+            return $lang;
+        }
+
+        // At last, return USA
+        return 'en_US';
+    }
+
+    /**
+     * find the matching lang from the locale
+     *
+     * @param string $app
+     * @param string $locale
+     * @return null|string
+     */
+    public function findLanguageFromLocale(string $app = 'core', string $locale = null) {
+        if ($this->languageExists($app, $locale)) {
+            return $locale;
+        }
+
+        // Try to split e.g: fr_FR => fr
+        $locale = explode('_', $locale)[0];
+        if ($this->languageExists($app, $locale)) {
+            return $locale;
+        }
+    }
+
+    /**
+     * Find all available languages for an app
+     *
+     * @param string|null $app App id or null for core
+     * @return string[] an array of available languages
+     */
+    public function findAvailableLanguages($app = null): array {
+        $key = $app;
+        if ($key === null) {
+            $key = 'null';
+        }
+
+        if ($availableLanguages = $this->cache->get($key)) {
+            $this->availableLanguages[$key] = $availableLanguages;
+        }
+
+        // also works with null as key
+        if (!empty($this->availableLanguages[$key])) {
+            return $this->availableLanguages[$key];
+        }
+
+        $available = ['en']; //english is always available
+        $dir = $this->findL10nDir($app);
+        if (is_dir($dir)) {
+            $files = scandir($dir);
+            if ($files !== false) {
+                foreach ($files as $file) {
+                    if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
+                        $available[] = substr($file, 0, -5);
+                    }
+                }
+            }
+        }
+
+        // merge with translations from theme
+        $theme = $this->config->getSystemValueString('theme');
+        if (!empty($theme)) {
+            $themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
+
+            if (is_dir($themeDir)) {
+                $files = scandir($themeDir);
+                if ($files !== false) {
+                    foreach ($files as $file) {
+                        if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
+                            $available[] = substr($file, 0, -5);
+                        }
+                    }
+                }
+            }
+        }
+
+        $this->availableLanguages[$key] = $available;
+        $this->cache->set($key, $available, 60);
+        return $available;
+    }
+
+    /**
+     * @return array|mixed
+     */
+    public function findAvailableLocales() {
+        if (!empty($this->availableLocales)) {
+            return $this->availableLocales;
+        }
+
+        $localeData = file_get_contents(\OC::$SERVERROOT . '/resources/locales.json');
+        $this->availableLocales = \json_decode($localeData, true);
+
+        return $this->availableLocales;
+    }
+
+    /**
+     * @param string|null $app App id or null for core
+     * @param string $lang
+     * @return bool
+     */
+    public function languageExists($app, $lang) {
+        if ($lang === 'en') { //english is always available
+            return true;
+        }
+
+        $languages = $this->findAvailableLanguages($app);
+        return in_array($lang, $languages);
+    }
+
+    public function getLanguageIterator(IUser $user = null): ILanguageIterator {
+        $user = $user ?? $this->userSession->getUser();
+        if ($user === null) {
+            throw new \RuntimeException('Failed to get an IUser instance');
+        }
+        return new LanguageIterator($user, $this->config);
+    }
+
+    /**
+     * Return the language to use when sending something to a user
+     *
+     * @param IUser|null $user
+     * @return string
+     * @since 20.0.0
+     */
+    public function getUserLanguage(IUser $user = null): string {
+        $language = $this->config->getSystemValue('force_language', false);
+        if ($language !== false) {
+            return $language;
+        }
+
+        if ($user instanceof IUser) {
+            $language = $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
+            if ($language !== null) {
+                return $language;
+            }
+
+            // Use language from request
+            if ($this->userSession->getUser() instanceof IUser &&
+                $user->getUID() === $this->userSession->getUser()->getUID()) {
+                try {
+                    return $this->getLanguageFromRequest();
+                } catch (LanguageNotFoundException $e) {
+                }
+            }
+        }
+
+        return $this->config->getSystemValueString('default_language', 'en');
+    }
+
+    /**
+     * @param string $locale
+     * @return bool
+     */
+    public function localeExists($locale) {
+        if ($locale === 'en') { //english is always available
+            return true;
+        }
+
+        if ($this->localeCache === []) {
+            $locales = $this->findAvailableLocales();
+            foreach ($locales as $l) {
+                $this->localeCache[$l['code']] = true;
+            }
+        }
+
+        return isset($this->localeCache[$locale]);
+    }
+
+    /**
+     * @throws LanguageNotFoundException
+     */
+    private function getLanguageFromRequest(?string $app = null): string {
+        $header = $this->request->getHeader('ACCEPT_LANGUAGE');
+        if ($header !== '') {
+            $available = $this->findAvailableLanguages($app);
+
+            // E.g. make sure that 'de' is before 'de_DE'.
+            sort($available);
+
+            $preferences = preg_split('/,\s*/', strtolower($header));
+            foreach ($preferences as $preference) {
+                [$preferred_language] = explode(';', $preference);
+                $preferred_language = str_replace('-', '_', $preferred_language);
+
+                foreach ($available as $available_language) {
+                    if ($preferred_language === strtolower($available_language)) {
+                        return $this->respectDefaultLanguage($app, $available_language);
+                    }
+                }
+
+                // Fallback from de_De to de
+                foreach ($available as $available_language) {
+                    if (substr($preferred_language, 0, 2) === $available_language) {
+                        return $available_language;
+                    }
+                }
+            }
+        }
+
+        throw new LanguageNotFoundException();
+    }
+
+    /**
+     * if default language is set to de_DE (formal German) this should be
+     * preferred to 'de' (non-formal German) if possible
+     */
+    protected function respectDefaultLanguage(?string $app, string $lang): string {
+        $result = $lang;
+        $defaultLanguage = $this->config->getSystemValue('default_language', false);
+
+        // use formal version of german ("Sie" instead of "Du") if the default
+        // language is set to 'de_DE' if possible
+        if (
+            is_string($defaultLanguage) &&
+            strtolower($lang) === 'de' &&
+            strtolower($defaultLanguage) === 'de_de' &&
+            $this->languageExists($app, 'de_DE')
+        ) {
+            $result = 'de_DE';
+        }
+
+        return $result;
+    }
+
+    /**
+     * Checks if $sub is a subdirectory of $parent
+     *
+     * @param string $sub
+     * @param string $parent
+     * @return bool
+     */
+    private function isSubDirectory($sub, $parent) {
+        // Check whether $sub contains no ".."
+        if (str_contains($sub, '..')) {
+            return false;
+        }
+
+        // Check whether $sub is a subdirectory of $parent
+        if (str_starts_with($sub, $parent)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Get a list of language files that should be loaded
+     *
+     * @param string $app
+     * @param string $lang
+     * @return string[]
+     */
+    // FIXME This method is only public, until OC_L10N does not need it anymore,
+    // FIXME This is also the reason, why it is not in the public interface
+    public function getL10nFilesForApp($app, $lang) {
+        $languageFiles = [];
+
+        $i18nDir = $this->findL10nDir($app);
+        $transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
+
+        if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
+                || $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
+                || $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/'))
+            && file_exists($transFile)
+        ) {
+            // load the translations file
+            $languageFiles[] = $transFile;
+        }
+
+        // merge with translations from theme
+        $theme = $this->config->getSystemValueString('theme');
+        if (!empty($theme)) {
+            $transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
+            if (file_exists($transFile)) {
+                $languageFiles[] = $transFile;
+            }
+        }
+
+        return $languageFiles;
+    }
+
+    /**
+     * find the l10n directory
+     *
+     * @param string $app App id or empty string for core
+     * @return string directory
+     */
+    protected function findL10nDir($app = null) {
+        if (in_array($app, ['core', 'lib'])) {
+            if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
+                return $this->serverRoot . '/' . $app . '/l10n/';
+            }
+        } elseif ($app && \OC_App::getAppPath($app) !== false) {
+            // Check if the app is in the app folder
+            return \OC_App::getAppPath($app) . '/l10n/';
+        }
+        return $this->serverRoot . '/core/l10n/';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getLanguages(): array {
+        $forceLanguage = $this->config->getSystemValue('force_language', false);
+        if ($forceLanguage !== false) {
+            $l = $this->get('lib', $forceLanguage);
+            $potentialName = $l->t('__language_name__');
+
+            return [
+                'commonLanguages' => [[
+                    'code' => $forceLanguage,
+                    'name' => $potentialName,
+                ]],
+                'otherLanguages' => [],
+            ];
+        }
+
+        $languageCodes = $this->findAvailableLanguages();
+
+        $commonLanguages = [];
+        $otherLanguages = [];
+
+        foreach ($languageCodes as $lang) {
+            $l = $this->get('lib', $lang);
+            // TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
+            $potentialName = $l->t('__language_name__');
+            if ($l->getLanguageCode() === $lang && $potentialName[0] !== '_') { //first check if the language name is in the translation file
+                $ln = [
+                    'code' => $lang,
+                    'name' => $potentialName
+                ];
+            } elseif ($lang === 'en') {
+                $ln = [
+                    'code' => $lang,
+                    'name' => 'English (US)'
+                ];
+            } else { //fallback to language code
+                $ln = [
+                    'code' => $lang,
+                    'name' => $lang
+                ];
+            }
+
+            // put appropriate languages into appropriate arrays, to print them sorted
+            // common languages -> divider -> other languages
+            if (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
+                $commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)] = $ln;
+            } else {
+                $otherLanguages[] = $ln;
+            }
+        }
+
+        ksort($commonLanguages);
+
+        // sort now by displayed language not the iso-code
+        usort($otherLanguages, function ($a, $b) {
+            if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
+                // If a doesn't have a name, but b does, list b before a
+                return 1;
+            }
+            if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
+                // If a does have a name, but b doesn't, list a before b
+                return -1;
+            }
+            // Otherwise compare the names
+            return strcmp($a['name'], $b['name']);
+        });
+
+        return [
+            // reset indexes
+            'commonLanguages' => array_values($commonLanguages),
+            'otherLanguages' => $otherLanguages
+        ];
+    }
 }

lib/private/L10N/L10NString.php

Indentation +50 added lines, -50 removed lines

@@ -28,67 +28,67 @@
 namespace OC\L10N;
 
 class L10NString implements \JsonSerializable {
-	/** @var L10N */
-	protected $l10n;
+    /** @var L10N */
+    protected $l10n;
 
-	/** @var string */
-	protected $text;
+    /** @var string */
+    protected $text;
 
-	/** @var array */
-	protected $parameters;
+    /** @var array */
+    protected $parameters;
 
-	/** @var integer */
-	protected $count;
+    /** @var integer */
+    protected $count;
 
-	/**
-	 * @param L10N $l10n
-	 * @param string|string[] $text
-	 * @param array $parameters
-	 * @param int $count
-	 */
-	public function __construct(L10N $l10n, $text, array $parameters, int $count = 1) {
-		$this->l10n = $l10n;
-		$this->text = $text;
-		$this->parameters = $parameters;
-		$this->count = $count;
-	}
+    /**
+     * @param L10N $l10n
+     * @param string|string[] $text
+     * @param array $parameters
+     * @param int $count
+     */
+    public function __construct(L10N $l10n, $text, array $parameters, int $count = 1) {
+        $this->l10n = $l10n;
+        $this->text = $text;
+        $this->parameters = $parameters;
+        $this->count = $count;
+    }
 
-	public function __toString(): string {
-		$translations = $this->l10n->getTranslations();
-		$identityTranslator = $this->l10n->getIdentityTranslator();
+    public function __toString(): string {
+        $translations = $this->l10n->getTranslations();
+        $identityTranslator = $this->l10n->getIdentityTranslator();
 
-		// Use the indexed version as per \Symfony\Contracts\Translation\TranslatorInterface
-		$identity = $this->text;
-		if (array_key_exists($this->text, $translations)) {
-			$identity = $translations[$this->text];
-		}
+        // Use the indexed version as per \Symfony\Contracts\Translation\TranslatorInterface
+        $identity = $this->text;
+        if (array_key_exists($this->text, $translations)) {
+            $identity = $translations[$this->text];
+        }
 
-		if (is_array($identity)) {
-			$pipeCheck = implode('', $identity);
-			if (str_contains($pipeCheck, '|')) {
-				return 'Can not use pipe character in translations';
-			}
+        if (is_array($identity)) {
+            $pipeCheck = implode('', $identity);
+            if (str_contains($pipeCheck, '|')) {
+                return 'Can not use pipe character in translations';
+            }
 
-			$identity = implode('|', $identity);
-		} elseif (str_contains($identity, '|')) {
-			return 'Can not use pipe character in translations';
-		}
+            $identity = implode('|', $identity);
+        } elseif (str_contains($identity, '|')) {
+            return 'Can not use pipe character in translations';
+        }
 
-		$beforeIdentity = $identity;
-		$identity = str_replace('%n', '%count%', $identity);
+        $beforeIdentity = $identity;
+        $identity = str_replace('%n', '%count%', $identity);
 
-		$parameters = [];
-		if ($beforeIdentity !== $identity) {
-			$parameters = ['%count%' => $this->count];
-		}
+        $parameters = [];
+        if ($beforeIdentity !== $identity) {
+            $parameters = ['%count%' => $this->count];
+        }
 
-		// $count as %count% as per \Symfony\Contracts\Translation\TranslatorInterface
-		$text = $identityTranslator->trans($identity, $parameters);
+        // $count as %count% as per \Symfony\Contracts\Translation\TranslatorInterface
+        $text = $identityTranslator->trans($identity, $parameters);
 
-		return vsprintf($text, $this->parameters);
-	}
+        return vsprintf($text, $this->parameters);
+    }
 
-	public function jsonSerialize(): string {
-		return $this->__toString();
-	}
+    public function jsonSerialize(): string {
+        return $this->__toString();
+    }
 }

lib/private/DB/QueryBuilder/QueryBuilder.php

Indentation +1300 added lines, -1300 removed lines

@@ -56,1304 +56,1304 @@
 use Psr\Log\LoggerInterface;
 
 class QueryBuilder implements IQueryBuilder {
-	/** @var ConnectionAdapter */
-	private $connection;
-
-	/** @var SystemConfig */
-	private $systemConfig;
-
-	private LoggerInterface $logger;
-
-	/** @var \Doctrine\DBAL\Query\QueryBuilder */
-	private $queryBuilder;
-
-	/** @var QuoteHelper */
-	private $helper;
-
-	/** @var bool */
-	private $automaticTablePrefix = true;
-
-	/** @var string */
-	protected $lastInsertedTable;
-
-	/**
-	 * Initializes a new QueryBuilder.
-	 *
-	 * @param ConnectionAdapter $connection
-	 * @param SystemConfig $systemConfig
-	 */
-	public function __construct(ConnectionAdapter $connection, SystemConfig $systemConfig, LoggerInterface $logger) {
-		$this->connection = $connection;
-		$this->systemConfig = $systemConfig;
-		$this->logger = $logger;
-		$this->queryBuilder = new \Doctrine\DBAL\Query\QueryBuilder($this->connection->getInner());
-		$this->helper = new QuoteHelper();
-	}
-
-	/**
-	 * Enable/disable automatic prefixing of table names with the oc_ prefix
-	 *
-	 * @param bool $enabled If set to true table names will be prefixed with the
-	 * owncloud database prefix automatically.
-	 * @since 8.2.0
-	 */
-	public function automaticTablePrefix($enabled) {
-		$this->automaticTablePrefix = (bool) $enabled;
-	}
-
-	/**
-	 * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
-	 * This producer method is intended for convenient inline usage. Example:
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where($qb->expr()->eq('u.id', 1));
-	 * </code>
-	 *
-	 * For more complex expression construction, consider storing the expression
-	 * builder object in a local variable.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IExpressionBuilder
-	 */
-	public function expr() {
-		if ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
-			return new OCIExpressionBuilder($this->connection, $this);
-		}
-		if ($this->connection->getDatabasePlatform() instanceof PostgreSQL94Platform) {
-			return new PgSqlExpressionBuilder($this->connection, $this);
-		}
-		if ($this->connection->getDatabasePlatform() instanceof MySQLPlatform) {
-			return new MySqlExpressionBuilder($this->connection, $this);
-		}
-		if ($this->connection->getDatabasePlatform() instanceof SqlitePlatform) {
-			return new SqliteExpressionBuilder($this->connection, $this);
-		}
-
-		return new ExpressionBuilder($this->connection, $this);
-	}
-
-	/**
-	 * Gets an FunctionBuilder used for object-oriented construction of query functions.
-	 * This producer method is intended for convenient inline usage. Example:
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where($qb->fun()->md5('u.id'));
-	 * </code>
-	 *
-	 * For more complex function construction, consider storing the function
-	 * builder object in a local variable.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IFunctionBuilder
-	 */
-	public function func() {
-		if ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
-			return new OCIFunctionBuilder($this->connection, $this, $this->helper);
-		}
-		if ($this->connection->getDatabasePlatform() instanceof SqlitePlatform) {
-			return new SqliteFunctionBuilder($this->connection, $this, $this->helper);
-		}
-		if ($this->connection->getDatabasePlatform() instanceof PostgreSQL94Platform) {
-			return new PgSqlFunctionBuilder($this->connection, $this, $this->helper);
-		}
-
-		return new FunctionBuilder($this->connection, $this, $this->helper);
-	}
-
-	/**
-	 * Gets the type of the currently built query.
-	 *
-	 * @return integer
-	 */
-	public function getType() {
-		return $this->queryBuilder->getType();
-	}
-
-	/**
-	 * Gets the associated DBAL Connection for this query builder.
-	 *
-	 * @return \OCP\IDBConnection
-	 */
-	public function getConnection() {
-		return $this->connection;
-	}
-
-	/**
-	 * Gets the state of this query builder instance.
-	 *
-	 * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
-	 */
-	public function getState() {
-		return $this->queryBuilder->getState();
-	}
-
-	/**
-	 * Executes this query using the bound parameters and their types.
-	 *
-	 * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate}
-	 * for insert, update and delete statements.
-	 *
-	 * @return IResult|int
-	 */
-	public function execute() {
-		if ($this->systemConfig->getValue('log_query', false)) {
-			try {
-				$params = [];
-				foreach ($this->getParameters() as $placeholder => $value) {
-					if ($value instanceof \DateTime) {
-						$params[] = $placeholder . ' => DateTime:\'' . $value->format('c') . '\'';
-					} elseif (is_array($value)) {
-						$params[] = $placeholder . ' => (\'' . implode('\', \'', $value) . '\')';
-					} else {
-						$params[] = $placeholder . ' => \'' . $value . '\'';
-					}
-				}
-				if (empty($params)) {
-					$this->logger->debug('DB QueryBuilder: \'{query}\'', [
-						'query' => $this->getSQL(),
-						'app' => 'core',
-					]);
-				} else {
-					$this->logger->debug('DB QueryBuilder: \'{query}\' with parameters: {params}', [
-						'query' => $this->getSQL(),
-						'params' => implode(', ', $params),
-						'app' => 'core',
-					]);
-				}
-			} catch (\Error $e) {
-				// likely an error during conversion of $value to string
-				$this->logger->error('DB QueryBuilder: error trying to log SQL query', ['exception' => $e]);
-			}
-		}
-
-		if (!empty($this->getQueryPart('select'))) {
-			$select = $this->getQueryPart('select');
-			$hasSelectAll = array_filter($select, static function ($s) {
-				return $s === '*';
-			});
-			$hasSelectSpecific = array_filter($select, static function ($s) {
-				return $s !== '*';
-			});
-
-			if (empty($hasSelectAll) === empty($hasSelectSpecific)) {
-				$exception = new QueryException('Query is selecting * and specific values in the same query. This is not supported in Oracle.');
-				$this->logger->error($exception->getMessage(), [
-					'query' => $this->getSQL(),
-					'app' => 'core',
-					'exception' => $exception,
-				]);
-			}
-		}
-
-		$numberOfParameters = 0;
-		$hasTooLargeArrayParameter = false;
-		foreach ($this->getParameters() as $parameter) {
-			if (is_array($parameter)) {
-				$count = count($parameter);
-				$numberOfParameters += $count;
-				$hasTooLargeArrayParameter = $hasTooLargeArrayParameter || ($count > 1000);
-			}
-		}
-
-		if ($hasTooLargeArrayParameter) {
-			$exception = new QueryException('More than 1000 expressions in a list are not allowed on Oracle.');
-			$this->logger->error($exception->getMessage(), [
-				'query' => $this->getSQL(),
-				'app' => 'core',
-				'exception' => $exception,
-			]);
-		}
-
-		if ($numberOfParameters > 65535) {
-			$exception = new QueryException('The number of parameters must not exceed 65535. Restriction by PostgreSQL.');
-			$this->logger->error($exception->getMessage(), [
-				'query' => $this->getSQL(),
-				'app' => 'core',
-				'exception' => $exception,
-			]);
-		}
-
-		$result = $this->queryBuilder->execute();
-		if (is_int($result)) {
-			return $result;
-		}
-		return new ResultAdapter($result);
-	}
-
-	public function executeQuery(): IResult {
-		if ($this->getType() !== \Doctrine\DBAL\Query\QueryBuilder::SELECT) {
-			throw new \RuntimeException('Invalid query type, expected SELECT query');
-		}
-
-		try {
-			$result = $this->execute();
-		} catch (\Doctrine\DBAL\Exception $e) {
-			throw \OC\DB\Exceptions\DbalException::wrap($e);
-		}
-
-		if ($result instanceof IResult) {
-			return $result;
-		}
-
-		throw new \RuntimeException('Invalid return type for query');
-	}
-
-	/**
-	 * Monkey-patched compatibility layer for apps that were adapted for Nextcloud 22 before
-	 * the first beta, where executeStatement was named executeUpdate.
-	 *
-	 * Static analysis should catch those misuses, but until then let's try to keep things
-	 * running.
-	 *
-	 * @internal
-	 * @deprecated
-	 * @todo drop ASAP
-	 */
-	public function executeUpdate(): int {
-		return $this->executeStatement();
-	}
-
-	public function executeStatement(): int {
-		if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::SELECT) {
-			throw new \RuntimeException('Invalid query type, expected INSERT, DELETE or UPDATE statement');
-		}
-
-		try {
-			$result = $this->execute();
-		} catch (\Doctrine\DBAL\Exception $e) {
-			throw \OC\DB\Exceptions\DbalException::wrap($e);
-		}
-
-		if (!is_int($result)) {
-			throw new \RuntimeException('Invalid return type for statement');
-		}
-
-		return $result;
-	}
-
-
-	/**
-	 * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('User', 'u')
-	 *     echo $qb->getSQL(); // SELECT u FROM User u
-	 * </code>
-	 *
-	 * @return string The SQL query string.
-	 */
-	public function getSQL() {
-		return $this->queryBuilder->getSQL();
-	}
-
-	/**
-	 * Sets a query parameter for the query being constructed.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = :user_id')
-	 *         ->setParameter(':user_id', 1);
-	 * </code>
-	 *
-	 * @param string|integer $key The parameter position or name.
-	 * @param mixed $value The parameter value.
-	 * @param string|null|int $type One of the IQueryBuilder::PARAM_* constants.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function setParameter($key, $value, $type = null) {
-		$this->queryBuilder->setParameter($key, $value, $type);
-
-		return $this;
-	}
-
-	/**
-	 * Sets a collection of query parameters for the query being constructed.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = :user_id1 OR u.id = :user_id2')
-	 *         ->setParameters(array(
-	 *             ':user_id1' => 1,
-	 *             ':user_id2' => 2
-	 *         ));
-	 * </code>
-	 *
-	 * @param array $params The query parameters to set.
-	 * @param array $types The query parameters types to set.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function setParameters(array $params, array $types = []) {
-		$this->queryBuilder->setParameters($params, $types);
-
-		return $this;
-	}
-
-	/**
-	 * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
-	 *
-	 * @return array The currently defined query parameters indexed by parameter index or name.
-	 */
-	public function getParameters() {
-		return $this->queryBuilder->getParameters();
-	}
-
-	/**
-	 * Gets a (previously set) query parameter of the query being constructed.
-	 *
-	 * @param mixed $key The key (index or name) of the bound parameter.
-	 *
-	 * @return mixed The value of the bound parameter.
-	 */
-	public function getParameter($key) {
-		return $this->queryBuilder->getParameter($key);
-	}
-
-	/**
-	 * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
-	 *
-	 * @return array The currently defined query parameter types indexed by parameter index or name.
-	 */
-	public function getParameterTypes() {
-		return $this->queryBuilder->getParameterTypes();
-	}
-
-	/**
-	 * Gets a (previously set) query parameter type of the query being constructed.
-	 *
-	 * @param mixed $key The key (index or name) of the bound parameter type.
-	 *
-	 * @return mixed The value of the bound parameter type.
-	 */
-	public function getParameterType($key) {
-		return $this->queryBuilder->getParameterType($key);
-	}
-
-	/**
-	 * Sets the position of the first result to retrieve (the "offset").
-	 *
-	 * @param int $firstResult The first result to return.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function setFirstResult($firstResult) {
-		$this->queryBuilder->setFirstResult((int) $firstResult);
-
-		return $this;
-	}
-
-	/**
-	 * Gets the position of the first result the query object was set to retrieve (the "offset").
-	 * Returns 0 if {@link setFirstResult} was not applied to this QueryBuilder.
-	 *
-	 * @return int The position of the first result.
-	 */
-	public function getFirstResult() {
-		return $this->queryBuilder->getFirstResult();
-	}
-
-	/**
-	 * Sets the maximum number of results to retrieve (the "limit").
-	 *
-	 * NOTE: Setting max results to "0" will cause mixed behaviour. While most
-	 * of the databases will just return an empty result set, Oracle will return
-	 * all entries.
-	 *
-	 * @param int|null $maxResults The maximum number of results to retrieve.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function setMaxResults($maxResults) {
-		if ($maxResults === null) {
-			$this->queryBuilder->setMaxResults($maxResults);
-		} else {
-			$this->queryBuilder->setMaxResults((int) $maxResults);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Gets the maximum number of results the query object was set to retrieve (the "limit").
-	 * Returns NULL if {@link setMaxResults} was not applied to this query builder.
-	 *
-	 * @return int|null The maximum number of results.
-	 */
-	public function getMaxResults() {
-		return $this->queryBuilder->getMaxResults();
-	}
-
-	/**
-	 * Specifies an item that is to be returned in the query result.
-	 * Replaces any previously specified selections, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id', 'p.id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed ...$selects The selection expressions.
-	 *
-	 * '@return $this This QueryBuilder instance.
-	 */
-	public function select(...$selects) {
-		if (count($selects) === 1 && is_array($selects[0])) {
-			$selects = $selects[0];
-		}
-
-		$this->queryBuilder->select(
-			$this->helper->quoteColumnNames($selects)
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Specifies an item that is to be returned with a different name in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->selectAlias('u.id', 'user_id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 * @param string $alias The column alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function selectAlias($select, $alias) {
-		$this->queryBuilder->addSelect(
-			$this->helper->quoteColumnName($select) . ' AS ' . $this->helper->quoteColumnName($alias)
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Specifies an item that is to be returned uniquely in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->selectDistinct('type')
-	 *         ->from('users');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function selectDistinct($select) {
-		if (!is_array($select)) {
-			$select = [$select];
-		}
-
-		$quotedSelect = $this->helper->quoteColumnNames($select);
-
-		$this->queryBuilder->addSelect(
-			'DISTINCT ' . implode(', ', $quotedSelect)
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Adds an item that is to be returned in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id')
-	 *         ->addSelect('p.id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed ...$selects The selection expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function addSelect(...$selects) {
-		if (count($selects) === 1 && is_array($selects[0])) {
-			$selects = $selects[0];
-		}
-
-		$this->queryBuilder->addSelect(
-			$this->helper->quoteColumnNames($selects)
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Turns the query being built into a bulk delete query that ranges over
-	 * a certain table.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->delete('users', 'u')
-	 *         ->where('u.id = :user_id');
-	 *         ->setParameter(':user_id', 1);
-	 * </code>
-	 *
-	 * @param string $delete The table whose rows are subject to the deletion.
-	 * @param string $alias The table alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function delete($delete = null, $alias = null) {
-		$this->queryBuilder->delete(
-			$this->getTableName($delete),
-			$alias
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Turns the query being built into a bulk update query that ranges over
-	 * a certain table
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where('u.id = ?');
-	 * </code>
-	 *
-	 * @param string $update The table whose rows are subject to the update.
-	 * @param string $alias The table alias used in the constructed query.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function update($update = null, $alias = null) {
-		$this->queryBuilder->update(
-			$this->getTableName($update),
-			$alias
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Turns the query being built into an insert query that inserts into
-	 * a certain table
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?',
-	 *                 'password' => '?'
-	 *             )
-	 *         );
-	 * </code>
-	 *
-	 * @param string $insert The table into which the rows should be inserted.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function insert($insert = null) {
-		$this->queryBuilder->insert(
-			$this->getTableName($insert)
-		);
-
-		$this->lastInsertedTable = $insert;
-
-		return $this;
-	}
-
-	/**
-	 * Creates and adds a query root corresponding to the table identified by the
-	 * given alias, forming a cartesian product with any existing query roots.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id')
-	 *         ->from('users', 'u')
-	 * </code>
-	 *
-	 * @param string|IQueryFunction $from The table.
-	 * @param string|null $alias The alias of the table.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function from($from, $alias = null) {
-		$this->queryBuilder->from(
-			$this->getTableName($from),
-			$this->quoteAlias($alias)
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Creates and adds a join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string|ICompositeExpression|null $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function join($fromAlias, $join, $alias, $condition = null) {
-		$this->queryBuilder->join(
-			$this->quoteAlias($fromAlias),
-			$this->getTableName($join),
-			$this->quoteAlias($alias),
-			$condition
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Creates and adds a join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string|ICompositeExpression|null $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function innerJoin($fromAlias, $join, $alias, $condition = null) {
-		$this->queryBuilder->innerJoin(
-			$this->quoteAlias($fromAlias),
-			$this->getTableName($join),
-			$this->quoteAlias($alias),
-			$condition
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Creates and adds a left join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string|ICompositeExpression|null $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function leftJoin($fromAlias, $join, $alias, $condition = null) {
-		$this->queryBuilder->leftJoin(
-			$this->quoteAlias($fromAlias),
-			$this->getTableName($join),
-			$this->quoteAlias($alias),
-			$condition
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Creates and adds a right join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string|ICompositeExpression|null $condition The condition for the join.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function rightJoin($fromAlias, $join, $alias, $condition = null) {
-		$this->queryBuilder->rightJoin(
-			$this->quoteAlias($fromAlias),
-			$this->getTableName($join),
-			$this->quoteAlias($alias),
-			$condition
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Sets a new value for a column in a bulk update query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where('u.id = ?');
-	 * </code>
-	 *
-	 * @param string $key The column to set.
-	 * @param ILiteral|IParameter|IQueryFunction|string $value The value, expression, placeholder, etc.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function set($key, $value) {
-		$this->queryBuilder->set(
-			$this->helper->quoteColumnName($key),
-			$this->helper->quoteColumnName($value)
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Specifies one or more restrictions to the query result.
-	 * Replaces any previously specified restrictions, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = ?');
-	 *
-	 *     // You can optionally programmatically build and/or expressions
-	 *     $qb = $conn->getQueryBuilder();
-	 *
-	 *     $or = $qb->expr()->orx();
-	 *     $or->add($qb->expr()->eq('u.id', 1));
-	 *     $or->add($qb->expr()->eq('u.id', 2));
-	 *
-	 *     $qb->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where($or);
-	 * </code>
-	 *
-	 * @param mixed ...$predicates The restriction predicates.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function where(...$predicates) {
-		if ($this->getQueryPart('where') !== null && $this->systemConfig->getValue('debug', false)) {
-			// Only logging a warning, not throwing for now.
-			$e = new QueryException('Using where() on non-empty WHERE part, please verify it is intentional to not call whereAnd() or whereOr() instead. Otherwise consider creating a new query builder object or call resetQueryPart(\'where\') first.');
-			$this->logger->warning($e->getMessage(), ['exception' => $e]);
-		}
-
-		call_user_func_array(
-			[$this->queryBuilder, 'where'],
-			$predicates
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Adds one or more restrictions to the query results, forming a logical
-	 * conjunction with any previously specified restrictions.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.username LIKE ?')
-	 *         ->andWhere('u.is_active = 1');
-	 * </code>
-	 *
-	 * @param mixed ...$where The query restrictions.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 *
-	 * @see where()
-	 */
-	public function andWhere(...$where) {
-		call_user_func_array(
-			[$this->queryBuilder, 'andWhere'],
-			$where
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Adds one or more restrictions to the query results, forming a logical
-	 * disjunction with any previously specified restrictions.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = 1')
-	 *         ->orWhere('u.id = 2');
-	 * </code>
-	 *
-	 * @param mixed ...$where The WHERE statement.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 *
-	 * @see where()
-	 */
-	public function orWhere(...$where) {
-		call_user_func_array(
-			[$this->queryBuilder, 'orWhere'],
-			$where
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Specifies a grouping over the results of the query.
-	 * Replaces any previously specified groupings, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->groupBy('u.id');
-	 * </code>
-	 *
-	 * @param mixed ...$groupBys The grouping expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function groupBy(...$groupBys) {
-		if (count($groupBys) === 1 && is_array($groupBys[0])) {
-			$groupBys = $groupBys[0];
-		}
-
-		call_user_func_array(
-			[$this->queryBuilder, 'groupBy'],
-			$this->helper->quoteColumnNames($groupBys)
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Adds a grouping expression to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->groupBy('u.lastLogin');
-	 *         ->addGroupBy('u.createdAt')
-	 * </code>
-	 *
-	 * @param mixed ...$groupBy The grouping expression.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function addGroupBy(...$groupBys) {
-		if (count($groupBys) === 1 && is_array($groupBys[0])) {
-			$$groupBys = $groupBys[0];
-		}
-
-		call_user_func_array(
-			[$this->queryBuilder, 'addGroupBy'],
-			$this->helper->quoteColumnNames($groupBys)
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Sets a value for a column in an insert query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?'
-	 *             )
-	 *         )
-	 *         ->setValue('password', '?');
-	 * </code>
-	 *
-	 * @param string $column The column into which the value should be inserted.
-	 * @param IParameter|string $value The value that should be inserted into the column.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function setValue($column, $value) {
-		$this->queryBuilder->setValue(
-			$this->helper->quoteColumnName($column),
-			(string) $value
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Specifies values for an insert query indexed by column names.
-	 * Replaces any previous values, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?',
-	 *                 'password' => '?'
-	 *             )
-	 *         );
-	 * </code>
-	 *
-	 * @param array $values The values to specify for the insert query indexed by column names.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function values(array $values) {
-		$quotedValues = [];
-		foreach ($values as $key => $value) {
-			$quotedValues[$this->helper->quoteColumnName($key)] = $value;
-		}
-
-		$this->queryBuilder->values($quotedValues);
-
-		return $this;
-	}
-
-	/**
-	 * Specifies a restriction over the groups of the query.
-	 * Replaces any previous having restrictions, if any.
-	 *
-	 * @param mixed ...$having The restriction over the groups.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function having(...$having) {
-		call_user_func_array(
-			[$this->queryBuilder, 'having'],
-			$having
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Adds a restriction over the groups of the query, forming a logical
-	 * conjunction with any existing having restrictions.
-	 *
-	 * @param mixed ...$having The restriction to append.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function andHaving(...$having) {
-		call_user_func_array(
-			[$this->queryBuilder, 'andHaving'],
-			$having
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Adds a restriction over the groups of the query, forming a logical
-	 * disjunction with any existing having restrictions.
-	 *
-	 * @param mixed ...$having The restriction to add.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function orHaving(...$having) {
-		call_user_func_array(
-			[$this->queryBuilder, 'orHaving'],
-			$having
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Specifies an ordering for the query results.
-	 * Replaces any previously specified orderings, if any.
-	 *
-	 * @param string|IQueryFunction|ILiteral|IParameter $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function orderBy($sort, $order = null) {
-		$this->queryBuilder->orderBy(
-			$this->helper->quoteColumnName($sort),
-			$order
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Adds an ordering to the query results.
-	 *
-	 * @param string|ILiteral|IParameter|IQueryFunction $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function addOrderBy($sort, $order = null) {
-		$this->queryBuilder->addOrderBy(
-			$this->helper->quoteColumnName($sort),
-			$order
-		);
-
-		return $this;
-	}
-
-	/**
-	 * Gets a query part by its name.
-	 *
-	 * @param string $queryPartName
-	 *
-	 * @return mixed
-	 */
-	public function getQueryPart($queryPartName) {
-		return $this->queryBuilder->getQueryPart($queryPartName);
-	}
-
-	/**
-	 * Gets all query parts.
-	 *
-	 * @return array
-	 */
-	public function getQueryParts() {
-		return $this->queryBuilder->getQueryParts();
-	}
-
-	/**
-	 * Resets SQL parts.
-	 *
-	 * @param array|null $queryPartNames
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function resetQueryParts($queryPartNames = null) {
-		$this->queryBuilder->resetQueryParts($queryPartNames);
-
-		return $this;
-	}
-
-	/**
-	 * Resets a single SQL part.
-	 *
-	 * @param string $queryPartName
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
-	public function resetQueryPart($queryPartName) {
-		$this->queryBuilder->resetQueryPart($queryPartName);
-
-		return $this;
-	}
-
-	/**
-	 * Creates a new named parameter and bind the value $value to it.
-	 *
-	 * This method provides a shortcut for PDOStatement::bindValue
-	 * when using prepared statements.
-	 *
-	 * The parameter $value specifies the value that you want to bind. If
-	 * $placeholder is not provided bindValue() will automatically create a
-	 * placeholder for you. An automatic placeholder will be of the name
-	 * ':dcValue1', ':dcValue2' etc.
-	 *
-	 * For more information see {@link https://www.php.net/pdostatement-bindparam}
-	 *
-	 * Example:
-	 * <code>
-	 * $value = 2;
-	 * $q->eq( 'id', $q->bindValue( $value ) );
-	 * $stmt = $q->executeQuery(); // executed with 'id = 2'
-	 * </code>
-	 *
-	 * @license New BSD License
-	 * @link http://www.zetacomponents.org
-	 *
-	 * @param mixed $value
-	 * @param mixed $type
-	 * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
-	 *
-	 * @return IParameter the placeholder name used.
-	 */
-	public function createNamedParameter($value, $type = IQueryBuilder::PARAM_STR, $placeHolder = null) {
-		return new Parameter($this->queryBuilder->createNamedParameter($value, $type, $placeHolder));
-	}
-
-	/**
-	 * Creates a new positional parameter and bind the given value to it.
-	 *
-	 * Attention: If you are using positional parameters with the query builder you have
-	 * to be very careful to bind all parameters in the order they appear in the SQL
-	 * statement , otherwise they get bound in the wrong order which can lead to serious
-	 * bugs in your code.
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select('u.*')
-	 *     ->from('users', 'u')
-	 *     ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
-	 *     ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
-	 * </code>
-	 *
-	 * @param mixed $value
-	 * @param integer $type
-	 *
-	 * @return IParameter
-	 */
-	public function createPositionalParameter($value, $type = IQueryBuilder::PARAM_STR) {
-		return new Parameter($this->queryBuilder->createPositionalParameter($value, $type));
-	}
-
-	/**
-	 * Creates a new parameter
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select('u.*')
-	 *     ->from('users', 'u')
-	 *     ->where('u.username = ' . $qb->createParameter('name'))
-	 *     ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
-	 * </code>
-	 *
-	 * @param string $name
-	 *
-	 * @return IParameter
-	 */
-	public function createParameter($name) {
-		return new Parameter(':' . $name);
-	}
-
-	/**
-	 * Creates a new function
-	 *
-	 * Attention: Column names inside the call have to be quoted before hand
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select($qb->createFunction('COUNT(*)'))
-	 *     ->from('users', 'u')
-	 *  echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
-	 * </code>
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select($qb->createFunction('COUNT(`column`)'))
-	 *     ->from('users', 'u')
-	 *  echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
-	 * </code>
-	 *
-	 * @param string $call
-	 *
-	 * @return IQueryFunction
-	 */
-	public function createFunction($call) {
-		return new QueryFunction($call);
-	}
-
-	/**
-	 * Used to get the id of the last inserted element
-	 * @return int
-	 * @throws \BadMethodCallException When being called before an insert query has been run.
-	 */
-	public function getLastInsertId(): int {
-		if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::INSERT && $this->lastInsertedTable) {
-			// lastInsertId() needs the prefix but no quotes
-			$table = $this->prefixTableName($this->lastInsertedTable);
-			return $this->connection->lastInsertId($table);
-		}
-
-		throw new \BadMethodCallException('Invalid call to getLastInsertId without using insert() before.');
-	}
-
-	/**
-	 * Returns the table name quoted and with database prefix as needed by the implementation
-	 *
-	 * @param string|IQueryFunction $table
-	 * @return string
-	 */
-	public function getTableName($table) {
-		if ($table instanceof IQueryFunction) {
-			return (string) $table;
-		}
-
-		$table = $this->prefixTableName($table);
-		return $this->helper->quoteColumnName($table);
-	}
-
-	/**
-	 * Returns the table name with database prefix as needed by the implementation
-	 *
-	 * @param string $table
-	 * @return string
-	 */
-	protected function prefixTableName($table) {
-		if ($this->automaticTablePrefix === false || str_starts_with($table, '*PREFIX*')) {
-			return $table;
-		}
-
-		return '*PREFIX*' . $table;
-	}
-
-	/**
-	 * Returns the column name quoted and with table alias prefix as needed by the implementation
-	 *
-	 * @param string $column
-	 * @param string $tableAlias
-	 * @return string
-	 */
-	public function getColumnName($column, $tableAlias = '') {
-		if ($tableAlias !== '') {
-			$tableAlias .= '.';
-		}
-
-		return $this->helper->quoteColumnName($tableAlias . $column);
-	}
-
-	/**
-	 * Returns the column name quoted and with table alias prefix as needed by the implementation
-	 *
-	 * @param string $alias
-	 * @return string
-	 */
-	public function quoteAlias($alias) {
-		if ($alias === '' || $alias === null) {
-			return $alias;
-		}
-
-		return $this->helper->quoteColumnName($alias);
-	}
+    /** @var ConnectionAdapter */
+    private $connection;
+
+    /** @var SystemConfig */
+    private $systemConfig;
+
+    private LoggerInterface $logger;
+
+    /** @var \Doctrine\DBAL\Query\QueryBuilder */
+    private $queryBuilder;
+
+    /** @var QuoteHelper */
+    private $helper;
+
+    /** @var bool */
+    private $automaticTablePrefix = true;
+
+    /** @var string */
+    protected $lastInsertedTable;
+
+    /**
+     * Initializes a new QueryBuilder.
+     *
+     * @param ConnectionAdapter $connection
+     * @param SystemConfig $systemConfig
+     */
+    public function __construct(ConnectionAdapter $connection, SystemConfig $systemConfig, LoggerInterface $logger) {
+        $this->connection = $connection;
+        $this->systemConfig = $systemConfig;
+        $this->logger = $logger;
+        $this->queryBuilder = new \Doctrine\DBAL\Query\QueryBuilder($this->connection->getInner());
+        $this->helper = new QuoteHelper();
+    }
+
+    /**
+     * Enable/disable automatic prefixing of table names with the oc_ prefix
+     *
+     * @param bool $enabled If set to true table names will be prefixed with the
+     * owncloud database prefix automatically.
+     * @since 8.2.0
+     */
+    public function automaticTablePrefix($enabled) {
+        $this->automaticTablePrefix = (bool) $enabled;
+    }
+
+    /**
+     * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
+     * This producer method is intended for convenient inline usage. Example:
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where($qb->expr()->eq('u.id', 1));
+     * </code>
+     *
+     * For more complex expression construction, consider storing the expression
+     * builder object in a local variable.
+     *
+     * @return \OCP\DB\QueryBuilder\IExpressionBuilder
+     */
+    public function expr() {
+        if ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
+            return new OCIExpressionBuilder($this->connection, $this);
+        }
+        if ($this->connection->getDatabasePlatform() instanceof PostgreSQL94Platform) {
+            return new PgSqlExpressionBuilder($this->connection, $this);
+        }
+        if ($this->connection->getDatabasePlatform() instanceof MySQLPlatform) {
+            return new MySqlExpressionBuilder($this->connection, $this);
+        }
+        if ($this->connection->getDatabasePlatform() instanceof SqlitePlatform) {
+            return new SqliteExpressionBuilder($this->connection, $this);
+        }
+
+        return new ExpressionBuilder($this->connection, $this);
+    }
+
+    /**
+     * Gets an FunctionBuilder used for object-oriented construction of query functions.
+     * This producer method is intended for convenient inline usage. Example:
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where($qb->fun()->md5('u.id'));
+     * </code>
+     *
+     * For more complex function construction, consider storing the function
+     * builder object in a local variable.
+     *
+     * @return \OCP\DB\QueryBuilder\IFunctionBuilder
+     */
+    public function func() {
+        if ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
+            return new OCIFunctionBuilder($this->connection, $this, $this->helper);
+        }
+        if ($this->connection->getDatabasePlatform() instanceof SqlitePlatform) {
+            return new SqliteFunctionBuilder($this->connection, $this, $this->helper);
+        }
+        if ($this->connection->getDatabasePlatform() instanceof PostgreSQL94Platform) {
+            return new PgSqlFunctionBuilder($this->connection, $this, $this->helper);
+        }
+
+        return new FunctionBuilder($this->connection, $this, $this->helper);
+    }
+
+    /**
+     * Gets the type of the currently built query.
+     *
+     * @return integer
+     */
+    public function getType() {
+        return $this->queryBuilder->getType();
+    }
+
+    /**
+     * Gets the associated DBAL Connection for this query builder.
+     *
+     * @return \OCP\IDBConnection
+     */
+    public function getConnection() {
+        return $this->connection;
+    }
+
+    /**
+     * Gets the state of this query builder instance.
+     *
+     * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
+     */
+    public function getState() {
+        return $this->queryBuilder->getState();
+    }
+
+    /**
+     * Executes this query using the bound parameters and their types.
+     *
+     * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate}
+     * for insert, update and delete statements.
+     *
+     * @return IResult|int
+     */
+    public function execute() {
+        if ($this->systemConfig->getValue('log_query', false)) {
+            try {
+                $params = [];
+                foreach ($this->getParameters() as $placeholder => $value) {
+                    if ($value instanceof \DateTime) {
+                        $params[] = $placeholder . ' => DateTime:\'' . $value->format('c') . '\'';
+                    } elseif (is_array($value)) {
+                        $params[] = $placeholder . ' => (\'' . implode('\', \'', $value) . '\')';
+                    } else {
+                        $params[] = $placeholder . ' => \'' . $value . '\'';
+                    }
+                }
+                if (empty($params)) {
+                    $this->logger->debug('DB QueryBuilder: \'{query}\'', [
+                        'query' => $this->getSQL(),
+                        'app' => 'core',
+                    ]);
+                } else {
+                    $this->logger->debug('DB QueryBuilder: \'{query}\' with parameters: {params}', [
+                        'query' => $this->getSQL(),
+                        'params' => implode(', ', $params),
+                        'app' => 'core',
+                    ]);
+                }
+            } catch (\Error $e) {
+                // likely an error during conversion of $value to string
+                $this->logger->error('DB QueryBuilder: error trying to log SQL query', ['exception' => $e]);
+            }
+        }
+
+        if (!empty($this->getQueryPart('select'))) {
+            $select = $this->getQueryPart('select');
+            $hasSelectAll = array_filter($select, static function ($s) {
+                return $s === '*';
+            });
+            $hasSelectSpecific = array_filter($select, static function ($s) {
+                return $s !== '*';
+            });
+
+            if (empty($hasSelectAll) === empty($hasSelectSpecific)) {
+                $exception = new QueryException('Query is selecting * and specific values in the same query. This is not supported in Oracle.');
+                $this->logger->error($exception->getMessage(), [
+                    'query' => $this->getSQL(),
+                    'app' => 'core',
+                    'exception' => $exception,
+                ]);
+            }
+        }
+
+        $numberOfParameters = 0;
+        $hasTooLargeArrayParameter = false;
+        foreach ($this->getParameters() as $parameter) {
+            if (is_array($parameter)) {
+                $count = count($parameter);
+                $numberOfParameters += $count;
+                $hasTooLargeArrayParameter = $hasTooLargeArrayParameter || ($count > 1000);
+            }
+        }
+
+        if ($hasTooLargeArrayParameter) {
+            $exception = new QueryException('More than 1000 expressions in a list are not allowed on Oracle.');
+            $this->logger->error($exception->getMessage(), [
+                'query' => $this->getSQL(),
+                'app' => 'core',
+                'exception' => $exception,
+            ]);
+        }
+
+        if ($numberOfParameters > 65535) {
+            $exception = new QueryException('The number of parameters must not exceed 65535. Restriction by PostgreSQL.');
+            $this->logger->error($exception->getMessage(), [
+                'query' => $this->getSQL(),
+                'app' => 'core',
+                'exception' => $exception,
+            ]);
+        }
+
+        $result = $this->queryBuilder->execute();
+        if (is_int($result)) {
+            return $result;
+        }
+        return new ResultAdapter($result);
+    }
+
+    public function executeQuery(): IResult {
+        if ($this->getType() !== \Doctrine\DBAL\Query\QueryBuilder::SELECT) {
+            throw new \RuntimeException('Invalid query type, expected SELECT query');
+        }
+
+        try {
+            $result = $this->execute();
+        } catch (\Doctrine\DBAL\Exception $e) {
+            throw \OC\DB\Exceptions\DbalException::wrap($e);
+        }
+
+        if ($result instanceof IResult) {
+            return $result;
+        }
+
+        throw new \RuntimeException('Invalid return type for query');
+    }
+
+    /**
+     * Monkey-patched compatibility layer for apps that were adapted for Nextcloud 22 before
+     * the first beta, where executeStatement was named executeUpdate.
+     *
+     * Static analysis should catch those misuses, but until then let's try to keep things
+     * running.
+     *
+     * @internal
+     * @deprecated
+     * @todo drop ASAP
+     */
+    public function executeUpdate(): int {
+        return $this->executeStatement();
+    }
+
+    public function executeStatement(): int {
+        if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::SELECT) {
+            throw new \RuntimeException('Invalid query type, expected INSERT, DELETE or UPDATE statement');
+        }
+
+        try {
+            $result = $this->execute();
+        } catch (\Doctrine\DBAL\Exception $e) {
+            throw \OC\DB\Exceptions\DbalException::wrap($e);
+        }
+
+        if (!is_int($result)) {
+            throw new \RuntimeException('Invalid return type for statement');
+        }
+
+        return $result;
+    }
+
+
+    /**
+     * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('User', 'u')
+     *     echo $qb->getSQL(); // SELECT u FROM User u
+     * </code>
+     *
+     * @return string The SQL query string.
+     */
+    public function getSQL() {
+        return $this->queryBuilder->getSQL();
+    }
+
+    /**
+     * Sets a query parameter for the query being constructed.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.id = :user_id')
+     *         ->setParameter(':user_id', 1);
+     * </code>
+     *
+     * @param string|integer $key The parameter position or name.
+     * @param mixed $value The parameter value.
+     * @param string|null|int $type One of the IQueryBuilder::PARAM_* constants.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function setParameter($key, $value, $type = null) {
+        $this->queryBuilder->setParameter($key, $value, $type);
+
+        return $this;
+    }
+
+    /**
+     * Sets a collection of query parameters for the query being constructed.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.id = :user_id1 OR u.id = :user_id2')
+     *         ->setParameters(array(
+     *             ':user_id1' => 1,
+     *             ':user_id2' => 2
+     *         ));
+     * </code>
+     *
+     * @param array $params The query parameters to set.
+     * @param array $types The query parameters types to set.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function setParameters(array $params, array $types = []) {
+        $this->queryBuilder->setParameters($params, $types);
+
+        return $this;
+    }
+
+    /**
+     * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
+     *
+     * @return array The currently defined query parameters indexed by parameter index or name.
+     */
+    public function getParameters() {
+        return $this->queryBuilder->getParameters();
+    }
+
+    /**
+     * Gets a (previously set) query parameter of the query being constructed.
+     *
+     * @param mixed $key The key (index or name) of the bound parameter.
+     *
+     * @return mixed The value of the bound parameter.
+     */
+    public function getParameter($key) {
+        return $this->queryBuilder->getParameter($key);
+    }
+
+    /**
+     * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
+     *
+     * @return array The currently defined query parameter types indexed by parameter index or name.
+     */
+    public function getParameterTypes() {
+        return $this->queryBuilder->getParameterTypes();
+    }
+
+    /**
+     * Gets a (previously set) query parameter type of the query being constructed.
+     *
+     * @param mixed $key The key (index or name) of the bound parameter type.
+     *
+     * @return mixed The value of the bound parameter type.
+     */
+    public function getParameterType($key) {
+        return $this->queryBuilder->getParameterType($key);
+    }
+
+    /**
+     * Sets the position of the first result to retrieve (the "offset").
+     *
+     * @param int $firstResult The first result to return.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function setFirstResult($firstResult) {
+        $this->queryBuilder->setFirstResult((int) $firstResult);
+
+        return $this;
+    }
+
+    /**
+     * Gets the position of the first result the query object was set to retrieve (the "offset").
+     * Returns 0 if {@link setFirstResult} was not applied to this QueryBuilder.
+     *
+     * @return int The position of the first result.
+     */
+    public function getFirstResult() {
+        return $this->queryBuilder->getFirstResult();
+    }
+
+    /**
+     * Sets the maximum number of results to retrieve (the "limit").
+     *
+     * NOTE: Setting max results to "0" will cause mixed behaviour. While most
+     * of the databases will just return an empty result set, Oracle will return
+     * all entries.
+     *
+     * @param int|null $maxResults The maximum number of results to retrieve.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function setMaxResults($maxResults) {
+        if ($maxResults === null) {
+            $this->queryBuilder->setMaxResults($maxResults);
+        } else {
+            $this->queryBuilder->setMaxResults((int) $maxResults);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Gets the maximum number of results the query object was set to retrieve (the "limit").
+     * Returns NULL if {@link setMaxResults} was not applied to this query builder.
+     *
+     * @return int|null The maximum number of results.
+     */
+    public function getMaxResults() {
+        return $this->queryBuilder->getMaxResults();
+    }
+
+    /**
+     * Specifies an item that is to be returned in the query result.
+     * Replaces any previously specified selections, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id', 'p.id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed ...$selects The selection expressions.
+     *
+     * '@return $this This QueryBuilder instance.
+     */
+    public function select(...$selects) {
+        if (count($selects) === 1 && is_array($selects[0])) {
+            $selects = $selects[0];
+        }
+
+        $this->queryBuilder->select(
+            $this->helper->quoteColumnNames($selects)
+        );
+
+        return $this;
+    }
+
+    /**
+     * Specifies an item that is to be returned with a different name in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->selectAlias('u.id', 'user_id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     * @param string $alias The column alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function selectAlias($select, $alias) {
+        $this->queryBuilder->addSelect(
+            $this->helper->quoteColumnName($select) . ' AS ' . $this->helper->quoteColumnName($alias)
+        );
+
+        return $this;
+    }
+
+    /**
+     * Specifies an item that is to be returned uniquely in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->selectDistinct('type')
+     *         ->from('users');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function selectDistinct($select) {
+        if (!is_array($select)) {
+            $select = [$select];
+        }
+
+        $quotedSelect = $this->helper->quoteColumnNames($select);
+
+        $this->queryBuilder->addSelect(
+            'DISTINCT ' . implode(', ', $quotedSelect)
+        );
+
+        return $this;
+    }
+
+    /**
+     * Adds an item that is to be returned in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id')
+     *         ->addSelect('p.id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed ...$selects The selection expression.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function addSelect(...$selects) {
+        if (count($selects) === 1 && is_array($selects[0])) {
+            $selects = $selects[0];
+        }
+
+        $this->queryBuilder->addSelect(
+            $this->helper->quoteColumnNames($selects)
+        );
+
+        return $this;
+    }
+
+    /**
+     * Turns the query being built into a bulk delete query that ranges over
+     * a certain table.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->delete('users', 'u')
+     *         ->where('u.id = :user_id');
+     *         ->setParameter(':user_id', 1);
+     * </code>
+     *
+     * @param string $delete The table whose rows are subject to the deletion.
+     * @param string $alias The table alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function delete($delete = null, $alias = null) {
+        $this->queryBuilder->delete(
+            $this->getTableName($delete),
+            $alias
+        );
+
+        return $this;
+    }
+
+    /**
+     * Turns the query being built into a bulk update query that ranges over
+     * a certain table
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where('u.id = ?');
+     * </code>
+     *
+     * @param string $update The table whose rows are subject to the update.
+     * @param string $alias The table alias used in the constructed query.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function update($update = null, $alias = null) {
+        $this->queryBuilder->update(
+            $this->getTableName($update),
+            $alias
+        );
+
+        return $this;
+    }
+
+    /**
+     * Turns the query being built into an insert query that inserts into
+     * a certain table
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?',
+     *                 'password' => '?'
+     *             )
+     *         );
+     * </code>
+     *
+     * @param string $insert The table into which the rows should be inserted.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function insert($insert = null) {
+        $this->queryBuilder->insert(
+            $this->getTableName($insert)
+        );
+
+        $this->lastInsertedTable = $insert;
+
+        return $this;
+    }
+
+    /**
+     * Creates and adds a query root corresponding to the table identified by the
+     * given alias, forming a cartesian product with any existing query roots.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id')
+     *         ->from('users', 'u')
+     * </code>
+     *
+     * @param string|IQueryFunction $from The table.
+     * @param string|null $alias The alias of the table.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function from($from, $alias = null) {
+        $this->queryBuilder->from(
+            $this->getTableName($from),
+            $this->quoteAlias($alias)
+        );
+
+        return $this;
+    }
+
+    /**
+     * Creates and adds a join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string|ICompositeExpression|null $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function join($fromAlias, $join, $alias, $condition = null) {
+        $this->queryBuilder->join(
+            $this->quoteAlias($fromAlias),
+            $this->getTableName($join),
+            $this->quoteAlias($alias),
+            $condition
+        );
+
+        return $this;
+    }
+
+    /**
+     * Creates and adds a join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string|ICompositeExpression|null $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function innerJoin($fromAlias, $join, $alias, $condition = null) {
+        $this->queryBuilder->innerJoin(
+            $this->quoteAlias($fromAlias),
+            $this->getTableName($join),
+            $this->quoteAlias($alias),
+            $condition
+        );
+
+        return $this;
+    }
+
+    /**
+     * Creates and adds a left join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string|ICompositeExpression|null $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function leftJoin($fromAlias, $join, $alias, $condition = null) {
+        $this->queryBuilder->leftJoin(
+            $this->quoteAlias($fromAlias),
+            $this->getTableName($join),
+            $this->quoteAlias($alias),
+            $condition
+        );
+
+        return $this;
+    }
+
+    /**
+     * Creates and adds a right join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string|ICompositeExpression|null $condition The condition for the join.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function rightJoin($fromAlias, $join, $alias, $condition = null) {
+        $this->queryBuilder->rightJoin(
+            $this->quoteAlias($fromAlias),
+            $this->getTableName($join),
+            $this->quoteAlias($alias),
+            $condition
+        );
+
+        return $this;
+    }
+
+    /**
+     * Sets a new value for a column in a bulk update query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where('u.id = ?');
+     * </code>
+     *
+     * @param string $key The column to set.
+     * @param ILiteral|IParameter|IQueryFunction|string $value The value, expression, placeholder, etc.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function set($key, $value) {
+        $this->queryBuilder->set(
+            $this->helper->quoteColumnName($key),
+            $this->helper->quoteColumnName($value)
+        );
+
+        return $this;
+    }
+
+    /**
+     * Specifies one or more restrictions to the query result.
+     * Replaces any previously specified restrictions, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->where('u.id = ?');
+     *
+     *     // You can optionally programmatically build and/or expressions
+     *     $qb = $conn->getQueryBuilder();
+     *
+     *     $or = $qb->expr()->orx();
+     *     $or->add($qb->expr()->eq('u.id', 1));
+     *     $or->add($qb->expr()->eq('u.id', 2));
+     *
+     *     $qb->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where($or);
+     * </code>
+     *
+     * @param mixed ...$predicates The restriction predicates.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function where(...$predicates) {
+        if ($this->getQueryPart('where') !== null && $this->systemConfig->getValue('debug', false)) {
+            // Only logging a warning, not throwing for now.
+            $e = new QueryException('Using where() on non-empty WHERE part, please verify it is intentional to not call whereAnd() or whereOr() instead. Otherwise consider creating a new query builder object or call resetQueryPart(\'where\') first.');
+            $this->logger->warning($e->getMessage(), ['exception' => $e]);
+        }
+
+        call_user_func_array(
+            [$this->queryBuilder, 'where'],
+            $predicates
+        );
+
+        return $this;
+    }
+
+    /**
+     * Adds one or more restrictions to the query results, forming a logical
+     * conjunction with any previously specified restrictions.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.username LIKE ?')
+     *         ->andWhere('u.is_active = 1');
+     * </code>
+     *
+     * @param mixed ...$where The query restrictions.
+     *
+     * @return $this This QueryBuilder instance.
+     *
+     * @see where()
+     */
+    public function andWhere(...$where) {
+        call_user_func_array(
+            [$this->queryBuilder, 'andWhere'],
+            $where
+        );
+
+        return $this;
+    }
+
+    /**
+     * Adds one or more restrictions to the query results, forming a logical
+     * disjunction with any previously specified restrictions.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->where('u.id = 1')
+     *         ->orWhere('u.id = 2');
+     * </code>
+     *
+     * @param mixed ...$where The WHERE statement.
+     *
+     * @return $this This QueryBuilder instance.
+     *
+     * @see where()
+     */
+    public function orWhere(...$where) {
+        call_user_func_array(
+            [$this->queryBuilder, 'orWhere'],
+            $where
+        );
+
+        return $this;
+    }
+
+    /**
+     * Specifies a grouping over the results of the query.
+     * Replaces any previously specified groupings, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->groupBy('u.id');
+     * </code>
+     *
+     * @param mixed ...$groupBys The grouping expression.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function groupBy(...$groupBys) {
+        if (count($groupBys) === 1 && is_array($groupBys[0])) {
+            $groupBys = $groupBys[0];
+        }
+
+        call_user_func_array(
+            [$this->queryBuilder, 'groupBy'],
+            $this->helper->quoteColumnNames($groupBys)
+        );
+
+        return $this;
+    }
+
+    /**
+     * Adds a grouping expression to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->groupBy('u.lastLogin');
+     *         ->addGroupBy('u.createdAt')
+     * </code>
+     *
+     * @param mixed ...$groupBy The grouping expression.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function addGroupBy(...$groupBys) {
+        if (count($groupBys) === 1 && is_array($groupBys[0])) {
+            $$groupBys = $groupBys[0];
+        }
+
+        call_user_func_array(
+            [$this->queryBuilder, 'addGroupBy'],
+            $this->helper->quoteColumnNames($groupBys)
+        );
+
+        return $this;
+    }
+
+    /**
+     * Sets a value for a column in an insert query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?'
+     *             )
+     *         )
+     *         ->setValue('password', '?');
+     * </code>
+     *
+     * @param string $column The column into which the value should be inserted.
+     * @param IParameter|string $value The value that should be inserted into the column.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function setValue($column, $value) {
+        $this->queryBuilder->setValue(
+            $this->helper->quoteColumnName($column),
+            (string) $value
+        );
+
+        return $this;
+    }
+
+    /**
+     * Specifies values for an insert query indexed by column names.
+     * Replaces any previous values, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?',
+     *                 'password' => '?'
+     *             )
+     *         );
+     * </code>
+     *
+     * @param array $values The values to specify for the insert query indexed by column names.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function values(array $values) {
+        $quotedValues = [];
+        foreach ($values as $key => $value) {
+            $quotedValues[$this->helper->quoteColumnName($key)] = $value;
+        }
+
+        $this->queryBuilder->values($quotedValues);
+
+        return $this;
+    }
+
+    /**
+     * Specifies a restriction over the groups of the query.
+     * Replaces any previous having restrictions, if any.
+     *
+     * @param mixed ...$having The restriction over the groups.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function having(...$having) {
+        call_user_func_array(
+            [$this->queryBuilder, 'having'],
+            $having
+        );
+
+        return $this;
+    }
+
+    /**
+     * Adds a restriction over the groups of the query, forming a logical
+     * conjunction with any existing having restrictions.
+     *
+     * @param mixed ...$having The restriction to append.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function andHaving(...$having) {
+        call_user_func_array(
+            [$this->queryBuilder, 'andHaving'],
+            $having
+        );
+
+        return $this;
+    }
+
+    /**
+     * Adds a restriction over the groups of the query, forming a logical
+     * disjunction with any existing having restrictions.
+     *
+     * @param mixed ...$having The restriction to add.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function orHaving(...$having) {
+        call_user_func_array(
+            [$this->queryBuilder, 'orHaving'],
+            $having
+        );
+
+        return $this;
+    }
+
+    /**
+     * Specifies an ordering for the query results.
+     * Replaces any previously specified orderings, if any.
+     *
+     * @param string|IQueryFunction|ILiteral|IParameter $sort The ordering expression.
+     * @param string $order The ordering direction.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function orderBy($sort, $order = null) {
+        $this->queryBuilder->orderBy(
+            $this->helper->quoteColumnName($sort),
+            $order
+        );
+
+        return $this;
+    }
+
+    /**
+     * Adds an ordering to the query results.
+     *
+     * @param string|ILiteral|IParameter|IQueryFunction $sort The ordering expression.
+     * @param string $order The ordering direction.
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function addOrderBy($sort, $order = null) {
+        $this->queryBuilder->addOrderBy(
+            $this->helper->quoteColumnName($sort),
+            $order
+        );
+
+        return $this;
+    }
+
+    /**
+     * Gets a query part by its name.
+     *
+     * @param string $queryPartName
+     *
+     * @return mixed
+     */
+    public function getQueryPart($queryPartName) {
+        return $this->queryBuilder->getQueryPart($queryPartName);
+    }
+
+    /**
+     * Gets all query parts.
+     *
+     * @return array
+     */
+    public function getQueryParts() {
+        return $this->queryBuilder->getQueryParts();
+    }
+
+    /**
+     * Resets SQL parts.
+     *
+     * @param array|null $queryPartNames
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function resetQueryParts($queryPartNames = null) {
+        $this->queryBuilder->resetQueryParts($queryPartNames);
+
+        return $this;
+    }
+
+    /**
+     * Resets a single SQL part.
+     *
+     * @param string $queryPartName
+     *
+     * @return $this This QueryBuilder instance.
+     */
+    public function resetQueryPart($queryPartName) {
+        $this->queryBuilder->resetQueryPart($queryPartName);
+
+        return $this;
+    }
+
+    /**
+     * Creates a new named parameter and bind the value $value to it.
+     *
+     * This method provides a shortcut for PDOStatement::bindValue
+     * when using prepared statements.
+     *
+     * The parameter $value specifies the value that you want to bind. If
+     * $placeholder is not provided bindValue() will automatically create a
+     * placeholder for you. An automatic placeholder will be of the name
+     * ':dcValue1', ':dcValue2' etc.
+     *
+     * For more information see {@link https://www.php.net/pdostatement-bindparam}
+     *
+     * Example:
+     * <code>
+     * $value = 2;
+     * $q->eq( 'id', $q->bindValue( $value ) );
+     * $stmt = $q->executeQuery(); // executed with 'id = 2'
+     * </code>
+     *
+     * @license New BSD License
+     * @link http://www.zetacomponents.org
+     *
+     * @param mixed $value
+     * @param mixed $type
+     * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
+     *
+     * @return IParameter the placeholder name used.
+     */
+    public function createNamedParameter($value, $type = IQueryBuilder::PARAM_STR, $placeHolder = null) {
+        return new Parameter($this->queryBuilder->createNamedParameter($value, $type, $placeHolder));
+    }
+
+    /**
+     * Creates a new positional parameter and bind the given value to it.
+     *
+     * Attention: If you are using positional parameters with the query builder you have
+     * to be very careful to bind all parameters in the order they appear in the SQL
+     * statement , otherwise they get bound in the wrong order which can lead to serious
+     * bugs in your code.
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select('u.*')
+     *     ->from('users', 'u')
+     *     ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
+     *     ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
+     * </code>
+     *
+     * @param mixed $value
+     * @param integer $type
+     *
+     * @return IParameter
+     */
+    public function createPositionalParameter($value, $type = IQueryBuilder::PARAM_STR) {
+        return new Parameter($this->queryBuilder->createPositionalParameter($value, $type));
+    }
+
+    /**
+     * Creates a new parameter
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select('u.*')
+     *     ->from('users', 'u')
+     *     ->where('u.username = ' . $qb->createParameter('name'))
+     *     ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
+     * </code>
+     *
+     * @param string $name
+     *
+     * @return IParameter
+     */
+    public function createParameter($name) {
+        return new Parameter(':' . $name);
+    }
+
+    /**
+     * Creates a new function
+     *
+     * Attention: Column names inside the call have to be quoted before hand
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select($qb->createFunction('COUNT(*)'))
+     *     ->from('users', 'u')
+     *  echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
+     * </code>
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select($qb->createFunction('COUNT(`column`)'))
+     *     ->from('users', 'u')
+     *  echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
+     * </code>
+     *
+     * @param string $call
+     *
+     * @return IQueryFunction
+     */
+    public function createFunction($call) {
+        return new QueryFunction($call);
+    }
+
+    /**
+     * Used to get the id of the last inserted element
+     * @return int
+     * @throws \BadMethodCallException When being called before an insert query has been run.
+     */
+    public function getLastInsertId(): int {
+        if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::INSERT && $this->lastInsertedTable) {
+            // lastInsertId() needs the prefix but no quotes
+            $table = $this->prefixTableName($this->lastInsertedTable);
+            return $this->connection->lastInsertId($table);
+        }
+
+        throw new \BadMethodCallException('Invalid call to getLastInsertId without using insert() before.');
+    }
+
+    /**
+     * Returns the table name quoted and with database prefix as needed by the implementation
+     *
+     * @param string|IQueryFunction $table
+     * @return string
+     */
+    public function getTableName($table) {
+        if ($table instanceof IQueryFunction) {
+            return (string) $table;
+        }
+
+        $table = $this->prefixTableName($table);
+        return $this->helper->quoteColumnName($table);
+    }
+
+    /**
+     * Returns the table name with database prefix as needed by the implementation
+     *
+     * @param string $table
+     * @return string
+     */
+    protected function prefixTableName($table) {
+        if ($this->automaticTablePrefix === false || str_starts_with($table, '*PREFIX*')) {
+            return $table;
+        }
+
+        return '*PREFIX*' . $table;
+    }
+
+    /**
+     * Returns the column name quoted and with table alias prefix as needed by the implementation
+     *
+     * @param string $column
+     * @param string $tableAlias
+     * @return string
+     */
+    public function getColumnName($column, $tableAlias = '') {
+        if ($tableAlias !== '') {
+            $tableAlias .= '.';
+        }
+
+        return $this->helper->quoteColumnName($tableAlias . $column);
+    }
+
+    /**
+     * Returns the column name quoted and with table alias prefix as needed by the implementation
+     *
+     * @param string $alias
+     * @return string
+     */
+    public function quoteAlias($alias) {
+        if ($alias === '' || $alias === null) {
+            return $alias;
+        }
+
+        return $this->helper->quoteColumnName($alias);
+    }
 }

lib/private/DB/MySqlTools.php

Indentation +33 added lines, -33 removed lines

@@ -29,41 +29,41 @@
  * Various MySQL specific helper functions.
  */
 class MySqlTools {
-	/**
-	 * @param IDBConnection $connection
-	 * @return bool
-	 */
-	public function supports4ByteCharset(IDBConnection $connection) {
-		$variables = ['innodb_file_per_table' => 'ON'];
-		if (!$this->isMariaDBWithLargePrefix($connection)) {
-			$variables['innodb_file_format'] = 'Barracuda';
-			$variables['innodb_large_prefix'] = 'ON';
-		}
+    /**
+     * @param IDBConnection $connection
+     * @return bool
+     */
+    public function supports4ByteCharset(IDBConnection $connection) {
+        $variables = ['innodb_file_per_table' => 'ON'];
+        if (!$this->isMariaDBWithLargePrefix($connection)) {
+            $variables['innodb_file_format'] = 'Barracuda';
+            $variables['innodb_large_prefix'] = 'ON';
+        }
 
-		foreach ($variables as $var => $val) {
-			$result = $connection->executeQuery("SHOW VARIABLES LIKE '$var'");
-			$row = $result->fetch();
-			$result->closeCursor();
-			if ($row === false) {
-				return false;
-			}
-			if (strcasecmp($row['Value'], $val) !== 0) {
-				return false;
-			}
-		}
-		return true;
-	}
+        foreach ($variables as $var => $val) {
+            $result = $connection->executeQuery("SHOW VARIABLES LIKE '$var'");
+            $row = $result->fetch();
+            $result->closeCursor();
+            if ($row === false) {
+                return false;
+            }
+            if (strcasecmp($row['Value'], $val) !== 0) {
+                return false;
+            }
+        }
+        return true;
+    }
 
-	protected function isMariaDBWithLargePrefix(IDBConnection $connection) {
-		$result = $connection->executeQuery('SELECT VERSION()');
-		$row = strtolower($result->fetchColumn());
-		$result->closeCursor();
+    protected function isMariaDBWithLargePrefix(IDBConnection $connection) {
+        $result = $connection->executeQuery('SELECT VERSION()');
+        $row = strtolower($result->fetchColumn());
+        $result->closeCursor();
 
-		if ($row === false) {
-			return false;
-		}
+        if ($row === false) {
+            return false;
+        }
 
-		return str_contains($row, 'maria') && version_compare($row, '10.3', '>=') ||
-			!str_contains($row, 'maria') && version_compare($row, '8.0', '>=');
-	}
+        return str_contains($row, 'maria') && version_compare($row, '10.3', '>=') ||
+            !str_contains($row, 'maria') && version_compare($row, '8.0', '>=');
+    }
 }