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