notification_service.py 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534
  1. """Notification service for sending push notifications via various providers."""
  2. import json
  3. import logging
  4. import smtplib
  5. from datetime import datetime
  6. from email.mime.multipart import MIMEMultipart
  7. from email.mime.text import MIMEText
  8. from typing import Any
  9. from urllib.parse import quote
  10. import httpx
  11. from sqlalchemy import select
  12. from sqlalchemy.ext.asyncio import AsyncSession
  13. from backend.app.models.notification import NotificationProvider
  14. logger = logging.getLogger(__name__)
  15. class NotificationService:
  16. """Service for sending notifications through various providers."""
  17. def __init__(self):
  18. self._http_client: httpx.AsyncClient | None = None
  19. async def _get_client(self) -> httpx.AsyncClient:
  20. """Get or create HTTP client."""
  21. if self._http_client is None or self._http_client.is_closed:
  22. self._http_client = httpx.AsyncClient(timeout=30.0)
  23. return self._http_client
  24. async def close(self):
  25. """Close HTTP client."""
  26. if self._http_client and not self._http_client.is_closed:
  27. await self._http_client.aclose()
  28. def _is_in_quiet_hours(self, provider: NotificationProvider) -> bool:
  29. """Check if current time is within provider's quiet hours."""
  30. if not provider.quiet_hours_enabled:
  31. return False
  32. if not provider.quiet_hours_start or not provider.quiet_hours_end:
  33. return False
  34. try:
  35. now = datetime.now()
  36. current_time = now.hour * 60 + now.minute
  37. start_parts = provider.quiet_hours_start.split(":")
  38. end_parts = provider.quiet_hours_end.split(":")
  39. start_minutes = int(start_parts[0]) * 60 + int(start_parts[1])
  40. end_minutes = int(end_parts[0]) * 60 + int(end_parts[1])
  41. # Handle overnight quiet hours (e.g., 22:00 to 07:00)
  42. if start_minutes > end_minutes:
  43. # Quiet hours span midnight
  44. return current_time >= start_minutes or current_time < end_minutes
  45. else:
  46. # Same day quiet hours
  47. return start_minutes <= current_time < end_minutes
  48. except (ValueError, TypeError, AttributeError):
  49. logger.warning(f"Invalid quiet hours format for provider {provider.name}")
  50. return False
  51. def _format_duration(self, seconds: int | None) -> str:
  52. """Format duration in seconds to human-readable string."""
  53. if seconds is None:
  54. return "Unknown"
  55. hours = seconds // 3600
  56. minutes = (seconds % 3600) // 60
  57. if hours > 0:
  58. return f"{hours}h {minutes}m"
  59. return f"{minutes}m"
  60. def _build_print_start_message(self, printer_name: str, data: dict) -> tuple[str, str]:
  61. """Build notification message for print start event."""
  62. filename = data.get("filename", "Unknown")
  63. # Clean up filename
  64. if filename.endswith(".gcode.3mf"):
  65. filename = filename[:-10]
  66. elif filename.endswith(".3mf"):
  67. filename = filename[:-4]
  68. title = "Print Started"
  69. estimated_time = data.get("raw_data", {}).get("print", {}).get("mc_remaining_time")
  70. time_str = self._format_duration(estimated_time * 60 if estimated_time else None)
  71. message = f"{printer_name}: {filename}\nEstimated: {time_str}"
  72. return title, message
  73. def _build_print_complete_message(
  74. self, printer_name: str, status: str, data: dict, archive_data: dict | None = None
  75. ) -> tuple[str, str]:
  76. """Build notification message for print complete event."""
  77. filename = data.get("filename", "Unknown")
  78. if filename.endswith(".gcode.3mf"):
  79. filename = filename[:-10]
  80. elif filename.endswith(".3mf"):
  81. filename = filename[:-4]
  82. if status == "completed":
  83. title = "Print Completed"
  84. elif status == "failed":
  85. title = "Print Failed"
  86. elif status in ("aborted", "stopped", "cancelled"):
  87. title = "Print Stopped"
  88. else:
  89. title = "Print Ended"
  90. lines = [f"{printer_name}: {filename}"]
  91. if archive_data:
  92. # Add print time if available
  93. if archive_data.get("print_time_seconds"):
  94. lines.append(f"Time: {self._format_duration(archive_data['print_time_seconds'])}")
  95. # Add filament used if available
  96. if archive_data.get("actual_filament_grams"):
  97. lines.append(f"Filament: {archive_data['actual_filament_grams']:.1f}g")
  98. # Add failure reason if failed
  99. if status == "failed" and archive_data.get("failure_reason"):
  100. lines.append(f"Reason: {archive_data['failure_reason']}")
  101. message = "\n".join(lines)
  102. return title, message
  103. def _build_progress_message(
  104. self, printer_name: str, filename: str, progress: int
  105. ) -> tuple[str, str]:
  106. """Build notification message for print progress milestone."""
  107. if filename.endswith(".gcode.3mf"):
  108. filename = filename[:-10]
  109. elif filename.endswith(".3mf"):
  110. filename = filename[:-4]
  111. title = f"Print {progress}% Complete"
  112. message = f"{printer_name}: {filename}"
  113. return title, message
  114. def _build_printer_offline_message(self, printer_name: str) -> tuple[str, str]:
  115. """Build notification message for printer offline event."""
  116. title = "Printer Offline"
  117. message = f"{printer_name} has disconnected"
  118. return title, message
  119. def _build_printer_error_message(
  120. self, printer_name: str, error_type: str, error_detail: str | None = None
  121. ) -> tuple[str, str]:
  122. """Build notification message for printer error event."""
  123. title = f"Printer Error: {error_type}"
  124. message = f"{printer_name}"
  125. if error_detail:
  126. message += f"\n{error_detail}"
  127. return title, message
  128. def _build_filament_low_message(
  129. self, printer_name: str, slot: int, remaining_percent: int
  130. ) -> tuple[str, str]:
  131. """Build notification message for low filament event."""
  132. title = "Filament Low"
  133. message = f"{printer_name}: Slot {slot} at {remaining_percent}%"
  134. return title, message
  135. async def send_test_notification(
  136. self, provider_type: str, config: dict[str, Any]
  137. ) -> tuple[bool, str]:
  138. """Send a test notification to verify configuration."""
  139. title = "BambuTrack Test"
  140. message = "This is a test notification from BambuTrack. If you see this, notifications are working correctly!"
  141. try:
  142. if provider_type == "callmebot":
  143. return await self._send_callmebot(config, f"{title}\n{message}")
  144. elif provider_type == "ntfy":
  145. return await self._send_ntfy(config, title, message)
  146. elif provider_type == "pushover":
  147. return await self._send_pushover(config, title, message)
  148. elif provider_type == "telegram":
  149. return await self._send_telegram(config, f"*{title}*\n{message}")
  150. elif provider_type == "email":
  151. return await self._send_email(config, title, message)
  152. else:
  153. return False, f"Unknown provider type: {provider_type}"
  154. except Exception as e:
  155. logger.exception(f"Error sending test notification via {provider_type}")
  156. return False, str(e)
  157. async def _send_callmebot(self, config: dict, message: str) -> tuple[bool, str]:
  158. """Send notification via CallMeBot (WhatsApp)."""
  159. phone = config.get("phone", "").strip()
  160. apikey = config.get("apikey", "").strip()
  161. if not phone or not apikey:
  162. return False, "Phone number and API key are required"
  163. # URL encode the message
  164. encoded_message = quote(message)
  165. url = f"https://api.callmebot.com/whatsapp.php?phone={phone}&text={encoded_message}&apikey={apikey}"
  166. client = await self._get_client()
  167. response = await client.get(url)
  168. if response.status_code == 200:
  169. return True, "Message sent successfully"
  170. else:
  171. return False, f"HTTP {response.status_code}: {response.text[:200]}"
  172. async def _send_ntfy(self, config: dict, title: str, message: str) -> tuple[bool, str]:
  173. """Send notification via ntfy."""
  174. server = config.get("server", "https://ntfy.sh").rstrip("/")
  175. topic = config.get("topic", "").strip()
  176. auth_token = config.get("auth_token", "").strip()
  177. if not topic:
  178. return False, "Topic is required"
  179. url = f"{server}/{topic}"
  180. headers = {"Title": title}
  181. if auth_token:
  182. headers["Authorization"] = f"Bearer {auth_token}"
  183. client = await self._get_client()
  184. response = await client.post(url, content=message, headers=headers)
  185. if response.status_code in (200, 204):
  186. return True, "Message sent successfully"
  187. else:
  188. return False, f"HTTP {response.status_code}: {response.text[:200]}"
  189. async def _send_pushover(self, config: dict, title: str, message: str) -> tuple[bool, str]:
  190. """Send notification via Pushover."""
  191. user_key = config.get("user_key", "").strip()
  192. app_token = config.get("app_token", "").strip()
  193. priority = config.get("priority", 0)
  194. if not user_key or not app_token:
  195. return False, "User key and app token are required"
  196. url = "https://api.pushover.net/1/messages.json"
  197. data = {
  198. "token": app_token,
  199. "user": user_key,
  200. "title": title,
  201. "message": message,
  202. "priority": priority,
  203. }
  204. client = await self._get_client()
  205. response = await client.post(url, data=data)
  206. if response.status_code == 200:
  207. return True, "Message sent successfully"
  208. else:
  209. try:
  210. error_data = response.json()
  211. errors = error_data.get("errors", [])
  212. return False, f"Pushover error: {', '.join(errors)}"
  213. except Exception:
  214. return False, f"HTTP {response.status_code}: {response.text[:200]}"
  215. async def _send_telegram(self, config: dict, message: str) -> tuple[bool, str]:
  216. """Send notification via Telegram bot."""
  217. bot_token = config.get("bot_token", "").strip()
  218. chat_id = config.get("chat_id", "").strip()
  219. if not bot_token or not chat_id:
  220. return False, "Bot token and chat ID are required"
  221. url = f"https://api.telegram.org/bot{bot_token}/sendMessage"
  222. data = {
  223. "chat_id": chat_id,
  224. "text": message,
  225. "parse_mode": "Markdown",
  226. }
  227. client = await self._get_client()
  228. response = await client.post(url, json=data)
  229. if response.status_code == 200:
  230. result = response.json()
  231. if result.get("ok"):
  232. return True, "Message sent successfully"
  233. else:
  234. return False, f"Telegram error: {result.get('description', 'Unknown error')}"
  235. else:
  236. return False, f"HTTP {response.status_code}: {response.text[:200]}"
  237. async def _send_email(self, config: dict, subject: str, body: str) -> tuple[bool, str]:
  238. """Send notification via email (SMTP)."""
  239. smtp_server = config.get("smtp_server", "").strip()
  240. smtp_port = int(config.get("smtp_port", 587))
  241. username = config.get("username", "").strip()
  242. password = config.get("password", "").strip()
  243. from_email = config.get("from_email", "").strip()
  244. to_email = config.get("to_email", "").strip()
  245. # Security: "starttls" (port 587), "ssl" (port 465), "none" (port 25)
  246. security = config.get("security", "starttls")
  247. # Authentication: "true" or "false"
  248. auth_enabled = config.get("auth_enabled", "true").lower() == "true"
  249. if not all([smtp_server, from_email, to_email]):
  250. return False, "SMTP server, from email, and to email are required"
  251. if auth_enabled and not all([username, password]):
  252. return False, "Username and password are required when authentication is enabled"
  253. try:
  254. msg = MIMEMultipart()
  255. msg["From"] = from_email
  256. msg["To"] = to_email
  257. msg["Subject"] = f"[BambuTrack] {subject}"
  258. msg.attach(MIMEText(body, "plain"))
  259. if security == "ssl":
  260. # Direct SSL connection (typically port 465)
  261. server = smtplib.SMTP_SSL(smtp_server, smtp_port)
  262. elif security == "starttls":
  263. # STARTTLS upgrade (typically port 587)
  264. server = smtplib.SMTP(smtp_server, smtp_port)
  265. server.starttls()
  266. else:
  267. # No encryption (typically port 25) - use with caution
  268. server = smtplib.SMTP(smtp_server, smtp_port)
  269. if auth_enabled:
  270. server.login(username, password)
  271. server.sendmail(from_email, to_email, msg.as_string())
  272. server.quit()
  273. return True, "Email sent successfully"
  274. except smtplib.SMTPAuthenticationError:
  275. return False, "SMTP authentication failed - check username/password"
  276. except smtplib.SMTPException as e:
  277. return False, f"SMTP error: {str(e)}"
  278. except Exception as e:
  279. return False, f"Email error: {str(e)}"
  280. async def _send_to_provider(
  281. self, provider: NotificationProvider, title: str, message: str
  282. ) -> tuple[bool, str]:
  283. """Send notification to a specific provider."""
  284. # Check quiet hours
  285. if self._is_in_quiet_hours(provider):
  286. logger.info(f"Skipping notification to {provider.name} - quiet hours active")
  287. return True, "Skipped - quiet hours"
  288. config = json.loads(provider.config) if isinstance(provider.config, str) else provider.config
  289. try:
  290. if provider.provider_type == "callmebot":
  291. return await self._send_callmebot(config, f"{title}\n{message}")
  292. elif provider.provider_type == "ntfy":
  293. return await self._send_ntfy(config, title, message)
  294. elif provider.provider_type == "pushover":
  295. return await self._send_pushover(config, title, message)
  296. elif provider.provider_type == "telegram":
  297. return await self._send_telegram(config, f"*{title}*\n{message}")
  298. elif provider.provider_type == "email":
  299. return await self._send_email(config, title, message)
  300. else:
  301. return False, f"Unknown provider type: {provider.provider_type}"
  302. except Exception as e:
  303. logger.exception(f"Error sending notification via {provider.provider_type}")
  304. return False, str(e)
  305. async def _update_provider_status(
  306. self, db: AsyncSession, provider_id: int, success: bool, error: str | None = None
  307. ):
  308. """Update provider status after sending notification."""
  309. result = await db.execute(
  310. select(NotificationProvider).where(NotificationProvider.id == provider_id)
  311. )
  312. provider = result.scalar_one_or_none()
  313. if provider:
  314. if success:
  315. provider.last_success = datetime.utcnow()
  316. else:
  317. provider.last_error = error
  318. provider.last_error_at = datetime.utcnow()
  319. await db.commit()
  320. async def _get_providers_for_event(
  321. self,
  322. db: AsyncSession,
  323. event_field: str,
  324. printer_id: int | None = None,
  325. ) -> list[NotificationProvider]:
  326. """Get all enabled providers that want a specific event type."""
  327. # Build the query dynamically based on event field
  328. query = select(NotificationProvider).where(
  329. NotificationProvider.enabled == True,
  330. getattr(NotificationProvider, event_field) == True,
  331. )
  332. if printer_id is not None:
  333. query = query.where(
  334. (NotificationProvider.printer_id == None) | (NotificationProvider.printer_id == printer_id)
  335. )
  336. result = await db.execute(query)
  337. return list(result.scalars().all())
  338. async def _send_to_providers(
  339. self,
  340. providers: list[NotificationProvider],
  341. title: str,
  342. message: str,
  343. db: AsyncSession,
  344. ):
  345. """Send notification to multiple providers."""
  346. for provider in providers:
  347. try:
  348. success, error = await self._send_to_provider(provider, title, message)
  349. await self._update_provider_status(db, provider.id, success, error if not success else None)
  350. if success:
  351. logger.info(f"Sent notification via {provider.name}")
  352. else:
  353. logger.warning(f"Failed to send notification via {provider.name}: {error}")
  354. except Exception as e:
  355. logger.exception(f"Error sending notification via {provider.name}")
  356. await self._update_provider_status(db, provider.id, False, str(e))
  357. async def on_print_start(
  358. self, printer_id: int, printer_name: str, data: dict, db: AsyncSession
  359. ):
  360. """Handle print start event - send notifications to relevant providers."""
  361. logger.info(f"on_print_start called for printer {printer_id} ({printer_name})")
  362. providers = await self._get_providers_for_event(db, "on_print_start", printer_id)
  363. if not providers:
  364. logger.info(f"No notification providers configured for print_start event on printer {printer_id}")
  365. return
  366. logger.info(f"Found {len(providers)} providers for print_start: {[p.name for p in providers]}")
  367. title, message = self._build_print_start_message(printer_name, data)
  368. await self._send_to_providers(providers, title, message, db)
  369. async def on_print_complete(
  370. self,
  371. printer_id: int,
  372. printer_name: str,
  373. status: str,
  374. data: dict,
  375. db: AsyncSession,
  376. archive_data: dict | None = None,
  377. ):
  378. """Handle print complete event - send notifications to relevant providers."""
  379. logger.info(f"on_print_complete called for printer {printer_id} ({printer_name}), status={status}")
  380. # Determine which event type this is
  381. if status == "completed":
  382. event_field = "on_print_complete"
  383. elif status in ("failed",):
  384. event_field = "on_print_failed"
  385. elif status in ("aborted", "stopped", "cancelled"):
  386. event_field = "on_print_stopped"
  387. else:
  388. # Unknown status, default to on_print_complete
  389. logger.warning(f"Unknown print status '{status}', defaulting to on_print_complete")
  390. event_field = "on_print_complete"
  391. providers = await self._get_providers_for_event(db, event_field, printer_id)
  392. if not providers:
  393. logger.info(f"No notification providers configured for {event_field} event on printer {printer_id}")
  394. return
  395. logger.info(f"Found {len(providers)} providers for {event_field}: {[p.name for p in providers]}")
  396. title, message = self._build_print_complete_message(printer_name, status, data, archive_data)
  397. await self._send_to_providers(providers, title, message, db)
  398. async def on_print_progress(
  399. self,
  400. printer_id: int,
  401. printer_name: str,
  402. filename: str,
  403. progress: int,
  404. db: AsyncSession,
  405. ):
  406. """Handle print progress milestone (25%, 50%, 75%)."""
  407. providers = await self._get_providers_for_event(db, "on_print_progress", printer_id)
  408. if not providers:
  409. return
  410. title, message = self._build_progress_message(printer_name, filename, progress)
  411. await self._send_to_providers(providers, title, message, db)
  412. async def on_printer_offline(
  413. self, printer_id: int, printer_name: str, db: AsyncSession
  414. ):
  415. """Handle printer offline event."""
  416. providers = await self._get_providers_for_event(db, "on_printer_offline", printer_id)
  417. if not providers:
  418. return
  419. title, message = self._build_printer_offline_message(printer_name)
  420. await self._send_to_providers(providers, title, message, db)
  421. async def on_printer_error(
  422. self,
  423. printer_id: int,
  424. printer_name: str,
  425. error_type: str,
  426. db: AsyncSession,
  427. error_detail: str | None = None,
  428. ):
  429. """Handle printer error event (AMS issues, etc.)."""
  430. providers = await self._get_providers_for_event(db, "on_printer_error", printer_id)
  431. if not providers:
  432. return
  433. title, message = self._build_printer_error_message(printer_name, error_type, error_detail)
  434. await self._send_to_providers(providers, title, message, db)
  435. async def on_filament_low(
  436. self,
  437. printer_id: int,
  438. printer_name: str,
  439. slot: int,
  440. remaining_percent: int,
  441. db: AsyncSession,
  442. ):
  443. """Handle low filament event."""
  444. providers = await self._get_providers_for_event(db, "on_filament_low", printer_id)
  445. if not providers:
  446. return
  447. title, message = self._build_filament_low_message(printer_name, slot, remaining_percent)
  448. await self._send_to_providers(providers, title, message, db)
  449. # Global instance
  450. notification_service = NotificationService()