sfa/senslab/slabdriver.py

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