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         self.pl_info = pl_info
 110         self.dirty = True
 111
 112     ##
 113     # Set the geni info the record
 114     #
 115     # @param geni_info is a dictionary containing geni info
 116
 117     def set_geni_info(self, geni_info):
 118         self.geni_info = geni_info
 119         self.dirty = True
 120
 121     ##
 122     # Return the pl_info of the record, or an empty dictionary if none exists
 123
 124     def get_pl_info(self):
 125         if self.pl_info:
 126             return self.pl_info
 127         else:
 128             return {}
 129
 130     ##
 131     # Return the geni_info of the record, or an empty dictionary if none exists
 132
 133     def get_geni_info(self):
 134         if self.geni_info:
 135             return self.geni_info
 136         else:
 137             return {}
 138
 139     ##
 140     # Return the name (HRN) of the record
 141
 142     def get_name(self):
 143         return self.name
 144
 145     ##
 146     # Return the type of the record
 147
 148     def get_type(self):
 149         return self.type
 150
 151     ##
 152     # Return the pointer of the record. The pointer is an integer that may be
 153     # used to look up the record in the PLC database. The evaluation of pointer
 154     # depends on the type of the record
 155
 156     def get_pointer(self):
 157         return self.pointer
 158
 159     ##
 160     # Return the GID of the record, in the form of a GID object
 161     # TODO: not the best name for the function, because we have things called
 162     # gidObjects in the Cred
 163
 164     def get_gid_object(self):
 165         return GID(string=self.gid)
 166
 167     ##
 168     # Return a key that uniquely identifies this record among all records in
 169     # Geni. This key is used to uniquely identify the record in the Geni
 170     # database.
 171
 172     def get_key(self):
 173         return self.name + "#" + self.type
 174
 175     ##
 176     # Returns a list of field names in this record. pl_info, geni_info are not
 177     # included because they are not part of the record that is stored in the
 178     # database, but are rather computed values from other entities
 179
 180     def get_field_names(self):
 181         return ["name", "gid", "type", "pointer"]
 182
 183     ##
 184     # Given a field name ("name", "gid", ...) return the value of that field.
 185     #
 186     # @param name is the name of field to be returned
 187
 188     def get_field_value_string(self, fieldname):
 189         if fieldname == "key":
 190             val = self.get_key()
 191         else:
 192             val = getattr(self, fieldname)
 193         if isinstance(val, str):
 194             return "'" + str(val) + "'"
 195         else:
 196             return str(val)
 197
 198     ##
 199     # Given a list of field names, return a list of values for those fields.
 200     #
 201     # @param fieldnames is a list of field names
 202
 203     def get_field_value_strings(self, fieldnames):
 204         strs = []
 205         for fieldname in fieldnames:
 206             strs.append(self.get_field_value_string(fieldname))
 207         return strs
 208
 209     ##
 210     # Return the record in the form of a dictionary
 211
 212     def as_dict(self):
 213         dict = {}
 214         names = self.get_field_names()
 215         for name in names:
 216             dict[name] = getattr(self, name)
 217
 218         if self.pl_info:
 219             dict['pl_info'] = self.pl_info
 220
 221         if self.geni_info:
 222             dict['geni_info'] = self.geni_info
 223
 224         return dict
 225
 226     ##
 227     # Load the record from a dictionary
 228     #
 229     # @param dict dictionary to load record fields from
 230
 231     def load_from_dict(self, dict):
 232         self.set_name(dict['name'])
 233         gidstr = dict.get("gid", None)
 234         if gidstr:
 235             self.set_gid(dict['gid'])
 236
 237         self.set_type(dict['type'])
 238         self.set_pointer(dict['pointer'])
 239         if "pl_info" in dict:
 240            self.set_pl_info(dict["pl_info"])
 241         if "geni_info" in dict:
 242            self.set_geni_info(dict["geni_info"])
 243
 244     ##
 245     # Save the record to a string. The string contains an XML representation of
 246     # the record.
 247
 248     def save_to_string(self):
 249
 250         dict = self.as_dict()
 251         record = RecordSpec()
 252         record.parseDict(dict)
 253         str = record.toxml()
 254         #str = xmlrpclib.dumps((dict,), allow_none=True)
 255         return str
 256
 257     ##
 258     # Load the record from a string. The string is assumed to contain an XML
 259     # representation of the record.
 260
 261     def load_from_string(self, str):
 262         #dict = xmlrpclib.loads(str)[0][0]
 263
 264         record = RecordSpec()
 265         record.parseString(str)
 266         record_dict = record.toDict()
 267         geni_dict = record_dict['record']
 268         self.load_from_dict(geni_dict)
 269
 270     ##
 271     # Dump the record to stdout
 272     #
 273     # @param dump_parents if true, then the parents of the GID will be dumped
 274
 275     def dump(self, dump_parents=False):
 276         print "RECORD", self.name
 277         print "        hrn:", self.name
 278         print "       type:", self.type
 279         print "        gid:"
 280         if (not self.gid):
 281             print "        None"
 282         else:
 283             self.get_gid_object().dump(8, dump_parents)
 284         print "    pointer:", self.pointer
 285
 286         print "  geni_info:"
 287         geni_info = getattr(self, "geni_info", {})
 288         if geni_info:
 289             for key in geni_info.keys():
 290                 print "       ", key, ":", geni_info[key]
 291
 292         print "    pl_info:"
 293         pl_info = getattr(self, "pl_info", {})
 294         if pl_info:
 295
 296             for key in pl_info.keys():
 297                 print "       ", key, ":", pl_info[key]
 298
 299
 300     def getdict(self):
 301         info = {'hrn': self.name, 'type': self.type, 'gid': self.gid}
 302         info.update(getattr(self, "geni_info", {}))
 303         info.update(getattr(self, "pl_info", {}))
 304         return info