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.manifoldapi import ManifoldAPI
   9 from manifold.manifoldresult import ManifoldException
  10
  11 debug=False
  12 debug=True
  13
  14 # add artificial delay in s
  15 debug_spin=0
  16 #debug_spin=1
  17
  18 # pretend the server only returns - empty lists to 'get' requests - this is to mimick
  19 # misconfigurations or expired credentials or similar corner case situations
  20 debug_empty=False
  21 #debug_empty=True
  22
  23 # turn this on if you want the fastest possible (locally cached) feedback
  24 # beware that this is very rough though...
  25 work_offline=False
  26 #work_offline=True
  27
  28 # this view is what the javascript talks to when it sends a query
  29 # see also
  30 # myslice/urls.py
  31 # as well as
  32 # static/js/manifold.js
  33 def proxy (request,format):
  34     """the view associated with /manifold/proxy/
  35 with the query passed using POST"""
  36
  37     # expecting a POST
  38     if request.method != 'POST':
  39         print "manifoldproxy.api: unexpected method %s -- exiting"%request.method
  40         return
  41     # we only support json for now
  42     # if needed in the future we should probably cater for
  43     # format_in : how is the query encoded in POST
  44     # format_out: how to serve the results
  45     if format != 'json':
  46         print "manifoldproxy.proxy: unexpected format %s -- exiting"%format
  47         return
  48     try:
  49         # translate incoming POST request into a query object
  50         if debug: print 'manifoldproxy.proxy: request.POST',request.POST
  51         manifold_query = Query()
  52         #manifold_query = ManifoldQuery()
  53         manifold_query.fill_from_POST(request.POST)
  54         offline_filename="offline-%s-%s.json"%(manifold_query.action,manifold_query.object)
  55         # retrieve session for request
  56         manifold_api_session_auth = request.session['manifold']['auth']
  57         if debug_empty and manifold_query.action.lower()=='get':
  58             json_answer=json.dumps({'code':0,'value':[]})
  59             print "By-passing : debug_empty & 'get' request : returning a fake empty list"
  60             return HttpResponse (json_answer, mimetype="application/json")
  61         ### patch : return the latest one..
  62         if work_offline:
  63             # if that won't work then we'll try to update anyways
  64             try:
  65                 with (file(offline_filename,"r")) as f:
  66                     json_answer=f.read()
  67                 print "By-passing : using contents from %s"%offline_filename
  68                 return HttpResponse (json_answer, mimetype="application/json")
  69             except:
  70                 import traceback
  71                 traceback.print_exc()
  72                 print "Could not run in offline mode, PROCEEDING"
  73                 pass
  74
  75         # actually forward
  76         manifold_api= ManifoldAPI(auth=manifold_api_session_auth)
  77         if debug: print '===> manifoldproxy.proxy: sending to backend', manifold_query
  78         # for the benefit of the python code, manifoldAPI raises an exception if something is wrong
  79         # however in this case we want to propagate the complete manifold result to the js world
  80         try:
  81             answer=manifold_api.send_manifold_query (manifold_query)
  82         except ManifoldException, manifold_result:
  83             answer=manifold_result
  84         print "="*80
  85         print "ANSWER IN PROXY", answer
  86         print answer.ok_value()
  87         print "="*80
  88         if debug:
  89             print '<=== manifoldproxy.proxy: received from backend with code', answer['code']
  90             if answer['code']==0:
  91                 print ".... ctd ",
  92                 value=answer.ok_value()
  93                 if isinstance (value, list): print "result is a list with %d entries"%len(value)
  94                 elif isinstance (value, dict): print "result is a dict with keys %s"%value.keys()
  95                 else: print "result is other (type=%s) : %s"%(type(value),value)
  96         json_answer=json.dumps(answer)
  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         # this is an artificial delay added for debugging purposes only
 102         if debug_spin>0:
 103             print "Adding additional artificial delay",debug_spin
 104             import time
 105             time.sleep(debug_spin)
 106         return HttpResponse (json_answer, mimetype="application/json")
 107
 108     except:
 109         import traceback
 110         traceback.print_exc()
 111
 112 ####################
 113 # see CSRF_FAILURE_VIEW in settings.py
 114 # the purpose of redefining this was to display the failure reason somehow
 115 # this however turns out disappointing/not very informative
 116 failure_answer=[ "csrf_failure" ]
 117 def csrf_failure(request, reason=""):
 118     print "CSRF failure with reason '%s'"%reason
 119     return HttpResponseForbidden (json.dumps (failure_answer), mimetype="application/json")