@fiduswriter/editor 0.1.75 → 0.1.76

package/src/documents/access_rights/request_access_dialog.ts

@@ -0,0 +1,151 @@
+import {Dialog, addAlert} from "fwtoolkit"
+
+import type {EditorDocumentApi} from "../../types.js"
+
+interface RequestableRight {
+    value: string
+    label: string
+}
+
+const REQUESTABLE_RIGHTS: RequestableRight[] = [
+    {value: "read", label: gettext("Read")},
+    {value: "comment", label: gettext("Comment")},
+    {value: "review", label: gettext("Review")},
+    {value: "write-tracked", label: gettext("Write tracked")},
+    {value: "write", label: gettext("Write")}
+]
+
+const RIGHT_ORDER = REQUESTABLE_RIGHTS.map(right => right.value)
+
+/**
+ * Dialog for requesting access to a document.
+ *
+ * For users who already have some access, only rights that are higher than
+ * the current level are offered. Token users and users without any known
+ * access can choose from all requestable rights.
+ */
+export class RequestAccessDialog {
+    documentId: number
+    currentRights: string
+    documentApi: EditorDocumentApi
+    isTokenUser: boolean
+
+    constructor(
+        documentId: number,
+        currentRights = "",
+        documentApi: EditorDocumentApi,
+        isTokenUser = false
+    ) {
+        this.documentId = documentId
+        this.currentRights = currentRights
+        this.documentApi = documentApi
+        this.isTokenUser = isTokenUser
+    }
+
+    open(): void {
+        const rightsOptions = this.getRightsOptions()
+        if (!rightsOptions.length) {
+            addAlert(
+                "error",
+                gettext("You already have the highest possible access level.")
+            )
+            return
+        }
+        const defaultRights =
+            rightsOptions.find(right => right.value === "write")?.value ||
+            rightsOptions[rightsOptions.length - 1].value
+        const bodyText = this.currentRights
+            ? gettext(
+                  "Select a higher access level to request from the document owner."
+              )
+            : gettext(
+                  "You do not have access to this document. Select the access level you would like to request from the document owner."
+              )
+        const dialog = new Dialog({
+            title: gettext("Request Access"),
+            id: "request-access-dialog",
+            width: 500,
+            body: `<p>${bodyText}</p>
+            <table class="fw-dialog-table">
+                <tbody>
+                    <tr>
+                        <th><label for="request-access-rights">${gettext(
+                            "Access level"
+                        )}</label></th>
+                        <td class="entry-field">
+                            <select id="request-access-rights" class="fw-button fw-light fw-large">
+                                ${rightsOptions
+                                    .map(
+                                        right =>
+                                            `<option value="${right.value}"${right.value === defaultRights ? " selected" : ""}>${right.label}</option>`
+                                    )
+                                    .join("")}
+                            </select>
+                            <div class="fw-select-arrow fa-solid fa-caret-down"></div>
+                        </td>
+                    </tr>
+                </tbody>
+            </table>`,
+            buttons: [
+                {
+                    text: gettext("Request"),
+                    classes: "fw-dark",
+                    click: () => {
+                        const rights = (
+                            dialog.dialogEl.querySelector(
+                                "#request-access-rights"
+                            ) as HTMLSelectElement
+                        ).value
+                        this.documentApi
+                            .requestAccess({
+                                document_id: this.documentId,
+                                rights
+                            })
+                            .then(({json}: {json: unknown}) => {
+                                const data = json as {
+                                    success?: boolean
+                                    error?: string
+                                }
+                                if (data.success) {
+                                    addAlert(
+                                        "success",
+                                        gettext(
+                                            "Your access request has been sent to the document owner."
+                                        )
+                                    )
+                                    dialog.close()
+                                } else {
+                                    addAlert(
+                                        "error",
+                                        data.error ||
+                                            gettext(
+                                                "Could not send access request."
+                                            )
+                                    )
+                                }
+                            })
+                            .catch(() => {
+                                addAlert(
+                                    "error",
+                                    gettext("Could not send access request.")
+                                )
+                            })
+                    }
+                },
+                {type: "cancel"}
+            ]
+        })
+        dialog.open()
+    }
+
+    getRightsOptions(): RequestableRight[] {
+        if (this.isTokenUser || !this.currentRights) {
+            return REQUESTABLE_RIGHTS
+        }
+        const currentIndex = RIGHT_ORDER.indexOf(this.currentRights)
+        if (currentIndex < 0) {
+            return REQUESTABLE_RIGHTS
+        }
+        return REQUESTABLE_RIGHTS.filter((_, index) => index > currentIndex)
+    }
+}

package/src/index.ts

@@ -41,6 +41,7 @@ import {ModCollab} from "./collab/index.js"
 import {ModComments} from "./comments/index.js"
 import {ModDB} from "./databases/index.js"
 import {ModDocumentTemplate} from "./document_template/index.js"
+import {RequestAccessDialog} from "./documents/access_rights/request_access_dialog.js"
 import {E2EESnapshotManager} from "./e2ee/snapshot-manager.js"
 import {ExportFidusFile} from "./exporter/native/file.js"
 import {ModFootnotes} from "./footnotes/index.js"
@@ -374,47 +375,68 @@ export class Editor {
                               token: this.docInfo.token
                           })
                     : Promise.resolve({json: {ws_base: ""}})
-                const stylesPromise = documentApi.getDocumentStyles(
-                    stylesPayload as {id: number; token?: string}
-                )
-                const docDataPromise = documentApi.getDocumentData(
-                    stylesPayload as {id: number; token?: string}
-                )
+                const stylesPromise = documentApi
+                    .getDocumentStyles(
+                        stylesPayload as {id: number; token?: string}
+                    )
+                    .catch(() => {
+                        return {json: {}}
+                    })
+                const docDataPromise = documentApi
+                    .getDocumentData(
+                        stylesPayload as {id: number; token?: string}
+                    )
+                    .catch(error => {
+                        // Only show "Invalid Share Link" for token validation errors.
+                        // For authenticated users without access, offer to request access.
+                        // This is also shown when the document does not exist so that we
+                        // do not reveal whether a document with the given ID exists.
+                        if (error.message === "Invalid or expired share link") {
+                            deactivateWait()
+                            const errorDialog = new Dialog({
+                                title: gettext("Invalid Share Link"),
+                                id: "invalid_share_link_dialog",
+                                body: gettext(
+                                    "This share link has expired or is invalid. Please ask the document owner for a new link."
+                                ),
+                                buttons: [
+                                    {
+                                        text: gettext("OK"),
+                                        classes: "fw-dark",
+                                        click: () => {
+                                            window.location.href = "/"
+                                        }
+                                    }
+                                ],
+                                canClose: false
+                            })
+                            errorDialog.open()
+                            return Promise.reject(false)
+                        } else if (
+                            error.status === 401 &&
+                            this.user.is_authenticated
+                        ) {
+                            deactivateWait()
+                            const requestAccessDialog = new RequestAccessDialog(
+                                this.docInfo.id as number,
+                                "",
+                                documentApi,
+                                Boolean(this.docInfo.token)
+                            )
+                            requestAccessDialog.open()
+                            return Promise.reject(false)
+                        } else {
+                            deactivateWait()
+                            console.error("Editor initialization failed:", error)
+                        }
+                        return Promise.reject(error)
+                    })
                 return Promise.all([
                     wsBasePromise,
                     stylesPromise,
                     docDataPromise
                 ])
             })
-            .catch(error => {
-                // Only show "Invalid Share Link" for token validation errors.
-                // Other errors (REST failures, etc.) should not show this dialog.
-                if (error.message === "Invalid or expired share link") {
-                    deactivateWait()
-                    const errorDialog = new Dialog({
-                        title: gettext("Invalid Share Link"),
-                        id: "invalid_share_link_dialog",
-                        body: gettext(
-                            "This share link has expired or is invalid. Please ask the document owner for a new link."
-                        ),
-                        buttons: [
-                            {
-                                text: gettext("OK"),
-                                classes: "fw-dark",
-                                click: () => {
-                                    window.location.href = "/"
-                                }
-                            }
-                        ],
-                        canClose: false
-                    })
-                    errorDialog.open()
-                } else {
-                    deactivateWait()
-                    console.error("Editor initialization failed:", error)
-                }
-                return Promise.reject(error)
-            })
             .then(([wsResult, stylesResult, docResult]) => {
                 let resubScribed = false
                 this.render()

package/src/menus/headerbar/model.ts

@@ -7,6 +7,7 @@ import {
 import type {BibDB, ExportDoc, ImageDB} from "@fiduswriter/document"
 import {CopyrightDialog} from "../../copyright_dialog/index.js"
 import {DocumentAccessRightsDialog} from "../../documents/access_rights/index.js"
+import {RequestAccessDialog} from "../../documents/access_rights/request_access_dialog.js"
 import {SaveCopy, SaveRevision} from "../../exporter/native/index.js"
 import {ExportFidusFile} from "../../exporter/native/file.js"
 import {LanguageDialog, RevisionDialog} from "../../dialogs/index.js"
@@ -72,6 +73,13 @@ const exportProgress = (doc: {title: string; path?: string}) => {
         task.update(percentage ?? null, message)
 }
 
+const showRequestAccess = (editor: Editor): boolean =>
+    editor.user.is_authenticated === true &&
+    !editor.docInfo.is_owner &&
+    (Boolean(editor.docInfo.token) ||
+        (Boolean(editor.docInfo.access_rights) &&
+            editor.docInfo.access_rights !== "write"))
+
 const languageItem = (
     language: string,
     name: string,
@@ -115,62 +123,26 @@ export const headerbarModel = () => ({
             content: [
                 {
                     title: (editor: Editor) =>
-                        editor.user.is_authenticated &&
-                        editor.docInfo.token &&
-                        !editor.docInfo.is_owner
+                        showRequestAccess(editor)
                             ? gettext("Request Access")
                             : gettext("Share"),
                     type: "action",
                     //icon: 'share',
                     tooltip: (editor: Editor) =>
-                        editor.user.is_authenticated &&
-                        editor.docInfo.token &&
-                        !editor.docInfo.is_owner
+                        showRequestAccess(editor)
                             ? gettext("Request to be added as a collaborator.")
                             : gettext("Share the document with other users."),
                     order: 0,
                     action: (editor: Editor) => {
-                        if (
-                            editor.user.is_authenticated &&
-                            editor.docInfo.token &&
-                            !editor.docInfo.is_owner
-                        ) {
-                            // TokenUser requesting access
-                            editor.app.apiConnectors.document
-                                .requestAccess({
-                                    document_id: editor.docInfo.id as number,
-                                    rights: "write"
-                                })
-                                .then(({json}: {json: unknown}) => {
-                                    const data = json as {
-                                        success?: boolean
-                                        error?: string
-                                    }
-                                    if (data.success) {
-                                        addAlert(
-                                            "success",
-                                            gettext(
-                                                "Your access request has been sent to the document owner."
-                                            )
-                                        )
-                                    } else {
-                                        addAlert(
-                                            "error",
-                                            data.error ||
-                                                gettext(
-                                                    "Could not send access request."
-                                                )
-                                        )
-                                    }
-                                })
-                                .catch(() => {
-                                    addAlert(
-                                        "error",
-                                        gettext(
-                                            "Could not send access request."
-                                        )
-                                    )
-                                })
+                        if (showRequestAccess(editor)) {
+                            // Request higher access rights from the document owner
+                            const requestAccessDialog = new RequestAccessDialog(
+                                editor.docInfo.id as number,
+                                editor.docInfo.access_rights || "",
+                                editor.app.apiConnectors.document,
+                                Boolean(editor.docInfo.token)
+                            )
+                            requestAccessDialog.open()
                             return
                         }
                         const onShareSuccess = async (
@@ -254,19 +226,40 @@ export const headerbarModel = () => ({
                             editor.e2ee?.password || "",
                             onShareSuccess,
                             editor.app.settings,
+                            editor.docInfo.is_owner,
                             editor.app.apiConnectors.contacts,
                             editor.app.apiConnectors.document
                         )
                         shareDialog.init()
                     },
+                    available: (editor: Editor) => {
+                        if (editor.app.settings.EDITOR_SAVE_MODE === "external") {
+                            return false
+                        }
+                        if (!editor.user.is_authenticated) {
+                            return true
+                        }
+                        if (editor.docInfo.is_owner) {
+                            return true
+                        }
+                        if (editor.docInfo.token) {
+                            return true
+                        }
+                        if (!editor.docInfo.access_rights) {
+                            return false
+                        }
+                        return editor.docInfo.access_rights !== "write"
+                    },
                     disabled: (editor: Editor) => {
                         return (
                             editor.app.isOffline() ||
-                            !editor.user.is_authenticated
+                            !editor.user.is_authenticated ||
+                            !editor.docInfo.owner ||
+                            (!editor.docInfo.is_owner &&
+                                !editor.docInfo.token &&
+                                editor.docInfo.access_rights === "write")
                         )
-                    },
-                    available: (editor: Editor) =>
-                        editor.app.settings.EDITOR_SAVE_MODE !== "external"
+                    }
                 },
                 {
                     title: (editor: Editor) =>