42af7a6551
- Gitea: NotificationTracker now exposes sender allowlist / blocklist filters via MultiEntitySelect, populated from Gitea /users/search merged with past EventLog senders so the picker is useful before the first webhook arrives. - Webhook providers (gitea, planka, webhook): stop scheduling interval polling jobs on tracker create/update/startup; hide the "every Xs" indicator in the tracker list since there is no polling. - Dashboard: stat cards are now <a> links that route to providers, trackers, targets, command-trackers, or scroll to the events panel. Provider deck rows highlight the target provider on click. - Command trackers / command configs: auto-reselect the right config when the provider type changes (matches notification-tracker behavior). - Migration: drop legacy batch_duration column from notification_tracker — the field is gone from the model but its NOT NULL constraint blocked inserts on older DBs. - Docs: refresh entity-relationships.md with current NotificationTracker fields (filters, adaptive_max_skip, default_*_config_id).
560 lines
18 KiB
Python
560 lines
18 KiB
Python
"""Service provider management API routes."""
|
|
|
|
import logging
|
|
|
|
from fastapi import APIRouter, Depends, HTTPException, status
|
|
from pydantic import BaseModel, ValidationError
|
|
from sqlmodel import select
|
|
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
from typing import Any
|
|
|
|
import aiohttp
|
|
|
|
from ..auth.dependencies import get_current_user
|
|
from ..database.engine import get_session
|
|
from ..database.models import EventLog, ServiceProvider, User
|
|
from ..services import (
|
|
make_immich_provider, make_gitea_provider, make_planka_provider,
|
|
make_nut_provider, make_google_photos_provider, list_provider_collections,
|
|
)
|
|
from ..services.http_session import get_http_session
|
|
from .helpers import get_owned_entity
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
router = APIRouter(prefix="/api/providers", tags=["providers"])
|
|
|
|
|
|
class ProviderCreate(BaseModel):
|
|
type: str
|
|
name: str
|
|
icon: str = ""
|
|
config: dict[str, Any] = {}
|
|
|
|
|
|
class ProviderUpdate(BaseModel):
|
|
name: str | None = None
|
|
icon: str | None = None
|
|
config: dict[str, Any] | None = None
|
|
|
|
|
|
class ProviderResponse(BaseModel):
|
|
id: int
|
|
type: str
|
|
name: str
|
|
icon: str
|
|
config: dict[str, Any]
|
|
created_at: str
|
|
|
|
|
|
# -- Per-provider config validation models --
|
|
|
|
|
|
class ImmichProviderConfig(BaseModel):
|
|
url: str
|
|
api_key: str
|
|
external_domain: str | None = None
|
|
|
|
|
|
class GiteaProviderConfig(BaseModel):
|
|
url: str
|
|
webhook_secret: str
|
|
api_token: str | None = None
|
|
|
|
|
|
class PlankaProviderConfig(BaseModel):
|
|
url: str
|
|
webhook_secret: str
|
|
api_key: str | None = None
|
|
|
|
|
|
class SchedulerProviderConfig(BaseModel):
|
|
"""Scheduler is a virtual provider — no required fields."""
|
|
|
|
pass
|
|
|
|
|
|
class NutProviderConfig(BaseModel):
|
|
host: str
|
|
port: int = 3493
|
|
username: str | None = None
|
|
password: str | None = None
|
|
|
|
|
|
class GooglePhotosProviderConfig(BaseModel):
|
|
client_id: str
|
|
client_secret: str
|
|
refresh_token: str
|
|
|
|
|
|
class PayloadMapping(BaseModel):
|
|
variable: str
|
|
jsonpath: str
|
|
default: str | None = None
|
|
|
|
|
|
class WebhookProviderConfig(BaseModel):
|
|
auth_mode: str = "none"
|
|
webhook_secret: str | None = None
|
|
payload_mappings: list[PayloadMapping] = []
|
|
event_type_path: str | None = None
|
|
collection_path: str | None = None
|
|
store_payloads: bool = True
|
|
max_stored_payloads: int = 20 # 1-100
|
|
|
|
|
|
_PROVIDER_CONFIG_MODELS: dict[str, type[BaseModel]] = {
|
|
"immich": ImmichProviderConfig,
|
|
"gitea": GiteaProviderConfig,
|
|
"planka": PlankaProviderConfig,
|
|
"scheduler": SchedulerProviderConfig,
|
|
"nut": NutProviderConfig,
|
|
"google_photos": GooglePhotosProviderConfig,
|
|
"webhook": WebhookProviderConfig,
|
|
}
|
|
|
|
|
|
def _validate_provider_config(provider_type: str, config: dict[str, Any]) -> None:
|
|
"""Validate provider config against the schema for the given type."""
|
|
config_model = _PROVIDER_CONFIG_MODELS.get(provider_type)
|
|
if config_model is None:
|
|
return
|
|
try:
|
|
config_model.model_validate(config)
|
|
except ValidationError as exc:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_400_BAD_REQUEST,
|
|
detail=f"Invalid config for '{provider_type}' provider: {exc}",
|
|
)
|
|
|
|
|
|
async def _test_provider_connection(provider: ServiceProvider) -> dict[str, Any]:
|
|
"""Test provider connection and return the result dict.
|
|
|
|
For providers that lack optional credentials (gitea without api_token,
|
|
planka without api_key), returns a success stub.
|
|
"""
|
|
http_session = await get_http_session()
|
|
|
|
if provider.type == "immich":
|
|
immich = make_immich_provider(http_session, provider)
|
|
return await immich.test_connection()
|
|
|
|
if provider.type == "gitea":
|
|
if not provider.config.get("api_token"):
|
|
return {"ok": True, "message": "Gitea webhook-only mode (no API token for testing)"}
|
|
gitea = make_gitea_provider(http_session, provider)
|
|
return await gitea.test_connection()
|
|
|
|
if provider.type == "planka":
|
|
if not provider.config.get("api_key"):
|
|
return {"ok": True, "message": "Planka webhook-only mode (no API key for testing)"}
|
|
planka = make_planka_provider(http_session, provider)
|
|
return await planka.test_connection()
|
|
|
|
if provider.type == "nut":
|
|
nut = make_nut_provider(provider)
|
|
return await nut.test_connection()
|
|
|
|
if provider.type == "google_photos":
|
|
gp = make_google_photos_provider(http_session, provider)
|
|
return await gp.test_connection()
|
|
|
|
if provider.type in ("scheduler", "webhook"):
|
|
return {"ok": True, "message": "Virtual provider — always available"}
|
|
|
|
return {"ok": False, "message": f"Unknown provider type: {provider.type}"}
|
|
|
|
|
|
async def _validate_provider_connection(provider: ServiceProvider) -> dict[str, Any]:
|
|
"""Test provider connection. Raise HTTPException on failure.
|
|
|
|
Returns the test_result dict on success (caller may inspect extra fields
|
|
like ``external_domain``).
|
|
"""
|
|
try:
|
|
test_result = await _test_provider_connection(provider)
|
|
except aiohttp.ClientError as err:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_400_BAD_REQUEST,
|
|
detail=f"Connection error: {err}",
|
|
)
|
|
except OSError as err:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_400_BAD_REQUEST,
|
|
detail=f"Connection error: {err}",
|
|
)
|
|
if not test_result.get("ok"):
|
|
raise HTTPException(
|
|
status_code=status.HTTP_400_BAD_REQUEST,
|
|
detail=test_result.get("message", f"Cannot connect to {provider.type} provider"),
|
|
)
|
|
return test_result
|
|
|
|
|
|
@router.get("")
|
|
async def list_providers(
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""List all service providers for the current user."""
|
|
result = await session.exec(
|
|
select(ServiceProvider).where(ServiceProvider.user_id == user.id)
|
|
)
|
|
providers = result.all()
|
|
return [_provider_response(p) for p in providers]
|
|
|
|
|
|
@router.post("", status_code=status.HTTP_201_CREATED)
|
|
async def create_provider(
|
|
body: ProviderCreate,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Add a new service provider (validates connection for known types)."""
|
|
_validate_provider_config(body.type, body.config)
|
|
|
|
# Build a temporary ServiceProvider for connection testing
|
|
temp_provider = ServiceProvider(
|
|
id=0, user_id=0, type=body.type, name=body.name, config=body.config,
|
|
)
|
|
test_result = await _validate_provider_connection(temp_provider)
|
|
|
|
# Store external_domain from Immich server config if available
|
|
if test_result.get("external_domain"):
|
|
body.config["external_domain"] = test_result["external_domain"]
|
|
|
|
provider = ServiceProvider(
|
|
user_id=user.id,
|
|
type=body.type,
|
|
name=body.name,
|
|
icon=body.icon,
|
|
config=body.config,
|
|
)
|
|
session.add(provider)
|
|
await session.commit()
|
|
await session.refresh(provider)
|
|
return _provider_response(provider)
|
|
|
|
|
|
@router.get("/capabilities")
|
|
async def list_provider_capabilities(
|
|
user: User = Depends(get_current_user),
|
|
):
|
|
"""List capabilities for all registered provider types."""
|
|
from notify_bridge_core.providers.capabilities import get_all_capabilities
|
|
result = {}
|
|
for pt, caps in get_all_capabilities().items():
|
|
result[pt] = {
|
|
"provider_type": caps.provider_type,
|
|
"display_name": caps.display_name,
|
|
"notification_slots": caps.notification_slots,
|
|
"command_slots": caps.command_slots,
|
|
"events": caps.events,
|
|
"commands": caps.commands,
|
|
"supported_filters": caps.supported_filters,
|
|
"webhook_based": caps.webhook_based,
|
|
"action_types": caps.action_types,
|
|
}
|
|
return result
|
|
|
|
|
|
@router.get("/capabilities/{provider_type}")
|
|
async def get_provider_capabilities(
|
|
provider_type: str,
|
|
user: User = Depends(get_current_user),
|
|
):
|
|
"""Get capabilities for a provider type (events, slots, commands)."""
|
|
from notify_bridge_core.providers.capabilities import get_capabilities
|
|
caps = get_capabilities(provider_type)
|
|
if not caps:
|
|
raise HTTPException(status_code=404, detail=f"Unknown provider type: {provider_type}")
|
|
return {
|
|
"provider_type": caps.provider_type,
|
|
"display_name": caps.display_name,
|
|
"notification_slots": caps.notification_slots,
|
|
"command_slots": caps.command_slots,
|
|
"events": caps.events,
|
|
"commands": caps.commands,
|
|
"supported_filters": caps.supported_filters,
|
|
"webhook_based": caps.webhook_based,
|
|
}
|
|
|
|
|
|
@router.get("/{provider_id}")
|
|
async def get_provider(
|
|
provider_id: int,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Get a specific service provider."""
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
return _provider_response(provider)
|
|
|
|
|
|
@router.put("/{provider_id}")
|
|
async def update_provider(
|
|
provider_id: int,
|
|
body: ProviderUpdate,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Update a service provider."""
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
if body.name is not None:
|
|
provider.name = body.name
|
|
if body.icon is not None:
|
|
provider.icon = body.icon
|
|
|
|
if body.config is not None:
|
|
# Merge rather than replace so the masked secrets the frontend
|
|
# receives on GET cannot silently nuke the stored values when the
|
|
# user saves without re-entering them. Any field that still carries
|
|
# our mask placeholder ("***…") is dropped from the incoming body.
|
|
incoming = dict(body.config)
|
|
for secret_field in (
|
|
"api_key", "api_token", "webhook_secret", "password",
|
|
"client_secret", "refresh_token",
|
|
):
|
|
value = incoming.get(secret_field)
|
|
if isinstance(value, str) and value.startswith("***"):
|
|
incoming.pop(secret_field, None)
|
|
new_config = {**provider.config, **incoming}
|
|
_validate_provider_config(provider.type, new_config)
|
|
config_changed = new_config != provider.config
|
|
provider.config = new_config
|
|
|
|
if config_changed:
|
|
test_result = await _validate_provider_connection(provider)
|
|
if test_result.get("external_domain"):
|
|
provider.config = {
|
|
**provider.config,
|
|
"external_domain": test_result["external_domain"],
|
|
}
|
|
|
|
session.add(provider)
|
|
await session.commit()
|
|
await session.refresh(provider)
|
|
return _provider_response(provider)
|
|
|
|
|
|
@router.delete("/{provider_id}", status_code=status.HTTP_204_NO_CONTENT)
|
|
async def delete_provider(
|
|
provider_id: int,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Delete a service provider."""
|
|
from .delete_protection import check_service_provider, raise_if_used
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
raise_if_used(await check_service_provider(session, provider.id), provider.name)
|
|
await session.delete(provider)
|
|
await session.commit()
|
|
|
|
|
|
@router.post("/{provider_id}/test")
|
|
async def test_provider(
|
|
provider_id: int,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Check if a service provider is reachable."""
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
return await _test_provider_connection(provider)
|
|
|
|
|
|
@router.get("/{provider_id}/people")
|
|
async def list_people(
|
|
provider_id: int,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Fetch people from a service provider (Immich only)."""
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
|
|
if provider.type == "immich":
|
|
from notify_bridge_core.providers.immich.client import ImmichClient
|
|
http_session = await get_http_session()
|
|
client = ImmichClient(
|
|
http_session,
|
|
provider.config.get("url", ""),
|
|
provider.config.get("api_key", ""),
|
|
)
|
|
people = await client.get_people()
|
|
return [{"id": pid, "name": name} for pid, name in people.items()]
|
|
|
|
return []
|
|
|
|
|
|
@router.get("/{provider_id}/collections")
|
|
async def list_collections(
|
|
provider_id: int,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Fetch collections from a service provider."""
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
|
|
return await list_provider_collections(provider)
|
|
|
|
|
|
@router.get("/{provider_id}/users")
|
|
async def list_provider_users(
|
|
provider_id: int,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
) -> list[dict[str, str]]:
|
|
"""Return user identities for sender allowlist/blocklist pickers.
|
|
|
|
Two sources are merged so the picker is useful both before and after the
|
|
first webhook arrives:
|
|
|
|
- **Provider API** (primary): Gitea's ``/users/search`` returns instance
|
|
users the api_token can see. Skipped when no api_token is set.
|
|
- **Past senders** (fallback): distinct ``sender`` values from
|
|
``EventLog.details`` for this provider, so pre-existing trackers stay
|
|
filterable even if the API call fails or is unconfigured.
|
|
"""
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
|
|
users_by_id: dict[str, str] = {}
|
|
|
|
# 1. Try the provider API.
|
|
if provider.type == "gitea" and (provider.config or {}).get("api_token"):
|
|
from notify_bridge_core.providers.gitea.client import GiteaClient
|
|
http_session = await get_http_session()
|
|
client = GiteaClient(
|
|
http_session,
|
|
provider.config.get("url", ""),
|
|
provider.config.get("api_token", ""),
|
|
)
|
|
try:
|
|
for u in await client.get_users():
|
|
login = u.get("login", "")
|
|
if isinstance(login, str) and login:
|
|
users_by_id[login] = u.get("full_name") or login
|
|
except Exception:
|
|
_LOGGER.warning("Failed to fetch Gitea users via API", exc_info=True)
|
|
|
|
# 2. Merge in past senders (covers users not visible to the API token, or
|
|
# cases where the API call fails).
|
|
result = await session.exec(
|
|
select(EventLog.details).where(EventLog.provider_id == provider.id)
|
|
)
|
|
for details in result.all():
|
|
if not isinstance(details, dict):
|
|
continue
|
|
sender = details.get("sender", "")
|
|
if isinstance(sender, str) and sender and sender not in users_by_id:
|
|
users_by_id[sender] = sender
|
|
|
|
return [
|
|
{"id": login, "name": name}
|
|
for login, name in sorted(users_by_id.items(), key=lambda kv: kv[0].lower())
|
|
]
|
|
|
|
|
|
@router.get("/{provider_id}/albums/{album_id}/shared-links")
|
|
async def get_album_shared_links(
|
|
provider_id: int,
|
|
album_id: str,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Check shared links for a specific album."""
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
|
|
if provider.type == "immich":
|
|
http_session = await get_http_session()
|
|
immich = make_immich_provider(http_session, provider)
|
|
links = await immich.client.get_shared_links(album_id)
|
|
return [
|
|
{
|
|
"id": link.id,
|
|
"key": link.key,
|
|
"has_password": link.has_password,
|
|
"is_expired": link.is_expired,
|
|
"is_accessible": link.is_accessible,
|
|
}
|
|
for link in links
|
|
]
|
|
|
|
return []
|
|
|
|
|
|
class CreateSharedLinkRequest(BaseModel):
|
|
"""Options for POST /shared-links.
|
|
|
|
``replace=True`` deletes every existing link for the album before creating
|
|
the new one, which is the only way to repair an expired or password-
|
|
protected link in the Immich API (there is no in-place "reset" endpoint).
|
|
Default ``False`` preserves the original additive behaviour used by the
|
|
"auto-create missing links" flow.
|
|
"""
|
|
|
|
replace: bool = False
|
|
|
|
|
|
@router.post("/{provider_id}/albums/{album_id}/shared-links")
|
|
async def create_album_shared_link(
|
|
provider_id: int,
|
|
album_id: str,
|
|
body: CreateSharedLinkRequest | None = None,
|
|
user: User = Depends(get_current_user),
|
|
session: AsyncSession = Depends(get_session),
|
|
):
|
|
"""Auto-create a public shared link for an album.
|
|
|
|
With ``replace=True`` existing links for the album are deleted first, so
|
|
expired/password-protected links are effectively recycled into a fresh
|
|
public one.
|
|
"""
|
|
provider = await _get_user_provider(session, provider_id, user.id)
|
|
|
|
if provider.type == "immich":
|
|
http_session = await get_http_session()
|
|
immich = make_immich_provider(http_session, provider)
|
|
if body and body.replace:
|
|
# Best-effort delete; if any delete fails we still try to create —
|
|
# the user will see the new link co-exist alongside the old one,
|
|
# which is better than a hard failure that leaves them stuck.
|
|
existing = await immich.client.get_shared_links(album_id)
|
|
for link in existing:
|
|
await immich.client.delete_shared_link(link.id)
|
|
success = await immich.client.create_shared_link(album_id)
|
|
if success:
|
|
return {"success": True}
|
|
raise HTTPException(status_code=400, detail="Failed to create shared link")
|
|
|
|
raise HTTPException(status_code=400, detail="Provider type does not support shared links")
|
|
|
|
|
|
def _provider_response(p: ServiceProvider) -> dict:
|
|
"""Build a safe response dict for a provider."""
|
|
config = dict(p.config)
|
|
# Mask sensitive fields
|
|
for secret_field in ("api_key", "api_token", "webhook_secret", "password",
|
|
"client_secret", "refresh_token"):
|
|
if secret_field in config:
|
|
key = config[secret_field]
|
|
config[secret_field] = f"***{key[-4:]}" if len(key) > 4 else "***"
|
|
return {
|
|
"id": p.id,
|
|
"type": p.type,
|
|
"name": p.name,
|
|
"icon": p.icon,
|
|
"config": config,
|
|
"webhook_token": p.webhook_token,
|
|
"created_at": p.created_at.isoformat(),
|
|
}
|
|
|
|
|
|
async def _get_user_provider(
|
|
session: AsyncSession, provider_id: int, user_id: int
|
|
) -> ServiceProvider:
|
|
"""Get a provider owned by the user, or raise 404."""
|
|
return await get_owned_entity(
|
|
session, ServiceProvider, provider_id, user_id,
|
|
not_found_msg="Provider not found",
|
|
)
|