签入版本
This commit is contained in:
@@ -0,0 +1,464 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为，本团队有权：
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
文件模板管理服务模块
|
||||
=============================================================
|
||||
|
||||
该模块实现了文件模板管理相关的所有业务逻辑。
|
||||
包括文件模板的分页查询、详情查询、添加、更新、删除等功能。
|
||||
文件模板用于存储系统中的各类模板文件，如导出模板、打印模板、消息模板等，
|
||||
通过编码（code）进行唯一标识，便于在代码中动态获取和使用。
|
||||
|
||||
命名规范：
|
||||
- 函数参数使用驼峰命名（如 templateId, pageNo）
|
||||
- 表单字段使用下划线命名（如 name, code, file_name, file_path）- 与数据库字段保持一致
|
||||
- 返回数据使用驼峰命名（如 createUser, updateTime）- 与前端规范保持一致
|
||||
- 私有函数以下划线开头（如 _apply_filters, _build_page_data）
|
||||
|
||||
功能模块：
|
||||
1. 分页查询：支持按名称/编码模糊搜索，按sort字段排序
|
||||
2. 详情查询：根据ID获取单个模板的详细信息
|
||||
3. 数据维护：模板的添加、更新、删除（支持批量）
|
||||
4. 编码检查：验证模板编码是否唯一
|
||||
5. 根据编码查询：通过编码获取模板信息
|
||||
"""
|
||||
|
||||
import logging
|
||||
|
||||
from django.core.paginator import Paginator, PageNotAnInteger, InvalidPage, EmptyPage
|
||||
|
||||
from application.file_template import forms
|
||||
from application.file_template.models import FileTemplate
|
||||
from constant.constants import PAGE_SIZE
|
||||
from utils import R, regular
|
||||
from utils.common import format_datetime, get_file_url, parse_request_body, save_file
|
||||
from utils.security import get_username
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 分页查询服务
|
||||
# =============================================================
|
||||
|
||||
def get_file_template_page(request):
|
||||
"""
|
||||
查询文件模板分页数据
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象，包含查询参数
|
||||
- pageNo: 当前页码（可选，默认为1）
|
||||
- pageSize: 每页记录数（可选，默认为PAGE_SIZE）
|
||||
- name: 模板名称（可选，模糊查询）
|
||||
- code: 模板编码（可选，模糊查询）
|
||||
|
||||
Returns:
|
||||
R: 包含分页数据的JSON响应
|
||||
"""
|
||||
try:
|
||||
# 获取分页参数
|
||||
page_no = int(request.GET.get('pageNo', 1))
|
||||
page_size = int(request.GET.get('pageSize', PAGE_SIZE))
|
||||
|
||||
# 构建基础查询（只查询未删除的记录）
|
||||
query = FileTemplate.objects.filter(is_delete=False)
|
||||
|
||||
# 应用筛选条件
|
||||
query = _apply_filters(query, request)
|
||||
|
||||
# 排序：按 sort 升序，再按创建时间降序
|
||||
query = query.order_by("sort", "-create_time")
|
||||
|
||||
# 执行分页查询
|
||||
paginator = Paginator(query, page_size)
|
||||
try:
|
||||
page_list = paginator.page(page_no)
|
||||
except (PageNotAnInteger, InvalidPage, EmptyPage):
|
||||
# 页码无效时默认返回第一页
|
||||
page_list = paginator.page(1)
|
||||
page_no = 1
|
||||
|
||||
# 构建并返回分页数据
|
||||
page_data = _build_page_data(page_list, paginator, page_no, page_size)
|
||||
return R.ok(data=page_data)
|
||||
|
||||
except Exception as e:
|
||||
logging.error(f"查询文件模板分页数据异常: {str(e)}")
|
||||
return R.failed(msg="查询失败，请稍后重试")
|
||||
|
||||
|
||||
def _apply_filters(queryset, request):
|
||||
"""
|
||||
应用查询筛选条件（私有辅助函数）
|
||||
|
||||
Args:
|
||||
queryset: 初始查询集
|
||||
request: HttpRequest对象，包含筛选参数
|
||||
|
||||
Returns:
|
||||
QuerySet: 应用筛选后的查询集
|
||||
"""
|
||||
# 模板名称模糊筛选
|
||||
name = request.GET.get('name')
|
||||
if name:
|
||||
queryset = queryset.filter(name__contains=name)
|
||||
|
||||
# 模板编码模糊筛选
|
||||
code = request.GET.get('code')
|
||||
if code:
|
||||
queryset = queryset.filter(code__contains=code)
|
||||
|
||||
return queryset
|
||||
|
||||
|
||||
def _build_page_data(page_list, paginator, page_no, page_size):
|
||||
"""
|
||||
构建分页返回数据（私有辅助函数）
|
||||
|
||||
Args:
|
||||
page_list: 当前页数据列表（Page对象）
|
||||
paginator: 分页器对象
|
||||
page_no: 当前页码
|
||||
page_size: 每页大小
|
||||
|
||||
Returns:
|
||||
dict: 标准格式的分页数据
|
||||
"""
|
||||
records = []
|
||||
for item in page_list:
|
||||
records.append({
|
||||
'id': item.id,
|
||||
'name': item.name,
|
||||
'code': item.code,
|
||||
'fileName': item.file_name,
|
||||
'filePath': get_file_url(item.file_path) if item.file_path else "",
|
||||
'sort': item.sort,
|
||||
'note': item.note,
|
||||
'createUser': item.create_user,
|
||||
'createTime': format_datetime(item.create_time),
|
||||
'updateUser': item.update_user,
|
||||
'updateTime': format_datetime(item.update_time),
|
||||
})
|
||||
|
||||
return {
|
||||
'records': records,
|
||||
'total': paginator.count, # 总记录数
|
||||
'size': page_size, # 每页大小
|
||||
'current': page_no, # 当前页码
|
||||
'pages': paginator.num_pages # 总页数
|
||||
}
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 详情查询服务
|
||||
# =============================================================
|
||||
|
||||
def get_file_template_detail(template_id):
|
||||
"""
|
||||
根据ID查询文件模板详情
|
||||
|
||||
Args:
|
||||
template_id: 模板ID
|
||||
|
||||
Returns:
|
||||
dict/None: 模板详情字典，不存在时返回None
|
||||
"""
|
||||
try:
|
||||
# 查询未删除的模板记录
|
||||
template = FileTemplate.objects.filter(is_delete=False, id=template_id).first()
|
||||
if not template:
|
||||
return None
|
||||
|
||||
# 返回详情数据
|
||||
return {
|
||||
'id': template.id,
|
||||
'name': template.name,
|
||||
'code': template.code,
|
||||
'fileName': template.file_name,
|
||||
'filePath': get_file_url(template.file_path),
|
||||
'sort': template.sort,
|
||||
'note': template.note,
|
||||
}
|
||||
except Exception as e:
|
||||
logging.error(f"查询文件模板详情异常，ID: {template_id}, 错误: {str(e)}")
|
||||
return None
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 编码查询服务
|
||||
# =============================================================
|
||||
|
||||
def get_file_template_by_code(template_code):
|
||||
"""
|
||||
根据编码查询文件模板
|
||||
|
||||
通常用于业务代码中通过编码动态获取模板信息。
|
||||
|
||||
Args:
|
||||
template_code: 模板编码
|
||||
|
||||
Returns:
|
||||
dict/None: 模板信息字典，不存在时返回None
|
||||
"""
|
||||
try:
|
||||
# 根据编码查询未删除的模板
|
||||
template = FileTemplate.objects.filter(is_delete=False, code=template_code).first()
|
||||
if not template:
|
||||
return None
|
||||
|
||||
return {
|
||||
'id': template.id,
|
||||
'name': template.name,
|
||||
'code': template.code,
|
||||
'fileName': template.file_name,
|
||||
'filePath': get_file_url(template.file_path) if template.file_path else None,
|
||||
'note': template.note,
|
||||
}
|
||||
except Exception as e:
|
||||
logging.error(f"根据编码查询文件模板异常，code: {template_code}, 错误: {str(e)}")
|
||||
return None
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 编码检查服务
|
||||
# =============================================================
|
||||
|
||||
def check_code_exists(code, exclude_id=None):
|
||||
"""
|
||||
检查模板编码是否存在
|
||||
|
||||
用于添加/更新时的编码唯一性验证。
|
||||
|
||||
Args:
|
||||
code: 模板编码
|
||||
exclude_id: 排除的模板ID（更新时使用，避免与自身冲突）
|
||||
|
||||
Returns:
|
||||
bool: 编码是否存在
|
||||
"""
|
||||
try:
|
||||
queryset = FileTemplate.objects.filter(is_delete=False, code=code)
|
||||
if exclude_id:
|
||||
queryset = queryset.exclude(id=exclude_id)
|
||||
return queryset.exists()
|
||||
except Exception as e:
|
||||
logging.error(f"检查模板编码异常，code: {code}, 错误: {str(e)}")
|
||||
return False
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 添加服务
|
||||
# =============================================================
|
||||
|
||||
def add_file_template(request):
|
||||
"""
|
||||
添加文件模板
|
||||
|
||||
处理流程：
|
||||
1. 解析请求体中的JSON数据
|
||||
2. 表单验证
|
||||
3. 检查编码唯一性
|
||||
4. 处理文件路径（保存文件）
|
||||
5. 创建数据库记录
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象，包含模板信息的JSON数据
|
||||
|
||||
Returns:
|
||||
R: 操作结果（成功/失败）
|
||||
"""
|
||||
# 解析请求参数
|
||||
data, error = parse_request_body(request)
|
||||
if error:
|
||||
return R.failed(msg=error)
|
||||
|
||||
# 表单验证
|
||||
form = forms.FileTemplateForm(data)
|
||||
if not form.is_valid():
|
||||
return R.failed(msg=regular.get_err(form))
|
||||
|
||||
cleaned_data = form.cleaned_data
|
||||
|
||||
# 检查编码是否已存在
|
||||
code = cleaned_data.get('code')
|
||||
if check_code_exists(code):
|
||||
return R.failed(msg=f"模板编码 '{code}' 已存在")
|
||||
|
||||
# 处理文件路径（保存文件到 file 目录）
|
||||
file_path = cleaned_data.get('filePath')
|
||||
if file_path:
|
||||
file_path = save_file(file_path, "file")
|
||||
|
||||
try:
|
||||
# 创建文件模板记录
|
||||
FileTemplate.objects.create(
|
||||
name=cleaned_data.get('name'),
|
||||
code=code,
|
||||
file_name=cleaned_data.get('fileName', ''),
|
||||
file_path=file_path,
|
||||
sort=data.get('sort', 0),
|
||||
note=data.get('note', ''),
|
||||
create_user=get_username(request),
|
||||
update_user=get_username(request)
|
||||
)
|
||||
return R.ok(msg="创建成功")
|
||||
except Exception as e:
|
||||
logging.error(f"添加文件模板异常: {str(e)}")
|
||||
return R.failed(msg="添加失败，请稍后重试")
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 更新服务
|
||||
# =============================================================
|
||||
|
||||
def update_file_template(request):
|
||||
"""
|
||||
更新文件模板
|
||||
|
||||
处理流程：
|
||||
1. 解析请求体中的JSON数据
|
||||
2. 验证模板ID
|
||||
3. 表单验证
|
||||
4. 查询现有记录
|
||||
5. 检查编码唯一性（排除自身）
|
||||
6. 处理文件路径（如有变化则保存新文件）
|
||||
7. 更新各字段
|
||||
8. 保存更新
|
||||
|
||||
Args:
|
||||
request: HttpRequest对象，包含模板ID和更新信息的JSON数据
|
||||
|
||||
Returns:
|
||||
R: 操作结果（成功/失败）
|
||||
"""
|
||||
# 解析请求参数
|
||||
data, error = parse_request_body(request)
|
||||
if error:
|
||||
return R.failed(msg=error)
|
||||
|
||||
# 验证模板ID
|
||||
template_id = data.get('id')
|
||||
if not template_id or not str(template_id).isdigit() or int(template_id) <= 0:
|
||||
return R.failed("模板ID无效")
|
||||
template_id = int(template_id)
|
||||
|
||||
# 表单验证
|
||||
form = forms.FileTemplateForm(data)
|
||||
if not form.is_valid():
|
||||
return R.failed(msg=regular.get_err(form))
|
||||
|
||||
try:
|
||||
# 查询模板记录
|
||||
template = FileTemplate.objects.filter(id=template_id, is_delete=False).first()
|
||||
if not template:
|
||||
return R.failed("模板不存在")
|
||||
|
||||
cleaned_data = form.cleaned_data
|
||||
|
||||
# 检查编码是否已存在（排除自身）
|
||||
code = cleaned_data.get('code')
|
||||
if code != template.code and check_code_exists(code, exclude_id=template_id):
|
||||
return R.failed(msg=f"模板编码 '{code}' 已存在")
|
||||
|
||||
# 处理文件路径（如有新文件则保存）
|
||||
file_path = cleaned_data.get('filePath')
|
||||
if file_path:
|
||||
file_path = save_file(file_path, "file")
|
||||
|
||||
# 更新各字段
|
||||
template.name = cleaned_data.get('name')
|
||||
template.code = code
|
||||
template.file_name = cleaned_data.get('fileName', '')
|
||||
template.file_path = file_path
|
||||
|
||||
# 可选字段更新
|
||||
if 'sort' in data:
|
||||
template.sort = int(data.get('sort', 0))
|
||||
if 'note' in data:
|
||||
template.note = data.get('note', '')
|
||||
|
||||
template.update_user = get_username(request)
|
||||
template.save()
|
||||
|
||||
return R.ok(msg="更新成功")
|
||||
except Exception as e:
|
||||
logging.error(f"更新文件模板异常，ID: {template_id}, 错误: {str(e)}")
|
||||
return R.failed(msg="更新失败，请稍后重试")
|
||||
|
||||
|
||||
# =============================================================
|
||||
# 删除服务（支持批量）
|
||||
# =============================================================
|
||||
|
||||
def delete_file_templates(template_ids):
|
||||
"""
|
||||
删除文件模板（批量删除）
|
||||
|
||||
采用逻辑删除方式（is_delete=True），而非物理删除。
|
||||
支持逗号分隔的多个ID。
|
||||
|
||||
Args:
|
||||
template_ids: 模板ID字符串，多个ID用逗号分隔
|
||||
例如: "1" 或 "1,2,3"
|
||||
|
||||
Returns:
|
||||
R: 操作结果，包含删除数量
|
||||
"""
|
||||
if not template_ids:
|
||||
return R.failed("记录ID不存在")
|
||||
|
||||
try:
|
||||
# 解析ID列表
|
||||
id_list = [int(id_str.strip()) for id_str in template_ids.split(',') if id_str.strip()]
|
||||
if not id_list:
|
||||
return R.failed("无效的记录ID")
|
||||
|
||||
# 批量更新删除标识（逻辑删除）
|
||||
updated_count = FileTemplate.objects.filter(
|
||||
id__in=id_list,
|
||||
is_delete=False
|
||||
).update(is_delete=True)
|
||||
|
||||
return R.ok(msg=f"本次共删除{updated_count}条数据")
|
||||
except ValueError:
|
||||
return R.failed("记录ID格式错误")
|
||||
except Exception as e:
|
||||
logging.error(f"删除文件模板异常，IDs: {template_ids}, 错误: {str(e)}")
|
||||
return R.failed(msg="删除失败，请稍后重试")
|
||||
Reference in New Issue
Block a user