feat: added custom sidebar menu, configurable via SIDEBAR_CUSTOM_MENU

The menu can be configured both via the setting SIDEBAR_CUSTOM_MENU,
where the config is stored as json list of lists, e.g.

    [["Example",""], ["Pagetitle","Subfolder/Pagetitle"], ["External
    Link", "https://example.com""]]

In the admin preferences the Menu can be configured in a convenient way. For
adding wiki pages a dropdown select box with all pages is available. The
order can be sorted manually via drag and drop.

This was discussed in #125.

Author: redimp

otterwiki/preferences.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 
 import re
+import json
 from otterwiki.util import is_valid_email
 from flask import (
     redirect,
@@ -12,7 +13,8 @@
     current_user,
 )
 from otterwiki.server import app, db, update_app_config, Preferences
-from otterwiki.helper import toast, send_mail
+from otterwiki.sidebar import SidebarPageIndex, SidebarMenu
+from otterwiki.helper import toast, send_mail, get_pagename
 from otterwiki.util import empty, is_valid_email
 from flask_login import current_user
 from otterwiki.auth import (
@@ -92,6 +94,17 @@ def handle_mail_preferences(form):
 
 
 def handle_sidebar_preferences(form):
+    custom_menu_js = json.dumps(
+        [   x
+            for x in list(zip(form.getlist("title"), form.getlist("link")))
+            if x[0].strip() or x[1].strip()
+        ]
+    )
+
+    _update_preference(
+        "SIDEBAR_CUSTOM_MENU", custom_menu_js
+    )
+
     for checkbox in [
         "sidebar_shortcut_home",
         "sidebar_shortcut_page_index",
@@ -337,10 +350,15 @@ def permissions_and_registration_form():
 def sidebar_preferences_form():
     if not has_permission("ADMIN"):
         abort(403)
+    # we re-use SidebarPageIndex to generate a list of all pages
+    sn = SidebarPageIndex("", mode="*")
+    pages = [get_pagename(fh[0], full=True, header=fh[1]) for fh in sn.filenames_and_header]
     # render form
     return render_template(
         "admin/sidebar_preferences.html",
         title="Sidebar Preferences",
+        pages=pages,
+        custom_menu=SidebarMenu().config,
     )
 
 

otterwiki/server.py

@@ -47,6 +47,7 @@
     MINIFY_HTML=True,
     SIDEBAR_MENUTREE_MODE="SORTED",
     SIDEBAR_MENUTREE_MAXDEPTH="",
+    SIDEBAR_CUSTOM_MENU="",
     COMMIT_MESSAGE="REQUIRED", # OPTIONAL
     GIT_WEB_SERVER=False,
     SIDEBAR_SHORTCUT_HOME=True,

otterwiki/sidebar.py

@@ -2,34 +2,78 @@
 
 import os
 import re
+import json
 from collections import OrderedDict
-
+from flask import url_for
 from otterwiki.server import storage, app
 from otterwiki.util import (
     split_path,
     join_path,
+    empty,
 )
 from otterwiki.helper import (
     get_pagename,
 )
 
 
-class SidebarNavigation:
+class SidebarMenu:
+    URI_SIMPLE = re.compile(
+        r"^(((https?)\:\/\/)|(mailto:))\S+"
+    )
+    def __init__(self):
+        self.menu = []
+        self.config = []
+        if not app.config.get("SIDEBAR_CUSTOM_MENU", None):
+            return
+        try:
+            raw_config = json.loads(app.config.get("SIDEBAR_CUSTOM_MENU",""))
+        except (ValueError, IndexError) as e:
+            app.logger.error(
+                f"Error decoding SIDEBAR_CUSTOM_MENU={app.config.get('SIDEBAR_CUSTOM_MENU','')}: {e}"
+            )
+            raw_config = []
+        for entry in raw_config:
+            if len(entry) != 2: continue # FIXME: print warning
+            if empty(entry[0]) and empty(entry[1]): continue
+            self.config.append(entry)
+        for entry in self.config:
+            title, link = entry
+            if empty(link):
+                if empty(title): continue
+                self.menu.append([title, url_for("view", path=title)])
+            elif self.URI_SIMPLE.match(link):
+                if empty(title): title = link
+                self.menu.append([title, link])
+            else:
+                if empty(title): title = link
+                self.menu.append([title, url_for("view", path=link)])
+
+    def query(self):
+        return self.menu
+
+class SidebarPageIndex:
     AXT_HEADING = re.compile(
         r' {0,3}(#{1,6})(?!#+)(?: *\n+|' r'\s+([^\n]*?)(?:\n+|\s+?#+\s*\n+))'
     )
     SETEX_HEADING = re.compile(r'([^\n]+)\n *(=|-){2,}[ \t]*\n+')
 
-    def __init__(self, path: str = "/"):
+    def __init__(self, path: str = "/", mode: str = ""):
         self.path = path if app.config["RETAIN_PAGE_NAME_CASE"] else path.lower()
         self.path_depth = len(split_path(self.path))
         try:
             self.max_depth = int(app.config["SIDEBAR_MENUTREE_MAXDEPTH"])
         except ValueError:
             self.max_depth = None
         self.mode = app.config["SIDEBAR_MENUTREE_MODE"]
+        # overwrite mode if argument is given
+        if mode: self.mode = mode
+
         # TODO load configs (yaml header in page?) (sidebar.yaml?)
+
         # TODO check for cached pages
+
+        self.filenames_and_header = []
+
         # load pages
         if self.mode == "":
             self.tree = None
@@ -122,6 +166,7 @@ def load(self):
             if entry.endswith(".md"):
                 header = self.read_header(entry)
                 entry = entry[:-3]
+            self.filenames_and_header.append((entry, header))
             parts = split_path(entry)
             self.add_node(self.tree, [], parts, header)
 

otterwiki/static/css/otterwiki.css

@@ -218,6 +218,10 @@ pre,
     padding-right: 0;
 }
 
+.btn-handle {
+    cursor: move;
+}
+
 .extra-nav-attachment {
     padding: 1rem;
 }