openerp/modules/registry.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19 #
  20 ##############################################################################
  21
  22 """ Models registries.
  23
  24 """
  25 from contextlib import contextmanager
  26 import logging
  27 import threading
  28
  29 import openerp.sql_db
  30 import openerp.osv.orm
  31 import openerp.tools
  32 import openerp.modules.db
  33 import openerp.tools.config
  34 from openerp.tools import assertion_report
  35
  36 _logger = logging.getLogger(__name__)
  37
  38 class Registry(object):
  39     """ Model registry for a particular database.
  40
  41     The registry is essentially a mapping between model names and model
  42     instances. There is one registry instance per database.
  43
  44     """
  45
  46     def __init__(self, db_name):
  47         self.models = {}    # model name/model instance mapping
  48         self._sql_error = {}
  49         self._store_function = {}
  50         self._init = True
  51         self._init_parent = {}
  52         self._assertion_report = assertion_report.assertion_report()
  53         self.fields_by_model = None
  54
  55         # modules fully loaded (maintained during init phase by `loading` module)
  56         self._init_modules = set()
  57
  58         self.db_name = db_name
  59         self.db = openerp.sql_db.db_connect(db_name)
  60
  61         # In monoprocess cron jobs flag (pooljobs)
  62         self.cron = False
  63
  64         # Inter-process signaling (used only when openerp.multi_process is True):
  65         # The `base_registry_signaling` sequence indicates the whole registry
  66         # must be reloaded.
  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
  71
  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
  75
  76         cr = self.db.cursor()
  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
  81         cr.close()
  82
  83     def do_parent_store(self, cr):
  84         for o in self._init_parent:
  85             self.get(o)._parent_store_compute(cr)
  86         self._init = False
  87
  88     def obj_list(self):
  89         """ Return the list of model names in this registry."""
  90         return self.models.keys()
  91
  92     def add(self, model_name, model):
  93         """ Add or replace a model in the registry."""
  94         self.models[model_name] = model
  95
  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)
  99
 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]
 103
 104     def load(self, cr, module):
 105         """ Load a given module in the registry.
 106
 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.
 111
 112         """
 113
 114         res = []
 115
 116         # Instantiate registered classes (via the MetaModel automatic discovery
 117         # or via explicit constructor call), and add them to the pool.
 118         for cls in openerp.osv.orm.MetaModel.module_to_models.get(module.name, []):
 119             res.append(cls.create_instance(self, cr))
 120
 121         return res
 122
 123     def schedule_cron_jobs(self):
 124         """ Make the cron thread care about this registry/database jobs.
 125         This will initiate the cron thread to check for any pending jobs for
 126         this registry/database as soon as possible. Then it will continuously
 127         monitor the ir.cron model for future jobs. See openerp.cron for
 128         details.
 129         """
 130         self.cron = True
 131
 132     def clear_caches(self):
 133         """ Clear the caches
 134         This clears the caches associated to methods decorated with
 135         ``tools.ormcache`` or ``tools.ormcache_multi`` for all the models.
 136         """
 137         for model in self.models.itervalues():
 138             model.clear_caches()
 139         # Special case for ir_ui_menu which does not use openerp.tools.ormcache.
 140         ir_ui_menu = self.models.get('ir.ui.menu')
 141         if ir_ui_menu:
 142             ir_ui_menu.clear_cache()
 143
 144
 145     # Useful only in a multi-process context.
 146     def reset_any_cache_cleared(self):
 147         self._any_cache_cleared = False
 148
 149     # Useful only in a multi-process context.
 150     def any_cache_cleared(self):
 151         return self._any_cache_cleared
 152
 153     @classmethod
 154     def setup_multi_process_signaling(cls, cr):
 155         if not openerp.multi_process:
 156             return
 157
 158         # Inter-process signaling:
 159         # The `base_registry_signaling` sequence indicates the whole registry
 160         # must be reloaded.
 161         # The `base_cache_signaling sequence` indicates all caches must be
 162         # invalidated (i.e. cleared).
 163         cr.execute("""SELECT sequence_name FROM information_schema.sequences WHERE sequence_name='base_registry_signaling'""")
 164         if not cr.fetchall():
 165             cr.execute("""CREATE SEQUENCE base_registry_signaling INCREMENT BY 1 START WITH 1""")
 166             cr.execute("""SELECT nextval('base_registry_signaling')""")
 167             cr.execute("""CREATE SEQUENCE base_cache_signaling INCREMENT BY 1 START WITH 1""")
 168             cr.execute("""SELECT nextval('base_cache_signaling')""")
 169
 170     @contextmanager
 171     def cursor(self, auto_commit=True):
 172         cr = self.db.cursor()
 173         try:
 174             yield cr
 175             if auto_commit:
 176                 cr.commit()
 177         finally:
 178             cr.close()
 179
 180
 181 class RegistryManager(object):
 182     """ Model registries manager.
 183
 184         The manager is responsible for creation and deletion of model
 185         registries (essentially database connection/model registry pairs).
 186
 187     """
 188     # Mapping between db name and model registry.
 189     # Accessed through the methods below.
 190     registries = {}
 191     registries_lock = threading.RLock()
 192
 193     @classmethod
 194     def get(cls, db_name, force_demo=False, status=None, update_module=False,
 195             pooljobs=True):
 196         """ Return a registry for a given database name."""
 197         try:
 198             return cls.registries[db_name]
 199         except KeyError:
 200             return cls.new(db_name, force_demo, status,
 201                            update_module, pooljobs)
 202
 203     @classmethod
 204     def new(cls, db_name, force_demo=False, status=None,
 205             update_module=False, pooljobs=True):
 206         """ Create and return a new registry for a given database name.
 207
 208         The (possibly) previous registry for that database name is discarded.
 209
 210         """
 211         import openerp.modules
 212         with cls.registries_lock:
 213             registry = Registry(db_name)
 214
 215             # Initializing a registry will call general code which will in turn
 216             # call registries.get (this object) to obtain the registry being
 217             # initialized. Make it available in the registries dictionary then
 218             # remove it if an exception is raised.
 219             cls.delete(db_name)
 220             cls.registries[db_name] = registry
 221             try:
 222                 # This should be a method on Registry
 223                 openerp.modules.load_modules(registry.db, force_demo, status, update_module)
 224             except Exception:
 225                 del cls.registries[db_name]
 226                 raise
 227
 228             cr = registry.db.cursor()
 229             try:
 230                 Registry.setup_multi_process_signaling(cr)
 231                 registry.do_parent_store(cr)
 232                 registry.get('ir.actions.report.xml').register_all(cr)
 233                 cr.commit()
 234             finally:
 235                 cr.close()
 236
 237         if pooljobs:
 238             registry.schedule_cron_jobs()
 239
 240         return registry
 241
 242     @classmethod
 243     def delete(cls, db_name):
 244         """Delete the registry linked to a given database.  """
 245         with cls.registries_lock:
 246             if db_name in cls.registries:
 247                 cls.registries[db_name].clear_caches()
 248                 del cls.registries[db_name]
 249
 250     @classmethod
 251     def delete_all(cls):
 252         """Delete all the registries. """
 253         with cls.registries_lock:
 254             for db_name in cls.registries.keys():
 255                 cls.delete(db_name)
 256
 257     @classmethod
 258     def clear_caches(cls, db_name):
 259         """Clear caches
 260
 261         This clears the caches associated to methods decorated with
 262         ``tools.ormcache`` or ``tools.ormcache_multi`` for all the models
 263         of the given database name.
 264
 265         This method is given to spare you a ``RegistryManager.get(db_name)``
 266         that would loads the given database if it was not already loaded.
 267         """
 268         with cls.registries_lock:
 269             if db_name in cls.registries:
 270                 cls.registries[db_name].clear_caches()
 271
 272     @classmethod
 273     def check_registry_signaling(cls, db_name):
 274         if openerp.multi_process and db_name in cls.registries:
 275             registry = cls.get(db_name, pooljobs=False)
 276             cr = registry.db.cursor()
 277             try:
 278                 cr.execute("""
 279                     SELECT base_registry_signaling.last_value,
 280                            base_cache_signaling.last_value
 281                     FROM base_registry_signaling, base_cache_signaling""")
 282                 r, c = cr.fetchone()
 283                 # Check if the model registry must be reloaded (e.g. after the
 284                 # database has been updated by another process).
 285                 if registry.base_registry_signaling_sequence != r:
 286                     _logger.info("Reloading the model registry after database signaling.")
 287                     # Don't run the cron in the Gunicorn worker.
 288                     registry = cls.new(db_name, pooljobs=False)
 289                     registry.base_registry_signaling_sequence = r
 290                 # Check if the model caches must be invalidated (e.g. after a write
 291                 # occured on another process). Don't clear right after a registry
 292                 # has been reload.
 293                 elif registry.base_cache_signaling_sequence != c:
 294                     _logger.info("Invalidating all model caches after database signaling.")
 295                     registry.base_cache_signaling_sequence = c
 296                     registry.clear_caches()
 297                     registry.reset_any_cache_cleared()
 298                     # One possible reason caches have been invalidated is the
 299                     # use of decimal_precision.write(), in which case we need
 300                     # to refresh fields.float columns.
 301                     for model in registry.models.values():
 302                         for column in model._columns.values():
 303                             if hasattr(column, 'digits_change'):
 304                                 column.digits_change(cr)
 305             finally:
 306                 cr.close()
 307
 308     @classmethod
 309     def signal_caches_change(cls, db_name):
 310         if openerp.multi_process and db_name in cls.registries:
 311             # Check the registries if any cache has been cleared and signal it
 312             # through the database to other processes.
 313             registry = cls.get(db_name, pooljobs=False)
 314             if registry.any_cache_cleared():
 315                 _logger.info("At least one model cache has been cleared, signaling through the database.")
 316                 cr = registry.db.cursor()
 317                 r = 1
 318                 try:
 319                     cr.execute("select nextval('base_cache_signaling')")
 320                     r = cr.fetchone()[0]
 321                 finally:
 322                     cr.close()
 323                 registry.base_cache_signaling_sequence = r
 324                 registry.reset_any_cache_cleared()
 325
 326     @classmethod
 327     def signal_registry_change(cls, db_name):
 328         if openerp.multi_process and db_name in cls.registries:
 329             registry = cls.get(db_name, pooljobs=False)
 330             cr = registry.db.cursor()
 331             r = 1
 332             try:
 333                 cr.execute("select nextval('base_registry_signaling')")
 334                 r = cr.fetchone()[0]
 335             finally:
 336                 cr.close()
 337             registry.base_registry_signaling_sequence = r
 338
 339 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: