From: Adam Dullage <redacted>
Date: Fri, 14 Jun 2024 07:25:51 +0000 (+0100)
Subject: Add custom path prefix support
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=a43b9cf592e9e88299b04bf252165a55d17641c8;p=flatnotes.git

Add custom path prefix support
---

diff --git a/client/api.js b/client/api.js
index 11a3731..4657f98 100644
--- a/client/api.js
+++ b/client/api.js
@@ -12,7 +12,7 @@ const api = axios.create();
 api.interceptors.request.use(
   // If the request is not for the token endpoint, add the token to the headers.
   function (config) {
-    if (config.url !== "/api/token") {
+    if (config.url !== "api/token") {
       const token = getStoredToken();
       config.headers.Authorization = `Bearer ${token}`;
     }
@@ -44,7 +44,7 @@ export function apiErrorHandler(error, toast) {
 
 export async function getConfig() {
   try {
-    const response = await api.get("/api/config");
+    const response = await api.get("api/config");
     return response.data;
   } catch (error) {
     return Promise.reject(error);
@@ -53,7 +53,7 @@ export async function getConfig() {
 
 export async function getToken(username, password, totp) {
   try {
-    const response = await api.post("/api/token", {
+    const response = await api.post("api/token", {
       username: username,
       password: totp ? password + totp : password,
     });
@@ -65,7 +65,7 @@ export async function getToken(username, password, totp) {
 
 export async function getNotes(term, sort, order, limit) {
   try {
-    const response = await api.get("/api/search", {
+    const response = await api.get("api/search", {
       params: {
         term: term,
         sort: sort,
@@ -81,7 +81,7 @@ export async function getNotes(term, sort, order, limit) {
 
 export async function createNote(title, content) {
   try {
-    const response = await api.post("/api/notes", {
+    const response = await api.post("api/notes", {
       title: title,
       content: content,
     });
@@ -93,7 +93,7 @@ export async function createNote(title, content) {
 
 export async function getNote(title) {
   try {
-    const response = await api.get(`/api/notes/${title}`);
+    const response = await api.get(`api/notes/${title}`);
     return new Note(response.data);
   } catch (response) {
     return Promise.reject(response);
@@ -102,7 +102,7 @@ export async function getNote(title) {
 
 export async function updateNote(title, newTitle, newContent) {
   try {
-    const response = await api.patch(`/api/notes/${title}`, {
+    const response = await api.patch(`api/notes/${title}`, {
       newTitle: newTitle,
       newContent: newContent,
     });
@@ -114,7 +114,7 @@ export async function updateNote(title, newTitle, newContent) {
 
 export async function deleteNote(title) {
   try {
-    await api.delete(`/api/notes/${title}`);
+    await api.delete(`api/notes/${title}`);
   } catch (response) {
     return Promise.reject(response);
   }
@@ -122,7 +122,7 @@ export async function deleteNote(title) {
 
 export async function getTags() {
   try {
-    const response = await api.get("/api/tags");
+    const response = await api.get("api/tags");
     return response.data;
   } catch (response) {
     return Promise.reject(response);
@@ -133,7 +133,7 @@ export async function createAttachment(file) {
   try {
     const formData = new FormData();
     formData.append("file", file);
-    const response = await api.post("/api/attachments", formData, {
+    const response = await api.post("api/attachments", formData, {
       headers: {
         "Content-Type": "multipart/form-data",
       },
diff --git a/client/index.html b/client/index.html
index 59f9d04..9bf1065 100644
--- a/client/index.html
+++ b/client/index.html
@@ -8,6 +8,7 @@
       content="width=device-width, initial-scale=1, shrink-to-fit=no"
     />
 
+    <base href="/" />
     <link
       rel="apple-touch-icon"
       sizes="180x180"
@@ -26,15 +27,15 @@
       href="assets/favicon-16x16.png"
     />
     <link rel="manifest" href="site.webmanifest" />
-    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#F8A66B" />
+    <link rel="mask-icon" href="safari-pinned-tab.svg" color="#F8A66B" />
     <link rel="shortcut icon" href="assets/favicon.ico" />
     <meta name="theme-color" content="#F8A66B" />
-    <link href="/style.css" rel="stylesheet" />
+    <link href="style.css" rel="stylesheet" />
 
     <title>flatnotes</title>
   </head>
   <body class="bg-theme-background text-theme-text">
     <div id="app"></div>
-    <script type="module" src="/index.js"></script>
+    <script type="module" src="index.js"></script>
   </body>
 </html>
diff --git a/client/router.js b/client/router.js
index 07b6c9d..81b2314 100644
--- a/client/router.js
+++ b/client/router.js
@@ -3,7 +3,7 @@ import * as constants from "./constants.js";
 import { createRouter, createWebHistory } from "vue-router";
 
 const router = createRouter({
-  history: createWebHistory(import.meta.env.BASE_URL),
+  history: createWebHistory(""),
   routes: [
     {
       path: "/",
diff --git a/client/site.webmanifest b/client/site.webmanifest
index 692075a..62faf14 100644
--- a/client/site.webmanifest
+++ b/client/site.webmanifest
@@ -4,13 +4,13 @@
   "start_url": "/",
   "icons": [
     {
-      "src": "/android-chrome-192x192.png",
+      "src": "android-chrome-192x192.png",
       "sizes": "192x192",
       "type": "image/png",
       "purpose": "any maskable"
     },
     {
-      "src": "/android-chrome-512x512.png",
+      "src": "android-chrome-512x512.png",
       "sizes": "512x512",
       "type": "image/png",
       "purpose": "any maskable"
diff --git a/client/style.css b/client/style.css
index 713c238..7876857 100644
--- a/client/style.css
+++ b/client/style.css
@@ -8,7 +8,7 @@
         font-style: normal;
         font-weight: 400;
         font-display: swap;
-        src: url("/assets/fonts/Poppins/Poppins-Regular.ttf");
+        src: url("assets/fonts/Poppins/Poppins-Regular.ttf");
     }
 
     body {
diff --git a/client/tokenStorage.js b/client/tokenStorage.js
index 2c4dc13..959af4d 100644
--- a/client/tokenStorage.js
+++ b/client/tokenStorage.js
@@ -1,7 +1,7 @@
 const tokenStorageKey = "token";
 
 function getCookieString(token) {
-  return `${tokenStorageKey}=${token}; path=/attachments; SameSite=Strict`;
+  return `${tokenStorageKey}=${token}; SameSite=Strict`;
 }
 
 export function storeToken(token, persist = false) {
diff --git a/server/attachments/file_system/file_system.py b/server/attachments/file_system/file_system.py
index e168c1f..9a5f35f 100644
--- a/server/attachments/file_system/file_system.py
+++ b/server/attachments/file_system/file_system.py
@@ -55,4 +55,4 @@ class FileSystemAttachments(BaseAttachments):
 
     def _url_for_filename(self, filename: str) -> str:
         """Return the URL for the given filename."""
-        return f"/attachments/{urllib.parse.quote(filename)}"
+        return f"attachments/{urllib.parse.quote(filename)}"
diff --git a/server/global_config.py b/server/global_config.py
index a620d48..4f4f9ee 100644
--- a/server/global_config.py
+++ b/server/global_config.py
@@ -10,6 +10,7 @@ class GlobalConfig:
         logger.debug("Loading global config...")
         self.auth_type: AuthType = self._load_auth_type()
         self.hide_recently_modified: bool = self._load_hide_recently_modified()
+        self.path_prefix: str = self._load_path_prefix()
 
     def load_auth(self):
         if self.auth_type in (AuthType.NONE, AuthType.READ_ONLY):
@@ -50,6 +51,14 @@ class GlobalConfig:
         key = "FLATNOTES_HIDE_RECENTLY_MODIFIED"
         return get_env(key, mandatory=False, default=False, cast_bool=True)
 
+    def _load_path_prefix(self):
+        key = "FLATNOTES_PATH_PREFIX"
+        value = get_env(key, mandatory=False, default="")
+        value = value.rstrip("/")
+        if value and not value.startswith("/"):
+            value = "/" + value
+        return value
+
 
 class AuthType(str, Enum):
     NONE = "none"
diff --git a/server/helpers.py b/server/helpers.py
index 977ef82..367830b 100644
--- a/server/helpers.py
+++ b/server/helpers.py
@@ -1,4 +1,5 @@
 import os
+import re
 import sys
 
 from pydantic import BaseModel
@@ -59,6 +60,22 @@ def get_env(
     return value
 
 
+def replace_base_href(html_file, path_prefix):
+    """Replace the href value for the base element in an HTML file."""
+    base_path = path_prefix + "/"
+    logger.info(
+        f"Replacing href value for base element in '{html_file}' "
+        + f"with '{base_path}'."
+    )
+    with open(html_file, "r", encoding="utf-8") as f:
+        html = f.read()
+    pattern = r'(<base\s+href=")[^"]*(")'
+    replacement = r"\1" + base_path + r"\2"
+    updated_html = re.sub(pattern, replacement, html, flags=re.IGNORECASE)
+    with open(html_file, "w", encoding="utf-8") as f:
+        f.write(updated_html)
+
+
 class CustomBaseModel(BaseModel):
     class Config:
         alias_generator = camel_case
diff --git a/server/main.py b/server/main.py
index cc27187..aa3ef92 100644
--- a/server/main.py
+++ b/server/main.py
@@ -1,6 +1,6 @@
 from typing import List, Literal
 
-from fastapi import Depends, FastAPI, HTTPException, UploadFile
+from fastapi import APIRouter, Depends, FastAPI, HTTPException, UploadFile
 from fastapi.responses import HTMLResponse
 from fastapi.staticfiles import StaticFiles
 
@@ -10,6 +10,7 @@ from attachments.models import AttachmentCreateResponse
 from auth.base import BaseAuth
 from auth.models import Login, Token
 from global_config import AuthType, GlobalConfig, GlobalConfigResponseModel
+from helpers import replace_base_href
 from notes.base import BaseNotes
 from notes.models import Note, NoteCreate, NoteUpdate, SearchResult
 
@@ -18,15 +19,20 @@ auth: BaseAuth = global_config.load_auth()
 note_storage: BaseNotes = global_config.load_note_storage()
 attachment_storage: BaseAttachments = global_config.load_attachment_storage()
 auth_deps = [Depends(auth.authenticate)] if auth else []
-app = FastAPI()
+router = APIRouter()
+app = FastAPI(
+    docs_url=global_config.path_prefix + "/docs",
+    openapi_url=global_config.path_prefix + "/openapi.json",
+)
+replace_base_href("client/dist/index.html", global_config.path_prefix)
 
 
 # region UI
-@app.get("/", include_in_schema=False)
-@app.get("/login", include_in_schema=False)
-@app.get("/search", include_in_schema=False)
-@app.get("/new", include_in_schema=False)
-@app.get("/note/{title}", include_in_schema=False)
+@router.get("/", include_in_schema=False)
+@router.get("/login", include_in_schema=False)
+@router.get("/search", include_in_schema=False)
+@router.get("/new", include_in_schema=False)
+@router.get("/note/{title}", include_in_schema=False)
 def root(title: str = ""):
     with open("client/dist/index.html", "r", encoding="utf-8") as f:
         html = f.read()
@@ -39,7 +45,7 @@ def root(title: str = ""):
 # region Login
 if global_config.auth_type not in [AuthType.NONE, AuthType.READ_ONLY]:
 
-    @app.post("/api/token", response_model=Token)
+    @router.post("/api/token", response_model=Token)
     def token(data: Login):
         try:
             return auth.login(data)
@@ -54,7 +60,7 @@ if global_config.auth_type not in [AuthType.NONE, AuthType.READ_ONLY]:
 
 # region Notes
 # Get Note
-@app.get(
+@router.get(
     "/api/notes/{title}",
     dependencies=auth_deps,
     response_model=Note,
@@ -74,7 +80,7 @@ def get_note(title: str):
 if global_config.auth_type != AuthType.READ_ONLY:
 
     # Create Note
-    @app.post(
+    @router.post(
         "/api/notes",
         dependencies=auth_deps,
         response_model=Note,
@@ -94,7 +100,7 @@ if global_config.auth_type != AuthType.READ_ONLY:
             )
 
     # Update Note
-    @app.patch(
+    @router.patch(
         "/api/notes/{title}",
         dependencies=auth_deps,
         response_model=Note,
@@ -115,7 +121,7 @@ if global_config.auth_type != AuthType.READ_ONLY:
             raise HTTPException(404, api_messages.note_not_found)
 
     # Delete Note
-    @app.delete(
+    @router.delete(
         "/api/notes/{title}",
         dependencies=auth_deps,
         response_model=None,
@@ -136,7 +142,7 @@ if global_config.auth_type != AuthType.READ_ONLY:
 
 
 # region Search
-@app.get(
+@router.get(
     "/api/search",
     dependencies=auth_deps,
     response_model=List[SearchResult],
@@ -153,7 +159,7 @@ def search(
     return note_storage.search(term, sort=sort, order=order, limit=limit)
 
 
-@app.get(
+@router.get(
     "/api/tags",
     dependencies=auth_deps,
     response_model=List[str],
@@ -167,7 +173,7 @@ def get_tags():
 
 
 # region Config
-@app.get("/api/config", response_model=GlobalConfigResponseModel)
+@router.get("/api/config", response_model=GlobalConfigResponseModel)
 def get_config():
     """Retrieve server-side config required for the UI."""
     return GlobalConfigResponseModel(
@@ -181,13 +187,13 @@ def get_config():
 
 # region Attachments
 # Get Attachment
-@app.get(
+@router.get(
     "/api/attachments/{filename}",
     dependencies=auth_deps,
 )
 # Include a secondary route used to create relative URLs that can be used
 # outside the context of flatnotes (e.g. "/attachments/image.jpg").
-@app.get(
+@router.get(
     "/attachments/{filename}",
     dependencies=auth_deps,
     include_in_schema=False,
@@ -210,7 +216,7 @@ def get_attachment(filename: str):
 if global_config.auth_type != AuthType.READ_ONLY:
 
     # Create Attachment
-    @app.post(
+    @router.post(
         "/api/attachments",
         dependencies=auth_deps,
         response_model=AttachmentCreateResponse,
@@ -232,7 +238,7 @@ if global_config.auth_type != AuthType.READ_ONLY:
 
 
 # region Healthcheck
-@app.get("/health")
+@router.get("/health")
 def healthcheck() -> str:
     """A lightweight endpoint that simply returns 'OK' to indicate the server
     is running."""
@@ -241,4 +247,9 @@ def healthcheck() -> str:
 
 # endregion
 
-app.mount("/", StaticFiles(directory="client/dist"), name="dist")
+app.include_router(router, prefix=global_config.path_prefix)
+app.mount(
+    global_config.path_prefix,
+    StaticFiles(directory="client/dist"),
+    name="dist",
+)
diff --git a/vite.config.js b/vite.config.js
index 34a0c65..3faaad3 100644
--- a/vite.config.js
+++ b/vite.config.js
@@ -6,7 +6,9 @@ const devApiUrl = "http://127.0.0.1:8000";
 export default defineConfig({
   plugins: [vue()],
   root: "client",
+  base: "",
   server: {
+    // Note: The FLATNOTES_PATH_PREFIX environment variable is not supported by the dev server
     port: 8080,
     proxy: {
       "/api/": {