Add a controller with the most important methods

Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2018-10-16 17:48:16 +02:00 committed by Julius Härtl
parent 69b530a442
commit 65a9ab47ea
No known key found for this signature in database
GPG Key ID: 4C614C6ED2CDE6DF
7 changed files with 202 additions and 6 deletions

View File

@ -0,0 +1,163 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com>
*
* @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 <http://www.gnu.org/licenses/>.
*
*/
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()
];
}
}

View File

@ -90,6 +90,11 @@ $application->registerRoutes($this, [
['root' => '/core', 'name' => 'WhatsNew#get', 'url' => '/whatsnew', 'verb' => 'GET'], ['root' => '/core', 'name' => 'WhatsNew#get', 'url' => '/whatsnew', 'verb' => 'GET'],
['root' => '/core', 'name' => 'WhatsNew#dismiss', 'url' => '/whatsnew', 'verb' => 'POST'], ['root' => '/core', 'name' => 'WhatsNew#dismiss', 'url' => '/whatsnew', 'verb' => 'POST'],
['root' => '/core', 'name' => 'AppPassword#getAppPassword', 'url' => '/getapppassword', 'verb' => 'GET'], ['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'],
], ],
]); ]);

View File

@ -66,19 +66,18 @@ class Resource implements IResource {
} }
/** /**
* @param IResource $resource
* @return ICollection[] * @return ICollection[]
* @since 15.0.0 * @since 15.0.0
*/ */
public function getCollections(IResource $resource): array { public function getCollections(): array {
$collections = []; $collections = [];
$query = $this->connection->getQueryBuilder(); $query = $this->connection->getQueryBuilder();
$query->select('collection_id') $query->select('collection_id')
->from('collres_resources') ->from('collres_resources')
->where($query->expr()->eq('resource_type', $query->createNamedParameter($resource->getType()))) ->where($query->expr()->eq('resource_type', $query->createNamedParameter($this->getType())))
->andWhere($query->expr()->eq('resource_id', $query->createNamedParameter($resource->getId()))); ->andWhere($query->expr()->eq('resource_id', $query->createNamedParameter($this->getId())));
$result = $query->execute(); $result = $query->execute();
while ($row = $result->fetch()) { while ($row = $result->fetch()) {

View File

@ -0,0 +1,28 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com>
*
* @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 <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Collaboration\Resources;
class CollectionException extends \RuntimeException {
}

View File

@ -1,4 +1,5 @@
<?php <?php
declare(strict_types=1);
/** /**
* @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com> * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com>
* *

View File

@ -40,9 +40,8 @@ interface IResource {
public function getId(): string; public function getId(): string;
/** /**
* @param IResource $resource
* @return ICollection[] * @return ICollection[]
* @since 15.0.0 * @since 15.0.0
*/ */
public function getCollections(IResource $resource): array; public function getCollections(): array;
} }

View File

@ -1,4 +1,5 @@
<?php <?php
declare(strict_types=1);
/** /**
* @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com> * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.com>
* *