[FIX] stock: fix text product label reports with special characters

Current behavior: When printing products ZPL Labels, special characters are not printed correctly. e.g. quotes become ' Steps to reproduce: - Modify a product name with special characters - Print a product label - Select ZPL Labels As the report is only rendered as text, the special characters are not dangerous and can be printed as is. opw-3684870 closes odoo#152657 Signed-off-by: Quentin Wolfs (quwo) <[email protected]>
metricwise · Feb 29, 2024 · 4c2e92d · 4c2e92d
1 parent 2d6a311
commit 4c2e92d
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 28 deletions.
diff --git a/addons/stock/report/product_label_report.py b/addons/stock/report/product_label_report.py
@@ -6,6 +6,7 @@
 from odoo import _, models
 from odoo.exceptions import UserError
 
+import markupsafe
 
 class ReportProductLabel(models.AbstractModel):
     _name = 'report.stock.label_product_product_view'
@@ -22,11 +23,43 @@ def _get_report_values(self, docids, data):
         quantity_by_product = defaultdict(list)
         for p, q in data.get('quantity_by_product').items():
             product = Product.browse(int(p))
-            quantity_by_product[product].append((product.barcode, q))
+            default_code_markup = markupsafe.Markup(product.default_code) if product.default_code else ''
+            product_info = {
+                'barcode': markupsafe.Markup(product.barcode),
+                'quantity': q,
+                'display_name_markup': markupsafe.Markup(product.display_name),
+                'default_code': (default_code_markup[:15], default_code_markup[15:30])
+            }
+            quantity_by_product[product].append(product_info)
         if data.get('custom_barcodes'):
             # we expect custom barcodes to be: {product: [(barcode, qty_of_barcode)]}
             for product, barcodes_qtys in data.get('custom_barcodes').items():
-                quantity_by_product[Product.browse(int(product))] += (barcodes_qtys)
+                product = Product.browse(int(product))
+                default_code_markup = markupsafe.Markup(product.default_code) if product.default_code else ''
+                for barcode_qty in barcodes_qtys:
+                    quantity_by_product[product].append({
+                        'barcode': markupsafe.Markup(barcode_qty[0]),
+                        'quantity': barcode_qty[1],
+                        'display_name_markup': markupsafe.Markup(product.display_name),
+                        'default_code': (default_code_markup[:15], default_code_markup[15:30])
+                    }
+                    )
         data['quantity'] = quantity_by_product
-
         return data
+
+
+class ReportLotLabel(models.AbstractModel):
+    _name = 'report.stock.label_lot_template_view'
+    _description = 'Lot Label Report'
+
+    def _get_report_values(self, docids, data):
+        lots = self.env['stock.production.lot'].browse(docids)
+        lot_list = []
+        for lot in lots:
+            lot_list.append({
+                'display_name_markup': markupsafe.Markup(lot.product_id.display_name),
+                'name': markupsafe.Markup(lot.name),
+            })
+        return {
+            'docs': lot_list,
+        }
diff --git a/addons/stock/report/product_templates.xml b/addons/stock/report/product_templates.xml
@@ -4,22 +4,21 @@
         <template id="label_product_product_view">
 		<t t-foreach="quantity.items()" t-as="barcode_and_qty_by_product">
                 <t t-set="product" t-value="barcode_and_qty_by_product[0]"/>
-                <t t-foreach="barcode_and_qty_by_product[1]" t-as="barcode_and_qty">
-                    <t t-set="barcode" t-value="barcode_and_qty[0]"/>
-                    <t t-foreach="range(barcode_and_qty[1])" t-as="qty">
+                <t t-foreach="barcode_and_qty_by_product[1]" t-as="product_info">
+                    <t t-set="barcode" t-value="product_info['barcode']"/>
+                    <t t-foreach="range(product_info['quantity'])" t-as="qty">
                         <t t-translation="off">
-^XA
-^FT100,80^A0N,40,30^FD<t t-esc="product.display_name"/>^FS
+^XA^CI28
+^FT100,80^A0N,40,30^FD<t t-out="product_info['display_name_markup']"/>^FS
 <t t-if="product.default_code and len(product.default_code) &gt; 15">
-^FT100,115^A0N,30,24^FD<t t-esc="product.default_code[:15]"/>^FS
-^FT100,150^A0N,30,24^FD<t t-esc="product.default_code[15:30]"/>^FS
+^FT100,115^A0N,30,24^FD<t t-out="product_info['default_code'][0]"/>^FS
+^FT100,150^A0N,30,24^FD<t t-out="product_info['default_code'][1]"/>^FS
 </t>
 <t t-else="">
-^FT100,150^A0N,30,24^FD<t t-esc="product.default_code"/>^FS
+^FT100,150^A0N,30,24^FD<t t-out="product_info['default_code'][0]"/>^FS
 </t>
 <t t-if="price_included">
 ^FO600,100,1
-^CI28
 <t t-if="product.currency_id.position == 'after'">
 ^A0N,66,48^FH^FD<t t-esc="product.lst_price if 'lst_price' in product else product.list_price" t-options='{"widget": "float", "precision": 2}'/><t t-esc="product.currency_id.symbol"/>^FS
 </t>
@@ -30,7 +29,7 @@
 <t t-if="barcode">
 ^FO100,160^BY3
 ^BCN,100,Y,N,N
-^FD<t t-esc="barcode"/>^FS
+^FD<t t-out="barcode"/>^FS
 </t>
 ^XZ
                         </t>
@@ -41,14 +40,14 @@
         <template id="label_lot_template_view">
             <t t-foreach="docs" t-as="lot">
                 <t t-translation="off">
-^XA
+^XA^CI28
 ^FO100,50
-^A0N,44,33^FD<t t-esc="lot.product_id.display_name"/>^FS
+^A0N,44,33^FD<t t-out="lot['display_name_markup']"/>^FS
 ^FO100,100
-^A0N,44,33^FDLN/SN: <t t-esc="lot.name"/>^FS
+^A0N,44,33^FDLN/SN: <t t-out="lot['name']"/>^FS
 ^FO100,150^BY3
 ^BCN,100,Y,N,N
-^FD<t t-esc="lot.name"/>^FS
+^FD<t t-out="lot['name']"/>^FS
 ^XZ
                 </t>
             </t>

diff --git a/addons/stock/tests/test_report.py b/addons/stock/tests/test_report.py
@@ -17,6 +17,15 @@ def setUpClass(cls):
         cls.supplier_location = cls.env['stock.location'].browse(cls.ModelDataObj._xmlid_to_res_id('stock.stock_location_suppliers'))
         cls.stock_location = cls.env['stock.location'].browse(cls.ModelDataObj._xmlid_to_res_id('stock.stock_location_stock'))
 
+        cls.product1 = cls.env['product.product'].create({
+            'name': 'Mellohi"',
+            'type': 'product',
+            'categ_id': cls.env.ref('product.product_category_all').id,
+            'tracking': 'lot',
+            'default_code': 'C4181234""154654654654',
+            'barcode': 'scan""me'
+        })
+
         product_form = Form(cls.env['product.product'])
         product_form.detailed_type = 'product'
         product_form.name = 'Product'
@@ -39,22 +48,33 @@ def get_report_forecast(self, product_template_ids=False, product_variant_ids=Fa
 
 
 class TestReports(TestReportsCommon):
+
+    def test_product_label_reports(self):
+        """ Test that all the special characters are correctly rendered for the product name, the default code and the barcode.
+            In this test we test that the double quote is rendered correctly.
+        """
+        report = self.env.ref('stock.label_product_product')
+        target = b'\n\t\t\n\n\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FDscan""me^FS\n\n^XZ\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FDscan""me^FS\n\n^XZ\n\n\n\n\n'
+        rendering, qweb_type = report._render_qweb_text(self.product1.product_tmpl_id.id, {'quantity_by_product': {self.product1.product_tmpl_id.id: 2}, 'active_model': 'product.template'})
+        self.assertEqual(target, rendering.replace(b' ', b''), 'Product name, default code or barcode is not correctly rendered, make sure the quotes are escaped correctly')
+        self.assertEqual(qweb_type, 'text', 'the report type is not good')
+
+    def test_product_label_custom_barcode_reports(self):
+        """ Test that the custom barcodes are correctly rendered with special characters."""
+        report = self.env.ref('stock.label_product_product')
+        target = b'\n\t\t\n\n\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FD123"barcode^FS\n\n^XZ\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FD123"barcode^FS\n\n^XZ\n\n\n\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FDbarcode"456^FS\n\n^XZ\n\n\n\n^XA^CI28\n^FT100,80^A0N,40,30^FD[C4181234""154654654654]Mellohi"^FS\n\n^FT100,115^A0N,30,24^FDC4181234""15465^FS\n^FT100,150^A0N,30,24^FD4654654^FS\n\n\n\n^FO100,160^BY3\n^BCN,100,Y,N,N\n^FDbarcode"456^FS\n\n^XZ\n\n\n\n\n'
+        rendering, qweb_type = report._render_qweb_text(self.product1.product_tmpl_id.id, {'custom_barcodes': {self.product1.product_tmpl_id.id: [('123"barcode', 2), ('barcode"456', 2)]}, 'quantity_by_product': {}, 'active_model': 'product.template'})
+        self.assertEqual(target, rendering.replace(b' ', b''), 'Custom barcodes are most likely not corretly rendered, make sure the quotes are escaped correctly')
+        self.assertEqual(qweb_type, 'text', 'the report type is not good')
+
     def test_reports(self):
-        product1 = self.env['product.product'].create({
-            'name': 'Mellohi',
-            'default_code': 'C418',
-            'type': 'product',
-            'categ_id': self.env.ref('product.product_category_all').id,
-            'tracking': 'lot',
-            'barcode': 'scan_me'
-        })
         lot1 = self.env['stock.production.lot'].create({
-            'name': 'Volume-Beta',
-            'product_id': product1.id,
+            'name': 'Volume-Beta"',
+            'product_id': self.product1.id,
             'company_id': self.env.company.id,
         })
         report = self.env.ref('stock.label_lot_template')
-        target = b'\n\n\n^XA\n^FO100,50\n^A0N,44,33^FD[C418]Mellohi^FS\n^FO100,100\n^A0N,44,33^FDLN/SN:Volume-Beta^FS\n^FO100,150^BY3\n^BCN,100,Y,N,N\n^FDVolume-Beta^FS\n^XZ\n\n\n'
+        target = b'\n\n\n^XA^CI28\n^FO100,50\n^A0N,44,33^FD[C4181234""154654654654]Mellohi"^FS\n^FO100,100\n^A0N,44,33^FDLN/SN:Volume-Beta"^FS\n^FO100,150^BY3\n^BCN,100,Y,N,N\n^FDVolume-Beta"^FS\n^XZ\n\n\n'
 
         rendering, qweb_type = report._render_qweb_text(lot1.id)
         self.assertEqual(target, rendering.replace(b' ', b''), 'The rendering is not good')