[IMP] base: store explicit field.translate to database

before this commit:
| field.translate in orm | ir_model_field.translate in database |
| ---------------------- | ------------------------------------ |
| False                  | False                                |
| True                   | True                                 |
| html_translate         | True                                 |
| xml_translate          | True                                 |

after this commit:
| field.translate in orm | ir_model_field.translate in database |
| ---------------------- | ------------------------------------ |
| False                  | NULL                                 |
| True                   | 'standard'                           |
| html_translate         | 'html_translate'                     |
| xml_translate          | 'xml_translate'                      |

closes #219406

Related: odoo/enterprise#90413
Related: odoo/upgrade#8085
Related: odoo/upgrade-util#296
Signed-off-by: Raphael Collet <[email protected]>

Author: HydrionBurst

addons/web/tests/test_translate.py

@@ -12,7 +12,7 @@ def setUpClass(cls):
             'name': 'x_html_test',
             'ttype': 'html',
             'model_id': cls.category.id,
-            'translate': True,
+            'translate': 'html_translate',
         })
 
     def test_web_override_translations(self):

odoo/addons/base/models/ir_model.py

@@ -17,7 +17,7 @@
 from odoo.fields import Command, Domain
 from odoo.tools import frozendict, reset_cached_properties, split_every, sql, unique, OrderedSet, SQL
 from odoo.tools.safe_eval import safe_eval, datetime, dateutil, time
-from odoo.tools.translate import _, LazyTranslate
+from odoo.tools.translate import FIELD_TRANSLATE, LazyTranslate, _
 
 _lt = LazyTranslate(__name__)
 _logger = logging.getLogger(__name__)
@@ -533,7 +533,11 @@ class IrModelFields(models.Model):
     required = fields.Boolean()
     readonly = fields.Boolean()
     index = fields.Boolean(string='Indexed')
-    translate = fields.Boolean(string='Translatable', help="Whether values for this field can be translated (enables the translation mechanism for that field)")
+    translate = fields.Selection([
+        ('standard', 'Translate as a whole'),
+        ('html_translate', 'Translate HTML terms'),
+        ('xml_translate', 'Translate XML terms'),
+    ], string='Translatable', help="Whether values for this field can be translated (enables the translation mechanism for that field)")
     company_dependent = fields.Boolean(string='Company Dependent', help="Whether values for this field is company dependent", readonly=True)
     size = fields.Integer()
     state = fields.Selection([('manual', 'Custom Field'), ('base', 'Base Field')], string='Type', default='manual', required=True, readonly=True, index=True)
@@ -993,6 +997,9 @@ def unlink(self):
     def create(self, vals_list):
         IrModel = self.env['ir.model']
         for vals in vals_list:
+            if vals.get('translate') and not isinstance(vals['translate'], str):
+                _logger.warning("Deprecated since Odoo 19, ir.model.fields.translate becomes Selection, the value should be a string")
+                vals['translate'] = 'html_translate' if vals.get('ttype') == 'html' else 'standard'
             if 'model_id' in vals:
                 vals['model'] = IrModel.browse(vals['model_id']).model
 
@@ -1073,6 +1080,10 @@ def write(self, vals):
             if column_name in vals:
                 del vals[column_name]
 
+        if vals.get('translate') and not isinstance(vals['translate'], str):
+            _logger.warning("Deprecated since Odoo 19, ir.model.fields.translate becomes Selection, the value should be a string")
+            vals['translate'] = 'html_translate' if vals.get('ttype') == 'html' else 'standard'
+
         res = super(IrModelFields, self).write(vals)
 
         self.env.flush_all()
@@ -1119,6 +1130,7 @@ def _compute_display_name(self):
 
     def _reflect_field_params(self, field, model_id):
         """ Return the values to write to the database for the given field. """
+        translate = next(k for k, v in FIELD_TRANSLATE.items() if v == field.translate)
         return {
             'model_id': model_id,
             'model': field.model_name,
@@ -1137,7 +1149,7 @@ def _reflect_field_params(self, field, model_id):
             'required': bool(field.required),
             'selectable': bool(field.search or field.store),
             'size': getattr(field, 'size', None),
-            'translate': bool(field.translate),
+            'translate': translate,
             'company_dependent': bool(field.company_dependent),
             'relation_field': field.inverse_name if field.type == 'one2many' else None,
             'relation_table': field.relation if field.type == 'many2many' else None,
@@ -1252,7 +1264,10 @@ def _instanciate_attrs(self, field_data):
             'company_dependent': bool(field_data['company_dependent']),
         }
         if field_data['ttype'] in ('char', 'text', 'html'):
-            attrs['translate'] = bool(field_data['translate'])
+            attrs['translate'] = FIELD_TRANSLATE.get(
+                field_data['translate'],
+                True
+            )
             if field_data['ttype'] == 'char':
                 attrs['size'] = field_data['size'] or None
             elif field_data['ttype'] == 'html':

odoo/addons/test_orm/tests/test_schema.py

@@ -1,5 +1,6 @@
 from odoo.fields import Domain
 from odoo.tests import common
+from odoo.tools.translate import FIELD_TRANSLATE
 
 from odoo.addons.base.models.ir_model import field_xmlid, model_xmlid, selection_xmlid
 
@@ -195,7 +196,7 @@ def test_models_fields(self):
                         self.assertEqual(ir_field.readonly, bool(field.readonly))
                         self.assertEqual(ir_field.required, bool(field.required))
                         self.assertEqual(ir_field.selectable, bool(field.search or field.store))
-                        self.assertEqual(ir_field.translate, bool(field.translate))
+                        self.assertEqual(FIELD_TRANSLATE.get(ir_field.translate or None, True), field.translate)
                         if field.relational:
                             self.assertEqual(ir_field.relation, field.comodel_name)
                         if field.type == 'one2many' and field.store:

odoo/modules/loading.py

@@ -377,8 +377,8 @@ def load_modules(
 
         if update_module and tools.sql.table_exists(cr, 'ir_model_fields'):
             # determine the fields which are currently translated in the database
-            cr.execute("SELECT model || '.' || name FROM ir_model_fields WHERE translate IS TRUE")
-            registry._database_translated_fields = {row[0] for row in cr.fetchall()}
+            cr.execute("SELECT model || '.' || name, translate FROM ir_model_fields WHERE translate IS NOT NULL")
+            registry._database_translated_fields = dict(cr.fetchall())
 
             # determine the fields which are currently company dependent in the database
             if odoo.tools.sql.column_exists(cr, 'ir_model_fields', 'company_dependent'):
@@ -455,7 +455,7 @@ def load_modules(
         if update_module:
             # set up the registry without the patch for translated fields
             database_translated_fields = registry._database_translated_fields
-            registry._database_translated_fields = set()
+            registry._database_translated_fields = {}
             registry._setup_models__(cr, [])  # incremental setup
             # determine which translated fields should no longer be translated,
             # and make their model fix the database schema

odoo/orm/model_classes.py

@@ -19,6 +19,7 @@
     frozendict,
     sql,
 )
+from odoo.tools.translate import FIELD_TRANSLATE
 
 if typing.TYPE_CHECKING:
     from odoo.api import Environment
@@ -382,9 +383,13 @@ def _setup(model_cls: type[BaseModel], env: Environment):
                 field._args__['translate'] for field in reversed(fields_) if 'translate' in field._args__
             ), False)
             if not translate:
+                field_translate = FIELD_TRANSLATE.get(
+                    model_cls.pool._database_translated_fields[f'{model_cls._name}.{name}'],
+                    True
+                )
                 # patch the field definition by adding an override
                 _logger.debug("Patching %s.%s with translate=True", model_cls._name, name)
-                fields_.append(type(fields_[0])(translate=True))
+                fields_.append(type(fields_[0])(translate=field_translate))
         if f'{model_cls._name}.{name}' in model_cls.pool._database_company_dependent_fields:
             # the field is currently company dependent in the database; ensure
             # the field is company dependent to avoid converting its column to

odoo/orm/registry.py

@@ -220,7 +220,7 @@ def init(self, db_name: str) -> None:
 
         self.models: dict[str, type[BaseModel]] = {}    # model name/model instance mapping
         self._sql_constraints = set()  # type: ignore
-        self._database_translated_fields: set[str] = set()  # names of translated fields in database "{model}.{field_name}"
+        self._database_translated_fields: dict[str, str] = {}  # names and translate function names of translated fields in database {"{model}.{field_name}": "translate_func"}
         self._database_company_dependent_fields: set[str] = set()  # names of company dependent fields in database
         if config['test_enable']:
             from odoo.tests.result import OdooTestResult  # noqa: PLC0415

odoo/tools/translate.py

@@ -79,6 +79,13 @@
 
 TRANSLATED_ATTRS.update({f't-attf-{attr}' for attr in TRANSLATED_ATTRS})
 
+# {column value of "ir_model_fields"."translate": orm field.translate}
+FIELD_TRANSLATE = {
+    None: False,
+    'standard': True,
+}
+
+
 def is_translatable_attrib(key):
     return key in TRANSLATED_ATTRS or key.endswith('.translate')
 
@@ -387,6 +394,9 @@ def is_text(term):
 
 xml_translate.term_adapter = xml_term_adapter
 
+FIELD_TRANSLATE['html_translate'] = html_translate
+FIELD_TRANSLATE['xml_translate'] = xml_translate
+
 
 def get_translation(module: str, lang: str, source: str, args: tuple | dict) -> str:
     """Translate and format using a module, language, source text and args."""