Files
DDSRem 2de976f6b3 Merge pull request #7050 from DDSRem-Dev/codex-comment-migration
docs: 统一全项目中文注释和结构化契约说明
2026-10-17 19:26:29 +08:00

270 lines
9.2 KiB
Python

"""
中心服务订阅和工作流分享用例。
"""
from __future__ import annotations
import json
from collections.abc import Awaitable, Callable
from dataclasses import asdict, dataclass
from typing import Any, Optional
from app.application.server.payload import build_subscribe_payload
from app.application.workflow import WorkflowSnapshot
@dataclass(frozen=True, slots=True)
class _ShareMetadata:
"""
冻结订阅与工作流分享共用的用户填写元数据。
:param title: 用户填写的分享标题
:param comment: 用户填写的分享说明
:param user: 对外展示的分享者名称
"""
title: str
comment: str
user: str
class ServerSharingService:
"""
协调本地订阅、工作流读取与中心服务分享传输。
"""
SUBSCRIBE_FIELDS = frozenset({
"share_title", "share_comment", "share_user", "share_uid", "name",
"year", "type", "keyword", "media_source", "media_id", "music_type",
"total_tracks", "season", "poster", "backdrop", "vote", "description",
"genre_ids", "include", "exclude", "quality", "resolution", "effect",
"total_episode", "custom_words", "media_category_id", "media_category",
"episode_group",
"date",
})
def __init__(
self,
*,
subscribe_provider: Callable[[int], Any],
async_subscribe_provider: Callable[[int], Awaitable[Any]],
workflow_provider: Callable[[int], Optional[WorkflowSnapshot]],
async_workflow_provider: Callable[
[int], Awaitable[Optional[WorkflowSnapshot]]
],
user_uuid_provider: Callable[[], str],
subscribe_sender: Callable[[dict[str, object]], Any],
async_subscribe_sender: Callable[[dict[str, object]], Awaitable[Any]],
workflow_sender: Callable[[dict[str, object]], Any],
async_workflow_sender: Callable[[dict[str, object]], Awaitable[Any]],
response_handler: Callable[[Any, Callable[[], None]], tuple[bool, str]],
subscribe_cache_clearer: Callable[[], None],
workflow_cache_clearer: Callable[[], None],
) -> None:
"""
保存本地数据端口、中心服务传输端口和缓存失效端口。
"""
self._subscribe_provider = subscribe_provider
self._async_subscribe_provider = async_subscribe_provider
self._workflow_provider = workflow_provider
self._async_workflow_provider = async_workflow_provider
self._user_uuid_provider = user_uuid_provider
self._subscribe_sender = subscribe_sender
self._async_subscribe_sender = async_subscribe_sender
self._workflow_sender = workflow_sender
self._async_workflow_sender = async_workflow_sender
self._response_handler = response_handler
self._subscribe_cache_clearer = subscribe_cache_clearer
self._workflow_cache_clearer = workflow_cache_clearer
def build_subscribe_payload(self, item: Optional[dict[str, object]]) -> Optional[dict[str, object]]:
"""
构造订阅分享载荷并隔离本地字段和旧专用 ID。
"""
payload: dict[str, object] | None = build_subscribe_payload(item, self.SUBSCRIBE_FIELDS)
return payload
@staticmethod
def prepare_workflow(workflow: WorkflowSnapshot) -> dict[str, object]:
"""
移除本地字段并把动作和流程编码为中心服务兼容格式。
"""
workflow_dict = asdict(workflow)
workflow_dict.pop("id", None)
workflow_dict.pop("context", None)
workflow_dict["actions"] = json.dumps(workflow_dict["actions"] or [])
workflow_dict["flows"] = json.dumps(workflow_dict["flows"] or [])
return workflow_dict
@staticmethod
def validate_workflow(
workflow: Optional[WorkflowSnapshot],
) -> tuple[bool, str]:
"""
验证工作流存在且同时包含动作与流程。
"""
if not workflow:
return False, "工作流不存在"
if not workflow.actions or not workflow.flows:
return False, "请分享有动作和流程的工作流"
return True, ""
@staticmethod
def _sharing_disabled(
enabled: bool,
kind: str,
) -> Optional[tuple[bool, str]]:
"""
统一共享开关拒绝结果,同时保持不同实体的用户提示。
"""
if enabled:
return None
return False, f"当前没有开启{kind}数据共享功能"
def _share_fields(self, metadata: _ShareMetadata) -> dict[str, str]:
"""
统一生成分享标题、备注、用户和当前宿主身份字段。
"""
return {
"share_title": metadata.title,
"share_comment": metadata.comment,
"share_user": metadata.user,
"share_uid": self._user_uuid_provider(),
}
def _subscribe_share_payload(
self,
subscribe: Any,
metadata: _ShareMetadata,
) -> tuple[Optional[dict[str, object]], str]:
"""
统一订阅存在性、宿主字段投影和媒体身份完整性校验。
"""
if not subscribe:
return None, "订阅不存在"
payload = self.build_subscribe_payload({
**self._share_fields(metadata),
**subscribe.to_dict(),
})
return (payload, "") if payload else (None, "订阅媒体身份不完整")
def _workflow_share_payload(
self,
workflow: Optional[WorkflowSnapshot],
metadata: _ShareMetadata,
) -> tuple[Optional[dict[str, object]], str]:
"""
统一工作流完整性校验和中心服务载荷投影。
"""
valid, message = self.validate_workflow(workflow)
if not valid or workflow is None:
return None, message
return {
**self._share_fields(metadata),
**self.prepare_workflow(workflow),
}, ""
def share_subscribe(
self,
*,
enabled: bool,
subscribe_id: int,
share_title: str,
share_comment: str,
share_user: str,
) -> tuple[bool, str]:
"""
同步读取并分享指定订阅。
"""
disabled = self._sharing_disabled(enabled, "订阅")
if disabled is not None:
return disabled
subscribe = self._subscribe_provider(subscribe_id)
payload, message = self._subscribe_share_payload(
subscribe, _ShareMetadata(share_title, share_comment, share_user)
)
if payload is None:
return False, message
return self._response_handler(
self._subscribe_sender(payload),
self._subscribe_cache_clearer,
)
async def async_share_subscribe(
self,
*,
enabled: bool,
subscribe_id: int,
share_title: str,
share_comment: str,
share_user: str,
) -> tuple[bool, str]:
"""
异步读取并分享指定订阅。
"""
disabled = self._sharing_disabled(enabled, "订阅")
if disabled is not None:
return disabled
subscribe = await self._async_subscribe_provider(subscribe_id)
payload, message = self._subscribe_share_payload(
subscribe, _ShareMetadata(share_title, share_comment, share_user)
)
if payload is None:
return False, message
return self._response_handler(
await self._async_subscribe_sender(payload),
self._subscribe_cache_clearer,
)
def share_workflow(
self,
*,
enabled: bool,
workflow_id: int,
share_title: str,
share_comment: str,
share_user: str,
) -> tuple[bool, str]:
"""
同步读取并分享指定工作流。
"""
disabled = self._sharing_disabled(enabled, "工作流")
if disabled is not None:
return disabled
workflow = self._workflow_provider(workflow_id)
payload, message = self._workflow_share_payload(
workflow, _ShareMetadata(share_title, share_comment, share_user)
)
if payload is None:
return False, message
return self._response_handler(
self._workflow_sender(payload),
self._workflow_cache_clearer,
)
async def async_share_workflow(
self,
*,
enabled: bool,
workflow_id: int,
share_title: str,
share_comment: str,
share_user: str,
) -> tuple[bool, str]:
"""
异步读取并分享指定工作流。
"""
disabled = self._sharing_disabled(enabled, "工作流")
if disabled is not None:
return disabled
workflow = await self._async_workflow_provider(workflow_id)
payload, message = self._workflow_share_payload(
workflow, _ShareMetadata(share_title, share_comment, share_user)
)
if payload is None:
return False, message
return self._response_handler(
await self._async_workflow_sender(payload),
self._workflow_cache_clearer,
)