Merge pull request #74 from jssuzanne/8.0

Deprecate install_in_connector()

Author: Guewen Baconnier

connector/CHANGES.rst

@@ -1,6 +1,10 @@
 Changelog
 ---------
 
+Future
+~~~~~~
+
+* method 'install_in_connector' is now deprecated
 
 3.1.0 (2015-05-15)
 ~~~~~~~~~~~~~~~~~~

connector/__init__.py

@@ -7,3 +7,4 @@
 from . import checkpoint
 from . import controllers
 from . import jobrunner
+from . import ir_module_module

connector/connector.py

@@ -19,11 +19,8 @@
 #
 ##############################################################################
 
-import inspect
 import logging
 from contextlib import contextmanager
-from openerp import models
-
 from .deprecate import log_deprecate, DeprecatedClass
 
 _logger = logging.getLogger(__name__)
@@ -49,42 +46,32 @@ def _get_openerp_module_name(module_path):
 
 
 def install_in_connector():
-    """ Installs an OpenERP module in the ``Connector`` framework.
+    log_deprecate("This call to 'install_in_connector()' has no effect and is "
+                  "not required.")
+
+
+def is_module_installed(env, module_name):
+    """ Check if an Odoo addon is installed.
 
-    It has to be called once per OpenERP module to plug.
+    The function might be called before `connector` is even installed;
+    in such case, `ir_module_module.is_module_installed()` is not available yet
+    and this is why we first check the installation of `connector` by looking
+    up for a model in the registry.
 
-    Under the cover, it creates a ``openerp.models.AbstractModel`` whose
-    name is the name of the module with a ``.intalled`` suffix:
-    ``{name_of_the_openerp_module_to_install}.installed``.
+    :param module_name: name of the addon to check being 'connector' or
+                        an addon depending on it
 
-    The connector then uses this model to know when the OpenERP module
-    is installed or not and whether it should use the ConnectorUnit
-    classes of this module or not and whether it should fire the
-    consumers of events or not.
     """
-    # Get the module of the caller
-    module = inspect.getmodule(inspect.currentframe().f_back)
-    openerp_module_name = _get_openerp_module_name(module.__name__)
-    # Build a new AbstractModel with the name of the module and the suffix
-    name = "%s.installed" % openerp_module_name
-    class_name = name.replace('.', '_')
-    # we need to call __new__ and __init__ in 2 phases because
-    # __init__ needs to have the right __module__ and _module attributes
-    model = models.MetaModel.__new__(models.MetaModel, class_name,
-                                     (models.AbstractModel,), {'_name': name})
-    # Update the module of the model, it should be the caller's one
-    model._module = openerp_module_name
-    model.__module__ = module.__name__
-    models.MetaModel.__init__(model, class_name,
-                              (models.AbstractModel,), {'_name': name})
-
-
-# install the connector itself
-install_in_connector()
-
-
-def is_module_installed(pool, module_name):
-    return bool(pool.get('%s.installed' % module_name))
+    if env.registry.get('connector.backend'):
+        if module_name == 'connector':
+            # fast-path: connector is necessarily installed because
+            # the model is in the registry
+            return True
+        # for another addon, check in ir.module.module
+        return env['ir.module.module'].is_module_installed(module_name)
+
+    # connector module is not installed neither any sub-addons
+    return False
 
 
 def get_openerp_module(cls_or_func):

connector/doc/guides/bootstrap_connector.rst

@@ -65,32 +65,6 @@ Of course, we also need to create the ``__init__.py`` file where we will
 put the imports of our python modules.
 
 
-***********************************
-Install the module in the connector
-***********************************
-
-Each new module needs to be plugged in the connector's framework.
-That's just a matter of following a convention and creating
-``connector_coffee/connector.py`` in which you will call the
-``install_in_connector`` function::
-
-    from openerp.addons.connector.connector import install_in_connector
-
-
-    install_in_connector()
-
-.. warning:: If you miss this line of code, your ConnectorUnit classes won't
-             be found.
-
-.. note:: The reason for this is that Odoo may import the Python modules
-          of uninstalled modules, so it automatically registers the
-          events and ConnectorUnit classes, even for uninstalled
-          modules.
-
-          To prevent this, we use a little trick: create an abstract
-          model and look in the registry if it is loaded.
-
-
 ********************
 Declare the backends
 ********************

connector/doc/locale/fr/LC_MESSAGES/api.po

@@ -937,38 +937,6 @@ msgstr ""
 "Ainsi nous serons capable de les filtrer en fonction de l'état "
 "d'installation des modules."
 
-#: ../../../connector.pydocstring of
-#: connector.connector.install_in_connector:1
-msgid "Installs an OpenERP module in the ``Connector`` framework."
-msgstr "Installe un module OpenERP dans le framework ``Connector``."
-
-#: ../../../connector.pydocstring of
-#: connector.connector.install_in_connector:3
-msgid "It has to be called once per OpenERP module to plug."
-msgstr "Il doit être appelé une fois par module OpenERP à brancher."
-
-#: ../../../connector.pydocstring of
-#: connector.connector.install_in_connector:5
-msgid ""
-"Under the cover, it creates a ``openerp.models.AbstractModel`` whose name is"
-" the name of the module with a ``.intalled`` suffix: "
-"``{name_of_the_openerp_module_to_install}.installed``."
-msgstr ""
-"Pour être précis, il crée un ``openerp.models.AbstractModel`` dont le nom "
-"est le nom du module avec un suffixe ``.intalled`` : "
-"``{name_of_the_openerp_module_to_install}.installed``."
-
-#: ../../../connector.pydocstring of
-#: connector.connector.install_in_connector:9
-msgid ""
-"The connector then uses this model to know when the OpenERP module is "
-"installed or not and whether it should use the ConnectorUnit classes of this"
-" module or not and whether it should fire the consumers of events or not."
-msgstr ""
-"Le connecteur utilise ensuite ce modèle pour savoir quand le module OpenERP "
-"est installé ou non, s'il doit utiliser les classes ConnectorUnit de ce "
-"module ou non et s'il doit allumer les consommateurs d'événements ou non."
-
 #: ../../api/api_event.rst:2
 msgid "Event"
 msgstr "Événement"

connector/doc/locale/fr/LC_MESSAGES/guides.po

@@ -66,12 +66,11 @@ msgstr "Installation du module dans le connecteur"
 msgid ""
 "Each new module needs to be plugged in the connector's framework. That's "
 "just a matter of following a convention and creating ``connector_coffee/"
-"connector.py`` in which you will call the ``install_in_connector`` function::"
+"connector.py``"
 msgstr ""
 "Chaque nouveau module doit être branché dans le framework du connecteur. "
 "C'est juste un question de suivre une convention et créer un fichier "
-"``connector_coffee/connector.py`` dans lequel vous allez appeler la fonction "
-"``install_in_connector``::"
+"``connector_coffee/connector.py``"
 
 #: ../../guides/bootstrap_connector.rst:82
 msgid ""

connector/ir_module_module.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Guewen Baconnier
+#    Copyright 2012-2013 Camptocamp SA
+#    Copyright 2015 anybox SA
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+from openerp import models, api
+from openerp.tools.cache import ormcache
+
+
+class IrModuleModule(models.Model):
+    """Overwrite ir.module.module to add cached method 'is_module_installed'.
+    This method is cached, because connector will always check if a module is
+    installed before do action.
+
+    All update (write method) on the field state, invalidate the cache
+    """
+    _inherit = 'ir.module.module'
+
+    @ormcache(skiparg=1)
+    def is_module_installed(self, module_name):
+        states = ('installed', 'to upgrade')
+        return bool(len(self.search([('name', '=', module_name),
+                                     ('state', 'in', states)])))
+
+    @api.multi
+    def write(self, values):
+        res = super(IrModuleModule, self).write(values)
+        if 'state' in values:
+            self.clear_caches()
+
+        return res

connector/producer.py

@@ -36,6 +36,7 @@
 from .event import (on_record_create,
                     on_record_write,
                     on_record_unlink)
+from .connector import is_module_installed
 
 
 create_original = models.BaseModel.create
@@ -45,7 +46,7 @@
 @openerp.api.returns('self', lambda value: value.id)
 def create(self, vals):
     record_id = create_original(self, vals)
-    if self.pool.get('connector.installed') is not None:
+    if is_module_installed(self.env, 'connector'):
         session = ConnectorSession(self.env.cr, self.env.uid,
                                    context=self.env.context)
         on_record_create.fire(session, self._name, record_id.id, vals)
@@ -59,7 +60,7 @@ def create(self, vals):
 @openerp.api.multi
 def write(self, vals):
     result = write_original(self, vals)
-    if self.pool.get('connector.installed') is not None:
+    if is_module_installed(self.env, 'connector'):
         session = ConnectorSession(self.env.cr, self.env.uid,
                                    context=self.env.context)
         if on_record_write.has_consumer_for(session, self._name):
@@ -75,7 +76,7 @@ def write(self, vals):
 
 @openerp.api.multi
 def unlink(self):
-    if self.pool.get('connector.installed') is not None:
+    if is_module_installed(self.env, 'connector'):
         session = ConnectorSession(self.env.cr, self.env.uid,
                                    context=self.env.context)
         if on_record_unlink.has_consumer_for(session, self._name):

connector/queue/model.py

@@ -515,7 +515,7 @@ def _find_or_create_channel(self, channel_path):
     @api.model
     def _register_jobs(self):
         for func in JOB_REGISTRY:
-            if not is_module_installed(self.pool, get_openerp_module(func)):
+            if not is_module_installed(self.env, get_openerp_module(func)):
                 continue
             func_name = '%s.%s' % (func.__module__, func.__name__)
             if not self.search_count([('name', '=', func_name)]):

connector/session.py

@@ -262,4 +262,4 @@ def is_module_installed(self, module_name):
         model with name ``module_name.installed`` is loaded in the
         registry.
         """
-        return is_module_installed(self.pool, module_name)
+        return is_module_installed(self.env, module_name)