# +======================================================================
# | 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 OperationLog(BaseModel):
    """
    操作日志模型类

    用于记录用户的操作行为，包括增删改查等操作。
    记录详细的客户端信息、地理位置、耗时等，便于安全审计和问题排查。
    继承自 BaseModel，自动包含：
    - id: 主键
    - is_delete: 逻辑删除标识
    - create_user: 创建人
    - create_time: 创建时间
    - update_user: 更新人
    - update_time: 更新时间

    主要业务字段：
    - title: 操作标题，简要描述操作内容
    - type: 操作类型（增删改查等）
    - source: 操作来源（后台、手机站、客户端等）
    - method: 请求方法，如 user.add
    - request_method: 请求方式，GET/POST/PUT/DELETE等
    - url: 请求URL
    - param: 请求参数
    - result: 返回结果
    - ip: 客户端IP地址
    - location: IP归属地
    - os: 操作系统
    - browser: 浏览器
    - consume_time: 请求耗时（毫秒）
    - status: 操作状态（0-正常，1-异常）
    - error: 错误信息
    """

    # ----------------------------------------------------------
    # 操作标题
    # ----------------------------------------------------------
    # 字段说明: 操作的简要描述
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度150字符，允许为空（blank=True），默认值为空字符串
    # 示例: "用户登录"、"添加商品"、"修改密码"
    # 作用: 用于列表展示，快速了解操作内容
    title = models.CharField(
        max_length=150,
        blank=True,
        default='',
        verbose_name="请求标题",
        help_text="请求标题",
        db_comment='请求标题',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 操作类型
    # ----------------------------------------------------------
    # 类型常量定义
    TYPE_CHOICES = (
        (0, "其他"),
        (1, "查询"),
        (2, "新增"),
        (3, "修改"),
        (4, "保存"),
        (5, "删除"),
        (6, "批量删除"),
        (7, "设置状态"),
        (8, "重置密码"),
        (9, "导入"),
        (10, "导出"),
        (11, "上传"),
        (12, "取消"),
        (13, "提交"),
        (14, "撤销"),
        (15, "审核"),
        (16, "强制"),
        (17, "清空"),
        (18, "授权"),
        (19, "缓存"),
        (20, "开账号"),
        (21, "生成代码"),
    )

    # 字段说明: 操作类别的分类
    # 字段类型: 整数（IntegerField）
    # 约束: 使用 TYPE_CHOICES 限制可选值，默认值为0（其他）
    # 作用: 区分操作类别，便于按类型统计分析
    type = models.IntegerField(
        choices=TYPE_CHOICES,
        default=0,
        verbose_name="请求类型",
        help_text="请求类型",
        db_comment='请求类型',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 操作来源
    # ----------------------------------------------------------
    # 来源常量定义
    SOURCE_CHOICES = (
        (0, "后台系统"),  # Django Admin 后台管理系统
        (1, "手机站"),  # 移动端 H5 站点
        (2, "客户端"),  # App、小程序等客户端
        (3, "其他"),  # 其他未分类的来源
    )

    # 字段说明: 请求来源系统
    # 字段类型: 无符号正整数（PositiveIntegerField）
    # 约束: 使用 SOURCE_CHOICES 限制可选值，默认值为0（后台系统）
    # 作用: 标识请求来自哪个系统，便于按来源统计分析
    source = models.PositiveIntegerField(
        choices=SOURCE_CHOICES,
        default=0,
        verbose_name="请求来源",
        help_text="请求来源：0-后台系统 1-手机站 2-客户端 3-其他",
        db_comment='请求来源',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 请求方法
    # ----------------------------------------------------------
    # 字段说明: 具体的操作标识
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度100字符，允许为空（blank=True），默认值为空字符串
    # 示例: "user.add"、"user.delete"
    # 作用: 标识具体执行的操作方法
    method = models.CharField(
        max_length=100,
        blank=True,
        default='',
        verbose_name="请求方法",
        help_text="请求方法",
        db_comment='请求方法',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 请求方式
    # ----------------------------------------------------------
    # 字段说明: HTTP协议方法
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度100字符，允许为空（blank=True），默认值为空字符串
    # 示例: "GET"、"POST"、"PUT"、"DELETE"
    request_method = models.CharField(
        max_length=100,
        blank=True,
        default='',
        verbose_name="请求方式",
        help_text="请求方式",
        db_comment='请求方式',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 请求URL
    # ----------------------------------------------------------
    # 字段说明: 完整的请求路径
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度1000字符，允许为空（blank=True），默认值为空字符串
    # 作用: 记录请求的完整路径（不含域名），便于问题定位
    url = models.CharField(
        max_length=1000,
        blank=True,
        default='',
        verbose_name="请求URL",
        help_text="请求URL",
        db_comment='请求URL',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 请求参数
    # ----------------------------------------------------------
    # 字段说明: 请求携带的参数
    # 字段类型: 文本（TextField）
    # 约束: 允许为空（blank=True），默认值为空字符串
    # 作用: 存储GET参数或POST表单数据，以文本形式存储便于查阅
    param = models.TextField(
        blank=True,
        default='',
        verbose_name="请求参数",
        help_text="请求参数",
        db_comment='请求参数',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 返回结果
    # ----------------------------------------------------------
    # 字段说明: 请求处理后的响应数据
    # 字段类型: 文本（TextField）
    # 约束: 允许为空（blank=True），默认值为空字符串
    # 作用: 存储请求处理后的响应数据，便于排查问题
    result = models.TextField(
        blank=True,
        default='',
        verbose_name="请求结果",
        help_text="请求结果",
        db_comment='请求结果',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 客户端IP地址
    # ----------------------------------------------------------
    # 字段说明: 发起请求的客户端IP
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度100字符，允许为空（blank=True），默认值为空字符串
    # 索引: 添加了数据库索引（db_index=True）以支持IP查询
    # 作用: 记录客户端IP，用于安全审计
    ip = models.CharField(
        max_length=100,
        blank=True,
        default='',
        db_index=True,
        verbose_name="请求IP",
        help_text="请求IP",
        db_comment='请求IP',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # IP归属地
    # ----------------------------------------------------------
    # 字段说明: IP地址的地理位置信息
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度255字符，允许为空（blank=True），默认值为空字符串
    # 示例: "广东省深圳市南山区"
    # 作用: 根据IP解析的地理位置，便于安全审计
    location = models.CharField(
        max_length=255,
        blank=True,
        default='',
        verbose_name="请求所在区域",
        help_text="请求所在区域",
        db_comment='请求所在区域',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 操作系统
    # ----------------------------------------------------------
    # 字段说明: 客户端操作系统
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度100字符，允许为空（blank=True），默认值为空字符串
    # 示例: "Windows 10"、"macOS 14.0"、"iOS 17.0"
    os = models.CharField(
        max_length=100,
        blank=True,
        default='',
        verbose_name="操作系统",
        help_text="操作系统",
        db_comment='操作系统',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 浏览器
    # ----------------------------------------------------------
    # 字段说明: 客户端浏览器
    # 字段类型: 字符串（CharField）
    # 约束: 最大长度100字符，允许为空（blank=True），默认值为空字符串
    # 示例: "Chrome 120.0"、"Safari 17.0"
    browser = models.CharField(
        max_length=100,
        blank=True,
        default='',
        verbose_name="浏览器",
        help_text="浏览器",
        db_comment='浏览器',  # 数据库字段注释
        db_default=''
    )

    # ----------------------------------------------------------
    # 请求耗时
    # ----------------------------------------------------------
    # 字段说明: 请求处理耗时
    # 字段类型: 无符号正整数（PositiveIntegerField）
    # 约束: 默认值为0
    # 单位: 毫秒（ms）
    # 作用: 记录接口响应时间，用于性能监控
    consume_time = models.PositiveIntegerField(
        default=0,
        verbose_name="请求耗时",
        help_text="请求耗时",
        db_comment='请求耗时',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 操作状态
    # ----------------------------------------------------------
    # 状态常量定义
    STATUS_CHOICES = (
        (0, "正常"),  # 操作成功
        (1, "异常"),  # 操作失败
    )

    # 字段说明: 操作执行状态
    # 字段类型: 无符号正整数（PositiveIntegerField）
    # 约束: 使用 STATUS_CHOICES 限制可选值，默认值为0（正常）
    # 作用: 标识操作是否成功，便于统计成功率
    status = models.PositiveIntegerField(
        choices=STATUS_CHOICES,
        default=0,
        verbose_name="请求状态",
        help_text="请求状态：0-正常 1-异常",
        db_comment='请求状态',  # 数据库字段注释
        db_default=0
    )

    # ----------------------------------------------------------
    # 错误信息
    # ----------------------------------------------------------
    # 字段说明: 操作失败时的错误描述
    # 字段类型: 文本（TextField）
    # 约束: 允许为空（blank=True），默认值为空字符串
    # 作用: 当 status=1 时，记录具体的错误信息，便于问题排查
    error = models.TextField(
        blank=True,
        default='',
        verbose_name="错误描述",
        help_text="错误描述",
        db_comment='错误描述',  # 数据库字段注释
        db_default=''
    )

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

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

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

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

        # 数据表注释
        db_table_comment = "请求标题"

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

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

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

        # 数据库索引配置
        # 为 create_time 字段创建索引，优化按时间查询的效率
        indexes = [
            models.Index(fields=['create_time'], name='idx_operation_log_create_time'),
        ]

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

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

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

        Returns:
            str: 包含操作标题和创建时间的字符串
        """
        return f'操作日志-{self.title}-{self.create_time}'