settings.py 91 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042
  1. import io
  2. import json
  3. import logging
  4. import os
  5. import zipfile
  6. from datetime import datetime
  7. from pathlib import Path
  8. from fastapi import APIRouter, Depends, File, HTTPException, UploadFile
  9. from fastapi.responses import FileResponse, JSONResponse
  10. from pydantic import BaseModel, Field
  11. from sqlalchemy import func, select
  12. from sqlalchemy.ext.asyncio import AsyncSession
  13. from backend.app.core.auth import (
  14. RequestPrinterScope,
  15. RequirePermissionIfAuthEnabled,
  16. ScopedCaller,
  17. caller_is_api_key,
  18. is_auth_enabled,
  19. require_auth_if_enabled,
  20. require_energy_cost_update,
  21. )
  22. from backend.app.core.config import APP_VERSION, settings as app_settings
  23. from backend.app.core.database import get_db
  24. from backend.app.core.permissions import Permission
  25. from backend.app.core.printer_scope import PrinterScope
  26. from backend.app.models.settings import Settings
  27. from backend.app.models.user import User
  28. from backend.app.schemas.settings import AppSettings, AppSettingsUpdate
  29. from backend.app.services import camera_light
  30. from backend.app.services.secret_fields import SETTINGS_SECRETS, SecretConfigError, mask_fields, merge_partial
  31. logger = logging.getLogger(__name__)
  32. router = APIRouter(prefix="/settings", tags=["settings"])
  33. DEFAULT_SETTINGS = AppSettings()
  34. # Sensitive credential fields blanked for API-key callers. Everyone else sees
  35. # them as the placeholder (write-only secrets, see services/secret_fields).
  36. _SENSITIVE_FIELDS_FOR_API_KEY = tuple(SETTINGS_SECRETS)
  37. async def get_setting(db: AsyncSession, key: str) -> str | None:
  38. """Get a single setting value by key."""
  39. result = await db.execute(select(Settings).where(Settings.key == key))
  40. setting = result.scalar_one_or_none()
  41. return setting.value if setting else None
  42. # Accepted spellings for a boolean settings value. Settings live in a VARCHAR
  43. # column and every reader compares them as strings, so these are normalised to
  44. # "true"/"false" on the way in. The sets are deliberately generous: these
  45. # endpoints are part of the documented REST surface, reached by scripts and by
  46. # Home Assistant rest_command, where "True", "1" and "on" are all natural.
  47. _TRUTHY_SETTING_VALUES = frozenset({"true", "1", "yes", "on"})
  48. _FALSY_SETTING_VALUES = frozenset({"false", "0", "no", "off"})
  49. def setting_is_true(value: object) -> bool:
  50. """Return True if a *stored* settings value means "on".
  51. Deliberately narrower than the spellings ``normalize_bool_setting`` accepts:
  52. it matches only what every other reader in the codebase treats as on
  53. (``value.lower() == "true"``). Submitted values are canonicalised on write,
  54. so a stored value is always "true"/"false"/""; accepting "1" or "on" here
  55. would make this function disagree with the rest of the app about any legacy
  56. row containing them.
  57. A bool is tolerated for the case of a row written before values were
  58. normalised, where SQLite coerced a raw bool into the VARCHAR column.
  59. """
  60. if isinstance(value, bool):
  61. return value
  62. if value is None:
  63. return False
  64. return str(value).strip().lower() == "true"
  65. def normalize_bool_setting(key: str, value: object) -> str:
  66. """Coerce a boolean-ish settings value to the canonical "true"/"false".
  67. Raises HTTPException(400) for values with no sensible interpretation, so an
  68. API client gets a message naming the field instead of a 500.
  69. A JSON boolean is the natural thing for an API client to send, and before
  70. this normalisation it caused two distinct failures on
  71. ``PUT /settings/spoolman``: ``bool.lower()`` raised AttributeError, and the
  72. raw bool was written into a VARCHAR column, which SQLite silently coerces
  73. to 1/0 while asyncpg rejects outright. Both surfaced as an opaque 500.
  74. """
  75. if isinstance(value, bool): # must precede the int branch — bool is an int
  76. return "true" if value else "false"
  77. if isinstance(value, int):
  78. if value in (0, 1):
  79. return "true" if value else "false"
  80. raise HTTPException(400, f"{key} must be a boolean; got the number {value}")
  81. if isinstance(value, str):
  82. candidate = value.strip().lower()
  83. if not candidate:
  84. # Empty is stored verbatim rather than normalised to "false".
  85. # get_spoolman_settings reads these with ``or "<default>"``, so an
  86. # empty stored value means "use the default" — and two of them
  87. # (spoolman_report_partial_usage, auto_add_unknown_rfid) default to
  88. # ON. Rewriting "" to "false" would silently switch them off for any
  89. # client that submits a blank value.
  90. return ""
  91. if candidate in _TRUTHY_SETTING_VALUES:
  92. return "true"
  93. if candidate in _FALSY_SETTING_VALUES:
  94. return "false"
  95. raise HTTPException(400, f"{key} must be a boolean; got {value!r}")
  96. raise HTTPException(400, f"{key} must be a boolean; got {type(value).__name__}")
  97. def normalize_str_setting(key: str, value: object) -> str:
  98. """Return a string settings value, rejecting types that would store garbage.
  99. ``str()`` on a dict or list would persist its repr, so those are refused
  100. rather than silently written. Numbers are accepted and stringified: a port
  101. or a bare host submitted unquoted is a plausible client mistake, not a
  102. reason to fail the request.
  103. """
  104. if isinstance(value, str):
  105. return value
  106. if value is None:
  107. return ""
  108. if isinstance(value, bool | int | float):
  109. return str(value)
  110. raise HTTPException(400, f"{key} must be a string; got {type(value).__name__}")
  111. async def get_external_base_url(db: AsyncSession) -> str:
  112. """Base URL for links Bambuddy hands to the outside world (no trailing slash).
  113. ``external_url`` is optional and has no default, so anything that must be
  114. absolute — a login link in an e-mail, the one-tap outcome verdict links
  115. (#1898), whose Telegram/ntfy buttons are dropped for a relative URL — falls
  116. back to APP_URL and finally to the dev origin.
  117. """
  118. import os
  119. external_url = await get_setting(db, "external_url")
  120. if external_url:
  121. return external_url.rstrip("/")
  122. return os.environ.get("APP_URL", "http://localhost:5173").rstrip("/")
  123. async def get_external_login_url(db: AsyncSession) -> str:
  124. """Get the external URL for the login page.
  125. Uses external_url from settings if available, otherwise falls back to APP_URL env var.
  126. Args:
  127. db: Database session
  128. Returns:
  129. Full URL to the login page
  130. """
  131. return await get_external_base_url(db) + "/login"
  132. async def set_setting(db: AsyncSession, key: str, value: str) -> None:
  133. """Set a single setting value."""
  134. from backend.app.core.db_dialect import upsert_setting
  135. await upsert_setting(db, Settings, key, value)
  136. # Settings stored as booleans / numbers. Storage is a VARCHAR column, so
  137. # _build_settings_response() parses these back, and update_settings() refuses
  138. # an explicit null for them: a null is stored as the literal "None", which
  139. # reads back as False for a boolean and is not a number at all.
  140. _BOOL_SETTING_KEYS = frozenset(
  141. {
  142. "auto_archive",
  143. "save_thumbnails",
  144. "capture_finish_photo",
  145. "finish_photo_restore_plate",
  146. "spoolman_enabled",
  147. "spoolman_disable_weight_sync",
  148. "spoolman_report_partial_usage",
  149. "auto_add_unknown_rfid",
  150. "disable_filament_warnings",
  151. "prefer_lowest_filament",
  152. "check_updates",
  153. "check_printer_firmware",
  154. "include_beta_updates",
  155. "announcements_enabled",
  156. "announcements_all_users",
  157. "virtual_printer_enabled",
  158. "ftp_retry_enabled",
  159. "mqtt_enabled",
  160. "mqtt_use_tls",
  161. "ha_enabled",
  162. "per_printer_mapping_expanded",
  163. "prometheus_enabled",
  164. "user_notifications_enabled",
  165. "queue_drying_enabled",
  166. "queue_drying_block",
  167. "ambient_drying_enabled",
  168. "print_drying_enabled",
  169. "require_plate_clear",
  170. "queue_shortest_first",
  171. # default_bed_levelling / default_flow_cali / default_nozzle_offset_cali
  172. # are tri-state strings (off/on/auto) — parsed via the raw-string else
  173. # branch; the TriState validator coerces legacy "true"/"false" rows.
  174. "default_vibration_cali",
  175. "default_layer_inspect",
  176. "default_timelapse",
  177. "default_confirm_outcome",
  178. "confirm_outcome_external_prints",
  179. "confirm_default_good_on_plate_clear",
  180. "billing_enabled",
  181. "printer_kill_switch_enabled",
  182. "ldap_enabled",
  183. "ldap_auto_provision",
  184. "local_login_enabled",
  185. "preheat_enabled",
  186. "queue_keep_bed_warm",
  187. }
  188. )
  189. _FLOAT_SETTING_KEYS = frozenset(
  190. {
  191. "default_filament_cost",
  192. "energy_cost_per_kwh",
  193. "camera_light_delay",
  194. "ams_temp_good",
  195. "ams_temp_fair",
  196. "library_disk_warning_gb",
  197. "low_stock_threshold",
  198. }
  199. )
  200. # String settings limited to a fixed set of values, which a stored "None"
  201. # would break when the settings response is built.
  202. _ENUM_SETTING_KEYS = frozenset({"energy_price_source"})
  203. _INT_SETTING_KEYS = frozenset(
  204. {
  205. "ams_humidity_good",
  206. "ams_humidity_fair",
  207. "ams_history_retention_days",
  208. "printer_sensor_history_retention_days",
  209. "ftp_retry_count",
  210. "ftp_retry_delay",
  211. "ftp_timeout",
  212. "mqtt_port",
  213. "stagger_group_size",
  214. "stagger_interval_minutes",
  215. "forecast_global_lead_time_days",
  216. "location_sensor_poll_interval",
  217. "finance_budget_reset_day",
  218. "session_max_hours",
  219. "pipeline_max_copies",
  220. "preheat_max_wait_seconds",
  221. "preheat_soak_seconds",
  222. "queue_keep_warm_bed_temp",
  223. "queue_keep_warm_max_minutes",
  224. "queue_max_concurrent_uploads",
  225. "ambient_drying_sustained_minutes",
  226. }
  227. )
  228. async def _build_settings_response(db: AsyncSession, is_api_key: bool = False, mask: bool = True) -> AppSettings:
  229. """Build the full settings response.
  230. Secrets are blank for API-key callers and the placeholder for everyone else;
  231. ``mask=False`` is for server-side use only (comparing with an update).
  232. """
  233. settings_dict = DEFAULT_SETTINGS.model_dump()
  234. result = await db.execute(select(Settings))
  235. for setting in result.scalars().all():
  236. if setting.key not in settings_dict:
  237. continue
  238. if setting.key in _BOOL_SETTING_KEYS:
  239. settings_dict[setting.key] = setting.value.lower() == "true"
  240. elif setting.key in _FLOAT_SETTING_KEYS or setting.key in _INT_SETTING_KEYS:
  241. # A value that does not parse (the literal "None" from an old
  242. # null save, or a hand-edited row) keeps the default instead of
  243. # taking the whole settings response down with it.
  244. parse = int if setting.key in _INT_SETTING_KEYS else float
  245. try:
  246. settings_dict[setting.key] = parse(setting.value)
  247. except (TypeError, ValueError):
  248. logger.warning("Setting %s has an unparseable value; using the default", setting.key)
  249. elif setting.key in [
  250. # Nullable floats. Settings storage stringifies None to the literal
  251. # "None", which must read back as null here -- not as the default
  252. # the _FLOAT_SETTING_KEYS branch above falls back to (#2905).
  253. "ams_temp_alarm",
  254. ]:
  255. try:
  256. settings_dict[setting.key] = float(setting.value)
  257. except (TypeError, ValueError):
  258. settings_dict[setting.key] = None
  259. elif setting.key == "default_printer_id":
  260. settings_dict[setting.key] = int(setting.value) if setting.value and setting.value != "None" else None
  261. elif setting.key == "open_in_slicer":
  262. # None means "inherit from preferred_slicer" (#1329). The PUT path
  263. # serializes None as the literal string "None"; strip it back so
  264. # the frontend sees a true null and falls back as intended.
  265. settings_dict[setting.key] = setting.value if setting.value and setting.value != "None" else None
  266. else:
  267. settings_dict[setting.key] = setting.value
  268. ha_settings = await get_homeassistant_settings(db)
  269. settings_dict.update(ha_settings)
  270. # ldap_bind_password is never returned to any caller (mask=False is
  271. # server-side only)
  272. if mask or is_api_key:
  273. settings_dict["ldap_bind_password"] = ""
  274. if is_api_key:
  275. for field in _SENSITIVE_FIELDS_FOR_API_KEY:
  276. if field in settings_dict:
  277. settings_dict[field] = ""
  278. elif mask:
  279. settings_dict = mask_fields(settings_dict, SETTINGS_SECRETS)
  280. return AppSettings(**settings_dict)
  281. @router.get("", response_model=AppSettings)
  282. @router.get("/", response_model=AppSettings)
  283. async def get_settings(
  284. db: AsyncSession = Depends(get_db),
  285. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  286. _is_api_key: bool = Depends(caller_is_api_key),
  287. ):
  288. """Get all application settings."""
  289. return await _build_settings_response(db, is_api_key=_is_api_key)
  290. @router.put("/", response_model=AppSettings)
  291. async def update_settings(
  292. settings_update: AppSettingsUpdate,
  293. db: AsyncSession = Depends(get_db),
  294. current_user: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  295. ):
  296. """Update application settings."""
  297. update_data = settings_update.model_dump(exclude_unset=True)
  298. # Write-only secrets: the placeholder keeps the stored value, and a kept
  299. # secret does not follow a changed destination.
  300. stored = (await _build_settings_response(db, mask=False)).model_dump()
  301. secrets = dict(SETTINGS_SECRETS)
  302. if stored.get("ha_token_from_env"):
  303. # The deployment's own token, not a stored secret to enter again: the
  304. # URL may change (the placeholder sent back still writes nothing).
  305. secrets["ha_token"] = ()
  306. try:
  307. update_data = merge_partial(stored, update_data, secrets)
  308. except SecretConfigError as exc:
  309. raise HTTPException(status_code=400, detail=str(exc)) from None
  310. # An explicit null for a boolean or numeric setting has no meaning -- these
  311. # are not clearable -- and would be stored as the literal "None".
  312. null_keys = sorted(
  313. key
  314. for key, value in update_data.items()
  315. if value is None and key in (_BOOL_SETTING_KEYS | _FLOAT_SETTING_KEYS | _INT_SETTING_KEYS | _ENUM_SETTING_KEYS)
  316. )
  317. if null_keys:
  318. raise HTTPException(status_code=422, detail=f"These settings cannot be null: {', '.join(null_keys)}")
  319. # Like an API key's or a provider's printers: a page still open from before
  320. # a printer delete would save the deleted id, which SQLite gives to the next
  321. # printer created (the validator has already checked it is a list of ints).
  322. # Only ids not stored yet are checked: the page sends the whole list, and an
  323. # id already there must not block every save.
  324. if update_data.get("obico_enabled_printers"):
  325. from backend.app.core.printer_scope import ensure_printers_exist
  326. try:
  327. stored = json.loads(await get_setting(db, "obico_enabled_printers") or "[]")
  328. except ValueError:
  329. stored = []
  330. stored = set(stored) if isinstance(stored, list) else set()
  331. added = [i for i in json.loads(update_data["obico_enabled_printers"]) if i not in stored]
  332. await ensure_printers_exist(db, added)
  333. # Safety refusals on disabling local login (#1589). Two failure modes
  334. # would otherwise lock everyone out of the install:
  335. # 1. No enabled OIDC provider exists — nobody could authenticate.
  336. # 2. The caller has no UserOIDCLink — they would lock themselves out
  337. # even if other admins are linked.
  338. # Either case returns HTTP 400 instead of silently saving. The
  339. # ``BAMBUDDY_LOCAL_LOGIN=true`` env-var bypass on /auth/login is a
  340. # separate recovery path; the refusals here protect the *default*
  341. # configuration where the env var is absent.
  342. if update_data.get("local_login_enabled") is False:
  343. from backend.app.models.oidc_provider import OIDCProvider, UserOIDCLink
  344. enabled_count = await db.scalar(select(func.count(OIDCProvider.id)).where(OIDCProvider.is_enabled.is_(True)))
  345. if not enabled_count:
  346. raise HTTPException(
  347. status_code=400,
  348. detail="Cannot disable local login: no OIDC provider is enabled.",
  349. )
  350. if current_user is not None:
  351. caller_links = await db.scalar(
  352. select(func.count(UserOIDCLink.id)).where(UserOIDCLink.user_id == current_user.id)
  353. )
  354. if not caller_links:
  355. raise HTTPException(
  356. status_code=400,
  357. detail="Cannot disable local login: your account has no OIDC link, so you would lock yourself out.",
  358. )
  359. # Check if any MQTT settings are being updated
  360. mqtt_keys = {
  361. "mqtt_enabled",
  362. "mqtt_broker",
  363. "mqtt_port",
  364. "mqtt_username",
  365. "mqtt_password",
  366. "mqtt_topic_prefix",
  367. "mqtt_use_tls",
  368. }
  369. mqtt_updated = bool(mqtt_keys & set(update_data.keys()))
  370. # The page saves every field it shows on each change, so compare against
  371. # what is stored: only a real change of price source is worth a read.
  372. price_source_changed = False
  373. for key in ("energy_price_source", "energy_price_ha_entity"):
  374. if key in update_data and str(update_data[key]) != (await get_setting(db, key) or ""):
  375. price_source_changed = True
  376. for key, value in update_data.items():
  377. # Convert value to string for storage
  378. if isinstance(value, bool):
  379. str_value = "true" if value else "false"
  380. elif value is None:
  381. str_value = "None"
  382. else:
  383. str_value = str(value)
  384. await set_setting(db, key, str_value)
  385. await db.commit()
  386. # Expire all objects to ensure fresh reads after commit
  387. db.expire_all()
  388. if {"camera_light_mode", "camera_light_delay"} & set(update_data.keys()):
  389. camera_light.invalidate_settings()
  390. if price_source_changed:
  391. # Read a newly chosen price sensor now, so the saved settings show its
  392. # price instead of the old one until the next hourly read (#1251).
  393. from backend.app.services.energy_price import current_price
  394. try:
  395. await current_price(db, remember=True)
  396. await db.commit()
  397. except Exception as e:
  398. logger.warning("Could not read the electricity price after saving its source: %s", e)
  399. # Reconfigure MQTT relay if any MQTT settings changed
  400. if mqtt_updated:
  401. try:
  402. from backend.app.services.mqtt_relay import mqtt_relay
  403. mqtt_settings = {
  404. "mqtt_enabled": (await get_setting(db, "mqtt_enabled") or "false") == "true",
  405. "mqtt_broker": await get_setting(db, "mqtt_broker") or "",
  406. "mqtt_port": int(await get_setting(db, "mqtt_port") or "1883"),
  407. "mqtt_username": await get_setting(db, "mqtt_username") or "",
  408. "mqtt_password": await get_setting(db, "mqtt_password") or "",
  409. "mqtt_topic_prefix": await get_setting(db, "mqtt_topic_prefix") or "bambuddy",
  410. "mqtt_use_tls": (await get_setting(db, "mqtt_use_tls") or "false") == "true",
  411. }
  412. await mqtt_relay.configure(mqtt_settings)
  413. except Exception:
  414. pass # Don't fail the settings update if MQTT reconfiguration fails
  415. # Return updated settings, secrets as the placeholder
  416. return await _build_settings_response(db, is_api_key=False)
  417. @router.patch("/", response_model=AppSettings)
  418. @router.patch("", response_model=AppSettings)
  419. async def patch_settings(
  420. settings_update: AppSettingsUpdate,
  421. db: AsyncSession = Depends(get_db),
  422. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  423. ):
  424. """Partially update application settings (same as PUT, for REST compatibility)."""
  425. return await update_settings(settings_update, db, _)
  426. class ElectricityPriceUpdate(BaseModel):
  427. """Payload for ``POST /settings/electricity-price`` (#1356).
  428. Mirrors the field name documented in ``wiki/features/energy.md`` so the
  429. Home Assistant ``rest_command`` example needs only a URL change, not a
  430. payload change. Plain non-negative float; tariffs can go as low as 0.0 in
  431. some markets (e.g. free hours).
  432. """
  433. energy_cost_per_kwh: float = Field(ge=0)
  434. @router.post("/electricity-price", response_model=AppSettings)
  435. async def update_electricity_price(
  436. payload: ElectricityPriceUpdate,
  437. db: AsyncSession = Depends(get_db),
  438. _: ScopedCaller = Depends(require_energy_cost_update()),
  439. _is_api_key: bool = Depends(caller_is_api_key),
  440. ):
  441. """Update the per-kWh electricity cost used by the energy-tracking pipeline.
  442. This is the only settings field writable via API key, gated by the
  443. ``can_update_energy_cost`` toggle on the key. JWT users still need the
  444. standard ``SETTINGS_UPDATE`` permission. See #1356 for the rationale —
  445. the general ``PATCH /settings`` route remains denied for API keys because
  446. it can rewrite SMTP/LDAP/MQTT credentials, which is a much wider surface
  447. than the documented dynamic-tariff use case requires.
  448. """
  449. await set_setting(db, "energy_cost_per_kwh", str(payload.energy_cost_per_kwh))
  450. await db.commit()
  451. db.expire_all()
  452. return await _build_settings_response(db, is_api_key=_is_api_key)
  453. @router.post("/reset", response_model=AppSettings)
  454. async def reset_settings(
  455. db: AsyncSession = Depends(get_db),
  456. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  457. ):
  458. """Reset all settings to defaults."""
  459. # Delete all settings
  460. result = await db.execute(select(Settings))
  461. for setting in result.scalars().all():
  462. await db.delete(setting)
  463. await db.commit()
  464. camera_light.invalidate_settings()
  465. return DEFAULT_SETTINGS
  466. @router.get("/default-sidebar-order")
  467. async def get_default_sidebar_order(
  468. db: AsyncSession = Depends(get_db),
  469. ):
  470. """Get the admin-set default sidebar order.
  471. Intentionally unauthenticated: non-admin users need to read this value to apply
  472. the default sidebar order, but may lack SETTINGS_READ permission.
  473. The value is non-sensitive (sidebar item IDs only).
  474. """
  475. value = await get_setting(db, "default_sidebar_order")
  476. return {"default_sidebar_order": value or ""}
  477. # Fields exposed via /ui-preferences without SETTINGS_READ. Each entry MUST be
  478. # non-sensitive (no credentials, no PII, no secret tokens) — granting SETTINGS_READ
  479. # also grants visibility of SMTP/LDAP/MQTT passwords and similar, so the goal of
  480. # this endpoint is exactly to NOT require that permission for UI rendering hints.
  481. # When adding a field here, confirm it doesn't carry anything sensitive.
  482. _UI_PREFERENCE_FIELDS: tuple[str, ...] = (
  483. "require_plate_clear",
  484. "check_printer_firmware",
  485. "camera_view_mode",
  486. "time_format",
  487. "date_format",
  488. "drying_presets",
  489. "ams_humidity_thresholds",
  490. "ams_humidity_good",
  491. "ams_humidity_fair",
  492. "ams_temp_good",
  493. "ams_temp_fair",
  494. # ams_temp_alarm is deliberately NOT here. This endpoint is unauthenticated
  495. # and exists so the UI can colour readings without SETTINGS_READ; the good /
  496. # fair bands are what the printer card colours by. The alarm threshold
  497. # changes no rendering anywhere -- only SettingsPage reads it, and that is
  498. # behind the settings permissions already (#2905).
  499. "bed_cooled_threshold",
  500. # Temperature / fan-speed presets for the printer-card popovers. Numbers
  501. # only; no PII / credentials.
  502. "nozzle_temp_presets",
  503. "bed_temp_presets",
  504. "chamber_temp_presets",
  505. "fan_speed_presets",
  506. )
  507. @router.get("/ui-preferences")
  508. async def get_ui_preferences(db: AsyncSession = Depends(get_db)):
  509. """Get the curated subset of settings that any page needs to render correctly.
  510. Intentionally not gated on SETTINGS_READ — every authenticated user (and
  511. every page that loads for them) needs these fields, but granting SETTINGS_READ
  512. would also grant visibility of secrets (SMTP/LDAP/MQTT credentials, etc.).
  513. Same pattern as /default-sidebar-order (#1293).
  514. Reuses _build_settings_response so the typed values match what /settings
  515. returns for fields with the same name — bool/int/float/str types stay in
  516. sync without a separate type-coercion path.
  517. """
  518. full = await _build_settings_response(db, is_api_key=False)
  519. dumped = full.model_dump()
  520. return {key: dumped[key] for key in _UI_PREFERENCE_FIELDS if key in dumped}
  521. # Install configuration the app shell reads before it can render correctly.
  522. #
  523. # Deliberately a second list rather than more entries in _UI_PREFERENCE_FIELDS.
  524. # That one is served to anyone at all, on the recorded grounds that its contents
  525. # are "public defaults that ship with the app" (test_route_auth_coverage.py), and
  526. # its field set is pinned by a test written to make anyone adding to it stop and
  527. # think. These fields are not defaults -- they are facts about how this
  528. # particular deployment is configured -- so they get their own endpoint at their
  529. # own trust level instead of stretching that charter to fit them.
  530. _UI_FLAG_FIELDS: tuple[str, ...] = (
  531. # The sidebar hides Finance unless billing is on. Layout read this from
  532. # GET /settings, which requires SETTINGS_READ, so for a non-admin the query
  533. # 403'd, the value arrived undefined, `undefined !== true` held, and the
  534. # entry was hidden from exactly the users cost_centers:read_own exists to
  535. # serve. The page itself was reachable by URL the whole time (#3023).
  536. "billing_enabled",
  537. # Same 403, opposite outcome. That gate tests `=== false`, which undefined
  538. # never satisfies, so an administrator who turned user notifications off
  539. # still left the entry showing -- to precisely the non-admins it governs.
  540. "user_notifications_enabled",
  541. # Not gates, but read by the shell and equally undefined for a non-admin:
  542. # the sponsor prompt fell back to EUR whatever the install uses, and the
  543. # update check ran even where it had been switched off.
  544. "currency",
  545. "check_updates",
  546. # Read by the print dialog, queue, file manager, inventory and SpoolBuddy
  547. # pages, which users without SETTINGS_READ open too: the 403 dropped them
  548. # all to their defaults (with billing on, the print dialog hid the cost
  549. # centre picker and the print was then refused for lacking one).
  550. "queue_shortest_first",
  551. "use_slicer_api",
  552. "open_in_slicer",
  553. "preferred_slicer",
  554. "disable_filament_warnings",
  555. "prefer_lowest_filament",
  556. "per_printer_mapping_expanded",
  557. "default_filament_cost",
  558. "default_bed_levelling",
  559. "default_flow_cali",
  560. "default_vibration_cali",
  561. "default_layer_inspect",
  562. "default_timelapse",
  563. "default_nozzle_offset_cali",
  564. "default_confirm_outcome",
  565. "stagger_group_size",
  566. "stagger_interval_minutes",
  567. "library_disk_warning_gb",
  568. "low_stock_threshold",
  569. "location_sensor_poll_interval",
  570. "location_sensor_alert_defaults",
  571. "pipeline_max_copies",
  572. "language",
  573. "dark_style",
  574. "dark_background",
  575. "dark_accent",
  576. "light_style",
  577. "light_background",
  578. "light_accent",
  579. # Which inventory a new spool goes to (unknown-tag prompt), and the
  580. # forecast's default lead time.
  581. "spoolman_enabled",
  582. "forecast_global_lead_time_days",
  583. # Preselected in the print dialog; withheld below from a caller who may
  584. # not use that printer.
  585. "default_printer_id",
  586. )
  587. @router.get("/ui-flags")
  588. async def get_ui_flags(
  589. db: AsyncSession = Depends(get_db),
  590. _: User | None = Depends(require_auth_if_enabled),
  591. printer_scope: PrinterScope = RequestPrinterScope,
  592. ):
  593. """Install configuration the app shell needs, for any signed-in user.
  594. Gated on being authenticated rather than on ``SETTINGS_READ``. The sidebar
  595. has to know whether billing is enabled before it can decide whether to offer
  596. Finance, and ``SETTINGS_READ`` cannot be the price of knowing that -- it also
  597. grants sight of the SMTP, LDAP and MQTT credentials.
  598. ``require_auth_if_enabled`` returns ``None`` when auth is switched off
  599. entirely, which is the case /ui-preferences was left ungated for. That is the
  600. distinction the two endpoints draw: "works when there is no auth" is not the
  601. same statement as "readable by anyone", and conflating them is what put a
  602. settings read in front of a permission that was never meant to require one.
  603. """
  604. full = await _build_settings_response(db, is_api_key=False)
  605. dumped = full.model_dump()
  606. flags = {key: dumped[key] for key in _UI_FLAG_FIELDS if key in dumped}
  607. if flags.get("default_printer_id") is not None and not printer_scope.allows(flags["default_printer_id"]):
  608. flags["default_printer_id"] = None
  609. # Whether G-code snippets are set up, not the snippets themselves.
  610. flags["has_gcode_snippets"] = bool(dumped.get("gcode_snippets"))
  611. return flags
  612. @router.get("/check-ffmpeg")
  613. async def check_ffmpeg(
  614. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  615. ):
  616. """Check if ffmpeg is installed and available.
  617. Gated on ``SETTINGS_READ`` (audit finding I4 — the binary path was
  618. leaking the host filesystem layout to unauthenticated callers).
  619. ``require_permission_if_auth_enabled`` returns ``None`` only when
  620. auth is disabled (in which case there's no privacy boundary to
  621. enforce); otherwise it raises 401/403 before we get here.
  622. """
  623. from backend.app.services.camera import get_ffmpeg_path
  624. ffmpeg_path = get_ffmpeg_path()
  625. return {
  626. "installed": ffmpeg_path is not None,
  627. "path": ffmpeg_path,
  628. }
  629. @router.get("/spoolman")
  630. async def get_spoolman_settings(
  631. db: AsyncSession = Depends(get_db),
  632. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  633. ):
  634. """Get Spoolman integration settings."""
  635. spoolman_enabled = await get_setting(db, "spoolman_enabled") or "false"
  636. spoolman_url = await get_setting(db, "spoolman_url") or ""
  637. spoolman_sync_mode = await get_setting(db, "spoolman_sync_mode") or "auto"
  638. spoolman_disable_weight_sync = await get_setting(db, "spoolman_disable_weight_sync") or "false"
  639. spoolman_report_partial_usage = await get_setting(db, "spoolman_report_partial_usage") or "true"
  640. auto_add_unknown_rfid = await get_setting(db, "auto_add_unknown_rfid") or "true"
  641. return {
  642. "spoolman_enabled": spoolman_enabled,
  643. "spoolman_url": spoolman_url,
  644. "spoolman_sync_mode": spoolman_sync_mode,
  645. "spoolman_disable_weight_sync": spoolman_disable_weight_sync,
  646. "spoolman_report_partial_usage": spoolman_report_partial_usage,
  647. "auto_add_unknown_rfid": auto_add_unknown_rfid,
  648. }
  649. @router.put("/spoolman")
  650. async def update_spoolman_settings(
  651. settings: dict,
  652. db: AsyncSession = Depends(get_db),
  653. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  654. ):
  655. """Update Spoolman integration settings.
  656. The body is a free-form dict rather than a schema, so each value is
  657. normalised before it is persisted — see ``normalize_bool_setting`` for why
  658. a JSON boolean used to produce a 500 here.
  659. """
  660. if "spoolman_enabled" in settings:
  661. was_enabled = setting_is_true(await get_setting(db, "spoolman_enabled"))
  662. new_val = normalize_bool_setting("spoolman_enabled", settings["spoolman_enabled"])
  663. now_enabled = new_val == "true"
  664. await set_setting(db, "spoolman_enabled", new_val)
  665. # Nothing is deleted on a mode change (#2812). Each mode keeps its slot
  666. # assignments in its own table, so both can hold rows at once and the
  667. # toggle is reversible: switching to Spoolman to see what it does, then
  668. # switching back, returns you to the assignments you had.
  669. #
  670. # This used to empty the other mode's table on every toggle. The reason
  671. # was real -- checks that read both tables would let a row in the mode
  672. # you are not using answer for the mode you are -- but the cost was that
  673. # inspecting a mode destroyed your configuration, with no confirmation
  674. # and no way back, and the deletion was unfiltered across every printer.
  675. # The readers that could be confused now ask which mode is active
  676. # (``spoolman_owns_assignments``), which is where that decision belongs:
  677. # the mode is a property of the install, not of the rows.
  678. if was_enabled != now_enabled:
  679. logger.info(
  680. "Inventory mode switched to %s; slot assignments in both tables kept",
  681. "Spoolman" if now_enabled else "built-in",
  682. )
  683. if "spoolman_url" in settings:
  684. await set_setting(db, "spoolman_url", normalize_str_setting("spoolman_url", settings["spoolman_url"]))
  685. if "spoolman_sync_mode" in settings:
  686. await set_setting(
  687. db, "spoolman_sync_mode", normalize_str_setting("spoolman_sync_mode", settings["spoolman_sync_mode"])
  688. )
  689. for bool_key in ("spoolman_disable_weight_sync", "spoolman_report_partial_usage", "auto_add_unknown_rfid"):
  690. if bool_key in settings:
  691. await set_setting(db, bool_key, normalize_bool_setting(bool_key, settings[bool_key]))
  692. spoolman_changed = "spoolman_enabled" in settings or "spoolman_url" in settings
  693. await db.commit()
  694. db.expire_all()
  695. if spoolman_changed:
  696. from backend.app.services.location_service import maybe_sync_spoolman_locations
  697. if await maybe_sync_spoolman_locations(db):
  698. await db.commit()
  699. # Return updated settings
  700. return await get_spoolman_settings(db)
  701. async def get_homeassistant_settings(db: AsyncSession) -> dict:
  702. """
  703. Get Home Assistant integration settings.
  704. Environment variables (HA_URL, HA_TOKEN) take precedence over database settings.
  705. """
  706. import os
  707. # Check environment variables first
  708. ha_url_env = os.environ.get("HA_URL")
  709. ha_token_env = os.environ.get("HA_TOKEN")
  710. # Fall back to database values
  711. ha_url = ha_url_env or await get_setting(db, "ha_url") or ""
  712. ha_token = ha_token_env or await get_setting(db, "ha_token") or ""
  713. ha_enabled_db = await get_setting(db, "ha_enabled") or "false"
  714. # Track which settings come from environment
  715. ha_url_from_env = bool(ha_url_env)
  716. ha_token_from_env = bool(ha_token_env)
  717. ha_env_managed = ha_url_from_env and ha_token_from_env
  718. # Auto-enable when both env vars are set, otherwise use database value
  719. if ha_url_env and ha_token_env:
  720. ha_enabled = True
  721. else:
  722. ha_enabled = ha_enabled_db.lower() == "true"
  723. return {
  724. "ha_enabled": ha_enabled,
  725. "ha_url": ha_url,
  726. "ha_token": ha_token,
  727. "ha_url_from_env": ha_url_from_env,
  728. "ha_token_from_env": ha_token_from_env,
  729. "ha_env_managed": ha_env_managed,
  730. }
  731. async def create_backup_zip(output_path: Path | None = None) -> tuple[Path, str]:
  732. """Create a complete backup ZIP (database + all data directories).
  733. If output_path is given, the ZIP is written there.
  734. Otherwise a temporary file is created (caller must clean up).
  735. Returns (zip_path, filename).
  736. """
  737. import shutil
  738. import tempfile
  739. from backend.app.core.db_dialect import is_sqlite
  740. base_dir = app_settings.base_dir
  741. filename = f"bambuddy-backup-{datetime.now().strftime('%Y%m%d-%H%M%S')}.zip"
  742. with tempfile.TemporaryDirectory() as temp_dir:
  743. temp_path = Path(temp_dir)
  744. if is_sqlite():
  745. from sqlalchemy import text
  746. from backend.app.core.database import engine
  747. db_path = Path(app_settings.database_url.replace("sqlite+aiosqlite:///", ""))
  748. # Checkpoint WAL to ensure all data is in main db file
  749. async with engine.begin() as conn:
  750. await conn.execute(text("PRAGMA wal_checkpoint(TRUNCATE)"))
  751. # Copy database file
  752. shutil.copy2(db_path, temp_path / "bambuddy.db")
  753. else:
  754. # PostgreSQL: export to a portable SQLite file via SQLAlchemy.
  755. # This makes backups restorable on both SQLite and Postgres installs.
  756. import json
  757. import sqlite3
  758. from sqlalchemy import create_engine as create_sync_engine
  759. from backend.app.core.database import Base, engine
  760. backup_db_path = temp_path / "bambuddy.db"
  761. metadata = Base.metadata
  762. # Build the portable SQLite schema with SQLAlchemy's own DDL rather
  763. # than a hand-rolled CREATE TABLE. metadata.create_all() emits the
  764. # exact schema a native SQLite install gets — NOT NULL, DEFAULT
  765. # (server_default=func.now() → CURRENT_TIMESTAMP), foreign keys,
  766. # unique constraints and indexes. The previous name+type-only
  767. # rebuild dropped all of these, so a Postgres→SQLite restore left
  768. # server_default columns (e.g. spoolbuddy_devices.created_at) with
  769. # no DEFAULT — SQLAlchemy omits such columns on INSERT and the DB
  770. # then wrote NULL, which 500'd on the next read (#2526). Using the
  771. # real DDL also keeps the #1333 BLOB guard: LargeBinary still
  772. # renders as BLOB, so OIDC icon bytes survive the round trip.
  773. schema_engine = create_sync_engine(f"sqlite:///{backup_db_path}")
  774. try:
  775. metadata.create_all(schema_engine)
  776. finally:
  777. schema_engine.dispose()
  778. dst = sqlite3.connect(str(backup_db_path))
  779. # Export data from Postgres to SQLite
  780. async with engine.connect() as conn:
  781. for table in metadata.sorted_tables:
  782. result = await conn.execute(table.select())
  783. rows = result.fetchall()
  784. if not rows:
  785. continue
  786. columns = list(result.keys())
  787. placeholders = ", ".join(["?"] * len(columns))
  788. col_list = ", ".join(columns)
  789. insert_sql = f"INSERT INTO {table.name} ({col_list}) VALUES ({placeholders})" # noqa: S608 # nosec B608 — table/column names from ORM metadata, not user input
  790. def _serialize_row(row):
  791. return tuple(json.dumps(v) if isinstance(v, (list, dict)) else v for v in row)
  792. dst.executemany(insert_sql, [_serialize_row(row) for row in rows])
  793. dst.commit()
  794. dst.close()
  795. logger.info("PostgreSQL backup exported to portable SQLite format")
  796. # Copy data directories (if they exist)
  797. dirs_to_backup = [
  798. ("archive", base_dir / "archive"),
  799. ("virtual_printer", base_dir / "virtual_printer"),
  800. ("plate_calibration", app_settings.plate_calibration_dir),
  801. ("icons", base_dir / "icons"),
  802. ("projects", base_dir / "projects"),
  803. ("overlay-branding", base_dir / "overlay-branding"),
  804. ]
  805. for name, src_dir in dirs_to_backup:
  806. if src_dir.exists() and any(src_dir.iterdir()):
  807. try:
  808. shutil.copytree(
  809. src_dir, temp_path / name
  810. ) # SEC-PATH-OK: name iterates the dirs_to_backup tuple of constant strings ("archive", "virtual_printer", ...)
  811. except shutil.Error as e:
  812. logger.warning("Some files in %s could not be copied: %s", name, e)
  813. except PermissionError as e:
  814. logger.warning("Permission denied copying %s: %s", name, e)
  815. # Say which version made this, so a restore that cannot import it can
  816. # name the versions rather than a list of columns. Backups from before
  817. # this existed simply have no manifest, and restore treats the version
  818. # as unknown.
  819. import json as _json
  820. manifest = {
  821. "format": 1,
  822. "app_version": APP_VERSION,
  823. "created_at": datetime.now().isoformat(timespec="seconds"),
  824. "database": "sqlite" if is_sqlite() else "postgresql",
  825. }
  826. (temp_path / "manifest.json").write_text(_json.dumps(manifest, indent=2) + "\n")
  827. # Include the MFA encryption key as a ZIP top-level entry alongside
  828. # bambuddy.db. Without it, encrypted client_secret / TOTP secret rows
  829. # would be unrecoverable after restore on a host without MFA_ENCRYPTION_KEY set.
  830. from backend.app.core.paths import resolve_data_dir
  831. mfa_key_src = resolve_data_dir() / ".mfa_encryption_key"
  832. if mfa_key_src.exists() and mfa_key_src.is_file():
  833. try:
  834. shutil.copy2(mfa_key_src, temp_path / ".mfa_encryption_key")
  835. except OSError as exc:
  836. logger.error(
  837. "Could not include MFA encryption key in backup (%s). "
  838. "The backup ZIP will not contain the key — restore on a "
  839. "keyless host will fail for encrypted secrets.",
  840. exc,
  841. )
  842. raise
  843. # Create ZIP
  844. if output_path is not None:
  845. zip_file = (
  846. output_path / filename
  847. ) # SEC-PATH-OK: filename = f"bambuddy-backup-{datetime.now()...}.zip" generated in create_backup_zip itself
  848. else:
  849. fd, tmp = tempfile.mkstemp(suffix=".zip")
  850. os.close(fd)
  851. zip_file = Path(tmp)
  852. with zipfile.ZipFile(zip_file, "w", zipfile.ZIP_DEFLATED) as zf:
  853. for file_path in temp_path.rglob("*"):
  854. if file_path.is_file():
  855. arcname = file_path.relative_to(temp_path)
  856. zf.write(file_path, arcname)
  857. return zip_file, filename
  858. @router.get("/backup")
  859. async def create_backup(
  860. db: AsyncSession = Depends(get_db),
  861. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_BACKUP),
  862. ):
  863. """Create a complete backup (database + all files) as a ZIP download."""
  864. from starlette.background import BackgroundTask
  865. try:
  866. zip_file, filename = await create_backup_zip()
  867. return FileResponse(
  868. path=zip_file,
  869. filename=filename,
  870. media_type="application/zip",
  871. background=BackgroundTask(lambda: zip_file.unlink(missing_ok=True)),
  872. )
  873. except Exception as e:
  874. logger.error("Backup failed: %s", e, exc_info=True)
  875. return JSONResponse(
  876. status_code=500,
  877. content={"success": False, "message": "Backup failed. Check server logs for details."},
  878. )
  879. class BackupSchemaIncompatible(Exception):
  880. """The backup has no value for a column this version requires.
  881. A backup carries the schema of the install that made it. Restoring it into
  882. a different version means the destination can have NOT NULL columns the
  883. backup never heard of -- either because that version is older and still has
  884. a column since removed (``user_wallets.currency``, dropped in #3123), or
  885. because it is newer and has added one. Most such columns have a default and
  886. can simply be filled. The ones that cannot are what this reports, and it has
  887. to be reported BEFORE the restore drops anything: the Postgres import wipes
  888. every table in the first transaction, so a failure halfway leaves the
  889. install with an empty schema and the previous data gone.
  890. """
  891. def _missing_required_columns(pg_table, src_columns: set[str]):
  892. """Split the destination's NOT NULL columns that the backup lacks.
  893. Returns ``(injectable, db_filled, unfillable)``:
  894. * ``injectable`` -- ``{name: value}`` from the model's Python-side default.
  895. These are invisible to the import's raw SQL: SQLAlchemy applies a
  896. ``default=`` on ORM and Core inserts, never on ``text()``, and
  897. ``create_all`` emits no DDL default for one. So a column like
  898. ``currency VARCHAR(3) NOT NULL`` with ``default="EUR"`` arrives with
  899. nothing to put in it unless we put it there.
  900. * ``db_filled`` -- has a server default or is the autoincrement key; the
  901. database fills it when the column is left out of the INSERT.
  902. * ``unfillable`` -- nothing can supply a value. The backup is incompatible.
  903. """
  904. injectable: dict = {}
  905. db_filled: list[str] = []
  906. unfillable: list[str] = []
  907. for col in pg_table.columns:
  908. if col.nullable or col.name in src_columns:
  909. continue
  910. if col.default is not None:
  911. arg = col.default.arg
  912. injectable[col.name] = arg(None) if callable(arg) else arg
  913. elif col.server_default is not None or col.primary_key:
  914. db_filled.append(col.name)
  915. else:
  916. unfillable.append(col.name)
  917. return injectable, db_filled, unfillable
  918. def check_backup_schema_compatible(sqlite_path: Path, backup_version: str | None = None) -> None:
  919. """Raise if this version cannot import that backup. Touches nothing.
  920. Only the cross-engine path needs this. A SQLite install restores by copying
  921. the backup's pages, schema included, and `init_db()` migrates it forward
  922. afterwards; the Postgres import instead recreates the schema from THIS
  923. process's ORM and then inserts the backup's columns into it.
  924. """
  925. import sqlite3
  926. from backend.app.core.database import Base
  927. src = sqlite3.connect(f"file:{sqlite_path}?mode=ro", uri=True)
  928. try:
  929. src_tables = {
  930. row[0]
  931. for row in src.execute(
  932. "SELECT name FROM sqlite_master WHERE type='table' "
  933. "AND name NOT LIKE 'sqlite_%' AND name NOT LIKE 'archive_fts%'"
  934. )
  935. }
  936. problems: list[str] = []
  937. # metadata.tables, not sorted_tables: the latter warns about the
  938. # library_files/library_folders/print_archives cycle, and nothing here
  939. # depends on the order.
  940. for name, pg_table in Base.metadata.tables.items():
  941. if name not in src_tables:
  942. continue
  943. # An empty table inserts nothing, so a column it cannot supply
  944. # cannot fail. Refusing a restore over one would be a false alarm.
  945. if src.execute(f'SELECT 1 FROM "{name}" LIMIT 1').fetchone() is None: # noqa: S608 # nosec B608 — name comes from ORM metadata
  946. continue
  947. src_columns = {row[1] for row in src.execute(f'PRAGMA table_info("{name}")')}
  948. _, _, unfillable = _missing_required_columns(pg_table, src_columns)
  949. problems.extend(f"{name}.{col}" for col in unfillable)
  950. finally:
  951. src.close()
  952. if not problems:
  953. return
  954. made_by = f"The backup was made by Bambuddy {backup_version}, " if backup_version else "The backup "
  955. raise BackupSchemaIncompatible(
  956. "This backup cannot be restored by this version of Bambuddy. It carries no value for "
  957. f"{len(problems)} column(s) this version requires and cannot default: {', '.join(sorted(problems))}. "
  958. f"{made_by}and this install runs {APP_VERSION}. Restore it on the version that made it, or "
  959. "upgrade this install to that version. Nothing has been changed."
  960. )
  961. def _read_backup_manifest(temp_path: Path) -> dict:
  962. """The backup's manifest.json, or {} for a backup made before it existed."""
  963. import json
  964. path = temp_path / "manifest.json"
  965. if not path.is_file():
  966. return {}
  967. try:
  968. data = json.loads(path.read_text())
  969. except (OSError, ValueError) as exc:
  970. logger.warning("Ignoring unreadable backup manifest: %s", exc)
  971. return {}
  972. return data if isinstance(data, dict) else {}
  973. def _restored_value_fixes(table_name: str) -> dict[str, tuple[tuple[str, ...], str]]:
  974. """Columns of ``table_name`` whose backed-up value must be one of a set, with its fallback.
  975. Older versions stored any project priority or status; one longer than the
  976. column fails the whole import on PostgreSQL. The fallbacks are the ones
  977. project import and the start-up repair use.
  978. """
  979. if table_name != "projects":
  980. return {}
  981. from backend.app.models.project import PROJECT_PRIORITIES, PROJECT_STATUSES
  982. return {"priority": (PROJECT_PRIORITIES, "normal"), "status": (PROJECT_STATUSES, "active")}
  983. async def _import_sqlite_to_postgres(sqlite_path: Path):
  984. """Import data from a SQLite database file into the current PostgreSQL database.
  985. Used for cross-database restore (SQLite backup → PostgreSQL).
  986. Reads all tables from the SQLite file and bulk-inserts into Postgres.
  987. """
  988. import sqlite3
  989. from sqlalchemy import text
  990. from backend.app.core.database import AUTOINCREMENT_TABLES, Base, _create_engine, highest_referenced_id
  991. # Before anything is dropped. The route checks this too, earlier and with
  992. # the backup's version in the message; this call is what makes the guarantee
  993. # a property of the import itself rather than of one caller.
  994. check_backup_schema_compatible(sqlite_path)
  995. # Create a temporary engine for the import (current engine was disposed)
  996. pg_engine = _create_engine()
  997. try:
  998. # Open SQLite file directly (sync — it's a local file read)
  999. src = sqlite3.connect(str(sqlite_path))
  1000. src.row_factory = sqlite3.Row
  1001. # Get list of tables from SQLite (skip internal/FTS tables)
  1002. cursor = src.execute(
  1003. "SELECT name FROM sqlite_master WHERE type='table' "
  1004. "AND name NOT LIKE 'sqlite_%' AND name NOT LIKE 'archive_fts%'"
  1005. )
  1006. src_tables = {row["name"] for row in cursor.fetchall()}
  1007. # Where SQLite's own counters stand: ids freed there are not given out
  1008. # again on PostgreSQL either (a backup from before they were kept has none).
  1009. src_counters: dict[str, int] = {}
  1010. if src.execute("SELECT 1 FROM sqlite_master WHERE name = 'sqlite_sequence'").fetchone():
  1011. src_counters = {row["name"]: row["seq"] for row in src.execute("SELECT name, seq FROM sqlite_sequence")}
  1012. # Get Postgres tables from our ORM models
  1013. metadata = Base.metadata
  1014. pg_tables = set(metadata.tables.keys())
  1015. # Only import tables that exist in both source and destination
  1016. tables_to_import = src_tables & pg_tables
  1017. sorted_tables = [t.name for t in metadata.sorted_tables if t.name in tables_to_import]
  1018. # Phase 1: Drop all tables and recreate WITHOUT foreign keys.
  1019. # This avoids all FK ordering/orphan issues during import; the
  1020. # constraints go back on at the end, once every row has landed.
  1021. async with pg_engine.begin() as conn:
  1022. # Cap how long DROP TABLE will wait for AccessExclusiveLock so
  1023. # any residual concurrent writer (per-printer MQTT clients
  1024. # writing reactively, an AMS history recorder firing on its
  1025. # hourly cadence) surfaces a fast `lock_timeout` error instead
  1026. # of blocking the restore for 30 s or producing a deadlock.
  1027. # SET LOCAL scopes to this transaction only; outside this
  1028. # restore path the global default (no timeout) applies.
  1029. await conn.execute(text("SET LOCAL lock_timeout = '10s'"))
  1030. # Drop every existing table in the public schema with CASCADE
  1031. # rather than `metadata.drop_all`. Two reasons:
  1032. # 1. The user's live DB may carry orphan tables from removed
  1033. # features (e.g. the legacy `spoolman_slot_assignments`,
  1034. # `spoolman_k_profile`) that hold FK constraints back to
  1035. # ORM tables. `drop_all` doesn't know they exist and emits
  1036. # `DROP TABLE printers` without CASCADE — Postgres refuses
  1037. # and the whole restore aborts (#XXXX).
  1038. # 2. Even within the metadata, `drop_all` is FK-ordered and
  1039. # breaks if a future schema rename leaves old constraints
  1040. # around. CASCADE is the right tool for a destructive
  1041. # restore: the user is intentionally wiping state.
  1042. await conn.execute(
  1043. text(
  1044. "DO $$ DECLARE r RECORD; BEGIN "
  1045. "FOR r IN (SELECT tablename FROM pg_tables WHERE schemaname = 'public') LOOP "
  1046. "EXECUTE 'DROP TABLE IF EXISTS public.' || quote_ident(r.tablename) || ' CASCADE'; "
  1047. "END LOOP; END $$;"
  1048. )
  1049. )
  1050. await conn.run_sync(metadata.create_all)
  1051. # Now strip the foreign keys, at the database level.
  1052. #
  1053. # This used to be done by discarding each ForeignKeyConstraint
  1054. # from `table.constraints` before `create_all`. That only
  1055. # suppresses the inline REFERENCES clause inside CREATE TABLE:
  1056. # `Table.foreign_key_constraints` is derived from the *columns'*
  1057. # ForeignKey objects, which the discard never touched. When
  1058. # `create_all` meets a dependency cycle it can't sort -- and
  1059. # library_files / library_folders / print_archives are exactly
  1060. # such a cycle -- it falls back to emitting those tables' keys
  1061. # as separate ALTER TABLE ... ADD FOREIGN KEY statements read
  1062. # straight from that property. Twelve constraints survived,
  1063. # including library_files.folder_id, and because the same cycle
  1064. # also drops the ordering edge from `sorted_tables` the child
  1065. # table was imported before its parent and the restore died on
  1066. # a ForeignKeyViolationError.
  1067. #
  1068. # Dropping them from pg_constraint instead is indifferent to how
  1069. # create_all chose to emit them, so a future model cycle cannot
  1070. # reintroduce this. It also keeps the app's global Base.metadata
  1071. # untouched: the old code only put the constraints back *after*
  1072. # the transaction, so a failure in here left the running process
  1073. # with an FK-less metadata until restart.
  1074. await conn.execute(
  1075. text(
  1076. "DO $$ DECLARE r RECORD; BEGIN "
  1077. "FOR r IN (SELECT conrelid::regclass AS tbl, conname FROM pg_constraint "
  1078. "WHERE contype = 'f' AND connamespace = 'public'::regnamespace) LOOP "
  1079. "EXECUTE 'ALTER TABLE ' || r.tbl || ' DROP CONSTRAINT ' || quote_ident(r.conname); "
  1080. "END LOOP; END $$;"
  1081. )
  1082. )
  1083. # Phase 2: Import data (no FKs to worry about)
  1084. async with pg_engine.begin() as conn:
  1085. # Import each table in dependency order (parents before children)
  1086. for table_name in sorted_tables:
  1087. rows = src.execute(f"SELECT * FROM {table_name}").fetchall() # noqa: S608 # nosec B608
  1088. if not rows:
  1089. continue
  1090. # Filter to columns that exist in the Postgres table
  1091. src_columns = rows[0].keys()
  1092. pg_table = metadata.tables.get(table_name)
  1093. pg_columns = {c.name for c in pg_table.columns} if pg_table is not None else set()
  1094. columns = [c for c in src_columns if c in pg_columns]
  1095. if not columns:
  1096. continue
  1097. # Columns this schema requires that the backup does not have at
  1098. # all. The block below handles a column PRESENT in the backup
  1099. # with a NULL in it; one the backup never had is not in
  1100. # `columns` and so never reached it -- which is how a backup
  1101. # from an install without `user_wallets.currency` died on
  1102. # NotNullViolationError against a version that still had it.
  1103. injected, _db_filled, _unfillable = _missing_required_columns(pg_table, set(src_columns))
  1104. if injected:
  1105. logger.info(
  1106. "Filling %s column(s) absent from the backup in %s: %s",
  1107. len(injected),
  1108. table_name,
  1109. ", ".join(sorted(injected)),
  1110. )
  1111. insert_columns = columns + list(injected)
  1112. col_list = ", ".join(insert_columns)
  1113. param_list = ", ".join(f":{c}" for c in insert_columns)
  1114. # ON CONFLICT DO NOTHING handles duplicate rows from SQLite (which doesn't enforce unique constraints)
  1115. insert_sql = text(f"INSERT INTO {table_name} ({col_list}) VALUES ({param_list}) ON CONFLICT DO NOTHING") # noqa: S608 # nosec B608
  1116. # Identify columns that need type conversion (SQLite stores booleans
  1117. # as int and datetimes as str — asyncpg requires native Python types)
  1118. from datetime import datetime as dt
  1119. bool_columns = set()
  1120. datetime_columns = set()
  1121. not_null_defaults = {} # col_name -> default value for NOT NULL columns
  1122. if pg_table is not None:
  1123. for col in pg_table.columns:
  1124. if col.name not in columns:
  1125. continue
  1126. col_type = str(col.type)
  1127. if col_type == "BOOLEAN":
  1128. bool_columns.add(col.name)
  1129. elif col_type in ("DATETIME", "TIMESTAMP WITHOUT TIME ZONE", "TIMESTAMP WITH TIME ZONE"):
  1130. datetime_columns.add(col.name)
  1131. # Track NOT NULL columns with defaults — older backups may have NULL
  1132. # for columns added after the backup was created
  1133. if not col.nullable:
  1134. if col.default is not None:
  1135. default = col.default.arg
  1136. if callable(default):
  1137. default = default(None)
  1138. not_null_defaults[col.name] = default
  1139. elif col.server_default is not None:
  1140. # server_default=func.now() → use current timestamp
  1141. if col.name in datetime_columns:
  1142. not_null_defaults[col.name] = "__now__"
  1143. else:
  1144. # Try to extract literal server default
  1145. sd = str(col.server_default.arg) if hasattr(col.server_default, "arg") else None
  1146. if sd is not None:
  1147. not_null_defaults[col.name] = sd
  1148. now = dt.now()
  1149. value_fixes = _restored_value_fixes(table_name)
  1150. def _convert_row(
  1151. row,
  1152. cols=columns,
  1153. bools=bool_columns,
  1154. dts=datetime_columns,
  1155. nn_defaults=not_null_defaults,
  1156. _now=now,
  1157. inject=injected,
  1158. fixes=value_fixes,
  1159. ):
  1160. result = dict(inject)
  1161. for c in cols:
  1162. val = row[c]
  1163. if val is None and c in nn_defaults:
  1164. val = _now if nn_defaults[c] == "__now__" else nn_defaults[c]
  1165. if val is not None:
  1166. if c in bools:
  1167. val = bool(val)
  1168. elif c in dts and isinstance(val, str):
  1169. try:
  1170. val = dt.fromisoformat(val)
  1171. except ValueError:
  1172. pass
  1173. result[c] = val
  1174. for c, (allowed, fallback) in fixes.items():
  1175. if c in result and result[c] not in allowed:
  1176. result[c] = fallback
  1177. return result
  1178. batch = [_convert_row(row) for row in rows]
  1179. await conn.execute(insert_sql, batch)
  1180. logger.info("Imported %d rows into %s", len(batch), table_name)
  1181. # Reset sequences to max(id) + 1 for each table with an id column;
  1182. # for AUTOINCREMENT_TABLES past SQLite's counter and every id still
  1183. # referred to, so a deleted row's id is not given to a new one.
  1184. for table_name in sorted_tables:
  1185. try:
  1186. async with conn.begin_nested():
  1187. result = await conn.execute(text(f"SELECT MAX(id) FROM {table_name}")) # noqa: S608 # nosec B608
  1188. max_id = result.scalar()
  1189. if table_name in AUTOINCREMENT_TABLES:
  1190. max_id = max(
  1191. max_id or 0,
  1192. src_counters.get(table_name) or 0,
  1193. await highest_referenced_id(conn, table_name),
  1194. )
  1195. if max_id:
  1196. seq_name = f"{table_name}_id_seq"
  1197. await conn.execute(text(f"SELECT setval('{seq_name}', {max_id})")) # noqa: S608
  1198. except Exception:
  1199. pass # Table may not have an id column or sequence
  1200. src.close()
  1201. logger.info("Cross-database import complete: %d tables imported", len(tables_to_import))
  1202. # Recreate FK constraints from ORM metadata, which Phase 1 left intact.
  1203. # Use individual transactions so orphaned SQLite data doesn't block valid FKs.
  1204. from sqlalchemy.schema import AddConstraint
  1205. failed_fks = []
  1206. for table in metadata.sorted_tables:
  1207. for fk in table.foreign_key_constraints:
  1208. try:
  1209. async with pg_engine.begin() as fk_conn:
  1210. await fk_conn.execute(AddConstraint(fk))
  1211. except Exception as e:
  1212. # Name the constraint by what it links, not by `fk.name`:
  1213. # these are unnamed in the ORM, so that field is None and
  1214. # the warning used to read "print_archives.None" for every
  1215. # one of the five keys on that table -- unusable for
  1216. # working out which rows to go and look at.
  1217. cols = ", ".join(c.name for c in fk.columns)
  1218. target = fk.elements[0].target_fullname if fk.elements else "unknown"
  1219. failed_fks.append(f"{table.name}({cols}) -> {target}")
  1220. # Postgres puts the offending key in a DETAIL line; it
  1221. # names the exact orphan value, which is the one thing
  1222. # that turns this into an actionable report.
  1223. detail = next(
  1224. (ln.strip() for ln in str(e).splitlines() if ln.startswith("DETAIL:")),
  1225. str(e).splitlines()[0] if str(e) else e.__class__.__name__,
  1226. )
  1227. logger.info("FK %s(%s) -> %s not restored: %s", table.name, cols, target, detail)
  1228. if failed_fks:
  1229. logger.warning(
  1230. "Could not restore %d FK constraints (orphaned data in the backup): %s. "
  1231. "The data is restored and usable; those columns are simply no longer "
  1232. "enforced. See the INFO lines above for the offending key in each case.",
  1233. len(failed_fks),
  1234. ", ".join(failed_fks),
  1235. )
  1236. finally:
  1237. await pg_engine.dispose()
  1238. @router.post("/restore")
  1239. async def restore_backup(
  1240. file: UploadFile = File(...),
  1241. db: AsyncSession = Depends(get_db),
  1242. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_RESTORE),
  1243. ):
  1244. """Restore from a complete backup ZIP.
  1245. Replaces the database and all data directories from the backup ZIP.
  1246. Requires a restart after restore.
  1247. """
  1248. import shutil
  1249. import tempfile
  1250. from fastapi import HTTPException
  1251. from backend.app.core.database import close_all_connections, init_db, reinitialize_database
  1252. from backend.app.core.db_dialect import is_sqlite
  1253. from backend.app.services.virtual_printer import virtual_printer_manager
  1254. base_dir = app_settings.base_dir
  1255. with tempfile.TemporaryDirectory() as temp_dir:
  1256. temp_path = Path(temp_dir)
  1257. # 1. Read and extract ZIP
  1258. content = await file.read()
  1259. # Check if it's a valid ZIP
  1260. if not file.filename or not file.filename.endswith(".zip"):
  1261. raise HTTPException(400, "Invalid backup file: must be a .zip file")
  1262. try:
  1263. with zipfile.ZipFile(io.BytesIO(content), "r") as zf:
  1264. for name in zf.namelist():
  1265. # Reject path-traversal payloads: any entry whose resolved
  1266. # path escapes temp_path would allow writing arbitrary files
  1267. # on the host (ZipSlip / CVE-2006-5456).
  1268. dest = (
  1269. temp_path / name
  1270. ).resolve() # SEC-PATH-OK: is_relative_to containment check below before extractall
  1271. # is_relative_to (Python 3.9+) covers both relative
  1272. # path-traversal (../etc/passwd) and absolute-path overrides
  1273. # (/etc/passwd) — str.startswith was vulnerable to
  1274. # prefix-collision attacks (e.g. /tmp/abc_evil/file passing
  1275. # a /tmp/abc prefix check).
  1276. if not dest.is_relative_to(temp_path.resolve()):
  1277. raise HTTPException(400, f"Invalid backup: unsafe path in ZIP: {name!r}")
  1278. zf.extractall(temp_path)
  1279. except zipfile.BadZipFile:
  1280. raise HTTPException(400, "Invalid backup file: not a valid ZIP")
  1281. # 2. Validate backup
  1282. backup_db = temp_path / "bambuddy.db"
  1283. if not backup_db.exists():
  1284. raise HTTPException(400, "Invalid backup: missing bambuddy.db")
  1285. # 2b. Can this version import this backup at all?
  1286. #
  1287. # Deliberately here: everything below has a side effect. The virtual
  1288. # printer stops, background services stop, the MFA key file is
  1289. # overwritten with the backup's -- and then the Postgres import drops
  1290. # every table in its first transaction. A backup rejected at the INSERT
  1291. # took the install's data with it and left the encrypted secrets under a
  1292. # key that no longer matches. Nothing above this line has touched
  1293. # anything.
  1294. import sqlite3
  1295. manifest = _read_backup_manifest(temp_path)
  1296. backup_version = manifest.get("app_version")
  1297. if backup_version:
  1298. logger.info("Backup was created by Bambuddy %s; this install runs %s", backup_version, APP_VERSION)
  1299. if not is_sqlite():
  1300. try:
  1301. check_backup_schema_compatible(backup_db, backup_version)
  1302. except BackupSchemaIncompatible as exc:
  1303. logger.error("Refusing backup: %s", exc)
  1304. raise HTTPException(400, str(exc)) from exc
  1305. except sqlite3.DatabaseError as exc:
  1306. raise HTTPException(400, f"Invalid backup: bambuddy.db is not readable ({exc})") from exc
  1307. try:
  1308. import asyncio
  1309. # 3. Stop virtual printer if running (releases file locks)
  1310. try:
  1311. if virtual_printer_manager.is_enabled:
  1312. logger.info("Stopping virtual printer for restore...")
  1313. await virtual_printer_manager.configure(enabled=False)
  1314. await asyncio.sleep(1)
  1315. except Exception as e:
  1316. logger.warning("Failed to stop virtual printer: %s", e)
  1317. # 3b. Pause timer-based background services BEFORE the DB swap.
  1318. # close_all_connections() below only disposes the engine's pool,
  1319. # not the asyncio tasks that opened sessions from it. The print
  1320. # scheduler (30 s cadence), smart-plug snapshot loop (30 s), and
  1321. # notification digest loop all
  1322. # wake up and call async_session(), which lazily re-creates a
  1323. # pool connection holding RowExclusiveLock on print_queue /
  1324. # smart_plug_energy_snapshots / etc. The DROP TABLE CASCADE
  1325. # pass in the PostgreSQL restore path needs AccessExclusiveLock
  1326. # on every public table, producing an AB/BA deadlock and a
  1327. # full restore rollback. Successful restore already requires a
  1328. # container restart, so we don't restart the services here.
  1329. try:
  1330. from backend.app.services.notification_service import notification_service
  1331. from backend.app.services.print_scheduler import scheduler as print_scheduler
  1332. from backend.app.services.smart_plug_manager import smart_plug_manager
  1333. logger.info("Pausing background services for restore...")
  1334. print_scheduler.stop()
  1335. smart_plug_manager.stop_scheduler()
  1336. notification_service.stop_digest_scheduler()
  1337. # In-flight loop iterations need a moment to commit + release
  1338. # their DB sessions before we dispose() the engine pool.
  1339. await asyncio.sleep(1.0)
  1340. except Exception as e:
  1341. logger.warning("Could not cleanly pause background services: %s", e)
  1342. # 4. Close current database connections
  1343. logger.info("Closing database connections...")
  1344. await close_all_connections()
  1345. # B1: Restore the MFA encryption key file BEFORE the database swap.
  1346. # If the key write fails (OSError, RO disk, full disk, EACCES) we
  1347. # can still abort while the live DB is intact. Doing this AFTER the
  1348. # DB swap would leave the database with rows encrypted under the
  1349. # backup's key but the running install holding only the old key —
  1350. # every encrypted secret becomes unrecoverable.
  1351. from backend.app.core.paths import resolve_data_dir
  1352. mfa_key_src = temp_path / ".mfa_encryption_key"
  1353. if mfa_key_src.exists() and mfa_key_src.is_file():
  1354. dst_key = resolve_data_dir() / ".mfa_encryption_key"
  1355. tmp_key = dst_key.parent / ".mfa_encryption_key.restore-tmp"
  1356. try:
  1357. dst_key.parent.mkdir(parents=True, exist_ok=True)
  1358. # S1: atomic write with restrictive mode from creation.
  1359. # O_TRUNC because a stale tmp may exist from a prior
  1360. # failed restore attempt — we want to overwrite it.
  1361. fd = os.open(str(tmp_key), os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
  1362. try:
  1363. os.write(fd, mfa_key_src.read_bytes())
  1364. finally:
  1365. os.close(fd)
  1366. # POSIX rename(2) — atomic when source/dest are on the
  1367. # same filesystem (we're staying inside dst_key.parent).
  1368. os.replace(str(tmp_key), str(dst_key))
  1369. # S9: warn if the FS doesn't enforce 0o600
  1370. actual_mode = dst_key.stat().st_mode & 0o777
  1371. if actual_mode != 0o600:
  1372. logger.warning(
  1373. "Restored MFA key file %s: filesystem did not enforce 0o600 "
  1374. "(actual: 0o%o). Key may be world-readable on Windows / SMB / FUSE.",
  1375. dst_key,
  1376. actual_mode,
  1377. )
  1378. logger.info("Restored .mfa_encryption_key from backup")
  1379. except OSError as e:
  1380. logger.error(
  1381. "Could not write restored MFA key file to %s: %s — "
  1382. "aborting BEFORE database swap (DB unchanged).",
  1383. dst_key,
  1384. e,
  1385. exc_info=True,
  1386. )
  1387. raise HTTPException(
  1388. status_code=500,
  1389. detail=("Restore aborted: MFA key write failed. Database is unchanged. Check server logs."),
  1390. ) from e
  1391. # 5. Replace database
  1392. logger.info("Restoring database from backup...")
  1393. if is_sqlite():
  1394. db_path = Path(app_settings.database_url.replace("sqlite+aiosqlite:///", ""))
  1395. # Use SQLite's online backup API instead of shutil.copy2.
  1396. # The pragma at database.py:19 runs the live DB in WAL mode,
  1397. # which means a naive file copy is unsafe: anything written
  1398. # to the live DB before this call that hasn't been
  1399. # checkpointed yet (seed_default_groups + init_db on first
  1400. # start, plus whatever background heartbeats wrote during
  1401. # the request window) sits in bambuddy.db-wal with valid
  1402. # checksums. The route handler's own `db: Depends(get_db)`
  1403. # session also keeps a connection checked out across
  1404. # engine.dispose(), holding fds to the WAL inode. With
  1405. # `shutil.copy2` SQLite finds the stale WAL on the next
  1406. # open and silently re-applies those page-level writes on
  1407. # top of the restored DB, partially clobbering it with
  1408. # fresh-install state — the user sees a "successful"
  1409. # restore where most rows and settings have reverted to
  1410. # defaults (#1211 / #668). The page-by-page backup API
  1411. # opens both DBs as real SQLite connections, takes the
  1412. # right locks, and routes new pages through the live DB's
  1413. # own WAL — so concurrent open sessions see their own
  1414. # snapshot until they close (transaction isolation) but
  1415. # can't corrupt the restored state.
  1416. import sqlite3
  1417. src_conn = sqlite3.connect(str(backup_db))
  1418. try:
  1419. dst_conn = sqlite3.connect(str(db_path))
  1420. try:
  1421. src_conn.backup(dst_conn)
  1422. finally:
  1423. dst_conn.close()
  1424. finally:
  1425. src_conn.close()
  1426. else:
  1427. # Import SQLite backup into PostgreSQL
  1428. logger.info("Importing SQLite backup into PostgreSQL...")
  1429. await _import_sqlite_to_postgres(backup_db)
  1430. # 6. Replace data directories
  1431. # For Docker compatibility: clear contents then copy (don't delete mount points)
  1432. dirs_to_restore = [
  1433. ("archive", base_dir / "archive"),
  1434. ("virtual_printer", base_dir / "virtual_printer"),
  1435. ("plate_calibration", app_settings.plate_calibration_dir),
  1436. ("icons", base_dir / "icons"),
  1437. ("projects", base_dir / "projects"),
  1438. ("overlay-branding", base_dir / "overlay-branding"),
  1439. ]
  1440. skipped_dirs = []
  1441. for name, dest_dir in dirs_to_restore:
  1442. src_dir = (
  1443. temp_path / name
  1444. ) # SEC-PATH-OK: name iterates the dirs_to_restore tuple of constant strings ("archive", "virtual_printer", ...)
  1445. if src_dir.exists():
  1446. logger.info("Restoring %s directory...", name)
  1447. try:
  1448. # Clear destination contents (not the dir itself - may be Docker mount)
  1449. if dest_dir.exists():
  1450. for item in dest_dir.iterdir():
  1451. try:
  1452. if item.is_dir():
  1453. shutil.rmtree(item)
  1454. else:
  1455. item.unlink()
  1456. except OSError as e:
  1457. logger.warning("Could not delete %s: %s", item, e)
  1458. else:
  1459. dest_dir.mkdir(parents=True, exist_ok=True)
  1460. # Copy contents from backup
  1461. for item in src_dir.iterdir():
  1462. dest_item = dest_dir / item.name
  1463. if item.is_dir():
  1464. shutil.copytree(item, dest_item)
  1465. else:
  1466. shutil.copy2(item, dest_item)
  1467. except OSError as e:
  1468. logger.warning("Could not restore %s directory: %s", name, e)
  1469. skipped_dirs.append(name)
  1470. # 7. Reset the encryption singleton so the migration that runs
  1471. # inside init_db() picks up the restored key file (if a new one
  1472. # was written above). Without this reset, _get_fernet would
  1473. # return the cached Fernet instance built from the previous key.
  1474. import backend.app.core.encryption as _enc_mod
  1475. _enc_mod._fernet_instance = None
  1476. _enc_mod._key_source = None
  1477. _enc_mod._warn_shown = False
  1478. # 8. Reinitialize the database engine and apply schema migrations so that
  1479. # tables added after the backup was created (e.g. ams_labels) exist
  1480. # immediately, without requiring a manual restart.
  1481. await reinitialize_database()
  1482. await init_db()
  1483. # 9. Sign everyone out. The restored users and auth tokens come from
  1484. # another point in time, possibly written by older code, so no
  1485. # session issued before the restore should stay valid.
  1486. from backend.app.core import database as _db_mod
  1487. async with _db_mod.engine.begin() as conn:
  1488. await _db_mod.invalidate_all_sessions(conn)
  1489. # Open dashboards of signed-in users too: they are never signed in
  1490. # again. API-key and anonymous ones are not closed outright (nothing
  1491. # ended theirs), but the restored data decides what they may still see: the anonymous ones
  1492. # go if the backup turns authentication on, and the refresh closes
  1493. # those of a key the backup does not have (or has under another key).
  1494. from backend.app.core.auth import invalidate_auth_enabled_cache
  1495. from backend.app.core.websocket import ws_manager
  1496. # Read from the restored data: this request has just cached the
  1497. # setting it had before.
  1498. invalidate_auth_enabled_cache()
  1499. # Cloud presets were cached per user of the replaced user table.
  1500. from backend.app.api.routes.cloud import forget_all_cloud_presets
  1501. forget_all_cloud_presets()
  1502. async with _db_mod.async_session() as auth_db:
  1503. auth_on = await is_auth_enabled(auth_db)
  1504. if auth_on:
  1505. await ws_manager.close_signed_in()
  1506. await ws_manager.close_anonymous()
  1507. await ws_manager.refresh_printer_scopes()
  1508. logger.info("Restore complete - restart required")
  1509. message = "Backup restored successfully. Please restart Bambuddy for changes to take effect."
  1510. if skipped_dirs:
  1511. message += f" Note: Some directories could not be restored ({', '.join(skipped_dirs)})."
  1512. return {
  1513. "success": True,
  1514. "message": message,
  1515. }
  1516. except HTTPException:
  1517. # Preserve specific HTTP error responses raised inside the restore
  1518. # body (e.g. the key-write OSError → 500). The blanket
  1519. # except Exception below would otherwise swallow them and replace
  1520. # the operator-facing detail with a generic message.
  1521. raise
  1522. except Exception as e:
  1523. logger.error("Restore failed: %s", e, exc_info=True)
  1524. return JSONResponse(
  1525. status_code=500,
  1526. content={"success": False, "message": "Restore failed. Check server logs for details."},
  1527. )
  1528. @router.get("/network-interfaces")
  1529. async def get_network_interfaces(
  1530. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  1531. ):
  1532. """Get available network interfaces with all IPs (primary + aliases)."""
  1533. from backend.app.services.network_utils import get_all_interface_ips
  1534. interfaces = get_all_interface_ips()
  1535. return {"interfaces": interfaces}
  1536. @router.get("/virtual-printer/models")
  1537. async def get_virtual_printer_models(
  1538. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  1539. ):
  1540. """Get available virtual printer models."""
  1541. from backend.app.services.virtual_printer import (
  1542. DEFAULT_VIRTUAL_PRINTER_MODEL,
  1543. VIRTUAL_PRINTER_MODELS,
  1544. )
  1545. return {
  1546. "models": VIRTUAL_PRINTER_MODELS,
  1547. "default": DEFAULT_VIRTUAL_PRINTER_MODEL,
  1548. }
  1549. def _legacy_vp_status(status: dict, printer_scope: PrinterScope) -> dict:
  1550. """The first virtual printer's status, without what names its target for a limited caller."""
  1551. if printer_scope.is_unrestricted:
  1552. return status
  1553. return {key: value for key, value in status.items() if key not in ("name", "serial", "target_printer_ip", "proxy")}
  1554. @router.get("/virtual-printer")
  1555. async def get_virtual_printer_settings(
  1556. db: AsyncSession = Depends(get_db),
  1557. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  1558. printer_scope: PrinterScope = RequestPrinterScope,
  1559. ):
  1560. """Get virtual printer settings and status."""
  1561. from backend.app.services.virtual_printer import (
  1562. DEFAULT_VIRTUAL_PRINTER_MODEL,
  1563. virtual_printer_manager,
  1564. )
  1565. enabled = await get_setting(db, "virtual_printer_enabled")
  1566. access_code = await get_setting(db, "virtual_printer_access_code")
  1567. mode = await get_setting(db, "virtual_printer_mode")
  1568. model = await get_setting(db, "virtual_printer_model")
  1569. target_printer_id = await get_setting(db, "virtual_printer_target_printer_id")
  1570. remote_interface_ip = await get_setting(db, "virtual_printer_remote_interface_ip")
  1571. tailscale_disabled_raw = await get_setting(db, "virtual_printer_tailscale_disabled")
  1572. archive_name_source = await get_setting(db, "virtual_printer_archive_name_source")
  1573. from backend.app.models.virtual_printer import VP_MODE_ARCHIVE, normalize_vp_mode
  1574. return {
  1575. "enabled": enabled == "true" if enabled else False,
  1576. "access_code_set": bool(access_code),
  1577. # Normalize on read so older settings rows (with `immediate` /
  1578. # `print_queue`) come out as `archive` / `queue` for the frontend.
  1579. "mode": normalize_vp_mode(mode) or VP_MODE_ARCHIVE,
  1580. "model": model or DEFAULT_VIRTUAL_PRINTER_MODEL,
  1581. # A target the caller can't see is not named.
  1582. "target_printer_id": int(target_printer_id)
  1583. if target_printer_id and printer_scope.allows(int(target_printer_id))
  1584. else None,
  1585. "remote_interface_ip": remote_interface_ip or "",
  1586. "tailscale_disabled": tailscale_disabled_raw == "true" if tailscale_disabled_raw else True,
  1587. "archive_name_source": archive_name_source if archive_name_source in ("metadata", "filename") else "metadata",
  1588. "status": _legacy_vp_status(virtual_printer_manager.get_status(), printer_scope),
  1589. }
  1590. @router.put("/virtual-printer")
  1591. async def update_virtual_printer_settings(
  1592. enabled: bool = None,
  1593. access_code: str = None,
  1594. mode: str = None,
  1595. model: str = None,
  1596. target_printer_id: int = None,
  1597. remote_interface_ip: str = None,
  1598. tailscale_disabled: bool = None,
  1599. archive_name_source: str = None,
  1600. db: AsyncSession = Depends(get_db),
  1601. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
  1602. printer_scope: PrinterScope = RequestPrinterScope,
  1603. ):
  1604. """Update virtual printer settings and restart services if needed.
  1605. For proxy mode with SSDP proxy (dual-homed setup):
  1606. - remote_interface_ip: IP of interface on slicer's network (LAN B)
  1607. - Local interface is auto-detected based on target printer IP
  1608. """
  1609. from sqlalchemy import select
  1610. from backend.app.models.printer import Printer
  1611. from backend.app.services.virtual_printer import (
  1612. DEFAULT_VIRTUAL_PRINTER_MODEL,
  1613. VIRTUAL_PRINTER_MODELS,
  1614. virtual_printer_manager,
  1615. )
  1616. # Get current values
  1617. current_enabled = await get_setting(db, "virtual_printer_enabled") == "true"
  1618. current_access_code = await get_setting(db, "virtual_printer_access_code") or ""
  1619. # Default to `archive` (the canonical name) but tolerate legacy `immediate`
  1620. # in the stored value — normalized later before validation.
  1621. current_mode = await get_setting(db, "virtual_printer_mode") or "archive"
  1622. current_model = await get_setting(db, "virtual_printer_model") or DEFAULT_VIRTUAL_PRINTER_MODEL
  1623. current_target_id_str = await get_setting(db, "virtual_printer_target_printer_id")
  1624. current_target_id = int(current_target_id_str) if current_target_id_str else None
  1625. current_remote_iface = await get_setting(db, "virtual_printer_remote_interface_ip") or ""
  1626. current_ts_disabled_raw = await get_setting(db, "virtual_printer_tailscale_disabled")
  1627. # Default True (opt-in) when the setting has never been saved — matches the model default.
  1628. current_ts_disabled = current_ts_disabled_raw == "true" if current_ts_disabled_raw else True
  1629. # Apply updates
  1630. new_enabled = enabled if enabled is not None else current_enabled
  1631. new_access_code = access_code if access_code is not None else current_access_code
  1632. new_mode = mode if mode is not None else current_mode
  1633. new_model = model if model is not None else current_model
  1634. new_target_id = target_printer_id if target_printer_id is not None else current_target_id
  1635. # One bridging to a printer the caller can't use is not theirs to change,
  1636. # and they can't aim it at such a printer.
  1637. from backend.app.models.virtual_printer import VirtualPrinter as FirstVP
  1638. # The first virtual printer is the one these settings reach.
  1639. first_vp = (await db.execute(select(FirstVP).order_by(FirstVP.position, FirstVP.id).limit(1))).scalar_one_or_none()
  1640. if not printer_scope.allows(current_target_id) or (
  1641. first_vp is not None and not printer_scope.allows(first_vp.target_printer_id)
  1642. ):
  1643. return JSONResponse(status_code=404, content={"detail": "Virtual printer not found"})
  1644. if target_printer_id is not None and not printer_scope.allows(target_printer_id):
  1645. return JSONResponse(status_code=400, content={"detail": f"Printer with ID {target_printer_id} not found"})
  1646. new_remote_iface = remote_interface_ip if remote_interface_ip is not None else current_remote_iface
  1647. new_ts_disabled = tailscale_disabled if tailscale_disabled is not None else current_ts_disabled
  1648. # Validate mode. Canonical wire values are `archive` / `review` / `queue`
  1649. # / `proxy`; legacy `immediate` and `print_queue` are accepted as aliases
  1650. # and translated before storage so support bundles stop showing the old
  1651. # confusing pair (#1429 mode-label discrepancy).
  1652. from backend.app.models.virtual_printer import VP_MODE_VALUES, normalize_vp_mode
  1653. canonical_mode = normalize_vp_mode(new_mode)
  1654. if canonical_mode not in VP_MODE_VALUES:
  1655. return JSONResponse(
  1656. status_code=400,
  1657. content={
  1658. "detail": f"Mode must be one of: {', '.join(VP_MODE_VALUES)}",
  1659. },
  1660. )
  1661. new_mode = canonical_mode
  1662. # Validate archive_name_source
  1663. if archive_name_source is not None and archive_name_source not in ("metadata", "filename"):
  1664. return JSONResponse(
  1665. status_code=400,
  1666. content={"detail": "archive_name_source must be 'metadata' or 'filename'"},
  1667. )
  1668. # Validate model
  1669. if model is not None and model not in VIRTUAL_PRINTER_MODELS:
  1670. return JSONResponse(
  1671. status_code=400,
  1672. content={"detail": f"Invalid model. Must be one of: {', '.join(VIRTUAL_PRINTER_MODELS.keys())}"},
  1673. )
  1674. # Mode-specific validation and printer lookup
  1675. target_printer_ip = ""
  1676. target_printer_serial = ""
  1677. if new_mode == "proxy":
  1678. # Proxy mode requires target printer when enabling
  1679. if new_enabled and not new_target_id:
  1680. # If just switching to proxy mode (not explicitly enabling), auto-disable
  1681. if enabled is None:
  1682. new_enabled = False
  1683. else:
  1684. return JSONResponse(
  1685. status_code=400,
  1686. content={"detail": "Target printer is required for proxy mode"},
  1687. )
  1688. # Look up printer IP and serial if we have a target
  1689. if new_target_id:
  1690. result = await db.execute(select(Printer).where(Printer.id == new_target_id))
  1691. printer = result.scalar_one_or_none()
  1692. if not printer:
  1693. return JSONResponse(
  1694. status_code=400,
  1695. content={"detail": f"Printer with ID {new_target_id} not found"},
  1696. )
  1697. target_printer_ip = printer.ip_address
  1698. target_printer_serial = printer.serial_number
  1699. # Access code not required for proxy mode
  1700. else:
  1701. # Non-proxy modes require access code when enabling
  1702. if new_enabled and not new_access_code:
  1703. # If just switching modes (not explicitly enabling), auto-disable
  1704. if enabled is None:
  1705. new_enabled = False
  1706. else:
  1707. return JSONResponse(
  1708. status_code=400,
  1709. content={"detail": "Access code is required when enabling virtual printer"},
  1710. )
  1711. # Validate access code length (Bambu Studio requires exactly 8 characters)
  1712. if access_code is not None and access_code and len(access_code) != 8:
  1713. return JSONResponse(
  1714. status_code=400,
  1715. content={"detail": "Access code must be exactly 8 characters"},
  1716. )
  1717. # Save settings
  1718. await set_setting(db, "virtual_printer_enabled", "true" if new_enabled else "false")
  1719. if access_code is not None:
  1720. await set_setting(db, "virtual_printer_access_code", access_code)
  1721. await set_setting(db, "virtual_printer_mode", new_mode)
  1722. if model is not None:
  1723. await set_setting(db, "virtual_printer_model", model)
  1724. if target_printer_id is not None:
  1725. await set_setting(db, "virtual_printer_target_printer_id", str(target_printer_id))
  1726. if remote_interface_ip is not None:
  1727. await set_setting(db, "virtual_printer_remote_interface_ip", remote_interface_ip)
  1728. if tailscale_disabled is not None:
  1729. await set_setting(db, "virtual_printer_tailscale_disabled", "true" if tailscale_disabled else "false")
  1730. if archive_name_source is not None:
  1731. await set_setting(db, "virtual_printer_archive_name_source", archive_name_source)
  1732. # Propagate tailscale_disabled to the first VirtualPrinter row so sync_from_db() picks it up
  1733. if tailscale_disabled is not None:
  1734. if first_vp is not None:
  1735. first_vp.tailscale_disabled = new_ts_disabled
  1736. await db.commit()
  1737. db.expire_all()
  1738. # Reconfigure virtual printer
  1739. try:
  1740. await virtual_printer_manager.configure(
  1741. enabled=new_enabled,
  1742. access_code=new_access_code,
  1743. mode=new_mode,
  1744. model=new_model,
  1745. target_printer_ip=target_printer_ip,
  1746. target_printer_serial=target_printer_serial,
  1747. remote_interface_ip=new_remote_iface,
  1748. )
  1749. except ValueError as e:
  1750. logger.warning("Virtual printer configuration validation error: %s", e)
  1751. return JSONResponse(
  1752. status_code=400,
  1753. content={"detail": "Invalid virtual printer configuration. Check the provided values."},
  1754. )
  1755. except Exception as e:
  1756. logger.error("Failed to configure virtual printer: %s", e, exc_info=True)
  1757. return JSONResponse(
  1758. status_code=500,
  1759. content={"detail": "Failed to configure virtual printer. Check server logs for details."},
  1760. )
  1761. return await get_virtual_printer_settings(db, printer_scope=printer_scope)
  1762. # =============================================================================
  1763. # MQTT Relay Settings
  1764. # =============================================================================
  1765. @router.get("/mqtt/status")
  1766. async def get_mqtt_status(
  1767. _: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_READ),
  1768. ):
  1769. """Get MQTT relay connection status."""
  1770. from backend.app.services.mqtt_relay import mqtt_relay
  1771. return mqtt_relay.get_status()