1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
# Copyright 2010-2011 Florent Le Coz <louiz@louiz.org>
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
# it under the terms of the zlib license. See the COPYING file.
"""
Defines the global config instance, used to get or set (and save) values
from/to the config file
"""
DEFSECTION = "Poezio"
from configparser import RawConfigParser, NoOptionError, NoSectionError
from os import environ, makedirs, path
from shutil import copy2
from optparse import OptionParser
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)
# Check config integrity and fix it if it’s wrong
for section in ('bindings', 'var'):
if not self.has_section(section):
self.add_section(section)
def get(self, option, default, section=DEFSECTION):
"""
get a value from the config but return
a default value if it is not found
The type of default defines the type
returned
"""
try:
if type(default) == int:
res = self.getint(option, section)
elif type(default) == float:
res = self.getfloat(option, section)
elif type(default) == bool:
res = self.getboolean(option, section)
else:
res = self.getstr(option, section)
except (NoOptionError, NoSectionError):
return default
return res
def getl(self, option, default, section=DEFSECTION):
"""
get a value and return it lowercase
"""
return self.get(option, default, section).lower()
def get_by_tabname(self, option, default, tabname, fallback=True):
"""
Try to get the value for the option. First we look in
a section named `tabname`, if the option is not present
in the section, we search for the global option if fallback is
True. And we return `default` as a fallback as a last resort.
"""
if tabname in self.sections():
if option in self.options(tabname):
# We go the tab-specific option
return self.get(option, default, tabname)
if fallback:
# We fallback to the global option
return self.get(option, default)
return default
def __get(self, option, section=DEFSECTION):
"""
facility for RawConfigParser.get
"""
return RawConfigParser.get(self, section, option)
def getstr(self, option, section=DEFSECTION):
"""
get a value and returns it as a string
"""
return self.__get(option, section)
def getint(self, option, section=DEFSECTION):
"""
get a value and returns it as an int
"""
try:
return int(self.__get(option, section))
except ValueError:
return -1
def getfloat(self, option, section=DEFSECTION):
"""
get a value and returns it as a float
"""
return float(self.__get(option, section))
def getboolean(self, option, section=DEFSECTION):
"""
get a value and returns it as a boolean
"""
return RawConfigParser.getboolean(self, section, option)
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.
TODO: make it write also new values in the file, not just what did already
exist
"""
if path.exists(self.file_name):
df = open(self.file_name, 'r')
lines_before = (line.strip() for line in df.readlines())
df.close()
else:
lines_before = []
result_lines = []
we_are_in_the_right_section = False
written = False
section_found = False
for line in lines_before:
if line.startswith('['): # check the section
if we_are_in_the_right_section and not written:
result_lines.append('%s = %s' % (option, value))
written = True
if line == '[%s]' % section:
we_are_in_the_right_section = True
section_found = True
else:
we_are_in_the_right_section = False
if (line.startswith('%s ' % (option,)) or
line.startswith('%s=' % (option,)) or
line.startswith('%s = ' % (option,))) and we_are_in_the_right_section:
line = '%s = %s' % (option, value)
written = True
result_lines.append(line)
if not section_found:
result_lines.append('[%s]' % section)
result_lines.append('%s = %s' % (option, value))
elif not written:
result_lines.append('%s = %s' % (option, value))
df = open(self.file_name, 'w')
for line in result_lines:
df.write('%s\n' % line)
df.close()
def set_and_save(self, option, value, section=DEFSECTION):
"""
set the value in the configuration then save it
to the file
"""
if self.has_section(section):
RawConfigParser.set(self, section, option, value)
else:
self.add_section(section)
RawConfigParser.set(self, section, option, value)
self.write_in_file(section, option, value)
def set(self, option, value, section=DEFSECTION):
"""
Set the value of an option temporarily
"""
try:
RawConfigParser.set(self, section, option, value)
except NoSectionError:
pass
firstrun = False
# creates the configuration directory if it doesn't exist
# and copy the default config in it
CONFIG_HOME = environ.get("XDG_CONFIG_HOME")
if not CONFIG_HOME:
CONFIG_HOME = path.join(environ.get('HOME'), '.config')
CONFIG_PATH = path.join(CONFIG_HOME, 'poezio')
try:
makedirs(CONFIG_PATH)
except OSError:
pass
if not path.isfile(path.join(CONFIG_PATH, 'poezio.cfg')):
copy2(path.join(path.dirname(__file__), '../data/default_config.cfg'), path.join(CONFIG_PATH, 'poezio.cfg'))
firstrun = True
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename", default=path.join(CONFIG_PATH, 'poezio.cfg'),
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")
(options, args) = parser.parse_args()
config = Config(options.filename)
if firstrun:
config.set('firstrun', True)
|
