create Preferences DB table

Author: yedpodtrzitko

tagstudio/src/core/constants.py

@@ -1,3 +1,6 @@
+from enum import Enum, StrEnum
+
+
 VERSION: str = "9.3.2"  # Major.Minor.Patch
 VERSION_BRANCH: str = ""  # Usually "" or "Pre-Release"
 
@@ -126,3 +129,8 @@
 
 TAG_FAVORITE = 1
 TAG_ARCHIVED = 0
+
+
+class PREFS(Enum):
+    IS_EXCLUDE_LIST = False
+    EXTENSION_LIST: list[str] = []

tagstudio/src/core/library/alchemy/library.py

@@ -24,8 +24,8 @@
     TextField,
 )
 from .joins import TagField, TagSubtag
-from .models import Entry, Tag, TagAlias
-from ...constants import TS_FOLDER_NAME, TAG_ARCHIVED, TAG_FAVORITE
+from .models import Entry, Preferences, Tag, TagAlias
+from ...constants import PREFS, TS_FOLDER_NAME, TAG_ARCHIVED, TAG_FAVORITE
 
 LIBRARY_FILENAME: str = "ts_library.sqlite"
 
@@ -77,8 +77,6 @@ class Library:
     dupe_files: list[str]
     engine: Engine | None
     dupe_entries: list[Entry]  # TODO
-    ext_list: list[str]  # TODO
-    is_exclude_list: bool  # TODO
 
     def __init__(self):
         self.clear_internal_vars()
@@ -99,8 +97,7 @@ def open_library(self, library_dir: Path | str) -> None:
 
         logger.info("opening library", connection_string=connection_string)
         self.engine = create_engine(connection_string)
-        session = Session(self.engine)
-        with session.begin():
+        with Session(self.engine) as session:
             make_tables(self.engine)
 
             tags = get_default_tags()
@@ -109,7 +106,15 @@ def open_library(self, library_dir: Path | str) -> None:
                 session.commit()
             except IntegrityError:
                 # default tags may exist already
-                pass
+                session.rollback()
+
+            for pref in PREFS:
+                try:
+                    session.add(Preferences(key=pref.name, value=pref.value))
+                    session.commit()
+                except IntegrityError:
+                    logger.error("pref already exists", pref=pref)
+                    session.rollback()
 
     def delete_item(self, item):
         logger.info("deleting item", item=item)
@@ -736,3 +741,22 @@ def mirror_entry_fields(self, items: list):
 
     def merge_dupe_entries(self):
         logger.error("merge_dupe_entries to be implemented")
+
+    def prefs(self, key: PREFS) -> Any:
+        # load given item from Preferences table
+        with Session(self.engine) as session:
+            return session.scalar(
+                select(Preferences).where(Preferences.key == key.name)
+            ).value
+
+    def set_prefs(self, key: PREFS, value: Any) -> None:
+        # set given item in Preferences table
+        with Session(self.engine) as session:
+            # load existing preference and update value
+            pref = session.scalar(
+                select(Preferences).where(Preferences.key == key.name)
+            )
+            pref.value = value
+            session.add(pref)
+            session.commit()
+            # TODO - try/except

tagstudio/src/core/library/alchemy/models.py

@@ -1,7 +1,7 @@
 from pathlib import Path
-from typing import Optional
+from typing import Any, Optional
 
-from sqlalchemy import ForeignKey
+from sqlalchemy import JSON, ForeignKey
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
 from .db import Base
@@ -183,3 +183,15 @@ def remove_tag(self, tag: Tag, field: TagBoxField | None = None) -> None:
 
         for tag_box_field in self.tag_box_fields:
             tag_box_field.tags.remove(tag)
+
+
+class Preferences(Base):
+    __tablename__ = "preferences"
+
+    key: Mapped[str] = mapped_column(primary_key=True)
+    value: Mapped[dict] = mapped_column(JSON, nullable=False)
+
+    def __init__(self, key: str, value: Any) -> None:
+        self.key = key
+        self.value = value
+        super().__init__()

tagstudio/src/qt/modals/file_extension.py

@@ -19,6 +19,7 @@
 
 from src.core.library import Library
 from src.qt.widgets.panel import PanelWidget
+from src.core.constants import PREFS
 
 
 class FileExtensionItemDelegate(QStyledItemDelegate):
@@ -43,7 +44,7 @@ def __init__(self, library: "Library"):
         self.root_layout.setContentsMargins(6, 6, 6, 6)
 
         # Create Table Widget --------------------------------------------------
-        self.table = QTableWidget(len(self.lib.ext_list), 1)
+        self.table = QTableWidget(len(self.lib.prefs(PREFS.EXTENSION_LIST)), 1)
         self.table.horizontalHeader().setVisible(False)
         self.table.verticalHeader().setVisible(False)
         self.table.horizontalHeader().setStretchLastSection(True)
@@ -65,9 +66,12 @@ def __init__(self, library: "Library"):
         self.mode_label.setText("List Mode:")
         self.mode_combobox = QComboBox()
         self.mode_combobox.setEditable(False)
-        self.mode_combobox.addItem("Exclude")
         self.mode_combobox.addItem("Include")
-        self.mode_combobox.setCurrentIndex(0 if self.lib.is_exclude_list else 1)
+        self.mode_combobox.addItem("Exclude")
+
+        is_exclude_list = int(bool(self.lib.prefs(PREFS.IS_EXCLUDE_LIST)))
+
+        self.mode_combobox.setCurrentIndex(is_exclude_list)
         self.mode_combobox.currentIndexChanged.connect(
             lambda i: self.update_list_mode(i)
         )
@@ -91,23 +95,23 @@ def update_list_mode(self, mode: int):
 
         Args:
             mode (int): The list mode, given by the index of the mode inside
-                the mode combobox. 0 for "Exclude", 1 for "Include".
+                the mode combobox. True for "Exclude", False for "Include".
         """
-        if mode == 0:
-            self.lib.is_exclude_list = True
-        elif mode == 1:
-            self.lib.is_exclude_list = False
+        self.lib.set_prefs(PREFS.IS_EXCLUDE_LIST, bool(mode))
 
     def refresh_list(self):
-        for i, ext in enumerate(self.lib.ext_list):
+        for i, ext in enumerate(self.lib.prefs(PREFS.EXTENSION_LIST)):
             self.table.setItem(i, 0, QTableWidgetItem(ext))
 
     def add_item(self):
         self.table.insertRow(self.table.rowCount())
 
     def save(self):
-        self.lib.ext_list.clear()
+        extensions = []
         for i in range(self.table.rowCount()):
             ext = self.table.item(i, 0)
-            if ext and ext.text():
-                self.lib.ext_list.append(ext.text().lower())
+            if ext and ext.text().strip():
+                extensions.append(ext.text().strip().lower())
+
+        # save preference
+        self.lib.set_prefs(PREFS.EXTENSION_LIST, extensions)

tagstudio/src/qt/ts_qt.py

@@ -367,9 +367,7 @@ def start(self) -> None:
         edit_menu.addSeparator()
 
         manage_file_extensions_action = QAction("Manage File Extensions", menu_bar)
-        manage_file_extensions_action.triggered.connect(
-            lambda: self.show_file_extension_modal()
-        )
+        manage_file_extensions_action.triggered.connect(self.show_file_extension_modal)
         edit_menu.addAction(manage_file_extensions_action)
 
         tag_database_action = QAction("Manage Tags", menu_bar)