Changeset ded6bb

Timestamp:

08/01/2009 02:26:26 AM (16 years ago)

Author:

Andrew Resch <andrewresch@gmail.com>

Branches:

2.0.x, develop, extjs4-port, master

Children:

9b0d4f

Parents:

838cef

Message:

Change the config format
Add test_config

Files:

• deluge/config.py (modified) (10 diffs)
• tests/common.py (modified) (1 diff)
• tests/test_config.py (added)

deluge/config.py

@@ -41 +41 @@
 really.
 
-The format of the config file is as follows:
-
-<format version as int>
-<config file version as int>
-<content>
-
-The format version is controlled by the Config class.  It should only be changed
-when anything below it is changed directly by the Config class.  An example of
-this would be if we changed the serializer for the content to something different.
+The format of the config file is two json encoded dicts:
+
+<version dict>
+<content dict>
+
+The version dict contains two keys: file and format.  The format version is 
+controlled by the Config class.  It should only be changed when anything below 
+it is changed directly by the Config class.  An example of this would be if we 
+changed the serializer for the content to something different.
 
 The config file version is changed by the 'owner' of the config file.  This is
@@ -91 +91 @@
     return property(doc=func.__doc__, **func())
 
+def find_json_objects(s):
+    """
+    Find json objects in a string.
+    
+    :param s: the string to find json objects in
+    :type s: string
+    
+    :returns: a list of tuples containing start and end locations of json objects in the string `s`
+    :rtype: [(start, end), ...]
+    
+    """
+    objects = []
+    opens = 0
+    start = s.find("{")
+    offset = start
+
+    if start < 0:
+        return []
+
+    for index, c in enumerate(s[offset:]):
+        if c == "{":
+            opens += 1
+        elif c == "}":
+            opens -= 1
+        if opens == 0:
+            objects.append((start, index+offset+1))
+            start = index + offset + 1
+
+    return objects
+    
+    
 class Config(object):
     """
@@ -106 +137 @@
 
         # These hold the version numbers and they will be set when loaded
-        self.__format_version = 1
-        self.__file_version = 1
+        self.__version = {
+            "format": 1,
+            "file": 1
+        }
 
         # This will get set with a reactor.callLater whenever a config option
         # is set.
-        self.__save_timer = None
+        self._save_timer = None
 
         if defaults:
@@ -135 +168 @@
         """
         Sets item 'key' to 'value' in the config dictionary, but does not allow
-        changing the item's type unless it is None
+        changing the item's type unless it is None.  If the types do not match,
+        it will attempt to convert it to the set type before raising a ValueError.
 
         :param key: string, item to change to change
         :param value: the value to change item to, must be same type as what is currently in the config
 
-        :raises ValueError: raised when the type of value is not the same as what is currently in the config
+        :raises ValueError: raised when the type of value is not the same as\
+what is currently in the config and it could not convert the value
 
         **Usage**
@@ -187 +222 @@
 
         # We set the save_timer for 5 seconds if not already set
-        if not self.__save_timer or not self.__save_timer.active():
-            self.__save_timer = reactor.callLater(5, self.save)
+        if not self._save_timer or not self._save_timer.active():
+            self._save_timer = reactor.callLater(5, self.save)
 
     def __getitem__(self, key):
@@ -305 +340 @@
 
         try:
-            data = open(filename, "rb")
+            data = open(filename, "rb").read()
         except IOError, e:
             log.warning("Unable to open config file %s: %s", filename, e)
             return
 
-        try:
-            self.__format_version = int(data.readline())
-        except ValueError:
-            data.seek(0)
-        else:
+        objects = find_json_objects(data)
+        
+        if not len(objects):
+            # No json objects found, try depickling it
             try:
-                self.__file_version = int(data.readline())
-            except ValueError:
-                pass
-
-        fdata = data.read()
-        data.close()
-
-        try:
-            self.__config.update(json.loads(fdata))
-        except Exception, e:
-            log.exception(e)
-            try:
-                self.__config.update(pickle.loads(fdata))
+                self.__config.update(pickle.loads(data))
             except Exception, e:
                 log.exception(e)
-                log.warning("Unable to load config file: %s", filename)
-
-
-
+                log.warning("Unable to load config file: %s", filename)                
+        elif len(objects) == 1:
+            start, end = objects[0]
+            try:
+                self.__config.update(json.loads(data[start:end]))
+            except Exception, e:
+                log.exception(e)
+                log.warning("Unable to load config file: %s", filename)                
+        elif len(objects) == 2:
+            try:
+                start, end = objects[0]
+                self.__version.update(json.loads(data[start:end]))
+                start, end = objects[1]
+                self.__config.update(json.loads(data[start:end]))
+            except Exception, e:
+                log.exception(e)
+                log.warning("Unable to load config file: %s", filename)                
+            
         log.debug("Config %s version: %s.%s loaded: %s", filename,
-            self.__format_version, self.__file_version, self.__config)
+            self.__version["format"], self.__version["file"], self.__config)
 
     def save(self, filename=None):
@@ -352 +388 @@
         # We will only write a new config file if there is a difference
         try:
-            data = open(filename, "rb")
-            data.readline()
-            data.readline()
-            loaded_data = json.loads(data.read())
-            data.close()
-            if self.__config == loaded_data:
+            data = open(filename, "rb").read()
+            objects = find_json_objects(data)
+            start, end = objects[0]
+            version = json.loads(data[start:end])
+            start, end = objects[1]
+            loaded_data = json.loads(data[start:end])
+
+            if self.__config == loaded_data and self.__version == version:
                 # The config has not changed so lets just return
-                self.__save_timer = None
+                self._save_timer = None
                 return
         except Exception, e:
             log.warning("Unable to open config file: %s", filename)
 
-        self.__save_timer = None
+        self._save_timer = None
 
         # Save the new config and make sure it's written to disk
@@ -370 +408 @@
             log.debug("Saving new config file %s", filename + ".new")
             f = open(filename + ".new", "wb")
-            f.write(str(self.__format_version) + "\n")
-            f.write(str(self.__file_version) + "\n")
+            json.dump(self.__version, f, indent=2)            
             json.dump(self.__config, f, indent=2)
             f.flush()
@@ -415 +452 @@
             raise ValueError("output_version needs to be greater than input_range")
 
-        if self.__file_version not in input_range:
+        if self.__version["file"] not in input_range:
             log.debug("File version %s is not in input_range %s, ignoring converter function..",
-                self.__file_version, input_range)
+                self.__version["file"], input_range)
             return
 
@@ -425 +462 @@
             log.exception(e)
             log.error("There was an exception try to convert config file %s %s to %s",
-                self.__config_file, self.__file_version, output_version)
+                self.__config_file, self.__version["file"], output_version)
             raise e
         else:
-            self.__file_version = output_version
+            self.__version["file"] = output_version
             self.save()
 

tests/common.py

@@ -9 +9 @@
     config_directory = tempfile.mkdtemp()
     deluge.configmanager.set_config_dir(config_directory)
+    return config_directory
 
 import gettext