Allow to restore/delete pages from trash via Collectives API

Signed-off-by: Jonas <[email protected]>

appinfo/routes.php

@@ -61,6 +61,13 @@
 		['name' => 'page#getAttachments', 'url' => '/_api/{collectiveId}/_pages/parent/{parentId}/page/{id}/attachments',
 			'verb' => 'GET', 'requirements' => ['collectiveId' => '\d+', 'parentId' => '\d+', 'id' => '\d+']],
 
+		// pages trash API
+		['name' => 'pageTrash#index', 'url' => '/_api/{collectiveId}/_pages/trash', 'verb' => 'GET'],
+		['name' => 'pageTrash#delete', 'url' => '/_api/{collectiveId}/_pages/trash/{id}', 'verb' => 'DELETE',
+			'requirements' => ['id' => '\d+']],
+		['name' => 'pageTrash#restore', 'url' => '/_api/{collectiveId}/_pages/trash/{id}', 'verb' => 'PATCH',
+			'requirements' => ['id' => '\d+']],
+
 		// public collectives API
 		['name' => 'publicCollective#get', 'url' => '/_api/p/{token}', 'verb' => 'GET'],
 
@@ -85,6 +92,13 @@
 		['name' => 'publicPage#getBacklinks', 'url' => '/_api/p/{token}/_pages/parent/{parentId}/page/{id}/backlinks',
 			'verb' => 'GET', 'requirements' => ['parentId' => '\d+', 'id' => '\d+']],
 
+		// public pages trash API
+		['name' => 'publicPageTrash#index', 'url' => '/_api/p/{token}/_pages/trash', 'verb' => 'GET'],
+		['name' => 'publicPageTrash#delete', 'url' => '/_api/p/{token}/_pages/trash/{id}', 'verb' => 'DELETE',
+			'requirements' => ['id' => '\d+']],
+		['name' => 'publicPageTrash#restore', 'url' => '/_api/p/{token}/_pages/trash/{id}', 'verb' => 'PATCH',
+			'requirements' => ['id' => '\d+']],
+
 		// default public route (Vue.js frontend)
 		['name' => 'publicStart#publicIndex', 'url' => '/p/{token}/{path}', 'verb' => 'GET',
 			'requirements' => ['path' => '.*'],	'defaults' => ['path' => '']],

lib/Controller/PageTrashController.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace OCA\Collectives\Controller;
+
+use OCA\Collectives\Service\PageService;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\IRequest;
+use OCP\IUserSession;
+use Psr\Log\LoggerInterface;
+
+class PageTrashController extends Controller {
+	private PageService $service;
+	private IUserSession $userSession;
+	private LoggerInterface $logger;
+
+	use ErrorHelper;
+
+	public function __construct(string            $appName,
+		IRequest          $request,
+		PageService       $service,
+		IUserSession      $userSession,
+		LoggerInterface   $logger) {
+		parent::__construct($appName, $request);
+		$this->service = $service;
+		$this->userSession = $userSession;
+		$this->logger = $logger;
+	}
+
+	/**
+	 * @return string
+	 */
+	private function getUserId(): string {
+		return $this->userSession->getUser()->getUID();
+	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @param int $collectiveId
+	 *
+	 * @return DataResponse
+	 */
+	public function index(int $collectiveId): DataResponse {
+		return $this->handleErrorResponse(function () use ($collectiveId): array {
+			$userId = $this->getUserId();
+			$pageInfos = $this->service->findAllTrash($collectiveId, $userId);
+			return [
+				"data" => $pageInfos
+			];
+		}, $this->logger);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @param int $collectiveId
+	 * @param int $id
+	 *
+	 * @return DataResponse
+	 */
+	public function restore(int $collectiveId, int $id): DataResponse {
+		return $this->handleErrorResponse(function () use ($collectiveId, $id): array {
+			$userId = $this->getUserId();
+			$pageInfo = $this->service->restore($collectiveId, $id, $userId);
+			return [
+				"data" => $pageInfo
+			];
+		}, $this->logger);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @param int $collectiveId
+	 * @param int $id
+	 *
+	 * @return DataResponse
+	 */
+	public function delete(int $collectiveId, int $id): DataResponse {
+		return $this->handleErrorResponse(function () use ($collectiveId, $id): array {
+			$userId = $this->getUserId();
+			$this->service->delete($collectiveId, $id, $userId);
+			return [];
+		}, $this->logger);
+	}
+}

lib/Controller/PublicPageTrashController.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace OCA\Collectives\Controller;
+
+use OCA\Collectives\Db\CollectiveShareMapper;
+use OCA\Collectives\Model\CollectiveShareInfo;
+use OCA\Collectives\Service\CollectiveShareService;
+use OCA\Collectives\Service\NotFoundException;
+use OCA\Collectives\Service\NotPermittedException;
+use OCA\Collectives\Service\PageService;
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Db\MultipleObjectsReturnedException;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\PublicShareController;
+use OCP\IRequest;
+use OCP\ISession;
+use Psr\Log\LoggerInterface;
+
+class PublicPageTrashController extends PublicShareController {
+	private CollectiveShareMapper $collectiveShareMapper;
+	private CollectiveShareService $collectiveShareService;
+	private PageService $service;
+	private LoggerInterface $logger;
+	private ?CollectiveShareInfo $share = null;
+
+	use ErrorHelper;
+
+	public function __construct(string                 $appName,
+		IRequest               $request,
+		CollectiveShareMapper  $collectiveShareMapper,
+		CollectiveShareService $collectiveShareService,
+		PageService            $service,
+		ISession               $session,
+		LoggerInterface        $logger) {
+		parent::__construct($appName, $request, $session);
+		$this->collectiveShareMapper = $collectiveShareMapper;
+		$this->collectiveShareService = $collectiveShareService;
+		$this->service = $service;
+		$this->logger = $logger;
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getPasswordHash(): string {
+		return '';
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isValidToken(): bool {
+		try {
+			$this->collectiveShareMapper->findOneByToken($this->getToken());
+		} catch (DoesNotExistException | MultipleObjectsReturnedException $e) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * @return bool
+	 */
+	protected function isPasswordProtected(): bool {
+		return false;
+	}
+
+	/**
+	 * @return CollectiveShareInfo
+	 * @throws NotFoundException
+	 */
+	private function getShare(): CollectiveShareInfo {
+		if (null === $this->share) {
+			$this->share = $this->collectiveShareService->findShareByToken($this->getToken());
+
+			if ($this->share === null) {
+				throw new NotFoundException('Failed to get shared collective');
+			}
+		}
+
+		return $this->share;
+	}
+
+	/**
+	 * @return void
+	 * @throws NotFoundException
+	 * @throws NotPermittedException
+	 */
+	private function checkEditPermissions(): void {
+		if (!$this->getShare()->getEditable()) {
+			throw new NotPermittedException('Not permitted to edit shared collective');
+		}
+	}
+
+	/**
+	 * @PublicPage
+	 *
+	 * @return DataResponse
+	 */
+	public function index(): DataResponse {
+		return $this->handleErrorResponse(function (): array {
+			$owner = $this->getShare()->getOwner();
+			$collectiveId = $this->getShare()->getCollectiveId();
+			$pageInfos = $this->service->findAll($collectiveId, $owner);
+			foreach ($pageInfos as $pageInfo) {
+				// Shares don't have a collective path
+				$pageInfo->setCollectivePath('');
+				$pageInfo->setShareToken($this->getToken());
+			}
+			return [
+				"data" => $pageInfos
+			];
+		}, $this->logger);
+	}
+
+	/**
+	 * @PublicPage
+	 *
+	 * @param int $id
+	 *
+	 * @return DataResponse
+	 */
+	public function restore(int $id): DataResponse {
+		return $this->handleErrorResponse(function () use ($id): array {
+			$this->checkEditPermissions();
+			$owner = $this->getShare()->getOwner();
+			$collectiveId = $this->getShare()->getCollectiveId();
+			$pageInfo = $this->service->restore($collectiveId, $id, $owner);
+			// Shares don't have a collective path
+			$pageInfo->setCollectivePath('');
+			$pageInfo->setShareToken($this->getToken());
+			return [
+				"data" => $pageInfo
+			];
+		}, $this->logger);
+	}
+
+	/**
+	 * @PublicPage
+	 *
+	 * @param int $id
+	 *
+	 * @return DataResponse
+	 */
+	public function delete(int $id): DataResponse {
+		return $this->handleErrorResponse(function () use ($id): array {
+			$this->checkEditPermissions();
+			$owner = $this->getShare()->getOwner();
+			$collectiveId = $this->getShare()->getCollectiveId();
+			$this->service->delete($collectiveId, $id, $owner);
+			return [];
+		}, $this->logger);
+	}
+}