sfa/senslab/slabdriver.py

   1 import sys
   2
   3 from sfa.util.faults import MissingSfaInfo
   4 from sfa.util.sfalogging import logger
   5 from sfa.util.table import SfaTable
   6 from sfa.util.defaultdict import defaultdict
   7
   8 from sfa.util.xrn import hrn_to_urn
   9 from sfa.util.plxrn import slicename_to_hrn, hostname_to_hrn, hrn_to_pl_slicename, hrn_to_pl_login_base
  10
  11 ## thierry: everything that is API-related (i.e. handling incoming requests)
  12 # is taken care of
  13 # SlabDriver should be really only about talking to the senslab testbed
  14
  15 ## thierry : please avoid wildcard imports :)
  16 from sfa.senslab.OARrestapi import OARapi
  17 from sfa.senslab.LDAPapi import LDAPapi
  18 from sfa.senslab.SenslabImportUsers import SenslabImportUsers
  19 from sfa.senslab.parsing import parse_filter
  20
  21 def list_to_dict(recs, key):
  22     """
  23     convert a list of dictionaries into a dictionary keyed on the
  24     specified dictionary key
  25     """
  26    # print>>sys.stderr, " \r\n \t\t 1list_to_dict : rec %s  \r\n \t\t list_to_dict key %s" %(recs,key)
  27     keys = [rec[key] for rec in recs]
  28     #print>>sys.stderr, " \r\n \t\t list_to_dict : rec %s  \r\n \t\t list_to_dict keys %s" %(recs,keys)
  29     return dict(zip(keys, recs))
  30
  31 # thierry : note
  32 # this inheritance scheme is so that the driver object can receive
  33 # GetNodes or GetSites sorts of calls directly
  34 # and thus minimize the differences in the managers with the pl version
  35 class SlabDriver ():
  36
  37     def __init__(self, config):
  38
  39         self.config=config
  40         self.hrn = config.SFA_INTERFACE_HRN
  41
  42         self.root_auth = config.SFA_REGISTRY_ROOT_AUTH
  43
  44
  45         print >>sys.stderr, "\r\n_____________ SFA SENSLAB DRIVER \r\n"
  46         # thierry - just to not break the rest of this code
  47         #self.oar = OARapi()
  48         #self.users = SenslabImportUsers()
  49         self.oar = OARapi()
  50         self.ldap = LDAPapi()
  51         self.users = SenslabImportUsers()
  52         self.time_format = "%Y-%m-%d %H:%M:%S"
  53         #self.logger=sfa_logger()
  54
  55
  56     def GetPersons(self, person_filter=None, return_fields=None):
  57
  58         person_list = self.ldap.ldapFind({'authority': self.root_auth })
  59         print>>sys.stderr, " \r\n \t\t SLABDRIVER.PY : GetPersons ldapfind rslt \r\n \t %s "%(person_list)
  60         return_person_list = parse_filter(person_list,person_filter ,'persons', return_fields)
  61         print>>sys.stderr, " \r\n \t\t SLABDRIVER.PY : GetPersons parse_filter \r\n \t %s "%(return_person_list)
  62         return return_person_list
  63
  64     def GetNodes(self,node_filter= None, return_fields=None):
  65
  66         self.oar.parser.SendRequest("GET_resources_full")
  67         node_dict = self.oar.parser.GetNodesFromOARParse()
  68         return_node_list = []
  69
  70         if not (node_filter or return_fields):
  71                 return_node_list = node_dict.values()
  72                 return return_node_list
  73
  74         return_node_list= parse_filter(node_dict.values(),node_filter ,'node', return_fields)
  75         return return_node_list
  76
  77     ##
  78     # Convert SFA fields to PLC fields for use when registering up updating
  79     # registry record in the PLC database
  80     #
  81     # @param type type of record (user, slice, ...)
  82     # @param hrn human readable name
  83     # @param sfa_fields dictionary of SFA fields
  84     # @param pl_fields dictionary of PLC fields (output)
  85
  86     def sfa_fields_to_pl_fields(self, type, hrn, record):
  87
  88         def convert_ints(tmpdict, int_fields):
  89             for field in int_fields:
  90                 if field in tmpdict:
  91                     tmpdict[field] = int(tmpdict[field])
  92
  93         pl_record = {}
  94         #for field in record:
  95         #    pl_record[field] = record[field]
  96
  97         if type == "slice":
  98             if not "instantiation" in pl_record:
  99                 pl_record["instantiation"] = "plc-instantiated"
 100             pl_record["name"] = hrn_to_pl_slicename(hrn)
 101             if "url" in record:
 102                pl_record["url"] = record["url"]
 103             if "description" in record:
 104                 pl_record["description"] = record["description"]
 105             if "expires" in record:
 106                 pl_record["expires"] = int(record["expires"])
 107
 108         elif type == "node":
 109             if not "hostname" in pl_record:
 110                 if not "hostname" in record:
 111                     raise MissingSfaInfo("hostname")
 112                 pl_record["hostname"] = record["hostname"]
 113             if not "model" in pl_record:
 114                 pl_record["model"] = "geni"
 115
 116         elif type == "authority":
 117             pl_record["login_base"] = hrn_to_pl_login_base(hrn)
 118
 119             if not "name" in pl_record:
 120                 pl_record["name"] = hrn
 121
 122             if not "abbreviated_name" in pl_record:
 123                 pl_record["abbreviated_name"] = hrn
 124
 125             if not "enabled" in pl_record:
 126                 pl_record["enabled"] = True
 127
 128             if not "is_public" in pl_record:
 129                 pl_record["is_public"] = True
 130
 131         return pl_record
 132
 133     def fill_record_pl_info(self, records):
 134         """
 135         Fill in the planetlab specific fields of a SFA record. This
 136         involves calling the appropriate PLC method to retrieve the
 137         database record for the object.
 138
 139         PLC data is filled into the pl_info field of the record.
 140
 141         @param record: record to fill in field (in/out param)
 142         """
 143         # get ids by type
 144         #print>>sys.stderr, "\r\n \r\rn \t\t >>>>>>>>>>fill_record_pl_info  records %s : "%(records)
 145         node_ids, site_ids, slice_ids = [], [], []
 146         person_ids, key_ids = [], []
 147         type_map = {'node': node_ids, 'authority': site_ids,
 148                     'slice': slice_ids, 'user': person_ids}
 149
 150         for record in records:
 151             for type in type_map:
 152                 #print>>sys.stderr, "\r\n \t\t \t fill_record_pl_info : type %s. record['pointer'] %s "%(type,record['pointer'])
 153                 if type == record['type']:
 154                     type_map[type].append(record['pointer'])
 155         #print>>sys.stderr, "\r\n \t\t \t fill_record_pl_info : records %s... \r\n \t\t \t fill_record_pl_info : type_map   %s"%(records,type_map)
 156         # get pl records
 157         nodes, sites, slices, persons, keys = {}, {}, {}, {}, {}
 158         if node_ids:
 159             node_list = self.GetNodes( node_ids)
 160             #print>>sys.stderr, " \r\n \t\t\t BEFORE LIST_TO_DICT_NODES node_ids : %s" %(node_ids)
 161             nodes = list_to_dict(node_list, 'node_id')
 162         if site_ids:
 163             site_list = self.oar.GetSites( site_ids)
 164             sites = list_to_dict(site_list, 'site_id')
 165             #print>>sys.stderr, " \r\n \t\t\t  site_ids %s sites  : %s" %(site_ids,sites)
 166         if slice_ids:
 167             slice_list = self.users.GetSlices( slice_ids)
 168             slices = list_to_dict(slice_list, 'slice_id')
 169         if person_ids:
 170             #print>>sys.stderr, " \r\n \t\t \t fill_record_pl_info BEFORE GetPersons  person_ids: %s" %(person_ids)
 171             person_list = self.GetPersons( person_ids)
 172             persons = list_to_dict(person_list, 'person_id')
 173             #print>>sys.stderr, "\r\n  fill_record_pl_info persons %s \r\n \t\t person_ids %s " %(persons, person_ids)
 174             for person in persons:
 175                 key_ids.extend(persons[person]['key_ids'])
 176                 #print>>sys.stderr, "\r\n key_ids %s " %(key_ids)
 177
 178         pl_records = {'node': nodes, 'authority': sites,
 179                       'slice': slices, 'user': persons}
 180
 181         if key_ids:
 182             key_list = self.users.GetKeys( key_ids)
 183             keys = list_to_dict(key_list, 'key_id')
 184            # print>>sys.stderr, "\r\n  fill_record_pl_info persons %s \r\n \t\t keys %s " %(keys)
 185         # fill record info
 186         for record in records:
 187             # records with pointer==-1 do not have plc info.
 188             # for example, the top level authority records which are
 189             # authorities, but not PL "sites"
 190             if record['pointer'] == -1:
 191                 continue
 192
 193             for type in pl_records:
 194                 if record['type'] == type:
 195                     if record['pointer'] in pl_records[type]:
 196                         record.update(pl_records[type][record['pointer']])
 197                         break
 198             # fill in key info
 199             if record['type'] == 'user':
 200                  if 'key_ids' not in record:
 201                         #print>>sys.stderr, " NO_KEY_IDS fill_record_pl_info key_ids record: %s" %(record)
 202                         logger.info("user record has no 'key_ids' - need to import  ?")
 203                  else:
 204                         pubkeys = [keys[key_id]['key'] for key_id in record['key_ids'] if key_id in keys]
 205                         record['keys'] = pubkeys
 206
 207         #print>>sys.stderr, "\r\n \r\rn \t\t <<<<<<<<<<<<<<<<<< fill_record_pl_info  records %s : "%(records)
 208         # fill in record hrns
 209         records = self.fill_record_hrns(records)
 210
 211         return records
 212
 213     def fill_record_hrns(self, records):
 214         """
 215         convert pl ids to hrns
 216         """
 217         #print>>sys.stderr, "\r\n \r\rn \t\t \t >>>>>>>>>>>>>>>>>>>>>> fill_record_hrns records %s : "%(records)
 218         # get ids
 219         slice_ids, person_ids, site_ids, node_ids = [], [], [], []
 220         for record in records:
 221             #print>>sys.stderr, "\r\n \r\rn \t\t \t record %s : "%(record)
 222             if 'site_id' in record:
 223                 site_ids.append(record['site_id'])
 224             if 'site_ids' in records:
 225                 site_ids.extend(record['site_ids'])
 226             if 'person_ids' in record:
 227                 person_ids.extend(record['person_ids'])
 228             if 'slice_ids' in record:
 229                 slice_ids.extend(record['slice_ids'])
 230             if 'node_ids' in record:
 231                 node_ids.extend(record['node_ids'])
 232
 233         # get pl records
 234         slices, persons, sites, nodes = {}, {}, {}, {}
 235         if site_ids:
 236             site_list = self.oar.GetSites( site_ids, ['site_id', 'login_base'])
 237             sites = list_to_dict(site_list, 'site_id')
 238             #print>>sys.stderr, " \r\n \r\n \t\t ____ site_list %s \r\n \t\t____ sites %s " % (site_list,sites)
 239         if person_ids:
 240             person_list = self.GetPersons( person_ids, ['person_id', 'email'])
 241             #print>>sys.stderr, " \r\n \r\n   \t\t____ person_lists %s " %(person_list)
 242             persons = list_to_dict(person_list, 'person_id')
 243         if slice_ids:
 244             slice_list = self.users.GetSlices( slice_ids, ['slice_id', 'name'])
 245             slices = list_to_dict(slice_list, 'slice_id')
 246         if node_ids:
 247             node_list = self.GetNodes( node_ids, ['node_id', 'hostname'])
 248             nodes = list_to_dict(node_list, 'node_id')
 249
 250         # convert ids to hrns
 251         for record in records:
 252
 253             # get all relevant data
 254             type = record['type']
 255             pointer = record['pointer']
 256             auth_hrn = self.hrn
 257             login_base = ''
 258             if pointer == -1:
 259                 continue
 260
 261             #print>>sys.stderr, " \r\n \r\n \t\t fill_record_hrns : sites %s \r\n \t\t record %s " %(sites, record)
 262             if 'site_id' in record:
 263                 site = sites[record['site_id']]
 264                 #print>>sys.stderr, " \r\n \r\n \t\t \t fill_record_hrns : sites %s \r\n \t\t\t site sites[record['site_id']] %s " %(sites,site)
 265                 login_base = site['login_base']
 266                 record['site'] = ".".join([auth_hrn, login_base])
 267             if 'person_ids' in record:
 268                 emails = [persons[person_id]['email'] for person_id in record['person_ids'] \
 269                           if person_id in  persons]
 270                 usernames = [email.split('@')[0] for email in emails]
 271                 person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
 272                 #print>>sys.stderr, " \r\n \r\n \t\t ____ person_hrns : %s " %(person_hrns)
 273                 record['persons'] = person_hrns
 274             if 'slice_ids' in record:
 275                 slicenames = [slices[slice_id]['name'] for slice_id in record['slice_ids'] \
 276                               if slice_id in slices]
 277                 slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
 278                 record['slices'] = slice_hrns
 279             if 'node_ids' in record:
 280                 hostnames = [nodes[node_id]['hostname'] for node_id in record['node_ids'] \
 281                              if node_id in nodes]
 282                 node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
 283                 record['nodes'] = node_hrns
 284             if 'site_ids' in record:
 285                 login_bases = [sites[site_id]['login_base'] for site_id in record['site_ids'] \
 286                                if site_id in sites]
 287                 site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
 288                 record['sites'] = site_hrns
 289         #print>>sys.stderr, "\r\n \r\rn \t\t \t <<<<<<<<<<<<<<<<<<<<<<<<  fill_record_hrns records %s : "%(records)
 290         return records
 291
 292     def fill_record_sfa_info(self, records):
 293
 294         def startswith(prefix, values):
 295             return [value for value in values if value.startswith(prefix)]
 296
 297         SenslabUsers = SenslabImportUsers()
 298         # get person ids
 299         person_ids = []
 300         site_ids = []
 301         for record in records:
 302             person_ids.extend(record.get("person_ids", []))
 303             site_ids.extend(record.get("site_ids", []))
 304             if 'site_id' in record:
 305                 site_ids.append(record['site_id'])
 306
 307         #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___person_ids %s \r\n \t\t site_ids %s " %(person_ids, site_ids)
 308
 309         # get all pis from the sites we've encountered
 310         # and store them in a dictionary keyed on site_id
 311         site_pis = {}
 312         if site_ids:
 313             pi_filter = {'|roles': ['pi'], '|site_ids': site_ids}
 314             pi_list = self.GetPersons( pi_filter, ['person_id', 'site_ids'])
 315             #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___ GetPersons ['person_id', 'site_ids'] pi_ilist %s" %(pi_list)
 316
 317             for pi in pi_list:
 318                 # we will need the pi's hrns also
 319                 person_ids.append(pi['person_id'])
 320
 321                 # we also need to keep track of the sites these pis
 322                 # belong to
 323                 for site_id in pi['site_ids']:
 324                     if site_id in site_pis:
 325                         site_pis[site_id].append(pi)
 326                     else:
 327                         site_pis[site_id] = [pi]
 328
 329         # get sfa records for all records associated with these records.
 330         # we'll replace pl ids (person_ids) with hrns from the sfa records
 331         # we obtain
 332
 333         # get the sfa records
 334         table = SfaTable()
 335         person_list, persons = [], {}
 336         person_list = table.find({'type': 'user', 'pointer': person_ids})
 337         # create a hrns keyed on the sfa record's pointer.
 338         # Its possible for  multiple records to have the same pointer so
 339         # the dict's value will be a list of hrns.
 340         persons = defaultdict(list)
 341         for person in person_list:
 342             persons[person['pointer']].append(person)
 343
 344         # get the pl records
 345         pl_person_list, pl_persons = [], {}
 346         pl_person_list = self.GetPersons(person_ids, ['person_id', 'roles'])
 347         pl_persons = list_to_dict(pl_person_list, 'person_id')
 348         #print>>sys.stderr, "\r\n \r\n _fill_record_sfa_info ___  _list %s \r\n \t\t SenslabUsers.GetPersons ['person_id', 'roles'] pl_persons %s \r\n records %s" %(pl_person_list, pl_persons,records)
 349         # fill sfa info
 350
 351         for record in records:
 352             # skip records with no pl info (top level authorities)
 353             #Sandrine 24 oct 11 2 lines
 354             #if record['pointer'] == -1:
 355                 #continue
 356             sfa_info = {}
 357             type = record['type']
 358             if (type == "slice"):
 359                 # all slice users are researchers
 360                 #record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')  ? besoin ou pas ?
 361                 record['PI'] = []
 362                 record['researcher'] = []
 363                 for person_id in record.get('person_ids', []):
 364                          #Sandrine 24 oct 11 line
 365                 #for person_id in record['person_ids']:
 366                     hrns = [person['hrn'] for person in persons[person_id]]
 367                     record['researcher'].extend(hrns)
 368
 369                 # pis at the slice's site
 370                 pl_pis = site_pis[record['site_id']]
 371                 pi_ids = [pi['person_id'] for pi in pl_pis]
 372                 for person_id in pi_ids:
 373                     hrns = [person['hrn'] for person in persons[person_id]]
 374                     record['PI'].extend(hrns)
 375                 record['geni_urn'] = hrn_to_urn(record['hrn'], 'slice')
 376                 record['geni_creator'] = record['PI']
 377
 378             elif (type == "authority"):
 379                 record['PI'] = []
 380                 record['operator'] = []
 381                 record['owner'] = []
 382                 for pointer in record['person_ids']:
 383                     if pointer not in persons or pointer not in pl_persons:
 384                         # this means there is not sfa or pl record for this user
 385                         continue
 386                     hrns = [person['hrn'] for person in persons[pointer]]
 387                     roles = pl_persons[pointer]['roles']
 388                     if 'pi' in roles:
 389                         record['PI'].extend(hrns)
 390                     if 'tech' in roles:
 391                         record['operator'].extend(hrns)
 392                     if 'admin' in roles:
 393                         record['owner'].extend(hrns)
 394                     # xxx TODO: OrganizationName
 395             elif (type == "node"):
 396                 sfa_info['dns'] = record.get("hostname", "")
 397                 # xxx TODO: URI, LatLong, IP, DNS
 398
 399             elif (type == "user"):
 400                  sfa_info['email'] = record.get("email", "")
 401                  sfa_info['geni_urn'] = hrn_to_urn(record['hrn'], 'user')
 402                  sfa_info['geni_certificate'] = record['gid']
 403                 # xxx TODO: PostalAddress, Phone
 404
 405             #print>>sys.stderr, "\r\n \r\rn \t\t \t <<<<<<<<<<<<<<<<<<<<<<<<  fill_record_sfa_info sfa_info %s  \r\n record %s : "%(sfa_info,record)
 406             record.update(sfa_info)
 407
 408     def fill_record_info(self, records):
 409         """
 410         Given a SFA record, fill in the PLC specific and SFA specific
 411         fields in the record.
 412         """
 413         #print >>sys.stderr, "\r\n \t\t fill_record_info %s"%(records)
 414         if not isinstance(records, list):
 415             records = [records]
 416         #print >>sys.stderr, "\r\n \t\t BEFORE fill_record_pl_info %s" %(records)
 417         self.fill_record_pl_info(records)
 418         #print >>sys.stderr, "\r\n \t\t after fill_record_pl_info %s" %(records)
 419         self.fill_record_sfa_info(records)
 420         #print >>sys.stderr, "\r\n \t\t after fill_record_sfa_info"
 421
 422     def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
 423         # get a list of the HRNs tht are members of the old and new records
 424         if oldRecord:
 425             oldList = oldRecord.get(listName, [])
 426         else:
 427             oldList = []
 428         newList = record.get(listName, [])
 429
 430         # if the lists are the same, then we don't have to update anything
 431         if (oldList == newList):
 432             return
 433
 434         # build a list of the new person ids, by looking up each person to get
 435         # their pointer
 436         newIdList = []
 437         table = SfaTable()
 438         records = table.find({'type': 'user', 'hrn': newList})
 439         for rec in records:
 440             newIdList.append(rec['pointer'])
 441
 442         # build a list of the old person ids from the person_ids field
 443         if oldRecord:
 444             oldIdList = oldRecord.get("person_ids", [])
 445             containerId = oldRecord.get_pointer()
 446         else:
 447             # if oldRecord==None, then we are doing a Register, instead of an
 448             # update.
 449             oldIdList = []
 450             containerId = record.get_pointer()
 451
 452     # add people who are in the new list, but not the oldList
 453         for personId in newIdList:
 454             if not (personId in oldIdList):
 455                 addFunc(self.plauth, personId, containerId)
 456
 457         # remove people who are in the old list, but not the new list
 458         for personId in oldIdList:
 459             if not (personId in newIdList):
 460                 delFunc(self.plauth, personId, containerId)
 461
 462     def update_membership(self, oldRecord, record):
 463         if record.type == "slice":
 464             self.update_membership_list(oldRecord, record, 'researcher',
 465                                         self.users.AddPersonToSlice,
 466                                         self.users.DeletePersonFromSlice)
 467         elif record.type == "authority":
 468             # xxx TODO
 469             pass
 470
 471 ### thierry
 472 # I don't think you plan on running a component manager at this point
 473 # let me clean up the mess of ComponentAPI that is deprecated anyways