openerp/addons/base/ir/ir_http.py

   1 #----------------------------------------------------------
   2 # ir_http modular http routing
   3 #----------------------------------------------------------
   4 import logging
   5 import re
   6 import sys
   7
   8 import werkzeug.exceptions
   9 import werkzeug.routing
  10
  11 import openerp
  12 from openerp import http
  13 from openerp.http import request
  14 from openerp.osv import osv, orm
  15
  16 _logger = logging.getLogger(__name__)
  17
  18
  19 # FIXME: replace by proxy on request.uid?
  20 _uid = object()
  21
  22 class ModelConverter(werkzeug.routing.BaseConverter):
  23
  24     def __init__(self, url_map, model=False):
  25         super(ModelConverter, self).__init__(url_map)
  26         self.model = model
  27         self.regex = '([0-9]+)'
  28
  29     def to_python(self, value):
  30         m = re.match(self.regex, value)
  31         return request.registry[self.model].browse(
  32             request.cr, _uid, int(m.group(1)), context=request.context)
  33
  34     def to_url(self, value):
  35         return value.id
  36
  37 class ModelsConverter(werkzeug.routing.BaseConverter):
  38
  39     def __init__(self, url_map, model=False):
  40         super(ModelsConverter, self).__init__(url_map)
  41         self.model = model
  42         # TODO add support for slug in the form [A-Za-z0-9-] bla-bla-89 -> id 89
  43         self.regex = '([0-9,]+)'
  44
  45     def to_python(self, value):
  46         # TODO:
  47         # - raise routing.ValidationError() if no browse record can be createdm
  48         # - support slug
  49         return request.registry[self.model].browse(request.cr, _uid, [int(i) for i in value.split(',')], context=request.context)
  50
  51     def to_url(self, value):
  52         return ",".join(i.id for i in value)
  53
  54 class ir_http(osv.AbstractModel):
  55     _name = 'ir.http'
  56
  57     _description = "HTTP routing"
  58
  59     def _get_converters(self):
  60         return {'model': ModelConverter, 'models': ModelsConverter}
  61
  62     def _find_handler(self):
  63         return self.routing_map().bind_to_environ(request.httprequest.environ).match()
  64
  65     def _auth_method_user(self):
  66         request.uid = request.session.uid
  67         if not request.uid:
  68             raise http.SessionExpiredException("Session expired")
  69
  70     def _auth_method_admin(self):
  71         if not request.db:
  72             raise http.SessionExpiredException("No valid database for request %s" % request.httprequest)
  73         request.uid = openerp.SUPERUSER_ID
  74
  75     def _auth_method_none(self):
  76         request.disable_db = True
  77         request.uid = None
  78
  79     def _authenticate(self, auth_method='user'):
  80         if request.session.uid:
  81             try:
  82                 request.session.check_security()
  83                 # what if error in security.check()
  84                 #   -> res_users.check()
  85                 #   -> res_users.check_credentials()
  86             except http.SessionExpiredException:
  87                 request.session.logout()
  88                 raise http.SessionExpiredException("Session expired for request %s" % request.httprequest)
  89         getattr(self, "_auth_method_%s" % auth_method)()
  90         return auth_method
  91
  92     def _handle_exception(self, exception):
  93         if isinstance(exception, openerp.exceptions.AccessError):
  94             code = 403
  95         else:
  96             code = getattr(exception, 'code', 500)
  97
  98         fn = getattr(self, '_handle_%d' % code, self._handle_unknown_exception)
  99         return fn(exception)
 100
 101     def _handle_unknown_exception(self, exception):
 102         raise exception
 103
 104     def _dispatch(self):
 105         # locate the controller method
 106         try:
 107             func, arguments = self._find_handler()
 108         except werkzeug.exceptions.NotFound, e:
 109             return self._handle_exception(e)
 110
 111         # check authentication level
 112         try:
 113             auth_method = self._authenticate(getattr(func, "auth", None))
 114         except Exception:
 115             # force a Forbidden exception with the original traceback
 116             return self._handle_exception(
 117                 convert_exception_to(
 118                     werkzeug.exceptions.Forbidden))
 119
 120         # post process arg to set uid on browse records
 121         for arg in arguments.itervalues():
 122             if isinstance(arg, orm.browse_record) and arg._uid is _uid:
 123                 arg._uid = request.uid
 124
 125         # set and execute handler
 126         try:
 127             request.set_handler(func, arguments, auth_method)
 128             result = request.dispatch()
 129             if isinstance(result, Exception):
 130                 raise result
 131         except Exception, e:
 132             return self._handle_exception(e)
 133
 134         return result
 135
 136     def routing_map(self):
 137         if not hasattr(self, '_routing_map'):
 138             _logger.info("Generating routing map")
 139             cr = request.cr
 140             m = request.registry.get('ir.module.module')
 141             ids = m.search(cr, openerp.SUPERUSER_ID, [('state', '=', 'installed'), ('name', '!=', 'web')], context=request.context)
 142             installed = set(x['name'] for x in m.read(cr, 1, ids, ['name'], context=request.context))
 143             mods = ['', "web"] + sorted(installed)
 144             self._routing_map = http.routing_map(mods, False, converters=self._get_converters())
 145
 146         return self._routing_map
 147
 148 def convert_exception_to(to_type, with_message=False):
 149     """ Should only be called from an exception handler. Fetches the current
 150     exception data from sys.exc_info() and creates a new exception of type
 151     ``to_type`` with the original traceback.
 152
 153     If ``with_message`` is ``True``, sets the new exception's message to be
 154     the stringification of the original exception. If ``False``, does not
 155     set the new exception's message. Otherwise, uses ``with_message`` as the
 156     new exception's message.
 157
 158     :type with_message: str|bool
 159     """
 160     etype, original, tb = sys.exc_info()
 161     try:
 162         if with_message is False:
 163             message = None
 164         elif with_message is True:
 165             message = str(original)
 166         else:
 167             message = str(with_message)
 168
 169         raise to_type, message, tb
 170     except to_type, e:
 171         return e
 172
 173 # vim:et: