Hopefully fixed git username-- Yasin :)
[myslice.git] / manifoldapi / manifoldapi.py
1 # Manifold API Python interface
2 import copy, xmlrpclib
3
4 from myslice.configengine import ConfigEngine
5
6 from django.contrib import messages
7 from django.shortcuts import redirect
8 from manifoldresult import ManifoldResult, ManifoldCode, ManifoldException
9 from manifold.core.result_value import ResultValue
10
11 debug=False
12 debug=True
13 debug_deep=False
14 #debug_deep=True
15
16 ########## ugly stuff for hopefully nicer debug messages
17 def mytruncate (obj, l):
18     # we will add '..' 
19     l1=l-2
20     repr="%s"%obj
21     return (repr[:l1]+'..') if len(repr)>l1 else repr
22
23 from time import time, gmtime, strftime
24 from math import trunc
25 def mytime (start=None):
26     gm=gmtime()
27     t=time()
28     msg=strftime("%H:%M:%S-", gmtime())+"%03d"%((t-trunc(t))*1000)
29     if start is not None: msg += " (%03fs)"%(t-start)
30     return t,msg
31 ##########
32
33 class ManifoldAPI:
34
35     def __init__ (self, auth=None, cainfo=None):
36         
37         self.auth = auth
38         self.cainfo = cainfo
39         self.errors = []
40         self.trace = []
41         self.calls = {}
42         self.multicall = False
43         self.url = ConfigEngine().manifold_url()
44         self.server = xmlrpclib.Server(self.url, verbose=False, allow_none=True)
45
46     def __repr__ (self): return "ManifoldAPI[%s]"%self.url
47
48     def _print_value (self, value):
49         print "+++",'value',
50         if isinstance (value,list):     print "[%d]"%len(value),
51         elif isinstance (value,dict):   print "{%d}"%len(value),
52         print mytruncate (value,80)
53     
54     # a one-liner to give a hint of what the return value looks like
55     def _print_result (self, result):
56         if not result:                        print "[no/empty result]"
57         elif isinstance (result,str):         print "result is '%s'"%result
58         elif isinstance (result,list):        print "result is a %d-elts list"%len(result)
59         elif isinstance (result,dict):        
60             print "result is a dict with %d keys : %s"%(len(result),result.keys())
61             for (k,v) in result.iteritems(): 
62                 if v is None: continue
63                 if k=='value':  self._print_value(v)
64                 else:           print '+++',k,':',mytruncate (v,30)
65         else:                                 print "[dont know how to display result] %s"%result
66
67     # how to display a call
68     def _repr_query (self,methodName, query):
69         try:    action=query['action']
70         except: action="???"
71         try:    subject=query['object']
72         except: subject="???"
73         # most of the time, we run 'forward'
74         if methodName=='forward':       return "forward(%s(%s))"%(action,subject)
75         else:                           return "%s(%s)"%(action,subject)
76
77     # xxx temporary code for scaffolding a ManifolResult on top of an API that does not expose error info
78     # as of march 2013 we work with an API that essentially either returns the value, or raises 
79     # an xmlrpclib.Fault exception with always the same 8002 code
80     # since most of the time we're getting this kind of issues for expired sessions
81     # (looks like sessions are rather short-lived), for now the choice is to map these errors on 
82     # a SESSION_EXPIRED code
83     def __getattr__(self, methodName):
84         def func(*args, **kwds):
85             # shorthand
86             def repr(): return self._repr_query (methodName, args[0])
87             try:
88                 if debug:
89                     start,msg = mytime()
90                     print "====>",msg,"ManifoldAPI.%s"%repr(),"url",self.url
91                     # No password in the logs
92                     logAuth = copy.copy(self.auth)
93                     for obfuscate in ['Authring','session']: 
94                         if obfuscate in logAuth:  logAuth[obfuscate]="XXX"
95                     if debug_deep: print "=> auth",logAuth
96                     if debug_deep: print "=> args",args,"kwds",kwds
97                 annotations = {
98                     'authentication': self.auth
99                 }
100                 args += (annotations,)
101                 result=getattr(self.server, methodName)(*args, **kwds)
102                 print "%s%r" %(methodName, args)
103                 
104                 if debug:
105                     print '<= result=',
106                     self._print_result(result)
107                     end,msg = mytime(start)
108                     print "<====",msg,"backend call %s returned"%(repr())
109
110                 return ResultValue(**result)
111
112             except Exception,error:
113                 print "** MANIFOLD API ERROR **"
114                 if debug: 
115                     print "===== xmlrpc catch-all exception:",error
116                     import traceback
117                     traceback.print_exc(limit=3)
118                 if "Connection refused" in error:
119                     raise ManifoldException ( ManifoldResult (code=ManifoldCode.SERVER_UNREACHABLE,
120                                                               output="%s answered %s"%(self.url,error)))
121                 # otherwise
122                 print "<==== ERROR On ManifoldAPI.%s"%repr()
123                 raise ManifoldException ( ManifoldResult (code=ManifoldCode.SERVER_UNREACHABLE, output="%s"%error) )
124
125         return func
126
127 def _execute_query(request, query, manifold_api_session_auth):
128     manifold_api = ManifoldAPI(auth=manifold_api_session_auth)
129     print "-"*80
130     print query
131     print query.to_dict()
132     print "-"*80
133     result = manifold_api.forward(query.to_dict())
134     if result['code'] == 2:
135         # this is gross; at the very least we need to logout() 
136         # but most importantly there is a need to refine that test, since 
137         # code==2 does not necessarily mean an expired session
138         # XXX only if we know it is the issue
139         del request.session['manifold']
140         # Flush django session
141         request.session.flush()
142         #raise Exception, 'Error running query: %r' % result
143     
144     if result['code'] == 1:
145         print "WARNING" 
146         print result['description']
147
148     # XXX Handle errors
149     #Error running query: {'origin': [0, 'XMLRPCAPI'], 'code': 2, 'description': 'No such session: No row was found for one()', 'traceback': 'Traceback (most recent call last):\n  File "/usr/local/lib/python2.7/dist-packages/manifold/core/xmlrpc_api.py", line 68, in xmlrpc_forward\n    user = Auth(auth).check()\n  File "/usr/local/lib/python2.7/dist-packages/manifold/auth/__init__.py", line 245, in check\n    return self.auth_method.check()\n  File "/usr/local/lib/python2.7/dist-packages/manifold/auth/__init__.py", line 95, in check\n    raise AuthenticationFailure, "No such session: %s" % e\nAuthenticationFailure: No such session: No row was found for one()\n', 'type': 2, 'ts': None, 'value': None}
150
151     return result['value'] 
152
153 def execute_query(request, query):
154     if not 'manifold' in request.session or not 'auth' in request.session['manifold']:
155         request.session.flush()
156         #raise Exception, "User not authenticated"
157         host = request.get_host()
158         return redirect('/')
159     manifold_api_session_auth = request.session['manifold']['auth']
160     return _execute_query(request, query, manifold_api_session_auth)
161
162 def execute_admin_query(request, query):
163     admin_user, admin_password = ConfigEngine().manifold_admin_user_password()
164     admin_auth = {'AuthMethod': 'password', 'Username': admin_user, 'AuthString': admin_password}
165     return _execute_query(request, query, admin_auth)