oca-technical/odoo-bringout-oca-automation-automation_oca/automation_oca/models/automation_configuration.py

# Copyright 2024 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from collections import defaultdict

from odoo import _, api, fields, models
from odoo.exceptions import ValidationError
from odoo.tools.safe_eval import (
    datetime as safe_datetime,
    dateutil as safe_dateutil,
    safe_eval,
    time as safe_time,
)


class AutomationConfiguration(models.Model):

    _name = "automation.configuration"
    _description = "Automation Configuration"
    _inherit = ["mail.thread"]

    name = fields.Char(required=True)
    active = fields.Boolean(default=True)
    tag_ids = fields.Many2many("automation.tag")
    company_id = fields.Many2one("res.company")
    domain = fields.Char(
        required=True,
        default="[]",
        compute="_compute_domain",
        help="""
        Filter to apply
        Following special variable can be used in filter :
         * datetime
         * dateutil
         * time
         * user
         * ref """,
    )
    editable_domain = fields.Char(
        required=True,
        default="[]",
        help="""Filter to apply
        Following special variable can be used in filter :
         * datetime
         * dateutil
         * time
         * user
         * ref """,
    )
    model_id = fields.Many2one(
        "ir.model",
        domain=[("is_mail_thread", "=", True)],
        required=True,
        ondelete="cascade",
        help="Model where the configuration is applied",
    )
    filter_id = fields.Many2one("automation.filter")
    filter_domain = fields.Binary(compute="_compute_filter_domain")
    model = fields.Char(related="model_id.model")
    field_id = fields.Many2one(
        "ir.model.fields",
        domain="[('model_id', '=', model_id), "
        "('ttype', 'in', ['char', 'selection', 'integer', 'text', 'many2one'])]",
        help="Used to avoid duplicates",
    )
    is_periodic = fields.Boolean(
        help="Mark it if you want to make the execution periodic"
    )
    # The idea of flow of states will be:
    # draft -> run       -> done -> draft (for periodic execution)
    #       -> on demand -> done -> draft (for on demand execution)
    state = fields.Selection(
        [
            ("draft", "Draft"),
            ("periodic", "Periodic"),
            ("ondemand", "On demand"),
            ("done", "Done"),
        ],
        default="draft",
        required=True,
        group_expand="_group_expand_states",
    )
    automation_step_ids = fields.One2many(
        "automation.configuration.step", inverse_name="configuration_id"
    )
    automation_direct_step_ids = fields.One2many(
        "automation.configuration.step",
        inverse_name="configuration_id",
        domain=[("parent_id", "=", False)],
    )
    record_test_count = fields.Integer(compute="_compute_record_test_count")
    record_count = fields.Integer(compute="_compute_record_count")
    record_done_count = fields.Integer(compute="_compute_record_count")
    record_run_count = fields.Integer(compute="_compute_record_count")
    activity_mail_count = fields.Integer(compute="_compute_activity_count")
    activity_action_count = fields.Integer(compute="_compute_activity_count")
    click_count = fields.Integer(compute="_compute_click_count")
    next_execution_date = fields.Datetime(compute="_compute_next_execution_date")

    @api.depends("filter_id.domain", "filter_id", "editable_domain")
    def _compute_domain(self):
        for record in self:
            record.domain = (
                record.filter_id and record.filter_id.domain
            ) or record.editable_domain

    @api.depends()
    def _compute_click_count(self):
        data = self.env["link.tracker.click"].read_group(
            [("automation_configuration_id", "in", self.ids)],
            [],
            ["automation_configuration_id"],
            lazy=False,
        )
        mapped_data = {d["automation_configuration_id"][0]: d["__count"] for d in data}
        for record in self:
            record.click_count = mapped_data.get(record.id, 0)

    @api.depends()
    def _compute_activity_count(self):
        data = self.env["automation.record.step"].read_group(
            [
                ("configuration_id", "in", self.ids),
                ("state", "=", "done"),
                ("is_test", "=", False),
            ],
            [],
            ["configuration_id", "step_type"],
            lazy=False,
        )
        mapped_data = defaultdict(lambda: {})
        for d in data:
            mapped_data[d["configuration_id"][0]][d["step_type"]] = d["__count"]
        for record in self:
            record.activity_mail_count = mapped_data[record.id].get("mail", 0)
            record.activity_action_count = mapped_data[record.id].get("action", 0)

    @api.depends()
    def _compute_record_count(self):
        data = self.env["automation.record"].read_group(
            [("configuration_id", "in", self.ids), ("is_test", "=", False)],
            [],
            ["configuration_id", "state"],
            lazy=False,
        )
        mapped_data = defaultdict(lambda: {})
        for d in data:
            mapped_data[d["configuration_id"][0]][d["state"]] = d["__count"]
        for record in self:
            record.record_done_count = mapped_data[record.id].get("done", 0)
            record.record_run_count = mapped_data[record.id].get("periodic", 0)
            record.record_count = sum(mapped_data[record.id].values())

    @api.depends()
    def _compute_record_test_count(self):
        data = self.env["automation.record"].read_group(
            [("configuration_id", "in", self.ids), ("is_test", "=", True)],
            [],
            ["configuration_id"],
            lazy=False,
        )
        mapped_data = {d["configuration_id"][0]: d["__count"] for d in data}
        for record in self:
            record.record_test_count = mapped_data.get(record.id, 0)

    @api.depends("model_id")
    def _compute_filter_domain(self):
        for record in self:
            record.filter_domain = (
                [] if not record.model_id else [("model_id", "=", record.model_id.id)]
            )

    @api.depends("state")
    def _compute_next_execution_date(self):
        for record in self:
            if record.state == "periodic":
                record.next_execution_date = self.env.ref(
                    "automation_oca.cron_configuration_run"
                ).nextcall
            else:
                record.next_execution_date = False

    @api.onchange("filter_id")
    def _onchange_filter(self):
        self.model_id = self.filter_id.model_id

    @api.onchange("model_id")
    def _onchange_model(self):
        self.editable_domain = []
        self.filter_id = False
        self.field_id = False
        self.automation_step_ids = [(5, 0, 0)]

    def start_automation(self):
        self.ensure_one()
        if self.state != "draft":
            raise ValidationError(_("State must be in draft in order to start"))
        self.state = "periodic" if self.is_periodic else "ondemand"

    def done_automation(self):
        self.ensure_one()
        self.state = "done"

    def back_to_draft(self):
        self.ensure_one()
        self.state = "draft"

    def cron_automation(self):
        for record in self.search([("state", "=", "periodic")]):
            record.run_automation()

    def _get_eval_context(self):
        """Prepare the context used when evaluating python code
        :returns: dict -- evaluation context given to safe_eval
        """
        return {
            "ref": self.env.ref,
            "user": self.env.user,
            "time": safe_time,
            "datetime": safe_datetime,
            "dateutil": safe_dateutil,
        }

    def _get_automation_records_to_create(self):
        """
        We will find all the records that fulfill the domain but don't have a record created.
        Also, we need to check by autencity field if defined.

        In order to do this, we will add some extra joins on the query of the domain
        """
        eval_context = self._get_eval_context()
        domain = safe_eval(self.domain, eval_context)
        Record = self.env[self.model_id.model]
        if self.company_id and "company_id" in Record._fields:
            # In case of company defined, we add only if the records have company field
            domain += [("company_id", "=", self.company_id.id)]
        query = Record._where_calc(domain)
        alias = query.left_join(
            query._tables[Record._table],
            "id",
            "automation_record",
            "res_id",
            "automation_record",
            "{rhs}.model = %s AND {rhs}.configuration_id = %s AND "
            "({rhs}.is_test IS NULL OR NOT {rhs}.is_test)",
            (Record._name, self.id),
        )
        query.add_where("{}.id is NULL".format(alias))
        if self.field_id:
            # In case of unicity field defined, we need to add this
            # left join to find already created records
            linked_tab = query.left_join(
                query._tables[Record._table],
                self.field_id.name,
                Record._table,
                self.field_id.name,
                "linked",
            )
            alias2 = query.left_join(
                linked_tab,
                "id",
                "automation_record",
                "res_id",
                "automation_record_linked",
                "{rhs}.model = %s AND {rhs}.configuration_id = %s AND "
                "({rhs}.is_test IS NULL OR NOT {rhs}.is_test)",
                (Record._name, self.id),
            )
            query.add_where("{}.id is NULL".format(alias2))
            from_clause, where_clause, params = query.get_sql()
            # We also need to find with a group by in order to avoid duplication
            # when we have both records created between two executions
            # (first one has priority)
            query_str = "SELECT {} FROM {} WHERE {}{}{}{} GROUP BY {}".format(
                ", ".join([f'MIN("{next(iter(query._tables))}".id) as id']),
                from_clause,
                where_clause or "TRUE",
                (" ORDER BY %s" % self.order) if query.order else "",
                (" LIMIT %d" % self.limit) if query.limit else "",
                (" OFFSET %d" % self.offset) if query.offset else "",
                "%s.%s" % (query._tables[Record._table], self.field_id.name),
            )
        else:
            query_str, params = query.select()
        self.env.cr.execute(query_str, params)
        return Record.browse([r[0] for r in self.env.cr.fetchall()])

    def run_automation(self):
        self.ensure_one()
        if self.state not in ["periodic", "ondemand"]:
            return
        records = self.env["automation.record"]
        for record in self._get_automation_records_to_create():
            records |= self._create_record(record)
        records.automation_step_ids._trigger_activities()

    def _create_record(self, record, **kwargs):
        return self.env["automation.record"].create(
            self._create_record_vals(record, **kwargs)
        )

    def _create_record_vals(self, record, **kwargs):
        return {
            **kwargs,
            "res_id": record.id,
            "model": record._name,
            "configuration_id": self.id,
            "automation_step_ids": [
                (0, 0, activity._create_record_activity_vals(record))
                for activity in self.automation_direct_step_ids
            ],
        }

    def _group_expand_states(self, states, domain, order):
        """
        This is used to show all the states on the kanban view
        """
        return [key for key, _val in self._fields["state"].selection]

    def save_filter(self):
        self.ensure_one()
        self.filter_id = self.env["automation.filter"].create(
            {
                "name": self.name,
                "domain": self.editable_domain,
                "model_id": self.model_id.id,
            }
        )