From: Adam Dullage <redacted>
Date: Fri, 13 Sep 2024 12:00:57 +0000 (+0100)
Subject: Implement quick access note config options
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=b9b4205e64fa4db609453fb15f55ec32641c3c8f;p=flatnotes.git

Implement quick access note config options
---

diff --git a/client/views/Home.vue b/client/views/Home.vue
index 8b82aae..a81b4d9 100644
--- a/client/views/Home.vue
+++ b/client/views/Home.vue
@@ -1,6 +1,6 @@
 <template>
-  <div class="flex h-full items-center justify-center">
-    <div class="flex max-w-[500px] flex-1 flex-col items-center">
+  <div class="flex h-full justify-center">
+    <div class="flex max-w-[500px] flex-1 flex-col items-center pt-[25vh]">
       <Logo class="mb-5" />
       <SearchInput class="mb-5 shadow-[0_0_20px] shadow-theme-shadow" />
       <LoadingIndicator
@@ -10,9 +10,9 @@
       >
         <p
           v-if="notes.length > 0"
-          class="mb-2 text-xs font-bold text-theme-text-very-muted"
+          class="mb-2 text-xs font-bold uppercase text-theme-text-very-muted"
         >
-          RECENTLY MODIFIED
+          {{ globalStore.config.quickAccessTitle }}
         </p>
         <RouterLink
           v-for="note in notes"
@@ -31,7 +31,6 @@ import { useToast } from "primevue/usetoast";
 import { onMounted, ref, watch } from "vue";
 import { RouterLink } from "vue-router";
 
-import { mdiPencil } from "@mdi/js";
 import { apiErrorHandler, getNotes } from "../api.js";
 import CustomButton from "../components/CustomButton.vue";
 import LoadingIndicator from "../components/LoadingIndicator.vue";
@@ -41,23 +40,22 @@ import SearchInput from "../partials/SearchInput.vue";
 
 const globalStore = useGlobalStore();
 const loadingIndicator = ref();
-const noNotesMessage =
-  "Click the 'New Note' button at the top of the page to get started.";
 const notes = ref([]);
 const toast = useToast();
 
 function init() {
-  if (globalStore.config.hideRecentlyModified) {
+  if (globalStore.config.quickAccessHide) {
     return;
   }
-  getNotes("*", "lastModified", "desc", 5)
+  getNotes(
+    globalStore.config.quickAccessTerm,
+    globalStore.config.quickAccessSort,
+    globalStore.config.quickAccessOrder,
+    globalStore.config.quickAccessLimit,
+  )
     .then((data) => {
       notes.value = data;
-      if (notes.value.length > 0) {
-        loadingIndicator.value.setLoaded();
-      } else {
-        loadingIndicator.value.setFailed(noNotesMessage, mdiPencil);
-      }
+      loadingIndicator.value.setLoaded();
     })
     .catch((error) => {
       loadingIndicator.value.setFailed();
diff --git a/server/global_config.py b/server/global_config.py
index dd1022a..df696c2 100644
--- a/server/global_config.py
+++ b/server/global_config.py
@@ -9,7 +9,12 @@ class GlobalConfig:
     def __init__(self) -> None:
         logger.debug("Loading global config...")
         self.auth_type: AuthType = self._load_auth_type()
-        self.hide_recently_modified: bool = self._load_hide_recently_modified()
+        self.quick_access_hide: bool = self._quick_access_hide()
+        self.quick_access_title: str = self._quick_access_title()
+        self.quick_access_term: str = self._quick_access_term()
+        self.quick_access_sort: str = self._quick_access_sort()
+        self.quick_access_order: str = self._quick_access_order()
+        self.quick_access_limit: int = self._quick_access_limit()
         self.path_prefix: str = self._load_path_prefix()
 
     def load_auth(self):
@@ -47,9 +52,57 @@ class GlobalConfig:
             sys.exit(1)
         return auth_type
 
-    def _load_hide_recently_modified(self):
-        key = "FLATNOTES_HIDE_RECENTLY_MODIFIED"
-        return get_env(key, mandatory=False, default=False, cast_bool=True)
+    def _quick_access_hide(self):
+        key = "FLATNOTES_QUICK_ACCESS_HIDE"
+        value = get_env(key, mandatory=False, default=False, cast_bool=True)
+        if value is False:
+            depricated_key = "FLATNOTES_HIDE_RECENTLY_MODIFIED"
+            value = get_env(
+                depricated_key, mandatory=False, default=False, cast_bool=True
+            )
+            if value is True:
+                logger.warning(
+                    f"{depricated_key} is depricated. Please use {key} instead."
+                )
+        return value
+
+    def _quick_access_title(self):
+        key = "FLATNOTES_QUICK_ACCESS_TITLE"
+        return get_env(key, mandatory=False, default="RECENTLY MODIFIED")
+
+    def _quick_access_term(self):
+        key = "FLATNOTES_QUICK_ACCESS_TERM"
+        return get_env(key, mandatory=False, default="*")
+
+    def _quick_access_sort(self):
+        key = "FLATNOTES_QUICK_ACCESS_SORT"
+        value = get_env(key, mandatory=False, default="lastModified")
+        valid_values = ["score", "title", "lastModified"]
+        if value not in valid_values:
+            logger.error(
+                f"Invalid value '{value}' for {key}. "
+                + "Must be one of: "
+                + ", ".join(valid_values)
+            )
+            sys.exit(1)
+        return value
+
+    def _quick_access_order(self):
+        key = "FLATNOTES_QUICK_ACCESS_ORDER"
+        value = get_env(key, mandatory=False, default="desc")
+        valid_values = ["asc", "desc"]
+        if value not in valid_values:
+            logger.error(
+                f"Invalid value '{value}' for {key}. "
+                + "Must be one of: "
+                + ", ".join(valid_values)
+            )
+            sys.exit(1)
+        return value
+
+    def _quick_access_limit(self):
+        key = "FLATNOTES_QUICK_ACCESS_LIMIT"
+        return get_env(key, mandatory=False, default=5, cast_int=True)
 
     def _load_path_prefix(self):
         key = "FLATNOTES_PATH_PREFIX"
@@ -72,4 +125,9 @@ class AuthType(str, Enum):
 
 class GlobalConfigResponseModel(CustomBaseModel):
     auth_type: AuthType
-    hide_recently_modified: bool
+    quick_access_hide: bool
+    quick_access_title: str
+    quick_access_term: str
+    quick_access_sort: str
+    quick_access_order: str
+    quick_access_limit: int
diff --git a/server/main.py b/server/main.py
index aa3ef92..4ec52ff 100644
--- a/server/main.py
+++ b/server/main.py
@@ -178,7 +178,12 @@ def get_config():
     """Retrieve server-side config required for the UI."""
     return GlobalConfigResponseModel(
         auth_type=global_config.auth_type,
-        hide_recently_modified=global_config.hide_recently_modified,
+        quick_access_hide=global_config.quick_access_hide,
+        quick_access_title=global_config.quick_access_title,
+        quick_access_term=global_config.quick_access_term,
+        quick_access_sort=global_config.quick_access_sort,
+        quick_access_order=global_config.quick_access_order,
+        quick_access_limit=global_config.quick_access_limit,
     )