notification_service.py 94 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391
  1. """Notification service for sending push notifications via various providers."""
  2. import asyncio
  3. import html
  4. import json
  5. import logging
  6. import re
  7. import smtplib
  8. from datetime import datetime, timedelta, timezone
  9. from email.mime.image import MIMEImage
  10. from email.mime.multipart import MIMEMultipart
  11. from email.mime.text import MIMEText
  12. from typing import Any
  13. from urllib.parse import quote
  14. import httpx
  15. from sqlalchemy import select
  16. from sqlalchemy.ext.asyncio import AsyncSession
  17. from backend.app.models.notification import NotificationDigestQueue, NotificationLog, NotificationProvider
  18. from backend.app.models.notification_template import NotificationTemplate
  19. logger = logging.getLogger(__name__)
  20. # Honest User-Agent — matches the convention used by every other outbound
  21. # httpx client in the codebase (bambu_cloud, makerworld, firmware_check,
  22. # inventory). Previously this client leaked python-httpx/<version>, which
  23. # was both inconsistent with the rest of the project and a more obvious
  24. # bot signature for upstream WAFs.
  25. _USER_AGENT = "Bambuddy/1.0 (+https://github.com/maziggy/bambuddy)"
  26. def _looks_like_cloudflare_challenge(response: httpx.Response) -> bool:
  27. """Return True if ``response`` looks like a Cloudflare mitigation
  28. interstitial (JS challenge / managed challenge / block page) rather
  29. than a legitimate response passed through Cloudflare.
  30. Self-hosted servers behind Cloudflare (Tunnel, "Bot Fight Mode", or
  31. "Under Attack" mode) intercept non-browser clients at the edge and
  32. return a challenge HTML page instead of forwarding to the origin —
  33. so we never reach the user's actual ntfy / webhook backend.
  34. Cloudflare cannot be defeated from a Python client; the user has to
  35. add a security-skip rule on their side. We detect the shape so the
  36. UI can tell them that, instead of dumping the raw HTML.
  37. Detection deliberately does NOT rely on ``Server: cloudflare`` alone
  38. — Cloudflare adds that header to every response it proxies (success
  39. AND legitimate origin errors), so a real 401 "wrong token" from a
  40. CF-fronted ntfy would false-positive into a misleading "your CF is
  41. blocking" message. Reliable signals: the ``cf-mitigated`` header
  42. (set only when CF actively mitigates) and the challenge body shape.
  43. """
  44. if response.headers.get("cf-mitigated"):
  45. return True
  46. content_type = (response.headers.get("content-type") or "").lower()
  47. if "html" not in content_type:
  48. return False
  49. body = (response.text or "")[:1024].lower()
  50. # "Just a moment..." is Cloudflare's universal challenge-page title
  51. # (managed challenge, JS challenge, Under Attack mode). Combined with
  52. # an HTML content-type this is unambiguous — no legitimate ntfy or
  53. # webhook backend returns HTML with that title. ``cf-chl-*`` and
  54. # ``challenge-platform`` cover newer / non-default CF templates.
  55. return "just a moment" in body or "cf-chl-bypass" in body or "cf-chl-opt" in body or "challenge-platform" in body
  56. def _assert_safe_provider_url(url: str, *, label: str) -> str | None:
  57. """Validate a provider URL taken from user-supplied config.
  58. Returns an error message on rejection, or None when the URL is
  59. acceptable — the ``_send_*`` methods return ``tuple[bool, str]`` rather
  60. than raising, so a message is more useful here than an exception.
  61. Uses the LAN-service policy: self-hosting ntfy, Bark, Gotify or a webhook
  62. receiver on the home LAN is normal and must keep working, so loopback and
  63. RFC-1918 stay permitted. Cloud-metadata endpoints, numeric-encoded IPs and
  64. non-HTTP schemes are rejected.
  65. """
  66. from backend.app.api.routes._url_safety import assert_safe_lan_service_url
  67. try:
  68. assert_safe_lan_service_url(url, label=label)
  69. except ValueError as exc:
  70. return str(exc)
  71. return None
  72. def _opaque_http_failure(response: httpx.Response, *, label: str) -> str:
  73. """Failure message for a provider whose destination host the user supplies.
  74. The response body is deliberately **not** returned to the caller. Provider
  75. URLs are configurable by anyone holding ``NOTIFICATIONS_CREATE`` — which
  76. the default Operators group carries and which does not imply
  77. ``SETTINGS_UPDATE`` — and ``POST /notifications/test-config`` accepts a URL
  78. straight from the request body without persisting anything. Echoing the
  79. response body there turned an intended "does my webhook work?" check into
  80. an authenticated read primitive against any host the Bambuddy process can
  81. reach, including services that are not exposed to the network at all.
  82. Providers whose host Bambuddy hardcodes (Pushover, Telegram, CallMeBot)
  83. keep returning the upstream body — there is no trust boundary to cross
  84. when the destination cannot be influenced.
  85. The body is logged at debug level, where it stays available to whoever
  86. already administers the host without being handed back over the API.
  87. """
  88. logger.debug(
  89. "%s delivery failed with HTTP %s; body: %s",
  90. label,
  91. response.status_code,
  92. (response.text or "")[:200],
  93. )
  94. return f"HTTP {response.status_code} from the configured {label} (see server logs at debug level for details)"
  95. class NotificationService:
  96. """Service for sending notifications through various providers."""
  97. def __init__(self):
  98. self._http_client: httpx.AsyncClient | None = None
  99. self._template_cache: dict[str, NotificationTemplate] = {}
  100. self._digest_scheduler_task: asyncio.Task | None = None
  101. self._last_digest_check: str = "" # "HH:MM" to avoid duplicate checks
  102. async def _get_client(self) -> httpx.AsyncClient:
  103. """Get or create HTTP client.
  104. The connect timeout is deliberately far shorter than the rest. A flat
  105. 30 s meant that when a site's internet went down, every alarm spent a
  106. full 30 s inside ``connect`` — longer than SQLite's 15 s
  107. ``busy_timeout`` — and any other task that wanted to write during that
  108. window failed with "database is locked" (#2770). Reaching a host either
  109. works in a couple of seconds or is not going to; sending the body is the
  110. part that legitimately takes time, so read/write keep the old 30 s and
  111. an image upload on a slow uplink is unaffected.
  112. """
  113. if self._http_client is None or self._http_client.is_closed:
  114. self._http_client = httpx.AsyncClient(
  115. timeout=httpx.Timeout(30.0, connect=5.0),
  116. headers={"User-Agent": _USER_AGENT},
  117. )
  118. return self._http_client
  119. async def close(self):
  120. """Close HTTP client."""
  121. if self._http_client and not self._http_client.is_closed:
  122. await self._http_client.aclose()
  123. def _is_in_quiet_hours(self, provider: NotificationProvider) -> bool:
  124. """Check if current time is within provider's quiet hours."""
  125. if not provider.quiet_hours_enabled:
  126. return False
  127. if not provider.quiet_hours_start or not provider.quiet_hours_end:
  128. return False
  129. try:
  130. now = datetime.now()
  131. current_time = now.hour * 60 + now.minute
  132. start_parts = provider.quiet_hours_start.split(":")
  133. end_parts = provider.quiet_hours_end.split(":")
  134. start_minutes = int(start_parts[0]) * 60 + int(start_parts[1])
  135. end_minutes = int(end_parts[0]) * 60 + int(end_parts[1])
  136. # Handle overnight quiet hours (e.g., 22:00 to 07:00)
  137. if start_minutes > end_minutes:
  138. # Quiet hours span midnight
  139. return current_time >= start_minutes or current_time < end_minutes
  140. else:
  141. # Same day quiet hours
  142. return start_minutes <= current_time < end_minutes
  143. except (ValueError, TypeError, AttributeError):
  144. logger.warning("Invalid quiet hours format for provider %s", provider.name)
  145. return False
  146. async def _get_template(self, db: AsyncSession, event_type: str) -> NotificationTemplate | None:
  147. """Get a notification template by event type.
  148. ``no_autoflush`` for the same reason as ``_get_providers_for_event``:
  149. this read runs before the provider is contacted, and must not be the
  150. thing that opens a write transaction on the caller's session (#2770).
  151. """
  152. # Check cache first
  153. if event_type in self._template_cache:
  154. return self._template_cache[event_type]
  155. with db.no_autoflush:
  156. result = await db.execute(select(NotificationTemplate).where(NotificationTemplate.event_type == event_type))
  157. template = result.scalar_one_or_none()
  158. if template:
  159. self._template_cache[event_type] = template
  160. return template
  161. def _render_template(self, template_str: str, variables: dict[str, Any]) -> str:
  162. """Render a template string with variables. Missing variables become empty."""
  163. result = template_str
  164. for key, value in variables.items():
  165. result = result.replace("{" + key + "}", str(value) if value is not None else "")
  166. # Remove any remaining unreplaced placeholders
  167. result = re.sub(r"\{[a-z_]+\}", "", result)
  168. return result
  169. async def _format_eta(self, seconds: int | None, db: AsyncSession) -> str:
  170. """Format ETA as wall-clock time, respecting user's time_format setting."""
  171. if not seconds or seconds <= 0:
  172. return "Unknown"
  173. from backend.app.api.routes.settings import get_setting
  174. eta_time = datetime.now() + timedelta(seconds=seconds)
  175. time_format = await get_setting(db, "time_format")
  176. if time_format == "12h":
  177. return eta_time.strftime("%I:%M %p").lstrip("0")
  178. # Default to 24h for "24h", "system", or unset
  179. return eta_time.strftime("%H:%M")
  180. def _format_duration(self, seconds: int | None) -> str:
  181. """Format duration in seconds to human-readable string."""
  182. if seconds is None:
  183. return "Unknown"
  184. hours = seconds // 3600
  185. minutes = (seconds % 3600) // 60
  186. if hours > 0:
  187. return f"{hours}h {minutes}m"
  188. return f"{minutes}m"
  189. def _clean_filename(self, filename: str) -> str:
  190. """Extract filename and remove file extensions."""
  191. import os
  192. # Strip path prefix (e.g., /data/Metadata/plate_5.gcode -> plate_5.gcode)
  193. filename = os.path.basename(filename)
  194. # Remove common extensions
  195. if filename.endswith(".gcode.3mf"):
  196. return filename[:-10]
  197. elif filename.endswith(".gcode"):
  198. return filename[:-6]
  199. elif filename.endswith(".3mf"):
  200. return filename[:-4]
  201. return filename
  202. async def _build_message_from_template(
  203. self, db: AsyncSession, event_type: str, variables: dict[str, Any]
  204. ) -> tuple[str, str]:
  205. """Build notification title and body from template."""
  206. # Add common variables
  207. variables["timestamp"] = datetime.now().strftime("%Y-%m-%d %H:%M")
  208. variables["app_name"] = "Bambuddy"
  209. template = await self._get_template(db, event_type)
  210. if not template:
  211. # Fallback to simple message
  212. logger.warning("Template not found for event type: %s", event_type)
  213. return event_type.replace("_", " ").title(), str(variables)
  214. title = self._render_template(template.title_template, variables)
  215. body = self._render_template(template.body_template, variables)
  216. return title, body
  217. async def send_test_notification(
  218. self, provider_type: str, config: dict[str, Any], db: AsyncSession | None = None
  219. ) -> tuple[bool, str]:
  220. """Send a test notification to verify configuration."""
  221. if db:
  222. title, message = await self._build_message_from_template(db, "test", {})
  223. else:
  224. title = "Bambuddy Test"
  225. message = "This is a test notification. If you see this, notifications are working!"
  226. try:
  227. if provider_type == "callmebot":
  228. return await self._send_callmebot(config, f"{title}\n{message}")
  229. elif provider_type == "ntfy":
  230. return await self._send_ntfy(config, title, message)
  231. elif provider_type == "pushover":
  232. return await self._send_pushover(config, title, message)
  233. elif provider_type == "telegram":
  234. return await self._send_telegram(config, f"*{title}*\n{message}")
  235. elif provider_type == "email":
  236. return await self._send_email(config, title, message)
  237. elif provider_type == "discord":
  238. return await self._send_discord(config, title, message)
  239. elif provider_type == "webhook":
  240. return await self._send_webhook(config, title, message)
  241. elif provider_type == "homeassistant":
  242. return await self._send_homeassistant(config, title, message, db=db)
  243. elif provider_type == "bark":
  244. return await self._send_bark(config, title, message)
  245. else:
  246. return False, f"Unknown provider type: {provider_type}"
  247. except Exception as e:
  248. logger.exception("Error sending test notification via %s", provider_type)
  249. return False, str(e)
  250. async def _send_callmebot(self, config: dict, message: str) -> tuple[bool, str]:
  251. """Send notification via CallMeBot (WhatsApp)."""
  252. phone = config.get("phone", "").strip()
  253. apikey = config.get("apikey", "").strip()
  254. if not phone or not apikey:
  255. return False, "Phone number and API key are required"
  256. # URL encode the message
  257. encoded_message = quote(message)
  258. url = f"https://api.callmebot.com/whatsapp.php?phone={phone}&text={encoded_message}&apikey={apikey}"
  259. client = await self._get_client()
  260. response = await client.get(url)
  261. if response.status_code == 200:
  262. return True, "Message sent successfully"
  263. else:
  264. return False, f"HTTP {response.status_code}: {response.text[:200]}"
  265. async def _send_bark(self, config: dict, title: str, message: str) -> tuple[bool, str]:
  266. """Send notification via Bark, the self-hostable iOS push service (#1495).
  267. POSTs JSON to {server}/push. Defaults to the official api.day.app
  268. relay; a self-hosted bark-server works by overriding the server URL.
  269. """
  270. server = (config.get("server") or "https://api.day.app").strip().rstrip("/")
  271. device_key = (config.get("device_key") or "").strip()
  272. if not device_key:
  273. return False, "Device key is required"
  274. url_error = _assert_safe_provider_url(server, label="Bark server URL")
  275. if url_error:
  276. return False, url_error
  277. payload: dict[str, Any] = {
  278. "device_key": device_key,
  279. "title": title,
  280. "body": message,
  281. }
  282. group = (config.get("group") or "").strip()
  283. if group:
  284. payload["group"] = group
  285. sound = (config.get("sound") or "").strip()
  286. if sound:
  287. payload["sound"] = sound
  288. level = (config.get("level") or "").strip()
  289. if level in ("active", "timeSensitive", "critical", "passive"):
  290. payload["level"] = level
  291. client = await self._get_client()
  292. response = await client.post(f"{server}/push", json=payload)
  293. if response.status_code == 200:
  294. # bark-server can report failures inside an HTTP 200 body
  295. # ({"code": 400, "message": ...}), so the status alone isn't proof.
  296. try:
  297. body = response.json()
  298. except ValueError:
  299. body = None
  300. if isinstance(body, dict) and body.get("code") not in (200, None):
  301. # Only the numeric code is echoed. A server chosen by the caller
  302. # controls this body too, so the free-text message is a (narrow)
  303. # read channel of the same kind _opaque_http_failure closes.
  304. logger.debug("Bark reported error %s: %s", body.get("code"), str(body.get("message"))[:200])
  305. return False, f"Bark error {body.get('code')} (see server logs at debug level for details)"
  306. return True, "Message sent successfully"
  307. return False, _opaque_http_failure(response, label="Bark server")
  308. async def _send_ntfy(
  309. self,
  310. config: dict,
  311. title: str,
  312. message: str,
  313. image_data: bytes | None = None,
  314. event_type: str | None = None,
  315. ) -> tuple[bool, str]:
  316. """Send notification via ntfy."""
  317. server = config.get("server", "https://ntfy.sh").rstrip("/")
  318. topic = config.get("topic", "").strip()
  319. auth_token = config.get("auth_token", "").strip()
  320. if not topic:
  321. return False, "Topic is required"
  322. url_error = _assert_safe_provider_url(server, label="ntfy server URL")
  323. if url_error:
  324. return False, url_error
  325. url = f"{server}/{topic}"
  326. # ntfy reads Title/Message from HTTP headers. httpx enforces ASCII
  327. # for str header values, but printer names and filenames can contain
  328. # non-ASCII characters (e.g. accented letters, CJK). Passing bytes
  329. # bypasses the ASCII check — ntfy handles UTF-8 headers correctly.
  330. headers: dict[str, str | bytes] = {"Title": title.encode("utf-8")}
  331. # Per-event Priority header (#990). Only set when the user has
  332. # explicitly mapped this event to a 1-5 value; otherwise fall through
  333. # to the ntfy server's default so existing setups stay unchanged.
  334. event_priorities = config.get("event_priorities") or {}
  335. if event_type and isinstance(event_priorities, dict):
  336. raw = event_priorities.get(event_type)
  337. try:
  338. priority = int(raw) if raw is not None else None
  339. except (TypeError, ValueError):
  340. priority = None
  341. if priority is not None and 1 <= priority <= 5:
  342. headers["Priority"] = str(priority)
  343. if auth_token:
  344. headers["Authorization"] = f"Bearer {auth_token}"
  345. client = await self._get_client()
  346. if image_data:
  347. # ntfy supports image attachments via multipart form-data.
  348. # HTTP headers cannot contain newlines, but ntfy interprets
  349. # literal \n (backslash-n) as newlines in the Message header.
  350. headers["Filename"] = "photo.jpg"
  351. headers["Message"] = message.replace("\n", "\\n").encode("utf-8")
  352. response = await client.put(url, content=image_data, headers=headers)
  353. if response.status_code == 400 and "attachments not allowed" in response.text:
  354. # Server has attachments disabled — retry without the image
  355. headers.pop("Filename", None)
  356. headers.pop("Message", None)
  357. response = await client.post(url, content=message.encode("utf-8"), headers=headers)
  358. else:
  359. response = await client.post(url, content=message.encode("utf-8"), headers=headers)
  360. if response.status_code in (200, 204):
  361. return True, "Message sent successfully"
  362. if _looks_like_cloudflare_challenge(response):
  363. return False, (
  364. f"HTTP {response.status_code} — ntfy server is behind a Cloudflare "
  365. "challenge. Bambuddy was served the JS challenge page instead of "
  366. "reaching ntfy. Cloudflare cannot be solved from a backend; add a "
  367. "Cloudflare security-skip rule for this hostname, disable Bot "
  368. "Fight Mode, or front the server with Cloudflare Access using a "
  369. "service token. (#1534)"
  370. )
  371. return False, _opaque_http_failure(response, label="ntfy server")
  372. async def _send_pushover(
  373. self, config: dict, title: str, message: str, image_data: bytes | None = None
  374. ) -> tuple[bool, str]:
  375. """Send notification via Pushover.
  376. Args:
  377. config: Provider configuration with user_key, app_token, priority
  378. title: Notification title
  379. message: Notification body
  380. image_data: Optional JPEG image bytes to attach (max 2.5MB)
  381. """
  382. user_key = config.get("user_key", "").strip()
  383. app_token = config.get("app_token", "").strip()
  384. try:
  385. priority = int(config.get("priority", 0))
  386. except (TypeError, ValueError):
  387. priority = 0
  388. if not user_key or not app_token:
  389. return False, "User key and app token are required"
  390. url = "https://api.pushover.net/1/messages.json"
  391. data = {
  392. "token": app_token,
  393. "user": user_key,
  394. "title": title,
  395. "message": message,
  396. "priority": priority,
  397. }
  398. # Emergency priority (2) keeps re-alerting until acknowledged, so
  399. # Pushover *requires* retry (how often, >= 30s) and expire (when to
  400. # give up, <= 10800s). Without them the API rejects the message. Only
  401. # send them at priority 2 — Pushover ignores them at other priorities.
  402. if priority == 2:
  403. try:
  404. retry = int(config.get("retry", 60))
  405. except (TypeError, ValueError):
  406. retry = 60
  407. try:
  408. expire = int(config.get("expire", 3600))
  409. except (TypeError, ValueError):
  410. expire = 3600
  411. data["retry"] = max(30, min(retry, 10800))
  412. data["expire"] = max(30, min(expire, 10800))
  413. client = await self._get_client()
  414. if image_data:
  415. # Pushover supports image attachments via multipart form-data
  416. files = {"attachment": ("photo.jpg", image_data, "image/jpeg")}
  417. response = await client.post(url, data=data, files=files)
  418. else:
  419. response = await client.post(url, data=data)
  420. if response.status_code == 200:
  421. return True, "Message sent successfully"
  422. else:
  423. try:
  424. error_data = response.json()
  425. errors = error_data.get("errors", [])
  426. return False, f"Pushover error: {', '.join(errors)}"
  427. except Exception:
  428. return False, f"HTTP {response.status_code}: {response.text[:200]}"
  429. async def _send_telegram(self, config: dict, message: str, image_data: bytes | None = None) -> tuple[bool, str]:
  430. """Send notification via Telegram bot."""
  431. bot_token = config.get("bot_token", "").strip()
  432. chat_id = config.get("chat_id", "").strip()
  433. if not bot_token or not chat_id:
  434. return False, "Bot token and chat ID are required"
  435. # Optional forum topic (#1518). Telegram expects message_thread_id as an
  436. # integer in the JSON sendMessage body — a string 400s there even though
  437. # the multipart sendPhoto call below would happily accept one. Coerce it
  438. # once, up front, so both call sites agree and a bad value fails loudly
  439. # instead of silently breaking only the text notifications.
  440. thread_id_raw = str(config.get("message_thread_id") or "").strip()
  441. message_thread_id: int | None = None
  442. if thread_id_raw:
  443. try:
  444. message_thread_id = int(thread_id_raw)
  445. except ValueError:
  446. return False, f"Invalid message thread ID: {thread_id_raw!r} is not a number"
  447. # Escape underscores in the message body so Telegram Markdown
  448. # parsing doesn't break on job names like "A1_plate_8" or error
  449. # codes like "0300_0001". The title is already wrapped in *bold*
  450. # markers, so only escape after the first newline.
  451. if "\n" in message:
  452. title_part, body_part = message.split("\n", 1)
  453. body_part = body_part.replace("_", "\\_")
  454. message = f"{title_part}\n{body_part}"
  455. client = await self._get_client()
  456. if image_data:
  457. # Use sendPhoto to attach the thumbnail with the caption
  458. url = f"https://api.telegram.org/bot{bot_token}/sendPhoto"
  459. form: dict[str, Any] = {"chat_id": chat_id, "caption": message, "parse_mode": "Markdown"}
  460. if message_thread_id is not None:
  461. form["message_thread_id"] = message_thread_id
  462. response = await client.post(
  463. url,
  464. data=form,
  465. files={"photo": ("photo.jpg", image_data, "image/jpeg")},
  466. )
  467. else:
  468. url = f"https://api.telegram.org/bot{bot_token}/sendMessage"
  469. data: dict[str, Any] = {
  470. "chat_id": chat_id,
  471. "text": message,
  472. "parse_mode": "Markdown",
  473. }
  474. if message_thread_id is not None:
  475. data["message_thread_id"] = message_thread_id
  476. response = await client.post(url, json=data)
  477. if response.status_code == 200:
  478. result = response.json()
  479. if result.get("ok"):
  480. return True, "Message sent successfully"
  481. else:
  482. return False, f"Telegram error: {result.get('description', 'Unknown error')}"
  483. else:
  484. return False, f"HTTP {response.status_code}: {response.text[:200]}"
  485. async def _send_email(
  486. self,
  487. config: dict,
  488. subject: str,
  489. body: str,
  490. image_data: bytes | None = None,
  491. finish_photo_url: str | None = None,
  492. ) -> tuple[bool, str]:
  493. """Send notification via email (SMTP).
  494. Inline finish-photo embed is opt-in via the template: when the rendered
  495. ``body`` contains the substituted ``{finish_photo_url}`` value AND the
  496. finish-photo bytes are present, the message is built as
  497. ``multipart/related`` wrapping a ``multipart/alternative`` (plain + HTML)
  498. plus an inline ``MIMEImage`` with ``Content-ID: <bambuddy-finish-photo>``.
  499. The HTML part replaces the URL with ``<img src="cid:...">``; the plain-
  500. text part keeps the URL as a clickable link. When the template doesn't
  501. reference ``{finish_photo_url}`` (or image bytes aren't available), the
  502. original single-part text shape is used — no attachment, no surprise
  503. inline image (#1792).
  504. """
  505. smtp_server = config.get("smtp_server", "").strip()
  506. smtp_port = int(config.get("smtp_port", 587))
  507. username = config.get("username", "").strip()
  508. password = config.get("password", "").strip()
  509. from_email = config.get("from_email", "").strip()
  510. to_email = config.get("to_email", "").strip()
  511. # Security: "starttls" (port 587), "ssl" (port 465), "none" (port 25)
  512. security = config.get("security", "starttls")
  513. # Authentication: "true" or "false"
  514. auth_enabled = config.get("auth_enabled", "true").lower() == "true"
  515. if not all([smtp_server, from_email, to_email]):
  516. return False, "SMTP server, from email, and to email are required"
  517. if auth_enabled and not all([username, password]):
  518. return False, "Username and password are required when authentication is enabled"
  519. # Template-driven: only inline-embed when the user's template explicitly
  520. # referenced {finish_photo_url} (so the URL appears in the rendered body)
  521. # AND the photo bytes are available. Falls back to text-only otherwise.
  522. inline_photo = bool(image_data and finish_photo_url and finish_photo_url in body)
  523. try:
  524. if inline_photo:
  525. # multipart/related → (multipart/alternative → text, html) + inline image
  526. msg = MIMEMultipart("related")
  527. msg["From"] = from_email
  528. msg["To"] = to_email
  529. msg["Subject"] = f"[Bambuddy] {subject}"
  530. alt = MIMEMultipart("alternative")
  531. alt.attach(MIMEText(body, "plain"))
  532. # Build HTML body: escape the rendered body, then swap the
  533. # escaped URL substring for an inline <img> referencing the
  534. # MIMEImage we attach below. Done AFTER escape so the cid: URL
  535. # we inject isn't re-escaped.
  536. escaped_body = html.escape(body).replace("\n", "<br>\n")
  537. escaped_url = html.escape(finish_photo_url)
  538. img_tag = (
  539. '<img src="cid:bambuddy-finish-photo" '
  540. 'alt="Printer camera snapshot" '
  541. 'style="max-width:100%;height:auto;border:1px solid #ddd;border-radius:4px;">'
  542. )
  543. html_body = f"<html><body><p>{escaped_body.replace(escaped_url, img_tag)}</p></body></html>"
  544. alt.attach(MIMEText(html_body, "html"))
  545. msg.attach(alt)
  546. img = MIMEImage(image_data, _subtype="jpeg")
  547. # Angle-bracketed Content-ID per RFC 2392, referenced from HTML
  548. # without the brackets via ``cid:bambuddy-finish-photo``.
  549. img.add_header("Content-ID", "<bambuddy-finish-photo>")
  550. img.add_header("Content-Disposition", "inline", filename="finish-photo.jpg")
  551. msg.attach(img)
  552. else:
  553. msg = MIMEMultipart()
  554. msg["From"] = from_email
  555. msg["To"] = to_email
  556. msg["Subject"] = f"[Bambuddy] {subject}"
  557. msg.attach(MIMEText(body, "plain"))
  558. # smtplib is synchronous and blocking: a wedged / greylisting /
  559. # firewall-dropped relay leaves recv() stuck. Two problems, two
  560. # fixes (#2572):
  561. # 1. No timeout — smtplib defaults to the global socket timeout,
  562. # which this app never sets, so a stuck relay blocks forever.
  563. # Pass an explicit timeout to every connect.
  564. # 2. Run on the event loop — a stuck (or merely slow) send freezes
  565. # every other coroutine, including a DB session a caller is
  566. # holding open across this notification. Offload to a worker
  567. # thread so the loop stays live and the connection is released
  568. # on schedule.
  569. smtp_timeout = 30.0
  570. msg_str = msg.as_string()
  571. def _blocking_send() -> None:
  572. if security == "ssl":
  573. # Direct SSL connection (typically port 465)
  574. server = smtplib.SMTP_SSL(smtp_server, smtp_port, timeout=smtp_timeout)
  575. elif security == "starttls":
  576. # STARTTLS upgrade (typically port 587)
  577. server = smtplib.SMTP(smtp_server, smtp_port, timeout=smtp_timeout)
  578. server.starttls()
  579. else:
  580. # No encryption (typically port 25) - use with caution
  581. server = smtplib.SMTP(smtp_server, smtp_port, timeout=smtp_timeout)
  582. try:
  583. if auth_enabled:
  584. server.login(username, password)
  585. server.sendmail(from_email, to_email, msg_str)
  586. finally:
  587. # quit() in finally so a send error doesn't leak the socket.
  588. try:
  589. server.quit()
  590. except Exception: # noqa: BLE001 — closing a broken connection is best-effort
  591. pass
  592. await asyncio.to_thread(_blocking_send)
  593. return True, "Email sent successfully"
  594. except smtplib.SMTPAuthenticationError:
  595. return False, "SMTP authentication failed - check username/password"
  596. except smtplib.SMTPException as e:
  597. return False, f"SMTP error: {str(e)}"
  598. except Exception as e:
  599. return False, f"Email error: {str(e)}"
  600. async def _send_discord(
  601. self, config: dict, title: str, message: str, image_data: bytes | None = None
  602. ) -> tuple[bool, str]:
  603. """Send notification via Discord webhook."""
  604. webhook_url = config.get("webhook_url", "").strip()
  605. if not webhook_url:
  606. return False, "Webhook URL is required"
  607. if not (
  608. webhook_url.startswith("https://discord.com/api/webhooks/")
  609. or webhook_url.startswith("https://discordapp.com/api/webhooks/")
  610. ):
  611. return False, "Invalid Discord webhook URL"
  612. # Discord embed format for nicer messages
  613. embed = {
  614. "title": title,
  615. "description": message,
  616. "color": 0x00AE42, # Bambu green
  617. }
  618. client = await self._get_client()
  619. if image_data:
  620. # Attach image via multipart form-data and reference in embed
  621. embed["image"] = {"url": "attachment://photo.jpg"}
  622. payload = {"embeds": [embed]}
  623. response = await client.post(
  624. webhook_url,
  625. data={"payload_json": json.dumps(payload)},
  626. files={"files[0]": ("photo.jpg", image_data, "image/jpeg")},
  627. )
  628. else:
  629. response = await client.post(webhook_url, json={"embeds": [embed]})
  630. if response.status_code in (200, 204):
  631. return True, "Message sent successfully"
  632. else:
  633. return False, f"HTTP {response.status_code}: {response.text[:200]}"
  634. async def _send_webhook(
  635. self,
  636. config: dict,
  637. title: str,
  638. message: str,
  639. image_data: bytes | None = None,
  640. event_type: str | None = None,
  641. variables: dict | None = None,
  642. ) -> tuple[bool, str]:
  643. """Send notification via generic webhook (POST JSON).
  644. Supports two payload formats:
  645. - generic: Custom field names with timestamp/source metadata + structured event data
  646. - slack: Slack/Mattermost compatible format (just {"text": "..."})
  647. """
  648. webhook_url = config.get("webhook_url", "").strip()
  649. auth_header = config.get("auth_header", "").strip()
  650. payload_format = config.get("payload_format", "generic").strip()
  651. if not webhook_url:
  652. return False, "Webhook URL is required"
  653. url_error = _assert_safe_provider_url(webhook_url, label="Webhook URL")
  654. if url_error:
  655. return False, url_error
  656. # Build payload based on format
  657. if payload_format == "slack":
  658. # Slack/Mattermost format - just text field
  659. data = {"text": f"*{title}*\n{message}"}
  660. else:
  661. # Generic format with custom field names
  662. custom_field_title = config.get("field_title", "title").strip() or "title"
  663. custom_field_message = config.get("field_message", "message").strip() or "message"
  664. data = {
  665. custom_field_title: title,
  666. custom_field_message: message,
  667. "timestamp": datetime.now().isoformat(),
  668. "source": "Bambuddy",
  669. }
  670. # For generic format, include structured event data for automation tools
  671. if payload_format != "slack":
  672. if event_type:
  673. data["event"] = event_type
  674. if variables:
  675. for key, value in variables.items():
  676. if key not in data: # Don't overwrite title/message/timestamp/source
  677. data[key] = value
  678. # Attach base64-encoded image when available (generic format only)
  679. if image_data and payload_format != "slack":
  680. import base64
  681. data["image"] = base64.b64encode(image_data).decode("ascii")
  682. headers = {"Content-Type": "application/json"}
  683. if auth_header:
  684. # Support "Bearer token" or just "token" format
  685. if " " in auth_header:
  686. headers["Authorization"] = auth_header
  687. else:
  688. headers["Authorization"] = f"Bearer {auth_header}"
  689. client = await self._get_client()
  690. try:
  691. response = await client.post(webhook_url, json=data, headers=headers)
  692. if response.status_code in (200, 201, 202, 204):
  693. return True, "Webhook delivered successfully"
  694. else:
  695. return False, _opaque_http_failure(response, label="webhook endpoint")
  696. except Exception as e:
  697. return False, f"Webhook error: {str(e)}"
  698. async def _send_homeassistant(
  699. self, config: dict, title: str, message: str, db: AsyncSession | None = None
  700. ) -> tuple[bool, str]:
  701. """Send notification via Home Assistant.
  702. Uses the globally configured HA URL/token from settings.
  703. Defaults to persistent_notification/create, but supports
  704. custom services via config["service"] (e.g. notify.mobile_app_myphone).
  705. """
  706. # Get HA connection settings from global config
  707. ha_url = ""
  708. ha_token = ""
  709. if db:
  710. from backend.app.api.routes.settings import get_homeassistant_settings
  711. try:
  712. ha_settings = await get_homeassistant_settings(db)
  713. ha_url = ha_settings.get("ha_url", "")
  714. ha_token = ha_settings.get("ha_token", "")
  715. except Exception as e:
  716. logger.warning("Failed to read HA settings from database: %s", e)
  717. else:
  718. # Fallback: read directly from environment if no DB session
  719. import os
  720. ha_url = os.environ.get("HA_URL", "")
  721. ha_token = os.environ.get("HA_TOKEN", "")
  722. if not ha_url or not ha_token:
  723. return False, (
  724. "Home Assistant is not configured. Please set HA URL and token in Settings → Network → Home Assistant."
  725. )
  726. # Determine which HA service to call - Default: persistent_notification.create
  727. service = (config.get("service") or "").strip()
  728. if service:
  729. # Allow in different forms:
  730. # - notify.mobile_app_<device>
  731. # - notify/mobile_app_<device>
  732. # - api/services/notify/mobile_app_<device>
  733. service_str = service.lstrip("/")
  734. if service_str.startswith("api/services/"):
  735. endpoint = service_str
  736. elif "/" in service_str:
  737. endpoint = f"api/services/{service_str}"
  738. elif "." in service_str:
  739. domain, svc = service_str.split(".", 1)
  740. endpoint = f"api/services/{domain}/{svc}"
  741. else:
  742. return False, (
  743. "Invalid Home Assistant service name. Use e.g. 'notify.mobile_app_yourdevice' or 'notify/your_service'."
  744. )
  745. if not re.match(r"^api/services/[a-zA-Z0-9_]+/[a-zA-Z0-9_]+$", endpoint):
  746. return False, (
  747. "Invalid Home Assistant service name. Domain and service must only contain letters, numbers, and underscores."
  748. )
  749. else:
  750. endpoint = "api/services/persistent_notification/create"
  751. url = f"{ha_url.rstrip('/')}/{endpoint}"
  752. headers = {
  753. "Authorization": f"Bearer {ha_token}",
  754. "Content-Type": "application/json",
  755. }
  756. payload = {
  757. "title": title,
  758. "message": message,
  759. }
  760. # Optional custom service-data (#1441), forwarded as HA's nested "data"
  761. # object so mobile-app push options (priority, ttl, channel, group, ...)
  762. # reach the notify service. Only included when configured — the default
  763. # persistent_notification.create schema rejects unknown keys.
  764. raw_data = config.get("data")
  765. if raw_data:
  766. if isinstance(raw_data, str):
  767. try:
  768. parsed_data = json.loads(raw_data)
  769. except json.JSONDecodeError as e:
  770. return False, f"Invalid JSON in the Data field: {e}"
  771. else:
  772. parsed_data = raw_data
  773. if not isinstance(parsed_data, dict):
  774. return False, 'The Data field must be a JSON object, e.g. {"priority": "high", "ttl": 0}'
  775. if parsed_data:
  776. payload["data"] = parsed_data
  777. client = await self._get_client()
  778. response = await client.post(url, json=payload, headers=headers)
  779. if response.status_code in (200, 201):
  780. return True, "Notification sent via Home Assistant"
  781. elif response.status_code == 401:
  782. return False, "Home Assistant authentication failed - check your token"
  783. else:
  784. # ha_url comes from global settings (SETTINGS_UPDATE, admin-only), so
  785. # this is a narrower channel than the per-request provider URLs — but
  786. # it lands in the same NOTIFICATIONS_CREATE-gated test response, so it
  787. # gets the same treatment.
  788. return False, _opaque_http_failure(response, label="Home Assistant endpoint")
  789. async def _send_to_provider(
  790. self,
  791. provider: NotificationProvider,
  792. title: str,
  793. message: str,
  794. db: AsyncSession | None = None,
  795. image_data: bytes | None = None,
  796. event_type: str | None = None,
  797. variables: dict | None = None,
  798. ) -> tuple[bool, str]:
  799. """Send notification to a specific provider."""
  800. # Check quiet hours
  801. if self._is_in_quiet_hours(provider):
  802. logger.info("Skipping notification to %s - quiet hours active", provider.name)
  803. return True, "Skipped - quiet hours"
  804. config = json.loads(provider.config) if isinstance(provider.config, str) else provider.config
  805. try:
  806. if provider.provider_type == "callmebot":
  807. return await self._send_callmebot(config, f"{title}\n{message}")
  808. elif provider.provider_type == "ntfy":
  809. return await self._send_ntfy(config, title, message, image_data=image_data, event_type=event_type)
  810. elif provider.provider_type == "pushover":
  811. return await self._send_pushover(config, title, message, image_data=image_data)
  812. elif provider.provider_type == "telegram":
  813. return await self._send_telegram(config, f"*{title}*\n{message}", image_data=image_data)
  814. elif provider.provider_type == "email":
  815. # finish_photo_url is pulled from the rendered template variables
  816. # so _send_email can detect whether the template referenced the
  817. # URL and inline-embed the photo only in that case.
  818. finish_photo_url = (variables or {}).get("finish_photo_url")
  819. return await self._send_email(
  820. config, title, message, image_data=image_data, finish_photo_url=finish_photo_url
  821. )
  822. elif provider.provider_type == "discord":
  823. return await self._send_discord(config, title, message, image_data=image_data)
  824. elif provider.provider_type == "webhook":
  825. return await self._send_webhook(
  826. config, title, message, image_data=image_data, event_type=event_type, variables=variables
  827. )
  828. elif provider.provider_type == "homeassistant":
  829. return await self._send_homeassistant(config, title, message, db=db)
  830. elif provider.provider_type == "bark":
  831. return await self._send_bark(config, title, message)
  832. else:
  833. return False, f"Unknown provider type: {provider.provider_type}"
  834. except Exception as e:
  835. logger.exception("Error sending notification via %s", provider.provider_type)
  836. return False, str(e)
  837. async def _update_provider_status(
  838. self, db: AsyncSession, provider_id: int, success: bool, error: str | None = None
  839. ):
  840. """Update provider status after sending notification."""
  841. result = await db.execute(select(NotificationProvider).where(NotificationProvider.id == provider_id))
  842. provider = result.scalar_one_or_none()
  843. if provider:
  844. if success:
  845. provider.last_success = datetime.now(timezone.utc)
  846. else:
  847. provider.last_error = error
  848. provider.last_error_at = datetime.now(timezone.utc)
  849. await db.commit()
  850. async def _get_providers_for_event(
  851. self,
  852. db: AsyncSession,
  853. event_field: str,
  854. printer_id: int | None = None,
  855. ) -> list[NotificationProvider]:
  856. """Get all enabled providers that want a specific event type.
  857. Runs under ``no_autoflush`` (#2770). Callers routinely hold pending
  858. writes when they raise an event — the AMS sensor loop does
  859. ``db.add(history)`` and only commits after the alarms have gone out — and
  860. without this, autoflush satisfies this SELECT by writing those rows,
  861. which opens a write transaction on SQLite. The provider is then contacted
  862. over the network with that transaction still open, so a site whose
  863. internet is down holds the single SQLite writer for the whole connect
  864. timeout and unrelated background tasks fail with "database is locked".
  865. Deferring the flush costs nothing here: providers are committed rows, so
  866. a pending change in the caller's session cannot be one this query wants.
  867. """
  868. # Build the query dynamically based on event field
  869. query = select(NotificationProvider).where(
  870. NotificationProvider.enabled.is_(True),
  871. getattr(NotificationProvider, event_field).is_(True),
  872. )
  873. if printer_id is not None:
  874. query = query.where(
  875. (NotificationProvider.printer_id.is_(None)) | (NotificationProvider.printer_id == printer_id)
  876. )
  877. with db.no_autoflush:
  878. result = await db.execute(query)
  879. return list(result.scalars().all())
  880. async def _log_notification(
  881. self,
  882. db: AsyncSession,
  883. provider_id: int,
  884. event_type: str,
  885. title: str,
  886. message: str,
  887. success: bool,
  888. error_message: str | None = None,
  889. printer_id: int | None = None,
  890. printer_name: str | None = None,
  891. ):
  892. """Create a log entry for a sent notification."""
  893. try:
  894. log = NotificationLog(
  895. provider_id=provider_id,
  896. event_type=event_type,
  897. title=title,
  898. message=message,
  899. success=success,
  900. error_message=error_message,
  901. printer_id=printer_id,
  902. printer_name=printer_name,
  903. )
  904. db.add(log)
  905. await db.commit()
  906. except Exception as e:
  907. logger.warning("Failed to log notification: %s", e)
  908. # Don't fail the notification just because logging failed
  909. async def _send_to_providers(
  910. self,
  911. providers: list[NotificationProvider],
  912. title: str,
  913. message: str,
  914. db: AsyncSession,
  915. event_type: str = "unknown",
  916. printer_id: int | None = None,
  917. printer_name: str | None = None,
  918. force_immediate: bool = False,
  919. image_data: bytes | None = None,
  920. variables: dict | None = None,
  921. ):
  922. """Send notification to multiple providers and log the results.
  923. All notifications are always sent immediately. If digest mode is enabled,
  924. the notification is ALSO queued for the daily digest summary.
  925. """
  926. for provider in providers:
  927. try:
  928. # Always send notification immediately
  929. success, error = await self._send_to_provider(
  930. provider, title, message, db, image_data=image_data, event_type=event_type, variables=variables
  931. )
  932. # Also queue for digest if enabled (digest is a summary, not a queue)
  933. if provider.daily_digest_enabled and provider.daily_digest_time:
  934. await self._queue_for_digest(
  935. provider=provider,
  936. event_type=event_type,
  937. title=title,
  938. message=message,
  939. db=db,
  940. printer_id=printer_id,
  941. printer_name=printer_name,
  942. )
  943. await self._update_provider_status(db, provider.id, success, error if not success else None)
  944. await self._log_notification(
  945. db=db,
  946. provider_id=provider.id,
  947. event_type=event_type,
  948. title=title,
  949. message=message,
  950. success=success,
  951. error_message=error if not success else None,
  952. printer_id=printer_id,
  953. printer_name=printer_name,
  954. )
  955. if success:
  956. logger.info("Sent notification via %s", provider.name)
  957. else:
  958. logger.warning("Failed to send notification via %s: %s", provider.name, error)
  959. except Exception as e:
  960. logger.exception("Error sending notification via %s", provider.name)
  961. await self._update_provider_status(db, provider.id, False, str(e))
  962. await self._log_notification(
  963. db=db,
  964. provider_id=provider.id,
  965. event_type=event_type,
  966. title=title,
  967. message=message,
  968. success=False,
  969. error_message=str(e),
  970. printer_id=printer_id,
  971. printer_name=printer_name,
  972. )
  973. async def on_print_start(
  974. self,
  975. printer_id: int,
  976. printer_name: str,
  977. data: dict,
  978. db: AsyncSession,
  979. archive_data: dict | None = None,
  980. ):
  981. """Handle print start event - send notifications to relevant providers.
  982. Args:
  983. printer_id: The printer ID
  984. printer_name: The printer name
  985. data: MQTT event data with filename, subtask_name, remaining_time, raw_data
  986. db: Database session
  987. archive_data: Optional archive data with print_time_seconds from 3MF parsing
  988. """
  989. logger.info("on_print_start called for printer %s (%s)", printer_id, printer_name)
  990. providers = await self._get_providers_for_event(db, "on_print_start", printer_id)
  991. if not providers:
  992. logger.info("No notification providers configured for print_start event on printer %s", printer_id)
  993. return
  994. # Use subtask_name (project name) if available, otherwise use filename
  995. subtask_name = data.get("subtask_name")
  996. if subtask_name:
  997. # Replace underscores with spaces for readability
  998. filename = subtask_name.replace("_", " ")
  999. else:
  1000. filename = self._clean_filename(data.get("filename", "Unknown"))
  1001. # Priority for estimated_time:
  1002. # 1. Archive's print_time_seconds from 3MF parsing (most reliable)
  1003. # 2. MQTT remaining_time (may be 0 at print start)
  1004. # 3. raw_data mc_remaining_time
  1005. estimated_time = None
  1006. # Try archive data first (from 3MF parsing - most reliable)
  1007. if archive_data and archive_data.get("print_time_seconds"):
  1008. estimated_time = archive_data["print_time_seconds"]
  1009. logger.debug("Using print_time_seconds from archive: %s", estimated_time)
  1010. # Fall back to MQTT remaining_time
  1011. if estimated_time is None:
  1012. estimated_time = data.get("remaining_time")
  1013. if estimated_time:
  1014. logger.debug("Using remaining_time from MQTT: %s", estimated_time)
  1015. # Last resort: raw_data mc_remaining_time (in minutes, convert to seconds)
  1016. if estimated_time is None:
  1017. raw_time = data.get("raw_data", {}).get("mc_remaining_time")
  1018. if raw_time:
  1019. estimated_time = raw_time * 60
  1020. logger.debug("Using mc_remaining_time from raw_data: %s", estimated_time)
  1021. time_str = self._format_duration(estimated_time)
  1022. eta_str = await self._format_eta(estimated_time, db)
  1023. variables = {
  1024. "printer": printer_name,
  1025. "filename": filename,
  1026. "estimated_time": time_str,
  1027. "eta": eta_str,
  1028. }
  1029. # Extract image data for providers that support attachments (e.g. Pushover)
  1030. image_data = None
  1031. if archive_data:
  1032. image_data = archive_data.get("image_data")
  1033. logger.info("Found %s providers for print_start: %s", len(providers), [p.name for p in providers])
  1034. title, message = await self._build_message_from_template(db, "print_start", variables)
  1035. await self._send_to_providers(
  1036. providers,
  1037. title,
  1038. message,
  1039. db,
  1040. "print_start",
  1041. printer_id,
  1042. printer_name,
  1043. image_data=image_data,
  1044. variables=variables,
  1045. )
  1046. async def on_print_complete(
  1047. self,
  1048. printer_id: int,
  1049. printer_name: str,
  1050. status: str,
  1051. data: dict,
  1052. db: AsyncSession,
  1053. archive_data: dict | None = None,
  1054. ):
  1055. """Handle print complete event - send notifications to relevant providers."""
  1056. logger.info("on_print_complete called for printer %s (%s), status=%s", printer_id, printer_name, status)
  1057. # Determine event type based on status
  1058. if status == "completed":
  1059. event_field = "on_print_complete"
  1060. event_type = "print_complete"
  1061. elif status in ("failed",):
  1062. event_field = "on_print_failed"
  1063. event_type = "print_failed"
  1064. elif status in ("aborted", "stopped", "cancelled"):
  1065. event_field = "on_print_stopped"
  1066. event_type = "print_stopped"
  1067. else:
  1068. logger.warning("Unknown print status '%s', defaulting to on_print_complete", status)
  1069. event_field = "on_print_complete"
  1070. event_type = "print_complete"
  1071. providers = await self._get_providers_for_event(db, event_field, printer_id)
  1072. if not providers:
  1073. logger.info("No notification providers configured for %s event on printer %s", event_field, printer_id)
  1074. return
  1075. # Use subtask_name (project name) if available, otherwise use filename
  1076. subtask_name = data.get("subtask_name")
  1077. if subtask_name:
  1078. filename = subtask_name.replace("_", " ")
  1079. else:
  1080. filename = self._clean_filename(data.get("filename", "Unknown"))
  1081. variables = {
  1082. "printer": printer_name,
  1083. "filename": filename,
  1084. "duration": "Unknown",
  1085. "filament_grams": "Unknown",
  1086. "reason": "Unknown",
  1087. }
  1088. if archive_data:
  1089. # {{duration}} on completion / failure / stopped events is the *actual*
  1090. # elapsed time (#1198). Slicer-estimated print_time_seconds is only used
  1091. # as a last-resort fallback when timestamps weren't recorded.
  1092. duration_seconds = archive_data.get("actual_time_seconds") or archive_data.get("print_time_seconds")
  1093. if duration_seconds:
  1094. variables["duration"] = self._format_duration(duration_seconds)
  1095. if archive_data.get("actual_filament_grams"):
  1096. variables["filament_grams"] = f"{archive_data['actual_filament_grams']:.1f}"
  1097. if status == "failed" and archive_data.get("failure_reason"):
  1098. variables["reason"] = archive_data["failure_reason"]
  1099. if archive_data.get("finish_photo_url"):
  1100. variables["finish_photo_url"] = archive_data["finish_photo_url"]
  1101. # Build per-slot breakdown string with AMS info when available
  1102. if archive_data.get("usage_results"):
  1103. parts = []
  1104. for u in archive_data["usage_results"]:
  1105. ams_id = u.get("ams_id", 0)
  1106. tray_id = u.get("tray_id", 0)
  1107. material = u.get("material", "Unknown") or "Unknown"
  1108. used = u.get("weight_used", 0)
  1109. if ams_id >= 128:
  1110. slot_label = "Ext"
  1111. else:
  1112. slot_label = f"AMS-{chr(65 + ams_id)} T{tray_id + 1}"
  1113. parts.append(f"{slot_label} {material}: {used:.1f}g")
  1114. variables["filament_details"] = " | ".join(parts)
  1115. elif archive_data.get("filament_slots"):
  1116. parts = []
  1117. for slot in archive_data["filament_slots"]:
  1118. ftype = slot.get("type", "Unknown") or "Unknown"
  1119. used = slot.get("used_g", 0)
  1120. parts.append(f"{ftype}: {used:.1f}g")
  1121. variables["filament_details"] = " | ".join(parts)
  1122. # Add progress for partial prints
  1123. if archive_data.get("progress") is not None:
  1124. variables["progress"] = str(archive_data["progress"])
  1125. # Extract image data for providers that support attachments (e.g. Pushover)
  1126. image_data = None
  1127. if archive_data:
  1128. image_data = archive_data.get("image_data")
  1129. logger.info("Found %s providers for %s: %s", len(providers), event_field, [p.name for p in providers])
  1130. title, message = await self._build_message_from_template(db, event_type, variables)
  1131. await self._send_to_providers(
  1132. providers,
  1133. title,
  1134. message,
  1135. db,
  1136. event_type,
  1137. printer_id,
  1138. printer_name,
  1139. image_data=image_data,
  1140. variables=variables,
  1141. )
  1142. async def on_print_progress(
  1143. self,
  1144. printer_id: int,
  1145. printer_name: str,
  1146. filename: str,
  1147. progress: int,
  1148. db: AsyncSession,
  1149. remaining_time: int | None = None,
  1150. image_data: bytes | None = None,
  1151. ):
  1152. """Handle print progress milestone (25%, 50%, 75%)."""
  1153. providers = await self._get_providers_for_event(db, "on_print_progress", printer_id)
  1154. if not providers:
  1155. return
  1156. eta_str = await self._format_eta(remaining_time, db)
  1157. variables = {
  1158. "printer": printer_name,
  1159. "filename": self._clean_filename(filename),
  1160. "progress": str(progress),
  1161. "remaining_time": self._format_duration(remaining_time) if remaining_time else "Unknown",
  1162. "eta": eta_str,
  1163. }
  1164. title, message = await self._build_message_from_template(db, "print_progress", variables)
  1165. await self._send_to_providers(
  1166. providers,
  1167. title,
  1168. message,
  1169. db,
  1170. "print_progress",
  1171. printer_id,
  1172. printer_name,
  1173. image_data=image_data,
  1174. variables=variables,
  1175. )
  1176. async def on_print_missing_spool_assignment(
  1177. self,
  1178. printer_id: int,
  1179. printer_name: str,
  1180. missing_slots: list[dict[str, str]],
  1181. db: AsyncSession,
  1182. ):
  1183. """Handle print-start event when required trays are missing spool assignments."""
  1184. if not missing_slots:
  1185. return
  1186. providers = await self._get_providers_for_event(db, "on_print_missing_spool_assignment", printer_id)
  1187. if not providers:
  1188. return
  1189. missing_slot_names = ", ".join(slot.get("slot", "Unknown") for slot in missing_slots)
  1190. detail_lines = []
  1191. for slot in missing_slots:
  1192. slot_name = slot.get("slot", "Unknown")
  1193. profile = slot.get("profile", "Unknown")
  1194. detail_lines.append(f"- {slot_name}: {profile}")
  1195. missing_profile_details = "\n".join(detail_lines)
  1196. variables = {
  1197. "printer": printer_name,
  1198. "missing_slots": missing_slot_names,
  1199. "missing_slot_details": missing_profile_details,
  1200. }
  1201. title, message = await self._build_message_from_template(db, "print_missing_spool_assignment", variables)
  1202. await self._send_to_providers(
  1203. providers,
  1204. title,
  1205. message,
  1206. db,
  1207. "print_missing_spool_assignment",
  1208. printer_id,
  1209. printer_name,
  1210. force_immediate=True,
  1211. variables=variables,
  1212. )
  1213. async def on_billing_charge_failed(
  1214. self,
  1215. printer_id: int,
  1216. printer_name: str,
  1217. filename: str,
  1218. archive_id: int | None,
  1219. error: str,
  1220. db: AsyncSession,
  1221. ) -> None:
  1222. """Notify providers that a terminal print could not be charged."""
  1223. providers = await self._get_providers_for_event(db, "on_billing_charge_failed", printer_id)
  1224. if not providers:
  1225. return
  1226. variables = {
  1227. "printer": printer_name,
  1228. "filename": self._clean_filename(filename),
  1229. "archive_id": str(archive_id) if archive_id is not None else "Unknown",
  1230. "error": error,
  1231. }
  1232. title, message = await self._build_message_from_template(db, "billing_charge_failed", variables)
  1233. await self._send_to_providers(
  1234. providers,
  1235. title,
  1236. message,
  1237. db,
  1238. "billing_charge_failed",
  1239. printer_id,
  1240. printer_name,
  1241. force_immediate=True,
  1242. variables=variables,
  1243. )
  1244. async def on_printer_offline(self, printer_id: int, printer_name: str, db: AsyncSession):
  1245. """Handle printer offline event."""
  1246. providers = await self._get_providers_for_event(db, "on_printer_offline", printer_id)
  1247. if not providers:
  1248. return
  1249. variables = {"printer": printer_name}
  1250. title, message = await self._build_message_from_template(db, "printer_offline", variables)
  1251. await self._send_to_providers(
  1252. providers, title, message, db, "printer_offline", printer_id, printer_name, variables=variables
  1253. )
  1254. async def on_printer_error(
  1255. self,
  1256. printer_id: int,
  1257. printer_name: str,
  1258. error_type: str,
  1259. db: AsyncSession,
  1260. error_detail: str | None = None,
  1261. image_data: bytes | None = None,
  1262. ):
  1263. """Handle printer error event (AMS issues, etc.)."""
  1264. providers = await self._get_providers_for_event(db, "on_printer_error", printer_id)
  1265. if not providers:
  1266. return
  1267. variables = {
  1268. "printer": printer_name,
  1269. "error_type": error_type,
  1270. "error_detail": error_detail or "No details available",
  1271. }
  1272. title, message = await self._build_message_from_template(db, "printer_error", variables)
  1273. await self._send_to_providers(
  1274. providers,
  1275. title,
  1276. message,
  1277. db,
  1278. "printer_error",
  1279. printer_id,
  1280. printer_name,
  1281. image_data=image_data,
  1282. variables=variables,
  1283. )
  1284. async def on_ai_failure_detection(
  1285. self,
  1286. printer_id: int,
  1287. printer_name: str,
  1288. task_name: str,
  1289. confidence: float,
  1290. action: str,
  1291. db: AsyncSession,
  1292. image_data: bytes | None = None,
  1293. ):
  1294. """Handle AI failure-detection event (Obico spaghetti / print-failure ML).
  1295. Split out of on_printer_error (#1794) so a user can subscribe to AI
  1296. alerts without also being paged for every HMS hardware code.
  1297. """
  1298. providers = await self._get_providers_for_event(db, "on_ai_failure_detection", printer_id)
  1299. if not providers:
  1300. return
  1301. variables = {
  1302. "printer": printer_name,
  1303. "task_name": task_name or "current job",
  1304. "confidence": f"{confidence:.2f}",
  1305. "action": action,
  1306. }
  1307. title, message = await self._build_message_from_template(db, "ai_failure_detection", variables)
  1308. await self._send_to_providers(
  1309. providers,
  1310. title,
  1311. message,
  1312. db,
  1313. "ai_failure_detection",
  1314. printer_id,
  1315. printer_name,
  1316. image_data=image_data,
  1317. variables=variables,
  1318. )
  1319. async def on_plate_not_empty(
  1320. self,
  1321. printer_id: int,
  1322. printer_name: str,
  1323. db: AsyncSession,
  1324. difference_percent: float | None = None,
  1325. ):
  1326. """Handle plate not empty event - objects detected on build plate before print."""
  1327. providers = await self._get_providers_for_event(db, "on_plate_not_empty", printer_id)
  1328. if not providers:
  1329. return
  1330. variables = {
  1331. "printer": printer_name,
  1332. "difference_percent": f"{difference_percent:.1f}" if difference_percent else "N/A",
  1333. }
  1334. title, message = await self._build_message_from_template(db, "plate_not_empty", variables)
  1335. await self._send_to_providers(
  1336. providers,
  1337. title,
  1338. message,
  1339. db,
  1340. "plate_not_empty",
  1341. printer_id,
  1342. printer_name,
  1343. force_immediate=True,
  1344. variables=variables,
  1345. )
  1346. async def on_plate_clear_required(
  1347. self,
  1348. printer_id: int,
  1349. printer_name: str,
  1350. db: AsyncSession,
  1351. ):
  1352. """Handle plate-clear-required event — a print ended and the queue is gated (#2525).
  1353. Distinct from ``on_plate_not_empty``, which is the camera check *before* a
  1354. print starts. This one fires on the rising edge of the Bambuddy-side
  1355. awaiting-plate-clear flag, i.e. whenever a print reaches a terminal state
  1356. and the next queued job can't dispatch until someone confirms the bed is
  1357. free. Off by default on every provider: it lands at the same moment as the
  1358. print-complete notification, so opting in is a deliberate choice.
  1359. """
  1360. providers = await self._get_providers_for_event(db, "on_plate_clear_required", printer_id)
  1361. if not providers:
  1362. return
  1363. variables = {"printer": printer_name}
  1364. title, message = await self._build_message_from_template(db, "plate_clear_required", variables)
  1365. await self._send_to_providers(
  1366. providers,
  1367. title,
  1368. message,
  1369. db,
  1370. "plate_clear_required",
  1371. printer_id,
  1372. printer_name,
  1373. variables=variables,
  1374. )
  1375. async def on_filament_low(
  1376. self,
  1377. printer_id: int,
  1378. printer_name: str,
  1379. slot: int,
  1380. remaining_percent: int,
  1381. db: AsyncSession,
  1382. color: str | None = None,
  1383. ):
  1384. """Handle low filament event."""
  1385. providers = await self._get_providers_for_event(db, "on_filament_low", printer_id)
  1386. if not providers:
  1387. return
  1388. variables = {
  1389. "printer": printer_name,
  1390. "slot": str(slot),
  1391. "remaining_percent": str(remaining_percent),
  1392. "color": color or "",
  1393. }
  1394. title, message = await self._build_message_from_template(db, "filament_low", variables)
  1395. await self._send_to_providers(
  1396. providers, title, message, db, "filament_low", printer_id, printer_name, variables=variables
  1397. )
  1398. async def on_maintenance_due(
  1399. self,
  1400. printer_id: int,
  1401. printer_name: str,
  1402. maintenance_items: list[dict],
  1403. db: AsyncSession,
  1404. ):
  1405. """Handle maintenance due event - sends notification when maintenance is due or warning."""
  1406. if not maintenance_items:
  1407. return
  1408. providers = await self._get_providers_for_event(db, "on_maintenance_due", printer_id)
  1409. if not providers:
  1410. logger.info("No notification providers configured for maintenance_due event on printer %s", printer_id)
  1411. return
  1412. # Format maintenance items list
  1413. items_list = []
  1414. for item in maintenance_items:
  1415. status = "OVERDUE" if item.get("is_due") else "Soon"
  1416. items_list.append(f"- {item['name']} ({status})")
  1417. items_str = "\n".join(items_list)
  1418. variables = {
  1419. "printer": printer_name,
  1420. "items": items_str,
  1421. }
  1422. logger.info("Found %s providers for maintenance_due: %s", len(providers), [p.name for p in providers])
  1423. title, message = await self._build_message_from_template(db, "maintenance_due", variables)
  1424. await self._send_to_providers(
  1425. providers, title, message, db, "maintenance_due", printer_id, printer_name, variables=variables
  1426. )
  1427. async def on_ams_humidity_high(
  1428. self,
  1429. printer_id: int,
  1430. printer_name: str,
  1431. ams_label: str,
  1432. humidity: float,
  1433. threshold: float,
  1434. db: AsyncSession,
  1435. ):
  1436. """Handle AMS high humidity alarm event. Always sends immediately (bypasses digest)."""
  1437. providers = await self._get_providers_for_event(db, "on_ams_humidity_high", printer_id)
  1438. if not providers:
  1439. return
  1440. variables = {
  1441. "printer": printer_name,
  1442. "ams_label": ams_label,
  1443. "humidity": f"{humidity:.0f}",
  1444. "threshold": f"{threshold:.0f}",
  1445. }
  1446. title, message = await self._build_message_from_template(db, "ams_humidity_high", variables)
  1447. # Alarms always send immediately, bypassing digest mode
  1448. await self._send_to_providers(
  1449. providers,
  1450. title,
  1451. message,
  1452. db,
  1453. "ams_humidity_high",
  1454. printer_id,
  1455. printer_name,
  1456. force_immediate=True,
  1457. variables=variables,
  1458. )
  1459. async def on_ams_temperature_high(
  1460. self,
  1461. printer_id: int,
  1462. printer_name: str,
  1463. ams_label: str,
  1464. temperature: float,
  1465. threshold: float,
  1466. db: AsyncSession,
  1467. ):
  1468. """Handle AMS high temperature alarm event. Always sends immediately (bypasses digest)."""
  1469. providers = await self._get_providers_for_event(db, "on_ams_temperature_high", printer_id)
  1470. if not providers:
  1471. return
  1472. variables = {
  1473. "printer": printer_name,
  1474. "ams_label": ams_label,
  1475. "temperature": f"{temperature:.1f}",
  1476. "threshold": f"{threshold:.1f}",
  1477. }
  1478. title, message = await self._build_message_from_template(db, "ams_temperature_high", variables)
  1479. # Alarms always send immediately, bypassing digest mode
  1480. await self._send_to_providers(
  1481. providers,
  1482. title,
  1483. message,
  1484. db,
  1485. "ams_temperature_high",
  1486. printer_id,
  1487. printer_name,
  1488. force_immediate=True,
  1489. variables=variables,
  1490. )
  1491. async def on_ams_drying_suspended(
  1492. self,
  1493. printer_id: int,
  1494. printer_name: str,
  1495. ams_label: str,
  1496. humidity: float,
  1497. threshold: float,
  1498. cycles: int,
  1499. db: AsyncSession,
  1500. ):
  1501. """Handle automatic drying giving up on one AMS unit (#2770).
  1502. Sent immediately rather than folded into a digest: it reports that
  1503. Bambuddy has STOPPED doing something, and a report of inaction that
  1504. arrives with tomorrow's summary has already cost the user a day.
  1505. """
  1506. providers = await self._get_providers_for_event(db, "on_ams_drying_suspended", printer_id)
  1507. if not providers:
  1508. return
  1509. variables = {
  1510. "printer": printer_name,
  1511. "ams_label": ams_label,
  1512. "humidity": f"{humidity:.0f}",
  1513. "threshold": f"{threshold:.0f}",
  1514. "cycles": str(cycles),
  1515. }
  1516. title, message = await self._build_message_from_template(db, "ams_drying_suspended", variables)
  1517. await self._send_to_providers(
  1518. providers,
  1519. title,
  1520. message,
  1521. db,
  1522. "ams_drying_suspended",
  1523. printer_id,
  1524. printer_name,
  1525. force_immediate=True,
  1526. variables=variables,
  1527. )
  1528. async def on_ams_ht_humidity_high(
  1529. self,
  1530. printer_id: int,
  1531. printer_name: str,
  1532. ams_label: str,
  1533. humidity: float,
  1534. threshold: float,
  1535. db: AsyncSession,
  1536. ):
  1537. """Handle AMS-HT high humidity alarm event. Always sends immediately (bypasses digest)."""
  1538. providers = await self._get_providers_for_event(db, "on_ams_ht_humidity_high", printer_id)
  1539. if not providers:
  1540. return
  1541. variables = {
  1542. "printer": printer_name,
  1543. "ams_label": ams_label,
  1544. "humidity": f"{humidity:.0f}",
  1545. "threshold": f"{threshold:.0f}",
  1546. }
  1547. # Use the same template as regular AMS (can create separate templates later if needed)
  1548. title, message = await self._build_message_from_template(db, "ams_humidity_high", variables)
  1549. # Alarms always send immediately, bypassing digest mode
  1550. await self._send_to_providers(
  1551. providers,
  1552. title,
  1553. message,
  1554. db,
  1555. "ams_ht_humidity_high",
  1556. printer_id,
  1557. printer_name,
  1558. force_immediate=True,
  1559. variables=variables,
  1560. )
  1561. async def on_ams_ht_temperature_high(
  1562. self,
  1563. printer_id: int,
  1564. printer_name: str,
  1565. ams_label: str,
  1566. temperature: float,
  1567. threshold: float,
  1568. db: AsyncSession,
  1569. ):
  1570. """Handle AMS-HT high temperature alarm event. Always sends immediately (bypasses digest)."""
  1571. providers = await self._get_providers_for_event(db, "on_ams_ht_temperature_high", printer_id)
  1572. if not providers:
  1573. return
  1574. variables = {
  1575. "printer": printer_name,
  1576. "ams_label": ams_label,
  1577. "temperature": f"{temperature:.1f}",
  1578. "threshold": f"{threshold:.1f}",
  1579. }
  1580. # Use the same template as regular AMS (can create separate templates later if needed)
  1581. title, message = await self._build_message_from_template(db, "ams_temperature_high", variables)
  1582. # Alarms always send immediately, bypassing digest mode
  1583. await self._send_to_providers(
  1584. providers,
  1585. title,
  1586. message,
  1587. db,
  1588. "ams_ht_temperature_high",
  1589. printer_id,
  1590. printer_name,
  1591. force_immediate=True,
  1592. variables=variables,
  1593. )
  1594. async def on_bed_cooled(
  1595. self,
  1596. printer_id: int,
  1597. printer_name: str,
  1598. bed_temp: float,
  1599. threshold: float,
  1600. filename: str,
  1601. db: AsyncSession,
  1602. ):
  1603. """Handle bed cooled event - bed temperature dropped below threshold after print."""
  1604. providers = await self._get_providers_for_event(db, "on_bed_cooled", printer_id)
  1605. if not providers:
  1606. return
  1607. variables = {
  1608. "printer": printer_name,
  1609. "bed_temp": f"{bed_temp:.0f}",
  1610. "threshold": f"{threshold:.0f}",
  1611. "filename": self._clean_filename(filename) if filename else "Unknown",
  1612. }
  1613. title, message = await self._build_message_from_template(db, "bed_cooled", variables)
  1614. await self._send_to_providers(
  1615. providers, title, message, db, "bed_cooled", printer_id, printer_name, variables=variables
  1616. )
  1617. async def on_ha_sensor_alert(
  1618. self,
  1619. printer_id: int,
  1620. printer_name: str,
  1621. sensor_name: str,
  1622. state: str,
  1623. db: AsyncSession,
  1624. ):
  1625. """A Home Assistant sensor bound to a printer entered its alert state (#1148).
  1626. Sent immediately rather than folded into a digest: the case this exists
  1627. for is an enclosure door left open, which is only worth telling someone
  1628. about while they can still act on it.
  1629. """
  1630. providers = await self._get_providers_for_event(db, "on_ha_sensor_alert", printer_id)
  1631. if not providers:
  1632. return
  1633. variables = {
  1634. "printer": printer_name,
  1635. "sensor": sensor_name,
  1636. "state": state,
  1637. }
  1638. title, message = await self._build_message_from_template(db, "ha_sensor_alert", variables)
  1639. await self._send_to_providers(
  1640. providers,
  1641. title,
  1642. message,
  1643. db,
  1644. "ha_sensor_alert",
  1645. printer_id,
  1646. printer_name,
  1647. force_immediate=True,
  1648. variables=variables,
  1649. )
  1650. async def on_first_layer_complete(
  1651. self,
  1652. printer_id: int,
  1653. printer_name: str,
  1654. filename: str,
  1655. total_layers: int,
  1656. db: AsyncSession,
  1657. image_data: bytes | None = None,
  1658. ):
  1659. """Handle first layer complete event."""
  1660. providers = await self._get_providers_for_event(db, "on_first_layer_complete", printer_id)
  1661. if not providers:
  1662. return
  1663. variables = {
  1664. "printer": printer_name,
  1665. "filename": self._clean_filename(filename),
  1666. "total_layers": str(total_layers),
  1667. }
  1668. title, message = await self._build_message_from_template(db, "first_layer_complete", variables)
  1669. await self._send_to_providers(
  1670. providers,
  1671. title,
  1672. message,
  1673. db,
  1674. "first_layer_complete",
  1675. printer_id,
  1676. printer_name,
  1677. image_data=image_data,
  1678. variables=variables,
  1679. )
  1680. def clear_template_cache(self):
  1681. """Clear the template cache. Call this when templates are updated."""
  1682. self._template_cache.clear()
  1683. async def send_user_print_email(
  1684. self,
  1685. event_type: str,
  1686. created_by_id: int | None,
  1687. printer_name: str,
  1688. filename: str,
  1689. db: AsyncSession,
  1690. ) -> None:
  1691. """Send a print event email notification to the user who submitted the job.
  1692. Args:
  1693. event_type: 'user_print_start', 'user_print_complete', 'user_print_failed', or 'user_print_stopped'
  1694. created_by_id: User ID who submitted the print job (from archive)
  1695. printer_name: Name of the printer
  1696. filename: Raw filename or subtask name
  1697. db: Database session
  1698. """
  1699. if created_by_id is None:
  1700. logger.debug("[EMAIL] Skipping user print email (%s): no created_by_id", event_type)
  1701. return
  1702. try:
  1703. # Check if advanced auth is enabled - required for user email notifications
  1704. from backend.app.models.settings import Settings
  1705. result = await db.execute(select(Settings).where(Settings.key == "advanced_auth_enabled"))
  1706. setting = result.scalar_one_or_none()
  1707. if not setting or setting.value.lower() != "true":
  1708. logger.debug("[EMAIL] Skipping user print email (%s): advanced_auth not enabled", event_type)
  1709. return
  1710. # Check if user notifications are enabled (admin-controlled toggle)
  1711. notif_enabled_result = await db.execute(
  1712. select(Settings).where(Settings.key == "user_notifications_enabled")
  1713. )
  1714. notif_enabled_setting = notif_enabled_result.scalar_one_or_none()
  1715. if notif_enabled_setting and notif_enabled_setting.value.lower() == "false":
  1716. logger.debug("[EMAIL] Skipping user print email (%s): user_notifications_enabled is false", event_type)
  1717. return
  1718. # Check SMTP settings are configured - required for sending emails
  1719. from backend.app.services.email_service import get_smtp_settings, send_user_print_notification
  1720. smtp_settings = await get_smtp_settings(db)
  1721. if not smtp_settings:
  1722. logger.debug("[EMAIL] Skipping user print email (%s): SMTP settings not configured", event_type)
  1723. return
  1724. # Load user preferences
  1725. from backend.app.models.user import User
  1726. from backend.app.models.user_email_pref import UserEmailPreference
  1727. user_result = await db.execute(select(User).where(User.id == created_by_id))
  1728. user = user_result.scalar_one_or_none()
  1729. if user is None or not user.email:
  1730. logger.debug(
  1731. "[EMAIL] Skipping user print email (%s): user %s not found or has no email address",
  1732. event_type,
  1733. created_by_id,
  1734. )
  1735. return
  1736. # Load user's notification preferences
  1737. pref_result = await db.execute(
  1738. select(UserEmailPreference).where(UserEmailPreference.user_id == created_by_id)
  1739. )
  1740. pref = pref_result.scalar_one_or_none()
  1741. # Determine if this event type should be sent
  1742. should_send = False
  1743. if event_type == "user_print_start":
  1744. should_send = pref is None or pref.notify_print_start
  1745. elif event_type == "user_print_complete":
  1746. should_send = pref is None or pref.notify_print_complete
  1747. elif event_type == "user_print_failed":
  1748. should_send = pref is None or pref.notify_print_failed
  1749. elif event_type == "user_print_stopped":
  1750. should_send = pref is None or pref.notify_print_stopped
  1751. if not should_send:
  1752. logger.debug(
  1753. "[EMAIL] Skipping user print email (%s): user %s has notifications disabled for this event",
  1754. event_type,
  1755. created_by_id,
  1756. )
  1757. return
  1758. logger.info(
  1759. "[EMAIL] Sending user print email: event=%s, user=%s (%s), printer=%s, file=%s",
  1760. event_type,
  1761. user.username,
  1762. user.email,
  1763. printer_name,
  1764. filename,
  1765. )
  1766. # Build variables
  1767. variables = {
  1768. "printer": printer_name,
  1769. "filename": self._clean_filename(filename),
  1770. }
  1771. # Send the email
  1772. await send_user_print_notification(
  1773. db=db,
  1774. event_type=event_type,
  1775. user_email=user.email,
  1776. username=user.username,
  1777. variables=variables,
  1778. )
  1779. logger.info("[EMAIL] User print email sent: event=%s → %s", event_type, user.email)
  1780. except Exception as e:
  1781. logger.warning("Failed to send user print email notification: %s", e, exc_info=True)
  1782. # ==================== Queue Notifications ====================
  1783. async def on_queue_job_added(
  1784. self,
  1785. job_name: str,
  1786. target: str,
  1787. db: AsyncSession,
  1788. printer_id: int | None = None,
  1789. printer_name: str | None = None,
  1790. ):
  1791. """Handle queue job added event."""
  1792. providers = await self._get_providers_for_event(db, "on_queue_job_added", printer_id)
  1793. if not providers:
  1794. return
  1795. variables = {
  1796. "job_name": job_name,
  1797. "target": target, # e.g., "Printer1" or "Any X1C"
  1798. "printer": printer_name or target,
  1799. }
  1800. title, message = await self._build_message_from_template(db, "queue_job_added", variables)
  1801. await self._send_to_providers(
  1802. providers, title, message, db, "queue_job_added", printer_id, printer_name, variables=variables
  1803. )
  1804. async def on_queue_job_assigned(
  1805. self,
  1806. job_name: str,
  1807. printer_id: int,
  1808. printer_name: str,
  1809. target_model: str,
  1810. db: AsyncSession,
  1811. ):
  1812. """Handle model-based job assigned to printer event."""
  1813. providers = await self._get_providers_for_event(db, "on_queue_job_assigned", printer_id)
  1814. if not providers:
  1815. return
  1816. variables = {
  1817. "job_name": job_name,
  1818. "printer": printer_name,
  1819. "target_model": target_model,
  1820. }
  1821. title, message = await self._build_message_from_template(db, "queue_job_assigned", variables)
  1822. await self._send_to_providers(
  1823. providers, title, message, db, "queue_job_assigned", printer_id, printer_name, variables=variables
  1824. )
  1825. async def on_queue_job_started(
  1826. self,
  1827. job_name: str,
  1828. printer_id: int,
  1829. printer_name: str,
  1830. db: AsyncSession,
  1831. estimated_time: int | None = None,
  1832. ):
  1833. """Handle queue job started printing event."""
  1834. providers = await self._get_providers_for_event(db, "on_queue_job_started", printer_id)
  1835. if not providers:
  1836. return
  1837. eta_str = await self._format_eta(estimated_time, db)
  1838. variables = {
  1839. "job_name": job_name,
  1840. "printer": printer_name,
  1841. "estimated_time": self._format_duration(estimated_time),
  1842. "eta": eta_str,
  1843. }
  1844. title, message = await self._build_message_from_template(db, "queue_job_started", variables)
  1845. await self._send_to_providers(
  1846. providers, title, message, db, "queue_job_started", printer_id, printer_name, variables=variables
  1847. )
  1848. async def on_queue_job_waiting(
  1849. self,
  1850. job_name: str,
  1851. target_model: str,
  1852. waiting_reason: str,
  1853. db: AsyncSession,
  1854. ):
  1855. """Handle job waiting for filament event."""
  1856. providers = await self._get_providers_for_event(db, "on_queue_job_waiting", None)
  1857. if not providers:
  1858. return
  1859. variables = {
  1860. "job_name": job_name,
  1861. "target_model": target_model,
  1862. "waiting_reason": waiting_reason,
  1863. }
  1864. title, message = await self._build_message_from_template(db, "queue_job_waiting", variables)
  1865. await self._send_to_providers(providers, title, message, db, "queue_job_waiting", variables=variables)
  1866. async def on_queue_job_skipped(
  1867. self,
  1868. job_name: str,
  1869. printer_id: int,
  1870. printer_name: str,
  1871. reason: str,
  1872. db: AsyncSession,
  1873. ):
  1874. """Handle job skipped event (e.g., previous print failed)."""
  1875. providers = await self._get_providers_for_event(db, "on_queue_job_skipped", printer_id)
  1876. if not providers:
  1877. return
  1878. variables = {
  1879. "job_name": job_name,
  1880. "printer": printer_name,
  1881. "reason": reason,
  1882. }
  1883. title, message = await self._build_message_from_template(db, "queue_job_skipped", variables)
  1884. await self._send_to_providers(
  1885. providers, title, message, db, "queue_job_skipped", printer_id, printer_name, variables=variables
  1886. )
  1887. async def on_queue_job_failed(
  1888. self,
  1889. job_name: str,
  1890. printer_id: int | None,
  1891. printer_name: str | None,
  1892. reason: str,
  1893. db: AsyncSession,
  1894. ):
  1895. """Handle job failed to start event (upload error, etc.)."""
  1896. providers = await self._get_providers_for_event(db, "on_queue_job_failed", printer_id)
  1897. if not providers:
  1898. return
  1899. variables = {
  1900. "job_name": job_name,
  1901. "printer": printer_name or "Unknown",
  1902. "reason": reason,
  1903. }
  1904. title, message = await self._build_message_from_template(db, "queue_job_failed", variables)
  1905. await self._send_to_providers(
  1906. providers, title, message, db, "queue_job_failed", printer_id, printer_name, variables=variables
  1907. )
  1908. async def on_queue_completed(
  1909. self,
  1910. completed_count: int,
  1911. db: AsyncSession,
  1912. ):
  1913. """Handle all queue jobs completed event."""
  1914. providers = await self._get_providers_for_event(db, "on_queue_completed", None)
  1915. if not providers:
  1916. return
  1917. variables = {
  1918. "completed_count": str(completed_count),
  1919. }
  1920. title, message = await self._build_message_from_template(db, "queue_completed", variables)
  1921. await self._send_to_providers(providers, title, message, db, "queue_completed", variables=variables)
  1922. # ==================== Inventory Stock Alerts ====================
  1923. async def on_stock_reorder_alert(
  1924. self,
  1925. material: str,
  1926. brand: str | None,
  1927. stock_g: float,
  1928. rate_g_day: float,
  1929. days_left: int,
  1930. db: AsyncSession,
  1931. ):
  1932. """Fire when an inventory SKU reaches its reorder point."""
  1933. providers = await self._get_providers_for_event(db, "on_stock_reorder_alert", None)
  1934. if not providers:
  1935. return
  1936. variables = {
  1937. "material": material,
  1938. "brand": brand or "",
  1939. "stock_g": f"{stock_g:.0f}",
  1940. "rate_g_day": f"{rate_g_day:.1f}",
  1941. "days_left": str(days_left),
  1942. }
  1943. title, message = await self._build_message_from_template(db, "stock_reorder_alert", variables)
  1944. await self._send_to_providers(providers, title, message, db, "stock_reorder_alert", variables=variables)
  1945. async def on_stock_break_alert(
  1946. self,
  1947. material: str,
  1948. brand: str | None,
  1949. stock_g: float,
  1950. rate_g_day: float,
  1951. days_left: int,
  1952. lead_time_days: int,
  1953. db: AsyncSession,
  1954. ):
  1955. """Fire when a stock break is detected (stock runs out before lead time)."""
  1956. providers = await self._get_providers_for_event(db, "on_stock_break_alert", None)
  1957. if not providers:
  1958. return
  1959. variables = {
  1960. "material": material,
  1961. "brand": brand or "",
  1962. "stock_g": f"{stock_g:.0f}",
  1963. "rate_g_day": f"{rate_g_day:.1f}",
  1964. "days_left": str(days_left),
  1965. "lead_time_days": str(lead_time_days),
  1966. }
  1967. title, message = await self._build_message_from_template(db, "stock_break_alert", variables)
  1968. await self._send_to_providers(providers, title, message, db, "stock_break_alert", variables=variables)
  1969. async def _queue_for_digest(
  1970. self,
  1971. provider: NotificationProvider,
  1972. event_type: str,
  1973. title: str,
  1974. message: str,
  1975. db: AsyncSession,
  1976. printer_id: int | None = None,
  1977. printer_name: str | None = None,
  1978. ):
  1979. """Queue a notification for later delivery in the daily digest."""
  1980. try:
  1981. queue_entry = NotificationDigestQueue(
  1982. provider_id=provider.id,
  1983. event_type=event_type,
  1984. title=title,
  1985. message=message,
  1986. printer_id=printer_id,
  1987. printer_name=printer_name,
  1988. )
  1989. db.add(queue_entry)
  1990. await db.commit()
  1991. logger.info("Queued notification for digest: %s for provider %s", event_type, provider.name)
  1992. except Exception as e:
  1993. logger.warning("Failed to queue notification for digest: %s", e)
  1994. async def send_digest(self, provider_id: int):
  1995. """Send all queued notifications as a single digest for a provider."""
  1996. from backend.app.core.database import async_session
  1997. async with async_session() as db:
  1998. # Get the provider
  1999. result = await db.execute(select(NotificationProvider).where(NotificationProvider.id == provider_id))
  2000. provider = result.scalar_one_or_none()
  2001. if not provider or not provider.enabled:
  2002. return
  2003. # Get all queued notifications for this provider
  2004. result = await db.execute(
  2005. select(NotificationDigestQueue)
  2006. .where(NotificationDigestQueue.provider_id == provider_id)
  2007. .order_by(NotificationDigestQueue.created_at)
  2008. )
  2009. queue_entries = list(result.scalars().all())
  2010. if not queue_entries:
  2011. logger.debug("No queued notifications for provider %s", provider.name)
  2012. return
  2013. # Build digest message
  2014. title = f"Daily Digest - {len(queue_entries)} Events"
  2015. # Group by event type
  2016. events_by_type: dict[str, list] = {}
  2017. for entry in queue_entries:
  2018. if entry.event_type not in events_by_type:
  2019. events_by_type[entry.event_type] = []
  2020. events_by_type[entry.event_type].append(entry)
  2021. # Format the digest body
  2022. body_parts = []
  2023. for event_type, entries in events_by_type.items():
  2024. event_label = event_type.replace("_", " ").title()
  2025. body_parts.append(f"== {event_label} ({len(entries)}) ==")
  2026. for entry in entries:
  2027. time_str = entry.created_at.strftime("%H:%M")
  2028. printer_info = f"[{entry.printer_name}] " if entry.printer_name else ""
  2029. body_parts.append(f" {time_str} {printer_info}{entry.title}")
  2030. body_parts.append("")
  2031. body = "\n".join(body_parts)
  2032. # Send the digest
  2033. success, error = await self._send_to_provider(provider, title, body, db)
  2034. # Log the digest
  2035. await self._log_notification(
  2036. db=db,
  2037. provider_id=provider.id,
  2038. event_type="daily_digest",
  2039. title=title,
  2040. message=body,
  2041. success=success,
  2042. error_message=error if not success else None,
  2043. )
  2044. # Clear the queue
  2045. for entry in queue_entries:
  2046. await db.delete(entry)
  2047. await db.commit()
  2048. if success:
  2049. logger.info("Sent daily digest with %s events to %s", len(queue_entries), provider.name)
  2050. else:
  2051. logger.warning("Failed to send daily digest to %s: %s", provider.name, error)
  2052. async def check_and_send_digests(self):
  2053. """Check all providers and send digests if it's their scheduled time."""
  2054. from backend.app.core.database import async_session
  2055. current_time = datetime.now().strftime("%H:%M")
  2056. # Avoid duplicate checks within the same minute
  2057. if current_time == self._last_digest_check:
  2058. return
  2059. self._last_digest_check = current_time
  2060. async with async_session() as db:
  2061. # Find all providers with digest enabled at this time
  2062. result = await db.execute(
  2063. select(NotificationProvider).where(
  2064. NotificationProvider.enabled.is_(True),
  2065. NotificationProvider.daily_digest_enabled.is_(True),
  2066. NotificationProvider.daily_digest_time == current_time,
  2067. )
  2068. )
  2069. providers = result.scalars().all()
  2070. for provider in providers:
  2071. try:
  2072. await self.send_digest(provider.id)
  2073. except Exception as e:
  2074. logger.error("Error sending digest for provider %s: %s", provider.id, e)
  2075. def start_digest_scheduler(self):
  2076. """Start the background scheduler for daily digest notifications."""
  2077. if self._digest_scheduler_task is None:
  2078. self._digest_scheduler_task = asyncio.create_task(self._digest_scheduler_loop())
  2079. logger.info("Notification digest scheduler started")
  2080. def stop_digest_scheduler(self):
  2081. """Stop the background scheduler for daily digests."""
  2082. if self._digest_scheduler_task:
  2083. self._digest_scheduler_task.cancel()
  2084. self._digest_scheduler_task = None
  2085. logger.info("Notification digest scheduler stopped")
  2086. async def _digest_scheduler_loop(self):
  2087. """Background loop that checks for scheduled digests every minute."""
  2088. while True:
  2089. try:
  2090. await self.check_and_send_digests()
  2091. except Exception as e:
  2092. logger.error("Error in digest scheduler: %s", e)
  2093. # Wait until the next minute
  2094. await asyncio.sleep(60)
  2095. # Global instance
  2096. notification_service = NotificationService()