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