diff --git a/sale_planner/__init__.py b/sale_planner/__init__.py index 134df274..b0eafef5 100644 --- a/sale_planner/__init__.py +++ b/sale_planner/__init__.py @@ -1,2 +1,4 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from . import wizard from . import models diff --git a/sale_planner/__manifest__.py b/sale_planner/__manifest__.py index c87d85f2..444a5da7 100644 --- a/sale_planner/__manifest__.py +++ b/sale_planner/__manifest__.py @@ -1,10 +1,10 @@ { 'name': 'Sale Order Planner', 'summary': 'Plans order dates and warehouses.', - 'version': '15.0.1.0.0', + 'version': '15.0.2.0.0', 'author': "Hibou Corp.", 'category': 'Sale', - 'license': 'AGPL-3', + 'license': 'OPL-1', 'complexity': 'expert', 'images': [], 'website': "https://hibou.io", @@ -37,6 +37,7 @@ on the specific method's characteristics. (e.g. Do they deliver on Saturday?) 'views/stock.xml', 'views/delivery.xml', 'views/product.xml', + 'views/res_config_settings_views.xml', ], 'auto_install': False, 'installable': True, diff --git a/sale_planner/models/__init__.py b/sale_planner/models/__init__.py index ff524f40..95b4955a 100644 --- a/sale_planner/models/__init__.py +++ b/sale_planner/models/__init__.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from . import delivery from . import partner from . import planning @@ -5,3 +7,4 @@ from . import product from . import resource from . import sale from . import stock +from . import res_config_settings diff --git a/sale_planner/models/delivery.py b/sale_planner/models/delivery.py index c8526c34..dc66ab81 100644 --- a/sale_planner/models/delivery.py +++ b/sale_planner/models/delivery.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from datetime import timedelta from odoo import api, fields, models @@ -61,6 +63,9 @@ class DeliveryCarrier(models.Model): def calculate_transit_days(self, date_planned, date_delivered): self.ensure_one() + if not self.delivery_calendar_id: + return 0 + if isinstance(date_planned, str): date_planned = fields.Datetime.from_string(date_planned) if isinstance(date_delivered, str): diff --git a/sale_planner/models/partner.py b/sale_planner/models/partner.py index a87ff4f0..a5c8a39e 100644 --- a/sale_planner/models/partner.py +++ b/sale_planner/models/partner.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from odoo import api, fields, models try: diff --git a/sale_planner/models/planning.py b/sale_planner/models/planning.py index 47d645af..54969669 100644 --- a/sale_planner/models/planning.py +++ b/sale_planner/models/planning.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from odoo import api, fields, models diff --git a/sale_planner/models/product.py b/sale_planner/models/product.py index 55cb677e..add93077 100644 --- a/sale_planner/models/product.py +++ b/sale_planner/models/product.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from odoo import api, fields, models diff --git a/sale_planner/models/res_config_settings.py b/sale_planner/models/res_config_settings.py new file mode 100644 index 00000000..06e2f899 --- /dev/null +++ b/sale_planner/models/res_config_settings.py @@ -0,0 +1,79 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + +from odoo import api, fields, models + + +def sale_planner_warehouse_ids(env, company): + get_param = env['ir.config_parameter'].sudo().get_param + warehouse_ids = get_param('sale.planner.warehouse_ids.%s' % (company.id, )) or [] + if warehouse_ids and isinstance(warehouse_ids, str): + try: + warehouse_ids = [int(i) for i in warehouse_ids.split(',')] + except: + warehouse_ids = [] + return warehouse_ids + + +def sale_planner_carrier_ids(env, company): + get_param = env['ir.config_parameter'].sudo().get_param + carrier_ids = get_param('sale.planner.carrier_ids.%s' % (company.id, )) or [] + if carrier_ids and isinstance(carrier_ids, str): + try: + carrier_ids = [int(c) for c in carrier_ids.split(',')] + except: + carrier_ids = [] + return carrier_ids + + +class ResConfigSettings(models.TransientModel): + _inherit = 'res.config.settings' + + sale_planner_warehouse_ids = fields.Many2many('stock.warehouse', + string='Sale Order Planner Warehouses', + compute='_compute_sale_planner_warehouse_ids', + inverse='_inverse_sale_planner_warehouse_ids') + sale_planner_carrier_ids = fields.Many2many('delivery.carrier', + string='Sale Order Planner Carriers', + compute='_compute_sale_planner_carrier_ids', + inverse='_inverse_sale_planner_carrier_ids') + + def _compute_sale_planner_warehouse_ids_ids(self): + company = self.company_id or self.env.user.company_id + return sale_planner_warehouse_ids(self.env, company) + + def _compute_sale_planner_carrier_ids_ids(self): + company = self.company_id or self.env.user.company_id + return sale_planner_carrier_ids(self.env, company) + + def _compute_sale_planner_warehouse_ids(self): + for settings in self: + warehouse_ids = settings._compute_sale_planner_warehouse_ids_ids() + warehouses = self.env['stock.warehouse'].browse(warehouse_ids) + settings.sale_planner_warehouse_ids = warehouses + + def _compute_sale_planner_carrier_ids(self): + for settings in self: + carrier_ids = settings._compute_sale_planner_carrier_ids_ids() + carriers = self.env['delivery.carrier'].browse(carrier_ids) + settings.sale_planner_carrier_ids = carriers + + def _inverse_sale_planner_warehouse_ids(self): + set_param = self.env['ir.config_parameter'].sudo().set_param + company_id = self.company_id.id or self.env.user.company_id.id + for settings in self: + warehouse_ids = ','.join(str(i) for i in settings.sale_planner_warehouse_ids.ids) + set_param('sale.planner.warehouse_ids.%s' % (company_id, ), warehouse_ids) + + def _inverse_sale_planner_carrier_ids(self): + set_param = self.env['ir.config_parameter'].sudo().set_param + company_id = self.company_id.id or self.env.user.company_id.id + for settings in self: + carrier_ids = ','.join(str(i) for i in settings.sale_planner_carrier_ids.ids) + set_param('sale.planner.carrier_ids.%s' % (company_id, ), carrier_ids) + + @api.model + def get_values(self): + res = super(ResConfigSettings, self).get_values() + res['sale_planner_warehouse_ids'] = [(6, 0, self._compute_sale_planner_warehouse_ids_ids())] + res['sale_planner_carrier_ids'] = [(6, 0, self._compute_sale_planner_carrier_ids_ids())] + return res diff --git a/sale_planner/models/sale.py b/sale_planner/models/sale.py index 30396792..919de060 100644 --- a/sale_planner/models/sale.py +++ b/sale_planner/models/sale.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from odoo import api, fields, models diff --git a/sale_planner/models/stock.py b/sale_planner/models/stock.py index 4d72f4f4..10011e6c 100644 --- a/sale_planner/models/stock.py +++ b/sale_planner/models/stock.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from odoo import api, fields, models @@ -7,3 +9,7 @@ class Warehouse(models.Model): shipping_calendar_id = fields.Many2one( 'resource.calendar', 'Shipping Calendar', help="This calendar represents shipping availability from the warehouse.") + sale_planner_carrier_ids = fields.Many2many('delivery.carrier', + relation='sale_planner_carrier_wh_rel', + string='Sale Order Planner Base Carriers', + help='Overrides the global carriers.') diff --git a/sale_planner/tests/__init__.py b/sale_planner/tests/__init__.py index 25366b57..8208aa7b 100644 --- a/sale_planner/tests/__init__.py +++ b/sale_planner/tests/__init__.py @@ -1 +1,3 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from . import test_planner diff --git a/sale_planner/tests/test_planner.py b/sale_planner/tests/test_planner.py index 4bc58ad8..5f746cc8 100644 --- a/sale_planner/tests/test_planner.py +++ b/sale_planner/tests/test_planner.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from odoo.tests import common from datetime import datetime, timedelta from json import loads as json_decode diff --git a/sale_planner/views/res_config_settings_views.xml b/sale_planner/views/res_config_settings_views.xml new file mode 100644 index 00000000..69b215f7 --- /dev/null +++ b/sale_planner/views/res_config_settings_views.xml @@ -0,0 +1,39 @@ + + + + + res.config.settings.view.form.inherit + res.config.settings + + + + +

Sale Order Planner

+
+
+
+
+
+
+
+
+
+
+ + + + + diff --git a/sale_planner/views/stock.xml b/sale_planner/views/stock.xml index d0195d86..81d0f78e 100644 --- a/sale_planner/views/stock.xml +++ b/sale_planner/views/stock.xml @@ -7,6 +7,7 @@ + diff --git a/sale_planner/wizard/__init__.py b/sale_planner/wizard/__init__.py index 235b12a8..48b8dc48 100644 --- a/sale_planner/wizard/__init__.py +++ b/sale_planner/wizard/__init__.py @@ -1 +1,3 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from . import order_planner diff --git a/sale_planner/wizard/order_planner.py b/sale_planner/wizard/order_planner.py index 6a072c76..61e7ee0c 100644 --- a/sale_planner/wizard/order_planner.py +++ b/sale_planner/wizard/order_planner.py @@ -1,3 +1,5 @@ +# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details. + from math import sin, cos, sqrt, atan2, radians from json import dumps, loads from copy import deepcopy @@ -10,11 +12,12 @@ _logger = getLogger(__name__) try: from uszipcode import SearchEngine except ImportError: - _logger.warning('module "uszipcode" cannot be loaded, falling back to Google API') + _logger.warn('module "uszipcode" cannot be loaded, falling back to Google API') SearchEngine = None from odoo import api, fields, models from odoo.tools.safe_eval import safe_eval +from ..models.res_config_settings import sale_planner_warehouse_ids, sale_planner_carrier_ids class FakeCollection(): @@ -26,7 +29,12 @@ class FakeCollection(): yield v def filtered(self, f): - return filter(f, self.vals) + return self.__class__([v for v in self.vals if f(v)]) + # return filter(f, self.vals) + + def mapped(self, s): + # note this only maps to one level and doesn't really support recordset + return [v[s] for v in self.vals] def sudo(self, *args, **kwargs): return self @@ -178,6 +186,12 @@ class FakeSaleOrder(FakeCollection): if item == '__last_update': return str(datetime.now()) return getattr(self, item) + + def _get_estimated_weight(self): + weight = 0.0 + for order_line in self.order_line.filtered(lambda l: l.product_id.type in ['product', 'consu'] and not l.is_delivery and not l.display_type): + weight += order_line.product_qty * order_line.product_id.weight + return weight def distance(lat_1, lon_1, lat_2, lon_2): @@ -308,15 +322,17 @@ class SaleOrderMakePlan(models.TransientModel): domain.append(('company_id', 'in', self.env.context['allowed_company_ids'])) if self.env.context.get('warehouse_domain'): + if not domain: + domain = [] domain.extend(self.env.context.get('warehouse_domain')) + if domain: + return warehouse.search(domain) - irconfig_parameter = self.env['ir.config_parameter'].sudo() - if irconfig_parameter.get_param('sale.order.planner.warehouse_domain'): - domain.extend(safe_eval(irconfig_parameter.get_param('sale.order.planner.warehouse_domain'))) + # no domain, use global + warehouse_ids = sale_planner_warehouse_ids(self.env, self.env.user.company_id) + return warehouse.browse(warehouse_ids) - return warehouse.search(domain) - - def get_shipping_carriers(self, carrier_id=None, domain=None): + def get_shipping_carriers(self, carrier_id=None, domain=None, warehouse_id=None): Carrier = self.env['delivery.carrier'].sudo() if carrier_id: return Carrier.browse(carrier_id) @@ -324,18 +340,21 @@ class SaleOrderMakePlan(models.TransientModel): if domain: if not isinstance(domain, (list, tuple)): domain = safe_eval(domain) - else: - domain = [] if self.env.context.get('carrier_domain'): - # potential bug here if this is textual + if not domain: + domain = [] domain.extend(self.env.context.get('carrier_domain')) + if domain: + return Carrier.search(domain) - irconfig_parameter = self.env['ir.config_parameter'].sudo() - if irconfig_parameter.get_param('sale.order.planner.carrier_domain'): - domain.extend(safe_eval(irconfig_parameter.get_param('sale.order.planner.carrier_domain'))) - - return Carrier.search(domain) + # no domain, use global + if warehouse_id: + warehouse = self.env['stock.warehouse'].sudo().browse(warehouse_id) + if warehouse.sale_planner_carrier_ids: + return warehouse.sale_planner_carrier_ids.sudo() + carrier_ids = sale_planner_carrier_ids(self.env, self.env.user.company_id) + return Carrier.browse(carrier_ids) def _generate_base_option(self, order_fake, policy_group): flag_force_closest = False @@ -616,6 +635,8 @@ class SaleOrderMakePlan(models.TransientModel): return self._find_closest_warehouse(warehouses, partner.partner_latitude, partner.partner_longitude) def _find_closest_warehouse(self, warehouses, latitude, longitude): + if not warehouses: + return warehouses distances = {distance(latitude, longitude, wh.partner_id.partner_latitude, wh.partner_id.partner_longitude): wh.id for wh in warehouses} wh_id = distances[min(distances)] return warehouses.filtered(lambda wh: wh.id == wh_id) @@ -662,19 +683,19 @@ class SaleOrderMakePlan(models.TransientModel): policy = line.product_id.product_tmpl_id.get_planning_policy() if policy and policy.carrier_filter_id: domain.extend(safe_eval(policy.carrier_filter_id.domain)) - carriers = self.get_shipping_carriers(base_option.get('carrier_id'), domain=domain) + carriers = self.get_shipping_carriers(base_option.get('carrier_id'), domain=domain, warehouse_id=base_option.get('warehouse_id')) _logger.info('generate_shipping_options:: base_option: ' + str(base_option) + ' order_fake: ' + str(order_fake) + ' carriers: ' + str(carriers)) if not carriers: - return base_option + return [base_option] if not base_option.get('sub_options'): options = [] # this locic comes from "delivery.models.sale_order.SaleOrder" for carrier in carriers: - option = self._generate_shipping_carrier_option(base_option, order_fake, carrier) - if option: - options.append(option) + carrier_options = self._generate_shipping_carrier_option(base_option, order_fake, carrier) + if carrier_options: + options += carrier_options if options: return options return [base_option] @@ -686,26 +707,40 @@ class SaleOrderMakePlan(models.TransientModel): for carrier in carriers: new_base_option = deepcopy(base_option) has_error = False + found_carrier_ids = set() for wh_id, wh_vals in base_option['sub_options'].items(): if has_error: continue order_fake.warehouse_id = warehouses.filtered(lambda wh: wh.id == wh_id) - order_fake.order_line = FakeCollection(filter(lambda line: line.product_id.id in wh_vals['product_ids'], original_order_fake_order_line)) - wh_option = self._generate_shipping_carrier_option(wh_vals, order_fake, carrier) - if not wh_option: + order_fake.order_line = FakeCollection(list(filter(lambda line: line.product_id.id in wh_vals['product_ids'], original_order_fake_order_line))) + wh_carrier_options = self._generate_shipping_carrier_option(wh_vals, order_fake, carrier) + if not wh_carrier_options: has_error = True else: - new_base_option['sub_options'][wh_id] = wh_option + for _option in wh_carrier_options: + if _option.get('carrier_id'): + found_carrier_ids.add(_option['carrier_id']) + new_base_option['sub_options'][wh_id] = wh_carrier_options if has_error: continue - # now that we've collected, we can roll up some details. - new_base_option['carrier_id'] = carrier.id - new_base_option['shipping_price'] = self._get_shipping_price_for_options(new_base_option['sub_options']) - new_base_option['requested_date'] = self._get_max_requested_date(new_base_option['sub_options']) - new_base_option['transit_days'] = self._get_max_transit_days(new_base_option['sub_options']) - options.append(new_base_option) + # now that we've collected details for this carrier, we likely have more than one carrier's rates + _logger.info(' from ' + str(carrier) + ' found ' + str(found_carrier_ids)) + for carrier_id in found_carrier_ids: + carrier_option = deepcopy(base_option) + carrier_option['carrier_id'] = False + for wh_id, wh_vals in base_option['sub_options'].items(): + for co in new_base_option['sub_options'].get(wh_id, []): + if co.get('carrier_id') == carrier_id: + # we have found the rate! + carrier_option['carrier_id'] = carrier_id + carrier_option['sub_options'][wh_id] = co + if carrier_option['carrier_id']: + carrier_option['shipping_price'] = self._get_shipping_price_for_options(carrier_option['sub_options']) + carrier_option['requested_date'] = self._get_max_requested_date(carrier_option['sub_options']) + carrier_option['transit_days'] = self._get_max_transit_days(carrier_option['sub_options']) + options.append(carrier_option) #restore values in case more processing occurs order_fake.warehouse_id = original_order_fake_warehouse_id @@ -734,6 +769,8 @@ class SaleOrderMakePlan(models.TransientModel): def _generate_shipping_carrier_option(self, base_option, order_fake, carrier): # some carriers look at the order carrier_id order_fake.carrier_id = carrier + date_planned = base_option.get('date_planned') + order_fake.date_planned = date_planned # this logic comes from "delivery.models.sale_order.SaleOrder" try: @@ -741,7 +778,9 @@ class SaleOrderMakePlan(models.TransientModel): date_delivered = None transit_days = 0 if carrier.delivery_type not in ['fixed', 'base_on_rule']: - if hasattr(carrier, 'rate_shipment_date_planned'): + if hasattr(carrier, 'rate_shipment_multi'): + result = carrier.rate_shipment_multi(order=order_fake) + elif hasattr(carrier, 'rate_shipment_date_planned'): # New API result = carrier.rate_shipment_date_planned(order_fake, base_option.get('date_planned')) if result: @@ -751,7 +790,8 @@ class SaleOrderMakePlan(models.TransientModel): elif hasattr(carrier, 'get_shipping_price_for_plan'): # Old API result = carrier.get_shipping_price_for_plan(order_fake, base_option.get('date_planned')) - if result and isinstance(result, list): + if result and isinstance(result, list) and not isinstance(result[0], dict): + # this detects the above only if it isn't a list of dictionaries (aka multi-rating result) price_unit, transit_days, date_delivered = result[0] elif not result: rate = carrier.rate_shipment(order_fake) @@ -762,7 +802,7 @@ class SaleOrderMakePlan(models.TransientModel): if rate.get('date_delivered'): date_delivered = rate.get('date_delivered') else: - _logger.warning('returning None because carrier: ' + str(carrier)) + _logger.warning('returning None because carrier: ' + str(carrier) + ' returned rate: ' + str(rate)) return None else: carrier = carrier.available_carriers(order_fake.partner_shipping_id) @@ -773,13 +813,38 @@ class SaleOrderMakePlan(models.TransientModel): if order_fake.company_id.currency_id.id != order_fake.pricelist_id.currency_id.id: price_unit = order_fake.company_id.currency_id.with_context(date=order_fake.date_order).compute(price_unit, order_fake.pricelist_id.currency_id) - final_price = float(price_unit) * (1.0 + (float(carrier.margin) / 100.0)) - option = deepcopy(base_option) - option['carrier_id'] = carrier.id - option['shipping_price'] = final_price - option['requested_date'] = date_delivered - option['transit_days'] = transit_days - return option + if result and isinstance(result, list): + res = [] + for rate in result: + rate_carrier = rate.get('carrier') + if not rate_carrier: + continue + price_unit = rate['price'] + date_delivered = rate.get('date_delivered') + transit_days = rate.get('transit_days') + + if date_planned and transit_days and not date_delivered: + # compute from planned date anc current rate carrier + date_delivered = rate_carrier.calculate_date_delivered(date_planned, transit_days) + elif date_planned and date_delivered and not transit_days: + transit_days = rate_carrier.calculate_transit_days(date_planned, date_delivered) + + final_price = float(price_unit) * (1.0 + (float(rate_carrier.margin) / 100.0)) + option = deepcopy(base_option) + option['carrier_id'] = rate_carrier.id + option['shipping_price'] = final_price + option['requested_date'] = fields.Datetime.to_string(date_delivered) if (date_delivered and isinstance(date_delivered, datetime)) else date_delivered + option['transit_days'] = transit_days + res.append(option) + return res + else: + final_price = float(price_unit) * (1.0 + (float(carrier.margin) / 100.0)) + option = deepcopy(base_option) + option['carrier_id'] = carrier.id + option['shipping_price'] = final_price + option['requested_date'] = fields.Datetime.to_string(date_delivered) if (date_delivered and isinstance(date_delivered, datetime)) else date_delivered + option['transit_days'] = transit_days + return [option] except Exception as e: _logger.info("Exception collecting carrier rates: " + str(e)) # Want to see more? @@ -796,12 +861,14 @@ class SaleOrderPlanningOption(models.TransientModel): def datetime_converter(o): if isinstance(o, datetime): return str(o) - - if 'sub_options' in values and not isinstance(values['sub_options'], str): - for wh_id, option in values['sub_options'].items(): - if option.get('date_planned'): - option['date_planned'] = str(option['date_planned']) - values['sub_options'] = dumps(values['sub_options'], default=datetime_converter) + if not isinstance(values, list): + values = [values] + for option_values in values: + if 'sub_options' in option_values and not isinstance(option_values['sub_options'], str): + for wh_id, option in option_values['sub_options'].items(): + if option.get('date_planned'): + option['date_planned'] = str(option['date_planned']) + option_values['sub_options'] = dumps(option_values['sub_options'], default=datetime_converter) return super(SaleOrderPlanningOption, self).create(values) def _compute_sub_options_text(self):