feat: custom sharePath setting

apps/client/src/translations/en/translation.json

@@ -1874,9 +1874,17 @@
     "show_login_link": "Show Login link in Share theme",
     "show_login_link_description": "Add a login link to the Share page footer",
     "check_share_root": "Check Share Root Status",
+    "check_share_root_error": "An unexpected error happened while checking the Share Root Status, please check the logs for more information.",
+    "share_note_title": "'{{noteTitle}}'",
     "share_root_found": "Share root note '{{noteTitle}}' is ready",
     "share_root_not_found": "No note with #shareRoot label found",
-    "share_root_not_shared": "Note '{{noteTitle}}' has #shareRoot label but is not shared"
+    "share_root_not_shared": "Note '{{noteTitle}}' has #shareRoot label but is not Shared",
+    "share_root_multiple_found": "Found multiple shared notes with a #shareRoot label: {{- foundNoteTitles}}. The note {{- activeNoteTitle}} will be used as shared root note.",
+    "share_path": "Share path",
+    "share_path_description": "The url prefix for shared notes (e.g. '/share' --> '/share/noteId' or '/custom-path' --> '/custom-path/noteId'). In order for the change to take effect, you need to restart the server.",
+    "share_path_placeholder": "/share or /custom-path",
+    "share_subtree": "Share subtree",
+    "share_subtree_description": "Share the entire subtree, not just the note"
   },
   "time_selector": {
     "invalid_input": "The entered time value is not a valid number.",

apps/client/src/widgets/type_widgets/options/other/share_settings.spec.ts

@@ -0,0 +1,75 @@
+import { describe, it, expect } from "vitest";
+
+describe.skip("ShareSettingsOptions", () => {})
+/*
+
+    Test currently fails during import:
+
+ FAIL   app  widgets/type_widgets/options/other/share_settings.spec.ts [ src/public/app/widgets/type_widgets/options/other/share_settings.spec.ts ]
+TypeError: Class extends value undefined is not a constructor or null
+ ❯ widgets/right_panel_widget.ts:20:32
+      20| class RightPanelWidget extends NoteContextAwareWidget {
+      21|     private $bodyWrapper!: JQuery<HTMLElement>;
+      22|     $body!: JQuery<HTMLElement>;
+
+
+import ShareSettingsOptions from "./share_settings.js";
+
+type TestCase<T extends (...args: any) => any> = [
+    desc: string,
+    fnParams: Parameters<T>,
+    expected: ReturnType<T>
+];
+
+
+
+describe("ShareSettingsOptions", () => {
+
+    describe("#normalizeSharePathInput", () => {
+
+        const testCases: TestCase<ShareSettingsOptions["normalizeSharePathInput"]>[] = [
+            [
+                "should handle multiple trailing '/' and remove them completely",
+                ["/trailingtest////"],
+                "/trailingtest"
+            ],
+            [
+                "should handle multiple starting '/' and replace them by a single '/'",
+                ["////startingtest"],
+                "/startingtest"
+            ],
+            [
+                "should handle multiple starting & trailing '/' and replace them by a single '/'",
+                ["////startingAndTrailingTest///"],
+                "/startingAndTrailingTest"
+            ],
+            [
+                "should not remove any '/' other than at the end or start of the input",
+                ["/test/with/subpath"],
+                "/test/with/subpath"
+            ],
+            [
+                "should prepend the string with a '/' if it does not start with one",
+                ["testpath"],
+                "/testpath"
+            ],
+            [
+                "should not change anything, if the string is a single '/'",
+                ["/"],
+                "/"
+            ],
+        ];
+
+        testCases.forEach((testCase) => {
+            const [desc, fnParams, expected] = testCase;
+            return it(desc, () => {
+                const shareSettings = new ShareSettingsOptions();
+                const actual = shareSettings.normalizeSharePathInput(...fnParams);
+                expect(actual).toStrictEqual(expected);
+            });
+        });
+
+
+    })
+
+})*/

apps/client/src/widgets/type_widgets/options/other/share_settings.ts

@@ -8,88 +8,172 @@ const TPL = /*html*/`
 <div class="options-section">
     <h4>${t("share.title")}</h4>
 
-    <label class="tn-checkbox">
-        <input class="form-check-input" type="checkbox" name="redirectBareDomain" value="true">
-        ${t("share.redirect_bare_domain")}
-    </label>
-    <p class="form-text">${t("share.redirect_bare_domain_description")}</p>
-
-    <label class="tn-checkbox">
-        <input class="form-check-input" type="checkbox" name="showLoginInShareTheme" value="true">
-        ${t("share.show_login_link")}
-    </label>
-    <p class="form-text">${t("share.show_login_link_description")}</p>
+    <div class="form-group">
+        <label class="tn-checkbox">
+            <input class="form-check-input redirect-bare-domain" type="checkbox" name="redirectBareDomain" value="true">
+            ${t("share.redirect_bare_domain")}
+        </label>
+        <p class="form-text">${t("share.redirect_bare_domain_description")}</p>
+
+        <div class="share-root-check mt-2 mb-2">
+            <button class="btn btn-sm btn-secondary check-share-root">${t("share.check_share_root")}</button>
+            <div class="share-root-status form-text mt-2"></div>
+        </div>
+    </div>
+
+    <div class="form-group">
+        <label class="tn-checkbox">
+        <input class="form-check-input show-login-in-share-theme" type="checkbox" name="showLoginInShareTheme" value="true">
+            ${t("share.show_login_link")}
+        </label>
+        <p class="form-text">${t("share.show_login_link_description")}</p>
+    </div>
+
+    <div class="form-group">
+        <label>${t("share.share_path")}</label>
+        <div>
+            <input type="text" class="form-control share-path" placeholder="${t("share.share_path_placeholder")}">
+        </div>
+        <div class="form-text">
+            ${t("share.share_path_description")}
+        </div>
+    </div>
+
 </div>`;
 
 export default class ShareSettingsOptions extends OptionsWidget {
+    private $redirectBareDomain!: JQuery<HTMLInputElement>;
+    private $showLoginInShareTheme!: JQuery<HTMLInputElement>;
+    private $sharePath!: JQuery<HTMLInputElement>;
     private $shareRootCheck!: JQuery<HTMLElement>;
     private $shareRootStatus!: JQuery<HTMLElement>;
 
     doRender() {
         this.$widget = $(TPL);
         this.contentSized();
 
+        this.$redirectBareDomain = this.$widget.find(".redirect-bare-domain");
+        this.$showLoginInShareTheme = this.$widget.find(".show-login-in-share-theme");
+        this.$sharePath = this.$widget.find(".share-path");
         this.$shareRootCheck = this.$widget.find(".share-root-check");
         this.$shareRootStatus = this.$widget.find(".share-root-status");
+        this.$shareRootCheck.hide();
 
-        // Add change handlers for both checkboxes
-        this.$widget.find('input[type="checkbox"]').on("change", (e: JQuery.ChangeEvent) => {
-            this.save();
+        this.$redirectBareDomain.on('change', async () => {
+            const redirectBareDomain = this.$redirectBareDomain.is(":checked");
+            await this.updateOption<"redirectBareDomain">("redirectBareDomain", redirectBareDomain.toString());
 
             // Show/hide share root status section based on redirectBareDomain checkbox
-            const target = e.target as HTMLInputElement;
-            if (target.name === "redirectBareDomain") {
-                this.$shareRootCheck.toggle(target.checked);
-                if (target.checked) {
-                    this.checkShareRoot();
-                }
-            }
+            this.$shareRootCheck.toggle(redirectBareDomain);
+        });
+
+        this.$showLoginInShareTheme.on('change', async () => {
+            const showLoginInShareTheme = this.$showLoginInShareTheme.is(":checked");
+            await this.updateOption<"showLoginInShareTheme">("showLoginInShareTheme", showLoginInShareTheme.toString());
+        });
+
+        this.$sharePath.on('change', async () => {
+            const DEFAULT_SHAREPATH = "/share";
+            const sharePathInput = this.$sharePath.val()?.trim() || "";
+
+            // TODO: inform user if they try to add more than a single path prefix (i.e. /sharePath/test)
+            // → this currently is not properly working, as for some reason the assets URL is not correctly rewritten
+            // and it only includes the first path in the URL, e.g.
+            // http://localhost:8080/sharePath/assets/v0.93.0/node_modules/normalize.css/normalize.css
+            // instead of
+            // http://localhost:8080/sharePath/test/assets/v0.93.0/node_modules/normalize.css/normalize.css
+            // alternatively/better approach: fix this behaviour :-)
+            const normalizedSharePath = this.normalizeSharePathInput(sharePathInput);
+            const optionValue = (!sharePathInput || !normalizedSharePath || normalizedSharePath === "/")
+                ? DEFAULT_SHAREPATH
+                : normalizedSharePath;
+
+            await this.updateOption<"sharePath">("sharePath", optionValue);
         });
 
-        // Add click handler for check share root button
         this.$widget.find(".check-share-root").on("click", () => this.checkShareRoot());
     }
 
+    // Ensure sharePath always starts with a single slash and does not end with (one or multiple) trailing slashes
+    normalizeSharePathInput(sharePathInput: string) {
+
+        const REGEXP_STARTING_SLASH = /^\/+/g;
+        const REGEXP_TRAILING_SLASH = /\b\/+$/g;
+
+        const normalizedSharePath = (!sharePathInput.startsWith("/")
+            ? `/${sharePathInput}`
+            : sharePathInput)
+            .replaceAll(REGEXP_TRAILING_SLASH, "")
+            .replaceAll(REGEXP_STARTING_SLASH, "/");
+
+        return normalizedSharePath;
+
+    }
+
     async optionsLoaded(options: OptionMap) {
         const redirectBareDomain = options.redirectBareDomain === "true";
-        this.$widget.find('input[name="redirectBareDomain"]').prop("checked", redirectBareDomain);
+        this.$redirectBareDomain.prop("checked", redirectBareDomain);
         this.$shareRootCheck.toggle(redirectBareDomain);
-        if (redirectBareDomain) {
-            await this.checkShareRoot();
-        }
 
-        this.$widget.find('input[name="showLoginInShareTheme"]').prop("checked", options.showLoginInShareTheme === "true");
+        this.$showLoginInShareTheme.prop("checked", options.showLoginInShareTheme === "true");
+        this.$sharePath.val(options.sharePath);
     }
 
     async checkShareRoot() {
-        const $button = this.$widget.find(".check-share-root");
-        $button.prop("disabled", true);
+        this.$shareRootCheck.prop("disabled", true);
+
+        const setCheckShareRootStyle = (removeClassName: string, addClassName: string, text: string) => {
+            this.$shareRootStatus
+            .removeClass(removeClassName)
+            .addClass(addClassName)
+            .text(text);
+
+            this.$shareRootCheck.prop("disabled", false);
+        };
 
         try {
             const shareRootNotes = await searchService.searchForNotes("#shareRoot");
-            const sharedShareRootNote = shareRootNotes.find((note) => note.isShared());
-
-            if (sharedShareRootNote) {
-                this.$shareRootStatus
-                    .removeClass("text-danger")
-                    .addClass("text-success")
-                    .text(t("share.share_root_found", { noteTitle: sharedShareRootNote.title }));
-            } else {
-                this.$shareRootStatus
-                    .removeClass("text-success")
-                    .addClass("text-danger")
-                    .text(shareRootNotes.length > 0 ? t("share.share_root_not_shared", { noteTitle: shareRootNotes[0].title }) : t("share.share_root_not_found"));
+            const sharedShareRootNotes = shareRootNotes.filter((note) => note.isShared());
+
+            // No Note found that has the sharedRoot label AND is currently shared
+            if (sharedShareRootNotes.length < 1) {
+                const textMessage = (shareRootNotes.length > 0)
+                    ? t("share.share_root_not_shared", { noteTitle: shareRootNotes[0].title })
+                    : t("share.share_root_not_found");
+
+                return setCheckShareRootStyle("text-success", "text-danger", textMessage);
             }
-        } finally {
-            $button.prop("disabled", false);
-        }
-    }
 
-    async save() {
-        const redirectBareDomain = this.$widget.find('input[name="redirectBareDomain"]').prop("checked");
-        await this.updateOption<"redirectBareDomain">("redirectBareDomain", redirectBareDomain.toString());
+            // more than one currently shared Note found with the sharedRoot label
+            // → use the first found, but warn user about it
+            if (sharedShareRootNotes.length > 1) {
+
+                const foundNoteTitles = shareRootNotes.map(note => t("share.share_note_title", {
+                    noteTitle: note.title,
+                    interpolation: {
+                        escapeValue: false
+                    }
+                }));
+                const activeNoteTitle = foundNoteTitles[0];
+
+                return setCheckShareRootStyle("text-danger", "text-success",
+                    t("share.share_root_multiple_found", {
+                        activeNoteTitle,
+                        foundNoteTitles: foundNoteTitles.join(", ")
+                    })
+                );
+            }
 
-        const showLoginInShareTheme = this.$widget.find('input[name="showLoginInShareTheme"]').prop("checked");
-        await this.updateOption<"showLoginInShareTheme">("showLoginInShareTheme", showLoginInShareTheme.toString());
+            // exactly one note that has the sharedRoot label AND is currently shared
+            return setCheckShareRootStyle("text-danger", "text-success",
+                t("share.share_root_found", { noteTitle: sharedShareRootNotes[0].title })
+            );
+
+        } catch(err) {
+            console.error(err);
+            return setCheckShareRootStyle("text-success", "text-danger",
+                t("share.check_share_root_error",)
+            );
+        }
     }
 }

apps/server/src/routes/api/options.ts

@@ -90,6 +90,8 @@ const ALLOWED_OPTIONS = new Set<OptionNames>([
     "allowedHtmlTags",
     "redirectBareDomain",
     "showLoginInShareTheme",
+    "shareSubtree",
+    "sharePath",
     "splitEditorOrientation",
 
     // AI/LLM integration options

apps/server/src/routes/routes.ts

@@ -79,6 +79,7 @@ const GET = "get",
     DEL = "delete";
 
 function register(app: express.Application) {
+
     route(GET, "/", [auth.checkAuth, csrfMiddleware], indexRoute.index);
     route(GET, "/login", [auth.checkAppInitialized, auth.checkPasswordSet], loginRoute.loginPage);
     route(GET, "/set-password", [auth.checkAppInitialized, auth.checkPasswordNotSet], loginRoute.setPasswordPage);

apps/server/src/services/auth.ts

@@ -49,11 +49,27 @@ function checkAuth(req: Request, res: Response, next: NextFunction) {
             // Check if any note has the #shareRoot label
             const shareRootNotes = attributes.getNotesWithLabel("shareRoot");
             if (shareRootNotes.length === 0) {
+                // should this be a translation string?
                 res.status(404).json({ message: "Share root not found. Please set up a note with #shareRoot label first." });
                 return;
             }
+
+            // Get the configured share path
+            const sharePath = options.getOption("sharePath") || '/share';
+
+            // Check if we're already at the share path to prevent redirect loops
+            if (req.path === sharePath || req.path.startsWith(`${sharePath}/`)) {
+                log.info(`checkAuth: Already at share path, skipping redirect. Path: ${req.path}, SharePath: ${sharePath}`);
+                next();
+                return;
+            }
+
+            // Redirect to the share path
+            log.info(`checkAuth: Redirecting to share path. From: ${req.path}, To: ${sharePath}`);
+            res.redirect(`${sharePath}/`);
+        } else {
+            res.redirect("login");
         }
-        res.redirect(hasRedirectBareDomain ? "share" : "login");
     } else {
         next();
     }

apps/server/src/services/options_init.ts

@@ -189,8 +189,10 @@ const defaultOptions: DefaultOption[] = [
     },
 
     // Share settings
+    { name: "sharePath", value: "/share", isSynced: true },
     { name: "redirectBareDomain", value: "false", isSynced: true },
     { name: "showLoginInShareTheme", value: "false", isSynced: true },
+    { name: "shareSubtree", value: "false", isSynced: true },
 
     // AI Options
     { name: "aiEnabled", value: "false", isSynced: true },