Files
2026-05-18 09:28:15 +08:00

376 lines
15 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""菜单管理模块
对应前端源码: api/system/menu.ts
parentId 规则:
- "-1" 表示顶级菜单
- 或已存在的目录菜单(type=1)的 ID
- 禁止使用 systemId!
类型 (type):
- 1: 目录菜单
- 2: Vue 扩展页面
- 3: 功能表单菜单
编码规则 (en_code):
- 业务字母开头 ^[a-zA-Z]
- 字母+数字组成 [a-zA-Z0-9]*
- 末尾是字母 [a-zA-Z]$
- 示例: customerList, orderMgmt, productInfo
url_address 规则 (type=2):
- 不能为空
- 必须以 ssw/{app_code}/ 开头
- 示例: ssw/tdc/jyzs/AiSmartInput
"""
import json
import random
import re
import string
import warnings
from aibridge.client import JNPFClient
from aibridge.models import APIResponse
def _random_suffix() -> str:
return ''.join(random.choices(string.digits, k=6))
def _validate_en_code_warning(en_code: str) -> None:
"""校验菜单编码格式,违规则发出警告(不阻止执行)"""
if not en_code:
warnings.warn("菜单 enCode 为空")
return
if not re.match(r"^[a-zA-Z][a-zA-Z0-9]*[a-zA-Z]$", en_code):
warnings.warn(
f"菜单 enCode '{en_code}' 不符合规范(业务字母开头,字母+数字组成,末尾是字母):"
r"^[a-zA-Z][a-zA-Z0-9]*[a-zA-Z]$"
)
def _validate_url_address_warning(url_address: str, app_code: str) -> None:
"""校验 url_address 格式,违规则发出警告(不阻止执行)"""
if not url_address:
warnings.warn("create_page_menu 的 url_address 不能为空")
return
expected_prefix = f"ssw/{app_code}/"
if not url_address.startswith(expected_prefix):
warnings.warn(
f"create_page_menu 的 url_address '{url_address}' 应以 '{expected_prefix}' 开头"
)
def _unique_name(api, base_name: str) -> str:
"""检查名称是否已存在,存在则加随机后缀"""
try:
resp = api._client.data_model.query_one("0", "base_module", "f_full_name", base_name)
if resp:
return f"{base_name}_{_random_suffix()}"
except Exception:
pass
return base_name
class MenuAPI:
"""菜单管理 API"""
def __init__(self, client: JNPFClient):
self._client = client
self._prefix = "/api/system/Menu"
# ==================== 基础 CRUD ====================
def get_list(self, data: dict = None) -> APIResponse:
"""获取菜单列表"""
return self._client.request("GET", f"{self._prefix}/ModuleBySystem", params=data or {})
def get_all_menus(self) -> list:
"""获取当前应用的所有菜单(扁平列表,包含目录)
使用 data_model.query 直接查询 base_module 表,并按 system_id 过滤。
"""
result = []
page = 1
system_id = self._client.config.system_id # 数字ID,不是 app_code
while True:
resp = self._client.data_model.query("0", "base_module",
current_page=page, page_size=500)
if not resp.success or not resp.data:
break
items = resp.data.get("list", [])
if not items:
break
for item in items:
# 按 system_id 过滤
if item.get("f_system_id") != system_id:
continue
result.append({
"id": item.get("f_id"),
"parentId": item.get("f_parent_id"),
"type": item.get("f_type"),
"fullName": item.get("f_full_name"),
"enCode": item.get("f_en_code"),
})
if len(items) < 500:
break
page += 1
return result
def get_user_menu_tree(self) -> list:
"""获取当前用户可见的菜单树(从 /api/oauth/CurrentUser 获取)
这是用户登录后浏览器实际使用的菜单数据,包含完整的多级嵌套结构。
比 get_tree() 更准确,直接反映用户在界面看到的菜单。
Returns:
树形结构菜单列表,每个节点包含 children 数组
"""
import time
resp = self._client.request("GET", "/api/oauth/CurrentUser", params={
"systemCode": self._client.app_code,
"isBackend": "0",
"_t": str(int(time.time() * 1000))
})
if resp.success and resp.data:
return resp.data.get("menuList", [])
return []
def get_children(self, parent_id: str) -> list:
"""获取指定菜单的子菜单"""
tree = self.get_user_menu_tree()
def find_children(menus, target_id):
for m in menus:
if m.get("id") == target_id:
return m.get("children", [])
if m.get("children"):
result = find_children(m.get("children"), target_id)
if result is not None:
return result
return None
result = find_children(tree, parent_id)
return result if result is not None else []
def get_info(self, menu_id: str) -> APIResponse:
"""获取菜单详情"""
return self._client.request("GET", f"{self._prefix}/{menu_id}")
def create(self, data: dict) -> APIResponse:
"""新建菜单"""
return self._client.request("POST", self._prefix, data=data)
def update(self, data: dict) -> APIResponse:
"""修改菜单(自动合并完整数据)"""
menu_id = data.get("id")
info = self.get_info(menu_id)
if info.code != 200:
return info
full_data = info.data.copy()
full_data.update(data)
return self._client.request("PUT", f"{self._prefix}/{menu_id}", json_data=full_data)
def delete(self, menu_id: str) -> APIResponse:
"""删除菜单(建议用 soft_delete)"""
return self._client.request("DELETE", f"{self._prefix}/{menu_id}")
# ==================== 查询辅助 ====================
def get_id_by_en_code(self, en_code: str) -> str | None:
"""通过编码查询菜单 ID(精确匹配,仅返回完全一致的一条)"""
try:
resp = self._client.data_model.query("0", "base_module", keyword=en_code, field="f_en_code", page_size=999)
if resp.success and resp.data:
records = resp.data.get("list", [])
# 精确匹配 en_code
for record in records:
if record.get("f_en_code") == en_code:
return record.get("f_id")
return None
except Exception:
return None
def get_id_by_name(self, full_name: str) -> str | None:
"""通过名称查询菜单 ID"""
resp = self._client.request("GET", f"{self._prefix}/Selector/0", params={"category": "Web"})
if resp.success and resp.data:
for item in resp.data.get("list", []):
if item.get("fullName") == full_name:
return item.get("id")
return None
def check_en_code_exists(self, en_code: str) -> bool:
"""检查编码是否已存在"""
return self.get_id_by_en_code(en_code) is not None
def check_name_exists(self, full_name: str) -> bool:
"""检查名称是否已存在"""
return self.get_id_by_name(full_name) is not None
# ==================== parentId ====================
def update_parent(self, menu_id: str, new_parent_id: str) -> APIResponse:
"""修改菜单的父级"""
info = self.get_info(menu_id)
if info.code != 200:
return info
data = info.data.copy()
data["parentId"] = new_parent_id
return self.update(data)
def batch_update_parent(self, menu_ids: list, new_parent_id: str) -> dict:
"""批量修改父级"""
results = {"success": 0, "failed": 0}
for menu_id in menu_ids:
if self.update_parent(menu_id, new_parent_id).code == 200:
results["success"] += 1
else:
results["failed"] += 1
return results
# ==================== 软删除 ====================
def soft_delete(self, menu_id: str) -> APIResponse:
"""软删除:停用 + 改名,避免重建冲突"""
info = self.get_info(menu_id)
if info.code != 200:
return info
data = info.data.copy()
data["enabledMark"] = 0
data["sortCode"] = 1000
name = data.get("fullName", "")
if f"({menu_id})" not in name:
data["fullName"] = f"{name}({menu_id})"
code = data.get("enCode", "")
if f"_{menu_id}" not in code:
data["enCode"] = f"{code}_{menu_id}"
return self.update(data)
def move_to_deleted(self, menu_ids: list) -> dict:
"""批量软删除"""
return {mid: self.soft_delete(mid).code == 200 for mid in menu_ids}
# ==================== 创建菜单 ====================
def _build_menu_data(self, menu_type: int, full_name: str, en_code: str,
parent_id: str, icon: str = "", sort_code: int = 0,
url_address: str = "", property_json: str = "",
category: str = "Web") -> dict:
"""构建菜单数据"""
return {
"parentId": parent_id,
"fullName": _unique_name(self, full_name),
"enCode": en_code,
"type": menu_type,
"category": category,
"icon": icon,
"urlAddress": url_address,
"propertyJson": property_json or '{"ids":[]}',
"enabledMark": 1,
"sortCode": sort_code,
"isButtonAuthorize": 0,
"isColumnAuthorize": 0,
"isDataAuthorize": 0,
"isFormAuthorize": 0,
"isCollapse": False,
"noShow": 0,
}
def _create_with_fix(self, data: dict, en_code: str, full_name: str,
parent_id: str, rename_fields: dict = None) -> APIResponse:
"""创建菜单并自动修复 parentId"""
resp = self.create(data)
actual_id = self.get_id_by_en_code(en_code)
if actual_id:
rename_data = {"id": actual_id, "fullName": full_name, "enCode": en_code}
if rename_fields:
rename_data.update(rename_fields)
self.update(rename_data)
info = self.get_info(actual_id)
if info.success and info.data.get("parentId") != parent_id:
self.update_parent(actual_id, parent_id)
result = APIResponse(code=resp.code, data={"id": actual_id}, msg=resp.msg)
result.id = actual_id
return result
def create_directory_menu(self, full_name: str, en_code: str,
icon: str = "icon-ym icon-ym-folder",
sort_code: int = 0, parent_id: str = "-1") -> APIResponse:
"""创建目录菜单(type=1)"""
_validate_en_code_warning(en_code)
data = self._build_menu_data(1, full_name, en_code, parent_id, icon, sort_code)
return self._create_with_fix(data, en_code, full_name, parent_id)
def create_form_menu(self, full_name: str, en_code: str, visual_dev_id: str,
parent_id: str, web_type: int = 2, sort_code: int = 0) -> APIResponse:
"""创建功能表单菜单(type=3)"""
_validate_en_code_warning(en_code)
prop = json.dumps({"moduleId": visual_dev_id, "webType": web_type, "isTree": 0}, ensure_ascii=False)
url = f"model/{en_code}"
data = self._build_menu_data(3, full_name, en_code, parent_id, "", sort_code, url, prop)
return self._create_with_fix(data, en_code, full_name, parent_id, {"urlAddress": url})
def create_page_menu(self, full_name: str, en_code: str, url_address: str,
parent_id: str = "-1", icon: str = "", sort_code: int = 0,
module_id: str = None, web_type: int = 2) -> APIResponse:
"""创建 Vue 页面菜单(type=2)"""
_validate_en_code_warning(en_code)
_validate_url_address_warning(url_address, self._client.app_code)
prop = json.dumps({"moduleId": module_id or "", "webType": web_type, "isTree": 0}, ensure_ascii=False)
data = self._build_menu_data(2, full_name, en_code, parent_id, icon, sort_code, url_address, prop)
return self._create_with_fix(data, en_code, full_name, parent_id)
# ==================== 移动端 App 菜单 ====================
def create_app_directory_menu(self, full_name: str, en_code: str,
icon: str = "icon-ym icon-ym-folder",
sort_code: int = 0, parent_id: str = "-1") -> APIResponse:
"""创建移动端目录菜单(category=App)"""
_validate_en_code_warning(en_code)
data = self._build_menu_data(1, full_name, en_code, parent_id, icon, sort_code, category="App")
resp = self.create(data)
actual_id = self.get_id_by_en_code(en_code)
if actual_id:
self.update({"id": actual_id, "fullName": full_name, "enCode": en_code})
result = APIResponse(code=resp.code, data={"id": actual_id}, msg=resp.msg)
result.id = actual_id
return result
def create_app_form_menu(self, full_name: str, en_code: str, form_id: str,
parent_id: str, icon: str = "icon-ym icon-ym-webForm",
sort_code: int = 0, web_type: int = 2) -> APIResponse:
"""创建移动端功能菜单(category=App)"""
app_en_code = f"{en_code}_app" if not en_code.endswith("_app") else en_code
_validate_en_code_warning(app_en_code)
prop = json.dumps({"moduleId": form_id, "webType": web_type, "isTree": 0}, ensure_ascii=False)
url = f"/pages/apply/dynamicModel/index?id={form_id}"
data = self._build_menu_data(3, full_name, en_code, parent_id, icon, sort_code, url, prop, "App")
resp = self.create(data)
actual_id = self.get_id_by_en_code(en_code)
if actual_id:
self.update({"id": actual_id, "fullName": full_name, "enCode": en_code})
result = APIResponse(code=resp.code, data={"id": actual_id}, msg=resp.msg)
result.id = actual_id
return result
def create_app_form_menu_with_parent(self, full_name: str, en_code: str, form_id: str,
parent_name: str, parent_en_code: str,
icon: str = "icon-ym icon-ym-webForm",
sort_code: int = 0, web_type: int = 2) -> dict:
"""创建移动端菜单,自动创建父目录"""
# 确保父目录存在
parent_id = self.get_id_by_en_code(parent_en_code)
if not parent_id:
dir_resp = self.create_app_directory_menu(parent_name, parent_en_code, sort_code=0)
parent_id = dir_resp.id or self.get_id_by_en_code(parent_en_code)
app_en_code = f"{en_code}_app" if not en_code.endswith("_app") else en_code
existing = self.get_id_by_en_code(app_en_code)
if existing:
return {"parent_id": parent_id, "menu_id": existing, "parent_created": False, "code": 200}
resp = self.create_app_form_menu(full_name, app_en_code, form_id, parent_id, icon, sort_code, web_type)
return {"parent_id": parent_id, "menu_id": resp.id, "parent_created": False, "code": resp.code}