mirrors/deluge
0
0
Fork 0
mirror of https://git.deluge-torrent.org/deluge synced 2025-08-02 22:48:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix #1341 issue where Config would try to cancel the save_timer when it is None.

Browse source
This commit is contained in:
Andrew Resch 2010-08-18 12:32:11 -07:00
commit d93fcf6eea
2 changed files with 46 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

40
deluge/config.py
View file

@ -45,9 +45,9 @@ The format of the config file is two json encoded dicts:
<version dict> <version dict>
<content dict> <content dict>
The version dict contains two keys: file and format. The format version is 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 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 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. changed the serializer for the content to something different.
The config file version is changed by the 'owner' of the config file. This is The config file version is changed by the 'owner' of the config file. This is
@ -93,13 +93,13 @@ def prop(func):
def find_json_objects(s): def find_json_objects(s):
""" """
Find json objects in a string. Find json objects in a string.
:param s: the string to find json objects in :param s: the string to find json objects in
:type s: string :type s: string
:returns: a list of tuples containing start and end locations of json objects in the string `s` :returns: a list of tuples containing start and end locations of json objects in the string `s`
:rtype: [(start, end), ...] :rtype: [(start, end), ...]
""" """
objects = [] objects = []
opens = 0 opens = 0
@ -119,8 +119,8 @@ def find_json_objects(s):
start = index + offset + 1 start = index + offset + 1
return objects return objects
class Config(object): class Config(object):
""" """
This class is used to access/create/modify config files This class is used to access/create/modify config files
@ -348,21 +348,21 @@ what is currently in the config and it could not convert the value
return return
objects = find_json_objects(data) objects = find_json_objects(data)
if not len(objects): if not len(objects):
# No json objects found, try depickling it # No json objects found, try depickling it
try: try:
self.__config.update(pickle.loads(data)) self.__config.update(pickle.loads(data))
except Exception, e: except Exception, e:
log.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: elif len(objects) == 1:
start, end = objects[0] start, end = objects[0]
try: try:
self.__config.update(json.loads(data[start:end])) self.__config.update(json.loads(data[start:end]))
except Exception, e: except Exception, e:
log.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) == 2: elif len(objects) == 2:
try: try:
start, end = objects[0] start, end = objects[0]
@ -371,8 +371,8 @@ what is currently in the config and it could not convert the value
self.__config.update(json.loads(data[start:end])) self.__config.update(json.loads(data[start:end]))
except Exception, e: except Exception, e:
log.exception(e) log.exception(e)
log.warning("Unable to load config file: %s", filename) log.warning("Unable to load config file: %s", filename)
log.debug("Config %s version: %s.%s loaded: %s", filename, log.debug("Config %s version: %s.%s loaded: %s", filename,
self.__version["format"], self.__version["file"], self.__config) self.__version["format"], self.__version["file"], self.__config)
@ -396,26 +396,24 @@ what is currently in the config and it could not convert the value
version = json.loads(data[start:end]) version = json.loads(data[start:end])
start, end = objects[1] start, end = objects[1]
loaded_data = json.loads(data[start:end]) loaded_data = json.loads(data[start:end])
if self.__config == loaded_data and self.__version == version: if self.__config == loaded_data and self.__version == version:
# The config has not changed so lets just return # The config has not changed so lets just return
self._save_timer.cancel() if self._save_timer:
self._save_timer.cancel()
return return
except Exception, e: except IOError, e:
log.warning("Unable to open config file: %s", filename) log.warning("Unable to open config file: %s because: %s", filename, e)
# Save the new config and make sure it's written to disk # Save the new config and make sure it's written to disk
try: try:
log.debug("Saving new config file %s", filename + ".new") log.debug("Saving new config file %s", filename + ".new")
f = open(filename + ".new", "wb") f = open(filename + ".new", "wb")
json.dump(self.__version, f, indent=2) json.dump(self.__version, f, indent=2)
json.dump(self.__config, f, indent=2) json.dump(self.__config, f, indent=2)
f.flush() f.flush()
os.fsync(f.fileno()) os.fsync(f.fileno())
f.close() f.close()
except Exception, e: except IOError, e:
log.error("Error writing new config file: %s", e) log.error("Error writing new config file: %s", e)
return False return False

48
tests/test_config.py
View file

@ -6,7 +6,7 @@ import os
from deluge.config import Config from deluge.config import Config
DEFAULTS = {"string": "foobar", "int": 1, "float": 0.435, "bool": True, "tuple": (1, 2)} DEFAULTS = {"string": "foobar", "int": 1, "float": 0.435, "bool": True}
class ConfigTestCase(unittest.TestCase): class ConfigTestCase(unittest.TestCase):
def setUp(self): def setUp(self):
@ -15,10 +15,10 @@ class ConfigTestCase(unittest.TestCase):
def test_init(self): def test_init(self):
config = Config("test.conf", defaults=DEFAULTS, config_dir=self.config_dir) config = Config("test.conf", defaults=DEFAULTS, config_dir=self.config_dir)
self.assertEquals(DEFAULTS, config.config) self.assertEquals(DEFAULTS, config.config)
config = Config("test.conf", config_dir=self.config_dir) config = Config("test.conf", config_dir=self.config_dir)
self.assertEquals({}, config.config) self.assertEquals({}, config.config)
def test_set_get_item(self): def test_set_get_item(self):
config = Config("test.conf", config_dir=self.config_dir) config = Config("test.conf", config_dir=self.config_dir)
config["foo"] = 1 config["foo"] = 1
@ -26,28 +26,28 @@ class ConfigTestCase(unittest.TestCase):
self.assertRaises(ValueError, config.set_item, "foo", "bar") self.assertRaises(ValueError, config.set_item, "foo", "bar")
config["foo"] = 2 config["foo"] = 2
self.assertEquals(config.get_item("foo"), 2) self.assertEquals(config.get_item("foo"), 2)
config._save_timer.cancel() config._save_timer.cancel()
def test_load(self): def test_load(self):
def check_config(): def check_config():
config = Config("test.conf", config_dir=self.config_dir) config = Config("test.conf", config_dir=self.config_dir)
self.assertEquals(config["string"], "foobar") self.assertEquals(config["string"], "foobar")
self.assertEquals(config["float"], 0.435) self.assertEquals(config["float"], 0.435)
# Test loading an old config from 1.1.x # Test loading an old config from 1.1.x
import pickle import pickle
pickle.dump(DEFAULTS, open(os.path.join(self.config_dir, "test.conf"), "wb")) pickle.dump(DEFAULTS, open(os.path.join(self.config_dir, "test.conf"), "wb"))
check_config() check_config()
# Test opening a previous 1.2 config file of just a json object # Test opening a previous 1.2 config file of just a json object
import json import json
json.dump(DEFAULTS, open(os.path.join(self.config_dir, "test.conf"), "wb"), indent=2) json.dump(DEFAULTS, open(os.path.join(self.config_dir, "test.conf"), "wb"), indent=2)
check_config() check_config()
# Test opening a previous 1.2 config file of having the format versions # Test opening a previous 1.2 config file of having the format versions
# as ints # as ints
f = open(os.path.join(self.config_dir, "test.conf"), "wb") f = open(os.path.join(self.config_dir, "test.conf"), "wb")
@ -55,26 +55,33 @@ class ConfigTestCase(unittest.TestCase):
f.write(str(1) + "\n") f.write(str(1) + "\n")
json.dump(DEFAULTS, f, indent=2) json.dump(DEFAULTS, f, indent=2)
f.close() f.close()
check_config() check_config()
# Test the 1.2 config format # Test the 1.2 config format
v = {"format": 1, "file": 1} v = {"format": 1, "file": 1}
f = open(os.path.join(self.config_dir, "test.conf"), "wb") f = open(os.path.join(self.config_dir, "test.conf"), "wb")
json.dump(v, f, indent=2) json.dump(v, f, indent=2)
json.dump(DEFAULTS, f, indent=2) json.dump(DEFAULTS, f, indent=2)
f.close() f.close()
check_config() check_config()
def test_save(self): def test_save(self):
config = Config("test.conf", defaults=DEFAULTS, config_dir=self.config_dir) config = Config("test.conf", defaults=DEFAULTS, config_dir=self.config_dir)
# We do this twice because the first time we need to save the file to disk
# and the second time we do a compare and we should not write
ret = config.save()
self.assertTrue(ret)
ret = config.save()
self.assertTrue(ret)
config["string"] = "baz" config["string"] = "baz"
config["int"] = 2 config["int"] = 2
ret = config.save() ret = config.save()
self.assertTrue(ret) self.assertTrue(ret)
del config del config
config = Config("test.conf", defaults=DEFAULTS, config_dir=self.config_dir) config = Config("test.conf", defaults=DEFAULTS, config_dir=self.config_dir)
self.assertEquals(config["string"], "baz") self.assertEquals(config["string"], "baz")
self.assertEquals(config["int"], 2) self.assertEquals(config["int"], 2)
@ -84,14 +91,14 @@ class ConfigTestCase(unittest.TestCase):
config["string"] = "baz" config["string"] = "baz"
config["int"] = 2 config["int"] = 2
self.assertTrue(config._save_timer.active()) self.assertTrue(config._save_timer.active())
def check_config(config): def check_config(config):
self.assertTrue(not config._save_timer.active()) self.assertTrue(not config._save_timer.active())
del config del config
config = Config("test.conf", defaults=DEFAULTS, config_dir=self.config_dir) config = Config("test.conf", defaults=DEFAULTS, config_dir=self.config_dir)
self.assertEquals(config["string"], "baz") self.assertEquals(config["string"], "baz")
self.assertEquals(config["int"], 2) self.assertEquals(config["int"], 2)
from twisted.internet.task import deferLater from twisted.internet.task import deferLater
from twisted.internet import reactor from twisted.internet import reactor
d = deferLater(reactor, 7, check_config, config) d = deferLater(reactor, 7, check_config, config)
@ -99,16 +106,15 @@ class ConfigTestCase(unittest.TestCase):
def test_find_json_objects(self): def test_find_json_objects(self):
s = """{ s = """{
"file": 1, "file": 1,
"format": 1 "format": 1
}{ }{
"ssl": true, "ssl": true,
"enabled": false, "enabled": false,
"port": 8115 "port": 8115
}\n""" }\n"""
from deluge.config import find_json_objects from deluge.config import find_json_objects
objects = find_json_objects(s) objects = find_json_objects(s)
self.assertEquals(len(objects), 2) self.assertEquals(len(objects), 2)