// SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved. // SPDX-License-Identifier: Apache-2.0 package mediaproxy // import "miniflux.app/v2/internal/mediaproxy" import ( "net/http" "os" "testing" "github.com/gorilla/mux" "miniflux.app/v2/internal/config" ) func TestProxyFilterWithHttpDefault(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "http-only") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpsDefault(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "http-only") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpNever(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "none") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := input if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpsNever(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "none") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := input if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpAlways(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpsAlways(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestAbsoluteProxyFilterWithHttpsAlways(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithAbsoluteProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestAbsoluteProxyFilterWithCustomPortAndSubfolderInBaseURL(t *testing.T) { os.Clearenv() os.Setenv("BASE_URL", "http://example.org:88/folder/") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } if config.Opts.BaseURL() != "http://example.org:88/folder" { t.Fatalf(`Unexpected base URL, got "%s"`, config.Opts.BaseURL()) } if config.Opts.RootURL() != "http://example.org:88" { t.Fatalf(`Unexpected root URL, got "%s"`, config.Opts.RootURL()) } router := mux.NewRouter() if config.Opts.BasePath() != "" { router = router.PathPrefix(config.Opts.BasePath()).Subrouter() } router.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithAbsoluteProxyURL(router, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestAbsoluteProxyFilterWithHttpsAlwaysAndAudioTag(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "audio") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `` output := RewriteDocumentWithAbsoluteProxyURL(r, input) expected := `` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpsAlwaysAndCustomProxyServer(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_CUSTOM_URL", "https://proxy-example/proxy") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpsAlwaysAndIncorrectCustomProxyServer(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_CUSTOM_URL", "http://:8080example.com") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestAbsoluteProxyFilterWithHttpsAlwaysAndCustomProxyServer(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_CUSTOM_URL", "https://proxy-example/proxy") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithAbsoluteProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpInvalid(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "invalid") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithHttpsInvalid(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "invalid") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

Test

` output := RewriteDocumentWithRelativeProxyURL(r, input) expected := `

Test

` if expected != output { t.Errorf(`Not expected output: got %q instead of %q`, output, expected) } } func TestProxyFilterWithSrcset(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

test

` expected := `

test

` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestProxyFilterWithEmptySrcset(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `

test

` expected := `

test

` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestProxyFilterWithPictureSource(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `` expected := `` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestProxyFilterOnlyNonHTTPWithPictureSource(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "https") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `` expected := `` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestProxyWithImageDataURL(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `` expected := `` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestProxyWithImageSourceDataURL(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `` expected := `` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestProxyFilterWithVideo(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "video") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `` expected := `` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestProxyFilterVideoPoster(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `` expected := `` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestProxyFilterVideoPosterOnce(t *testing.T) { os.Clearenv() os.Setenv("MEDIA_PROXY_MODE", "all") os.Setenv("MEDIA_PROXY_RESOURCE_TYPES", "image,video") os.Setenv("MEDIA_PROXY_PRIVATE_KEY", "test") var err error parser := config.NewParser() config.Opts, err = parser.ParseEnvironmentVariables() if err != nil { t.Fatalf(`Parsing failure: %v`, err) } r := mux.NewRouter() r.HandleFunc("/proxy/{encodedDigest}/{encodedURL}", func(w http.ResponseWriter, r *http.Request) {}).Name("proxy") input := `` expected := `` output := RewriteDocumentWithRelativeProxyURL(r, input) if expected != output { t.Errorf(`Not expected output: got %s`, output) } } func TestShouldProxifyURLWithMimeType(t *testing.T) { testCases := []struct { name string mediaURL string mediaMimeType string mediaProxyOption string mediaProxyResourceTypes []string expected bool }{ { name: "Empty URL should not be proxified", mediaURL: "", mediaMimeType: "image/jpeg", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"image"}, expected: false, }, { name: "Data URL should not be proxified", mediaURL: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==", mediaMimeType: "image/png", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"image"}, expected: false, }, { name: "HTTP URL with all mode and matching MIME type should be proxified", mediaURL: "http://example.com/image.jpg", mediaMimeType: "image/jpeg", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"image"}, expected: true, }, { name: "HTTPS URL with all mode and matching MIME type should be proxified", mediaURL: "https://example.com/image.jpg", mediaMimeType: "image/jpeg", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"image"}, expected: true, }, { name: "HTTP URL with http-only mode and matching MIME type should be proxified", mediaURL: "http://example.com/image.jpg", mediaMimeType: "image/jpeg", mediaProxyOption: "http-only", mediaProxyResourceTypes: []string{"image"}, expected: true, }, { name: "HTTPS URL with http-only mode should not be proxified", mediaURL: "https://example.com/image.jpg", mediaMimeType: "image/jpeg", mediaProxyOption: "http-only", mediaProxyResourceTypes: []string{"image"}, expected: false, }, { name: "URL with none mode should not be proxified", mediaURL: "http://example.com/image.jpg", mediaMimeType: "image/jpeg", mediaProxyOption: "none", mediaProxyResourceTypes: []string{"image"}, expected: false, }, { name: "URL with matching MIME type should be proxified", mediaURL: "http://example.com/video.mp4", mediaMimeType: "video/mp4", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"video"}, expected: true, }, { name: "URL with non-matching MIME type should not be proxified", mediaURL: "http://example.com/video.mp4", mediaMimeType: "video/mp4", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"image"}, expected: false, }, { name: "URL with multiple resource types and matching MIME type should be proxified", mediaURL: "http://example.com/audio.mp3", mediaMimeType: "audio/mp3", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"image", "audio", "video"}, expected: true, }, { name: "URL with multiple resource types but non-matching MIME type should not be proxified", mediaURL: "http://example.com/document.pdf", mediaMimeType: "application/pdf", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"image", "audio", "video"}, expected: false, }, { name: "URL with empty resource types should not be proxified", mediaURL: "http://example.com/image.jpg", mediaMimeType: "image/jpeg", mediaProxyOption: "all", mediaProxyResourceTypes: []string{}, expected: false, }, { name: "URL with partial MIME type match should be proxified", mediaURL: "http://example.com/image.jpg", mediaMimeType: "image/jpeg", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"image"}, expected: true, }, { name: "URL with audio MIME type and audio resource type should be proxified", mediaURL: "http://example.com/song.ogg", mediaMimeType: "audio/ogg", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"audio"}, expected: true, }, { name: "URL with video MIME type and video resource type should be proxified", mediaURL: "http://example.com/movie.webm", mediaMimeType: "video/webm", mediaProxyOption: "all", mediaProxyResourceTypes: []string{"video"}, expected: true, }, } for _, tc := range testCases { t.Run(tc.name, func(t *testing.T) { result := ShouldProxifyURLWithMimeType(tc.mediaURL, tc.mediaMimeType, tc.mediaProxyOption, tc.mediaProxyResourceTypes) if result != tc.expected { t.Errorf("Expected %v, got %v for URL: %s, MIME type: %s, proxy option: %s, resource types: %v", tc.expected, result, tc.mediaURL, tc.mediaMimeType, tc.mediaProxyOption, tc.mediaProxyResourceTypes) } }) } }