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