Merge branch 'fibre' of ssh://git.onelab.eu/git/myslice into fibre
[unfold.git] / portal / actions-100314.py
1 from django.http                import HttpResponse
2 from manifold.core.query        import Query
3 from manifoldapi.manifoldapi    import execute_query,execute_admin_query
4 from portal.models              import PendingUser, PendingSlice, PendingAuthority
5 import json
6
7 from django.contrib.auth.models import User
8 from django.template.loader     import render_to_string
9 from django.core.mail           import EmailMultiAlternatives
10
11 from theme                      import ThemeView
12
13 theme = ThemeView()
14
15 # Thierry: moving this right into the code so 
16 # most people can use myslice without having to install sfa
17 # XXX tmp sfa dependency, should be moved to SFA gateway
18 #from sfa.util.xrn                import Xrn 
19
20
21 # Get the list of authorities
22
23 def authority_get_pis(request, authority_hrn):
24     query = Query.get('authority').filter_by('authority_hrn', '==', authority_hrn).select('pi_users')
25     results = execute_admin_query(request, query)
26     # NOTE: temporarily commented. Because results is giving empty list. 
27     # Needs more debugging
28     #if not results:
29     #    raise Exception, "Authority not found: %s" % authority_hrn
30     #result, = results
31     #return result['pi_users']
32     return results
33
34 def authority_get_pi_emails(request, authority_hrn):
35     pi_users = authority_get_pis(request,authority_hrn)
36     if any(d['pi_users'] == None for d in pi_users):
37         theme.template_name = 'email_default_recipients.txt' 
38         default_email = render_to_string(theme.template, request)
39         default_email = default_email.replace('\n', '')
40         return default_email
41     else:
42         pi_user_hrns = [ hrn for x in pi_users for hrn in x['pi_users'] ]
43         query = Query.get('user').filter_by('user_hrn', 'included', pi_user_hrns).select('user_email')
44         results = execute_admin_query(request, query)
45         return [result['user_email'] for result in results]
46
47 def is_pi(wsgi_request, user_hrn, authority_hrn):
48     # XXX could be done in a single query !
49
50     # select pi_authorities from user where user_hrn == "ple.upmc.jordan_auge"
51     query = Query.get('user').filter_by('user_hrn', '==', user_hrn).select('pi_authorities')
52     results = execute_admin_query(wsgi_request, query)
53     if not results:
54         # XXX Warning ?
55         return False
56     result = results[0]
57     user_authority_hrns = result.get('pi_authorities', [])
58     return authority_hrn in user_authority_hrns
59     
60 # SFA get record
61
62 def sfa_get_user(request, user_hrn, pub):
63     query_sfa_user = Query.get('user').filter_by('user_hrn', '==', user_hrn)
64     result_sfa_user = execute_query(request, query_sfa_user)
65     return result_sfa_user                        
66
67 def sfa_update_user(request, user_hrn, user_params):
68     # user_params: keys [public_key] 
69     if 'email' in user_params:
70         user_params['user_email'] = user_params['email']
71     query = Query.update('user').filter_by('user_hrn', '==', user_hrn).set(user_params).select('user_hrn')
72     results = execute_query(request,query)
73     return results
74
75 def sfa_add_authority(request, authority_params):
76     query = Query.create('authority').set(authority_params).select('authority_hrn')
77     results = execute_query(request, query)
78     print "sfa_add_auth results=",results
79     if not results:
80         raise Exception, "Could not create %s. Already exists ?" % authority_params['hrn']
81     return results
82
83 def sfa_add_user_to_slice(request, user_hrn, slice_params):
84 # UPDATE myslice:slice SET researcher=['ple.upmc.jordan_auge','ple.inria.thierry_parmentelat','ple.upmc.loic_baron','ple.upmc.ciro_scognamiglio','ple.upmc.mohammed-yasin_rahman','ple.upmc.azerty'] where slice_hrn=='ple.upmc.myslicedemo'
85     query_current_users = Query.get('slice').select('user').filter_by('slice_hrn','==',slice_params['hrn'])
86     results_current_users = execute_query(request, query_current_users)
87     slice_params['researcher'] = slice_params['researcher'] | results_current_users
88     query = Query.update('slice').filter_by('user_hrn', '==', user_hrn).set(slice_params).select('slice_hrn')
89     results = execute_query(request, query)
90 # Also possible but not supported yet
91 # UPDATE myslice:user SET slice=['ple.upmc.agent','ple.upmc.myslicedemo','ple.upmc.tophat'] where user_hrn=='ple.upmc.azerty'
92     if not results:
93         raise Exception, "Could not create %s. Already exists ?" % slice_params['hrn']
94     return results
95
96 # Propose hrn
97
98 def manifold_add_user(wsgi_request, request):
99     """Add a Manifold user corresponding to a user request.
100
101     Args:
102         wsgi_request: a WSGIRequest instance
103         request (dict): a dictionary containing the user request built from the
104             form.
105
106     Returns:
107         The user_id of the inserted user.
108
109     Raises:
110         ?
111     
112     """
113     USER_CONFIG = '{"firstname": "%(first_name)s", "lastname": "%(last_name)s", "authority": "%(authority_hrn)s"}'
114
115     user_params = {
116         'email'     : request['email'],
117         'password'  : request['password'],
118         'config'    : USER_CONFIG % request,
119         'status'    : 1,
120     }
121
122     query = Query.create('local:user').set(user_params).select('email')
123     results = execute_admin_query(request, query)
124     if not results:
125         raise Exception, "Failed creating manifold user: %s" % user_params['email']
126     result = results[0]
127     return result['email']
128
129 def manifold_update_user(request, email, user_params):
130     # user_params: password, config e.g., 
131     query = Query.update('local:user').filter_by('email', '==', email).set(user_params).select('email')
132     results = execute_admin_query(request,query)
133     # NOTE: results remains empty and goes to Exception. However, it updates the manifold DB.
134     # That's why I commented the exception part. -- Yasin 
135     #if not results:
136     #    raise Exception, "Failed updating manifold user: %s" % user_params['email']
137     #result, = results
138     return results
139
140 def manifold_add_account(request, account_params):
141     query = Query.create('local:account').set(account_params).select(['user', 'platform'])
142     results = execute_admin_query(request,query)
143     if not results:
144         raise Exception, "Failed creating manifold account on platform %s for user: %s" % (account_params['platform'], account_params['user'])
145     result, = results
146     return result['user_id']
147
148 def manifold_update_account(request,user_id,account_params):
149     # account_params: config
150     query = Query.update('local:account').filter_by('platform', '==', 'myslice').filter_by('user_id', '==', user_id).set(account_params).select('user_id')
151     results = execute_admin_query(request,query)
152     return results
153
154 #explicitly mention the platform_id
155 def manifold_delete_account(request, platform_id, user_id, account_params):
156     query = Query.delete('local:account').filter_by('platform_id', '==', platform_id).filter_by('user_id', '==', user_id).set(account_params).select('user_id')
157     results = execute_admin_query(request,query)
158     return results
159
160
161 #not tested
162 def manifold_add_platform(request, platform_params):
163     query = Query.create('local:platform').set(platform_params).select(['user', 'platform'])
164     results = execute_admin_query(request,query)
165     if not results:
166         raise Exception, "Failed creating manifold platform %s for user: %s" % (platform_params['platform'], platform_params['user'])
167     result, = results
168     return result['platform_id']
169
170
171 def make_request_user(user):
172     request = {}
173     request['type']          = 'user'
174     request['id']            = user.id
175     request['timestamp']     = user.created # XXX in DB ?
176     request['authority_hrn'] = user.authority_hrn
177     request['first_name']    = user.first_name
178     request['last_name']     = user.last_name
179     request['email']         = user.email
180     request['login']         = user.login
181     request['user_hrn']      = user.user_hrn
182     request['public_key']    = user.public_key
183     request['private_key']   = user.private_key
184     return request
185
186 def make_request_slice(slice):
187     request = {}
188     request['type'] = 'slice'
189     request['id'] = slice.id
190     request['user_hrn'] = slice.user_hrn
191     request['timestamp'] = slice.created
192     request['authority_hrn'] = slice.authority_hrn
193     request['slice_name'] = slice.slice_name
194     request['number_of_nodes'] = slice.number_of_nodes
195     request['type_of_nodes'] = slice.type_of_nodes
196     request['purpose'] = slice.purpose
197     return request
198
199 def make_request_authority(authority):
200     request = {}
201     request['type']                  = 'authority'
202     request['id']                    = authority.id
203     request['site_name']             = authority.site_name
204     request['site_latitude']         = authority.site_latitude
205     request['site_longitude']        = authority.site_longitude
206     request['site_url']              = authority.site_url
207     request['site_authority']        = authority.site_authority
208     request['site_abbreviated_name'] = authority.site_abbreviated_name
209     request['address_line1']         = authority.address_line1
210     request['address_line2']         = authority.address_line2
211     request['address_line3']         = authority.address_line3
212     request['address_city']          = authority.address_city
213     request['address_postalcode']    = authority.address_postalcode
214     request['address_state']         = authority.address_state
215     request['address_country']       = authority.address_country
216     request['authority_hrn']         = authority.authority_hrn
217     request['timestamp']             = authority.created
218     return request
219
220 def make_requests(pending_users, pending_slices, pending_authorities):
221     requests = []
222     for user in pending_users:
223         requests.append(make_request_user(user))
224     for slice in pending_slices:
225         requests.append(make_request_slice(slice))
226     for authority in pending_authorities:
227         requests.append(make_request_authority(authority))
228     return requests   
229
230 def get_request_by_id(ids):
231     sorted_ids = { 'user': [], 'slice': [], 'authority': [] }
232     for type__id in ids:
233         type, id = type__id.split('__')
234         sorted_ids[type].append(id)
235         
236     if not ids:
237         pending_users  = PendingUser.objects.all()
238         pending_slices = PendingSlice.objects.all()
239         pending_authorities = PendingAuthority.objects.all()
240     else:
241         pending_users  = PendingUser.objects.filter(id__in=sorted_ids['user']).all()
242         pending_slices = PendingSlice.objects.filter(id__in=sorted_ids['slice']).all()
243         pending_authorities = PendingAuthority.objects.filter(id__in=sorted_ids['authority']).all()
244
245     return make_requests(pending_users, pending_slices, pending_authorities)
246
247 def get_requests(authority_hrns=None):
248     print "get_request_by_authority auth_hrns = ", authority_hrns
249     if not authority_hrns:
250         pending_users  = PendingUser.objects.all()
251         pending_slices = PendingSlice.objects.all()
252         pending_authorities = PendingAuthority.objects.all()
253     else:
254         pending_users  = PendingUser.objects.filter(authority_hrn__in=authority_hrns).all()
255         pending_slices = PendingSlice.objects.filter(authority_hrn__in=authority_hrns).all()
256         pending_authorities = PendingAuthority.objects.filter(authority_hrn__in=authority_hrns).all()
257
258     return make_requests(pending_users, pending_slices, pending_authorities)
259
260 # XXX Is it in sync with the form fields ?
261
262 def portal_validate_request(wsgi_request, request_ids):
263     status = {}
264
265     if not isinstance(request_ids, list):
266         request_ids = [request_ids]
267
268     requests = get_request_by_id(request_ids)
269     for request in requests:
270         # type, id, timestamp, details, allowed -- MISSING: authority_hrn
271         # CAREFUL about details
272         # user  : first name, last name, email, password, keypair
273         # slice : number of nodes, type of nodes, purpose
274         
275         request_status = {}
276
277         if request['type'] == 'user':
278
279             try:
280                 create_user(wsgi_request, request)
281                 request_status['SFA user'] = {'status': True }
282
283             except Exception, e:
284                  request_status['SFA user'] = {'status': False, 'description': str(e)}
285                        
286 #            user_params = {'status':2}
287 #            manifold_update_user(request, request['email'], user_params)
288
289             # MANIFOLD user should be added beforehand, during registration
290             #try:
291             #    manifold_user_params = { key: request[key] for key in MANIFOLD_USER_KEYS }
292             #    # XXX # manifold_add_user(manifold_user_params)
293             #    request_status['MySlice user'] = {'status': True }
294             #except Exception, e:
295             #    request_status['MySlice user'] = {'status': False, 'description': str(e)}
296
297             # XXX
298             #manifold_account_params = { key: request[key] for key in MANIFOLD_ACCOUNT_KEYS }
299             #manifold_add_account(manifold_account_params)
300             #request_status['MySlice testbed accounts'] = {'status': False }
301
302         elif request['type'] == 'slice':
303             try:
304                 create_slice(wsgi_request, request)
305                 request_status['SFA slice'] = {'status': True }
306
307             except Exception, e:
308                 request_status['SFA slice'] = {'status': False, 'description': str(e)}
309
310         elif request['type'] == 'authority':
311             try:
312                 #hrn = "%s.%s" % (request['authority_hrn'], request['site_authority'])
313                 hrn = request['site_authority']
314                 # XXX tmp sfa dependency
315                 from sfa.util.xrn import Xrn 
316                 urn = Xrn(hrn, request['type']).get_urn()
317
318                 sfa_authority_params = {
319                     'hrn'        : hrn,
320                     'urn'        : urn,
321                     'type'       : request['type'],
322                     #'pi'        : None,
323                     'enabled'    : True
324                 }
325                 print "ADD Authority"
326                 sfa_add_authority(wsgi_request, sfa_authority_params)
327                 request_status['SFA authority'] = {'status': True }
328
329             except Exception, e:
330                 request_status['SFA authority'] = {'status': False, 'description': str(e)}
331
332         # XXX Remove from Pendings in database
333
334         status['%s__%s' % (request['type'], request['id'])] = request_status
335
336     return status
337
338
339 def validate_action(request, **kwargs):
340     ids = filter(None, kwargs['id'].split('/'))
341     status = portal_validate_request(request, ids)
342     json_answer = json.dumps(status)
343     return HttpResponse (json_answer, mimetype="application/json")
344
345 # Django and ajax
346 # http://djangosnippets.org/snippets/942/
347
348
349
350 #-------------------------------------------------------------------------------
351 # REQUESTS - Slices
352 #-------------------------------------------------------------------------------
353
354 def create_slice(wsgi_request, request):
355     """
356     Arguments:
357         wsgi_request (~ WSGIRequest) : 
358         request (dict) : the slice request in our own dict format
359
360     Raises:
361         Exception
362     """
363     hrn = "%s.%s" % (request['authority_hrn'], request['slice_name'])
364     # XXX tmp sfa dependency
365     from sfa.util.xrn import Xrn 
366     urn = Xrn(hrn, request['type']).get_urn()
367     
368     # Add User to Slice if we have the user_hrn in pendingslice table
369     user_hrn = request.get('user_hrn', None)
370     user_hrns = list([user_hrn]) if user_hrn else list()
371
372     # XXX We should create a slice with Manifold terminology
373     slice_params = {
374         'slice_hrn'        : hrn, 
375         'slice_urn'        : urn,
376         'slice_type'       : request['type'],
377         'users'            : user_hrns,
378         'slice_enabled'    : True
379     }
380     # ignored in request: id, timestamp,  number_of_nodes, type_of_nodes, purpose
381
382     query = Query.create('slice').set(slice_params).select('slice_hrn')
383     results = execute_query(wsgi_request, query)
384     if not results:
385         raise Exception, "Could not create %s. Already exists ?" % slice_params['hrn']
386     return results
387
388 def create_pending_slice(wsgi_request, request, email):
389     """
390     """
391
392     # Insert an entry in the PendingSlice table
393     s = PendingSlice(
394         slice_name      = request['slice_name'],
395         user_hrn        = request['user_hrn'],
396         authority_hrn   = request['authority_hrn'],
397         number_of_nodes = request['number_of_nodes'],
398         purpose         = request['purpose'],
399     )
400     s.save()
401
402     try:
403         # Send an email: the recipients are the PI of the authority
404         recipients = authority_get_pi_emails(wsgi_request, request['authority_hrn'])
405     
406         theme.template_name = 'slice_request_email.txt' 
407         text_content = render_to_string(theme.template, request)
408     
409         theme.template_name = 'slice_request_email.html' 
410         html_content = render_to_string(theme.template, request)
411     
412         theme.template_name = 'slice_request_email_subject.txt'
413         subject = render_to_string(theme.template, request)
414         subject = subject.replace('\n', '')
415     
416         sender = email
417         msg = EmailMultiAlternatives(subject, text_content, sender, [recipients])
418         print msg
419         msg.attach_alternative(html_content, "text/html")
420         msg.send()
421     except Exception, e:
422         print "Failed to send email, please check the mail templates and the SMTP configuration of your server"
423
424 #-------------------------------------------------------------------------------
425 # REQUESTS - Users
426 #-------------------------------------------------------------------------------
427
428 def manifold_add_reference_user_accounts(wsgi_request, request):
429     """When a new user is created, add reference accounts to the reference platform.
430     """
431     # XXX XXX XXX The rest of this function has to be checked XXX XXX XXX
432
433     # Retrieve user information
434     user_query  = Query().get('local:user')             \
435         .select('user_id', 'config', 'email', 'status') \
436         .filter_by('email', '==', request['email'])
437     user_details = execute_admin_query(wsgi_request, user_query)
438
439     # USER MAIN ACCOUNT != reference
440     #print 'USER MAIN ACCOUNT != reference'
441     list_accounts_query = Query().get('local:account')              \
442         .select('user_id', 'platform_id', 'auth_type', 'config')    \
443         .filter_by('user_id', '==', user_details[0]['user_id'])     \
444         .filter_by('auth_type', '!=', 'reference')
445     list_accounts = execute_admin_query(wsgi_request, list_accounts_query)
446
447     # XXX main_platform is being erased several times ???
448     for account in list_accounts:
449         main_platform_query = Query().get('local:platform')         \
450             .select('platform_id', 'platform')                      \
451             .filter_by('platform_id', '==', account['platform_id'])
452         main_platform = execute_admin_query(wsgi_request, main_platform_query)
453
454     # Add reference accounts on SFA enabled platforms
455     platforms_query = Query().get('local:platform') \
456         .filter_by('disabled', '==', '0')           \
457         .filter_by('gateway_type', '==', 'sfa')     \
458         .select('platform_id', 'gateway_type')
459     platforms = execute_admin_query(wsgi_request, platforms_query)
460     for platform in platforms:
461         #print "add reference to platform ",platform
462         manifold_account_params = {
463             'user_id'       : user_details[0]['user_id'],
464             'platform_id'   : platform['platform_id'],
465             'auth_type'     : 'reference',
466             'config'        : '{"reference_platform": "' + main_platform[0]['platform'] + '"}',
467         }
468         manifold_add_account(wsgi_request, manifold_account_params)
469
470 def sfa_create_user(wsgi_request, request):
471     """
472     Arguments:
473         wsgi_request (~ WSGIRequest) : 
474         request (dict) : the user request in our own dict format
475
476     Raises:
477         Exception
478     """
479     from sfa.util.xrn import Xrn 
480
481     auth_pi = request.get('pi', None)
482     auth_pi = list([auth_pi]) if auth_pi else list()
483
484     # We create a user request with Manifold terminology
485     sfa_user_params = {
486         'user_hrn'          : request['user_hrn'],
487         'user_email'        : request['email'],
488         'user_urn'          : Xrn(request['user_hrn'], request['type']).get_urn(),
489         'user_type'         : request['type'],
490         'keys'              : request['public_key'],
491         'user_first_name'   : request['first_name'],
492         'user_last_name'    : request['last_name'],
493         'pi_authorities'    : auth_pi,
494         'user_enabled'      : True
495     }
496
497     query = Query.create('user').set(sfa_user_params).select('user_hrn')
498     results = execute_query(wsgi_request, query)
499     if not results:
500         raise Exception, "Could not create %s. Already exists ?" % sfa_user_params['user_hrn']
501     return results
502
503 #def ldap_create_user
504
505 def create_user(wsgi_request, request):
506     
507     # XXX This has to be stored centrally
508     USER_STATUS_ENABLED = 2
509
510     # NOTE : if we were to create a user directly (just like we create slices,
511     # we would have to perform the steps in create_pending_user too
512
513     # Add the user to the SFA registry
514     sfa_create_user(wsgi_request, request)
515
516     # Update Manifold user status
517     manifold_update_user(wsgi_request, request['email'], {'status': USER_STATUS_ENABLED})
518
519     # Add reference accounts for platforms
520     manifold_add_reference_user_accounts(wsgi_request, request)
521
522 def create_pending_user(wsgi_request, request, user_detail):
523     """
524     """
525
526     # Insert an entry in the PendingUser table
527     b = PendingUser(
528         first_name    = request['first_name'],
529         last_name     = request['last_name'],
530         authority_hrn = request['authority_hrn'],
531         email         = request['email'],
532         password      = request['password'],
533         public_key    = request['public_key'],
534         private_key   = request['private_key'],
535         user_hrn      = request['user_hrn'],
536         pi            = '',                         # XXX Why not None ?
537     )
538     b.save()
539
540     # saves the user to django auth_user table [needed for password reset]
541     user = User.objects.create_user(request['email'], request['email'], request['password'])
542
543     # Creating a manifold user
544     user_id = manifold_add_user(wsgi_request, request)
545
546     # Creating a Manifold account on the MySlice platform
547     # Note the JSON representation of public and private keys already includes quotes
548     account_config = {
549         'user_hrn'          : request['user_hrn'],
550         'user_public_key'   : request['public_key'],
551     }
552     if request['private_key']:
553         account_config['user_private_key'] = request['private_key']
554
555     user_id = user_detail['user_id'] + 1 # the user_id for the newly created user in local:user
556
557     # XXX TODO: Require a myslice platform
558     # ALERT: this will disapear with ROUTERV2 of Manifold
559     # We have to consider the case where several registries can be used
560     # Removed hardcoded platform = 5
561     # This platform == 'myslice' is a TMP FIX !!
562     try:
563         reg_platform_query = Query().get('local:platform') \
564             .filter_by('platform', '==', 'myslice')           \
565             .select('platform_id')
566         reg_platform = execute_admin_query(wsgi_request, reg_platform_query)
567
568         registry_platform_id = reg_platform[0]['platform_id']
569         account_params = {
570             'platform_id'   : reg_platform_id, # XXX ALERT !!
571             'user_id'       : user_id, 
572             'auth_type'     : request['auth_type'], 
573             'config'        : json.dumps(account_config),
574         }
575         manifold_add_account(wsgi_request, account_params)
576     except Exception, e:
577         print "Failed creating manifold account on platform %s for user: %s" % ('myslice', request['email'])
578
579     try:
580         # Send an email: the recipients are the PI of the authority
581         # If No PI is defined for this Authority, send to a default email (different for each theme)
582         recipients = authority_get_pi_emails(wsgi_request, request['authority_hrn'])
583         
584         theme.template_name = 'user_request_email.html'
585         html_content = render_to_string(theme.template, request)
586     
587         theme.template_name = 'user_request_email.txt'
588         text_content = render_to_string(theme.template, request)
589     
590         theme.template_name = 'user_request_email_subject.txt'
591         subject = render_to_string(theme.template, request)
592         subject = subject.replace('\n', '')
593     
594         theme.template_name = 'email_default_sender.txt'
595         sender =  render_to_string(theme.template, request)
596         sender = sender.replace('\n', '')
597     
598         msg = EmailMultiAlternatives(subject, text_content, sender, [recipients])
599         msg.attach_alternative(html_content, "text/html")
600         msg.send()
601     except Exception, e:
602         print "Failed to send email, please check the mail templates and the SMTP configuration of your server"