Email Verification: sends link to user to validate the email address
[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(d['pi_users'] == None for d 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         pending_users  = PendingUser.objects.all()
256         pending_slices = PendingSlice.objects.all()
257         pending_authorities = PendingAuthority.objects.all()
258     else:
259         pending_users  = PendingUser.objects.filter(authority_hrn__in=authority_hrns).all()
260         pending_slices = PendingSlice.objects.filter(authority_hrn__in=authority_hrns).all()
261         pending_authorities = PendingAuthority.objects.filter(authority_hrn__in=authority_hrns).all()
262
263     return make_requests(pending_users, pending_slices, pending_authorities)
264
265 # XXX Is it in sync with the form fields ?
266
267 def portal_validate_request(wsgi_request, request_ids):
268     status = {}
269
270     if not isinstance(request_ids, list):
271         request_ids = [request_ids]
272
273     requests = get_request_by_id(request_ids)
274     for request in requests:
275         # type, id, timestamp, details, allowed -- MISSING: authority_hrn
276         # CAREFUL about details
277         # user  : first name, last name, email, password, keypair
278         # slice : number of nodes, type of nodes, purpose
279         
280         request_status = {}
281
282         if request['type'] == 'user':
283
284             try:
285                 create_user(wsgi_request, request)
286                 request_status['SFA user'] = {'status': True }
287                 PendingUser.objects.get(id=request['id']).delete()
288             except Exception, e:
289                  request_status['SFA user'] = {'status': False, 'description': str(e)}
290                        
291 #            user_params = {'status':2}
292 #            manifold_update_user(request, request['email'], user_params)
293
294             # MANIFOLD user should be added beforehand, during registration
295             #try:
296             #    manifold_user_params = { key: request[key] for key in MANIFOLD_USER_KEYS }
297             #    # XXX # manifold_add_user(manifold_user_params)
298             #    request_status['MySlice user'] = {'status': True }
299             #except Exception, e:
300             #    request_status['MySlice user'] = {'status': False, 'description': str(e)}
301
302             # XXX
303             #manifold_account_params = { key: request[key] for key in MANIFOLD_ACCOUNT_KEYS }
304             #manifold_add_account(manifold_account_params)
305             #request_status['MySlice testbed accounts'] = {'status': False }
306
307         elif request['type'] == 'slice':
308             try:
309                 create_slice(wsgi_request, request)
310                 request_status['SFA slice'] = {'status': True }
311                 PendingSlice.objects.get(id=request['id']).delete()
312
313             except Exception, e:
314                 request_status['SFA slice'] = {'status': False, 'description': str(e)}
315
316         elif request['type'] == 'authority':
317             try:
318                 #hrn = "%s.%s" % (request['authority_hrn'], request['site_authority'])
319                 hrn = request['site_authority']
320                 # XXX tmp sfa dependency
321                 from sfa.util.xrn import Xrn 
322                 urn = Xrn(hrn, request['type']).get_urn()
323
324                 sfa_authority_params = {
325                     'hrn'        : hrn,
326                     'urn'        : urn,
327                     'type'       : request['type'],
328                     #'pi'        : None,
329                     'enabled'    : True
330                 }
331                 print "ADD Authority"
332                 sfa_add_authority(wsgi_request, sfa_authority_params)
333                 request_status['SFA authority'] = {'status': True }
334                 PendingAuthority.objects.get(id=request['id']).delete()
335
336             except Exception, e:
337                 request_status['SFA authority'] = {'status': False, 'description': str(e)}
338
339         # XXX Remove from Pendings in database
340
341         status['%s__%s' % (request['type'], request['id'])] = request_status
342
343     return status
344
345
346 def validate_action(request, **kwargs):
347     ids = filter(None, kwargs['id'].split('/'))
348     status = portal_validate_request(request, ids)
349     json_answer = json.dumps(status)
350     return HttpResponse (json_answer, mimetype="application/json")
351
352 # Django and ajax
353 # http://djangosnippets.org/snippets/942/
354
355
356
357 #-------------------------------------------------------------------------------
358 # REQUESTS - Slices
359 #-------------------------------------------------------------------------------
360
361 def create_slice(wsgi_request, request):
362     """
363     Arguments:
364         wsgi_request (~ WSGIRequest) : 
365         request (dict) : the slice request in our own dict format
366
367     Raises:
368         Exception
369     """
370     hrn = "%s.%s" % (request['authority_hrn'], request['slice_name'])
371     # XXX tmp sfa dependency
372     from sfa.util.xrn import Xrn 
373     urn = Xrn(hrn, request['type']).get_urn()
374     
375     # Add User to Slice if we have the user_hrn in pendingslice table
376     user_hrn = request.get('user_hrn', None)
377     user_hrns = list([user_hrn]) if user_hrn else list()
378
379     # XXX We should create a slice with Manifold terminology
380     slice_params = {
381         'slice_hrn'        : hrn, 
382         'slice_urn'        : urn,
383         'slice_type'       : request['type'],
384         'users'            : user_hrns,
385         'slice_enabled'    : True
386     }
387     # ignored in request: id, timestamp,  number_of_nodes, type_of_nodes, purpose
388
389     query = Query.create('slice').set(slice_params).select('slice_hrn')
390     results = execute_query(wsgi_request, query)
391     if not results:
392         raise Exception, "Could not create %s. Already exists ?" % slice_params['hrn']
393     return results
394
395 def create_pending_slice(wsgi_request, request, email):
396     """
397     """
398
399     # Insert an entry in the PendingSlice table
400     s = PendingSlice(
401         slice_name      = request['slice_name'],
402         user_hrn        = request['user_hrn'],
403         authority_hrn   = request['authority_hrn'],
404         number_of_nodes = request['number_of_nodes'],
405         purpose         = request['purpose'],
406     )
407     s.save()
408
409     try:
410         # Send an email: the recipients are the PI of the authority
411         recipients = authority_get_pi_emails(wsgi_request, request['authority_hrn'])
412
413         theme.template_name = 'slice_request_email.txt' 
414         text_content = render_to_string(theme.template, request)
415     
416         theme.template_name = 'slice_request_email.html' 
417         html_content = render_to_string(theme.template, request)
418     
419         theme.template_name = 'slice_request_email_subject.txt'
420         subject = render_to_string(theme.template, request)
421         subject = subject.replace('\n', '')
422     
423         sender = email
424         msg = EmailMultiAlternatives(subject, text_content, sender, recipients)
425         msg.attach_alternative(html_content, "text/html")
426         msg.send()
427     except Exception, e:
428         print "Failed to send email, please check the mail templates and the SMTP configuration of your server"
429
430 #-------------------------------------------------------------------------------
431 # REQUESTS - Users
432 #-------------------------------------------------------------------------------
433
434 def manifold_add_reference_user_accounts(wsgi_request, request):
435     """When a new user is created, add reference accounts to the reference platform.
436     """
437     # XXX XXX XXX The rest of this function has to be checked XXX XXX XXX
438
439     # Retrieve user information
440     user_query  = Query().get('local:user')             \
441         .select('user_id', 'config', 'email', 'status') \
442         .filter_by('email', '==', request['email'])
443     user_details = execute_admin_query(wsgi_request, user_query)
444
445     # USER MAIN ACCOUNT != reference
446     #print 'USER MAIN ACCOUNT != reference'
447     list_accounts_query = Query().get('local:account')              \
448         .select('user_id', 'platform_id', 'auth_type', 'config')    \
449         .filter_by('user_id', '==', user_details[0]['user_id'])     \
450         .filter_by('auth_type', '!=', 'reference')
451     list_accounts = execute_admin_query(wsgi_request, list_accounts_query)
452
453     # XXX main_platform is being erased several times ???
454     for account in list_accounts:
455         main_platform_query = Query().get('local:platform')         \
456             .select('platform_id', 'platform')                      \
457             .filter_by('platform_id', '==', account['platform_id'])
458         main_platform = execute_admin_query(wsgi_request, main_platform_query)
459
460     # Add reference accounts on SFA enabled platforms
461     platforms_query = Query().get('local:platform') \
462         .filter_by('disabled', '==', '0')           \
463         .filter_by('gateway_type', '==', 'sfa')     \
464         .select('platform_id', 'gateway_type')
465     platforms = execute_admin_query(wsgi_request, platforms_query)
466     for platform in platforms:
467         #print "add reference to platform ",platform
468         manifold_account_params = {
469             'user_id'       : user_details[0]['user_id'],
470             'platform_id'   : platform['platform_id'],
471             'auth_type'     : 'reference',
472             'config'        : '{"reference_platform": "' + main_platform[0]['platform'] + '"}',
473         }
474         manifold_add_account(wsgi_request, manifold_account_params)
475
476 def sfa_create_user(wsgi_request, request):
477     """
478     Arguments:
479         wsgi_request (~ WSGIRequest) : 
480         request (dict) : the user request in our own dict format
481
482     Raises:
483         Exception
484     """
485     from sfa.util.xrn import Xrn 
486
487     auth_pi = request.get('pi', None)
488     auth_pi = list([auth_pi]) if auth_pi else list()
489
490     # We create a user request with Manifold terminology
491     sfa_user_params = {
492         'user_hrn'          : request['user_hrn'],
493         'user_email'        : request['email'],
494         'user_urn'          : Xrn(request['user_hrn'], request['type']).get_urn(),
495         'user_type'         : request['type'],
496         'keys'              : request['public_key'],
497         'user_first_name'   : request['first_name'],
498         'user_last_name'    : request['last_name'],
499         'pi_authorities'    : auth_pi,
500         'user_enabled'      : True
501     }
502
503     query = Query.create('user').set(sfa_user_params).select('user_hrn')
504     results = execute_query(wsgi_request, query)
505     if not results:
506         raise Exception, "Could not create %s. Already exists ?" % sfa_user_params['user_hrn']
507     return results
508
509 def create_user(wsgi_request, request):
510     
511     # XXX This has to be stored centrally
512     USER_STATUS_ENABLED = 2
513
514     # NOTE : if we were to create a user directly (just like we create slices,
515     # we would have to perform the steps in create_pending_user too
516
517     # Add the user to the SFA registry
518     sfa_create_user(wsgi_request, request)
519
520     # Update Manifold user status
521     manifold_update_user(wsgi_request, request['email'], {'status': USER_STATUS_ENABLED})
522
523     # Add reference accounts for platforms
524     manifold_add_reference_user_accounts(wsgi_request, request)
525
526 def create_pending_user(wsgi_request, request, user_detail):
527     """
528     """
529
530     # Insert an entry in the PendingUser table
531     b = PendingUser(
532         first_name    = request['first_name'],
533         last_name     = request['last_name'],
534         authority_hrn = request['authority_hrn'],
535         email         = request['email'],
536         password      = request['password'],
537         public_key    = request['public_key'],
538         private_key   = request['private_key'],
539         user_hrn      = request['user_hrn'],
540         pi            = '',                         # XXX Why not None ?
541         email_hash    = request['email_hash'],
542         status        = 'False',
543     )
544     b.save()
545     # sends email to user to activate the email
546     theme.template_name = 'activate_user.html'
547     html_content = render_to_string(theme.template, request)
548     theme.template_name = 'activate_user.txt'
549     text_content = render_to_string(theme.template, request)
550     theme.template_name = 'activate_user_email_subject.txt'
551     subject = render_to_string(theme.template, request)
552     subject = subject.replace('\n', '')
553     sender = 'support@myslice.info'
554     recipient = [request['email']]
555     #recipient = recipient.append(request['email'])
556
557     msg = EmailMultiAlternatives(subject, text_content, sender, recipient)
558     msg.attach_alternative(html_content, "text/html")
559     msg.send()
560    
561     # saves the user to django auth_user table [needed for password reset]
562     user = User.objects.create_user(request['email'], request['email'], request['password'])
563
564     # Creating a manifold user
565     user_id = manifold_add_user(wsgi_request, request)
566
567     # Creating a Manifold account on the MySlice platform
568     # Note the JSON representation of public and private keys already includes quotes
569     account_config = {
570         'user_hrn'          : request['user_hrn'],
571         'user_public_key'   : request['public_key'],
572     }
573     if request['private_key']:
574         account_config['user_private_key'] = request['private_key']
575
576     user_id = user_detail['user_id'] + 1 # the user_id for the newly created user in local:user
577
578     # XXX TODO: Require a myslice platform
579     # ALERT: this will disapear with ROUTERV2 of Manifold
580     # We have to consider the case where several registries can be used
581     # Removed hardcoded platform = 5
582     # This platform == 'myslice' is a TMP FIX !!
583     try:
584         reg_platform_query = Query().get('local:platform') \
585             .filter_by('platform', '==', 'myslice')           \
586             .select('platform_id')
587         reg_platform = execute_admin_query(wsgi_request, reg_platform_query)
588
589         reg_platform_id = reg_platform[0]['platform_id']
590         account_params = {
591             'platform_id'   : reg_platform_id, # XXX ALERT !!
592             'user_id'       : user_id, 
593             'auth_type'     : request['auth_type'], 
594             'config'        : json.dumps(account_config),
595         }
596         manifold_add_account(wsgi_request, account_params)
597     except Exception, e:
598         print "Failed creating manifold account on platform %s for user: %s" % ('myslice', request['email'])
599
600     try:
601         # Send an email: the recipients are the PI of the authority
602         # If No PI is defined for this Authority, send to a default email (different for each theme)
603         recipients = authority_get_pi_emails(wsgi_request, request['authority_hrn'])
604         
605         theme.template_name = 'user_request_email.html'
606         html_content = render_to_string(theme.template, request)
607     
608         theme.template_name = 'user_request_email.txt'
609         text_content = render_to_string(theme.template, request)
610     
611         theme.template_name = 'user_request_email_subject.txt'
612         subject = render_to_string(theme.template, request)
613         subject = subject.replace('\n', '')
614     
615         theme.template_name = 'email_default_sender.txt'
616         sender =  render_to_string(theme.template, request)
617         sender = sender.replace('\n', '')
618     
619         msg = EmailMultiAlternatives(subject, text_content, sender, recipients)
620         msg.attach_alternative(html_content, "text/html")
621         msg.send()
622     except Exception, e:
623         print "Failed to send email, please check the mail templates and the SMTP configuration of your server"
624         import traceback
625         traceback.print_exc()