- 登录时从路由参数 yUserId/access_token 获取并存入 userInfo - 轻应用管理页路由参数新增 userName/gateDepartName/typeName 选项 - 添加系统默认界面模式设置(管理员可指定全量/简洁) - useLayoutMode hook 支持优先级:用户自选 > 管理员默认 > 会话级 Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
216 lines
9.3 KiB
Python
216 lines
9.3 KiB
Python
"""System-wide runtime settings editable from the admin UI.
|
|
|
|
Backed by a single JSON file under the DeerFlow runtime home (default
|
|
``.deer-flow/system_settings.json``). Unlike :mod:`extensions_config` this
|
|
file is **not** part of the project source tree — it is per-deployment
|
|
state, and it stays writable at runtime.
|
|
|
|
The only feature stored here at the moment is the **prompt prefix toggle**
|
|
shown in the chat input: an administrator can configure a label and a
|
|
prefix string, and any user can flip the toggle on/off; when enabled, the
|
|
prefix is prepended to the first human message of a new thread.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import logging
|
|
import threading
|
|
from pathlib import Path
|
|
from typing import Literal
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
from deerflow.config.runtime_paths import runtime_home
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
_SETTINGS_FILE = "system_settings.json"
|
|
_lock = threading.Lock()
|
|
|
|
|
|
class PromptPrefixSettings(BaseModel):
|
|
"""Admin-configurable first-message prompt prefix."""
|
|
|
|
enabled: bool = Field(default=False, description="Whether the prefix toggle is offered to users at all")
|
|
switch_label: str = Field(default="加入立场前缀", description="Toggle label shown in the chat input")
|
|
prompt_prefix: str = Field(default="", description="Text prepended to the first user message when enabled")
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
class AppearanceSettings(BaseModel):
|
|
"""System-wide appearance defaults that any *new* user inherits.
|
|
|
|
Once a user explicitly toggles their theme in the UI, that choice is
|
|
persisted in the browser and supersedes this default — so changing
|
|
``default_theme`` here only affects users who have never touched the
|
|
toggle, and any future first-time loads.
|
|
"""
|
|
|
|
default_theme: Literal["light", "dark", "lightblue"] = Field(
|
|
default="light",
|
|
description="Theme applied for users who haven't picked their own (light / dark / lightblue)",
|
|
)
|
|
default_skill_view: Literal["card", "list"] = Field(
|
|
default="list",
|
|
description="Default skill list display mode for users who haven't picked their own (card / list)",
|
|
)
|
|
default_agent_view: Literal["card", "list"] = Field(
|
|
default="card",
|
|
description="Default agent list display mode for users who haven't picked their own (card / list)",
|
|
)
|
|
default_layout_mode: Literal["full", "compact"] = Field(
|
|
default="full",
|
|
description="Default interface layout for users who haven't picked their own — full (sidebar + header) / compact (hidden)",
|
|
)
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
class CitationDisplaySettings(BaseModel):
|
|
"""System-wide cleanup rules for citation cards and detail dialogs."""
|
|
|
|
cleanup_words: list[str] = Field(
|
|
default_factory=list,
|
|
description="Words or phrases used to remove noisy advertisement/disclaimer lines from citation display.",
|
|
)
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
class PrivateSquareSettings(BaseModel):
|
|
"""Admin-configurable settings for the agent private-square (私密广场).
|
|
|
|
The password gates read access to all agents flagged ``is_private=True``.
|
|
The hash is stored opaquely — the router layer is responsible for hashing
|
|
and verifying so the harness package keeps zero dependencies on
|
|
``app.gateway.auth``.
|
|
"""
|
|
|
|
enabled: bool = Field(default=False, description="Whether the private square is offered to users at all")
|
|
password_hash: str = Field(default="", description="Opaque hash of the admin-configured password. Empty = no password set yet.")
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
#: Id of the always-present built-in default square (used when the admin has
|
|
#: configured no squares, or when a published item picks none).
|
|
DEFAULT_SQUARE_ID = "default"
|
|
|
|
|
|
class PublishSquare(BaseModel):
|
|
"""One admin-configured publish square (发布广场).
|
|
|
|
A pure organizational category that published agents/skills can be filed
|
|
under — unlike the password-gated :class:`PrivateSquareSettings`, a square
|
|
has **no access control**: every logged-in user can browse every square.
|
|
Each agent/skill belongs to at most one square (a single ``square_id``
|
|
field on the row), so an item can never be "published twice".
|
|
"""
|
|
|
|
id: str = Field(..., description="Stable square id (slug/uuid); used as agents.square_id / skills.square_id")
|
|
name: str = Field(..., description="Display name shown as the square's tab label")
|
|
description: str = Field(default="", description="Optional description shown in the admin config / tab hint")
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
class PublishSquaresSettings(BaseModel):
|
|
"""Admin-configurable list of publish squares.
|
|
|
|
``squares`` is display-ordered. ``default_square_id`` selects the square a
|
|
publisher lands in when they do not pick one explicitly. There is always at
|
|
least one effective square — :func:`list_publish_squares` injects a built-in
|
|
"默认广场" when the admin has configured none, so the publish flow always has
|
|
a valid target.
|
|
"""
|
|
|
|
squares: list[PublishSquare] = Field(default_factory=list, description="Ordered list of configured squares")
|
|
default_square_id: str = Field(default=DEFAULT_SQUARE_ID, description="Square id used when a publisher picks none")
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
def list_publish_squares(settings: PublishSquaresSettings) -> list[PublishSquare]:
|
|
"""Return the effective square list, always non-empty.
|
|
|
|
Falls back to a single built-in default square when the admin has not
|
|
configured any, so callers never have to special-case the empty state.
|
|
"""
|
|
if settings.squares:
|
|
return list(settings.squares)
|
|
return [PublishSquare(id=DEFAULT_SQUARE_ID, name="默认广场", description="")]
|
|
|
|
|
|
def resolve_default_square_id(settings: PublishSquaresSettings) -> str:
|
|
"""Resolve the effective default square id against the configured set."""
|
|
ids = [s.id for s in settings.squares]
|
|
if settings.default_square_id and settings.default_square_id in ids:
|
|
return settings.default_square_id
|
|
return ids[0] if ids else DEFAULT_SQUARE_ID
|
|
|
|
|
|
def normalize_square_id(square_id: str | None, settings: PublishSquaresSettings) -> str:
|
|
"""Coerce an arbitrary ``square_id`` to a valid configured square id.
|
|
|
|
Empty / unknown / orphaned (square later deleted) ids all collapse to the
|
|
effective default square, so a published item always resolves to a real
|
|
tab.
|
|
"""
|
|
default_id = resolve_default_square_id(settings)
|
|
if not square_id:
|
|
return default_id
|
|
valid = {s.id for s in list_publish_squares(settings)}
|
|
return square_id if square_id in valid else default_id
|
|
|
|
|
|
class LeaderboardSettings(BaseModel):
|
|
"""Admin-configurable defaults for the user leaderboard analytics."""
|
|
|
|
exclude_user_ids: list[str] = Field(default_factory=list, description="User ids excluded from leaderboard aggregation.")
|
|
include_scheduled: bool = Field(default=True, description="Whether scheduled task runs participate in leaderboard statistics.")
|
|
include_admins: bool = Field(default=True, description="Whether admin accounts participate in leaderboard statistics.")
|
|
include_failed: bool = Field(default=True, description="Whether failed runs and provider calls participate in leaderboard statistics.")
|
|
cleanup_system_questions: bool = Field(default=True, description="Hide attachment/system marker questions such as <uploaded_files>.")
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
class SystemSettings(BaseModel):
|
|
"""Top-level system settings document."""
|
|
|
|
prompt_prefix: PromptPrefixSettings = Field(default_factory=PromptPrefixSettings)
|
|
private_square: PrivateSquareSettings = Field(default_factory=PrivateSquareSettings)
|
|
publish_squares: PublishSquaresSettings = Field(default_factory=PublishSquaresSettings)
|
|
appearance: AppearanceSettings = Field(default_factory=AppearanceSettings)
|
|
citation_display: CitationDisplaySettings = Field(default_factory=CitationDisplaySettings)
|
|
leaderboard: LeaderboardSettings = Field(default_factory=LeaderboardSettings)
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
def _settings_path() -> Path:
|
|
home = runtime_home()
|
|
home.mkdir(parents=True, exist_ok=True)
|
|
return home / _SETTINGS_FILE
|
|
|
|
|
|
def load_system_settings() -> SystemSettings:
|
|
"""Read the on-disk system settings, returning defaults when missing."""
|
|
path = _settings_path()
|
|
if not path.is_file():
|
|
return SystemSettings()
|
|
try:
|
|
raw = json.loads(path.read_text(encoding="utf-8"))
|
|
if not isinstance(raw, dict):
|
|
logger.warning("System settings file %s is not a JSON object; ignoring", path)
|
|
return SystemSettings()
|
|
return SystemSettings.model_validate(raw)
|
|
except Exception as exc:
|
|
logger.warning("Failed to read system settings from %s: %s", path, exc)
|
|
return SystemSettings()
|
|
|
|
|
|
def save_system_settings(settings: SystemSettings) -> SystemSettings:
|
|
"""Persist the settings document atomically, returning the saved value."""
|
|
path = _settings_path()
|
|
payload = settings.model_dump(mode="json")
|
|
with _lock:
|
|
tmp = path.with_suffix(path.suffix + ".tmp")
|
|
tmp.write_text(json.dumps(payload, ensure_ascii=False, indent=2), encoding="utf-8")
|
|
tmp.replace(path)
|
|
return settings
|