Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support to filter media by dimensions and content type precedence… #624

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions handlers/media.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ const (
)

type MediaTypeSupport struct {
Types []string
MaxBytes int
Types []string
MaxBytes int
MaxWidth int
MaxHeight int
}

// Attachment is a resolved attachment
Expand Down Expand Up @@ -84,7 +86,10 @@ func resolveAttachment(ctx context.Context, b courier.Backend, contentType, medi
}

mediaType, _ := parseContentType(media.ContentType())
mediaSupport := support[mediaType]
mediaSupport, ok := support[MediaType(media.ContentType())]
if !ok {
mediaSupport = support[mediaType]
}

// our candidates are the uploaded media and any alternates of the same media type
candidates := append([]courier.Media{media}, filterMediaByType(media.Alternates(), mediaType)...)
Expand All @@ -99,6 +104,11 @@ func resolveAttachment(ctx context.Context, b courier.Backend, contentType, medi
candidates = filterMediaBySize(candidates, mediaSupport.MaxBytes)
}

// narrow down the candidates to the ones that don't exceed our max dimensions
if mediaSupport.MaxWidth > 0 && mediaSupport.MaxHeight > 0 {
candidates = filterMediaByDimensions(candidates, mediaSupport.MaxWidth, mediaSupport.MaxHeight)
}

// if we have no candidates, we can't use this media
if len(candidates) == 0 {
return nil, nil
Expand Down Expand Up @@ -144,6 +154,10 @@ func filterMediaBySize(in []courier.Media, maxBytes int) []courier.Media {
return filterMedia(in, func(m courier.Media) bool { return m.Size() <= maxBytes })
}

func filterMediaByDimensions(in []courier.Media, maxWidth int, MaxHeight int) []courier.Media {
return filterMedia(in, func(m courier.Media) bool { return m.Width() <= maxWidth && m.Height() <= MaxHeight })
}

func filterMedia(in []courier.Media, f func(courier.Media) bool) []courier.Media {
filtered := make([]courier.Media, 0, len(in))
for _, m := range in {
Expand Down
23 changes: 23 additions & 0 deletions handlers/media_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,29 @@ func TestResolveAttachments(t *testing.T) {
mediaSupport: map[handlers.MediaType]handlers.MediaTypeSupport{},
err: "invalid attachment format: http://mock.com/1234/test.jpg",
},
{ // 14: resolveable uploaded image URL with matching dimensions
attachments: []string{"image/jpeg:http://mock.com/1234/test.jpg"},
mediaSupport: map[handlers.MediaType]handlers.MediaTypeSupport{handlers.MediaTypeImage: {Types: []string{"image/jpeg", "image/png"}, MaxWidth: 1000, MaxHeight: 1000}},
allowURLOnly: true,
resolved: []*handlers.Attachment{
{Type: handlers.MediaTypeImage, Name: "test.jpg", ContentType: "image/jpeg", URL: "http://mock.com/1234/test.jpg", Media: imageJPG, Thumbnail: nil},
},
},
{ // 15: resolveable uploaded image URL without matching dimensions
attachments: []string{"image/jpeg:http://mock.com/1234/test.jpg"},
mediaSupport: map[handlers.MediaType]handlers.MediaTypeSupport{handlers.MediaTypeImage: {Types: []string{"image/jpeg", "image/png"}, MaxWidth: 100, MaxHeight: 100}},
allowURLOnly: true,
resolved: []*handlers.Attachment{},
errors: []*courier.ChannelError{courier.ErrorMediaUnresolveable("image/jpeg")},
},
{ // 16: resolveable uploaded image URL without matching dimensions by specific content type precendence
attachments: []string{"image/jpeg:http://mock.com/1234/test.jpg"},
mediaSupport: map[handlers.MediaType]handlers.MediaTypeSupport{handlers.MediaTypeImage: {Types: []string{"image/jpeg", "image/png"}, MaxWidth: 100, MaxHeight: 100}, handlers.MediaType("image/jpeg"): {Types: []string{"image/jpeg", "image/png"}, MaxWidth: 1000, MaxHeight: 1000}},
allowURLOnly: true,
resolved: []*handlers.Attachment{
{Type: handlers.MediaTypeImage, Name: "test.jpg", ContentType: "image/jpeg", URL: "http://mock.com/1234/test.jpg", Media: imageJPG, Thumbnail: nil},
},
},
}

for i, tc := range tcs {
Expand Down
Loading