sface/config.py

   1 # config for sface
   2 # uses in this order
   3 # command-line args
   4 # ~/.sfi/sfi_config
   5 ###
   6
   7 import os
   8 import types
   9 from optparse import OptionParser
  10
  11
  12 class Config:
  13
  14     d_registry= "http://www.planet-lab.org:12345"
  15     d_slicemgr= "http://www.planet-lab.org:12347"
  16 #    d_aggmgr=   "http://www.planet-lab.org:12346"
  17
  18     supported = [
  19         # local code name, config variable name, default
  20         ('slice',       'SFI_SLICE' ,   None,           '-s','--slice',         "slice HRN"),
  21         ('user',        'SFI_USER',     None,           '-u','--user',          "user HRN"),
  22         ('authority',   'SFI_AUTH',     None,           '-t','--auth',          "users's authority HRN"),
  23         ('registry',    'SFI_REGISTRY', d_registry,     '-r','--registry',      "registry API URL"),
  24         ('slicemgr',    'SFI_SM' ,      d_slicemgr,     '-m','--slicemgr',      "slice API URL"),
  25 #        ('aggmgr',     'SFI_AM',       d_aggmgr,       '-a','--aggregate',     "aggregate manager's URL"),
  26         ('verbose',     'SFACE_VERBOSE',True,          '-v','--verbose',       "UI verbosity"),
  27         ('debug',       'SFACE_DEBUG',  False,          '-d','--debug',         "UI debug flag"),
  28         ]
  29
  30     def fields (self):
  31         return [ tup[0] for tup in Config.supported ]
  32
  33     def field_labels (self):
  34         return [ (tup[0],tup[5]) for tup in Config.supported ]
  35
  36     def sfi_field (self, sfi):
  37         for tuple in Config.supported:
  38             if tuple[1]==sfi: return tuple[0]
  39         return None
  40
  41     def sfi_name(self, field):
  42         for tuple in Config.supported:
  43             if tuple[0] == field: return tuple[1]
  44         return None
  45
  46     def field_default (self, field):
  47         for tuple in Config.supported:
  48             if tuple[0]==field: return tuple[2]
  49         return None
  50
  51     # xxx todo - need for validators - not even sure this is still useful
  52     def define_accessors (self):
  53         for (field,sfi,default,_,__,___) in Config.supported:
  54             self.define_accessor (field,sfi,default)
  55
  56     def define_accessor (self,field,sfi,default):
  57         get_name="get" + field.capitalize();
  58         if not hasattr(Config,get_name):
  59             def get_call (self): return getattr(self,field)
  60             setattr (Config, get_name, get_call)
  61         set_name="set" + field.capitalize();
  62         if not hasattr(Config,set_name):
  63             def set_call (self, newvalue): setattr (self, field, newvalue)
  64             setattr (Config, set_name, set_call)
  65
  66     # the generic form of accessors
  67     def get(self,field): return getattr(self,field)
  68     def set(self,field,value): setattr(self,field,value)
  69
  70     def __init__(self):
  71         self.read_config()
  72
  73     def dirname (self):
  74         return os.path.expanduser("~/.sfi/")
  75
  76     def filename (self):
  77         return self.dirname() + "sfi_config"
  78
  79     def read_config(self):
  80         tmp={}
  81         try:
  82             execfile(self.filename(), tmp)
  83         except:
  84             print "Warning - no config file found %s"%self.filename()
  85             pass
  86         for (field,sfi,default,_,__,___) in Config.supported:
  87             if tmp.has_key(sfi):setattr(self,field,tmp[sfi])
  88             else:               setattr(self,field,default)
  89         self.display("After reading config from %s"%self.filename())
  90
  91     def display (self, msg):
  92         if self.debug:
  93             print msg
  94             for k in self.fields():
  95                 print "%-20s: %r"%(k, self.get(k))
  96
  97     def save_config(self):
  98         configdir = self.dirname()
  99         if not os.path.exists(configdir):
 100             os.makedirs(configdir)
 101
 102         configfile = self.filename()
 103         if not os.path.exists(configfile):
 104             open(configfile, "w").close()
 105
 106         tmpfile = configfile + ".tmp"
 107
 108         out = open(tmpfile, "w")
 109         lineno = 0
 110         written_fields = []
 111         fields = self.fields()
 112         for line in open(configfile, "r"):
 113             lineno += 1
 114             try:
 115                 sfi, val = line.split('=')
 116                 sfi = sfi.strip()
 117                 val = val.strip()
 118                 field = self.sfi_field(sfi)
 119                 if field:
 120                     written_fields.append(field)
 121                     newval = self.get(field)
 122                     if not self.is_bool_field(field):
 123                         newval="'%s'"%newval
 124                     line = "%s = %s\n" % (sfi, newval)
 125             except:
 126                 if self.debug:
 127                     import traceback
 128                     print 'line',lineno,'ignored',line
 129             out.write(line)
 130
 131         # append other field in the end
 132         new_fields = [f for f in fields if f not in written_fields]
 133         for field in new_fields:
 134             sfi = self.sfi_name(field)
 135             val = self.get(field)
 136             if not self.is_bool_field(field):
 137                 val="'%s'" % val
 138             out.write("%s = %s\n" % (sfi, val))
 139
 140         out.close()
 141         os.unlink(configfile)
 142         os.rename(tmpfile, configfile)
 143
 144     # check if a field is a boolean field
 145     def is_bool_field(self, field):
 146         for (f,_,default,__,___,____) in Config.supported:
 147             if field==f: return isinstance(default,bool)
 148         return None
 149
 150     # to accept strings as bools
 151     def is_true(self,value):
 152         if value==True: return True
 153         if isinstance(value,types.StringTypes) and value.lower()=='true': return True
 154
 155     def add_options_to_OptionParser (self, parser):
 156         for (field,_,default,short,long,msg) in Config.supported:
 157             if isinstance(default,bool):
 158                 parser.add_option(short,long,dest=field,action="store_true",help=msg)
 159             else:
 160                 parser.add_option(short,long,dest=field,action="store",default=None, help=msg)
 161
 162     def update_from_OptionParser (self, optparse_options):
 163         for field in self.fields():
 164             if not hasattr(optparse_options,field) : continue
 165             value=getattr(optparse_options,field)
 166             if value is not None:
 167                 setattr(self,field,getattr(optparse_options,field))
 168
 169 #    def setUser(self, user):
 170 #        Config.SFI_USER = user
 171 #
 172 #        # Should probably get authority from user record instead...
 173 #        a = user.split('.')
 174 #        Config.SFI_AUTH = '.'.join(a[:len(a)-1])
 175
 176     def getSliceRSpecFile(self):
 177         return os.path.expanduser("~/.sfi/%s.rspec" % self.getSlice())
 178
 179
 180 # configuration singleton
 181 config = Config()
 182 config.define_accessors()