1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ##############################################################################
22 #.apidoc title: Objects Services (OSV)
24 from functools import wraps
26 from psycopg2 import IntegrityError, errorcodes
30 import openerp.netsvc as netsvc
31 import openerp.pooler as pooler
32 import openerp.sql_db as sql_db
33 from openerp.tools.translate import translate
34 from openerp.osv.orm import MetaModel, Model, TransientModel, AbstractModel
35 import openerp.exceptions
37 _logger = logging.getLogger(__name__)
40 class except_osv(Exception):
41 def __init__(self, name, value):
44 self.args = (name, value)
48 class object_proxy(object):
55 def wrapper(self, dbname, *args, **kwargs):
56 """ Wraps around OSV functions and normalises a few exceptions
60 # We try to do the same as the _(), but without the frame
61 # inspection, since we aready are wrapping an osv function
62 # trans_obj = self.get('ir.translation') cannot work yet :(
65 if args and isinstance(args[-1], dict):
67 elif isinstance(kwargs, dict):
68 ctx = kwargs.get('context', {})
71 if args and isinstance(args[0], (long, int)):
74 lang = ctx and ctx.get('lang')
75 if not (lang or hasattr(src, '__call__')):
78 # We open a *new* cursor here, one reason is that failed SQL
79 # queries (as in IntegrityError) will invalidate the current one.
82 if hasattr(src, '__call__'):
83 # callable. We need to find the right parameters to call
84 # the orm._sql_message(self, cr, uid, ids, context) function,
86 # our signature is f(osv_pool, dbname [,uid, obj, method, args])
88 if args and len(args) > 1:
89 obj = self.get(args[1])
90 if len(args) > 3 and isinstance(args[3], (long, int, list)):
94 cr = sql_db.db_connect(dbname).cursor()
95 return src(obj, cr, uid, ids, context=(ctx or {}))
101 return False # so that the original SQL error will
102 # be returned, it is the best we have.
105 cr = sql_db.db_connect(dbname).cursor()
106 res = translate(cr, name=False, source_type=ttype,
107 lang=lang, source=src)
116 return tr(src, 'code')
119 if pooler.get_pool(dbname)._init:
120 raise except_osv('Database not ready', 'Currently, this database is not fully loaded and can not be used.')
121 return f(self, dbname, *args, **kwargs)
122 except orm.except_orm, inst:
123 raise except_osv(inst.name, inst.value)
126 except IntegrityError, inst:
127 osv_pool = pooler.get_pool(dbname)
128 for key in osv_pool._sql_error.keys():
130 netsvc.abort_response(1, _('Constraint Error'), 'warning',
131 tr(osv_pool._sql_error[key], 'sql_constraint') or inst[0])
132 if inst.pgcode in (errorcodes.NOT_NULL_VIOLATION, errorcodes.FOREIGN_KEY_VIOLATION, errorcodes.RESTRICT_VIOLATION):
133 msg = _('The operation cannot be completed, probably due to the following:\n- deletion: you may be trying to delete a record while other records still reference it\n- creation/update: a mandatory field is not correctly set')
134 _logger.debug("IntegrityError", exc_info=True)
136 errortxt = inst.pgerror.replace('«','"').replace('»','"')
137 if '"public".' in errortxt:
138 context = errortxt.split('"public".')[1]
139 model_name = table = context.split('"')[1]
141 last_quote_end = errortxt.rfind('"')
142 last_quote_begin = errortxt.rfind('"', 0, last_quote_end)
143 model_name = table = errortxt[last_quote_begin+1:last_quote_end].strip()
144 model = table.replace("_",".")
145 model_obj = osv_pool.get(model)
147 model_name = model_obj._description or model_obj._name
148 msg += _('\n\n[object with reference: %s - %s]') % (model_name, model)
151 netsvc.abort_response(1, _('Integrity Error'), 'warning', msg)
153 netsvc.abort_response(1, _('Integrity Error'), 'warning', inst[0])
155 _logger.exception("Uncaught exception")
160 def execute_cr(self, cr, uid, obj, method, *args, **kw):
161 object = pooler.get_pool(cr.dbname).get(obj)
163 raise except_osv('Object Error', 'Object %s doesn\'t exist' % str(obj))
164 return getattr(object, method)(cr, uid, *args, **kw)
166 def execute_kw(self, db, uid, obj, method, args, kw=None):
167 return self.execute(db, uid, obj, method, *args, **kw or {})
170 def execute(self, db, uid, obj, method, *args, **kw):
171 cr = pooler.get_db(db).cursor()
174 if method.startswith('_'):
175 raise except_osv('Access Denied', 'Private methods (such as %s) cannot be called remotely.' % (method,))
176 res = self.execute_cr(cr, uid, obj, method, *args, **kw)
178 _logger.warning('The method %s of the object %s can not return `None` !', method, obj)
187 def exec_workflow_cr(self, cr, uid, obj, signal, *args):
188 object = pooler.get_pool(cr.dbname).get(obj)
190 raise except_osv('Object Error', 'Object %s doesn\'t exist' % str(obj))
191 return object._workflow_signal(cr, uid, [args[0]], signal)
194 def exec_workflow(self, db, uid, obj, signal, *args):
195 cr = pooler.get_db(db).cursor()
198 res = self.exec_workflow_cr(cr, uid, obj, signal, *args)
207 # deprecated - for backward compatibility.
209 osv_memory = TransientModel
210 osv_abstract = AbstractModel # ;-)
213 def start_object_proxy():
216 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: