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 """ Models registries.
25 from contextlib import contextmanager
30 import openerp.osv.orm
32 import openerp.modules.db
33 import openerp.tools.config
34 from openerp.tools import assertion_report
36 _logger = logging.getLogger(__name__)
38 class Registry(object):
39 """ Model registry for a particular database.
41 The registry is essentially a mapping between model names and model
42 instances. There is one registry instance per database.
46 def __init__(self, db_name):
47 self.models = {} # model name/model instance mapping
49 self._store_function = {}
51 self._init_parent = {}
52 self._assertion_report = assertion_report.assertion_report()
53 self.fields_by_model = None
55 # modules fully loaded (maintained during init phase by `loading` module)
56 self._init_modules = set()
58 self.db_name = db_name
59 self.db = openerp.sql_db.db_connect(db_name)
61 # Indicates that the registry is
64 # Inter-process signaling (used only when openerp.multi_process is True):
65 # The `base_registry_signaling` sequence indicates the whole registry
67 # The `base_cache_signaling sequence` indicates all caches must be
68 # invalidated (i.e. cleared).
69 self.base_registry_signaling_sequence = 1
70 self.base_cache_signaling_sequence = 1
72 # Flag indicating if at least one model cache has been cleared.
73 # Useful only in a multi-process context.
74 self._any_cache_cleared = False
77 has_unaccent = openerp.modules.db.has_unaccent(cr)
78 if openerp.tools.config['unaccent'] and not has_unaccent:
79 _logger.warning("The option --unaccent was given but no unaccent() function was found in database.")
80 self.has_unaccent = openerp.tools.config['unaccent'] and has_unaccent
83 def do_parent_store(self, cr):
84 for o in self._init_parent:
85 self.get(o)._parent_store_compute(cr)
89 """ Return the list of model names in this registry."""
90 return self.models.keys()
92 def add(self, model_name, model):
93 """ Add or replace a model in the registry."""
94 self.models[model_name] = model
96 def get(self, model_name):
97 """ Return a model for a given name or None if it doesn't exist."""
98 return self.models.get(model_name)
100 def __getitem__(self, model_name):
101 """ Return a model for a given name or raise KeyError if it doesn't exist."""
102 return self.models[model_name]
104 def load(self, cr, module):
105 """ Load a given module in the registry.
107 At the Python level, the modules are already loaded, but not yet on a
108 per-registry level. This method populates a registry with the given
109 modules, i.e. it instanciates all the classes of a the given module
110 and registers them in the registry.
113 models_to_load = [] # need to preserve loading order
114 # Instantiate registered classes (via the MetaModel automatic discovery
115 # or via explicit constructor call), and add them to the pool.
116 for cls in openerp.osv.orm.MetaModel.module_to_models.get(module.name, []):
117 # models register themselves in self.models
118 model = cls.create_instance(self, cr)
119 if model._name not in models_to_load:
120 # avoid double-loading models whose declaration is split
121 models_to_load.append(model._name)
122 return [self.models[m] for m in models_to_load]
124 def clear_caches(self):
126 This clears the caches associated to methods decorated with
127 ``tools.ormcache`` or ``tools.ormcache_multi`` for all the models.
129 for model in self.models.itervalues():
131 # Special case for ir_ui_menu which does not use openerp.tools.ormcache.
132 ir_ui_menu = self.models.get('ir.ui.menu')
134 ir_ui_menu.clear_cache()
137 # Useful only in a multi-process context.
138 def reset_any_cache_cleared(self):
139 self._any_cache_cleared = False
141 # Useful only in a multi-process context.
142 def any_cache_cleared(self):
143 return self._any_cache_cleared
146 def setup_multi_process_signaling(cls, cr):
147 if not openerp.multi_process:
150 # Inter-process signaling:
151 # The `base_registry_signaling` sequence indicates the whole registry
153 # The `base_cache_signaling sequence` indicates all caches must be
154 # invalidated (i.e. cleared).
155 cr.execute("""SELECT sequence_name FROM information_schema.sequences WHERE sequence_name='base_registry_signaling'""")
156 if not cr.fetchall():
157 cr.execute("""CREATE SEQUENCE base_registry_signaling INCREMENT BY 1 START WITH 1""")
158 cr.execute("""SELECT nextval('base_registry_signaling')""")
159 cr.execute("""CREATE SEQUENCE base_cache_signaling INCREMENT BY 1 START WITH 1""")
160 cr.execute("""SELECT nextval('base_cache_signaling')""")
163 def cursor(self, auto_commit=True):
164 cr = self.db.cursor()
173 class RegistryManager(object):
174 """ Model registries manager.
176 The manager is responsible for creation and deletion of model
177 registries (essentially database connection/model registry pairs).
180 # Mapping between db name and model registry.
181 # Accessed through the methods below.
183 registries_lock = threading.RLock()
186 def get(cls, db_name, force_demo=False, status=None, update_module=False):
187 """ Return a registry for a given database name."""
189 return cls.registries[db_name]
191 return cls.new(db_name, force_demo, status,
194 # set db tracker - cleaned up at the WSGI
195 # dispatching phase in openerp.service.wsgi_server.application
196 threading.current_thread().dbname = db_name
199 def new(cls, db_name, force_demo=False, status=None,
200 update_module=False):
201 """ Create and return a new registry for a given database name.
203 The (possibly) previous registry for that database name is discarded.
206 import openerp.modules
207 with cls.registries_lock:
208 registry = Registry(db_name)
210 # Initializing a registry will call general code which will in turn
211 # call registries.get (this object) to obtain the registry being
212 # initialized. Make it available in the registries dictionary then
213 # remove it if an exception is raised.
215 cls.registries[db_name] = registry
217 # This should be a method on Registry
218 openerp.modules.load_modules(registry.db, force_demo, status, update_module)
220 del cls.registries[db_name]
223 # load_modules() above can replace the registry by calling
224 # indirectly new() again (when modules have to be uninstalled).
226 registry = cls.registries[db_name]
228 cr = registry.db.cursor()
230 Registry.setup_multi_process_signaling(cr)
231 registry.do_parent_store(cr)
232 registry.get('ir.actions.report.xml').register_all(cr)
237 registry.ready = True
240 # only in case of update, otherwise we'll have an infinite reload loop!
241 cls.signal_registry_change(db_name)
245 def delete(cls, db_name):
246 """Delete the registry linked to a given database. """
247 with cls.registries_lock:
248 if db_name in cls.registries:
249 cls.registries[db_name].clear_caches()
250 del cls.registries[db_name]
254 """Delete all the registries. """
255 with cls.registries_lock:
256 for db_name in cls.registries.keys():
260 def clear_caches(cls, db_name):
263 This clears the caches associated to methods decorated with
264 ``tools.ormcache`` or ``tools.ormcache_multi`` for all the models
265 of the given database name.
267 This method is given to spare you a ``RegistryManager.get(db_name)``
268 that would loads the given database if it was not already loaded.
270 with cls.registries_lock:
271 if db_name in cls.registries:
272 cls.registries[db_name].clear_caches()
275 def check_registry_signaling(cls, db_name):
276 if openerp.multi_process and db_name in cls.registries:
277 registry = cls.get(db_name)
278 cr = registry.db.cursor()
281 SELECT base_registry_signaling.last_value,
282 base_cache_signaling.last_value
283 FROM base_registry_signaling, base_cache_signaling""")
285 # Check if the model registry must be reloaded (e.g. after the
286 # database has been updated by another process).
287 if registry.base_registry_signaling_sequence != r:
288 _logger.info("Reloading the model registry after database signaling.")
289 registry = cls.new(db_name)
290 registry.base_registry_signaling_sequence = r
291 # Check if the model caches must be invalidated (e.g. after a write
292 # occured on another process). Don't clear right after a registry
294 elif registry.base_cache_signaling_sequence != c:
295 _logger.info("Invalidating all model caches after database signaling.")
296 registry.base_cache_signaling_sequence = c
297 registry.clear_caches()
298 registry.reset_any_cache_cleared()
299 # One possible reason caches have been invalidated is the
300 # use of decimal_precision.write(), in which case we need
301 # to refresh fields.float columns.
302 for model in registry.models.values():
303 for column in model._columns.values():
304 if hasattr(column, 'digits_change'):
305 column.digits_change(cr)
310 def signal_caches_change(cls, db_name):
311 if openerp.multi_process and db_name in cls.registries:
312 # Check the registries if any cache has been cleared and signal it
313 # through the database to other processes.
314 registry = cls.get(db_name)
315 if registry.any_cache_cleared():
316 _logger.info("At least one model cache has been cleared, signaling through the database.")
317 cr = registry.db.cursor()
320 cr.execute("select nextval('base_cache_signaling')")
324 registry.base_cache_signaling_sequence = r
325 registry.reset_any_cache_cleared()
328 def signal_registry_change(cls, db_name):
329 if openerp.multi_process and db_name in cls.registries:
330 registry = cls.get(db_name)
331 cr = registry.db.cursor()
334 cr.execute("select nextval('base_registry_signaling')")
338 registry.base_registry_signaling_sequence = r
340 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: