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 __init__ (self):
  31         print 'WARNING - should pass config dir'
  32         self.dirname=os.path.expanduser("~/.sfi/")
  33         self.read_config()
  34
  35     def get_dirname (self):
  36         return self.dirname
  37
  38     # warning, might lose unsaved data..
  39     def set_dirname (self, dirname):
  40         self.dirname=dirname
  41         self.read_config()
  42
  43     def fields (self):
  44         return [ tup[0] for tup in Config.supported ]
  45
  46     def field_labels (self):
  47         return [ (tup[0],tup[5]) for tup in Config.supported ]
  48
  49     def sfi_field (self, sfi):
  50         for tuple in Config.supported:
  51             if tuple[1]==sfi: return tuple[0]
  52         return None
  53
  54     def sfi_name(self, field):
  55         for tuple in Config.supported:
  56             if tuple[0] == field: return tuple[1]
  57         return None
  58
  59     def field_default (self, field):
  60         for tuple in Config.supported:
  61             if tuple[0]==field: return tuple[2]
  62         return None
  63
  64     # xxx todo - need for validators - not even sure this is still useful
  65     def define_accessors (self):
  66         for (field,sfi,default,_,__,___) in Config.supported:
  67             self.define_accessor (field,sfi,default)
  68
  69     def define_accessor (self,field,sfi,default):
  70         get_name="get" + field.capitalize();
  71         if not hasattr(Config,get_name):
  72             def get_call (self): return getattr(self,field)
  73             setattr (Config, get_name, get_call)
  74         set_name="set" + field.capitalize();
  75         if not hasattr(Config,set_name):
  76             def set_call (self, newvalue): setattr (self, field, newvalue)
  77             setattr (Config, set_name, set_call)
  78
  79     # the generic form of accessors
  80     def get(self,field): return getattr(self,field)
  81     def set(self,field,value): setattr(self,field,value)
  82
  83     def config_file (self):
  84         return os.path.join(self.get_dirname(),"sfi_config")
  85
  86     def read_config(self):
  87         tmp={}
  88         try:
  89             execfile(self.config_file(), tmp)
  90         except:
  91             print "Warning - no config file found %s"%self.config_file()
  92             pass
  93         for (field,sfi,default,_,__,___) in Config.supported:
  94             if tmp.has_key(sfi):setattr(self,field,tmp[sfi])
  95             else:               setattr(self,field,default)
  96         self.display("After reading config from %s"%self.config_file())
  97
  98     def display (self, msg):
  99         if self.debug:
 100             print msg
 101             for k in self.fields():
 102                 print "%-20s: %r"%(k, self.get(k))
 103
 104     def save_config(self):
 105         configdir = self.get_dirname()
 106         if not os.path.exists(configdir):
 107             os.makedirs(configdir)
 108
 109         configfile = self.config_file()
 110         if not os.path.exists(configfile):
 111             open(configfile, "w").close()
 112
 113         tmpfile = configfile + ".tmp"
 114
 115         out = open(tmpfile, "w")
 116         lineno = 0
 117         written_fields = []
 118         fields = self.fields()
 119         for line in open(configfile, "r"):
 120             lineno += 1
 121             try:
 122                 sfi, val = line.split('=')
 123                 sfi = sfi.strip()
 124                 val = val.strip()
 125                 field = self.sfi_field(sfi)
 126                 if field:
 127                     written_fields.append(field)
 128                     newval = self.get(field)
 129                     if not self.is_bool_field(field):
 130                         newval="'%s'"%newval
 131                     line = "%s = %s\n" % (sfi, newval)
 132             except:
 133                 if self.debug:
 134                     import traceback
 135                     print 'line',lineno,'ignored',line
 136             out.write(line)
 137
 138         # append other field in the end
 139         new_fields = [f for f in fields if f not in written_fields]
 140         for field in new_fields:
 141             sfi = self.sfi_name(field)
 142             val = self.get(field)
 143             if not self.is_bool_field(field):
 144                 val="'%s'" % val
 145             out.write("%s = %s\n" % (sfi, val))
 146
 147         out.close()
 148         os.unlink(configfile)
 149         os.rename(tmpfile, configfile)
 150         if self.debug:
 151             print 'stored config in %s'%configfile
 152
 153     # check if a field is a boolean field
 154     def is_bool_field(self, field):
 155         for (f,_,default,__,___,____) in Config.supported:
 156             if field==f: return isinstance(default,bool)
 157         return None
 158
 159     # to accept strings as bools
 160     def is_true(self,value):
 161         if value==True: return True
 162         if isinstance(value,types.StringTypes) and value.lower()=='true': return True
 163
 164     def add_options_to_OptionParser (self, parser):
 165         parser.add_option ("-d","--dir",dest='dirname',action='store',
 166                            default=os.path.expanduser("~/.sfi/"),
 167                            help="sfi config dir")
 168         for (field,_,default,short,long,msg) in Config.supported:
 169             if isinstance(default,bool):
 170                 parser.add_option(short,long,dest=field,action="store_true",help=msg)
 171             else:
 172                 parser.add_option(short,long,dest=field,action="store",default=None, help=msg)
 173
 174     def update_from_OptionParser (self, optparse_options):
 175         self.set_dirname(optparse_options.dirname)
 176         print 'setting dir',self.dirname
 177         for field in self.fields():
 178             if not hasattr(optparse_options,field) : continue
 179             value=getattr(optparse_options,field)
 180             if value is not None:
 181                 setattr(self,field,getattr(optparse_options,field))
 182
 183 #    def setUser(self, user):
 184 #        Config.SFI_USER = user
 185 #
 186 #        # Should probably get authority from user record instead...
 187 #        a = user.split('.')
 188 #        Config.SFI_AUTH = '.'.join(a[:len(a)-1])
 189
 190     def fullpath (self, filename): return os.path.join(self.get_dirname(),filename)
 191
 192     def getSliceRSpecFile(self): return self.fullpath("%s.rspec" % self.getSlice())
 193
 194     def getSliceRecordFile(self): return self.fullpath ("%s.record" % self.getSlice())
 195
 196     def getAuthorityRecordFile(self): return self.fullpath ("%s/%s.record" % self.getAuthority())
 197
 198     def getAuthorityListFile(self, i=None):
 199         if (i != None) and (i != 0):
 200             return self.fullpath ("%s_list.record.%d" % (self.getAuthority(),i))
 201         else:
 202             return self.fullpath ("%s_list.record" % self.getAuthority())
 203
 204
 205 # configuration singleton
 206 config = Config()
 207 config.define_accessors()
 208