[ADD] stock_location_product_restriction: Prevent to mix different products into the same stock location

Author: lmignon

stock_location_product_restriction/README.rst

@@ -0,0 +1,100 @@
+==================================
+Stock Location Product Restriction
+==================================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! 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-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fstock--logistics--warehouse-lightgray.png?logo=github
+    :target: https://github.com/OCA/stock-logistics-warehouse/tree/10.0/stock_location_product_restriction
+    :alt: OCA/stock-logistics-warehouse
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/stock-logistics-warehouse-10-0/stock-logistics-warehouse-10-0-stock_location_product_restriction
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/153/10.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module extends the functionality of stock to allow you to prevent to put
+items of different products into the same stock location.
+
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+By default, Odoo allows you to put items of any product into the same location.
+This behaviour remains the one by default once the addon is installed.
+Once installed, you can specify at any level of the stock location hierarchy
+if you want to restrict the usage of the location to only items of the same
+product. This property is inherited by all the children locations while you
+don't specify an other specific value on a child location. The constrains only
+applies location by location.
+
+Once a location is configured to only contains items of the same product, the
+system will prevent you to move items of any others products into a location
+that already contains product items. A new filter into the tree view of the
+stock locations will also allow you to find all the location where this new
+restriction is violated.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/stock-logistics-warehouse/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/stock-logistics-warehouse/issues/new?body=module:%20stock_location_product_restriction%0Aversion:%2010.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
+~~~~~~~
+
+* ACSONE SA/NV
+
+Contributors
+~~~~~~~~~~~~
+
+* Laurent Mignon <laurent.mignon@acsone.eu> (https://www.acsone.eu/)
+
+Other credits
+~~~~~~~~~~~~~
+
+The development of this module has been financially supported by:
+
+* ACSONE SA/NV
+* Alcyon Benelux
+
+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/stock-logistics-warehouse <https://github.com/OCA/stock-logistics-warehouse/tree/10.0/stock_location_product_restriction>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

stock_location_product_restriction/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from .hooks import pre_init_hook

stock_location_product_restriction/__manifest__.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Stock Location Product Restriction",
+    "summary": """
+        Prevent to mix different products into the same stock location""",
+    "version": "10.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
+    "website": "https://acsone.eu/",
+    "depends": ["stock"],
+    "data": ["views/stock_location.xml"],
+    "demo": [],
+    "pre_init_hook": "pre_init_hook",
+}

stock_location_product_restriction/hooks.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+import logging
+
+_logger = logging.getLogger(__name__)
+
+
+def column_exists(cr, tablename, columnname):
+    """ Return whether the given column exists. """
+    query = """ SELECT 1 FROM information_schema.columns
+                WHERE table_name=%s AND column_name=%s """
+    cr.execute(query, (tablename, columnname))
+    return cr.rowcount
+
+
+def pre_init_hook(cr):
+    _logger.info("Initialize product_restriction on table stock_location")
+    if not column_exists(cr, "stock_location", "product_restriction"):
+        cr.execute(
+            """
+            ALTER TABLE stock_location
+                ADD COLUMN product_restriction character varying;
+            ALTER TABLE stock_location
+                ADD COLUMN parent_product_restriction character varying;
+        """
+        )
+    cr.execute(
+        """
+        UPDATE stock_location set product_restriction = 'any';
+        UPDATE stock_location set parent_product_restriction = 'any'
+        where location_id is not null;
+    """
+    )

stock_location_product_restriction/models/__init__.py

@@ -0,0 +1,2 @@
+from . import stock_location
+from . import stock_move

stock_location_product_restriction/models/stock_location.py

@@ -0,0 +1,141 @@
+# -*- coding: utf-8 -*-
+# Copyright 2020 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import api, fields, models, _
+from odoo.osv.expression import NEGATIVE_TERM_OPERATORS
+
+
+class StockLocation(models.Model):
+
+    _inherit = "stock.location"
+
+    product_restriction = fields.Selection(
+        string="Product restriction",
+        selection="_selection_product_restriction",
+        help="If 'Same product' is selected the system will prevent to put "
+        "items of different products into the same location.",
+        index=True,
+        required=True,
+        compute="_compute_product_restriction",
+        store=True,
+        default="any",
+    )
+
+    specific_product_restriction = fields.Selection(
+        string="Specific product restriction",
+        selection="_selection_product_restriction",
+        help="If specified the restriction specified will apply to "
+        "the current location and all its children",
+        default=False,
+    )
+
+    parent_product_restriction = fields.Selection(
+        selection="_selection_product_restriction",
+        store=True,
+        readonly=True,
+        related="location_id.product_restriction",
+    )
+
+    has_restriction_violation = fields.Boolean(
+        compute="_compute_restriction_violation",
+        search="_search_has_restriction_violation",
+    )
+
+    restriction_violation_message = fields.Char(
+        compute="_compute_restriction_violation"
+    )
+
+    @api.model
+    def _selection_product_restriction(self):
+        return [
+            ("any", "Items of any products are allowed into the location"),
+            (
+                "same",
+                "Only items of the same product allowed into the location",
+            ),
+        ]
+
+    @api.depends("specific_product_restriction", "parent_product_restriction")
+    def _compute_product_restriction(self):
+        default_value = "any"
+        for rec in self:
+            rec.product_restriction = (
+                rec.specific_product_restriction
+                or rec.parent_product_restriction
+                or default_value
+            )
+
+    @api.depends("product_restriction")
+    def _compute_restriction_violation(self):
+        records = self
+        if self.env.in_onchange:
+            records = self._origin
+        if not records:
+            # case where the compute is called from the create form
+            return
+        ProductProduct = self.env["product.product"]
+        SQL = """
+           SELECT
+               stock_quant.location_id,
+               array_agg(distinct(product_id))
+           FROM
+               stock_quant,
+               stock_location
+           WHERE
+               stock_quant.location_id in %s
+               and stock_location.id = stock_quant.location_id
+               and stock_location.product_restriction = 'same'
+           GROUP BY
+               stock_quant.location_id
+            HAVING count(distinct(product_id)) > 1
+       """
+        self.env.cr.execute(SQL, (tuple(records.ids),))
+        product_ids_by_location_id = dict(self.env.cr.fetchall())
+        for record in self:
+            record_id = record.id
+            if self.env.in_onchange:
+                record_id = self._origin.id
+            has_restriction_violation = False
+            restriction_violation_message = False
+            product_ids = product_ids_by_location_id.get(record_id)
+            if product_ids:
+                products = ProductProduct.browse(product_ids)
+                has_restriction_violation = True
+                restriction_violation_message = _(
+                    "This location should only contain items of the same "
+                    "product but it contains items of products %s"
+                ) % " | ".join(products.mapped("name"))
+            record.has_restriction_violation = has_restriction_violation
+            record.restriction_violation_message = (
+                restriction_violation_message
+            )
+
+    def _search_has_restriction_violation(self, operator, value):
+        search_has_violation = (
+            # has_restriction_violation != False
+            (operator in NEGATIVE_TERM_OPERATORS and not value)
+            or
+            # has_restriction_violation = True
+            (operator not in NEGATIVE_TERM_OPERATORS and value)
+        )
+        SQL = """
+            SELECT
+                stock_quant.location_id
+            FROM
+               stock_quant,
+               stock_location
+            WHERE
+               stock_location.id = stock_quant.location_id
+               and stock_location.product_restriction = 'same'
+            GROUP BY
+               stock_quant.location_id
+            HAVING count(distinct(product_id)) > 1
+        """
+        self.env.cr.execute(SQL)
+        violation_ids = [r[0] for r in self.env.cr.fetchall()]
+        if search_has_violation:
+            op = "in"
+        else:
+            op = "not in"
+        return [("id", op, violation_ids)]