388 lines
14 KiB
Python
388 lines
14 KiB
Python
# +======================================================================
|
|
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
|
# +----------------------------------------------------------------------
|
|
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
|
# +----------------------------------------------------------------------
|
|
# | 开源协议: Apache-2.0
|
|
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
|
# +----------------------------------------------------------------------
|
|
# | 官方网站: https://www.djangoadmin.cn
|
|
# +----------------------------------------------------------------------
|
|
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
|
# +======================================================================
|
|
# | 版权和免责声明:
|
|
# | 一、知识产权声明
|
|
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
|
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
|
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
|
# | 二、使用限制与禁止条款
|
|
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
|
# | 1. 任何违反中华人民共和国法律法规的用途；
|
|
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
|
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
|
# | 三、责任豁免
|
|
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
|
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
|
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
|
# | 四、违约与法律责任
|
|
# | 如发现任何违反本声明的行为，本团队有权：
|
|
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
|
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
|
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
|
# | 五、许可范围说明
|
|
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
|
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
|
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
|
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
|
# | 成的一切经济损失及商誉损害。
|
|
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
|
# | 许可协议》附件为准。
|
|
# +======================================================================
|
|
|
|
"""
|
|
操作日志服务模块
|
|
=============================================================
|
|
|
|
该模块实现了操作日志相关的所有业务逻辑。
|
|
包括操作日志的记录、分页查询、删除等功能。
|
|
"""
|
|
|
|
import json
|
|
import logging
|
|
|
|
from django.core.paginator import Paginator, PageNotAnInteger, InvalidPage, EmptyPage
|
|
|
|
from application.operation_log.models import OperationLog
|
|
from constant.constants import PAGE_SIZE
|
|
from utils import R
|
|
from utils.ip2region import get_ip_location
|
|
from utils.common import get_client_ip, format_params, format_result, parse_user_agent, get_method_name, \
|
|
truncate_json, format_datetime
|
|
from utils.security import get_username
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
# =============================================================
|
|
# 分页查询服务
|
|
# =============================================================
|
|
|
|
def get_operation_log_page(request):
|
|
"""
|
|
查询操作日志分页数据
|
|
|
|
Args:
|
|
request: HttpRequest对象，包含查询参数
|
|
- pageNo: 当前页码
|
|
- pageSize: 每页记录数
|
|
- title: 操作标题（模糊查询）
|
|
- type: 操作类型
|
|
- status: 操作状态
|
|
- startTime: 开始时间
|
|
- endTime: 结束时间
|
|
|
|
Returns:
|
|
R: 包含分页数据的JSON响应
|
|
"""
|
|
try:
|
|
# 获取分页参数
|
|
page_no = int(request.GET.get('pageNo', 1))
|
|
page_size = int(request.GET.get('pageSize', PAGE_SIZE))
|
|
|
|
# 构建基础查询（只查询未删除的记录）
|
|
query = OperationLog.objects.filter(is_delete=0)
|
|
|
|
# 应用筛选条件
|
|
query = _apply_filters(query, request)
|
|
|
|
# 按创建时间倒序排列
|
|
query = query.order_by("-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:
|
|
logger.error(f"查询操作日志分页数据异常: {str(e)}")
|
|
return R.failed(msg="查询失败，请稍后重试")
|
|
|
|
|
|
def _apply_filters(queryset, request):
|
|
"""
|
|
应用查询筛选条件
|
|
|
|
Args:
|
|
queryset: 初始查询集
|
|
request: HttpRequest对象，包含筛选参数
|
|
|
|
Returns:
|
|
QuerySet: 应用筛选后的查询集
|
|
"""
|
|
# 操作标题模糊筛选
|
|
title = request.GET.get('title')
|
|
if title:
|
|
queryset = queryset.filter(title__contains=title)
|
|
|
|
# 操作类型筛选
|
|
log_type = request.GET.get('type')
|
|
if log_type and log_type.isdigit():
|
|
queryset = queryset.filter(type=int(log_type))
|
|
|
|
# 操作状态筛选
|
|
status = request.GET.get('status')
|
|
if status and status.isdigit():
|
|
queryset = queryset.filter(status=int(status))
|
|
|
|
# 操作来源筛选
|
|
source = request.GET.get('source')
|
|
if source and source.isdigit():
|
|
queryset = queryset.filter(source=int(source))
|
|
|
|
# 用户名筛选
|
|
username = request.GET.get('username')
|
|
if username:
|
|
queryset = queryset.filter(create_user__contains=username)
|
|
|
|
# IP筛选
|
|
ip = request.GET.get('ip')
|
|
if ip:
|
|
queryset = queryset.filter(ip__contains=ip)
|
|
|
|
return queryset
|
|
|
|
|
|
def _build_page_data(page_list, paginator, page_no, page_size):
|
|
"""
|
|
构建分页返回数据
|
|
|
|
Args:
|
|
page_list: 当前页数据列表
|
|
paginator: 分页器对象
|
|
page_no: 当前页码
|
|
page_size: 每页大小
|
|
|
|
Returns:
|
|
dict: 分页数据
|
|
"""
|
|
records = []
|
|
for item in page_list:
|
|
records.append({
|
|
'id': item.id,
|
|
'title': item.title,
|
|
'type': item.type,
|
|
'typeText': item.get_type_display(),
|
|
'source': item.source,
|
|
'sourceText': item.get_source_display(),
|
|
'method': item.method,
|
|
'requestMethod': item.request_method,
|
|
'url': item.url,
|
|
'param': truncate_json(item.param, 100),
|
|
'result': truncate_json(item.result, 100),
|
|
'ip': item.ip,
|
|
'location': item.location,
|
|
'os': item.os,
|
|
'browser': item.browser,
|
|
'consumeTime': item.consume_time,
|
|
'status': item.status,
|
|
'statusText': item.get_status_display(),
|
|
'error': item.error,
|
|
'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_operation_log_detail(log_id):
|
|
"""
|
|
根据ID查询操作日志详情
|
|
|
|
Args:
|
|
log_id: 日志ID
|
|
|
|
Returns:
|
|
dict/None: 日志详情或None
|
|
"""
|
|
try:
|
|
# 查询未删除的日志记录
|
|
log = OperationLog.objects.filter(is_delete=0, id=log_id).first()
|
|
if not log:
|
|
return None
|
|
|
|
# 构建详情数据
|
|
detail = {
|
|
'id': log.id,
|
|
'title': log.title,
|
|
'type': log.type,
|
|
'typeText': log.get_type_display(),
|
|
'source': log.source,
|
|
'sourceText': log.get_source_display(),
|
|
'method': log.method,
|
|
'requestMethod': log.request_method,
|
|
'url': log.url,
|
|
'param': log.param,
|
|
'result': log.result,
|
|
'ip': log.ip,
|
|
'location': log.location,
|
|
'os': log.os,
|
|
'browser': log.browser,
|
|
'consumeTime': log.consume_time,
|
|
'status': log.status,
|
|
'statusText': log.get_status_display(),
|
|
'error': log.error,
|
|
'createUser': log.create_user,
|
|
'createTime': format_datetime(log.create_time),
|
|
'updateUser': log.update_user,
|
|
'updateTime': format_datetime(log.update_time),
|
|
}
|
|
|
|
# 格式化参数和结果
|
|
if detail.get('param'):
|
|
try:
|
|
detail['paramFormatted'] = json.loads(detail['param'])
|
|
except:
|
|
detail['paramFormatted'] = detail['param']
|
|
|
|
if detail.get('result'):
|
|
try:
|
|
detail['resultFormatted'] = json.loads(detail['result'])
|
|
except:
|
|
detail['resultFormatted'] = detail['result']
|
|
|
|
return detail
|
|
|
|
except Exception as e:
|
|
logger.error(f"查询操作日志详情异常，ID: {log_id}, 错误: {str(e)}")
|
|
return None
|
|
|
|
|
|
# =============================================================
|
|
# 删除服务（支持批量）
|
|
# =============================================================
|
|
|
|
def delete_operation_logs(log_ids):
|
|
"""
|
|
删除操作日志（批量逻辑删除）
|
|
|
|
Args:
|
|
log_ids: 日志ID字符串，多个ID用逗号分隔
|
|
例如: "1" 或 "1,2,3"
|
|
|
|
Returns:
|
|
R: 操作结果
|
|
"""
|
|
if not log_ids:
|
|
return R.failed("记录ID不存在")
|
|
|
|
try:
|
|
# 解析ID列表
|
|
id_list = [int(id_str.strip()) for id_str in log_ids.split(',') if id_str.strip()]
|
|
if not id_list:
|
|
return R.failed("无效的记录ID")
|
|
|
|
# 批量更新删除标识（逻辑删除）
|
|
updated_count = OperationLog.objects.filter(
|
|
id__in=id_list,
|
|
is_delete=0
|
|
).update(is_delete=1)
|
|
|
|
if updated_count == 0:
|
|
return R.failed("未找到可删除的日志记录")
|
|
|
|
return R.ok(msg=f"本次共删除{updated_count}条数据")
|
|
|
|
except ValueError:
|
|
return R.failed("记录ID格式错误")
|
|
except Exception as e:
|
|
logger.error(f"删除操作日志异常，IDs: {log_ids}, 错误: {str(e)}")
|
|
return R.failed(msg="删除失败，请稍后重试")
|
|
|
|
|
|
# =============================================================
|
|
# 记录日志服务
|
|
# =============================================================
|
|
|
|
def record_operation_log(request, title, log_type, status, source=0,
|
|
error_msg=None, consume_time=0, result=None):
|
|
"""
|
|
记录操作日志
|
|
|
|
Args:
|
|
request: HttpRequest对象
|
|
title: 操作标题
|
|
log_type: 操作类型
|
|
status: 操作状态（0-正常，1-异常）
|
|
source: 操作来源（0-后台，1-前台）
|
|
error_msg: 错误描述
|
|
consume_time: 请求耗时（毫秒）
|
|
result: 返回结果
|
|
|
|
Returns:
|
|
None
|
|
"""
|
|
try:
|
|
# 获取客户端IP
|
|
client_ip = get_client_ip(request)
|
|
|
|
# 获取地理位置信息（ip2region 直接返回字符串）
|
|
location_str = get_ip_location(client_ip)
|
|
|
|
# 解析User-Agent
|
|
user_agent = request.META.get('HTTP_USER_AGENT', '')
|
|
ua_info = parse_user_agent(user_agent)
|
|
|
|
# 获取请求参数
|
|
params = getattr(request, 'log_params', {})
|
|
param_str = format_params(params) if params else ''
|
|
|
|
# 格式化返回结果
|
|
result_str = format_result(result)
|
|
|
|
# 构建日志数据
|
|
log_data = {
|
|
'title': title[:150] if title else '',
|
|
'type': log_type,
|
|
'source': source,
|
|
'method': get_method_name(request),
|
|
'request_method': request.method,
|
|
'url': request.path[:1000] if request.path else '',
|
|
'param': param_str[:5000] if param_str else '',
|
|
'result': result_str[:5000] if result_str else '',
|
|
'ip': client_ip,
|
|
'location': location_str[:255] if location_str else '',
|
|
'os': ua_info['os'],
|
|
'browser': ua_info['browser'],
|
|
'consume_time': consume_time,
|
|
'status': status,
|
|
'error': error_msg[:500] if error_msg else '',
|
|
'create_user': get_username(request),
|
|
'update_user': get_username(request),
|
|
}
|
|
|
|
# 保存日志
|
|
OperationLog.objects.create(**log_data)
|
|
|
|
except Exception as e:
|
|
logger.error(f"记录操作日志异常: {e}")
|