sfa/plc/pldriver.py

   1 #
   2 from sfa.util.faults import MissingSfaInfo
   3 from sfa.util.sfalogging import logger
   4 from sfa.util.table import SfaTable
   5 from sfa.util.defaultdict import defaultdict
   6
   7 from sfa.util.xrn import hrn_to_urn, get_leaf
   8 from sfa.util.plxrn import slicename_to_hrn, hostname_to_hrn, hrn_to_pl_slicename, hrn_to_pl_login_base
   9
  10 # the driver interface, mostly provides default behaviours
  11 from sfa.managers.driver import Driver
  12
  13 from sfa.plc.plshell import PlShell
  14
  15 def list_to_dict(recs, key):
  16     """
  17     convert a list of dictionaries into a dictionary keyed on the
  18     specified dictionary key
  19     """
  20     keys = [rec[key] for rec in recs]
  21     return dict(zip(keys, recs))
  22
  23 #
  24 # inheriting Driver is not very helpful in the PL case but
  25 # makes sense in the general case
  26 #
  27 # PlShell is just an xmlrpc serverproxy where methods
  28 # can be sent as-is; it takes care of authentication
  29 # from the global config
  30 #
  31 # so OTOH we inherit PlShell just so one can do driver.GetNodes
  32 # which would not make much sense in the context of other testbeds
  33 # so ultimately PlDriver might just as well drop the PlShell inheritance
  34 #
  35 class PlDriver (Driver, PlShell):
  36
  37     def __init__ (self, config):
  38         PlShell.__init__ (self, config)
  39
  40         self.hrn = config.SFA_INTERFACE_HRN
  41         # xxx thgen fixme - use SfaTable hardwired for now
  42         # will need to extend generic to support multiple storage systems
  43         #self.SfaTable = SfaTable
  44         # Initialize the PLC shell only if SFA wraps a myPLC
  45         rspec_type = config.get_aggregate_type()
  46         assert (rspec_type == 'pl' or rspec_type == 'vini' or \
  47                     rspec_type == 'eucalyptus' or rspec_type == 'max')
  48
  49     ########## disabled users
  50     def is_enabled_entity (self, record, aggregates):
  51         self.fill_record_info(record, aggregates)
  52         if record['type'] == 'user':
  53             return record['enabled']
  54         # only users can be disabled
  55         return True
  56
  57     ##########
  58     def register (self, hrn, sfa_record, pub_key):
  59         type = sfa_record['type']
  60         pl_record = self.sfa_fields_to_pl_fields(type, hrn, sfa_record)
  61
  62         if type == 'authority':
  63             sites = self.GetSites([pl_record['login_base']])
  64             if not sites:
  65                 pointer = self.AddSite(pl_record)
  66             else:
  67                 pointer = sites[0]['site_id']
  68
  69         elif type == 'slice':
  70             acceptable_fields=['url', 'instantiation', 'name', 'description']
  71             for key in pl_record.keys():
  72                 if key not in acceptable_fields:
  73                     pl_record.pop(key)
  74             slices = self.GetSlices([pl_record['name']])
  75             if not slices:
  76                  pointer = self.AddSlice(pl_record)
  77             else:
  78                  pointer = slices[0]['slice_id']
  79
  80         elif type == 'user':
  81             persons = self.GetPersons([sfa_record['email']])
  82             if not persons:
  83                 pointer = self.AddPerson(dict(sfa_record))
  84             else:
  85                 pointer = persons[0]['person_id']
  86
  87             if 'enabled' in sfa_record and sfa_record['enabled']:
  88                 self.UpdatePerson(pointer, {'enabled': sfa_record['enabled']})
  89             # add this person to the site only if she is being added for the first
  90             # time by sfa and doesont already exist in plc
  91             if not persons or not persons[0]['site_ids']:
  92                 login_base = get_leaf(sfa_record['authority'])
  93                 self.AddPersonToSite(pointer, login_base)
  94
  95             # What roles should this user have?
  96             self.AddRoleToPerson('user', pointer)
  97             # Add the user's key
  98             if pub_key:
  99                 self.AddPersonKey(pointer, {'key_type' : 'ssh', 'key' : pub_key})
 100
 101         elif type == 'node':
 102             login_base = hrn_to_pl_login_base(sfa_record['authority'])
 103             nodes = api.driver.GetNodes([pl_record['hostname']])
 104             if not nodes:
 105                 pointer = api.driver.AddNode(login_base, pl_record)
 106             else:
 107                 pointer = nodes[0]['node_id']
 108
 109         return pointer
 110
 111     def remove (self, sfa_record):
 112         type=sfa_record['type']
 113         pointer=sfa_record['pointer']
 114         if type == 'user':
 115             persons = self.GetPersons(pointer)
 116             # only delete this person if he has site ids. if he doesnt, it probably means
 117             # he was just removed from a site, not actually deleted
 118             if persons and persons[0]['site_ids']:
 119                 self.DeletePerson(pointer)
 120         elif type == 'slice':
 121             if self.GetSlices(pointer):
 122                 self.DeleteSlice(pointer)
 123         elif type == 'node':
 124             if self.GetNodes(pointer):
 125                 self.DeleteNode(pointer)
 126         elif type == 'authority':
 127             if self.GetSites(pointer):
 128                 self.DeleteSite(pointer)
 129
 130
 131
 132
 133
 134     ##
 135     # Convert SFA fields to PLC fields for use when registering up updating
 136     # registry record in the PLC database
 137     #
 138
 139     def sfa_fields_to_pl_fields(self, type, hrn, sfa_record):
 140
 141         pl_record = {}
 142
 143         if type == "slice":
 144             pl_record["name"] = hrn_to_pl_slicename(hrn)
 145             if "instantiation" in sfa_record:
 146                 pl_record['instantiation']=sfa_record['instantiation']
 147             else:
 148                 pl_record["instantiation"] = "plc-instantiated"
 149             if "url" in sfa_record:
 150                pl_record["url"] = sfa_record["url"]
 151             if "description" in sfa_record:
 152                 pl_record["description"] = sfa_record["description"]
 153             if "expires" in sfa_record:
 154                 pl_record["expires"] = int(sfa_record["expires"])
 155
 156         elif type == "node":
 157             if not "hostname" in pl_record:
 158                 # fetch from sfa_record
 159                 if "hostname" not in sfa_record:
 160                     raise MissingSfaInfo("hostname")
 161                 pl_record["hostname"] = sfa_record["hostname"]
 162             if "model" in sfa_record:
 163                 pl_record["model"] = sfa_record["model"]
 164             else:
 165                 pl_record["model"] = "geni"
 166
 167         elif type == "authority":
 168             pl_record["login_base"] = hrn_to_pl_login_base(hrn)
 169             if "name" not in sfa_record:
 170                 pl_record["name"] = hrn
 171             if "abbreviated_name" not in sfa_record:
 172                 pl_record["abbreviated_name"] = hrn
 173             if "enabled" not in sfa_record:
 174                 pl_record["enabled"] = True
 175             if "is_public" not in sfa_record:
 176                 pl_record["is_public"] = True
 177
 178         return pl_record
 179
 180     ####################
 181     def fill_record_info(self, records, aggregates):
 182         """
 183         Given a (list of) SFA record, fill in the PLC specific
 184         and SFA specific fields in the record.
 185         """
 186         if not isinstance(records, list):
 187             records = [records]
 188
 189         self.fill_record_pl_info(records)
 190         self.fill_record_sfa_info(records, aggregates)
 191
 192     def fill_record_pl_info(self, records):
 193         """
 194         Fill in the planetlab specific fields of a SFA record. This
 195         involves calling the appropriate PLC method to retrieve the
 196         database record for the object.
 197
 198         PLC data is filled into the pl_info field of the record.
 199
 200         @param record: record to fill in field (in/out param)
 201         """
 202         # get ids by type
 203         node_ids, site_ids, slice_ids = [], [], []
 204         person_ids, key_ids = [], []
 205         type_map = {'node': node_ids, 'authority': site_ids,
 206                     'slice': slice_ids, 'user': person_ids}
 207
 208         for record in records:
 209             for type in type_map:
 210                 if type == record['type']:
 211                     type_map[type].append(record['pointer'])
 212
 213         # get pl records
 214         nodes, sites, slices, persons, keys = {}, {}, {}, {}, {}
 215         if node_ids:
 216             node_list = self.GetNodes(node_ids)
 217             nodes = list_to_dict(node_list, 'node_id')
 218         if site_ids:
 219             site_list = self.GetSites(site_ids)
 220             sites = list_to_dict(site_list, 'site_id')
 221         if slice_ids:
 222             slice_list = self.GetSlices(slice_ids)
 223             slices = list_to_dict(slice_list, 'slice_id')
 224         if person_ids:
 225             person_list = self.GetPersons(person_ids)
 226             persons = list_to_dict(person_list, 'person_id')
 227             for person in persons:
 228                 key_ids.extend(persons[person]['key_ids'])
 229
 230         pl_records = {'node': nodes, 'authority': sites,
 231                       'slice': slices, 'user': persons}
 232
 233         if key_ids:
 234             key_list = self.GetKeys(key_ids)
 235             keys = list_to_dict(key_list, 'key_id')
 236
 237         # fill record info
 238         for record in records:
 239             # records with pointer==-1 do not have plc info.
 240             # for example, the top level authority records which are
 241             # authorities, but not PL "sites"
 242             if record['pointer'] == -1:
 243                 continue
 244
 245             for type in pl_records:
 246                 if record['type'] == type:
 247                     if record['pointer'] in pl_records[type]:
 248                         record.update(pl_records[type][record['pointer']])
 249                         break
 250             # fill in key info
 251             if record['type'] == 'user':
 252                 if 'key_ids' not in record:
 253                     logger.info("user record has no 'key_ids' - need to import from myplc ?")
 254                 else:
 255                     pubkeys = [keys[key_id]['key'] for key_id in record['key_ids'] if key_id in keys]
 256                     record['keys'] = pubkeys
 257
 258         # fill in record hrns
 259         records = self.fill_record_hrns(records)
 260
 261         return records
 262
 263     def fill_record_hrns(self, records):
 264         """
 265         convert pl ids to hrns
 266         """
 267
 268         # get ids
 269         slice_ids, person_ids, site_ids, node_ids = [], [], [], []
 270         for record in records:
 271             if 'site_id' in record:
 272                 site_ids.append(record['site_id'])
 273             if 'site_ids' in record:
 274                 site_ids.extend(record['site_ids'])
 275             if 'person_ids' in record:
 276                 person_ids.extend(record['person_ids'])
 277             if 'slice_ids' in record:
 278                 slice_ids.extend(record['slice_ids'])
 279             if 'node_ids' in record:
 280                 node_ids.extend(record['node_ids'])
 281
 282         # get pl records
 283         slices, persons, sites, nodes = {}, {}, {}, {}
 284         if site_ids:
 285             site_list = self.GetSites(site_ids, ['site_id', 'login_base'])
 286             sites = list_to_dict(site_list, 'site_id')
 287         if person_ids:
 288             person_list = self.GetPersons(person_ids, ['person_id', 'email'])
 289             persons = list_to_dict(person_list, 'person_id')
 290         if slice_ids:
 291             slice_list = self.GetSlices(slice_ids, ['slice_id', 'name'])
 292             slices = list_to_dict(slice_list, 'slice_id')
 293         if node_ids:
 294             node_list = self.GetNodes(node_ids, ['node_id', 'hostname'])
 295             nodes = list_to_dict(node_list, 'node_id')
 296
 297         # convert ids to hrns
 298         for record in records:
 299             # get all relevant data
 300             type = record['type']
 301             pointer = record['pointer']
 302             auth_hrn = self.hrn
 303             login_base = ''
 304             if pointer == -1:
 305                 continue
 306
 307             if 'site_id' in record:
 308                 site = sites[record['site_id']]
 309                 login_base = site['login_base']
 310                 record['site'] = ".".join([auth_hrn, login_base])
 311             if 'person_ids' in record:
 312                 emails = [persons[person_id]['email'] for person_id in record['person_ids'] \
 313                           if person_id in  persons]
 314                 usernames = [email.split('@')[0] for email in emails]
 315                 person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
 316                 record['persons'] = person_hrns
 317             if 'slice_ids' in record:
 318                 slicenames = [slices[slice_id]['name'] for slice_id in record['slice_ids'] \
 319                               if slice_id in slices]
 320                 slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
 321                 record['slices'] = slice_hrns
 322             if 'node_ids' in record:
 323                 hostnames = [nodes[node_id]['hostname'] for node_id in record['node_ids'] \
 324                              if node_id in nodes]
 325                 node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
 326                 record['nodes'] = node_hrns
 327             if 'site_ids' in record:
 328                 login_bases = [sites[site_id]['login_base'] for site_id in record['site_ids'] \
 329                                if site_id in sites]
 330                 site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
 331                 record['sites'] = site_hrns
 332
 333         return records
 334
 335     # aggregates is basically api.aggregates
 336     def fill_record_sfa_info(self, records, aggregates):
 337
 338         def startswith(prefix, values):
 339             return [value for value in values if value.startswith(prefix)]
 340
 341         # get person ids
 342         person_ids = []
 343         site_ids = []
 344         for record in records:
 345             person_ids.extend(record.get("person_ids", []))
 346             site_ids.extend(record.get("site_ids", []))
 347             if 'site_id' in record:
 348                 site_ids.append(record['site_id'])
 349
 350         # get all pis from the sites we've encountered
 351         # and store them in a dictionary keyed on site_id
 352         site_pis = {}
 353         if site_ids:
 354             pi_filter = {'|roles': ['pi'], '|site_ids': site_ids}
 355             pi_list = self.GetPersons(pi_filter, ['person_id', 'site_ids'])
 356             for pi in pi_list:
 357                 # we will need the pi's hrns also
 358                 person_ids.append(pi['person_id'])
 359
 360                 # we also need to keep track of the sites these pis
 361                 # belong to
 362                 for site_id in pi['site_ids']:
 363                     if site_id in site_pis:
 364                         site_pis[site_id].append(pi)
 365                     else:
 366                         site_pis[site_id] = [pi]
 367
 368         # get sfa records for all records associated with these records.
 369         # we'll replace pl ids (person_ids) with hrns from the sfa records
 370         # we obtain
 371
 372         # get the sfa records
 373         # xxx thgen fixme - use SfaTable hardwired for now
 374         # table = self.SfaTable()
 375         table = SfaTable()
 376         person_list, persons = [], {}
 377         person_list = table.find({'type': 'user', 'pointer': person_ids})
 378         # create a hrns keyed on the sfa record's pointer.
 379         # Its possible for multiple records to have the same pointer so
 380         # the dict's value will be a list of hrns.
 381         persons = defaultdict(list)
 382         for person in person_list:
 383             persons[person['pointer']].append(person)
 384
 385         # get the pl records
 386         pl_person_list, pl_persons = [], {}
 387         pl_person_list = self.GetPersons(person_ids, ['person_id', 'roles'])
 388         pl_persons = list_to_dict(pl_person_list, 'person_id')
 389
 390         # fill sfa info
 391         for record in records:
 392             # skip records with no pl info (top level authorities)
 393             #if record['pointer'] == -1:
 394             #    continue
 395             sfa_info = {}
 396             type = record['type']
 397             if (type == "slice"):
 398                 # all slice users are researchers
 399                 record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')
 400                 record['PI'] = []
 401                 record['researcher'] = []
 402                 for person_id in record.get('person_ids', []):
 403                     hrns = [person['hrn'] for person in persons[person_id]]
 404                     record['researcher'].extend(hrns)
 405
 406                 # pis at the slice's site
 407                 if 'site_id' in record and record['site_id'] in site_pis:
 408                     pl_pis = site_pis[record['site_id']]
 409                     pi_ids = [pi['person_id'] for pi in pl_pis]
 410                     for person_id in pi_ids:
 411                         hrns = [person['hrn'] for person in persons[person_id]]
 412                         record['PI'].extend(hrns)
 413                         record['geni_creator'] = record['PI']
 414
 415             elif (type.startswith("authority")):
 416                 record['url'] = None
 417                 if record['hrn'] in aggregates:
 418
 419                     record['url'] = aggregates[record['hrn']].get_url()
 420
 421                 if record['pointer'] != -1:
 422                     record['PI'] = []
 423                     record['operator'] = []
 424                     record['owner'] = []
 425                     for pointer in record.get('person_ids', []):
 426                         if pointer not in persons or pointer not in pl_persons:
 427                             # this means there is not sfa or pl record for this user
 428                             continue
 429                         hrns = [person['hrn'] for person in persons[pointer]]
 430                         roles = pl_persons[pointer]['roles']
 431                         if 'pi' in roles:
 432                             record['PI'].extend(hrns)
 433                         if 'tech' in roles:
 434                             record['operator'].extend(hrns)
 435                         if 'admin' in roles:
 436                             record['owner'].extend(hrns)
 437                         # xxx TODO: OrganizationName
 438             elif (type == "node"):
 439                 sfa_info['dns'] = record.get("hostname", "")
 440                 # xxx TODO: URI, LatLong, IP, DNS
 441
 442             elif (type == "user"):
 443                 sfa_info['email'] = record.get("email", "")
 444                 sfa_info['geni_urn'] = hrn_to_urn(record['hrn'], 'user')
 445                 sfa_info['geni_certificate'] = record['gid']
 446                 # xxx TODO: PostalAddress, Phone
 447             record.update(sfa_info)
 448
 449     ####################
 450     def update_membership(self, oldRecord, record):
 451         if record.type == "slice":
 452             self.update_membership_list(oldRecord, record, 'researcher',
 453                                         self.AddPersonToSlice,
 454                                         self.DeletePersonFromSlice)
 455         elif record.type == "authority":
 456             logger.info("update_membership 'autority' not implemented")
 457             pass
 458         else:
 459             pass
 460
 461     def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
 462         # get a list of the HRNs that are members of the old and new records
 463         if oldRecord:
 464             oldList = oldRecord.get(listName, [])
 465         else:
 466             oldList = []
 467         newList = record.get(listName, [])
 468
 469         # if the lists are the same, then we don't have to update anything
 470         if (oldList == newList):
 471             return
 472
 473         # build a list of the new person ids, by looking up each person to get
 474         # their pointer
 475         newIdList = []
 476         # xxx thgen fixme - use SfaTable hardwired for now
 477         #table = self.SfaTable()
 478         table = SfaTable()
 479         records = table.find({'type': 'user', 'hrn': newList})
 480         for rec in records:
 481             newIdList.append(rec['pointer'])
 482
 483         # build a list of the old person ids from the person_ids field
 484         if oldRecord:
 485             oldIdList = oldRecord.get("person_ids", [])
 486             containerId = oldRecord.get_pointer()
 487         else:
 488             # if oldRecord==None, then we are doing a Register, instead of an
 489             # update.
 490             oldIdList = []
 491             containerId = record.get_pointer()
 492
 493     # add people who are in the new list, but not the oldList
 494         for personId in newIdList:
 495             if not (personId in oldIdList):
 496                 addFunc(personId, containerId)
 497
 498         # remove people who are in the old list, but not the new list
 499         for personId in oldIdList:
 500             if not (personId in newIdList):
 501                 delFunc(personId, containerId)