notification.py 9.7 KB

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