nextcloud / server

apps/files_external/lib/Service/UserLegacyStoragesService.php

Indentation +22 added lines, -22 removed lines

@@ -29,28 +29,28 @@
  * Read user defined mounts from the legacy mount.json
  */
 class UserLegacyStoragesService extends LegacyStoragesService {
-	/**
-	 * @var IUserSession
-	 */
-	private $userSession;
+    /**
+     * @var IUserSession
+     */
+    private $userSession;
 
-	/**
-	 * @param BackendService $backendService
-	 * @param IUserSession $userSession
-	 */
-	public function __construct(BackendService $backendService, IUserSession $userSession) {
-		$this->backendService = $backendService;
-		$this->userSession = $userSession;
-	}
+    /**
+     * @param BackendService $backendService
+     * @param IUserSession $userSession
+     */
+    public function __construct(BackendService $backendService, IUserSession $userSession) {
+        $this->backendService = $backendService;
+        $this->userSession = $userSession;
+    }
 
-	/**
-	 * Read legacy config data
-	 *
-	 * @return array list of storage configs
-	 */
-	protected function readLegacyConfig() {
-		// read user config
-		$user = $this->userSession->getUser()->getUID();
-		return \OC_Mount_Config::readData($user);
-	}
+    /**
+     * Read legacy config data
+     *
+     * @return array list of storage configs
+     */
+    protected function readLegacyConfig() {
+        // read user config
+        $user = $this->userSession->getUser()->getUID();
+        return \OC_Mount_Config::readData($user);
+    }
 }

apps/files_external/lib/Service/DBConfigService.php

Indentation +452 added lines, -452 removed lines

@@ -32,456 +32,456 @@
  * Stores the mount config in the database
  */
 class DBConfigService {
-	const MOUNT_TYPE_ADMIN = 1;
-	const MOUNT_TYPE_PERSONAl = 2;
-
-	const APPLICABLE_TYPE_GLOBAL = 1;
-	const APPLICABLE_TYPE_GROUP = 2;
-	const APPLICABLE_TYPE_USER = 3;
-
-	/**
-	 * @var IDBConnection
-	 */
-	private $connection;
-
-	/**
-	 * @var ICrypto
-	 */
-	private $crypto;
-
-	/**
-	 * DBConfigService constructor.
-	 *
-	 * @param IDBConnection $connection
-	 * @param ICrypto $crypto
-	 */
-	public function __construct(IDBConnection $connection, ICrypto $crypto) {
-		$this->connection = $connection;
-		$this->crypto = $crypto;
-	}
-
-	/**
-	 * @param int $mountId
-	 * @return array
-	 */
-	public function getMountById($mountId) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select(['mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'type'])
-			->from('external_mounts', 'm')
-			->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
-		$mounts = $this->getMountsFromQuery($query);
-		if (count($mounts) > 0) {
-			return $mounts[0];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Get all configured mounts
-	 *
-	 * @return array
-	 */
-	public function getAllMounts() {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select(['mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'type'])
-			->from('external_mounts');
-		return $this->getMountsFromQuery($query);
-	}
-
-	public function getMountsForUser($userId, $groupIds) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select(['m.mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'm.type'])
-			->from('external_mounts', 'm')
-			->innerJoin('m', 'external_applicable', 'a', $builder->expr()->eq('m.mount_id', 'a.mount_id'))
-			->where($builder->expr()->orX(
-				$builder->expr()->andX( // global mounts
-					$builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_GLOBAL, IQueryBuilder::PARAM_INT)),
-					$builder->expr()->isNull('a.value')
-				),
-				$builder->expr()->andX( // mounts for user
-					$builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_USER, IQueryBuilder::PARAM_INT)),
-					$builder->expr()->eq('a.value', $builder->createNamedParameter($userId))
-				),
-				$builder->expr()->andX( // mounts for group
-					$builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_GROUP, IQueryBuilder::PARAM_INT)),
-					$builder->expr()->in('a.value', $builder->createNamedParameter($groupIds, IQueryBuilder::PARAM_INT_ARRAY))
-				)
-			));
-
-		return $this->getMountsFromQuery($query);
-	}
-
-	/**
-	 * Get admin defined mounts
-	 *
-	 * @return array
-	 */
-	public function getAdminMounts() {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select(['mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'type'])
-			->from('external_mounts')
-			->where($builder->expr()->eq('type', $builder->expr()->literal(self::MOUNT_TYPE_ADMIN, IQueryBuilder::PARAM_INT)));
-		return $this->getMountsFromQuery($query);
-	}
-
-	protected function getForQuery(IQueryBuilder $builder, $type, $value) {
-		$query = $builder->select(['m.mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'm.type'])
-			->from('external_mounts', 'm')
-			->innerJoin('m', 'external_applicable', 'a', $builder->expr()->eq('m.mount_id', 'a.mount_id'))
-			->where($builder->expr()->eq('a.type', $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)));
-
-		if (is_null($value)) {
-			$query = $query->andWhere($builder->expr()->isNull('a.value'));
-		} else {
-			$query = $query->andWhere($builder->expr()->eq('a.value', $builder->createNamedParameter($value)));
-		}
-
-		return $query;
-	}
-
-	/**
-	 * Get mounts by applicable
-	 *
-	 * @param int $type any of the self::APPLICABLE_TYPE_ constants
-	 * @param string|null $value user_id, group_id or null for global mounts
-	 * @return array
-	 */
-	public function getMountsFor($type, $value) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $this->getForQuery($builder, $type, $value);
-
-		return $this->getMountsFromQuery($query);
-	}
-
-	/**
-	 * Get admin defined mounts by applicable
-	 *
-	 * @param int $type any of the self::APPLICABLE_TYPE_ constants
-	 * @param string|null $value user_id, group_id or null for global mounts
-	 * @return array
-	 */
-	public function getAdminMountsFor($type, $value) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $this->getForQuery($builder, $type, $value);
-		$query->andWhere($builder->expr()->eq('m.type', $builder->expr()->literal(self::MOUNT_TYPE_ADMIN, IQueryBuilder::PARAM_INT)));
-
-		return $this->getMountsFromQuery($query);
-	}
-
-	/**
-	 * Get admin defined mounts for multiple applicable
-	 *
-	 * @param int $type any of the self::APPLICABLE_TYPE_ constants
-	 * @param string[] $values user_ids or group_ids
-	 * @return array
-	 */
-	public function getAdminMountsForMultiple($type, array $values) {
-		$builder = $this->connection->getQueryBuilder();
-		$params = array_map(function ($value) use ($builder) {
-			return $builder->createNamedParameter($value, IQueryBuilder::PARAM_STR);
-		}, $values);
-
-		$query = $builder->select(['m.mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'm.type'])
-			->from('external_mounts', 'm')
-			->innerJoin('m', 'external_applicable', 'a', $builder->expr()->eq('m.mount_id', 'a.mount_id'))
-			->where($builder->expr()->eq('a.type', $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)))
-			->andWhere($builder->expr()->in('a.value', $params));
-		$query->andWhere($builder->expr()->eq('m.type', $builder->expr()->literal(self::MOUNT_TYPE_ADMIN, IQueryBuilder::PARAM_INT)));
-
-		return $this->getMountsFromQuery($query);
-	}
-
-	/**
-	 * Get user defined mounts by applicable
-	 *
-	 * @param int $type any of the self::APPLICABLE_TYPE_ constants
-	 * @param string|null $value user_id, group_id or null for global mounts
-	 * @return array
-	 */
-	public function getUserMountsFor($type, $value) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $this->getForQuery($builder, $type, $value);
-		$query->andWhere($builder->expr()->eq('m.type', $builder->expr()->literal(self::MOUNT_TYPE_PERSONAl, IQueryBuilder::PARAM_INT)));
-
-		return $this->getMountsFromQuery($query);
-	}
-
-	/**
-	 * Add a mount to the database
-	 *
-	 * @param string $mountPoint
-	 * @param string $storageBackend
-	 * @param string $authBackend
-	 * @param int $priority
-	 * @param int $type self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAL
-	 * @return int the id of the new mount
-	 */
-	public function addMount($mountPoint, $storageBackend, $authBackend, $priority, $type) {
-		if (!$priority) {
-			$priority = 100;
-		}
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->insert('external_mounts')
-			->values([
-				'mount_point' => $builder->createNamedParameter($mountPoint, IQueryBuilder::PARAM_STR),
-				'storage_backend' => $builder->createNamedParameter($storageBackend, IQueryBuilder::PARAM_STR),
-				'auth_backend' => $builder->createNamedParameter($authBackend, IQueryBuilder::PARAM_STR),
-				'priority' => $builder->createNamedParameter($priority, IQueryBuilder::PARAM_INT),
-				'type' => $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)
-			]);
-		$query->execute();
-		return (int)$this->connection->lastInsertId('*PREFIX*external_mounts');
-	}
-
-	/**
-	 * Remove a mount from the database
-	 *
-	 * @param int $mountId
-	 */
-	public function removeMount($mountId) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->delete('external_mounts')
-			->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-
-		$query = $builder->delete('external_applicable')
-			->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-
-		$query = $builder->delete('external_config')
-			->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-
-		$query = $builder->delete('external_options')
-			->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	/**
-	 * @param int $mountId
-	 * @param string $newMountPoint
-	 */
-	public function setMountPoint($mountId, $newMountPoint) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->update('external_mounts')
-			->set('mount_point', $builder->createNamedParameter($newMountPoint))
-			->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
-
-		$query->execute();
-	}
-
-	/**
-	 * @param int $mountId
-	 * @param string $newAuthBackend
-	 */
-	public function setAuthBackend($mountId, $newAuthBackend) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->update('external_mounts')
-			->set('auth_backend', $builder->createNamedParameter($newAuthBackend))
-			->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
-
-		$query->execute();
-	}
-
-	/**
-	 * @param int $mountId
-	 * @param string $key
-	 * @param string $value
-	 */
-	public function setConfig($mountId, $key, $value) {
-		if ($key === 'password') {
-			$value = $this->encryptValue($value);
-		}
-		$count = $this->connection->insertIfNotExist('*PREFIX*external_config', [
-			'mount_id' => $mountId,
-			'key' => $key,
-			'value' => $value
-		], ['mount_id', 'key']);
-		if ($count === 0) {
-			$builder = $this->connection->getQueryBuilder();
-			$query = $builder->update('external_config')
-				->set('value', $builder->createNamedParameter($value, IQueryBuilder::PARAM_STR))
-				->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
-				->andWhere($builder->expr()->eq('key', $builder->createNamedParameter($key, IQueryBuilder::PARAM_STR)));
-			$query->execute();
-		}
-	}
-
-	/**
-	 * @param int $mountId
-	 * @param string $key
-	 * @param string $value
-	 */
-	public function setOption($mountId, $key, $value) {
-
-		$count = $this->connection->insertIfNotExist('*PREFIX*external_options', [
-			'mount_id' => $mountId,
-			'key' => $key,
-			'value' => json_encode($value)
-		], ['mount_id', 'key']);
-		if ($count === 0) {
-			$builder = $this->connection->getQueryBuilder();
-			$query = $builder->update('external_options')
-				->set('value', $builder->createNamedParameter(json_encode($value), IQueryBuilder::PARAM_STR))
-				->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
-				->andWhere($builder->expr()->eq('key', $builder->createNamedParameter($key, IQueryBuilder::PARAM_STR)));
-			$query->execute();
-		}
-	}
-
-	public function addApplicable($mountId, $type, $value) {
-		$this->connection->insertIfNotExist('*PREFIX*external_applicable', [
-			'mount_id' => $mountId,
-			'type' => $type,
-			'value' => $value
-		], ['mount_id', 'type', 'value']);
-	}
-
-	public function removeApplicable($mountId, $type, $value) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->delete('external_applicable')
-			->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
-			->andWhere($builder->expr()->eq('type', $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)));
-
-		if (is_null($value)) {
-			$query = $query->andWhere($builder->expr()->isNull('value'));
-		} else {
-			$query = $query->andWhere($builder->expr()->eq('value', $builder->createNamedParameter($value, IQueryBuilder::PARAM_STR)));
-		}
-
-		$query->execute();
-	}
-
-	private function getMountsFromQuery(IQueryBuilder $query) {
-		$result = $query->execute();
-		$mounts = $result->fetchAll();
-		$uniqueMounts = [];
-		foreach ($mounts as $mount) {
-			$id = $mount['mount_id'];
-			if (!isset($uniqueMounts[$id])) {
-				$uniqueMounts[$id] = $mount;
-			}
-		}
-		$uniqueMounts = array_values($uniqueMounts);
-
-		$mountIds = array_map(function ($mount) {
-			return $mount['mount_id'];
-		}, $uniqueMounts);
-		$mountIds = array_values(array_unique($mountIds));
-
-		$applicable = $this->getApplicableForMounts($mountIds);
-		$config = $this->getConfigForMounts($mountIds);
-		$options = $this->getOptionsForMounts($mountIds);
-
-		return array_map(function ($mount, $applicable, $config, $options) {
-			$mount['type'] = (int)$mount['type'];
-			$mount['priority'] = (int)$mount['priority'];
-			$mount['applicable'] = $applicable;
-			$mount['config'] = $config;
-			$mount['options'] = $options;
-			return $mount;
-		}, $uniqueMounts, $applicable, $config, $options);
-	}
-
-	/**
-	 * Get mount options from a table grouped by mount id
-	 *
-	 * @param string $table
-	 * @param string[] $fields
-	 * @param int[] $mountIds
-	 * @return array [$mountId => [['field1' => $value1, ...], ...], ...]
-	 */
-	private function selectForMounts($table, array $fields, array $mountIds) {
-		if (count($mountIds) === 0) {
-			return [];
-		}
-		$builder = $this->connection->getQueryBuilder();
-		$fields[] = 'mount_id';
-		$placeHolders = array_map(function ($id) use ($builder) {
-			return $builder->createPositionalParameter($id, IQueryBuilder::PARAM_INT);
-		}, $mountIds);
-		$query = $builder->select($fields)
-			->from($table)
-			->where($builder->expr()->in('mount_id', $placeHolders));
-		$rows = $query->execute()->fetchAll();
-
-		$result = [];
-		foreach ($mountIds as $mountId) {
-			$result[$mountId] = [];
-		}
-		foreach ($rows as $row) {
-			if (isset($row['type'])) {
-				$row['type'] = (int)$row['type'];
-			}
-			$result[$row['mount_id']][] = $row;
-		}
-		return $result;
-	}
-
-	/**
-	 * @param int[] $mountIds
-	 * @return array [$id => [['type' => $type, 'value' => $value], ...], ...]
-	 */
-	public function getApplicableForMounts($mountIds) {
-		return $this->selectForMounts('external_applicable', ['type', 'value'], $mountIds);
-	}
-
-	/**
-	 * @param int[] $mountIds
-	 * @return array [$id => ['key1' => $value1, ...], ...]
-	 */
-	public function getConfigForMounts($mountIds) {
-		$mountConfigs = $this->selectForMounts('external_config', ['key', 'value'], $mountIds);
-		return array_map([$this, 'createKeyValueMap'], $mountConfigs);
-	}
-
-	/**
-	 * @param int[] $mountIds
-	 * @return array [$id => ['key1' => $value1, ...], ...]
-	 */
-	public function getOptionsForMounts($mountIds) {
-		$mountOptions = $this->selectForMounts('external_options', ['key', 'value'], $mountIds);
-		$optionsMap = array_map([$this, 'createKeyValueMap'], $mountOptions);
-		return array_map(function (array $options) {
-			return array_map(function ($option) {
-				return json_decode($option);
-			}, $options);
-		}, $optionsMap);
-	}
-
-	/**
-	 * @param array $keyValuePairs [['key'=>$key, 'value=>$value], ...]
-	 * @return array ['key1' => $value1, ...]
-	 */
-	private function createKeyValueMap(array $keyValuePairs) {
-		$decryptedPairts = array_map(function ($pair) {
-			if ($pair['key'] === 'password') {
-				$pair['value'] = $this->decryptValue($pair['value']);
-			}
-			return $pair;
-		}, $keyValuePairs);
-		$keys = array_map(function ($pair) {
-			return $pair['key'];
-		}, $decryptedPairts);
-		$values = array_map(function ($pair) {
-			return $pair['value'];
-		}, $decryptedPairts);
-
-		return array_combine($keys, $values);
-	}
-
-	private function encryptValue($value) {
-		return $this->crypto->encrypt($value);
-	}
-
-	private function decryptValue($value) {
-		try {
-			return $this->crypto->decrypt($value);
-		} catch (\Exception $e) {
-			return $value;
-		}
-	}
+    const MOUNT_TYPE_ADMIN = 1;
+    const MOUNT_TYPE_PERSONAl = 2;
+
+    const APPLICABLE_TYPE_GLOBAL = 1;
+    const APPLICABLE_TYPE_GROUP = 2;
+    const APPLICABLE_TYPE_USER = 3;
+
+    /**
+     * @var IDBConnection
+     */
+    private $connection;
+
+    /**
+     * @var ICrypto
+     */
+    private $crypto;
+
+    /**
+     * DBConfigService constructor.
+     *
+     * @param IDBConnection $connection
+     * @param ICrypto $crypto
+     */
+    public function __construct(IDBConnection $connection, ICrypto $crypto) {
+        $this->connection = $connection;
+        $this->crypto = $crypto;
+    }
+
+    /**
+     * @param int $mountId
+     * @return array
+     */
+    public function getMountById($mountId) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select(['mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'type'])
+            ->from('external_mounts', 'm')
+            ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
+        $mounts = $this->getMountsFromQuery($query);
+        if (count($mounts) > 0) {
+            return $mounts[0];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get all configured mounts
+     *
+     * @return array
+     */
+    public function getAllMounts() {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select(['mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'type'])
+            ->from('external_mounts');
+        return $this->getMountsFromQuery($query);
+    }
+
+    public function getMountsForUser($userId, $groupIds) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select(['m.mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'm.type'])
+            ->from('external_mounts', 'm')
+            ->innerJoin('m', 'external_applicable', 'a', $builder->expr()->eq('m.mount_id', 'a.mount_id'))
+            ->where($builder->expr()->orX(
+                $builder->expr()->andX( // global mounts
+                    $builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_GLOBAL, IQueryBuilder::PARAM_INT)),
+                    $builder->expr()->isNull('a.value')
+                ),
+                $builder->expr()->andX( // mounts for user
+                    $builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_USER, IQueryBuilder::PARAM_INT)),
+                    $builder->expr()->eq('a.value', $builder->createNamedParameter($userId))
+                ),
+                $builder->expr()->andX( // mounts for group
+                    $builder->expr()->eq('a.type', $builder->createNamedParameter(self::APPLICABLE_TYPE_GROUP, IQueryBuilder::PARAM_INT)),
+                    $builder->expr()->in('a.value', $builder->createNamedParameter($groupIds, IQueryBuilder::PARAM_INT_ARRAY))
+                )
+            ));
+
+        return $this->getMountsFromQuery($query);
+    }
+
+    /**
+     * Get admin defined mounts
+     *
+     * @return array
+     */
+    public function getAdminMounts() {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select(['mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'type'])
+            ->from('external_mounts')
+            ->where($builder->expr()->eq('type', $builder->expr()->literal(self::MOUNT_TYPE_ADMIN, IQueryBuilder::PARAM_INT)));
+        return $this->getMountsFromQuery($query);
+    }
+
+    protected function getForQuery(IQueryBuilder $builder, $type, $value) {
+        $query = $builder->select(['m.mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'm.type'])
+            ->from('external_mounts', 'm')
+            ->innerJoin('m', 'external_applicable', 'a', $builder->expr()->eq('m.mount_id', 'a.mount_id'))
+            ->where($builder->expr()->eq('a.type', $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)));
+
+        if (is_null($value)) {
+            $query = $query->andWhere($builder->expr()->isNull('a.value'));
+        } else {
+            $query = $query->andWhere($builder->expr()->eq('a.value', $builder->createNamedParameter($value)));
+        }
+
+        return $query;
+    }
+
+    /**
+     * Get mounts by applicable
+     *
+     * @param int $type any of the self::APPLICABLE_TYPE_ constants
+     * @param string|null $value user_id, group_id or null for global mounts
+     * @return array
+     */
+    public function getMountsFor($type, $value) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $this->getForQuery($builder, $type, $value);
+
+        return $this->getMountsFromQuery($query);
+    }
+
+    /**
+     * Get admin defined mounts by applicable
+     *
+     * @param int $type any of the self::APPLICABLE_TYPE_ constants
+     * @param string|null $value user_id, group_id or null for global mounts
+     * @return array
+     */
+    public function getAdminMountsFor($type, $value) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $this->getForQuery($builder, $type, $value);
+        $query->andWhere($builder->expr()->eq('m.type', $builder->expr()->literal(self::MOUNT_TYPE_ADMIN, IQueryBuilder::PARAM_INT)));
+
+        return $this->getMountsFromQuery($query);
+    }
+
+    /**
+     * Get admin defined mounts for multiple applicable
+     *
+     * @param int $type any of the self::APPLICABLE_TYPE_ constants
+     * @param string[] $values user_ids or group_ids
+     * @return array
+     */
+    public function getAdminMountsForMultiple($type, array $values) {
+        $builder = $this->connection->getQueryBuilder();
+        $params = array_map(function ($value) use ($builder) {
+            return $builder->createNamedParameter($value, IQueryBuilder::PARAM_STR);
+        }, $values);
+
+        $query = $builder->select(['m.mount_id', 'mount_point', 'storage_backend', 'auth_backend', 'priority', 'm.type'])
+            ->from('external_mounts', 'm')
+            ->innerJoin('m', 'external_applicable', 'a', $builder->expr()->eq('m.mount_id', 'a.mount_id'))
+            ->where($builder->expr()->eq('a.type', $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)))
+            ->andWhere($builder->expr()->in('a.value', $params));
+        $query->andWhere($builder->expr()->eq('m.type', $builder->expr()->literal(self::MOUNT_TYPE_ADMIN, IQueryBuilder::PARAM_INT)));
+
+        return $this->getMountsFromQuery($query);
+    }
+
+    /**
+     * Get user defined mounts by applicable
+     *
+     * @param int $type any of the self::APPLICABLE_TYPE_ constants
+     * @param string|null $value user_id, group_id or null for global mounts
+     * @return array
+     */
+    public function getUserMountsFor($type, $value) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $this->getForQuery($builder, $type, $value);
+        $query->andWhere($builder->expr()->eq('m.type', $builder->expr()->literal(self::MOUNT_TYPE_PERSONAl, IQueryBuilder::PARAM_INT)));
+
+        return $this->getMountsFromQuery($query);
+    }
+
+    /**
+     * Add a mount to the database
+     *
+     * @param string $mountPoint
+     * @param string $storageBackend
+     * @param string $authBackend
+     * @param int $priority
+     * @param int $type self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAL
+     * @return int the id of the new mount
+     */
+    public function addMount($mountPoint, $storageBackend, $authBackend, $priority, $type) {
+        if (!$priority) {
+            $priority = 100;
+        }
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->insert('external_mounts')
+            ->values([
+                'mount_point' => $builder->createNamedParameter($mountPoint, IQueryBuilder::PARAM_STR),
+                'storage_backend' => $builder->createNamedParameter($storageBackend, IQueryBuilder::PARAM_STR),
+                'auth_backend' => $builder->createNamedParameter($authBackend, IQueryBuilder::PARAM_STR),
+                'priority' => $builder->createNamedParameter($priority, IQueryBuilder::PARAM_INT),
+                'type' => $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)
+            ]);
+        $query->execute();
+        return (int)$this->connection->lastInsertId('*PREFIX*external_mounts');
+    }
+
+    /**
+     * Remove a mount from the database
+     *
+     * @param int $mountId
+     */
+    public function removeMount($mountId) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->delete('external_mounts')
+            ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+
+        $query = $builder->delete('external_applicable')
+            ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+
+        $query = $builder->delete('external_config')
+            ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+
+        $query = $builder->delete('external_options')
+            ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    /**
+     * @param int $mountId
+     * @param string $newMountPoint
+     */
+    public function setMountPoint($mountId, $newMountPoint) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->update('external_mounts')
+            ->set('mount_point', $builder->createNamedParameter($newMountPoint))
+            ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
+
+        $query->execute();
+    }
+
+    /**
+     * @param int $mountId
+     * @param string $newAuthBackend
+     */
+    public function setAuthBackend($mountId, $newAuthBackend) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->update('external_mounts')
+            ->set('auth_backend', $builder->createNamedParameter($newAuthBackend))
+            ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)));
+
+        $query->execute();
+    }
+
+    /**
+     * @param int $mountId
+     * @param string $key
+     * @param string $value
+     */
+    public function setConfig($mountId, $key, $value) {
+        if ($key === 'password') {
+            $value = $this->encryptValue($value);
+        }
+        $count = $this->connection->insertIfNotExist('*PREFIX*external_config', [
+            'mount_id' => $mountId,
+            'key' => $key,
+            'value' => $value
+        ], ['mount_id', 'key']);
+        if ($count === 0) {
+            $builder = $this->connection->getQueryBuilder();
+            $query = $builder->update('external_config')
+                ->set('value', $builder->createNamedParameter($value, IQueryBuilder::PARAM_STR))
+                ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
+                ->andWhere($builder->expr()->eq('key', $builder->createNamedParameter($key, IQueryBuilder::PARAM_STR)));
+            $query->execute();
+        }
+    }
+
+    /**
+     * @param int $mountId
+     * @param string $key
+     * @param string $value
+     */
+    public function setOption($mountId, $key, $value) {
+
+        $count = $this->connection->insertIfNotExist('*PREFIX*external_options', [
+            'mount_id' => $mountId,
+            'key' => $key,
+            'value' => json_encode($value)
+        ], ['mount_id', 'key']);
+        if ($count === 0) {
+            $builder = $this->connection->getQueryBuilder();
+            $query = $builder->update('external_options')
+                ->set('value', $builder->createNamedParameter(json_encode($value), IQueryBuilder::PARAM_STR))
+                ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
+                ->andWhere($builder->expr()->eq('key', $builder->createNamedParameter($key, IQueryBuilder::PARAM_STR)));
+            $query->execute();
+        }
+    }
+
+    public function addApplicable($mountId, $type, $value) {
+        $this->connection->insertIfNotExist('*PREFIX*external_applicable', [
+            'mount_id' => $mountId,
+            'type' => $type,
+            'value' => $value
+        ], ['mount_id', 'type', 'value']);
+    }
+
+    public function removeApplicable($mountId, $type, $value) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->delete('external_applicable')
+            ->where($builder->expr()->eq('mount_id', $builder->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
+            ->andWhere($builder->expr()->eq('type', $builder->createNamedParameter($type, IQueryBuilder::PARAM_INT)));
+
+        if (is_null($value)) {
+            $query = $query->andWhere($builder->expr()->isNull('value'));
+        } else {
+            $query = $query->andWhere($builder->expr()->eq('value', $builder->createNamedParameter($value, IQueryBuilder::PARAM_STR)));
+        }
+
+        $query->execute();
+    }
+
+    private function getMountsFromQuery(IQueryBuilder $query) {
+        $result = $query->execute();
+        $mounts = $result->fetchAll();
+        $uniqueMounts = [];
+        foreach ($mounts as $mount) {
+            $id = $mount['mount_id'];
+            if (!isset($uniqueMounts[$id])) {
+                $uniqueMounts[$id] = $mount;
+            }
+        }
+        $uniqueMounts = array_values($uniqueMounts);
+
+        $mountIds = array_map(function ($mount) {
+            return $mount['mount_id'];
+        }, $uniqueMounts);
+        $mountIds = array_values(array_unique($mountIds));
+
+        $applicable = $this->getApplicableForMounts($mountIds);
+        $config = $this->getConfigForMounts($mountIds);
+        $options = $this->getOptionsForMounts($mountIds);
+
+        return array_map(function ($mount, $applicable, $config, $options) {
+            $mount['type'] = (int)$mount['type'];
+            $mount['priority'] = (int)$mount['priority'];
+            $mount['applicable'] = $applicable;
+            $mount['config'] = $config;
+            $mount['options'] = $options;
+            return $mount;
+        }, $uniqueMounts, $applicable, $config, $options);
+    }
+
+    /**
+     * Get mount options from a table grouped by mount id
+     *
+     * @param string $table
+     * @param string[] $fields
+     * @param int[] $mountIds
+     * @return array [$mountId => [['field1' => $value1, ...], ...], ...]
+     */
+    private function selectForMounts($table, array $fields, array $mountIds) {
+        if (count($mountIds) === 0) {
+            return [];
+        }
+        $builder = $this->connection->getQueryBuilder();
+        $fields[] = 'mount_id';
+        $placeHolders = array_map(function ($id) use ($builder) {
+            return $builder->createPositionalParameter($id, IQueryBuilder::PARAM_INT);
+        }, $mountIds);
+        $query = $builder->select($fields)
+            ->from($table)
+            ->where($builder->expr()->in('mount_id', $placeHolders));
+        $rows = $query->execute()->fetchAll();
+
+        $result = [];
+        foreach ($mountIds as $mountId) {
+            $result[$mountId] = [];
+        }
+        foreach ($rows as $row) {
+            if (isset($row['type'])) {
+                $row['type'] = (int)$row['type'];
+            }
+            $result[$row['mount_id']][] = $row;
+        }
+        return $result;
+    }
+
+    /**
+     * @param int[] $mountIds
+     * @return array [$id => [['type' => $type, 'value' => $value], ...], ...]
+     */
+    public function getApplicableForMounts($mountIds) {
+        return $this->selectForMounts('external_applicable', ['type', 'value'], $mountIds);
+    }
+
+    /**
+     * @param int[] $mountIds
+     * @return array [$id => ['key1' => $value1, ...], ...]
+     */
+    public function getConfigForMounts($mountIds) {
+        $mountConfigs = $this->selectForMounts('external_config', ['key', 'value'], $mountIds);
+        return array_map([$this, 'createKeyValueMap'], $mountConfigs);
+    }
+
+    /**
+     * @param int[] $mountIds
+     * @return array [$id => ['key1' => $value1, ...], ...]
+     */
+    public function getOptionsForMounts($mountIds) {
+        $mountOptions = $this->selectForMounts('external_options', ['key', 'value'], $mountIds);
+        $optionsMap = array_map([$this, 'createKeyValueMap'], $mountOptions);
+        return array_map(function (array $options) {
+            return array_map(function ($option) {
+                return json_decode($option);
+            }, $options);
+        }, $optionsMap);
+    }
+
+    /**
+     * @param array $keyValuePairs [['key'=>$key, 'value=>$value], ...]
+     * @return array ['key1' => $value1, ...]
+     */
+    private function createKeyValueMap(array $keyValuePairs) {
+        $decryptedPairts = array_map(function ($pair) {
+            if ($pair['key'] === 'password') {
+                $pair['value'] = $this->decryptValue($pair['value']);
+            }
+            return $pair;
+        }, $keyValuePairs);
+        $keys = array_map(function ($pair) {
+            return $pair['key'];
+        }, $decryptedPairts);
+        $values = array_map(function ($pair) {
+            return $pair['value'];
+        }, $decryptedPairts);
+
+        return array_combine($keys, $values);
+    }
+
+    private function encryptValue($value) {
+        return $this->crypto->encrypt($value);
+    }
+
+    private function decryptValue($value) {
+        try {
+            return $this->crypto->decrypt($value);
+        } catch (\Exception $e) {
+            return $value;
+        }
+    }
 }

apps/files_external/lib/Service/LegacyStoragesService.php

Indentation +175 added lines, -175 removed lines

@@ -30,183 +30,183 @@
  * Read mount config from legacy mount.json
  */
 abstract class LegacyStoragesService {
-	/** @var BackendService */
-	protected $backendService;
+    /** @var BackendService */
+    protected $backendService;
 
-	/**
-	 * Read legacy config data
-	 *
-	 * @return array list of mount configs
-	 */
-	abstract protected function readLegacyConfig();
+    /**
+     * Read legacy config data
+     *
+     * @return array list of mount configs
+     */
+    abstract protected function readLegacyConfig();
 
-	/**
-	 * Copy legacy storage options into the given storage config object.
-	 *
-	 * @param StorageConfig $storageConfig storage config to populate
-	 * @param string $mountType mount type
-	 * @param string $applicable applicable user or group
-	 * @param array $storageOptions legacy storage options
-	 *
-	 * @return StorageConfig populated storage config
-	 */
-	protected function populateStorageConfigWithLegacyOptions(
-		&$storageConfig,
-		$mountType,
-		$applicable,
-		$storageOptions
-	) {
-		$backend = $this->backendService->getBackend($storageOptions['backend']);
-		if (!$backend) {
-			throw new \UnexpectedValueException('Invalid backend ' . $storageOptions['backend']);
-		}
-		$storageConfig->setBackend($backend);
-		if (isset($storageOptions['authMechanism']) && $storageOptions['authMechanism'] !== 'builtin::builtin') {
-			$authMechanism = $this->backendService->getAuthMechanism($storageOptions['authMechanism']);
-		} else {
-			$authMechanism = $backend->getLegacyAuthMechanism($storageOptions);
-			$storageOptions['authMechanism'] = 'null'; // to make error handling easier
-		}
-		if (!$authMechanism) {
-			throw new \UnexpectedValueException('Invalid authentication mechanism ' . $storageOptions['authMechanism']);
-		}
-		$storageConfig->setAuthMechanism($authMechanism);
-		$storageConfig->setBackendOptions($storageOptions['options']);
-		if (isset($storageOptions['mountOptions'])) {
-			$storageConfig->setMountOptions($storageOptions['mountOptions']);
-		}
-		if (!isset($storageOptions['priority'])) {
-			$storageOptions['priority'] = $backend->getPriority();
-		}
-		$storageConfig->setPriority($storageOptions['priority']);
-		if ($mountType === \OC_Mount_Config::MOUNT_TYPE_USER) {
-			$applicableUsers = $storageConfig->getApplicableUsers();
-			if ($applicable !== 'all') {
-				$applicableUsers[] = $applicable;
-				$storageConfig->setApplicableUsers($applicableUsers);
-			}
-		} else if ($mountType === \OC_Mount_Config::MOUNT_TYPE_GROUP) {
-			$applicableGroups = $storageConfig->getApplicableGroups();
-			$applicableGroups[] = $applicable;
-			$storageConfig->setApplicableGroups($applicableGroups);
-		}
-		return $storageConfig;
-	}
+    /**
+     * Copy legacy storage options into the given storage config object.
+     *
+     * @param StorageConfig $storageConfig storage config to populate
+     * @param string $mountType mount type
+     * @param string $applicable applicable user or group
+     * @param array $storageOptions legacy storage options
+     *
+     * @return StorageConfig populated storage config
+     */
+    protected function populateStorageConfigWithLegacyOptions(
+        &$storageConfig,
+        $mountType,
+        $applicable,
+        $storageOptions
+    ) {
+        $backend = $this->backendService->getBackend($storageOptions['backend']);
+        if (!$backend) {
+            throw new \UnexpectedValueException('Invalid backend ' . $storageOptions['backend']);
+        }
+        $storageConfig->setBackend($backend);
+        if (isset($storageOptions['authMechanism']) && $storageOptions['authMechanism'] !== 'builtin::builtin') {
+            $authMechanism = $this->backendService->getAuthMechanism($storageOptions['authMechanism']);
+        } else {
+            $authMechanism = $backend->getLegacyAuthMechanism($storageOptions);
+            $storageOptions['authMechanism'] = 'null'; // to make error handling easier
+        }
+        if (!$authMechanism) {
+            throw new \UnexpectedValueException('Invalid authentication mechanism ' . $storageOptions['authMechanism']);
+        }
+        $storageConfig->setAuthMechanism($authMechanism);
+        $storageConfig->setBackendOptions($storageOptions['options']);
+        if (isset($storageOptions['mountOptions'])) {
+            $storageConfig->setMountOptions($storageOptions['mountOptions']);
+        }
+        if (!isset($storageOptions['priority'])) {
+            $storageOptions['priority'] = $backend->getPriority();
+        }
+        $storageConfig->setPriority($storageOptions['priority']);
+        if ($mountType === \OC_Mount_Config::MOUNT_TYPE_USER) {
+            $applicableUsers = $storageConfig->getApplicableUsers();
+            if ($applicable !== 'all') {
+                $applicableUsers[] = $applicable;
+                $storageConfig->setApplicableUsers($applicableUsers);
+            }
+        } else if ($mountType === \OC_Mount_Config::MOUNT_TYPE_GROUP) {
+            $applicableGroups = $storageConfig->getApplicableGroups();
+            $applicableGroups[] = $applicable;
+            $storageConfig->setApplicableGroups($applicableGroups);
+        }
+        return $storageConfig;
+    }
 
-	/**
-	 * Read the external storages config
-	 *
-	 * @return StorageConfig[] map of storage id to storage config
-	 */
-	public function getAllStorages() {
-		$mountPoints = $this->readLegacyConfig();
-		/**
-		 * Here is the how the horribly messy mount point array looks like
-		 * from the mount.json file:
-		 *
-		 * $storageOptions = $mountPoints[$mountType][$applicable][$mountPath]
-		 *
-		 * - $mountType is either "user" or "group"
-		 * - $applicable is the name of a user or group (or the current user for personal mounts)
-		 * - $mountPath is the mount point path (where the storage must be mounted)
-		 * - $storageOptions is a map of storage options:
-		 *     - "priority": storage priority
-		 *     - "backend": backend identifier
-		 *     - "class": LEGACY backend class name
-		 *     - "options": backend-specific options
-		 *     - "authMechanism": authentication mechanism identifier
-		 *     - "mountOptions": mount-specific options (ex: disable previews, scanner, etc)
-		 */
-		// group by storage id
-		/** @var StorageConfig[] $storages */
-		$storages = [];
-		// for storages without id (legacy), group by config hash for
-		// later processing
-		$storagesWithConfigHash = [];
-		foreach ($mountPoints as $mountType => $applicables) {
-			foreach ($applicables as $applicable => $mountPaths) {
-				foreach ($mountPaths as $rootMountPath => $storageOptions) {
-					$currentStorage = null;
-					/**
-					 * Flag whether the config that was read already has an id.
-					 * If not, it will use a config hash instead and generate
-					 * a proper id later
-					 *
-					 * @var boolean
-					 */
-					$hasId = false;
-					// the root mount point is in the format "/$user/files/the/mount/point"
-					// we remove the "/$user/files" prefix
-					$parts = explode('/', ltrim($rootMountPath, '/'), 3);
-					if (count($parts) < 3) {
-						// something went wrong, skip
-						\OCP\Util::writeLog(
-							'files_external',
-							'Could not parse mount point "' . $rootMountPath . '"',
-							\OCP\Util::ERROR
-						);
-						continue;
-					}
-					$relativeMountPath = rtrim($parts[2], '/');
-					// note: we cannot do this after the loop because the decrypted config
-					// options might be needed for the config hash
-					$storageOptions['options'] = \OC_Mount_Config::decryptPasswords($storageOptions['options']);
-					if (!isset($storageOptions['backend'])) {
-						$storageOptions['backend'] = $storageOptions['class']; // legacy compat
-					}
-					if (!isset($storageOptions['authMechanism'])) {
-						$storageOptions['authMechanism'] = null; // ensure config hash works
-					}
-					if (isset($storageOptions['id'])) {
-						$configId = (int)$storageOptions['id'];
-						if (isset($storages[$configId])) {
-							$currentStorage = $storages[$configId];
-						}
-						$hasId = true;
-					} else {
-						// missing id in legacy config, need to generate
-						// but at this point we don't know the max-id, so use
-						// first group it by config hash
-						$storageOptions['mountpoint'] = $rootMountPath;
-						$configId = \OC_Mount_Config::makeConfigHash($storageOptions);
-						if (isset($storagesWithConfigHash[$configId])) {
-							$currentStorage = $storagesWithConfigHash[$configId];
-						}
-					}
-					if (is_null($currentStorage)) {
-						// create new
-						$currentStorage = new StorageConfig($configId);
-						$currentStorage->setMountPoint($relativeMountPath);
-					}
-					try {
-						$this->populateStorageConfigWithLegacyOptions(
-							$currentStorage,
-							$mountType,
-							$applicable,
-							$storageOptions
-						);
-						if ($hasId) {
-							$storages[$configId] = $currentStorage;
-						} else {
-							$storagesWithConfigHash[$configId] = $currentStorage;
-						}
-					} catch (\UnexpectedValueException $e) {
-						// don't die if a storage backend doesn't exist
-						\OCP\Util::writeLog(
-							'files_external',
-							'Could not load storage: "' . $e->getMessage() . '"',
-							\OCP\Util::ERROR
-						);
-					}
-				}
-			}
-		}
+    /**
+     * Read the external storages config
+     *
+     * @return StorageConfig[] map of storage id to storage config
+     */
+    public function getAllStorages() {
+        $mountPoints = $this->readLegacyConfig();
+        /**
+         * Here is the how the horribly messy mount point array looks like
+         * from the mount.json file:
+         *
+         * $storageOptions = $mountPoints[$mountType][$applicable][$mountPath]
+         *
+         * - $mountType is either "user" or "group"
+         * - $applicable is the name of a user or group (or the current user for personal mounts)
+         * - $mountPath is the mount point path (where the storage must be mounted)
+         * - $storageOptions is a map of storage options:
+         *     - "priority": storage priority
+         *     - "backend": backend identifier
+         *     - "class": LEGACY backend class name
+         *     - "options": backend-specific options
+         *     - "authMechanism": authentication mechanism identifier
+         *     - "mountOptions": mount-specific options (ex: disable previews, scanner, etc)
+         */
+        // group by storage id
+        /** @var StorageConfig[] $storages */
+        $storages = [];
+        // for storages without id (legacy), group by config hash for
+        // later processing
+        $storagesWithConfigHash = [];
+        foreach ($mountPoints as $mountType => $applicables) {
+            foreach ($applicables as $applicable => $mountPaths) {
+                foreach ($mountPaths as $rootMountPath => $storageOptions) {
+                    $currentStorage = null;
+                    /**
+                     * Flag whether the config that was read already has an id.
+                     * If not, it will use a config hash instead and generate
+                     * a proper id later
+                     *
+                     * @var boolean
+                     */
+                    $hasId = false;
+                    // the root mount point is in the format "/$user/files/the/mount/point"
+                    // we remove the "/$user/files" prefix
+                    $parts = explode('/', ltrim($rootMountPath, '/'), 3);
+                    if (count($parts) < 3) {
+                        // something went wrong, skip
+                        \OCP\Util::writeLog(
+                            'files_external',
+                            'Could not parse mount point "' . $rootMountPath . '"',
+                            \OCP\Util::ERROR
+                        );
+                        continue;
+                    }
+                    $relativeMountPath = rtrim($parts[2], '/');
+                    // note: we cannot do this after the loop because the decrypted config
+                    // options might be needed for the config hash
+                    $storageOptions['options'] = \OC_Mount_Config::decryptPasswords($storageOptions['options']);
+                    if (!isset($storageOptions['backend'])) {
+                        $storageOptions['backend'] = $storageOptions['class']; // legacy compat
+                    }
+                    if (!isset($storageOptions['authMechanism'])) {
+                        $storageOptions['authMechanism'] = null; // ensure config hash works
+                    }
+                    if (isset($storageOptions['id'])) {
+                        $configId = (int)$storageOptions['id'];
+                        if (isset($storages[$configId])) {
+                            $currentStorage = $storages[$configId];
+                        }
+                        $hasId = true;
+                    } else {
+                        // missing id in legacy config, need to generate
+                        // but at this point we don't know the max-id, so use
+                        // first group it by config hash
+                        $storageOptions['mountpoint'] = $rootMountPath;
+                        $configId = \OC_Mount_Config::makeConfigHash($storageOptions);
+                        if (isset($storagesWithConfigHash[$configId])) {
+                            $currentStorage = $storagesWithConfigHash[$configId];
+                        }
+                    }
+                    if (is_null($currentStorage)) {
+                        // create new
+                        $currentStorage = new StorageConfig($configId);
+                        $currentStorage->setMountPoint($relativeMountPath);
+                    }
+                    try {
+                        $this->populateStorageConfigWithLegacyOptions(
+                            $currentStorage,
+                            $mountType,
+                            $applicable,
+                            $storageOptions
+                        );
+                        if ($hasId) {
+                            $storages[$configId] = $currentStorage;
+                        } else {
+                            $storagesWithConfigHash[$configId] = $currentStorage;
+                        }
+                    } catch (\UnexpectedValueException $e) {
+                        // don't die if a storage backend doesn't exist
+                        \OCP\Util::writeLog(
+                            'files_external',
+                            'Could not load storage: "' . $e->getMessage() . '"',
+                            \OCP\Util::ERROR
+                        );
+                    }
+                }
+            }
+        }
 
-		// convert parameter values
-		foreach ($storages as $storage) {
-			$storage->getBackend()->validateStorageDefinition($storage);
-			$storage->getAuthMechanism()->validateStorageDefinition($storage);
-		}
-		return $storages;
-	}
+        // convert parameter values
+        foreach ($storages as $storage) {
+            $storage->getBackend()->validateStorageDefinition($storage);
+            $storage->getAuthMechanism()->validateStorageDefinition($storage);
+        }
+        return $storages;
+    }
 }

apps/files_external/lib/Service/UserTrait.php

Indentation +37 added lines, -37 removed lines

@@ -30,46 +30,46 @@
  */
 trait UserTrait {
 
-	/** @var IUserSession */
-	protected $userSession;
+    /** @var IUserSession */
+    protected $userSession;
 
-	/**
-	 * User override
-	 *
-	 * @var IUser|null
-	 */
-	private $user = null;
+    /**
+     * User override
+     *
+     * @var IUser|null
+     */
+    private $user = null;
 
-	/**
-	 * @return IUser|null
-	 */
-	protected function getUser() {
-		if ($this->user) {
-			return $this->user;
-		}
-		return $this->userSession->getUser();
-	}
+    /**
+     * @return IUser|null
+     */
+    protected function getUser() {
+        if ($this->user) {
+            return $this->user;
+        }
+        return $this->userSession->getUser();
+    }
 
-	/**
-	 * Override the user from the session
-	 * Unset with ->resetUser() when finished!
-	 *
-	 * @param IUser
-	 * @return self
-	 */
-	public function setUser(IUser $user) {
-		$this->user = $user;
-		return $this;
-	}
+    /**
+     * Override the user from the session
+     * Unset with ->resetUser() when finished!
+     *
+     * @param IUser
+     * @return self
+     */
+    public function setUser(IUser $user) {
+        $this->user = $user;
+        return $this;
+    }
 
-	/**
-	 * Reset the user override
-	 *
-	 * @return self
-	 */
-	public function resetUser() {
-		$this->user = null;
-		return $this;
-	}
+    /**
+     * Reset the user override
+     *
+     * @return self
+     */
+    public function resetUser() {
+        $this->user = null;
+        return $this;
+    }
 }
 

apps/files_external/lib/Service/StoragesService.php

Indentation +486 added lines, -486 removed lines

@@ -41,490 +41,490 @@
  */
 abstract class StoragesService {
 
-	/** @var BackendService */
-	protected $backendService;
-
-	/**
-	 * @var DBConfigService
-	 */
-	protected $dbConfig;
-
-	/**
-	 * @var IUserMountCache
-	 */
-	protected $userMountCache;
-
-	/**
-	 * @param BackendService $backendService
-	 * @param DBConfigService $dbConfigService
-	 * @param IUserMountCache $userMountCache
-	 */
-	public function __construct(BackendService $backendService, DBConfigService $dbConfigService, IUserMountCache $userMountCache) {
-		$this->backendService = $backendService;
-		$this->dbConfig = $dbConfigService;
-		$this->userMountCache = $userMountCache;
-	}
-
-	protected function readDBConfig() {
-		return $this->dbConfig->getAdminMounts();
-	}
-
-	protected function getStorageConfigFromDBMount(array $mount) {
-		$applicableUsers = array_filter($mount['applicable'], function ($applicable) {
-			return $applicable['type'] === DBConfigService::APPLICABLE_TYPE_USER;
-		});
-		$applicableUsers = array_map(function ($applicable) {
-			return $applicable['value'];
-		}, $applicableUsers);
-
-		$applicableGroups = array_filter($mount['applicable'], function ($applicable) {
-			return $applicable['type'] === DBConfigService::APPLICABLE_TYPE_GROUP;
-		});
-		$applicableGroups = array_map(function ($applicable) {
-			return $applicable['value'];
-		}, $applicableGroups);
-
-		try {
-			$config = $this->createStorage(
-				$mount['mount_point'],
-				$mount['storage_backend'],
-				$mount['auth_backend'],
-				$mount['config'],
-				$mount['options'],
-				array_values($applicableUsers),
-				array_values($applicableGroups),
-				$mount['priority']
-			);
-			$config->setType($mount['type']);
-			$config->setId((int)$mount['mount_id']);
-			return $config;
-		} catch (\UnexpectedValueException $e) {
-			// don't die if a storage backend doesn't exist
-			\OCP\Util::writeLog(
-				'files_external',
-				'Could not load storage: "' . $e->getMessage() . '"',
-				\OCP\Util::ERROR
-			);
-			return null;
-		} catch (\InvalidArgumentException $e) {
-			\OCP\Util::writeLog(
-				'files_external',
-				'Could not load storage: "' . $e->getMessage() . '"',
-				\OCP\Util::ERROR
-			);
-			return null;
-		}
-	}
-
-	/**
-	 * Read the external storages config
-	 *
-	 * @return array map of storage id to storage config
-	 */
-	protected function readConfig() {
-		$mounts = $this->readDBConfig();
-		$configs = array_map([$this, 'getStorageConfigFromDBMount'], $mounts);
-		$configs = array_filter($configs, function ($config) {
-			return $config instanceof StorageConfig;
-		});
-
-		$keys = array_map(function (StorageConfig $config) {
-			return $config->getId();
-		}, $configs);
-
-		return array_combine($keys, $configs);
-	}
-
-	/**
-	 * Get a storage with status
-	 *
-	 * @param int $id storage id
-	 *
-	 * @return StorageConfig
-	 * @throws NotFoundException if the storage with the given id was not found
-	 */
-	public function getStorage($id) {
-		$mount = $this->dbConfig->getMountById($id);
-
-		if (!is_array($mount)) {
-			throw new NotFoundException('Storage with id "' . $id . '" not found');
-		}
-
-		$config = $this->getStorageConfigFromDBMount($mount);
-		if ($this->isApplicable($config)) {
-			return $config;
-		} else {
-			throw new NotFoundException('Storage with id "' . $id . '" not found');
-		}
-	}
-
-	/**
-	 * Check whether this storage service should provide access to a storage
-	 *
-	 * @param StorageConfig $config
-	 * @return bool
-	 */
-	abstract protected function isApplicable(StorageConfig $config);
-
-	/**
-	 * Gets all storages, valid or not
-	 *
-	 * @return StorageConfig[] array of storage configs
-	 */
-	public function getAllStorages() {
-		return $this->readConfig();
-	}
-
-	/**
-	 * Gets all valid storages
-	 *
-	 * @return StorageConfig[]
-	 */
-	public function getStorages() {
-		return array_filter($this->getAllStorages(), [$this, 'validateStorage']);
-	}
-
-	/**
-	 * Validate storage
-	 * FIXME: De-duplicate with StoragesController::validate()
-	 *
-	 * @param StorageConfig $storage
-	 * @return bool
-	 */
-	protected function validateStorage(StorageConfig $storage) {
-		/** @var Backend */
-		$backend = $storage->getBackend();
-		/** @var AuthMechanism */
-		$authMechanism = $storage->getAuthMechanism();
-
-		if (!$backend->isVisibleFor($this->getVisibilityType())) {
-			// not permitted to use backend
-			return false;
-		}
-		if (!$authMechanism->isVisibleFor($this->getVisibilityType())) {
-			// not permitted to use auth mechanism
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get the visibility type for this controller, used in validation
-	 *
-	 * @return string BackendService::VISIBILITY_* constants
-	 */
-	abstract public function getVisibilityType();
-
-	/**
-	 * @return integer
-	 */
-	protected function getType() {
-		return DBConfigService::MOUNT_TYPE_ADMIN;
-	}
-
-	/**
-	 * Add new storage to the configuration
-	 *
-	 * @param StorageConfig $newStorage storage attributes
-	 *
-	 * @return StorageConfig storage config, with added id
-	 */
-	public function addStorage(StorageConfig $newStorage) {
-		$allStorages = $this->readConfig();
-
-		$configId = $this->dbConfig->addMount(
-			$newStorage->getMountPoint(),
-			$newStorage->getBackend()->getIdentifier(),
-			$newStorage->getAuthMechanism()->getIdentifier(),
-			$newStorage->getPriority(),
-			$this->getType()
-		);
-
-		$newStorage->setId($configId);
-
-		foreach ($newStorage->getApplicableUsers() as $user) {
-			$this->dbConfig->addApplicable($configId, DBConfigService::APPLICABLE_TYPE_USER, $user);
-		}
-		foreach ($newStorage->getApplicableGroups() as $group) {
-			$this->dbConfig->addApplicable($configId, DBConfigService::APPLICABLE_TYPE_GROUP, $group);
-		}
-		foreach ($newStorage->getBackendOptions() as $key => $value) {
-			$this->dbConfig->setConfig($configId, $key, $value);
-		}
-		foreach ($newStorage->getMountOptions() as $key => $value) {
-			$this->dbConfig->setOption($configId, $key, $value);
-		}
-
-		if (count($newStorage->getApplicableUsers()) === 0 && count($newStorage->getApplicableGroups()) === 0) {
-			$this->dbConfig->addApplicable($configId, DBConfigService::APPLICABLE_TYPE_GLOBAL, null);
-		}
-
-		// add new storage
-		$allStorages[$configId] = $newStorage;
-
-		$this->triggerHooks($newStorage, Filesystem::signal_create_mount);
-
-		$newStorage->setStatus(StorageNotAvailableException::STATUS_SUCCESS);
-		return $newStorage;
-	}
-
-	/**
-	 * Create a storage from its parameters
-	 *
-	 * @param string $mountPoint storage mount point
-	 * @param string $backendIdentifier backend identifier
-	 * @param string $authMechanismIdentifier authentication mechanism identifier
-	 * @param array $backendOptions backend-specific options
-	 * @param array|null $mountOptions mount-specific options
-	 * @param array|null $applicableUsers users for which to mount the storage
-	 * @param array|null $applicableGroups groups for which to mount the storage
-	 * @param int|null $priority priority
-	 *
-	 * @return StorageConfig
-	 */
-	public function createStorage(
-		$mountPoint,
-		$backendIdentifier,
-		$authMechanismIdentifier,
-		$backendOptions,
-		$mountOptions = null,
-		$applicableUsers = null,
-		$applicableGroups = null,
-		$priority = null
-	) {
-		$backend = $this->backendService->getBackend($backendIdentifier);
-		if (!$backend) {
-			throw new \InvalidArgumentException('Unable to get backend for ' . $backendIdentifier);
-		}
-		$authMechanism = $this->backendService->getAuthMechanism($authMechanismIdentifier);
-		if (!$authMechanism) {
-			throw new \InvalidArgumentException('Unable to get authentication mechanism for ' . $authMechanismIdentifier);
-		}
-		$newStorage = new StorageConfig();
-		$newStorage->setMountPoint($mountPoint);
-		$newStorage->setBackend($backend);
-		$newStorage->setAuthMechanism($authMechanism);
-		$newStorage->setBackendOptions($backendOptions);
-		if (isset($mountOptions)) {
-			$newStorage->setMountOptions($mountOptions);
-		}
-		if (isset($applicableUsers)) {
-			$newStorage->setApplicableUsers($applicableUsers);
-		}
-		if (isset($applicableGroups)) {
-			$newStorage->setApplicableGroups($applicableGroups);
-		}
-		if (isset($priority)) {
-			$newStorage->setPriority($priority);
-		}
-
-		return $newStorage;
-	}
-
-	/**
-	 * Triggers the given hook signal for all the applicables given
-	 *
-	 * @param string $signal signal
-	 * @param string $mountPoint hook mount pount param
-	 * @param string $mountType hook mount type param
-	 * @param array $applicableArray array of applicable users/groups for which to trigger the hook
-	 */
-	protected function triggerApplicableHooks($signal, $mountPoint, $mountType, $applicableArray) {
-		foreach ($applicableArray as $applicable) {
-			\OCP\Util::emitHook(
-				Filesystem::CLASSNAME,
-				$signal,
-				[
-					Filesystem::signal_param_path => $mountPoint,
-					Filesystem::signal_param_mount_type => $mountType,
-					Filesystem::signal_param_users => $applicable,
-				]
-			);
-		}
-	}
-
-	/**
-	 * Triggers $signal for all applicable users of the given
-	 * storage
-	 *
-	 * @param StorageConfig $storage storage data
-	 * @param string $signal signal to trigger
-	 */
-	abstract protected function triggerHooks(StorageConfig $storage, $signal);
-
-	/**
-	 * Triggers signal_create_mount or signal_delete_mount to
-	 * accommodate for additions/deletions in applicableUsers
-	 * and applicableGroups fields.
-	 *
-	 * @param StorageConfig $oldStorage old storage data
-	 * @param StorageConfig $newStorage new storage data
-	 */
-	abstract protected function triggerChangeHooks(StorageConfig $oldStorage, StorageConfig $newStorage);
-
-	/**
-	 * Update storage to the configuration
-	 *
-	 * @param StorageConfig $updatedStorage storage attributes
-	 *
-	 * @return StorageConfig storage config
-	 * @throws NotFoundException if the given storage does not exist in the config
-	 */
-	public function updateStorage(StorageConfig $updatedStorage) {
-		$id = $updatedStorage->getId();
-
-		$existingMount = $this->dbConfig->getMountById($id);
-
-		if (!is_array($existingMount)) {
-			throw new NotFoundException('Storage with id "' . $id . '" not found while updating storage');
-		}
-
-		$oldStorage = $this->getStorageConfigFromDBMount($existingMount);
-
-		$removedUsers = array_diff($oldStorage->getApplicableUsers(), $updatedStorage->getApplicableUsers());
-		$removedGroups = array_diff($oldStorage->getApplicableGroups(), $updatedStorage->getApplicableGroups());
-		$addedUsers = array_diff($updatedStorage->getApplicableUsers(), $oldStorage->getApplicableUsers());
-		$addedGroups = array_diff($updatedStorage->getApplicableGroups(), $oldStorage->getApplicableGroups());
-
-		$oldUserCount = count($oldStorage->getApplicableUsers());
-		$oldGroupCount = count($oldStorage->getApplicableGroups());
-		$newUserCount = count($updatedStorage->getApplicableUsers());
-		$newGroupCount = count($updatedStorage->getApplicableGroups());
-		$wasGlobal = ($oldUserCount + $oldGroupCount) === 0;
-		$isGlobal = ($newUserCount + $newGroupCount) === 0;
-
-		foreach ($removedUsers as $user) {
-			$this->dbConfig->removeApplicable($id, DBConfigService::APPLICABLE_TYPE_USER, $user);
-		}
-		foreach ($removedGroups as $group) {
-			$this->dbConfig->removeApplicable($id, DBConfigService::APPLICABLE_TYPE_GROUP, $group);
-		}
-		foreach ($addedUsers as $user) {
-			$this->dbConfig->addApplicable($id, DBConfigService::APPLICABLE_TYPE_USER, $user);
-		}
-		foreach ($addedGroups as $group) {
-			$this->dbConfig->addApplicable($id, DBConfigService::APPLICABLE_TYPE_GROUP, $group);
-		}
-
-		if ($wasGlobal && !$isGlobal) {
-			$this->dbConfig->removeApplicable($id, DBConfigService::APPLICABLE_TYPE_GLOBAL, null);
-		} else if (!$wasGlobal && $isGlobal) {
-			$this->dbConfig->addApplicable($id, DBConfigService::APPLICABLE_TYPE_GLOBAL, null);
-		}
-
-		$changedConfig = array_diff_assoc($updatedStorage->getBackendOptions(), $oldStorage->getBackendOptions());
-		$changedOptions = array_diff_assoc($updatedStorage->getMountOptions(), $oldStorage->getMountOptions());
-
-		foreach ($changedConfig as $key => $value) {
-			$this->dbConfig->setConfig($id, $key, $value);
-		}
-		foreach ($changedOptions as $key => $value) {
-			$this->dbConfig->setOption($id, $key, $value);
-		}
-
-		if ($updatedStorage->getMountPoint() !== $oldStorage->getMountPoint()) {
-			$this->dbConfig->setMountPoint($id, $updatedStorage->getMountPoint());
-		}
-
-		if ($updatedStorage->getAuthMechanism()->getIdentifier() !== $oldStorage->getAuthMechanism()->getIdentifier()) {
-			$this->dbConfig->setAuthBackend($id, $updatedStorage->getAuthMechanism()->getIdentifier());
-		}
-
-		$this->triggerChangeHooks($oldStorage, $updatedStorage);
-
-		if (($wasGlobal && !$isGlobal) || count($removedGroups) > 0) { // to expensive to properly handle these on the fly
-			$this->userMountCache->remoteStorageMounts($this->getStorageId($updatedStorage));
-		} else {
-			$storageId = $this->getStorageId($updatedStorage);
-			foreach ($removedUsers as $userId) {
-				$this->userMountCache->removeUserStorageMount($storageId, $userId);
-			}
-		}
-
-		return $this->getStorage($id);
-	}
-
-	/**
-	 * Delete the storage with the given id.
-	 *
-	 * @param int $id storage id
-	 *
-	 * @throws NotFoundException if no storage was found with the given id
-	 */
-	public function removeStorage($id) {
-		$existingMount = $this->dbConfig->getMountById($id);
-
-		if (!is_array($existingMount)) {
-			throw new NotFoundException('Storage with id "' . $id . '" not found');
-		}
-
-		$this->dbConfig->removeMount($id);
-
-		$deletedStorage = $this->getStorageConfigFromDBMount($existingMount);
-		$this->triggerHooks($deletedStorage, Filesystem::signal_delete_mount);
-
-		// delete oc_storages entries and oc_filecache
-		try {
-			$rustyStorageId = $this->getRustyStorageIdFromConfig($deletedStorage);
-			\OC\Files\Cache\Storage::remove($rustyStorageId);
-		} catch (\Exception $e) {
-			// can happen either for invalid configs where the storage could not
-			// be instantiated or whenever $user vars where used, in which case
-			// the storage id could not be computed
-			\OCP\Util::writeLog(
-				'files_external',
-				'Exception: "' . $e->getMessage() . '"',
-				\OCP\Util::ERROR
-			);
-		}
-	}
-
-	/**
-	 * Returns the rusty storage id from oc_storages from the given storage config.
-	 *
-	 * @param StorageConfig $storageConfig
-	 * @return string rusty storage id
-	 */
-	private function getRustyStorageIdFromConfig(StorageConfig $storageConfig) {
-		// if any of the storage options contains $user, it is not possible
-		// to compute the possible storage id as we don't know which users
-		// mounted it already (and we certainly don't want to iterate over ALL users)
-		foreach ($storageConfig->getBackendOptions() as $value) {
-			if (strpos($value, '$user') !== false) {
-				throw new \Exception('Cannot compute storage id for deletion due to $user vars in the configuration');
-			}
-		}
-
-		// note: similar to ConfigAdapter->prepateStorageConfig()
-		$storageConfig->getAuthMechanism()->manipulateStorageConfig($storageConfig);
-		$storageConfig->getBackend()->manipulateStorageConfig($storageConfig);
-
-		$class = $storageConfig->getBackend()->getStorageClass();
-		$storageImpl = new $class($storageConfig->getBackendOptions());
-
-		return $storageImpl->getId();
-	}
-
-	/**
-	 * Construct the storage implementation
-	 *
-	 * @param StorageConfig $storageConfig
-	 * @return int
-	 */
-	private function getStorageId(StorageConfig $storageConfig) {
-		try {
-			$class = $storageConfig->getBackend()->getStorageClass();
-			/** @var \OC\Files\Storage\Storage $storage */
-			$storage = new $class($storageConfig->getBackendOptions());
-
-			// auth mechanism should fire first
-			$storage = $storageConfig->getBackend()->wrapStorage($storage);
-			$storage = $storageConfig->getAuthMechanism()->wrapStorage($storage);
-
-			return $storage->getStorageCache()->getNumericId();
-		} catch (\Exception $e) {
-			return -1;
-		}
-	}
+    /** @var BackendService */
+    protected $backendService;
+
+    /**
+     * @var DBConfigService
+     */
+    protected $dbConfig;
+
+    /**
+     * @var IUserMountCache
+     */
+    protected $userMountCache;
+
+    /**
+     * @param BackendService $backendService
+     * @param DBConfigService $dbConfigService
+     * @param IUserMountCache $userMountCache
+     */
+    public function __construct(BackendService $backendService, DBConfigService $dbConfigService, IUserMountCache $userMountCache) {
+        $this->backendService = $backendService;
+        $this->dbConfig = $dbConfigService;
+        $this->userMountCache = $userMountCache;
+    }
+
+    protected function readDBConfig() {
+        return $this->dbConfig->getAdminMounts();
+    }
+
+    protected function getStorageConfigFromDBMount(array $mount) {
+        $applicableUsers = array_filter($mount['applicable'], function ($applicable) {
+            return $applicable['type'] === DBConfigService::APPLICABLE_TYPE_USER;
+        });
+        $applicableUsers = array_map(function ($applicable) {
+            return $applicable['value'];
+        }, $applicableUsers);
+
+        $applicableGroups = array_filter($mount['applicable'], function ($applicable) {
+            return $applicable['type'] === DBConfigService::APPLICABLE_TYPE_GROUP;
+        });
+        $applicableGroups = array_map(function ($applicable) {
+            return $applicable['value'];
+        }, $applicableGroups);
+
+        try {
+            $config = $this->createStorage(
+                $mount['mount_point'],
+                $mount['storage_backend'],
+                $mount['auth_backend'],
+                $mount['config'],
+                $mount['options'],
+                array_values($applicableUsers),
+                array_values($applicableGroups),
+                $mount['priority']
+            );
+            $config->setType($mount['type']);
+            $config->setId((int)$mount['mount_id']);
+            return $config;
+        } catch (\UnexpectedValueException $e) {
+            // don't die if a storage backend doesn't exist
+            \OCP\Util::writeLog(
+                'files_external',
+                'Could not load storage: "' . $e->getMessage() . '"',
+                \OCP\Util::ERROR
+            );
+            return null;
+        } catch (\InvalidArgumentException $e) {
+            \OCP\Util::writeLog(
+                'files_external',
+                'Could not load storage: "' . $e->getMessage() . '"',
+                \OCP\Util::ERROR
+            );
+            return null;
+        }
+    }
+
+    /**
+     * Read the external storages config
+     *
+     * @return array map of storage id to storage config
+     */
+    protected function readConfig() {
+        $mounts = $this->readDBConfig();
+        $configs = array_map([$this, 'getStorageConfigFromDBMount'], $mounts);
+        $configs = array_filter($configs, function ($config) {
+            return $config instanceof StorageConfig;
+        });
+
+        $keys = array_map(function (StorageConfig $config) {
+            return $config->getId();
+        }, $configs);
+
+        return array_combine($keys, $configs);
+    }
+
+    /**
+     * Get a storage with status
+     *
+     * @param int $id storage id
+     *
+     * @return StorageConfig
+     * @throws NotFoundException if the storage with the given id was not found
+     */
+    public function getStorage($id) {
+        $mount = $this->dbConfig->getMountById($id);
+
+        if (!is_array($mount)) {
+            throw new NotFoundException('Storage with id "' . $id . '" not found');
+        }
+
+        $config = $this->getStorageConfigFromDBMount($mount);
+        if ($this->isApplicable($config)) {
+            return $config;
+        } else {
+            throw new NotFoundException('Storage with id "' . $id . '" not found');
+        }
+    }
+
+    /**
+     * Check whether this storage service should provide access to a storage
+     *
+     * @param StorageConfig $config
+     * @return bool
+     */
+    abstract protected function isApplicable(StorageConfig $config);
+
+    /**
+     * Gets all storages, valid or not
+     *
+     * @return StorageConfig[] array of storage configs
+     */
+    public function getAllStorages() {
+        return $this->readConfig();
+    }
+
+    /**
+     * Gets all valid storages
+     *
+     * @return StorageConfig[]
+     */
+    public function getStorages() {
+        return array_filter($this->getAllStorages(), [$this, 'validateStorage']);
+    }
+
+    /**
+     * Validate storage
+     * FIXME: De-duplicate with StoragesController::validate()
+     *
+     * @param StorageConfig $storage
+     * @return bool
+     */
+    protected function validateStorage(StorageConfig $storage) {
+        /** @var Backend */
+        $backend = $storage->getBackend();
+        /** @var AuthMechanism */
+        $authMechanism = $storage->getAuthMechanism();
+
+        if (!$backend->isVisibleFor($this->getVisibilityType())) {
+            // not permitted to use backend
+            return false;
+        }
+        if (!$authMechanism->isVisibleFor($this->getVisibilityType())) {
+            // not permitted to use auth mechanism
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Get the visibility type for this controller, used in validation
+     *
+     * @return string BackendService::VISIBILITY_* constants
+     */
+    abstract public function getVisibilityType();
+
+    /**
+     * @return integer
+     */
+    protected function getType() {
+        return DBConfigService::MOUNT_TYPE_ADMIN;
+    }
+
+    /**
+     * Add new storage to the configuration
+     *
+     * @param StorageConfig $newStorage storage attributes
+     *
+     * @return StorageConfig storage config, with added id
+     */
+    public function addStorage(StorageConfig $newStorage) {
+        $allStorages = $this->readConfig();
+
+        $configId = $this->dbConfig->addMount(
+            $newStorage->getMountPoint(),
+            $newStorage->getBackend()->getIdentifier(),
+            $newStorage->getAuthMechanism()->getIdentifier(),
+            $newStorage->getPriority(),
+            $this->getType()
+        );
+
+        $newStorage->setId($configId);
+
+        foreach ($newStorage->getApplicableUsers() as $user) {
+            $this->dbConfig->addApplicable($configId, DBConfigService::APPLICABLE_TYPE_USER, $user);
+        }
+        foreach ($newStorage->getApplicableGroups() as $group) {
+            $this->dbConfig->addApplicable($configId, DBConfigService::APPLICABLE_TYPE_GROUP, $group);
+        }
+        foreach ($newStorage->getBackendOptions() as $key => $value) {
+            $this->dbConfig->setConfig($configId, $key, $value);
+        }
+        foreach ($newStorage->getMountOptions() as $key => $value) {
+            $this->dbConfig->setOption($configId, $key, $value);
+        }
+
+        if (count($newStorage->getApplicableUsers()) === 0 && count($newStorage->getApplicableGroups()) === 0) {
+            $this->dbConfig->addApplicable($configId, DBConfigService::APPLICABLE_TYPE_GLOBAL, null);
+        }
+
+        // add new storage
+        $allStorages[$configId] = $newStorage;
+
+        $this->triggerHooks($newStorage, Filesystem::signal_create_mount);
+
+        $newStorage->setStatus(StorageNotAvailableException::STATUS_SUCCESS);
+        return $newStorage;
+    }
+
+    /**
+     * Create a storage from its parameters
+     *
+     * @param string $mountPoint storage mount point
+     * @param string $backendIdentifier backend identifier
+     * @param string $authMechanismIdentifier authentication mechanism identifier
+     * @param array $backendOptions backend-specific options
+     * @param array|null $mountOptions mount-specific options
+     * @param array|null $applicableUsers users for which to mount the storage
+     * @param array|null $applicableGroups groups for which to mount the storage
+     * @param int|null $priority priority
+     *
+     * @return StorageConfig
+     */
+    public function createStorage(
+        $mountPoint,
+        $backendIdentifier,
+        $authMechanismIdentifier,
+        $backendOptions,
+        $mountOptions = null,
+        $applicableUsers = null,
+        $applicableGroups = null,
+        $priority = null
+    ) {
+        $backend = $this->backendService->getBackend($backendIdentifier);
+        if (!$backend) {
+            throw new \InvalidArgumentException('Unable to get backend for ' . $backendIdentifier);
+        }
+        $authMechanism = $this->backendService->getAuthMechanism($authMechanismIdentifier);
+        if (!$authMechanism) {
+            throw new \InvalidArgumentException('Unable to get authentication mechanism for ' . $authMechanismIdentifier);
+        }
+        $newStorage = new StorageConfig();
+        $newStorage->setMountPoint($mountPoint);
+        $newStorage->setBackend($backend);
+        $newStorage->setAuthMechanism($authMechanism);
+        $newStorage->setBackendOptions($backendOptions);
+        if (isset($mountOptions)) {
+            $newStorage->setMountOptions($mountOptions);
+        }
+        if (isset($applicableUsers)) {
+            $newStorage->setApplicableUsers($applicableUsers);
+        }
+        if (isset($applicableGroups)) {
+            $newStorage->setApplicableGroups($applicableGroups);
+        }
+        if (isset($priority)) {
+            $newStorage->setPriority($priority);
+        }
+
+        return $newStorage;
+    }
+
+    /**
+     * Triggers the given hook signal for all the applicables given
+     *
+     * @param string $signal signal
+     * @param string $mountPoint hook mount pount param
+     * @param string $mountType hook mount type param
+     * @param array $applicableArray array of applicable users/groups for which to trigger the hook
+     */
+    protected function triggerApplicableHooks($signal, $mountPoint, $mountType, $applicableArray) {
+        foreach ($applicableArray as $applicable) {
+            \OCP\Util::emitHook(
+                Filesystem::CLASSNAME,
+                $signal,
+                [
+                    Filesystem::signal_param_path => $mountPoint,
+                    Filesystem::signal_param_mount_type => $mountType,
+                    Filesystem::signal_param_users => $applicable,
+                ]
+            );
+        }
+    }
+
+    /**
+     * Triggers $signal for all applicable users of the given
+     * storage
+     *
+     * @param StorageConfig $storage storage data
+     * @param string $signal signal to trigger
+     */
+    abstract protected function triggerHooks(StorageConfig $storage, $signal);
+
+    /**
+     * Triggers signal_create_mount or signal_delete_mount to
+     * accommodate for additions/deletions in applicableUsers
+     * and applicableGroups fields.
+     *
+     * @param StorageConfig $oldStorage old storage data
+     * @param StorageConfig $newStorage new storage data
+     */
+    abstract protected function triggerChangeHooks(StorageConfig $oldStorage, StorageConfig $newStorage);
+
+    /**
+     * Update storage to the configuration
+     *
+     * @param StorageConfig $updatedStorage storage attributes
+     *
+     * @return StorageConfig storage config
+     * @throws NotFoundException if the given storage does not exist in the config
+     */
+    public function updateStorage(StorageConfig $updatedStorage) {
+        $id = $updatedStorage->getId();
+
+        $existingMount = $this->dbConfig->getMountById($id);
+
+        if (!is_array($existingMount)) {
+            throw new NotFoundException('Storage with id "' . $id . '" not found while updating storage');
+        }
+
+        $oldStorage = $this->getStorageConfigFromDBMount($existingMount);
+
+        $removedUsers = array_diff($oldStorage->getApplicableUsers(), $updatedStorage->getApplicableUsers());
+        $removedGroups = array_diff($oldStorage->getApplicableGroups(), $updatedStorage->getApplicableGroups());
+        $addedUsers = array_diff($updatedStorage->getApplicableUsers(), $oldStorage->getApplicableUsers());
+        $addedGroups = array_diff($updatedStorage->getApplicableGroups(), $oldStorage->getApplicableGroups());
+
+        $oldUserCount = count($oldStorage->getApplicableUsers());
+        $oldGroupCount = count($oldStorage->getApplicableGroups());
+        $newUserCount = count($updatedStorage->getApplicableUsers());
+        $newGroupCount = count($updatedStorage->getApplicableGroups());
+        $wasGlobal = ($oldUserCount + $oldGroupCount) === 0;
+        $isGlobal = ($newUserCount + $newGroupCount) === 0;
+
+        foreach ($removedUsers as $user) {
+            $this->dbConfig->removeApplicable($id, DBConfigService::APPLICABLE_TYPE_USER, $user);
+        }
+        foreach ($removedGroups as $group) {
+            $this->dbConfig->removeApplicable($id, DBConfigService::APPLICABLE_TYPE_GROUP, $group);
+        }
+        foreach ($addedUsers as $user) {
+            $this->dbConfig->addApplicable($id, DBConfigService::APPLICABLE_TYPE_USER, $user);
+        }
+        foreach ($addedGroups as $group) {
+            $this->dbConfig->addApplicable($id, DBConfigService::APPLICABLE_TYPE_GROUP, $group);
+        }
+
+        if ($wasGlobal && !$isGlobal) {
+            $this->dbConfig->removeApplicable($id, DBConfigService::APPLICABLE_TYPE_GLOBAL, null);
+        } else if (!$wasGlobal && $isGlobal) {
+            $this->dbConfig->addApplicable($id, DBConfigService::APPLICABLE_TYPE_GLOBAL, null);
+        }
+
+        $changedConfig = array_diff_assoc($updatedStorage->getBackendOptions(), $oldStorage->getBackendOptions());
+        $changedOptions = array_diff_assoc($updatedStorage->getMountOptions(), $oldStorage->getMountOptions());
+
+        foreach ($changedConfig as $key => $value) {
+            $this->dbConfig->setConfig($id, $key, $value);
+        }
+        foreach ($changedOptions as $key => $value) {
+            $this->dbConfig->setOption($id, $key, $value);
+        }
+
+        if ($updatedStorage->getMountPoint() !== $oldStorage->getMountPoint()) {
+            $this->dbConfig->setMountPoint($id, $updatedStorage->getMountPoint());
+        }
+
+        if ($updatedStorage->getAuthMechanism()->getIdentifier() !== $oldStorage->getAuthMechanism()->getIdentifier()) {
+            $this->dbConfig->setAuthBackend($id, $updatedStorage->getAuthMechanism()->getIdentifier());
+        }
+
+        $this->triggerChangeHooks($oldStorage, $updatedStorage);
+
+        if (($wasGlobal && !$isGlobal) || count($removedGroups) > 0) { // to expensive to properly handle these on the fly
+            $this->userMountCache->remoteStorageMounts($this->getStorageId($updatedStorage));
+        } else {
+            $storageId = $this->getStorageId($updatedStorage);
+            foreach ($removedUsers as $userId) {
+                $this->userMountCache->removeUserStorageMount($storageId, $userId);
+            }
+        }
+
+        return $this->getStorage($id);
+    }
+
+    /**
+     * Delete the storage with the given id.
+     *
+     * @param int $id storage id
+     *
+     * @throws NotFoundException if no storage was found with the given id
+     */
+    public function removeStorage($id) {
+        $existingMount = $this->dbConfig->getMountById($id);
+
+        if (!is_array($existingMount)) {
+            throw new NotFoundException('Storage with id "' . $id . '" not found');
+        }
+
+        $this->dbConfig->removeMount($id);
+
+        $deletedStorage = $this->getStorageConfigFromDBMount($existingMount);
+        $this->triggerHooks($deletedStorage, Filesystem::signal_delete_mount);
+
+        // delete oc_storages entries and oc_filecache
+        try {
+            $rustyStorageId = $this->getRustyStorageIdFromConfig($deletedStorage);
+            \OC\Files\Cache\Storage::remove($rustyStorageId);
+        } catch (\Exception $e) {
+            // can happen either for invalid configs where the storage could not
+            // be instantiated or whenever $user vars where used, in which case
+            // the storage id could not be computed
+            \OCP\Util::writeLog(
+                'files_external',
+                'Exception: "' . $e->getMessage() . '"',
+                \OCP\Util::ERROR
+            );
+        }
+    }
+
+    /**
+     * Returns the rusty storage id from oc_storages from the given storage config.
+     *
+     * @param StorageConfig $storageConfig
+     * @return string rusty storage id
+     */
+    private function getRustyStorageIdFromConfig(StorageConfig $storageConfig) {
+        // if any of the storage options contains $user, it is not possible
+        // to compute the possible storage id as we don't know which users
+        // mounted it already (and we certainly don't want to iterate over ALL users)
+        foreach ($storageConfig->getBackendOptions() as $value) {
+            if (strpos($value, '$user') !== false) {
+                throw new \Exception('Cannot compute storage id for deletion due to $user vars in the configuration');
+            }
+        }
+
+        // note: similar to ConfigAdapter->prepateStorageConfig()
+        $storageConfig->getAuthMechanism()->manipulateStorageConfig($storageConfig);
+        $storageConfig->getBackend()->manipulateStorageConfig($storageConfig);
+
+        $class = $storageConfig->getBackend()->getStorageClass();
+        $storageImpl = new $class($storageConfig->getBackendOptions());
+
+        return $storageImpl->getId();
+    }
+
+    /**
+     * Construct the storage implementation
+     *
+     * @param StorageConfig $storageConfig
+     * @return int
+     */
+    private function getStorageId(StorageConfig $storageConfig) {
+        try {
+            $class = $storageConfig->getBackend()->getStorageClass();
+            /** @var \OC\Files\Storage\Storage $storage */
+            $storage = new $class($storageConfig->getBackendOptions());
+
+            // auth mechanism should fire first
+            $storage = $storageConfig->getBackend()->wrapStorage($storage);
+            $storage = $storageConfig->getAuthMechanism()->wrapStorage($storage);
+
+            return $storage->getStorageCache()->getNumericId();
+        } catch (\Exception $e) {
+            return -1;
+        }
+    }
 }

apps/files_external/lib/Service/UserStoragesService.php

Indentation +91 added lines, -91 removed lines

@@ -40,105 +40,105 @@
  * (aka personal storages)
  */
 class UserStoragesService extends StoragesService {
-	use UserTrait;
+    use UserTrait;
 
-	/**
-	 * Create a user storages service
-	 *
-	 * @param BackendService $backendService
-	 * @param DBConfigService $dbConfig
-	 * @param IUserSession $userSession user session
-	 * @param IUserMountCache $userMountCache
-	 */
-	public function __construct(
-		BackendService $backendService,
-		DBConfigService $dbConfig,
-		IUserSession $userSession,
-		IUserMountCache $userMountCache
-	) {
-		$this->userSession = $userSession;
-		parent::__construct($backendService, $dbConfig, $userMountCache);
-	}
+    /**
+     * Create a user storages service
+     *
+     * @param BackendService $backendService
+     * @param DBConfigService $dbConfig
+     * @param IUserSession $userSession user session
+     * @param IUserMountCache $userMountCache
+     */
+    public function __construct(
+        BackendService $backendService,
+        DBConfigService $dbConfig,
+        IUserSession $userSession,
+        IUserMountCache $userMountCache
+    ) {
+        $this->userSession = $userSession;
+        parent::__construct($backendService, $dbConfig, $userMountCache);
+    }
 
-	protected function readDBConfig() {
-		return $this->dbConfig->getUserMountsFor(DBConfigService::APPLICABLE_TYPE_USER, $this->getUser()->getUID());
-	}
+    protected function readDBConfig() {
+        return $this->dbConfig->getUserMountsFor(DBConfigService::APPLICABLE_TYPE_USER, $this->getUser()->getUID());
+    }
 
-	/**
-	 * Triggers $signal for all applicable users of the given
-	 * storage
-	 *
-	 * @param StorageConfig $storage storage data
-	 * @param string $signal signal to trigger
-	 */
-	protected function triggerHooks(StorageConfig $storage, $signal) {
-		$user = $this->getUser()->getUID();
+    /**
+     * Triggers $signal for all applicable users of the given
+     * storage
+     *
+     * @param StorageConfig $storage storage data
+     * @param string $signal signal to trigger
+     */
+    protected function triggerHooks(StorageConfig $storage, $signal) {
+        $user = $this->getUser()->getUID();
 
-		// trigger hook for the current user
-		$this->triggerApplicableHooks(
-			$signal,
-			$storage->getMountPoint(),
-			\OC_Mount_Config::MOUNT_TYPE_USER,
-			[$user]
-		);
-	}
+        // trigger hook for the current user
+        $this->triggerApplicableHooks(
+            $signal,
+            $storage->getMountPoint(),
+            \OC_Mount_Config::MOUNT_TYPE_USER,
+            [$user]
+        );
+    }
 
-	/**
-	 * Triggers signal_create_mount or signal_delete_mount to
-	 * accommodate for additions/deletions in applicableUsers
-	 * and applicableGroups fields.
-	 *
-	 * @param StorageConfig $oldStorage old storage data
-	 * @param StorageConfig $newStorage new storage data
-	 */
-	protected function triggerChangeHooks(StorageConfig $oldStorage, StorageConfig $newStorage) {
-		// if mount point changed, it's like a deletion + creation
-		if ($oldStorage->getMountPoint() !== $newStorage->getMountPoint()) {
-			$this->triggerHooks($oldStorage, Filesystem::signal_delete_mount);
-			$this->triggerHooks($newStorage, Filesystem::signal_create_mount);
-		}
-	}
+    /**
+     * Triggers signal_create_mount or signal_delete_mount to
+     * accommodate for additions/deletions in applicableUsers
+     * and applicableGroups fields.
+     *
+     * @param StorageConfig $oldStorage old storage data
+     * @param StorageConfig $newStorage new storage data
+     */
+    protected function triggerChangeHooks(StorageConfig $oldStorage, StorageConfig $newStorage) {
+        // if mount point changed, it's like a deletion + creation
+        if ($oldStorage->getMountPoint() !== $newStorage->getMountPoint()) {
+            $this->triggerHooks($oldStorage, Filesystem::signal_delete_mount);
+            $this->triggerHooks($newStorage, Filesystem::signal_create_mount);
+        }
+    }
 
-	protected function getType() {
-		return DBConfigService::MOUNT_TYPE_PERSONAl;
-	}
+    protected function getType() {
+        return DBConfigService::MOUNT_TYPE_PERSONAl;
+    }
 
-	/**
-	 * Add new storage to the configuration
-	 *
-	 * @param StorageConfig $newStorage storage attributes
-	 *
-	 * @return StorageConfig storage config, with added id
-	 */
-	public function addStorage(StorageConfig $newStorage) {
-		$newStorage->setApplicableUsers([$this->getUser()->getUID()]);
-		$config = parent::addStorage($newStorage);
-		return $config;
-	}
+    /**
+     * Add new storage to the configuration
+     *
+     * @param StorageConfig $newStorage storage attributes
+     *
+     * @return StorageConfig storage config, with added id
+     */
+    public function addStorage(StorageConfig $newStorage) {
+        $newStorage->setApplicableUsers([$this->getUser()->getUID()]);
+        $config = parent::addStorage($newStorage);
+        return $config;
+    }
 
-	/**
-	 * Update storage to the configuration
-	 *
-	 * @param StorageConfig $updatedStorage storage attributes
-	 *
-	 * @return StorageConfig storage config
-	 * @throws NotFoundException if the given storage does not exist in the config
-	 */
-	public function updateStorage(StorageConfig $updatedStorage) {
-		$updatedStorage->setApplicableUsers([$this->getUser()->getUID()]);
-		return parent::updateStorage($updatedStorage);
-	}
+    /**
+     * Update storage to the configuration
+     *
+     * @param StorageConfig $updatedStorage storage attributes
+     *
+     * @return StorageConfig storage config
+     * @throws NotFoundException if the given storage does not exist in the config
+     */
+    public function updateStorage(StorageConfig $updatedStorage) {
+        $updatedStorage->setApplicableUsers([$this->getUser()->getUID()]);
+        return parent::updateStorage($updatedStorage);
+    }
 
-	/**
-	 * Get the visibility type for this controller, used in validation
-	 *
-	 * @return string BackendService::VISIBILITY_* constants
-	 */
-	public function getVisibilityType() {
-		return BackendService::VISIBILITY_PERSONAL;
-	}
+    /**
+     * Get the visibility type for this controller, used in validation
+     *
+     * @return string BackendService::VISIBILITY_* constants
+     */
+    public function getVisibilityType() {
+        return BackendService::VISIBILITY_PERSONAL;
+    }
 
-	protected function isApplicable(StorageConfig $config) {
-		return ($config->getApplicableUsers() === [$this->getUser()->getUID()]) && $config->getType() === StorageConfig::MOUNT_TYPE_PERSONAl;
-	}
+    protected function isApplicable(StorageConfig $config) {
+        return ($config->getApplicableUsers() === [$this->getUser()->getUID()]) && $config->getType() === StorageConfig::MOUNT_TYPE_PERSONAl;
+    }
 }

apps/files_external/lib/Controller/UserStoragesController.php

Indentation +180 added lines, -180 removed lines

@@ -43,185 +43,185 @@
  * User storages controller
  */
 class UserStoragesController extends StoragesController {
-	/**
-	 * @var IUserSession
-	 */
-	private $userSession;
-
-	/**
-	 * Creates a new user storages controller.
-	 *
-	 * @param string $AppName application name
-	 * @param IRequest $request request object
-	 * @param IL10N $l10n l10n service
-	 * @param UserStoragesService $userStoragesService storage service
-	 * @param IUserSession $userSession
-	 * @param ILogger $logger
-	 */
-	public function __construct(
-		$AppName,
-		IRequest $request,
-		IL10N $l10n,
-		UserStoragesService $userStoragesService,
-		IUserSession $userSession,
-		ILogger $logger
-	) {
-		parent::__construct(
-			$AppName,
-			$request,
-			$l10n,
-			$userStoragesService,
-			$logger
-		);
-		$this->userSession = $userSession;
-	}
-
-	protected function manipulateStorageConfig(StorageConfig $storage) {
-		/** @var AuthMechanism */
-		$authMechanism = $storage->getAuthMechanism();
-		$authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser());
-		/** @var Backend */
-		$backend = $storage->getBackend();
-		$backend->manipulateStorageConfig($storage, $this->userSession->getUser());
-	}
-
-	/**
-	 * Get all storage entries
-	 *
-	 * @NoAdminRequired
-	 *
-	 * @return DataResponse
-	 */
-	public function index() {
-		return parent::index();
-	}
-
-	/**
-	 * Return storage
-	 *
-	 * @NoAdminRequired
-	 *
-	 * {@inheritdoc}
-	 */
-	public function show($id, $testOnly = true) {
-		return parent::show($id, $testOnly);
-	}
-
-	/**
-	 * Create an external storage entry.
-	 *
-	 * @param string $mountPoint storage mount point
-	 * @param string $backend backend identifier
-	 * @param string $authMechanism authentication mechanism identifier
-	 * @param array $backendOptions backend-specific options
-	 * @param array $mountOptions backend-specific mount options
-	 *
-	 * @return DataResponse
-	 *
-	 * @NoAdminRequired
-	 */
-	public function create(
-		$mountPoint,
-		$backend,
-		$authMechanism,
-		$backendOptions,
-		$mountOptions
-	) {
-		$newStorage = $this->createStorage(
-			$mountPoint,
-			$backend,
-			$authMechanism,
-			$backendOptions,
-			$mountOptions
-		);
-		if ($newStorage instanceOf DataResponse) {
-			return $newStorage;
-		}
-
-		$response = $this->validate($newStorage);
-		if (!empty($response)) {
-			return $response;
-		}
-
-		$newStorage = $this->service->addStorage($newStorage);
-		$this->updateStorageStatus($newStorage);
-
-		return new DataResponse(
-			$newStorage,
-			Http::STATUS_CREATED
-		);
-	}
-
-	/**
-	 * Update an external storage entry.
-	 *
-	 * @param int $id storage id
-	 * @param string $mountPoint storage mount point
-	 * @param string $backend backend identifier
-	 * @param string $authMechanism authentication mechanism identifier
-	 * @param array $backendOptions backend-specific options
-	 * @param array $mountOptions backend-specific mount options
-	 * @param bool $testOnly whether to storage should only test the connection or do more things
-	 *
-	 * @return DataResponse
-	 *
-	 * @NoAdminRequired
-	 */
-	public function update(
-		$id,
-		$mountPoint,
-		$backend,
-		$authMechanism,
-		$backendOptions,
-		$mountOptions,
-		$testOnly = true
-	) {
-		$storage = $this->createStorage(
-			$mountPoint,
-			$backend,
-			$authMechanism,
-			$backendOptions,
-			$mountOptions
-		);
-		if ($storage instanceOf DataResponse) {
-			return $storage;
-		}
-		$storage->setId($id);
-
-		$response = $this->validate($storage);
-		if (!empty($response)) {
-			return $response;
-		}
-
-		try {
-			$storage = $this->service->updateStorage($storage);
-		} catch (NotFoundException $e) {
-			return new DataResponse(
-				[
-					'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
-				],
-				Http::STATUS_NOT_FOUND
-			);
-		}
-
-		$this->updateStorageStatus($storage, $testOnly);
-
-		return new DataResponse(
-			$storage,
-			Http::STATUS_OK
-		);
-
-	}
-
-	/**
-	 * Delete storage
-	 *
-	 * @NoAdminRequired
-	 *
-	 * {@inheritdoc}
-	 */
-	public function destroy($id) {
-		return parent::destroy($id);
-	}
+    /**
+     * @var IUserSession
+     */
+    private $userSession;
+
+    /**
+     * Creates a new user storages controller.
+     *
+     * @param string $AppName application name
+     * @param IRequest $request request object
+     * @param IL10N $l10n l10n service
+     * @param UserStoragesService $userStoragesService storage service
+     * @param IUserSession $userSession
+     * @param ILogger $logger
+     */
+    public function __construct(
+        $AppName,
+        IRequest $request,
+        IL10N $l10n,
+        UserStoragesService $userStoragesService,
+        IUserSession $userSession,
+        ILogger $logger
+    ) {
+        parent::__construct(
+            $AppName,
+            $request,
+            $l10n,
+            $userStoragesService,
+            $logger
+        );
+        $this->userSession = $userSession;
+    }
+
+    protected function manipulateStorageConfig(StorageConfig $storage) {
+        /** @var AuthMechanism */
+        $authMechanism = $storage->getAuthMechanism();
+        $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser());
+        /** @var Backend */
+        $backend = $storage->getBackend();
+        $backend->manipulateStorageConfig($storage, $this->userSession->getUser());
+    }
+
+    /**
+     * Get all storage entries
+     *
+     * @NoAdminRequired
+     *
+     * @return DataResponse
+     */
+    public function index() {
+        return parent::index();
+    }
+
+    /**
+     * Return storage
+     *
+     * @NoAdminRequired
+     *
+     * {@inheritdoc}
+     */
+    public function show($id, $testOnly = true) {
+        return parent::show($id, $testOnly);
+    }
+
+    /**
+     * Create an external storage entry.
+     *
+     * @param string $mountPoint storage mount point
+     * @param string $backend backend identifier
+     * @param string $authMechanism authentication mechanism identifier
+     * @param array $backendOptions backend-specific options
+     * @param array $mountOptions backend-specific mount options
+     *
+     * @return DataResponse
+     *
+     * @NoAdminRequired
+     */
+    public function create(
+        $mountPoint,
+        $backend,
+        $authMechanism,
+        $backendOptions,
+        $mountOptions
+    ) {
+        $newStorage = $this->createStorage(
+            $mountPoint,
+            $backend,
+            $authMechanism,
+            $backendOptions,
+            $mountOptions
+        );
+        if ($newStorage instanceOf DataResponse) {
+            return $newStorage;
+        }
+
+        $response = $this->validate($newStorage);
+        if (!empty($response)) {
+            return $response;
+        }
+
+        $newStorage = $this->service->addStorage($newStorage);
+        $this->updateStorageStatus($newStorage);
+
+        return new DataResponse(
+            $newStorage,
+            Http::STATUS_CREATED
+        );
+    }
+
+    /**
+     * Update an external storage entry.
+     *
+     * @param int $id storage id
+     * @param string $mountPoint storage mount point
+     * @param string $backend backend identifier
+     * @param string $authMechanism authentication mechanism identifier
+     * @param array $backendOptions backend-specific options
+     * @param array $mountOptions backend-specific mount options
+     * @param bool $testOnly whether to storage should only test the connection or do more things
+     *
+     * @return DataResponse
+     *
+     * @NoAdminRequired
+     */
+    public function update(
+        $id,
+        $mountPoint,
+        $backend,
+        $authMechanism,
+        $backendOptions,
+        $mountOptions,
+        $testOnly = true
+    ) {
+        $storage = $this->createStorage(
+            $mountPoint,
+            $backend,
+            $authMechanism,
+            $backendOptions,
+            $mountOptions
+        );
+        if ($storage instanceOf DataResponse) {
+            return $storage;
+        }
+        $storage->setId($id);
+
+        $response = $this->validate($storage);
+        if (!empty($response)) {
+            return $response;
+        }
+
+        try {
+            $storage = $this->service->updateStorage($storage);
+        } catch (NotFoundException $e) {
+            return new DataResponse(
+                [
+                    'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
+                ],
+                Http::STATUS_NOT_FOUND
+            );
+        }
+
+        $this->updateStorageStatus($storage, $testOnly);
+
+        return new DataResponse(
+            $storage,
+            Http::STATUS_OK
+        );
+
+    }
+
+    /**
+     * Delete storage
+     *
+     * @NoAdminRequired
+     *
+     * {@inheritdoc}
+     */
+    public function destroy($id) {
+        return parent::destroy($id);
+    }
 
 }

apps/files_external/lib/Controller/GlobalStoragesController.php

Indentation +145 added lines, -145 removed lines

@@ -39,151 +39,151 @@
  * Global storages controller
  */
 class GlobalStoragesController extends StoragesController {
-	/**
-	 * Creates a new global storages controller.
-	 *
-	 * @param string $AppName application name
-	 * @param IRequest $request request object
-	 * @param IL10N $l10n l10n service
-	 * @param GlobalStoragesService $globalStoragesService storage service
-	 * @param ILogger $logger
-	 */
-	public function __construct(
-		$AppName,
-		IRequest $request,
-		IL10N $l10n,
-		GlobalStoragesService $globalStoragesService,
-		ILogger $logger
-	) {
-		parent::__construct(
-			$AppName,
-			$request,
-			$l10n,
-			$globalStoragesService,
-			$logger
-		);
-	}
-
-	/**
-	 * Create an external storage entry.
-	 *
-	 * @param string $mountPoint storage mount point
-	 * @param string $backend backend identifier
-	 * @param string $authMechanism authentication mechanism identifier
-	 * @param array $backendOptions backend-specific options
-	 * @param array $mountOptions mount-specific options
-	 * @param array $applicableUsers users for which to mount the storage
-	 * @param array $applicableGroups groups for which to mount the storage
-	 * @param int $priority priority
-	 *
-	 * @return DataResponse
-	 */
-	public function create(
-		$mountPoint,
-		$backend,
-		$authMechanism,
-		$backendOptions,
-		$mountOptions,
-		$applicableUsers,
-		$applicableGroups,
-		$priority
-	) {
-		$newStorage = $this->createStorage(
-			$mountPoint,
-			$backend,
-			$authMechanism,
-			$backendOptions,
-			$mountOptions,
-			$applicableUsers,
-			$applicableGroups,
-			$priority
-		);
-		if ($newStorage instanceof DataResponse) {
-			return $newStorage;
-		}
-
-		$response = $this->validate($newStorage);
-		if (!empty($response)) {
-			return $response;
-		}
-
-		$newStorage = $this->service->addStorage($newStorage);
-
-		$this->updateStorageStatus($newStorage);
-
-		return new DataResponse(
-			$newStorage,
-			Http::STATUS_CREATED
-		);
-	}
-
-	/**
-	 * Update an external storage entry.
-	 *
-	 * @param int $id storage id
-	 * @param string $mountPoint storage mount point
-	 * @param string $backend backend identifier
-	 * @param string $authMechanism authentication mechansim identifier
-	 * @param array $backendOptions backend-specific options
-	 * @param array $mountOptions mount-specific options
-	 * @param array $applicableUsers users for which to mount the storage
-	 * @param array $applicableGroups groups for which to mount the storage
-	 * @param int $priority priority
-	 * @param bool $testOnly whether to storage should only test the connection or do more things
-	 *
-	 * @return DataResponse
-	 */
-	public function update(
-		$id,
-		$mountPoint,
-		$backend,
-		$authMechanism,
-		$backendOptions,
-		$mountOptions,
-		$applicableUsers,
-		$applicableGroups,
-		$priority,
-		$testOnly = true
-	) {
-		$storage = $this->createStorage(
-			$mountPoint,
-			$backend,
-			$authMechanism,
-			$backendOptions,
-			$mountOptions,
-			$applicableUsers,
-			$applicableGroups,
-			$priority
-		);
-		if ($storage instanceof DataResponse) {
-			return $storage;
-		}
-		$storage->setId($id);
-
-		$response = $this->validate($storage);
-		if (!empty($response)) {
-			return $response;
-		}
-
-		try {
-			$storage = $this->service->updateStorage($storage);
-		} catch (NotFoundException $e) {
-			return new DataResponse(
-				[
-					'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
-				],
-				Http::STATUS_NOT_FOUND
-			);
-		}
-
-		$this->updateStorageStatus($storage, $testOnly);
-
-		return new DataResponse(
-			$storage,
-			Http::STATUS_OK
-		);
-
-	}
+    /**
+     * Creates a new global storages controller.
+     *
+     * @param string $AppName application name
+     * @param IRequest $request request object
+     * @param IL10N $l10n l10n service
+     * @param GlobalStoragesService $globalStoragesService storage service
+     * @param ILogger $logger
+     */
+    public function __construct(
+        $AppName,
+        IRequest $request,
+        IL10N $l10n,
+        GlobalStoragesService $globalStoragesService,
+        ILogger $logger
+    ) {
+        parent::__construct(
+            $AppName,
+            $request,
+            $l10n,
+            $globalStoragesService,
+            $logger
+        );
+    }
+
+    /**
+     * Create an external storage entry.
+     *
+     * @param string $mountPoint storage mount point
+     * @param string $backend backend identifier
+     * @param string $authMechanism authentication mechanism identifier
+     * @param array $backendOptions backend-specific options
+     * @param array $mountOptions mount-specific options
+     * @param array $applicableUsers users for which to mount the storage
+     * @param array $applicableGroups groups for which to mount the storage
+     * @param int $priority priority
+     *
+     * @return DataResponse
+     */
+    public function create(
+        $mountPoint,
+        $backend,
+        $authMechanism,
+        $backendOptions,
+        $mountOptions,
+        $applicableUsers,
+        $applicableGroups,
+        $priority
+    ) {
+        $newStorage = $this->createStorage(
+            $mountPoint,
+            $backend,
+            $authMechanism,
+            $backendOptions,
+            $mountOptions,
+            $applicableUsers,
+            $applicableGroups,
+            $priority
+        );
+        if ($newStorage instanceof DataResponse) {
+            return $newStorage;
+        }
+
+        $response = $this->validate($newStorage);
+        if (!empty($response)) {
+            return $response;
+        }
+
+        $newStorage = $this->service->addStorage($newStorage);
+
+        $this->updateStorageStatus($newStorage);
+
+        return new DataResponse(
+            $newStorage,
+            Http::STATUS_CREATED
+        );
+    }
+
+    /**
+     * Update an external storage entry.
+     *
+     * @param int $id storage id
+     * @param string $mountPoint storage mount point
+     * @param string $backend backend identifier
+     * @param string $authMechanism authentication mechansim identifier
+     * @param array $backendOptions backend-specific options
+     * @param array $mountOptions mount-specific options
+     * @param array $applicableUsers users for which to mount the storage
+     * @param array $applicableGroups groups for which to mount the storage
+     * @param int $priority priority
+     * @param bool $testOnly whether to storage should only test the connection or do more things
+     *
+     * @return DataResponse
+     */
+    public function update(
+        $id,
+        $mountPoint,
+        $backend,
+        $authMechanism,
+        $backendOptions,
+        $mountOptions,
+        $applicableUsers,
+        $applicableGroups,
+        $priority,
+        $testOnly = true
+    ) {
+        $storage = $this->createStorage(
+            $mountPoint,
+            $backend,
+            $authMechanism,
+            $backendOptions,
+            $mountOptions,
+            $applicableUsers,
+            $applicableGroups,
+            $priority
+        );
+        if ($storage instanceof DataResponse) {
+            return $storage;
+        }
+        $storage->setId($id);
+
+        $response = $this->validate($storage);
+        if (!empty($response)) {
+            return $response;
+        }
+
+        try {
+            $storage = $this->service->updateStorage($storage);
+        } catch (NotFoundException $e) {
+            return new DataResponse(
+                [
+                    'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
+                ],
+                Http::STATUS_NOT_FOUND
+            );
+        }
+
+        $this->updateStorageStatus($storage, $testOnly);
+
+        return new DataResponse(
+            $storage,
+            Http::STATUS_OK
+        );
+
+    }
 
 
 }

apps/files_external/lib/Controller/UserGlobalStoragesController.php

Indentation +160 added lines, -160 removed lines

@@ -43,165 +43,165 @@
  * User global storages controller
  */
 class UserGlobalStoragesController extends StoragesController {
-	/**
-	 * @var IUserSession
-	 */
-	private $userSession;
-
-	/**
-	 * Creates a new user global storages controller.
-	 *
-	 * @param string $AppName application name
-	 * @param IRequest $request request object
-	 * @param IL10N $l10n l10n service
-	 * @param UserGlobalStoragesService $userGlobalStoragesService storage service
-	 * @param IUserSession $userSession
-	 */
-	public function __construct(
-		$AppName,
-		IRequest $request,
-		IL10N $l10n,
-		UserGlobalStoragesService $userGlobalStoragesService,
-		IUserSession $userSession,
-		ILogger $logger
-	) {
-		parent::__construct(
-			$AppName,
-			$request,
-			$l10n,
-			$userGlobalStoragesService,
-			$logger
-		);
-		$this->userSession = $userSession;
-	}
-
-	/**
-	 * Get all storage entries
-	 *
-	 * @return DataResponse
-	 *
-	 * @NoAdminRequired
-	 */
-	public function index() {
-		$storages = $this->service->getUniqueStorages();
-
-		// remove configuration data, this must be kept private
-		foreach ($storages as $storage) {
-			$this->sanitizeStorage($storage);
-		}
-
-		return new DataResponse(
-			$storages,
-			Http::STATUS_OK
-		);
-	}
-
-	protected function manipulateStorageConfig(StorageConfig $storage) {
-		/** @var AuthMechanism */
-		$authMechanism = $storage->getAuthMechanism();
-		$authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser());
-		/** @var Backend */
-		$backend = $storage->getBackend();
-		$backend->manipulateStorageConfig($storage, $this->userSession->getUser());
-	}
-
-	/**
-	 * Get an external storage entry.
-	 *
-	 * @param int $id storage id
-	 * @param bool $testOnly whether to storage should only test the connection or do more things
-	 * @return DataResponse
-	 *
-	 * @NoAdminRequired
-	 */
-	public function show($id, $testOnly = true) {
-		try {
-			$storage = $this->service->getStorage($id);
-
-			$this->updateStorageStatus($storage, $testOnly);
-		} catch (NotFoundException $e) {
-			return new DataResponse(
-				[
-					'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
-				],
-				Http::STATUS_NOT_FOUND
-			);
-		}
-
-		$this->sanitizeStorage($storage);
-
-		return new DataResponse(
-			$storage,
-			Http::STATUS_OK
-		);
-	}
-
-	/**
-	 * Update an external storage entry.
-	 * Only allows setting user provided backend fields
-	 *
-	 * @param int $id storage id
-	 * @param array $backendOptions backend-specific options
-	 * @param bool $testOnly whether to storage should only test the connection or do more things
-	 *
-	 * @return DataResponse
-	 *
-	 * @NoAdminRequired
-	 */
-	public function update(
-		$id,
-		$backendOptions,
-		$testOnly = true
-	) {
-		try {
-			$storage = $this->service->getStorage($id);
-			$authMechanism = $storage->getAuthMechanism();
-			if ($authMechanism instanceof IUserProvided) {
-				$authMechanism->saveBackendOptions($this->userSession->getUser(), $id, $backendOptions);
-				$authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser());
-			} else {
-				return new DataResponse(
-					[
-						'message' => (string)$this->l10n->t('Storage with id "%i" is not user editable', array($id))
-					],
-					Http::STATUS_FORBIDDEN
-				);
-			}
-		} catch (NotFoundException $e) {
-			return new DataResponse(
-				[
-					'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
-				],
-				Http::STATUS_NOT_FOUND
-			);
-		}
-
-		$this->updateStorageStatus($storage, $testOnly);
-		$this->sanitizeStorage($storage);
-
-		return new DataResponse(
-			$storage,
-			Http::STATUS_OK
-		);
-
-	}
-
-	/**
-	 * Remove sensitive data from a StorageConfig before returning it to the user
-	 *
-	 * @param StorageConfig $storage
-	 */
-	protected function sanitizeStorage(StorageConfig $storage) {
-		$storage->setBackendOptions([]);
-		$storage->setMountOptions([]);
-
-		if ($storage->getAuthMechanism() instanceof IUserProvided) {
-			try {
-				$storage->getAuthMechanism()->manipulateStorageConfig($storage, $this->userSession->getUser());
-			} catch (InsufficientDataForMeaningfulAnswerException $e) {
-				// not configured yet
-			}
-		}
-	}
+    /**
+     * @var IUserSession
+     */
+    private $userSession;
+
+    /**
+     * Creates a new user global storages controller.
+     *
+     * @param string $AppName application name
+     * @param IRequest $request request object
+     * @param IL10N $l10n l10n service
+     * @param UserGlobalStoragesService $userGlobalStoragesService storage service
+     * @param IUserSession $userSession
+     */
+    public function __construct(
+        $AppName,
+        IRequest $request,
+        IL10N $l10n,
+        UserGlobalStoragesService $userGlobalStoragesService,
+        IUserSession $userSession,
+        ILogger $logger
+    ) {
+        parent::__construct(
+            $AppName,
+            $request,
+            $l10n,
+            $userGlobalStoragesService,
+            $logger
+        );
+        $this->userSession = $userSession;
+    }
+
+    /**
+     * Get all storage entries
+     *
+     * @return DataResponse
+     *
+     * @NoAdminRequired
+     */
+    public function index() {
+        $storages = $this->service->getUniqueStorages();
+
+        // remove configuration data, this must be kept private
+        foreach ($storages as $storage) {
+            $this->sanitizeStorage($storage);
+        }
+
+        return new DataResponse(
+            $storages,
+            Http::STATUS_OK
+        );
+    }
+
+    protected function manipulateStorageConfig(StorageConfig $storage) {
+        /** @var AuthMechanism */
+        $authMechanism = $storage->getAuthMechanism();
+        $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser());
+        /** @var Backend */
+        $backend = $storage->getBackend();
+        $backend->manipulateStorageConfig($storage, $this->userSession->getUser());
+    }
+
+    /**
+     * Get an external storage entry.
+     *
+     * @param int $id storage id
+     * @param bool $testOnly whether to storage should only test the connection or do more things
+     * @return DataResponse
+     *
+     * @NoAdminRequired
+     */
+    public function show($id, $testOnly = true) {
+        try {
+            $storage = $this->service->getStorage($id);
+
+            $this->updateStorageStatus($storage, $testOnly);
+        } catch (NotFoundException $e) {
+            return new DataResponse(
+                [
+                    'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
+                ],
+                Http::STATUS_NOT_FOUND
+            );
+        }
+
+        $this->sanitizeStorage($storage);
+
+        return new DataResponse(
+            $storage,
+            Http::STATUS_OK
+        );
+    }
+
+    /**
+     * Update an external storage entry.
+     * Only allows setting user provided backend fields
+     *
+     * @param int $id storage id
+     * @param array $backendOptions backend-specific options
+     * @param bool $testOnly whether to storage should only test the connection or do more things
+     *
+     * @return DataResponse
+     *
+     * @NoAdminRequired
+     */
+    public function update(
+        $id,
+        $backendOptions,
+        $testOnly = true
+    ) {
+        try {
+            $storage = $this->service->getStorage($id);
+            $authMechanism = $storage->getAuthMechanism();
+            if ($authMechanism instanceof IUserProvided) {
+                $authMechanism->saveBackendOptions($this->userSession->getUser(), $id, $backendOptions);
+                $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser());
+            } else {
+                return new DataResponse(
+                    [
+                        'message' => (string)$this->l10n->t('Storage with id "%i" is not user editable', array($id))
+                    ],
+                    Http::STATUS_FORBIDDEN
+                );
+            }
+        } catch (NotFoundException $e) {
+            return new DataResponse(
+                [
+                    'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
+                ],
+                Http::STATUS_NOT_FOUND
+            );
+        }
+
+        $this->updateStorageStatus($storage, $testOnly);
+        $this->sanitizeStorage($storage);
+
+        return new DataResponse(
+            $storage,
+            Http::STATUS_OK
+        );
+
+    }
+
+    /**
+     * Remove sensitive data from a StorageConfig before returning it to the user
+     *
+     * @param StorageConfig $storage
+     */
+    protected function sanitizeStorage(StorageConfig $storage) {
+        $storage->setBackendOptions([]);
+        $storage->setMountOptions([]);
+
+        if ($storage->getAuthMechanism() instanceof IUserProvided) {
+            try {
+                $storage->getAuthMechanism()->manipulateStorageConfig($storage, $this->userSession->getUser());
+            } catch (InsufficientDataForMeaningfulAnswerException $e) {
+                // not configured yet
+            }
+        }
+    }
 
 }