314984aa98
Extract link header parsing into a reusable pkg/rfc5988 package with Parse and FindByRel functions, used by Sentry and GitHub drivers for pagination. Signed-off-by: Aurélien Sibiril <81782+aureliensibiril@users.noreply.github.com>
89 lines
2.3 KiB
Go
89 lines
2.3 KiB
Go
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
|
|
//
|
|
// Permission to use, copy, modify, and/or distribute this software for any
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
// copyright notice and this permission notice appear in all copies.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
|
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
// PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
// Package rfc5988 provides a parser for HTTP Link headers as defined in
|
|
// RFC 5988 (Web Linking).
|
|
package rfc5988
|
|
|
|
import "strings"
|
|
|
|
// Link represents a single entry in an HTTP Link header.
|
|
type Link struct {
|
|
URL string
|
|
Params map[string]string
|
|
}
|
|
|
|
// Parse parses an HTTP Link header value into individual Link entries.
|
|
// Each entry has the form <URL>; param1="value1"; param2="value2".
|
|
func Parse(header string) []Link {
|
|
if header == "" {
|
|
return nil
|
|
}
|
|
|
|
var links []Link
|
|
|
|
for part := range strings.SplitSeq(header, ",") {
|
|
part = strings.TrimSpace(part)
|
|
if part == "" {
|
|
continue
|
|
}
|
|
|
|
start := strings.Index(part, "<")
|
|
end := strings.Index(part, ">")
|
|
if start == -1 || end == -1 || end <= start {
|
|
continue
|
|
}
|
|
|
|
link := Link{
|
|
URL: part[start+1 : end],
|
|
Params: make(map[string]string),
|
|
}
|
|
|
|
rest := part[end+1:]
|
|
for segment := range strings.SplitSeq(rest, ";") {
|
|
segment = strings.TrimSpace(segment)
|
|
if segment == "" {
|
|
continue
|
|
}
|
|
|
|
key, value, ok := strings.Cut(segment, "=")
|
|
if !ok {
|
|
continue
|
|
}
|
|
|
|
key = strings.TrimSpace(key)
|
|
value = strings.TrimSpace(value)
|
|
value = strings.Trim(value, `"`)
|
|
|
|
link.Params[key] = value
|
|
}
|
|
|
|
links = append(links, link)
|
|
}
|
|
|
|
return links
|
|
}
|
|
|
|
// FindByRel returns the URL of the first Link entry whose "rel" parameter
|
|
// matches the given value. It returns an empty string if no match is found.
|
|
func FindByRel(header string, rel string) string {
|
|
for _, link := range Parse(header) {
|
|
if link.Params["rel"] == rel {
|
|
return link.URL
|
|
}
|
|
}
|
|
|
|
return ""
|
|
}
|