role_service.py 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604
  1. """角色 CRUD、权限矩阵与用户关联维护。"""
  2. from __future__ import annotations
  3. from datetime import datetime, timezone
  4. from typing import Any
  5. from sqlalchemy import func, select
  6. from sqlalchemy.exc import IntegrityError
  7. from dms.common.enums import (
  8. AuditAction,
  9. AuditTarget,
  10. DeptScope,
  11. EnabledStatus,
  12. RoleCode,
  13. SecurityLevel,
  14. )
  15. from dms.common.errors import (
  16. ConflictError,
  17. InvalidArgumentError,
  18. ResourceNotFoundError,
  19. RoleInUseError,
  20. )
  21. from dms.common.pagination import PageRequest, page_result
  22. from dms.common.response import serialize_id
  23. from dms.database.transaction import transaction
  24. from dms.extensions import db
  25. from dms.models import Role, RolePermission, User
  26. from dms.security.auth_context import get_auth_context
  27. from dms.services.audit_service import business_audit
  28. ROLE_CREATE_FIELDS = {"roleName", "sortNo", "status", "remark", "isDefault"}
  29. ROLE_UPDATE_FIELDS = {
  30. "roleName",
  31. "sortNo",
  32. "status",
  33. "remark",
  34. "isDefault",
  35. "rowVersion",
  36. }
  37. ROLE_PERMISSION_FIELDS = {"matrix", "rowVersion"}
  38. ROLE_USER_FIELDS = {"userIds", "rowVersion"}
  39. # 矩阵 7 个操作布尔位与 AllowedAction 一一对应
  40. PERMISSION_FIELDS: tuple[tuple[str, str], ...] = (
  41. ("canView", "can_view"),
  42. ("canDownload", "can_download"),
  43. ("canEdit", "can_edit"),
  44. ("canDelete", "can_delete"),
  45. ("canConfigPermission", "can_config_permission"),
  46. ("canBindAttachment", "can_bind_attachment"),
  47. ("canUnbindAttachment", "can_unbind_attachment"),
  48. )
  49. MATRIX_KEYS = {
  50. (level.value, scope.value)
  51. for level in SecurityLevel
  52. for scope in DeptScope
  53. }
  54. def _utc_now() -> datetime:
  55. return datetime.now(timezone.utc).replace(tzinfo=None)
  56. def _required_text(
  57. value: Any,
  58. *,
  59. field: str,
  60. max_length: int,
  61. ) -> str:
  62. if not isinstance(value, str) or not value.strip():
  63. raise InvalidArgumentError(f"{field}不能为空")
  64. normalized = value.strip()
  65. if len(normalized) > max_length:
  66. raise InvalidArgumentError(f"{field}长度不能超过{max_length}")
  67. return normalized
  68. def _optional_text(value: Any, *, field: str, max_length: int) -> str | None:
  69. if value is None:
  70. return None
  71. if not isinstance(value, str):
  72. raise InvalidArgumentError(f"{field}必须是字符串")
  73. normalized = value.strip()
  74. if len(normalized) > max_length:
  75. raise InvalidArgumentError(f"{field}长度不能超过{max_length}")
  76. return normalized or None
  77. def _sort_no(value: Any) -> int:
  78. if type(value) is not int or value < 0 or value > 999999:
  79. raise InvalidArgumentError("sortNo必须是0~999999的整数")
  80. return value
  81. def _status_value(value: Any) -> str:
  82. if not isinstance(value, str):
  83. raise InvalidArgumentError("status必须是字符串")
  84. try:
  85. return EnabledStatus(value).value
  86. except ValueError as exc:
  87. raise InvalidArgumentError("status必须是ENABLED或DISABLED") from exc
  88. def _boolean(value: Any, *, field: str) -> bool:
  89. if type(value) is not bool:
  90. raise InvalidArgumentError(f"{field}必须是布尔值")
  91. return value
  92. def _row_version(value: Any) -> int:
  93. if type(value) is not int or value < 0:
  94. raise InvalidArgumentError("rowVersion必须是非负整数")
  95. return value
  96. def _id_list(value: Any, *, field: str) -> list[int]:
  97. if not isinstance(value, list) or any(
  98. not isinstance(item, str) or not item.isdecimal() or int(item) <= 0
  99. for item in value
  100. ):
  101. raise InvalidArgumentError(f"{field}必须是正整数形式的字符串ID数组")
  102. ids = [int(item) for item in value]
  103. if len(set(ids)) != len(ids):
  104. raise InvalidArgumentError(f"{field}不能包含重复ID")
  105. return ids
  106. def _exact_payload(payload: Any, expected: set[str]) -> dict[str, Any]:
  107. if not isinstance(payload, dict) or set(payload) != expected:
  108. raise InvalidArgumentError(
  109. "请求体字段必须且只能包含:" + "、".join(sorted(expected))
  110. )
  111. return payload
  112. def _role_row(session, role_id: int, *, for_update: bool = False) -> Role:
  113. stmt = select(Role).where(Role.id == role_id, Role.is_deleted.is_(False))
  114. if for_update:
  115. stmt = stmt.with_for_update()
  116. role = session.scalar(stmt)
  117. if role is None:
  118. raise ResourceNotFoundError("角色不存在")
  119. return role
  120. def _member_counts(session, role_ids: list[int]) -> dict[int, int]:
  121. if not role_ids:
  122. return {}
  123. rows = session.execute(
  124. select(User.role_id, func.count(User.id))
  125. .where(User.role_id.in_(role_ids), User.is_deleted.is_(False))
  126. .group_by(User.role_id)
  127. ).all()
  128. return {role_id: count for role_id, count in rows}
  129. def role_summary(role: Role, member_count: int) -> dict[str, object]:
  130. return {
  131. "id": serialize_id(role.id),
  132. "roleName": role.role_name,
  133. "sortNo": role.sort_no,
  134. "status": role.status,
  135. "remark": role.remark,
  136. "isDefault": role.is_default,
  137. "memberCount": member_count,
  138. "rowVersion": role.row_version,
  139. }
  140. def list_roles(
  141. *,
  142. keyword: str | None,
  143. status: str | None,
  144. page_request: PageRequest,
  145. ) -> dict[str, object]:
  146. filters = [Role.is_deleted.is_(False)]
  147. if keyword:
  148. filters.append(Role.role_name.like(f"%{keyword.strip()}%"))
  149. if status:
  150. try:
  151. normalized_status = EnabledStatus(status).value
  152. except ValueError as exc:
  153. raise InvalidArgumentError("status必须是ENABLED或DISABLED") from exc
  154. filters.append(Role.status == normalized_status)
  155. total = db.session.scalar(select(func.count(Role.id)).where(*filters)) or 0
  156. roles = db.session.scalars(
  157. select(Role)
  158. .where(*filters)
  159. .order_by(Role.sort_no.asc(), Role.id.asc())
  160. .offset(page_request.offset)
  161. .limit(page_request.page_size)
  162. ).all()
  163. counts = _member_counts(db.session, [role.id for role in roles])
  164. return page_result(
  165. [role_summary(role, counts.get(role.id, 0)) for role in roles],
  166. page=page_request.page,
  167. page_size=page_request.page_size,
  168. total=total,
  169. )
  170. def _clear_other_defaults(session, *, keep_id: int | None) -> None:
  171. """将除 keep_id 外的活跃默认角色取消默认标记(先清后设避免唯一约束冲突)。"""
  172. stmt = select(Role).where(
  173. Role.is_default.is_(True),
  174. Role.is_deleted.is_(False),
  175. )
  176. if keep_id is not None:
  177. stmt = stmt.where(Role.id != keep_id)
  178. actor_id = get_auth_context().user_id
  179. now = _utc_now()
  180. for existing in session.scalars(stmt).all():
  181. existing.is_default = False
  182. existing.updated_by = actor_id
  183. existing.updated_at = now
  184. existing.row_version += 1
  185. def _ensure_role_name_free(session, role_name: str, *, exclude_id: int) -> None:
  186. duplicated = session.scalar(
  187. select(Role.id).where(
  188. Role.role_name == role_name,
  189. Role.is_deleted.is_(False),
  190. Role.id != exclude_id,
  191. )
  192. )
  193. if duplicated is not None:
  194. raise ConflictError("角色名已存在")
  195. def _seed_permission_rows(session, role_id: int, actor_id: int | None) -> None:
  196. for level in SecurityLevel:
  197. for scope in DeptScope:
  198. session.add(
  199. RolePermission(
  200. role_id=role_id,
  201. security_level=level.value,
  202. dept_scope=scope.value,
  203. created_by=actor_id,
  204. updated_by=actor_id,
  205. )
  206. )
  207. def create_role(payload: Any) -> dict[str, object]:
  208. body = _exact_payload(payload, ROLE_CREATE_FIELDS)
  209. role_name = _required_text(body["roleName"], field="roleName", max_length=64)
  210. sort_no = _sort_no(body["sortNo"])
  211. status = _status_value(body["status"])
  212. remark = _optional_text(body["remark"], field="remark", max_length=255)
  213. is_default = _boolean(body["isDefault"], field="isDefault")
  214. actor_id = get_auth_context().user_id
  215. try:
  216. with transaction() as session:
  217. _ensure_role_name_free(session, role_name, exclude_id=0)
  218. if is_default:
  219. _clear_other_defaults(session, keep_id=None)
  220. session.flush()
  221. role = Role(
  222. role_name=role_name,
  223. sort_no=sort_no,
  224. status=status,
  225. remark=remark,
  226. is_default=is_default,
  227. created_by=actor_id,
  228. updated_by=actor_id,
  229. )
  230. session.add(role)
  231. session.flush()
  232. _seed_permission_rows(session, role.id, actor_id)
  233. session.add(
  234. business_audit(
  235. action=AuditAction.CREATE_ROLE,
  236. target=AuditTarget.ROLE,
  237. target_id=role.id,
  238. target_name=role.role_name,
  239. detail={
  240. "roleName": role.role_name,
  241. "sortNo": role.sort_no,
  242. "status": role.status,
  243. "remark": role.remark,
  244. "isDefault": role.is_default,
  245. },
  246. )
  247. )
  248. return role_summary(role, 0)
  249. except IntegrityError as exc:
  250. raise ConflictError("角色名已存在或默认角色设置冲突") from exc
  251. def update_role(role_id: int, payload: Any) -> dict[str, object]:
  252. body = _exact_payload(payload, ROLE_UPDATE_FIELDS)
  253. role_name = _required_text(body["roleName"], field="roleName", max_length=64)
  254. sort_no = _sort_no(body["sortNo"])
  255. status = _status_value(body["status"])
  256. remark = _optional_text(body["remark"], field="remark", max_length=255)
  257. is_default = _boolean(body["isDefault"], field="isDefault")
  258. expected_version = _row_version(body["rowVersion"])
  259. actor_id = get_auth_context().user_id
  260. now = _utc_now()
  261. with transaction() as session:
  262. role = _role_row(session, role_id, for_update=True)
  263. if role.row_version != expected_version:
  264. raise ConflictError(
  265. "数据已被其他用户修改,请刷新后重试",
  266. details={"currentRowVersion": role.row_version},
  267. )
  268. _ensure_role_name_free(session, role_name, exclude_id=role.id)
  269. before = {
  270. "roleName": role.role_name,
  271. "sortNo": role.sort_no,
  272. "status": role.status,
  273. "remark": role.remark,
  274. "isDefault": role.is_default,
  275. }
  276. # 新设默认:先清旧默认,避免 default_marker 唯一约束冲突
  277. if is_default and not role.is_default:
  278. _clear_other_defaults(session, keep_id=role.id)
  279. session.flush()
  280. role.role_name = role_name
  281. role.sort_no = sort_no
  282. role.status = status
  283. role.remark = remark
  284. role.is_default = is_default
  285. role.updated_by = actor_id
  286. role.updated_at = now
  287. role.row_version += 1
  288. after = {
  289. "roleName": role.role_name,
  290. "sortNo": role.sort_no,
  291. "status": role.status,
  292. "remark": role.remark,
  293. "isDefault": role.is_default,
  294. }
  295. session.add(
  296. business_audit(
  297. action=AuditAction.EDIT_ROLE,
  298. target=AuditTarget.ROLE,
  299. target_id=role.id,
  300. target_name=role.role_name,
  301. detail={"before": before, "after": after},
  302. )
  303. )
  304. member_count = _member_counts(db.session, [role.id]).get(role.id, 0)
  305. return role_summary(role, member_count)
  306. def delete_role(role_id: int, row_version: int) -> dict[str, object]:
  307. actor_id = get_auth_context().user_id
  308. now = _utc_now()
  309. with transaction() as session:
  310. role = _role_row(session, role_id, for_update=True)
  311. if role.row_version != row_version:
  312. raise ConflictError(
  313. "数据已被其他用户修改,请刷新后重试",
  314. details={"currentRowVersion": role.row_version},
  315. )
  316. bound_users = (
  317. session.scalar(
  318. select(func.count(User.id)).where(
  319. User.role_id == role_id,
  320. User.is_deleted.is_(False),
  321. )
  322. )
  323. or 0
  324. )
  325. if bound_users:
  326. raise RoleInUseError(
  327. details={"memberCount": bound_users},
  328. )
  329. target_name = role.role_name
  330. role.is_deleted = True
  331. role.deleted_at = now
  332. role.updated_by = actor_id
  333. role.updated_at = now
  334. role.row_version += 1
  335. # 矩阵行随角色软删,保留审计追溯
  336. for row in session.scalars(
  337. select(RolePermission).where(
  338. RolePermission.role_id == role_id,
  339. RolePermission.is_deleted.is_(False),
  340. )
  341. ).all():
  342. row.is_deleted = True
  343. row.deleted_at = now
  344. row.updated_by = actor_id
  345. row.updated_at = now
  346. session.add(
  347. business_audit(
  348. action=AuditAction.DELETE_ROLE,
  349. target=AuditTarget.ROLE,
  350. target_id=role_id,
  351. target_name=target_name,
  352. detail={"roleName": target_name, "rowVersion": role.row_version},
  353. )
  354. )
  355. return {"id": serialize_id(role_id), "deleted": True}
  356. def _permission_row_dto(row: RolePermission) -> dict[str, object]:
  357. dto: dict[str, object] = {
  358. "securityLevel": row.security_level,
  359. "deptScope": row.dept_scope,
  360. }
  361. for name, attr in PERMISSION_FIELDS:
  362. dto[name] = getattr(row, attr)
  363. return dto
  364. def list_role_permissions(role_id: int) -> list[dict[str, object]]:
  365. _role_row(db.session, role_id)
  366. rows = db.session.scalars(
  367. select(RolePermission)
  368. .where(
  369. RolePermission.role_id == role_id,
  370. RolePermission.is_deleted.is_(False),
  371. )
  372. .order_by(RolePermission.id.asc())
  373. ).all()
  374. return [_permission_row_dto(row) for row in rows]
  375. def _validate_matrix(value: Any) -> list[dict[str, Any]]:
  376. expected_row_fields = {"securityLevel", "deptScope"} | {
  377. name for name, _ in PERMISSION_FIELDS
  378. }
  379. if not isinstance(value, list) or len(value) != len(MATRIX_KEYS):
  380. raise InvalidArgumentError(f"权限矩阵必须为{len(MATRIX_KEYS)}行")
  381. rows: dict[tuple[str, str], dict[str, Any]] = {}
  382. for item in value:
  383. if not isinstance(item, dict) or set(item) != expected_row_fields:
  384. raise InvalidArgumentError(
  385. "矩阵行字段必须且只能包含:" + "、".join(sorted(expected_row_fields))
  386. )
  387. key = (item["securityLevel"], item["deptScope"])
  388. if key not in MATRIX_KEYS:
  389. raise InvalidArgumentError("矩阵行的密级或部门范围不是有效枚举值")
  390. if key in rows:
  391. raise InvalidArgumentError("矩阵行不能重复")
  392. for name, _ in PERMISSION_FIELDS:
  393. if type(item[name]) is not bool:
  394. raise InvalidArgumentError(f"{name}必须是布尔值")
  395. rows[key] = item
  396. return list(value)
  397. def update_role_permissions(role_id: int, payload: Any) -> dict[str, object]:
  398. body = _exact_payload(payload, ROLE_PERMISSION_FIELDS)
  399. matrix = _validate_matrix(body["matrix"])
  400. expected_version = _row_version(body["rowVersion"])
  401. actor_id = get_auth_context().user_id
  402. now = _utc_now()
  403. with transaction() as session:
  404. role = _role_row(session, role_id, for_update=True)
  405. if role.row_version != expected_version:
  406. raise ConflictError(
  407. "数据已被其他用户修改,请刷新后重试",
  408. details={"currentRowVersion": role.row_version},
  409. )
  410. existing_rows = session.scalars(
  411. select(RolePermission).where(
  412. RolePermission.role_id == role_id,
  413. RolePermission.is_deleted.is_(False),
  414. )
  415. ).all()
  416. by_key = {(row.security_level, row.dept_scope): row for row in existing_rows}
  417. if set(by_key) != MATRIX_KEYS:
  418. raise ConflictError("角色权限矩阵数据不完整,请联系管理员核查")
  419. changed_keys: list[dict[str, object]] = []
  420. for item in matrix:
  421. row = by_key[(item["securityLevel"], item["deptScope"])]
  422. before_flags = {
  423. name: getattr(row, attr) for name, attr in PERMISSION_FIELDS
  424. }
  425. after_flags = {name: item[name] for name, _ in PERMISSION_FIELDS}
  426. if before_flags != after_flags:
  427. row.updated_by = actor_id
  428. row.updated_at = now
  429. for name, attr in PERMISSION_FIELDS:
  430. setattr(row, attr, item[name])
  431. changed_keys.append(
  432. {
  433. "securityLevel": row.security_level,
  434. "deptScope": row.dept_scope,
  435. "before": before_flags,
  436. "after": after_flags,
  437. }
  438. )
  439. role.updated_by = actor_id
  440. role.updated_at = now
  441. role.row_version += 1
  442. session.add(
  443. business_audit(
  444. action=AuditAction.CHANGE_ROLE_PERMISSION,
  445. target=AuditTarget.ROLE,
  446. target_id=role_id,
  447. target_name=role.role_name,
  448. detail={"scope": "matrix", "changedRows": changed_keys},
  449. )
  450. )
  451. return {
  452. "id": serialize_id(role_id),
  453. "matrix": list_role_permissions(role_id),
  454. "rowVersion": role.row_version,
  455. }
  456. def list_role_users(role_id: int) -> dict[str, object]:
  457. _role_row(db.session, role_id)
  458. user_ids = db.session.scalars(
  459. select(User.id)
  460. .where(User.role_id == role_id, User.is_deleted.is_(False))
  461. .order_by(User.id.asc())
  462. ).all()
  463. return {"id": serialize_id(role_id), "userIds": [serialize_id(v) for v in user_ids]}
  464. def update_role_users(role_id: int, payload: Any) -> dict[str, object]:
  465. body = _exact_payload(payload, ROLE_USER_FIELDS)
  466. user_ids = _id_list(body["userIds"], field="userIds")
  467. expected_version = _row_version(body["rowVersion"])
  468. actor_id = get_auth_context().user_id
  469. now = _utc_now()
  470. with transaction() as session:
  471. role = _role_row(session, role_id, for_update=True)
  472. if role.row_version != expected_version:
  473. raise ConflictError(
  474. "数据已被其他用户修改,请刷新后重试",
  475. details={"currentRowVersion": role.row_version},
  476. )
  477. target_ids = set(user_ids)
  478. found: dict[int, User] = {}
  479. if target_ids:
  480. for user in session.scalars(
  481. select(User)
  482. .where(User.id.in_(target_ids), User.is_deleted.is_(False))
  483. .with_for_update()
  484. ).all():
  485. found[user.id] = user
  486. if set(found) != target_ids:
  487. raise InvalidArgumentError("userIds包含无效用户")
  488. for user in found.values():
  489. if user.role_code != RoleCode.USER.value:
  490. raise InvalidArgumentError("仅普通用户可关联自定义角色")
  491. current_users = session.scalars(
  492. select(User)
  493. .where(User.role_id == role_id, User.is_deleted.is_(False))
  494. .with_for_update()
  495. ).all()
  496. added_ids: list[int] = []
  497. removed_ids: list[int] = []
  498. for user in current_users:
  499. if user.id not in target_ids:
  500. user.role_id = None
  501. user.auth_version += 1
  502. user.updated_by = actor_id
  503. user.updated_at = now
  504. user.row_version += 1
  505. removed_ids.append(user.id)
  506. for user_id in sorted(target_ids):
  507. user = found[user_id]
  508. if user.role_id != role_id:
  509. user.role_id = role_id
  510. user.auth_version += 1
  511. user.updated_by = actor_id
  512. user.updated_at = now
  513. user.row_version += 1
  514. added_ids.append(user_id)
  515. role.updated_by = actor_id
  516. role.updated_at = now
  517. role.row_version += 1
  518. session.add(
  519. business_audit(
  520. action=AuditAction.CHANGE_ROLE_USER,
  521. target=AuditTarget.ROLE,
  522. target_id=role_id,
  523. target_name=role.role_name,
  524. detail={
  525. "addedUserIds": [serialize_id(v) for v in added_ids],
  526. "removedUserIds": [serialize_id(v) for v in removed_ids],
  527. },
  528. )
  529. )
  530. return {
  531. "id": serialize_id(role_id),
  532. "userIds": [serialize_id(v) for v in sorted(target_ids)],
  533. "rowVersion": role.row_version,
  534. }