sfa/util/config.py

   1 #!/usr/bin/python
   2 import sys
   3 import os
   4 import time
   5 import tempfile
   6 import codecs
   7 from sfa.util.xml import XML
   8 from sfa.util.py23 import StringIO
   9 from sfa.util.py23 import ConfigParser
  10
  11 default_config = \
  12 """
  13 """
  14
  15 def isbool(v):
  16     return v.lower() in ("true", "false")
  17
  18 def str2bool(v):
  19     return v.lower() in ("true", "1")
  20
  21 class Config:
  22
  23     def __init__(self, config_file='/etc/sfa/sfa_config'):
  24         self._files = []
  25         self.config_path = os.path.dirname(config_file)
  26         self.config = ConfigParser.ConfigParser()
  27         self.filename = config_file
  28         if not os.path.isfile(self.filename):
  29             self.create(self.filename)
  30         self.load(self.filename)
  31
  32
  33     def _header(self):
  34         header = """
  35 DO NOT EDIT. This file was automatically generated at
  36 %s from:
  37
  38 %s
  39 """ % (time.asctime(), os.linesep.join(self._files))
  40
  41         # Get rid of the surrounding newlines
  42         return header.strip().split(os.linesep)
  43
  44     def create(self, filename):
  45         if not os.path.exists(os.path.dirname(filename)):
  46             os.makedirs(os.path.dirname(filename))
  47         configfile = open(filename, 'w')
  48         configfile.write(default_config)
  49         configfile.close()
  50
  51
  52     def load(self, filename):
  53         if filename:
  54             try:
  55                 self.config.read(filename)
  56             except ConfigParser.MissingSectionHeaderError:
  57                 if filename.endswith('.xml'):
  58                     self.load_xml(filename)
  59                 else:
  60                     self.load_shell(filename)
  61             self._files.append(filename)
  62             self.set_attributes()
  63
  64     def load_xml(self, filename):
  65         xml = XML(filename)
  66         categories = xml.xpath('//configuration/variables/category')
  67         for category in categories:
  68             section_name = category.get('id')
  69             if not self.config.has_section(section_name):
  70                 self.config.add_section(section_name)
  71             options = category.xpath('./variablelist/variable')
  72             for option in options:
  73                 option_name = option.get('id')
  74                 value = option.xpath('./value')[0].text
  75                 if not value:
  76                     value = ""
  77                 self.config.set(section_name, option_name, value)
  78
  79     def load_shell(self, filename):
  80         f = open(filename, 'r')
  81         for line in f:
  82             try:
  83                 if line.startswith('#'):
  84                     continue
  85                 parts = line.strip().split("=")
  86                 if len(parts) < 2:
  87                     continue
  88                 option = parts[0]
  89                 value = parts[1].replace('"', '').replace("'","")
  90                 section, var = self.locate_varname(option, strict=False)
  91                 if section and var:
  92                     self.set(section, var, value)
  93             except:
  94                 pass
  95         f.close()
  96
  97     def locate_varname(self, varname, strict=True):
  98         varname = varname.lower()
  99         sections = self.config.sections()
 100         section_name = ""
 101         var_name = ""
 102         for section in sections:
 103             if varname.startswith(section.lower()) and len(section) > len(section_name):
 104                 section_name = section.lower()
 105                 var_name = varname.replace(section_name, "")[1:]
 106         if strict and not self.config.has_option(section_name, var_name):
 107             raise ConfigParser.NoOptionError(var_name, section_name)
 108         return (section_name, var_name)
 109
 110     def set_attributes(self):
 111         sections = self.config.sections()
 112         for section in sections:
 113             for item in self.config.items(section):
 114                 name = "%s_%s" % (section, item[0])
 115                 value = item[1]
 116                 if isbool(value):
 117                     value = str2bool(value)
 118                 elif value.isdigit():
 119                     value = int(value)
 120                 setattr(self, name, value)
 121                 setattr(self, name.upper(), value)
 122
 123     def variables(self):
 124         """
 125         Return all variables.
 126
 127         Returns:
 128
 129         variables = { 'category_id': (category, variablelist) }
 130
 131         category = { 'id': "category_identifier",
 132                      'name': "Category name",
 133                      'description': "Category description" }
 134
 135         variablelist = { 'variable_id': variable }
 136
 137         variable = { 'id': "variable_identifier",
 138                      'type': "variable_type",
 139                      'value': "variable_value",
 140                      'name': "Variable name",
 141                      'description': "Variable description" }
 142         """
 143
 144         variables = {}
 145         for section in self.config.sections():
 146             category = {
 147                 'id': section,
 148                 'name': section,
 149                 'description': section,
 150             }
 151             variable_list = {}
 152             for item in self.config.items(section):
 153                 var_name = item[0]
 154                 name = "%s_%s" % (section, var_name)
 155                 value = item[1]
 156                 if isbool(value):
 157                     value_type = bool
 158                 elif value.isdigit():
 159                     value_type = int
 160                 else:
 161                     value_type = str
 162                 variable = {
 163                     'id': var_name,
 164                     'type': value_type,
 165                     'value': value,
 166                     'name': name,
 167                     'description': name,
 168                 }
 169                 variable_list[name] = variable
 170             variables[section] = (category, variable_list)
 171         return variables
 172
 173     def verify(self, config1, config2, validate_method):
 174         return True
 175
 176     def validate_type(self, var_type, value):
 177         return True
 178
 179     @staticmethod
 180     def is_xml(config_file):
 181         try:
 182             x = Xml(config_file)
 183             return True
 184         except:
 185             return False
 186
 187     @staticmethod
 188     def is_ini(config_file):
 189         try:
 190             c = ConfigParser.ConfigParser()
 191             c.read(config_file)
 192             return True
 193         except ConfigParser.MissingSectionHeaderError:
 194             return False
 195
 196
 197     def dump(self, sections=None):
 198         if sections is None: sections=[]
 199         sys.stdout.write(output_python())
 200
 201     def output_python(self, encoding = "utf-8"):
 202         buf = codecs.lookup(encoding)[3](StringIO())
 203         buf.writelines(["# " + line + os.linesep for line in self._header()])
 204
 205         for section in self.sections():
 206             buf.write("[%s]%s" % (section, os.linesep))
 207             for (name,value) in self.items(section):
 208                 buf.write("%s=%s%s" % (name,value,os.linesep))
 209             buf.write(os.linesep)
 210         return buf.getvalue()
 211
 212     def output_shell(self, show_comments = True, encoding = "utf-8"):
 213         """
 214         Return variables as a shell script.
 215         """
 216
 217         buf = codecs.lookup(encoding)[3](StringIO())
 218         buf.writelines(["# " + line + os.linesep for line in self._header()])
 219
 220         for section in self.sections():
 221             for (name,value) in self.items(section):
 222                 # bash does not have the concept of NULL
 223                 if value:
 224                     option = "%s_%s" % (section.upper(), name.upper())
 225                     if isbool(value):
 226                         value = str(str2bool(value))
 227                     elif not value.isdigit():
 228                         value = '"%s"' % value
 229                     buf.write(option + "=" + value + os.linesep)
 230         return buf.getvalue()
 231
 232     def output_php(selfi, encoding = "utf-8"):
 233         """
 234         Return variables as a PHP script.
 235         """
 236
 237         buf = codecs.lookup(encoding)[3](StringIO())
 238         buf.write("<?php" + os.linesep)
 239         buf.writelines(["// " + line + os.linesep for line in self._header()])
 240
 241         for section in self.sections():
 242             for (name,value) in self.items(section):
 243                 option = "%s_%s" % (section, name)
 244                 buf.write(os.linesep)
 245                 buf.write("// " + option + os.linesep)
 246                 if value is None:
 247                     value = 'NULL'
 248                 buf.write("define('%s', %s);" % (option, value) + os.linesep)
 249
 250         buf.write("?>" + os.linesep)
 251
 252         return buf.getvalue()
 253
 254     def output_xml(self, encoding = "utf-8"):
 255         pass
 256
 257     def output_variables(self, encoding="utf-8"):
 258         """
 259         Return list of all variable names.
 260         """
 261
 262         buf = codecs.lookup(encoding)[3](StringIO())
 263         for section in self.sections():
 264             for (name,value) in self.items(section):
 265                 option = "%s_%s" % (section,name)
 266                 buf.write(option + os.linesep)
 267
 268         return buf.getvalue()
 269         pass
 270
 271     def write(self, filename=None):
 272         if not filename:
 273             filename = self.filename
 274         configfile = open(filename, 'w')
 275         self.config.write(configfile)
 276
 277     def save(self, filename=None):
 278         self.write(filename)
 279
 280
 281     def get_trustedroots_dir(self):
 282         return self.config_path + os.sep + 'trusted_roots'
 283
 284     def get_openflow_aggrMgr_info(self):
 285         aggr_mgr_ip = 'localhost'
 286         if (hasattr(self,'openflow_aggregate_manager_ip')):
 287             aggr_mgr_ip = self.OPENFLOW_AGGREGATE_MANAGER_IP
 288
 289         aggr_mgr_port = 2603
 290         if (hasattr(self,'openflow_aggregate_manager_port')):
 291             aggr_mgr_port = self.OPENFLOW_AGGREGATE_MANAGER_PORT
 292
 293         return (aggr_mgr_ip,aggr_mgr_port)
 294
 295     def get_interface_hrn(self):
 296         if (hasattr(self,'sfa_interface_hrn')):
 297             return self.SFA_INTERFACE_HRN
 298         else:
 299             return "plc"
 300
 301     def __getattr__(self, attr):
 302         return getattr(self.config, attr)
 303
 304 if __name__ == '__main__':
 305     filename = None
 306     if len(sys.argv) > 1:
 307         filename = sys.argv[1]
 308         config = Config(filename)
 309     else:
 310         config = Config()
 311     config.dump()
 312