nextcloud / server

lib/private/Encryption/Util.php

Indentation +366 added lines, -366 removed lines

@@ -39,370 +39,370 @@
 use OCP\IUser;
 
 class Util {
-	public const HEADER_START = 'HBEGIN';
-	public const HEADER_END = 'HEND';
-	public const HEADER_PADDING_CHAR = '-';
-
-	public const HEADER_ENCRYPTION_MODULE_KEY = 'oc_encryption_module';
-
-	/**
-	 * block size will always be 8192 for a PHP stream
-	 * @see https://bugs.php.net/bug.php?id=21641
-	 * @var integer
-	 */
-	protected $headerSize = 8192;
-
-	/**
-	 * block size will always be 8192 for a PHP stream
-	 * @see https://bugs.php.net/bug.php?id=21641
-	 * @var integer
-	 */
-	protected $blockSize = 8192;
-
-	/** @var View */
-	protected $rootView;
-
-	/** @var array */
-	protected $ocHeaderKeys;
-
-	/** @var \OC\User\Manager */
-	protected $userManager;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var array paths excluded from encryption */
-	protected $excludedPaths;
-
-	/** @var \OC\Group\Manager $manager */
-	protected $groupManager;
-
-	/**
-	 *
-	 * @param View $rootView
-	 * @param \OC\User\Manager $userManager
-	 * @param \OC\Group\Manager $groupManager
-	 * @param IConfig $config
-	 */
-	public function __construct(
-		View $rootView,
-		\OC\User\Manager $userManager,
-		\OC\Group\Manager $groupManager,
-		IConfig $config) {
-		$this->ocHeaderKeys = [
-			self::HEADER_ENCRYPTION_MODULE_KEY
-		];
-
-		$this->rootView = $rootView;
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->config = $config;
-
-		$this->excludedPaths[] = 'files_encryption';
-		$this->excludedPaths[] = 'appdata_' . $config->getSystemValue('instanceid', null);
-		$this->excludedPaths[] = 'files_external';
-	}
-
-	/**
-	 * read encryption module ID from header
-	 *
-	 * @param array $header
-	 * @return string
-	 * @throws ModuleDoesNotExistsException
-	 */
-	public function getEncryptionModuleId(array $header = null) {
-		$id = '';
-		$encryptionModuleKey = self::HEADER_ENCRYPTION_MODULE_KEY;
-
-		if (isset($header[$encryptionModuleKey])) {
-			$id = $header[$encryptionModuleKey];
-		} elseif (isset($header['cipher'])) {
-			if (class_exists('\OCA\Encryption\Crypto\Encryption')) {
-				// fall back to default encryption if the user migrated from
-				// ownCloud <= 8.0 with the old encryption
-				$id = \OCA\Encryption\Crypto\Encryption::ID;
-			} else {
-				throw new ModuleDoesNotExistsException('Default encryption module missing');
-			}
-		}
-
-		return $id;
-	}
-
-	/**
-	 * create header for encrypted file
-	 *
-	 * @param array $headerData
-	 * @param IEncryptionModule $encryptionModule
-	 * @return string
-	 * @throws EncryptionHeaderToLargeException if header has to many arguments
-	 * @throws EncryptionHeaderKeyExistsException if header key is already in use
-	 */
-	public function createHeader(array $headerData, IEncryptionModule $encryptionModule) {
-		$header = self::HEADER_START . ':' . self::HEADER_ENCRYPTION_MODULE_KEY . ':' . $encryptionModule->getId() . ':';
-		foreach ($headerData as $key => $value) {
-			if (in_array($key, $this->ocHeaderKeys)) {
-				throw new EncryptionHeaderKeyExistsException($key);
-			}
-			$header .= $key . ':' . $value . ':';
-		}
-		$header .= self::HEADER_END;
-
-		if (strlen($header) > $this->getHeaderSize()) {
-			throw new EncryptionHeaderToLargeException();
-		}
-
-		$paddedHeader = str_pad($header, $this->headerSize, self::HEADER_PADDING_CHAR, STR_PAD_RIGHT);
-
-		return $paddedHeader;
-	}
-
-	/**
-	 * go recursively through a dir and collect all files and sub files.
-	 *
-	 * @param string $dir relative to the users files folder
-	 * @return array with list of files relative to the users files folder
-	 */
-	public function getAllFiles($dir) {
-		$result = [];
-		$dirList = [$dir];
-
-		while ($dirList) {
-			$dir = array_pop($dirList);
-			$content = $this->rootView->getDirectoryContent($dir);
-
-			foreach ($content as $c) {
-				if ($c->getType() === 'dir') {
-					$dirList[] = $c->getPath();
-				} else {
-					$result[] = $c->getPath();
-				}
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * check if it is a file uploaded by the user stored in data/user/files
-	 * or a metadata file
-	 *
-	 * @param string $path relative to the data/ folder
-	 * @return boolean
-	 */
-	public function isFile($path) {
-		$parts = explode('/', Filesystem::normalizePath($path), 4);
-		if (isset($parts[2]) && $parts[2] === 'files') {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * return size of encryption header
-	 *
-	 * @return integer
-	 */
-	public function getHeaderSize() {
-		return $this->headerSize;
-	}
-
-	/**
-	 * return size of block read by a PHP stream
-	 *
-	 * @return integer
-	 */
-	public function getBlockSize() {
-		return $this->blockSize;
-	}
-
-	/**
-	 * get the owner and the path for the file relative to the owners files folder
-	 *
-	 * @param string $path
-	 * @return array
-	 * @throws \BadMethodCallException
-	 */
-	public function getUidAndFilename($path) {
-		$parts = explode('/', $path);
-		$uid = '';
-		if (count($parts) > 2) {
-			$uid = $parts[1];
-		}
-		if (!$this->userManager->userExists($uid)) {
-			throw new \BadMethodCallException(
-				'path needs to be relative to the system wide data folder and point to a user specific file'
-			);
-		}
-
-		$ownerPath = implode('/', array_slice($parts, 2));
-
-		return [$uid, Filesystem::normalizePath($ownerPath)];
-	}
-
-	/**
-	 * Remove .path extension from a file path
-	 * @param string $path Path that may identify a .part file
-	 * @return string File path without .part extension
-	 * @note this is needed for reusing keys
-	 */
-	public function stripPartialFileExtension($path) {
-		$extension = pathinfo($path, PATHINFO_EXTENSION);
-
-		if ($extension === 'part') {
-			$newLength = strlen($path) - 5; // 5 = strlen(".part")
-			$fPath = substr($path, 0, $newLength);
-
-			// if path also contains a transaction id, we remove it too
-			$extension = pathinfo($fPath, PATHINFO_EXTENSION);
-			if (substr($extension, 0, 12) === 'ocTransferId') { // 12 = strlen("ocTransferId")
-				$newLength = strlen($fPath) - strlen($extension) - 1;
-				$fPath = substr($fPath, 0, $newLength);
-			}
-			return $fPath;
-		} else {
-			return $path;
-		}
-	}
-
-	public function getUserWithAccessToMountPoint($users, $groups) {
-		$result = [];
-		if ($users === [] && $groups === []) {
-			$users = $this->userManager->search('', null, null);
-			$result = array_map(function (IUser $user) {
-				return $user->getUID();
-			}, $users);
-		} else {
-			$result = array_merge($result, $users);
-
-			$groupManager = \OC::$server->getGroupManager();
-			foreach ($groups as $group) {
-				$groupObject = $groupManager->get($group);
-				if ($groupObject) {
-					$foundUsers = $groupObject->searchUsers('', -1, 0);
-					$userIds = [];
-					foreach ($foundUsers as $user) {
-						$userIds[] = $user->getUID();
-					}
-					$result = array_merge($result, $userIds);
-				}
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * check if the file is stored on a system wide mount point
-	 * @param string $path relative to /data/user with leading '/'
-	 * @param string $uid
-	 * @return boolean
-	 */
-	public function isSystemWideMountPoint($path, $uid) {
-		if (\OCP\App::isEnabled("files_external")) {
-			/** @var GlobalStoragesService $storageService */
-			$storageService = \OC::$server->get(GlobalStoragesService::class);
-			$storages = $storageService->getAllStorages();
-			foreach ($storages as $storage) {
-				if (strpos($path, '/files/' . $storage->getMountPoint()) === 0) {
-					if ($this->isMountPointApplicableToUser($storage, $uid)) {
-						return true;
-					}
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * check if mount point is applicable to user
-	 *
-	 * @param StorageConfig $mount
-	 * @param string $uid
-	 * @return boolean
-	 */
-	private function isMountPointApplicableToUser(StorageConfig $mount, string $uid) {
-		if ($mount->getApplicableUsers() === [] && $mount->getApplicableGroups() === []) {
-			// applicable for everyone
-			return true;
-		}
-		// check if mount point is applicable for the user
-		if (array_search($uid, $mount->getApplicableUsers()) !== false) {
-			return true;
-		}
-		// check if mount point is applicable for group where the user is a member
-		foreach ($mount->getApplicableGroups() as $gid) {
-			if ($this->groupManager->isInGroup($uid, $gid)) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * check if it is a path which is excluded by ownCloud from encryption
-	 *
-	 * @param string $path
-	 * @return boolean
-	 */
-	public function isExcluded($path) {
-		$normalizedPath = Filesystem::normalizePath($path);
-		$root = explode('/', $normalizedPath, 4);
-		if (count($root) > 1) {
-
-			// detect alternative key storage root
-			$rootDir = $this->getKeyStorageRoot();
-			if ($rootDir !== '' &&
-				0 === strpos(
-					Filesystem::normalizePath($path),
-					Filesystem::normalizePath($rootDir)
-				)
-			) {
-				return true;
-			}
-
-
-			//detect system wide folders
-			if (in_array($root[1], $this->excludedPaths)) {
-				return true;
-			}
-
-			// detect user specific folders
-			if ($this->userManager->userExists($root[1])
-				&& in_array($root[2], $this->excludedPaths)) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * check if recovery key is enabled for user
-	 *
-	 * @param string $uid
-	 * @return boolean
-	 */
-	public function recoveryEnabled($uid) {
-		$enabled = $this->config->getUserValue($uid, 'encryption', 'recovery_enabled', '0');
-
-		return $enabled === '1';
-	}
-
-	/**
-	 * set new key storage root
-	 *
-	 * @param string $root new key store root relative to the data folder
-	 */
-	public function setKeyStorageRoot($root) {
-		$this->config->setAppValue('core', 'encryption_key_storage_root', $root);
-	}
-
-	/**
-	 * get key storage root
-	 *
-	 * @return string key storage root
-	 */
-	public function getKeyStorageRoot() {
-		return $this->config->getAppValue('core', 'encryption_key_storage_root', '');
-	}
+    public const HEADER_START = 'HBEGIN';
+    public const HEADER_END = 'HEND';
+    public const HEADER_PADDING_CHAR = '-';
+
+    public const HEADER_ENCRYPTION_MODULE_KEY = 'oc_encryption_module';
+
+    /**
+     * block size will always be 8192 for a PHP stream
+     * @see https://bugs.php.net/bug.php?id=21641
+     * @var integer
+     */
+    protected $headerSize = 8192;
+
+    /**
+     * block size will always be 8192 for a PHP stream
+     * @see https://bugs.php.net/bug.php?id=21641
+     * @var integer
+     */
+    protected $blockSize = 8192;
+
+    /** @var View */
+    protected $rootView;
+
+    /** @var array */
+    protected $ocHeaderKeys;
+
+    /** @var \OC\User\Manager */
+    protected $userManager;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var array paths excluded from encryption */
+    protected $excludedPaths;
+
+    /** @var \OC\Group\Manager $manager */
+    protected $groupManager;
+
+    /**
+     *
+     * @param View $rootView
+     * @param \OC\User\Manager $userManager
+     * @param \OC\Group\Manager $groupManager
+     * @param IConfig $config
+     */
+    public function __construct(
+        View $rootView,
+        \OC\User\Manager $userManager,
+        \OC\Group\Manager $groupManager,
+        IConfig $config) {
+        $this->ocHeaderKeys = [
+            self::HEADER_ENCRYPTION_MODULE_KEY
+        ];
+
+        $this->rootView = $rootView;
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->config = $config;
+
+        $this->excludedPaths[] = 'files_encryption';
+        $this->excludedPaths[] = 'appdata_' . $config->getSystemValue('instanceid', null);
+        $this->excludedPaths[] = 'files_external';
+    }
+
+    /**
+     * read encryption module ID from header
+     *
+     * @param array $header
+     * @return string
+     * @throws ModuleDoesNotExistsException
+     */
+    public function getEncryptionModuleId(array $header = null) {
+        $id = '';
+        $encryptionModuleKey = self::HEADER_ENCRYPTION_MODULE_KEY;
+
+        if (isset($header[$encryptionModuleKey])) {
+            $id = $header[$encryptionModuleKey];
+        } elseif (isset($header['cipher'])) {
+            if (class_exists('\OCA\Encryption\Crypto\Encryption')) {
+                // fall back to default encryption if the user migrated from
+                // ownCloud <= 8.0 with the old encryption
+                $id = \OCA\Encryption\Crypto\Encryption::ID;
+            } else {
+                throw new ModuleDoesNotExistsException('Default encryption module missing');
+            }
+        }
+
+        return $id;
+    }
+
+    /**
+     * create header for encrypted file
+     *
+     * @param array $headerData
+     * @param IEncryptionModule $encryptionModule
+     * @return string
+     * @throws EncryptionHeaderToLargeException if header has to many arguments
+     * @throws EncryptionHeaderKeyExistsException if header key is already in use
+     */
+    public function createHeader(array $headerData, IEncryptionModule $encryptionModule) {
+        $header = self::HEADER_START . ':' . self::HEADER_ENCRYPTION_MODULE_KEY . ':' . $encryptionModule->getId() . ':';
+        foreach ($headerData as $key => $value) {
+            if (in_array($key, $this->ocHeaderKeys)) {
+                throw new EncryptionHeaderKeyExistsException($key);
+            }
+            $header .= $key . ':' . $value . ':';
+        }
+        $header .= self::HEADER_END;
+
+        if (strlen($header) > $this->getHeaderSize()) {
+            throw new EncryptionHeaderToLargeException();
+        }
+
+        $paddedHeader = str_pad($header, $this->headerSize, self::HEADER_PADDING_CHAR, STR_PAD_RIGHT);
+
+        return $paddedHeader;
+    }
+
+    /**
+     * go recursively through a dir and collect all files and sub files.
+     *
+     * @param string $dir relative to the users files folder
+     * @return array with list of files relative to the users files folder
+     */
+    public function getAllFiles($dir) {
+        $result = [];
+        $dirList = [$dir];
+
+        while ($dirList) {
+            $dir = array_pop($dirList);
+            $content = $this->rootView->getDirectoryContent($dir);
+
+            foreach ($content as $c) {
+                if ($c->getType() === 'dir') {
+                    $dirList[] = $c->getPath();
+                } else {
+                    $result[] = $c->getPath();
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * check if it is a file uploaded by the user stored in data/user/files
+     * or a metadata file
+     *
+     * @param string $path relative to the data/ folder
+     * @return boolean
+     */
+    public function isFile($path) {
+        $parts = explode('/', Filesystem::normalizePath($path), 4);
+        if (isset($parts[2]) && $parts[2] === 'files') {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * return size of encryption header
+     *
+     * @return integer
+     */
+    public function getHeaderSize() {
+        return $this->headerSize;
+    }
+
+    /**
+     * return size of block read by a PHP stream
+     *
+     * @return integer
+     */
+    public function getBlockSize() {
+        return $this->blockSize;
+    }
+
+    /**
+     * get the owner and the path for the file relative to the owners files folder
+     *
+     * @param string $path
+     * @return array
+     * @throws \BadMethodCallException
+     */
+    public function getUidAndFilename($path) {
+        $parts = explode('/', $path);
+        $uid = '';
+        if (count($parts) > 2) {
+            $uid = $parts[1];
+        }
+        if (!$this->userManager->userExists($uid)) {
+            throw new \BadMethodCallException(
+                'path needs to be relative to the system wide data folder and point to a user specific file'
+            );
+        }
+
+        $ownerPath = implode('/', array_slice($parts, 2));
+
+        return [$uid, Filesystem::normalizePath($ownerPath)];
+    }
+
+    /**
+     * Remove .path extension from a file path
+     * @param string $path Path that may identify a .part file
+     * @return string File path without .part extension
+     * @note this is needed for reusing keys
+     */
+    public function stripPartialFileExtension($path) {
+        $extension = pathinfo($path, PATHINFO_EXTENSION);
+
+        if ($extension === 'part') {
+            $newLength = strlen($path) - 5; // 5 = strlen(".part")
+            $fPath = substr($path, 0, $newLength);
+
+            // if path also contains a transaction id, we remove it too
+            $extension = pathinfo($fPath, PATHINFO_EXTENSION);
+            if (substr($extension, 0, 12) === 'ocTransferId') { // 12 = strlen("ocTransferId")
+                $newLength = strlen($fPath) - strlen($extension) - 1;
+                $fPath = substr($fPath, 0, $newLength);
+            }
+            return $fPath;
+        } else {
+            return $path;
+        }
+    }
+
+    public function getUserWithAccessToMountPoint($users, $groups) {
+        $result = [];
+        if ($users === [] && $groups === []) {
+            $users = $this->userManager->search('', null, null);
+            $result = array_map(function (IUser $user) {
+                return $user->getUID();
+            }, $users);
+        } else {
+            $result = array_merge($result, $users);
+
+            $groupManager = \OC::$server->getGroupManager();
+            foreach ($groups as $group) {
+                $groupObject = $groupManager->get($group);
+                if ($groupObject) {
+                    $foundUsers = $groupObject->searchUsers('', -1, 0);
+                    $userIds = [];
+                    foreach ($foundUsers as $user) {
+                        $userIds[] = $user->getUID();
+                    }
+                    $result = array_merge($result, $userIds);
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * check if the file is stored on a system wide mount point
+     * @param string $path relative to /data/user with leading '/'
+     * @param string $uid
+     * @return boolean
+     */
+    public function isSystemWideMountPoint($path, $uid) {
+        if (\OCP\App::isEnabled("files_external")) {
+            /** @var GlobalStoragesService $storageService */
+            $storageService = \OC::$server->get(GlobalStoragesService::class);
+            $storages = $storageService->getAllStorages();
+            foreach ($storages as $storage) {
+                if (strpos($path, '/files/' . $storage->getMountPoint()) === 0) {
+                    if ($this->isMountPointApplicableToUser($storage, $uid)) {
+                        return true;
+                    }
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * check if mount point is applicable to user
+     *
+     * @param StorageConfig $mount
+     * @param string $uid
+     * @return boolean
+     */
+    private function isMountPointApplicableToUser(StorageConfig $mount, string $uid) {
+        if ($mount->getApplicableUsers() === [] && $mount->getApplicableGroups() === []) {
+            // applicable for everyone
+            return true;
+        }
+        // check if mount point is applicable for the user
+        if (array_search($uid, $mount->getApplicableUsers()) !== false) {
+            return true;
+        }
+        // check if mount point is applicable for group where the user is a member
+        foreach ($mount->getApplicableGroups() as $gid) {
+            if ($this->groupManager->isInGroup($uid, $gid)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * check if it is a path which is excluded by ownCloud from encryption
+     *
+     * @param string $path
+     * @return boolean
+     */
+    public function isExcluded($path) {
+        $normalizedPath = Filesystem::normalizePath($path);
+        $root = explode('/', $normalizedPath, 4);
+        if (count($root) > 1) {
+
+            // detect alternative key storage root
+            $rootDir = $this->getKeyStorageRoot();
+            if ($rootDir !== '' &&
+                0 === strpos(
+                    Filesystem::normalizePath($path),
+                    Filesystem::normalizePath($rootDir)
+                )
+            ) {
+                return true;
+            }
+
+
+            //detect system wide folders
+            if (in_array($root[1], $this->excludedPaths)) {
+                return true;
+            }
+
+            // detect user specific folders
+            if ($this->userManager->userExists($root[1])
+                && in_array($root[2], $this->excludedPaths)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * check if recovery key is enabled for user
+     *
+     * @param string $uid
+     * @return boolean
+     */
+    public function recoveryEnabled($uid) {
+        $enabled = $this->config->getUserValue($uid, 'encryption', 'recovery_enabled', '0');
+
+        return $enabled === '1';
+    }
+
+    /**
+     * set new key storage root
+     *
+     * @param string $root new key store root relative to the data folder
+     */
+    public function setKeyStorageRoot($root) {
+        $this->config->setAppValue('core', 'encryption_key_storage_root', $root);
+    }
+
+    /**
+     * get key storage root
+     *
+     * @return string key storage root
+     */
+    public function getKeyStorageRoot() {
+        return $this->config->getAppValue('core', 'encryption_key_storage_root', '');
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -99,7 +99,7 @@ 
 		$this->config = $config;
 
 		$this->excludedPaths[] = 'files_encryption';
-		$this->excludedPaths[] = 'appdata_' . $config->getSystemValue('instanceid', null);
+		$this->excludedPaths[] = 'appdata_'.$config->getSystemValue('instanceid', null);
 		$this->excludedPaths[] = 'files_external';
 	}
 
@@ -139,12 +139,12 @@ 
 	 * @throws EncryptionHeaderKeyExistsException if header key is already in use
 	 */
 	public function createHeader(array $headerData, IEncryptionModule $encryptionModule) {
-		$header = self::HEADER_START . ':' . self::HEADER_ENCRYPTION_MODULE_KEY . ':' . $encryptionModule->getId() . ':';
+		$header = self::HEADER_START.':'.self::HEADER_ENCRYPTION_MODULE_KEY.':'.$encryptionModule->getId().':';
 		foreach ($headerData as $key => $value) {
 			if (in_array($key, $this->ocHeaderKeys)) {
 				throw new EncryptionHeaderKeyExistsException($key);
 			}
-			$header .= $key . ':' . $value . ':';
+			$header .= $key.':'.$value.':';
 		}
 		$header .= self::HEADER_END;
 
@@ -269,7 +269,7 @@ 
 		$result = [];
 		if ($users === [] && $groups === []) {
 			$users = $this->userManager->search('', null, null);
-			$result = array_map(function (IUser $user) {
+			$result = array_map(function(IUser $user) {
 				return $user->getUID();
 			}, $users);
 		} else {
@@ -304,7 +304,7 @@ 
 			$storageService = \OC::$server->get(GlobalStoragesService::class);
 			$storages = $storageService->getAllStorages();
 			foreach ($storages as $storage) {
-				if (strpos($path, '/files/' . $storage->getMountPoint()) === 0) {
+				if (strpos($path, '/files/'.$storage->getMountPoint()) === 0) {
 					if ($this->isMountPointApplicableToUser($storage, $uid)) {
 						return true;
 					}

lib/private/Encryption/File.php

Indentation +92 added lines, -92 removed lines

@@ -35,96 +35,96 @@
 
 class File implements \OCP\Encryption\IFile {
 
-	/** @var Util */
-	protected $util;
-
-	/** @var IRootFolder */
-	private $rootFolder;
-
-	/** @var IManager */
-	private $shareManager;
-
-	/**
-	 * cache results of already checked folders
-	 *
-	 * @var array
-	 */
-	protected $cache;
-
-	public function __construct(Util $util,
-								IRootFolder $rootFolder,
-								IManager $shareManager) {
-		$this->util = $util;
-		$this->cache = new CappedMemoryCache();
-		$this->rootFolder = $rootFolder;
-		$this->shareManager = $shareManager;
-	}
-
-
-	/**
-	 * get list of users with access to the file
-	 *
-	 * @param string $path to the file
-	 * @return array  ['users' => $uniqueUserIds, 'public' => $public]
-	 */
-	public function getAccessList($path) {
-
-		// Make sure that a share key is generated for the owner too
-		[$owner, $ownerPath] = $this->util->getUidAndFilename($path);
-
-		// always add owner to the list of users with access to the file
-		$userIds = [$owner];
-
-		if (!$this->util->isFile($owner . '/' . $ownerPath)) {
-			return ['users' => $userIds, 'public' => false];
-		}
-
-		$ownerPath = substr($ownerPath, strlen('/files'));
-		$userFolder = $this->rootFolder->getUserFolder($owner);
-		try {
-			$file = $userFolder->get($ownerPath);
-		} catch (NotFoundException $e) {
-			$file = null;
-		}
-		$ownerPath = $this->util->stripPartialFileExtension($ownerPath);
-
-		// first get the shares for the parent and cache the result so that we don't
-		// need to check all parents for every file
-		$parent = dirname($ownerPath);
-		$parentNode = $userFolder->get($parent);
-		if (isset($this->cache[$parent])) {
-			$resultForParents = $this->cache[$parent];
-		} else {
-			$resultForParents = $this->shareManager->getAccessList($parentNode);
-			$this->cache[$parent] = $resultForParents;
-		}
-		$userIds = array_merge($userIds, $resultForParents['users']);
-		$public = $resultForParents['public'] || $resultForParents['remote'];
-
-
-		// Find out who, if anyone, is sharing the file
-		if ($file !== null) {
-			$resultForFile = $this->shareManager->getAccessList($file, false);
-			$userIds = array_merge($userIds, $resultForFile['users']);
-			$public = $resultForFile['public'] || $resultForFile['remote'] || $public;
-		}
-
-		// check if it is a group mount
-		if (\OCP\App::isEnabled("files_external")) {
-			/** @var GlobalStoragesService $storageService */
-			$storageService = \OC::$server->get(GlobalStoragesService::class);
-			$storages = $storageService->getAllStorages();
-			foreach ($storages as $storage) {
-				if ($storage->getMountPoint() == substr($ownerPath, 0, strlen($storage->getMountPoint()))) {
-					$mountedFor = $this->util->getUserWithAccessToMountPoint($storage->getApplicableUsers(), $storage->getApplicableGroups());
-					$userIds = array_merge($userIds, $mountedFor);
-				}
-			}
-		}
-
-		// Remove duplicate UIDs
-		$uniqueUserIds = array_unique($userIds);
-
-		return ['users' => $uniqueUserIds, 'public' => $public];
-	}
+    /** @var Util */
+    protected $util;
+
+    /** @var IRootFolder */
+    private $rootFolder;
+
+    /** @var IManager */
+    private $shareManager;
+
+    /**
+     * cache results of already checked folders
+     *
+     * @var array
+     */
+    protected $cache;
+
+    public function __construct(Util $util,
+                                IRootFolder $rootFolder,
+                                IManager $shareManager) {
+        $this->util = $util;
+        $this->cache = new CappedMemoryCache();
+        $this->rootFolder = $rootFolder;
+        $this->shareManager = $shareManager;
+    }
+
+
+    /**
+     * get list of users with access to the file
+     *
+     * @param string $path to the file
+     * @return array  ['users' => $uniqueUserIds, 'public' => $public]
+     */
+    public function getAccessList($path) {
+
+        // Make sure that a share key is generated for the owner too
+        [$owner, $ownerPath] = $this->util->getUidAndFilename($path);
+
+        // always add owner to the list of users with access to the file
+        $userIds = [$owner];
+
+        if (!$this->util->isFile($owner . '/' . $ownerPath)) {
+            return ['users' => $userIds, 'public' => false];
+        }
+
+        $ownerPath = substr($ownerPath, strlen('/files'));
+        $userFolder = $this->rootFolder->getUserFolder($owner);
+        try {
+            $file = $userFolder->get($ownerPath);
+        } catch (NotFoundException $e) {
+            $file = null;
+        }
+        $ownerPath = $this->util->stripPartialFileExtension($ownerPath);
+
+        // first get the shares for the parent and cache the result so that we don't
+        // need to check all parents for every file
+        $parent = dirname($ownerPath);
+        $parentNode = $userFolder->get($parent);
+        if (isset($this->cache[$parent])) {
+            $resultForParents = $this->cache[$parent];
+        } else {
+            $resultForParents = $this->shareManager->getAccessList($parentNode);
+            $this->cache[$parent] = $resultForParents;
+        }
+        $userIds = array_merge($userIds, $resultForParents['users']);
+        $public = $resultForParents['public'] || $resultForParents['remote'];
+
+
+        // Find out who, if anyone, is sharing the file
+        if ($file !== null) {
+            $resultForFile = $this->shareManager->getAccessList($file, false);
+            $userIds = array_merge($userIds, $resultForFile['users']);
+            $public = $resultForFile['public'] || $resultForFile['remote'] || $public;
+        }
+
+        // check if it is a group mount
+        if (\OCP\App::isEnabled("files_external")) {
+            /** @var GlobalStoragesService $storageService */
+            $storageService = \OC::$server->get(GlobalStoragesService::class);
+            $storages = $storageService->getAllStorages();
+            foreach ($storages as $storage) {
+                if ($storage->getMountPoint() == substr($ownerPath, 0, strlen($storage->getMountPoint()))) {
+                    $mountedFor = $this->util->getUserWithAccessToMountPoint($storage->getApplicableUsers(), $storage->getApplicableGroups());
+                    $userIds = array_merge($userIds, $mountedFor);
+                }
+            }
+        }
+
+        // Remove duplicate UIDs
+        $uniqueUserIds = array_unique($userIds);
+
+        return ['users' => $uniqueUserIds, 'public' => $public];
+    }
 }

apps/files_external/lib/Controller/ApiController.php

Indentation +73 added lines, -73 removed lines

@@ -39,87 +39,87 @@
 
 class ApiController extends OCSController {
 
-	/** @var IUserSession */
-	private $userSession;
-	/** @var UserGlobalStoragesService */
-	private $userGlobalStoragesService;
-	/** @var UserStoragesService */
-	private $userStoragesService;
+    /** @var IUserSession */
+    private $userSession;
+    /** @var UserGlobalStoragesService */
+    private $userGlobalStoragesService;
+    /** @var UserStoragesService */
+    private $userStoragesService;
 
-	public function __construct(
-		string $appName,
-		IRequest $request,
-		IUserSession $userSession,
-		UserGlobalStoragesService $userGlobalStorageService,
-		UserStoragesService $userStorageService
-	) {
-		parent::__construct($appName, $request);
+    public function __construct(
+        string $appName,
+        IRequest $request,
+        IUserSession $userSession,
+        UserGlobalStoragesService $userGlobalStorageService,
+        UserStoragesService $userStorageService
+    ) {
+        parent::__construct($appName, $request);
 
-		$this->userSession = $userSession;
-		$this->userGlobalStoragesService = $userGlobalStorageService;
-		$this->userStoragesService = $userStorageService;
-	}
+        $this->userSession = $userSession;
+        $this->userGlobalStoragesService = $userGlobalStorageService;
+        $this->userStoragesService = $userStorageService;
+    }
 
-	/**
-	 * Formats the given mount config to a mount entry.
-	 *
-	 * @param string $mountPoint mount point name, relative to the data dir
-	 * @param StorageConfig $mountConfig mount config to format
-	 *
-	 * @return array entry
-	 */
-	private function formatMount(string $mountPoint, StorageConfig $mountConfig): array {
-		// split path from mount point
-		$path = \dirname($mountPoint);
-		if ($path === '.' || $path === '/') {
-			$path = '';
-		}
+    /**
+     * Formats the given mount config to a mount entry.
+     *
+     * @param string $mountPoint mount point name, relative to the data dir
+     * @param StorageConfig $mountConfig mount config to format
+     *
+     * @return array entry
+     */
+    private function formatMount(string $mountPoint, StorageConfig $mountConfig): array {
+        // split path from mount point
+        $path = \dirname($mountPoint);
+        if ($path === '.' || $path === '/') {
+            $path = '';
+        }
 
-		$isSystemMount = $mountConfig->getType() === StorageConfig::MOUNT_TYPE_ADMIN;
+        $isSystemMount = $mountConfig->getType() === StorageConfig::MOUNT_TYPE_ADMIN;
 
-		$permissions = \OCP\Constants::PERMISSION_READ;
-		// personal mounts can be deleted
-		if (!$isSystemMount) {
-			$permissions |= \OCP\Constants::PERMISSION_DELETE;
-		}
+        $permissions = \OCP\Constants::PERMISSION_READ;
+        // personal mounts can be deleted
+        if (!$isSystemMount) {
+            $permissions |= \OCP\Constants::PERMISSION_DELETE;
+        }
 
-		$entry = [
-			'name' => basename($mountPoint),
-			'path' => $path,
-			'type' => 'dir',
-			'backend' => $mountConfig->getBackend()->getText(),
-			'scope' => $isSystemMount ? 'system' : 'personal',
-			'permissions' => $permissions,
-			'id' => $mountConfig->getId(),
-			'class' => $mountConfig->getBackend()->getIdentifier(),
-		];
-		return $entry;
-	}
+        $entry = [
+            'name' => basename($mountPoint),
+            'path' => $path,
+            'type' => 'dir',
+            'backend' => $mountConfig->getBackend()->getText(),
+            'scope' => $isSystemMount ? 'system' : 'personal',
+            'permissions' => $permissions,
+            'id' => $mountConfig->getId(),
+            'class' => $mountConfig->getBackend()->getIdentifier(),
+        ];
+        return $entry;
+    }
 
-	/**
-	 * @NoAdminRequired
-	 *
-	 * Returns the mount points visible for this user.
-	 *
-	 * @return DataResponse share information
-	 */
-	public function getUserMounts(): DataResponse {
-		$entries = [];
-		$mountPoints = [];
+    /**
+     * @NoAdminRequired
+     *
+     * Returns the mount points visible for this user.
+     *
+     * @return DataResponse share information
+     */
+    public function getUserMounts(): DataResponse {
+        $entries = [];
+        $mountPoints = [];
 
-		foreach ($this->userGlobalStoragesService->getStorages() as $storage) {
-			$mountPoint = $storage->getMountPoint();
-			$mountPoints[$mountPoint] = $storage;
-		}
+        foreach ($this->userGlobalStoragesService->getStorages() as $storage) {
+            $mountPoint = $storage->getMountPoint();
+            $mountPoints[$mountPoint] = $storage;
+        }
 
-		foreach ($this->userStoragesService->getStorages() as $storage) {
-			$mountPoint = $storage->getMountPoint();
-			$mountPoints[$mountPoint] = $storage;
-		}
-		foreach ($mountPoints as $mountPoint => $mount) {
-			$entries[] = $this->formatMount($mountPoint, $mount);
-		}
+        foreach ($this->userStoragesService->getStorages() as $storage) {
+            $mountPoint = $storage->getMountPoint();
+            $mountPoints[$mountPoint] = $storage;
+        }
+        foreach ($mountPoints as $mountPoint => $mount) {
+            $entries[] = $this->formatMount($mountPoint, $mount);
+        }
 
-		return new DataResponse($entries);
-	}
+        return new DataResponse($entries);
+    }
 }

apps/files_external/lib/Command/Import.php

Indentation +183 added lines, -183 removed lines

@@ -40,187 +40,187 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Import extends Base {
-	/**
-	 * @var GlobalStoragesService
-	 */
-	private $globalService;
-
-	/**
-	 * @var UserStoragesService
-	 */
-	private $userService;
-
-	/**
-	 * @var IUserSession
-	 */
-	private $userSession;
-
-	/**
-	 * @var IUserManager
-	 */
-	private $userManager;
-
-	/** @var ImportLegacyStoragesService */
-	private $importLegacyStorageService;
-
-	/** @var BackendService */
-	private $backendService;
-
-	public function __construct(GlobalStoragesService $globalService,
-						 UserStoragesService $userService,
-						 IUserSession $userSession,
-						 IUserManager $userManager,
-						 ImportLegacyStoragesService $importLegacyStorageService,
-						 BackendService $backendService
-	) {
-		parent::__construct();
-		$this->globalService = $globalService;
-		$this->userService = $userService;
-		$this->userSession = $userSession;
-		$this->userManager = $userManager;
-		$this->importLegacyStorageService = $importLegacyStorageService;
-		$this->backendService = $backendService;
-	}
-
-	protected function configure() {
-		$this
-			->setName('files_external:import')
-			->setDescription('Import mount configurations')
-			->addOption(
-				'user',
-				'',
-				InputOption::VALUE_OPTIONAL,
-				'user to add the mount configurations for, if not set the mount will be added as system mount'
-			)
-			->addArgument(
-				'path',
-				InputArgument::REQUIRED,
-				'path to a json file containing the mounts to import, use "-" to read from stdin'
-			)
-			->addOption(
-				'dry',
-				'',
-				InputOption::VALUE_NONE,
-				'Don\'t save the imported mounts, only list the new mounts'
-			);
-		parent::configure();
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$user = (string) $input->getOption('user');
-		$path = $input->getArgument('path');
-		if ($path === '-') {
-			$json = file_get_contents('php://stdin');
-		} else {
-			if (!file_exists($path)) {
-				$output->writeln('<error>File not found: ' . $path . '</error>');
-				return 1;
-			}
-			$json = file_get_contents($path);
-		}
-		if (!is_string($json) || strlen($json) < 2) {
-			$output->writeln('<error>Error while reading json</error>');
-			return 1;
-		}
-		$data = json_decode($json, true);
-		if (!is_array($data)) {
-			$output->writeln('<error>Error while parsing json</error>');
-			return 1;
-		}
-
-		$isLegacy = isset($data['user']) || isset($data['group']);
-		if ($isLegacy) {
-			$this->importLegacyStorageService->setData($data);
-			$mounts = $this->importLegacyStorageService->getAllStorages();
-			foreach ($mounts as $mount) {
-				if ($mount->getBackendOption('password') === false) {
-					$output->writeln('<error>Failed to decrypt password</error>');
-					return 1;
-				}
-			}
-		} else {
-			if (!isset($data[0])) { //normalize to an array of mounts
-				$data = [$data];
-			}
-			$mounts = array_map([$this, 'parseData'], $data);
-		}
-
-		if ($user) {
-			// ensure applicables are correct for personal mounts
-			foreach ($mounts as $mount) {
-				$mount->setApplicableGroups([]);
-				$mount->setApplicableUsers([$user]);
-			}
-		}
-
-		$storageService = $this->getStorageService($user);
-
-		$existingMounts = $storageService->getAllStorages();
-
-		foreach ($mounts as $mount) {
-			foreach ($existingMounts as $existingMount) {
-				if (
-					$existingMount->getMountPoint() === $mount->getMountPoint() &&
-					$existingMount->getApplicableGroups() === $mount->getApplicableGroups() &&
-					$existingMount->getApplicableUsers() === $mount->getApplicableUsers() &&
-					$existingMount->getBackendOptions() === $mount->getBackendOptions()
-				) {
-					$output->writeln("<error>Duplicate mount (" . $mount->getMountPoint() . ")</error>");
-					return 1;
-				}
-			}
-		}
-
-		if ($input->getOption('dry')) {
-			if (count($mounts) === 0) {
-				$output->writeln('<error>No mounts to be imported</error>');
-				return 1;
-			}
-			$listCommand = new ListCommand($this->globalService, $this->userService, $this->userSession, $this->userManager);
-			$listInput = new ArrayInput([], $listCommand->getDefinition());
-			$listInput->setOption('output', $input->getOption('output'));
-			$listInput->setOption('show-password', true);
-			$listCommand->listMounts($user, $mounts, $listInput, $output);
-		} else {
-			foreach ($mounts as $mount) {
-				$storageService->addStorage($mount);
-			}
-		}
-		return 0;
-	}
-
-	private function parseData(array $data) {
-		$mount = new StorageConfig($data['mount_id']);
-		$mount->setMountPoint($data['mount_point']);
-		$mount->setBackend($this->getBackendByClass($data['storage']));
-		$authBackend = $this->backendService->getAuthMechanism($data['authentication_type']);
-		$mount->setAuthMechanism($authBackend);
-		$mount->setBackendOptions($data['configuration']);
-		$mount->setMountOptions($data['options']);
-		$mount->setApplicableUsers(isset($data['applicable_users']) ? $data['applicable_users'] : []);
-		$mount->setApplicableGroups(isset($data['applicable_groups']) ? $data['applicable_groups'] : []);
-		return $mount;
-	}
-
-	private function getBackendByClass($className) {
-		$backends = $this->backendService->getBackends();
-		foreach ($backends as $backend) {
-			if ($backend->getStorageClass() === $className) {
-				return $backend;
-			}
-		}
-	}
-
-	protected function getStorageService($userId) {
-		if (!empty($userId)) {
-			$user = $this->userManager->get($userId);
-			if (is_null($user)) {
-				throw new NoUserException("user $userId not found");
-			}
-			$this->userSession->setUser($user);
-			return $this->userService;
-		} else {
-			return $this->globalService;
-		}
-	}
+    /**
+     * @var GlobalStoragesService
+     */
+    private $globalService;
+
+    /**
+     * @var UserStoragesService
+     */
+    private $userService;
+
+    /**
+     * @var IUserSession
+     */
+    private $userSession;
+
+    /**
+     * @var IUserManager
+     */
+    private $userManager;
+
+    /** @var ImportLegacyStoragesService */
+    private $importLegacyStorageService;
+
+    /** @var BackendService */
+    private $backendService;
+
+    public function __construct(GlobalStoragesService $globalService,
+                            UserStoragesService $userService,
+                            IUserSession $userSession,
+                            IUserManager $userManager,
+                            ImportLegacyStoragesService $importLegacyStorageService,
+                            BackendService $backendService
+    ) {
+        parent::__construct();
+        $this->globalService = $globalService;
+        $this->userService = $userService;
+        $this->userSession = $userSession;
+        $this->userManager = $userManager;
+        $this->importLegacyStorageService = $importLegacyStorageService;
+        $this->backendService = $backendService;
+    }
+
+    protected function configure() {
+        $this
+            ->setName('files_external:import')
+            ->setDescription('Import mount configurations')
+            ->addOption(
+                'user',
+                '',
+                InputOption::VALUE_OPTIONAL,
+                'user to add the mount configurations for, if not set the mount will be added as system mount'
+            )
+            ->addArgument(
+                'path',
+                InputArgument::REQUIRED,
+                'path to a json file containing the mounts to import, use "-" to read from stdin'
+            )
+            ->addOption(
+                'dry',
+                '',
+                InputOption::VALUE_NONE,
+                'Don\'t save the imported mounts, only list the new mounts'
+            );
+        parent::configure();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $user = (string) $input->getOption('user');
+        $path = $input->getArgument('path');
+        if ($path === '-') {
+            $json = file_get_contents('php://stdin');
+        } else {
+            if (!file_exists($path)) {
+                $output->writeln('<error>File not found: ' . $path . '</error>');
+                return 1;
+            }
+            $json = file_get_contents($path);
+        }
+        if (!is_string($json) || strlen($json) < 2) {
+            $output->writeln('<error>Error while reading json</error>');
+            return 1;
+        }
+        $data = json_decode($json, true);
+        if (!is_array($data)) {
+            $output->writeln('<error>Error while parsing json</error>');
+            return 1;
+        }
+
+        $isLegacy = isset($data['user']) || isset($data['group']);
+        if ($isLegacy) {
+            $this->importLegacyStorageService->setData($data);
+            $mounts = $this->importLegacyStorageService->getAllStorages();
+            foreach ($mounts as $mount) {
+                if ($mount->getBackendOption('password') === false) {
+                    $output->writeln('<error>Failed to decrypt password</error>');
+                    return 1;
+                }
+            }
+        } else {
+            if (!isset($data[0])) { //normalize to an array of mounts
+                $data = [$data];
+            }
+            $mounts = array_map([$this, 'parseData'], $data);
+        }
+
+        if ($user) {
+            // ensure applicables are correct for personal mounts
+            foreach ($mounts as $mount) {
+                $mount->setApplicableGroups([]);
+                $mount->setApplicableUsers([$user]);
+            }
+        }
+
+        $storageService = $this->getStorageService($user);
+
+        $existingMounts = $storageService->getAllStorages();
+
+        foreach ($mounts as $mount) {
+            foreach ($existingMounts as $existingMount) {
+                if (
+                    $existingMount->getMountPoint() === $mount->getMountPoint() &&
+                    $existingMount->getApplicableGroups() === $mount->getApplicableGroups() &&
+                    $existingMount->getApplicableUsers() === $mount->getApplicableUsers() &&
+                    $existingMount->getBackendOptions() === $mount->getBackendOptions()
+                ) {
+                    $output->writeln("<error>Duplicate mount (" . $mount->getMountPoint() . ")</error>");
+                    return 1;
+                }
+            }
+        }
+
+        if ($input->getOption('dry')) {
+            if (count($mounts) === 0) {
+                $output->writeln('<error>No mounts to be imported</error>');
+                return 1;
+            }
+            $listCommand = new ListCommand($this->globalService, $this->userService, $this->userSession, $this->userManager);
+            $listInput = new ArrayInput([], $listCommand->getDefinition());
+            $listInput->setOption('output', $input->getOption('output'));
+            $listInput->setOption('show-password', true);
+            $listCommand->listMounts($user, $mounts, $listInput, $output);
+        } else {
+            foreach ($mounts as $mount) {
+                $storageService->addStorage($mount);
+            }
+        }
+        return 0;
+    }
+
+    private function parseData(array $data) {
+        $mount = new StorageConfig($data['mount_id']);
+        $mount->setMountPoint($data['mount_point']);
+        $mount->setBackend($this->getBackendByClass($data['storage']));
+        $authBackend = $this->backendService->getAuthMechanism($data['authentication_type']);
+        $mount->setAuthMechanism($authBackend);
+        $mount->setBackendOptions($data['configuration']);
+        $mount->setMountOptions($data['options']);
+        $mount->setApplicableUsers(isset($data['applicable_users']) ? $data['applicable_users'] : []);
+        $mount->setApplicableGroups(isset($data['applicable_groups']) ? $data['applicable_groups'] : []);
+        return $mount;
+    }
+
+    private function getBackendByClass($className) {
+        $backends = $this->backendService->getBackends();
+        foreach ($backends as $backend) {
+            if ($backend->getStorageClass() === $className) {
+                return $backend;
+            }
+        }
+    }
+
+    protected function getStorageService($userId) {
+        if (!empty($userId)) {
+            $user = $this->userManager->get($userId);
+            if (is_null($user)) {
+                throw new NoUserException("user $userId not found");
+            }
+            $this->userSession->setUser($user);
+            return $this->userService;
+        } else {
+            return $this->globalService;
+        }
+    }
 }

apps/files_external/lib/Command/Create.php

Indentation +178 added lines, -178 removed lines

@@ -43,182 +43,182 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Create extends Base {
-	/**
-	 * @var GlobalStoragesService
-	 */
-	private $globalService;
-
-	/**
-	 * @var UserStoragesService
-	 */
-	private $userService;
-
-	/**
-	 * @var IUserManager
-	 */
-	private $userManager;
-
-	/** @var BackendService */
-	private $backendService;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	public function __construct(GlobalStoragesService $globalService,
-						 UserStoragesService $userService,
-						 IUserManager $userManager,
-						 IUserSession $userSession,
-						 BackendService $backendService
-	) {
-		parent::__construct();
-		$this->globalService = $globalService;
-		$this->userService = $userService;
-		$this->userManager = $userManager;
-		$this->userSession = $userSession;
-		$this->backendService = $backendService;
-	}
-
-	protected function configure() {
-		$this
-			->setName('files_external:create')
-			->setDescription('Create a new mount configuration')
-			->addOption(
-				'user',
-				'',
-				InputOption::VALUE_OPTIONAL,
-				'user to add the mount configuration for, if not set the mount will be added as system mount'
-			)
-			->addArgument(
-				'mount_point',
-				InputArgument::REQUIRED,
-				'mount point for the new mount'
-			)
-			->addArgument(
-				'storage_backend',
-				InputArgument::REQUIRED,
-				'storage backend identifier for the new mount, see `occ files_external:backends` for possible values'
-			)
-			->addArgument(
-				'authentication_backend',
-				InputArgument::REQUIRED,
-				'authentication backend identifier for the new mount, see `occ files_external:backends` for possible values'
-			)
-			->addOption(
-				'config',
-				'c',
-				InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
-				'Mount configuration option in key=value format'
-			)
-			->addOption(
-				'dry',
-				'',
-				InputOption::VALUE_NONE,
-				'Don\'t save the created mount, only list the new mount'
-			);
-		parent::configure();
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$user = (string) $input->getOption('user');
-		$mountPoint = $input->getArgument('mount_point');
-		$storageIdentifier = $input->getArgument('storage_backend');
-		$authIdentifier = $input->getArgument('authentication_backend');
-		$configInput = $input->getOption('config');
-
-		$storageBackend = $this->backendService->getBackend($storageIdentifier);
-		$authBackend = $this->backendService->getAuthMechanism($authIdentifier);
-
-		if (!Filesystem::isValidPath($mountPoint)) {
-			$output->writeln('<error>Invalid mountpoint "' . $mountPoint . '"</error>');
-			return 1;
-		}
-		if (is_null($storageBackend)) {
-			$output->writeln('<error>Storage backend with identifier "' . $storageIdentifier . '" not found (see `occ files_external:backends` for possible values)</error>');
-			return 404;
-		}
-		if (is_null($authBackend)) {
-			$output->writeln('<error>Authentication backend with identifier "' . $authIdentifier . '" not found (see `occ files_external:backends` for possible values)</error>');
-			return 404;
-		}
-		$supportedSchemes = array_keys($storageBackend->getAuthSchemes());
-		if (!in_array($authBackend->getScheme(), $supportedSchemes)) {
-			$output->writeln('<error>Authentication backend "' . $authIdentifier . '" not valid for storage backend "' . $storageIdentifier . '" (see `occ files_external:backends storage ' . $storageIdentifier . '` for possible values)</error>');
-			return 1;
-		}
-
-		$config = [];
-		foreach ($configInput as $configOption) {
-			if (!strpos($configOption, '=')) {
-				$output->writeln('<error>Invalid mount configuration option "' . $configOption . '"</error>');
-				return 1;
-			}
-			[$key, $value] = explode('=', $configOption, 2);
-			if (!$this->validateParam($key, $value, $storageBackend, $authBackend)) {
-				$output->writeln('<error>Unknown configuration for backends "' . $key . '"</error>');
-				return 1;
-			}
-			$config[$key] = $value;
-		}
-
-		$mount = new StorageConfig();
-		$mount->setMountPoint($mountPoint);
-		$mount->setBackend($storageBackend);
-		$mount->setAuthMechanism($authBackend);
-		$mount->setBackendOptions($config);
-
-		if ($user) {
-			if (!$this->userManager->userExists($user)) {
-				$output->writeln('<error>User "' . $user . '" not found</error>');
-				return 1;
-			}
-			$mount->setApplicableUsers([$user]);
-		}
-
-		if ($input->getOption('dry')) {
-			$this->showMount($user, $mount, $input, $output);
-		} else {
-			$this->getStorageService($user)->addStorage($mount);
-			if ($input->getOption('output') === self::OUTPUT_FORMAT_PLAIN) {
-				$output->writeln('<info>Storage created with id ' . $mount->getId() . '</info>');
-			} else {
-				$output->writeln((string)$mount->getId());
-			}
-		}
-		return 0;
-	}
-
-	private function validateParam($key, &$value, Backend $storageBackend, AuthMechanism $authBackend) {
-		$params = array_merge($storageBackend->getParameters(), $authBackend->getParameters());
-		foreach ($params as $param) {
-			/** @var DefinitionParameter $param */
-			if ($param->getName() === $key) {
-				if ($param->getType() === DefinitionParameter::VALUE_BOOLEAN) {
-					$value = ($value === 'true');
-				}
-				return true;
-			}
-		}
-		return false;
-	}
-
-	private function showMount($user, StorageConfig $mount, InputInterface $input, OutputInterface $output) {
-		$listCommand = new ListCommand($this->globalService, $this->userService, $this->userSession, $this->userManager);
-		$listInput = new ArrayInput([], $listCommand->getDefinition());
-		$listInput->setOption('output', $input->getOption('output'));
-		$listInput->setOption('show-password', true);
-		$listCommand->listMounts($user, [$mount], $listInput, $output);
-	}
-
-	protected function getStorageService($userId) {
-		if (!empty($userId)) {
-			$user = $this->userManager->get($userId);
-			if (is_null($user)) {
-				throw new NoUserException("user $userId not found");
-			}
-			$this->userSession->setUser($user);
-			return $this->userService;
-		} else {
-			return $this->globalService;
-		}
-	}
+    /**
+     * @var GlobalStoragesService
+     */
+    private $globalService;
+
+    /**
+     * @var UserStoragesService
+     */
+    private $userService;
+
+    /**
+     * @var IUserManager
+     */
+    private $userManager;
+
+    /** @var BackendService */
+    private $backendService;
+
+    /** @var IUserSession */
+    private $userSession;
+
+    public function __construct(GlobalStoragesService $globalService,
+                            UserStoragesService $userService,
+                            IUserManager $userManager,
+                            IUserSession $userSession,
+                            BackendService $backendService
+    ) {
+        parent::__construct();
+        $this->globalService = $globalService;
+        $this->userService = $userService;
+        $this->userManager = $userManager;
+        $this->userSession = $userSession;
+        $this->backendService = $backendService;
+    }
+
+    protected function configure() {
+        $this
+            ->setName('files_external:create')
+            ->setDescription('Create a new mount configuration')
+            ->addOption(
+                'user',
+                '',
+                InputOption::VALUE_OPTIONAL,
+                'user to add the mount configuration for, if not set the mount will be added as system mount'
+            )
+            ->addArgument(
+                'mount_point',
+                InputArgument::REQUIRED,
+                'mount point for the new mount'
+            )
+            ->addArgument(
+                'storage_backend',
+                InputArgument::REQUIRED,
+                'storage backend identifier for the new mount, see `occ files_external:backends` for possible values'
+            )
+            ->addArgument(
+                'authentication_backend',
+                InputArgument::REQUIRED,
+                'authentication backend identifier for the new mount, see `occ files_external:backends` for possible values'
+            )
+            ->addOption(
+                'config',
+                'c',
+                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+                'Mount configuration option in key=value format'
+            )
+            ->addOption(
+                'dry',
+                '',
+                InputOption::VALUE_NONE,
+                'Don\'t save the created mount, only list the new mount'
+            );
+        parent::configure();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $user = (string) $input->getOption('user');
+        $mountPoint = $input->getArgument('mount_point');
+        $storageIdentifier = $input->getArgument('storage_backend');
+        $authIdentifier = $input->getArgument('authentication_backend');
+        $configInput = $input->getOption('config');
+
+        $storageBackend = $this->backendService->getBackend($storageIdentifier);
+        $authBackend = $this->backendService->getAuthMechanism($authIdentifier);
+
+        if (!Filesystem::isValidPath($mountPoint)) {
+            $output->writeln('<error>Invalid mountpoint "' . $mountPoint . '"</error>');
+            return 1;
+        }
+        if (is_null($storageBackend)) {
+            $output->writeln('<error>Storage backend with identifier "' . $storageIdentifier . '" not found (see `occ files_external:backends` for possible values)</error>');
+            return 404;
+        }
+        if (is_null($authBackend)) {
+            $output->writeln('<error>Authentication backend with identifier "' . $authIdentifier . '" not found (see `occ files_external:backends` for possible values)</error>');
+            return 404;
+        }
+        $supportedSchemes = array_keys($storageBackend->getAuthSchemes());
+        if (!in_array($authBackend->getScheme(), $supportedSchemes)) {
+            $output->writeln('<error>Authentication backend "' . $authIdentifier . '" not valid for storage backend "' . $storageIdentifier . '" (see `occ files_external:backends storage ' . $storageIdentifier . '` for possible values)</error>');
+            return 1;
+        }
+
+        $config = [];
+        foreach ($configInput as $configOption) {
+            if (!strpos($configOption, '=')) {
+                $output->writeln('<error>Invalid mount configuration option "' . $configOption . '"</error>');
+                return 1;
+            }
+            [$key, $value] = explode('=', $configOption, 2);
+            if (!$this->validateParam($key, $value, $storageBackend, $authBackend)) {
+                $output->writeln('<error>Unknown configuration for backends "' . $key . '"</error>');
+                return 1;
+            }
+            $config[$key] = $value;
+        }
+
+        $mount = new StorageConfig();
+        $mount->setMountPoint($mountPoint);
+        $mount->setBackend($storageBackend);
+        $mount->setAuthMechanism($authBackend);
+        $mount->setBackendOptions($config);
+
+        if ($user) {
+            if (!$this->userManager->userExists($user)) {
+                $output->writeln('<error>User "' . $user . '" not found</error>');
+                return 1;
+            }
+            $mount->setApplicableUsers([$user]);
+        }
+
+        if ($input->getOption('dry')) {
+            $this->showMount($user, $mount, $input, $output);
+        } else {
+            $this->getStorageService($user)->addStorage($mount);
+            if ($input->getOption('output') === self::OUTPUT_FORMAT_PLAIN) {
+                $output->writeln('<info>Storage created with id ' . $mount->getId() . '</info>');
+            } else {
+                $output->writeln((string)$mount->getId());
+            }
+        }
+        return 0;
+    }
+
+    private function validateParam($key, &$value, Backend $storageBackend, AuthMechanism $authBackend) {
+        $params = array_merge($storageBackend->getParameters(), $authBackend->getParameters());
+        foreach ($params as $param) {
+            /** @var DefinitionParameter $param */
+            if ($param->getName() === $key) {
+                if ($param->getType() === DefinitionParameter::VALUE_BOOLEAN) {
+                    $value = ($value === 'true');
+                }
+                return true;
+            }
+        }
+        return false;
+    }
+
+    private function showMount($user, StorageConfig $mount, InputInterface $input, OutputInterface $output) {
+        $listCommand = new ListCommand($this->globalService, $this->userService, $this->userSession, $this->userManager);
+        $listInput = new ArrayInput([], $listCommand->getDefinition());
+        $listInput->setOption('output', $input->getOption('output'));
+        $listInput->setOption('show-password', true);
+        $listCommand->listMounts($user, [$mount], $listInput, $output);
+    }
+
+    protected function getStorageService($userId) {
+        if (!empty($userId)) {
+            $user = $this->userManager->get($userId);
+            if (is_null($user)) {
+                throw new NoUserException("user $userId not found");
+            }
+            $this->userSession->setUser($user);
+            return $this->userService;
+        } else {
+            return $this->globalService;
+        }
+    }
 }

apps/files_external/lib/Lib/StorageConfig.php

Indentation +394 added lines, -394 removed lines

@@ -36,398 +36,398 @@
  * External storage configuration
  */
 class StorageConfig implements \JsonSerializable {
-	public const MOUNT_TYPE_ADMIN = 1;
-	public const MOUNT_TYPE_PERSONAl = 2;
-
-	/**
-	 * Storage config id
-	 *
-	 * @var int
-	 */
-	private $id;
-
-	/**
-	 * Backend
-	 *
-	 * @var Backend
-	 */
-	private $backend;
-
-	/**
-	 * Authentication mechanism
-	 *
-	 * @var AuthMechanism
-	 */
-	private $authMechanism;
-
-	/**
-	 * Backend options
-	 *
-	 * @var array
-	 */
-	private $backendOptions = [];
-
-	/**
-	 * Mount point path, relative to the user's "files" folder
-	 *
-	 * @var string
-	 */
-	private $mountPoint;
-
-	/**
-	 * Storage status
-	 *
-	 * @var int
-	 */
-	private $status;
-
-	/**
-	 * Status message
-	 *
-	 * @var string
-	 */
-	private $statusMessage;
-
-	/**
-	 * Priority
-	 *
-	 * @var int
-	 */
-	private $priority;
-
-	/**
-	 * List of users who have access to this storage
-	 *
-	 * @var string[]
-	 */
-	private $applicableUsers = [];
-
-	/**
-	 * List of groups that have access to this storage
-	 *
-	 * @var string[]
-	 */
-	private $applicableGroups = [];
-
-	/**
-	 * Mount-specific options
-	 *
-	 * @var array
-	 */
-	private $mountOptions = [];
-
-	/**
-	 * Whether it's a personal or admin mount
-	 *
-	 * @var int
-	 */
-	private $type;
-
-	/**
-	 * Creates a storage config
-	 *
-	 * @param int|null $id config id or null for a new config
-	 */
-	public function __construct($id = null) {
-		$this->id = $id;
-		$this->mountOptions['enable_sharing'] = false;
-	}
-
-	/**
-	 * Returns the configuration id
-	 *
-	 * @return int
-	 */
-	public function getId() {
-		return $this->id;
-	}
-
-	/**
-	 * Sets the configuration id
-	 *
-	 * @param int $id configuration id
-	 */
-	public function setId($id) {
-		$this->id = $id;
-	}
-
-	/**
-	 * Returns mount point path relative to the user's
-	 * "files" folder.
-	 *
-	 * @return string path
-	 */
-	public function getMountPoint() {
-		return $this->mountPoint;
-	}
-
-	/**
-	 * Sets mount point path relative to the user's
-	 * "files" folder.
-	 * The path will be normalized.
-	 *
-	 * @param string $mountPoint path
-	 */
-	public function setMountPoint($mountPoint) {
-		$this->mountPoint = \OC\Files\Filesystem::normalizePath($mountPoint);
-	}
-
-	/**
-	 * @return Backend
-	 */
-	public function getBackend() {
-		return $this->backend;
-	}
-
-	/**
-	 * @param Backend $backend
-	 */
-	public function setBackend(Backend $backend) {
-		$this->backend = $backend;
-	}
-
-	/**
-	 * @return AuthMechanism
-	 */
-	public function getAuthMechanism() {
-		return $this->authMechanism;
-	}
-
-	/**
-	 * @param AuthMechanism $authMechanism
-	 */
-	public function setAuthMechanism(AuthMechanism $authMechanism) {
-		$this->authMechanism = $authMechanism;
-	}
-
-	/**
-	 * Returns the external storage backend-specific options
-	 *
-	 * @return array backend options
-	 */
-	public function getBackendOptions() {
-		return $this->backendOptions;
-	}
-
-	/**
-	 * Sets the external storage backend-specific options
-	 *
-	 * @param array $backendOptions backend options
-	 */
-	public function setBackendOptions($backendOptions) {
-		if ($this->getBackend() instanceof  Backend) {
-			$parameters = $this->getBackend()->getParameters();
-			foreach ($backendOptions as $key => $value) {
-				if (isset($parameters[$key])) {
-					switch ($parameters[$key]->getType()) {
-						case \OCA\Files_External\Lib\DefinitionParameter::VALUE_BOOLEAN:
-							$value = (bool)$value;
-							break;
-					}
-					$backendOptions[$key] = $value;
-				}
-			}
-		}
-
-		$this->backendOptions = $backendOptions;
-	}
-
-	/**
-	 * @param string $key
-	 * @return mixed
-	 */
-	public function getBackendOption($key) {
-		if (isset($this->backendOptions[$key])) {
-			return $this->backendOptions[$key];
-		}
-		return null;
-	}
-
-	/**
-	 * @param string $key
-	 * @param mixed $value
-	 */
-	public function setBackendOption($key, $value) {
-		$this->backendOptions[$key] = $value;
-	}
-
-	/**
-	 * Returns the mount priority
-	 *
-	 * @return int priority
-	 */
-	public function getPriority() {
-		return $this->priority;
-	}
-
-	/**
-	 * Sets the mount priotity
-	 *
-	 * @param int $priority priority
-	 */
-	public function setPriority($priority) {
-		$this->priority = $priority;
-	}
-
-	/**
-	 * Returns the users for which to mount this storage
-	 *
-	 * @return string[] applicable users
-	 */
-	public function getApplicableUsers() {
-		return $this->applicableUsers;
-	}
-
-	/**
-	 * Sets the users for which to mount this storage
-	 *
-	 * @param string[]|null $applicableUsers applicable users
-	 */
-	public function setApplicableUsers($applicableUsers) {
-		if (is_null($applicableUsers)) {
-			$applicableUsers = [];
-		}
-		$this->applicableUsers = $applicableUsers;
-	}
-
-	/**
-	 * Returns the groups for which to mount this storage
-	 *
-	 * @return string[] applicable groups
-	 */
-	public function getApplicableGroups() {
-		return $this->applicableGroups;
-	}
-
-	/**
-	 * Sets the groups for which to mount this storage
-	 *
-	 * @param string[]|null $applicableGroups applicable groups
-	 */
-	public function setApplicableGroups($applicableGroups) {
-		if (is_null($applicableGroups)) {
-			$applicableGroups = [];
-		}
-		$this->applicableGroups = $applicableGroups;
-	}
-
-	/**
-	 * Returns the mount-specific options
-	 *
-	 * @return array mount specific options
-	 */
-	public function getMountOptions() {
-		return $this->mountOptions;
-	}
-
-	/**
-	 * Sets the mount-specific options
-	 *
-	 * @param array $mountOptions applicable groups
-	 */
-	public function setMountOptions($mountOptions) {
-		if (is_null($mountOptions)) {
-			$mountOptions = [];
-		}
-		$this->mountOptions = $mountOptions;
-	}
-
-	/**
-	 * @param string $key
-	 * @return mixed
-	 */
-	public function getMountOption($key) {
-		if (isset($this->mountOptions[$key])) {
-			return $this->mountOptions[$key];
-		}
-		return null;
-	}
-
-	/**
-	 * @param string $key
-	 * @param mixed $value
-	 */
-	public function setMountOption($key, $value) {
-		$this->mountOptions[$key] = $value;
-	}
-
-	/**
-	 * Gets the storage status, whether the config worked last time
-	 *
-	 * @return int $status status
-	 */
-	public function getStatus() {
-		return $this->status;
-	}
-
-	/**
-	 * Gets the message describing the storage status
-	 *
-	 * @return string|null
-	 */
-	public function getStatusMessage() {
-		return $this->statusMessage;
-	}
-
-	/**
-	 * Sets the storage status, whether the config worked last time
-	 *
-	 * @param int $status status
-	 * @param string|null $message optional message
-	 */
-	public function setStatus($status, $message = null) {
-		$this->status = $status;
-		$this->statusMessage = $message;
-	}
-
-	/**
-	 * @return int self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl
-	 */
-	public function getType() {
-		return $this->type;
-	}
-
-	/**
-	 * @param int $type self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl
-	 */
-	public function setType($type) {
-		$this->type = $type;
-	}
-
-	/**
-	 * Serialize config to JSON
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize() {
-		$result = [];
-		if (!is_null($this->id)) {
-			$result['id'] = $this->id;
-		}
-		$result['mountPoint'] = $this->mountPoint;
-		$result['backend'] = $this->backend->getIdentifier();
-		$result['authMechanism'] = $this->authMechanism->getIdentifier();
-		$result['backendOptions'] = $this->backendOptions;
-		if (!is_null($this->priority)) {
-			$result['priority'] = $this->priority;
-		}
-		if (!empty($this->applicableUsers)) {
-			$result['applicableUsers'] = $this->applicableUsers;
-		}
-		if (!empty($this->applicableGroups)) {
-			$result['applicableGroups'] = $this->applicableGroups;
-		}
-		if (!empty($this->mountOptions)) {
-			$result['mountOptions'] = $this->mountOptions;
-		}
-		if (!is_null($this->status)) {
-			$result['status'] = $this->status;
-		}
-		if (!is_null($this->statusMessage)) {
-			$result['statusMessage'] = $this->statusMessage;
-		}
-		$result['userProvided'] = $this->authMechanism instanceof IUserProvided;
-		$result['type'] = ($this->getType() === self::MOUNT_TYPE_PERSONAl) ? 'personal': 'system';
-		return $result;
-	}
+    public const MOUNT_TYPE_ADMIN = 1;
+    public const MOUNT_TYPE_PERSONAl = 2;
+
+    /**
+     * Storage config id
+     *
+     * @var int
+     */
+    private $id;
+
+    /**
+     * Backend
+     *
+     * @var Backend
+     */
+    private $backend;
+
+    /**
+     * Authentication mechanism
+     *
+     * @var AuthMechanism
+     */
+    private $authMechanism;
+
+    /**
+     * Backend options
+     *
+     * @var array
+     */
+    private $backendOptions = [];
+
+    /**
+     * Mount point path, relative to the user's "files" folder
+     *
+     * @var string
+     */
+    private $mountPoint;
+
+    /**
+     * Storage status
+     *
+     * @var int
+     */
+    private $status;
+
+    /**
+     * Status message
+     *
+     * @var string
+     */
+    private $statusMessage;
+
+    /**
+     * Priority
+     *
+     * @var int
+     */
+    private $priority;
+
+    /**
+     * List of users who have access to this storage
+     *
+     * @var string[]
+     */
+    private $applicableUsers = [];
+
+    /**
+     * List of groups that have access to this storage
+     *
+     * @var string[]
+     */
+    private $applicableGroups = [];
+
+    /**
+     * Mount-specific options
+     *
+     * @var array
+     */
+    private $mountOptions = [];
+
+    /**
+     * Whether it's a personal or admin mount
+     *
+     * @var int
+     */
+    private $type;
+
+    /**
+     * Creates a storage config
+     *
+     * @param int|null $id config id or null for a new config
+     */
+    public function __construct($id = null) {
+        $this->id = $id;
+        $this->mountOptions['enable_sharing'] = false;
+    }
+
+    /**
+     * Returns the configuration id
+     *
+     * @return int
+     */
+    public function getId() {
+        return $this->id;
+    }
+
+    /**
+     * Sets the configuration id
+     *
+     * @param int $id configuration id
+     */
+    public function setId($id) {
+        $this->id = $id;
+    }
+
+    /**
+     * Returns mount point path relative to the user's
+     * "files" folder.
+     *
+     * @return string path
+     */
+    public function getMountPoint() {
+        return $this->mountPoint;
+    }
+
+    /**
+     * Sets mount point path relative to the user's
+     * "files" folder.
+     * The path will be normalized.
+     *
+     * @param string $mountPoint path
+     */
+    public function setMountPoint($mountPoint) {
+        $this->mountPoint = \OC\Files\Filesystem::normalizePath($mountPoint);
+    }
+
+    /**
+     * @return Backend
+     */
+    public function getBackend() {
+        return $this->backend;
+    }
+
+    /**
+     * @param Backend $backend
+     */
+    public function setBackend(Backend $backend) {
+        $this->backend = $backend;
+    }
+
+    /**
+     * @return AuthMechanism
+     */
+    public function getAuthMechanism() {
+        return $this->authMechanism;
+    }
+
+    /**
+     * @param AuthMechanism $authMechanism
+     */
+    public function setAuthMechanism(AuthMechanism $authMechanism) {
+        $this->authMechanism = $authMechanism;
+    }
+
+    /**
+     * Returns the external storage backend-specific options
+     *
+     * @return array backend options
+     */
+    public function getBackendOptions() {
+        return $this->backendOptions;
+    }
+
+    /**
+     * Sets the external storage backend-specific options
+     *
+     * @param array $backendOptions backend options
+     */
+    public function setBackendOptions($backendOptions) {
+        if ($this->getBackend() instanceof  Backend) {
+            $parameters = $this->getBackend()->getParameters();
+            foreach ($backendOptions as $key => $value) {
+                if (isset($parameters[$key])) {
+                    switch ($parameters[$key]->getType()) {
+                        case \OCA\Files_External\Lib\DefinitionParameter::VALUE_BOOLEAN:
+                            $value = (bool)$value;
+                            break;
+                    }
+                    $backendOptions[$key] = $value;
+                }
+            }
+        }
+
+        $this->backendOptions = $backendOptions;
+    }
+
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function getBackendOption($key) {
+        if (isset($this->backendOptions[$key])) {
+            return $this->backendOptions[$key];
+        }
+        return null;
+    }
+
+    /**
+     * @param string $key
+     * @param mixed $value
+     */
+    public function setBackendOption($key, $value) {
+        $this->backendOptions[$key] = $value;
+    }
+
+    /**
+     * Returns the mount priority
+     *
+     * @return int priority
+     */
+    public function getPriority() {
+        return $this->priority;
+    }
+
+    /**
+     * Sets the mount priotity
+     *
+     * @param int $priority priority
+     */
+    public function setPriority($priority) {
+        $this->priority = $priority;
+    }
+
+    /**
+     * Returns the users for which to mount this storage
+     *
+     * @return string[] applicable users
+     */
+    public function getApplicableUsers() {
+        return $this->applicableUsers;
+    }
+
+    /**
+     * Sets the users for which to mount this storage
+     *
+     * @param string[]|null $applicableUsers applicable users
+     */
+    public function setApplicableUsers($applicableUsers) {
+        if (is_null($applicableUsers)) {
+            $applicableUsers = [];
+        }
+        $this->applicableUsers = $applicableUsers;
+    }
+
+    /**
+     * Returns the groups for which to mount this storage
+     *
+     * @return string[] applicable groups
+     */
+    public function getApplicableGroups() {
+        return $this->applicableGroups;
+    }
+
+    /**
+     * Sets the groups for which to mount this storage
+     *
+     * @param string[]|null $applicableGroups applicable groups
+     */
+    public function setApplicableGroups($applicableGroups) {
+        if (is_null($applicableGroups)) {
+            $applicableGroups = [];
+        }
+        $this->applicableGroups = $applicableGroups;
+    }
+
+    /**
+     * Returns the mount-specific options
+     *
+     * @return array mount specific options
+     */
+    public function getMountOptions() {
+        return $this->mountOptions;
+    }
+
+    /**
+     * Sets the mount-specific options
+     *
+     * @param array $mountOptions applicable groups
+     */
+    public function setMountOptions($mountOptions) {
+        if (is_null($mountOptions)) {
+            $mountOptions = [];
+        }
+        $this->mountOptions = $mountOptions;
+    }
+
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function getMountOption($key) {
+        if (isset($this->mountOptions[$key])) {
+            return $this->mountOptions[$key];
+        }
+        return null;
+    }
+
+    /**
+     * @param string $key
+     * @param mixed $value
+     */
+    public function setMountOption($key, $value) {
+        $this->mountOptions[$key] = $value;
+    }
+
+    /**
+     * Gets the storage status, whether the config worked last time
+     *
+     * @return int $status status
+     */
+    public function getStatus() {
+        return $this->status;
+    }
+
+    /**
+     * Gets the message describing the storage status
+     *
+     * @return string|null
+     */
+    public function getStatusMessage() {
+        return $this->statusMessage;
+    }
+
+    /**
+     * Sets the storage status, whether the config worked last time
+     *
+     * @param int $status status
+     * @param string|null $message optional message
+     */
+    public function setStatus($status, $message = null) {
+        $this->status = $status;
+        $this->statusMessage = $message;
+    }
+
+    /**
+     * @return int self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl
+     */
+    public function getType() {
+        return $this->type;
+    }
+
+    /**
+     * @param int $type self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl
+     */
+    public function setType($type) {
+        $this->type = $type;
+    }
+
+    /**
+     * Serialize config to JSON
+     *
+     * @return array
+     */
+    public function jsonSerialize() {
+        $result = [];
+        if (!is_null($this->id)) {
+            $result['id'] = $this->id;
+        }
+        $result['mountPoint'] = $this->mountPoint;
+        $result['backend'] = $this->backend->getIdentifier();
+        $result['authMechanism'] = $this->authMechanism->getIdentifier();
+        $result['backendOptions'] = $this->backendOptions;
+        if (!is_null($this->priority)) {
+            $result['priority'] = $this->priority;
+        }
+        if (!empty($this->applicableUsers)) {
+            $result['applicableUsers'] = $this->applicableUsers;
+        }
+        if (!empty($this->applicableGroups)) {
+            $result['applicableGroups'] = $this->applicableGroups;
+        }
+        if (!empty($this->mountOptions)) {
+            $result['mountOptions'] = $this->mountOptions;
+        }
+        if (!is_null($this->status)) {
+            $result['status'] = $this->status;
+        }
+        if (!is_null($this->statusMessage)) {
+            $result['statusMessage'] = $this->statusMessage;
+        }
+        $result['userProvided'] = $this->authMechanism instanceof IUserProvided;
+        $result['type'] = ($this->getType() === self::MOUNT_TYPE_PERSONAl) ? 'personal': 'system';
+        return $result;
+    }
 }

apps/files_external/lib/AppInfo/Application.php

Indentation +104 added lines, -104 removed lines

@@ -78,108 +78,108 @@
  */
 class Application extends App implements IBackendProvider, IAuthMechanismProvider, IBootstrap {
 
-	/**
-	 * Application constructor.
-	 *
-	 * @throws \OCP\AppFramework\QueryException
-	 */
-	public function __construct(array $urlParams = []) {
-		parent::__construct('files_external', $urlParams);
-	}
-
-	public function register(IRegistrationContext $context): void {
-		$context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
-		$context->registerEventListener(GroupDeletedEvent::class, GroupDeletedListener::class);
-	}
-
-	public function boot(IBootContext $context): void {
-		$context->injectFn(function (IMountProviderCollection $mountProviderCollection, ConfigAdapter $configAdapter) {
-			$mountProviderCollection->registerProvider($configAdapter);
-		});
-		\OCA\Files\App::getNavigationManager()->add(function () {
-			$l = \OC::$server->getL10N('files_external');
-			return [
-				'id' => 'extstoragemounts',
-				'appname' => 'files_external',
-				'script' => 'list.php',
-				'order' => 30,
-				'name' => $l->t('External storage'),
-			];
-		});
-		$context->injectFn(function (BackendService $backendService, UserPlaceholderHandler $userConfigHandler) {
-			$backendService->registerBackendProvider($this);
-			$backendService->registerAuthMechanismProvider($this);
-			$backendService->registerConfigHandler('user', function () use ($userConfigHandler) {
-				return $userConfigHandler;
-			});
-		});
-
-		// force-load auth mechanisms since some will register hooks
-		// TODO: obsolete these and use the TokenProvider to get the user's password from the session
-		$this->getAuthMechanisms();
-	}
-
-	/**
-	 * @{inheritdoc}
-	 */
-	public function getBackends() {
-		$container = $this->getContainer();
-
-		$backends = [
-			$container->query(Local::class),
-			$container->query(FTP::class),
-			$container->query(DAV::class),
-			$container->query(OwnCloud::class),
-			$container->query(SFTP::class),
-			$container->query(AmazonS3::class),
-			$container->query(Swift::class),
-			$container->query(SFTP_Key::class),
-			$container->query(SMB::class),
-			$container->query(SMB_OC::class),
-		];
-
-		return $backends;
-	}
-
-	/**
-	 * @{inheritdoc}
-	 */
-	public function getAuthMechanisms() {
-		$container = $this->getContainer();
-
-		return [
-			// AuthMechanism::SCHEME_NULL mechanism
-			$container->query(NullMechanism::class),
-
-			// AuthMechanism::SCHEME_BUILTIN mechanism
-			$container->query(Builtin::class),
-
-			// AuthMechanism::SCHEME_PASSWORD mechanisms
-			$container->query(Password::class),
-			$container->query(SessionCredentials::class),
-			$container->query(LoginCredentials::class),
-			$container->query(UserProvided::class),
-			$container->query(GlobalAuth::class),
-			$container->query(UserGlobalAuth::class),
-
-			// AuthMechanism::SCHEME_OAUTH1 mechanisms
-			$container->query(OAuth1::class),
-
-			// AuthMechanism::SCHEME_OAUTH2 mechanisms
-			$container->query(OAuth2::class),
-
-			// AuthMechanism::SCHEME_PUBLICKEY mechanisms
-			$container->query(RSA::class),
-			$container->query(RSAPrivateKey::class),
-
-			// AuthMechanism::SCHEME_OPENSTACK mechanisms
-			$container->query(OpenStackV2::class),
-			$container->query(OpenStackV3::class),
-			$container->query(Rackspace::class),
-
-			// Specialized mechanisms
-			$container->query(AccessKey::class),
-			$container->query(KerberosAuth::class),
-		];
-	}
+    /**
+     * Application constructor.
+     *
+     * @throws \OCP\AppFramework\QueryException
+     */
+    public function __construct(array $urlParams = []) {
+        parent::__construct('files_external', $urlParams);
+    }
+
+    public function register(IRegistrationContext $context): void {
+        $context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
+        $context->registerEventListener(GroupDeletedEvent::class, GroupDeletedListener::class);
+    }
+
+    public function boot(IBootContext $context): void {
+        $context->injectFn(function (IMountProviderCollection $mountProviderCollection, ConfigAdapter $configAdapter) {
+            $mountProviderCollection->registerProvider($configAdapter);
+        });
+        \OCA\Files\App::getNavigationManager()->add(function () {
+            $l = \OC::$server->getL10N('files_external');
+            return [
+                'id' => 'extstoragemounts',
+                'appname' => 'files_external',
+                'script' => 'list.php',
+                'order' => 30,
+                'name' => $l->t('External storage'),
+            ];
+        });
+        $context->injectFn(function (BackendService $backendService, UserPlaceholderHandler $userConfigHandler) {
+            $backendService->registerBackendProvider($this);
+            $backendService->registerAuthMechanismProvider($this);
+            $backendService->registerConfigHandler('user', function () use ($userConfigHandler) {
+                return $userConfigHandler;
+            });
+        });
+
+        // force-load auth mechanisms since some will register hooks
+        // TODO: obsolete these and use the TokenProvider to get the user's password from the session
+        $this->getAuthMechanisms();
+    }
+
+    /**
+     * @{inheritdoc}
+     */
+    public function getBackends() {
+        $container = $this->getContainer();
+
+        $backends = [
+            $container->query(Local::class),
+            $container->query(FTP::class),
+            $container->query(DAV::class),
+            $container->query(OwnCloud::class),
+            $container->query(SFTP::class),
+            $container->query(AmazonS3::class),
+            $container->query(Swift::class),
+            $container->query(SFTP_Key::class),
+            $container->query(SMB::class),
+            $container->query(SMB_OC::class),
+        ];
+
+        return $backends;
+    }
+
+    /**
+     * @{inheritdoc}
+     */
+    public function getAuthMechanisms() {
+        $container = $this->getContainer();
+
+        return [
+            // AuthMechanism::SCHEME_NULL mechanism
+            $container->query(NullMechanism::class),
+
+            // AuthMechanism::SCHEME_BUILTIN mechanism
+            $container->query(Builtin::class),
+
+            // AuthMechanism::SCHEME_PASSWORD mechanisms
+            $container->query(Password::class),
+            $container->query(SessionCredentials::class),
+            $container->query(LoginCredentials::class),
+            $container->query(UserProvided::class),
+            $container->query(GlobalAuth::class),
+            $container->query(UserGlobalAuth::class),
+
+            // AuthMechanism::SCHEME_OAUTH1 mechanisms
+            $container->query(OAuth1::class),
+
+            // AuthMechanism::SCHEME_OAUTH2 mechanisms
+            $container->query(OAuth2::class),
+
+            // AuthMechanism::SCHEME_PUBLICKEY mechanisms
+            $container->query(RSA::class),
+            $container->query(RSAPrivateKey::class),
+
+            // AuthMechanism::SCHEME_OPENSTACK mechanisms
+            $container->query(OpenStackV2::class),
+            $container->query(OpenStackV3::class),
+            $container->query(Rackspace::class),
+
+            // Specialized mechanisms
+            $container->query(AccessKey::class),
+            $container->query(KerberosAuth::class),
+        ];
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -71,7 +71,7 @@ 
 use OCP\Group\Events\GroupDeletedEvent;
 use OCP\User\Events\UserDeletedEvent;
 
-require_once __DIR__ . '/../../3rdparty/autoload.php';
+require_once __DIR__.'/../../3rdparty/autoload.php';
 
 /**
  * @package OCA\Files_External\AppInfo
@@ -93,10 +93,10 @@ 
 	}
 
 	public function boot(IBootContext $context): void {
-		$context->injectFn(function (IMountProviderCollection $mountProviderCollection, ConfigAdapter $configAdapter) {
+		$context->injectFn(function(IMountProviderCollection $mountProviderCollection, ConfigAdapter $configAdapter) {
 			$mountProviderCollection->registerProvider($configAdapter);
 		});
-		\OCA\Files\App::getNavigationManager()->add(function () {
+		\OCA\Files\App::getNavigationManager()->add(function() {
 			$l = \OC::$server->getL10N('files_external');
 			return [
 				'id' => 'extstoragemounts',
@@ -106,10 +106,10 @@ 
 				'name' => $l->t('External storage'),
 			];
 		});
-		$context->injectFn(function (BackendService $backendService, UserPlaceholderHandler $userConfigHandler) {
+		$context->injectFn(function(BackendService $backendService, UserPlaceholderHandler $userConfigHandler) {
 			$backendService->registerBackendProvider($this);
 			$backendService->registerAuthMechanismProvider($this);
-			$backendService->registerConfigHandler('user', function () use ($userConfigHandler) {
+			$backendService->registerConfigHandler('user', function() use ($userConfigHandler) {
 				return $userConfigHandler;
 			});
 		});

apps/files_external/lib/Listener/UserDeletedListener.php

Indentation +11 added lines, -11 removed lines

@@ -29,17 +29,17 @@
 use OCP\User\Events\UserDeletedEvent;
 
 class UserDeletedListener implements IEventListener {
-	/** @var DBConfigService */
-	private $config;
+    /** @var DBConfigService */
+    private $config;
 
-	public function __construct(DBConfigService $config) {
-		$this->config = $config;
-	}
+    public function __construct(DBConfigService $config) {
+        $this->config = $config;
+    }
 
-	public function handle(Event $event): void {
-		if (!$event instanceof UserDeletedEvent) {
-			return;
-		}
-		$this->config->modifyMountsOnUserDelete($event->getUser()->getUID());
-	}
+    public function handle(Event $event): void {
+        if (!$event instanceof UserDeletedEvent) {
+            return;
+        }
+        $this->config->modifyMountsOnUserDelete($event->getUser()->getUID());
+    }
 }

apps/files_external/lib/Listener/GroupDeletedListener.php

Indentation +11 added lines, -11 removed lines

@@ -29,17 +29,17 @@
 use OCP\Group\Events\GroupDeletedEvent;
 
 class GroupDeletedListener implements IEventListener {
-	/** @var DBConfigService */
-	private $config;
+    /** @var DBConfigService */
+    private $config;
 
-	public function __construct(DBConfigService $config) {
-		$this->config = $config;
-	}
+    public function __construct(DBConfigService $config) {
+        $this->config = $config;
+    }
 
-	public function handle(Event $event): void {
-		if (!$event instanceof GroupDeletedEvent) {
-			return;
-		}
-		$this->config->modifyMountsOnGroupDelete($event->getGroup()->getGID());
-	}
+    public function handle(Event $event): void {
+        if (!$event instanceof GroupDeletedEvent) {
+            return;
+        }
+        $this->config->modifyMountsOnGroupDelete($event->getGroup()->getGID());
+    }
 }