config.py 4.96 KB
Newer Older
1
# Copyright 2009 chickenzilla
2
# Copyright 2010 Le Coz Florent <louiz@louiz.org>
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# Poezio 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Poezio.  If not, see <http://www.gnu.org/licenses/>.

18 19 20 21 22
"""
Defines the global config instance, used to get or set (and save) values
from/to the config file
"""

23 24
DEFSECTION = "Poezio"

25
from configparser import RawConfigParser, NoOptionError, NoSectionError
26
from os import environ, makedirs, path
27
from shutil import copy2
28
from optparse import OptionParser
29 30 31 32 33 34 35 36 37 38

class Config(RawConfigParser):
    """
    load/save the config to a file
    """
    def __init__(self, file_name):
        self.file_name = file_name
        RawConfigParser.__init__(self, None)
        RawConfigParser.read(self, file_name)

39
    def get(self, option, default, section=DEFSECTION):
40 41 42 43 44 45
        """
        get a value from the config but return
        a default value if it is not found
        The type of default defines the type
        returned
        """
46
        try:
47
            if type(default) == int:
48
                res = self.getint(option, section)
49
            elif type(default) == float:
50
                res = self.getfloat(option, section)
51
            elif type(default) == bool:
52
                res = self.getboolean(option, section)
53
            else:
54
                res = self.getstr(option, section)
55
        except( NoOptionError, NoSectionError):
56 57 58
            return default
        return res

59
    def __get(self, option, section=DEFSECTION):
60 61 62
        """
        facility for RawConfigParser.get
        """
63
        return RawConfigParser.get(self, section, option)
64

65
    def getstr(self, option, section=DEFSECTION):
66 67 68
        """
        get a value and returns it as a string
        """
69
        return self.__get(option, section)
70

71
    def getint(self, option, section=DEFSECTION):
72 73 74
        """
        get a value and returns it as an int
        """
75
        try:
76
            return int(self.__get(option, section))
77 78
        except ValueError:
            return -1
79

80
    def getfloat(self, option, section=DEFSECTION):
81 82 83
        """
        get a value and returns it as a float
        """
84
        return float(self.__get(option, section))
85

86
    def getboolean(self, option, section=DEFSECTION):
87 88 89
        """
        get a value and returns it as a boolean
        """
90
        return RawConfigParser.getboolean(self, section, option)
91

92 93 94 95 96
    def write_in_file(self, section, option, value):
        """
        Our own way to save write the value in the file
        Just find the right section, and then find the
        right option, and edit it.
97 98 99

        TODO: make it write also new values in the file, not just what did already
        exist
100 101 102 103 104 105 106 107 108 109 110 111
        """
        df = open(self.file_name, 'r')
        lines_before = [line.strip() for line in df.readlines()]
        df.close()
        result_lines = []
        we_are_in_the_right_section = False
        for line in lines_before:
            if line.startswith('['): # check the section
                if line == '[%s]' % section:
                    we_are_in_the_right_section = True
                else:
                    we_are_in_the_right_section = False
112 113
            if (line.startswith('%s ' % (option,)) or
                line.startswith('%s=' % (option,))) and we_are_in_the_right_section:
114 115 116 117 118 119
                line = '%s = %s' % (option, value)
            result_lines.append(line)
        df = open(self.file_name, 'w')
        for line in result_lines:
            df.write('%s\n' % line)
        df.close()
120

121
    def set_and_save(self, option, value, section=DEFSECTION):
122 123 124 125
        """
        set the value in the configuration then save it
        to the file
        """
126 127
        RawConfigParser.set(self, section, option, value)
        self.write_in_file(section, option, value)
128

129 130
# creates the configuration directory if it doesn't exist
# and copy the default config in it
131 132
CONFIG_HOME = environ.get("XDG_CONFIG_HOME")
if not CONFIG_HOME:
133 134
    CONFIG_HOME = environ.get('HOME')+'/.config'
CONFIG_PATH = CONFIG_HOME + '/poezio/'
135 136
try:
    makedirs(CONFIG_PATH)
137 138
except OSError:
    pass
139

140
if not path.isfile(CONFIG_PATH+'poezio.cfg'):
141
    copy2('./data/default_config.cfg', CONFIG_PATH+'poezio.cfg')
142

143 144
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename", default=CONFIG_PATH+'poezio.cfg',
145 146 147
                  help="The config file you want to use", metavar="CONFIG_FILE")
parser.add_option("-d", "--debug", dest="debug",
                  help="The file where debug will be written", metavar="DEBUG_FILE")
148 149
(options, args) = parser.parse_args()
config = Config(options.filename)