Merge lp:~camptocamp/carriers-deliveries/7.0-delivery_carrier_label_dispatch-output-file-yvr into lp:~stock-logistic-core-editors/carriers-deliveries/7.0

[Yannick Vaucher @ Camptocamp]

[Leonardo Pistone (lepistone)]

Hi Yannick,

#file_type='pdf'

is meant to be commented out?

I approve in any case because you are not really changing that line, justing indenting it a little :)

review: Approve (code review)

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

I have some work on my side on the same part of the code. I will merge your changes in my own branch because they will conflict a lot otherwise. I put your branch as WIP just to avoid people reviewing it meanwhile.

[Yannick Vaucher @ Camptocamp (yvaucher-c2c)]

Merged Guewen's work

[Yannick Vaucher @ Camptocamp (yvaucher-c2c)]

Resolved conflicts Needs reviews

[lp:~camptocamp/carriers-deliveries/7.0-delivery_carrier_label_dispatch-output-file-yvr]

21. By Yannick Vaucher @ Camptocamp on 2014-03-31

Add better exception message from dispatch to identify the pack with an error

22. By Yannick Vaucher @ Camptocamp on 2014-04-10

update pot file

[Yannick Vaucher @ Camptocamp (yvaucher-c2c)]

This project is now hosted on https://github.com/OCA/carriers-deliveries. Please move your proposal there if you still want to merge it once fixed. This guide may help you https://github.com/OCA/maintainers-tools/wiki/How-to-move-a-Merge-Proposal-to-GitHub

Unmerged revisions

22. By Yannick Vaucher @ Camptocamp on 2014-04-10

update pot file

21. By Yannick Vaucher @ Camptocamp on 2014-03-31

Add better exception message from dispatch to identify the pack with an error

20. By Yannick Vaucher @ Camptocamp on 2014-03-28

merge main branch to resolve conflicts

19. By Yannick Vaucher @ Camptocamp on 2014-03-28

add file extension in file name for poor OS

18. By Yannick Vaucher @ Camptocamp on 2014-03-27

fix generation of picking shipping labels from picking dispatch when there are no pack defined in the pickings

17. By Guewen Baconnier @ Camptocamp on 2014-02-24

use the general method and not the one for the button

avoid utils.PdfReadError('Cannot read an empty file') error

16. By Yannick Vaucher @ Camptocamp on 2014-01-21

[FIX] delivery_carrier_label_dispatch - save picking dispatch label pdf file as attachement of the picking

=== modified file 'delivery_carrier_label_dispatch/__init__.py'
--- delivery_carrier_label_dispatch/__init__.py	2014-01-09 13:54:55 +0000
+++ delivery_carrier_label_dispatch/__init__.py	2014-04-10 14:10:35 +0000
@@ -18,6 +18,5 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 ##############################################################################
-from . import stock
 from . import picking_dispatch
 from . import wizard

=== modified file 'delivery_carrier_label_dispatch/__openerp__.py'
--- delivery_carrier_label_dispatch/__openerp__.py	2014-01-09 13:54:55 +0000
+++ delivery_carrier_label_dispatch/__openerp__.py	2014-04-10 14:10:35 +0000
@@ -29,8 +29,13 @@
 [Link module] Carrier labels - Picking dispatch
 ==============================
 
-This module adds a wizard on picking dispatch to generate related picking
-labels
+This module adds a wizard on picking dispatch to generate the labels
+of the packs. The labels are merged in one PDF file.
+
+If you want multiple labels for one picking, all the moves should have been
+put in a pack before the labels can be printed.
+
+If you don't define your pack it will be considered a picking is a single pack.
 
 Contributors
 ------------

=== modified file 'delivery_carrier_label_dispatch/i18n/delivery_carrier_label_dispatch.pot'
--- delivery_carrier_label_dispatch/i18n/delivery_carrier_label_dispatch.pot	2014-01-09 13:54:55 +0000
+++ delivery_carrier_label_dispatch/i18n/delivery_carrier_label_dispatch.pot	2014-04-10 14:10:35 +0000
@@ -6,58 +6,75 @@
 msgstr ""
 "Project-Id-Version: OpenERP Server 7.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-01-09 13:29+0000\n"
-"PO-Revision-Date: 2014-01-09 14:30+0100\n"
-"Last-Translator: Yannick Vaucher <[e-mail]>\n"
+"POT-Creation-Date: 2014-04-10 14:03+0000\n"
+"PO-Revision-Date: 2014-04-10 14:03+0000\n"
+"Last-Translator: <>\n"
 "Language-Team: \n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
+"Content-Transfer-Encoding: \n"
 "Plural-Forms: \n"
 
 #. module: delivery_carrier_label_dispatch
+#: model:ir.model.fields,field_description:delivery_carrier_label_dispatch.field_picking_dispatch_carrier_id
+#: field:picking.dispatch,carrier_id:0
+msgid "Carrier"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
 #: view:picking.dispatch:0
 msgid "Carrier Info"
 msgstr ""
 
 #. module: delivery_carrier_label_dispatch
+#: view:delivery.carrier.label.generate:0
+msgid "Close"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: view:picking.dispatch:0
+msgid "Delivery"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: code:_description:0
+#: model:ir.model,name:delivery_carrier_label_dispatch.model_picking_dispatch
+#, python-format
+msgid "Dispatch Picking Order"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
 #: model:ir.actions.act_window,name:delivery_carrier_label_dispatch.action_delivery_carrier_label_generate
 msgid "Generate Carrier Labels"
 msgstr ""
 
 #. module: delivery_carrier_label_dispatch
-#: model:ir.model,name:delivery_carrier_label_dispatch.model_stock_picking
-msgid "Picking List"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: code:addons/delivery_carrier_label_dispatch/picking_dispatch.py:100
-#, python-format
-msgid ""
-"You can not remove a mandatory option.\n"
-"Options are reset to default."
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: model:ir.model,name:delivery_carrier_label_dispatch.model_picking_dispatch
-msgid "Dispatch Picking Order"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
+#: view:delivery.carrier.label.generate:0
+msgid "Generate Carriers Labels"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: view:delivery.carrier.label.generate:0
+msgid "Generate Labels"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: field:delivery.carrier.label.generate,generate_new_labels:0
+#: model:ir.model.fields,field_description:delivery_carrier_label_dispatch.field_delivery_carrier_label_generate_generate_new_labels
+msgid "Generate new labels"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: help:delivery.carrier.label.generate,generate_new_labels:0
+msgid "If this option is used, new labels will be generated for the packs even if they already have one.\n"
+"The default is to use the existing label."
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: model:ir.model.fields,field_description:delivery_carrier_label_dispatch.field_picking_dispatch_option_ids
 #: view:picking.dispatch:0
-msgid "Delivery"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: code:addons/delivery_carrier_label_dispatch/wizard/generate_labels.py:58
-#, python-format
-msgid "No picking dispatch selected"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: field:delivery.carrier.label.generate,label_pdf_file:0
-#: model:ir.model.fields,field_description:delivery_carrier_label_dispatch.field_delivery_carrier_label_generate_label_pdf_file
-msgid "Labels file"
+#: field:picking.dispatch,option_ids:0
+msgid "Options"
 msgstr ""
 
 #. module: delivery_carrier_label_dispatch
@@ -67,71 +84,35 @@
 msgstr ""
 
 #. module: delivery_carrier_label_dispatch
+#: code:_description:0
+#: model:ir.model,name:delivery_carrier_label_dispatch.model_stock_picking
+#, python-format
+msgid "Picking List"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: view:picking.dispatch:0
+msgid "Set Options"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: view:delivery.carrier.label.generate:0
+msgid "This wizard creates an attachement on each selected dispatch containing picking labels"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: view:picking.dispatch:0
+msgid "Warning, setting options will erase existing ones in pickings"
+msgstr ""
+
+#. module: delivery_carrier_label_dispatch
+#: code:_description:0
 #: model:ir.model,name:delivery_carrier_label_dispatch.model_delivery_carrier_label_generate
+#, python-format
 msgid "delivery.carrier.label.generate"
 msgstr ""
 
 #. module: delivery_carrier_label_dispatch
-#: view:picking.dispatch:0
-msgid "Set Options"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: model:ir.model.fields,field_description:delivery_carrier_label_dispatch.field_picking_dispatch_carrier_id
-#: field:picking.dispatch,carrier_id:0
-msgid "Carrier"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: code:addons/delivery_carrier_label_dispatch/wizard/generate_labels.py:58
-#, python-format
-msgid "Error"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: view:picking.dispatch:0
-msgid "Warning, setting options will erase existing ones in pickings"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: model:ir.model.fields,field_description:delivery_carrier_label_dispatch.field_picking_dispatch_option_ids
-#: view:picking.dispatch:0
-#: field:picking.dispatch,option_ids:0
-msgid "Options"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: view:delivery.carrier.label.generate:0
-msgid "Generate Labels"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: view:delivery.carrier.label.generate:0
-msgid "Labels"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: view:delivery.carrier.label.generate:0
-msgid "Generate Carriers Labels"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: view:delivery.carrier.label.generate:0
-msgid "Close"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: code:addons/delivery_carrier_label_dispatch/picking_dispatch.py:99
-#, python-format
-msgid "User Error !"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
-#: model:ir.model,name:delivery_carrier_label_dispatch.model_stock_picking_out
-msgid "Delivery Orders"
-msgstr ""
-
-#. module: delivery_carrier_label_dispatch
 #: view:delivery.carrier.label.generate:0
 msgid "or"
 msgstr ""

=== modified file 'delivery_carrier_label_dispatch/pdf_utils.py'
--- delivery_carrier_label_dispatch/pdf_utils.py	2013-12-17 07:55:56 +0000
+++ delivery_carrier_label_dispatch/pdf_utils.py	2014-04-10 14:10:35 +0000
@@ -39,6 +39,8 @@
 
     output = PdfFileWriter()
     for pdf in pdf_list:
+        if not pdf:
+            continue
         reader = PdfFileReader(StringIO(pdf))
 
         for page in range(reader.getNumPages()):

=== removed file 'delivery_carrier_label_dispatch/stock.py'
--- delivery_carrier_label_dispatch/stock.py	2013-12-17 07:42:04 +0000
+++ delivery_carrier_label_dispatch/stock.py	1970-01-01 00:00:00 +0000
@@ -1,62 +0,0 @@
-# -*- coding: utf-8 -*-
-##############################################################################
-#
-#    Author: Yannick Vaucher
-#    Copyright 2013 Camptocamp SA
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU Affero General Public License as
-#    published by the Free Software Foundation, either version 3 of the
-#    License, or (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU Affero General Public License for more details.
-#
-#    You should have received a copy of the GNU Affero General Public License
-#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-##############################################################################
-from pdf_utils import assemble_pdf
-from openerp.osv import orm
-
-
-class stock_picking(orm.Model):
-    _inherit = 'stock.picking'
-
-    def get_pdf_label(self, cr, uid, ids, context=None):
-        """ Return a single pdf of labels for a stock picking
-
-        If more than one label is found for a picking we merge one label per
-        tracking in a single pdf
-
-        :return: a list of pdf file data
-        """
-        res = dict.fromkeys(ids, False)
-        label_obj = self.pool.get('shipping.label')
-        for picking_id in ids:
-            label_ids = label_obj.search(cr, uid,
-                                         [('file_type', '=', 'pdf'),
-                                          ('res_id', '=', picking_id)],
-                                         order='create_date',
-                                         context=context)
-            if label_ids:
-                all_picking_labels = label_obj.browse(cr, uid,
-                                                      label_ids,
-                                                      context=context)
-
-                tracking_ids = [l.tracking_id for l in all_picking_labels]
-
-                # filter for newest created label for each trackings
-                label_datas = []
-                tracking_ids = set(tracking_ids)
-                while tracking_ids:
-                    tracking_id = tracking_ids.pop()
-                    for label in all_picking_labels:
-                        if label.tracking_id.id == tracking_id.id:
-                            label_datas.append(label.datas.decode('base64'))
-
-                label_pdf = assemble_pdf(label_datas)
-                res[picking_id] = label_pdf.encode('base64')
-        return res

=== modified file 'delivery_carrier_label_dispatch/wizard/generate_labels.py'
--- delivery_carrier_label_dispatch/wizard/generate_labels.py	2013-12-17 07:42:04 +0000
+++ delivery_carrier_label_dispatch/wizard/generate_labels.py	2014-04-10 14:10:35 +0000
@@ -18,11 +18,14 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 ##############################################################################
+from operator import attrgetter
+from itertools import groupby
+
+from openerp.osv import orm, fields
+from openerp.tools.translate import _
+
 from ..pdf_utils import assemble_pdf
 
-from openerp.osv import orm, fields
-from tools.translate import _
-
 
 class DeliveryCarrierLabelGenerate(orm.TransientModel):
 
@@ -40,52 +43,106 @@
     _columns = {
         'dispatch_ids': fields.many2many('picking.dispatch',
                                          string='Picking Dispatch'),
-        'label_pdf_file': fields.binary('Labels file'),
+        'generate_new_labels': fields.boolean(
+            'Generate new labels',
+            help="If this option is used, new labels will be "
+                 "generated for the packs even if they already have one.\n"
+                 "The default is to use the existing label."),
     }
 
     _defaults = {
         'dispatch_ids': _get_dispatch_ids,
+        'generate_new_labels': False,
     }
 
+    def _get_packs(self, cr, uid, wizard, dispatch, context=None):
+        moves = sorted(dispatch.move_ids, key=attrgetter('tracking_id.name'))
+        for pack, moves in groupby(moves, key=attrgetter('tracking_id')):
+            pack_label = self._find_pack_label(cr, uid, wizard, pack,
+                                               context=context)
+            yield pack, list(moves), pack_label
+
+    def _find_picking_label(self, cr, uid, wizard, picking, context=None):
+        label_obj = self.pool['shipping.label']
+        domain = [('file_type', '=', 'pdf'),
+                  ('res_id', '=', picking.id),
+                  ('tracking_id', '=', False),
+                  ]
+        label_id = label_obj.search(cr, uid, domain, order='create_date DESC',
+                                    limit=1, context=context)
+        if not label_id:
+            return None
+        return label_obj.browse(cr, uid, label_id[0], context=context)
+
+    def _find_pack_label(self, cr, uid, wizard, pack, context=None):
+        label_obj = self.pool['shipping.label']
+        domain = [('file_type', '=', 'pdf'),
+                  ('tracking_id', '=', pack.id),
+                  ]
+        label_id = label_obj.search(cr, uid, domain, order='create_date DESC',
+                                    limit=1, context=context)
+        if not label_id:
+            return None
+        return label_obj.browse(cr, uid, label_id[0], context=context)
+
+    def _get_all_pdf(self, cr, uid, wizard, dispatch, context=None):
+        for pack, moves, label in self._get_packs(cr, uid, wizard, dispatch,
+                                                  context=context):
+            if not label or wizard.generate_new_labels:
+                picking_out_obj = self.pool['stock.picking.out']
+                picking = moves[0].picking_id
+                # generate the label of the pack
+                if pack:
+                    tracking_ids = [pack.id]
+                else:
+                    tracking_ids = None
+                try:
+                    picking_out_obj.generate_labels(
+                        cr, uid, [picking.id],
+                        tracking_ids=tracking_ids,
+                        context=context)
+                except orm.except_orm as e:
+                    picking_name = _('Picking: %s') % picking.name
+                    pack_num = _('Pack: %s') % pack.name if pack else ''
+                    raise orm.except_orm(
+                        e.name,
+                        _('%s %s - %s') % (picking_name, pack_num, e.value))
+                if pack:
+                    label = self._find_pack_label(cr, uid, wizard, pack,
+                                                  context=context)
+                else:
+                    label = self._find_picking_label(cr, uid, wizard, picking,
+                                                     context=context)
+                if not label:
+                    continue  # no label could be generated
+            yield label
+
     def action_generate_labels(self, cr, uid, ids, context=None):
         """
         Call the creation of the delivery carrier label
         of the missing labels and get the existing ones
         Then merge all of them in a single PDF
+
         """
         this = self.browse(cr, uid, ids, context=context)[0]
         if not this.dispatch_ids:
             raise orm.except_orm(_('Error'), _('No picking dispatch selected'))
 
-        picking_out_obj = self.pool.get('stock.picking.out')
-
-        # flatten all picking in one list to keep the order in case
-        # there are multiple dispatch or if pickings
-        # have been ordered to ease packaging
-        pickings = [(pick, pick.get_pdf_label()[pick.id])
-                    for dispatch in this.dispatch_ids
-                    for pick in dispatch.related_picking_ids]
-        # get picking ids for which we want to generate pdf label
-        picking_ids = [pick.id for pick, pdf in pickings
-                       if not pdf]
-        # generate missing picking labels
-        picking_out_obj.action_generate_carrier_label(cr, uid,
-                                                      picking_ids,
-                                                      #file_type='pdf',
-                                                      context=context)
-
-        # Get all pdf files adding the newly generated ones
-        data_list = [pdf or pick.get_pdf_label()[pick.id]
-                     for pick, pdf in pickings]
-        pdf_list = [data.decode('base64') for data in data_list if data]
-        pdf_file = assemble_pdf(pdf_list)
-        this.write({'label_pdf_file': pdf_file.encode('base64')})
+        attachment_obj = self.pool.get('ir.attachment')
+
+        for dispatch in this.dispatch_ids:
+            labels = self._get_all_pdf(cr, uid, this, dispatch,
+                                       context=context)
+            labels = (label.datas for label in labels)
+            labels = (label.decode('base64') for label in labels if labels)
+            data = {
+                'name': dispatch.name + '.pdf',
+                'res_id': dispatch.id,
+                'res_model': 'picking.dispatch',
+                'datas': assemble_pdf(labels).encode('base64'),
+            }
+            attachment_obj.create(cr, uid, data, context=context)
+
         return {
-            'type': 'ir.actions.act_window',
-            'res_model': 'delivery.carrier.label.generate',
-            'view_mode': 'form',
-            'view_type': 'form',
-            'res_id': this.id,
-            'views': [(False, 'form')],
-            'target': 'new',
+            'type': 'ir.actions.act_window_close',
         }

=== modified file 'delivery_carrier_label_dispatch/wizard/generate_labels_view.xml'
--- delivery_carrier_label_dispatch/wizard/generate_labels_view.xml	2013-12-06 12:51:58 +0000
+++ delivery_carrier_label_dispatch/wizard/generate_labels_view.xml	2014-04-10 14:10:35 +0000
@@ -7,13 +7,12 @@
       <field name="model">delivery.carrier.label.generate</field>
       <field name="arch" type="xml">
         <form string="Generate Carriers Labels" version="7.0">
-
+          <group>
+            <label string="This wizard creates an attachement on each selected dispatch containing picking labels"/>
+          </group>
           <group>
             <field name="dispatch_ids"/>
-          </group>
-          <separator string="Labels"/>
-          <group>
-            <field name="label_pdf_file" filename="picking_labels.pdf"/>
+            <field name="generate_new_labels"/>
           </group>
           <footer>
             <button name="action_generate_labels" string="Generate Labels" type="object" icon="gtk-execute" class="oe_highlight"/>