Statistics
| Branch: | Tag: | Revision:

root / kamaki / cli / config.py @ 26cd03ca

History | View | Annotate | Download (4 kB)

1
# Copyright 2011-2012 GRNET S.A. All rights reserved.
2
#
3
# Redistribution and use in source and binary forms, with or
4
# without modification, are permitted provided that the following
5
# conditions are met:
6
#
7
#   1. Redistributions of source code must retain the above
8
#      copyright notice, this list of conditions and the following
9
#      disclaimer.
10
#
11
#   2. Redistributions in binary form must reproduce the above
12
#      copyright notice, this list of conditions and the following
13
#      disclaimer in the documentation and/or other materials
14
#      provided with the distribution.
15
#
16
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
# POSSIBILITY OF SUCH DAMAGE.
28
#
29
# The views and conclusions contained in the software and
30
# documentation are those of the authors and should not be
31
# interpreted as representing official policies, either expressed
32
# or implied, of GRNET S.A.
33

    
34
import os
35

    
36
from collections import defaultdict
37
from ConfigParser import RawConfigParser, NoOptionError, NoSectionError
38

    
39
try:
40
    from collections import OrderedDict
41
except ImportError:
42
    from ordereddict import OrderedDict
43

    
44

    
45
# Path to the file that stores the configuration
46
CONFIG_PATH = os.path.expanduser('~/.kamakirc')
47

    
48
# Name of a shell variable to bypass the CONFIG_PATH value
49
CONFIG_ENV = 'KAMAKI_CONFIG'
50

    
51
HEADER = """
52
# Kamaki configuration file
53
"""
54

    
55
DEFAULTS = {
56
    'global': {
57
        'colors': 'on',
58
        'token': ''
59
    },
60
    'config': {
61
        'cli': 'config_cli',
62
        'description': 'Configuration commands'
63
    }
64
}
65

    
66

    
67
class Config(RawConfigParser):
68
    def __init__(self, path=None):
69
        RawConfigParser.__init__(self, dict_type=OrderedDict)
70
        self.path = path or os.environ.get(CONFIG_ENV, CONFIG_PATH)
71
        self._overrides = defaultdict(dict)
72
        self._load_defaults()
73
        self.read(self.path)
74

    
75
    def _load_defaults(self):
76
        for section, options in DEFAULTS.items():
77
            for option, val in options.items():
78
                self.set(section, option, val)
79

    
80
    def apis(self):
81
        return [api for api in self.sections() if api != 'global']
82

    
83
    def get(self, section, option):
84
        value = self._overrides.get(section, {}).get(option)
85
        if value is not None:
86
            return value
87

    
88
        try:
89
            return RawConfigParser.get(self, section, option)
90
        except (NoSectionError, NoOptionError):
91
            return DEFAULTS.get(section, {}).get(option)
92

    
93
    def set(self, section, option, value):
94
        if section not in RawConfigParser.sections(self):
95
            self.add_section(section)
96
        RawConfigParser.set(self, section, option, value)
97

    
98
    def remove_option(self, section, option):
99
        try:
100
            RawConfigParser.remove_option(self, section, option)
101
        except NoSectionError:
102
            pass
103

    
104
    def items(self, section, include_defaults=False):
105
        try:
106
            d = dict(DEFAULTS[section]) if include_defaults else {}
107
        except KeyError:
108
            d = {}
109
        try:
110
            d.update(RawConfigParser.items(self, section))
111
        except NoSectionError:
112
            pass
113
        return d.items()
114

    
115
    def override(self, section, option, value):
116
        self._overrides[section][option] = value
117

    
118
    def write(self):
119
        with open(self.path, 'w') as f:
120
            os.chmod(self.path, 0600)
121
            f.write(HEADER.lstrip())
122
            RawConfigParser.write(self, f)