manual update for missing files

Signed-off-by: samin-z <samin.zavarkesh@gmail.com>

Author: samin-z

lib/Service/ApiService.php

@@ -188,9 +188,11 @@ public function push(Session $session, Document $document, int $version, array $
 			$this->addToPushQueue($document, [$awareness, ...array_values($steps)]);
 		} catch (InvalidArgumentException $e) {
 			return new DataResponse(['error' => $e->getMessage()], Http::STATUS_UNPROCESSABLE_ENTITY);
-		} catch (DoesNotExistException|NotPermittedException) {
+		} catch (DoesNotExistException) {
 			// Either no write access or session was removed in the meantime (#3875).
 			return new DataResponse(['error' => $this->l10n->t('Editing session has expired. Please reload the page.')], Http::STATUS_PRECONDITION_FAILED);
+		} catch (NotPermittedException) {
+			return new DataResponse(['error' => $this->l10n->t('This document is read-only.')], Http::STATUS_FORBIDDEN);
 		}
 		return new DataResponse($result);
 	}
@@ -228,6 +230,7 @@ public function sync(Session $session, Document $document, int $version = 0, ?st
 
 			// ensure file is still present and accessible
 			$file = $this->documentService->getFileForSession($session, $shareToken);
+			$result['readOnly'] = $this->documentService->isReadOnly($file, $shareToken);
 			$this->documentService->assertNoOutsideConflict($document, $file);
 		} catch (NotPermittedException|NotFoundException|InvalidPathException $e) {
 			$this->logger->info($e->getMessage(), ['exception' => $e]);
@@ -275,6 +278,10 @@ public function save(Session $session, Document $document, int $version = 0, ?st
 			} catch (LockedException) {
 				// Ignore locked exception since it might happen due to an autosave action happening at the same time
 			}
+		} catch (NotPermittedException) {
+			return new DataResponse([
+				'error' => $this->l10n->t('Read-only permission cannot save document changes. Please reload the page.')
+			], Http::STATUS_FORBIDDEN);
 		} catch (NotFoundException) {
 			return new DataResponse([], Http::STATUS_NOT_FOUND);
 		} catch (Exception $e) {

lib/Service/DocumentService.php

@@ -207,7 +207,8 @@ public function writeDocumentState(int $documentId, string $content): void {
 	 */
 	public function addStep(Document $document, Session $session, array $steps, int $version, ?int $recoveryAttempt, ?string $shareToken): array {
 		$documentId = $session->getDocumentId();
-		$readOnly = $this->isReadOnlyCached($session, $shareToken);
+		$file = $this->getFileForSession($session, $shareToken);
+		$readOnly = $this->isReadOnly($file, $shareToken);
 		$stepsToInsert = [];
 		$stepsIncludeQuery = false;
 		$documentState = null;
@@ -372,7 +373,7 @@ public function autosave(Document $document, ?File $file, int $version, ?string
 		}
 
 		if ($this->isReadOnly($file, $shareToken)) {
-			return $document;
+			throw new NotPermittedException('Read-only permission cannot save document changes. Please reload the page.');
 		}
 
 		$this->assertNoOutsideConflict($document, $file, $force);
@@ -590,30 +591,14 @@ public function getFileByShareToken(string $shareToken, ?string $path = null): F
 		}
 		throw new \InvalidArgumentException('No proper share data');
 	}
-
-	public function isReadOnlyCached(Session $session, ?string $shareToken = null): bool {
-		$cacheKey = 'read-only-' . $session->getId();
-		$isReadOnly = $this->cache->get($cacheKey);
-		if ($isReadOnly === null) {
-			$file = $this->getFileForSession($session, $shareToken);
-			$isReadOnly = $this->isReadOnly($file, $shareToken);
-			$this->cache->set($cacheKey, $isReadOnly, 60 * 5);
-			return $isReadOnly;
-		}
-
-		return $isReadOnly;
-	}
-
 	public function isReadOnly(File $file, ?string $token): bool {
-		$readOnly = true;
+		$readOnly = !$file->isUpdateable();
 		if ($token !== null) {
 			try {
 				$this->checkSharePermissions($token, Constants::PERMISSION_UPDATE);
-				$readOnly = false;
 			} catch (NotFoundException $e) {
+				$readOnly = true;
 			}
-		} else {
-			$readOnly = !$file->isUpdateable();
 		}
 
 		$lockInfo = $this->getLockInfo($file);

src/components/Editor.vue

@@ -74,6 +74,7 @@
 <script>
 import Vue, { ref, set, watch } from 'vue'
 import { getCurrentUser } from '@nextcloud/auth'
+import { showWarning } from '@nextcloud/dialogs'
 import { loadState } from '@nextcloud/initial-state'
 import { isPublicShare } from '@nextcloud/sharing/public'
 import { emit, subscribe, unsubscribe } from '@nextcloud/event-bus'
@@ -471,6 +472,7 @@ export default {
 			bus.on('stateChange', this.onStateChange)
 			bus.on('idle', this.onIdle)
 			bus.on('save', this.onSave)
+			bus.on('permissionChange', this.onPermissionChange)
 		},
 
 		unlistenSyncServiceEvents() {
@@ -483,6 +485,7 @@ export default {
 			bus.off('stateChange', this.onStateChange)
 			bus.off('idle', this.onIdle)
 			bus.off('save', this.onSave)
+			bus.off('permissionChange', this.onPermissionChange)
 		},
 
 		reconnect() {
@@ -669,7 +672,17 @@ export default {
 			}
 
 			if (type === ERROR_TYPE.PUSH_FORBIDDEN) {
-				this.hasConnectionIssue = true
+				this.readOnly = true
+				this.editMode = false
+				if (this.$editor) {
+					this.$editor.setEditable(this.editMode)
+				}
+				showWarning(
+					t(
+						'text',
+						'Your editing permissions have been revoked. The document is now read-only.',
+					),
+				)
 				this.emit('push:forbidden')
 				return
 			}
@@ -722,6 +735,26 @@ export default {
 			})
 		},
 
+		onPermissionChange({ readOnly }) {
+			this.readOnly = readOnly
+			this.editMode = !readOnly && !this.openReadOnlyEnabled
+			if (this.$editor) {
+				this.$editor.setEditable(this.editMode)
+			}
+			if (readOnly) {
+				showWarning(
+					t(
+						'text',
+						'Your editing permissions have been revoked. The document is now read-only.',
+					),
+				)
+			} else {
+				showWarning(
+					t('text', 'You now have edit permissions for this document.'),
+				)
+			}
+		},
+
 		onFocus() {
 			this.emit('focus')
 		},

src/services/PollingBackend.js

@@ -29,10 +29,11 @@ const FETCH_INTERVAL_MAX = 5000
 const FETCH_INTERVAL_SINGLE_EDITOR = 5000
 
 /**
- * Interval to check for changes for read only users
+ * Interval to check for permission changes while read-only.
+ * Step updates are rare here; keep polling fast so edit permission can be restored.
  * @type {number}
  */
-const FETCH_INTERVAL_READ_ONLY = 30000
+const FETCH_INTERVAL_READ_ONLY = 5000
 
 /**
  * Interval to fetch for changes when a browser window is considered invisible by the
@@ -42,8 +43,6 @@ const FETCH_INTERVAL_READ_ONLY = 30000
  */
 const FETCH_INTERVAL_INVISIBLE = 20000
 
-const FETCH_INTERVAL_NOTIFY = 30000
-
 /* Maximum number of retries for fetching before emitting a connection error */
 const MAX_RETRY_FETCH_COUNT = 5
 
@@ -59,6 +58,8 @@ class PollingBackend {
 	#syncService
 	/** @type {Connection} */
 	#connection
+	/** @type {boolean} */
+	#readOnly = false
 
 	#lastPoll
 	#fetchInterval
@@ -73,6 +74,7 @@ class PollingBackend {
 		this.#fetchInterval = FETCH_INTERVAL
 		this.#fetchRetryCounter = 0
 		this.#lastPoll = 0
+		this.#readOnly = connection.state?.document?.readOnly ?? false
 	}
 
 	connect() {
@@ -126,6 +128,18 @@ class PollingBackend {
 		const { document, sessions } = data
 		this.#fetchRetryCounter = 0
 
+		if (data.readOnly !== undefined && data.readOnly !== this.#readOnly) {
+			this.#readOnly = data.readOnly
+			this.#syncService.bus.emit('permissionChange', {
+				readOnly: this.#readOnly,
+			})
+			if (data.readOnly) {
+				this.maximumReadOnlyTimer()
+			} else {
+				this.resetRefetchTimer()
+			}
+		}
+
 		this.#syncService.bus.emit('change', { document, sessions })
 		this.#syncService.receiveSteps(data)
 
@@ -138,7 +152,7 @@ class PollingBackend {
 			}
 			const disconnect = Date.now() - COLLABORATOR_DISCONNECT_TIME
 			const alive = sessions.filter((s) => s.lastContact * 1000 > disconnect)
-			if (this.#syncService.isReadOnly) {
+			if (this.#readOnly) {
 				this.maximumReadOnlyTimer()
 			} else if (alive.length < 2) {
 				this.maximumRefetchTimer()
@@ -197,25 +211,30 @@ class PollingBackend {
 		document.removeEventListener('visibilitychange', this.visibilitychange.bind(this))
 	}
 
+	#notifyPushInterval() {
+		// notify_push delivers step updates but not permission changes
+		return FETCH_INTERVAL_SINGLE_EDITOR
+	}
+
 	resetRefetchTimer() {
 		if (this.#notifyPushBus && this.#initialLoadingFinished) {
-			this.#fetchInterval = FETCH_INTERVAL_NOTIFY
+			this.#fetchInterval = this.#notifyPushInterval()
 			return
 		}
 		this.#fetchInterval = FETCH_INTERVAL
 	}
 
 	increaseRefetchTimer() {
 		if (this.#notifyPushBus && this.#initialLoadingFinished) {
-			this.#fetchInterval = FETCH_INTERVAL_NOTIFY
+			this.#fetchInterval = this.#notifyPushInterval()
 			return
 		}
 		this.#fetchInterval = Math.min(this.#fetchInterval * 2, FETCH_INTERVAL_MAX)
 	}
 
 	maximumRefetchTimer() {
 		if (this.#notifyPushBus && this.#initialLoadingFinished) {
-			this.#fetchInterval = FETCH_INTERVAL_NOTIFY
+			this.#fetchInterval = this.#notifyPushInterval()
 			return
 		}
 		this.#fetchInterval = FETCH_INTERVAL_SINGLE_EDITOR

src/services/SyncService.ts

@@ -5,6 +5,7 @@
 
 /* eslint-disable jsdoc/valid-types */
 
+import { showError } from '@nextcloud/dialogs'
 import mitt from 'mitt'
 import debounce from 'debounce'
 
@@ -116,6 +117,9 @@ export declare type EventTypes = {
 	/* Emitted once a document becomes idle */
 	idle: void
 
+	/* Emitted if the read only state of the document has changed */
+	permissionChange: { readOnly: boolean }
+
 }
 
 class SyncService {
@@ -374,6 +378,19 @@ class SyncService {
 			this.autosave.clear()
 		} catch (e) {
 			logger.error('Failed to save document.', { error: e })
+			const response = (
+				e as { response?: { status?: number; data?: { error?: string } } }
+			).response
+			if (response?.status === 403) {
+				// Document is now read-only; permissionChange from sync will update the UI
+				return
+			}
+			if (response?.status === 412) {
+				this.bus.emit('error', { type: ERROR_TYPE.LOAD_ERROR, data: response })
+				if (response.data?.error) {
+					showError(response.data.error)
+				}
+			}
 			throw e
 		}
 	}