# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意，禁止将本产品用于以下任何行为：
# | 1. 任何违反中华人民共和国法律法规的用途；
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为，本团队有权：
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================

"""
定时任务模型模块
=============================================================

该模块定义了定时任务相关的数据库模型。
用于存储系统中的定时任务信息，支持任务的创建、调度和执行。
"""

from django.db import models
from application.models import BaseModel
from utils.common import get_table_name


# =============================================================
# 定时任务模型类
# =============================================================

class Job(BaseModel):
    """
    定时任务模型类

    用于存储系统中的定时任务信息，每个任务代表一个可调度的作业。
    任务支持 Cron 表达式，可以设置执行策略和状态管理。
    继承自 BaseModel，自动包含：
    - id: 主键
    - is_delete: 逻辑删除标识
    - create_user: 创建人
    - create_time: 创建时间
    - update_user: 更新人
    - update_time: 更新时间

    主要业务字段：
    - job_name: 任务名称
    - job_alias: 任务别名
    - job_group: 任务分组
    - job_trigger: 任务触发器
    - status: 任务状态（0-未发布, 1-运行中, 2-暂停, 3-删除）
    - cron_expression: Cron表达式
    - execute_policy: 执行策略（1-立即执行, 2-执行一次, 3-放弃执行）
    - is_sync: 是否同步执行（0-异步, 1-同步）
    - url: 任务URL
    - note: 任务备注
    """

    # ----------------------------------------------------------
    # 状态常量定义
    # ----------------------------------------------------------
    STATUS_CHOICES = (
        (0, "未发布"),  # 未发布状态：任务未启用
        (1, "运行中"),  # 运行中状态：任务正常调度
        (2, "暂停"),  # 暂停状态：任务暂停执行
        (3, "删除"),  # 删除状态：任务已删除
    )

    # ----------------------------------------------------------
    # 执行策略常量定义
    # ----------------------------------------------------------
    POLICY_CHOICES = (
        (1, "立即执行"),  # 立即执行：任务触发后立即执行
        (2, "执行一次"),  # 执行一次：任务只执行一次
        (3, "放弃执行"),  # 放弃执行：任务触发后放弃执行
    )

    # ----------------------------------------------------------
    # 同步标识常量定义
    # ----------------------------------------------------------
    SYNC_CHOICES = (
        (0, "异步"),  # 异步执行：不等待执行结果
        (1, "同步"),  # 同步执行：等待执行结果
    )

    # ----------------------------------------------------------
    # 任务名称
    # ----------------------------------------------------------
    # 字段说明: 任务的显示名称
    # 字段类型: 字符串（CharField）
    # 约束: 非空（null=False），最大长度255字符
    # 索引: 添加了数据库索引（db_index=True）以支持名称搜索
    # 作用: 用于前端展示和日志记录
    job_name = models.CharField(
        max_length=255,
        null=False,
        db_index=True,
        verbose_name="任务名称",
        help_text="任务名称",
        db_comment='任务名称'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 任务别名
    # ----------------------------------------------------------
    # 字段说明: 任务的别名
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True, blank=True），最大长度255字符
    # 作用: 用于展示更友好的任务名称
    job_alias = models.CharField(
        max_length=255,
        null=True,
        blank=True,
        verbose_name="任务别名",
        help_text="任务别名",
        db_comment='任务别名'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 任务分组
    # ----------------------------------------------------------
    # 字段说明: 任务所属分组
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True, blank=True），最大长度255字符
    # 默认值: "DEFAULT"
    # 作用: 对任务进行分类管理，便于批量操作
    job_group = models.CharField(
        max_length=255,
        null=True,
        blank=True,
        verbose_name="任务分组",
        help_text="任务分组",
        default="DEFAULT",
        db_comment='任务分组',  # 数据库字段注释
        db_default="DEFAULT"
    )

    # ----------------------------------------------------------
    # 任务触发器
    # ----------------------------------------------------------
    # 字段说明: 任务触发器标识
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True, blank=True），最大长度255字符
    # 作用: 映射到具体的执行方法，用于内部方法调用
    job_trigger = models.CharField(
        max_length=255,
        null=True,
        blank=True,
        verbose_name="任务触发器",
        help_text="任务触发器",
        db_comment='任务触发器'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 任务状态
    # ----------------------------------------------------------
    # 字段说明: 任务的运行状态
    # 字段类型: 正整数（PositiveIntegerField）
    # 约束: 使用 STATUS_CHOICES 限制可选值，默认值为0（未发布）
    # 可选值: 0-未发布, 1-运行中, 2-暂停, 3-删除
    # 作用: 控制任务是否在调度器中运行
    status = models.PositiveIntegerField(
        choices=STATUS_CHOICES,
        default=0,
        verbose_name="任务状态：0-未发布 1-运行中 2-暂停 3-删除",
        help_text="任务状态：0-未发布 1-运行中 2-暂停 3-删除",
        db_comment='任务状态：0-未发布 1-运行中 2-暂停 3-删除',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # Cron表达式
    # ----------------------------------------------------------
    # 字段说明: 任务的调度规则
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True, blank=True），最大长度255字符
    # 示例: "0 2 * * *" 表示每天凌晨2点执行
    # 作用: 定义任务的执行时间规则
    cron_expression = models.CharField(
        max_length=255,
        null=True,
        blank=True,
        verbose_name="Cron表达式",
        help_text="Cron表达式",
        db_comment='Cron表达式'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 执行策略
    # ----------------------------------------------------------
    # 字段说明: 任务触发后的执行策略
    # 字段类型: 小整数（SmallIntegerField）
    # 约束: 使用 POLICY_CHOICES 限制可选值，默认值为3（放弃执行）
    # 可选值: 1-立即执行, 2-执行一次, 3-放弃执行
    # 作用: 控制任务在触发后的具体执行行为
    execute_policy = models.SmallIntegerField(
        choices=POLICY_CHOICES,
        default=3,
        verbose_name="执行策略：1-立即执行 2-执行一次 3-放弃执行",
        help_text="执行策略：1-立即执行 2-执行一次 3-放弃执行",
        db_comment='执行策略：1-立即执行 2-执行一次 3-放弃执行',  # 数据库字段注释
        db_default=3
    )

    # ----------------------------------------------------------
    # 是否同步执行
    # ----------------------------------------------------------
    # 字段说明: 任务是否同步执行
    # 字段类型: 正整数（PositiveIntegerField）
    # 约束: 使用 SYNC_CHOICES 限制可选值，默认值为0（异步）
    # 可选值: 0-异步, 1-同步
    # 作用: 控制任务执行时是否等待结果返回
    is_sync = models.PositiveIntegerField(
        choices=SYNC_CHOICES,
        default=0,
        verbose_name="是否同步任务：0-否 1-是",
        help_text="是否同步任务：0-否 1-是",
        db_comment='是否同步任务：0-否 1-是',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 任务URL
    # ----------------------------------------------------------
    # 字段说明: 任务调用的URL地址
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True, blank=True），最大长度255字符
    # 作用: 当任务通过HTTP方式执行时，调用此URL
    url = models.CharField(
        max_length=255,
        null=True,
        blank=True,
        verbose_name="任务URL",
        help_text="任务URL",
        db_comment='任务URL'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 任务参数
    # ----------------------------------------------------------
    # 字段说明: 定时任务的执行参数
    # 字段类型: 长文本（TextField）
    # 约束: 允许为空（null=True, blank=True）
    # 存储: JSON格式字符串
    # 作用: 为任务执行提供动态配置参数
    params = models.TextField(
        null=True,
        blank=True,
        verbose_name="任务参数",
        help_text="任务参数",
        db_comment='任务参数'
    )

    # ----------------------------------------------------------
    # 任务备注
    # ----------------------------------------------------------
    # 字段说明: 任务的说明信息
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True, blank=True），最大长度255字符
    # 作用: 存储任务的描述信息，如用途、注意事项等
    note = models.CharField(
        max_length=255,
        null=True,
        blank=True,
        verbose_name="任务备注",
        help_text="任务备注",
        db_comment='任务备注'  # 数据库字段注释
    )

    # =============================================================
    # 模型元数据配置
    # =============================================================

    class Meta:
        """
        模型元数据配置类

        定义模型在数据库中的表名、显示名称、默认排序规则等。
        """

        # 数据表名
        # 使用配置文件中的表前缀 + "job"，避免与其他应用表名冲突
        db_table = get_table_name('job')

        # 数据表注释
        db_table_comment = "任务名称"

        # 模型在admin后台显示的友好名称（单数）
        verbose_name = "定时任务表"

        # 模型在admin后台显示的友好名称（复数）
        verbose_name_plural = verbose_name

        # 默认排序规则
        # 按照创建时间倒序排列，最新的在前
        ordering = ("-create_time",)

    # =============================================================
    # 实例方法
    # =============================================================

    def __str__(self):
        """
        模型的字符串表示方法

        当需要将模型实例转换为字符串时调用，如admin后台显示、日志输出等。

        Returns:
            str: 包含任务名称的字符串
        """
        return f"任务{self.job_name}"