notification.py 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  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. class NotificationProviderBase(BaseModel):
  17. """Base schema for notification providers."""
  18. name: str = Field(..., min_length=1, max_length=100, description="User-defined name")
  19. provider_type: ProviderType = Field(..., description="Type of notification provider")
  20. enabled: bool = Field(default=True, description="Whether notifications are enabled")
  21. config: dict[str, Any] = Field(..., description="Provider-specific configuration")
  22. # Event triggers - print lifecycle
  23. on_print_start: bool = Field(default=False, description="Notify on print start")
  24. on_print_complete: bool = Field(default=True, description="Notify on print complete")
  25. on_print_failed: bool = Field(default=True, description="Notify on print failed")
  26. on_print_stopped: bool = Field(default=True, description="Notify when print is stopped/cancelled")
  27. on_print_progress: bool = Field(default=False, description="Notify at 25%, 50%, 75% progress")
  28. # Event triggers - printer status
  29. on_printer_offline: bool = Field(default=False, description="Notify when printer goes offline")
  30. on_printer_error: bool = Field(default=False, description="Notify on printer errors (AMS, etc.)")
  31. on_filament_low: bool = Field(default=False, description="Notify when filament is running low")
  32. on_maintenance_due: bool = Field(default=False, description="Notify when maintenance is due")
  33. # Event triggers - AMS environmental alarms (regular AMS)
  34. on_ams_humidity_high: bool = Field(default=False, description="Notify when AMS humidity exceeds threshold")
  35. on_ams_temperature_high: bool = Field(default=False, description="Notify when AMS temperature exceeds threshold")
  36. # Event triggers - AMS-HT environmental alarms
  37. on_ams_ht_humidity_high: bool = Field(default=False, description="Notify when AMS-HT humidity exceeds threshold")
  38. on_ams_ht_temperature_high: bool = Field(
  39. default=False, description="Notify when AMS-HT temperature exceeds threshold"
  40. )
  41. # Event triggers - Build plate detection
  42. on_plate_not_empty: bool = Field(default=True, description="Notify when objects detected on plate before print")
  43. # Event triggers - Bed cooled
  44. on_bed_cooled: bool = Field(default=False, description="Notify when bed cools after print")
  45. # Event triggers - Print queue
  46. on_queue_job_added: bool = Field(default=False, description="Notify when job is added to queue")
  47. on_queue_job_assigned: bool = Field(default=False, description="Notify when model-based job is assigned to printer")
  48. on_queue_job_started: bool = Field(default=False, description="Notify when queue job starts printing")
  49. on_queue_job_waiting: bool = Field(default=True, description="Notify when job is waiting for filament")
  50. on_queue_job_skipped: bool = Field(default=True, description="Notify when job is skipped")
  51. on_queue_job_failed: bool = Field(default=True, description="Notify when job fails to start")
  52. on_queue_completed: bool = Field(default=False, description="Notify when all queue jobs finish")
  53. # Quiet hours
  54. quiet_hours_enabled: bool = Field(default=False, description="Enable quiet hours")
  55. quiet_hours_start: str | None = Field(default=None, description="Start time in HH:MM format")
  56. quiet_hours_end: str | None = Field(default=None, description="End time in HH:MM format")
  57. # Daily digest
  58. daily_digest_enabled: bool = Field(default=False, description="Batch notifications into daily digest")
  59. daily_digest_time: str | None = Field(default=None, description="Time to send digest in HH:MM format")
  60. # Printer filter
  61. printer_id: int | None = Field(default=None, description="Specific printer ID or null for all")
  62. @field_validator("quiet_hours_start", "quiet_hours_end", "daily_digest_time")
  63. @classmethod
  64. def validate_time_format(cls, v: str | None) -> str | None:
  65. if v is None:
  66. return v
  67. try:
  68. parts = v.split(":")
  69. if len(parts) != 2:
  70. raise ValueError("Invalid time format")
  71. hour, minute = int(parts[0]), int(parts[1])
  72. if not (0 <= hour <= 23 and 0 <= minute <= 59):
  73. raise ValueError("Invalid time range")
  74. return f"{hour:02d}:{minute:02d}"
  75. except (ValueError, TypeError):
  76. raise ValueError("Time must be in HH:MM format (e.g., 22:00)")
  77. class NotificationProviderCreate(NotificationProviderBase):
  78. """Schema for creating a notification provider."""
  79. pass
  80. class NotificationProviderUpdate(BaseModel):
  81. """Schema for updating a notification provider (all fields optional)."""
  82. name: str | None = Field(default=None, min_length=1, max_length=100)
  83. provider_type: ProviderType | None = None
  84. enabled: bool | None = None
  85. config: dict[str, Any] | None = None
  86. # Event triggers - print lifecycle
  87. on_print_start: bool | None = None
  88. on_print_complete: bool | None = None
  89. on_print_failed: bool | None = None
  90. on_print_stopped: bool | None = None
  91. on_print_progress: bool | None = None
  92. # Event triggers - printer status
  93. on_printer_offline: bool | None = None
  94. on_printer_error: bool | None = None
  95. on_filament_low: bool | None = None
  96. on_maintenance_due: bool | None = None
  97. # Event triggers - AMS environmental alarms (regular AMS)
  98. on_ams_humidity_high: bool | None = None
  99. on_ams_temperature_high: bool | None = None
  100. # Event triggers - AMS-HT environmental alarms
  101. on_ams_ht_humidity_high: bool | None = None
  102. on_ams_ht_temperature_high: bool | None = None
  103. # Event triggers - Build plate detection
  104. on_plate_not_empty: bool | None = None
  105. # Event triggers - Bed cooled
  106. on_bed_cooled: bool | None = None
  107. # Event triggers - Print queue
  108. on_queue_job_added: bool | None = None
  109. on_queue_job_assigned: bool | None = None
  110. on_queue_job_started: bool | None = None
  111. on_queue_job_waiting: bool | None = None
  112. on_queue_job_skipped: bool | None = None
  113. on_queue_job_failed: bool | None = None
  114. on_queue_completed: bool | None = None
  115. # Quiet hours
  116. quiet_hours_enabled: bool | None = None
  117. quiet_hours_start: str | None = None
  118. quiet_hours_end: str | None = None
  119. # Daily digest
  120. daily_digest_enabled: bool | None = None
  121. daily_digest_time: str | None = None
  122. # Printer filter
  123. printer_id: int | None = None
  124. class NotificationProviderResponse(NotificationProviderBase):
  125. """Schema for notification provider API responses."""
  126. id: int
  127. last_success: datetime | None = None
  128. last_error: str | None = None
  129. last_error_at: datetime | None = None
  130. created_at: datetime
  131. updated_at: datetime
  132. class Config:
  133. from_attributes = True
  134. class NotificationTestRequest(BaseModel):
  135. """Schema for testing notification configuration."""
  136. provider_type: ProviderType
  137. config: dict[str, Any]
  138. class NotificationTestResponse(BaseModel):
  139. """Schema for test notification response."""
  140. success: bool
  141. message: str
  142. # Provider-specific config schemas for documentation/validation reference
  143. class CallMeBotConfig(BaseModel):
  144. """CallMeBot/WhatsApp configuration."""
  145. phone: str = Field(..., description="Phone number with country code (e.g., +1234567890)")
  146. apikey: str = Field(..., description="API key from CallMeBot")
  147. class NtfyConfig(BaseModel):
  148. """ntfy configuration."""
  149. server: str = Field(default="https://ntfy.sh", description="ntfy server URL")
  150. topic: str = Field(..., description="Topic name to publish to")
  151. auth_token: str | None = Field(default=None, description="Optional authentication token")
  152. class PushoverConfig(BaseModel):
  153. """Pushover configuration."""
  154. user_key: str = Field(..., description="Your Pushover user key")
  155. app_token: str = Field(..., description="Your Pushover application token")
  156. priority: int = Field(default=0, ge=-2, le=2, description="Message priority (-2 to 2)")
  157. class TelegramConfig(BaseModel):
  158. """Telegram bot configuration."""
  159. bot_token: str = Field(..., description="Bot token from @BotFather")
  160. chat_id: str = Field(..., description="Chat ID to send messages to")
  161. class EmailConfig(BaseModel):
  162. """Email/SMTP configuration."""
  163. smtp_server: str = Field(..., description="SMTP server hostname")
  164. smtp_port: int = Field(default=587, description="SMTP port (587 for TLS, 465 for SSL)")
  165. username: str = Field(..., description="SMTP username/email")
  166. password: str = Field(..., description="SMTP password or app password")
  167. from_email: str = Field(..., description="From email address")
  168. to_email: str = Field(..., description="Recipient email address")
  169. use_tls: bool = Field(default=True, description="Use TLS encryption")
  170. # Notification Log schemas
  171. class NotificationLogResponse(BaseModel):
  172. """Schema for notification log API responses."""
  173. id: int
  174. provider_id: int
  175. provider_name: str | None = None
  176. provider_type: str | None = None
  177. event_type: str
  178. title: str
  179. message: str
  180. success: bool
  181. error_message: str | None = None
  182. printer_id: int | None = None
  183. printer_name: str | None = None
  184. created_at: datetime
  185. class Config:
  186. from_attributes = True
  187. class NotificationLogStats(BaseModel):
  188. """Statistics for notification logs."""
  189. total: int
  190. success_count: int
  191. failure_count: int
  192. by_event_type: dict[str, int]
  193. by_provider: dict[str, int]