Added more tests for user config parsing.
[electrum-nvc.git] / lib / simple_config.py
index a58ff9f..d4893b1 100644 (file)
-import json
+import ast
+import threading
 import os
-from util import user_dir
 
-class SimpleConfig:
+from util import user_dir, print_error, print_msg
 
+SYSTEM_CONFIG_PATH = "/etc/electrum.conf"
 
-    default_options = {"gui": "lite", "proxy": { "mode": "none", "host":"localhost", "port":"8080" },
-    "winpos-qt": [100, 100, 840, 400], "winpos-lite": [4, 25, 351, 149], "history": False }
-    
-    def __init__(self):
-        # Find electrum data folder
-        self.config_folder = user_dir()
-        # Read the file
-        if os.path.exists(self.config_file_path()):
-            self.load_config()
+config = None
+
+
+def get_config():
+    global config
+    return config
+
+
+def set_config(c):
+    global config
+    config = c
+
+
+class SimpleConfig(object):
+    """
+    The SimpleConfig class is responsible for handling operations involving
+    configuration files.
+
+    There are 3 different sources of possible configuration values:
+        1. Command line options.
+        2. User configuration (in the user's config directory)
+        3. System configuration (in /etc/)
+    They are taken in order (1. overrides config options set in 2., that
+    override config set in 3.)
+    """
+    def __init__(self, options=None, read_system_config_function=None,
+                 read_user_config_function=None, read_user_dir_function=None):
+
+        # This is the holder of actual options for the current user.
+        self.current_options = {}
+        # This lock needs to be acquired for updating and reading the config in
+        # a thread-safe way.
+        self.lock = threading.RLock()
+        # The path for the config directory. This is set later by init_path()
+        self.path = None
+
+        if options is None:
+            options = {}  # Having a mutable as a default value is a bad idea.
+
+        # The following two functions are there for dependency injection when
+        # testing.
+        if read_system_config_function is None:
+            read_system_config_function = read_system_config
+        if read_user_config_function is None:
+            read_user_config_function = read_user_config
+        if read_user_dir_function is None:
+            self.user_dir = user_dir
         else:
-            self.config = self.default_options
-            # Make config directory if it does not yet exist.
-            if not os.path.exists(self.config_folder):
-                os.mkdir(self.config_folder)
-            self.save_config()
+            self.user_dir = read_user_dir_function
+
+        # Save the command-line keys to make sure we don't override them.
+        self.command_line_keys = options.keys()
+        # Save the system config keys to make sure we don't override them.
+        self.system_config_keys = []
+
+        if options.get('portable') is not True:
+            # system conf
+            system_config = read_system_config_function()
+            self.system_config_keys = system_config.keys()
+            self.current_options.update(system_config)
+
+        # update the current options with the command line options last (to
+        # override both others).
+        self.current_options.update(options)
+
+        # init path
+        self.init_path()
+
+        # user config.
+        self.user_config = read_user_config_function(self.path)
+        # The user config is overwritten by the current config!
+        self.user_config.update(self.current_options)
+        self.current_options = self.user_config
+
+        set_config(self)  # Make a singleton instance of 'self'
+
+    def init_path(self):
+        # Read electrum path in the command line configuration
+        self.path = self.current_options.get('electrum_path')
+
+        # If not set, use the user's default data directory.
+        if self.path is None:
+            self.path = self.user_dir()
+
+        # Make directory if it does not yet exist.
+        if not os.path.exists(self.path):
+            os.mkdir(self.path)
+
+        print_error( "electrum directory", self.path)
 
     def set_key(self, key, value, save = True):
-        self.config[key] = value
-        if save == True:
-            self.save_config()
-
-    def save_config(self):
-        if not os.path.exists(self.config_folder):
-            os.mkdir(self.config_folder)
-        f = open(self.config_file_path(), "w+")
-        f.write(json.dumps(self.config))
-
-    def load_config(self):
-        f = open(self.config_file_path(), "r")
-        file_contents = f.read()
-        if file_contents:
-            user_config = json.loads(file_contents)
-            for i in user_config:
-                self.config[i] = user_config[i]
-        else:
-            self.config = self.default_options
-            self.save_config()
-  
-    def config_file_path(self):
-        return "%s" % (self.config_folder + "/config.json")
-
-    def __init__(self):
-        # Find electrum data folder
-        self.config_folder = user_dir()
-        self.config = self.default_options
-        # Read the file
-        if os.path.exists(self.config_file_path()):
-            self.load_config()
-        self.save_config()
+        if not self.is_modifiable(key):
+            print "Warning: not changing key '%s' because it is not modifiable" \
+                  " (passed as command line option or defined in /etc/electrum.conf)"%key
+            return
+
+        with self.lock:
+            self.user_config[key] = value
+            self.current_options[key] = value
+            if save:
+                self.save_user_config()
+
+        return
+
+    def get(self, key, default=None):
+        out = None
+        with self.lock:
+            out = self.current_options.get(key, default)
+        return out
+
+    def is_modifiable(self, key):
+        if key in self.command_line_keys:
+            return False
+        if key in self.system_config_keys:
+            return False
+        return True
+
+    def save_user_config(self):
+        if not self.path: return
+
+        path = os.path.join(self.path, "config")
+        s = repr(self.user_config)
+        f = open(path,"w")
+        f.write( s )
+        f.close()
+        if self.get('gui') != 'android':
+            import stat
+            os.chmod(path, stat.S_IREAD | stat.S_IWRITE)
+
+def read_system_config(path=SYSTEM_CONFIG_PATH):
+    """Parse and return the system config settings in /etc/electrum.conf."""
+    result = {}
+    if os.path.exists(path):
+        try:
+            import ConfigParser
+        except ImportError:
+            print "cannot parse electrum.conf. please install ConfigParser"
+            return
+
+        p = ConfigParser.ConfigParser()
+        try:
+            p.read(path)
+            for k, v in p.items('client'):
+                result[k] = v
+        except (ConfigParser.NoSectionError, ConfigParser.MissingSectionHeaderError):
+            pass
+
+    return result
+
+def read_user_config(path):
+    """Parse and store the user config settings in electrum.conf into user_config[]."""
+    if not path: return {}  # Return a dict, since we will call update() on it.
+
+    config_path = os.path.join(path, "config")
+    result = {}
+    if os.path.exists(config_path):
+        try:
+
+            with open(config_path, "r") as f:
+                data = f.read()
+            result = ast.literal_eval( data )  #parse raw data from reading wallet file
+
+        except Exception:
+            print_msg("Error: Cannot read config file.")
+            result = {}
 
+        if not type(result) is dict:
+            return {}
 
+    return result