[MM-63436] Replace Exif parser dependency (#30479)
* Replace Exif parser dependency * Improve forward seeking logic * Fix linting * Stop decoding upon finding tag * Use latest version of imagemeta dependency * Don't skip TIFF reader tests * Log improvements --------- Co-authored-by: Mattermost Build <build@mattermost.com>
Этот коммит содержится в:
Claudio Costa
коммит произвёл
GitHub
GitHub
родитель
2454de5b4a
Коммит
f8e16780ef
@@ -4,12 +4,14 @@
|
||||
package imaging
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"image"
|
||||
"io"
|
||||
"strings"
|
||||
|
||||
"github.com/anthonynsimon/bild/transform"
|
||||
"github.com/rwcarlsen/goexif/exif"
|
||||
"github.com/bep/imagemeta"
|
||||
)
|
||||
|
||||
const (
|
||||
@@ -33,6 +35,8 @@ const (
|
||||
RotatedCW
|
||||
)
|
||||
|
||||
var errStopDecoding = fmt.Errorf("stop decoding")
|
||||
|
||||
// MakeImageUpright changes the orientation of the given image.
|
||||
func MakeImageUpright(img image.Image, orientation int) image.Image {
|
||||
switch orientation {
|
||||
@@ -55,23 +59,101 @@ func MakeImageUpright(img image.Image, orientation int) image.Image {
|
||||
}
|
||||
}
|
||||
|
||||
type fwSeeker struct {
|
||||
r io.Reader
|
||||
pos int64
|
||||
}
|
||||
|
||||
func (f *fwSeeker) Read(p []byte) (int, error) {
|
||||
n, err := f.r.Read(p)
|
||||
if err != nil {
|
||||
return n, err
|
||||
}
|
||||
f.pos += int64(n)
|
||||
return n, nil
|
||||
}
|
||||
|
||||
func (f *fwSeeker) Seek(offset int64, whence int) (int64, error) {
|
||||
isForwardSeek := (whence == io.SeekStart && offset >= f.pos) ||
|
||||
(whence == io.SeekCurrent && offset >= 0)
|
||||
|
||||
// We only support seeking forward.
|
||||
if !isForwardSeek {
|
||||
return 0, fmt.Errorf("seeking backwards is not supported")
|
||||
}
|
||||
|
||||
toRead := offset
|
||||
if whence == io.SeekStart {
|
||||
toRead -= f.pos
|
||||
}
|
||||
|
||||
// Seeking forward means we can simply discard the data.
|
||||
n, err := io.CopyN(io.Discard, f.r, toRead)
|
||||
if err != nil {
|
||||
return n, fmt.Errorf("failed to seek: %w", err)
|
||||
}
|
||||
|
||||
f.pos += n
|
||||
|
||||
return f.pos, nil
|
||||
}
|
||||
|
||||
// GetImageOrientation reads the input data and returns the EXIF encoded
|
||||
// image orientation.
|
||||
func GetImageOrientation(input io.Reader) (int, error) {
|
||||
exifData, err := exif.Decode(input)
|
||||
if err != nil {
|
||||
// image orientation. Supported formats are JPEG, PNG, TIFF, and WebP.
|
||||
// Passing an io.ReadSeeker is preferable as we can't guarantee a plain
|
||||
// io.Reader will work for all formats (e.g. TIFF requires backwards seeking).
|
||||
func GetImageOrientation(input io.Reader, format string) (int, error) {
|
||||
orientation := Upright
|
||||
|
||||
// Strip the "image/" prefix from the format in case it's a MIME type.
|
||||
format, _ = strings.CutPrefix(format, "image/")
|
||||
|
||||
var imgFormat imagemeta.ImageFormat
|
||||
switch format {
|
||||
case "jpeg":
|
||||
imgFormat = imagemeta.JPEG
|
||||
case "png":
|
||||
imgFormat = imagemeta.PNG
|
||||
case "tiff":
|
||||
imgFormat = imagemeta.TIFF
|
||||
case "webp":
|
||||
imgFormat = imagemeta.WebP
|
||||
default:
|
||||
// We don't support EXIF on any other format.
|
||||
return orientation, fmt.Errorf("unsupported image format: %s", format)
|
||||
}
|
||||
|
||||
var rs io.ReadSeeker
|
||||
if r, ok := input.(io.ReadSeeker); ok {
|
||||
rs = r
|
||||
} else {
|
||||
rs = &fwSeeker{r: input}
|
||||
}
|
||||
|
||||
opts := imagemeta.Options{
|
||||
R: rs,
|
||||
HandleTag: func(tag imagemeta.TagInfo) error {
|
||||
if tag.Tag == "Orientation" {
|
||||
if o, ok := tag.Value.(uint16); ok {
|
||||
orientation = int(o)
|
||||
// Stop decoding after we've found the orientation tag]
|
||||
// since it's the only one we care about.
|
||||
return errStopDecoding
|
||||
}
|
||||
}
|
||||
return nil
|
||||
},
|
||||
ShouldHandleTag: func(tag imagemeta.TagInfo) bool {
|
||||
// We only care about the orientation tag.
|
||||
return tag.Tag == "Orientation"
|
||||
},
|
||||
Sources: imagemeta.EXIF, // We only care about EXIF data.
|
||||
ImageFormat: imgFormat,
|
||||
}
|
||||
|
||||
if err := imagemeta.Decode(opts); err != nil && !errors.Is(err, errStopDecoding) {
|
||||
return Upright, fmt.Errorf("failed to decode exif data: %w", err)
|
||||
}
|
||||
|
||||
tag, err := exifData.Get("Orientation")
|
||||
if err != nil {
|
||||
return Upright, fmt.Errorf("failed to get orientation field from exif data: %w", err)
|
||||
}
|
||||
|
||||
orientation, err := tag.Int(0)
|
||||
if err != nil {
|
||||
return Upright, fmt.Errorf("failed to get value from exif tag: %w", err)
|
||||
}
|
||||
|
||||
return orientation, nil
|
||||
}
|
||||
|
||||
199
server/channels/app/imaging/orientation_test.go
Обычный файл
199
server/channels/app/imaging/orientation_test.go
Обычный файл
@@ -0,0 +1,199 @@
|
||||
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
||||
// See LICENSE.txt for license information.
|
||||
|
||||
package imaging
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/mattermost/mattermost/server/v8/channels/utils/fileutils"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestFwSeeker(t *testing.T) {
|
||||
t.Run("Read", func(t *testing.T) {
|
||||
data := []byte("hello world")
|
||||
reader := bytes.NewReader(data)
|
||||
seeker := &fwSeeker{r: reader}
|
||||
|
||||
// Read the first 5 bytes
|
||||
buf := make([]byte, 5)
|
||||
n, err := seeker.Read(buf)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 5, n)
|
||||
require.Equal(t, []byte("hello"), buf)
|
||||
|
||||
// Read the next 6 bytes
|
||||
buf = make([]byte, 6)
|
||||
n, err = seeker.Read(buf)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 6, n)
|
||||
require.Equal(t, []byte(" world"), buf)
|
||||
|
||||
// Try to read more, should get EOF
|
||||
buf = make([]byte, 1)
|
||||
n, err = seeker.Read(buf)
|
||||
require.Equal(t, 0, n)
|
||||
require.Equal(t, io.EOF, err)
|
||||
})
|
||||
|
||||
t.Run("Seek forward from start", func(t *testing.T) {
|
||||
data := []byte("hello world")
|
||||
reader := bytes.NewReader(data)
|
||||
seeker := &fwSeeker{r: reader}
|
||||
|
||||
// Seek forward 6 bytes
|
||||
pos, err := seeker.Seek(6, io.SeekStart)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, int64(6), pos)
|
||||
|
||||
// Seeking from the same position should work
|
||||
pos, err = seeker.Seek(6, io.SeekStart)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, int64(6), pos)
|
||||
|
||||
// Seeking again from start should work.
|
||||
pos, err = seeker.Seek(7, io.SeekStart)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, int64(7), pos)
|
||||
|
||||
// Seeking backwards should not be supported
|
||||
_, err = seeker.Seek(6, io.SeekStart)
|
||||
require.EqualError(t, err, "seeking backwards is not supported")
|
||||
|
||||
// Read the remaining data
|
||||
buf := make([]byte, 4)
|
||||
n, err := seeker.Read(buf)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 4, n)
|
||||
require.Equal(t, []byte("orld"), buf)
|
||||
})
|
||||
|
||||
t.Run("Seek forward from current", func(t *testing.T) {
|
||||
data := []byte("hello world")
|
||||
reader := bytes.NewReader(data)
|
||||
seeker := &fwSeeker{r: reader}
|
||||
|
||||
// Read first 6 bytes
|
||||
buf := make([]byte, 6)
|
||||
n, err := seeker.Read(buf)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 6, n)
|
||||
require.Equal(t, []byte("hello "), buf)
|
||||
|
||||
// Seek forward 2 more bytes from current position
|
||||
pos, err := seeker.Seek(2, io.SeekCurrent)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, int64(8), pos)
|
||||
|
||||
// Read the remaining data
|
||||
buf = make([]byte, 3)
|
||||
n, err = seeker.Read(buf)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 3, n)
|
||||
require.Equal(t, []byte("rld"), buf)
|
||||
})
|
||||
|
||||
t.Run("Seek backward not supported", func(t *testing.T) {
|
||||
data := []byte("hello world")
|
||||
reader := bytes.NewReader(data)
|
||||
seeker := &fwSeeker{r: reader}
|
||||
|
||||
// Try to seek backward
|
||||
_, err := seeker.Seek(-1, io.SeekCurrent)
|
||||
require.EqualError(t, err, "seeking backwards is not supported")
|
||||
|
||||
// Try to seek from end
|
||||
_, err = seeker.Seek(0, io.SeekEnd)
|
||||
require.EqualError(t, err, "seeking backwards is not supported")
|
||||
})
|
||||
|
||||
t.Run("Seek beyond EOF", func(t *testing.T) {
|
||||
data := []byte("hello")
|
||||
reader := bytes.NewReader(data)
|
||||
seeker := &fwSeeker{r: reader}
|
||||
|
||||
// Try to seek beyond EOF
|
||||
n, err := seeker.Seek(10, io.SeekStart)
|
||||
require.EqualError(t, err, "failed to seek: EOF")
|
||||
require.Equal(t, int64(5), n) // Should have read until EOF (5 bytes)
|
||||
})
|
||||
}
|
||||
|
||||
func TestGetImageOrientation(t *testing.T) {
|
||||
imgDir, ok := fileutils.FindDir("tests/exif_samples")
|
||||
require.True(t, ok, "Failed to find exif samples directory")
|
||||
|
||||
// Define orientations and their corresponding file prefixes
|
||||
orientations := map[string]int{
|
||||
"up": Upright,
|
||||
"up-mirrored": UprightMirrored,
|
||||
"down": UpsideDown,
|
||||
"down-mirrored": UpsideDownMirrored,
|
||||
"left": RotatedCCW,
|
||||
"left-mirrored": RotatedCWMirrored,
|
||||
"right": RotatedCW,
|
||||
"right-mirrored": RotatedCCWMirrored,
|
||||
}
|
||||
|
||||
// Define supported formats
|
||||
formats := []string{"jpg", "png", "tiff", "webp"}
|
||||
|
||||
// Generate test cases for all combinations
|
||||
var testCases []struct {
|
||||
name string
|
||||
fileName string
|
||||
expectedOrientation int
|
||||
}
|
||||
|
||||
for prefix, orientation := range orientations {
|
||||
for _, format := range formats {
|
||||
testCases = append(testCases, struct {
|
||||
name string
|
||||
fileName string
|
||||
expectedOrientation int
|
||||
}{
|
||||
name: fmt.Sprintf("%s (%s)", prefix, format),
|
||||
fileName: fmt.Sprintf("%s.%s", prefix, format),
|
||||
expectedOrientation: orientation,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
dec, err := NewDecoder(DecoderOptions{})
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, tc := range testCases {
|
||||
var orientation int
|
||||
imgPath := filepath.Join(imgDir, tc.fileName)
|
||||
file, err := os.Open(imgPath)
|
||||
require.NoError(t, err)
|
||||
defer file.Close()
|
||||
|
||||
_, format, err := dec.DecodeConfig(file)
|
||||
require.NoError(t, err)
|
||||
|
||||
t.Run(tc.name+"_file", func(t *testing.T) {
|
||||
_, err = file.Seek(0, io.SeekStart)
|
||||
require.NoError(t, err)
|
||||
|
||||
orientation, err = GetImageOrientation(file, format)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tc.expectedOrientation, orientation, "Incorrect orientation detected for %s", tc.fileName)
|
||||
})
|
||||
|
||||
t.Run(tc.name+"_reader", func(t *testing.T) {
|
||||
_, err = file.Seek(0, io.SeekStart)
|
||||
require.NoError(t, err)
|
||||
|
||||
orientation, err = GetImageOrientation(&io.LimitedReader{R: file, N: 1024 * 1024}, format)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tc.expectedOrientation, orientation, "Incorrect orientation detected for %s", tc.fileName)
|
||||
})
|
||||
}
|
||||
}
|
||||
Ссылка в новой задаче
Block a user