1
0
Fork 0
mirror of https://github.com/miniflux/v2.git synced 2025-09-15 18:57:04 +00:00

Rename internal url package to avoid overlap with net/url

This commit is contained in:
Frédéric Guillot 2023-08-13 19:09:01 -07:00
parent 9f465fd70d
commit e5d9f2f5a0
23 changed files with 74 additions and 75 deletions

104
internal/urllib/url.go Normal file
View file

@ -0,0 +1,104 @@
// SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
package urllib // import "miniflux.app/v2/internal/urllib"
import (
"fmt"
"net/url"
"strings"
)
// IsAbsoluteURL returns true if the link is absolute.
func IsAbsoluteURL(link string) bool {
u, err := url.Parse(link)
if err != nil {
return false
}
return u.IsAbs()
}
// AbsoluteURL converts the input URL as absolute URL if necessary.
func AbsoluteURL(baseURL, input string) (string, error) {
if strings.HasPrefix(input, "//") {
input = "https://" + input[2:]
}
u, err := url.Parse(input)
if err != nil {
return "", fmt.Errorf("unable to parse input URL: %v", err)
}
if u.IsAbs() {
return u.String(), nil
}
base, err := url.Parse(baseURL)
if err != nil {
return "", fmt.Errorf("unable to parse base URL: %v", err)
}
return base.ResolveReference(u).String(), nil
}
// RootURL returns absolute URL without the path.
func RootURL(websiteURL string) string {
if strings.HasPrefix(websiteURL, "//") {
websiteURL = "https://" + websiteURL[2:]
}
absoluteURL, err := AbsoluteURL(websiteURL, "")
if err != nil {
return websiteURL
}
u, err := url.Parse(absoluteURL)
if err != nil {
return absoluteURL
}
return u.Scheme + "://" + u.Host + "/"
}
// IsHTTPS returns true if the URL is using HTTPS.
func IsHTTPS(websiteURL string) bool {
parsedURL, err := url.Parse(websiteURL)
if err != nil {
return false
}
return strings.ToLower(parsedURL.Scheme) == "https"
}
// Domain returns only the domain part of the given URL.
func Domain(websiteURL string) string {
parsedURL, err := url.Parse(websiteURL)
if err != nil {
return websiteURL
}
return parsedURL.Host
}
// JoinBaseURLAndPath returns a URL string with the provided path elements joined together.
func JoinBaseURLAndPath(baseURL, path string) (string, error) {
if baseURL == "" {
return "", fmt.Errorf("empty base URL")
}
if path == "" {
return "", fmt.Errorf("empty path")
}
_, err := url.Parse(baseURL)
if err != nil {
return "", fmt.Errorf("invalid base URL: %w", err)
}
finalURL, err := url.JoinPath(baseURL, path)
if err != nil {
return "", fmt.Errorf("unable to join base URL %s and path %s: %w", baseURL, path, err)
}
return finalURL, nil
}

122
internal/urllib/url_test.go Normal file
View file

@ -0,0 +1,122 @@
// SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
package urllib // import "miniflux.app/v2/internal/urllib"
import "testing"
func TestIsAbsoluteURL(t *testing.T) {
scenarios := map[string]bool{
"https://example.org/file.pdf": true,
"magnet:?xt.1=urn:sha1:YNCKHTQCWBTRNJIV4WNAE52SJUQCZO5C&xt.2=urn:sha1:TXGCZQTH26NL6OUQAJJPFALHG2LTGBC7": true,
"invalid url": false,
}
for input, expected := range scenarios {
actual := IsAbsoluteURL(input)
if actual != expected {
t.Errorf(`Unexpected result, got %v instead of %v for %q`, actual, expected, input)
}
}
}
func TestAbsoluteURL(t *testing.T) {
scenarios := [][]string{
{"https://example.org/path/file.ext", "https://example.org/folder/", "/path/file.ext"},
{"https://example.org/folder/path/file.ext", "https://example.org/folder/", "path/file.ext"},
{"https://example.org/", "https://example.org/path", "./"},
{"https://example.org/folder/", "https://example.org/folder/", "./"},
{"https://example.org/path/file.ext", "https://example.org/folder", "path/file.ext"},
{"https://example.org/path/file.ext", "https://example.org/folder/", "https://example.org/path/file.ext"},
{"https://static.example.org/path/file.ext", "https://www.example.org/", "//static.example.org/path/file.ext"},
{"magnet:?xt=urn:btih:c12fe1c06bba254a9dc9f519b335aa7c1367a88a", "https://www.example.org/", "magnet:?xt=urn:btih:c12fe1c06bba254a9dc9f519b335aa7c1367a88a"},
{"magnet:?xt.1=urn:sha1:YNCKHTQCWBTRNJIV4WNAE52SJUQCZO5C&xt.2=urn:sha1:TXGCZQTH26NL6OUQAJJPFALHG2LTGBC7", "https://www.example.org/", "magnet:?xt.1=urn:sha1:YNCKHTQCWBTRNJIV4WNAE52SJUQCZO5C&xt.2=urn:sha1:TXGCZQTH26NL6OUQAJJPFALHG2LTGBC7"},
}
for _, scenario := range scenarios {
actual, err := AbsoluteURL(scenario[1], scenario[2])
if err != nil {
t.Errorf(`Got error for (%q, %q): %v`, scenario[1], scenario[2], err)
}
if actual != scenario[0] {
t.Errorf(`Unexpected result, got %q instead of %q for (%q, %q)`, actual, scenario[0], scenario[1], scenario[2])
}
}
}
func TestRootURL(t *testing.T) {
scenarios := map[string]string{
"https://example.org/path/file.ext": "https://example.org/",
"//static.example.org/path/file.ext": "https://static.example.org/",
"https://example|org/path/file.ext": "https://example|org/path/file.ext",
}
for input, expected := range scenarios {
actual := RootURL(input)
if actual != expected {
t.Errorf(`Unexpected result, got %q instead of %q`, actual, expected)
}
}
}
func TestIsHTTPS(t *testing.T) {
scenarios := map[string]bool{
"https://example.org/": true,
"http://example.org/": false,
"https://example|org/": false,
}
for input, expected := range scenarios {
actual := IsHTTPS(input)
if actual != expected {
t.Errorf(`Unexpected result, got %v instead of %v`, actual, expected)
}
}
}
func TestDomain(t *testing.T) {
scenarios := map[string]string{
"https://static.example.org/": "static.example.org",
"https://example|org/": "https://example|org/",
}
for input, expected := range scenarios {
actual := Domain(input)
if actual != expected {
t.Errorf(`Unexpected result, got %q instead of %q`, actual, expected)
}
}
}
func TestJoinBaseURLAndPath(t *testing.T) {
type args struct {
baseURL string
path string
}
tests := []struct {
name string
args args
want string
wantErr bool
}{
{"empty base url", args{"", "/api/bookmarks/"}, "", true},
{"empty path", args{"https://example.com", ""}, "", true},
{"invalid base url", args{"incorrect url", ""}, "", true},
{"valid", args{"https://example.com", "/api/bookmarks/"}, "https://example.com/api/bookmarks/", false},
{"valid", args{"https://example.com/subfolder", "/api/bookmarks/"}, "https://example.com/subfolder/api/bookmarks/", false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := JoinBaseURLAndPath(tt.args.baseURL, tt.args.path)
if (err != nil) != tt.wantErr {
t.Errorf("JoinBaseURLAndPath error = %v, wantErr %v", err, tt.wantErr)
return
}
if got != tt.want {
t.Errorf("JoinBaseURLAndPath = %v, want %v", got, tt.want)
}
})
}
}