Fix open locally with files lock and wopi allow list (backport stable26)

appinfo/routes.php

@@ -72,6 +72,7 @@
 	'ocs' => [
 		// Public pages: new file creation
 		['name' => 'documentAPI#create', 'url' => '/api/v1/file', 'verb' => 'POST'],
+		['name' => 'documentAPI#openLocal', 'url' => '/api/v1/local', 'verb' => 'POST'],
 
 		// Client API endpoints
 		['name' => 'OCS#createDirect', 'url' => '/api/v1/document', 'verb' => 'POST'],

lib/Controller/DocumentAPIController.php

@@ -30,11 +30,17 @@
 use OCA\Richdocuments\Helper;
 use OCA\Richdocuments\TemplateManager;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\JSONResponse;
 use OCP\Files\Folder;
 use OCP\Files\IRootFolder;
+use OCP\Files\Lock\ILock;
+use OCP\Files\Lock\ILockManager;
+use OCP\Files\Lock\LockContext;
+use OCP\Files\Lock\NoLockProviderException;
 use OCP\IL10N;
 use OCP\IRequest;
+use OCP\PreConditionNotMetException;
 use OCP\Share\IManager;
 use Psr\Log\LoggerInterface;
 use Throwable;
@@ -45,15 +51,17 @@ class DocumentAPIController extends \OCP\AppFramework\OCSController {
 	private $templateManager;
 	private $l10n;
 	private $logger;
+	private $lockManager;
 	private $userId;
 
-	public function __construct(IRequest $request, IRootFolder $rootFolder, IManager $shareManager, TemplateManager $templateManager, IL10N $l10n, LoggerInterface $logger, $userId) {
+	public function __construct(IRequest $request, IRootFolder $rootFolder, IManager $shareManager, TemplateManager $templateManager, IL10N $l10n, LoggerInterface $logger, ILockManager $lockManager, $userId) {
 		parent::__construct(Application::APPNAME, $request);
 		$this->rootFolder = $rootFolder;
 		$this->shareManager = $shareManager;
 		$this->templateManager = $templateManager;
 		$this->l10n = $l10n;
 		$this->logger = $logger;
+		$this->lockManager = $lockManager;
 		$this->userId = $userId;
 	}
 
@@ -147,4 +155,24 @@ public function create(string $mimeType, string $fileName, string $directoryPath
 			'data' => \OCA\Files\Helper::formatFileInfo($file->getFileInfo())
 		]);
 	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function openLocal(int $fileId): DataResponse {
+		try {
+			$files = $this->rootFolder->getUserFolder($this->userId)->getById($fileId);
+			$file = array_shift($files);
+			$this->lockManager->unlock(new LockContext(
+				$file,
+				ILock::TYPE_APP,
+				Application::APPNAME
+			));
+			return new DataResponse([]);
+		} catch (NoLockProviderException|PreConditionNotMetException $e) {
+			return new DataResponse([], Http::STATUS_BAD_REQUEST);
+		} catch (\Exception $e) {
+			return new DataResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
+		}
+	}
 }

lib/Service/InitialStateService.php

@@ -87,6 +87,7 @@ public function provideDocument(Wopi $wopi, array $params): void {
 		$this->initialState->provideInitialState('theming-customLogo', ($logoSet ?
 			\OC::$server->getURLGenerator()->getAbsoluteURL(\OC::$server->getThemingDefaults()->getLogo())
 			: false));
+		$this->initialState->provideInitialState('open_local_editor', $this->config->getAppValue(Application::APPNAME, 'open_local_editor', 'yes') === 'yes');
 	}
 
 	public function prepareParams(array $params): array {

src/document.js

@@ -35,7 +35,7 @@
 const checkProxyStatus = () => {
 	checkingProxyStatus = true
 	const url = Config.get('urlsrc').slice(0, Config.get('urlsrc').indexOf('proxy.php') + 'proxy.php'.length)
 	$.get(url + '?status').done(function(val) {
 		if (val && val.status && val.status !== 'OK') {
 			if (val.status === 'starting' || val.status === 'stopped') {
 				document.getElementById('proxyLoadingIcon').classList.add('icon-loading-small')
@@ -326,7 +326,7 @@
 							PostMessages.sendWOPIPostMessage('loolframe', 'Hide_Menu_Item', { id: 'insertgraphicremote' })
 						}
 
-						if (Config.get('userId') !== null && !Config.get('isPublicShare')) {
+						if (Config.get('userId') !== null && !Config.get('isPublicShare') && loadState('richdocuments', 'open_local_editor', true)) {
 							PostMessages.sendWOPIPostMessage('loolframe', 'Insert_Button', {
 								id: 'Open_Local_Editor',
 								imgurl: window.location.protocol + '//' + getNextcloudUrl() + imagePath('richdocuments', 'launch.svg'),
@@ -481,11 +481,13 @@
 						break
 					case 'Get_Views_Resp':
 						if (documentsMain.openingLocally) {
-							documentsMain.UI.removeViews(parsed.args)
 							documentsMain.unlockFile()
 								.catch(_ => {}) // Unlocking failed, possibly because file was not locked, we want to proceed regardless.
 								.then(() => {
-									documentsMain.openLocally()
+									documentsMain.openLocally().then(() => {
+										documentsMain.UI.removeViews(parsed.args)
+										documentsMain.close()
+									})
 								})
 						}
 						break
@@ -591,29 +593,24 @@
 	},
 
 	unlockFile() {
-		const unlockUrl = getRootUrl() + '/index.php/apps/richdocuments/wopi/files/' + documentsMain.fileId
-		const unlockConfig = {
-			headers: { 'X-WOPI-Override': 'UNLOCK' },
-		}
-		return axios.post(unlockUrl, { access_token: documentsMain.token }, unlockConfig)
+		return axios.post(generateOcsUrl('apps/richdocuments/api/v1/local'), { fileId: this.fileId })
 	},
 
-	openLocally() {
+	async openLocally() {
 		if (documentsMain.openingLocally) {
 			documentsMain.openingLocally = false
 
-			axios.post(
+			const result = await axios.post(
 				OC.linkToOCS('apps/files/api/v1', 2) + 'openlocaleditor?format=json',
 				{ path: documentsMain.fullPath }
-			).then((result) => {
-				const url = 'nc://open/'
-					+ Config.get('userId') + '@' + getNextcloudUrl()
-					+ OC.encodePath(documentsMain.fullPath)
-					+ '?token=' + result.data.ocs.data.token
-
-				this.showOpenLocalConfirmation(url, window.top)
-				window.location.href = url
-			})
+			)
+			const url = 'nc://open/'
+				+ Config.get('userId') + '@' + getNextcloudUrl()
+				+ OC.encodePath(documentsMain.fullPath)
+				+ '?token=' + result.data.ocs.data.token
+
+			this.showOpenLocalConfirmation(url, window.top)
+			window.open(url)
 		}
 	},