diff sat/tools/config.py @ 2562:26edcf3a30eb

core, setup: huge cleaning: - moved directories from src and frontends/src to sat and sat_frontends, which is the recommanded naming convention - move twisted directory to root - removed all hacks from setup.py, and added missing dependencies, it is now clean - use https URL for website in setup.py - removed "Environment :: X11 Applications :: GTK", as wix is deprecated and removed - renamed sat.sh to sat and fixed its installation - added python_requires to specify Python version needed - replaced glib2reactor which use deprecated code by gtk3reactor sat can now be installed directly from virtualenv without using --system-site-packages anymore \o/
author Goffi <goffi@goffi.org>
date Mon, 02 Apr 2018 19:44:50 +0200
parents src/tools/config.py@0046283a285d
children 56f94936df1e
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sat/tools/config.py	Mon Apr 02 19:44:50 2018 +0200
@@ -0,0 +1,119 @@
+#!/usr/bin/env python2
+# -*- coding: utf-8 -*-
+
+# SAT: a jabber client
+# Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
+# Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org)
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+""" Configuration related useful methods """
+
+from sat.core.log import getLogger
+log = getLogger(__name__)
+
+from sat.core.constants import Const as C
+from sat.core.i18n import _
+from sat.core import exceptions
+
+from ConfigParser import SafeConfigParser, DEFAULTSECT, NoOptionError, NoSectionError
+from xdg import BaseDirectory
+import os
+import csv
+import json
+
+
+def fixConfigOption(section, option, value, silent=True):
+    """Force a configuration option value, writing it in the first found user
+    config file, eventually creating a new user config file if none is found.
+
+    @param section (str): the config section
+    @param option (str): the config option
+    @param value (str): the new value
+    @param silent (boolean): toggle logging output (must be True when called from sat.sh)
+    """
+    config = SafeConfigParser()
+    target_file = None
+    for file_ in C.CONFIG_FILES[::-1]:
+        # we will eventually update the existing file with the highest priority, if it's a user personal file...
+        if not silent:
+            log.debug(_(u"Testing file %s") % file_)
+        if os.path.isfile(file_):
+            if file_.startswith(os.path.expanduser('~')):
+                config.read([file_])
+                target_file = file_
+            break
+    if not target_file:
+        # ... otherwise we create a new config file for that user
+        target_file = BaseDirectory.save_config_path('sat') + '/sat.conf'
+    if section and section.upper() != DEFAULTSECT and not config.has_section(section):
+        config.add_section(section)
+    config.set(section, option, value)
+    with open(target_file, 'wb') as configfile:
+        config.write(configfile)  # for the next time that user launches sat
+    if not silent:
+        if option in ('passphrase',):  # list here the options storing a password
+            value = '******'
+        log.warning(_(u"Config auto-update: %(option)s set to %(value)s in the file %(config_file)s") %
+                    {'option': option, 'value': value, 'config_file': target_file})
+
+def parseMainConf():
+    """look for main .ini configuration file, and parse it"""
+    config = SafeConfigParser(defaults=C.DEFAULT_CONFIG)
+    try:
+        config.read(C.CONFIG_FILES)
+    except:
+        log.error(_("Can't read main config !"))
+    return config
+
+def getConfig(config, section, name, default=None):
+    """Get a configuration option
+
+    @param config (SafeConfigParser): the configuration instance
+    @param section (str): section of the config file (None or '' for DEFAULT)
+    @param name (str): name of the option
+    @param default: value to use if not found, or Exception to raise an exception
+    @return (unicode, list, dict): parsed value
+    @raise: NoOptionError if option is not present and default is Exception
+            NoSectionError if section doesn't exists and default is Exception
+            exceptions.ParsingError error while parsing value
+    """
+    if not section:
+        section = DEFAULTSECT
+
+    try:
+        value = config.get(section, name).decode('utf-8')
+    except (NoOptionError, NoSectionError) as e:
+        if default is Exception:
+            raise e
+        return default
+
+    if name.endswith('_path') or name.endswith('_dir'):
+        value = os.path.expanduser(value)
+    # thx to Brian (http://stackoverflow.com/questions/186857/splitting-a-semicolon-separated-string-to-a-dictionary-in-python/186873#186873)
+    elif name.endswith('_list'):
+        value = csv.reader([value], delimiter=',', quotechar='"', skipinitialspace=True).next()
+    elif name.endswith('_dict'):
+        try:
+            value = json.loads(value)
+        except ValueError as e:
+            raise exceptions.ParsingError(u"Error while parsing data: {}".format(e))
+        if not isinstance(value, dict):
+            raise exceptions.ParsingError(u"{name} value is not a dict: {value}".format(name=name, value=value))
+    elif name.endswith('_json'):
+        try:
+            value = json.loads(value)
+        except ValueError as e:
+            raise exceptions.ParsingError(u"Error while parsing data: {}".format(e))
+    return value