feat(example_images): add dedicated folder check and update settings handling for example images path, see #431

py/routes/misc_routes.py

@@ -4,6 +4,7 @@ import sys
 import threading
 import asyncio
 import subprocess
+import re
 from server import PromptServer # type: ignore
 from aiohttp import web
 from ..services.settings_manager import settings
@@ -85,6 +86,54 @@ node_registry = NodeRegistry()
 class MiscRoutes:
     """Miscellaneous routes for various utility functions"""
     
+    @staticmethod
+    def is_dedicated_example_images_folder(folder_path):
+        """
+        Check if a folder is a dedicated example images folder.
+        
+        A dedicated folder should either be:
+        1. Empty
+        2. Only contain .download_progress.json file and/or folders with valid SHA256 hash names (64 hex characters)
+        
+        Args:
+            folder_path (str): Path to the folder to check
+            
+        Returns:
+            bool: True if the folder is dedicated, False otherwise
+        """
+        try:
+            if not os.path.exists(folder_path) or not os.path.isdir(folder_path):
+                return False
+            
+            items = os.listdir(folder_path)
+            
+            # Empty folder is considered dedicated
+            if not items:
+                return True
+            
+            # Check each item in the folder
+            for item in items:
+                item_path = os.path.join(folder_path, item)
+                
+                # Allow .download_progress.json file
+                if item == '.download_progress.json' and os.path.isfile(item_path):
+                    continue
+                
+                # Allow folders with valid SHA256 hash names (64 hex characters)
+                if os.path.isdir(item_path):
+                    # Check if the folder name is a valid SHA256 hash
+                    if re.match(r'^[a-fA-F0-9]{64}$', item):
+                        continue
+                
+                # If we encounter anything else, it's not a dedicated folder
+                return False
+            
+            return True
+            
+        except Exception as e:
+            logger.error(f"Error checking if folder is dedicated: {e}")
+            return False
+    
     @staticmethod
     def setup_routes(app):
         """Register miscellaneous routes"""
@@ -180,7 +229,7 @@ class MiscRoutes:
                 if value == settings.get(key):
                     # No change, skip
                     continue
-                # Special handling for example_images_path - verify path exists
+                # Special handling for example_images_path - verify path exists and is dedicated
                 if key == 'example_images_path' and value:
                     if not os.path.exists(value):
                         return web.json_response({
@@ -188,6 +237,13 @@ class MiscRoutes:
                             'error': f"Path does not exist: {value}"
                         })
                     
+                    # Check if folder is dedicated for example images
+                    if not MiscRoutes.is_dedicated_example_images_folder(value):
+                        return web.json_response({
+                            'success': False,
+                            'error': "Please set a dedicated folder for example images."
+                        })
+                    
                     # Path changed - server restart required for new path to take effect
                     old_path = settings.get('example_images_path')
                     if old_path != value:

py/utils/example_images_download_manager.py

@@ -40,10 +40,10 @@ class DownloadManager:
         
         Expects a JSON body with:
         {
-            "output_dir": "path/to/output",  # Base directory to save example images
             "optimize": true,                # Whether to optimize images (default: true)
             "model_types": ["lora", "checkpoint"], # Model types to process (default: both)
-            "delay": 1.0                     # Delay between downloads to avoid rate limiting (default: 1.0)
+            "delay": 1.0,                    # Delay between downloads to avoid rate limiting (default: 1.0)
+            "auto_mode": false               # Flag to indicate automatic download (default: false)
         }
         """
         global download_task, is_downloading, download_progress
@@ -64,16 +64,30 @@ class DownloadManager:
         try:
             # Parse the request body
             data = await request.json()
-            output_dir = data.get('output_dir')
+            auto_mode = data.get('auto_mode', False)
             optimize = data.get('optimize', True)
             model_types = data.get('model_types', ['lora', 'checkpoint'])
             delay = float(data.get('delay', 0.2)) # Default to 0.2 seconds
             
+            # Get output directory from settings
+            from ..services.service_registry import ServiceRegistry
+            settings_manager = await ServiceRegistry.get_settings_manager()
+            output_dir = settings_manager.get('example_images_path')
+            
             if not output_dir:
-                return web.json_response({
-                    'success': False,
-                    'error': 'Missing output_dir parameter'
-                }, status=400)
+                error_msg = 'Example images path not configured in settings'
+                if auto_mode:
+                    # For auto mode, just log and return success to avoid showing error toasts
+                    logger.debug(error_msg)
+                    return web.json_response({
+                        'success': True,
+                        'message': 'Example images path not configured, skipping auto download'
+                    })
+                else:
+                    return web.json_response({
+                        'success': False,
+                        'error': error_msg
+                    }, status=400)
             
             # Create the output directory
             os.makedirs(output_dir, exist_ok=True)
@@ -426,7 +440,6 @@ class DownloadManager:
         Expects a JSON body with:
         {
             "model_hashes": ["hash1", "hash2", ...],  # List of model hashes to download
-            "output_dir": "path/to/output",           # Base directory to save example images
             "optimize": true,                         # Whether to optimize images (default: true)
             "model_types": ["lora", "checkpoint"],    # Model types to process (default: both)
             "delay": 1.0                              # Delay between downloads (default: 1.0)
@@ -444,7 +457,6 @@ class DownloadManager:
             # Parse the request body
             data = await request.json()
             model_hashes = data.get('model_hashes', [])
-            output_dir = data.get('output_dir')
             optimize = data.get('optimize', True)
             model_types = data.get('model_types', ['lora', 'checkpoint'])
             delay = float(data.get('delay', 0.2)) # Default to 0.2 seconds
@@ -454,11 +466,16 @@ class DownloadManager:
                     'success': False,
                     'error': 'Missing model_hashes parameter'
                 }, status=400)
-                
+            
+            # Get output directory from settings
+            from ..services.service_registry import ServiceRegistry
+            settings_manager = await ServiceRegistry.get_settings_manager()
+            output_dir = settings_manager.get('example_images_path')
+            
             if not output_dir:
                 return web.json_response({
                     'success': False,
-                    'error': 'Missing output_dir parameter'
+                    'error': 'Example images path not configured in settings'
                 }, status=400)
             
             # Create the output directory