-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17625 from nextcloud/enh/noid/direct-editing
Direct editing API to allow file editing using a one-time token
- Loading branch information
Showing
25 changed files
with
1,489 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
apps/files/lib/BackgroundJob/CleanupDirectEditingTokens.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <?php | ||
|
|
||
| namespace OCA\Files\BackgroundJob; | ||
|
|
||
| use OC\BackgroundJob\TimedJob; | ||
| use OCP\DirectEditing\IManager; | ||
|
|
||
| class CleanupDirectEditingTokens extends TimedJob { | ||
|
|
||
| private const INTERVAL_MINUTES = 15 * 60; | ||
|
|
||
| /** | ||
| * @var IManager | ||
| */ | ||
| private $manager; | ||
|
|
||
| public function __construct(IManager $manager) { | ||
| $this->interval = self::INTERVAL_MINUTES; | ||
| $this->manager = $manager; | ||
| } | ||
|
|
||
| /** | ||
| * Makes the background job do its work | ||
| * | ||
| * @param array $argument unused argument | ||
| * @throws \Exception | ||
| */ | ||
| public function run($argument) { | ||
| $this->manager->cleanup(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| <?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 OCA\Files\Service\DirectEditingService; | ||
| 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; | ||
|
|
||
| /** @var DirectEditingService */ | ||
| private $directEditingService; | ||
|
|
||
| public function __construct($appName, IRequest $request, $corsMethods, $corsAllowedHeaders, $corsMaxAge, | ||
| IEventDispatcher $eventDispatcher, IURLGenerator $urlGenerator, IManager $manager, DirectEditingService $directEditingService, ILogger $logger) { | ||
| parent::__construct($appName, $request, $corsMethods, $corsAllowedHeaders, $corsMaxAge); | ||
|
|
||
| $this->eventDispatcher = $eventDispatcher; | ||
| $this->directEditingManager = $manager; | ||
| $this->directEditingService = $directEditingService; | ||
| $this->logger = $logger; | ||
| $this->urlGenerator = $urlGenerator; | ||
| } | ||
|
|
||
| /** | ||
| * @NoAdminRequired | ||
| */ | ||
| public function info(): DataResponse { | ||
| $response = new DataResponse($this->directEditingService->getDirectEditingCapabilitites()); | ||
| $response->setETag($this->directEditingService->getDirectEditingETag()); | ||
| return $response; | ||
| } | ||
|
|
||
| /** | ||
| * @NoAdminRequired | ||
| */ | ||
| public function create(string $path, string $editorId, string $creatorId, string $templateId = null): DataResponse { | ||
| $this->eventDispatcher->dispatchTyped(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->dispatchTyped(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->dispatchTyped(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); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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(); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.