# +======================================================================
# | 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 Menu(BaseModel):
    """
    菜单模型类

    用于存储系统的菜单和权限节点信息。
    菜单用于构建前端导航菜单，权限节点用于后端接口权限控制。
    支持树形层级结构，通过 parent_id 关联上级菜单。
    继承自 BaseModel，自动包含：
    - id: 主键
    - is_delete: 逻辑删除标识
    - create_user: 创建人
    - create_time: 创建时间
    - update_user: 更新人
    - update_time: 更新时间

    主要业务字段：
    - name: 菜单名称，如"用户管理"、"系统设置"
    - icon: 菜单图标，用于前端展示
    - icon2: 备用菜单图标
    - parent_id: 上级菜单ID，用于构建树形结构
    - path: 前端路由路径
    - component: 前端组件路径
    - permission: 权限标识，如"sys:user:list"
    - target: 打开方式（0-内部, 1-外部）
    - type: 菜单类型（0-菜单, 1-节点）
    - status: 菜单状态（0-正常, 1-禁用）
    - hide: 是否隐藏（0-可见, 1-不可见）
    - sort: 排序值，控制显示顺序

    关联关系：
    - 自关联：通过 parent_id 关联到自身的上级菜单，形成树形结构
    - 与 Role 模型为多对多关系，通过 RoleMenu 中间表关联
    """

    # ----------------------------------------------------------
    # 菜单名称
    # ----------------------------------------------------------
    # 字段说明: 菜单的显示名称
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度100字符
    # 索引: 添加了数据库索引（db_index=True）以提升查询效率
    # 示例: "用户管理"、"角色管理"、"系统设置"
    # 作用: 用于前端导航栏展示
    name = models.CharField(
        max_length=100,
        db_index=True,
        verbose_name="菜单名称",
        help_text="菜单名称",
        db_comment='菜单名称'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 菜单图标
    # ----------------------------------------------------------
    # 字段说明: 菜单的图标样式类或图标地址
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True），最大长度50字符
    # 示例: "el-icon-user"、"fa-users"
    # 作用: 用于前端导航栏图标的渲染
    icon = models.CharField(
        null=True,
        max_length=50,
        verbose_name="菜单图标",
        help_text="菜单图标",
        db_comment='菜单图标'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 备用菜单图标
    # ----------------------------------------------------------
    # 字段说明: 备用菜单图标
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True），最大长度50字符
    # 作用: 用于兼容不同版本的图标库
    icon2 = models.CharField(
        null=True,
        max_length=50,
        verbose_name="菜单图标",
        help_text="菜单图标",
        db_comment='菜单图标'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 上级ID
    # ----------------------------------------------------------
    # 字段说明: 上级菜单的ID
    # 字段类型: 整数（IntegerField）
    # 约束: 默认值为0（表示顶级菜单）
    # 索引: 添加了数据库索引（db_index=True）以支持树形结构查询
    # 作用: 构建菜单树形结构，实现多层级导航
    parent_id = models.IntegerField(
        default=0,
        db_index=True,
        verbose_name="上级ID",
        help_text="上级ID",
        db_comment='上级ID',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 菜单路径
    # ----------------------------------------------------------
    # 字段说明: 前端路由的URL路径
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True），最大长度255字符
    # 示例: "/system/user"、"/system/role"
    # 作用: 定义菜单对应的前端路由地址
    path = models.CharField(
        null=True,
        max_length=255,
        verbose_name="菜单路径",
        help_text="菜单路径",
        db_comment='菜单路径'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 菜单组件
    # ----------------------------------------------------------
    # 字段说明: 前端组件的文件路径
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True），最大长度255字符
    # 示例: "system/user/index"、"system/role/index"
    # 作用: 定义菜单对应的前端组件位置
    component = models.CharField(
        null=True,
        max_length=255,
        verbose_name="菜单组件",
        help_text="菜单组件",
        db_comment='菜单组件'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 权限节点
    # ----------------------------------------------------------
    # 字段说明: 权限标识
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True），最大长度100字符
    # 示例: "sys:user:list"、"sys:user:add"
    # 作用: 用于后端接口权限控制，当 type=1 时表示具体的操作权限
    permission = models.CharField(
        null=True,
        max_length=100,
        verbose_name="权限节点",
        help_text="权限节点",
        db_comment='权限节点'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 打开方式
    # ----------------------------------------------------------
    # 字段说明: 菜单链接的打开方式
    # 字段类型: 整数（IntegerField）
    # 约束: 默认值为0
    # 可选值: 0-内部打开, 1-外部打开
    # 作用: 控制菜单链接在内部框架还是新窗口中打开
    target = models.IntegerField(
        default=0,
        verbose_name="打开方式",
        help_text="打开方式",
        db_comment='打开方式',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 菜单类型
    # ----------------------------------------------------------
    # 字段说明: 区分菜单和权限节点
    # 字段类型: 整数（IntegerField）
    # 约束: 默认值为0
    # 可选值: 0-菜单（显示在导航栏）, 1-节点（按钮/权限，不显示在菜单树中）
    # 作用: 区分导航菜单和权限节点
    type = models.IntegerField(
        default=0,
        verbose_name="菜单类型：0-菜单 1-节点",
        help_text="菜单类型：0-菜单 1-节点",
        db_comment='菜单类型：0-菜单 1-节点',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 菜单状态
    # ----------------------------------------------------------
    # 状态常量定义
    STATUS_CHOICES = (
        (0, "正常"),  # 正常状态：菜单可用
        (1, "禁用"),  # 禁用状态：菜单不可用
    )

    # 字段说明: 菜单的启用/禁用状态
    # 字段类型: 整数（IntegerField）
    # 约束: 使用 STATUS_CHOICES 限制可选值，默认值为0（正常）
    # 作用: 控制菜单是否可用，禁用的菜单不显示且无权访问
    status = models.IntegerField(
        choices=STATUS_CHOICES,
        default=0,
        verbose_name="菜单状态：0-正常 1-禁用",
        help_text="菜单状态：0-正常 1-禁用",
        db_comment='菜单状态：0-正常 1-禁用',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 是否可见
    # ----------------------------------------------------------
    # 可见性常量定义
    HIDE_CHOICES = (
        (0, "可见"),  # 菜单在导航栏显示
        (1, "不可见"),  # 菜单在导航栏隐藏
    )

    # 字段说明: 菜单是否在导航栏显示
    # 字段类型: 整数（IntegerField）
    # 约束: 使用 HIDE_CHOICES 限制可选值，默认值为1（不可见）
    # 作用: 控制菜单是否在导航栏显示，隐藏的菜单不显示但可通过URL访问
    hide = models.IntegerField(
        choices=HIDE_CHOICES,
        default=1,
        verbose_name="是否可见：0-可见 1-不可见",
        help_text="是否可见：0-可见 1-不可见",
        db_comment='是否可见：0-可见 1-不可见',  # 数据库字段注释
        db_default=1
    )

    # ----------------------------------------------------------
    # 排序
    # ----------------------------------------------------------
    # 字段说明: 菜单的显示顺序
    # 字段类型: 整数（IntegerField）
    # 约束: 默认值为0
    # 排序规则: 数字越小越靠前
    # 作用: 手动控制菜单在导航栏中的显示顺序
    sort = models.IntegerField(
        default=0,
        verbose_name="排序",
        help_text="排序",
        db_comment='排序',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 备注
    # ----------------------------------------------------------
    # 字段说明: 菜单的说明信息
    # 字段类型: 字符串（CharField）
    # 约束: 允许为空（null=True），最大长度255字符
    # 作用: 存储菜单的备注信息，便于管理
    note = models.CharField(
        null=True,
        max_length=255,
        verbose_name="备注",
        help_text="备注",
        db_comment='备注'  # 数据库字段注释
    )

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

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

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

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

        # 数据表注释
        db_table_comment = "菜单名称"

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

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

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

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

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

        Returns:
            str: 包含菜单ID的字符串
        """
        return f"菜单{self.id}"