v1.4.1.5 - Enhanced logging for easier debugging

Nigel · Nigel · commit 8f2ae3b066d8 · 2026-01-05T03:58:08.000+01:00
- Added comprehensive logging throughout the application
- Enhanced logging in backup_utils.py for backup operations
- Enhanced logging in remote_browser.py for connection testing
- Enhanced logging in addon.py for UI operations
- Improved error messages and debugging information
- Updated release notes to mention enhanced logging
diff --git a/release_notes_1.4.1.5.md b/release_notes_1.4.1.5.md
@@ -38,6 +38,7 @@
 2. **Path Validation**: Prevents invalid paths from causing silent failures
 3. **User Experience**: Clear feedback and proper dialog flows
 4. **Error Handling**: Comprehensive error handling for all operations
+5. **Enhanced Logging**: Detailed logging throughout the application for easier debugging and troubleshooting
 
 ## Testing
 
diff --git a/service.libreelec.backupper/addon.py b/service.libreelec.backupper/addon.py
@@ -30,17 +30,25 @@ def __init__(self):
     def show_backups(self, mode='view'):
         """Display a list of available backups for selection
         mode: 'view' for viewing/listing, 'restore' for selecting to restore"""
+        xbmc.log(f"BackupBrowser: Showing backups in {mode} mode", xbmc.LOGINFO)
+
         # Get list of available backups
+        xbmc.log("BackupBrowser: Retrieving backup list...", xbmc.LOGDEBUG)
         backups = self.backup_utils.get_all_backups()
+        xbmc.log(f"BackupBrowser: Found {len(backups)} backups", xbmc.LOGINFO)
+
         if not backups:
+            xbmc.log("BackupBrowser: No backup files found", xbmc.LOGWARNING)
             xbmcgui.Dialog().ok(ADDON_NAME, "No backup files found")
             return
 
         # Create backup options with detailed information
+        xbmc.log("BackupBrowser: Processing backup list...", xbmc.LOGDEBUG)
         backup_options = []
         for backup in backups:
             try:
                 backup_name = os.path.basename(backup)
+                xbmc.log(f"BackupBrowser: Processing backup: {backup_name}", xbmc.LOGDEBUG)
 
                 # Get backup date from filename (format: backup_items_timestamp.zip)
                 # Extract timestamp from filename
@@ -70,7 +78,8 @@ def show_backups(self, mode='view'):
                             backup_date = "Unknown date"
                     else:
                         backup_date = "Unknown date"
-                except:
+                except Exception as e:
+                    xbmc.log(f"BackupBrowser: Error parsing backup date for {backup_name}: {str(e)}", xbmc.LOGWARNING)
                     backup_date = "Unknown date"
 
                 # Get backup size
@@ -81,7 +90,8 @@ def show_backups(self, mode='view'):
                         # For remote backups, size info may not be available
                         backup_size = 0
                     backup_size_formatted = self.backup_utils.format_size(backup_size)
-                except:
+                except Exception as e:
+                    xbmc.log(f"BackupBrowser: Error getting backup size for {backup_name}: {str(e)}", xbmc.LOGWARNING)
                     backup_size_formatted = "Unknown size"
 
                 # Create display string
@@ -90,40 +100,55 @@ def show_backups(self, mode='view'):
                     display_name += f" ({backup_size_formatted})"
 
                 backup_options.append((display_name, backup))
+                xbmc.log(f"BackupBrowser: Added backup option: {display_name}", xbmc.LOGDEBUG)
             except Exception as e:
-                xbmc.log(f"Error processing backup {backup}: {str(e)}", xbmc.LOGERROR)
+                xbmc.log(f"BackupBrowser: Error processing backup {backup}: {str(e)}", xbmc.LOGERROR)
                 continue
 
+        xbmc.log(f"BackupBrowser: Created {len(backup_options)} backup options", xbmc.LOGINFO)
+
         if not backup_options:
+            xbmc.log("BackupBrowser: No valid backup options created", xbmc.LOGWARNING)
             xbmcgui.Dialog().ok(ADDON_NAME, "No valid backup files found")
             return
 
         # Show dialog to select backup
         dialog = xbmcgui.Dialog()
         title = "Select backup to restore" if mode == 'restore' else "Available backups"
+        xbmc.log(f"BackupBrowser: Showing selection dialog with title: {title}", xbmc.LOGINFO)
         selected = dialog.select(title, [opt[0] for opt in backup_options])
 
         if selected == -1:  # User cancelled
+            xbmc.log("BackupBrowser: User cancelled backup selection", xbmc.LOGINFO)
             return
 
         selected_backup = backup_options[selected][1]
+        selected_display = backup_options[selected][0]
+        xbmc.log(f"BackupBrowser: User selected backup: {selected_display}", xbmc.LOGINFO)
 
         if mode == 'restore':
             # Confirm restore
+            xbmc.log("BackupBrowser: Showing restore confirmation dialog", xbmc.LOGDEBUG)
             confirmed = dialog.yesno(
                 ADDON_NAME,
                 f"Restore backup: {os.path.basename(selected_backup)}?",
                 "This will overwrite existing files. Continue?"
             )
 
             if confirmed:
+                xbmc.log(f"BackupBrowser: Starting backup restoration: {selected_backup}", xbmc.LOGINFO)
                 success, message = self.backup_utils.restore_backup(selected_backup)
                 if success:
+                    xbmc.log("BackupBrowser: Backup restoration completed successfully", xbmc.LOGINFO)
                     dialog.ok(ADDON_NAME, "Backup restored successfully")
                 else:
+                    xbmc.log(f"BackupBrowser: Backup restoration failed: {message}", xbmc.LOGERROR)
                     dialog.ok(ADDON_NAME, f"Failed to restore backup: {message}")
+            else:
+                xbmc.log("BackupBrowser: User cancelled backup restoration", xbmc.LOGINFO)
         else:
             # For view mode, just show backup info
+            xbmc.log("BackupBrowser: Showing backup information dialog", xbmc.LOGDEBUG)
             dialog.ok(ADDON_NAME, f"Backup: {os.path.basename(selected_backup)}")
 
 def show_main_menu():
diff --git a/service.libreelec.backupper/resources/lib/backup_utils.py b/service.libreelec.backupper/resources/lib/backup_utils.py
@@ -48,37 +48,56 @@ def __init__(self, addon=None):
     
     def update_backup_location(self):
         """Update backup location from settings"""
+        xbmc.log("BackupManager: Updating backup location settings", xbmc.LOGINFO)
+
         # Get backup location type from settings
         self.location_type = int(self.addon.getSetting('backup_location_type') or "0")
-        
+        xbmc.log(f"BackupManager: Location type = {self.location_type} (0=Local, 1=Remote)", xbmc.LOGINFO)
+
         # Define paths for various Kodi directories
         self.kodi_home = xbmcvfs.translatePath('special://home')
         self.kodi_userdata = xbmcvfs.translatePath('special://userdata')
-        
+        xbmc.log(f"BackupManager: Kodi paths - home: {self.kodi_home}, userdata: {self.kodi_userdata}", xbmc.LOGDEBUG)
+
         # Initialize backup_dir
         self.backup_dir = None
-        
+
         # Handle local backup location
         if self.location_type == 0:  # Local
             self.backup_dir = self.addon.getSetting('backup_location')
+            xbmc.log(f"BackupManager: Local backup location setting: {self.backup_dir}", xbmc.LOGINFO)
+
             if not self.backup_dir:
                 self.backup_dir = "/storage/backup"  # Default location
-            
+                xbmc.log("BackupManager: Using default local backup location: /storage/backup", xbmc.LOGINFO)
+
             # Validate that local path doesn't contain network protocols or remote path formats
             if self.backup_dir and (self.backup_dir.startswith(('nfs:', 'smb:', 'ftp:', 'sftp:', 'http:', 'https:')) or '://' in self.backup_dir or ':' in self.backup_dir):
-                xbmc.log(f"Invalid local path detected (contains network protocol or remote path format): {self.backup_dir}", xbmc.LOGWARNING)
+                xbmc.log(f"BackupManager: Invalid local path detected (contains network protocol or remote path format): {self.backup_dir}", xbmc.LOGWARNING)
                 # Reset to default if invalid
                 self.backup_dir = "/storage/backup"
                 self.addon.setSetting('backup_location', self.backup_dir)
-                xbmc.log(f"Reset backup location to default: {self.backup_dir}", xbmc.LOGINFO)
+                xbmc.log("BackupManager: Reset backup location to default: /storage/backup", xbmc.LOGINFO)
+            else:
+                xbmc.log(f"BackupManager: Local backup directory validated: {self.backup_dir}", xbmc.LOGINFO)
         else:  # Remote
+            xbmc.log("BackupManager: Configuring remote backup settings", xbmc.LOGINFO)
+
             # Get remote settings
             self.remote_type = int(self.addon.getSetting('remote_location_type') or "0")
             self.remote_path = self.addon.getSetting('remote_path')
             self.remote_username = self.addon.getSetting('remote_username')
-            self.remote_password = self.addon.getSetting('remote_password')
+            # Don't log password for security
             self.remote_port = int(self.addon.getSetting('remote_port') or "0")
-            
+
+            remote_type_names = ["SMB", "NFS", "FTP", "SFTP", "WebDAV"]
+            remote_type_name = remote_type_names[self.remote_type] if self.remote_type < len(remote_type_names) else f"Unknown({self.remote_type})"
+
+            xbmc.log(f"BackupManager: Remote type = {self.remote_type} ({remote_type_name})", xbmc.LOGINFO)
+            xbmc.log(f"BackupManager: Remote path = {self.remote_path}", xbmc.LOGINFO)
+            xbmc.log(f"BackupManager: Remote username = {self.remote_username}", xbmc.LOGINFO)
+            xbmc.log(f"BackupManager: Remote port = {self.remote_port}", xbmc.LOGINFO)
+
             # Set default ports if not specified
             if self.remote_port == 0:
                 if self.remote_type == 0:  # SMB
@@ -91,21 +110,28 @@ def update_backup_location(self):
                     self.remote_port = 22
                 elif self.remote_type == 4:  # WebDAV
                     self.remote_port = 80
-            
+                xbmc.log(f"BackupManager: Set default port for {remote_type_name}: {self.remote_port}", xbmc.LOGINFO)
+
             # Create a temporary local directory for staging remote files
             self.backup_dir = os.path.join(xbmcvfs.translatePath('special://temp'), 'libreelec_backupper')
-        
+            xbmc.log(f"BackupManager: Remote staging directory: {self.backup_dir}", xbmc.LOGINFO)
+
         # Ensure backup directory exists (only for remote backups where we create temp dirs)
         if self.location_type != 0:  # Remote
             if self.backup_dir and not os.path.exists(self.backup_dir):
                 try:
                     os.makedirs(self.backup_dir)
+                    xbmc.log(f"BackupManager: Created staging directory: {self.backup_dir}", xbmc.LOGINFO)
                 except Exception as e:
-                    xbmc.log(f"Error creating backup directory: {str(e)}", xbmc.LOGERROR)
+                    xbmc.log(f"BackupManager: Error creating backup directory: {str(e)}", xbmc.LOGERROR)
                     # Fall back to addon profile if custom location can't be created
                     self.backup_dir = xbmcvfs.translatePath(self.addon.getAddonInfo('profile'))
+                    xbmc.log(f"BackupManager: Falling back to addon profile directory: {self.backup_dir}", xbmc.LOGWARNING)
                     if not os.path.exists(self.backup_dir):
                         os.makedirs(self.backup_dir)
+                        xbmc.log("BackupManager: Created fallback directory", xbmc.LOGINFO)
+
+        xbmc.log(f"BackupManager: Final backup directory: {self.backup_dir}", xbmc.LOGINFO)
     
     def _create_webdav_session(self):
         """Create a WebDAV session with retry logic and connection pooling"""
diff --git a/service.libreelec.backupper/resources/lib/remote_browser.py b/service.libreelec.backupper/resources/lib/remote_browser.py
@@ -39,16 +39,22 @@ def __init__(self):
     
     def reload_settings(self):
         """Reload settings from Kodi"""
+        xbmc.log("RemoteBrowser: Reloading settings from Kodi", xbmc.LOGINFO)
+
         # Force reload of addon to get fresh settings
         global ADDON
         ADDON = xbmcaddon.Addon()
-        
+
         self.remote_type = int(ADDON.getSetting('remote_location_type'))
         self.remote_path = ADDON.getSetting('remote_path')
         self.username = ADDON.getSetting('remote_username')
-        self.password = ADDON.getSetting('remote_password')
+        # Don't log password for security
         self.port = ADDON.getSetting('remote_port')
-        
+
+        xbmc.log(f"RemoteBrowser: Remote type = {self.remote_type}", xbmc.LOGINFO)
+        xbmc.log(f"RemoteBrowser: Remote path = {self.remote_path}", xbmc.LOGINFO)
+        xbmc.log(f"RemoteBrowser: Username = {self.username}", xbmc.LOGINFO)
+
         # Default ports if not specified
         self.default_ports = {
             0: 445,  # SMB
@@ -57,9 +63,14 @@ def reload_settings(self):
             3: 22,   # SFTP
             4: 80    # WebDAV
         }
-        
+
         if not self.port:
             self.port = str(self.default_ports.get(self.remote_type, 0))
+            xbmc.log(f"RemoteBrowser: Set default port: {self.port}", xbmc.LOGINFO)
+        else:
+            xbmc.log(f"RemoteBrowser: Using configured port: {self.port}", xbmc.LOGINFO)
+
+        xbmc.log("RemoteBrowser: Settings reloaded successfully", xbmc.LOGINFO)
     
     def browse(self, mode='backup'):
         """Main method to browse remote locations based on type
