X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=manifoldapi%2Fmanifoldapi.py;h=aab968b407d7f29364a7225d71c1681f7f72beba;hb=5157e8e19cbfd0a8b31fab00e75de248a7bc59e2;hp=a8b2ab9a2d3a94f540e4458813dd0e3a4df9f272;hpb=4f924a3d5b8d6ca7cf022e15900369c7a0c4ce7e;p=myslice.git diff --git a/manifoldapi/manifoldapi.py b/manifoldapi/manifoldapi.py index a8b2ab9a..aab968b4 100644 --- a/manifoldapi/manifoldapi.py +++ b/manifoldapi/manifoldapi.py @@ -1,78 +1,43 @@ # Manifold API Python interface -import copy, xmlrpclib +import copy +import ssl -from myslice.configengine import ConfigEngine +# for python3 +try: import xmlrpclib +except: import xmlrpc.client as xmlrpclib from django.contrib import messages from django.shortcuts import redirect -from manifoldresult import ManifoldResult, ManifoldCode, ManifoldException -from manifold.core.result_value import ResultValue -debug=False -debug=True -debug_deep=False -#debug_deep=True - -########## ugly stuff for hopefully nicer debug messages -def mytruncate (obj, l): - # we will add '..' - l1=l-2 - repr="%s"%obj - return (repr[:l1]+'..') if len(repr)>l1 else repr - -from time import time, gmtime, strftime -from math import trunc -def mytime (start=None): - gm=gmtime() - t=time() - msg=strftime("%H:%M:%S-", gmtime())+"%03d"%((t-trunc(t))*1000) - if start is not None: msg += " (%03fs)"%(t-start) - return t,msg -########## +from manifold.core.result_value import ResultValue +from manifoldresult import ManifoldResult, ManifoldCode, ManifoldException, truncate_result + +# being available from the outside (r2lab django web site) +try: + from myslice.settings import logger +except: + import logging + logger = logging.getLogger('manifoldapi') + class ManifoldAPI: - def __init__ (self, auth=None, cainfo=None): + def __init__(self, url, auth=None, cainfo=None): + self.url = url self.auth = auth self.cainfo = cainfo self.errors = [] self.trace = [] self.calls = {} self.multicall = False - self.url = ConfigEngine().manifold_url() - self.server = xmlrpclib.Server(self.url, verbose=False, allow_none=True) - - def __repr__ (self): return "ManifoldAPI[%s]"%self.url - - def _print_value (self, value): - print "+++",'value', - if isinstance (value,list): print "[%d]"%len(value), - elif isinstance (value,dict): print "{%d}"%len(value), - print mytruncate (value,80) - - # a one-liner to give a hint of what the return value looks like - def _print_result (self, result): - if not result: print "[no/empty result]" - elif isinstance (result,str): print "result is '%s'"%result - elif isinstance (result,list): print "result is a %d-elts list"%len(result) - elif isinstance (result,dict): - print "result is a dict with %d keys : %s"%(len(result),result.keys()) - for (k,v) in result.iteritems(): - if v is None: continue - if k=='value': self._print_value(v) - else: print '+++',k,':',mytruncate (v,30) - else: print "[dont know how to display result] %s"%result - - # how to display a call - def _repr_query (self,methodName, query): - try: action=query['action'] - except: action="???" - try: subject=query['object'] - except: subject="???" - # most of the time, we run 'forward' - if methodName=='forward': return "forward(%s(%s))"%(action,subject) - else: return "%s(%s)"%(action,subject) + + # Manifold uses a self signed certificate + # https://www.python.org/dev/peps/pep-0476/ + try: turn_off_server_verify = { 'context' : ssl._create_unverified_context() } + except: turn_off_server_verify = {} + self.server = xmlrpclib.Server(self.url, verbose=False, allow_none=True, + **turn_off_server_verify) # xxx temporary code for scaffolding a ManifolResult on top of an API that does not expose error info # as of march 2013 we work with an API that essentially either returns the value, or raises @@ -81,69 +46,67 @@ class ManifoldAPI: # (looks like sessions are rather short-lived), for now the choice is to map these errors on # a SESSION_EXPIRED code def __getattr__(self, methodName): + def func(*args, **kwds): - # shorthand - def repr(): return self._repr_query (methodName, args[0]) + import time + start = time.time() + + # the message to display + auth_message = "".format(self.auth) if 'AuthMethod' not in self.auth \ + else "[session]" if self.auth['AuthMethod'] == 'session' \ + else "user:{}".format(self.auth['Username']) if self.auth['AuthMethod'] == 'password' \ + else "anonymous" if self.auth['AuthMethod'] == 'anonymous' \ + else "[???]" + "{}".format(self.auth) + end_message = "MANIFOLD <- {}( {}( {} ) ) with auth={} to {}"\ + .format(methodName, + args[0]['action'] or '', + args[0]['object'] or '', + auth_message, + self.url) try: - if debug: - start,msg = mytime() - print "====>",msg,"ManifoldAPI.%s"%repr(),"url",self.url - # No password in the logs - logAuth = copy.copy(self.auth) - for obfuscate in ['Authring','session']: - if obfuscate in logAuth: logAuth[obfuscate]="XXX" - if debug_deep: print "=> auth",logAuth - if debug_deep: print "=> args",args,"kwds",kwds - annotations = { - 'authentication': self.auth - } - args += (annotations,) - result=getattr(self.server, methodName)(*args, **kwds) - print "%s%r" %(methodName, args) - - if debug: - print '<= result=', - self._print_result(result) - end,msg = mytime(start) - print "<====",msg,"backend call %s returned"%(repr()) - + args += ({ 'authentication': self.auth },) + result = getattr(self.server, methodName)(*args, **kwds) + logger.debug("{} executed in {} seconds -> {}"\ + .format(end_message, time.time() - start, truncate_result(result))) return ResultValue(**result) - except Exception,error: - print "** MANIFOLD API ERROR **" - if debug: - print "===== xmlrpc catch-all exception:",error - import traceback - traceback.print_exc(limit=3) + except Exception as error: + logger.error("===== xmlrpc catch-all exception: {}".format(error)) + import traceback + logger.error(traceback.format_exc(limit=3)) + if "Connection refused" in error: raise ManifoldException ( ManifoldResult (code=ManifoldCode.SERVER_UNREACHABLE, - output="%s answered %s"%(self.url,error))) + output="{} answered {}".format(self.url, error))) # otherwise - print "<==== ERROR On ManifoldAPI.%s"%repr() - raise ManifoldException ( ManifoldResult (code=ManifoldCode.SERVER_UNREACHABLE, output="%s"%error) ) + logger.error("{} FAILED - executed in {} seconds"\ + .format(end_message, time.time() - start)) + logger.error("MANIFOLD {}".format(error)) + raise ManifoldException ( ManifoldResult (code = ManifoldCode.SERVER_UNREACHABLE, + output = "{}".format(error))) return func -def _execute_query(request, query, manifold_api_session_auth): - manifold_api = ManifoldAPI(auth=manifold_api_session_auth) - print "-"*80 - print query - print query.to_dict() - print "-"*80 +def _execute_query(url, request, query, manifold_api_session_auth): + + manifold_api = ManifoldAPI(url, auth = manifold_api_session_auth) + + logger.debug("MANIFOLD -> QUERY : {}".format(" ".join(str(query).split()))) result = manifold_api.forward(query.to_dict()) if result['code'] == 2: # this is gross; at the very least we need to logout() # but most importantly there is a need to refine that test, since # code==2 does not necessarily mean an expired session # XXX only if we know it is the issue - del request.session['manifold'] + #SessionCache().end_session(request) # Flush django session + del request.session['manifold'] + request.session.flush() - #raise Exception, 'Error running query: %r' % result + #raise Exception, 'Error running query: {}'.format(result) if result['code'] == 1: - print "WARNING" - print result['description'] + logger.warning("MANIFOLD : {}".format(result['description'])) # XXX Handle errors #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} @@ -151,15 +114,32 @@ def _execute_query(request, query, manifold_api_session_auth): return result['value'] def execute_query(request, query): + + #logger.debug("EXECUTE QUERY: request - {}".format(request.session.items())) + if not 'manifold' in request.session or not 'auth' in request.session['manifold']: + #manifold_api_session_auth = SessionCache().get_auth(request) + #if not manifold_api_session_auth: request.session.flush() #raise Exception, "User not authenticated" host = request.get_host() return redirect('/') + manifold_api_session_auth = request.session['manifold']['auth'] - return _execute_query(request, query, manifold_api_session_auth) + + from myslice.settings import config + url = config.manifold_url() + return _execute_query(url, request, query, manifold_api_session_auth) def execute_admin_query(request, query): - admin_user, admin_password = ConfigEngine().manifold_admin_user_password() + # xxx config + from myslice.settings import config + url = config.manifold_url() + + admin_user, admin_password = config.manifold_admin_user_password() + if not admin_user or not admin_password: + logger.error("""CONFIG: you need to setup admin_user and admin_password in myslice.ini +Some functions won't work properly until you do so""") admin_auth = {'AuthMethod': 'password', 'Username': admin_user, 'AuthString': admin_password} - return _execute_query(request, query, admin_auth) + + return _execute_query(url, request, query, admin_auth)