manifold/manifoldproxy.py

   1 import json
   2 # this is for django objects only
   3 #from django.core import serializers
   4 from django.http import HttpResponse, HttpResponseForbidden
   5
   6 #from manifold.manifoldquery import ManifoldQuery
   7 from manifold.core.query import Query
   8 from manifold.core.result_value import ResultValue
   9 from manifold.manifoldapi import ManifoldAPI
  10 from manifold.manifoldresult import ManifoldException
  11
  12 debug=False
  13 debug=True
  14
  15 # add artificial delay in s
  16 debug_spin=0
  17 #debug_spin=1
  18
  19 # pretend the server only returns - empty lists to 'get' requests - this is to mimick
  20 # misconfigurations or expired credentials or similar corner case situations
  21 debug_empty=False
  22 #debug_empty=True
  23
  24 # turn this on if you want the fastest possible (locally cached) feedback
  25 # beware that this is very rough though...
  26 work_offline=False
  27 #work_offline=True
  28
  29 # this view is what the javascript talks to when it sends a query
  30 # see also
  31 # myslice/urls.py
  32 # as well as
  33 # static/js/manifold.js
  34 def proxy (request,format):
  35     """the view associated with /manifold/proxy/
  36 with the query passed using POST"""
  37
  38     # expecting a POST
  39     if request.method != 'POST':
  40         print "manifoldproxy.api: unexpected method %s -- exiting"%request.method
  41         return
  42     # we only support json for now
  43     # if needed in the future we should probably cater for
  44     # format_in : how is the query encoded in POST
  45     # format_out: how to serve the results
  46     if format != 'json':
  47         print "manifoldproxy.proxy: unexpected format %s -- exiting"%format
  48         return
  49     try:
  50         # translate incoming POST request into a query object
  51         if debug: print 'manifoldproxy.proxy: request.POST',request.POST
  52         manifold_query = Query()
  53         #manifold_query = ManifoldQuery()
  54         manifold_query.fill_from_POST(request.POST)
  55         offline_filename="offline-%s-%s.json"%(manifold_query.action,manifold_query.object)
  56         # retrieve session for request
  57
  58         # We allow some requests to use the ADMIN user account
  59         if (manifold_query.get_from() == 'local:user' and manifold_query.get_action() == 'create') or (manifold_query.get_from() == 'local:platform' and manifold_query.get_action() == 'get'):
  60             print "W: Used hardcoded demo account for admin queries"
  61             manifold_api_session_auth = {'AuthMethod': 'password', 'Username': 'demo', 'AuthString': 'demo'}
  62         else:
  63             manifold_api_session_auth = request.session['manifold']['auth']
  64
  65         if debug_empty and manifold_query.action.lower()=='get':
  66             json_answer=json.dumps({'code':0,'value':[]})
  67             print "By-passing : debug_empty & 'get' request : returning a fake empty list"
  68             return HttpResponse (json_answer, mimetype="application/json")
  69         ### patch : return the latest one..
  70         if work_offline:
  71             # if that won't work then we'll try to update anyways
  72             try:
  73                 with (file(offline_filename,"r")) as f:
  74                     json_answer=f.read()
  75                 print "By-passing : using contents from %s"%offline_filename
  76                 return HttpResponse (json_answer, mimetype="application/json")
  77             except:
  78                 import traceback
  79                 traceback.print_exc()
  80                 print "Could not run in offline mode, PROCEEDING"
  81                 pass
  82
  83         # actually forward
  84         manifold_api= ManifoldAPI(auth=manifold_api_session_auth)
  85         if debug: print '===> manifoldproxy.proxy: sending to backend', manifold_query
  86         # for the benefit of the python code, manifoldAPI raises an exception if something is wrong
  87         # however in this case we want to propagate the complete manifold result to the js world
  88
  89
  90         result = manifold_api.forward(manifold_query.to_dict())
  91
  92         # XXX TEMP HACK
  93         if 'description' in result and result['description'] and isinstance(result['description'], (tuple, list, set, frozenset)):
  94             result [ 'description' ] = [ ResultValue.to_html (x) for x in result['description'] ]
  95
  96         json_answer=json.dumps(result)
  97         # if in debug mode we save this so we can use offline mode later
  98         if debug:
  99             with (file(offline_filename,"w")) as f:
 100                 f.write(json_answer)
 101
 102         # this is an artificial delay added for debugging purposes only
 103         if debug_spin>0:
 104             print "Adding additional artificial delay",debug_spin
 105             import time
 106             time.sleep(debug_spin)
 107
 108         return HttpResponse (json_answer, mimetype="application/json")
 109
 110     except Exception,e:
 111         print "** PROXY ERROR **",e
 112         import traceback
 113         traceback.print_exc()
 114
 115 ####################
 116 # see CSRF_FAILURE_VIEW in settings.py
 117 # the purpose of redefining this was to display the failure reason somehow
 118 # this however turns out disappointing/not very informative
 119 failure_answer=[ "csrf_failure" ]
 120 def csrf_failure(request, reason=""):
 121     print "CSRF failure with reason '%s'"%reason
 122     return HttpResponseForbidden (json.dumps (failure_answer), mimetype="application/json")