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