fc / apps /automation /admin /document_delivery /document_delivery_schedule_admin.py
jun2024's picture
Upload 2241 files
b4f2238 verified
Raw History Blame Contribute Delete
13.8 kB
"""
文书送达定时任务 Django Admin 界面
提供定时任务管理、手动触发查询等功能。
"""
from __future__ import annotations
import logging
import threading
from typing import Any
from django.contrib import admin, messages
from django.db.models import QuerySet
from django.forms import ModelForm
from django.http import HttpRequest, HttpResponse, HttpResponseRedirect
from django.shortcuts import get_object_or_404
from django.urls import path, reverse
from django.utils import timezone
from django.utils.html import format_html
from django.utils.safestring import SafeString
from django.utils.translation import gettext_lazy as _
from apps.automation.models import DocumentDeliverySchedule
logger = logging.getLogger("apps.automation")
def _get_document_delivery_schedule_service() -> Any:
"""获取文书送达定时任务服务实例(工厂函数)"""
from apps.automation.services.document_delivery.document_delivery_schedule_service import (
DocumentDeliveryScheduleService,
)
return DocumentDeliveryScheduleService()
@admin.register(DocumentDeliverySchedule)
class DocumentDeliveryScheduleAdmin(admin.ModelAdmin[DocumentDeliverySchedule]):
"""文书送达定时任务管理"""
def get_model_perms(self, request: HttpRequest) -> dict[str, bool]:
"""隐藏后台入口(保留代码与直达地址能力)"""
return {}
list_display = [
"id",
"credential_display",
"runs_per_day",
"hour_interval",
"cutoff_hours",
"status_display",
"last_run_display",
"next_run_display",
"created_at",
]
list_filter = [
"is_active",
"runs_per_day",
"hour_interval",
"created_at",
("credential", admin.RelatedFieldListFilter),
]
search_fields = [
"credential__account",
"credential__site_name",
]
ordering = ["-created_at"]
list_per_page = 20
readonly_fields = [
"id",
"last_run_at",
"next_run_at",
"created_at",
"updated_at",
"manual_trigger_button",
]
fieldsets = (
(
_("基本信息"),
{"fields": ("id", "credential", "is_active")},
),
(
_("调度配置"),
{
"fields": ("runs_per_day", "hour_interval", "cutoff_hours"),
"description": "配置定时任务的运行频率和时间范围",
},
),
(
_("运行状态"),
{"fields": ("last_run_at", "next_run_at", "manual_trigger_button")},
),
(
_("时间戳"),
{"fields": ("created_at", "updated_at"), "classes": ("collapse",)},
),
)
actions = [
"trigger_manual_query_action",
"activate_schedules_action",
"deactivate_schedules_action",
]
def get_urls(self) -> list[Any]:
"""添加自定义URL"""
urls = super().get_urls()
custom_urls: list[Any] = [
path(
"<int:schedule_id>/trigger/",
self.admin_site.admin_view(self.trigger_manual_query_view),
name="automation_documentdeliveryschedule_trigger",
),
]
return custom_urls + urls
@admin.display(description=_("账号凭证"))
def credential_display(self, obj: DocumentDeliverySchedule) -> SafeString | str:
"""账号凭证显示"""
if obj.credential:
url = reverse("admin:organization_accountcredential_change", args=[obj.credential.id])
return format_html(
'<a href="{}" target="_blank">{} ({})</a>', url, obj.credential.account, obj.credential.site_name
)
return "-"
@admin.display(description=_("状态"))
def status_display(self, obj: DocumentDeliverySchedule) -> SafeString:
"""状态显示(带颜色)"""
if obj.is_active:
return format_html('<span style="color: green; font-weight: bold;">{}</span>', "✓ 启用")
else:
return format_html('<span style="color: red; font-weight: bold;">{}</span>', "✗ 禁用")
@admin.display(description=_("上次运行"))
def last_run_display(self, obj: DocumentDeliverySchedule) -> SafeString:
"""上次运行时间显示"""
if obj.last_run_at:
now = timezone.now()
time_diff = now - obj.last_run_at
if time_diff.days > 0:
time_str = f"{time_diff.days} 天前"
color = "orange" if time_diff.days > 1 else "blue"
elif time_diff.seconds > 3600:
hours = time_diff.seconds // 3600
time_str = f"{hours} 小时前"
color = "blue"
elif time_diff.seconds > 60:
minutes = time_diff.seconds // 60
time_str = f"{minutes} 分钟前"
color = "green"
else:
time_str = "刚刚"
color = "green"
return format_html(
'<span style="color: {};">{}</span><br><small style="color: #666;">{}</small>',
color,
time_str,
obj.last_run_at.strftime("%m-%d %H:%M"),
)
return format_html('<span style="color: gray;">{}</span>', "从未运行")
@admin.display(description=_("下次运行"))
def next_run_display(self, obj: DocumentDeliverySchedule) -> SafeString:
"""下次运行时间显示"""
if not obj.is_active:
return format_html('<span style="color: gray;">{}</span>', "已禁用")
if obj.next_run_at:
now = timezone.now()
if obj.next_run_at <= now:
return format_html(
'<span style="color: red; font-weight: bold;">⏰ 待执行</span><br>'
'<small style="color: #666;">{}</small>',
obj.next_run_at.strftime("%m-%d %H:%M"),
)
time_diff = obj.next_run_at - now
if time_diff.days > 0:
time_str = f"{time_diff.days} 天后"
color = "blue"
elif time_diff.seconds > 3600:
hours = time_diff.seconds // 3600
time_str = f"{hours} 小时后"
color = "blue"
elif time_diff.seconds > 60:
minutes = time_diff.seconds // 60
time_str = f"{minutes} 分钟后"
color = "orange"
else:
time_str = "即将执行"
color = "red"
return format_html(
'<span style="color: {};">{}</span><br><small style="color: #666;">{}</small>',
color,
time_str,
obj.next_run_at.strftime("%m-%d %H:%M"),
)
return format_html('<span style="color: gray;">{}</span>', "未设置")
@admin.display(description=_("操作"))
def manual_trigger_button(self, obj: DocumentDeliverySchedule) -> SafeString | str:
"""手动触发按钮"""
if obj.id and obj.credential:
trigger_url = reverse("admin:automation_documentdeliveryschedule_trigger", args=[obj.id])
return format_html(
'<a href="{}" class="button" onclick="return confirm('
"'确认要手动触发文书查询吗?这将立即执行一次查询任务。');"
'">'
"🚀 手动触发查询</a>",
trigger_url,
)
return "-"
@admin.action(description=_("🚀 手动触发选中的查询任务"))
def trigger_manual_query_action(self, request: HttpRequest, queryset: QuerySet[DocumentDeliverySchedule]) -> None:
"""手动触发查询操作(异步执行,不阻塞 Admin)"""
service = _get_document_delivery_schedule_service()
triggered_count = 0
error_count = 0
for schedule in queryset:
if not schedule.credential:
error_count += 1
continue
def run_task(schedule_id: int) -> None:
try:
service.execute_scheduled_task(schedule_id)
logger.info(f"后台文书查询任务完成: Schedule ID={schedule_id}")
except Exception as e:
logger.error(f"后台文书查询任务失败: Schedule ID={schedule_id}, 错误: {e!s}")
t = threading.Thread(target=run_task, args=(schedule.id,), daemon=True)
t.start()
triggered_count += 1
logger.info(f"管理员触发后台文书查询: Schedule ID={schedule.id}, User={request.user}")
if triggered_count > 0:
messages.success(request, f"已在后台启动 {triggered_count} 个查询任务(不阻塞页面)")
if error_count > 0:
messages.error(request, f"触发失败 {error_count} 个任务(无账号凭证)")
@admin.action(description=_("✓ 启用选中的定时任务"))
def activate_schedules_action(self, request: HttpRequest, queryset: QuerySet[DocumentDeliverySchedule]) -> None:
"""启用定时任务操作"""
updated = queryset.update(is_active=True)
messages.success(request, _(f"成功启用 {updated} 个定时任务"))
logger.info(f"管理员批量启用定时任务: Count={updated}, User={request.user}")
@admin.action(description=_("✗ 禁用选中的定时任务"))
def deactivate_schedules_action(self, request: HttpRequest, queryset: QuerySet[DocumentDeliverySchedule]) -> None:
"""禁用定时任务操作"""
updated = queryset.update(is_active=False)
messages.success(request, _(f"成功禁用 {updated} 个定时任务"))
logger.info(f"管理员批量禁用定时任务: Count={updated}, User={request.user}")
def trigger_manual_query_view(self, request: HttpRequest, schedule_id: int) -> HttpResponse:
"""手动触发查询视图(异步执行,不阻塞 Admin)"""
schedule = get_object_or_404(DocumentDeliverySchedule, id=schedule_id)
if not schedule.credential:
messages.error(request, "该定时任务没有关联的账号凭证")
else:
def run_task() -> None:
try:
service = _get_document_delivery_schedule_service()
result = service.execute_scheduled_task(schedule_id)
logger.info(f"后台文书查询任务完成: Schedule ID={schedule_id}, Result={result}")
except Exception as e:
logger.error(f"后台文书查询任务失败: Schedule ID={schedule_id}, 错误: {e!s}")
t = threading.Thread(target=run_task, daemon=True)
t.start()
messages.success(request, "查询任务已在后台启动,请查看日志了解执行结果(不阻塞页面)")
logger.info(f"管理员触发后台文书查询: Schedule ID={schedule_id}, User={request.user}")
return HttpResponseRedirect(reverse("admin:automation_documentdeliveryschedule_change", args=[schedule_id]))
def get_queryset(self, request: HttpRequest) -> QuerySet[DocumentDeliverySchedule]:
"""优化查询性能"""
return super().get_queryset(request).select_related("credential")
def formfield_for_foreignkey(self, db_field: Any, request: HttpRequest, **kwargs: Any) -> Any:
"""自定义外键字段"""
if db_field.name == "credential":
kwargs["queryset"] = db_field.related_model.objects.all().order_by("site_name", "account")
return super().formfield_for_foreignkey(db_field, request, **kwargs)
def get_form(
self,
request: HttpRequest,
obj: DocumentDeliverySchedule | None = None,
change: bool = False,
**kwargs: Any,
) -> type[ModelForm[Any]]:
"""自定义表单"""
form = super().get_form(request, obj, change, **kwargs)
if "runs_per_day" in form.base_fields:
form.base_fields["runs_per_day"].help_text = "每天运行的次数,建议1-4次"
if "hour_interval" in form.base_fields:
form.base_fields["hour_interval"].help_text = "运行间隔小时数,应该是24除以runs_per_day的结果"
if "cutoff_hours" in form.base_fields:
form.base_fields["cutoff_hours"].help_text = "只处理最近N小时内的文书,建议24-72小时"
return form
def save_model(self, request: HttpRequest, obj: DocumentDeliverySchedule, form: Any, change: bool) -> None:
"""保存模型时的处理"""
super().save_model(request, obj, form, change)
try:
service = _get_document_delivery_schedule_service()
service.update_schedule(
obj.id,
runs_per_day=obj.runs_per_day,
hour_interval=obj.hour_interval,
cutoff_hours=obj.cutoff_hours,
is_active=obj.is_active,
)
if not change:
messages.success(request, "定时任务创建成功!下次运行时间已自动计算")
logger.info(
"管理员%s文书送达定时任务: Schedule ID=%s, User=%s",
"创建" if not change else "更新",
obj.id,
request.user,
)
except Exception as e:
messages.warning(request, f"定时任务已{'创建' if not change else '更新'},但下次运行时间计算失败: {e!s}")
logger.error(f"管理员操作定时任务后计算下次运行时间失败: Schedule ID={obj.id}, 错误: {e!s}")