Files
bambuddy/backend/app/models/notification_template.py
maziggy 7e6b390d74 feat(notifications): template-driven finish-photo email embed + user_print_* rename (#1792)
Reporter (email provider, "Reason: unknown" failures) wanted a camera snapshot
  in failure emails. The finish-photo capture path shipped in 0.2.5b1 (#1397)
  already loads JPEG bytes into archive_data["image_data"] for terminal print
  events, and pushover/telegram/discord/ntfy users have been getting them.
  Email was the one provider that dropped the bytes on the floor. Reporter
  separately flagged that the Message Templates list shows "Print Completed"
  and "User Print Completed" with no visual cue they're different dispatches.

  Both fixes in one commit because they touch the same UI surface (Message
  Templates) and both stem from the same reporter conversation.

  1) Inline finish-photo embed in email — template-driven, opt-in.

     _send_email now accepts finish_photo_url alongside image_data. Inline
     embed fires only when bytes are present AND URL is set AND the rendered
     body contains that URL — i.e. the user's template referenced the existing
     {finish_photo_url} variable. The multipart/related shape wraps a
     multipart/alternative (plain + HTML) plus an inline MIMEImage with
     Content-ID: <bambuddy-finish-photo>. The HTML part replaces the escaped
     URL in-place with the cid <img>, so the image appears WHERE the user put
     the variable in the template, not stapled to the bottom. Plain-text part
     keeps the URL as a clickable link for non-HTML clients.

     First draft of this fix unconditionally inlined the photo whenever
     image_data was present, which bypassed the template system. Reverted to
     the template-driven contract: default templates unchanged, opt-in by
     editing the template body to include {finish_photo_url}.

  2) user_print_* template name disambiguation.

     The four user_print_* templates are the per-user SMTP emails sent to the
     print's submitter (advanced-auth-only path). They shared the "Print
     Completed" / "Print Failed" / etc. short names with the broadcast
     provider templates, so the Message Templates list was indistinguishable.
     The EVENT_NAMES display map in routes/notification_templates.py already
     used the disambiguated "… Email" labels, but the seed wrote the short
     name to the DB.

     DEFAULT_TEMPLATES now seeds the four user_print_* rows with " Email"
     suffix so fresh installs are correctly labelled. New
     _migrate_rename_user_print_template_names runs on startup and updates
     existing rows where the name still matches the old default. Admin-edited
     names are preserved. Standard SQL UPDATE works on both SQLite and
     Postgres without dialect branching.
2026-06-22 11:15:39 +02:00

228 lines
9.0 KiB
Python

"""Notification template model for customizable notification messages."""
from datetime import datetime
from sqlalchemy import Boolean, DateTime, Integer, String, Text, func
from sqlalchemy.orm import Mapped, mapped_column
from backend.app.core.database import Base
class NotificationTemplate(Base):
"""Model for notification message templates."""
__tablename__ = "notification_templates"
id: Mapped[int] = mapped_column(Integer, primary_key=True, index=True)
event_type: Mapped[str] = mapped_column(String(50), nullable=False, unique=True)
name: Mapped[str] = mapped_column(String(100), nullable=False)
title_template: Mapped[str] = mapped_column(Text, nullable=False)
body_template: Mapped[str] = mapped_column(Text, nullable=False)
is_default: Mapped[bool] = mapped_column(Boolean, default=True)
created_at: Mapped[datetime] = mapped_column(DateTime, server_default=func.now())
updated_at: Mapped[datetime] = mapped_column(DateTime, server_default=func.now(), onupdate=func.now())
# Default templates for seeding
DEFAULT_TEMPLATES = [
{
"event_type": "print_start",
"name": "Print Started",
"title_template": "Print Started",
"body_template": "{printer}: {filename}\nEstimated: {estimated_time}",
},
{
"event_type": "print_complete",
"name": "Print Completed",
"title_template": "Print Completed",
"body_template": "{printer}: {filename}\nTime: {duration}\nFilament: {filament_grams}g",
},
{
"event_type": "print_failed",
"name": "Print Failed",
"title_template": "Print Failed",
"body_template": "{printer}: {filename}\nTime: {duration}\nReason: {reason}",
},
{
"event_type": "print_stopped",
"name": "Print Stopped",
"title_template": "Print Stopped",
"body_template": "{printer}: {filename}\nTime: {duration}",
},
{
"event_type": "print_progress",
"name": "Print Progress",
"title_template": "Print {progress}% Complete",
"body_template": "{printer}: {filename}\nRemaining: {remaining_time}",
},
{
"event_type": "print_missing_spool_assignment",
"name": "Missing Spool Assignment",
"title_template": "Missing Spool Assignment",
"body_template": "{printer}: print started with missing spool assignments\nSlots: {missing_slots}\nExpected profile:\n{missing_slot_details}",
},
{
"event_type": "printer_offline",
"name": "Printer Offline",
"title_template": "Printer Offline",
"body_template": "{printer} has disconnected",
},
{
"event_type": "printer_error",
"name": "Printer Error",
"title_template": "Printer Error: {error_type}",
"body_template": "{printer}\n{error_detail}",
},
{
"event_type": "ai_failure_detection",
"name": "AI Failure Detection",
"title_template": "Possible Print Failure Detected",
"body_template": "{printer}: {task_name}\nConfidence: {confidence}\nAction taken: {action}",
},
{
"event_type": "plate_not_empty",
"name": "Plate Not Empty",
"title_template": "Plate Not Empty - Print Paused",
"body_template": "{printer}: Objects detected on build plate. Print has been paused. Clear plate and resume.",
},
{
"event_type": "filament_low",
"name": "Filament Low",
"title_template": "Filament Low",
"body_template": "{printer}: Slot {slot} at {remaining_percent}%",
},
{
"event_type": "maintenance_due",
"name": "Maintenance Due",
"title_template": "Maintenance Due",
"body_template": "{printer}:\n{items}",
},
{
"event_type": "ams_humidity_high",
"name": "AMS Humidity High",
"title_template": "AMS Humidity Alert",
"body_template": "{printer} {ams_label}: Humidity {humidity}% exceeds {threshold}% threshold",
},
{
"event_type": "ams_temperature_high",
"name": "AMS Temperature High",
"title_template": "AMS Temperature Alert",
"body_template": "{printer} {ams_label}: Temperature {temperature}°C exceeds {threshold}°C threshold",
},
{
"event_type": "bed_cooled",
"name": "Bed Cooled",
"title_template": "Bed Cooled",
"body_template": "{printer}: Bed cooled to {bed_temp}°C (threshold: {threshold}°C)",
},
{
"event_type": "first_layer_complete",
"name": "First Layer Complete",
"title_template": "First Layer Complete",
"body_template": "{printer}: {filename}\nLayer 1/{total_layers} done",
},
{
"event_type": "test",
"name": "Test Notification",
"title_template": "Bambuddy Test",
"body_template": "This is a test notification. If you see this, notifications are working!",
},
# Queue notifications
{
"event_type": "queue_job_added",
"name": "Queue Job Added",
"title_template": "Job Queued",
"body_template": "{job_name} added to queue for {target}",
},
{
"event_type": "queue_job_assigned",
"name": "Queue Job Assigned",
"title_template": "Job Assigned",
"body_template": "{job_name} assigned to {printer} (from Any {target_model} queue)",
},
{
"event_type": "queue_job_started",
"name": "Queue Job Started",
"title_template": "Queue Job Started",
"body_template": "{printer}: {job_name}\nEstimated: {estimated_time}",
},
{
"event_type": "queue_job_waiting",
"name": "Queue Job Waiting",
"title_template": "Queue Job Waiting",
"body_template": "{job_name} waiting for {target_model}\n{waiting_reason}",
},
{
"event_type": "queue_job_skipped",
"name": "Queue Job Skipped",
"title_template": "Job Skipped",
"body_template": "{printer}: {job_name}\nReason: {reason}",
},
{
"event_type": "queue_job_failed",
"name": "Queue Job Failed",
"title_template": "Job Failed to Start",
"body_template": "{printer}: {job_name}\nReason: {reason}",
},
{
"event_type": "queue_completed",
"name": "Queue Completed",
"title_template": "Queue Complete",
"body_template": "All {completed_count} queued jobs have finished",
},
{
"event_type": "user_created",
"name": "Welcome Email",
"title_template": "Welcome to {app_name}",
"body_template": "Welcome {username}!\n\nYour account has been created.\nUsername: {username}\nPassword: {password}\n\nLogin at: {login_url}",
},
{
"event_type": "password_reset",
"name": "Password Reset",
"title_template": "{app_name} - Password Reset",
"body_template": "Hello {username},\n\nYour password has been reset.\nNew Password: {password}\n\nLogin at: {login_url}",
},
# Inventory stock alert templates
{
"event_type": "stock_reorder_alert",
"name": "Stock Reorder Alert",
"title_template": "Reorder Alert: {material}",
"body_template": "{material} ({brand}) has reached the reorder point.\nStock: {stock_g}g | Rate: {rate_g_day}g/day | Days left: {days_left}d\nReorder now to avoid a stock break.",
},
{
"event_type": "stock_break_alert",
"name": "Stock Break Alert",
"title_template": "Stock Break Risk: {material}",
"body_template": "{material} ({brand}) will run out before replenishment arrives.\nStock: {stock_g}g | Rate: {rate_g_day}g/day | Lead time: {lead_time_days}d\nOnly {days_left}d of stock remaining — order immediately.",
},
# User email notification templates (sent to the print job owner).
# Names include " Email" so they aren't confused with the provider-level
# `print_*` templates above, which share the same body shape but are
# broadcast to admin-configured providers (ntfy/pushover/telegram/discord/
# etc.) rather than mailed to a specific user.
{
"event_type": "user_print_start",
"name": "User Print Started Email",
"title_template": "Your Print Has Started",
"body_template": "Hello {username},\n\nYour print job has started on {printer}.\n\nFile: {filename}\n\nYou will be notified when it completes.",
},
{
"event_type": "user_print_complete",
"name": "User Print Completed Email",
"title_template": "Your Print Is Complete",
"body_template": "Hello {username},\n\nYour print job has completed on {printer}.\n\nFile: {filename}",
},
{
"event_type": "user_print_failed",
"name": "User Print Failed Email",
"title_template": "Your Print Has Failed",
"body_template": "Hello {username},\n\nYour print job has failed on {printer}.\n\nFile: {filename}",
},
{
"event_type": "user_print_stopped",
"name": "User Print Stopped Email",
"title_template": "Your Print Has Been Stopped",
"body_template": "Hello {username},\n\nYour print job was stopped on {printer}.\n\nFile: {filename}",
},
]