# +======================================================================
# | 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 Notice(BaseModel):
    """
    通知公告模型类

    用于存储系统内部的通知和公告信息。
    通知公告用于向系统用户发布重要消息、活动通知、系统更新等内容。
    继承自 BaseModel，自动包含：
    - id: 主键
    - is_delete: 逻辑删除标识
    - create_user: 创建人
    - create_time: 创建时间
    - update_user: 更新人
    - update_time: 更新时间

    主要业务字段：
    - title: 通知标题
    - cover: 通知封面图片
    - type: 通知类型（1-通知, 2-公告）
    - status: 发布状态（1-正常, 2-停用）
    - click_num: 点击/浏览次数
    - content: 通知详细内容（支持富文本）
    """

    # ----------------------------------------------------------
    # 通知标题
    # ----------------------------------------------------------
    # 字段说明: 通知公告的标题
    # 字段类型: 字符串（CharField）
    # 约束: 非空（null=False），最大长度150字符
    # 索引: 添加了数据库索引（db_index=True）以支持标题搜索
    # 示例: "五一放假通知"、"系统升级公告"
    # 作用: 用于列表展示和搜索
    title = models.CharField(
        null=False,
        max_length=150,
        db_index=True,
        verbose_name="通知标题",
        help_text="通知标题",
        db_comment='通知标题'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 通知封面
    # ----------------------------------------------------------
    # 字段说明: 通知公告的封面图片
    # 字段类型: 字符串（CharField）
    # 约束: 非空（null=False），最大长度255字符
    # 作用: 用于列表展示的封面图片
    cover = models.CharField(
        null=False,
        max_length=255,
        verbose_name="通知封面",
        help_text="通知封面",
        db_comment='通知封面'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 通知类型
    # ----------------------------------------------------------
    # 类型常量定义
    TYPE_CHOICES = (
        (1, "通知"),  # 普通通知，如会议提醒、日常通知
        (2, "公告"),  # 正式公告，如规章制度发布、重要声明
    )

    # 字段说明: 通知公告的分类类型
    # 字段类型: 整数（IntegerField）
    # 约束: 使用 TYPE_CHOICES 限制可选值，默认值为1（通知）
    # 作用: 区分通知和公告，影响显示样式和推送方式
    type = models.IntegerField(
        choices=TYPE_CHOICES,
        default=1,
        verbose_name="通知类型：1-通知 2-公告",
        help_text="通知类型：1-通知 2-公告",
        db_comment='通知类型：1-通知 2-公告',  # 数据库字段注释
        db_default=1
    )

    # ----------------------------------------------------------
    # 通知状态
    # ----------------------------------------------------------
    # 状态常量定义
    STATUS_CHOICES = (
        (1, "正常"),  # 正常状态：通知已发布并正常显示
        (2, "停用"),  # 停用状态：通知已撤回或不再显示
    )

    # 字段说明: 通知公告的发布状态
    # 字段类型: 整数（IntegerField）
    # 约束: 使用 STATUS_CHOICES 限制可选值，默认值为1（正常）
    # 作用: 控制通知公告是否在前端展示
    status = models.IntegerField(
        choices=STATUS_CHOICES,
        default=1,
        verbose_name="通知状态：1-正常 2-停用",
        help_text="通知状态：1-正常 2-停用",
        db_comment='通知状态：1-正常 2-停用',  # 数据库字段注释
        db_default=1
    )

    # ----------------------------------------------------------
    # 点击次数
    # ----------------------------------------------------------
    # 字段说明: 通知公告被查看的次数
    # 字段类型: 整数（IntegerField）
    # 约束: 默认值为0
    # 作用: 记录浏览次数，用于统计热度
    click_num = models.IntegerField(
        default=0,
        verbose_name="点击率",
        help_text="点击率",
        db_comment='点击率',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 通知内容
    # ----------------------------------------------------------
    # 字段说明: 通知公告的详细内容
    # 字段类型: 文本（TextField）
    # 约束: 允许为空（null=True）
    # 作用: 存储通知公告的详细正文内容，支持富文本格式（HTML）
    content = models.TextField(
        null=True,
        verbose_name="通知内容",
        help_text="通知内容",
        db_comment='通知内容'  # 数据库字段注释
    )

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

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

        定义模型在数据库中的表名、显示名称等。
        """

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

        # 数据表注释
        db_table_comment = "通知标题"

        # 模型在admin后台显示的友好名称（单数）
        verbose_name = "通知公告表"

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

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

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

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

        Returns:
            str: 包含通知标题的字符串
        """
        return f"通知公告{self.title}"