[19.0][MIG]: website_sale_product_brand

website_sale_product_brand/README.rst

@@ -0,0 +1,135 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+==================================
+Product Brand Filtering in Website
+==================================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:2866648306719d101a1a7e53c7797ebb0c3f171e68905bf0f627ed69f5f020f4
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/license-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%2Fe--commerce-lightgray.png?logo=github
+    :target: https://github.com/OCA/e-commerce/tree/19.0/website_sale_product_brand
+    :alt: OCA/e-commerce
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/e-commerce-19-0/e-commerce-19-0-website_sale_product_brand
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/e-commerce&target_branch=19.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module was written to extend the functionality of product filtering
+on website. It will allow you to filter product based on its brand.
+
+While shopping online, we have seen various eShops having a feature to
+shop by brands which ODOO does not yet provide officially. Website Sale
+Product Brand fills the gap at certain extent and by providing basic
+search by brands, thus reducing end-user’s efforts in searching the
+products he/she wants to purchase.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+In order to hide brands from the e-commerce:
+
+1. Go to *Website > eCommerce > Product brands*
+2. Click on the brand you want to unpublish.
+3. Click on the *Website published* smart button.
+
+Usage
+=====
+
+Shop by brand feature is available on various famous e-commerce websites
+like amazon, flipkart and many. Shop by brand feature enables you to
+display product relevant to that particular brand.
+
+To use this module, you need to:
+
+Once you install this module, user will be able to create a new brand
+and define the brand to a product.
+
+To create product brand go to *Website > Settings > Products > Product
+brands*:
+
+   - User can assign a nice logo with brand description.
+   - After configuring the brand, user can assign a particular brand to
+     a particular products.
+
+Based on this configuration, you will see the menuitem shop by brand
+next to shop menu. It will show all the brands and once you select that
+brand it will show product's which is related to this brand.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/e-commerce/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/e-commerce/issues/new?body=module:%20website_sale_product_brand%0Aversion:%2019.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
+-------
+
+* Serpent Consulting Services Pvt. Ltd.
+* Tecnativa
+
+Contributors
+------------
+
+- Jay Vora <jay.vora@serpentcs.com>
+
+- Meet Dholakia <m.dholakia.serpentcs@gmail.com>
+
+- `Tecnativa <https://www.tecnativa.com>`__:
+
+     - Ernesto Tejeda <ernesto.tejeda@tecnativa.com>
+     - Sergio Teruel <sergio.teruel@tecnativa.com>
+     - Alexandre Díaz
+     - David Vidal
+     - Carlos López
+     - Pilar Vargas
+
+- `Studio73 <https://www.studio73.es>`__:
+
+     - Alex Garcia <[alex@studio73.es]>
+
+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/e-commerce <https://github.com/OCA/e-commerce/tree/19.0/website_sale_product_brand>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

website_sale_product_brand/__init__.py

@@ -0,0 +1,5 @@
+# © 2016 Serpent Consulting Services Pvt. Ltd. (http://www.serpentcs.com)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from . import models
+from . import controllers

website_sale_product_brand/__manifest__.py

@@ -0,0 +1,36 @@
+# © 2016 Serpent Consulting Services Pvt. Ltd. (http://www.serpentcs.com)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Product Brand Filtering in Website",
+    "category": "e-commerce",
+    "author": "Serpent Consulting Services Pvt. Ltd., "
+    "Tecnativa, "
+    "Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/e-commerce",
+    "version": "19.0.1.0.0",
+    "license": "AGPL-3",
+    "depends": ["product_brand", "website_sale"],
+    "data": [
+        "security/ir.model.access.csv",
+        "data/website_menu.xml",
+        "views/product_brand.xml",
+        "views/product_brand_views.xml",
+        "views/templates.xml",
+    ],
+    "assets": {
+        "web.assets_frontend": [
+            "/website_sale_product_brand/static/src/scss/website_sale_product_brand.scss",
+            (
+                "after",
+                "website_sale/static/src/interactions/website_sale.js",
+                "/website_sale_product_brand/static/src/interactions/website_sale_brand_filter.esm.js",
+            ),
+        ],
+        "web.assets_tests": [
+            "/website_sale_product_brand/static/src/js/tour.esm.js",
+            "/website_sale_product_brand/static/src/js/test_website_sale_filter_brand.esm.js",
+        ],
+    },
+    "installable": True,
+}

website_sale_product_brand/controllers/__init__.py

@@ -0,0 +1,4 @@
+# © 2016 Serpent Consulting Services Pvt. Ltd. (http://www.serpentcs.com)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from . import main

website_sale_product_brand/controllers/main.py

@@ -0,0 +1,211 @@
+# © 2016 Serpent Consulting Services Pvt. Ltd. (http://www.serpentcs.com)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import http
+from odoo.fields import Domain
+from odoo.http import request
+
+from odoo.addons.website_sale.controllers.main import QueryURL, WebsiteSale
+
+
+class WebsiteSale(WebsiteSale):
+    def _update_domain(self, brands_list, domain):
+        selected_brand_ids = [int(brand) for brand in brands_list]
+        if brands_list:
+            for leaf in domain:
+                if leaf[0] == "product_brand_id":
+                    domain.remove(leaf)
+            domain += [("product_brand_id", "in", selected_brand_ids)]
+        return domain
+
+    def _get_brand_ids(self, req):
+        return req.getlist("brand") or req.getlist("brand_ids") or []
+
+    def _build_brands_list(
+        self,
+        selected_brand_ids,
+        search=None,
+        products=None,
+        search_products=None,
+        category=None,
+    ):
+        domain = []
+        if not products:
+            domain = [("id", "in", selected_brand_ids)]
+        elif search or category:
+            domain = [("product_ids", "in", search_products.ids)]
+        return (
+            request.env["product.brand"]
+            .sudo()
+            .search(domain)
+            .filtered(lambda x: x.is_published and x.published_products_count > 0)
+        )
+
+    def _get_shop_domain_no_brands(
+        self, search, category, attribute_value_dict, search_in_description
+    ):
+        return super()._get_shop_domain(
+            search,
+            category,
+            attribute_value_dict,
+            search_in_description=search_in_description,
+        )
+
+    def _remove_extra_brands(self, brands, search_products, attrib_values):
+        if attrib_values:
+            search_product_brands = search_products.mapped("product_brand_id")
+            brands = brands.filtered(lambda b: b.id in search_product_brands.ids)
+        # sort brands by name
+        return brands.sorted(key=lambda brand: brand.name)
+
+    def _get_search_options(
+        self,
+        category=None,
+        attribute_value_dict=None,
+        tags=None,
+        min_price=0.0,
+        max_price=0.0,
+        conversion_rate=1,
+        **post,
+    ):
+        res = super()._get_search_options(
+            category=category,
+            attribute_value_dict=attribute_value_dict,
+            tags=tags,
+            min_price=min_price,
+            max_price=max_price,
+            conversion_rate=conversion_rate,
+            **post,
+        )
+        res["brand_ids"] = request.env.context.get("brand_ids")
+        return res
+
+    def _get_shop_domain(
+        self, search, category, attribute_value_dict, search_in_description=True
+    ):
+        domain = super()._get_shop_domain(
+            search,
+            category,
+            attribute_value_dict,
+            search_in_description=search_in_description,
+        )
+        brand_ids = request.env.context.get("brand_ids") or [
+            int(b)
+            for b in (
+                request.httprequest.args.getlist("brand")
+                or request.httprequest.args.getlist("brand_ids")
+            )
+            if b and str(b).isdigit()
+        ]
+        if brand_ids:
+            domain = Domain.AND([domain, [("product_brand_id", "in", brand_ids)]])
+        return domain
+
+    @http.route(
+        [
+            "/shop",
+            "/shop/page/<int:page>",
+            '/shop/category/<model("product.public.category"):category>',
+            '/shop/category/<model("product.public.category"):category'
+            ">/page/<int:page>",  # Continue previous line
+            "/shop/brands",
+        ],
+        type="http",
+        auth="public",
+        website=True,
+    )
+    def shop(
+        self,
+        page=0,
+        category=None,
+        search="",
+        min_price=0.0,
+        max_price=0.0,
+        ppg=False,
+        brand=None,
+        **post,
+    ):
+        brands_list = self._get_brand_ids(request.httprequest.args)
+        if brands_list:
+            request.update_context(brand_ids=[int(b) for b in brands_list])
+        elif brand:
+            context = dict(request.env.context)
+            context.setdefault("brand_ids", [int(brand)])
+            request.update_context(**context)
+        res = super().shop(
+            page=page,
+            category=category,
+            search=search,
+            min_price=min_price,
+            max_price=max_price,
+            ppg=ppg,
+            brand=brand,
+            **post,
+        )
+        qcontext = getattr(res, "qcontext", None) or {}
+        attrib_values = qcontext.get("attrib_values")
+        products = qcontext.get("products")
+        if attrib_values is None or products is None:
+            return res
+        attribute_values = request.httprequest.args.getlist("attribute_values")
+        if attribute_values:
+            post["attribute_values"] = attribute_values
+        domain = self._get_shop_domain_no_brands(
+            search, category, attrib_values, search_in_description=False
+        )
+        search_products = request.env["product.template"].search(domain)
+        # build brands list
+        selected_brand_ids = [int(brand) for brand in brands_list]
+        brands = self._build_brands_list(
+            selected_brand_ids, search, products, search_products, category
+        )
+        brands = self._remove_extra_brands(brands, search_products, attrib_values)
+        # use search() domain instead of mapped() for better performance:
+        # will basically search for product's related attribute values
+        attrib_valid_ids = (
+            request.env["product.attribute.value"]
+            .search(
+                [
+                    "&",
+                    (
+                        "pav_attribute_line_ids.product_tmpl_id",
+                        "in",
+                        search_products._ids,
+                    ),
+                    ("pav_attribute_line_ids.value_ids", "!=", False),
+                ]
+            )
+            .ids
+        )
+        keep = qcontext.get("keep")
+        if keep and hasattr(keep, "args"):
+            keep.args["brand"] = brands_list
+            keep.args["brand_ids"] = selected_brand_ids
+        # assign values for usage in qweb
+        qcontext.update(
+            {
+                "brands": brands,
+                "selected_brand_ids": selected_brand_ids,
+                "attr_valid": attrib_valid_ids,
+            }
+        )
+        return res
+
+    # Method to get the brands.
+    @http.route(["/page/product_brands"], type="http", auth="public", website=True)
+    def product_brands(self, **post):
+        b_obj = request.env["product.brand"]
+        domain = [("website_published", "=", True)]
+        if post.get("search"):
+            domain += [("name", "ilike", post.get("search"))]
+        brand_rec = (
+            b_obj.sudo()
+            .search(domain)
+            .filtered(lambda x: x.published_products_count > 0)
+        )
+
+        keep = QueryURL("/page/product_brands", brand_id=[])
+        values = {"brand_rec": brand_rec, "keep": keep}
+        if post.get("search"):
+            values.update({"search": post.get("search")})
+        return request.render("website_sale_product_brand.product_brands", values)