536 lines
18 KiB
Python
536 lines
18 KiB
Python
# +======================================================================
|
||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||
# +----------------------------------------------------------------------
|
||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||
# +----------------------------------------------------------------------
|
||
# | 开源协议: Apache-2.0
|
||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||
# +----------------------------------------------------------------------
|
||
# | 官方网站: https://www.djangoadmin.cn
|
||
# +----------------------------------------------------------------------
|
||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||
# +======================================================================
|
||
# | 版权和免责声明:
|
||
# | 一、知识产权声明
|
||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||
# | 二、使用限制与禁止条款
|
||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||
# | 三、责任豁免
|
||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||
# | 四、违约与法律责任
|
||
# | 如发现任何违反本声明的行为，本团队有权：
|
||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||
# | 五、许可范围说明
|
||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||
# | 成的一切经济损失及商誉损害。
|
||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||
# | 许可协议》附件为准。
|
||
# +======================================================================
|
||
|
||
"""
|
||
菜单管理服务模块
|
||
=============================================================
|
||
|
||
该模块实现了菜单管理相关的所有业务逻辑。
|
||
包括菜单的列表查询、详情查询、添加、更新、删除等功能，以及用户菜单权限的获取。
|
||
菜单用于构建系统的导航结构，支持树形结构展示，包含目录、菜单、按钮三种类型。
|
||
|
||
命名规范：
|
||
- 函数参数使用驼峰命名（如 menuId, userId）
|
||
- 表单字段使用下划线命名（如 name, icon, parent_id）- 与数据库字段保持一致
|
||
- 返回数据使用驼峰命名（如 parentId, createUser）- 与前端规范保持一致
|
||
- 私有函数以下划线开头（如 _build_tree, _get_tree）
|
||
|
||
功能模块：
|
||
1. 菜单维护：菜单的增删改查操作
|
||
2. 菜单树构建：将扁平菜单数据转换为树形结构
|
||
3. 权限控制：根据用户角色获取可访问的菜单和权限节点
|
||
"""
|
||
|
||
import logging
|
||
from typing import Dict, Any, Optional
|
||
|
||
from django.db import connection
|
||
|
||
from application.menu import forms
|
||
from application.menu.models import Menu
|
||
from utils import R, regular
|
||
from utils.common import format_datetime, parse_request_body
|
||
from utils.security import get_username
|
||
|
||
|
||
# =============================================================
|
||
# 列表查询服务
|
||
# =============================================================
|
||
|
||
def get_menu_list(request):
|
||
"""
|
||
获取菜单列表数据
|
||
|
||
Args:
|
||
request: HttpRequest对象，包含查询参数
|
||
- name: 菜单名称（可选，模糊查询）
|
||
|
||
Returns:
|
||
R: 包含菜单列表数据的JSON响应
|
||
"""
|
||
try:
|
||
# 构建基础查询（只查询未删除的记录）
|
||
query = Menu.objects.filter(is_delete=False)
|
||
|
||
# 菜单名称模糊筛选
|
||
name = request.GET.get('name')
|
||
if name:
|
||
query = query.filter(name__contains=name)
|
||
|
||
# 按排序字段和ID升序排列
|
||
menu_list = query.order_by('sort', 'id').all()
|
||
|
||
# 构建返回数据
|
||
result = []
|
||
for item in menu_list:
|
||
result.append(_menu_to_dict(item))
|
||
|
||
return R.ok(data=result)
|
||
|
||
except Exception as e:
|
||
logging.error(f"获取菜单列表异常: {str(e)}")
|
||
return R.failed(msg="查询失败，请稍后重试")
|
||
|
||
|
||
def _menu_to_dict(menu) -> Dict[str, Any]:
|
||
"""
|
||
将菜单模型转换为字典（私有辅助函数）
|
||
|
||
Args:
|
||
menu: Menu模型实例
|
||
|
||
Returns:
|
||
Dict: 菜单数据字典
|
||
"""
|
||
return {
|
||
'id': menu.id,
|
||
'name': menu.name,
|
||
'icon': menu.icon,
|
||
'parentId': menu.parent_id,
|
||
'path': menu.path,
|
||
'component': menu.component,
|
||
'permission': menu.permission,
|
||
'target': menu.target,
|
||
'type': menu.type,
|
||
'status': menu.status,
|
||
'hide': menu.hide,
|
||
'note': menu.note,
|
||
'sort': menu.sort,
|
||
'createUser': menu.create_user,
|
||
'createTime': format_datetime(menu.create_time),
|
||
'updateUser': menu.update_user,
|
||
'updateTime': format_datetime(menu.update_time),
|
||
}
|
||
|
||
|
||
# =============================================================
|
||
# 详情查询服务
|
||
# =============================================================
|
||
|
||
def get_menu_detail(menu_id: int) -> Optional[Dict[str, Any]]:
|
||
"""
|
||
根据ID查询菜单详情
|
||
|
||
Args:
|
||
menu_id: 菜单ID
|
||
|
||
Returns:
|
||
Optional[Dict]: 菜单详情字典，不存在时返回None
|
||
"""
|
||
try:
|
||
# 查询未删除的菜单记录
|
||
menu = Menu.objects.filter(id=menu_id, is_delete=False).first()
|
||
if not menu:
|
||
return None
|
||
|
||
# 返回详情数据
|
||
return {
|
||
'id': menu.id,
|
||
'name': menu.name,
|
||
'icon': menu.icon,
|
||
'parentId': menu.parent_id,
|
||
'path': menu.path,
|
||
'component': menu.component,
|
||
'permission': menu.permission,
|
||
'target': menu.target,
|
||
'type': menu.type,
|
||
'status': menu.status,
|
||
'hide': menu.hide,
|
||
'sort': menu.sort,
|
||
'note': menu.note,
|
||
'createUser': menu.create_user,
|
||
'createTime': format_datetime(menu.create_time),
|
||
'updateUser': menu.update_user,
|
||
'updateTime': format_datetime(menu.update_time),
|
||
}
|
||
except Exception as e:
|
||
logging.error(f"查询菜单详情异常，ID: {menu_id}, 错误: {str(e)}")
|
||
return None
|
||
|
||
|
||
# =============================================================
|
||
# 添加服务
|
||
# =============================================================
|
||
|
||
def add_menu(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.MenuForm(data=data)
|
||
if not form.is_valid():
|
||
return R.failed(msg=regular.get_err(form))
|
||
|
||
try:
|
||
cleaned_data = form.cleaned_data
|
||
|
||
# 验证上级菜单是否存在（如果 parentId 不为0）
|
||
parent_id = cleaned_data.get('parentId')
|
||
if parent_id and parent_id > 0:
|
||
parent_exists = Menu.objects.filter(id=parent_id, is_delete=False).exists()
|
||
if not parent_exists:
|
||
return R.failed("上级菜单不存在")
|
||
|
||
# 验证路径唯一性（如果是菜单类型）
|
||
path = cleaned_data.get('path')
|
||
menu_type = cleaned_data.get('type')
|
||
if menu_type == 1 and path: # 1 表示菜单类型
|
||
if Menu.objects.filter(path=path, is_delete=False).exists():
|
||
return R.failed(f"菜单路径 '{path}' 已存在")
|
||
|
||
# 创建菜单记录
|
||
Menu.objects.create(
|
||
name=cleaned_data.get('name'),
|
||
icon=cleaned_data.get('icon'),
|
||
parent_id=parent_id,
|
||
path=path,
|
||
component=cleaned_data.get('component'),
|
||
target=cleaned_data.get('target'),
|
||
permission=cleaned_data.get('permission'),
|
||
type=menu_type,
|
||
status=cleaned_data.get('status'),
|
||
hide=cleaned_data.get('hide', False),
|
||
sort=cleaned_data.get('sort', 0),
|
||
note=cleaned_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_menu(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
|
||
menu_id = data.get('id')
|
||
if not menu_id or not str(menu_id).isdigit() or int(menu_id) <= 0:
|
||
return R.failed("菜单ID无效")
|
||
menu_id = int(menu_id)
|
||
|
||
# 表单验证
|
||
form = forms.MenuForm(data)
|
||
if not form.is_valid():
|
||
return R.failed(msg=regular.get_err(form))
|
||
|
||
try:
|
||
cleaned_data = form.cleaned_data
|
||
|
||
# 查询菜单记录
|
||
menu = Menu.objects.filter(id=menu_id, is_delete=False).first()
|
||
if not menu:
|
||
return R.failed("菜单不存在")
|
||
|
||
# 验证上级菜单是否存在且不能选择自己作为上级
|
||
parent_id = cleaned_data.get('parentId')
|
||
if parent_id and parent_id > 0:
|
||
if parent_id == menu_id:
|
||
return R.failed("不能将自己设为上级菜单")
|
||
|
||
parent_exists = Menu.objects.filter(id=parent_id, is_delete=False).exists()
|
||
if not parent_exists:
|
||
return R.failed("上级菜单不存在")
|
||
|
||
# 验证路径唯一性（如果是菜单类型且路径变更）
|
||
path = cleaned_data.get('path')
|
||
menu_type = cleaned_data.get('type')
|
||
if menu_type == 1 and path and path != menu.path:
|
||
if Menu.objects.filter(path=path, is_delete=False).exclude(id=menu_id).exists():
|
||
return R.failed(f"菜单路径 '{path}' 已存在")
|
||
|
||
# 更新各字段
|
||
menu.name = cleaned_data.get('name')
|
||
menu.icon = cleaned_data.get('icon')
|
||
menu.parent_id = parent_id
|
||
menu.path = path
|
||
menu.component = cleaned_data.get('component')
|
||
menu.permission = cleaned_data.get('permission')
|
||
menu.target = cleaned_data.get('target')
|
||
menu.type = menu_type
|
||
menu.status = cleaned_data.get('status')
|
||
menu.hide = cleaned_data.get('hide', menu.hide)
|
||
menu.sort = cleaned_data.get('sort', menu.sort)
|
||
menu.note = cleaned_data.get('note')
|
||
menu.update_user = get_username(request)
|
||
menu.save()
|
||
|
||
return R.ok(msg="更新成功")
|
||
except Exception as e:
|
||
logging.error(f"更新菜单异常，ID: {menu_id}, 错误: {str(e)}")
|
||
return R.failed(msg="更新失败，请稍后重试")
|
||
|
||
|
||
# =============================================================
|
||
# 删除服务（支持批量）
|
||
# =============================================================
|
||
|
||
def delete_menus(menu_ids: str):
|
||
"""
|
||
批量删除菜单
|
||
|
||
根据传入的菜单ID字符串（逗号分隔）批量删除菜单。
|
||
删除前会检查每个菜单是否存在子级菜单，如有子级则禁止删除。
|
||
|
||
Args:
|
||
menu_ids: 逗号分隔的菜单ID字符串，如 "1,2,3"
|
||
|
||
Returns:
|
||
R: 操作结果
|
||
"""
|
||
if not menu_ids:
|
||
return R.failed("记录ID不存在")
|
||
|
||
try:
|
||
# 解析ID列表
|
||
id_list = [int(id_str.strip()) for id_str in menu_ids.split(',') if id_str.strip()]
|
||
if not id_list:
|
||
return R.failed("无效的记录ID")
|
||
|
||
# 存储有子级无法删除的菜单名称
|
||
has_children_menus = []
|
||
success_ids = []
|
||
|
||
# 遍历检查每个菜单
|
||
for menu_id in id_list:
|
||
menu = Menu.objects.only('id', 'name').filter(id=menu_id, is_delete=False).first()
|
||
if not menu:
|
||
return R.failed(f"ID为{menu_id}的菜单不存在")
|
||
|
||
# 检查是否有子级菜单
|
||
child_exists = Menu.objects.filter(parent_id=menu_id, is_delete=False).exists()
|
||
if child_exists:
|
||
has_children_menus.append(menu.name)
|
||
else:
|
||
success_ids.append(menu_id)
|
||
|
||
# 如果有包含子级的菜单，返回错误
|
||
if has_children_menus:
|
||
menu_names = "、".join(has_children_menus)
|
||
return R.failed(f"菜单【{menu_names}】存在子级菜单，无法删除")
|
||
|
||
# 批量执行软删除
|
||
updated_count = Menu.objects.filter(
|
||
id__in=success_ids,
|
||
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: {menu_ids}, 错误: {str(e)}")
|
||
return R.failed(msg="删除失败，请稍后重试")
|
||
|
||
|
||
# =============================================================
|
||
# 权限获取服务
|
||
# =============================================================
|
||
|
||
def get_user_permissions(user_id):
|
||
"""
|
||
获取用户权限节点列表
|
||
|
||
根据用户ID获取该用户拥有的所有权限标识。
|
||
|
||
Args:
|
||
user_id: 用户ID
|
||
|
||
Returns:
|
||
list: 权限标识列表
|
||
"""
|
||
if user_id == 1:
|
||
# 超级管理员拥有所有权限
|
||
menu_list = Menu.objects.filter(is_delete=False, type=1, status=0).values()
|
||
permission_list = []
|
||
for item in menu_list:
|
||
permission_list.append(item['permission'])
|
||
return permission_list
|
||
else:
|
||
# 普通用户从角色关联中获取权限
|
||
qn = connection.ops.quote_name
|
||
sql = 'SELECT m.* FROM django_menu AS m '
|
||
sql += 'INNER JOIN django_role_menu AS rm ON m.id=rm.menu_id '
|
||
sql += 'INNER JOIN django_user_role AS ur ON ur.role_id=rm.role_id '
|
||
sql += f'WHERE ur.user_id=%s AND (m.type=1 OR (m.type=0 AND m.permission!=\'\')) AND m.{qn("status")}=0 AND m.is_delete=0'
|
||
menu_list = Menu.objects.raw(sql, [user_id])
|
||
permission_list = []
|
||
for item in menu_list:
|
||
permission_list.append(item.permission)
|
||
return permission_list
|
||
|
||
|
||
def get_user_permission_menus(user_id):
|
||
"""
|
||
获取用户权限菜单树
|
||
|
||
根据用户ID获取该用户可访问的菜单树结构。
|
||
|
||
Args:
|
||
user_id: 用户ID
|
||
|
||
Returns:
|
||
list: 菜单树结构列表
|
||
"""
|
||
if user_id == 1:
|
||
# 超级管理员查看全部菜单
|
||
menu_list = Menu.objects.filter(is_delete=False, status=0, type=0).order_by("sort")
|
||
return _build_tree(menu_list)
|
||
else:
|
||
# 普通用户从角色关联中获取菜单
|
||
qn = connection.ops.quote_name
|
||
sql = 'SELECT m.* FROM django_menu AS m '
|
||
sql += 'INNER JOIN django_role_menu AS rm ON m.id=rm.menu_id '
|
||
sql += 'INNER JOIN django_user_role AS ur ON ur.role_id=rm.role_id '
|
||
sql += f'WHERE ur.user_id=%s AND m.type=0 AND m.{qn("status")}=0 AND m.is_delete=0 '
|
||
sql += 'ORDER BY m.sort ASC;'
|
||
menu_list = Menu.objects.raw(sql, [user_id])
|
||
return _build_tree(menu_list)
|
||
|
||
|
||
def _build_tree(menu_list):
|
||
"""
|
||
构建菜单树结构（私有辅助函数）
|
||
|
||
将扁平的菜单列表转换为树形结构。
|
||
|
||
Args:
|
||
menu_list: 菜单查询集或列表
|
||
|
||
Returns:
|
||
list: 树形结构的菜单列表
|
||
"""
|
||
menu_data = []
|
||
for item in menu_list:
|
||
data = {
|
||
'id': item.id,
|
||
'name': item.name,
|
||
'icon': item.icon,
|
||
'icon2': getattr(item, 'icon2', ''),
|
||
'parentId': item.parent_id,
|
||
'path': item.path,
|
||
'component': item.component,
|
||
'permission': item.permission,
|
||
'target': item.target,
|
||
'type': item.type,
|
||
'hide': item.hide,
|
||
}
|
||
menu_data.append(data)
|
||
|
||
# 递归构建树形结构
|
||
result = _get_tree(menu_data, 0)
|
||
return result
|
||
|
||
|
||
def _get_tree(data, parent_id):
|
||
"""
|
||
递归获取树状结构（私有辅助函数）
|
||
|
||
Args:
|
||
data: 菜单数据列表
|
||
parent_id: 父级ID
|
||
|
||
Returns:
|
||
list: 树形结构数据
|
||
"""
|
||
result = []
|
||
for item in data:
|
||
if parent_id != item["parentId"]:
|
||
continue
|
||
|
||
# 递归获取子节点
|
||
children = _get_tree(data, item["id"])
|
||
if children:
|
||
item["children"] = children
|
||
else:
|
||
item["children"] = []
|
||
|
||
result.append(item)
|
||
|
||
return result
|