Added the possibility for users to define a set of information fields
[sfa.git] / sfa / managers / aggregate_manager_pl.py
1 #!/usr/bin/python
2
3 import datetime
4 import time
5 import traceback
6 import sys
7 import re
8 from types import StringTypes
9
10 from sfa.util.faults import *
11 from sfa.util.xrn import get_authority, hrn_to_urn, urn_to_hrn, Xrn
12 from sfa.util.plxrn import slicename_to_hrn, hrn_to_pl_slicename, hostname_to_urn
13 from sfa.util.rspec import *
14 from sfa.util.specdict import *
15 from sfa.util.record import SfaRecord
16 from sfa.util.policy import Policy
17 from sfa.util.record import *
18 from sfa.util.sfaticket import SfaTicket
19 from sfa.plc.slices import Slices
20 from sfa.trust.credential import Credential
21 import sfa.plc.peers as peers
22 from sfa.plc.network import *
23 from sfa.plc.api import SfaAPI
24 from sfa.plc.aggregate import Aggregate
25 from sfa.plc.slices import *
26 from sfa.util.version import version_core
27 from sfa.rspecs.rspec_version import RSpecVersion
28 from sfa.rspecs.sfa_rspec import sfa_rspec_version
29 from sfa.rspecs.pg_rspec import pg_rspec_version
30 from sfa.rspecs.rspec_parser import parse_rspec 
31 from sfa.util.sfatime import utcparse
32 from sfa.util.callids import Callids
33
34 def GetVersion(api):
35     xrn=Xrn(api.hrn)
36
37     supported_rspecs = [dict(pg_rspec_version), dict(sfa_rspec_version)]
38     version_more = {'interface':'aggregate',
39                     'testbed':'myplc',
40                     'hrn':xrn.get_hrn(),
41                     'request_rspec_versions': supported_rspecs,
42                     'ad_rspec_versions': supported_rspecs,
43                     'default_ad_rspec': dict(sfa_rspec_version)
44                     }
45     return version_core(version_more)
46
47 def __get_registry_objects(slice_xrn, creds, users):
48     """
49
50     """
51     hrn, type = urn_to_hrn(slice_xrn)
52
53     hrn_auth = get_authority(hrn)
54
55     # Build up objects that an SFA registry would return if SFA
56     # could contact the slice's registry directly
57     reg_objects = None
58
59     if users:
60         # dont allow special characters in the site login base
61         #only_alphanumeric = re.compile('[^a-zA-Z0-9]+')
62         #login_base = only_alphanumeric.sub('', hrn_auth[:20]).lower()
63         slicename = hrn_to_pl_slicename(hrn)
64         login_base = slicename.split('_')[0]
65         reg_objects = {}
66         site = {}
67         site['site_id'] = 0
68         site['name'] = 'geni.%s' % login_base 
69         site['enabled'] = True
70         site['max_slices'] = 100
71
72         # Note:
73         # Is it okay if this login base is the same as one already at this myplc site?
74         # Do we need uniqueness?  Should use hrn_auth instead of just the leaf perhaps?
75         site['login_base'] = login_base
76         site['abbreviated_name'] = login_base
77         site['max_slivers'] = 1000
78         reg_objects['site'] = site
79
80         slice = {}
81         
82         extime = Credential(string=creds[0]).get_expiration()
83         # If the expiration time is > 60 days from now, set the expiration time to 60 days from now
84         if extime > datetime.datetime.utcnow() + datetime.timedelta(days=60):
85             extime = datetime.datetime.utcnow() + datetime.timedelta(days=60)
86         slice['expires'] = int(time.mktime(extime.timetuple()))
87         slice['hrn'] = hrn
88         slice['name'] = hrn_to_pl_slicename(hrn)
89         slice['url'] = hrn
90         slice['description'] = hrn
91         slice['pointer'] = 0
92         reg_objects['slice_record'] = slice
93
94         reg_objects['users'] = {}
95         for user in users:
96             user['key_ids'] = []
97             hrn, _ = urn_to_hrn(user['urn'])
98             user['email'] = hrn_to_pl_slicename(hrn) + "@geni.net"
99             user['first_name'] = hrn
100             user['last_name'] = hrn
101             reg_objects['users'][user['email']] = user
102
103         return reg_objects
104
105 def __get_hostnames(nodes):
106     hostnames = []
107     for node in nodes:
108         hostnames.append(node.hostname)
109     return hostnames
110
111 def SliverStatus(api, slice_xrn, creds, call_id):
112     if Callids().already_handled(call_id): return {}
113
114     (hrn, type) = urn_to_hrn(slice_xrn)
115     # find out where this slice is currently running
116     api.logger.info(hrn)
117     slicename = hrn_to_pl_slicename(hrn)
118     
119     slices = api.plshell.GetSlices(api.plauth, [slicename], ['node_ids','person_ids','name','expires'])
120     if len(slices) == 0:        
121         raise Exception("Slice %s not found (used %s as slicename internally)" % slice_xrn, slicename)
122     slice = slices[0]
123     
124     # report about the local nodes only
125     nodes = api.plshell.GetNodes(api.plauth, {'node_id':slice['node_ids'],'peer_id':None},
126                                  ['hostname', 'site_id', 'boot_state', 'last_contact'])
127     site_ids = [node['site_id'] for node in nodes]
128     sites = api.plshell.GetSites(api.plauth, site_ids, ['site_id', 'login_base'])
129     sites_dict = dict ( [ (site['site_id'],site['login_base'] ) for site in sites ] )
130
131     result = {}
132     top_level_status = 'unknown'
133     if nodes:
134         top_level_status = 'ready'
135     result['geni_urn'] = Xrn(slice_xrn, 'slice').get_urn()
136     result['pl_login'] = slice['name']
137     result['pl_expires'] = datetime.datetime.fromtimestamp(slice['expires']).ctime()
138     
139     resources = []
140     for node in nodes:
141         res = {}
142         res['pl_hostname'] = node['hostname']
143         res['pl_boot_state'] = node['boot_state']
144         res['pl_last_contact'] = node['last_contact']
145         if node['last_contact'] is not None:
146             res['pl_last_contact'] = datetime.datetime.fromtimestamp(node['last_contact']).ctime()
147         res['geni_urn'] = hostname_to_urn(api.hrn, sites_dict[node['site_id']], node['hostname'])
148         if node['boot_state'] == 'boot':
149             res['geni_status'] = 'ready'
150         else:
151             res['geni_status'] = 'failed'
152             top_level_staus = 'failed' 
153             
154         res['geni_error'] = ''
155
156         resources.append(res)
157         
158     result['geni_status'] = top_level_status
159     result['geni_resources'] = resources
160     # XX remove me
161     #api.logger.info(result)
162     # XX remove me
163     return result
164
165 def CreateSliver(api, slice_xrn, creds, rspec_string, users, call_id):
166     """
167     Create the sliver[s] (slice) at this aggregate.    
168     Verify HRN and initialize the slice record in PLC if necessary.
169     """
170     if Callids().already_handled(call_id): return ""
171
172     reg_objects = __get_registry_objects(slice_xrn, creds, users)
173
174     (hrn, type) = urn_to_hrn(slice_xrn)
175     peer = None
176     aggregate = Aggregate(api)
177     slices = Slices(api)
178     peer = slices.get_peer(hrn)
179     sfa_peer = slices.get_sfa_peer(hrn)
180     registry = api.registries[api.hrn]
181     credential = api.getCredential()
182     (site_id, remote_site_id) = slices.verify_site(registry, credential, hrn, 
183                                                    peer, sfa_peer, reg_objects)
184
185     slice = slices.verify_slice(registry, credential, hrn, site_id, 
186                                        remote_site_id, peer, sfa_peer, reg_objects)
187      
188     nodes = api.plshell.GetNodes(api.plauth, slice['node_ids'], ['hostname'])
189     current_slivers = [node['hostname'] for node in nodes] 
190     rspec = parse_rspec(rspec_string)
191     requested_slivers = [str(host) for host in rspec.get_nodes_with_slivers()]
192     # remove nodes not in rspec
193     deleted_nodes = list(set(current_slivers).difference(requested_slivers))
194
195     # add nodes from rspec
196     added_nodes = list(set(requested_slivers).difference(current_slivers))
197
198     try:
199         if peer:
200             api.plshell.UnBindObjectFromPeer(api.plauth, 'slice', slice['slice_id'], peer)
201
202         api.plshell.AddSliceToNodes(api.plauth, slice['name'], added_nodes) 
203         api.plshell.DeleteSliceFromNodes(api.plauth, slice['name'], deleted_nodes)
204
205         # TODO: update slice tags
206         #network.updateSliceTags()
207
208     finally:
209         if peer:
210             api.plshell.BindObjectToPeer(api.plauth, 'slice', slice.id, peer, 
211                                          slice.peer_id)
212
213     return aggregate.get_rspec(slice_xrn=slice_xrn, version=rspec.version)
214
215
216 def RenewSliver(api, xrn, creds, expiration_time, call_id):
217     if Callids().already_handled(call_id): return True
218     (hrn, type) = urn_to_hrn(xrn)
219     slicename = hrn_to_pl_slicename(hrn)
220     slices = api.plshell.GetSlices(api.plauth, {'name': slicename}, ['slice_id'])
221     if not slices:
222         raise RecordNotFound(hrn)
223     slice = slices[0]
224     requested_time = utcparse(expiration_time)
225     record = {'expires': int(time.mktime(requested_time.timetuple()))}
226     try:
227         api.plshell.UpdateSlice(api.plauth, slice['slice_id'], record)
228         return True
229     except:
230         return False
231
232 def start_slice(api, xrn, creds):
233     hrn, type = urn_to_hrn(xrn)
234     slicename = hrn_to_pl_slicename(hrn)
235     slices = api.plshell.GetSlices(api.plauth, {'name': slicename}, ['slice_id'])
236     if not slices:
237         raise RecordNotFound(hrn)
238     slice_id = slices[0]['slice_id']
239     slice_tags = api.plshell.GetSliceTags(api.plauth, {'slice_id': slice_id, 'tagname': 'enabled'}, ['slice_tag_id'])
240     # just remove the tag if it exists
241     if slice_tags:
242         api.plshell.DeleteSliceTag(api.plauth, slice_tags[0]['slice_tag_id'])
243
244     return 1
245  
246 def stop_slice(api, xrn, creds):
247     hrn, type = urn_to_hrn(xrn)
248     slicename = hrn_to_pl_slicename(hrn)
249     slices = api.plshell.GetSlices(api.plauth, {'name': slicename}, ['slice_id'])
250     if not slices:
251         raise RecordNotFound(hrn)
252     slice_id = slices[0]['slice_id']
253     slice_tags = api.plshell.GetSliceTags(api.plauth, {'slice_id': slice_id, 'tagname': 'enabled'})
254     if not slice_tags:
255         api.plshell.AddSliceTag(api.plauth, slice_id, 'enabled', '0')
256     elif slice_tags[0]['value'] != "0":
257         tag_id = attributes[0]['slice_tag_id']
258         api.plshell.UpdateSliceTag(api.plauth, tag_id, '0')
259     return 1
260
261 def reset_slice(api, xrn):
262     # XX not implemented at this interface
263     return 1
264
265 def DeleteSliver(api, xrn, creds, call_id):
266     if Callids().already_handled(call_id): return ""
267     (hrn, type) = urn_to_hrn(xrn)
268     slicename = hrn_to_pl_slicename(hrn)
269     slices = api.plshell.GetSlices(api.plauth, {'name': slicename})
270     if not slices:
271         return 1
272     slice = slices[0]
273
274     # determine if this is a peer slice
275     peer = peers.get_peer(api, hrn)
276     try:
277         if peer:
278             api.plshell.UnBindObjectFromPeer(api.plauth, 'slice', slice['slice_id'], peer)
279         api.plshell.DeleteSliceFromNodes(api.plauth, slicename, slice['node_ids'])
280     finally:
281         if peer:
282             api.plshell.BindObjectToPeer(api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])
283     return 1
284
285 # xxx Thierry : caching at the aggregate level sounds wrong...
286 #caching=True
287 caching=False
288 def ListSlices(api, creds, call_id):
289     if Callids().already_handled(call_id): return []
290     # look in cache first
291     if caching and api.cache:
292         slices = api.cache.get('slices')
293         if slices:
294             return slices
295
296     # get data from db 
297     slices = api.plshell.GetSlices(api.plauth, {'peer_id': None}, ['name'])
298     slice_hrns = [slicename_to_hrn(api.hrn, slice['name']) for slice in slices]
299     slice_urns = [hrn_to_urn(slice_hrn, 'slice') for slice_hrn in slice_hrns]
300
301     # cache the result
302     if caching and api.cache:
303         api.cache.add('slices', slice_urns) 
304
305     return slice_urns
306     
307 def ListResources(api, creds, options,call_id):
308     if Callids().already_handled(call_id): return ""
309     # get slice's hrn from options
310     xrn = options.get('geni_slice_urn', '')
311     (hrn, type) = urn_to_hrn(xrn)
312
313     # get the rspec's return format from options
314     rspec_version = RSpecVersion(options.get('rspec_version'))
315     version_string = "rspec_%s" % (rspec_version.get_version_name())
316
317     #panos adding the info option to the caching key (can be improved)
318     if options.get('info'):
319         version_string = version_string + "_"+options.get('info')
320
321     print "[aggregate] version string = ",version_string
322     
323     # look in cache first
324     if caching and api.cache and not xrn:
325         rspec = api.cache.get(version_string)
326         if rspec:
327             api.logger.info("aggregate.ListResources: returning cached value for hrn %s"%hrn)
328             return rspec 
329
330     #aggregate = Aggregate(api)
331     #panos: passing user-defined options
332     #print "manager options = ",options
333     aggregate = Aggregate(api, options)
334
335     rspec =  aggregate.get_rspec(slice_xrn=xrn, version=rspec_version)
336
337     # cache the result
338     if caching and api.cache and not xrn:
339         api.cache.add(version_string, rspec)
340
341     return rspec
342
343
344 def get_ticket(api, xrn, creds, rspec, users):
345
346     reg_objects = __get_registry_objects(xrn, creds, users)
347
348     slice_hrn, type = urn_to_hrn(xrn)
349     slices = Slices(api)
350     peer = slices.get_peer(slice_hrn)
351     sfa_peer = slices.get_sfa_peer(slice_hrn)
352
353     # get the slice record
354     registry = api.registries[api.hrn]
355     credential = api.getCredential()
356     records = registry.Resolve(xrn, credential)
357
358     # similar to CreateSliver, we must verify that the required records exist
359     # at this aggregate before we can issue a ticket
360     site_id, remote_site_id = slices.verify_site(registry, credential, slice_hrn,
361                                                  peer, sfa_peer, reg_objects)
362     slice = slices.verify_slice(registry, credential, slice_hrn, site_id,
363                                 remote_site_id, peer, sfa_peer, reg_objects)
364
365     # make sure we get a local slice record
366     record = None
367     for tmp_record in records:
368         if tmp_record['type'] == 'slice' and \
369            not tmp_record['peer_authority']:
370             record = SliceRecord(dict=tmp_record)
371     if not record:
372         raise RecordNotFound(slice_hrn)
373
374     # get sliver info
375     slivers = Slices(api).get_slivers(slice_hrn)
376     if not slivers:
377         raise SliverDoesNotExist(slice_hrn)
378
379     # get initscripts
380     initscripts = []
381     data = {
382         'timestamp': int(time.time()),
383         'initscripts': initscripts,
384         'slivers': slivers
385     }
386
387     # create the ticket
388     object_gid = record.get_gid_object()
389     new_ticket = SfaTicket(subject = object_gid.get_subject())
390     new_ticket.set_gid_caller(api.auth.client_gid)
391     new_ticket.set_gid_object(object_gid)
392     new_ticket.set_issuer(key=api.key, subject=api.hrn)
393     new_ticket.set_pubkey(object_gid.get_pubkey())
394     new_ticket.set_attributes(data)
395     new_ticket.set_rspec(rspec)
396     #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
397     new_ticket.encode()
398     new_ticket.sign()
399
400     return new_ticket.save_to_string(save_parents=True)
401
402
403
404 def main():
405     api = SfaAPI()
406     """
407     rspec = ListResources(api, "plc.princeton.sapan", None, 'pl_test_sapan')
408     #rspec = ListResources(api, "plc.princeton.coblitz", None, 'pl_test_coblitz')
409     #rspec = ListResources(api, "plc.pl.sirius", None, 'pl_test_sirius')
410     print rspec
411     """
412     f = open(sys.argv[1])
413     xml = f.read()
414     f.close()
415     CreateSliver(api, "plc.princeton.sapan", xml, 'CreateSliver_sapan')
416
417 if __name__ == "__main__":
418     main()