Skip to content

Change the method of get file extension. - #475

Open
myafer wants to merge 16 commits into
Baseflow:mainfrom
myafer:develop
Open

myafer wants to merge 16 commits into
Baseflow:mainfrom
myafer:develop

Conversation

@myafer

@myafer myafer commented Dec 4, 2024 •

Copy link
Copy Markdown

✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)

Bug fix.

⤵️ What is the current behavior?

When the http response's Content-Type is not image and the _resizeimage is not work.

🆕 What is the new behavior (if this is a feature change)?

The new method is get files extension with the file's binary data.

💥 Does this PR introduce a breaking change?

No.

🐛 Recommendations for testing

📝 Links to relevant issues/docs

🤔 Checklist before submitting

  • All projects build
  • Follows style guide lines (code style guide)
  • Relevant documentation was updated
  • Rebased onto current develop

@cedvdb

cedvdb commented Apr 22, 2025 •

Copy link
Copy Markdown

@renefloor could this be reviewed ? using magic bytes is preferred over a potentially missing extension

@rickdijk
rickdijk changed the base branch from develop to main September 16, 2026 00:24
settings.gradle and pubspec.yaml conflicted on lines main has since
moved past (kotlin 2.3.20, build_runner ^2.14.0), so main's lines are
kept. image_cache_manager.dart reformatted with dart format.

Co-Authored-By: Claude <noreply@anthropic.com>
@rickdijk

Copy link
Copy Markdown
Contributor

main has moved since you opened this, and our changes to example/android/settings.gradle and pubspec.yaml left it conflicting. I have merged main into your branch and resolved those conflicts. In both files main had already moved past the versions this pull request set (Kotlin 2.3.20 rather than 1.8.22, and build_runner ^2.14.0 rather than ^2.4.9), so I kept main's lines there. Your image_cache_manager.dart change is untouched apart from one line reflowed by dart format.

The resizer decided whether a file could be resized from the extension of
the file on disk. That extension is derived from the url, so images served
from extension-less urls, or from urls whose extension does not match the
payload, were never resized. It also treated any zero-prefixed binary as an
ico.

- Detect jpeg, png, ico, cur and webp by their magic number, reading 12
  bytes instead of 8 (webp needs the RIFF/WEBP marker at offset 8).
- Keep an extension fallback for formats without a signature at the start
  of the file, like tga, which only stores a signature in its footer.
- Read the header in a helper that always closes the file handle.
- Restore the trailing newline in example/android/build.gradle, which was
  dropped by an earlier commit in this branch.
- Bump to 3.4.6 with a dated changelog entry, as CONTRIBUTING now requires.

Tests: cover an image served without an extension and a non-image payload
served with an image extension.
@myafer

myafer commented Oct 19, 2026

Copy link
Copy Markdown
Author

Pushed a follow-up on top of your merge — thanks for resolving the settings.gradle / pubspec.yaml conflicts, I left your resolution untouched. The branch is still conflict-free against main.

What changed in image_cache_manager.dart:

  • Detect jpeg / png / ico / cur by magic number, and webp by its RIFF....WEBP marker, so 12 bytes are read instead of 8.
  • Fixed the swapped ICO (00 00 01 00) / CUR (00 00 02 00) values and dropped the 00 00 00 00 check, which matched any zero-prefixed binary.
  • Kept an extension fallback, but only for formats without a header signature (tga only writes one in its footer). supportedFileNames stays as it is.
  • Removed the debugPrint, and the header is now read in a helper that closes the handle in a finally.

Tests in test/image_cache_manager_test.dart: an image served from an extension-less url is resized, and a non-image payload served with a .png url is returned untouched.

Also bumped to 3.4.6 with a dated changelog entry per CONTRIBUTING, and restored the trailing newline in example/android/build.gradle that an earlier commit in this branch dropped.

dart format is clean. I could not run flutter test locally (mockito ^5.7.0 requires Dart 3.11, I only have 3.9), so it would be great if someone could approve the workflow run — it is still sitting at action_required.

Flutter decodes bmp and wbmp as well, so they are resizable too. Bmp has a
'BM' signature and can be detected from the content. Wbmp starts with a
two byte header that is too generic to match on, so it joins tga in the
extension fallback.
@myafer

myafer commented Oct 19, 2026

Copy link
Copy Markdown
Author

Follow-up: added bmp (BM) to the signatures, and wbmp to the extension fallback.

Wbmp is in Flutter's list of decodable formats, but it cannot be detected from the content: its header is 00 00, which matches any zero-prefixed binary — the same trap as the 00 00 00 00 ico check that was removed. So like tga it is only recognized by its extension.

Gif is intentionally left out: it is decodable, but _resizeImageFile re-encodes to PNG, so resizing would turn an animated gif into a still image. Happy to add it if that trade-off is acceptable.

Two bytes (the SOI marker) are enough to tell jpeg apart from the other
formats that are checked, which is what SDWebImage and most detectors do.
A file that is detected as an image but fails to decode then errors out of
getImageFile, as it already did for a mislabeled extension before this
change.
The extension that was passed to putFile came from the cached file path. For
a url without an extension that path ends in the key itself, so the
extension contained a slash and putFile failed to create the file. This is
what the new test for an extension-less url caught.

The resized image is always encoded as png anyway, so name it png instead of
copying the extension of the url.
The resizer always re-encodes the image to png, which keeps a single frame.
Now that webp is recognized by its signature, an animated webp would enter
the resizer and silently lose its animation. That is the same reason gif is
not recognized at all.

Read the flags of the VP8X chunk, which is where an extended webp marks
itself as animated, and pass those files through untouched. A static webp,
with or without a VP8X chunk, is still resized.
A tga without an id field and without a colour map starts with the same
four bytes as an ico or a cur, so the signatures cannot be told apart. It
does not affect the result, since all of them are resizable, but it looks
like a mistake without the note.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants