Direct editing API to allow file editing using a one-time token for

mobile apps

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

2 files changed, 228 insertions, 0 deletions

diff --git a/apps/files/lib/Controller/DirectEditingController.php b/apps/files/lib/Controller/DirectEditingController.php
new file mode 100644
index 00000000000..cf948d20f76
--- /dev/null
+++ b/apps/files/lib/Controller/DirectEditingController.php
@@ -0,0 +1,156 @@
+<?php
+/**
+ * @copyright Copyright (c) 2019 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/>.
+ *
+ */
+
+namespace OCA\Files\Controller;
+
+
+use Exception;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\OCSController;
+use OCP\DirectEditing\ACreateEmpty;
+use OCP\DirectEditing\ACreateFromTemplate;
+use OCP\DirectEditing\IEditor;
+use OCP\DirectEditing\IManager;
+use OCP\DirectEditing\RegisterDirectEditorEvent;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\ILogger;
+use OCP\IRequest;
+use OCP\IURLGenerator;
+
+class DirectEditingController extends OCSController {
+
+	/** @var IEventDispatcher */
+	private $eventDispatcher;
+
+	/** @var IManager */
+	private $directEditingManager;
+
+	/** @var IURLGenerator */
+	private $urlGenerator;
+
+	/** @var ILogger */
+	private $logger;
+
+	public function __construct($appName, IRequest $request, $corsMethods, $corsAllowedHeaders, $corsMaxAge,
+								IEventDispatcher $eventDispatcher, IURLGenerator $urlGenerator, IManager $manager, ILogger $logger) {
+		parent::__construct($appName, $request, $corsMethods, $corsAllowedHeaders, $corsMaxAge);
+
+		$this->eventDispatcher = $eventDispatcher;
+		$this->directEditingManager = $manager;
+		$this->logger = $logger;
+		$this->urlGenerator = $urlGenerator;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @return DataResponse
+	 */
+	public function get(): DataResponse {
+		$this->eventDispatcher->dispatch(RegisterDirectEditorEvent::class, new RegisterDirectEditorEvent($this->directEditingManager));
+
+		$capabilities = [
+			'editors' => [],
+			'creators' => []
+		];
+
+		/**
+		 * @var string $id
+		 * @var IEditor $editor
+		 */
+		foreach ($this->directEditingManager->getEditors() as $id => $editor) {
+			$capabilities['editors'][$id] = [
+				'name' => $editor->getName(),
+				'mimetypes' => $editor->getMimetypes(),
+				'optionalMimetypes' => $editor->getMimetypesOptional(),
+				'secure' => $editor->isSecure(),
+			];
+			/** @var ACreateEmpty|ACreateFromTemplate $creator */
+			foreach ($editor->getCreators() as $creator) {
+				$id = $creator->getId();
+				$capabilities['creators'][$id] = [
+					'id' => $id,
+					'name' => $creator->getName(),
+					'extension' => $creator->getExtension(),
+					'templates' => false
+				];
+				if ($creator instanceof ACreateFromTemplate) {
+					$capabilities['creators'][$id]['templates'] = true;
+				}
+
+			}
+		}
+		return new DataResponse($capabilities);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function create(string $path, string $editorId, string $creatorId, string $templateId = null): DataResponse {
+		$this->eventDispatcher->dispatch(RegisterDirectEditorEvent::class, new RegisterDirectEditorEvent($this->directEditingManager));
+
+		try {
+			$token = $this->directEditingManager->create($path, $editorId, $creatorId, $templateId);
+			return new DataResponse([
+				'url' => $this->urlGenerator->linkToRouteAbsolute('files.DirectEditingView.edit', ['token' => $token])
+			]);
+		} catch (Exception $e) {
+			$this->logger->logException($e, ['message' => 'Exception when creating a new file through direct editing']);
+			return new DataResponse('Failed to create file', Http::STATUS_FORBIDDEN);
+		}
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function open(int $fileId, string $editorId = null): DataResponse {
+		$this->eventDispatcher->dispatch(RegisterDirectEditorEvent::class, new RegisterDirectEditorEvent($this->directEditingManager));
+
+		try {
+			$token = $this->directEditingManager->open($fileId, $editorId);
+			return new DataResponse([
+				'url' => $this->urlGenerator->linkToRouteAbsolute('files.DirectEditingView.edit', ['token' => $token])
+			]);
+		} catch (Exception $e) {
+			$this->logger->logException($e, ['message' => 'Exception when opening a file through direct editing']);
+			return new DataResponse('Failed to open file', Http::STATUS_FORBIDDEN);
+		}
+	}
+
+
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function templates(string $editorId, string $creatorId): DataResponse {
+		$this->eventDispatcher->dispatch(RegisterDirectEditorEvent::class, new RegisterDirectEditorEvent($this->directEditingManager));
+
+		try {
+			return new DataResponse($this->directEditingManager->getTemplates($editorId, $creatorId));
+		} catch (Exception $e) {
+			$this->logger->logException($e);
+			return new DataResponse('Failed to open file', Http::STATUS_INTERNAL_SERVER_ERROR);
+		}
+	}
+}
diff --git a/apps/files/lib/Controller/DirectEditingViewController.php b/apps/files/lib/Controller/DirectEditingViewController.php
new file mode 100644
index 00000000000..9fbce4ece12
--- /dev/null
+++ b/apps/files/lib/Controller/DirectEditingViewController.php
@@ -0,0 +1,72 @@
+<?php
+/**
+ * @copyright Copyright (c) 2019 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/>.
+ *
+ */
+
+namespace OCA\Files\Controller;
+
+
+use Exception;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http\NotFoundResponse;
+use OCP\AppFramework\Http\Response;
+use OCP\DirectEditing\IManager;
+use OCP\DirectEditing\RegisterDirectEditorEvent;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\ILogger;
+use OCP\IRequest;
+
+class DirectEditingViewController extends Controller {
+
+	/** @var IEventDispatcher */
+	private $eventDispatcher;
+
+	/** @var IManager */
+	private $directEditingManager;
+
+	/** @var ILogger */
+	private $logger;
+
+	public function __construct($appName, IRequest $request, IEventDispatcher $eventDispatcher, IManager $manager, ILogger $logger) {
+		parent::__construct($appName, $request);
+
+		$this->eventDispatcher = $eventDispatcher;
+		$this->directEditingManager = $manager;
+		$this->logger = $logger;
+	}
+
+	/**
+	 * @PublicPage
+	 * @NoCSRFRequired
+	 *
+	 * @param string $token
+	 * @return Response
+	 */
+	public function edit(string $token): Response {
+		$this->eventDispatcher->dispatchTyped(new RegisterDirectEditorEvent($this->directEditingManager));
+		try {
+			return $this->directEditingManager->edit($token);
+		} catch (Exception $e) {
+			$this->logger->logException($e);
+			return new NotFoundResponse();
+		}
+	}
+}