settings.py 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979
  1. import json
  2. import re
  3. from pydantic import BaseModel, Field, ValidationInfo, field_validator
  4. from backend.app.schemas.print_queue import TriState
  5. from backend.app.utils.printer_models import MAX_CHAMBER_TEMP_C
  6. # Outbound service URLs validated on save, so a bad value is rejected at
  7. # configuration time with a clear message rather than failing opaquely at
  8. # request time. Every one of these services is commonly self-hosted on the same
  9. # host or LAN as Bambuddy, so the LAN-service policy applies: loopback and
  10. # RFC-1918 stay permitted, while cloud-metadata endpoints, numeric-encoded IPs,
  11. # IPv4-mapped IPv6 and non-HTTP schemes are rejected. See
  12. # ``_url_safety.assert_safe_lan_service_url``.
  13. #
  14. # Module-level rather than a class attribute so the CI backstop in
  15. # tests/unit/test_outbound_url_ssrf_guards.py can import the real list and
  16. # cannot drift from it. Any new outbound-URL setting belongs here (or, if it
  17. # must be reachable on the public internet, on the stricter OIDC guard).
  18. LAN_SERVICE_URL_SETTINGS = ("ha_url", "obico_ml_url", "orcaslicer_api_url", "bambu_studio_api_url")
  19. # ``docker_compose_dir`` is unusual among the string settings: it is not
  20. # consumed by Bambuddy at all, it is interpolated into a shell command that
  21. # the Settings page invites the user to copy and paste into a root-capable
  22. # terminal (#2664). A value like ``/opt/bambuddy; rm -rf /`` would render as a
  23. # perfectly plausible-looking update command, so anyone with settings:update
  24. # could hand every admin a destructive one-liner to run. Restricting the field
  25. # to characters that occur in real paths removes that entirely; the frontend
  26. # double-quotes the value when it contains a space, which is safe precisely
  27. # because quotes, ``$`` and backticks cannot survive this pattern.
  28. _COMPOSE_DIR_ALLOWED = re.compile(r"^[\w \-./\\:~]+$", re.UNICODE)
  29. _COMPOSE_DIR_MAX_LEN = 512
  30. class AppSettings(BaseModel):
  31. """Application settings schema."""
  32. auto_archive: bool = Field(default=True, description="Automatically archive prints when completed")
  33. save_thumbnails: bool = Field(default=True, description="Extract and save preview images from 3MF files")
  34. capture_finish_photo: bool = Field(
  35. default=True,
  36. description=(
  37. "Capture photo from printer camera when print completes. Bambuddy records a "
  38. "brief timelapse during the print so the photo can be sourced from the moment "
  39. "before the bed drops; the timelapse file is kept if you enabled timelapse for "
  40. "this print, otherwise it is deleted automatically after the photo is captured."
  41. ),
  42. )
  43. finish_photo_restore_plate: bool = Field(
  44. default=True,
  45. description=(
  46. "Raise the build plate back into camera framing before taking the finish photo. "
  47. "Bambu's end G-code drops the plate ~100mm as the last thing it does, leaving the "
  48. "finished print far below the camera's natural framing. Bambuddy moves it back to "
  49. "just above the last printed layer, takes the photo, then lowers it again. Skipped "
  50. "when the print height is unknown or another job is queued for the printer."
  51. ),
  52. )
  53. default_filament_cost: float = Field(default=25.0, description="Default filament cost per kg")
  54. currency: str = Field(default="USD", description="Currency for cost tracking")
  55. energy_cost_per_kwh: float = Field(default=0.15, description="Electricity cost per kWh for energy tracking")
  56. energy_tracking_mode: str = Field(
  57. default="total",
  58. description="Energy display mode on stats: 'print' shows sum of per-print energy, 'total' shows lifetime plug consumption",
  59. )
  60. # Spoolman integration
  61. spoolman_enabled: bool = Field(default=False, description="Enable Spoolman integration for filament tracking")
  62. spoolman_url: str = Field(default="", description="Spoolman server URL (e.g., http://localhost:7912)")
  63. spoolman_sync_mode: str = Field(
  64. default="auto", description="Sync mode: 'auto' syncs immediately, 'manual' requires button press"
  65. )
  66. spoolman_disable_weight_sync: bool = Field(
  67. default=False,
  68. description="Disable remaining_weight sync. When enabled, only location is updated for existing spools.",
  69. )
  70. spoolman_report_partial_usage: bool = Field(
  71. default=True,
  72. description="Report Partial Usage for Failed Prints. When a print fails or is cancelled, report the estimated filament used up to that point based on layer progress.",
  73. )
  74. auto_add_unknown_rfid: bool = Field(
  75. default=True,
  76. description="Automatically add spools with unknown RFID tags to inventory. Disable if you pre-create inventory entries manually to avoid duplicates.",
  77. )
  78. disable_filament_warnings: bool = Field(
  79. default=False,
  80. description="Disable insufficient filament warnings when printing or queueing prints",
  81. )
  82. prefer_lowest_filament: bool = Field(
  83. default=False,
  84. description="When multiple AMS spools match, prefer the one with lowest remaining filament",
  85. )
  86. # Updates
  87. check_updates: bool = Field(default=True, description="Automatically check for updates on startup")
  88. check_printer_firmware: bool = Field(default=True, description="Check for printer firmware updates from Bambu Lab")
  89. include_beta_updates: bool = Field(default=False, description="Include beta/prerelease versions in update checks")
  90. # Language
  91. language: str = Field(default="en", description="UI language (en, de, fr, ja, it, pt-BR)")
  92. notification_language: str = Field(default="en", description="Language for push notifications (en, de)")
  93. # Bed cooled notification threshold
  94. bed_cooled_threshold: float = Field(
  95. default=35.0, description="Bed temperature threshold for cooled notification (°C)"
  96. )
  97. # AMS threshold settings for humidity and temperature coloring
  98. ams_humidity_good: int = Field(default=40, description="Humidity threshold for good (green): <= this value")
  99. ams_humidity_fair: int = Field(
  100. default=60, description="Humidity threshold for fair (orange): <= this value, > is red"
  101. )
  102. ams_temp_good: float = Field(default=28.0, description="Temperature threshold for good (blue): <= this value")
  103. ams_temp_fair: float = Field(
  104. default=35.0, description="Temperature threshold for fair (orange): <= this value, > is red"
  105. )
  106. # Separate from ams_temp_fair on purpose (#2905). The fair threshold decides
  107. # when the AMS card turns amber; this decides when a notification is sent.
  108. # 35 C is a sensible place to change a colour and not a sensible place to
  109. # page someone -- a room above 35 C makes the alarm fire once an hour for as
  110. # long as the weather lasts, and the only way to silence it was to raise the
  111. # display band and lose the colour that says the unit is warm. None means
  112. # "not set", which resolves to ams_temp_fair so every existing install keeps
  113. # behaving exactly as it does now.
  114. ams_temp_alarm: float | None = Field(
  115. default=None,
  116. description="Temperature threshold (°C) for sending an alarm. Unset falls back to ams_temp_fair.",
  117. )
  118. ams_history_retention_days: int = Field(default=30, description="Number of days to keep AMS sensor history data")
  119. printer_sensor_history_retention_days: int = Field(
  120. default=30, description="Number of days to keep printer heater history data (nozzle / bed / chamber)"
  121. )
  122. # Queue auto-drying settings
  123. queue_drying_enabled: bool = Field(
  124. default=False, description="Automatically dry AMS filament between queued prints"
  125. )
  126. queue_drying_block: bool = Field(
  127. default=False,
  128. description="Block queue until drying completes (when disabled, prints take priority over drying)",
  129. )
  130. ambient_drying_enabled: bool = Field(
  131. default=False,
  132. description="Automatically dry AMS filament on idle printers when humidity exceeds threshold, regardless of queue",
  133. )
  134. print_drying_enabled: bool = Field(
  135. default=False,
  136. description=(
  137. "Allow auto-drying to also fire on a printer that is currently printing, "
  138. "when its model+firmware supports concurrent drying (H2D 01.03.00.00+, "
  139. "H2C/H2S/P2S/H2D Pro 01.02.00.00+, X2D/A2L 01.01.00.00+, X1C 01.11.02.00+). "
  140. "Drying temperature is automatically capped 5 degC below the idle preset "
  141. "(floor 40 degC) to protect spools during print."
  142. ),
  143. )
  144. drying_presets: str = Field(
  145. default="",
  146. description="JSON blob of drying presets per filament type (empty = use built-in defaults)",
  147. )
  148. ams_humidity_thresholds: str = Field(
  149. default="",
  150. description=(
  151. "JSON blob of per-filament-type humidity trigger thresholds for auto-drying and alarms. "
  152. 'Shape: {"default": int, "PLA": int, "ASA": int, ...}. '
  153. "Empty = fall back to ams_humidity_fair for all types."
  154. ),
  155. )
  156. # Auto-print G-code injection (#422)
  157. gcode_snippets: str = Field(
  158. default="",
  159. description="JSON: per-model G-code injection snippets {model: {start_gcode, end_gcode}}",
  160. )
  161. # Scheduled local backup (#884)
  162. local_backup_enabled: bool = Field(default=False, description="Enable scheduled local backups")
  163. local_backup_schedule: str = Field(default="daily", description="Backup frequency: hourly, daily, weekly")
  164. local_backup_time: str = Field(default="03:00", description="Time of day for daily/weekly backups (HH:MM, 24h)")
  165. local_backup_retention: int = Field(default=5, description="Number of backup files to keep (1-100)")
  166. local_backup_path: str = Field(default="", description="Backup output directory (empty = DATA_DIR/backups)")
  167. # Print modal settings
  168. per_printer_mapping_expanded: bool = Field(
  169. default=False, description="Expand custom filament mapping by default in print modal"
  170. )
  171. # Date/time display format
  172. date_format: str = Field(default="system", description="Date format: system, us, eu, iso")
  173. time_format: str = Field(default="system", description="Time format: system, 12h, 24h")
  174. # Default printer for operations
  175. default_printer_id: int | None = Field(default=None, description="Default printer ID for uploads, reprints, etc.")
  176. # Slicer Pipelines (#1425 PR C). Cap on the ``copies`` field in the
  177. # Run-with-pipeline modal — keeps a misclick from queueing 5000 prints.
  178. pipeline_max_copies: int = Field(
  179. default=50,
  180. ge=1,
  181. le=1000,
  182. description="Upper bound on the copies an operator can request when running a Slicer Pipeline. Larger fleets / production rigs can raise this; the hard ceiling at 1000 is a sanity guard against fat-fingered input.",
  183. )
  184. # Virtual Printer
  185. virtual_printer_enabled: bool = Field(default=False, description="Enable virtual printer for slicer uploads")
  186. virtual_printer_access_code: str = Field(default="", description="Access code for virtual printer authentication")
  187. virtual_printer_mode: str = Field(
  188. default="archive",
  189. description="Mode: 'archive' (archive now), 'review' (pending review), 'queue' (add to print queue), or 'proxy' (relay to real printer)",
  190. )
  191. virtual_printer_archive_name_source: str = Field(
  192. default="metadata",
  193. description="Source for the archive's display name on virtual-printer uploads: 'metadata' uses the 3MF's embedded print_name (default, matches Bambu's behavior), 'filename' uses the filename Bambu Studio sent over FTP (lets users rename via the slicer's 'send to printer' dialog).",
  194. )
  195. # Dark mode theme settings
  196. dark_style: str = Field(default="vibrant", description="Dark mode style: classic, glow, vibrant")
  197. dark_background: str = Field(
  198. default="cool", description="Dark mode background: neutral, warm, cool, oled, slate, forest"
  199. )
  200. dark_accent: str = Field(default="green", description="Dark mode accent: green, teal, blue, orange, purple, red")
  201. # Light mode theme settings
  202. light_style: str = Field(default="classic", description="Light mode style: classic, glow, vibrant")
  203. light_background: str = Field(default="neutral", description="Light mode background: neutral, warm, cool")
  204. light_accent: str = Field(default="green", description="Light mode accent: green, teal, blue, orange, purple, red")
  205. # FTP retry settings for unreliable WiFi connections
  206. ftp_retry_enabled: bool = Field(default=True, description="Enable automatic retry for FTP operations")
  207. ftp_retry_count: int = Field(default=3, description="Number of retry attempts for FTP operations (1-10)")
  208. ftp_retry_delay: int = Field(default=2, description="Seconds to wait between FTP retry attempts (1-30)")
  209. ftp_timeout: int = Field(default=30, description="FTP connection timeout in seconds (10-300)")
  210. # MQTT Relay settings for publishing events to external broker
  211. mqtt_enabled: bool = Field(default=False, description="Enable MQTT event publishing to external broker")
  212. mqtt_broker: str = Field(default="", description="MQTT broker hostname or IP address")
  213. mqtt_port: int = Field(default=1883, description="MQTT broker port (default 1883, TLS typically 8883)")
  214. mqtt_username: str = Field(default="", description="MQTT username for authentication (optional)")
  215. mqtt_password: str = Field(default="", description="MQTT password for authentication (optional)")
  216. mqtt_topic_prefix: str = Field(default="bambuddy", description="Topic prefix for all published messages")
  217. mqtt_use_tls: bool = Field(default=False, description="Use TLS/SSL encryption for MQTT connection")
  218. # External URL for notifications
  219. external_url: str = Field(
  220. default="", description="External URL where Bambuddy is accessible (for notification images)"
  221. )
  222. # Directory holding the user's docker-compose.yml, shown in the update
  223. # instructions so the printed command can be pasted from anywhere (#2664).
  224. # Empty means "omit the cd" — which is also the correct rendering when
  225. # nothing could be detected, rather than guessing a path that fails.
  226. docker_compose_dir: str = Field(
  227. default="", description="Host directory containing docker-compose.yml, used in the update instructions"
  228. )
  229. # Home Assistant integration for smart plug control
  230. ha_enabled: bool = Field(default=False, description="Enable Home Assistant integration for smart plug control")
  231. ha_url: str = Field(default="", description="Home Assistant URL (e.g., http://192.168.1.100:8123)")
  232. ha_token: str = Field(default="", description="Home Assistant Long-Lived Access Token")
  233. ha_url_from_env: bool = Field(default=False, description="Whether HA URL is set via HA_URL environment variable")
  234. ha_token_from_env: bool = Field(
  235. default=False, description="Whether HA token is set via HA_TOKEN environment variable"
  236. )
  237. ha_env_managed: bool = Field(
  238. default=False, description="Whether HA integration is fully managed by environment variables"
  239. )
  240. # File Manager / Library settings
  241. library_archive_mode: str = Field(
  242. default="ask",
  243. description="When printing from File Manager, create archive entry: 'always', 'never', or 'ask'",
  244. )
  245. library_disk_warning_gb: float = Field(
  246. default=5.0,
  247. description="Show warning when free disk space falls below this threshold (GB)",
  248. )
  249. # Camera view settings
  250. camera_view_mode: str = Field(
  251. default="window",
  252. description="Camera view mode: 'window' opens in new browser window, 'embedded' shows overlay on main screen",
  253. )
  254. # Preferred slicer application (server-side / API sidecar slicer)
  255. preferred_slicer: str = Field(
  256. default="bambu_studio",
  257. description="Slicer used for the server-side API / sidecar: 'bambu_studio' or 'orcaslicer'",
  258. )
  259. # "Open in Slicer" desktop URI handler — independent of the API slicer so
  260. # a user can slice via the Bambu Studio sidecar but open files locally in
  261. # OrcaSlicer, or vice versa (#1329). None falls back to ``preferred_slicer``
  262. # so existing installs behave identically until someone changes it.
  263. open_in_slicer: str | None = Field(
  264. default=None,
  265. description=(
  266. "Desktop slicer for the 'Open in Slicer' button: 'bambu_studio' or "
  267. "'orcaslicer'. None inherits from preferred_slicer."
  268. ),
  269. )
  270. # Where slicing runs. Orthogonal to ``preferred_slicer``, which only says
  271. # *which slicer binary* the sidecar drives: a browser engine is a different
  272. # execution site, not a different binary choice. Kept as its own key so the
  273. # two never have to encode impossible combinations.
  274. #
  275. # Only "sidecar" is implemented today; the slice modal offers a per-job
  276. # choice when more than one engine is available, and hides the control
  277. # entirely while there is only one.
  278. slice_engine: str = Field(
  279. default="sidecar",
  280. description="Default execution site for slicing: 'sidecar' (server-side API) or 'browser'",
  281. )
  282. # Slicer dispatch mode: when True, "Slice" actions open the in-app
  283. # SliceModal and call the slicer-API sidecar. When False (default), they
  284. # hand off to the user's local desktop slicer via URI scheme — preserving
  285. # the original Bambuddy behavior for users who don't run a sidecar.
  286. use_slicer_api: bool = Field(
  287. default=False,
  288. description="Use the slicer-API sidecar for slicing instead of the desktop slicer URI scheme",
  289. )
  290. # Slicer-API sidecar base URLs. Per-installation, configured via the
  291. # Settings UI (the "Slicer" card). Empty string means "fall back to the
  292. # SLICER_API_URL / BAMBU_STUDIO_API_URL env vars" — which themselves
  293. # default to the docker-compose ports in core/config.py.
  294. orcaslicer_api_url: str = Field(
  295. default="",
  296. description="OrcaSlicer sidecar URL (e.g. http://localhost:3003). Empty falls back to the SLICER_API_URL env var.",
  297. )
  298. bambu_studio_api_url: str = Field(
  299. default="",
  300. description="BambuStudio sidecar URL (e.g. http://localhost:3001). Empty falls back to the BAMBU_STUDIO_API_URL env var.",
  301. )
  302. # How long to keep waiting on a slice that isn't finishing. Measured against
  303. # the sidecar's progress channel, not total elapsed time — a heavy model can
  304. # legitimately slice for half an hour, and a wall-clock ceiling cannot tell
  305. # that apart from a stalled one (#2730). Sidecars too old to report progress
  306. # fall back to using this as a total-elapsed ceiling, which is the pre-#2730
  307. # behaviour with a configurable number.
  308. slicer_stall_timeout_minutes: int = Field(
  309. default=15,
  310. ge=1,
  311. le=240,
  312. description=(
  313. "Give up on a slice after this many minutes with no progress from the sidecar. "
  314. "On sidecars that do not report progress, applies to total slicing time instead."
  315. ),
  316. )
  317. # Prometheus metrics endpoint
  318. prometheus_enabled: bool = Field(default=False, description="Enable Prometheus metrics endpoint at /metrics")
  319. prometheus_token: str = Field(
  320. default="", description="Bearer token for Prometheus metrics authentication (optional)"
  321. )
  322. # Inventory low stock threshold
  323. low_stock_threshold: float = Field(
  324. default=20.0,
  325. ge=0.1,
  326. le=99.9,
  327. description="Low stock threshold percentage (%) for inventory filtering and display",
  328. )
  329. # Session policy (#1706) — admin-set ceiling for user session lifetime.
  330. # Default 24h preserves the M-2 audit reduction from 7 days. Max 720h
  331. # (30 days) bounds blast radius if an admin chooses a long session.
  332. session_max_hours: int = Field(
  333. default=24,
  334. ge=1,
  335. le=720,
  336. description=(
  337. "Maximum session lifetime in hours for user logins (default 24, max 720). "
  338. "Applies to new logins only; already-issued tokens keep their original expiry. "
  339. "Longer sessions reduce automatic logout protection."
  340. ),
  341. )
  342. # User email notifications (requires Advanced Authentication)
  343. user_notifications_enabled: bool = Field(
  344. default=True,
  345. description="Enable user email notifications for print job events (requires Advanced Authentication)",
  346. )
  347. # Default print options. bed_levelling / flow_cali / nozzle_offset_cali are
  348. # tri-state (off/on/auto), defaulting to "auto" per BambuStudio.
  349. default_bed_levelling: TriState = Field(default="auto", description="Default bed levelling option for new prints")
  350. default_flow_cali: TriState = Field(default="auto", description="Default flow calibration option for new prints")
  351. default_vibration_cali: bool = Field(
  352. default=True, description="Default vibration calibration option for new prints"
  353. )
  354. default_layer_inspect: bool = Field(
  355. default=False, description="Default first layer inspection option for new prints"
  356. )
  357. default_timelapse: bool = Field(default=False, description="Default timelapse option for new prints")
  358. default_nozzle_offset_cali: TriState = Field(
  359. default="auto",
  360. description="Default nozzle offset calibration option for new prints (dual-nozzle printers only)",
  361. )
  362. # Staggered batch start for multi-printer jobs
  363. stagger_group_size: int = Field(
  364. default=2, ge=1, le=50, description="Number of printers to start simultaneously in staggered mode"
  365. )
  366. stagger_interval_minutes: int = Field(
  367. default=5, ge=1, le=60, description="Minutes between staggered printer groups"
  368. )
  369. # Finance budget window settings
  370. billing_enabled: bool = Field(
  371. default=False,
  372. description="Enable cost-center billing enforcement for print and queue operations",
  373. )
  374. printer_kill_switch_enabled: bool = Field(
  375. default=False,
  376. description="Immediately stop printer jobs that start without Bambuddy authorization",
  377. )
  378. finance_budget_reset_day: int = Field(
  379. default=1,
  380. ge=1,
  381. le=31,
  382. description="Day of month when monthly finance budget window resets (1-31, clamped for short months)",
  383. )
  384. finance_budget_reset_timezone: str = Field(
  385. default="UTC",
  386. description="IANA timezone for finance monthly budget reset calculation (e.g., Europe/Berlin)",
  387. )
  388. # Plate-clear confirmation for queue scheduling
  389. require_plate_clear: bool = Field(
  390. default=False,
  391. description="Require per-printer plate-clear confirmation before starting queued prints on finished printers",
  392. )
  393. queue_shortest_first: bool = Field(
  394. default=False,
  395. description="Shortest Job First — scheduler prioritizes shorter print jobs over longer ones",
  396. )
  397. queue_max_concurrent_uploads: int = Field(
  398. default=4,
  399. ge=1,
  400. le=16,
  401. description=(
  402. "How many printers the queue may upload to at the same time. Printers are independent "
  403. "machines, so raising this starts a multi-printer batch proportionally sooner; each "
  404. "concurrent upload costs one connection and one thread on the Bambuddy host."
  405. ),
  406. )
  407. # Preheat / heat-soak before queued prints (#1468). The scheduler stage runs
  408. # BEFORE FTP upload. Three hardware tiers behave differently:
  409. # - Chamber heater (H2C/H2D/H2DPro/H2S/X2D/X1E): M141 → wait for chamber
  410. # sensor to reach target → soak
  411. # - Chamber sensor only (X1C/P2S): M140 only → wait for radiant chamber
  412. # warm-up to reach target OR max-wait timeout → soak
  413. # - No chamber sensor (P1S/P1P/A1/A1 Mini): M140 only → fixed soak timer
  414. # (no way to verify chamber temp; relies entirely on max_wait + soak)
  415. # Chamber target derives per-print from the loaded AMS filament types via
  416. # preheat_filament_targets (max across loaded slots). A target of 0 skips
  417. # the chamber phase but keeps the bed phase + soak. Per-queue-item
  418. # `preheat_chamber_target_override` (nullable) bypasses the derivation.
  419. preheat_enabled: bool = Field(
  420. default=False,
  421. description="Master toggle / default for new queue items. Per-item preheat_override can flip the decision per print.",
  422. )
  423. preheat_filament_targets: str = Field(
  424. default="",
  425. description=(
  426. "JSON map of normalized filament type → chamber target °C. Empty = bundled defaults "
  427. "(PLA/PETG/TPU/PVA: 0, PETG-CF: 40, ABS/ASA: 45, PA/PC/PC-FR: 50, PA-CF: 55, default: 0). "
  428. "Scheduler picks max across loaded AMS slots; 0 disables chamber phase for that print."
  429. ),
  430. )
  431. preheat_max_wait_seconds: int = Field(
  432. default=900,
  433. ge=60,
  434. le=3600,
  435. description="Maximum time to wait for the chamber to reach the target before falling through to the soak phase (radiant heating on X1C/P2S can take 15-30 min).",
  436. )
  437. preheat_soak_seconds: int = Field(
  438. default=300,
  439. ge=0,
  440. le=1800,
  441. description="Additional hold time at temperature after the chamber reaches the target (or after max_wait_seconds elapses). 0 = no soak.",
  442. )
  443. queue_keep_bed_warm: bool = Field(
  444. default=False,
  445. description=(
  446. "While a printer is in FINISH state awaiting plate-clear and the next queued item requires "
  447. "chamber heating, hold the bed hot so the chamber stays warm during the bed-clearing "
  448. "window. The bed is the chamber's heating element here: the hold target is "
  449. "queue_keep_warm_bed_temp, or the item's own bed_temperature when the slicer metadata "
  450. "reports a higher one. Only fires for filaments with a non-zero chamber target "
  451. "(ASA, ABS, PA, PC etc.); PLA/PETG prints are skipped automatically."
  452. ),
  453. )
  454. queue_keep_warm_bed_temp: int = Field(
  455. default=90,
  456. ge=40,
  457. le=110,
  458. description=(
  459. "Bed temperature (°C) used when the bed's job is to heat the chamber. 90 sustains "
  460. "chamber warmth on enclosed printers and satisfies bed-threshold-linked aftermarket "
  461. "chamber heaters (which typically activate at bed ≥ 80). Applies in two places: the "
  462. "keep-warm hold between chamber-heated prints, and preheat when a chamber-heated "
  463. "item's slicer metadata carries no bed temperature at all. A parsed bed temperature "
  464. "higher than this always wins, so the bed is never driven cooler than the print needs."
  465. ),
  466. )
  467. queue_keep_warm_max_minutes: int = Field(
  468. default=120,
  469. ge=5,
  470. le=480,
  471. description=(
  472. "How long keep-warm may hold the bed on a printer waiting for its plate to be cleared. "
  473. "When this elapses the bed is switched off, and the hold does not re-arm until the "
  474. "printer next becomes a keep-warm candidate — so a plate nobody clears cannot leave the "
  475. "bed hot indefinitely. Set it to how long you realistically take to reach the printer; "
  476. "the only cost of it being too short is that the next print re-soaks from cold."
  477. ),
  478. )
  479. # User-configurable presets for the printer-card temperature / fan-speed
  480. # popovers. Each is a JSON array of exactly 3 ints (the "Off" button is
  481. # rendered separately and is not configurable). Empty string = use built-in
  482. # defaults. Validators on AppSettingsUpdate enforce the shape on writes.
  483. nozzle_temp_presets: str = Field(
  484. default="",
  485. description="JSON array of 3 nozzle-temperature preset values in C (0-320). Empty = use defaults [120, 220, 260]",
  486. )
  487. bed_temp_presets: str = Field(
  488. default="",
  489. description="JSON array of 3 bed-temperature preset values in C (0-140). Empty = use defaults [55, 75, 90]",
  490. )
  491. chamber_temp_presets: str = Field(
  492. default="",
  493. description="JSON array of 3 chamber-temperature preset values in C (0-65). Empty = use defaults [35, 45, 60]",
  494. )
  495. fan_speed_presets: str = Field(
  496. default="",
  497. description="JSON array of 3 fan-speed preset values in % (0-100). Empty = use defaults [50, 75, 100]",
  498. )
  499. # Local login (#1589) — when False, /auth/login rejects username+password
  500. # credentials with HTTP 403 and the login page hides the credentials form,
  501. # leaving only the OIDC SSO provider buttons. LDAP is governed by its own
  502. # `ldap_enabled` toggle and is not affected. The env-var
  503. # ``BAMBUDDY_LOCAL_LOGIN=true`` bypasses this gate at the route level so a
  504. # server admin can recover an install whose SSO provider is unreachable
  505. # without editing the DB.
  506. local_login_enabled: bool = Field(
  507. default=True,
  508. description=(
  509. "Allow username + password login on /auth/login. Disable when only SSO should be usable. "
  510. "BAMBUDDY_LOCAL_LOGIN=true on the server overrides this to keep a recovery path open."
  511. ),
  512. )
  513. # LDAP authentication (#794)
  514. ldap_enabled: bool = Field(default=False, description="Enable LDAP authentication")
  515. ldap_server_url: str = Field(default="", description="LDAP server URL (e.g., ldap://ldap.example.com:389)")
  516. ldap_bind_dn: str = Field(default="", description="Bind DN for LDAP searches (e.g., cn=admin,dc=example,dc=com)")
  517. ldap_bind_password: str = Field(default="", description="Bind password for LDAP searches")
  518. ldap_search_base: str = Field(default="", description="Search base DN (e.g., ou=users,dc=example,dc=com)")
  519. ldap_user_filter: str = Field(
  520. default="(sAMAccountName={username})",
  521. description="LDAP user search filter. {username} is replaced with the login username",
  522. )
  523. ldap_security: str = Field(default="starttls", description="LDAP security: 'starttls' or 'ldaps'")
  524. ldap_group_mapping: str = Field(
  525. default="",
  526. description="JSON: LDAP group to BamBuddy group mapping {ldap_group_dn: bambuddy_group_name}",
  527. )
  528. ldap_auto_provision: bool = Field(
  529. default=False,
  530. description="Auto-create BamBuddy user on first successful LDAP login",
  531. )
  532. ldap_default_group: str = Field(
  533. default="",
  534. description="Fallback BamBuddy group name assigned when an LDAP user authenticates but has no mapped groups. Empty = no fallback.",
  535. )
  536. # Obico AI failure detection (#172)
  537. obico_enabled: bool = Field(default=False, description="Enable Obico AI print failure detection")
  538. obico_ml_url: str = Field(
  539. default="",
  540. description="Self-hosted Obico ML API base URL (e.g., http://192.168.1.10:3333)",
  541. )
  542. obico_ml_token: str = Field(
  543. default="",
  544. description=(
  545. "Bearer token for the Obico ML API, matching the server's ML_API_TOKEN "
  546. "environment variable. Empty when the server runs without one."
  547. ),
  548. )
  549. obico_sensitivity: str = Field(
  550. default="medium",
  551. description="Detection sensitivity: 'low', 'medium', or 'high' (adjusts LOW/HIGH thresholds)",
  552. )
  553. obico_action: str = Field(
  554. default="notify",
  555. description="Action on detected failure: 'notify', 'pause', or 'pause_and_off'",
  556. )
  557. obico_poll_interval: int = Field(
  558. default=10,
  559. ge=5,
  560. le=120,
  561. description="Seconds between detection checks while a print is running",
  562. )
  563. obico_enabled_printers: str = Field(
  564. default="",
  565. description="JSON array of printer IDs to monitor (empty = all connected printers)",
  566. )
  567. # Inventory forecasting
  568. forecast_global_lead_time_days: int = Field(
  569. default=0,
  570. ge=0,
  571. description="Global lead time floor (days) used in reorder point calculation for all SKUs",
  572. )
  573. location_sensor_poll_interval: int = Field(
  574. default=120,
  575. ge=60,
  576. le=3600,
  577. description="Seconds between Home Assistant polls/UI refreshes for storage-location sensors",
  578. )
  579. # Server-backed rather than per-browser: these seed the alert rule written
  580. # onto each sensor row when one is bound, so two admins binding sensors
  581. # from different browsers must not seed different rules — and a restore
  582. # has to bring them back. The "show on card" default stays local, because
  583. # show_on_card is decided per sensor and this is only its form
  584. # pre-selection. Same JSON-in-a-string shape as preheat_filament_targets.
  585. location_sensor_alert_defaults: str = Field(
  586. default="",
  587. description=(
  588. "JSON map of sensor category (temperature/humidity/battery) → "
  589. '{"alertAbove": str, "alertBelow": str, "notifyOnAlert": bool}, seeding new '
  590. "storage-location sensor bindings. Empty = built-in defaults."
  591. ),
  592. )
  593. # Default sidebar order (admin-set for all users)
  594. default_sidebar_order: str = Field(
  595. default="",
  596. description="JSON object with 'order' key containing array of sidebar item IDs (empty = no default)",
  597. )
  598. class AppSettingsUpdate(BaseModel):
  599. """Schema for updating settings (all fields optional)."""
  600. auto_archive: bool | None = None
  601. save_thumbnails: bool | None = None
  602. capture_finish_photo: bool | None = None
  603. finish_photo_restore_plate: bool | None = None
  604. default_filament_cost: float | None = None
  605. currency: str | None = None
  606. energy_cost_per_kwh: float | None = None
  607. energy_tracking_mode: str | None = None
  608. spoolman_enabled: bool | None = None
  609. spoolman_url: str | None = None
  610. spoolman_sync_mode: str | None = None
  611. spoolman_disable_weight_sync: bool | None = None
  612. spoolman_report_partial_usage: bool | None = None
  613. auto_add_unknown_rfid: bool | None = None
  614. disable_filament_warnings: bool | None = None
  615. prefer_lowest_filament: bool | None = None
  616. check_updates: bool | None = None
  617. check_printer_firmware: bool | None = None
  618. include_beta_updates: bool | None = None
  619. local_login_enabled: bool | None = None
  620. language: str | None = None
  621. notification_language: str | None = None
  622. bed_cooled_threshold: float | None = None
  623. ams_humidity_good: int | None = None
  624. ams_humidity_fair: int | None = None
  625. ams_temp_good: float | None = None
  626. ams_temp_fair: float | None = None
  627. ams_temp_alarm: float | None = None
  628. ams_history_retention_days: int | None = None
  629. printer_sensor_history_retention_days: int | None = None
  630. queue_drying_enabled: bool | None = None
  631. queue_drying_block: bool | None = None
  632. ambient_drying_enabled: bool | None = None
  633. print_drying_enabled: bool | None = None
  634. drying_presets: str | None = None
  635. ams_humidity_thresholds: str | None = None
  636. per_printer_mapping_expanded: bool | None = None
  637. date_format: str | None = None
  638. time_format: str | None = None
  639. default_printer_id: int | None = None
  640. pipeline_max_copies: int | None = None
  641. virtual_printer_enabled: bool | None = None
  642. virtual_printer_access_code: str | None = None
  643. virtual_printer_mode: str | None = None
  644. virtual_printer_archive_name_source: str | None = None
  645. dark_style: str | None = None
  646. dark_background: str | None = None
  647. dark_accent: str | None = None
  648. light_style: str | None = None
  649. light_background: str | None = None
  650. light_accent: str | None = None
  651. ftp_retry_enabled: bool | None = None
  652. ftp_retry_count: int | None = None
  653. ftp_retry_delay: int | None = None
  654. ftp_timeout: int | None = None
  655. mqtt_enabled: bool | None = None
  656. mqtt_broker: str | None = None
  657. mqtt_port: int | None = None
  658. mqtt_username: str | None = None
  659. mqtt_password: str | None = None
  660. mqtt_topic_prefix: str | None = None
  661. mqtt_use_tls: bool | None = None
  662. external_url: str | None = None
  663. docker_compose_dir: str | None = None
  664. ha_enabled: bool | None = None
  665. ha_url: str | None = None
  666. ha_token: str | None = None
  667. library_archive_mode: str | None = None
  668. library_disk_warning_gb: float | None = None
  669. camera_view_mode: str | None = None
  670. preferred_slicer: str | None = None
  671. open_in_slicer: str | None = None
  672. slice_engine: str | None = None
  673. use_slicer_api: bool | None = None
  674. orcaslicer_api_url: str | None = None
  675. bambu_studio_api_url: str | None = None
  676. slicer_stall_timeout_minutes: int | None = Field(default=None, ge=1, le=240)
  677. prometheus_enabled: bool | None = None
  678. prometheus_token: str | None = None
  679. low_stock_threshold: float | None = Field(default=None, ge=0.1, le=99.9)
  680. session_max_hours: int | None = Field(default=None, ge=1, le=720)
  681. user_notifications_enabled: bool | None = None
  682. default_bed_levelling: TriState | None = None
  683. default_flow_cali: TriState | None = None
  684. default_vibration_cali: bool | None = None
  685. default_layer_inspect: bool | None = None
  686. default_timelapse: bool | None = None
  687. default_nozzle_offset_cali: TriState | None = None
  688. stagger_group_size: int | None = Field(default=None, ge=1, le=50)
  689. stagger_interval_minutes: int | None = Field(default=None, ge=1, le=60)
  690. billing_enabled: bool | None = None
  691. printer_kill_switch_enabled: bool | None = None
  692. finance_budget_reset_day: int | None = Field(default=None, ge=1, le=31)
  693. finance_budget_reset_timezone: str | None = None
  694. require_plate_clear: bool | None = None
  695. queue_shortest_first: bool | None = None
  696. queue_max_concurrent_uploads: int | None = Field(default=None, ge=1, le=16)
  697. preheat_enabled: bool | None = None
  698. preheat_filament_targets: str | None = None
  699. preheat_max_wait_seconds: int | None = Field(default=None, ge=60, le=3600)
  700. preheat_soak_seconds: int | None = Field(default=None, ge=0, le=1800)
  701. queue_keep_bed_warm: bool | None = None
  702. queue_keep_warm_bed_temp: int | None = Field(default=None, ge=40, le=110)
  703. queue_keep_warm_max_minutes: int | None = Field(default=None, ge=5, le=480)
  704. nozzle_temp_presets: str | None = None
  705. bed_temp_presets: str | None = None
  706. chamber_temp_presets: str | None = None
  707. fan_speed_presets: str | None = None
  708. gcode_snippets: str | None = None
  709. local_backup_enabled: bool | None = None
  710. local_backup_schedule: str | None = None
  711. local_backup_time: str | None = None
  712. local_backup_retention: int | None = None
  713. local_backup_path: str | None = None
  714. ldap_enabled: bool | None = None
  715. ldap_server_url: str | None = None
  716. ldap_bind_dn: str | None = None
  717. ldap_bind_password: str | None = None
  718. ldap_search_base: str | None = None
  719. ldap_user_filter: str | None = None
  720. ldap_security: str | None = None
  721. ldap_group_mapping: str | None = None
  722. ldap_auto_provision: bool | None = None
  723. ldap_default_group: str | None = None
  724. obico_enabled: bool | None = None
  725. obico_ml_url: str | None = None
  726. obico_ml_token: str | None = None
  727. obico_sensitivity: str | None = None
  728. obico_action: str | None = None
  729. obico_poll_interval: int | None = Field(default=None, ge=5, le=120)
  730. obico_enabled_printers: str | None = None
  731. default_sidebar_order: str | None = None
  732. forecast_global_lead_time_days: int | None = Field(default=None, ge=0)
  733. location_sensor_poll_interval: int | None = Field(default=None, ge=60, le=3600)
  734. # Three categories × three short fields is well under 300 characters of
  735. # JSON, so 2000 is pure headroom — the cap only stops a stray client from
  736. # parking megabytes in the settings table. Write path only: the AppSettings
  737. # read model must keep accepting whatever an older install already stored.
  738. location_sensor_alert_defaults: str | None = Field(default=None, max_length=2000)
  739. @field_validator(*LAN_SERVICE_URL_SETTINGS)
  740. @classmethod
  741. def validate_lan_service_url(cls, v: str | None, info: ValidationInfo) -> str | None:
  742. """Reject SSRF-unsafe outbound service URLs on save.
  743. Empty (and whitespace-only) is the documented "not configured / fall
  744. back to the env var" value for all four fields and must keep passing.
  745. Values that are not absolute URLs at all ("192.168.1.10:3333",
  746. "localhost:3333") are left alone rather than rejected. Two reasons:
  747. - They are inert. Every consumer of these four settings goes through
  748. httpx, which raises UnsupportedProtocol for a URL with no scheme, so
  749. no request is ever issued and there is nothing to guard against.
  750. - They were storable before this validator existed, and the settings
  751. UI is a plain text input with no scheme enforcement. Newly rejecting
  752. them would break saves that have nothing to do with the URL: the
  753. Obico panel, for one, sends obico_ml_url with every change and
  754. auto-saves, so one legacy value would block toggling detection on or
  755. off. A pre-existing misconfiguration should keep failing where it
  756. already failed (at request time), not spread to unrelated fields.
  757. ``urlparse`` is no help in telling the two apart — it reads
  758. "localhost:3333" as scheme "localhost" — so the test is the literal
  759. "://" that makes a string an absolute URL.
  760. """
  761. if v is None or not v.strip():
  762. return v
  763. candidate = v.strip()
  764. if "://" not in candidate:
  765. return v
  766. # Lazy-imported: schemas avoid top-level imports from api/routes,
  767. # matching the existing pattern in auth.py's _validate_icon_url.
  768. from backend.app.api.routes._url_safety import assert_safe_lan_service_url
  769. try:
  770. assert_safe_lan_service_url(candidate, label=info.field_name or "URL")
  771. except ValueError as exc:
  772. raise ValueError(str(exc)) from exc
  773. return v
  774. @field_validator("docker_compose_dir")
  775. @classmethod
  776. def validate_docker_compose_dir(cls, v: str | None) -> str | None:
  777. """Keep the copy-and-paste update command free of shell injection (#2664).
  778. Validated on the write path only. Doing it on ``AppSettings`` as well
  779. would mean a single bad row — however it got there — 500s the entire
  780. settings GET and takes the app down with it, which is a worse outcome
  781. than rendering a string that has to be pasted into a shell by hand to
  782. do anything at all.
  783. """
  784. if v is None or not v.strip():
  785. return v
  786. candidate = v.strip()
  787. if len(candidate) > _COMPOSE_DIR_MAX_LEN:
  788. raise ValueError(f"Compose directory must be at most {_COMPOSE_DIR_MAX_LEN} characters")
  789. if not _COMPOSE_DIR_ALLOWED.match(candidate):
  790. raise ValueError(
  791. "Compose directory may only contain path characters (letters, digits, space, and - _ . / \\ : ~)"
  792. )
  793. # A trailing backslash is the one survivor that would still break the
  794. # frontend's double-quoting: `cd "/opt/bam buddy\"` escapes the closing
  795. # quote and swallows the rest of the line. Harmless (the shell just
  796. # waits for a terminator rather than running anything) but the user
  797. # would be left staring at a continuation prompt, so refuse it here
  798. # instead of shipping a command that cannot work.
  799. if candidate.endswith("\\"):
  800. raise ValueError("Compose directory must not end with a backslash")
  801. return candidate
  802. @field_validator("gcode_snippets")
  803. @classmethod
  804. def validate_gcode_snippets(cls, v: str | None) -> str | None:
  805. if v is None or v == "":
  806. return v
  807. try:
  808. parsed = json.loads(v)
  809. except json.JSONDecodeError:
  810. raise ValueError("gcode_snippets must be valid JSON or empty")
  811. if not isinstance(parsed, dict):
  812. raise ValueError("gcode_snippets must be a JSON object keyed by printer model")
  813. return v
  814. @field_validator("ldap_group_mapping")
  815. @classmethod
  816. def validate_ldap_group_mapping(cls, v: str | None) -> str | None:
  817. if v is None or v == "":
  818. return v
  819. try:
  820. parsed = json.loads(v)
  821. except json.JSONDecodeError:
  822. raise ValueError("ldap_group_mapping must be valid JSON or empty")
  823. if not isinstance(parsed, dict):
  824. raise ValueError("ldap_group_mapping must be a JSON object mapping LDAP group DNs to BamBuddy group names")
  825. return v
  826. @field_validator("obico_enabled_printers")
  827. @classmethod
  828. def validate_obico_enabled_printers(cls, v: str | None) -> str | None:
  829. if v is None or v == "":
  830. return v
  831. try:
  832. parsed = json.loads(v)
  833. except json.JSONDecodeError:
  834. raise ValueError("obico_enabled_printers must be valid JSON or empty")
  835. if not isinstance(parsed, list) or not all(isinstance(item, int) for item in parsed):
  836. raise ValueError("obico_enabled_printers must be a JSON array of printer IDs (integers)")
  837. return v
  838. @staticmethod
  839. def _validate_preset_triple(v: str | None, field_name: str, lo: int, hi: int) -> str | None:
  840. """Validate a JSON array of exactly 3 ints in [lo, hi]. Empty = defaults."""
  841. if v is None or v == "":
  842. return v
  843. try:
  844. parsed = json.loads(v)
  845. except json.JSONDecodeError:
  846. raise ValueError(f"{field_name} must be valid JSON or empty")
  847. if not isinstance(parsed, list) or len(parsed) != 3:
  848. raise ValueError(f"{field_name} must be a JSON array of exactly 3 integers")
  849. if not all(isinstance(item, int) and not isinstance(item, bool) for item in parsed):
  850. raise ValueError(f"{field_name} entries must all be integers")
  851. if not all(lo <= item <= hi for item in parsed):
  852. raise ValueError(f"{field_name} entries must each be in [{lo}, {hi}]")
  853. return v
  854. @field_validator("nozzle_temp_presets")
  855. @classmethod
  856. def validate_nozzle_temp_presets(cls, v: str | None) -> str | None:
  857. return cls._validate_preset_triple(v, "nozzle_temp_presets", 0, 320)
  858. @field_validator("bed_temp_presets")
  859. @classmethod
  860. def validate_bed_temp_presets(cls, v: str | None) -> str | None:
  861. return cls._validate_preset_triple(v, "bed_temp_presets", 0, 140)
  862. @field_validator("chamber_temp_presets")
  863. @classmethod
  864. def validate_chamber_temp_presets(cls, v: str | None) -> str | None:
  865. return cls._validate_preset_triple(v, "chamber_temp_presets", 0, MAX_CHAMBER_TEMP_C)
  866. @field_validator("fan_speed_presets")
  867. @classmethod
  868. def validate_fan_speed_presets(cls, v: str | None) -> str | None:
  869. return cls._validate_preset_triple(v, "fan_speed_presets", 0, 100)
  870. @field_validator("obico_sensitivity")
  871. @classmethod
  872. def validate_obico_sensitivity(cls, v: str | None) -> str | None:
  873. if v is None:
  874. return v
  875. if v not in ("low", "medium", "high"):
  876. raise ValueError("obico_sensitivity must be 'low', 'medium', or 'high'")
  877. return v
  878. @field_validator("obico_action")
  879. @classmethod
  880. def validate_obico_action(cls, v: str | None) -> str | None:
  881. if v is None:
  882. return v
  883. if v not in ("notify", "pause", "pause_and_off"):
  884. raise ValueError("obico_action must be 'notify', 'pause', or 'pause_and_off'")
  885. return v
  886. @field_validator("default_sidebar_order")
  887. @classmethod
  888. def validate_default_sidebar_order(cls, v: str | None) -> str | None:
  889. if v is None or v == "":
  890. return v
  891. try:
  892. parsed = json.loads(v)
  893. except json.JSONDecodeError:
  894. raise ValueError("default_sidebar_order must be valid JSON or empty")
  895. if isinstance(parsed, dict):
  896. order = parsed.get("order")
  897. hidden_system_item_ids = parsed.get("hiddenSystemItemIds", [])
  898. if not isinstance(hidden_system_item_ids, list) or not all(
  899. isinstance(item, str) for item in hidden_system_item_ids
  900. ):
  901. raise ValueError("sidebar hidden system item IDs must be an array of strings")
  902. elif isinstance(parsed, list):
  903. order = parsed
  904. else:
  905. raise ValueError("default_sidebar_order must be a JSON object with 'order' key or a JSON array")
  906. if not isinstance(order, list) or not all(isinstance(item, str) for item in order):
  907. raise ValueError("sidebar order must be an array of strings")
  908. return v