geni/util/record.py

   1 ##
   2 # Implements support for geni records
   3 #
   4 # TODO: Use existing PLC database methods? or keep this separate?
   5 ##
   6
   7 import report
   8 from types import StringTypes
   9 from gid import *
  10 from geni.util.rspec import *
  11 ##
  12 # The GeniRecord class implements a Geni Record. A GeniRecord is a tuple
  13 # (Name, GID, Type, Info).
  14 #
  15 # Name specifies the HRN of the object
  16 # GID is the GID of the object
  17 # Type is user | sa | ma | slice | component
  18 #
  19 # Info is comprised of the following sub-fields
  20 #        pointer = a pointer to the record in the PL database
  21 #        pl_info = planetlab-specific info (when talking to client)
  22 #        geni_info = geni-specific info (when talking to client)
  23 #
  24 # The pointer is interpreted depending on the type of the record. For example,
  25 # if the type=="user", then pointer is assumed to be a person_id that indexes
  26 # into the persons table.
  27 #
  28 # A given HRN may have more than one record, provided that the records are
  29 # of different types. For example, planetlab.us.arizona may have both an SA
  30 # and a MA record, but cannot have two SA records.
  31
  32 class GeniRecord:
  33
  34     ##
  35     # Create a Geni Record
  36     #
  37     # @param name if !=None, assign the name of the record
  38     # @param gid if !=None, assign the gid of the record
  39     # @param type one of user | sa | ma | slice | component
  40     # @param pointer is a pointer to a PLC record
  41     # @param dict if !=None, then fill in this record from the dictionary
  42
  43     def __init__(self, name=None, gid=None, type=None, pointer=None, dict=None, string=None):
  44         self.dirty = True
  45         self.pl_info = None
  46         self.geni_info = None
  47         self.name = None
  48         self.gid = None
  49         self.type = None
  50         self.pointer = None
  51         if name:
  52             self.set_name(name)
  53         if gid:
  54             self.set_gid(gid)
  55         if type:
  56             self.set_type(type)
  57         if pointer:
  58             self.set_pointer(pointer)
  59         if dict:
  60             self.load_from_dict(dict)
  61         if string:
  62             self.load_from_string(string)
  63
  64     ##
  65     # Set the name of the record
  66     #
  67     # @param name is a string containing the HRN
  68
  69     def set_name(self, name):
  70         self.name = name
  71         self.dirty = True
  72
  73     ##
  74     # Set the GID of the record
  75     #
  76     # @param gid is a GID object or the string representation of a GID object
  77
  78     def set_gid(self, gid):
  79         if isinstance(gid, StringTypes):
  80             self.gid = gid
  81         else:
  82             self.gid = gid.save_to_string(save_parents=True)
  83         self.dirty = True
  84
  85     ##
  86     # Set the type of the record
  87     #
  88     # @param type is a string: user | sa | ma | slice | component
  89
  90     def set_type(self, type):
  91         self.type = type
  92         self.dirty = True
  93
  94     ##
  95     # Set the pointer of the record
  96     #
  97     # @param pointer is an integer containing the ID of a PLC record
  98
  99     def set_pointer(self, pointer):
 100         self.pointer = pointer
 101         self.dirty = True
 102
 103     ##
 104     # Set the PLC info of the record
 105     #
 106     # @param pl_info is a dictionary containing planetlab info
 107
 108     def set_pl_info(self, pl_info):
 109         if isinstance(pl_info, list):
 110             pl_info = pl_info[0]
 111         self.pl_info = pl_info
 112         self.dirty = True
 113
 114     ##
 115     # Set the geni info the record
 116     #
 117     # @param geni_info is a dictionary containing geni info
 118
 119     def set_geni_info(self, geni_info):
 120         if isinstance(geni_info, list):
 121             geni_info = geni_info[0]
 122         self.geni_info = geni_info
 123         self.dirty = True
 124
 125     ##
 126     # Return the pl_info of the record, or an empty dictionary if none exists
 127
 128     def get_pl_info(self):
 129         if self.pl_info:
 130             return self.pl_info
 131         else:
 132             return {}
 133
 134     ##
 135     # Return the geni_info of the record, or an empty dictionary if none exists
 136
 137     def get_geni_info(self):
 138         if self.geni_info:
 139             return self.geni_info
 140         else:
 141             return {}
 142
 143     ##
 144     # Return the name (HRN) of the record
 145
 146     def get_name(self):
 147         return self.name
 148
 149     ##
 150     # Return the type of the record
 151
 152     def get_type(self):
 153         return self.type
 154
 155     ##
 156     # Return the pointer of the record. The pointer is an integer that may be
 157     # used to look up the record in the PLC database. The evaluation of pointer
 158     # depends on the type of the record
 159
 160     def get_pointer(self):
 161         return self.pointer
 162
 163     ##
 164     # Return the GID of the record, in the form of a GID object
 165     # TODO: not the best name for the function, because we have things called
 166     # gidObjects in the Cred
 167
 168     def get_gid_object(self):
 169         return GID(string=self.gid)
 170
 171     ##
 172     # Return a key that uniquely identifies this record among all records in
 173     # Geni. This key is used to uniquely identify the record in the Geni
 174     # database.
 175
 176     def get_key(self):
 177         return self.name + "#" + self.type
 178
 179     ##
 180     # Returns a list of field names in this record. pl_info, geni_info are not
 181     # included because they are not part of the record that is stored in the
 182     # database, but are rather computed values from other entities
 183
 184     def get_field_names(self):
 185         return ["name", "gid", "type", "pointer"]
 186
 187     ##
 188     # Given a field name ("name", "gid", ...) return the value of that field.
 189     #
 190     # @param name is the name of field to be returned
 191
 192     def get_field_value_string(self, fieldname):
 193         if fieldname == "key":
 194             val = self.get_key()
 195         else:
 196             val = getattr(self, fieldname)
 197         if isinstance(val, str):
 198             return "'" + str(val) + "'"
 199         else:
 200             return str(val)
 201
 202     ##
 203     # Given a list of field names, return a list of values for those fields.
 204     #
 205     # @param fieldnames is a list of field names
 206
 207     def get_field_value_strings(self, fieldnames):
 208         strs = []
 209         for fieldname in fieldnames:
 210             strs.append(self.get_field_value_string(fieldname))
 211         return strs
 212
 213     ##
 214     # Return the record in the form of a dictionary
 215
 216     def as_dict(self):
 217         dict = {}
 218         names = self.get_field_names()
 219         for name in names:
 220             dict[name] = getattr(self, name)
 221
 222         if self.pl_info:
 223             dict['pl_info'] = self.pl_info
 224
 225         if self.geni_info:
 226             dict['geni_info'] = self.geni_info
 227
 228         return dict
 229
 230     ##
 231     # Load the record from a dictionary
 232     #
 233     # @param dict dictionary to load record fields from
 234
 235     def load_from_dict(self, dict):
 236         self.set_name(dict['name'])
 237         gidstr = dict.get("gid", None)
 238         if gidstr:
 239             self.set_gid(dict['gid'])
 240
 241         self.set_type(dict['type'])
 242         self.set_pointer(dict['pointer'])
 243         if "pl_info" in dict:
 244            self.set_pl_info(dict["pl_info"])
 245         if "geni_info" in dict:
 246            self.set_geni_info(dict["geni_info"])
 247
 248     ##
 249     # Save the record to a string. The string contains an XML representation of
 250     # the record.
 251
 252     def save_to_string(self):
 253
 254         dict = self.as_dict()
 255         record = RecordSpec()
 256         record.parseDict(dict)
 257         str = record.toxml()
 258         #str = xmlrpclib.dumps((dict,), allow_none=True)
 259         return str
 260
 261     ##
 262     # Load the record from a string. The string is assumed to contain an XML
 263     # representation of the record.
 264
 265     def load_from_string(self, str):
 266         #dict = xmlrpclib.loads(str)[0][0]
 267
 268         record = RecordSpec()
 269         record.parseString(str)
 270         record_dict = record.toDict()
 271         geni_dict = record_dict['record']
 272         self.load_from_dict(geni_dict)
 273
 274     ##
 275     # Dump the record to stdout
 276     #
 277     # @param dump_parents if true, then the parents of the GID will be dumped
 278
 279     def dump(self, dump_parents=False):
 280         print "RECORD", self.name
 281         print "        hrn:", self.name
 282         print "       type:", self.type
 283         print "        gid:"
 284         if (not self.gid):
 285             print "        None"
 286         else:
 287             self.get_gid_object().dump(8, dump_parents)
 288         print "    pointer:", self.pointer
 289
 290         print "  geni_info:"
 291         geni_info = getattr(self, "geni_info", {})
 292         if geni_info:
 293             for key in geni_info.keys():
 294                 print "       ", key, ":", geni_info[key]
 295
 296         print "    pl_info:"
 297         pl_info = getattr(self, "pl_info", {})
 298         if pl_info:
 299
 300             for key in pl_info.keys():
 301                 print "       ", key, ":", pl_info[key]
 302
 303
 304     def getdict(self):
 305         info = {'hrn': self.name, 'type': self.type, 'gid': self.gid}
 306         info.update(getattr(self, "geni_info", {}))
 307         info.update(getattr(self, "pl_info", {}))
 308         return info