jneilliii/OctoPrint-PrusaSlicerThumbnails

Reserved characters in thumbnail filenames are not correctly encoded (leading to 404 error)

manolitto opened this issue · 8 comments

manolitto commented

The src attribute of the generated img element is not correctly encoded.
All reserved characters must be percent encoded: see "Reserved characters" in https://en.wikipedia.org/wiki/Percent-encoding

Example:

<img id="prusaslicer_state_thumbnail" class="pull-left" src="plugin/prusaslicerthumbnails/thumbnail/Base#magnetic,openlock_0.15mm_PLA_MK3S_5h17m.png?20220106190630" width="100%">

--> gives a 404 not found error

... whereas

<img id="prusaslicer_state_thumbnail" class="pull-left" src="plugin/prusaslicerthumbnails/thumbnail/Base%23magnetic,openlock_0.15mm_PLA_MK3S_5h17m.png?20220106190630" width="100%">

--> correctly displays the image

jneilliii commented

Thanks for this. I thought I had accounted for that already, but will definitely take a look.

jneilliii commented

I think I've fixed this with the above commit, but need to test to verify. If you want to test it out you can change the plugin's release channel in OctoPrint's Software Update settings to Release Candidate and update when prompted.

SturmB commented

Good evening. I'm afraid this issue is not completely fixed. I have tried both the latest stable (1.0.0) and RC (1.0.1rc5) and am witnessing the same issue with both. I have detailed the issue on this Reddit thread.

In short, whenever the gcode filename contains a special character, such as '#' or '%', the thumbnail renderer breaks and displays the 'broken image' icon instead of the image. (Seems to return a 400 error code.) I have also confirmed that renaming an existing gcode file to remove the special characters fixes the issue.

Some info that may be of use for you:

jneilliii commented

Did you reupload your file after updating to the latest rc version?

SturmB commented

Just tried it. Yes, uploading a gcode with a special character in its filename while the v1.0.1rc5 Slicer Thumbnail plugin is installed does show the thumbnail. Yay!

Existing files on the OctoPi still need to have their filenames changed, however. Or deleted and re-uploaded.

jneilliii commented

Thanks for the confirmation @SturmB. I'm pretty sure the scan files option in settings wouldn't pick these up either because when it checks the metadata the filename matches what's there and it's purely a web encoding issue.

SturmB commented

I just tried the "Scan Files" option, just for the heck of it. You are correct that thumbnails for gcode files that were uploaded while using v1.0.0 of the plugin are still not recognized.

I look forward to RC5 making it into stable. In the mean time, I'll probably keep using RC5 as I don't see any bugs with it so far. I might also try to refrain from adding special characters to my filenames anyway, just to prevent any other possible problems in the future, perhaps with other plugins.

jneilliii commented

you can actually disable the newly added feature in OctoPrint if you are just trying to avoid the special characters in general. I'll try to add some logic for the update install to handle the migration a little better between versions. might be able to do that tonight and release a rc6 version to validate it works properly prior to stable release. you'll find most my plugins have rc versions newer than stable release and are more or less fully functional. I typically put those out there for people to validate changes related to reported issues prior to stable release.

  • 👍1