feat: provider-strict configs, slot-based templates, broadcast targets, email bots, command templates
Major architectural improvements: - Provider-type enforcement: configs validated against provider type at assignment - TemplateConfig migrated to slot-based pattern (TemplateSlot child table) - Broadcast targets: TargetReceiver child table for multi-receiver dispatch - EmailBot: first-class email sender entity with SMTP config, test connection - CommandTemplateConfig: generic slot-based command response templates - Provider capability registry: dynamic slot/event/command definitions per provider - CommandTracker play/pause button matches NotificationTracker style
This commit is contained in:
@@ -105,6 +105,14 @@ async def migrate_schema(engine: AsyncEngine) -> None:
|
||||
)
|
||||
logger.info("Added update_mode column to telegram_bot table")
|
||||
|
||||
# Add command_template_config_id to command_config if missing
|
||||
if await _has_table(conn, "command_config"):
|
||||
if not await _has_column(conn, "command_config", "command_template_config_id"):
|
||||
await conn.execute(
|
||||
text("ALTER TABLE command_config ADD COLUMN command_template_config_id INTEGER")
|
||||
)
|
||||
logger.info("Added command_template_config_id column to command_config table")
|
||||
|
||||
# Add date_only_format to template_config if missing
|
||||
if await _has_table(conn, "template_config"):
|
||||
if not await _has_column(conn, "template_config", "date_only_format"):
|
||||
@@ -537,3 +545,171 @@ async def migrate_entity_refactor(engine: AsyncEngine) -> None:
|
||||
# or notification_tracker_target. SQLite doesn't support DROP COLUMN in
|
||||
# all versions, and SQLModel will simply ignore columns not defined on
|
||||
# the model class. The columns will remain in the DB but are unused.
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Template slot migration
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
# Old column names that existed on template_config before the slot refactor
|
||||
_LEGACY_TEMPLATE_COLUMNS = [
|
||||
"message_assets_added",
|
||||
"message_assets_removed",
|
||||
"message_collection_renamed",
|
||||
"message_collection_deleted",
|
||||
"message_sharing_changed",
|
||||
"periodic_summary_message",
|
||||
"scheduled_assets_message",
|
||||
"memory_mode_message",
|
||||
]
|
||||
|
||||
|
||||
async def migrate_template_slots(engine: AsyncEngine) -> None:
|
||||
"""Migrate legacy TemplateConfig column-based templates to TemplateSlot rows.
|
||||
|
||||
Reads the old per-column template values via raw SQL (since they're no longer
|
||||
on the SQLModel class) and inserts them as TemplateSlot rows.
|
||||
Idempotent: skips if template_slot table already has data or legacy columns
|
||||
don't exist.
|
||||
"""
|
||||
async with engine.begin() as conn:
|
||||
if not await _has_table(conn, "template_config"):
|
||||
return
|
||||
|
||||
# Check if the legacy columns still exist in the DB
|
||||
has_legacy = await _has_column(conn, "template_config", "message_assets_added")
|
||||
if not has_legacy:
|
||||
logger.debug("No legacy template columns found — skipping slot migration")
|
||||
return
|
||||
|
||||
# Check if template_slot table exists and already has data
|
||||
if await _has_table(conn, "template_slot"):
|
||||
slot_count = (await conn.execute(text("SELECT COUNT(*) FROM template_slot"))).scalar()
|
||||
if slot_count and slot_count > 0:
|
||||
logger.debug("template_slot table already has %d rows — skipping migration", slot_count)
|
||||
return
|
||||
|
||||
# Create template_slot table if it doesn't exist yet
|
||||
# (SQLModel.metadata.create_all may have already created it, but be safe)
|
||||
if not await _has_table(conn, "template_slot"):
|
||||
await conn.execute(text(
|
||||
"CREATE TABLE template_slot ("
|
||||
" id INTEGER PRIMARY KEY,"
|
||||
" config_id INTEGER NOT NULL REFERENCES template_config(id),"
|
||||
" slot_name TEXT NOT NULL,"
|
||||
" template TEXT DEFAULT '',"
|
||||
" UNIQUE(config_id, slot_name)"
|
||||
")"
|
||||
))
|
||||
logger.info("Created template_slot table")
|
||||
|
||||
# Read all template configs with their legacy column values
|
||||
col_list = ", ".join(_LEGACY_TEMPLATE_COLUMNS)
|
||||
rows = (await conn.execute(
|
||||
text(f"SELECT id, {col_list} FROM template_config")
|
||||
)).fetchall()
|
||||
|
||||
migrated = 0
|
||||
for row in rows:
|
||||
config_id = row[0]
|
||||
for i, col_name in enumerate(_LEGACY_TEMPLATE_COLUMNS):
|
||||
template_text = row[i + 1] or ""
|
||||
if template_text.strip():
|
||||
await conn.execute(
|
||||
text(
|
||||
"INSERT INTO template_slot (config_id, slot_name, template) "
|
||||
"VALUES (:cid, :sn, :tmpl)"
|
||||
),
|
||||
{"cid": config_id, "sn": col_name, "tmpl": template_text},
|
||||
)
|
||||
migrated += 1
|
||||
|
||||
if migrated:
|
||||
logger.info("Migrated %d template slots from legacy columns", migrated)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Target receiver migration
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
async def migrate_target_receivers(engine: AsyncEngine) -> None:
|
||||
"""Migrate single chat_id/url from NotificationTarget.config to TargetReceiver rows.
|
||||
|
||||
For each existing target that has a chat_id or url in its config JSON and
|
||||
no receivers yet, creates a TargetReceiver row.
|
||||
Idempotent: skips targets that already have receivers.
|
||||
"""
|
||||
async with engine.begin() as conn:
|
||||
if not await _has_table(conn, "notification_target"):
|
||||
return
|
||||
|
||||
# Create target_receiver table if it doesn't exist yet
|
||||
if not await _has_table(conn, "target_receiver"):
|
||||
await conn.execute(text(
|
||||
"CREATE TABLE target_receiver ("
|
||||
" id INTEGER PRIMARY KEY,"
|
||||
" target_id INTEGER NOT NULL REFERENCES notification_target(id),"
|
||||
" name TEXT DEFAULT '',"
|
||||
" config TEXT DEFAULT '{}',"
|
||||
" receiver_key TEXT DEFAULT '',"
|
||||
" enabled INTEGER DEFAULT 1,"
|
||||
" created_at TIMESTAMP,"
|
||||
" UNIQUE(target_id, receiver_key)"
|
||||
")"
|
||||
))
|
||||
logger.info("Created target_receiver table")
|
||||
|
||||
# Check if any receivers already exist
|
||||
if await _has_table(conn, "target_receiver"):
|
||||
recv_count = (await conn.execute(text("SELECT COUNT(*) FROM target_receiver"))).scalar()
|
||||
if recv_count and recv_count > 0:
|
||||
logger.debug("target_receiver already has %d rows — skipping migration", recv_count)
|
||||
return
|
||||
|
||||
# Read all targets
|
||||
targets = (await conn.execute(
|
||||
text("SELECT id, type, config FROM notification_target")
|
||||
)).fetchall()
|
||||
|
||||
migrated = 0
|
||||
for row in targets:
|
||||
target_id, target_type, raw_config = row[0], row[1], row[2]
|
||||
try:
|
||||
cfg = json.loads(raw_config) if isinstance(raw_config, str) else (raw_config or {})
|
||||
except (json.JSONDecodeError, TypeError):
|
||||
cfg = {}
|
||||
|
||||
receiver_key = ""
|
||||
receiver_config = {}
|
||||
receiver_name = ""
|
||||
|
||||
if target_type == "telegram":
|
||||
chat_id = cfg.get("chat_id", "")
|
||||
if chat_id:
|
||||
receiver_key = str(chat_id)
|
||||
receiver_config = {"chat_id": str(chat_id)}
|
||||
receiver_name = f"Chat {chat_id}"
|
||||
elif target_type == "webhook":
|
||||
url = cfg.get("url", "")
|
||||
if url:
|
||||
receiver_key = url
|
||||
receiver_config = {"url": url, "headers": cfg.get("headers", {})}
|
||||
receiver_name = url[:50]
|
||||
|
||||
if receiver_key:
|
||||
await conn.execute(
|
||||
text(
|
||||
"INSERT INTO target_receiver (target_id, name, config, receiver_key, enabled, created_at) "
|
||||
"VALUES (:tid, :name, :cfg, :rk, 1, CURRENT_TIMESTAMP)"
|
||||
),
|
||||
{
|
||||
"tid": target_id,
|
||||
"name": receiver_name,
|
||||
"cfg": json.dumps(receiver_config),
|
||||
"rk": receiver_key,
|
||||
},
|
||||
)
|
||||
migrated += 1
|
||||
|
||||
if migrated:
|
||||
logger.info("Migrated %d target receivers from legacy config", migrated)
|
||||
|
||||
@@ -6,7 +6,7 @@ from datetime import datetime, timezone
|
||||
from typing import Any
|
||||
from uuid import uuid4
|
||||
|
||||
from sqlalchemy import UniqueConstraint
|
||||
from sqlalchemy import UniqueConstraint, Text
|
||||
from sqlmodel import JSON, Column, Field, SQLModel
|
||||
|
||||
|
||||
@@ -53,6 +53,24 @@ class TelegramBot(SQLModel, table=True):
|
||||
created_at: datetime = Field(default_factory=_utcnow)
|
||||
|
||||
|
||||
class EmailBot(SQLModel, table=True):
|
||||
"""Email sender — SMTP connection for sending email notifications."""
|
||||
|
||||
__tablename__ = "email_bot"
|
||||
|
||||
id: int | None = Field(default=None, primary_key=True)
|
||||
user_id: int = Field(foreign_key="user.id")
|
||||
name: str
|
||||
icon: str = Field(default="")
|
||||
email: str # From address
|
||||
smtp_host: str
|
||||
smtp_port: int = Field(default=587)
|
||||
smtp_username: str = Field(default="")
|
||||
smtp_password: str = Field(default="")
|
||||
smtp_use_tls: bool = Field(default=True)
|
||||
created_at: datetime = Field(default_factory=_utcnow)
|
||||
|
||||
|
||||
class TelegramChat(SQLModel, table=True):
|
||||
__tablename__ = "telegram_chat"
|
||||
|
||||
@@ -124,7 +142,10 @@ class TrackingConfig(SQLModel, table=True):
|
||||
|
||||
|
||||
class TemplateConfig(SQLModel, table=True):
|
||||
"""Jinja2 message templates. Tied to a provider type."""
|
||||
"""Jinja2 message templates. Tied to a provider type.
|
||||
|
||||
Template content is stored in TemplateSlot child rows (one per slot).
|
||||
"""
|
||||
|
||||
__tablename__ = "template_config"
|
||||
|
||||
@@ -135,32 +156,41 @@ class TemplateConfig(SQLModel, table=True):
|
||||
description: str = Field(default="")
|
||||
icon: str = Field(default="")
|
||||
|
||||
# Event-driven notification templates
|
||||
message_assets_added: str = Field(default="")
|
||||
message_assets_removed: str = Field(default="")
|
||||
message_collection_renamed: str = Field(default="")
|
||||
message_collection_deleted: str = Field(default="")
|
||||
message_sharing_changed: str = Field(default="")
|
||||
|
||||
# Scheduled notification templates
|
||||
periodic_summary_message: str = Field(default="")
|
||||
scheduled_assets_message: str = Field(default="")
|
||||
memory_mode_message: str = Field(default="")
|
||||
|
||||
date_format: str = Field(default="%d.%m.%Y, %H:%M UTC")
|
||||
date_only_format: str = Field(default="%d.%m.%Y")
|
||||
|
||||
created_at: datetime = Field(default_factory=_utcnow)
|
||||
|
||||
|
||||
class TemplateSlot(SQLModel, table=True):
|
||||
"""One Jinja2 template for a specific slot within a TemplateConfig.
|
||||
|
||||
Slot names are provider-specific (e.g. 'message_assets_added' for Immich).
|
||||
"""
|
||||
|
||||
__tablename__ = "template_slot"
|
||||
__table_args__ = (
|
||||
UniqueConstraint("config_id", "slot_name", name="uq_template_slot"),
|
||||
)
|
||||
|
||||
id: int | None = Field(default=None, primary_key=True)
|
||||
config_id: int = Field(foreign_key="template_config.id", index=True)
|
||||
slot_name: str
|
||||
template: str = Field(default="", sa_column=Column(Text, default=""))
|
||||
|
||||
|
||||
class NotificationTarget(SQLModel, table=True):
|
||||
"""Where to send notifications. Pure delivery endpoint."""
|
||||
"""Where to send notifications. Pure delivery endpoint.
|
||||
|
||||
Target-level config holds connection/display settings (e.g. bot_token,
|
||||
disable_url_preview). Actual delivery endpoints live in TargetReceiver rows.
|
||||
"""
|
||||
|
||||
__tablename__ = "notification_target"
|
||||
|
||||
id: int | None = Field(default=None, primary_key=True)
|
||||
user_id: int = Field(foreign_key="user.id")
|
||||
type: str # "telegram" or "webhook"
|
||||
type: str # "telegram", "webhook", or "email"
|
||||
name: str
|
||||
icon: str = Field(default="")
|
||||
config: dict[str, Any] = Field(default_factory=dict, sa_column=Column(JSON))
|
||||
@@ -168,6 +198,28 @@ class NotificationTarget(SQLModel, table=True):
|
||||
created_at: datetime = Field(default_factory=_utcnow)
|
||||
|
||||
|
||||
class TargetReceiver(SQLModel, table=True):
|
||||
"""One delivery endpoint within a NotificationTarget (broadcast support).
|
||||
|
||||
For Telegram: config = {"chat_id": "12345"}
|
||||
For Webhook: config = {"url": "https://...", "headers": {...}}
|
||||
For Email: config = {"email": "user@example.com", "name": "..."}
|
||||
"""
|
||||
|
||||
__tablename__ = "target_receiver"
|
||||
__table_args__ = (
|
||||
UniqueConstraint("target_id", "receiver_key", name="uq_target_receiver"),
|
||||
)
|
||||
|
||||
id: int | None = Field(default=None, primary_key=True)
|
||||
target_id: int = Field(foreign_key="notification_target.id", index=True)
|
||||
name: str = Field(default="")
|
||||
config: dict[str, Any] = Field(default_factory=dict, sa_column=Column(JSON))
|
||||
receiver_key: str = Field(default="") # dedup key (e.g. chat_id, url, email)
|
||||
enabled: bool = Field(default=True)
|
||||
created_at: datetime = Field(default_factory=_utcnow)
|
||||
|
||||
|
||||
class NotificationTracker(SQLModel, table=True):
|
||||
"""Watches a provider's collections for changes."""
|
||||
|
||||
@@ -246,9 +298,43 @@ class CommandConfig(SQLModel, table=True):
|
||||
response_mode: str = Field(default="media") # "media" or "text"
|
||||
default_count: int = Field(default=5)
|
||||
rate_limits: dict[str, Any] = Field(default_factory=dict, sa_column=Column(JSON))
|
||||
command_template_config_id: int | None = Field(
|
||||
default=None, foreign_key="command_template_config.id"
|
||||
)
|
||||
created_at: datetime = Field(default_factory=_utcnow)
|
||||
|
||||
|
||||
class CommandTemplateConfig(SQLModel, table=True):
|
||||
"""Jinja2 templates for command responses. Provider-specific via slots."""
|
||||
|
||||
__tablename__ = "command_template_config"
|
||||
|
||||
id: int | None = Field(default=None, primary_key=True)
|
||||
user_id: int = Field(default=0) # 0 = system-owned
|
||||
provider_type: str
|
||||
name: str
|
||||
description: str = Field(default="")
|
||||
icon: str = Field(default="")
|
||||
created_at: datetime = Field(default_factory=_utcnow)
|
||||
|
||||
|
||||
class CommandTemplateSlot(SQLModel, table=True):
|
||||
"""One Jinja2 template for a specific command response slot.
|
||||
|
||||
Slot names match command names (e.g. 'status', 'help', 'albums').
|
||||
"""
|
||||
|
||||
__tablename__ = "command_template_slot"
|
||||
__table_args__ = (
|
||||
UniqueConstraint("config_id", "slot_name", name="uq_command_template_slot"),
|
||||
)
|
||||
|
||||
id: int | None = Field(default=None, primary_key=True)
|
||||
config_id: int = Field(foreign_key="command_template_config.id", index=True)
|
||||
slot_name: str
|
||||
template: str = Field(default="", sa_column=Column(Text, default=""))
|
||||
|
||||
|
||||
class CommandTracker(SQLModel, table=True):
|
||||
"""Links a provider to a command config for interactive bot commands."""
|
||||
|
||||
|
||||
Reference in New Issue
Block a user