Implement share provider for deck

Signed-off-by: Julius Härtl <jus@bitgrid.net>

lib/Sharing/Listener.php

@@ -0,0 +1,113 @@
+<?php
+/*
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Sharing;
+
+
+use OC\Files\Filesystem;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\Share\Events\VerifyMountPointEvent;
+use OCP\Share\IShare;
+use Symfony\Component\EventDispatcher\GenericEvent;
+
+class Listener {
+
+	public function __construct($userId) {
+		$this->userId = $userId;
+	}
+
+	public function register(IEventDispatcher $dispatcher): void {
+		/**
+		 * @psalm-suppress UndefinedClass
+		 */
+		$dispatcher->addListener('OCP\Share::preShare', [self::class, 'listenPreShare'], 1000);
+		$dispatcher->addListener(VerifyMountPointEvent::class, [self::class, 'listenVerifyMountPointEvent'], 1000);
+	}
+
+	public static function listenPreShare(GenericEvent $event): void {
+		/** @var self $listener */
+		$listener = \OC::$server->query(self::class);
+		$listener->overwriteShareTarget($event);
+	}
+
+	public static function listenVerifyMountPointEvent(VerifyMountPointEvent $event): void {
+		/** @var self $listener */
+		$listener = \OC::$server->query(self::class);
+		$listener->overwriteMountPoint($event);
+	}
+
+	public function overwriteShareTarget(GenericEvent $event): void {
+		/** @var IShare $share */
+		$share = $event->getSubject();
+
+		if ($share->getShareType() !== IShare::TYPE_DECK
+			&& $share->getShareType() !== DeckShareProvider::SHARE_TYPE_DECK_USER) {
+			return;
+		}
+
+		$target = DeckShareProvider::DECK_FOLDER_PLACEHOLDER . '/' . $share->getNode()->getName();
+		$target = Filesystem::normalizePath($target);
+		$share->setTarget($target);
+	}
+
+	public function overwriteMountPoint(VerifyMountPointEvent $event): void {
+		$share = $event->getShare();
+		$view = $event->getView();
+
+		if ($share->getShareType() !== IShare::TYPE_DECK
+			&& $share->getShareType() !== DeckShareProvider::SHARE_TYPE_DECK_USER) {
+			return;
+		}
+
+		if ($event->getParent() === DeckShareProvider::DECK_FOLDER_PLACEHOLDER) {
+			try {
+				$userId = $view->getOwner('/');
+			} catch (\Exception $e) {
+				// If we fail to get the owner of the view from the cache,
+				// e.g. because the user never logged in but a cron job runs
+				// We fallback to calculating the owner from the root of the view:
+				if (substr_count($view->getRoot(), '/') >= 2) {
+					// /37c09aa0-1b92-4cf6-8c66-86d8cac8c1d0/files
+					[, $userId, ] = explode('/', $view->getRoot(), 3);
+				} else {
+					// Something weird is going on, we can't fallback more
+					// so for now we don't overwrite the share path ¯\_(ツ)_/¯
+					return;
+				}
+			}
+
+			$parent = $this->getAttachmentFolder();
+			$event->setParent($parent);
+			if (!$event->getView()->is_dir($parent)) {
+				$event->getView()->mkdir($parent);
+			}
+		}
+	}
+
+	private function getAttachmentFolder() {
+		return \OC::$server->getConfig()->getUserValue($this->userId, 'deck', 'attachment_folder', '/Deck');
+	}
+}

lib/Sharing/ShareAPIHelper.php

@@ -0,0 +1,112 @@
+<?php
+/*
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Deck\Sharing;
+
+
+use OCA\Deck\Db\CardMapper;
+use OCP\IURLGenerator;
+use OCP\Share\IShare;
+
+class ShareAPIHelper {
+
+	private $urlGenerator;
+	private $cardMapper;
+
+	public function __construct(IURLGenerator $urlGenerator, CardMapper $cardMapper) {
+		$this->urlGenerator = $urlGenerator;
+		$this->cardMapper = $cardMapper;
+	}
+
+	public function formatShare(IShare $share): array {
+		$result = [];
+		$card = $this->cardMapper->find($share->getSharedWith());
+		$boardId = $this->cardMapper->findBoardId($card->getId());
+		$result['share_with'] = $share->getSharedWith();
+		$result['share_with_displayname'] = $card->getTitle();
+		$result['share_with_link'] = $this->urlGenerator->linkToRouteAbsolute('deck.page.index') . '#/board/' . $boardId . '/card/' . $card->getId();
+		return $result;
+	}
+
+	public function createShare(IShare $share, string $shareWith, int $permissions, $expireDate) {
+		$share->setSharedWith($shareWith);
+		$share->setPermissions($permissions);
+
+		if ($expireDate !== '') {
+			try {
+				$expireDate = $this->parseDate($expireDate);
+				$share->setExpirationDate($expireDate);
+			} catch (\Exception $e) {
+				throw new OCSNotFoundException($this->l->t('Invalid date, date format must be YYYY-MM-DD'));
+			}
+		}
+	}
+
+	/**
+	 * Make sure that the passed date is valid ISO 8601
+	 * So YYYY-MM-DD
+	 * If not throw an exception
+	 *
+	 * Copied from \OCA\Files_Sharing\Controller\ShareAPIController::parseDate.
+	 *
+	 * @param string $expireDate
+	 * @return \DateTime
+	 * @throws \Exception
+	 */
+	private function parseDate(string $expireDate): \DateTime {
+		try {
+			$date = $this->timeFactory->getDateTime($expireDate);
+		} catch (\Exception $e) {
+			throw new \Exception('Invalid date. Format must be YYYY-MM-DD');
+		}
+
+		if ($date === false) {
+			throw new \Exception('Invalid date. Format must be YYYY-MM-DD');
+		}
+
+		$date->setTime(0, 0, 0);
+
+		return $date;
+	}
+
+	/**
+	 * Returns whether the given user can access the given room share or not.
+	 *
+	 * A user can access a room share only if she is a participant of the room.
+	 *
+	 * @param IShare $share
+	 * @param string $user
+	 * @return bool
+	 */
+	public function canAccessShare(IShare $share, string $user): bool {
+		try {
+			$this->permissionService->checkPermission($this->cardMapper, $share->getSharedWith(), Acl::PERMISSION_READ, $user);
+		} catch (NoPermissionException $e) {
+			return false;
+		}
+		return true;
+	}
+}