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