summaryrefslogtreecommitdiff
path: root/portato/config_parser.py
blob: 2ef52c5f1bf3f979524b14dac82a91845d43de81 (plain)
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
# -*- coding: utf-8 -*-
#
# File: portato/config_parser.py
# This file is part of the Portato-Project, a graphical portage-frontend.
#
# Copyright (C) 2006-2010 René 'Necoro' Neumann
# This is free software.  You may redistribute copies of it under the terms of
# the GNU General Public License version 2.
# There is NO WARRANTY, to the extent permitted by law.
#
# Written by René 'Necoro' Neumann <necoro@necoro.net>

"""
A simple parser for configuration files in ini-style.

The main difference to other simple ini-parsers is, that it does not
write the whole structure into the file, but only the changed values.
Thus it keeps comments and structuring of the file.

:Variables:

    COMMENT : string []
        comment marks allowed

    TRUE
        Regular expression for all TRUE values allowed.
        Currently supported are the values (case insensitive): true, 1, on, wahr, ja, yes.

    FALSE
        Regular expression for all FALSE values allowed.
        Currently supported are the values (case insensitive): false, 0, off, falsch, nein, no.

    SECTION
        Regular expression allowing the recognition of a section header.

    EXPRESSION
        Regular expression defining a normal option-value pair.
"""

from __future__ import absolute_import, with_statement
__docformat__ = "restructuredtext"

import re
from threading import Lock

from .helper import debug, error

COMMENT = [";","#"]

# precompiled expressions
TRUE = re.compile("((true)|(1)|(on)|(wahr)|(ja)|(yes))", re.I)
FALSE = re.compile("((false)|(0)|(off)|(falsch)|(nein)|(no))", re.I)
SECTION = re.compile("\s*\[(?P<name>\w(\w|[-_])*)\]\s*")
EXPRESSION = re.compile(r"\s*(?P<key>\w(\w|[-_:])*)\s*=\s*(?P<value>.*)\s*")

class KeyNotFoundException (KeyError):
    """
    Exception signaling, that a specific key could not be found in the configuration.
    """
    pass

class SectionNotFoundException (KeyError):
    """
    Exception signaling, that a section could not be found in the configuration.
    """
    pass

class Value (object):
    """
    Class defining a value of a key.
    
    :IVariables:

        value
            The specific value.

        old
            The old value

        line : int
            The line in the config file.
        
        boolean : boolean
            The boolean meaning of this value. Set this to ``None`` if this is not a boolean.
    
        changed : boolean
            Set to True if the value has been changed.
    """
    

    def __init__ (self, value, line, bool = None):
        """
        Constructor.

        :Parameters:

            value : string
                the value

            line : int
                the line in the config file

            bool : boolean
                The boolean meaning of the value. Set this to ``None`` if this is not a boolean.
        """

        self.__value = value
        self.line = line
        self.boolean = bool
        
        self.changed = False # true if we changed it
        self.old = value # keep the original one ... so if we change it back to this one, we do not have to write

    def set (self, value):
        """
        Sets the value to a new one.
        
        :param value: new value
        :type value: string
        """

        self.__value = value
        
        if value != self.old:
            self.changed = True
        else:
            self.changed = False

    def get (self):
        """
        Returns the actual value.
        
        :rtype: string
        """

        return self.__value
    
    def is_bool (self):
        """
        Returns whether the actual value has a boolean meaning.
        
        :rtype: boolean
        """

        return (self.boolean != None)

    def __str__ (self):
        return str(self.__value)

    def __repr__ (self):
        return self.__str__()
    
    value = property(get,set)
    
class ConfigParser:
    """
    The parser class.

    :CVariables:

        true_false : string -> string
            A mapping from the truth values to their opposits.
    
    :IVariables:

        file : string
            the file to scan
        cache : string[]
            caches the content of the file
        vars : string -> (string -> `Value`)
            the found options grouped by section
        pos : int -> (int, int)
            the positions of the values grouped by lineno
    """

    # generates the complementary true-false-pairs
    true_false = {
                "true"     : "false",
                "1"        : "0",
                "on"    : "off",
                "yes"    : "no",
                "ja"    : "nein",
                "wahr"    : "falsch"}
    true_false.update(zip(true_false.values(), true_false.keys()))

    def __init__ (self, file):
        """
        Constructor.

        :param file: the configuration file to open
        :type file: string
        """

        self.file = file
        self.writelock = Lock()
        self.__initialize()

    def __initialize (self):
        """Private method which initializes our dictionaries."""

        self.vars = {"MAIN": {}}
        self.cache = [] # file cache
        self.pos = {} # stores the positions of the matches
        self.sections = {"MAIN" : -1} # the line with the section header

    def _invert (self, val):
        """
        Invertes a given boolean.

        :param val: value to invert
        :type val: string
        :returns: inverted value
        :rtype: string

        :see: `true_false`
        """

        return self.true_false[val.lower()]

    def parse (self):
        """
        Parses the file.
        """

        # read into cache
        with open(self.file, "r") as f:
            self.cache = f.readlines()

        # implicit first section is main
        section = "MAIN"
        count = -1
        for line in self.cache:
            count += 1

            ls = line.strip()
            if not ls: continue # empty
            if ls[0] in COMMENT: continue # comment
            
            # look for a section
            match = SECTION.search(line)
            if match:
                sec = match.group("name").upper()
                self.sections[sec] = count
                if sec != section:
                    self.vars[sec] = {}
                    section = sec
                continue

            # look for an expression
            match = EXPRESSION.search(line)
            if match:
                val = match.group("value")
                
                # find the boolean value
                bool = None
                if TRUE.match(val):
                    bool = True
                elif FALSE.match(val):
                    bool = False
                
                # insert
                key = match.group("key").lower()
                self.vars[section][key] = Value(val, count, bool = bool)
                self.pos[count] = match.span("value")
            else: # neither comment nor empty nor expression nor section => error
                error(_("Unrecognized line in configuration: %s"), line)

    def _access (self, key, section):
        """
        Private method for accessing the saved variables.

        :Parameters:

            key : string
                the key
            section : string
                the section

        :returns: the value wanted
        :rtype: `Value`

        :Exceptions:
            
            - `KeyNotFoundException` : Raised if the specified key could not be found.
            - `SectionNotFoundException` : Raised if the specified section could not be found.
        """
        
        try:
            sectiondict = self.vars[section]
        except KeyError:
            raise SectionNotFoundException("Section '%s' not found in file '%s'." % (section, self.file))
        
        try:
            return sectiondict[key]
        except KeyError:
            raise KeyNotFoundException("Key '%s' not found in section '%s' in file '%s'." % (key, section, self.file))

    def get (self, key, section = "MAIN"):
        """
        Returns the value of a given key in a section.

        :Parameters:

            key : string
                the key
            section : string
                the section
        
        :returns: value
        :rtype: string
        
        :Exceptions:
            
            - `KeyNotFoundException` : Raised if the specified key could not be found.
            - `SectionNotFoundException` : Raised if the specified section could not be found.
        """

        section = section.upper()
        key = key.lower()
        return self._access(key, section).value

    def get_boolean (self, key, section = "MAIN"):
        """
        Returns the boolean value of a given key in a section.

        :Parameters:

            key : string
                the key
            section : string
                the section
        
        :returns: value
        :rtype: boolean

        :Exceptions:
            
            - `KeyNotFoundException` : Raised if the specified key could not be found.
            - `SectionNotFoundException` : Raised if the specified section could not be found.
            - `ValueError` : Raised if the key accessed is not a boolean.
        """
        
        section = section.upper()
        key = key.lower()

        val = self._access(key, section)

        if val.is_bool():
            return val.boolean

        raise ValueError, "\"%s\" is not a boolean. (%s)" % (key, val.value)

    def set (self, key, value, section = "MAIN"):
        """
        Sets a new value of a given key in a section.

        :Parameters:

            key : string
                the key
            value : string or boolean
                the new value
            section : string
                the section
        
        :Exceptions:
            
            - `KeyNotFoundException` : Raised if the specified key could not be found.
            - `SectionNotFoundException` : Raised if the specified section could not be found.
            - `ValueError` : if a boolean value is passed and the old/new value is not a boolean
        """
        
        section = section.upper()
        key = key.lower()

        if not isinstance(value, bool): # str
            self._access(key, section).value = value
        else:
            val = self._access(key, section)
            if val.is_bool():
                if value is not val.boolean:
                    val.boolean = value
                    val.value = self._invert(val.value)
            else:
                raise ValueError, "\"%s\" is not a boolean." % key

    def add_section (self, section, comment = None, with_blankline = True):
        """
        Adds a section to a the current configuration. If this section already exists, it does nothing.

        :Parameters:
            
            comment : string
                An additional comment to place above this section. '\\n' in the comment is interpreted correctly.

            with_blankline : boolean
                Add an additional blank line above the section.
        """
        section = section.upper()

        if section in self.vars:
            return

        if with_blankline and len(self.cache) > 0:
            self.cache.append("\n")

        if comment:
            if isinstance(comment, basestring):
                comment = comment.split("\n")
            
            # add newlines to comment at the beginning and the end
            comment.insert(0, "")
            comment.append("")
            
            for c in comment:
                self.cache.append("# %s\n" % c)

        self.vars[section] = {}
        self.sections[section] = len(self.cache)
        self.cache.append("[%s]\n" % section)

    def add (self, key, value, section = "MAIN", comment = None, with_blankline = True):
        """
        Adds a key to the specified section. If the key already exists, it acts the same as `set`.

        :Parameters:

            key : string
                The key to add.
            section : string
                The section where to add the key to.
            comment : string
                An additional comment for the key. '\\n' is correctly handled.
            with_blankline : boolean
                Add an additional blank line in front of the value.

        :raises SectionNotFoundException: if the section specified was not found
        """

        section = section.upper()
        key = key.lower()

        try:
            if key in self.vars[section]:
                return self.set(key, value, section)
        except KeyError:
            raise SectionNotFoundException("Section '%s' not found in file '%s'." % (section, self.file))

        self.write()
        
        # find line# to add
        if self.vars[section]:
            mline = max((x.line for x in self.vars[section].itervalues())) + 1
        else: # no value inside the section at the moment
            mline = self.sections[section] + 1

        if with_blankline and mline > 0:
            self.cache.insert(mline, "\n")
            mline += 1

        if comment:
            if isinstance(comment, basestring):
                comment = comment.split("\n")
            
            for c in comment:
                self.cache.insert(mline, "; %s\n" % c)
                mline += 1
        
        self.cache.insert(mline, "%s = %s\n" % (key, value))
        
        self.write()

    def write (self):
        """
        Writes the configuration file.
        """

        if not self.cache:
            return

        with self.writelock:
            for sec in self.vars.itervalues():
                for val in sec.itervalues():
                    if val.changed:
                        part1 = self.cache[val.line][:self.pos[val.line][0]]     # key+DELIMITER
                        part2 = val.value                                        # value
                        part3 = self.cache[val.line][self.pos[val.line][1]:]    # everything behind the value (\n in normal cases)

                        if not val.old and part1.endswith("\n"): # empty original value
                            part1 = part1[:-1] # strip \n
                            part3 = part3 + "\n"

                        self.cache[val.line] = part1 + part2 + part3
            
            # write
            with open(self.file, "w") as f:
                f.writelines(self.cache)

            # reload
            self.__initialize()
            self.parse()