stock.py

# -*- coding: utf-8 -*-
##############################################################################
#
#    Copyright (C) All Rights Reserved 2014 Akretion
#    @author David BEAL <david.beal@akretion.com>
#
#    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 openerp.osv import orm
from openerp.tools.translate import _
from .report.label import GLSLabel, InvalidDataForMako
from .report.exception_helper import (InvalidAccountNumber)
from .report.label_helper import (
    InvalidValueNotInList,
    InvalidMissingField,
    InvalidType,)
from openerp.tools import DEFAULT_SERVER_DATETIME_FORMAT
from datetime import datetime
import pycountry
from operator import attrgetter


EXCEPT_TITLE = "GLS Library Exception"
LABEL_TYPE = 'zpl2'


def raise_exception(orm, message):
    raise orm.except_orm(EXCEPT_TITLE, map_except_message(message))


def map_except_message(message):
    """ Allows to map vocabulary from external library
        to Odoo vocabulary in Exception message
    """
    model_mapping = {
        'shipper_country': 'partner_id.country_id.code',
    }
    for key, val in model_mapping.items():
        message = message.replace(key, val)
    return message


class StockPicking(orm.Model):
    _inherit = "stock.picking"

    def action_done(self, cr, uid, ids, context=None):
        """
        :return: see original method
        """
        for picking in self.browse(cr, uid, ids, context=context):
            if picking.carrier_type == 'gls':
                self.generate_labels(
                    cr, uid, [picking.id], context=context)

        return super(StockPicking, self).action_done(
            cr, uid, ids, context=context)

    def _customize_gls_picking(self, cr, uid, picking, context=None):
        "Use this method to override gls picking"
        return True

    def _prepare_global_gls(self, cr, uid, picking=None, context=None):
        res = {}
        param_m = self.pool['ir.config_parameter']
        gls_keys = ['carrier_gls_warehouse', 'carrier_gls_customer_code']
        ids = param_m.search(cr, uid, [('key', 'in', gls_keys)],
                             context=context)
        for elm in param_m.browse(cr, uid, ids, context=context):
            res[elm.key] = elm.value
        return res

    def _prepare_address_name_gls(self, cr, uid, partner, context=None):
        consignee = partner.name
        contact = partner.name
        if partner.parent_id and partner.use_parent_address:
            consignee = partner.parent_id.name
        return {'consignee_name': consignee, 'contact': contact}

    def _prepare_address_gls(self, cr, uid, picking, context=None):
        address = {}
        res = self.pool['res.partner']._get_split_address(
            cr, uid, picking.partner_id, 3, 35, context=context)
        address['street'], address['street2'], address['street3'] = res
        country_code = (picking.partner_id and
                        picking.partner_id.country_id.code or 'FR')
        iso_3166 = pycountry.countries.get(alpha2=country_code).numeric
        address.update({
            "zip": picking.partner_id.zip,
            "city": picking.partner_id.city,
            "consignee_phone": picking.partner_id.phone,
            "consignee_mobile": (picking.partner_id.mobile or
                                 picking.partner_id.phone),
            "consignee_email": picking.partner_id.email,
            "country_code": picking.partner_id.country_id.code or 'FR',
            # useful uniship label only
            "country_norme3166": int(iso_3166),
        })
        destination = self._prepare_address_name_gls(
            cr, uid, picking.partner_id, context=context)
        address['consignee_name'] = destination['consignee_name'][:35]
        address['contact'] = destination['contact'][:35]
        return address

    def _prepare_delivery_gls(
            self, cr, uid, picking, number_of_packages, context=None):
        shipping_date = picking.min_date or picking.date
        shipping_date = datetime.strptime(
            shipping_date, DEFAULT_SERVER_DATETIME_FORMAT)
        delivery = {}
        delivery.update({
            'consignee_ref': picking.name[:20],
            'additional_ref_1': u'',
            'additional_ref_2': picking.name[:20],
            'shipping_date': shipping_date.strftime('%Y%m%d'),
            'commentary': picking.note,
            'parcel_total_number': number_of_packages,
        })
        return delivery

    def _prepare_sender_gls(self, cr, uid, pick, context=None):
        partner = self.pool['stock.picking.out']._get_label_sender_address(
            cr, uid, pick, context=context)
        global_infos = self._prepare_global_gls(cr, uid, context=context)
        sender = {'contact_id': pick.company_id.gls_fr_contact_id,
                  'customer_id': global_infos['carrier_gls_customer_code'],
                  'contact_id_inter': pick.company_id.gls_inter_contact_id,
                  'outbound_depot': global_infos['carrier_gls_warehouse']}
        if partner.country_id:
            sender['country'] = partner.country_id.name
        sender.update({
            'shipper_street': partner.street,
            'shipper_street2': partner.street2,
            'shipper_name': partner.name,
            'shipper_country': partner.country_id.code,
            'shipper_zip': partner.zip,
            'shipper_city': partner.city,
        })
        return sender

    def _prepare_pack_gls(
            self, cr, uid, tracking, pack_number, weight=None, context=None):
        pack = {}
        pack.update({
            'parcel_number_label': pack_number,
            'parcel_number_barcode': pack_number,
            'custom_sequence': self._get_sequence(
                cr, uid, 'gls', context=context),
        })
        if weight:
            pack.update({
                'weight': "{0:05.2f}".format(weight),
            })
        else:
            if tracking.move_ids:
                tracking_weight = [move.weight
                                   for move in tracking.move_ids][0]
                pack.update({
                    'weight': "{0:05.2f}".format(tracking_weight),
                })
        return pack

    def _get_tracking_ids_from_moves(self, cr, uid, picking, context=None):
        """ get all the trackings of the picking
            no tracking_id will return a False (Browse Null), meaning that
            we want a label for the picking
        """
        return sorted(set(
            line.tracking_id for line in picking.move_lines
        ), key=attrgetter('name'))

    def _get_weight_from_moves_without_tracking(
            self, cr, uid, picking, context=None):
        weights = [line.weight for line in picking.move_lines
                   if not line.tracking_id]
        return sum(weights)

    def _generate_gls_labels(
            self, cr, uid, picking, service, tracking_ids=None, context=None):
        """ Generate labels and write tracking numbers received """
        pack_nbr = 0
        pick2update = {}
        address = self._prepare_address_gls(cr, uid, picking, context=context)
        if tracking_ids is None:
            trackings = self._get_tracking_ids_from_moves(
                cr, uid, picking, context=context)
        else:
            # restrict on the provided trackings
            trackings = self.pool['stock.tracking'].browse(
                cr, uid, tracking_ids, context=context)
        labels = []
        without_track = 0
        for track in trackings:
            if not track:
                without_track += 1
        pick2update['number_of_packages'] = len(trackings) - without_track + 1
        delivery = self._prepare_delivery_gls(
            cr, uid, picking, pick2update['number_of_packages'],
            context=context)
        # Write tracking_number on serial field
        # for move lines with tracking
        # and on picking for other moves
        for packing in trackings:
            pack_nbr += 1
            addr = address.copy()
            deliv = delivery.copy()
            if not packing:
                without_track -= 1
                if without_track > 0:
                    continue
                # only executed for the last move line with no tracking
                weight = self._get_weight_from_moves_without_tracking(
                    cr, uid, picking, context=context)
                pack = self._prepare_pack_gls(
                    cr, uid, packing, pack_nbr, weight=weight, context=context)
                label = self.get_zpl(service, deliv, addr, pack)
                pick2update['carrier_tracking_ref'] = label['tracking_number']
            else:
                pack = self._prepare_pack_gls(
                    cr, uid, packing, pack_nbr, context=context)
                label = self.get_zpl(service, deliv, addr, pack)
                packing.write({'serial': label['tracking_number']})
            label_info = {
                'tracking_id': packing.id if packing else False,
                'file': label['content'],
                'file_type': LABEL_TYPE,
                'name': label['filename']+'.zpl',
            }
            if label['tracking_number']:
                label_info['name'] = '%s%s.zpl' % (label['tracking_number'],
                                                   label['filename'])
            labels.append(label_info)
        # must be on this stock.picking.out to event on connector
        # like in modules prestahop or magento
        self.pool['stock.picking.out'].write(cr, uid, picking.id, pick2update,
                                             context=context)
        picking = self.browse(cr, uid, picking.id, context=context)
        self._customize_gls_picking(cr, uid, picking, context=context)
        return labels

    def get_zpl(self, service, delivery, address, pack):
        try:
            result = service.get_label(delivery, address, pack)
        except (InvalidMissingField,
                InvalidDataForMako,
                InvalidValueNotInList,
                InvalidAccountNumber,
                InvalidType) as e:
            raise_exception(orm, e.message)
        except Exception, e:
            raise orm.except_orm(EXCEPT_TITLE, e.message)
        return result

    def generate_shipping_labels(
            self, cr, uid, ids, tracking_ids=None, context=None):
        """ Add label generation for GLS """
        if isinstance(ids, (long, int)):
            ids = [ids]
        assert len(ids) == 1
        picking = self.browse(cr, uid, ids[0], context=context)
        if picking.carrier_id.type == 'gls':
            sender = self._prepare_sender_gls(
                cr, uid, picking, context=context)
            # gls has a rescue label without webservice required
            # if webservice is down
            # rescue label is also used for international carrier
            test = False
            if picking.company_id.gls_test:
                test = True
            try:
                service = GLSLabel(
                    sender, picking.carrier_code, test_plateform=test)
            except InvalidMissingField as e:
                raise_exception(orm, e.message)
            except Exception as e:
                raise_exception(orm, e.message)
            return self._generate_gls_labels(
                cr, uid, picking, service,
                tracking_ids=tracking_ids,
                context=context)
        return super(StockPicking, self).\
            generate_shipping_labels(
                cr, uid, ids, tracking_ids=tracking_ids, context=context)

    def _get_sequence(self, cr, uid, label_name, context=None):
        sequence = self.pool['ir.sequence'].next_by_code(
            cr, uid, 'stock.picking_' + label_name, context=context)
        if not sequence:
            raise orm.except_orm(
                _("Picking sequence"),
                _("There is no sequence defined for the label '%s'")
                % label_name)
        return sequence


class StockPickingOut(orm.Model):
    _inherit = 'stock.picking.out'

    def copy(self, cr, uid, id, default=None, context=None):
        if default is None:
            default = {}
        default.update({
            'carrier_tracking_ref': None,
        })
        return super(StockPickingOut, self).copy(
            cr, uid, id, default, context=context)

    def get_shipping_cost(self, cr, uid, ids, context=None):
        return 0


class StockPickingIn(orm.Model):
    _inherit = 'stock.picking.in'

    def action_generate_carrier_label(self, cr, uid, ids, context=None):
        raise orm.except_orm(
            "Return label",
            "Return Label is not implemented for "
            "GLS Carrier \n"
            "Ask us for service proposal, http://www.akretion.com/contact")


class ShippingLabel(orm.Model):
    _inherit = 'shipping.label'

    def _get_file_type_selection(self, cr, uid, context=None):
        selection = super(ShippingLabel, self)._get_file_type_selection(
            cr, uid, context=None)
        selection.append(('zpl2', 'ZPL2'))
        selection = list(set(selection))
        return selection