nextcloud / server

apps/files_sharing/lib/Cache.php

Indentation +159 added lines, -159 removed lines

@@ -46,163 +46,163 @@
  * don't use this class directly if you need to get metadata, use \OC\Files\Filesystem::getFileInfo instead
  */
 class Cache extends CacheJail {
-	/** @var \OCA\Files_Sharing\SharedStorage */
-	private $storage;
-	/** @var ICacheEntry */
-	private $sourceRootInfo;
-	/** @var IUserManager */
-	private $userManager;
-
-	private $rootUnchanged = true;
-
-	private $ownerDisplayName;
-
-	private $numericId;
-
-	/**
-	 * @param \OCA\Files_Sharing\SharedStorage $storage
-	 */
-	public function __construct($storage, ICacheEntry $sourceRootInfo, IUserManager $userManager) {
-		$this->storage = $storage;
-		$this->sourceRootInfo = $sourceRootInfo;
-		$this->userManager = $userManager;
-		$this->numericId = $sourceRootInfo->getStorageId();
-
-		parent::__construct(
-			null,
-			''
-		);
-	}
-
-	protected function getRoot() {
-		if ($this->root === '') {
-			$absoluteRoot = $this->sourceRootInfo->getPath();
-
-			// the sourceRootInfo path is the absolute path of the folder in the "real" storage
-			// in the case where a folder is shared from a Jail we need to ensure that the share Jail
-			// has it's root set relative to the source Jail
-			$currentStorage = $this->storage->getSourceStorage();
-			if ($currentStorage->instanceOfStorage(Jail::class)) {
-				/** @var Jail $currentStorage */
-				$absoluteRoot = $currentStorage->getJailedPath($absoluteRoot);
-			}
-			$this->root = $absoluteRoot;
-		}
-		return $this->root;
-	}
-
-	protected function getGetUnjailedRoot() {
-		return $this->sourceRootInfo->getPath();
-	}
-
-	public function getCache() {
-		if (is_null($this->cache)) {
-			$sourceStorage = $this->storage->getSourceStorage();
-			if ($sourceStorage) {
-				$this->cache = $sourceStorage->getCache();
-			} else {
-				// don't set $this->cache here since sourceStorage will be set later
-				return new FailedCache();
-			}
-		}
-		return $this->cache;
-	}
-
-	public function getNumericStorageId() {
-		if (isset($this->numericId)) {
-			return $this->numericId;
-		} else {
-			return false;
-		}
-	}
-
-	public function get($file) {
-		if ($this->rootUnchanged && ($file === '' || $file === $this->sourceRootInfo->getId())) {
-			return $this->formatCacheEntry(clone $this->sourceRootInfo, '');
-		}
-		return parent::get($file);
-	}
-
-	public function update($id, array $data) {
-		$this->rootUnchanged = false;
-		parent::update($id, $data);
-	}
-
-	public function insert($file, array $data) {
-		$this->rootUnchanged = false;
-		return parent::insert($file, $data);
-	}
-
-	public function remove($file) {
-		$this->rootUnchanged = false;
-		parent::remove($file);
-	}
-
-	public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
-		$this->rootUnchanged = false;
-		return parent::moveFromCache($sourceCache, $sourcePath, $targetPath);
-	}
-
-	protected function formatCacheEntry($entry, $path = null) {
-		if (is_null($path)) {
-			$path = $entry['path'] ?? '';
-			$entry['path'] = $this->getJailedPath($path);
-		} else {
-			$entry['path'] = $path;
-		}
-
-		try {
-			if (isset($entry['permissions'])) {
-				$entry['permissions'] &= $this->storage->getShare()->getPermissions();
-			} else {
-				$entry['permissions'] = $this->storage->getPermissions($entry['path']);
-			}
-		} catch (StorageNotAvailableException $e) {
-			// thrown by FailedStorage e.g. when the sharer does not exist anymore
-			// (IDE may say the exception is never thrown – false negative)
-			$sharePermissions = 0;
-		}
-		$entry['uid_owner'] = $this->storage->getOwner('');
-		$entry['displayname_owner'] = $this->getOwnerDisplayName();
-		if ($path === '') {
-			$entry['is_share_mount_point'] = true;
-		}
-		return $entry;
-	}
-
-	private function getOwnerDisplayName() {
-		if (!$this->ownerDisplayName) {
-			$uid = $this->storage->getOwner('');
-			$user = $this->userManager->get($uid);
-			if ($user) {
-				$this->ownerDisplayName = $user->getDisplayName();
-			} else {
-				$this->ownerDisplayName = $uid;
-			}
-		}
-		return $this->ownerDisplayName;
-	}
-
-	/**
-	 * remove all entries for files that are stored on the storage from the cache
-	 */
-	public function clear() {
-		// Not a valid action for Shared Cache
-	}
-
-	public function getQueryFilterForStorage(): ISearchOperator {
-		// Do the normal jail behavior for non files
-		if ($this->storage->getItemType() !== 'file') {
-			return parent::getQueryFilterForStorage();
-		}
-
-		// for single file shares we don't need to do the LIKE
-		return new SearchBinaryOperator(
-			ISearchBinaryOperator::OPERATOR_AND,
-			[
-				\OC\Files\Cache\Cache::getQueryFilterForStorage(),
-				new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'path', $this->getGetUnjailedRoot()),
-			]
-		);
-	}
+    /** @var \OCA\Files_Sharing\SharedStorage */
+    private $storage;
+    /** @var ICacheEntry */
+    private $sourceRootInfo;
+    /** @var IUserManager */
+    private $userManager;
+
+    private $rootUnchanged = true;
+
+    private $ownerDisplayName;
+
+    private $numericId;
+
+    /**
+     * @param \OCA\Files_Sharing\SharedStorage $storage
+     */
+    public function __construct($storage, ICacheEntry $sourceRootInfo, IUserManager $userManager) {
+        $this->storage = $storage;
+        $this->sourceRootInfo = $sourceRootInfo;
+        $this->userManager = $userManager;
+        $this->numericId = $sourceRootInfo->getStorageId();
+
+        parent::__construct(
+            null,
+            ''
+        );
+    }
+
+    protected function getRoot() {
+        if ($this->root === '') {
+            $absoluteRoot = $this->sourceRootInfo->getPath();
+
+            // the sourceRootInfo path is the absolute path of the folder in the "real" storage
+            // in the case where a folder is shared from a Jail we need to ensure that the share Jail
+            // has it's root set relative to the source Jail
+            $currentStorage = $this->storage->getSourceStorage();
+            if ($currentStorage->instanceOfStorage(Jail::class)) {
+                /** @var Jail $currentStorage */
+                $absoluteRoot = $currentStorage->getJailedPath($absoluteRoot);
+            }
+            $this->root = $absoluteRoot;
+        }
+        return $this->root;
+    }
+
+    protected function getGetUnjailedRoot() {
+        return $this->sourceRootInfo->getPath();
+    }
+
+    public function getCache() {
+        if (is_null($this->cache)) {
+            $sourceStorage = $this->storage->getSourceStorage();
+            if ($sourceStorage) {
+                $this->cache = $sourceStorage->getCache();
+            } else {
+                // don't set $this->cache here since sourceStorage will be set later
+                return new FailedCache();
+            }
+        }
+        return $this->cache;
+    }
+
+    public function getNumericStorageId() {
+        if (isset($this->numericId)) {
+            return $this->numericId;
+        } else {
+            return false;
+        }
+    }
+
+    public function get($file) {
+        if ($this->rootUnchanged && ($file === '' || $file === $this->sourceRootInfo->getId())) {
+            return $this->formatCacheEntry(clone $this->sourceRootInfo, '');
+        }
+        return parent::get($file);
+    }
+
+    public function update($id, array $data) {
+        $this->rootUnchanged = false;
+        parent::update($id, $data);
+    }
+
+    public function insert($file, array $data) {
+        $this->rootUnchanged = false;
+        return parent::insert($file, $data);
+    }
+
+    public function remove($file) {
+        $this->rootUnchanged = false;
+        parent::remove($file);
+    }
+
+    public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
+        $this->rootUnchanged = false;
+        return parent::moveFromCache($sourceCache, $sourcePath, $targetPath);
+    }
+
+    protected function formatCacheEntry($entry, $path = null) {
+        if (is_null($path)) {
+            $path = $entry['path'] ?? '';
+            $entry['path'] = $this->getJailedPath($path);
+        } else {
+            $entry['path'] = $path;
+        }
+
+        try {
+            if (isset($entry['permissions'])) {
+                $entry['permissions'] &= $this->storage->getShare()->getPermissions();
+            } else {
+                $entry['permissions'] = $this->storage->getPermissions($entry['path']);
+            }
+        } catch (StorageNotAvailableException $e) {
+            // thrown by FailedStorage e.g. when the sharer does not exist anymore
+            // (IDE may say the exception is never thrown – false negative)
+            $sharePermissions = 0;
+        }
+        $entry['uid_owner'] = $this->storage->getOwner('');
+        $entry['displayname_owner'] = $this->getOwnerDisplayName();
+        if ($path === '') {
+            $entry['is_share_mount_point'] = true;
+        }
+        return $entry;
+    }
+
+    private function getOwnerDisplayName() {
+        if (!$this->ownerDisplayName) {
+            $uid = $this->storage->getOwner('');
+            $user = $this->userManager->get($uid);
+            if ($user) {
+                $this->ownerDisplayName = $user->getDisplayName();
+            } else {
+                $this->ownerDisplayName = $uid;
+            }
+        }
+        return $this->ownerDisplayName;
+    }
+
+    /**
+     * remove all entries for files that are stored on the storage from the cache
+     */
+    public function clear() {
+        // Not a valid action for Shared Cache
+    }
+
+    public function getQueryFilterForStorage(): ISearchOperator {
+        // Do the normal jail behavior for non files
+        if ($this->storage->getItemType() !== 'file') {
+            return parent::getQueryFilterForStorage();
+        }
+
+        // for single file shares we don't need to do the LIKE
+        return new SearchBinaryOperator(
+            ISearchBinaryOperator::OPERATOR_AND,
+            [
+                \OC\Files\Cache\Cache::getQueryFilterForStorage(),
+                new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'path', $this->getGetUnjailedRoot()),
+            ]
+        );
+    }
 }

apps/files_sharing/lib/SharedStorage.php

Indentation +468 added lines, -468 removed lines

@@ -52,472 +52,472 @@
  */
 class SharedStorage extends \OC\Files\Storage\Wrapper\Jail implements ISharedStorage, IDisableEncryptionStorage {
 
-	/** @var \OCP\Share\IShare */
-	private $superShare;
-
-	/** @var \OCP\Share\IShare[] */
-	private $groupedShares;
-
-	/**
-	 * @var \OC\Files\View
-	 */
-	private $ownerView;
-
-	private $initialized = false;
-
-	/**
-	 * @var ICacheEntry
-	 */
-	private $sourceRootInfo;
-
-	/** @var string */
-	private $user;
-
-	/**
-	 * @var \OCP\ILogger
-	 */
-	private $logger;
-
-	/** @var  IStorage */
-	private $nonMaskedStorage;
-
-	private $options;
-
-	/** @var boolean */
-	private $sharingDisabledForUser;
-
-	public function __construct($arguments) {
-		$this->ownerView = $arguments['ownerView'];
-		$this->logger = \OC::$server->getLogger();
-
-		$this->superShare = $arguments['superShare'];
-		$this->groupedShares = $arguments['groupedShares'];
-
-		$this->user = $arguments['user'];
-		if (isset($arguments['sharingDisabledForUser'])) {
-			$this->sharingDisabledForUser = $arguments['sharingDisabledForUser'];
-		} else {
-			$this->sharingDisabledForUser = false;
-		}
-
-		parent::__construct([
-			'storage' => null,
-			'root' => null,
-		]);
-	}
-
-	/**
-	 * @return ICacheEntry
-	 */
-	private function getSourceRootInfo() {
-		if (is_null($this->sourceRootInfo)) {
-			if (is_null($this->superShare->getNodeCacheEntry())) {
-				$this->init();
-				$this->sourceRootInfo = $this->nonMaskedStorage->getCache()->get($this->rootPath);
-			} else {
-				$this->sourceRootInfo = $this->superShare->getNodeCacheEntry();
-			}
-		}
-		return $this->sourceRootInfo;
-	}
-
-	private function init() {
-		if ($this->initialized) {
-			return;
-		}
-		$this->initialized = true;
-		try {
-			Filesystem::initMountPoints($this->superShare->getShareOwner());
-			$storageId = $this->superShare->getNodeCacheEntry() ? $this->superShare->getNodeCacheEntry()->getStorageId() : null;
-			$sourcePath = $this->ownerView->getPath($this->superShare->getNodeId(), $storageId);
-			[$this->nonMaskedStorage, $this->rootPath] = $this->ownerView->resolvePath($sourcePath);
-			$this->storage = new PermissionsMask([
-				'storage' => $this->nonMaskedStorage,
-				'mask' => $this->superShare->getPermissions(),
-			]);
-		} catch (NotFoundException $e) {
-			// original file not accessible or deleted, set FailedStorage
-			$this->storage = new FailedStorage(['exception' => $e]);
-			$this->cache = new FailedCache();
-			$this->rootPath = '';
-		} catch (NoUserException $e) {
-			// sharer user deleted, set FailedStorage
-			$this->storage = new FailedStorage(['exception' => $e]);
-			$this->cache = new FailedCache();
-			$this->rootPath = '';
-		} catch (\Exception $e) {
-			$this->storage = new FailedStorage(['exception' => $e]);
-			$this->cache = new FailedCache();
-			$this->rootPath = '';
-			$this->logger->logException($e);
-		}
-
-		if (!$this->nonMaskedStorage) {
-			$this->nonMaskedStorage = $this->storage;
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function instanceOfStorage($class): bool {
-		if ($class === '\OC\Files\Storage\Common') {
-			return true;
-		}
-		if (in_array($class, ['\OC\Files\Storage\Home', '\OC\Files\ObjectStore\HomeObjectStoreStorage', '\OCP\Files\IHomeStorage'])) {
-			return false;
-		}
-		return parent::instanceOfStorage($class);
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getShareId() {
-		return $this->superShare->getId();
-	}
-
-	private function isValid(): bool {
-		return $this->getSourceRootInfo() && ($this->getSourceRootInfo()->getPermissions() & Constants::PERMISSION_SHARE) === Constants::PERMISSION_SHARE;
-	}
-
-	/**
-	 * get id of the mount point
-	 *
-	 * @return string
-	 */
-	public function getId(): string {
-		return 'shared::' . $this->getMountPoint();
-	}
-
-	/**
-	 * Get the permissions granted for a shared file
-	 *
-	 * @param string $target Shared target file path
-	 * @return int CRUDS permissions granted
-	 */
-	public function getPermissions($target = ''): int {
-		if (!$this->isValid()) {
-			return 0;
-		}
-		$permissions = parent::getPermissions($target) & $this->superShare->getPermissions();
-
-		// part files and the mount point always have delete permissions
-		if ($target === '' || pathinfo($target, PATHINFO_EXTENSION) === 'part') {
-			$permissions |= \OCP\Constants::PERMISSION_DELETE;
-		}
-
-		if ($this->sharingDisabledForUser) {
-			$permissions &= ~\OCP\Constants::PERMISSION_SHARE;
-		}
-
-		return $permissions;
-	}
-
-	public function isCreatable($path): bool {
-		return (bool)($this->getPermissions($path) & \OCP\Constants::PERMISSION_CREATE);
-	}
-
-	public function isReadable($path): bool {
-		if (!$this->isValid()) {
-			return false;
-		}
-		if (!$this->file_exists($path)) {
-			return false;
-		}
-		/** @var IStorage $storage */
-		/** @var string $internalPath */
-		[$storage, $internalPath] = $this->resolvePath($path);
-		return $storage->isReadable($internalPath);
-	}
-
-	public function isUpdatable($path): bool {
-		return (bool)($this->getPermissions($path) & \OCP\Constants::PERMISSION_UPDATE);
-	}
-
-	public function isDeletable($path): bool {
-		return (bool)($this->getPermissions($path) & \OCP\Constants::PERMISSION_DELETE);
-	}
-
-	public function isSharable($path): bool {
-		if (\OCP\Util::isSharingDisabledForUser() || !\OC\Share\Share::isResharingAllowed()) {
-			return false;
-		}
-		return (bool)($this->getPermissions($path) & \OCP\Constants::PERMISSION_SHARE);
-	}
-
-	public function fopen($path, $mode) {
-		$source = $this->getUnjailedPath($path);
-		switch ($mode) {
-			case 'r+':
-			case 'rb+':
-			case 'w+':
-			case 'wb+':
-			case 'x+':
-			case 'xb+':
-			case 'a+':
-			case 'ab+':
-			case 'w':
-			case 'wb':
-			case 'x':
-			case 'xb':
-			case 'a':
-			case 'ab':
-				$creatable = $this->isCreatable(dirname($path));
-				$updatable = $this->isUpdatable($path);
-				// if neither permissions given, no need to continue
-				if (!$creatable && !$updatable) {
-					if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
-						$updatable = $this->isUpdatable(dirname($path));
-					}
-
-					if (!$updatable) {
-						return false;
-					}
-				}
-
-				$exists = $this->file_exists($path);
-				// if a file exists, updatable permissions are required
-				if ($exists && !$updatable) {
-					return false;
-				}
-
-				// part file is allowed if !$creatable but the final file is $updatable
-				if (pathinfo($path, PATHINFO_EXTENSION) !== 'part') {
-					if (!$exists && !$creatable) {
-						return false;
-					}
-				}
-		}
-		$info = [
-			'target' => $this->getMountPoint() . '/' . $path,
-			'source' => $source,
-			'mode' => $mode,
-		];
-		\OCP\Util::emitHook('\OC\Files\Storage\Shared', 'fopen', $info);
-		return $this->nonMaskedStorage->fopen($this->getUnjailedPath($path), $mode);
-	}
-
-	/**
-	 * see https://www.php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2): bool {
-		$this->init();
-		$isPartFile = pathinfo($path1, PATHINFO_EXTENSION) === 'part';
-		$targetExists = $this->file_exists($path2);
-		$sameFolder = dirname($path1) === dirname($path2);
-
-		if ($targetExists || ($sameFolder && !$isPartFile)) {
-			if (!$this->isUpdatable('')) {
-				return false;
-			}
-		} else {
-			if (!$this->isCreatable('')) {
-				return false;
-			}
-		}
-
-		return $this->nonMaskedStorage->rename($this->getUnjailedPath($path1), $this->getUnjailedPath($path2));
-	}
-
-	/**
-	 * return mount point of share, relative to data/user/files
-	 *
-	 * @return string
-	 */
-	public function getMountPoint(): string {
-		return $this->superShare->getTarget();
-	}
-
-	/**
-	 * @param string $path
-	 */
-	public function setMountPoint($path): void {
-		$this->superShare->setTarget($path);
-
-		foreach ($this->groupedShares as $share) {
-			$share->setTarget($path);
-		}
-	}
-
-	/**
-	 * get the user who shared the file
-	 *
-	 * @return string
-	 */
-	public function getSharedFrom(): string {
-		return $this->superShare->getShareOwner();
-	}
-
-	/**
-	 * @return \OCP\Share\IShare
-	 */
-	public function getShare(): IShare {
-		return $this->superShare;
-	}
-
-	/**
-	 * return share type, can be "file" or "folder"
-	 *
-	 * @return string
-	 */
-	public function getItemType(): string {
-		return $this->superShare->getNodeType();
-	}
-
-	/**
-	 * @param string $path
-	 * @param null $storage
-	 * @return Cache
-	 */
-	public function getCache($path = '', $storage = null) {
-		if ($this->cache) {
-			return $this->cache;
-		}
-		if (!$storage) {
-			$storage = $this;
-		}
-		$sourceRoot = $this->getSourceRootInfo();
-		if ($this->storage instanceof FailedStorage) {
-			return new FailedCache();
-		}
-
-		$this->cache = new \OCA\Files_Sharing\Cache(
-			$storage,
-			$sourceRoot,
-			\OC::$server->get(IUserManager::class)
-		);
-		return $this->cache;
-	}
-
-	public function getScanner($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return new \OCA\Files_Sharing\Scanner($storage);
-	}
-
-	public function getOwner($path): string {
-		return $this->superShare->getShareOwner();
-	}
-
-	public function getWatcher($path = '', $storage = null): NullWatcher {
-		// cache updating is handled by the share source
-		return new NullWatcher();
-	}
-
-	/**
-	 * unshare complete storage, also the grouped shares
-	 *
-	 * @return bool
-	 */
-	public function unshareStorage(): bool {
-		foreach ($this->groupedShares as $share) {
-			\OC::$server->getShareManager()->deleteFromSelf($share, $this->user);
-		}
-		return true;
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider) {
-		/** @var \OCP\Files\Storage $targetStorage */
-		[$targetStorage, $targetInternalPath] = $this->resolvePath($path);
-		$targetStorage->acquireLock($targetInternalPath, $type, $provider);
-		// lock the parent folders of the owner when locking the share as recipient
-		if ($path === '') {
-			$sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
-			$this->ownerView->lockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider) {
-		/** @var \OCP\Files\Storage $targetStorage */
-		[$targetStorage, $targetInternalPath] = $this->resolvePath($path);
-		$targetStorage->releaseLock($targetInternalPath, $type, $provider);
-		// unlock the parent folders of the owner when unlocking the share as recipient
-		if ($path === '') {
-			$sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
-			$this->ownerView->unlockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider) {
-		/** @var \OCP\Files\Storage $targetStorage */
-		[$targetStorage, $targetInternalPath] = $this->resolvePath($path);
-		$targetStorage->changeLock($targetInternalPath, $type, $provider);
-	}
-
-	/**
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability() {
-		// shares do not participate in availability logic
-		return [
-			'available' => true,
-			'last_checked' => 0,
-		];
-	}
-
-	/**
-	 * @param bool $available
-	 */
-	public function setAvailability($available) {
-		// shares do not participate in availability logic
-	}
-
-	public function getSourceStorage() {
-		$this->init();
-		return $this->nonMaskedStorage;
-	}
-
-	public function getWrapperStorage() {
-		$this->init();
-		return $this->storage;
-	}
-
-	public function file_get_contents($path) {
-		$info = [
-			'target' => $this->getMountPoint() . '/' . $path,
-			'source' => $this->getUnjailedPath($path),
-		];
-		\OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_get_contents', $info);
-		return parent::file_get_contents($path);
-	}
-
-	public function file_put_contents($path, $data) {
-		$info = [
-			'target' => $this->getMountPoint() . '/' . $path,
-			'source' => $this->getUnjailedPath($path),
-		];
-		\OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_put_contents', $info);
-		return parent::file_put_contents($path, $data);
-	}
-
-	public function setMountOptions(array $options) {
-		$this->mountOptions = $options;
-	}
-
-	public function getUnjailedPath($path) {
-		$this->init();
-		return parent::getUnjailedPath($path);
-	}
+    /** @var \OCP\Share\IShare */
+    private $superShare;
+
+    /** @var \OCP\Share\IShare[] */
+    private $groupedShares;
+
+    /**
+     * @var \OC\Files\View
+     */
+    private $ownerView;
+
+    private $initialized = false;
+
+    /**
+     * @var ICacheEntry
+     */
+    private $sourceRootInfo;
+
+    /** @var string */
+    private $user;
+
+    /**
+     * @var \OCP\ILogger
+     */
+    private $logger;
+
+    /** @var  IStorage */
+    private $nonMaskedStorage;
+
+    private $options;
+
+    /** @var boolean */
+    private $sharingDisabledForUser;
+
+    public function __construct($arguments) {
+        $this->ownerView = $arguments['ownerView'];
+        $this->logger = \OC::$server->getLogger();
+
+        $this->superShare = $arguments['superShare'];
+        $this->groupedShares = $arguments['groupedShares'];
+
+        $this->user = $arguments['user'];
+        if (isset($arguments['sharingDisabledForUser'])) {
+            $this->sharingDisabledForUser = $arguments['sharingDisabledForUser'];
+        } else {
+            $this->sharingDisabledForUser = false;
+        }
+
+        parent::__construct([
+            'storage' => null,
+            'root' => null,
+        ]);
+    }
+
+    /**
+     * @return ICacheEntry
+     */
+    private function getSourceRootInfo() {
+        if (is_null($this->sourceRootInfo)) {
+            if (is_null($this->superShare->getNodeCacheEntry())) {
+                $this->init();
+                $this->sourceRootInfo = $this->nonMaskedStorage->getCache()->get($this->rootPath);
+            } else {
+                $this->sourceRootInfo = $this->superShare->getNodeCacheEntry();
+            }
+        }
+        return $this->sourceRootInfo;
+    }
+
+    private function init() {
+        if ($this->initialized) {
+            return;
+        }
+        $this->initialized = true;
+        try {
+            Filesystem::initMountPoints($this->superShare->getShareOwner());
+            $storageId = $this->superShare->getNodeCacheEntry() ? $this->superShare->getNodeCacheEntry()->getStorageId() : null;
+            $sourcePath = $this->ownerView->getPath($this->superShare->getNodeId(), $storageId);
+            [$this->nonMaskedStorage, $this->rootPath] = $this->ownerView->resolvePath($sourcePath);
+            $this->storage = new PermissionsMask([
+                'storage' => $this->nonMaskedStorage,
+                'mask' => $this->superShare->getPermissions(),
+            ]);
+        } catch (NotFoundException $e) {
+            // original file not accessible or deleted, set FailedStorage
+            $this->storage = new FailedStorage(['exception' => $e]);
+            $this->cache = new FailedCache();
+            $this->rootPath = '';
+        } catch (NoUserException $e) {
+            // sharer user deleted, set FailedStorage
+            $this->storage = new FailedStorage(['exception' => $e]);
+            $this->cache = new FailedCache();
+            $this->rootPath = '';
+        } catch (\Exception $e) {
+            $this->storage = new FailedStorage(['exception' => $e]);
+            $this->cache = new FailedCache();
+            $this->rootPath = '';
+            $this->logger->logException($e);
+        }
+
+        if (!$this->nonMaskedStorage) {
+            $this->nonMaskedStorage = $this->storage;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function instanceOfStorage($class): bool {
+        if ($class === '\OC\Files\Storage\Common') {
+            return true;
+        }
+        if (in_array($class, ['\OC\Files\Storage\Home', '\OC\Files\ObjectStore\HomeObjectStoreStorage', '\OCP\Files\IHomeStorage'])) {
+            return false;
+        }
+        return parent::instanceOfStorage($class);
+    }
+
+    /**
+     * @return string
+     */
+    public function getShareId() {
+        return $this->superShare->getId();
+    }
+
+    private function isValid(): bool {
+        return $this->getSourceRootInfo() && ($this->getSourceRootInfo()->getPermissions() & Constants::PERMISSION_SHARE) === Constants::PERMISSION_SHARE;
+    }
+
+    /**
+     * get id of the mount point
+     *
+     * @return string
+     */
+    public function getId(): string {
+        return 'shared::' . $this->getMountPoint();
+    }
+
+    /**
+     * Get the permissions granted for a shared file
+     *
+     * @param string $target Shared target file path
+     * @return int CRUDS permissions granted
+     */
+    public function getPermissions($target = ''): int {
+        if (!$this->isValid()) {
+            return 0;
+        }
+        $permissions = parent::getPermissions($target) & $this->superShare->getPermissions();
+
+        // part files and the mount point always have delete permissions
+        if ($target === '' || pathinfo($target, PATHINFO_EXTENSION) === 'part') {
+            $permissions |= \OCP\Constants::PERMISSION_DELETE;
+        }
+
+        if ($this->sharingDisabledForUser) {
+            $permissions &= ~\OCP\Constants::PERMISSION_SHARE;
+        }
+
+        return $permissions;
+    }
+
+    public function isCreatable($path): bool {
+        return (bool)($this->getPermissions($path) & \OCP\Constants::PERMISSION_CREATE);
+    }
+
+    public function isReadable($path): bool {
+        if (!$this->isValid()) {
+            return false;
+        }
+        if (!$this->file_exists($path)) {
+            return false;
+        }
+        /** @var IStorage $storage */
+        /** @var string $internalPath */
+        [$storage, $internalPath] = $this->resolvePath($path);
+        return $storage->isReadable($internalPath);
+    }
+
+    public function isUpdatable($path): bool {
+        return (bool)($this->getPermissions($path) & \OCP\Constants::PERMISSION_UPDATE);
+    }
+
+    public function isDeletable($path): bool {
+        return (bool)($this->getPermissions($path) & \OCP\Constants::PERMISSION_DELETE);
+    }
+
+    public function isSharable($path): bool {
+        if (\OCP\Util::isSharingDisabledForUser() || !\OC\Share\Share::isResharingAllowed()) {
+            return false;
+        }
+        return (bool)($this->getPermissions($path) & \OCP\Constants::PERMISSION_SHARE);
+    }
+
+    public function fopen($path, $mode) {
+        $source = $this->getUnjailedPath($path);
+        switch ($mode) {
+            case 'r+':
+            case 'rb+':
+            case 'w+':
+            case 'wb+':
+            case 'x+':
+            case 'xb+':
+            case 'a+':
+            case 'ab+':
+            case 'w':
+            case 'wb':
+            case 'x':
+            case 'xb':
+            case 'a':
+            case 'ab':
+                $creatable = $this->isCreatable(dirname($path));
+                $updatable = $this->isUpdatable($path);
+                // if neither permissions given, no need to continue
+                if (!$creatable && !$updatable) {
+                    if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
+                        $updatable = $this->isUpdatable(dirname($path));
+                    }
+
+                    if (!$updatable) {
+                        return false;
+                    }
+                }
+
+                $exists = $this->file_exists($path);
+                // if a file exists, updatable permissions are required
+                if ($exists && !$updatable) {
+                    return false;
+                }
+
+                // part file is allowed if !$creatable but the final file is $updatable
+                if (pathinfo($path, PATHINFO_EXTENSION) !== 'part') {
+                    if (!$exists && !$creatable) {
+                        return false;
+                    }
+                }
+        }
+        $info = [
+            'target' => $this->getMountPoint() . '/' . $path,
+            'source' => $source,
+            'mode' => $mode,
+        ];
+        \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'fopen', $info);
+        return $this->nonMaskedStorage->fopen($this->getUnjailedPath($path), $mode);
+    }
+
+    /**
+     * see https://www.php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2): bool {
+        $this->init();
+        $isPartFile = pathinfo($path1, PATHINFO_EXTENSION) === 'part';
+        $targetExists = $this->file_exists($path2);
+        $sameFolder = dirname($path1) === dirname($path2);
+
+        if ($targetExists || ($sameFolder && !$isPartFile)) {
+            if (!$this->isUpdatable('')) {
+                return false;
+            }
+        } else {
+            if (!$this->isCreatable('')) {
+                return false;
+            }
+        }
+
+        return $this->nonMaskedStorage->rename($this->getUnjailedPath($path1), $this->getUnjailedPath($path2));
+    }
+
+    /**
+     * return mount point of share, relative to data/user/files
+     *
+     * @return string
+     */
+    public function getMountPoint(): string {
+        return $this->superShare->getTarget();
+    }
+
+    /**
+     * @param string $path
+     */
+    public function setMountPoint($path): void {
+        $this->superShare->setTarget($path);
+
+        foreach ($this->groupedShares as $share) {
+            $share->setTarget($path);
+        }
+    }
+
+    /**
+     * get the user who shared the file
+     *
+     * @return string
+     */
+    public function getSharedFrom(): string {
+        return $this->superShare->getShareOwner();
+    }
+
+    /**
+     * @return \OCP\Share\IShare
+     */
+    public function getShare(): IShare {
+        return $this->superShare;
+    }
+
+    /**
+     * return share type, can be "file" or "folder"
+     *
+     * @return string
+     */
+    public function getItemType(): string {
+        return $this->superShare->getNodeType();
+    }
+
+    /**
+     * @param string $path
+     * @param null $storage
+     * @return Cache
+     */
+    public function getCache($path = '', $storage = null) {
+        if ($this->cache) {
+            return $this->cache;
+        }
+        if (!$storage) {
+            $storage = $this;
+        }
+        $sourceRoot = $this->getSourceRootInfo();
+        if ($this->storage instanceof FailedStorage) {
+            return new FailedCache();
+        }
+
+        $this->cache = new \OCA\Files_Sharing\Cache(
+            $storage,
+            $sourceRoot,
+            \OC::$server->get(IUserManager::class)
+        );
+        return $this->cache;
+    }
+
+    public function getScanner($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return new \OCA\Files_Sharing\Scanner($storage);
+    }
+
+    public function getOwner($path): string {
+        return $this->superShare->getShareOwner();
+    }
+
+    public function getWatcher($path = '', $storage = null): NullWatcher {
+        // cache updating is handled by the share source
+        return new NullWatcher();
+    }
+
+    /**
+     * unshare complete storage, also the grouped shares
+     *
+     * @return bool
+     */
+    public function unshareStorage(): bool {
+        foreach ($this->groupedShares as $share) {
+            \OC::$server->getShareManager()->deleteFromSelf($share, $this->user);
+        }
+        return true;
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider) {
+        /** @var \OCP\Files\Storage $targetStorage */
+        [$targetStorage, $targetInternalPath] = $this->resolvePath($path);
+        $targetStorage->acquireLock($targetInternalPath, $type, $provider);
+        // lock the parent folders of the owner when locking the share as recipient
+        if ($path === '') {
+            $sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
+            $this->ownerView->lockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider) {
+        /** @var \OCP\Files\Storage $targetStorage */
+        [$targetStorage, $targetInternalPath] = $this->resolvePath($path);
+        $targetStorage->releaseLock($targetInternalPath, $type, $provider);
+        // unlock the parent folders of the owner when unlocking the share as recipient
+        if ($path === '') {
+            $sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
+            $this->ownerView->unlockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function changeLock($path, $type, ILockingProvider $provider) {
+        /** @var \OCP\Files\Storage $targetStorage */
+        [$targetStorage, $targetInternalPath] = $this->resolvePath($path);
+        $targetStorage->changeLock($targetInternalPath, $type, $provider);
+    }
+
+    /**
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability() {
+        // shares do not participate in availability logic
+        return [
+            'available' => true,
+            'last_checked' => 0,
+        ];
+    }
+
+    /**
+     * @param bool $available
+     */
+    public function setAvailability($available) {
+        // shares do not participate in availability logic
+    }
+
+    public function getSourceStorage() {
+        $this->init();
+        return $this->nonMaskedStorage;
+    }
+
+    public function getWrapperStorage() {
+        $this->init();
+        return $this->storage;
+    }
+
+    public function file_get_contents($path) {
+        $info = [
+            'target' => $this->getMountPoint() . '/' . $path,
+            'source' => $this->getUnjailedPath($path),
+        ];
+        \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_get_contents', $info);
+        return parent::file_get_contents($path);
+    }
+
+    public function file_put_contents($path, $data) {
+        $info = [
+            'target' => $this->getMountPoint() . '/' . $path,
+            'source' => $this->getUnjailedPath($path),
+        ];
+        \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_put_contents', $info);
+        return parent::file_put_contents($path, $data);
+    }
+
+    public function setMountOptions(array $options) {
+        $this->mountOptions = $options;
+    }
+
+    public function getUnjailedPath($path) {
+        $this->init();
+        return parent::getUnjailedPath($path);
+    }
 }

lib/private/TemplateLayout.php

Indentation +332 added lines, -332 removed lines

@@ -57,336 +57,336 @@
 use OCP\Util;
 
 class TemplateLayout extends \OC_Template {
-	private static $versionHash = '';
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var IInitialStateService */
-	private $initialState;
-
-	/** @var INavigationManager */
-	private $navigationManager;
-
-	/**
-	 * @param string $renderAs
-	 * @param string $appId application id
-	 */
-	public function __construct($renderAs, $appId = '') {
-
-		/** @var IConfig */
-		$this->config = \OC::$server->get(IConfig::class);
-
-		/** @var IInitialStateService */
-		$this->initialState = \OC::$server->get(IInitialStateService::class);
-
-		if (\OC_Util::isIe()) {
-			Util::addStyle('ie');
-		}
-
-		// Decide which page we show
-		if ($renderAs === TemplateResponse::RENDER_AS_USER) {
-			/** @var INavigationManager */
-			$this->navigationManager = \OC::$server->get(INavigationManager::class);
-
-			parent::__construct('core', 'layout.user');
-			if (in_array(\OC_App::getCurrentApp(), ['settings','admin', 'help']) !== false) {
-				$this->assign('bodyid', 'body-settings');
-			} else {
-				$this->assign('bodyid', 'body-user');
-			}
-
-			$this->initialState->provideInitialState('core', 'active-app', $this->navigationManager->getActiveEntry());
-			$this->initialState->provideInitialState('unified-search', 'limit-default', SearchQuery::LIMIT_DEFAULT);
-			Util::addScript('dist/unified-search', null, true);
-
-			// Add navigation entry
-			$this->assign('application', '');
-			$this->assign('appid', $appId);
-
-			$navigation = $this->navigationManager->getAll();
-			$this->assign('navigation', $navigation);
-			$settingsNavigation = $this->navigationManager->getAll('settings');
-			$this->assign('settingsnavigation', $settingsNavigation);
-
-			foreach ($navigation as $entry) {
-				if ($entry['active']) {
-					$this->assign('application', $entry['name']);
-					break;
-				}
-			}
-
-			foreach ($settingsNavigation as $entry) {
-				if ($entry['active']) {
-					$this->assign('application', $entry['name']);
-					break;
-				}
-			}
-
-			$userDisplayName = false;
-			$user = \OC::$server->get(IUserSession::class)->getUser();
-			if ($user) {
-				$userDisplayName = $user->getDisplayName();
-			}
-			$this->assign('user_displayname', $userDisplayName);
-			$this->assign('user_uid', \OC_User::getUser());
-
-			if (\OC_User::getUser() === false) {
-				$this->assign('userAvatarSet', false);
-			} else {
-				$this->assign('userAvatarSet', true);
-				$this->assign('userAvatarVersion', $this->config->getUserValue(\OC_User::getUser(), 'avatar', 'version', 0));
-			}
-
-			// check if app menu icons should be inverted
-			try {
-				/** @var \OCA\Theming\Util $util */
-				$util = \OC::$server->query(\OCA\Theming\Util::class);
-				$this->assign('themingInvertMenu', $util->invertTextColor(\OC::$server->getThemingDefaults()->getColorPrimary()));
-			} catch (\OCP\AppFramework\QueryException $e) {
-				$this->assign('themingInvertMenu', false);
-			} catch (\OCP\AutoloadNotAllowedException $e) {
-				$this->assign('themingInvertMenu', false);
-			}
-		} elseif ($renderAs === TemplateResponse::RENDER_AS_ERROR) {
-			parent::__construct('core', 'layout.guest', '', false);
-			$this->assign('bodyid', 'body-login');
-			$this->assign('user_displayname', '');
-			$this->assign('user_uid', '');
-		} elseif ($renderAs === TemplateResponse::RENDER_AS_GUEST) {
-			parent::__construct('core', 'layout.guest');
-			\OC_Util::addStyle('guest');
-			$this->assign('bodyid', 'body-login');
-
-			$userDisplayName = false;
-			$user = \OC::$server->get(IUserSession::class)->getUser();
-			if ($user) {
-				$userDisplayName = $user->getDisplayName();
-			}
-			$this->assign('user_displayname', $userDisplayName);
-			$this->assign('user_uid', \OC_User::getUser());
-		} elseif ($renderAs === TemplateResponse::RENDER_AS_PUBLIC) {
-			parent::__construct('core', 'layout.public');
-			$this->assign('appid', $appId);
-			$this->assign('bodyid', 'body-public');
-
-			/** @var IRegistry $subscription */
-			$subscription = \OC::$server->query(IRegistry::class);
-			$showSimpleSignup = $this->config->getSystemValueBool('simpleSignUpLink.shown', true);
-			if ($showSimpleSignup && $subscription->delegateHasValidSubscription()) {
-				$showSimpleSignup = false;
-			}
-			$this->assign('showSimpleSignUpLink', $showSimpleSignup);
-		} else {
-			parent::__construct('core', 'layout.base');
-		}
-		// Send the language and the locale to our layouts
-		$lang = \OC::$server->getL10NFactory()->findLanguage();
-		$locale = \OC::$server->getL10NFactory()->findLocale($lang);
-
-		$lang = str_replace('_', '-', $lang);
-		$this->assign('language', $lang);
-		$this->assign('locale', $locale);
-
-		if (\OC::$server->getSystemConfig()->getValue('installed', false)) {
-			if (empty(self::$versionHash)) {
-				$v = \OC_App::getAppVersions();
-				$v['core'] = implode('.', \OCP\Util::getVersion());
-				self::$versionHash = substr(md5(implode(',', $v)), 0, 8);
-			}
-		} else {
-			self::$versionHash = md5('not installed');
-		}
-
-		// Add the js files
-		$jsFiles = self::findJavascriptFiles(\OC_Util::$scripts);
-		$this->assign('jsfiles', []);
-		if ($this->config->getSystemValue('installed', false) && $renderAs != TemplateResponse::RENDER_AS_ERROR) {
-			// this is on purpose outside of the if statement below so that the initial state is prefilled (done in the getConfig() call)
-			// see https://github.com/nextcloud/server/pull/22636 for details
-			$jsConfigHelper = new JSConfigHelper(
-				\OC::$server->getL10N('lib'),
-				\OC::$server->query(Defaults::class),
-				\OC::$server->getAppManager(),
-				\OC::$server->getSession(),
-				\OC::$server->getUserSession()->getUser(),
-				$this->config,
-				\OC::$server->getGroupManager(),
-				\OC::$server->get(IniGetWrapper::class),
-				\OC::$server->getURLGenerator(),
-				\OC::$server->getCapabilitiesManager(),
-				\OC::$server->query(IInitialStateService::class)
-			);
-			$config = $jsConfigHelper->getConfig();
-			if (\OC::$server->getContentSecurityPolicyNonceManager()->browserSupportsCspV3()) {
-				$this->assign('inline_ocjs', $config);
-			} else {
-				$this->append('jsfiles', \OC::$server->getURLGenerator()->linkToRoute('core.OCJS.getConfig', ['v' => self::$versionHash]));
-			}
-		}
-		foreach ($jsFiles as $info) {
-			$web = $info[1];
-			$file = $info[2];
-			$this->append('jsfiles', $web.'/'.$file . $this->getVersionHashSuffix());
-		}
-
-		try {
-			$pathInfo = \OC::$server->getRequest()->getPathInfo();
-		} catch (\Exception $e) {
-			$pathInfo = '';
-		}
-
-		// Do not initialise scss appdata until we have a fully installed instance
-		// Do not load scss for update, errors, installation or login page
-		if (\OC::$server->getSystemConfig()->getValue('installed', false)
-			&& !\OCP\Util::needUpgrade()
-			&& $pathInfo !== ''
-			&& !preg_match('/^\/login/', $pathInfo)
-			&& $renderAs !== TemplateResponse::RENDER_AS_ERROR
-		) {
-			$cssFiles = self::findStylesheetFiles(\OC_Util::$styles);
-		} else {
-			// If we ignore the scss compiler,
-			// we need to load the guest css fallback
-			\OC_Util::addStyle('guest');
-			$cssFiles = self::findStylesheetFiles(\OC_Util::$styles, false);
-		}
-
-		$this->assign('cssfiles', []);
-		$this->assign('printcssfiles', []);
-		$this->assign('versionHash', self::$versionHash);
-		foreach ($cssFiles as $info) {
-			$web = $info[1];
-			$file = $info[2];
-
-			if (substr($file, -strlen('print.css')) === 'print.css') {
-				$this->append('printcssfiles', $web.'/'.$file . $this->getVersionHashSuffix());
-			} else {
-				$suffix = $this->getVersionHashSuffix($web, $file);
-
-				if (strpos($file, '?v=') == false) {
-					$this->append('cssfiles', $web.'/'.$file . $suffix);
-				} else {
-					$this->append('cssfiles', $web.'/'.$file . '-' . substr($suffix, 3));
-				}
-			}
-		}
-
-		$this->assign('initialStates', $this->initialState->getInitialStates());
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $file
-	 * @return string
-	 */
-	protected function getVersionHashSuffix($path = false, $file = false) {
-		if ($this->config->getSystemValue('debug', false)) {
-			// allows chrome workspace mapping in debug mode
-			return "";
-		}
-		$themingSuffix = '';
-		$v = [];
-
-		if ($this->config->getSystemValue('installed', false)) {
-			if (\OC::$server->getAppManager()->isInstalled('theming')) {
-				$themingSuffix = '-' . $this->config->getAppValue('theming', 'cachebuster', '0');
-			}
-			$v = \OC_App::getAppVersions();
-		}
-
-		// Try the webroot path for a match
-		if ($path !== false && $path !== '') {
-			$appName = $this->getAppNamefromPath($path);
-			if (array_key_exists($appName, $v)) {
-				$appVersion = $v[$appName];
-				return '?v=' . substr(md5($appVersion), 0, 8) . $themingSuffix;
-			}
-		}
-		// fallback to the file path instead
-		if ($file !== false && $file !== '') {
-			$appName = $this->getAppNamefromPath($file);
-			if (array_key_exists($appName, $v)) {
-				$appVersion = $v[$appName];
-				return '?v=' . substr(md5($appVersion), 0, 8) . $themingSuffix;
-			}
-		}
-
-		return '?v=' . self::$versionHash . $themingSuffix;
-	}
-
-	/**
-	 * @param array $styles
-	 * @return array
-	 */
-	public static function findStylesheetFiles($styles, $compileScss = true) {
-		// Read the selected theme from the config file
-		$theme = \OC_Util::getTheme();
-
-		if ($compileScss) {
-			$SCSSCacher = \OC::$server->query(SCSSCacher::class);
-		} else {
-			$SCSSCacher = null;
-		}
-
-		$locator = new \OC\Template\CSSResourceLocator(
-			\OC::$server->getLogger(),
-			$theme,
-			[ \OC::$SERVERROOT => \OC::$WEBROOT ],
-			[ \OC::$SERVERROOT => \OC::$WEBROOT ],
-			$SCSSCacher
-		);
-		$locator->find($styles);
-		return $locator->getResources();
-	}
-
-	/**
-	 * @param string $path
-	 * @return string|boolean
-	 */
-	public function getAppNamefromPath($path) {
-		if ($path !== '' && is_string($path)) {
-			$pathParts = explode('/', $path);
-			if ($pathParts[0] === 'css') {
-				// This is a scss request
-				return $pathParts[1];
-			}
-			return end($pathParts);
-		}
-		return false;
-	}
-
-	/**
-	 * @param array $scripts
-	 * @return array
-	 */
-	public static function findJavascriptFiles($scripts) {
-		// Read the selected theme from the config file
-		$theme = \OC_Util::getTheme();
-
-		$locator = new \OC\Template\JSResourceLocator(
-			\OC::$server->getLogger(),
-			$theme,
-			[ \OC::$SERVERROOT => \OC::$WEBROOT ],
-			[ \OC::$SERVERROOT => \OC::$WEBROOT ],
-			\OC::$server->query(JSCombiner::class)
-			);
-		$locator->find($scripts);
-		return $locator->getResources();
-	}
-
-	/**
-	 * Converts the absolute file path to a relative path from \OC::$SERVERROOT
-	 * @param string $filePath Absolute path
-	 * @return string Relative path
-	 * @throws \Exception If $filePath is not under \OC::$SERVERROOT
-	 */
-	public static function convertToRelativePath($filePath) {
-		$relativePath = explode(\OC::$SERVERROOT, $filePath);
-		if (count($relativePath) !== 2) {
-			throw new \Exception('$filePath is not under the \OC::$SERVERROOT');
-		}
-
-		return $relativePath[1];
-	}
+    private static $versionHash = '';
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var IInitialStateService */
+    private $initialState;
+
+    /** @var INavigationManager */
+    private $navigationManager;
+
+    /**
+     * @param string $renderAs
+     * @param string $appId application id
+     */
+    public function __construct($renderAs, $appId = '') {
+
+        /** @var IConfig */
+        $this->config = \OC::$server->get(IConfig::class);
+
+        /** @var IInitialStateService */
+        $this->initialState = \OC::$server->get(IInitialStateService::class);
+
+        if (\OC_Util::isIe()) {
+            Util::addStyle('ie');
+        }
+
+        // Decide which page we show
+        if ($renderAs === TemplateResponse::RENDER_AS_USER) {
+            /** @var INavigationManager */
+            $this->navigationManager = \OC::$server->get(INavigationManager::class);
+
+            parent::__construct('core', 'layout.user');
+            if (in_array(\OC_App::getCurrentApp(), ['settings','admin', 'help']) !== false) {
+                $this->assign('bodyid', 'body-settings');
+            } else {
+                $this->assign('bodyid', 'body-user');
+            }
+
+            $this->initialState->provideInitialState('core', 'active-app', $this->navigationManager->getActiveEntry());
+            $this->initialState->provideInitialState('unified-search', 'limit-default', SearchQuery::LIMIT_DEFAULT);
+            Util::addScript('dist/unified-search', null, true);
+
+            // Add navigation entry
+            $this->assign('application', '');
+            $this->assign('appid', $appId);
+
+            $navigation = $this->navigationManager->getAll();
+            $this->assign('navigation', $navigation);
+            $settingsNavigation = $this->navigationManager->getAll('settings');
+            $this->assign('settingsnavigation', $settingsNavigation);
+
+            foreach ($navigation as $entry) {
+                if ($entry['active']) {
+                    $this->assign('application', $entry['name']);
+                    break;
+                }
+            }
+
+            foreach ($settingsNavigation as $entry) {
+                if ($entry['active']) {
+                    $this->assign('application', $entry['name']);
+                    break;
+                }
+            }
+
+            $userDisplayName = false;
+            $user = \OC::$server->get(IUserSession::class)->getUser();
+            if ($user) {
+                $userDisplayName = $user->getDisplayName();
+            }
+            $this->assign('user_displayname', $userDisplayName);
+            $this->assign('user_uid', \OC_User::getUser());
+
+            if (\OC_User::getUser() === false) {
+                $this->assign('userAvatarSet', false);
+            } else {
+                $this->assign('userAvatarSet', true);
+                $this->assign('userAvatarVersion', $this->config->getUserValue(\OC_User::getUser(), 'avatar', 'version', 0));
+            }
+
+            // check if app menu icons should be inverted
+            try {
+                /** @var \OCA\Theming\Util $util */
+                $util = \OC::$server->query(\OCA\Theming\Util::class);
+                $this->assign('themingInvertMenu', $util->invertTextColor(\OC::$server->getThemingDefaults()->getColorPrimary()));
+            } catch (\OCP\AppFramework\QueryException $e) {
+                $this->assign('themingInvertMenu', false);
+            } catch (\OCP\AutoloadNotAllowedException $e) {
+                $this->assign('themingInvertMenu', false);
+            }
+        } elseif ($renderAs === TemplateResponse::RENDER_AS_ERROR) {
+            parent::__construct('core', 'layout.guest', '', false);
+            $this->assign('bodyid', 'body-login');
+            $this->assign('user_displayname', '');
+            $this->assign('user_uid', '');
+        } elseif ($renderAs === TemplateResponse::RENDER_AS_GUEST) {
+            parent::__construct('core', 'layout.guest');
+            \OC_Util::addStyle('guest');
+            $this->assign('bodyid', 'body-login');
+
+            $userDisplayName = false;
+            $user = \OC::$server->get(IUserSession::class)->getUser();
+            if ($user) {
+                $userDisplayName = $user->getDisplayName();
+            }
+            $this->assign('user_displayname', $userDisplayName);
+            $this->assign('user_uid', \OC_User::getUser());
+        } elseif ($renderAs === TemplateResponse::RENDER_AS_PUBLIC) {
+            parent::__construct('core', 'layout.public');
+            $this->assign('appid', $appId);
+            $this->assign('bodyid', 'body-public');
+
+            /** @var IRegistry $subscription */
+            $subscription = \OC::$server->query(IRegistry::class);
+            $showSimpleSignup = $this->config->getSystemValueBool('simpleSignUpLink.shown', true);
+            if ($showSimpleSignup && $subscription->delegateHasValidSubscription()) {
+                $showSimpleSignup = false;
+            }
+            $this->assign('showSimpleSignUpLink', $showSimpleSignup);
+        } else {
+            parent::__construct('core', 'layout.base');
+        }
+        // Send the language and the locale to our layouts
+        $lang = \OC::$server->getL10NFactory()->findLanguage();
+        $locale = \OC::$server->getL10NFactory()->findLocale($lang);
+
+        $lang = str_replace('_', '-', $lang);
+        $this->assign('language', $lang);
+        $this->assign('locale', $locale);
+
+        if (\OC::$server->getSystemConfig()->getValue('installed', false)) {
+            if (empty(self::$versionHash)) {
+                $v = \OC_App::getAppVersions();
+                $v['core'] = implode('.', \OCP\Util::getVersion());
+                self::$versionHash = substr(md5(implode(',', $v)), 0, 8);
+            }
+        } else {
+            self::$versionHash = md5('not installed');
+        }
+
+        // Add the js files
+        $jsFiles = self::findJavascriptFiles(\OC_Util::$scripts);
+        $this->assign('jsfiles', []);
+        if ($this->config->getSystemValue('installed', false) && $renderAs != TemplateResponse::RENDER_AS_ERROR) {
+            // this is on purpose outside of the if statement below so that the initial state is prefilled (done in the getConfig() call)
+            // see https://github.com/nextcloud/server/pull/22636 for details
+            $jsConfigHelper = new JSConfigHelper(
+                \OC::$server->getL10N('lib'),
+                \OC::$server->query(Defaults::class),
+                \OC::$server->getAppManager(),
+                \OC::$server->getSession(),
+                \OC::$server->getUserSession()->getUser(),
+                $this->config,
+                \OC::$server->getGroupManager(),
+                \OC::$server->get(IniGetWrapper::class),
+                \OC::$server->getURLGenerator(),
+                \OC::$server->getCapabilitiesManager(),
+                \OC::$server->query(IInitialStateService::class)
+            );
+            $config = $jsConfigHelper->getConfig();
+            if (\OC::$server->getContentSecurityPolicyNonceManager()->browserSupportsCspV3()) {
+                $this->assign('inline_ocjs', $config);
+            } else {
+                $this->append('jsfiles', \OC::$server->getURLGenerator()->linkToRoute('core.OCJS.getConfig', ['v' => self::$versionHash]));
+            }
+        }
+        foreach ($jsFiles as $info) {
+            $web = $info[1];
+            $file = $info[2];
+            $this->append('jsfiles', $web.'/'.$file . $this->getVersionHashSuffix());
+        }
+
+        try {
+            $pathInfo = \OC::$server->getRequest()->getPathInfo();
+        } catch (\Exception $e) {
+            $pathInfo = '';
+        }
+
+        // Do not initialise scss appdata until we have a fully installed instance
+        // Do not load scss for update, errors, installation or login page
+        if (\OC::$server->getSystemConfig()->getValue('installed', false)
+            && !\OCP\Util::needUpgrade()
+            && $pathInfo !== ''
+            && !preg_match('/^\/login/', $pathInfo)
+            && $renderAs !== TemplateResponse::RENDER_AS_ERROR
+        ) {
+            $cssFiles = self::findStylesheetFiles(\OC_Util::$styles);
+        } else {
+            // If we ignore the scss compiler,
+            // we need to load the guest css fallback
+            \OC_Util::addStyle('guest');
+            $cssFiles = self::findStylesheetFiles(\OC_Util::$styles, false);
+        }
+
+        $this->assign('cssfiles', []);
+        $this->assign('printcssfiles', []);
+        $this->assign('versionHash', self::$versionHash);
+        foreach ($cssFiles as $info) {
+            $web = $info[1];
+            $file = $info[2];
+
+            if (substr($file, -strlen('print.css')) === 'print.css') {
+                $this->append('printcssfiles', $web.'/'.$file . $this->getVersionHashSuffix());
+            } else {
+                $suffix = $this->getVersionHashSuffix($web, $file);
+
+                if (strpos($file, '?v=') == false) {
+                    $this->append('cssfiles', $web.'/'.$file . $suffix);
+                } else {
+                    $this->append('cssfiles', $web.'/'.$file . '-' . substr($suffix, 3));
+                }
+            }
+        }
+
+        $this->assign('initialStates', $this->initialState->getInitialStates());
+    }
+
+    /**
+     * @param string $path
+     * @param string $file
+     * @return string
+     */
+    protected function getVersionHashSuffix($path = false, $file = false) {
+        if ($this->config->getSystemValue('debug', false)) {
+            // allows chrome workspace mapping in debug mode
+            return "";
+        }
+        $themingSuffix = '';
+        $v = [];
+
+        if ($this->config->getSystemValue('installed', false)) {
+            if (\OC::$server->getAppManager()->isInstalled('theming')) {
+                $themingSuffix = '-' . $this->config->getAppValue('theming', 'cachebuster', '0');
+            }
+            $v = \OC_App::getAppVersions();
+        }
+
+        // Try the webroot path for a match
+        if ($path !== false && $path !== '') {
+            $appName = $this->getAppNamefromPath($path);
+            if (array_key_exists($appName, $v)) {
+                $appVersion = $v[$appName];
+                return '?v=' . substr(md5($appVersion), 0, 8) . $themingSuffix;
+            }
+        }
+        // fallback to the file path instead
+        if ($file !== false && $file !== '') {
+            $appName = $this->getAppNamefromPath($file);
+            if (array_key_exists($appName, $v)) {
+                $appVersion = $v[$appName];
+                return '?v=' . substr(md5($appVersion), 0, 8) . $themingSuffix;
+            }
+        }
+
+        return '?v=' . self::$versionHash . $themingSuffix;
+    }
+
+    /**
+     * @param array $styles
+     * @return array
+     */
+    public static function findStylesheetFiles($styles, $compileScss = true) {
+        // Read the selected theme from the config file
+        $theme = \OC_Util::getTheme();
+
+        if ($compileScss) {
+            $SCSSCacher = \OC::$server->query(SCSSCacher::class);
+        } else {
+            $SCSSCacher = null;
+        }
+
+        $locator = new \OC\Template\CSSResourceLocator(
+            \OC::$server->getLogger(),
+            $theme,
+            [ \OC::$SERVERROOT => \OC::$WEBROOT ],
+            [ \OC::$SERVERROOT => \OC::$WEBROOT ],
+            $SCSSCacher
+        );
+        $locator->find($styles);
+        return $locator->getResources();
+    }
+
+    /**
+     * @param string $path
+     * @return string|boolean
+     */
+    public function getAppNamefromPath($path) {
+        if ($path !== '' && is_string($path)) {
+            $pathParts = explode('/', $path);
+            if ($pathParts[0] === 'css') {
+                // This is a scss request
+                return $pathParts[1];
+            }
+            return end($pathParts);
+        }
+        return false;
+    }
+
+    /**
+     * @param array $scripts
+     * @return array
+     */
+    public static function findJavascriptFiles($scripts) {
+        // Read the selected theme from the config file
+        $theme = \OC_Util::getTheme();
+
+        $locator = new \OC\Template\JSResourceLocator(
+            \OC::$server->getLogger(),
+            $theme,
+            [ \OC::$SERVERROOT => \OC::$WEBROOT ],
+            [ \OC::$SERVERROOT => \OC::$WEBROOT ],
+            \OC::$server->query(JSCombiner::class)
+            );
+        $locator->find($scripts);
+        return $locator->getResources();
+    }
+
+    /**
+     * Converts the absolute file path to a relative path from \OC::$SERVERROOT
+     * @param string $filePath Absolute path
+     * @return string Relative path
+     * @throws \Exception If $filePath is not under \OC::$SERVERROOT
+     */
+    public static function convertToRelativePath($filePath) {
+        $relativePath = explode(\OC::$SERVERROOT, $filePath);
+        if (count($relativePath) !== 2) {
+            throw new \Exception('$filePath is not under the \OC::$SERVERROOT');
+        }
+
+        return $relativePath[1];
+    }
 }

lib/private/legacy/OC_User.php

Indentation +340 added lines, -340 removed lines

@@ -59,344 +59,344 @@
  *   logout()
  */
 class OC_User {
-	private static $_usedBackends = [];
-
-	private static $_setupedBackends = [];
-
-	// bool, stores if a user want to access a resource anonymously, e.g if they open a public link
-	private static $incognitoMode = false;
-
-	/**
-	 * Adds the backend to the list of used backends
-	 *
-	 * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
-	 * @return bool
-	 *
-	 * Set the User Authentication Module
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function useBackend($backend = 'database') {
-		if ($backend instanceof \OCP\UserInterface) {
-			self::$_usedBackends[get_class($backend)] = $backend;
-			\OC::$server->getUserManager()->registerBackend($backend);
-		} else {
-			// You'll never know what happens
-			if (null === $backend or !is_string($backend)) {
-				$backend = 'database';
-			}
-
-			// Load backend
-			switch ($backend) {
-				case 'database':
-				case 'mysql':
-				case 'sqlite':
-					\OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', ILogger::DEBUG);
-					self::$_usedBackends[$backend] = new \OC\User\Database();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-				case 'dummy':
-					self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-				default:
-					\OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', ILogger::DEBUG);
-					$className = 'OC_USER_' . strtoupper($backend);
-					self::$_usedBackends[$backend] = new $className();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * remove all used backends
-	 */
-	public static function clearBackends() {
-		self::$_usedBackends = [];
-		\OC::$server->getUserManager()->clearBackends();
-	}
-
-	/**
-	 * setup the configured backends in config.php
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function setupBackends() {
-		OC_App::loadApps(['prelogin']);
-		$backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
-		if (isset($backends['default']) && !$backends['default']) {
-			// clear default backends
-			self::clearBackends();
-		}
-		foreach ($backends as $i => $config) {
-			if (!is_array($config)) {
-				continue;
-			}
-			$class = $config['class'];
-			$arguments = $config['arguments'];
-			if (class_exists($class)) {
-				if (array_search($i, self::$_setupedBackends) === false) {
-					// make a reflection object
-					$reflectionObj = new ReflectionClass($class);
-
-					// use Reflection to create a new instance, using the $args
-					$backend = $reflectionObj->newInstanceArgs($arguments);
-					self::useBackend($backend);
-					self::$_setupedBackends[] = $i;
-				} else {
-					\OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', ILogger::DEBUG);
-				}
-			} else {
-				\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', ILogger::ERROR);
-			}
-		}
-	}
-
-	/**
-	 * Try to login a user, assuming authentication
-	 * has already happened (e.g. via Single Sign On).
-	 *
-	 * Log in a user and regenerate a new session.
-	 *
-	 * @param \OCP\Authentication\IApacheBackend $backend
-	 * @return bool
-	 */
-	public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
-		$uid = $backend->getCurrentUserId();
-		$run = true;
-		OC_Hook::emit("OC_User", "pre_login", ["run" => &$run, "uid" => $uid, 'backend' => $backend]);
-
-		if ($uid) {
-			if (self::getUser() !== $uid) {
-				self::setUserId($uid);
-				$userSession = \OC::$server->getUserSession();
-				$userSession->setLoginName($uid);
-				$request = OC::$server->getRequest();
-				$userSession->createSessionToken($request, $uid, $uid);
-				// setup the filesystem
-				OC_Util::setupFS($uid);
-				// first call the post_login hooks, the login-process needs to be
-				// completed before we can safely create the users folder.
-				// For example encryption needs to initialize the users keys first
-				// before we can create the user folder with the skeleton files
-				OC_Hook::emit(
-					'OC_User',
-					'post_login',
-					[
-						'uid' => $uid,
-						'password' => '',
-						'isTokenLogin' => false,
-					]
-				);
-				/** @var IEventDispatcher $dispatcher */
-				$dispatcher = \OC::$server->get(IEventDispatcher::class);
-				$dispatcher->dispatchTyped(new UserLoggedInEvent(
-						\OC::$server->get(IUserManager::class)->get($uid),
-						$uid,
-						'',
-						false)
-				);
-
-				//trigger creation of user home and /files folder
-				\OC::$server->getUserFolder($uid);
-			}
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Verify with Apache whether user is authenticated.
-	 *
-	 * @return boolean|null
-	 *          true: authenticated
-	 *          false: not authenticated
-	 *          null: not handled / no backend available
-	 */
-	public static function handleApacheAuth() {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			OC_App::loadApps();
-
-			//setup extra user backends
-			self::setupBackends();
-			\OC::$server->getUserSession()->unsetMagicInCookie();
-
-			return self::loginWithApache($backend);
-		}
-
-		return null;
-	}
-
-
-	/**
-	 * Sets user id for session and triggers emit
-	 *
-	 * @param string $uid
-	 */
-	public static function setUserId($uid) {
-		$userSession = \OC::$server->getUserSession();
-		$userManager = \OC::$server->getUserManager();
-		if ($user = $userManager->get($uid)) {
-			$userSession->setUser($user);
-		} else {
-			\OC::$server->getSession()->set('user_id', $uid);
-		}
-	}
-
-	/**
-	 * Check if the user is logged in, considers also the HTTP basic credentials
-	 *
-	 * @deprecated use \OC::$server->getUserSession()->isLoggedIn()
-	 * @return bool
-	 */
-	public static function isLoggedIn() {
-		return \OC::$server->getUserSession()->isLoggedIn();
-	}
-
-	/**
-	 * set incognito mode, e.g. if a user wants to open a public link
-	 *
-	 * @param bool $status
-	 */
-	public static function setIncognitoMode($status) {
-		self::$incognitoMode = $status;
-	}
-
-	/**
-	 * get incognito mode status
-	 *
-	 * @return bool
-	 */
-	public static function isIncognitoMode() {
-		return self::$incognitoMode;
-	}
-
-	/**
-	 * Returns the current logout URL valid for the currently logged-in user
-	 *
-	 * @param \OCP\IURLGenerator $urlGenerator
-	 * @return string
-	 */
-	public static function getLogoutUrl(\OCP\IURLGenerator $urlGenerator) {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			return $backend->getLogoutUrl();
-		}
-
-		$user = \OC::$server->getUserSession()->getUser();
-		if ($user instanceof \OCP\IUser) {
-			$backend = $user->getBackend();
-			if ($backend instanceof \OCP\User\Backend\ICustomLogout) {
-				return $backend->getLogoutUrl();
-			}
-		}
-
-		$logoutUrl = $urlGenerator->linkToRoute('core.login.logout');
-		$logoutUrl .= '?requesttoken=' . urlencode(\OCP\Util::callRegister());
-
-		return $logoutUrl;
-	}
-
-	/**
-	 * Check if the user is an admin user
-	 *
-	 * @param string $uid uid of the admin
-	 * @return bool
-	 */
-	public static function isAdminUser($uid) {
-		$group = \OC::$server->getGroupManager()->get('admin');
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($group && $user && $group->inGroup($user) && self::$incognitoMode === false) {
-			return true;
-		}
-		return false;
-	}
-
-
-	/**
-	 * get the user id of the user currently logged in.
-	 *
-	 * @return string|bool uid or false
-	 */
-	public static function getUser() {
-		$uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
-		if (!is_null($uid) && self::$incognitoMode === false) {
-			return $uid;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Set password
-	 *
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @param string $recoveryPassword for the encryption app to reset encryption keys
-	 * @return bool
-	 *
-	 * Change the password of a user
-	 */
-	public static function setPassword($uid, $password, $recoveryPassword = null) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->setPassword($password, $recoveryPassword);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $uid The username
-	 * @return string
-	 *
-	 * returns the path to the users home directory
-	 * @deprecated Use \OC::$server->getUserManager->getHome()
-	 */
-	public static function getHome($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->getHome();
-		} else {
-			return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
-		}
-	}
-
-	/**
-	 * Get a list of all users display name
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array associative array with all display names (value) and corresponding uids (key)
-	 *
-	 * Get a list of all display names and user ids.
-	 * @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
-	 */
-	public static function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$displayNames = [];
-		$users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
-		foreach ($users as $user) {
-			$displayNames[$user->getUID()] = $user->getDisplayName();
-		}
-		return $displayNames;
-	}
-
-	/**
-	 * Returns the first active backend from self::$_usedBackends.
-	 *
-	 * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
-	 */
-	private static function findFirstActiveUsedBackend() {
-		foreach (self::$_usedBackends as $backend) {
-			if ($backend instanceof OCP\Authentication\IApacheBackend) {
-				if ($backend->isSessionActive()) {
-					return $backend;
-				}
-			}
-		}
-
-		return null;
-	}
+    private static $_usedBackends = [];
+
+    private static $_setupedBackends = [];
+
+    // bool, stores if a user want to access a resource anonymously, e.g if they open a public link
+    private static $incognitoMode = false;
+
+    /**
+     * Adds the backend to the list of used backends
+     *
+     * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
+     * @return bool
+     *
+     * Set the User Authentication Module
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function useBackend($backend = 'database') {
+        if ($backend instanceof \OCP\UserInterface) {
+            self::$_usedBackends[get_class($backend)] = $backend;
+            \OC::$server->getUserManager()->registerBackend($backend);
+        } else {
+            // You'll never know what happens
+            if (null === $backend or !is_string($backend)) {
+                $backend = 'database';
+            }
+
+            // Load backend
+            switch ($backend) {
+                case 'database':
+                case 'mysql':
+                case 'sqlite':
+                    \OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', ILogger::DEBUG);
+                    self::$_usedBackends[$backend] = new \OC\User\Database();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+                case 'dummy':
+                    self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+                default:
+                    \OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', ILogger::DEBUG);
+                    $className = 'OC_USER_' . strtoupper($backend);
+                    self::$_usedBackends[$backend] = new $className();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * remove all used backends
+     */
+    public static function clearBackends() {
+        self::$_usedBackends = [];
+        \OC::$server->getUserManager()->clearBackends();
+    }
+
+    /**
+     * setup the configured backends in config.php
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function setupBackends() {
+        OC_App::loadApps(['prelogin']);
+        $backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
+        if (isset($backends['default']) && !$backends['default']) {
+            // clear default backends
+            self::clearBackends();
+        }
+        foreach ($backends as $i => $config) {
+            if (!is_array($config)) {
+                continue;
+            }
+            $class = $config['class'];
+            $arguments = $config['arguments'];
+            if (class_exists($class)) {
+                if (array_search($i, self::$_setupedBackends) === false) {
+                    // make a reflection object
+                    $reflectionObj = new ReflectionClass($class);
+
+                    // use Reflection to create a new instance, using the $args
+                    $backend = $reflectionObj->newInstanceArgs($arguments);
+                    self::useBackend($backend);
+                    self::$_setupedBackends[] = $i;
+                } else {
+                    \OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', ILogger::DEBUG);
+                }
+            } else {
+                \OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', ILogger::ERROR);
+            }
+        }
+    }
+
+    /**
+     * Try to login a user, assuming authentication
+     * has already happened (e.g. via Single Sign On).
+     *
+     * Log in a user and regenerate a new session.
+     *
+     * @param \OCP\Authentication\IApacheBackend $backend
+     * @return bool
+     */
+    public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
+        $uid = $backend->getCurrentUserId();
+        $run = true;
+        OC_Hook::emit("OC_User", "pre_login", ["run" => &$run, "uid" => $uid, 'backend' => $backend]);
+
+        if ($uid) {
+            if (self::getUser() !== $uid) {
+                self::setUserId($uid);
+                $userSession = \OC::$server->getUserSession();
+                $userSession->setLoginName($uid);
+                $request = OC::$server->getRequest();
+                $userSession->createSessionToken($request, $uid, $uid);
+                // setup the filesystem
+                OC_Util::setupFS($uid);
+                // first call the post_login hooks, the login-process needs to be
+                // completed before we can safely create the users folder.
+                // For example encryption needs to initialize the users keys first
+                // before we can create the user folder with the skeleton files
+                OC_Hook::emit(
+                    'OC_User',
+                    'post_login',
+                    [
+                        'uid' => $uid,
+                        'password' => '',
+                        'isTokenLogin' => false,
+                    ]
+                );
+                /** @var IEventDispatcher $dispatcher */
+                $dispatcher = \OC::$server->get(IEventDispatcher::class);
+                $dispatcher->dispatchTyped(new UserLoggedInEvent(
+                        \OC::$server->get(IUserManager::class)->get($uid),
+                        $uid,
+                        '',
+                        false)
+                );
+
+                //trigger creation of user home and /files folder
+                \OC::$server->getUserFolder($uid);
+            }
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Verify with Apache whether user is authenticated.
+     *
+     * @return boolean|null
+     *          true: authenticated
+     *          false: not authenticated
+     *          null: not handled / no backend available
+     */
+    public static function handleApacheAuth() {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            OC_App::loadApps();
+
+            //setup extra user backends
+            self::setupBackends();
+            \OC::$server->getUserSession()->unsetMagicInCookie();
+
+            return self::loginWithApache($backend);
+        }
+
+        return null;
+    }
+
+
+    /**
+     * Sets user id for session and triggers emit
+     *
+     * @param string $uid
+     */
+    public static function setUserId($uid) {
+        $userSession = \OC::$server->getUserSession();
+        $userManager = \OC::$server->getUserManager();
+        if ($user = $userManager->get($uid)) {
+            $userSession->setUser($user);
+        } else {
+            \OC::$server->getSession()->set('user_id', $uid);
+        }
+    }
+
+    /**
+     * Check if the user is logged in, considers also the HTTP basic credentials
+     *
+     * @deprecated use \OC::$server->getUserSession()->isLoggedIn()
+     * @return bool
+     */
+    public static function isLoggedIn() {
+        return \OC::$server->getUserSession()->isLoggedIn();
+    }
+
+    /**
+     * set incognito mode, e.g. if a user wants to open a public link
+     *
+     * @param bool $status
+     */
+    public static function setIncognitoMode($status) {
+        self::$incognitoMode = $status;
+    }
+
+    /**
+     * get incognito mode status
+     *
+     * @return bool
+     */
+    public static function isIncognitoMode() {
+        return self::$incognitoMode;
+    }
+
+    /**
+     * Returns the current logout URL valid for the currently logged-in user
+     *
+     * @param \OCP\IURLGenerator $urlGenerator
+     * @return string
+     */
+    public static function getLogoutUrl(\OCP\IURLGenerator $urlGenerator) {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            return $backend->getLogoutUrl();
+        }
+
+        $user = \OC::$server->getUserSession()->getUser();
+        if ($user instanceof \OCP\IUser) {
+            $backend = $user->getBackend();
+            if ($backend instanceof \OCP\User\Backend\ICustomLogout) {
+                return $backend->getLogoutUrl();
+            }
+        }
+
+        $logoutUrl = $urlGenerator->linkToRoute('core.login.logout');
+        $logoutUrl .= '?requesttoken=' . urlencode(\OCP\Util::callRegister());
+
+        return $logoutUrl;
+    }
+
+    /**
+     * Check if the user is an admin user
+     *
+     * @param string $uid uid of the admin
+     * @return bool
+     */
+    public static function isAdminUser($uid) {
+        $group = \OC::$server->getGroupManager()->get('admin');
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($group && $user && $group->inGroup($user) && self::$incognitoMode === false) {
+            return true;
+        }
+        return false;
+    }
+
+
+    /**
+     * get the user id of the user currently logged in.
+     *
+     * @return string|bool uid or false
+     */
+    public static function getUser() {
+        $uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
+        if (!is_null($uid) && self::$incognitoMode === false) {
+            return $uid;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Set password
+     *
+     * @param string $uid The username
+     * @param string $password The new password
+     * @param string $recoveryPassword for the encryption app to reset encryption keys
+     * @return bool
+     *
+     * Change the password of a user
+     */
+    public static function setPassword($uid, $password, $recoveryPassword = null) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->setPassword($password, $recoveryPassword);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $uid The username
+     * @return string
+     *
+     * returns the path to the users home directory
+     * @deprecated Use \OC::$server->getUserManager->getHome()
+     */
+    public static function getHome($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->getHome();
+        } else {
+            return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
+        }
+    }
+
+    /**
+     * Get a list of all users display name
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array associative array with all display names (value) and corresponding uids (key)
+     *
+     * Get a list of all display names and user ids.
+     * @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
+     */
+    public static function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $displayNames = [];
+        $users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
+        foreach ($users as $user) {
+            $displayNames[$user->getUID()] = $user->getDisplayName();
+        }
+        return $displayNames;
+    }
+
+    /**
+     * Returns the first active backend from self::$_usedBackends.
+     *
+     * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
+     */
+    private static function findFirstActiveUsedBackend() {
+        foreach (self::$_usedBackends as $backend) {
+            if ($backend instanceof OCP\Authentication\IApacheBackend) {
+                if ($backend->isSessionActive()) {
+                    return $backend;
+                }
+            }
+        }
+
+        return null;
+    }
 }