[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/convert_bootstrap.py

@@ -37,7 +37,7 @@
 from .inherit import for_each_inherit
 from .misc import SelfPrintEvalContext
 from .pg import column_exists, get_value_or_en_translation, table_exists
-from .records import edit_view
+from .views.records import edit_view
 
 # python3 shims
 try:

src/util/domains.py

@@ -31,8 +31,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.records import remove_view
 
 _logger = logging.getLogger(__name__)
 

src/util/models.py

@@ -48,7 +48,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.records 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/modules.py

@@ -4,7 +4,6 @@
 import logging
 import os
 import re
-from contextlib import contextmanager
 from operator import itemgetter
 
 import lxml
@@ -14,7 +13,6 @@
     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
@@ -44,7 +42,7 @@
     table_exists,
     target_of,
 )
-from .report import add_to_migration_reports
+from .views.records import add_view, edit_view, remove_view  # noqa: F401
 
 _logger = logging.getLogger(__name__)
 
@@ -55,249 +53,6 @@
     basestring = unicode = str
 
 
-def remove_view(cr, xml_id=None, view_id=None, silent=False, key=None):
-    """
-    Remove a view and all its descendants.
-
-    This function recursively deletes the given view and its inherited views, as long as
-    they are part of a module. It will fail as soon as a custom view exists anywhere in
-    the hierarchy. It also removes multi-website COWed views.
-
-    :param str xml_id: optional, the xml_id of the view to remove
-    :param int view_id: optional, the ID of the view to remove
-    :param bool silent: whether to show in the logs disabled custom views
-    :param str or None key: key used to detect multi-website COWed views, if `None` then
-                                set to `xml_id` if provided, otherwise set to the xml_id
-                                referencing the view with ID `view_id` if any
-
-    .. warning::
-       Either `xml_id` or `view_id` must be set. Specifying both will raise an error.
-    """
-    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):
-    """
-    Context manager to edit a view's arch.
-
-    This function returns a context manager that may yield a parsed arch of a view as an
-    `etree Element <https://lxml.de/tutorial.html#the-element-class>`_. Any changes done
-    in the returned object will be written back to the database upon exit of the context
-    manager, updating also the translated versions of the arch. Since the function may not
-    yield, use :func:`~odoo.upgrade.util.misc.skippable_cm` to avoid errors.
-
-    .. code-block:: python
-
-        with util.skippable_cm(), util.edit_view(cr, "xml.id") as arch:
-            arch.attrib["string"] = "My Form"
-
-    To select the target view to edit use either `xmlid` or `view_id`, not both.
-
-    When the view is identified by `view_id`, the arch is always yielded if the view
-    exists, with disregard to any `noupdate` flag it may have associated. When `xmlid` is
-    set, if the view `noupdate` flag is `True` then the arch will not be yielded *unless*
-    `skip_if_not_noupdate` is set to `False`. If `noupdate` is `False`, the view will be
-    yielded for edit.
-
-    If the `active` argument is not `None`, the `active` flag of the view will be set
-    accordingly.
-
-    .. warning::
-       The default value of `active` is `True`, therefore views are always *activated* by
-       default. To avoid inadvertently activating views, pass `None` as `active` parameter.
-
-    :param str xmlid: optional, xml_id of the view edit
-    :param int view_id: optional, ID of the view to edit
-    :param bool skip_if_not_noupdate: whether to force the edit of views requested via
-                                     `xmlid` parameter even if they are flagged as
-                                     `noupdate=True`, ignored if `view_id` is set
-    :param bool or None active: active flag value to set, nothing is set when `None`
-    :return: a context manager that yields the parsed arch, upon exit the context manager
-             writes back the changes.
-    """
-    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").strip())
-
-            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):