# +======================================================================
# | 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 Role(BaseModel):
    """
    角色模型类

    用于存储系统的角色信息。
    角色是权限的集合，一个角色代表一组权限。
    通过给用户分配角色，实现对用户权限的控制。
    继承自 BaseModel，自动包含：
    - id: 主键
    - is_delete: 逻辑删除标识
    - create_user: 创建人
    - create_time: 创建时间
    - update_user: 更新人
    - update_time: 更新时间

    主要业务字段：
    - name: 角色名称，如"超级管理员"、"普通用户"
    - code: 角色编码，系统内部标识，如"admin"、"user"
    - sort: 排序值，控制显示顺序
    - note: 备注说明，描述角色的用途和权限范围

    关联关系：
    - 与 User 模型为多对多关系，一个用户可以有多个角色，一个角色可以被多个用户拥有
    - 与 Menu 模型为多对多关系，通过 RoleMenu 中间表关联，表示角色拥有的菜单权限
    """

    # ----------------------------------------------------------
    # 角色名称
    # ----------------------------------------------------------
    # 字段说明: 角色的显示名称
    # 字段类型: 字符串（CharField）
    # 约束: 非空（null=False），最大长度100字符
    # 索引: 添加了数据库索引（db_index=True）以提升查询效率
    # 示例: "超级管理员"、"普通用户"、"访客"
    # 作用: 用于前端展示角色名称
    name = models.CharField(
        null=False,
        max_length=100,
        db_index=True,
        verbose_name="角色名称",
        help_text="角色名称",
        db_comment='角色名称'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 角色编码
    # ----------------------------------------------------------
    # 字段说明: 角色的唯一编码
    # 字段类型: 字符串（CharField）
    # 约束: 非空（null=False），最大长度100字符
    # 索引: 添加了数据库索引（db_index=True）以提升查询效率
    # 示例: "admin"、"user"、"guest"
    # 注意: 编码一旦确定，尽量不要修改，避免代码中的引用失效
    # 作用: 用于在代码中引用角色，如通过编码判断用户角色
    code = models.CharField(
        null=False,
        max_length=100,
        db_index=True,
        verbose_name="角色编码",
        help_text="角色编码",
        db_comment='角色编码'  # 数据库字段注释
    )

    # ----------------------------------------------------------
    # 排序
    # ----------------------------------------------------------
    # 字段说明: 控制角色的显示顺序
    # 字段类型: 整数（IntegerField）
    # 约束: 非空（null=False），默认值为0
    # 排序规则: 数字越小越靠前
    # 作用: 手动控制角色在列表中的显示顺序
    sort = models.IntegerField(
        null=False,
        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:
        """
        模型元数据配置类

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

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

        # 数据表注释
        db_table_comment = "角色名称"

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

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

        # 默认排序规则
        # 按照 sort 字段升序排列（数值小的在前），确保显示顺序可控
        ordering = ("sort",)

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

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

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

        Returns:
            str: 包含角色名称的字符串
        """
        return f'角色{self.name}：'