4 import dateutil.relativedelta
12 _logger = logging.getLogger(__name__)
14 #----------------------------------------------------------
15 # OpenERPSession RPC openerp backend access
16 #----------------------------------------------------------
17 class AuthenticationError(Exception):
20 class SessionExpiredException(Exception):
23 class Service(object):
24 def __init__(self, session, service_name):
25 self.session = session
26 self.service_name = service_name
28 def __getattr__(self, method):
29 def proxy_method(*args):
30 result = self.session.send(self.service_name, method, *args)
35 def __init__(self, session, model):
36 self.session = session
38 self.proxy = self.session.proxy('object')
40 def __getattr__(self, method):
41 self.session.assert_valid()
42 def proxy(*args, **kw):
43 result = self.proxy.execute_kw(self.session._db, self.session._uid, self.session._password, self.model, method, args, kw)
46 if isinstance(result, list) and len(result) > 0 and "id" in result[0]:
50 result = [index[x] for x in args[0] if x in index]
54 def search_read(self, domain=None, fields=None, offset=0, limit=None, order=None, context=None):
55 record_ids = self.search(domain or [], offset, limit or False, order or False, context or {})
56 if not record_ids: return []
57 records = self.read(record_ids, fields or [], context or {})
60 class OpenERPSession(object):
62 An OpenERP RPC session, a given user can own multiple such sessions
65 .. attribute:: context
67 The session context, a ``dict``. Can be reloaded by calling
68 :meth:`openerpweb.openerpweb.OpenERPSession.get_context`
70 .. attribute:: domains_store
72 A ``dict`` matching domain keys to evaluable (but non-literal) domains.
74 Used to store references to non-literal domains which need to be
75 round-tripped to the client browser.
78 self._creation_time = time.time()
82 self._password = False
85 self.jsonp_requests = {} # FIXME use a LRU
87 def send(self, service_name, method, *args):
88 return openerp.netsvc.dispatch_rpc(service_name, method, args)
90 def proxy(self, service):
91 return Service(self, service)
93 def bind(self, db, uid, login, password):
97 self._password = password
99 def authenticate(self, db, login, password, env=None):
100 uid = self.proxy('common').authenticate(db, login, password, env)
101 self.bind(db, uid, login, password)
103 if uid: self.get_context()
106 def assert_valid(self, force=False):
108 Ensures this session is valid (logged into the openerp server)
110 if self._uid and not force:
112 # TODO use authenticate instead of login
113 self._uid = self.proxy("common").login(self._db, self._login, self._password)
115 raise AuthenticationError("Authentication failure")
117 def ensure_valid(self):
120 self.assert_valid(True)
124 def execute(self, model, func, *l, **d):
125 model = self.model(model)
126 r = getattr(model, func)(*l, **d)
129 def exec_workflow(self, model, id, signal):
131 r = self.proxy('object').exec_workflow(self._db, self._uid, self._password, model, signal, id)
134 def model(self, model):
135 """ Get an RPC proxy for the object ``model``, bound to this session.
137 :param model: an OpenERP model name
139 :rtype: a model object
141 if self._db == False:
142 raise SessionExpiredException("Session expired")
144 return Model(self, model)
146 def get_context(self):
147 """ Re-initializes the current user's session context (based on
148 his preferences) by calling res.users.get_context() with the old
151 :returns: the new context
153 assert self._uid, "The user needs to be logged-in to initialize his context"
154 self.context = self.model('res.users').context_get() or {}
155 self.context['uid'] = self._uid
156 self._fix_lang(self.context)
159 def _fix_lang(self, context):
160 """ OpenERP provides languages which may not make sense and/or may not
161 be understood by the web client's libraries.
165 :param dict context: context to fix
167 lang = context['lang']
169 # inane OpenERP locale
173 # lang to lang_REGION (datejs only handles lang_REGION, no bare langs)
174 if lang in babel.core.LOCALE_ALIASES:
175 lang = babel.core.LOCALE_ALIASES[lang]
177 context['lang'] = lang or 'en_US'