web/web_timeline/static/src/views/timeline/timeline_arch_parser.esm.js

/** @odoo-module **/
/**
 * Copyright 2024 Tecnativa - Carlos López
 * License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 */
import {_t} from "@web/core/l10n/translation";
import {archParseBoolean} from "@web/views/utils";
import {parseExpr} from "@web/core/py_js/py";
import {visitXML} from "@web/core/utils/xml";

const MODES = ["day", "week", "month", "fit"];

export class TimelineParseArchError extends Error {}

export class TimelineArchParser {
    parse(arch, fields) {
        const archInfo = {
            colors: [],
            class: "",
            templateDocs: {},
            min_height: 300,
            mode: "fit",
            canCreate: true,
            canUpdate: true,
            canDelete: true,
            options: {
                groupOrder: "order",
                orientation: {axis: "both", item: "top"},
                selectable: true,
                multiselect: true,
                showCurrentTime: true,
                stack: true,
                margin: {item: 2},
                zoomKey: "ctrlKey",
            },
        };
        const fieldNames = fields.display_name ? ["display_name"] : [];
        visitXML(arch, (node) => {
            switch (node.tagName) {
                case "timeline": {
                    if (!node.hasAttribute("date_start")) {
                        throw new TimelineParseArchError(
                            _t("Timeline view has not defined 'date_start' attribute.")
                        );
                    }
                    if (!node.hasAttribute("default_group_by")) {
                        throw new TimelineParseArchError(
                            _t(
                                "Timeline view has not defined 'default_group_by' attribute."
                            )
                        );
                    }
                    archInfo.date_start = node.getAttribute("date_start");
                    archInfo.default_group_by = node.getAttribute("default_group_by");
                    if (node.hasAttribute("class")) {
                        archInfo.class = node.getAttribute("class");
                    }
                    if (node.hasAttribute("date_stop")) {
                        archInfo.date_stop = node.getAttribute("date_stop");
                    }
                    if (node.hasAttribute("date_delay")) {
                        archInfo.date_delay = node.getAttribute("date_delay");
                    }
                    if (node.hasAttribute("colors")) {
                        archInfo.colors = this.parse_colors(
                            node.getAttribute("colors")
                        );
                    }
                    if (node.hasAttribute("dependency_arrow")) {
                        archInfo.dependency_arrow =
                            node.getAttribute("dependency_arrow");
                    }
                    if (node.hasAttribute("stack")) {
                        archInfo.options.stack = archParseBoolean(
                            node.getAttribute("stack"),
                            true
                        );
                    }
                    if (node.hasAttribute("zoomKey")) {
                        archInfo.options.zoomKey =
                            node.getAttribute("zoomKey") || "ctrlKey";
                    }
                    if (node.hasAttribute("margin")) {
                        archInfo.options.margin = node.getAttribute("margin")
                            ? JSON.parse(node.getAttribute("margin"))
                            : {item: 2};
                    }
                    if (node.hasAttribute("min_height")) {
                        archInfo.min_height = node.getAttribute("min_height");
                    }
                    if (node.hasAttribute("mode")) {
                        archInfo.mode = node.getAttribute("mode");
                        if (!MODES.includes(archInfo.mode)) {
                            throw new TimelineParseArchError(
                                `Timeline view cannot display mode: ${archInfo.mode}`
                            );
                        }
                    }
                    if (node.hasAttribute("event_open_popup")) {
                        archInfo.open_popup_action = archParseBoolean(
                            node.getAttribute("event_open_popup")
                        );
                    }
                    if (node.hasAttribute("create")) {
                        archInfo.canCreate = archParseBoolean(
                            node.getAttribute("create"),
                            true
                        );
                    }
                    if (node.hasAttribute("edit")) {
                        archInfo.canUpdate = archParseBoolean(
                            node.getAttribute("edit"),
                            true
                        );
                    }
                    if (node.hasAttribute("delete")) {
                        archInfo.canDelete = archParseBoolean(
                            node.getAttribute("delete"),
                            true
                        );
                    }
                    break;
                }
                case "field": {
                    const fieldName = node.getAttribute("name");
                    if (!fieldNames.includes(fieldName)) {
                        fieldNames.push(fieldName);
                    }
                    break;
                }
                case "t": {
                    if (node.hasAttribute("t-name")) {
                        archInfo.templateDocs[node.getAttribute("t-name")] = node;
                        break;
                    }
                }
            }
        });

        const fieldsToGather = [
            "date_start",
            "date_stop",
            "default_group_by",
            "progress",
            "date_delay",
            archInfo.default_group_by,
        ];

        for (const field of fieldsToGather) {
            if (archInfo[field] && !fieldNames.includes(archInfo[field])) {
                fieldNames.push(archInfo[field]);
            }
        }
        for (const color of archInfo.colors) {
            if (!fieldNames.includes(color.field)) {
                fieldNames.push(color.field);
            }
        }

        if (
            archInfo.dependency_arrow &&
            !fieldNames.includes(archInfo.dependency_arrow)
        ) {
            fieldNames.push(archInfo.dependency_arrow);
        }
        archInfo.fieldNames = fieldNames;
        return archInfo;
    }
    /**
     * Parse the colors attribute.
     * @param {Array} colors
     * @returns {Array}
     */
    parse_colors(colors) {
        if (colors) {
            return colors
                .split(";")
                .filter(Boolean)
                .map((color_pair) => {
                    const [color, expr] = color_pair.split(":");
                    const ast = parseExpr(expr);
                    return {
                        color: color,
                        field: ast.left.value,
                        ast,
                    };
                });
        }
        return [];
    }
}