# +====================================================================== # | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ] # +---------------------------------------------------------------------- # | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有 # +---------------------------------------------------------------------- # | 开源协议: Apache-2.0 # | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。 # +---------------------------------------------------------------------- # | 官方网站: https://www.djangoadmin.cn # +---------------------------------------------------------------------- # | 研发团队: 小蚂蚁云团队 荣誉出品 # +====================================================================== # | 版权和免责声明: # | 一、知识产权声明 # | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、 # | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权， # | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。 # | 二、使用限制与禁止条款 # | 您理解并同意，禁止将本产品用于以下任何行为： # | 1. 任何违反中华人民共和国法律法规的用途； # | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为； # | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。 # | 三、责任豁免 # | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失 # | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三 # | 方提起索赔或行政机关进行调查，您应独立承担全部责任。 # | 四、违约与法律责任 # | 如发现任何违反本声明的行为，本团队有权： # | 1. 无条件配合公安机关及其他有权机关的调查取证工作； # | 2. 依法追究相关方的民事责任，并要求赔偿全部损失； # | 3. 保留进一步采取刑事控告等法律措施的权利。 # | 五、许可范围说明 # | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包 # | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通 # | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、 # | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造 # | 成的一切经济损失及商誉损害。 # | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件 # | 许可协议》附件为准。 # +====================================================================== """ 文件模板模型模块 ============================================================= 该模块定义了文件模板相关的数据库模型。 文件模板用于存储系统中的各类模板文件，通过编码（code）进行唯一标识。 """ from django.db import models from application.models import BaseModel from utils.common import get_file_url, get_table_name # ============================================================= # 文件模板模型类 # ============================================================= class FileTemplate(BaseModel): """ 文件模板模型类 用于存储系统中的文件模板信息，支持各类业务模板的管理。 模板通过编码（code）进行唯一标识，便于在代码中动态获取和使用。 继承自 BaseModel，自动包含： - id: 主键 - is_delete: 逻辑删除标识 - create_user: 创建人 - create_time: 创建时间 - update_user: 更新人 - update_time: 更新时间 主要业务字段： - name: 模板名称，如"用户导出模板" - code: 模板编码，唯一标识，如"USER_EXPORT" - file_name: 文件名称，上传时的原始文件名 - file_path: 文件路径，存储路径 - sort: 排序值，控制显示顺序 - note: 备注说明 """ # ---------------------------------------------------------- # 模板名称 # ---------------------------------------------------------- # 字段说明: 模板的显示名称 # 字段类型: 字符串（CharField） # 约束: 最大长度100字符，允许为空（blank=True, null=True） # 索引: 添加了数据库索引（db_index=True）以支持名称搜索 # 示例: "用户导出模板"、"短信验证码模板" # 作用: 用于前端展示模板名称 name = models.CharField( max_length=100, blank=True, null=True, default=None, db_index=True, verbose_name="模板名称", help_text="模板名称", db_comment='模板名称', # 数据库字段注释 db_default=None ) # ---------------------------------------------------------- # 模板编码 # ---------------------------------------------------------- # 字段说明: 模板的唯一标识 # 字段类型: 字符串（CharField） # 约束: 最大长度50字符，允许为空（blank=True, null=True） # 索引: 添加了数据库索引（db_index=True）以支持编码查询 # 示例: "USER_EXPORT"、"SMS_VERIFY_CODE" # 建议: 使用大写字母和下划线，如 "USER_EXPORT" # 作用: 用于在代码中通过编码获取模板 code = models.CharField( max_length=50, blank=True, null=True, default=None, db_index=True, verbose_name="模板编码", help_text="模板编码，建议使用大写字母和下划线", db_comment='模板编码', # 数据库字段注释 db_default=None ) # ---------------------------------------------------------- # 文件名称 # ---------------------------------------------------------- # 字段说明: 上传时的原始文件名 # 字段类型: 字符串（CharField） # 约束: 最大长度255字符，允许为空（blank=True, null=True） # 示例: "用户导出模板.xlsx"、"短信模板.txt" # 作用: 用于下载时提供原始文件名 file_name = models.CharField( max_length=255, blank=True, null=True, default=None, verbose_name="文件名称", help_text="文件名称", db_comment='文件名称', # 数据库字段注释 db_default=None ) # ---------------------------------------------------------- # 文件路径 # ---------------------------------------------------------- # 字段说明: 文件的存储路径 # 字段类型: 字符串（CharField） # 约束: 最大长度255字符，允许为空（blank=True, null=True） # 示例: "/templates/user_export.xlsx" # 作用: 存储文件的实际路径，通过 full_file_path 属性获取完整URL file_path = models.CharField( max_length=255, blank=True, null=True, default=None, verbose_name="文件路径", help_text="文件路径", db_comment='文件路径', # 数据库字段注释 db_default=None ) # ---------------------------------------------------------- # 备注 # ---------------------------------------------------------- # 字段说明: 模板的说明信息 # 字段类型: 字符串（CharField） # 约束: 允许为空（null=True），最大长度255字符 # 作用: 存储模板的用途描述、使用说明等附加信息 note = models.CharField( null=True, max_length=255, verbose_name="文件模板备注", help_text="文件模板备注", db_comment='文件模板备注' # 数据库字段注释 ) # ---------------------------------------------------------- # 排序 # ---------------------------------------------------------- # 字段说明: 控制模板的显示顺序 # 字段类型: 整数（IntegerField） # 约束: 默认值为0 # 排序规则: 数字越小越靠前 # 作用: 手动控制模板在列表中的显示顺序 sort = models.IntegerField( default=0, verbose_name="文件模板顺序", help_text="文件模板顺序", db_comment='文件模板顺序', # 数据库字段注释 db_default=0 ) # ============================================================= # 模型元数据配置 # ============================================================= class Meta: """ 模型元数据配置类 定义模型在数据库中的表名、显示名称、默认排序规则等。 """ # 数据表名 # 使用配置文件中的表前缀 + "file_template"，避免与其他应用表名冲突 db_table = get_table_name('file_template') # 数据表注释 db_table_comment = "模板名称" # 模型在admin后台显示的友好名称（单数） verbose_name = "文件模板表" # 模型在admin后台显示的友好名称（复数） verbose_name_plural = verbose_name # 默认排序规则 # 按照创建时间倒序排列，最新的在前 ordering = ("-create_time",) # 索引定义 # 为常用查询字段添加索引，提高查询效率 indexes = [ models.Index(fields=['code'], name='idx_file_template_code'), models.Index(fields=['name'], name='idx_file_template_name'), ] # ============================================================= # 实例方法 # ============================================================= def __str__(self): """ 模型的字符串表示方法 当需要将模型实例转换为字符串时调用，如admin后台显示、日志输出等。 Returns: str: 包含模板名称和编码的字符串 """ return f'文件模板{self.name or ""}[{self.code or ""}]' @property def full_file_path(self): """ 获取文件的完整访问路径 属性方法，返回文件的完整访问路径。 如果 file_path 已经是完整URL则直接返回，否则拼接完整访问路径。 Returns: str: 文件的完整访问URL，如果 file_path 为空则返回空字符串 """ if not self.file_path: return '' # 如果已经是完整URL（以 http:// 或 https:// 开头），则直接返回 if self.file_path.startswith(('http://', 'https://')): return self.file_path # 拼接完整URL return get_file_url(self.file_path) @property def file_extension(self): """ 获取文件扩展名 属性方法，从 file_name 中提取文件扩展名。 Returns: str: 文件扩展名（不含点），如果没有扩展名则返回空字符串 """ if not self.file_name: return '' import os return os.path.splitext(self.file_name)[1][1:].lower()