sfa/plc/pldriver.py

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