Merge branch 'dev-future' into dev

Author: MenxLi

MANIFEST.in

@@ -3,5 +3,5 @@ include lires/version.yaml *
 recursive-include lires/assets *
 recursive-include lires_qt/docs *
 recursive-include lires_qt/icons *
-recursive-include lires_qt/stylesheets *
+recursive-include lires_qt/assets *
 recursive-include lires_web/dist *

lires/cmd/generateDefaultConf.py

@@ -1,73 +1,15 @@
 import os
-from ..core.dataClass import DataTableList
-from ..confReader import CONF_FILE_PATH, saveToConf, DEFAULT_DATA_PATH, DEFAULT_PDF_VIEWER_DIR
+from ..confReader import generateDefaultConf
 
 def run():
 	generateDefaultConf()
 
-try:
-	import darkdetect
-	# this is the only place where darkdetect is used, 
-	# this dependency is not required for the server environment
-	is_sys_darkmode = darkdetect.isDark()
-except ImportError:
-	is_sys_darkmode = False
-
-def generateDefaultConf():
-	"""
-	"database" points to local database, used by LiresWeb,
-	"""
-	saveToConf(
-		## CORE SETTINGS ##
-		accepted_extensions = [".pdf", ".caj", ".html", ".hpack", ".md", ".pptx", ".ppt"],
-		database = DEFAULT_DATA_PATH,
-
-		host = "",
-		port = "8080",
-		access_key = "",
-
-		pdfjs_viewer_path = os.path.join(DEFAULT_PDF_VIEWER_DIR, "web", "viewer.html"),
-
-		## GUI SETTINGS ##
-		# Maybe move them to a separate file?
-		server_preset = [{
-			"host": "http://localhost",
-			"port": "8080",
-			"access_key": ""
-		}],
-
-		default_tags = [],
-		table_headers = [ 
-				DataTableList.HEADER_FILESTATUS,
-				DataTableList.HEADER_TITLE,
-				DataTableList.HEADER_YEAR, 
-				DataTableList.HEADER_AUTHOR
-			 ],
-		sort_method = DataTableList.SORT_TIMEADDED,
-		sort_reverse = False,
-		font_sizes = {
-			"data": ["Arial", 10],
-			"tag": ["Arial", 10]
-
-		},
-        stylesheet = "Simple-dark" if is_sys_darkmode else "Simple",
-		auto_save_comments = False,
-		gui_status = {
-			"show_toolbar": True,
-			"tag_uncollapsed": []
-		},
-		proxies = {
-			"proxy_config": {
-				"proxy_type": "socks5",
-				"host": "127.0.0.1",
-				"port": ""
-			},
-			"enable_requests": False,
-			"enable_qt": False,
-		},
-
-    )
-	print("Generated default configuration file at: ", CONF_FILE_PATH)
+	try:
+		from lires_qt.config import generateDefaultGUIConfig
+		generateDefaultGUIConfig()
+	except ModuleNotFoundError as e:
+		print(e)
+		print("Failed to import lires_qt.config, skip generating GUI configuration file")
 
 if __name__ == "__main__":
 	run()

lires/confReader.py

@@ -1,6 +1,7 @@
 import os, json, tempfile, logging
 from .core import globalVar as G
 from .types.configT import *
+import deprecated
 
 logger_lrs = logging.getLogger("lires")
 
@@ -10,9 +11,12 @@
 
 # a schematic ascii image of the file tree
 # LRS_HOME
-# ├── conf.json
+# ├── config.json
+# ├── (config_gui.json)
 # ├── pdf-viewer
-# ├── log.txt
+# ├── core.log
+# ├── (gui.log)
+# ├── (server.log)
 # ├── Database (default)
 # │   ├── lrs.db
 # │   └── ...
@@ -36,12 +40,11 @@
 if G.prog_args and G.prog_args.config_file:
     CONF_FILE_PATH = os.path.abspath(G.prog_args.config_file)
     if os.path.isdir(CONF_FILE_PATH):
-        CONF_FILE_PATH = os.path.join(CONF_FILE_PATH, "lrs-conf.json")
+        CONF_FILE_PATH = os.path.join(CONF_FILE_PATH, "lrs-config.json")
 else:
-    CONF_FILE_PATH = join(LRS_HOME, "conf.json")
+    CONF_FILE_PATH = join(LRS_HOME, "config.json")
 
 ASSETS_PATH = join(CURR_PATH, "assets")
-BIB_TEMPLATE_PATH = join(ASSETS_PATH, "bibtexTemplates")
 
 DEFAULT_DATA_PATH = join(LRS_HOME, "Database")
 DEFAULT_PDF_VIEWER_DIR = join(LRS_HOME, "pdf-viewer")
@@ -109,6 +112,7 @@ def getDatabasePath_withFallback(offline: Optional[bool] = None, fallback: str =
     else:
         return fallback
 
+@deprecated.deprecated(version="1.2.0", reason="use getConf instead")
 def getConfV(key : str):
     try:
         return getConf()[key]
@@ -142,9 +146,34 @@ def saveToConf(**kwargs):
     # So that next time the configuration will be read from file by getConf/getConfV
     G.resetGlobalConfVar()
 
-def saveToConf_guiStatus(**kwargs):
-    gui_status = getConfV("gui_status")
-    for k,v in kwargs.items():
-        gui_status[k] = v
-    saveToConf(gui_status = gui_status)
 
+def generateDefaultConf():
+    """
+    "database" points to local database, used by LiresServer and Qt GUI in local mode,
+    """
+    default_config: LiresConfT = {
+        "accepted_extensions": [".pdf", ".caj", ".html", ".hpack", ".md", ".pptx", ".ppt"],
+        "database": DEFAULT_DATA_PATH,
+
+        "host": "",
+        "port": "8080",
+        "access_key": "",
+
+        "pdfjs_viewer_path": os.path.join(DEFAULT_PDF_VIEWER_DIR, "web", "viewer.html"),
+
+        "proxies": {
+            "proxy_config": {
+                "proxy_type": "socks5",
+                "host": "127.0.0.1",
+                "port": ""
+            },
+            "enable_requests": False,
+            "enable_qt": False,
+        },
+    }
+
+    with open(CONF_FILE_PATH, "w", encoding="utf-8") as fp:
+        json.dump(default_config, fp, indent=1)
+    
+    print("Generated default configuration file at: ", CONF_FILE_PATH)
+    return 

lires/core/dataClass.py

@@ -503,37 +503,6 @@ def reloadFromFile(self, idx):
     def getTable(self):
         pass
 
-    # def getTableItem(self, row: int, col: int) -> str:
-        # data = self[row]
-        # return DataList.TB_FUNCS[col](data)
-
-    # def getTableHeaderItem(self, col: int) -> str:
-        # return self.TB_HEADER[col]
-
-class DataTableList(DataList, DataCore):
-    HEADER_FILESTATUS = "File status"
-    HEADER_YEAR = "Year"
-    HEADER_AUTHOR = "Author"
-    HEADER_TITLE = "Title"
-    HEADER_TIMEMODIFY = "Time modified"
-    _HEADER_FUNCS = {
-        HEADER_FILESTATUS: lambda x: x.getFileStatusStr(),
-        HEADER_YEAR: lambda x: x.year,
-        HEADER_AUTHOR: lambda x: x.getAuthorsAbbr(),
-        HEADER_TITLE: lambda x: x.title,
-        HEADER_TIMEMODIFY: lambda x: TimeUtils.toStr(TimeUtils.stamp2Local(x.time_modified))
-    }
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.header_order = getConfV("table_headers")
-
-    def getTableItem(self, row: int, col: int) -> str:
-        data = self[row]
-        return DataTableList._HEADER_FUNCS[self.header_order[col]](data)
-
-    def getTableHeaderItem(self, col: int) -> str:
-        return self.header_order[col]
-
 class DataBase(Dict[str, DataPoint], DataCore):
     def __init__(self, local_path: Optional[str] = None, force_offline: bool = False):
         super().__init__()

lires/core/utils.py

@@ -283,7 +283,7 @@ def formatMarkdownHTML(md_html: str, abs_fpath: bool = True):
         html_template = string.Template(fp.read())
 
     USE_MATHJAX = False     # To determine if using latex equation, save bandwidth
-    for sign in ["$$", "\\("]:
+    for sign in ["$$", "\\(", "$"]:
         if sign in md_html:
             USE_MATHJAX = True
     if USE_MATHJAX:

lires/types/configT.py

@@ -1,19 +1,6 @@
 from __future__ import annotations
 from typing import Literal, Optional, Tuple, TypedDict, List, Union
 
-class _ConfServerPresetT(TypedDict):
-    host: str
-    port: str
-    access_key: str
-
-class _ConfFontSizeT(TypedDict):
-    data: Tuple[str, int]
-    tag: Tuple[str, int]
-
-class _ConfGUIStatusT(TypedDict):
-    show_toolbar: bool
-    tag_uncollapsed: List[str]
-
 class _ConfProxyT(TypedDict):
     proxy_config: _ProxyT
     enable_requests: bool
@@ -40,20 +27,4 @@ class LiresConfT(TypedDict):
     # PDFjs viewer for pdf render in qwebengine and webui
     # the path is suppose to be the viewer.html
     pdfjs_viewer_path: str
-
-    """GUI SETTINGS"""
-    server_preset: List[_ConfServerPresetT]
-    # Tag settings
-    default_tags: List[str]
-    table_headers: List[str]
-
-    # GUI settings
-    sort_method: str
-    sort_reverse: bool
-
-    font_sizes: _ConfFontSizeT
-    stylesheet: str
-    auto_save_comments: bool
-    gui_status: _ConfGUIStatusT
-
-    proxies: _ConfProxyT
+    proxies: _ConfProxyT

lires/version.yaml

@@ -444,3 +444,11 @@ version_history:
     - Refactors:
       - Better default arguments for datacard container
       - Record hover state in datacard container
+  
+  1.0.5:
+    - Deploy:
+      - Use docker-compose
+    - Refactor:
+      - Isolate qt gui configuration file
+      - Move bibtex templates into qt module
+      - Set name for each access key