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