Merge pull request #58 from robweber/gui_settings

Add limited system settings restore

README.txt

@@ -14,6 +14,17 @@ On the Backup Selection page you can select which items from your user profile f
 
 You can also define non-XBMC directories on your device. See "Custom Directories" for more information on how these are handled. 
 
+Restores:
+
+During the restore process there are a few checks and post-run procedures to know about. 
+
+The first is a version check. If you are restoring to a different version of XBMC than the one used to create the backup archive you'll get a warning. In most cases it is OK to proceed, just know that some specific items like addons and database files may not work correctly.
+
+The next check is for an advancedsettings.xml file. If you've created this file and it exists in your restore archive you'll be asked to reboot XBMC. This is so that the file can be loaded and used for any special settings, mainly path substitutions, you may have had that would affect the rest of the restore. XBMC Backup will prompt you to continue the restore process when you reboot the program. 
+
+The last bit of post-processing is done after all the backup files have been restored. If you have restored your configuration files the addon will attempt to restore any system specific settings that it can from the guisettings.xml file. This is done by comparing the restored file with settings via the JSONPRC Settings.SetSettingValue method. Only system specific settings can be restored so you will get any custom views or skin specific settings back. See the FAQ for how to restore these.  
+
+
 Scheduling: 
 
 You can schedule backups to be completed on a set interval via the scheduling area. When it is time for the backup to run it will be executed in the background. 
@@ -79,7 +90,7 @@ If you've created restore points with an older version of the addon (pre 0.3.6)
 
 Several settings aren't being restored, this includes views, weather, etc. How do I get these back? 
 
-GUISETTINGS.xml is a configuration file used heavily by XBMC for remembering GUI specific settings. Due to the fact that XBMC reads this file on startup, and writes from memory to this file on shutdown; it is not possible to restore this file while XBMC is running. You must manually move this file from your backup archives if you wish to restore it. User SouthMark has posted the following steps for restoring in the OpenELEC system where this is more difficult: 
+GUISETTINGS.xml is a configuration file used heavily by XBMC for remembering GUI specific settings. Due to the fact that XBMC reads this file on startup, and writes from memory to this file on shutdown; it is not possible to restore this file while XBMC is running. This addon attempts to restore what settings it can via the JSONRPC interface, however you will still most likely be missing your specific skin settings and view settings. To get these back you must manually move this file from your backup archives if you wish to restore it. User SouthMark has posted the following steps for restoring in the OpenELEC system where this is more difficult: 
 
 1. Run the restore of your backup
 2. SSH using putty to the IP Address of your media centre username: root Password openelec

addon.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <addon id="script.xbmcbackup"
-    name="XBMC Backup" version="0.5.8.6" provider-name="robweber">
+    name="XBMC Backup" version="0.5.8.7" provider-name="robweber">
   <requires>
     <import addon="xbmc.python" version="2.14.0"/>
   </requires>

changelog.txt

@@ -1,3 +1,7 @@
+Version 0.5.8.7
+
+allow limited updating of guisettings file through json
+
 Version 0.5.8.6
 
 show notification if some files failed

resources/lib/backup.py

@@ -5,6 +5,7 @@ import utils as utils
 import time
 import json
 from vfs import XBMCFileSystem,DropboxFileSystem,ZipFileSystem
+from resources.lib.guisettings import GuiSettingsManager
 
 def folderSort(aKey):
     result = aKey[0]
@@ -423,6 +424,11 @@ class XbmcBackup:
                 self.xbmc_vfs.rmfile(xbmc.translatePath("special://temp/" + self.restore_point))
                 self.xbmc_vfs.rmdir(self.remote_vfs.root_path)
 
+            if(utils.getSetting("backup_config") == "true"):
+                #update the guisettings information (or what we can from it)
+                gui_settings = GuiSettingsManager('special://home/userdata/guisettings.xml')
+                gui_settings.run()
+
             #call update addons to refresh everything
             xbmc.executebuiltin('UpdateLocalAddons')
 

resources/lib/guisettings.py

@@ -0,0 +1,96 @@
+import utils as utils
+from xml.dom import minidom
+from xml.parsers.expat import ExpatError
+import json
+import xbmc,xbmcvfs
+
+
+class GuiSettingsManager:
+    doc = None
+    settings_allowed = list()
+    found_settings = list()
+    
+    def __init__(self,settingsFile):
+        self._readFile(xbmc.translatePath(settingsFile))
+    
+    def run(self):
+        #get a list of all the settings we can manipulate via json
+        json_response = json.loads(xbmc.executeJSONRPC('{"jsonrpc":"2.0", "id":1, "method":"Settings.GetSettings","params":{"level":"advanced"}}'))
+        
+        settings = json_response['result']['settings']
+           
+        for aSetting in settings:
+            self.settings_allowed.append(aSetting['id'])
+            
+        #parse the existing xml file and get all the settings
+        root_nodes = self.__parseNodes(self.doc.documentElement)
+        
+        for aNode in root_nodes:
+            secondary_list = self.__parseNodes(self.doc.getElementsByTagName(aNode.name)[0])
+            
+            for secondNode in secondary_list:
+                #if the node does not have children and is not default
+                if(not secondNode.hasChildren and not secondNode.isDefault):
+                    
+                    if(secondNode.json_name() in self.settings_allowed):
+                        self.found_settings.append(secondNode)
+                    
+        #go through all the found settings and update them
+        for aSetting in self.found_settings:
+            utils.log("updating: " + aSetting.json_name() + ", value: " + aSetting.value)
+            
+            #check for boolean and numeric values
+            if(aSetting.value.isdigit() or (aSetting.value == 'true' or aSetting.value == 'false')):
+                xbmc.executeJSONRPC('{"jsonrpc":"2.0", "id":1, "method":"Settings.SetSettingValue","params":{"setting":"' + aSetting.json_name() + '","value":' + aSetting.value + '}}')
+            else:
+                xbmc.executeJSONRPC('{"jsonrpc":"2.0", "id":1, "method":"Settings.SetSettingValue","params":{"setting":"' + aSetting.json_name() + '","value":"' + aSetting.value + '"}}')
+            
+    def __parseNodes(self,nodeList):
+        result = []
+
+        for node in nodeList.childNodes:
+            if(node.nodeType == self.doc.ELEMENT_NODE):
+                aSetting = SettingNode(node.nodeName)
+
+                #detect if there are any element nodes
+                if(len(node.childNodes) > 0):
+                    for child_node in node.childNodes:
+                        if(child_node.nodeType == self.doc.ELEMENT_NODE):
+                            aSetting.hasChildren = True
+
+                if(not aSetting.hasChildren and len(node.childNodes) > 0):
+                    aSetting.value = node.firstChild.nodeValue
+                    
+                    if('default' not in node.attributes.keys()):
+                        aSetting.isDefault = False
+                        
+                aSetting.parent = node.parentNode.nodeName
+                
+                result.append(aSetting)
+        return result
+    
+    
+    def _readFile(self,fileLoc):
+        
+        if(xbmcvfs.exists(fileLoc)):
+            
+            try:
+                
+                self.doc = minidom.parse(fileLoc)
+            except ExpatError:
+                utils.log("Can't read " + fileLoc)
+                
+class SettingNode:
+    name = ''
+    value = ''
+    hasChildren = False
+    isDefault = True
+    parent = ''
+    
+    def __init__(self,name):
+        self.name = name
+        
+    def json_name(self):
+        return self.parent + "." + self.name
+                
+