mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-30 11:12:35 +02:00
maziggy
6d316c5593
A library row with archive.filename "Cube (1).gcode.3mf.gcode.3mf" uploaded
to /Cube_(1).gcode.3mf.3mf (single-iteration strip + append). Post-print
cleanup looked at /Cube_(1).3mf and /Cube_(1).gcode (subtask_name + ext),
missed the on-card file, and A1 firmware re-ran it on next power-on.
- New derive_remote_filename() helper in backend/app/utils/filename.py:
iterative strip of .gcode.3mf/.3mf suffixes, append single .3mf,
space->underscore. isinstance() guard raises TypeError on non-str
input rather than entering the strip loop with a duck-typed
object that returns truthy sentinels from endswith.
- Three previously-duplicated upload sites (background_dispatch reprint +
library, print_scheduler queue) now share the helper.
- SD cleanup fetches archive.filename and tries the derived path first,
with the legacy subtask_name + ext paths kept as fallbacks.
- 10 new unit tests pin the reproducer + edge cases (doubled .gcode.3mf,
doubled .3mf, raw .gcode preserved, idempotence, Unicode, plus the
type guard against MagicMock / None / int inputs).
91 lines
3.8 KiB
Python
91 lines
3.8 KiB
Python
"""Print-file filename validation matching Bambu Studio's save-dialog rules.
|
|
|
|
The Bambu printer SD card is FAT32/exFAT. Names containing the Windows /
|
|
DOS-reserved set (``< > : " / \\ | ? *``), ASCII control characters
|
|
(0x00-0x1F), or trailing dots / spaces cannot be created on it — FTP fails
|
|
with ``553 Could not create file`` (#1540). Bambu Studio refuses to save
|
|
such names client-side; Bambuddy now does the same at the rename, upload,
|
|
and dispatch boundaries so the failure surfaces with a clear message
|
|
instead of an obscure FTP error after the user has already hit Print.
|
|
"""
|
|
|
|
INVALID_FILENAME_CHARS = '<>:"/\\|?*'
|
|
|
|
# FAT/exFAT cap on a single path component; UTF-8 byte length, not codepoints,
|
|
# because that is what the on-disk encoding limit actually is.
|
|
MAX_FILENAME_BYTES = 255
|
|
|
|
|
|
class InvalidFilenameError(ValueError):
|
|
"""Filename contains characters or shape the printer SD card rejects.
|
|
|
|
``char`` is the first offending character when the failure is a
|
|
character-set violation, or ``None`` for structural failures (empty,
|
|
bare ``.``, trailing space, too long, etc.). The frontend echoes it
|
|
back to the user in the Bambu Studio-style error message.
|
|
"""
|
|
|
|
def __init__(self, message: str, char: str | None = None):
|
|
super().__init__(message)
|
|
self.char = char
|
|
|
|
|
|
def validate_print_filename(name: str) -> None:
|
|
"""Raise ``InvalidFilenameError`` if ``name`` would fail on the SD card.
|
|
|
|
Matches Bambu Studio's save-dialog rejection set. Callers are expected
|
|
to translate the exception into an HTTP 400 (or a clean dispatch
|
|
rejection); the message is intentionally short and ASCII so it fits
|
|
a translation template.
|
|
"""
|
|
if not name or not name.strip():
|
|
raise InvalidFilenameError("Filename cannot be empty")
|
|
|
|
if name in (".", ".."):
|
|
raise InvalidFilenameError("Filename cannot be '.' or '..'")
|
|
|
|
for ch in name:
|
|
if ch in INVALID_FILENAME_CHARS:
|
|
raise InvalidFilenameError(f"Filename contains invalid character: {ch}", char=ch)
|
|
if ord(ch) < 0x20:
|
|
raise InvalidFilenameError("Filename contains a control character", char=ch)
|
|
|
|
if name.endswith(" ") or name.endswith("."):
|
|
raise InvalidFilenameError("Filename cannot end with a space or dot")
|
|
|
|
if len(name.encode("utf-8")) > MAX_FILENAME_BYTES:
|
|
raise InvalidFilenameError(f"Filename exceeds {MAX_FILENAME_BYTES} bytes")
|
|
|
|
|
|
def derive_remote_filename(filename: str) -> str:
|
|
"""Compute the SD-card filename used when uploading a sliced print file.
|
|
|
|
Strips repeated trailing ``.gcode.3mf`` / ``.3mf`` suffixes until the
|
|
bare stem remains, then appends a single ``.3mf``; spaces are
|
|
replaced with underscores because the firmware parses
|
|
``ftp://{filename}`` as a URL.
|
|
|
|
Canonical for both the dispatch uploader and the post-print SD
|
|
cleanup — when the two drift apart the cleanup misses, and a
|
|
library row whose stored filename ended up with a doubled
|
|
``.gcode.3mf`` (#1542) leaves the real file on the SD card. On A1
|
|
firmware that lingering file becomes a ghost print on the next
|
|
power-on (same family as the P1S behaviour in #374).
|
|
|
|
Raises ``TypeError`` on non-string input rather than entering the
|
|
strip loop, because a duck-typed object that returns truthy
|
|
sentinels from ``endswith`` would never escape and the resulting
|
|
unbounded allocation has cgroup-OOM'd the test runner under mocks.
|
|
"""
|
|
if not isinstance(filename, str):
|
|
raise TypeError(f"derive_remote_filename requires str, got {type(filename).__name__}")
|
|
stem = filename
|
|
while True:
|
|
if stem.endswith(".gcode.3mf"):
|
|
stem = stem[:-10]
|
|
elif stem.endswith(".3mf"):
|
|
stem = stem[:-4]
|
|
else:
|
|
break
|
|
return f"{stem}.3mf".replace(" ", "_")
|