modified verify_slice.. need to work on getting 'persons'
[sfa.git] / sfa / plc / slices.py
1 ### $Id$
2 ### $URL$
3
4 import datetime
5 import time
6 import traceback
7 import sys
8
9 from types import StringTypes
10 from sfa.util.namespace import *
11 from sfa.util.rspec import *
12 from sfa.util.specdict import *
13 from sfa.util.faults import *
14 from sfa.util.record import SfaRecord
15 from sfa.util.policy import Policy
16 from sfa.util.prefixTree import prefixTree
17 from sfa.util.debug import log
18
19 MAXINT =  2L**31-1
20
21 class Slices:
22
23     rspec_to_slice_tag = {'max_rate':'net_max_rate'}
24
25     def __init__(self, api, ttl = .5, origin_hrn=None):
26         self.api = api
27         #filepath = path + os.sep + filename
28         self.policy = Policy(self.api)    
29         self.origin_hrn = origin_hrn
30
31     def get_slivers(self, xrn, node=None):
32         hrn, type = urn_to_hrn(xrn)
33          
34         slice_name = hrn_to_pl_slicename(hrn)
35         # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
36         # of doing all of this?
37         #return self.api.GetSliceTicket(self.auth, slice_name) 
38         
39         # from PLCAPI.GetSlivers.get_slivers()
40         slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
41         slices = self.api.plshell.GetSlices(self.api.plauth, slice_name, slice_fields)
42         # Build up list of users and slice attributes
43         person_ids = set()
44         all_slice_tag_ids = set()
45         for slice in slices:
46             person_ids.update(slice['person_ids'])
47             all_slice_tag_ids.update(slice['slice_tag_ids'])
48         person_ids = list(person_ids)
49         all_slice_tag_ids = list(all_slice_tag_ids)
50         # Get user information
51         all_persons_list = self.api.plshell.GetPersons(self.api.plauth, {'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
52         all_persons = {}
53         for person in all_persons_list:
54             all_persons[person['person_id']] = person        
55
56         # Build up list of keys
57         key_ids = set()
58         for person in all_persons.values():
59             key_ids.update(person['key_ids'])
60         key_ids = list(key_ids)
61         # Get user account keys
62         all_keys_list = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key', 'key_type'])
63         all_keys = {}
64         for key in all_keys_list:
65             all_keys[key['key_id']] = key
66         # Get slice attributes
67         all_slice_tags_list = self.api.plshell.GetSliceTags(self.api.plauth, all_slice_tag_ids)
68         all_slice_tags = {}
69         for slice_tag in all_slice_tags_list:
70             all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
71            
72         slivers = []
73         for slice in slices:
74             keys = []
75             for person_id in slice['person_ids']:
76                 if person_id in all_persons:
77                     person = all_persons[person_id]
78                     if not person['enabled']:
79                         continue
80                     for key_id in person['key_ids']:
81                         if key_id in all_keys:
82                             key = all_keys[key_id]
83                             keys += [{'key_type': key['key_type'],
84                                     'key': key['key']}]
85             attributes = []
86             # All (per-node and global) attributes for this slice
87             slice_tags = []
88             for slice_tag_id in slice['slice_tag_ids']:
89                 if slice_tag_id in all_slice_tags:
90                     slice_tags.append(all_slice_tags[slice_tag_id]) 
91             # Per-node sliver attributes take precedence over global
92             # slice attributes, so set them first.
93             # Then comes nodegroup slice attributes
94             # Followed by global slice attributes
95             sliver_attributes = []
96
97             if node is not None:
98                 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
99                     sliver_attributes.append(sliver_attribute['tagname'])
100                     attributes.append({'tagname': sliver_attribute['tagname'],
101                                     'value': sliver_attribute['value']})
102
103             # set nodegroup slice attributes
104             for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
105                 # Do not set any nodegroup slice attributes for
106                 # which there is at least one sliver attribute
107                 # already set.
108                 if slice_tag not in slice_tags:
109                     attributes.append({'tagname': slice_tag['tagname'],
110                         'value': slice_tag['value']})
111
112             for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
113                 # Do not set any global slice attributes for
114                 # which there is at least one sliver attribute
115                 # already set.
116                 if slice_tag['tagname'] not in sliver_attributes:
117                     attributes.append({'tagname': slice_tag['tagname'],
118                                    'value': slice_tag['value']})
119
120             # XXX Sanity check; though technically this should be a system invariant
121             # checked with an assertion
122             if slice['expires'] > MAXINT:  slice['expires']= MAXINT
123             
124             slivers.append({
125                 'hrn': hrn,
126                 'name': slice['name'],
127                 'slice_id': slice['slice_id'],
128                 'instantiation': slice['instantiation'],
129                 'expires': slice['expires'],
130                 'keys': keys,
131                 'attributes': attributes
132             })
133
134         return slivers
135  
136     def get_peer(self, xrn):
137         hrn, type = urn_to_hrn(xrn)
138         # Becaues of myplc federation,  we first need to determine if this
139         # slice belongs to out local plc or a myplc peer. We will assume it 
140         # is a local site, unless we find out otherwise  
141         peer = None
142
143         # get this slice's authority (site)
144         slice_authority = get_authority(hrn)
145
146         # get this site's authority (sfa root authority or sub authority)
147         site_authority = get_authority(slice_authority).lower()
148
149         # check if we are already peered with this site_authority, if so
150         peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
151         for peer_record in peers:
152             names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
153             if site_authority in names:
154                 peer = peer_record['shortname']
155
156         return peer
157
158     def get_sfa_peer(self, xrn):
159         hrn, type = urn_to_hrn(xrn)
160
161         # return the authority for this hrn or None if we are the authority
162         sfa_peer = None
163         slice_authority = get_authority(hrn)
164         site_authority = get_authority(slice_authority)
165
166         if site_authority != self.api.hrn:
167             sfa_peer = site_authority
168
169         return sfa_peer 
170
171     def verify_site(self, registry, credential, slice_hrn, peer, sfa_peer, reg_objects=None):
172         authority = get_authority(slice_hrn)
173         authority_urn = hrn_to_urn(authority, 'authority')
174         
175         if reg_objects:
176             site = reg_objects['site']
177         else:
178             site_records = registry.resolve(credential, authority_urn)
179             site = {}            
180             for site_record in site_records:            
181                 if site_record['type'] == 'authority':
182                     site = site_record
183             if not site:
184                 raise RecordNotFound(authority)
185             
186         remote_site_id = site.pop('site_id')    
187                 
188         login_base = get_leaf(authority)
189         sites = self.api.plshell.GetSites(self.api.plauth, login_base)
190
191         if not sites:
192             site_id = self.api.plshell.AddSite(self.api.plauth, site)
193             if peer:
194                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)   
195             # mark this site as an sfa peer record
196             if sfa_peer and not reg_objects:
197                 peer_dict = {'type': 'authority', 'hrn': authority, 'peer_authority': sfa_peer, 'pointer': site_id}
198                 registry.register_peer_object(credential, peer_dict)
199         else:
200             site_id = sites[0]['site_id']
201             remote_site_id = sites[0]['peer_site_id']
202             
203             old_site = sites[0]
204             #the site is already on the remote agg. Let us update(e.g. max_slices field) it with the latest info.
205         self.sync_site(old_site, site, peer)
206
207
208         return (site_id, remote_site_id) 
209
210     def verify_slice(self, registry, credential, slice_hrn, site_id, remote_site_id, peer, sfa_peer, reg_objects=None):
211         slice = {}
212         slice_record = None
213         authority = get_authority(slice_hrn)
214
215         if reg_objects:
216             slice_record = reg_objects['slice_record']
217         else:
218             slice_records = registry.resolve(credential, slice_hrn)
219     
220             for record in slice_records:
221                 if record['type'] in ['slice']:
222                     slice_record = record
223             if not slice_record:
224                 raise RecordNotFound(hrn)
225             
226         
227         slicename = hrn_to_pl_slicename(slice_hrn)
228         parts = slicename.split("_")
229         login_base = parts[0]
230         slices = self.api.plshell.GetSlices(self.api.plauth, [slicename]) 
231         if not slices:
232             slice_fields = {}
233             slice_keys = ['name', 'url', 'description']
234             for key in slice_keys:
235                 if key in slice_record and slice_record[key]:
236                     slice_fields[key] = slice_record[key]
237
238             # add the slice  
239             slice_id = self.api.plshell.AddSlice(self.api.plauth, slice_fields)
240             slice = slice_fields
241             slice['slice_id'] = slice_id
242
243             # mark this slice as an sfa peer record
244             if sfa_peer:
245                 peer_dict = {'type': 'slice', 'hrn': slice_hrn, 'peer_authority': sfa_peer, 'pointer': slice_id}
246                 registry.register_peer_object(credential, peer_dict)
247
248             #this belongs to a peer
249             if peer:
250                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice_id, peer, slice_record['pointer'])
251             slice['node_ids'] = []
252         else:
253             slice = slices[0]
254             slice_id = slice['slice_id']
255             site_id = slice['site_id']
256             #the slice is alredy on the remote agg. Let us update(e.g. expires field) it with the latest info.
257             self.sync_slice(slice, slice_record, peer)
258
259         slice['peer_slice_id'] = slice_record['pointer']
260         self.verify_persons(registry, credential, slice_record, site_id, remote_site_id, peer, sfa_peer)
261     
262         return slice        
263
264     def verify_persons(self, registry, credential, slice_record, site_id, remote_site_id, peer, sfa_peer):
265         # get the list of valid slice users from the registry and make 
266         # sure they are added to the slice 
267         slicename = hrn_to_pl_slicename(slice_record['hrn'])
268         researchers = slice_record.get('researcher', [])
269         for researcher in researchers:
270             person_record = {}
271             person_records = registry.resolve(credential, researcher)
272             for record in person_records:
273                 if record['type'] in ['user'] and record['enabled']:
274                     person_record = record
275             if not person_record:
276                 return 1
277             person_dict = person_record
278             local_person=False
279             if peer:
280                 peer_id = self.api.plshell.GetPeers(self.api.plauth, {'shortname': peer}, ['peer_id'])[0]['peer_id']
281                 persons = self.api.plshell.GetPersons(self.api.plauth, {'email': [person_dict['email']], 'peer_id': peer_id}, ['person_id', 'key_ids'])
282                 if not persons:
283                     persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])
284                     if persons:
285                        local_person=True
286
287             else:
288                 persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])   
289         
290             if not persons:
291                 person_id=self.api.plshell.AddPerson(self.api.plauth, person_dict)
292                 self.api.plshell.UpdatePerson(self.api.plauth, person_id, {'enabled' : True})
293                 
294                 # mark this person as an sfa peer record
295                 if sfa_peer:
296                     peer_dict = {'type': 'user', 'hrn': researcher, 'peer_authority': sfa_peer, 'pointer': person_id}
297                     registry.register_peer_object(credential, peer_dict)
298
299                 if peer:
300                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
301                 key_ids = []
302             else:
303                 person_id = persons[0]['person_id']
304                 key_ids = persons[0]['key_ids']
305
306
307             # if this is a peer person, we must unbind them from the peer or PLCAPI will throw
308             # an error
309             if peer:
310                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
311                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site_id,  peer)
312
313             self.api.plshell.AddPersonToSlice(self.api.plauth, person_dict['email'], slicename)
314             self.api.plshell.AddPersonToSite(self.api.plauth, person_dict['email'], site_id)
315             if peer and not local_person:
316                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
317             if peer:
318                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)
319             
320             self.verify_keys(registry, credential, person_dict, key_ids, person_id, peer, local_person)
321
322     def verify_keys(self, registry, credential, person_dict, key_ids, person_id,  peer, local_person):
323         keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key'])
324         keys = [key['key'] for key in keylist]
325         
326         #add keys that arent already there
327         key_ids = person_dict['key_ids']
328         for personkey in person_dict['keys']:
329             if personkey not in keys:
330                 key = {'key_type': 'ssh', 'key': personkey}
331                 if peer:
332                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
333                 key_id = self.api.plshell.AddPersonKey(self.api.plauth, person_dict['email'], key)
334                 if peer and not local_person:
335                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
336                 if peer:
337                     try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key_id, peer, key_ids.pop(0))
338
339                     except: pass   
340
341     def create_slice_aggregate(self, xrn, rspec):
342         hrn, type = urn_to_hrn(xrn)
343         # Determine if this is a peer slice
344         peer = self.get_peer(hrn)
345         sfa_peer = self.get_sfa_peer(hrn)
346
347         spec = RSpec(rspec)
348         # Get the slice record from sfa
349         slicename = hrn_to_pl_slicename(hrn) 
350         slice = {}
351         slice_record = None
352         registry = self.api.registries[self.api.hrn]
353         credential = self.api.getCredential()
354
355         site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
356         slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
357
358         # find out where this slice is currently running
359         nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
360         hostnames = [node['hostname'] for node in nodelist]
361
362         # get netspec details
363         nodespecs = spec.getDictsByTagName('NodeSpec')
364
365         # dict in which to store slice attributes to set for the nodes
366         nodes = {}
367         for nodespec in nodespecs:
368             if isinstance(nodespec['name'], list):
369                 for nodename in nodespec['name']:
370                     nodes[nodename] = {}
371                     for k in nodespec.keys():
372                         rspec_attribute_value = nodespec[k]
373                         if (self.rspec_to_slice_tag.has_key(k)):
374                             slice_tag_name = self.rspec_to_slice_tag[k]
375                             nodes[nodename][slice_tag_name] = rspec_attribute_value
376             elif isinstance(nodespec['name'], StringTypes):
377                 nodename = nodespec['name']
378                 nodes[nodename] = {}
379                 for k in nodespec.keys():
380                     rspec_attribute_value = nodespec[k]
381                     if (self.rspec_to_slice_tag.has_key(k)):
382                         slice_tag_name = self.rspec_to_slice_tag[k]
383                         nodes[nodename][slice_tag_name] = rspec_attribute_value
384
385                 for k in nodespec.keys():
386                     rspec_attribute_value = nodespec[k]
387                     if (self.rspec_to_slice_tag.has_key(k)):
388                         slice_tag_name = self.rspec_to_slice_tag[k]
389                         nodes[nodename][slice_tag_name] = rspec_attribute_value
390
391         node_names = nodes.keys()
392         # remove nodes not in rspec
393         deleted_nodes = list(set(hostnames).difference(node_names))
394         # add nodes from rspec
395         added_nodes = list(set(node_names).difference(hostnames))
396
397         if peer:
398             self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
399
400         self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes) 
401
402         # Add recognized slice tags
403         for node_name in node_names:
404             node = nodes[node_name]
405             for slice_tag in node.keys():
406                 value = node[slice_tag]
407                 if (isinstance(value, list)):
408                     value = value[0]
409
410                 self.api.plshell.AddSliceTag(self.api.plauth, slicename, slice_tag, value, node_name)
411
412         self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
413         if peer:
414             self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])
415
416         return 1
417
418     def sync_site(self, old_record, new_record, peer):
419         if old_record['max_slices'] != new_record['max_slices'] or old_record['max_slivers'] != new_record['max_slivers']:
420             if peer:
421                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', old_record['site_id'], peer)
422             if old_record['max_slices'] != new_record['max_slices']:
423                 self.api.plshell.UpdateSite(self.api.plauth, old_record['site_id'], {'max_slices' : new_record['max_slices']})
424             if old_record['max_slivers'] != new_record['max_slivers']:
425                 self.api.plshell.UpdateSite(self.api.plauth, old_record['site_id'], {'max_slivers' : new_record['max_slivers']})
426             if peer:
427                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', old_record['site_id'], peer, old_record['peer_site_id'])
428         return 1
429
430     def sync_slice(self, old_record, new_record, peer):
431         if old_record['expires'] != new_record['expires']:
432             if peer:
433                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', old_record['slice_id'], peer)
434             self.api.plshell.UpdateSlice(self.api.plauth, old_record['slice_id'], {'expires' : new_record['expires']})
435             if peer:
436                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', old_record['slice_id'], peer, old_record['peer_slice_id'])
437         return 1