sfa/util/config.py

   1 ##
   2 # SFA Configuration Info
   3 #
   4 # This module holds configuration parameters for SFA. There are two
   5 # main pieces of information that are used: the database connection and
   6 # the PLCAPI connection
   7 ##
   8
   9 ##
  10 # SFA uses a MYSQL database to store records. This database may be
  11 # co-located with the PLC database, or it may be a separate database. The
  12 # following parameters define the connection to the database.
  13 #
  14 # Note that SFA does not access any of the PLC databases directly via
  15 # a mysql connection; All PLC databases are accessed via PLCAPI.
  16
  17 ### $Id$
  18 ### $URL$
  19
  20 import os.path
  21 import traceback
  22
  23 class Config:
  24     """
  25     Parse the bash/Python/PHP version of the configuration file. Very
  26     fast but no type conversions.
  27     """
  28
  29     def __init__(self, config_file = "/etc/sfa/sfa_config.py"):
  30         self.config_file = None
  31         self.config_path = None
  32         self.data_path = None
  33         self.load(config_file)
  34
  35     def load(self, config_file):
  36         try:
  37             execfile(config_file, self.__dict__)
  38             self.config_file = config_file
  39             # path to configuration data
  40             self.config_path = os.path.dirname(config_file)
  41
  42             # path to server data
  43             if not hasattr(self, 'SFA_DATA_DIR'):
  44                 # default to /var/lib/sfa not specified in config
  45                 self.SFA_DATA_DIR="/var/lib/sfa"
  46                 self.data_path = self.SFA_DATA_DIR
  47             else:
  48                 self.data_path = self.SFA_DATA_DIR
  49
  50             # path to config data
  51             if not hasattr(self, 'SFA_CONFIG_DIR'):
  52                 # default to /var/lib/sfa not specified in config
  53                 self.SFA_CONFIG_DIR="/etc/sfa"
  54
  55             if not hasattr(self, 'SFA_REGISTRY_LEVEL1_AUTH'):
  56                 self.SFA_REGISTRY_LEVEL1_AUTH=None
  57
  58             # define interface types
  59             # this will determine which manager to use
  60             if not hasattr(self, 'SFA_REGISTRY_TYPE'):
  61                 self.SFA_REGISTRY_TYPE='pl'
  62
  63             if not hasattr(self, 'SFA_AGGREGATE_TYPE'):
  64                 self.SFA_AGGREGATE_TYPE='pl'
  65
  66             if not hasattr(self, 'SFA_SM_TYPE'):
  67                 self.SFA_SM_TYPE='pl'
  68
  69             if not hasattr(self, 'SFA_CM_TYPE'):
  70                 self.SFA_COMPONENT_TYPE='pl'
  71
  72             # create the data directory if it doesnt exist
  73             if not os.path.isdir(self.SFA_DATA_DIR):
  74                 try:
  75                     os.mkdir(self.SFA_DATA_DIR)
  76                 except: pass
  77
  78         except IOError, e:
  79             raise IOError, "Could not find the configuration file: %s" % config_file
  80
  81     def get_trustedroots_dir(self):
  82         return self.config_path + os.sep + 'trusted_roots'
  83
  84     def get_openflow_aggrMgr_info(self):
  85         aggr_mgr_ip = 'localhost'
  86         if (hasattr(self,'OPENFLOW_AGGREGATE_MANAGER_IP')):
  87             aggr_mgr_ip = self.OPENFLOW_AGGREGATE_MANAGER_IP
  88
  89         aggr_mgr_port = 2603
  90         if (hasattr(self,'OPENFLOW_AGGREGATE_MANAGER_PORT')):
  91             aggr_mgr_port = self.OPENFLOW_AGGREGATE_MANAGER_PORT
  92
  93         return (aggr_mgr_ip,aggr_mgr_port)
  94
  95     def get_aggregate_type(self):
  96         if (hasattr(self,'SFA_AGGREGATE_TYPE')):
  97             return self.SFA_AGGREGATE_TYPE
  98         else:
  99             return "pl"
 100
 101     def get_plc_dbinfo(self):
 102         return {
 103             'dbname' : self.SFA_PLC_DB_NAME,
 104             'address' : self.SFA_PLC_DB_HOST,
 105             'port' : self.SFA_PLC_DB_PORT,
 106             'user' : self.SFA_PLC_DB_USER,
 107             'password' : self.SFA_PLC_DB_PASSWORD
 108             }
 109
 110     ##
 111     # SFA uses a PLCAPI connection to perform operations on the registry,
 112     # such as creating and deleting slices. This connection requires an account
 113     # on the PLC server with full administrator access.
 114     #
 115     # The Url parameter controls whether the connection uses PLCAPI directly (i.e.
 116     # SFA is located on the same machine as PLC), or uses a XMLRPC connection
 117     # to the PLC machine. If you wish to use the API directly, then remove the Url
 118     # field from the dictionary.
 119
 120     def get_plc_auth(self):
 121         return {
 122             'AuthMethod': 'capability',
 123             'Username': self.SFA_PLC_USER,
 124             'AuthString':  self.SFA_PLC_PASSWORD,
 125             "Url": self.SFA_PLC_URL
 126             }