notification.py 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. """Pydantic schemas for notification providers."""
  2. from datetime import datetime
  3. from enum import Enum
  4. from typing import Any
  5. from pydantic import BaseModel, Field, field_validator
  6. class ProviderType(str, Enum):
  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. # Quiet hours
  43. quiet_hours_enabled: bool = Field(default=False, description="Enable quiet hours")
  44. quiet_hours_start: str | None = Field(default=None, description="Start time in HH:MM format")
  45. quiet_hours_end: str | None = Field(default=None, description="End time in HH:MM format")
  46. # Daily digest
  47. daily_digest_enabled: bool = Field(default=False, description="Batch notifications into daily digest")
  48. daily_digest_time: str | None = Field(default=None, description="Time to send digest in HH:MM format")
  49. # Printer filter
  50. printer_id: int | None = Field(default=None, description="Specific printer ID or null for all")
  51. @field_validator("quiet_hours_start", "quiet_hours_end", "daily_digest_time")
  52. @classmethod
  53. def validate_time_format(cls, v: str | None) -> str | None:
  54. if v is None:
  55. return v
  56. try:
  57. parts = v.split(":")
  58. if len(parts) != 2:
  59. raise ValueError("Invalid time format")
  60. hour, minute = int(parts[0]), int(parts[1])
  61. if not (0 <= hour <= 23 and 0 <= minute <= 59):
  62. raise ValueError("Invalid time range")
  63. return f"{hour:02d}:{minute:02d}"
  64. except (ValueError, TypeError):
  65. raise ValueError("Time must be in HH:MM format (e.g., 22:00)")
  66. class NotificationProviderCreate(NotificationProviderBase):
  67. """Schema for creating a notification provider."""
  68. pass
  69. class NotificationProviderUpdate(BaseModel):
  70. """Schema for updating a notification provider (all fields optional)."""
  71. name: str | None = Field(default=None, min_length=1, max_length=100)
  72. provider_type: ProviderType | None = None
  73. enabled: bool | None = None
  74. config: dict[str, Any] | None = None
  75. # Event triggers - print lifecycle
  76. on_print_start: bool | None = None
  77. on_print_complete: bool | None = None
  78. on_print_failed: bool | None = None
  79. on_print_stopped: bool | None = None
  80. on_print_progress: bool | None = None
  81. # Event triggers - printer status
  82. on_printer_offline: bool | None = None
  83. on_printer_error: bool | None = None
  84. on_filament_low: bool | None = None
  85. on_maintenance_due: bool | None = None
  86. # Event triggers - AMS environmental alarms (regular AMS)
  87. on_ams_humidity_high: bool | None = None
  88. on_ams_temperature_high: bool | None = None
  89. # Event triggers - AMS-HT environmental alarms
  90. on_ams_ht_humidity_high: bool | None = None
  91. on_ams_ht_temperature_high: bool | None = None
  92. # Event triggers - Build plate detection
  93. on_plate_not_empty: bool | None = None
  94. # Quiet hours
  95. quiet_hours_enabled: bool | None = None
  96. quiet_hours_start: str | None = None
  97. quiet_hours_end: str | None = None
  98. # Daily digest
  99. daily_digest_enabled: bool | None = None
  100. daily_digest_time: str | None = None
  101. # Printer filter
  102. printer_id: int | None = None
  103. class NotificationProviderResponse(NotificationProviderBase):
  104. """Schema for notification provider API responses."""
  105. id: int
  106. last_success: datetime | None = None
  107. last_error: str | None = None
  108. last_error_at: datetime | None = None
  109. created_at: datetime
  110. updated_at: datetime
  111. class Config:
  112. from_attributes = True
  113. class NotificationTestRequest(BaseModel):
  114. """Schema for testing notification configuration."""
  115. provider_type: ProviderType
  116. config: dict[str, Any]
  117. class NotificationTestResponse(BaseModel):
  118. """Schema for test notification response."""
  119. success: bool
  120. message: str
  121. # Provider-specific config schemas for documentation/validation reference
  122. class CallMeBotConfig(BaseModel):
  123. """CallMeBot/WhatsApp configuration."""
  124. phone: str = Field(..., description="Phone number with country code (e.g., +1234567890)")
  125. apikey: str = Field(..., description="API key from CallMeBot")
  126. class NtfyConfig(BaseModel):
  127. """ntfy configuration."""
  128. server: str = Field(default="https://ntfy.sh", description="ntfy server URL")
  129. topic: str = Field(..., description="Topic name to publish to")
  130. auth_token: str | None = Field(default=None, description="Optional authentication token")
  131. class PushoverConfig(BaseModel):
  132. """Pushover configuration."""
  133. user_key: str = Field(..., description="Your Pushover user key")
  134. app_token: str = Field(..., description="Your Pushover application token")
  135. priority: int = Field(default=0, ge=-2, le=2, description="Message priority (-2 to 2)")
  136. class TelegramConfig(BaseModel):
  137. """Telegram bot configuration."""
  138. bot_token: str = Field(..., description="Bot token from @BotFather")
  139. chat_id: str = Field(..., description="Chat ID to send messages to")
  140. class EmailConfig(BaseModel):
  141. """Email/SMTP configuration."""
  142. smtp_server: str = Field(..., description="SMTP server hostname")
  143. smtp_port: int = Field(default=587, description="SMTP port (587 for TLS, 465 for SSL)")
  144. username: str = Field(..., description="SMTP username/email")
  145. password: str = Field(..., description="SMTP password or app password")
  146. from_email: str = Field(..., description="From email address")
  147. to_email: str = Field(..., description="Recipient email address")
  148. use_tls: bool = Field(default=True, description="Use TLS encryption")
  149. # Notification Log schemas
  150. class NotificationLogResponse(BaseModel):
  151. """Schema for notification log API responses."""
  152. id: int
  153. provider_id: int
  154. provider_name: str | None = None
  155. provider_type: str | None = None
  156. event_type: str
  157. title: str
  158. message: str
  159. success: bool
  160. error_message: str | None = None
  161. printer_id: int | None = None
  162. printer_name: str | None = None
  163. created_at: datetime
  164. class Config:
  165. from_attributes = True
  166. class NotificationLogStats(BaseModel):
  167. """Statistics for notification logs."""
  168. total: int
  169. success_count: int
  170. failure_count: int
  171. by_event_type: dict[str, int]
  172. by_provider: dict[str, int]