Unify and refactor exception handling in framework and addons. The generic `except_osv` is now deprecated, and replaced by more specialized exception subtypes: - `UserError` (renamed from Warning, as it conflicts with the built-in `Warning`) raised when a non-technical error occurs during a business operation. It could be a missing information in the data provided by the user, or a misconfiguration. - `AccessError`: raised when any operation is denied because the user conducting it does not have the required access rights. - `AccessDenied`: raised when an operation that requires authenticated access is attempted via an unauthenticated request. - `MissingError`: raised when an operation is attempted on a record that does not exist. - `ValidationError`: raised when an operation violates a SQL or Python constraint. - All other exceptions are internal errors due to a system problem or bug, and raised untouched to the client-side, which should display a traceback. All exceptions take a single message argument. The `test_exceptions` module has been updated to showcase both new and old (deprecated) exceptions. A great many old `except_osv` had a useless title with "Error!" or "Warning", those have been removed, as this is handled by the client-side widget that displays the messages. This commit introduces a more consistent policy for logging errors and warnings: - All messages that do not require administrator attention should be logged at INFO level or lower. This includes all errors that are notified to the user in a friendly manner, even for access right problems or validation errors during business operations. - All messages that indicate a likely misconfiguration or malicious use by the users should be logged at WARNING level, as they typically require administrator attention. - All other unhandled internal errors cannot typically be handled by the user and should be logged at ERROR or higher level, as they require immediate administrator attention.
90 lines
3.9 KiB
Python
90 lines
3.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
import openerp.exceptions
|
|
import openerp.osv.orm
|
|
import openerp.osv.osv
|
|
import openerp.tools.safe_eval
|
|
from openerp.exceptions import UserError
|
|
from openerp.exceptions import except_orm
|
|
|
|
class m(openerp.osv.osv.Model):
|
|
""" This model exposes a few methods that will raise the different
|
|
exceptions that must be handled by the server (and its RPC layer)
|
|
and the clients.
|
|
"""
|
|
_name = 'test.exceptions.model'
|
|
|
|
def generate_except_osv(self, cr, uid, ids, context=None):
|
|
# title is ignored in the new (6.1) exceptions
|
|
raise openerp.osv.osv.except_osv('title', 'description')
|
|
|
|
def generate_except_orm(self, cr, uid, ids, context=None):
|
|
# title is ignored in the new (6.1) exceptions
|
|
raise except_orm('title', 'description')
|
|
|
|
def generate_warning(self, cr, uid, ids, context=None):
|
|
raise openerp.exceptions.Warning('description')
|
|
|
|
def generate_redirect_warning(self, cr, uid, ids, context=None):
|
|
dummy, action_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'test_exceptions', 'action_test_exceptions')
|
|
raise openerp.exceptions.RedirectWarning('description', action_id, 'Go to the redirection')
|
|
|
|
def generate_access_denied(self, cr, uid, ids, context=None):
|
|
raise openerp.exceptions.AccessDenied()
|
|
|
|
def generate_access_error(self, cr, uid, ids, context=None):
|
|
raise openerp.exceptions.AccessError('description')
|
|
|
|
def generate_exc_access_denied(self, cr, uid, ids, context=None):
|
|
raise Exception('AccessDenied')
|
|
|
|
def generate_undefined(self, cr, uid, ids, context=None):
|
|
self.surely_undefined_symbol
|
|
|
|
def generate_user_error(self, cr, uid, ids, context=None):
|
|
raise UserError('description')
|
|
|
|
def generate_missing_error(self, cr, uid, ids, context=None):
|
|
raise openerp.exceptions.MissingError('description')
|
|
|
|
def generate_validation_error(self, cr, uid, ids, context=None):
|
|
raise openerp.exceptions.ValidationError('description')
|
|
|
|
|
|
def generate_except_osv_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_except_osv, context)
|
|
|
|
def generate_except_orm_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_except_orm, context)
|
|
|
|
def generate_warning_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_warning, context)
|
|
|
|
def generate_redirect_warning_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_redirect_warning, context)
|
|
|
|
def generate_access_denied_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_access_denied, context)
|
|
|
|
def generate_access_error_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_access_error, context)
|
|
|
|
def generate_exc_access_denied_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_exc_access_denied, context)
|
|
|
|
def generate_undefined_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_undefined, context)
|
|
|
|
def generate_user_error_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_user_error, context)
|
|
|
|
def generate_missing_error_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_missing_error, context)
|
|
|
|
def generate_validation_error_safe_eval(self, cr, uid, ids, context=None):
|
|
self.generate_safe_eval(cr, uid, ids, self.generate_validation_error, context)
|
|
|
|
|
|
def generate_safe_eval(self, cr, uid, ids, f, context):
|
|
globals_dict = { 'generate': lambda *args: f(cr, uid, ids, context) }
|
|
openerp.tools.safe_eval.safe_eval("generate()", mode='exec', globals_dict=globals_dict)
|