notification.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  1. """Pydantic schemas for notification providers."""
  2. from datetime import datetime
  3. from typing import Any
  4. from pydantic import BaseModel, Field, field_validator
  5. from backend.app.core.compat import StrEnum
  6. class ProviderType(StrEnum):
  7. """Supported notification provider types."""
  8. CALLMEBOT = "callmebot"
  9. NTFY = "ntfy"
  10. PUSHOVER = "pushover"
  11. TELEGRAM = "telegram"
  12. EMAIL = "email"
  13. DISCORD = "discord"
  14. WEBHOOK = "webhook"
  15. HOMEASSISTANT = "homeassistant"
  16. BARK = "bark"
  17. class NotificationProviderBase(BaseModel):
  18. """Base schema for notification providers."""
  19. name: str = Field(..., min_length=1, max_length=100, description="User-defined name")
  20. provider_type: ProviderType = Field(..., description="Type of notification provider")
  21. enabled: bool = Field(default=True, description="Whether notifications are enabled")
  22. config: dict[str, Any] = Field(..., description="Provider-specific configuration")
  23. # Event triggers - print lifecycle
  24. on_print_start: bool = Field(default=False, description="Notify on print start")
  25. on_print_complete: bool = Field(default=True, description="Notify on print complete")
  26. on_print_failed: bool = Field(default=True, description="Notify on print failed")
  27. on_print_stopped: bool = Field(default=True, description="Notify when print is stopped/cancelled")
  28. on_print_progress: bool = Field(default=False, description="Notify at 25%, 50%, 75% progress")
  29. on_print_missing_spool_assignment: bool = Field(
  30. default=False,
  31. description="Notify when a print starts with required trays missing spool assignments",
  32. )
  33. on_billing_charge_failed: bool = Field(default=True, description="Notify when a print charge cannot be recorded")
  34. # Event triggers - printer status
  35. on_printer_offline: bool = Field(default=False, description="Notify when printer goes offline")
  36. on_printer_error: bool = Field(default=False, description="Notify on printer errors (AMS, etc.)")
  37. on_ai_failure_detection: bool = Field(
  38. default=False,
  39. description="Notify when Obico AI detects a possible print failure (spaghetti)",
  40. )
  41. on_filament_low: bool = Field(default=False, description="Notify when filament is running low")
  42. on_maintenance_due: bool = Field(default=False, description="Notify when maintenance is due")
  43. # Event triggers - AMS environmental alarms (regular AMS)
  44. on_ams_humidity_high: bool = Field(default=False, description="Notify when AMS humidity exceeds threshold")
  45. on_ams_temperature_high: bool = Field(default=False, description="Notify when AMS temperature exceeds threshold")
  46. on_ams_drying_suspended: bool = Field(
  47. default=True, description="Notify when automatic drying gives up on an AMS unit"
  48. )
  49. # Event triggers - AMS-HT environmental alarms
  50. on_ams_ht_humidity_high: bool = Field(default=False, description="Notify when AMS-HT humidity exceeds threshold")
  51. on_ams_ht_temperature_high: bool = Field(
  52. default=False, description="Notify when AMS-HT temperature exceeds threshold"
  53. )
  54. # Event triggers - Home Assistant sensors (#1148)
  55. on_ha_sensor_alert: bool = Field(
  56. default=False, description="Notify when a bound Home Assistant sensor enters its alert state"
  57. )
  58. # Event triggers - Build plate detection
  59. on_plate_not_empty: bool = Field(default=True, description="Notify when objects detected on plate before print")
  60. on_plate_clear_required: bool = Field(
  61. default=False, description="Notify when a finished print is waiting for plate-clear confirmation"
  62. )
  63. # Event triggers - Bed cooled
  64. on_bed_cooled: bool = Field(default=False, description="Notify when bed cools after print")
  65. # Event triggers - First layer complete
  66. on_first_layer_complete: bool = Field(default=False, description="Notify when first layer completes")
  67. # Event triggers - Print queue
  68. on_queue_job_added: bool = Field(default=False, description="Notify when job is added to queue")
  69. on_queue_job_assigned: bool = Field(default=False, description="Notify when model-based job is assigned to printer")
  70. on_queue_job_started: bool = Field(default=False, description="Notify when queue job starts printing")
  71. on_queue_job_waiting: bool = Field(default=True, description="Notify when job is waiting for filament or printer")
  72. on_queue_job_skipped: bool = Field(default=True, description="Notify when job is skipped")
  73. on_queue_job_failed: bool = Field(default=True, description="Notify when job fails to start")
  74. on_queue_completed: bool = Field(default=False, description="Notify when all queue jobs finish")
  75. # Quiet hours
  76. quiet_hours_enabled: bool = Field(default=False, description="Enable quiet hours")
  77. quiet_hours_start: str | None = Field(default=None, description="Start time in HH:MM format")
  78. quiet_hours_end: str | None = Field(default=None, description="End time in HH:MM format")
  79. # Daily digest
  80. daily_digest_enabled: bool = Field(default=False, description="Batch notifications into daily digest")
  81. daily_digest_time: str | None = Field(default=None, description="Time to send digest in HH:MM format")
  82. # Printer filter
  83. printer_id: int | None = Field(default=None, description="Specific printer ID or null for all")
  84. @field_validator("quiet_hours_start", "quiet_hours_end", "daily_digest_time")
  85. @classmethod
  86. def validate_time_format(cls, v: str | None) -> str | None:
  87. if v is None:
  88. return v
  89. try:
  90. parts = v.split(":")
  91. if len(parts) != 2:
  92. raise ValueError("Invalid time format")
  93. hour, minute = int(parts[0]), int(parts[1])
  94. if not (0 <= hour <= 23 and 0 <= minute <= 59):
  95. raise ValueError("Invalid time range")
  96. return f"{hour:02d}:{minute:02d}"
  97. except (ValueError, TypeError):
  98. raise ValueError("Time must be in HH:MM format (e.g., 22:00)")
  99. class NotificationProviderCreate(NotificationProviderBase):
  100. """Schema for creating a notification provider."""
  101. pass
  102. class NotificationProviderUpdate(BaseModel):
  103. """Schema for updating a notification provider (all fields optional)."""
  104. name: str | None = Field(default=None, min_length=1, max_length=100)
  105. provider_type: ProviderType | None = None
  106. enabled: bool | None = None
  107. config: dict[str, Any] | None = None
  108. # Event triggers - print lifecycle
  109. on_print_start: bool | None = None
  110. on_print_complete: bool | None = None
  111. on_print_failed: bool | None = None
  112. on_print_stopped: bool | None = None
  113. on_print_progress: bool | None = None
  114. on_print_missing_spool_assignment: bool | None = None
  115. on_billing_charge_failed: bool | None = None
  116. # Event triggers - printer status
  117. on_printer_offline: bool | None = None
  118. on_printer_error: bool | None = None
  119. on_ai_failure_detection: bool | None = None
  120. on_filament_low: bool | None = None
  121. on_maintenance_due: bool | None = None
  122. # Event triggers - AMS environmental alarms (regular AMS)
  123. on_ams_humidity_high: bool | None = None
  124. on_ams_temperature_high: bool | None = None
  125. on_ams_drying_suspended: bool | None = None
  126. # Event triggers - AMS-HT environmental alarms
  127. on_ams_ht_humidity_high: bool | None = None
  128. on_ams_ht_temperature_high: bool | None = None
  129. # Event triggers - Home Assistant sensors (#1148)
  130. on_ha_sensor_alert: bool | None = None
  131. # Event triggers - Build plate detection
  132. on_plate_not_empty: bool | None = None
  133. on_plate_clear_required: bool | None = None
  134. # Event triggers - Bed cooled
  135. on_bed_cooled: bool | None = None
  136. # Event triggers - First layer complete
  137. on_first_layer_complete: bool | None = None
  138. # Event triggers - Print queue
  139. on_queue_job_added: bool | None = None
  140. on_queue_job_assigned: bool | None = None
  141. on_queue_job_started: bool | None = None
  142. on_queue_job_waiting: bool | None = None
  143. on_queue_job_skipped: bool | None = None
  144. on_queue_job_failed: bool | None = None
  145. on_queue_completed: bool | None = None
  146. # Quiet hours
  147. quiet_hours_enabled: bool | None = None
  148. quiet_hours_start: str | None = None
  149. quiet_hours_end: str | None = None
  150. # Daily digest
  151. daily_digest_enabled: bool | None = None
  152. daily_digest_time: str | None = None
  153. # Printer filter
  154. printer_id: int | None = None
  155. class NotificationProviderResponse(NotificationProviderBase):
  156. """Schema for notification provider API responses."""
  157. id: int
  158. last_success: datetime | None = None
  159. last_error: str | None = None
  160. last_error_at: datetime | None = None
  161. created_at: datetime
  162. updated_at: datetime
  163. class Config:
  164. from_attributes = True
  165. class NotificationTestRequest(BaseModel):
  166. """Schema for testing notification configuration."""
  167. provider_type: ProviderType
  168. config: dict[str, Any]
  169. class NotificationTestResponse(BaseModel):
  170. """Schema for test notification response."""
  171. success: bool
  172. message: str
  173. # Provider-specific config schemas for documentation/validation reference
  174. class CallMeBotConfig(BaseModel):
  175. """CallMeBot/WhatsApp configuration."""
  176. phone: str = Field(..., description="Phone number with country code (e.g., +1234567890)")
  177. apikey: str = Field(..., description="API key from CallMeBot")
  178. class NtfyConfig(BaseModel):
  179. """ntfy configuration."""
  180. server: str = Field(default="https://ntfy.sh", description="ntfy server URL")
  181. topic: str = Field(..., description="Topic name to publish to")
  182. auth_token: str | None = Field(default=None, description="Optional authentication token")
  183. event_priorities: dict[str, int] | None = Field(
  184. default=None,
  185. description=(
  186. "Per-event priority override. Keys are event names (e.g. 'on_print_failed'); "
  187. "values are ntfy priorities 1-5 (1=min, 2=low, 3=default, 4=high, 5=urgent). "
  188. "Events without an entry use ntfy's server-side default."
  189. ),
  190. )
  191. class PushoverConfig(BaseModel):
  192. """Pushover configuration."""
  193. user_key: str = Field(..., description="Your Pushover user key")
  194. app_token: str = Field(..., description="Your Pushover application token")
  195. priority: int = Field(default=0, ge=-2, le=2, description="Message priority (-2 to 2)")
  196. # Emergency priority (2) only: how often to re-alert and when to stop.
  197. # Pushover requires retry >= 30s and expire <= 10800s (3h).
  198. retry: int = Field(default=60, ge=30, le=10800, description="Emergency re-alert interval in seconds (priority 2)")
  199. expire: int = Field(default=3600, ge=30, le=10800, description="Emergency alert expiry in seconds (priority 2)")
  200. class TelegramConfig(BaseModel):
  201. """Telegram bot configuration."""
  202. bot_token: str = Field(..., description="Bot token from @BotFather")
  203. chat_id: str = Field(..., description="Chat ID to send messages to")
  204. class EmailConfig(BaseModel):
  205. """Email/SMTP configuration."""
  206. smtp_server: str = Field(..., description="SMTP server hostname")
  207. smtp_port: int = Field(default=587, description="SMTP port (587 for TLS, 465 for SSL)")
  208. username: str = Field(..., description="SMTP username/email")
  209. password: str = Field(..., description="SMTP password or app password")
  210. from_email: str = Field(..., description="From email address")
  211. to_email: str = Field(..., description="Recipient email address")
  212. use_tls: bool = Field(default=True, description="Use TLS encryption")
  213. # Notification Log schemas
  214. class NotificationLogResponse(BaseModel):
  215. """Schema for notification log API responses."""
  216. id: int
  217. provider_id: int
  218. provider_name: str | None = None
  219. provider_type: str | None = None
  220. event_type: str
  221. title: str
  222. message: str
  223. success: bool
  224. error_message: str | None = None
  225. printer_id: int | None = None
  226. printer_name: str | None = None
  227. created_at: datetime
  228. class Config:
  229. from_attributes = True
  230. class NotificationLogStats(BaseModel):
  231. """Statistics for notification logs."""
  232. total: int
  233. success_count: int
  234. failure_count: int
  235. by_event_type: dict[str, int]
  236. by_provider: dict[str, int]