# -*- coding: utf-8 -*- # Part of Odoo. See LICENSE file for full copyright and licensing details. from datetime import timedelta from odoo import api, fields, tools, models, _ from odoo.exceptions import UserError, ValidationError class UoMCategory(models.Model): _name = 'uom.category' _description = 'Product UoM Categories' name = fields.Char('Unit of Measure Category', required=True, translate=True) class UoM(models.Model): _name = 'uom.uom' _description = 'Product Unit of Measure' _order = "name" def _unprotected_uom_xml_ids(self): return [ "product_uom_hour", # NOTE: this uom is protected when hr_timesheet is installed. "product_uom_dozen", ] name = fields.Char('Unit of Measure', required=True, translate=True) category_id = fields.Many2one( 'uom.category', 'Category', required=True, ondelete='restrict', help="Conversion between Units of Measure can only occur if they belong to the same category. The conversion will be made based on the ratios.") factor = fields.Float( 'Ratio', default=1.0, digits=0, required=True, # force NUMERIC with unlimited precision help='How much bigger or smaller this unit is compared to the reference Unit of Measure for this category: 1 * (reference unit) = ratio * (this unit)') factor_inv = fields.Float( 'Bigger Ratio', compute='_compute_factor_inv', digits=0, # force NUMERIC with unlimited precision readonly=True, required=True, help='How many times this Unit of Measure is bigger than the reference Unit of Measure in this category: 1 * (this unit) = ratio * (reference unit)') rounding = fields.Float( 'Rounding Precision', default=0.01, digits=0, required=True, help="The computed quantity will be a multiple of this value. " "Use 1.0 for a Unit of Measure that cannot be further split, such as a piece.") active = fields.Boolean('Active', default=True, help="Uncheck the active field to disable a unit of measure without deleting it.") uom_type = fields.Selection([ ('bigger', 'Bigger than the reference Unit of Measure'), ('reference', 'Reference Unit of Measure for this category'), ('smaller', 'Smaller than the reference Unit of Measure')], 'Type', default='reference', required=True) _sql_constraints = [ ('factor_gt_zero', 'CHECK (factor!=0)', 'The conversion ratio for a unit of measure cannot be 0!'), ('rounding_gt_zero', 'CHECK (rounding>0)', 'The rounding precision must be strictly positive.'), ('factor_reference_is_one', "CHECK((uom_type = 'reference' AND factor = 1.0) OR (uom_type != 'reference'))", "The reference unit must have a conversion factor equal to 1.") ] @api.depends('factor') def _compute_factor_inv(self): for uom in self: uom.factor_inv = uom.factor and (1.0 / uom.factor) or 0.0 @api.onchange('uom_type') def _onchange_uom_type(self): if self.uom_type == 'reference': self.factor = 1 @api.onchange('factor', 'factor_inv', 'uom_type', 'rounding', 'category_id') def _onchange_critical_fields(self): if self._filter_protected_uoms() and self.create_date < (fields.Datetime.now() - timedelta(days=1)): return { 'warning': { 'title': _("Warning for %s", self.name), 'message': _( "Some critical fields have been modified on %s.\n" "Note that existing data WON'T be updated by this change.\n\n" "As units of measure impact the whole system, this may cause critical issues.\n" "E.g. modifying the rounding could disturb your inventory balance.\n\n" "Therefore, changing core units of measure in a running database is not recommended.", self.name, ) } } @api.constrains('category_id', 'uom_type', 'active') def _check_category_reference_uniqueness(self): """ Force the existence of only one UoM reference per category NOTE: this is a constraint on the all table. This might not be a good practice, but this is not possible to do it in SQL directly. """ category_ids = self.mapped('category_id').ids self.env['uom.uom'].flush(['category_id', 'uom_type', 'active']) self._cr.execute(""" SELECT C.id AS category_id, count(U.id) AS uom_count FROM uom_category C LEFT JOIN uom_uom U ON C.id = U.category_id AND uom_type = 'reference' AND U.active = 't' WHERE C.id IN %s GROUP BY C.id """, (tuple(category_ids),)) for uom_data in self._cr.dictfetchall(): if uom_data['uom_count'] == 0: raise ValidationError(_("UoM category %s should have a reference unit of measure. If you just created a new category, please record the 'reference' unit first.") % (self.env['uom.category'].browse(uom_data['category_id']).name,)) if uom_data['uom_count'] > 1: raise ValidationError(_("UoM category %s should only have one reference unit of measure.") % (self.env['uom.category'].browse(uom_data['category_id']).name,)) @api.constrains('category_id') def _validate_uom_category(self): for uom in self: reference_uoms = self.env['uom.uom'].search([ ('category_id', '=', uom.category_id.id), ('uom_type', '=', 'reference')]) if len(reference_uoms) > 1: raise ValidationError(_("UoM category %s should only have one reference unit of measure.") % (self.category_id.name)) @api.model_create_multi def create(self, vals_list): for values in vals_list: if 'factor_inv' in values: factor_inv = values.pop('factor_inv') values['factor'] = factor_inv and (1.0 / factor_inv) or 0.0 return super(UoM, self).create(vals_list) def write(self, values): if 'factor_inv' in values: factor_inv = values.pop('factor_inv') values['factor'] = factor_inv and (1.0 / factor_inv) or 0.0 return super(UoM, self).write(values) @api.ondelete(at_uninstall=False) def _unlink_except_master_data(self): locked_uoms = self._filter_protected_uoms() if locked_uoms: raise UserError(_( "The following units of measure are used by the system and cannot be deleted: %s\nYou can archive them instead.", ", ".join(locked_uoms.mapped('name')), )) @api.model def name_create(self, name): """ The UoM category and factor are required, so we'll have to add temporary values for imported UoMs """ values = { self._rec_name: name, 'factor': 1 } # look for the category based on the english name, i.e. no context on purpose! # TODO: should find a way to have it translated but not created until actually used if not self._context.get('default_category_id'): EnglishUoMCateg = self.env['uom.category'].with_context({}) misc_category = EnglishUoMCateg.search([('name', '=', 'Unsorted/Imported Units')]) if misc_category: values['category_id'] = misc_category.id else: values['category_id'] = EnglishUoMCateg.name_create('Unsorted/Imported Units')[0] new_uom = self.create(values) return new_uom.name_get()[0] def _compute_quantity(self, qty, to_unit, round=True, rounding_method='UP', raise_if_failure=True): """ Convert the given quantity from the current UoM `self` into a given one :param qty: the quantity to convert :param to_unit: the destination UoM record (uom.uom) :param raise_if_failure: only if the conversion is not possible - if true, raise an exception if the conversion is not possible (different UoM category), - otherwise, return the initial quantity """ if not self: return qty self.ensure_one() if self.category_id.id != to_unit.category_id.id: if raise_if_failure: raise UserError(_('The unit of measure %s defined on the order line doesn\'t belong to the same category as the unit of measure %s defined on the product. Please correct the unit of measure defined on the order line or on the product, they should belong to the same category.') % (self.name, to_unit.name)) else: return qty amount = qty / self.factor if to_unit: amount = amount * to_unit.factor if round: amount = tools.float_round(amount, precision_rounding=to_unit.rounding, rounding_method=rounding_method) return amount def _compute_price(self, price, to_unit): self.ensure_one() if not self or not price or not to_unit or self == to_unit: return price if self.category_id.id != to_unit.category_id.id: return price amount = price * self.factor if to_unit: amount = amount / to_unit.factor return amount def _filter_protected_uoms(self): """Verifies self does not contain protected uoms.""" linked_model_data = self.env['ir.model.data'].search([ ('model', '=', self._name), ('res_id', 'in', self.ids), ('module', '=', 'uom'), ('name', 'not in', self._unprotected_uom_xml_ids()), ]) if not linked_model_data: return self.browse() else: return self.browse(set(linked_model_data.mapped('res_id')))