[WIP][ADD] Module phs delivery label

Author: Michael Michot

phs_delivery_label/__init__.py

@@ -0,0 +1,3 @@
+from . import models
+
+# from . import tests

phs_delivery_label/__manifest__.py

@@ -0,0 +1,21 @@
+# Copyright 2020 Pharmasimple (https://www.pharmasimple.be)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+{
+    "name": "PHS Delivery label",
+    "category": "Delivery",
+    "summary": "Pharmasimple delivery carrier label",
+    "version": "14.0.1.0.0",
+    "author": "Pharmasimple",
+    "license": "AGPL-3",
+    "website": "https://github.com/akretion/phs-addons",
+    "depends": [
+        "base",
+        "delivery",
+    ],
+    "data": [
+        "views/report_label.xml",
+        "report/phs_label_reports.xml",
+    ],
+    "installable": True,
+    "application": False,
+}

phs_delivery_label/models/__init__.py

@@ -0,0 +1,3 @@
+from . import delivery_carrier
+from . import stock_picking
+from . import stock_quant_package

phs_delivery_label/models/delivery_carrier.py

@@ -0,0 +1,37 @@
+from odoo import fields, models
+
+
+class DeliveryCarrier(models.Model):
+    """ Add service group """
+
+    _inherit = "delivery.carrier"
+
+    delivery_type = fields.Selection(
+        selection_add=[("pharmasimple", "Pharmasimple")],
+        ondelete={"pharmasimple": "set default"},
+    )
+
+    pharmasimple_default_packaging_id = fields.Many2one(
+        "product.packaging", domain=[("package_carrier_type", "=", "pharmasimple")]
+    )
+
+    def pharmasimple_rate_shipment(self, order):
+        self.ensure_one()
+        delivery_product_price = self.product_id and self.product_id.lst_price or 0
+        return {
+            "success": True,
+            "price": delivery_product_price,
+            "error_message": False,
+            "warning_message": False,
+        }
+
+    def pharmasimple_send_shipping(self, pickings):
+        """
+        It will generate the labels for all the packages of the picking.
+        Packages are mandatory in this case
+        """
+        for pick in pickings:
+            pick._set_a_default_package()
+            pick._generate_pharmasimple_label()
+
+        return [{"exact_price": False, "tracking_number": False}]

phs_delivery_label/models/stock_picking.py

@@ -0,0 +1,191 @@
+import base64
+import re
+from operator import attrgetter
+
+from odoo import exceptions, models
+
+_compile_itemid = re.compile(r"[^0-9A-Za-z+\-_]")
+
+
+class StockPicking(models.Model):
+    _inherit = "stock.picking"
+
+    def get_shipping_label_values(self, label):
+        self.ensure_one()
+        return {
+            "name": label["name"],
+            "res_id": self.id,
+            "res_model": "stock.picking",
+            "datas": label["file"],
+            "file_type": label["file_type"],
+        }
+
+    def _set_a_default_package(self):
+        """Pickings using this module must have a package
+        If not this method put it one silently
+        """
+        for picking in self:
+            move_lines = picking.move_line_ids.filtered(
+                lambda s: not (s.package_id or s.result_package_id)
+            )
+            if move_lines:
+                carrier = picking.carrier_id
+                default_packaging = carrier.pharmasimple_default_packaging_id
+                package = self.env["stock.quant.package"].create(
+                    {
+                        "packaging_id": default_packaging
+                        and default_packaging.id
+                        or False
+                    }
+                )
+                move_lines.write({"result_package_id": package.id})
+
+    def _get_packages_from_picking(self):
+        """ Get all the packages from the picking """
+        self.ensure_one()
+        operation_obj = self.env["stock.move.line"]
+        operations = operation_obj.search(
+            [
+                "|",
+                ("package_id", "!=", False),
+                ("result_package_id", "!=", False),
+                ("picking_id", "=", self.id),
+            ]
+        )
+        package_ids = set()
+        for operation in operations:
+            # Take the destination package. If empty, the package is
+            # moved so take the source one.
+            package_ids.add(operation.result_package_id.id or operation.package_id.id)
+
+        packages = self.env["stock.quant.package"].browse(package_ids)
+        return packages
+
+    def info_from_label(self, label):
+        data = base64.b64decode(label["binary"])
+
+        return {
+            "file": data,
+            "file_type": label["file_type"],
+            "name": "1234" + "." + label["file_type"],
+        }
+
+    def write_tracking_number_label(self, label_result, packages):
+        """
+        If there are no pack defined, write tracking_number on picking
+        otherwise, write it on parcel_tracking field of each pack.
+        Note we can receive multiple labels for a same package
+        """
+
+        labels = []
+
+        # It could happen that no successful label has been returned by the API
+        if not label_result:
+            return labels
+
+        if not packages:
+            label = label_result[0]["value"][0]
+            self.carrier_tracking_ref = label["tracking_number"]
+            labels.append(self.info_from_label(label))
+
+        tracking_refs = []
+        for package in packages:
+            tracking_numbers = []
+            for label in label_result:
+                for label_value in label["value"]:
+                    if package.name in label_value["item_id"].split("+")[-1]:
+                        tracking_numbers.append(label_value["tracking_number"])
+                        labels.append(self.info_from_label(label_value))
+            package.parcel_tracking = "; ".join(tracking_numbers)
+            tracking_refs += tracking_numbers
+
+        existing_tracking_ref = (
+            self.carrier_tracking_ref and self.carrier_tracking_ref.split("; ") or []
+        )
+        self.carrier_tracking_ref = "; ".join(existing_tracking_ref + tracking_refs)
+        return labels
+
+    def _get_itemid(self, picking, pack_no):
+        """Allowed characters are alphanumeric plus `+`, `-` and `_`
+        Last `+` separates picking name and package number (if any)
+
+        :return string: itemid
+
+        """
+        name = _compile_itemid.sub("", picking.name)
+        if not pack_no:
+            return name
+
+        pack_no = _compile_itemid.sub("", pack_no)
+        codes = [name, pack_no]
+        return "+".join(c for c in codes if c)
+
+    def generate_label(self, picking, packages):
+        results = []
+
+        for package in packages:
+            file_type = "pdf"
+            pdf, pdf_format = (
+                self.env.ref("phs_delivery_label.phs_delivery_label_report")
+                .sudo()
+                ._render_qweb_pdf(picking.ids)
+            )
+            # binary = base64.b64encode(bytes(pdf, "utf-8"))
+            binary = pdf
+            res = {"value": []}
+            res["success"] = True
+            res["value"].append(
+                {
+                    "item_id": self._get_itemid(
+                        picking, package.name if package else None
+                    ),
+                    "binary": binary,
+                    "tracking_number": "1234",
+                    "file_type": file_type,
+                }
+            )
+            results.append(res)
+        return results
+
+    def _generate_pharmasimple_label(self, package_ids=None):
+        """ Generate labels """
+        self.ensure_one()
+
+        if package_ids is None:
+            packages = self._get_packages_from_picking()
+            packages = packages.sorted(key=attrgetter("name"))
+        else:
+            # restrict on the provided packages
+            package_obj = self.env["stock.quant.package"]
+            packages = package_obj.browse(package_ids)
+
+        # Do not generate label for packages that are already done
+        packages = packages.filtered(lambda p: not p.parcel_tracking)
+
+        label_results = self.generate_label(self, packages)
+
+        # Process the success packages first
+        success_label_results = [
+            label for label in label_results if "errors" not in label
+        ]
+        failed_label_results = [label for label in label_results if "errors" in label]
+
+        # Case when there is a failed label, rollback odoo data
+        if failed_label_results:
+            self._cr.rollback()
+
+        labels = self.write_tracking_number_label(success_label_results, packages)
+
+        if failed_label_results:
+            # Commit the change to save the changes,
+            # This ensures the label pushed recored correctly in Odoo
+            self._cr.commit()  # pylint: disable=invalid-commit
+            error_message = "\n".join(label["errors"] for label in failed_label_results)
+            raise exceptions.Warning(error_message)
+
+        return labels
+
+    def generate_pharmasimple_shipping_labels(self, package_ids=None):
+        """ Add label generation for Pharmasimple """
+        self.ensure_one()
+        return self._generate_pharmasimple_label(package_ids=package_ids)

phs_delivery_label/models/stock_quant_package.py

@@ -0,0 +1,11 @@
+from odoo import fields, models
+
+
+class StockQuantPackage(models.Model):
+    _inherit = "stock.quant.package"
+
+    parcel_tracking = fields.Char("Parcel Tracking")
+    package_carrier_type = fields.Selection(
+        related="packaging_id.package_carrier_type",
+        string="Packaging's Carrier",
+    )

phs_delivery_label/report/phs_label_reports.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<openerp>
+    <data>
+
+        <record id="phs_delivery_label_report" model="ir.actions.report">
+            <field name="name">Phs delivery label</field>
+            <field name="model">stock.picking</field>
+            <field name="report_type">qweb-pdf</field>
+            <field
+                name="report_name"
+            >phs_delivery_label.report_pharmasimple_label</field>
+            <field
+                name="report_file"
+            >phs_delivery_label.report_pharmasimple_label</field>
+            <field name="print_report_name">(object._get_report_base_filename())</field>
+            <field name="attachment">(object.name+'.pdf')</field>
+            <field name="binding_model_id" ref="model_stock_picking" />
+            <field name="binding_type">report</field>
+        </record>
+
+        <record id="paperformat_pharmasimple_label" model="report.paperformat">
+            <field name="name">Pharmasimple Paper Format</field>
+            <field name="default" eval="True" />
+            <field name="format">custom</field>
+            <field name="page_height">150</field>
+            <field name="page_width">100</field>
+            <field name="orientation">Portrait</field>
+            <field name="margin_top">4</field>
+            <field name="margin_bottom">1</field>
+            <field name="margin_left">1</field>
+            <field name="margin_right">1</field>
+            <field name="header_line" eval="False" />
+            <field name="header_spacing">0</field>
+            <field name="dpi">90</field>
+            <field
+                name="report_ids"
+                eval="[(6,0,[ref('phs_delivery_label.phs_delivery_label_report')])]"
+            />
+        </record>
+
+    </data>
+</openerp>