[14.0][MIG] connector

connector/README.rst

@@ -0,0 +1,143 @@
+=========
+Connector
+=========
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fconnector-lightgray.png?logo=github
+    :target: https://github.com/OCA/connector/tree/13.0/connector
+    :alt: OCA/connector
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/connector-13-0/connector-13-0-connector
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/102/13.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This is a framework designed to build connectors with external systems,
+usually called ``Backends`` in the documentation.
+
+Documentation: http://odoo-connector.com
+
+It features:
+
+* A jobs queue
+
+    In which the connectors can push functions (synchronization tasks)
+    to be executed later.
+
+* An event pattern
+
+    The connectors can subscribe listener functions on the events,
+    executed when the events are fired.
+
+* Connector base classes
+
+    Called ``ConnectorUnit``.
+
+    Include base classes for the use in connectors, ready to be extended:
+
+    * ``Synchronizer``: flow of an import or export
+    * ``Mapper``: transform a record according to mapping rules
+    * ``Binder``: link external IDs with local IDS
+    * ``BackendAdapter``: adapter interface for the exchanges with the backend
+    * But ``ConnectorUnit`` can be extended to accomplish any task
+
+* A multi-backend support
+
+    Each ``ConnectorUnit`` can be registered amongst a backend type (eg.
+    Magento) and a backend version (allow to have a different ``Mapper``
+    for each backend's version for instance)
+
+It is used for example used to connect Magento_ and Prestashop_, but
+also used with Solr, CMIS, ...
+
+.. _Magento: http://odoo-magento-connector.com
+.. _Prestashop: https://github.com/OCA/connector-prestashop
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+This module does nothing on its own.  It is a ground for developing
+advanced connector modules. For further information, please go on:
+http://odoo-connector.com
+
+Changelog
+=========
+
+.. [ The change log. The goal of this file is to help readers
+    understand changes between version. The primary audience is
+    end users and integrators. Purely technical changes such as
+    code refactoring must not be mentioned here.
+
+    This file may contain ONE level of section titles, underlined
+    with the ~ (tilde) character. Other section markers are
+    forbidden and will likely break the structure of the README.rst
+    or other documents where this fragment is included. ]
+
+Next
+~~~~
+
+12.0.1.0.0 (2018-11-26)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* [MIGRATION] from 12.0 branched at rev. 324e006
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/connector/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/connector/issues/new?body=module:%20connector%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Camptocamp
+* Openerp Connector Core Editors
+
+Contributors
+~~~~~~~~~~~~
+
+Read the `contributors list`_
+
+.. _contributors list: ./AUTHORS
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/connector <https://github.com/OCA/connector/tree/13.0/connector>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

connector/__init__.py

@@ -0,0 +1,2 @@
+from . import components
+from . import models

connector/__manifest__.py

@@ -0,0 +1,18 @@
+# Copyright 2013 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+{
+    "name": "Connector",
+    "version": "14.0.1.0.0",
+    "author": "Camptocamp,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/connector",
+    "license": "LGPL-3",
+    "category": "Generic Modules",
+    "depends": ["mail", "queue_job", "component", "component_event"],
+    "data": [
+        "security/connector_security.xml",
+        "views/connector_menu.xml",
+        "views/res_partner_views.xml",
+    ],
+    "installable": True,
+}

connector/components/__init__.py

@@ -0,0 +1,7 @@
+from . import core
+from . import backend_adapter
+from . import binder
+from . import mapper
+from . import listener
+from . import locker
+from . import synchronizer

connector/components/backend_adapter.py

@@ -0,0 +1,64 @@
+# Copyright 2013 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+"""
+
+Backend Adapter
+===============
+
+An external adapter has a common interface to speak with the backend.
+It translates the basic orders (search, read, write) to the protocol
+used by the backend.
+
+"""
+
+from odoo.addons.component.core import AbstractComponent
+
+
+class BackendAdapter(AbstractComponent):
+    """ Base Backend Adapter for the connectors """
+
+    _name = "base.backend.adapter"
+    _inherit = "base.connector"
+    _usage = "backend.adapter"
+
+
+# pylint: disable=W8106
+class CRUDAdapter(AbstractComponent):
+    """Base External Adapter specialized in the handling
+    of records on external systems.
+
+    This is an empty shell, Components can inherit and implement their own
+    implementation for the methods.
+
+    """
+
+    _name = "base.backend.adapter.crud"
+    _inherit = "base.backend.adapter"
+    _usage = "backend.adapter"
+
+    def search(self, *args, **kwargs):
+        """Search records according to some criterias
+        and returns a list of ids"""
+        raise NotImplementedError
+
+    def read(self, *args, **kwargs):
+        """ Returns the information of a record """
+        raise NotImplementedError
+
+    def search_read(self, *args, **kwargs):
+        """Search records according to some criterias
+        and returns their information"""
+        raise NotImplementedError
+
+    def create(self, *args, **kwargs):
+        """ Create a record on the external system """
+        raise NotImplementedError
+
+    def write(self, *args, **kwargs):
+        """ Update records on the external system """
+        raise NotImplementedError
+
+    def delete(self, *args, **kwargs):
+        """ Delete a record on the external system """
+        raise NotImplementedError

connector/components/binder.py

@@ -0,0 +1,148 @@
+# Copyright 2013 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+"""
+Binders
+=======
+
+Binders are components that know how to find the external ID for an
+Odoo ID, how to find the Odoo ID for an external ID and how to
+create the binding between them.
+
+"""
+
+from odoo import fields, models, tools
+
+from odoo.addons.component.core import AbstractComponent
+
+
+class Binder(AbstractComponent):
+    """For one record of a model, capable to find an external or
+    internal id, or create the binding (link) between them
+
+    This is a default implementation that can be inherited or reimplemented
+    in the connectors.
+
+    This implementation assumes that binding models are ``_inherits`` of
+    the models they are binding.
+
+    """
+
+    _name = "base.binder"
+    _inherit = "base.connector"
+    _usage = "binder"
+
+    _external_field = "external_id"  # override in sub-classes
+    _backend_field = "backend_id"  # override in sub-classes
+    _odoo_field = "odoo_id"  # override in sub-classes
+    _sync_date_field = "sync_date"  # override in sub-classes
+
+    def to_internal(self, external_id, unwrap=False):
+        """Give the Odoo recordset for an external ID
+
+        :param external_id: external ID for which we want
+                            the Odoo ID
+        :param unwrap: if True, returns the normal record
+                       else return the binding record
+        :return: a recordset, depending on the value of unwrap,
+                 or an empty recordset if the external_id is not mapped
+        :rtype: recordset
+        """
+        bindings = self.model.with_context(active_test=False).search(
+            [
+                (self._external_field, "=", tools.ustr(external_id)),
+                (self._backend_field, "=", self.backend_record.id),
+            ]
+        )
+        if not bindings:
+            if unwrap:
+                return self.model.browse()[self._odoo_field]
+            return self.model.browse()
+        bindings.ensure_one()
+        if unwrap:
+            bindings = bindings[self._odoo_field]
+        return bindings
+
+    def to_external(self, binding, wrap=False):
+        """Give the external ID for an Odoo binding ID
+
+        :param binding: Odoo binding for which we want the external id
+        :param wrap: if True, binding is a normal record, the
+                     method will search the corresponding binding and return
+                     the external id of the binding
+        :return: external ID of the record
+        """
+        if isinstance(binding, models.BaseModel):
+            binding.ensure_one()
+        else:
+            binding = self.model.browse(binding)
+        if wrap:
+            binding = self.model.with_context(active_test=False).search(
+                [
+                    (self._odoo_field, "=", binding.id),
+                    (self._backend_field, "=", self.backend_record.id),
+                ]
+            )
+            if not binding:
+                return None
+            binding.ensure_one()
+            return binding[self._external_field]
+        return binding[self._external_field]
+
+    def bind(self, external_id, binding):
+        """Create the link between an external ID and an Odoo ID
+
+        :param external_id: external id to bind
+        :param binding: Odoo record to bind
+        :type binding: int
+        """
+        # Prevent False, None, or "", but not 0
+        assert (
+            external_id or external_id == 0
+        ) and binding, "external_id or binding missing, " "got: %s, %s" % (
+            external_id,
+            binding,
+        )
+        # avoid to trigger the export when we modify the `external_id`
+        now_fmt = fields.Datetime.now()
+        if isinstance(binding, models.BaseModel):
+            binding.ensure_one()
+        else:
+            binding = self.model.browse(binding)
+        binding.with_context(connector_no_export=True).write(
+            {
+                self._external_field: tools.ustr(external_id),
+                self._sync_date_field: now_fmt,
+            }
+        )
+
+    def unwrap_binding(self, binding):
+        """For a binding record, gives the normal record.
+
+        Example: when called with a ``magento.product.product`` id,
+        it will return the corresponding ``product.product`` id.
+
+        :param browse: when True, returns a browse_record instance
+                       rather than an ID
+        """
+        if isinstance(binding, models.BaseModel):
+            binding.ensure_one()
+        else:
+            binding = self.model.browse(binding)
+
+        return binding[self._odoo_field]
+
+    def unwrap_model(self):
+        """For a binding model, gives the normal model.
+
+        Example: when called on a binder for ``magento.product.product``,
+        it will return ``product.product``.
+        """
+        try:
+            column = self.model._fields[self._odoo_field]
+        except KeyError:
+            raise ValueError(
+                "Cannot unwrap model %s, because it has no %s fields"
+                % (self.model._name, self._odoo_field)
+            )
+        return column.comodel_name