notification.py 7.6 KB

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