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
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
10 # the driver interface, mostly provides default behaviours
11 from sfa.managers.driver import Driver
13 from sfa.plc.plshell import PlShell
15 def list_to_dict(recs, key):
17 convert a list of dictionaries into a dictionary keyed on the
18 specified dictionary key
20 return dict ( [ (rec[key],rec) for rec in recs ] )
23 # inheriting Driver is not very helpful in the PL case but
24 # makes sense in the general case
26 # PlShell is just an xmlrpc serverproxy where methods
27 # can be sent as-is; it takes care of authentication
28 # from the global config
30 # so OTOH we inherit PlShell just so one can do driver.GetNodes
31 # which would not make much sense in the context of other testbeds
32 # so ultimately PlDriver should drop the PlShell inheritance
33 # and would have a driver.shell reference to a PlShell instead
35 class PlDriver (Driver, PlShell):
37 def __init__ (self, config):
38 PlShell.__init__ (self, config)
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')
49 ########## disabled users
50 def is_enabled_entity (self, record):
51 self.fill_record_info(record)
52 if record['type'] == 'user':
53 return record['enabled']
54 # only users can be disabled
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)
62 if type == 'authority':
63 sites = self.GetSites([pl_record['login_base']])
65 pointer = self.AddSite(pl_record)
67 pointer = sites[0]['site_id']
70 acceptable_fields=['url', 'instantiation', 'name', 'description']
71 for key in pl_record.keys():
72 if key not in acceptable_fields:
74 slices = self.GetSlices([pl_record['name']])
76 pointer = self.AddSlice(pl_record)
78 pointer = slices[0]['slice_id']
81 persons = self.GetPersons([sfa_record['email']])
83 pointer = self.AddPerson(dict(sfa_record))
85 pointer = persons[0]['person_id']
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)
95 # What roles should this user have?
96 self.AddRoleToPerson('user', pointer)
99 self.AddPersonKey(pointer, {'key_type' : 'ssh', 'key' : pub_key})
102 login_base = hrn_to_pl_login_base(sfa_record['authority'])
103 nodes = api.driver.GetNodes([pl_record['hostname']])
105 pointer = api.driver.AddNode(login_base, pl_record)
107 pointer = nodes[0]['node_id']
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']
117 # new_key implemented for users only
118 if new_key and type not in [ 'user' ]:
119 raise UnknownSfaType(type)
121 if (type == "authority"):
122 self.UpdateSite(pointer, new_sfa_record)
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)
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...
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',
140 update_fields[key] = all_fields[key]
141 self.UpdatePerson(pointer, update_fields)
144 # must check this key against the previous one if it exists
145 persons = self.GetPersons([pointer], ['key_ids'])
147 keys = person['key_ids']
148 keys = self.GetKeys(person['key_ids'])
150 # Delete all stale keys
153 if new_key != key['key']:
154 self.DeleteKey(key['key_id'])
158 self.AddPersonKey(pointer, {'key_type': 'ssh', 'key': new_key})
161 self.UpdateNode(pointer, new_sfa_record)
167 def remove (self, sfa_record):
168 type=sfa_record['type']
169 pointer=sfa_record['pointer']
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)
180 if self.GetNodes(pointer):
181 self.DeleteNode(pointer)
182 elif type == 'authority':
183 if self.GetSites(pointer):
184 self.DeleteSite(pointer)
193 # Convert SFA fields to PLC fields for use when registering up updating
194 # registry record in the PLC database
197 def sfa_fields_to_pl_fields(self, type, hrn, sfa_record):
202 pl_record["name"] = hrn_to_pl_slicename(hrn)
203 if "instantiation" in sfa_record:
204 pl_record['instantiation']=sfa_record['instantiation']
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"])
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"]
223 pl_record["model"] = "geni"
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
239 def fill_record_info(self, records):
241 Given a (list of) SFA record, fill in the PLC specific
242 and SFA specific fields in the record.
244 if not isinstance(records, list):
247 self.fill_record_pl_info(records)
248 self.fill_record_sfa_info(records)
250 def fill_record_pl_info(self, records):
252 Fill in the planetlab specific fields of a SFA record. This
253 involves calling the appropriate PLC method to retrieve the
254 database record for the object.
256 @param record: record to fill in field (in/out param)
259 node_ids, site_ids, slice_ids = [], [], []
260 person_ids, key_ids = [], []
261 type_map = {'node': node_ids, 'authority': site_ids,
262 'slice': slice_ids, 'user': person_ids}
264 for record in records:
265 for type in type_map:
266 if type == record['type']:
267 type_map[type].append(record['pointer'])
270 nodes, sites, slices, persons, keys = {}, {}, {}, {}, {}
272 node_list = self.GetNodes(node_ids)
273 nodes = list_to_dict(node_list, 'node_id')
275 site_list = self.GetSites(site_ids)
276 sites = list_to_dict(site_list, 'site_id')
278 slice_list = self.GetSlices(slice_ids)
279 slices = list_to_dict(slice_list, 'slice_id')
281 person_list = self.GetPersons(person_ids)
282 persons = list_to_dict(person_list, 'person_id')
283 for person in persons:
284 key_ids.extend(persons[person]['key_ids'])
286 pl_records = {'node': nodes, 'authority': sites,
287 'slice': slices, 'user': persons}
290 key_list = self.GetKeys(key_ids)
291 keys = list_to_dict(key_list, 'key_id')
294 for record in records:
295 # records with pointer==-1 do not have plc info.
296 # for example, the top level authority records which are
297 # authorities, but not PL "sites"
298 if record['pointer'] == -1:
301 for type in pl_records:
302 if record['type'] == type:
303 if record['pointer'] in pl_records[type]:
304 record.update(pl_records[type][record['pointer']])
307 if record['type'] == 'user':
308 if 'key_ids' not in record:
309 logger.info("user record has no 'key_ids' - need to import from myplc ?")
311 pubkeys = [keys[key_id]['key'] for key_id in record['key_ids'] if key_id in keys]
312 record['keys'] = pubkeys
314 # fill in record hrns
315 records = self.fill_record_hrns(records)
319 def fill_record_hrns(self, records):
321 convert pl ids to hrns
325 slice_ids, person_ids, site_ids, node_ids = [], [], [], []
326 for record in records:
327 if 'site_id' in record:
328 site_ids.append(record['site_id'])
329 if 'site_ids' in record:
330 site_ids.extend(record['site_ids'])
331 if 'person_ids' in record:
332 person_ids.extend(record['person_ids'])
333 if 'slice_ids' in record:
334 slice_ids.extend(record['slice_ids'])
335 if 'node_ids' in record:
336 node_ids.extend(record['node_ids'])
339 slices, persons, sites, nodes = {}, {}, {}, {}
341 site_list = self.GetSites(site_ids, ['site_id', 'login_base'])
342 sites = list_to_dict(site_list, 'site_id')
344 person_list = self.GetPersons(person_ids, ['person_id', 'email'])
345 persons = list_to_dict(person_list, 'person_id')
347 slice_list = self.GetSlices(slice_ids, ['slice_id', 'name'])
348 slices = list_to_dict(slice_list, 'slice_id')
350 node_list = self.GetNodes(node_ids, ['node_id', 'hostname'])
351 nodes = list_to_dict(node_list, 'node_id')
353 # convert ids to hrns
354 for record in records:
355 # get all relevant data
356 type = record['type']
357 pointer = record['pointer']
363 if 'site_id' in record:
364 site = sites[record['site_id']]
365 login_base = site['login_base']
366 record['site'] = ".".join([auth_hrn, login_base])
367 if 'person_ids' in record:
368 emails = [persons[person_id]['email'] for person_id in record['person_ids'] \
369 if person_id in persons]
370 usernames = [email.split('@')[0] for email in emails]
371 person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
372 record['persons'] = person_hrns
373 if 'slice_ids' in record:
374 slicenames = [slices[slice_id]['name'] for slice_id in record['slice_ids'] \
375 if slice_id in slices]
376 slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
377 record['slices'] = slice_hrns
378 if 'node_ids' in record:
379 hostnames = [nodes[node_id]['hostname'] for node_id in record['node_ids'] \
381 node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
382 record['nodes'] = node_hrns
383 if 'site_ids' in record:
384 login_bases = [sites[site_id]['login_base'] for site_id in record['site_ids'] \
386 site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
387 record['sites'] = site_hrns
391 # aggregates is basically api.aggregates
392 def fill_record_sfa_info(self, records):
394 def startswith(prefix, values):
395 return [value for value in values if value.startswith(prefix)]
400 for record in records:
401 person_ids.extend(record.get("person_ids", []))
402 site_ids.extend(record.get("site_ids", []))
403 if 'site_id' in record:
404 site_ids.append(record['site_id'])
406 # get all pis from the sites we've encountered
407 # and store them in a dictionary keyed on site_id
410 pi_filter = {'|roles': ['pi'], '|site_ids': site_ids}
411 pi_list = self.GetPersons(pi_filter, ['person_id', 'site_ids'])
413 # we will need the pi's hrns also
414 person_ids.append(pi['person_id'])
416 # we also need to keep track of the sites these pis
418 for site_id in pi['site_ids']:
419 if site_id in site_pis:
420 site_pis[site_id].append(pi)
422 site_pis[site_id] = [pi]
424 # get sfa records for all records associated with these records.
425 # we'll replace pl ids (person_ids) with hrns from the sfa records
428 # get the sfa records
429 # xxx thgen fixme - use SfaTable hardwired for now
430 # table = self.SfaTable()
432 person_list, persons = [], {}
433 person_list = table.find({'type': 'user', 'pointer': person_ids})
434 # create a hrns keyed on the sfa record's pointer.
435 # Its possible for multiple records to have the same pointer so
436 # the dict's value will be a list of hrns.
437 persons = defaultdict(list)
438 for person in person_list:
439 persons[person['pointer']].append(person)
442 pl_person_list, pl_persons = [], {}
443 pl_person_list = self.GetPersons(person_ids, ['person_id', 'roles'])
444 pl_persons = list_to_dict(pl_person_list, 'person_id')
447 for record in records:
448 # skip records with no pl info (top level authorities)
449 #if record['pointer'] == -1:
452 type = record['type']
453 if (type == "slice"):
454 # all slice users are researchers
455 record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')
457 record['researcher'] = []
458 for person_id in record.get('person_ids', []):
459 hrns = [person['hrn'] for person in persons[person_id]]
460 record['researcher'].extend(hrns)
462 # pis at the slice's site
463 if 'site_id' in record and record['site_id'] in site_pis:
464 pl_pis = site_pis[record['site_id']]
465 pi_ids = [pi['person_id'] for pi in pl_pis]
466 for person_id in pi_ids:
467 hrns = [person['hrn'] for person in persons[person_id]]
468 record['PI'].extend(hrns)
469 record['geni_creator'] = record['PI']
471 elif (type.startswith("authority")):
473 if record['pointer'] != -1:
475 record['operator'] = []
477 for pointer in record.get('person_ids', []):
478 if pointer not in persons or pointer not in pl_persons:
479 # this means there is not sfa or pl record for this user
481 hrns = [person['hrn'] for person in persons[pointer]]
482 roles = pl_persons[pointer]['roles']
484 record['PI'].extend(hrns)
486 record['operator'].extend(hrns)
488 record['owner'].extend(hrns)
489 # xxx TODO: OrganizationName
490 elif (type == "node"):
491 sfa_info['dns'] = record.get("hostname", "")
492 # xxx TODO: URI, LatLong, IP, DNS
494 elif (type == "user"):
495 sfa_info['email'] = record.get("email", "")
496 sfa_info['geni_urn'] = hrn_to_urn(record['hrn'], 'user')
497 sfa_info['geni_certificate'] = record['gid']
498 # xxx TODO: PostalAddress, Phone
499 record.update(sfa_info)
502 def update_membership(self, oldRecord, record):
503 if record.type == "slice":
504 self.update_membership_list(oldRecord, record, 'researcher',
505 self.AddPersonToSlice,
506 self.DeletePersonFromSlice)
507 elif record.type == "authority":
508 logger.info("update_membership 'authority' not implemented")
513 def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
514 # get a list of the HRNs that are members of the old and new records
516 oldList = oldRecord.get(listName, [])
519 newList = record.get(listName, [])
521 # if the lists are the same, then we don't have to update anything
522 if (oldList == newList):
525 # build a list of the new person ids, by looking up each person to get
529 records = table.find({'type': 'user', 'hrn': newList})
531 newIdList.append(rec['pointer'])
533 # build a list of the old person ids from the person_ids field
535 oldIdList = oldRecord.get("person_ids", [])
536 containerId = oldRecord.get_pointer()
538 # if oldRecord==None, then we are doing a Register, instead of an
541 containerId = record.get_pointer()
543 # add people who are in the new list, but not the oldList
544 for personId in newIdList:
545 if not (personId in oldIdList):
546 addFunc(personId, containerId)
548 # remove people who are in the old list, but not the new list
549 for personId in oldIdList:
550 if not (personId in newIdList):
551 delFunc(personId, containerId)