notification_service.py 23 KB

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