Merge pull request #467 from willmiao/codex/migrate-frontend-settings-to-backend

feat(settings): centralize settings loading and snake_case keys

py/routes/misc_routes.py

@@ -179,7 +179,7 @@ class MiscRoutes:
             # Define keys that should be synced from backend to frontend
             sync_keys = [
                 'civitai_api_key',
-                'default_lora_root', 
+                'default_lora_root',
                 'default_checkpoint_root',
                 'default_embedding_root',
                 'base_model_path_mappings',
@@ -193,8 +193,15 @@ class MiscRoutes:
                 'proxy_username',
                 'proxy_password',
                 'example_images_path',
-                'optimizeExampleImages',
-                'autoDownloadExampleImages'
+                'optimize_example_images',
+                'auto_download_example_images',
+                'blur_mature_content',
+                'autoplay_on_hover',
+                'display_density',
+                'card_info_display',
+                'include_trigger_words',
+                'show_only_sfw',
+                'compact_mode'
             ]
             
             # Build response with only the keys that should be synced

py/services/settings_manager.py

@@ -5,10 +5,41 @@ from typing import Any, Dict
 
 logger = logging.getLogger(__name__)
 
+
+DEFAULT_SETTINGS: Dict[str, Any] = {
+    "civitai_api_key": "",
+    "language": "en",
+    "show_only_sfw": False,
+    "enable_metadata_archive_db": False,
+    "proxy_enabled": False,
+    "proxy_host": "",
+    "proxy_port": "",
+    "proxy_username": "",
+    "proxy_password": "",
+    "proxy_type": "http",
+    "default_lora_root": "",
+    "default_checkpoint_root": "",
+    "default_embedding_root": "",
+    "base_model_path_mappings": {},
+    "download_path_templates": {},
+    "example_images_path": "",
+    "optimize_example_images": True,
+    "auto_download_example_images": False,
+    "blur_mature_content": True,
+    "autoplay_on_hover": False,
+    "display_density": "default",
+    "card_info_display": "always",
+    "include_trigger_words": False,
+    "compact_mode": False,
+}
+
+
 class SettingsManager:
     def __init__(self):
         self.settings_file = os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(__file__))), 'settings.json')
         self.settings = self._load_settings()
+        self._migrate_setting_keys()
+        self._ensure_default_settings()
         self._migrate_download_path_template()
         self._auto_set_default_roots()
         self._check_environment_variables()
@@ -23,11 +54,49 @@ class SettingsManager:
                 logger.error(f"Error loading settings: {e}")
         return self._get_default_settings()
 
+    def _ensure_default_settings(self) -> None:
+        """Ensure all default settings keys exist"""
+        updated = False
+        for key, value in self._get_default_settings().items():
+            if key not in self.settings:
+                if isinstance(value, dict):
+                    self.settings[key] = value.copy()
+                else:
+                    self.settings[key] = value
+                updated = True
+        if updated:
+            self._save_settings()
+
+    def _migrate_setting_keys(self) -> None:
+        """Migrate legacy camelCase setting keys to snake_case"""
+        key_migrations = {
+            'optimizeExampleImages': 'optimize_example_images',
+            'autoDownloadExampleImages': 'auto_download_example_images',
+            'blurMatureContent': 'blur_mature_content',
+            'autoplayOnHover': 'autoplay_on_hover',
+            'displayDensity': 'display_density',
+            'cardInfoDisplay': 'card_info_display',
+            'includeTriggerWords': 'include_trigger_words',
+            'compactMode': 'compact_mode',
+        }
+
+        updated = False
+        for old_key, new_key in key_migrations.items():
+            if old_key in self.settings:
+                if new_key not in self.settings:
+                    self.settings[new_key] = self.settings[old_key]
+                del self.settings[old_key]
+                updated = True
+
+        if updated:
+            logger.info("Migrated legacy setting keys to snake_case")
+            self._save_settings()
+
     def _migrate_download_path_template(self):
         """Migrate old download_path_template to new download_path_templates"""
         old_template = self.settings.get('download_path_template')
         templates = self.settings.get('download_path_templates')
-        
+
         # If old template exists and new templates don't exist, migrate
         if old_template is not None and not templates:
             logger.info("Migrating download_path_template to download_path_templates")
@@ -78,18 +147,11 @@ class SettingsManager:
 
     def _get_default_settings(self) -> Dict[str, Any]:
         """Return default settings"""
-        return {
-            "civitai_api_key": "",
-            "language": "en",
-            "show_only_sfw": False,  # Show only SFW content
-            "enable_metadata_archive_db": False,  # Enable metadata archive database
-            "proxy_enabled": False,  # Enable app-level proxy
-            "proxy_host": "",  # Proxy host
-            "proxy_port": "",  # Proxy port  
-            "proxy_username": "",  # Proxy username (optional)
-            "proxy_password": "",  # Proxy password (optional)
-            "proxy_type": "http"  # Proxy type: http, https, socks4, socks5
-        }
+        defaults = DEFAULT_SETTINGS.copy()
+        # Ensure nested dicts are independent copies
+        defaults['base_model_path_mappings'] = {}
+        defaults['download_path_templates'] = {}
+        return defaults
 
     def get(self, key: str, default: Any = None) -> Any:
         """Get setting value"""