rest/sfa_api.py

   1 import os
   2 import json
   3 import ConfigParser
   4 import datetime
   5 from time                       import mktime
   6 import xmltodict
   7
   8 from django.shortcuts           import render_to_response
   9 from django.http                import HttpResponse
  10
  11 from sfa.trust.certificate      import Keypair, Certificate
  12 from sfa.client.sfaserverproxy  import SfaServerProxy
  13 from sfa.client.return_value    import ReturnValue
  14 from sfa.util.xrn               import Xrn, get_leaf, get_authority, hrn_to_urn, urn_to_hrn
  15
  16 from manifold.core.query        import Query
  17
  18 from manifoldapi.manifoldapi    import execute_admin_query
  19
  20 from unfold.loginrequired       import LoginRequiredView
  21
  22 from myslice.settings           import logger, config
  23
  24 from rest.json_encoder          import MyEncoder
  25
  26 def dispatch(request, method):
  27
  28     hrn = ''
  29     urn = ''
  30     object_type = ''
  31     rspec = ''
  32     recursive = False
  33     options   = dict()
  34     platforms = list()
  35
  36     results = dict()
  37     display = None
  38
  39     if request.method == 'POST':
  40         req_items = request.POST
  41     elif request.method == 'GET':
  42         req_items = request.GET
  43
  44     for el in req_items.items():
  45         if el[0].startswith('rspec'):
  46             rspec += el[1]
  47         elif el[0].startswith('platform'):
  48             platforms = req_items.getlist('platform[]')
  49         #elif el[0].startswith('options'):
  50         #    options += req_items.getlist('options[]')
  51         elif el[0].startswith('hrn'):
  52             hrn = el[1]
  53         elif el[0].startswith('urn'):
  54             urn = el[1]
  55         elif el[0].startswith('type'):
  56             object_type = el[1]
  57         elif el[0].startswith('recursive'):
  58             if el[1] == '1':
  59                 recursive = True
  60             else:
  61                 recursive = False
  62         elif el[0].startswith('display'):
  63             display = el[1]
  64
  65     results = sfa_client(request, method, hrn=hrn, urn=urn, object_type=object_type, recursive=recursive, options=options, platforms=platforms)
  66     if display == 'table':
  67         return render_to_response('table-default.html', {'data' : data, 'fields' : columns, 'id' : '@component_id', 'options' : None})
  68     else:
  69         return HttpResponse(json.dumps(results, cls=MyEncoder), content_type="application/json")
  70
  71 def get_user_account(request, user_email, platform_name):
  72     """
  73     Returns the user configuration for a given platform.
  74     This function does not resolve references.
  75     """
  76     user_query  = Query().get('local:user').filter_by('email', '==', user_email).select('user_id')
  77     user_details = execute_admin_query(request, user_query)
  78     platform_query  = Query().get('local:platform').filter_by('platform', '==', platform_name).select('platform_id')
  79     platform_details = execute_admin_query(request, platform_query)
  80
  81     account_query  = Query().get('local:account').filter_by('platform_id','==',platform_details[0]['platform_id']).filter_by('user_id', '==', user_details[0]['user_id']).select('user_id','platform_id','auth_type','config')
  82     accounts = execute_admin_query(request, account_query)
  83
  84     if not accounts:
  85         raise Exception, "this account does not exist"
  86
  87     if accounts[0]['auth_type'] == 'reference':
  88         pf = json.loads(accounts[0]['config'])['reference_platform']
  89         return get_user_account(request, user_email, pf)
  90
  91     return accounts[0]
  92
  93 def sfa_client(request, method, hrn=None, urn=None, object_type=None, rspec=None, recursive=None, options=None, platforms=None, admin=False):
  94
  95     Config = ConfigParser.ConfigParser()
  96     monitor_file = os.path.abspath(os.path.dirname(__file__) + '/../myslice/monitor.ini')
  97     Config.read(monitor_file)
  98
  99     if admin:
 100         user_email, admin_password = config.manifold_admin_user_password()
 101     else:
 102         #logger.debug(request.session['user']['email'])
 103         user_email = request.session['user']['email']
 104
 105     results = dict()
 106
 107     if hrn is None:
 108         hrn = ''
 109     if urn is None:
 110         urn = ''
 111     if object_type is None:
 112         object_type = ''
 113     if rspec is None:
 114         rspec = ''
 115     if recursive is None:
 116         recursive = False
 117     if options is None:
 118         options  = dict()
 119     if platforms is None:
 120         platforms = list()
 121
 122     if method not in ['GetVersion','ListResources']:
 123         try:
 124             if not hrn:
 125                 hrn = urn_to_hrn(urn)
 126             else:
 127                 urn = hrn_to_urn(hrn, object_type)
 128         except Exception,e:
 129             logger.error(e)
 130             raise Exception, "Provide urn OR hrn + type as parameters of method %s" % method
 131
 132     if len(platforms)==0:
 133         platforms = get_platforms(request)
 134         #platforms.append('myslice')
 135     #results = {'method':method,'platforms':platforms,'rspec':rspec,'options':options}
 136
 137     result = []
 138     dict_result = {}
 139     data = []
 140     columns = []
 141     api_options = {}
 142     api_options['geni_rspec_version'] = {'type': 'GENI', 'version': '3'}
 143     api_options['list_leases'] = 'all'
 144     server_am = False
 145     for pf in platforms:
 146         platform = get_platform_config(request, pf)
 147         logger.debug("platform={}".format(platform))
 148         if 'sm' in platform and len(platform['sm']) > 0:
 149             logger.debug('sm')
 150             server_am = True
 151             server_url = platform['sm']
 152         if 'rm' in platform and len(platform['rm']) > 0:
 153             logger.debug('rm')
 154             server_am = False
 155             server_url = platform['rm']
 156         if 'registry' in platform and len(platform['registry']) > 0:
 157             logger.debug('registry')
 158             server_am = False
 159             server_url = platform['registry']
 160
 161         if not Config.has_option('monitor', 'cert') :
 162              #return HttpResponse(json.dumps({'error' : '-1'}), content_type="application/json")
 163              return {'error' : '-1', 'msg': 'monitor.ini has no cert configured'}
 164
 165         cert = os.path.abspath(Config.get('monitor', 'cert'))
 166         if not os.path.isfile(cert) :
 167              #return HttpResponse(json.dumps({'error' : '-1'}), content_type="application/json")
 168              return {'error' : '-1', 'msg': 'check cert file at %s'%cert}
 169
 170         if not Config.has_option('monitor', 'pkey') :
 171              #return HttpResponse(json.dumps({'error' : '-2'}), content_type="application/json")
 172              return {'error' : '-2'}
 173
 174         pkey = os.path.abspath(Config.get('monitor', 'pkey'))
 175         if not os.path.isfile(pkey) :
 176              #return HttpResponse(json.dumps({'error' : '-2'}), content_type="application/json")
 177              return {'error' : '-2'}
 178
 179         server = SfaServerProxy(server_url, pkey, cert)
 180
 181         try:
 182             # Get user config from Manifold
 183             user_config = get_user_config(request, user_email, pf)
 184             if 'delegated_user_credential' in user_config:
 185                 user_cred = user_config['delegated_user_credential']
 186             elif 'user_credential' in user_config:
 187                 user_cred = user_config['user_credential']
 188             else:
 189                 user_cred = {}
 190
 191             if object_type:
 192                 if 'delegated_%s_credentials'%object_type in user_config:
 193                     for obj_name, cred in user_config['delegated_%s_credentials'%object_type].items():
 194                         if obj_name == hrn:
 195                             object_cred = cred
 196                 elif '%s_credentials'%object_type in user_config:
 197                     for obj_name, cred in user_config['%s_credentials'%object_type].items():
 198                         if obj_name == hrn:
 199                             object_cred = cred
 200
 201             # Both AM & Registry
 202             if method == "GetVersion":
 203                 result = server.GetVersion()
 204             else:
 205                 # AM API Calls
 206                 if server_am:
 207                     if method == "ListResources":
 208                         result = server.ListResources([user_cred], api_options)
 209                         logger.debug(result)
 210                         dict_result = xmltodict.parse(result['value'])
 211                         result['parsed'] = dict_result
 212                         if isinstance(dict_result['rspec']['node'], list):
 213                             columns.extend(dict_result['rspec']['node'][0].keys())
 214                         else:
 215                             columns.extend(dict_result['rspec']['node'].keys())
 216
 217                     elif method == "Describe":
 218                         version = server.GetVersion()
 219                         logger.debug(version['geni_api'])
 220                         # if GetVersion = v2
 221                         if version['geni_api'] == 2:
 222                             # ListResources(slice_hrn)
 223                             api_options['geni_slice_urn'] = urn
 224                             result = server.ListResources([object_cred], api_options)
 225                             dict_result = xmltodict.parse(result['value'])
 226                         # else GetVersion = v3
 227                         else:
 228                             result = server.Describe([urn] ,[object_cred], api_options)
 229                             dict_result = xmltodict.parse(result['value']['geni_rspec'])
 230
 231                         result['parsed'] = dict_result
 232                         if 'rspec' in dict_result and 'node' in dict_result['rspec']:
 233                             if isinstance(dict_result['rspec']['node'], list):
 234                                 columns.extend(dict_result['rspec']['node'][0].keys())
 235                             else:
 236                                 columns.extend(dict_result['rspec']['node'].keys())
 237
 238                     elif method == 'Renew':
 239                         # Renew till 1 month from now
 240                         d = datetime.datetime.utcnow() + datetime.timedelta(365/12)
 241                         date = d.isoformat("T") + "Z"
 242                         result = server.Renew([urn] ,[object_cred], date, api_options)
 243                     elif method == 'Delete':
 244                         result = server.Delete([urn] ,[object_cred], api_options)
 245                     elif method == 'Allocate':
 246                         api_options['call_id']    = unique_call_id()
 247                         # List of users comes from the Registry
 248                         api_options['sfa_users']  = sfa_users
 249                         api_options['geni_users'] = geni_users
 250                         # if GetVersion = v2
 251                         version = server.GetVersion()
 252                         if version['geni_api'] == 2:
 253                             result = server.CreateSliver([urn] ,[object_cred], rspec, api_options)
 254                         # else GetVersion = v3
 255                         else:
 256                             result = server.Allocate([urn] ,[object_cred], rspec, api_options)
 257                     elif method == 'Provision':
 258                         # if GetVersion = v2
 259                         # Nothing it is not supported by v2 AMs
 260                         version = server.GetVersion()
 261                         if version['geni_api'] == 3:
 262                             api_options['call_id']    = unique_call_id()
 263                             # List of users comes from the Registry
 264                             api_options['sfa_users']  = sfa_users
 265                             api_options['geni_users'] = geni_users
 266                             result = server.Provision([urn] ,[object_cred], api_options)
 267                     elif method == 'Status':
 268                         result = server.Status([urn] ,[object_cred], api_options)
 269                     elif method == 'PerformOperationalAction':
 270                         # if GetVersion = v2
 271                         # Nothing it is not supported by v2 AMs
 272                         version = server.GetVersion()
 273                         if version['geni_api'] == 3:
 274                             result = server.PerformOperationalAction([urn] ,[object_cred], action, api_options)
 275                     elif method == 'Shutdown':
 276                         result = server.Shutdown(urn ,[object_cred], api_options)
 277                     else:
 278                         #return HttpResponse(json.dumps({'error' : '-3','msg':'method not supported by AM'}), content_type="application/json")
 279                         logger.debug('method %s not handled by AM' % method)
 280                         result = []
 281
 282                 # Registry API Calls
 283                 else:
 284                     record_dict = {'urn': urn, 'hrn': hrn, 'type': object_type}
 285                     if method == "List":
 286                         # hrn is required
 287                         api_options['recursive'] = recursive
 288                         result = server.List(hrn, user_cred, api_options)
 289                         if object_type:
 290                             result = filter_records(object_type, result)
 291                     elif method == "Resolve":
 292                         # hrn is required
 293                         # details can be True or False
 294                         api_options['details']=True
 295                         result = server.Resolve(hrn, user_cred, api_options)
 296                         if object_type:
 297                             result = filter_records(object_type, result)
 298                     elif method == "Register":
 299                         # record_dict must be crafted
 300                         # auth_cred must be selected in the list of auth_creds from user's account
 301                         result = server.Register(record_dict, auth_cred)
 302                     elif method == "Update":
 303                         # record_dict must be crafted
 304                         # object_cred must be selected in the list of creds for the object type
 305                         # from user's account
 306                         result = server.Update(record_dict, object_cred)
 307                     elif method == "Remove":
 308                         # hrn is required
 309                         # auth_cred must be selected in the list of auth_creds from user's account
 310                         # object_type is required
 311                         result = server.Remove(hrn, auth_cred, object_type)
 312                     else:
 313                         #return HttpResponse(json.dumps({'error' : '-3','msg':'method not supported by Registry'}), content_type="application/json")
 314                         logger.debug('method %s not handled by Registry' % method)
 315                         result = []
 316
 317             results[pf] = result
 318             if dict_result:
 319                 if 'rspec' in dict_result and 'node' in dict_result['rspec']:
 320                     if isinstance(dict_result['rspec']['node'], list):
 321                         data = data + dict_result['rspec']['node']
 322                     else:
 323                         data.append(dict_result['rspec']['node'])
 324         except Exception,e:
 325             import traceback
 326             logger.error(traceback.format_exc())
 327             logger.error(e)
 328             results[pf] = {'error':'-3', 'error_msg': str(e)}
 329
 330     results['columns'] = columns
 331     return results
 332
 333 def get_user_config(request, user_email, platform_name):
 334     account = get_user_account(request, user_email, platform_name)
 335     return json.loads(account['config']) if account['config'] else {}
 336
 337 def get_platforms(request):
 338     ret = list()
 339     platform_query  = Query().get('local:platform').filter_by('gateway_type', '==', 'sfa').filter_by('disabled','==',0).select('platform')
 340     platforms = execute_admin_query(request, platform_query)
 341
 342     for p in platforms:
 343         ret.append(p['platform'])
 344     return ret
 345
 346 def get_platform_config(request, platform_name):
 347     platform_query  = Query().get('local:platform').filter_by('platform', '==', platform_name).select('platform', 'config')
 348     platforms = execute_admin_query(request, platform_query)
 349
 350     return json.loads(platforms[0]['config']) if platforms[0]['config'] else {}
 351
 352 def filter_records(type, records):
 353     filtered_records = []
 354     for record in records:
 355         if (record['type'] == type) or (type == "all"):
 356             filtered_records.append(record)
 357     return filtered_records