File size: 16,672 Bytes
b4f2238 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 | """
文件夹模板 Admin 配置
Requirements: 6.1, 6.7
"""
import logging
from typing import Any
from django import forms
from django.contrib import admin
from django.http import JsonResponse
from django.urls import path
from django.utils.html import format_html
from django.utils.translation import gettext_lazy as _
from apps.core.exceptions import NotFoundError
from apps.core.models.enums import LegalStatus
from apps.documents.models import (
DocumentCaseStage,
DocumentCaseType,
DocumentContractType,
FolderTemplate,
FolderTemplateType,
LegalStatusMatchMode,
)
logger = logging.getLogger(__name__)
def _get_admin_service() -> Any:
"""工厂函数:获取Admin服务实例"""
from apps.documents.services.template.folder_template.admin_service import FolderTemplateAdminService
return FolderTemplateAdminService()
class MultiSelectWidget(forms.CheckboxSelectMultiple):
"""多选复选框组件"""
template_name: str = "django/forms/widgets/checkbox_select.html"
option_template_name: str = "django/forms/widgets/checkbox_option.html"
class FolderTemplateForm(forms.ModelForm):
"""文件夹模板表单,包含ID验证逻辑和多选字段"""
# 模板类型单选(必选)
template_type = forms.ChoiceField(
choices=FolderTemplateType.choices,
widget=forms.RadioSelect,
label=_("模板类型"),
help_text=_("必须选择:合同文件夹模板或案件文件夹模板"),
)
# 合同类型多选(放在最上面)
contract_types_field = forms.MultipleChoiceField(
choices=[(c.value, c.label) for c in DocumentContractType],
widget=forms.CheckboxSelectMultiple,
required=False,
label=_("合同类型"),
help_text=_("仅在选择'合同文件夹模板'时有效,可多选"),
)
# 案件类型多选
case_types_field = forms.MultipleChoiceField(
choices=[(c.value, c.label) for c in DocumentCaseType],
widget=forms.CheckboxSelectMultiple,
required=False,
label=_("案件类型"),
help_text=_("仅在选择'案件文件夹模板'时有效,可多选"),
)
# 案件阶段单选
case_stage_field = forms.ChoiceField(
choices=[("", "不限")] + [(c.value, c.label) for c in DocumentCaseStage],
widget=forms.Select,
required=False,
label=_("案件阶段"),
help_text=_("仅在选择'案件文件夹模板'时有效,单选"),
)
# 诉讼地位多选
legal_statuses_field = forms.MultipleChoiceField(
choices=LegalStatus.choices,
widget=forms.CheckboxSelectMultiple,
required=False,
label=_("我方诉讼地位"),
help_text=_("仅在选择'案件文件夹模板'时有效,可多选;不选表示匹配任意诉讼地位"),
)
# 诉讼地位匹配模式
legal_status_match_mode = forms.ChoiceField(
choices=LegalStatusMatchMode.choices,
widget=forms.Select,
required=False,
label=_("诉讼地位匹配模式"),
help_text=_("仅在选择'案件文件夹模板'时有效"),
)
class Meta:
model = FolderTemplate
fields = ["name", "template_type", "is_active", "structure"]
def __init__(self, *args: Any, **kwargs: Any) -> None:
"""初始化表单,保存request对象用于消息显示"""
self.request = kwargs.pop("request", None)
super().__init__(*args, **kwargs)
# 从实例加载已选值
if self.instance and self.instance.pk:
self.fields["template_type"].initial = self.instance.template_type
self.fields["contract_types_field"].initial = self.instance.contract_types or []
self.fields["case_types_field"].initial = self.instance.case_types or []
# 案件阶段:从列表取第一个值或空
case_stages = self.instance.case_stages or []
self.fields["case_stage_field"].initial = case_stages[0] if case_stages else ""
# 诉讼地位字段
self.fields["legal_statuses_field"].initial = self.instance.legal_statuses or []
self.fields["legal_status_match_mode"].initial = (
self.instance.legal_status_match_mode or LegalStatusMatchMode.ANY
)
def clean_structure(self) -> Any:
"""验证并自动修复文件夹结构中的重复ID"""
structure = self.cleaned_data.get("structure")
if not structure:
return structure
admin_service = _get_admin_service()
# 准备验证数据
form_data = {"structure": structure, "id": self.instance.id if self.instance.pk else None}
# 验证并尝试自动修复
validation_result = admin_service.validate_and_fix_template_form(form_data)
if not validation_result["is_valid"]:
# 如果验证失败且无法修复,显示错误
error_messages = validation_result["errors"]
if len(error_messages) == 1:
raise forms.ValidationError(error_messages[0])
else:
combined_message = "文件夹结构验证失败:" + ";".join(error_messages)
raise forms.ValidationError(combined_message)
# 如果自动修复了重复ID,使用修复后的结构
if validation_result["is_fixed"]:
fixed_structure = validation_result["fixed_structure"]
fix_messages = validation_result["fix_messages"]
# 保存修复消息,在save_model中显示
self._fix_messages = fix_messages
return fixed_structure
return structure
def save(self, commit: bool = True) -> Any:
"""保存时将多选字段值写入JSON字段,根据模板类型处理相应字段"""
instance = super().save(commit=False)
admin_service = _get_admin_service()
save_data = admin_service.prepare_save_data(
template_type=self.cleaned_data.get("template_type"),
contract_types_field=self.cleaned_data.get("contract_types_field", []),
case_types_field=self.cleaned_data.get("case_types_field", []),
case_stage_field=self.cleaned_data.get("case_stage_field", ""),
legal_statuses_field=self.cleaned_data.get("legal_statuses_field", []),
legal_status_match_mode=self.cleaned_data.get("legal_status_match_mode", LegalStatusMatchMode.ANY),
)
instance.template_type = save_data["template_type"]
instance.contract_types = save_data["contract_types"]
instance.case_types = save_data["case_types"]
instance.case_stages = save_data["case_stages"]
instance.legal_statuses = save_data["legal_statuses"]
instance.legal_status_match_mode = save_data["legal_status_match_mode"]
if commit:
instance.save()
return instance
@admin.register(FolderTemplate)
class FolderTemplateAdmin(admin.ModelAdmin[FolderTemplate]):
"""
文件夹模板管理
提供文件夹模板的 CRUD 操作和拖拽配置界面.
"""
form = FolderTemplateForm # 使用自定义表单
list_display = (
"id",
"name",
"template_type_display",
"contract_types_display",
"case_types_display",
"case_stage_display",
"legal_statuses_display",
"legal_status_match_mode_display",
"is_active",
"folder_count_display",
"updated_at",
)
list_filter = (
"template_type",
"is_active",
)
search_fields = ("name",)
list_per_page = 50
ordering = ("-updated_at",)
readonly_fields = (
"created_at",
"updated_at",
"structure_preview",
)
fieldsets = (
(None, {"fields": ("name",)}),
(_("模板类型"), {"fields": ("template_type",), "description": _("选择此模板用于合同还是案件,必须二选一")}),
(
_("适用范围"),
{
"fields": (
"contract_types_field",
"case_types_field",
"case_stage_field",
"legal_statuses_field",
"legal_status_match_mode",
),
"description": _("根据模板类型选择相应的适用范围:合同模板选择合同类型,案件模板选择案件类型和阶段"),
},
),
(_("状态"), {"fields": ("is_active",)}),
(
_("文件夹结构"),
{"fields": ("structure", "structure_preview"), "description": _("使用 JSON 格式定义文件夹层级结构")},
),
(_("时间信息"), {"fields": ("created_at", "updated_at"), "classes": ("collapse",)}),
)
actions = ["activate_templates", "deactivate_templates", "duplicate_templates"]
change_form_template = "admin/documents/foldertemplate/change_form.html"
change_list_template = "admin/documents/foldertemplate/change_list.html"
class Media:
css = {LegalStatusMatchMode.ALL: ("documents/css/folder_tree.css", "documents/css/multi_select.css")}
js = (
"documents/js/folder_tree.js",
"documents/js/template_type_toggle.js",
)
@admin.display(description=_("模板类型"))
def template_type_display(self, obj: FolderTemplate) -> str:
"""显示模板类型"""
return str(obj.template_type_display)
@admin.display(description=_("合同类型"))
def contract_types_display(self, obj: FolderTemplate) -> str:
"""显示合同类型"""
return str(obj.contract_types_display)
@admin.display(description=_("案件类型"))
def case_types_display(self, obj: FolderTemplate) -> str:
"""显示案件类型"""
return str(obj.case_types_display)
@admin.display(description=_("案件阶段"))
def case_stage_display(self, obj: FolderTemplate) -> str:
"""显示案件阶段"""
stages = obj.case_stages or []
if not stages:
return "-"
stage_label = dict(DocumentCaseStage.choices).get(stages[0], stages[0])
return str(stage_label)
@admin.display(description=_("我方诉讼地位"))
def legal_statuses_display(self, obj: FolderTemplate) -> str:
"""显示诉讼地位"""
if obj.template_type != "case":
return "-"
return str(obj.get_legal_statuses_display() or "任意")
@admin.display(description=_("匹配模式"))
def legal_status_match_mode_display(self, obj: FolderTemplate) -> str:
"""显示诉讼地位匹配模式"""
if obj.template_type != "case":
return "-"
return str(obj.get_legal_status_match_mode_display())
def get_urls(self) -> list[Any]:
"""添加自定义URL"""
urls = super().get_urls()
custom_urls = [
path(
"validate-structure/",
self.admin_site.admin_view(self.validate_structure_view),
name="documents_foldertemplate_validate_structure",
),
path(
"duplicate-report/",
self.admin_site.admin_view(self.duplicate_report_view),
name="documents_foldertemplate_duplicate_report",
),
path(
"initialize-defaults/",
self.admin_site.admin_view(self.initialize_defaults_view),
name="documents_foldertemplate_initialize_defaults",
),
path(
"<int:pk>/structure-json/",
self.admin_site.admin_view(self.get_structure_json_view),
name="documents_foldertemplate_structure_json",
),
]
return custom_urls + urls
def validate_structure_view(self, request: Any) -> JsonResponse:
"""AJAX结构验证视图"""
admin_service = _get_admin_service()
try:
import json
data: dict[str, Any] = json.loads(request.body)
except Exception:
logger.exception("操作失败")
data = {}
result = admin_service.validate_structure_ids(
structure=data.get("structure"),
template_id=data.get("template_id"),
)
return JsonResponse(result)
def duplicate_report_view(self, request: Any) -> JsonResponse:
"""重复ID报告视图"""
admin_service = _get_admin_service()
report_data = admin_service.get_duplicate_report()
return JsonResponse(report_data)
def initialize_defaults_view(self, request: Any) -> Any:
"""初始化默认模板视图"""
from django.contrib import messages
from django.shortcuts import redirect
admin_service = _get_admin_service()
result = admin_service.initialize_default_templates()
for item in result.get("messages", []):
level = item.get("level")
message = item.get("message")
if not message:
continue
if level == "success":
messages.success(request, message)
elif level == "info":
messages.info(request, message)
elif level == "warning":
messages.warning(request, message)
else:
messages.error(request, message)
return redirect("admin:documents_foldertemplate_changelist")
def get_structure_json_view(self, request: Any, pk: int) -> JsonResponse:
"""获取文件夹模板结构JSON(供AJAX调用)"""
admin_service = _get_admin_service()
try:
result: dict[str, Any] = admin_service.get_structure_json(pk)
return JsonResponse(result)
except NotFoundError:
return JsonResponse({"success": False, "error": "模板不存在"}, status=404)
def save_model(self, request: Any, obj: FolderTemplate, form: Any, change: bool) -> None:
"""保存模型 - 处理自动修复的结构并显示消息"""
if hasattr(form, "cleaned_data") and "structure" in form.cleaned_data:
obj.structure = form.cleaned_data["structure"]
if hasattr(form, "_fix_messages"):
from django.contrib import messages
for message in form._fix_messages:
messages.success(request, "✅ " + str(message))
super().save_model(request, obj, form, change)
@admin.display(description=_("文件夹数量"))
def folder_count_display(self, obj: FolderTemplate) -> int:
"""显示文件夹数量"""
return self._count_folders(obj.structure)
def _count_folders(self, structure: Any) -> int:
"""递归计算文件夹数量"""
if not structure:
return 0
count = 0
children = structure.get("children", [])
for child in children:
count += 1
count += self._count_folders(child)
return count
@admin.display(description=_("结构预览"))
def structure_preview(self, obj: FolderTemplate) -> Any:
"""文件夹结构预览"""
if not obj.structure:
return _("暂无结构")
admin_service = _get_admin_service()
return admin_service.render_structure_preview(obj.structure)
def _render_structure_tree(self, structure: Any, level: int = 0) -> Any:
"""递归渲染文件夹树"""
admin_service = _get_admin_service()
return admin_service.render_structure_tree(structure, level)
@admin.action(description=_("启用选中的模板"))
def activate_templates(self, request: Any, queryset: Any) -> None:
"""批量启用模板"""
admin_service = _get_admin_service()
updated: int = admin_service.batch_activate(queryset)
self.message_user(request, _("已启用 %(count)d 个模板") % {"count": updated})
@admin.action(description=_("禁用选中的模板"))
def deactivate_templates(self, request: Any, queryset: Any) -> None:
"""批量禁用模板"""
admin_service = _get_admin_service()
updated: int = admin_service.batch_deactivate(queryset)
self.message_user(request, _("已禁用 %(count)d 个模板") % {"count": updated})
@admin.action(description=_("复制选中的模板"))
def duplicate_templates(self, request: Any, queryset: Any) -> None:
"""批量复制文件夹模板"""
admin_service = _get_admin_service()
count = admin_service.batch_duplicate_templates(queryset)
self.message_user(request, _("已复制 %(count)d 个模板") % {"count": count})
|