feat: 完善知识库预览功能与配置管理优化
This commit is contained in:
@@ -1,22 +1,32 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from functools import lru_cache
|
||||
from os import environ
|
||||
from pathlib import Path
|
||||
|
||||
from pydantic import Field
|
||||
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||
|
||||
SERVER_DIR = Path(__file__).resolve().parents[3]
|
||||
ROOT_DIR = SERVER_DIR.parent
|
||||
from __future__ import annotations
|
||||
|
||||
from os import environ
|
||||
from pathlib import Path
|
||||
|
||||
from dotenv import dotenv_values
|
||||
from pydantic import Field
|
||||
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||
|
||||
SERVER_DIR = Path(__file__).resolve().parents[3]
|
||||
ROOT_DIR = SERVER_DIR.parent
|
||||
DEFAULT_ENV_FILES = (ROOT_DIR / ".env", SERVER_DIR / ".env")
|
||||
ONLYOFFICE_FIELD_NAMES = {
|
||||
"ONLYOFFICE_ENABLED": "onlyoffice_enabled",
|
||||
"ONLYOFFICE_PUBLIC_URL": "onlyoffice_public_url",
|
||||
"ONLYOFFICE_BACKEND_URL": "onlyoffice_backend_url",
|
||||
"ONLYOFFICE_JWT_SECRET": "onlyoffice_jwt_secret",
|
||||
}
|
||||
|
||||
_settings_cache: Settings | None = None
|
||||
_settings_cache_signature: tuple[tuple[str, bool, int | None, int | None], ...] | None = None
|
||||
|
||||
|
||||
class Settings(BaseSettings):
|
||||
model_config = SettingsConfigDict(
|
||||
env_file=(ROOT_DIR / ".env", SERVER_DIR / ".env"),
|
||||
env_file_encoding="utf-8",
|
||||
extra="ignore",
|
||||
)
|
||||
class Settings(BaseSettings):
|
||||
model_config = SettingsConfigDict(
|
||||
env_file=DEFAULT_ENV_FILES,
|
||||
env_file_encoding="utf-8",
|
||||
extra="ignore",
|
||||
)
|
||||
|
||||
app_name: str = Field(default="X-Financial Server", alias="APP_NAME")
|
||||
app_env: str = Field(default="local", alias="APP_ENV")
|
||||
@@ -73,16 +83,80 @@ class Settings(BaseSettings):
|
||||
if not path.is_absolute():
|
||||
path = SERVER_DIR / path
|
||||
return path.resolve()
|
||||
|
||||
|
||||
@lru_cache
|
||||
def get_settings() -> Settings:
|
||||
return Settings()
|
||||
|
||||
|
||||
def refresh_settings(updated_values: dict[str, str]) -> Settings:
|
||||
for key, value in updated_values.items():
|
||||
environ[key] = value
|
||||
|
||||
get_settings.cache_clear()
|
||||
return get_settings()
|
||||
|
||||
def _resolve_env_files() -> tuple[Path, ...]:
|
||||
env_files = Settings.model_config.get("env_file") or ()
|
||||
return tuple(Path(item) for item in env_files)
|
||||
|
||||
|
||||
def _build_settings_signature() -> tuple[tuple[str, bool, int | None, int | None], ...]:
|
||||
signature: list[tuple[str, bool, int | None, int | None]] = []
|
||||
|
||||
for env_file in _resolve_env_files():
|
||||
if not env_file.exists():
|
||||
signature.append((str(env_file), False, None, None))
|
||||
continue
|
||||
|
||||
stat = env_file.stat()
|
||||
signature.append((str(env_file), True, stat.st_mtime_ns, stat.st_size))
|
||||
|
||||
return tuple(signature)
|
||||
|
||||
|
||||
def _parse_onlyoffice_enabled(value: object) -> bool:
|
||||
return str(value).strip().lower() in {"1", "true", "yes", "on"}
|
||||
|
||||
|
||||
def _load_onlyoffice_env_file_overrides() -> dict[str, object]:
|
||||
overrides: dict[str, object] = {}
|
||||
|
||||
for env_file in _resolve_env_files():
|
||||
if not env_file.exists():
|
||||
continue
|
||||
|
||||
values = dotenv_values(env_file)
|
||||
for alias, field_name in ONLYOFFICE_FIELD_NAMES.items():
|
||||
if alias not in values:
|
||||
continue
|
||||
|
||||
value = values[alias]
|
||||
if field_name == "onlyoffice_enabled":
|
||||
overrides[field_name] = _parse_onlyoffice_enabled(value)
|
||||
else:
|
||||
overrides[field_name] = "" if value is None else str(value)
|
||||
|
||||
return overrides
|
||||
|
||||
|
||||
def _clear_settings_cache() -> None:
|
||||
global _settings_cache, _settings_cache_signature
|
||||
|
||||
_settings_cache = None
|
||||
_settings_cache_signature = None
|
||||
|
||||
|
||||
def get_settings() -> Settings:
|
||||
global _settings_cache, _settings_cache_signature
|
||||
|
||||
signature = _build_settings_signature()
|
||||
if _settings_cache is None or _settings_cache_signature != signature:
|
||||
settings = Settings()
|
||||
onlyoffice_overrides = _load_onlyoffice_env_file_overrides()
|
||||
if onlyoffice_overrides:
|
||||
settings = settings.model_copy(update=onlyoffice_overrides)
|
||||
|
||||
_settings_cache = settings
|
||||
_settings_cache_signature = signature
|
||||
|
||||
return _settings_cache
|
||||
|
||||
|
||||
get_settings.cache_clear = _clear_settings_cache # type: ignore[attr-defined]
|
||||
|
||||
|
||||
def refresh_settings(updated_values: dict[str, str]) -> Settings:
|
||||
for key, value in updated_values.items():
|
||||
environ[key] = value
|
||||
|
||||
get_settings.cache_clear()
|
||||
return get_settings()
|
||||
|
||||
@@ -232,19 +232,43 @@ class KnowledgeService:
|
||||
|
||||
return file_path, entry["mime_type"], entry["original_name"]
|
||||
|
||||
def build_onlyoffice_config(
|
||||
self,
|
||||
document_id: str,
|
||||
current_user: CurrentUserContext,
|
||||
) -> KnowledgeOnlyOfficeConfigRead:
|
||||
self.ensure_library_ready()
|
||||
settings = get_settings()
|
||||
if not settings.onlyoffice_enabled:
|
||||
raise ValueError("ONLYOFFICE 预览未启用。")
|
||||
if not settings.onlyoffice_public_url or not settings.onlyoffice_backend_url:
|
||||
raise ValueError("ONLYOFFICE 地址配置不完整。")
|
||||
if not settings.onlyoffice_jwt_secret:
|
||||
raise ValueError("ONLYOFFICE JWT 密钥未配置。")
|
||||
def build_onlyoffice_config(
|
||||
self,
|
||||
document_id: str,
|
||||
current_user: CurrentUserContext,
|
||||
) -> KnowledgeOnlyOfficeConfigRead:
|
||||
self.ensure_library_ready()
|
||||
settings = get_settings()
|
||||
if not settings.onlyoffice_enabled:
|
||||
logger.warning(
|
||||
"ONLYOFFICE disabled in runtime config doc=%s enabled=%s public_url=%s backend_url=%s jwt_set=%s",
|
||||
document_id,
|
||||
settings.onlyoffice_enabled,
|
||||
settings.onlyoffice_public_url,
|
||||
settings.onlyoffice_backend_url,
|
||||
bool(settings.onlyoffice_jwt_secret),
|
||||
)
|
||||
raise ValueError("ONLYOFFICE 预览未启用。")
|
||||
if not settings.onlyoffice_public_url or not settings.onlyoffice_backend_url:
|
||||
logger.warning(
|
||||
"ONLYOFFICE config incomplete doc=%s enabled=%s public_url=%s backend_url=%s jwt_set=%s",
|
||||
document_id,
|
||||
settings.onlyoffice_enabled,
|
||||
settings.onlyoffice_public_url,
|
||||
settings.onlyoffice_backend_url,
|
||||
bool(settings.onlyoffice_jwt_secret),
|
||||
)
|
||||
raise ValueError("ONLYOFFICE 地址配置不完整。")
|
||||
if not settings.onlyoffice_jwt_secret:
|
||||
logger.warning(
|
||||
"ONLYOFFICE JWT missing doc=%s enabled=%s public_url=%s backend_url=%s jwt_set=%s",
|
||||
document_id,
|
||||
settings.onlyoffice_enabled,
|
||||
settings.onlyoffice_public_url,
|
||||
settings.onlyoffice_backend_url,
|
||||
bool(settings.onlyoffice_jwt_secret),
|
||||
)
|
||||
raise ValueError("ONLYOFFICE JWT 密钥未配置。")
|
||||
|
||||
index = self._load_index()
|
||||
entry = self._require_entry(index, document_id)
|
||||
@@ -263,42 +287,41 @@ class KnowledgeService:
|
||||
callback_url = (
|
||||
f"{backend_base_url}{settings.api_v1_prefix}/knowledge/documents/{document_id}/onlyoffice/callback"
|
||||
)
|
||||
can_edit = current_user.is_admin or "manager" in current_user.role_codes
|
||||
document_key = self._build_onlyoffice_document_key(entry)
|
||||
|
||||
config: dict[str, Any] = {
|
||||
"documentType": document_type,
|
||||
"document": {
|
||||
document_key = self._build_onlyoffice_document_key(entry)
|
||||
|
||||
config: dict[str, Any] = {
|
||||
"documentType": document_type,
|
||||
"document": {
|
||||
"fileType": extension,
|
||||
"key": document_key,
|
||||
"title": entry["original_name"],
|
||||
"url": document_url,
|
||||
"permissions": {
|
||||
"download": True,
|
||||
"edit": can_edit,
|
||||
"print": True,
|
||||
"copy": True,
|
||||
"title": entry["original_name"],
|
||||
"url": document_url,
|
||||
"permissions": {
|
||||
"download": True,
|
||||
"edit": False,
|
||||
"print": True,
|
||||
"copy": True,
|
||||
},
|
||||
},
|
||||
"editorConfig": {
|
||||
"mode": "view",
|
||||
"lang": "zh-CN",
|
||||
"callbackUrl": callback_url,
|
||||
"user": {
|
||||
"id": current_user.username,
|
||||
"name": current_user.name,
|
||||
},
|
||||
},
|
||||
"editorConfig": {
|
||||
"mode": "edit" if can_edit else "view",
|
||||
"lang": "zh-CN",
|
||||
"callbackUrl": callback_url,
|
||||
"user": {
|
||||
"id": current_user.username,
|
||||
"name": current_user.name,
|
||||
},
|
||||
"customization": {
|
||||
"compactHeader": True,
|
||||
"compactToolbar": True,
|
||||
"toolbarNoTabs": False,
|
||||
"autosave": can_edit,
|
||||
"forcesave": can_edit,
|
||||
},
|
||||
},
|
||||
"width": "100%",
|
||||
"height": "100%",
|
||||
}
|
||||
"customization": {
|
||||
"compactHeader": True,
|
||||
"compactToolbar": True,
|
||||
"toolbarNoTabs": False,
|
||||
"autosave": False,
|
||||
"forcesave": False,
|
||||
},
|
||||
},
|
||||
"width": "100%",
|
||||
"height": "100%",
|
||||
}
|
||||
config["token"] = jwt.encode(config, settings.onlyoffice_jwt_secret, algorithm="HS256")
|
||||
|
||||
return KnowledgeOnlyOfficeConfigRead(
|
||||
|
||||
@@ -9,6 +9,7 @@ Requires-Dist: uvicorn[standard]<1.0.0,>=0.30.0
|
||||
Requires-Dist: sqlalchemy<3.0.0,>=2.0.36
|
||||
Requires-Dist: alembic<2.0.0,>=1.14.0
|
||||
Requires-Dist: psycopg[binary]<4.0.0,>=3.2.0
|
||||
Requires-Dist: PyJWT<3.0.0,>=2.9.0
|
||||
Requires-Dist: pydantic-settings<3.0.0,>=2.6.0
|
||||
Requires-Dist: python-dotenv<2.0.0,>=1.0.1
|
||||
Requires-Dist: email-validator<3.0.0,>=2.2.0
|
||||
|
||||
@@ -12,6 +12,7 @@ src/app/api/v1/endpoints/auth.py
|
||||
src/app/api/v1/endpoints/bootstrap.py
|
||||
src/app/api/v1/endpoints/employees.py
|
||||
src/app/api/v1/endpoints/health.py
|
||||
src/app/api/v1/endpoints/knowledge.py
|
||||
src/app/api/v1/endpoints/reimbursements.py
|
||||
src/app/api/v1/endpoints/settings.py
|
||||
src/app/core/__init__.py
|
||||
@@ -45,12 +46,14 @@ src/app/schemas/__init__.py
|
||||
src/app/schemas/auth.py
|
||||
src/app/schemas/bootstrap.py
|
||||
src/app/schemas/employee.py
|
||||
src/app/schemas/knowledge.py
|
||||
src/app/schemas/reimbursement.py
|
||||
src/app/schemas/settings.py
|
||||
src/app/services/__init__.py
|
||||
src/app/services/auth.py
|
||||
src/app/services/employee.py
|
||||
src/app/services/employee_seed.py
|
||||
src/app/services/knowledge.py
|
||||
src/app/services/model_connectivity.py
|
||||
src/app/services/reimbursement.py
|
||||
src/app/services/settings.py
|
||||
@@ -62,5 +65,6 @@ src/x_financial_server.egg-info/top_level.txt
|
||||
tests/test_auth_service.py
|
||||
tests/test_employee_service.py
|
||||
tests/test_imports.py
|
||||
tests/test_server_start_dependencies.py
|
||||
tests/test_settings_persistence.py
|
||||
tests/test_settings_service.py
|
||||
@@ -3,6 +3,7 @@ uvicorn[standard]<1.0.0,>=0.30.0
|
||||
sqlalchemy<3.0.0,>=2.0.36
|
||||
alembic<2.0.0,>=1.14.0
|
||||
psycopg[binary]<4.0.0,>=3.2.0
|
||||
PyJWT<3.0.0,>=2.9.0
|
||||
pydantic-settings<3.0.0,>=2.6.0
|
||||
python-dotenv<2.0.0,>=1.0.1
|
||||
email-validator<3.0.0,>=2.2.0
|
||||
|
||||
Reference in New Issue
Block a user