# -*- coding: utf-8 -*-
-#----------------------------------------------------------
-# OpenERP HTTP layer
-#----------------------------------------------------------
-import ast
-import cgi
-import collections
-import contextlib
-import errno
-import functools
-import getpass
-import inspect
-import logging
-import mimetypes
-import os
-import random
-import re
-import sys
-import tempfile
-import threading
-import time
-import traceback
-import urlparse
-import warnings
-import babel.core
-import simplejson
-import werkzeug.contrib.sessions
-import werkzeug.datastructures
-import werkzeug.exceptions
-import werkzeug.local
-import werkzeug.routing
-import werkzeug.wrappers
-import werkzeug.wsgi
-
-import openerp
-from openerp.service import security, model as service_model
-from openerp.tools import config
-
-_logger = logging.getLogger(__name__)
-
-#----------------------------------------------------------
-# RequestHandler
-#----------------------------------------------------------
-class WebRequest(object):
- """ Parent class for all OpenERP Web request types, mostly deals with
- initialization and setup of the request object (the dispatching itself has
- to be handled by the subclasses)
-
- :param request: a wrapped werkzeug Request object
- :type request: :class:`werkzeug.wrappers.BaseRequest`
-
- .. attribute:: httprequest
-
- the original :class:`werkzeug.wrappers.Request` object provided to the
- request
-
- .. attribute:: httpsession
-
- .. deprecated:: 8.0
-
- Use ``self.session`` instead.
-
- .. attribute:: params
-
- :class:`~collections.Mapping` of request parameters, not generally
- useful as they're provided directly to the handler method as keyword
- arguments
-
- .. attribute:: session_id
-
- opaque identifier for the :class:`session.OpenERPSession` instance of
- the current request
-
- .. attribute:: session
-
- a :class:`OpenERPSession` holding the HTTP session data for the
- current http session
-
- .. attribute:: context
-
- :class:`~collections.Mapping` of context values for the current request
-
- .. attribute:: db
-
- ``str``, the name of the database linked to the current request. Can be ``None``
- if the current request uses the ``none`` authentication.
-
- .. attribute:: uid
-
- ``int``, the id of the user related to the current request. Can be ``None``
- if the current request uses the ``none`` authenticatoin.
- """
- def __init__(self, httprequest):
- self.httprequest = httprequest
- self.httpresponse = None
- self.httpsession = httprequest.session
- self.session = httprequest.session
- self.session_id = httprequest.session.sid
- self.disable_db = False
- self.uid = None
- self.func = None
- self.func_arguments = {}
- self.auth_method = None
- self._cr_cm = None
- self._cr = None
- self.func_request_type = None
- # set db/uid trackers - they're cleaned up at the WSGI
- # dispatching phase in openerp.service.wsgi_server.application
- if self.db:
- threading.current_thread().dbname = self.db
- if self.session.uid:
- threading.current_thread().uid = self.session.uid
- self.context = dict(self.session.context)
- self.lang = self.context["lang"]
-
- @property
- def registry(self):
- """
- The registry to the database linked to this request. Can be ``None`` if the current request uses the
- ``none'' authentication.
- """
- return openerp.modules.registry.RegistryManager.get(self.db) if self.db else None
-
- @property
- def db(self):
- """
- The registry to the database linked to this request. Can be ``None`` if the current request uses the
- ``none'' authentication.
- """
- return self.session.db if not self.disable_db else None
-
- @property
- def cr(self):
- """
- The cursor initialized for the current method call. If the current request uses the ``none`` authentication
- trying to access this property will raise an exception.
- """
- # some magic to lazy create the cr
- if not self._cr_cm:
- self._cr_cm = self.registry.cursor()
- self._cr = self._cr_cm.__enter__()
- return self._cr
-
- def set_handler(self, func, arguments, auth):
- # is this needed ?
- arguments = dict((k, v) for k, v in arguments.iteritems()
- if not k.startswith("_ignored_"))
-
- self.func = func
- self.func_request_type = func.exposed
- self.func_arguments = arguments
- self.auth_method = auth
-
- def _call_function(self, *args, **kwargs):
- try:
- # ugly syntax only to get the __exit__ arguments to pass to self._cr
- request = self
- class with_obj(object):
- def __enter__(self):
- pass
- def __exit__(self, *args):
- if request._cr_cm:
- request._cr_cm.__exit__(*args)
- request._cr_cm = None
- request._cr = None
-
- with with_obj():
- if self.func_request_type != self._request_type:
- raise Exception("%s, %s: Function declared as capable of handling request of type '%s' but called with a request of type '%s'" \
- % (self.func, self.httprequest.path, self.func_request_type, self._request_type))
-
- kwargs.update(self.func_arguments)
-
- # Backward for 7.0
- if getattr(self.func, '_first_arg_is_req', False):
- args = (request,) + args
- # Correct exception handling and concurency retry
- @service_model.check
- def checked_call(dbname, *a, **kw):
- return self.func(*a, **kw)
- if self.db:
- return checked_call(self.db, *args, **kwargs)
- return self.func(*args, **kwargs)
- finally:
- # just to be sure no one tries to re-use the request
- self.disable_db = True
- self.uid = None
-
- @property
- def debug(self):
- return 'debug' in self.httprequest.args
-
- @contextlib.contextmanager
- def registry_cr(self):
- warnings.warn('please use request.registry and request.cr directly', DeprecationWarning)
- yield (self.registry, self.cr)
-
-def route(route, type="http", auth="user"):
- """
- Decorator marking the decorated method as being a handler for requests. The method must be part of a subclass
- of ``Controller``.
-
- :param route: string or array. The route part that will determine which http requests will match the decorated
- method. Can be a single string or an array of strings. See werkzeug's routing documentation for the format of
- route expression ( http://werkzeug.pocoo.org/docs/routing/ ).
- :param type: The type of request, can be ``'http'`` or ``'json'``.
- :param auth: The type of authentication method, can on of the following:
-
- * ``user``: The user must be authenticated and the current request will perform using the rights of the
- user.
- * ``admin``: The user may not be authenticated and the current request will perform using the admin user.
- * ``none``: The method is always active, even if there is no database. Mainly used by the framework and
- authentication modules. There request code will not have any facilities to access the database nor have any
- configuration indicating the current database nor the current user.
- """
- assert type in ["http", "json"]
- def decorator(f):
- if isinstance(route, list):
- f.routes = route
- else:
- f.routes = [route]
- f.exposed = type
- if getattr(f, "auth", None) is None:
- f.auth = auth
- return f
- return decorator
-
-class JsonRequest(WebRequest):
- """ JSON-RPC2 over HTTP.
-
- Sucessful request::
-
- --> {"jsonrpc": "2.0",
- "method": "call",
- "params": {"context": {},
- "arg1": "val1" },
- "id": null}
-
- <-- {"jsonrpc": "2.0",
- "result": { "res1": "val1" },
- "id": null}
-
- Request producing a error::
-
- --> {"jsonrpc": "2.0",
- "method": "call",
- "params": {"context": {},
- "arg1": "val1" },
- "id": null}
-
- <-- {"jsonrpc": "2.0",
- "error": {"code": 1,
- "message": "End user error message.",
- "data": {"code": "codestring",
- "debug": "traceback" } },
- "id": null}
-
- """
- _request_type = "json"
-
- def __init__(self, *args):
- super(JsonRequest, self).__init__(*args)
-
- self.jsonp_handler = None
-
- args = self.httprequest.args
- jsonp = args.get('jsonp')
- self.jsonp = jsonp
- request = None
- request_id = args.get('id')
-
- if jsonp and self.httprequest.method == 'POST':
- # jsonp 2 steps step1 POST: save call
- def handler():
- self.session.jsonp_requests[request_id] = self.httprequest.form['r']
- self.session.modified = True
- headers=[('Content-Type', 'text/plain; charset=utf-8')]
- r = werkzeug.wrappers.Response(request_id, headers=headers)
- return r
- self.jsonp_handler = handler
- return
- elif jsonp and args.get('r'):
- # jsonp method GET
- request = args.get('r')
- elif jsonp and request_id:
- # jsonp 2 steps step2 GET: run and return result
- request = self.session.jsonp_requests.pop(request_id, "")
- else:
- # regular jsonrpc2
- request = self.httprequest.stream.read()
-
- # Read POST content or POST Form Data named "request"
- self.jsonrequest = simplejson.loads(request)
- self.params = dict(self.jsonrequest.get("params", {}))
- self.context = self.params.pop('context', self.session.context)
-
- def dispatch(self):
- """ Calls the method asked for by the JSON-RPC2 or JSONP request
- """
- if self.jsonp_handler:
- return self.jsonp_handler()
- response = {"jsonrpc": "2.0" }
- error = None
-
- try:
- response['id'] = self.jsonrequest.get('id')
- response["result"] = self._call_function(**self.params)
- except AuthenticationError, e:
- _logger.exception("Exception during JSON request handling.")
- se = serialize_exception(e)
- error = {
- 'code': 100,
- 'message': "OpenERP Session Invalid",
- 'data': se
- }
- except Exception, e:
- _logger.exception("Exception during JSON request handling.")
- se = serialize_exception(e)
- error = {
- 'code': 200,
- 'message': "OpenERP Server Error",
- 'data': se
- }
- if error:
- response["error"] = error
-
- if self.jsonp:
- # If we use jsonp, that's mean we are called from another host
- # Some browser (IE and Safari) do no allow third party cookies
- # We need then to manage http sessions manually.
- response['session_id'] = self.session_id
- mime = 'application/javascript'
- body = "%s(%s);" % (self.jsonp, simplejson.dumps(response),)
- else:
- mime = 'application/json'
- body = simplejson.dumps(response)
-
- r = werkzeug.wrappers.Response(body, headers=[('Content-Type', mime), ('Content-Length', len(body))])
- return r
-
-def serialize_exception(e):
- tmp = {
- "name": type(e).__module__ + "." + type(e).__name__ if type(e).__module__ else type(e).__name__,
- "debug": traceback.format_exc(),
- "message": u"%s" % e,
- "arguments": to_jsonable(e.args),
- }
- if isinstance(e, openerp.osv.osv.except_osv):
- tmp["exception_type"] = "except_osv"
- elif isinstance(e, openerp.exceptions.Warning):
- tmp["exception_type"] = "warning"
- elif isinstance(e, openerp.exceptions.AccessError):
- tmp["exception_type"] = "access_error"
- elif isinstance(e, openerp.exceptions.AccessDenied):
- tmp["exception_type"] = "access_denied"
- return tmp
-
-def to_jsonable(o):
- if isinstance(o, str) or isinstance(o,unicode) or isinstance(o, int) or isinstance(o, long) \
- or isinstance(o, bool) or o is None or isinstance(o, float):
- return o
- if isinstance(o, list) or isinstance(o, tuple):
- return [to_jsonable(x) for x in o]
- if isinstance(o, dict):
- tmp = {}
- for k, v in o.items():
- tmp[u"%s" % k] = to_jsonable(v)
- return tmp
- return u"%s" % o
-
-def jsonrequest(f):
- """
- .. deprecated:: 8.0
-
- Use the ``route()`` decorator instead.
- """
- f.combine = True
- base = f.__name__.lstrip('/')
- if f.__name__ == "index":
- base = ""
- return route([base, base + "/<path:_ignored_path>"], type="json", auth="user")(f)
-
-class HttpRequest(WebRequest):
- """ Regular GET/POST request
- """
- _request_type = "http"
-
- def __init__(self, *args):
- super(HttpRequest, self).__init__(*args)
- params = dict(self.httprequest.args)
- params.update(self.httprequest.form)
- params.update(self.httprequest.files)
- params.pop('session_id', None)
- self.params = params
-
- def dispatch(self):
- try:
- r = self._call_function(**self.params)
- except werkzeug.exceptions.HTTPException, e:
- r = e
- except Exception, e:
- _logger.exception("An exception occured during an http request")
- se = serialize_exception(e)
- error = {
- 'code': 200,
- 'message': "OpenERP Server Error",
- 'data': se
- }
- r = werkzeug.exceptions.InternalServerError(cgi.escape(simplejson.dumps(error)))
- else:
- if not r:
- r = werkzeug.wrappers.Response(status=204) # no content
- return r
-
- def make_response(self, data, headers=None, cookies=None):
- """ Helper for non-HTML responses, or HTML responses with custom
- response headers or cookies.
-
- While handlers can just return the HTML markup of a page they want to
- send as a string if non-HTML data is returned they need to create a
- complete response object, or the returned data will not be correctly
- interpreted by the clients.
-
- :param basestring data: response body
- :param headers: HTTP headers to set on the response
- :type headers: ``[(name, value)]``
- :param collections.Mapping cookies: cookies to set on the client
- """
- response = werkzeug.wrappers.Response(data, headers=headers)
- if cookies:
- for k, v in cookies.iteritems():
- response.set_cookie(k, v)
- return response
-
- def not_found(self, description=None):
- """ Helper for 404 response, return its result from the method
- """
- return werkzeug.exceptions.NotFound(description)
-
-def httprequest(f):
- """
- .. deprecated:: 8.0
-
- Use the ``route()`` decorator instead.
- """
- f.combine = True
- base = f.__name__.lstrip('/')
- if f.__name__ == "index":
- base = ""
- return route([base, base + "/<path:_ignored_path>"], type="http", auth="user")(f)
-
-#----------------------------------------------------------
-# Thread local global request object
-#----------------------------------------------------------
-_request_stack = werkzeug.local.LocalStack()
-
-request = _request_stack()
"""
- A global proxy that always redirect to the current request object.
+``openerp.http`` offers decorators to register WSGI and RPC endpoints handlers.
+See :ref:`routing`.
"""
-@contextlib.contextmanager
-def set_request(req):
- _request_stack.push(req)
- try:
- yield
- finally:
- _request_stack.pop()
-
-#----------------------------------------------------------
-# Controller and route registration
-#----------------------------------------------------------
-addons_module = {}
-addons_manifest = {}
-controllers_per_module = collections.defaultdict(list)
-
-class ControllerType(type):
- def __init__(cls, name, bases, attrs):
- super(ControllerType, cls).__init__(name, bases, attrs)
-
- # flag old-style methods with req as first argument
- for k, v in attrs.items():
- if inspect.isfunction(v):
- spec = inspect.getargspec(v)
- first_arg = spec.args[1] if len(spec.args) >= 2 else None
- if first_arg in ["req", "request"]:
- v._first_arg_is_req = True
-
- # store the controller in the controllers list
- name_class = ("%s.%s" % (cls.__module__, cls.__name__), cls)
- class_path = name_class[0].split(".")
- if not class_path[:2] == ["openerp", "addons"]:
- module = ""
- else:
- # we want to know all modules that have controllers
- module = class_path[2]
- # but we only store controllers directly inheriting from Controller
- if not "Controller" in globals() or not Controller in bases:
- return
- controllers_per_module[module].append(name_class)
-
-class Controller(object):
- __metaclass__ = ControllerType
-
-def routing_map(modules, nodb_only, converters=None):
- routing_map = werkzeug.routing.Map(strict_slashes=False, converters=converters)
- for module in modules:
- if module not in controllers_per_module:
- continue
-
- for _, cls in controllers_per_module[module]:
- subclasses = cls.__subclasses__()
- subclasses = [c for c in subclasses if c.__module__.startswith('openerp.addons.') and c.__module__.split(".")[2] in modules]
- if subclasses:
- name = "%s (extended by %s)" % (cls.__name__, ', '.join(sub.__name__ for sub in subclasses))
- cls = type(name, tuple(reversed(subclasses)), {})
-
- o = cls()
- members = inspect.getmembers(o)
- for mk, mv in members:
- if inspect.ismethod(mv) and getattr(mv, 'exposed', False) and (not nodb_only or nodb_only == (mv.auth == "none")):
- for url in mv.routes:
- if getattr(mv, "combine", False):
- url = o._cp_path.rstrip('/') + '/' + url.lstrip('/')
- if url.endswith("/") and len(url) > 1:
- url = url[: -1]
- routing_map.add(werkzeug.routing.Rule(url, endpoint=mv))
- return routing_map
+from . import service
-#----------------------------------------------------------
-# HTTP Sessions
-#----------------------------------------------------------
-class AuthenticationError(Exception):
- pass
-
-class SessionExpiredException(Exception):
- pass
-
-class Service(object):
- """
- .. deprecated:: 8.0
- Use ``openerp.netsvc.dispatch_rpc()`` instead.
- """
- def __init__(self, session, service_name):
- self.session = session
- self.service_name = service_name
-
- def __getattr__(self, method):
- def proxy_method(*args):
- result = openerp.netsvc.dispatch_rpc(self.service_name, method, args)
- return result
- return proxy_method
-
-class Model(object):
+def handler():
"""
- .. deprecated:: 8.0
- Use the resistry and cursor in ``openerp.addons.web.http.request`` instead.
+ Decorator to register a WSGI handler. The handler must return None if it
+ does not handle the request.
"""
- def __init__(self, session, model):
- self.session = session
- self.model = model
- self.proxy = self.session.proxy('object')
-
- def __getattr__(self, method):
- self.session.assert_valid()
- def proxy(*args, **kw):
- # Can't provide any retro-compatibility for this case, so we check it and raise an Exception
- # to tell the programmer to adapt his code
- if not request.db or not request.uid or self.session.db != request.db \
- or self.session.uid != request.uid:
- raise Exception("Trying to use Model with badly configured database or user.")
-
- mod = request.registry.get(self.model)
- if method.startswith('_'):
- raise Exception("Access denied")
- meth = getattr(mod, method)
- cr = request.cr
- result = meth(cr, request.uid, *args, **kw)
- # reorder read
- if method == "read":
- if isinstance(result, list) and len(result) > 0 and "id" in result[0]:
- index = {}
- for r in result:
- index[r['id']] = r
- result = [index[x] for x in args[0] if x in index]
- return result
- return proxy
-
-class OpenERPSession(werkzeug.contrib.sessions.Session):
- def __init__(self, *args, **kwargs):
- self.inited = False
- self.modified = False
- super(OpenERPSession, self).__init__(*args, **kwargs)
- self.inited = True
- self._default_values()
- self.modified = False
-
- def __getattr__(self, attr):
- return self.get(attr, None)
- def __setattr__(self, k, v):
- if getattr(self, "inited", False):
- try:
- object.__getattribute__(self, k)
- except:
- return self.__setitem__(k, v)
- object.__setattr__(self, k, v)
-
- def authenticate(self, db, login=None, password=None, uid=None):
- """
- Authenticate the current user with the given db, login and password. If successful, store
- the authentication parameters in the current session and request.
-
- :param uid: If not None, that user id will be used instead the login to authenticate the user.
- """
-
- if uid is None:
- wsgienv = request.httprequest.environ
- env = dict(
- base_location=request.httprequest.url_root.rstrip('/'),
- HTTP_HOST=wsgienv['HTTP_HOST'],
- REMOTE_ADDR=wsgienv['REMOTE_ADDR'],
- )
- uid = openerp.netsvc.dispatch_rpc('common', 'authenticate', [db, login, password, env])
- else:
- security.check(db, uid, password)
- self.db = db
- self.uid = uid
- self.login = login
- self.password = password
- request.uid = uid
- request.disable_db = False
-
- if uid: self.get_context()
- return uid
-
- def check_security(self):
- """
- Chech the current authentication parameters to know if those are still valid. This method
- should be called at each request. If the authentication fails, a ``SessionExpiredException``
- is raised.
- """
- if not self.db or not self.uid:
- raise SessionExpiredException("Session expired")
- security.check(self.db, self.uid, self.password)
-
- def logout(self):
- for k in self.keys():
- del self[k]
- self._default_values()
-
- def _default_values(self):
- self.setdefault("db", None)
- self.setdefault("uid", None)
- self.setdefault("login", None)
- self.setdefault("password", None)
- self.setdefault("context", {'tz': "UTC", "uid": None})
- self.setdefault("jsonp_requests", {})
-
- def get_context(self):
- """
- Re-initializes the current user's session context (based on
- his preferences) by calling res.users.get_context() with the old
- context.
-
- :returns: the new context
- """
- assert self.uid, "The user needs to be logged-in to initialize his context"
- self.context = request.registry.get('res.users').context_get(request.cr, request.uid) or {}
- self.context['uid'] = self.uid
- self._fix_lang(self.context)
- return self.context
-
- def _fix_lang(self, context):
- """ OpenERP provides languages which may not make sense and/or may not
- be understood by the web client's libraries.
-
- Fix those here.
-
- :param dict context: context to fix
- """
- lang = context['lang']
-
- # inane OpenERP locale
- if lang == 'ar_AR':
- lang = 'ar'
-
- # lang to lang_REGION (datejs only handles lang_REGION, no bare langs)
- if lang in babel.core.LOCALE_ALIASES:
- lang = babel.core.LOCALE_ALIASES[lang]
-
- context['lang'] = lang or 'en_US'
-
- # Deprecated to be removed in 9
+ def decorator(f):
+ service.wsgi_server.register_wsgi_handler(f)
+ return decorator
+def route(url):
"""
- Damn properties for retro-compatibility. All of that is deprecated, all
- of that.
+ Same as then handler() decorator but register the handler under a specific
+ url. Not yet implemented.
"""
- @property
- def _db(self):
- return self.db
- @_db.setter
- def _db(self, value):
- self.db = value
- @property
- def _uid(self):
- return self.uid
- @_uid.setter
- def _uid(self, value):
- self.uid = value
- @property
- def _login(self):
- return self.login
- @_login.setter
- def _login(self, value):
- self.login = value
- @property
- def _password(self):
- return self.password
- @_password.setter
- def _password(self, value):
- self.password = value
-
- def send(self, service_name, method, *args):
- """
- .. deprecated:: 8.0
- Use ``openerp.netsvc.dispatch_rpc()`` instead.
- """
- return openerp.netsvc.dispatch_rpc(service_name, method, args)
-
- def proxy(self, service):
- """
- .. deprecated:: 8.0
- Use ``openerp.netsvc.dispatch_rpc()`` instead.
- """
- return Service(self, service)
-
- def assert_valid(self, force=False):
- """
- .. deprecated:: 8.0
- Use ``check_security()`` instead.
-
- Ensures this session is valid (logged into the openerp server)
- """
- if self.uid and not force:
- return
- # TODO use authenticate instead of login
- self.uid = self.proxy("common").login(self.db, self.login, self.password)
- if not self.uid:
- raise AuthenticationError("Authentication failure")
-
- def ensure_valid(self):
- """
- .. deprecated:: 8.0
- Use ``check_security()`` instead.
- """
- if self.uid:
- try:
- self.assert_valid(True)
- except Exception:
- self.uid = None
-
- def execute(self, model, func, *l, **d):
- """
- .. deprecated:: 8.0
- Use the resistry and cursor in ``openerp.addons.web.http.request`` instead.
- """
- model = self.model(model)
- r = getattr(model, func)(*l, **d)
- return r
-
- def exec_workflow(self, model, id, signal):
- """
- .. deprecated:: 8.0
- Use the resistry and cursor in ``openerp.addons.web.http.request`` instead.
- """
- self.assert_valid()
- r = self.proxy('object').exec_workflow(self.db, self.uid, self.password, model, signal, id)
- return r
-
- def model(self, model):
- """
- .. deprecated:: 8.0
- Use the resistry and cursor in ``openerp.addons.web.http.request`` instead.
-
- Get an RPC proxy for the object ``model``, bound to this session.
-
- :param model: an OpenERP model name
- :type model: str
- :rtype: a model object
- """
- if not self.db:
- raise SessionExpiredException("Session expired")
-
- return Model(self, model)
-
-def session_gc(session_store):
- if random.random() < 0.001:
- # we keep session one week
- last_week = time.time() - 60*60*24*7
- for fname in os.listdir(session_store.path):
- path = os.path.join(session_store.path, fname)
- try:
- if os.path.getmtime(path) < last_week:
- os.unlink(path)
- except OSError:
- pass
-
-#----------------------------------------------------------
-# WSGI Layer
-#----------------------------------------------------------
-# Add potentially missing (older ubuntu) font mime types
-mimetypes.add_type('application/font-woff', '.woff')
-mimetypes.add_type('application/vnd.ms-fontobject', '.eot')
-mimetypes.add_type('application/x-font-ttf', '.ttf')
-
-class DisableCacheMiddleware(object):
- def __init__(self, app):
- self.app = app
- def __call__(self, environ, start_response):
- def start_wrapped(status, headers):
- referer = environ.get('HTTP_REFERER', '')
- parsed = urlparse.urlparse(referer)
- debug = parsed.query.count('debug') >= 1
-
- new_headers = []
- unwanted_keys = ['Last-Modified']
- if debug:
- new_headers = [('Cache-Control', 'no-cache')]
- unwanted_keys += ['Expires', 'Etag', 'Cache-Control']
-
- for k, v in headers:
- if k not in unwanted_keys:
- new_headers.append((k, v))
-
- start_response(status, new_headers)
- return self.app(environ, start_wrapped)
-
-def session_path():
- try:
- import pwd
- username = pwd.getpwuid(os.geteuid()).pw_name
- except ImportError:
- try:
- username = getpass.getuser()
- except Exception:
- username = "unknown"
- path = os.path.join(tempfile.gettempdir(), "oe-sessions-" + username)
- try:
- os.mkdir(path, 0700)
- except OSError as exc:
- if exc.errno == errno.EEXIST:
- # directory exists: ensure it has the correct permissions
- # this will fail if the directory is not owned by the current user
- os.chmod(path, 0700)
- else:
- raise
- return path
-
-class Root(object):
- """Root WSGI application for the OpenERP Web Client.
- """
- def __init__(self):
- # Setup http sessions
- path = session_path()
- _logger.debug('HTTP sessions stored in: %s', path)
- self.session_store = werkzeug.contrib.sessions.FilesystemSessionStore(path, session_class=OpenERPSession)
-
- # TODO should we move this to ir.http so that only configured modules are served ?
- _logger.info("HTTP Configuring static files")
- self.load_addons()
-
- _logger.info("Generating nondb routing")
- self.nodb_routing_map = routing_map(['', "web"], True)
-
- def __call__(self, environ, start_response):
- """ Handle a WSGI request
- """
- return self.dispatch(environ, start_response)
-
- def load_addons(self):
- """ Load all addons from addons patch containg static files and
- controllers and configure them. """
- statics = {}
-
- for addons_path in openerp.modules.module.ad_paths:
- for module in sorted(os.listdir(str(addons_path))):
- if module not in addons_module:
- manifest_path = os.path.join(addons_path, module, '__openerp__.py')
- path_static = os.path.join(addons_path, module, 'static')
- if os.path.isfile(manifest_path) and os.path.isdir(path_static):
- manifest = ast.literal_eval(open(manifest_path).read())
- manifest['addons_path'] = addons_path
- _logger.debug("Loading %s", module)
- if 'openerp.addons' in sys.modules:
- m = __import__('openerp.addons.' + module)
- addons_module[module] = m
- addons_manifest[module] = manifest
- statics['/%s/static' % module] = path_static
-
- app = werkzeug.wsgi.SharedDataMiddleware(self.dispatch, statics)
- self.dispatch = DisableCacheMiddleware(app)
-
- def setup_session(self, httprequest):
- # recover or create session
- session_gc(self.session_store)
-
- sid = httprequest.args.get('session_id')
- explicit_session = True
- if not sid:
- sid = httprequest.headers.get("X-Openerp-Session-Id")
- if not sid:
- sid = httprequest.cookies.get('session_id')
- explicit_session = False
- if sid is None:
- httprequest.session = self.session_store.new()
- else:
- httprequest.session = self.session_store.get(sid)
- return explicit_session
-
- def setup_db(self, httprequest):
- # if no db is found on the session try to deduce it from the domain
- db = db_monodb(httprequest)
- if db != httprequest.session.db:
- httprequest.session.logout()
- httprequest.session.db = db
-
- def setup_lang(self, httprequest):
- if not "lang" in httprequest.session.context:
- lang = httprequest.accept_languages.best or "en_US"
- lang = babel.core.LOCALE_ALIASES.get(lang, lang).replace('-', '_')
- httprequest.session.context["lang"] = lang
-
- def get_request(self, httprequest):
- # deduce type of request
- if httprequest.args.get('jsonp'):
- return JsonRequest(httprequest)
- if httprequest.mimetype == "application/json":
- return JsonRequest(httprequest)
- else:
- return HttpRequest(httprequest)
-
- def get_response(self, httprequest, result, explicit_session):
- if isinstance(result, basestring):
- response = werkzeug.wrappers.Response(result, mimetype='text/html')
- else:
- response = result
-
- if httprequest.session.should_save:
- self.session_store.save(httprequest.session)
- # We must not set the cookie if the session id was specified using a http header or a GET parameter.
- # There are two reasons to this:
- # - When using one of those two means we consider that we are overriding the cookie, which means creating a new
- # session on top of an already existing session and we don't want to create a mess with the 'normal' session
- # (the one using the cookie). That is a special feature of the Session Javascript class.
- # - It could allow session fixation attacks.
- if not explicit_session and hasattr(response, 'set_cookie'):
- response.set_cookie('session_id', httprequest.session.sid, max_age=90 * 24 * 60 * 60)
-
- return response
-
- def dispatch(self, environ, start_response):
- """
- Performs the actual WSGI dispatching for the application.
- """
- try:
- httprequest = werkzeug.wrappers.Request(environ)
- httprequest.parameter_storage_class = werkzeug.datastructures.ImmutableDict
- httprequest.app = self
-
- explicit_session = self.setup_session(httprequest)
- self.setup_db(httprequest)
- self.setup_lang(httprequest)
-
- request = self.get_request(httprequest)
-
- with set_request(request):
- db = request.session.db
- if db:
- openerp.modules.registry.RegistryManager.check_registry_signaling(db)
- result = request.registry['ir.http']._dispatch()
- openerp.modules.registry.RegistryManager.signal_caches_change(db)
- else:
- # fallback to non-db handlers
- func, arguments = self.nodb_routing_map.bind_to_environ(request.httprequest.environ).match()
- request.set_handler(func, arguments, "none")
- result = request.dispatch()
- response = self.get_response(httprequest, result, explicit_session)
- return response(environ, start_response)
-
- except werkzeug.exceptions.HTTPException, e:
- return e(environ, start_response)
-
- def get_db_router(self, db):
- if not db:
- return self.nodb_routing_map
- return request.registry['ir.http'].routing_map()
-
-def db_list(force=False, httprequest=None):
- httprequest = httprequest or request.httprequest
- dbs = openerp.netsvc.dispatch_rpc("db", "list", [force])
- h = httprequest.environ['HTTP_HOST'].split(':')[0]
- d = h.split('.')[0]
- r = openerp.tools.config['dbfilter'].replace('%h', h).replace('%d', d)
- dbs = [i for i in dbs if re.match(r, i)]
- return dbs
+ def decorator(f):
+ pass # TODO
+ return decorator
-def db_monodb(httprequest=None):
+def rpc(endpoint):
"""
- Magic function to find the current database.
-
- Implementation details:
-
- * Magic
- * More magic
-
- Returns ``None`` if the magic is not magic enough.
+ Decorator to register a RPC endpoint handler. The handler will receive
+ already unmarshalled RCP arguments.
"""
- httprequest = httprequest or request.httprequest
- db = None
- redirect = None
-
- dbs = db_list(True, httprequest)
-
- # try the db already in the session
- db_session = httprequest.session.db
- if db_session in dbs:
- return db_session
-
- # if dbfilters was specified when launching the server and there is
- # only one possible db, we take that one
- if openerp.tools.config['dbfilter'] != ".*" and len(dbs) == 1:
- return dbs[0]
- return None
-
-#----------------------------------------------------------
-# RPC controller
-#----------------------------------------------------------
-class CommonController(Controller):
-
- @route('/jsonrpc', type='json', auth="none")
- def jsonrpc(self, service, method, args):
- """ Method used by client APIs to contact OpenERP. """
- return openerp.netsvc.dispatch_rpc(service, method, args)
-
- @route('/gen_session_id', type='json', auth="none")
- def gen_session_id(self):
- nsession = root.session_store.new()
- return nsession.sid
-
-root = None
-
-def wsgi_postload():
- global root
- root = Root()
- openerp.wsgi.register_wsgi_handler(root)
+ def decorator(f):
+ service.wsgi_server.register_rpc_endpoint(endpoint, f)
+ return decorator
-# vim:et:ts=4:sw=4:
+# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
projects / odoo / odoo.git / blobdiff