sfa/senslab/slabdriver.py

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