[REF] util.views: create new package, move views-related code

Changes:
- move `util.views_convert` -> `util.views.convert`
- move records-related views helpers into `util.views.records`
- move `util.convert_bootstrap` -> `util.views.bootstrap`
- move some helpers from `util.records` -> `util.views.records`
- add version checks for views/html conversion helpers

Author: andreabak

src/util/__init__.py

@@ -16,3 +16,4 @@
 from .records import *
 from .report import *
 from .specific import *
+from .views import *

src/util/models.py

@@ -25,8 +25,9 @@
 
 # avoid namespace clash
 from .pg import rename_table as pg_rename_table
-from .records import _rm_refs, remove_records, remove_view, replace_record_references_batch
+from .records import _rm_refs, remove_records, replace_record_references_batch
 from .report import add_to_migration_reports
+from .views import remove_view
 
 _logger = logging.getLogger(__name__)
 

src/util/modules.py

@@ -39,7 +39,8 @@
 from .models import delete_model
 from .orm import env, flush
 from .pg import column_exists, table_exists, target_of
-from .records import ref, remove_menus, remove_records, remove_view, replace_record_references_batch
+from .records import ref, remove_menus, remove_records, replace_record_references_batch
+from .views import remove_view
 
 INSTALLED_MODULE_STATES = ("installed", "to install", "to upgrade")
 NO_AUTOINSTALL = str2bool(os.getenv("UPG_NO_AUTOINSTALL", "0")) if version_gte("15.0") else False

src/util/records.py

@@ -2,7 +2,6 @@
 import logging
 import os
 import re
-from contextlib import contextmanager
 from operator import itemgetter
 
 import lxml
@@ -12,12 +11,12 @@
     from odoo import release
     from odoo.tools.convert import xml_import
     from odoo.tools.misc import file_open
-    from odoo.tools.translate import xml_translate
 except ImportError:
     from openerp import release
     from openerp.tools.convert import xml_import
     from openerp.tools.misc import file_open
 
+from . import views
 from .const import NEARLYWARN
 from .exceptions import MigrationError
 from .helpers import _get_theme_models, _ir_values_value, _validate_model, model_of_table, table_of_model
@@ -41,7 +40,6 @@
     table_exists,
     target_of,
 )
-from .report import add_to_migration_reports
 
 _logger = logging.getLogger(__name__)
 
@@ -52,219 +50,6 @@
     basestring = unicode = str
 
 
-def remove_view(cr, xml_id=None, view_id=None, silent=False, key=None):
-    """
-    Recursively delete the given view and its inherited views, as long as they
-    are part of a module. Will crash as soon as a custom view exists anywhere
-    in the hierarchy.
-
-    Also handle multi-website COWed views.
-    """
-    assert bool(xml_id) ^ bool(view_id)
-    if xml_id:
-        view_id = ref(cr, xml_id)
-        if view_id:
-            module, _, name = xml_id.partition(".")
-            cr.execute("SELECT model FROM ir_model_data WHERE module=%s AND name=%s", [module, name])
-
-            [model] = cr.fetchone()
-            if model != "ir.ui.view":
-                raise ValueError("%r should point to a 'ir.ui.view', not a %r" % (xml_id, model))
-    else:
-        # search matching xmlid for logging or renaming of custom views
-        xml_id = "?"
-        if not key:
-            cr.execute("SELECT module, name FROM ir_model_data WHERE model='ir.ui.view' AND res_id=%s", [view_id])
-            if cr.rowcount:
-                xml_id = "%s.%s" % cr.fetchone()
-
-    # From given or determined xml_id, the views duplicated in a multi-website
-    # context are to be found and removed.
-    if xml_id != "?" and column_exists(cr, "ir_ui_view", "key"):
-        cr.execute("SELECT id FROM ir_ui_view WHERE key = %s AND id != %s", [xml_id, view_id])
-        for [v_id] in cr.fetchall():
-            remove_view(cr, view_id=v_id, silent=silent, key=xml_id)
-
-    if not view_id:
-        return
-
-    cr.execute(
-        """
-        SELECT v.id, x.module || '.' || x.name, v.name
-        FROM ir_ui_view v LEFT JOIN
-           ir_model_data x ON (v.id = x.res_id AND x.model = 'ir.ui.view' AND x.module !~ '^_')
-        WHERE v.inherit_id = %s;
-    """,
-        [view_id],
-    )
-    for child_id, child_xml_id, child_name in cr.fetchall():
-        if child_xml_id:
-            if not silent:
-                _logger.info(
-                    "remove deprecated built-in view %s (ID %s) as parent view %s (ID %s) is going to be removed",
-                    child_xml_id,
-                    child_id,
-                    xml_id,
-                    view_id,
-                )
-            remove_view(cr, child_xml_id, silent=True)
-        else:
-            if not silent:
-                _logger.warning(
-                    "deactivate deprecated custom view with ID %s as parent view %s (ID %s) is going to be removed",
-                    child_id,
-                    xml_id,
-                    view_id,
-                )
-            disable_view_query = """
-                UPDATE ir_ui_view
-                SET name = (name || ' - old view, inherited from ' || %%s),
-                    inherit_id = NULL
-                    %s
-                    WHERE id = %%s
-            """
-            # In 8.0, disabling requires setting mode to 'primary'
-            extra_set_sql = ""
-            if column_exists(cr, "ir_ui_view", "mode"):
-                extra_set_sql = ",  mode = 'primary' "
-
-            # Column was not present in v7 and it's older version
-            if column_exists(cr, "ir_ui_view", "active"):
-                extra_set_sql += ", active = false "
-
-            disable_view_query = disable_view_query % extra_set_sql
-            cr.execute(disable_view_query, (key or xml_id, child_id))
-            add_to_migration_reports(
-                {"id": child_id, "name": child_name},
-                "Disabled views",
-            )
-    if not silent:
-        _logger.info("remove deprecated %s view %s (ID %s)", key and "COWed" or "built-in", key or xml_id, view_id)
-
-    remove_records(cr, "ir.ui.view", [view_id])
-
-
-@contextmanager
-def edit_view(cr, xmlid=None, view_id=None, skip_if_not_noupdate=True, active=True):
-    """Contextmanager that may yield etree arch of a view.
-    As it may not yield, you must use `skippable_cm`
-
-        with util.skippable_cm(), util.edit_view(cr, 'xml.id') as arch:
-            arch.attrib['string'] = 'My Form'
-
-    When view_id is passed to identify a view, view's arch will always yield to be edited because
-    we assume that xmlid for such view does not exist to check its noupdate flag.
-
-    If view's noupdate=false then the arch will not be yielded for edit unless skip_if_not_noupdate=False,
-    because when noupdate=False we assume it is a standard view that will be updated by the ORM later on anyways.
-
-    If view's noupdate=True, the view will be yielded for edit.
-
-    If the `active` argument is not None, the view will be (de)activated accordingly.
-
-    For more details, see discussion in: https://github.com/odoo/upgrade-specific/pull/4216
-    """
-    assert bool(xmlid) ^ bool(view_id), "You Must specify either xmlid or view_id"
-    noupdate = True
-    if xmlid:
-        if "." not in xmlid:
-            raise ValueError("Please use fully qualified name <module>.<name>")
-
-        module, _, name = xmlid.partition(".")
-        cr.execute(
-            """
-                SELECT res_id, noupdate
-                  FROM ir_model_data
-                 WHERE module = %s
-                   AND name = %s
-        """,
-            [module, name],
-        )
-        data = cr.fetchone()
-        if data:
-            view_id, noupdate = data
-
-    if view_id and not (skip_if_not_noupdate and not noupdate):
-        arch_col = "arch_db" if column_exists(cr, "ir_ui_view", "arch_db") else "arch"
-        jsonb_column = column_type(cr, "ir_ui_view", arch_col) == "jsonb"
-        cr.execute(
-            """
-                SELECT {arch}
-                  FROM ir_ui_view
-                 WHERE id=%s
-            """.format(
-                arch=arch_col,
-            ),
-            [view_id],
-        )
-        [arch] = cr.fetchone() or [None]
-        if arch:
-
-            def parse(arch):
-                arch = arch.encode("utf-8") if isinstance(arch, unicode) else arch
-                return lxml.etree.fromstring(arch.replace(b"&#13;\n", b"\n"))
-
-            if jsonb_column:
-
-                def get_trans_terms(value):
-                    terms = []
-                    xml_translate(terms.append, value)
-                    return terms
-
-                translation_terms = {lang: get_trans_terms(value) for lang, value in arch.items()}
-                arch_etree = parse(arch["en_US"])
-                yield arch_etree
-                new_arch = lxml.etree.tostring(arch_etree, encoding="unicode")
-                terms_en = translation_terms["en_US"]
-                arch_column_value = Json(
-                    {
-                        lang: xml_translate(dict(zip(terms_en, terms)).get, new_arch)
-                        for lang, terms in translation_terms.items()
-                    }
-                )
-            else:
-                arch_etree = parse(arch)
-                yield arch_etree
-                arch_column_value = lxml.etree.tostring(arch_etree, encoding="unicode")
-
-            set_active = ", active={}".format(bool(active)) if active is not None else ""
-            cr.execute(
-                "UPDATE ir_ui_view SET {arch}=%s{set_active} WHERE id=%s".format(arch=arch_col, set_active=set_active),
-                [arch_column_value, view_id],
-            )
-
-
-def add_view(cr, name, model, view_type, arch_db, inherit_xml_id=None, priority=16):
-    inherit_id = None
-    if inherit_xml_id:
-        inherit_id = ref(cr, inherit_xml_id)
-        if not inherit_id:
-            raise ValueError(
-                "Unable to add view '%s' because its inherited view '%s' cannot be found!" % (name, inherit_xml_id)
-            )
-    arch_col = "arch_db" if column_exists(cr, "ir_ui_view", "arch_db") else "arch"
-    jsonb_column = column_type(cr, "ir_ui_view", arch_col) == "jsonb"
-    arch_column_value = Json({"en_US": arch_db}) if jsonb_column else arch_db
-    cr.execute(
-        """
-        INSERT INTO ir_ui_view(name, "type",  model, inherit_id, mode, active, priority, %s)
-        VALUES(%%(name)s, %%(view_type)s, %%(model)s, %%(inherit_id)s, %%(mode)s, 't', %%(priority)s, %%(arch_db)s)
-        RETURNING id
-    """
-        % arch_col,
-        {
-            "name": name,
-            "view_type": view_type,
-            "model": model,
-            "inherit_id": inherit_id,
-            "mode": "extension" if inherit_id else "primary",
-            "priority": priority,
-            "arch_db": arch_column_value,
-        },
-    )
-    return cr.fetchone()[0]
-
-
 # fmt:off
 if version_gte("saas~14.3"):
     def remove_asset(cr, name):
@@ -273,7 +58,7 @@ def remove_asset(cr, name):
             remove_records(cr, "ir.asset", [aid for aid, in cr.fetchall()])
 else:
     def remove_asset(cr, name):
-        remove_view(cr, name, silent=True)
+        views.remove_view(cr, name, silent=True)
 # fmt:on
 
 
@@ -304,7 +89,7 @@ def remove_record(cr, name):
     # deleguate to the right method
     if model == "ir.ui.view":
         _logger.log(NEARLYWARN, "Removing view %r", name)
-        return remove_view(cr, view_id=res_id)
+        return views.remove_view(cr, view_id=res_id)
 
     if model == "ir.ui.menu":
         _logger.log(NEARLYWARN, "Removing menu %r", name)
@@ -332,7 +117,7 @@ def remove_records(cr, model, ids):
         )
         if theme_copy_model == "ir.ui.view":
             for (view_id,) in cr.fetchall():
-                remove_view(cr, view_id=view_id)
+                views.remove_view(cr, view_id=view_id)
         else:
             remove_records(cr, theme_copy_model, [rid for rid, in cr.fetchall()])
 
@@ -347,7 +132,7 @@ def remove_records(cr, model, ids):
                 remove_menus(cr, [menu_id for menu_id, in cr.fetchall()])
             elif inh.model == "ir.ui.view":
                 for (view_id,) in cr.fetchall():
-                    remove_view(cr, view_id=view_id)
+                    views.remove_view(cr, view_id=view_id)
             else:
                 remove_records(cr, inh.model, [rid for rid, in cr.fetchall()])
 
@@ -399,7 +184,7 @@ def _rm_refs(cr, model, ids=None):
             if ref_model == "ir.ui.view":
                 cr.execute("SELECT id" + query_tail, [needle])
                 for (view_id,) in cr.fetchall():
-                    remove_view(cr, view_id=view_id, silent=True)
+                    views.remove_view(cr, view_id=view_id, silent=True)
             elif ref_model == "ir.ui.menu":
                 cr.execute("SELECT id" + query_tail, [needle])
                 menu_ids = tuple(m[0] for m in cr.fetchall())

src/util/views/__init__.py

@@ -0,0 +1 @@
+from .records import *

src/util/convert_bootstrap.py renamed to src/util/views/bootstrap.py

@@ -11,7 +11,7 @@
 except ImportError:
     from distutils.version import StrictVersion as Version  # N.B. deprecated, will be removed in py3.12
 
-from .views_convert import (
+from .convert import (
     ALL,
     BE,
     BS,