diff --git a/core/Controller/CollaborationResourcesController.php b/core/Controller/CollaborationResourcesController.php new file mode 100644 index 0000000000..b56d67d845 --- /dev/null +++ b/core/Controller/CollaborationResourcesController.php @@ -0,0 +1,163 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OC\Core\Controller; + +use OCP\AppFramework\Http; +use OCP\AppFramework\OCSController; +use OCP\AppFramework\Http\DataResponse; +use OCP\Collaboration\Resources\CollectionException; +use OCP\Collaboration\Resources\ICollection; +use OCP\Collaboration\Resources\IManager; +use OCP\Collaboration\Resources\IResource; +use OCP\Collaboration\Resources\ResourceException; +use OCP\IRequest; + +class CollaborationResourcesController extends OCSController { + /** @var IManager */ + private $manager; + + public function __construct( + $appName, + IRequest $request, + IManager $manager + ) { + parent::__construct($appName, $request); + + $this->manager = $manager; + } + + /** + * @param int $collectionId + * @return ICollection + * @throws CollectionException when the collection was not found for the user + */ + protected function getCollection(int $collectionId): ICollection { + $collection = $this->manager->getCollection($collectionId); + + if (false) { // TODO auth checking + throw new CollectionException('Not found'); + } + + return $collection; + } + + /** + * @NoAdminRequired + * + * @param int $collectionId + * @return DataResponse + */ + public function listCollection(int $collectionId): DataResponse { + try { + $collection = $this->getCollection($collectionId); + } catch (CollectionException $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + + return new DataResponse($this->prepareCollection($collection)); + } + + /** + * @NoAdminRequired + * + * @param int $collectionId + * @param string $resourceType + * @param string $resourceId + * @return DataResponse + */ + public function addResource(int $collectionId, string $resourceType, string $resourceId): DataResponse { + try { + $collection = $this->getCollection($collectionId); + } catch (CollectionException $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + + try { + $resource = $this->manager->getResource($resourceType, $resourceId); + } catch (ResourceException $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + + try { + $collection->addResource($resource); + } catch (ResourceException $e) { + } + + return new DataResponse($this->prepareCollection($collection)); + } + + /** + * @NoAdminRequired + * + * @param int $collectionId + * @param string $resourceType + * @param string $resourceId + * @return DataResponse + */ + public function removeResource(int $collectionId, string $resourceType, string $resourceId): DataResponse { + try { + $collection = $this->getCollection($collectionId); + } catch (CollectionException $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + + try { + $resource = $this->manager->getResource($resourceType, $resourceId); + } catch (CollectionException $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + + $collection->removeResource($resource); + + return new DataResponse($this->prepareCollection($collection)); + } + + /** + * @NoAdminRequired + * + * @param string $resourceType + * @param string $resourceId + * @return DataResponse + */ + public function getCollectionsByResource(string $resourceType, string $resourceId): DataResponse { + try { + // TODO auth checking + $resource = $this->manager->getResource($resourceType, $resourceId); + } catch (CollectionException $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + + return new DataResponse(array_map([$this, 'prepareCollection'], $resource->getCollections())); + } + + protected function prepareCollection(ICollection $collection): array { + return array_map([$this, 'prepareResources'], $collection->getResources()); + } + + protected function prepareResources(IResource $resource): array { + return [ + 'type' => $resource->getType(), + 'id' => $resource->getId() + ]; + } +} diff --git a/core/routes.php b/core/routes.php index d79fea1ca2..7fcd576d32 100644 --- a/core/routes.php +++ b/core/routes.php @@ -90,6 +90,11 @@ $application->registerRoutes($this, [ ['root' => '/core', 'name' => 'WhatsNew#get', 'url' => '/whatsnew', 'verb' => 'GET'], ['root' => '/core', 'name' => 'WhatsNew#dismiss', 'url' => '/whatsnew', 'verb' => 'POST'], ['root' => '/core', 'name' => 'AppPassword#getAppPassword', 'url' => '/getapppassword', 'verb' => 'GET'], + + ['root' => '/collaboration', 'name' => 'CollaborationResources#listCollection', 'url' => '/resources/collections/{collectionId}', 'verb' => 'GET'], + ['root' => '/collaboration', 'name' => 'CollaborationResources#addResource', 'url' => '/resources/collections/{collectionId}', 'verb' => 'POST'], + ['root' => '/collaboration', 'name' => 'CollaborationResources#removeResource', 'url' => '/resources/collections/{collectionId}', 'verb' => 'DELETE'], + ['root' => '/collaboration', 'name' => 'CollaborationResources#getCollectionsByResource', 'url' => '/resources/{resourceType}/{resourceId}', 'verb' => 'GET'], ], ]); diff --git a/lib/private/Collaboration/Resources/Resource.php b/lib/private/Collaboration/Resources/Resource.php index f82ceff559..0eda8ba55c 100644 --- a/lib/private/Collaboration/Resources/Resource.php +++ b/lib/private/Collaboration/Resources/Resource.php @@ -66,19 +66,18 @@ class Resource implements IResource { } /** - * @param IResource $resource * @return ICollection[] * @since 15.0.0 */ - public function getCollections(IResource $resource): array { + public function getCollections(): array { $collections = []; $query = $this->connection->getQueryBuilder(); $query->select('collection_id') ->from('collres_resources') - ->where($query->expr()->eq('resource_type', $query->createNamedParameter($resource->getType()))) - ->andWhere($query->expr()->eq('resource_id', $query->createNamedParameter($resource->getId()))); + ->where($query->expr()->eq('resource_type', $query->createNamedParameter($this->getType()))) + ->andWhere($query->expr()->eq('resource_id', $query->createNamedParameter($this->getId()))); $result = $query->execute(); while ($row = $result->fetch()) { diff --git a/lib/public/Collaboration/Resources/CollectionException.php b/lib/public/Collaboration/Resources/CollectionException.php new file mode 100644 index 0000000000..f5130d37d6 --- /dev/null +++ b/lib/public/Collaboration/Resources/CollectionException.php @@ -0,0 +1,28 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Collaboration\Resources; + + +class CollectionException extends \RuntimeException { + +} diff --git a/lib/public/Collaboration/Resources/IProvider.php b/lib/public/Collaboration/Resources/IProvider.php index 06e2a6a81e..eac92733de 100644 --- a/lib/public/Collaboration/Resources/IProvider.php +++ b/lib/public/Collaboration/Resources/IProvider.php @@ -1,4 +1,5 @@ * diff --git a/lib/public/Collaboration/Resources/IResource.php b/lib/public/Collaboration/Resources/IResource.php index 42631bc27a..9f8628c0d4 100644 --- a/lib/public/Collaboration/Resources/IResource.php +++ b/lib/public/Collaboration/Resources/IResource.php @@ -40,9 +40,8 @@ interface IResource { public function getId(): string; /** - * @param IResource $resource * @return ICollection[] * @since 15.0.0 */ - public function getCollections(IResource $resource): array; + public function getCollections(): array; } diff --git a/lib/public/Collaboration/Resources/ResourceException.php b/lib/public/Collaboration/Resources/ResourceException.php index f31b2031a8..d03264bcef 100644 --- a/lib/public/Collaboration/Resources/ResourceException.php +++ b/lib/public/Collaboration/Resources/ResourceException.php @@ -1,4 +1,5 @@ *