Compare commits
12 Commits
Author | SHA1 | Date |
---|---|---|
Sasha Koshka | 4985bf0bc8 | |
Sasha Koshka | f6d3c47816 | |
Sasha Koshka | 24d70951c9 | |
Sasha Koshka | b436ec8cb5 | |
Sasha Koshka | 54f7209f13 | |
Adnan Maolood | b0f27c6f74 | |
Yujiri | 8c0af18617 | |
Adnan Maolood | 353416685a | |
Adnan Maolood | 0ceec22705 | |
Adnan Maolood | 3d2110d90f | |
Adnan Maolood | b5c47a5ef0 | |
Adnan Maolood | fb0d4d24bd |
14
README.md
14
README.md
|
@ -1,16 +1,18 @@
|
|||
# go-gemini
|
||||
|
||||
[![godocs.io](https://godocs.io/git.sr.ht/~adnano/go-gemini?status.svg)](https://godocs.io/git.sr.ht/~adnano/go-gemini) [![builds.sr.ht status](https://builds.sr.ht/~adnano/go-gemini.svg)](https://builds.sr.ht/~adnano/go-gemini?)
|
||||
This repository is a fork of [go-gemini](https://godocs.io/git.sr.ht/~adnano/go-gemini)
|
||||
implementing better parity with net/http and some tweaks required for use in
|
||||
[Hnakra](https://git.tebibyte.media/sashakoshka/hnakra).
|
||||
|
||||
Package gemini implements the [Gemini protocol](https://gemini.circumlunar.space)
|
||||
in Go. It provides an API similar to that of net/http to facilitate the
|
||||
development of Gemini clients and servers.
|
||||
|
||||
Compatible with version v0.14.3 of the Gemini specification.
|
||||
Compatible with version v0.16.0 of the Gemini specification.
|
||||
|
||||
## Usage
|
||||
|
||||
import "git.sr.ht/~adnano/go-gemini"
|
||||
import "git.tebibyte.media/sashakoshka/go-gemini"
|
||||
|
||||
Note that some filesystem-related functionality is only available on Go 1.16
|
||||
or later as it relies on the io/fs package.
|
||||
|
@ -22,12 +24,6 @@ To run an example:
|
|||
|
||||
go run examples/server.go
|
||||
|
||||
## Contributing
|
||||
|
||||
Send patches and questions to [~adnano/go-gemini-devel](https://lists.sr.ht/~adnano/go-gemini-devel).
|
||||
|
||||
Subscribe to release announcements on [~adnano/go-gemini-announce](https://lists.sr.ht/~adnano/go-gemini-announce).
|
||||
|
||||
## License
|
||||
|
||||
go-gemini is licensed under the terms of the MIT license (see LICENSE).
|
||||
|
|
6
doc.go
6
doc.go
|
@ -30,7 +30,7 @@ Servers should be configured with certificates:
|
|||
server.GetCertificate = certificates.Get
|
||||
|
||||
Mux is a Gemini request multiplexer.
|
||||
Mux can handle requests for multiple hosts and schemes.
|
||||
Mux can handle requests for multiple hosts and paths.
|
||||
|
||||
mux := &gemini.Mux{}
|
||||
mux.HandleFunc("example.com", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
|
||||
|
@ -39,8 +39,8 @@ Mux can handle requests for multiple hosts and schemes.
|
|||
mux.HandleFunc("example.org/about.gmi", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
|
||||
fmt.Fprint(w, "About example.org")
|
||||
})
|
||||
mux.HandleFunc("http://example.net", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
|
||||
fmt.Fprint(w, "Proxied content from http://example.net")
|
||||
mux.HandleFunc("/images/", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
|
||||
w.WriteHeader(gemini.StatusGone, "Gone forever")
|
||||
})
|
||||
server.Handler = mux
|
||||
|
||||
|
|
|
@ -10,8 +10,8 @@ import (
|
|||
"log"
|
||||
"time"
|
||||
|
||||
"git.sr.ht/~adnano/go-gemini"
|
||||
"git.sr.ht/~adnano/go-gemini/certificate"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini/certificate"
|
||||
)
|
||||
|
||||
type User struct {
|
||||
|
@ -52,7 +52,7 @@ func fingerprint(cert *x509.Certificate) string {
|
|||
}
|
||||
|
||||
func profile(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
|
||||
tls := r.TLS()
|
||||
tls := r.TLS
|
||||
if len(tls.PeerCertificates) == 0 {
|
||||
w.WriteHeader(gemini.StatusCertificateRequired, "Certificate required")
|
||||
return
|
||||
|
@ -68,7 +68,7 @@ func profile(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
|
|||
}
|
||||
|
||||
func changeUsername(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
|
||||
tls := r.TLS()
|
||||
tls := r.TLS
|
||||
if len(tls.PeerCertificates) == 0 {
|
||||
w.WriteHeader(gemini.StatusCertificateRequired, "Certificate required")
|
||||
return
|
||||
|
|
|
@ -11,7 +11,7 @@ import (
|
|||
"os"
|
||||
"time"
|
||||
|
||||
"git.sr.ht/~adnano/go-gemini/certificate"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini/certificate"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
|
@ -16,8 +16,8 @@ import (
|
|||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"git.sr.ht/~adnano/go-gemini"
|
||||
"git.sr.ht/~adnano/go-gemini/tofu"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini/tofu"
|
||||
)
|
||||
|
||||
var (
|
||||
|
|
|
@ -10,7 +10,7 @@ import (
|
|||
"io"
|
||||
"os"
|
||||
|
||||
"git.sr.ht/~adnano/go-gemini"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
|
@ -11,8 +11,8 @@ import (
|
|||
"os/signal"
|
||||
"time"
|
||||
|
||||
"git.sr.ht/~adnano/go-gemini"
|
||||
"git.sr.ht/~adnano/go-gemini/certificate"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini/certificate"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
|
@ -10,8 +10,8 @@ import (
|
|||
"log"
|
||||
"time"
|
||||
|
||||
"git.sr.ht/~adnano/go-gemini"
|
||||
"git.sr.ht/~adnano/go-gemini/certificate"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini"
|
||||
"git.tebibyte.media/sashakoshka/go-gemini/certificate"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
2
fs.go
2
fs.go
|
@ -169,7 +169,7 @@ func dirList(w ResponseWriter, f fs.File) {
|
|||
}
|
||||
link := LineLink{
|
||||
Name: name,
|
||||
URL: (&url.URL{Path: name}).EscapedPath(),
|
||||
URL: "./" + url.PathEscape(name),
|
||||
}
|
||||
fmt.Fprintln(w, link.String())
|
||||
}
|
||||
|
|
2
go.mod
2
go.mod
|
@ -1,4 +1,4 @@
|
|||
module git.sr.ht/~adnano/go-gemini
|
||||
module git.tebibyte.media/sashakoshka/go-gemini
|
||||
|
||||
go 1.15
|
||||
|
||||
|
|
148
mux.go
148
mux.go
|
@ -32,31 +32,15 @@ import (
|
|||
// the pattern "/" matches all paths not matched by other registered
|
||||
// patterns, not just the URL with Path == "/".
|
||||
//
|
||||
// Patterns may also contain schemes and hostnames.
|
||||
// Wildcard patterns can be used to match multiple hostnames (e.g. "*.example.com").
|
||||
// Patterns may optionally begin with a host name, restricting matches to
|
||||
// URLs on that host only. Host-specific patterns take precedence over
|
||||
// general patterns, so that a handler might register for the two patterns
|
||||
// "/search" and "search.example.com/" without also taking over requests
|
||||
// for "gemini://example.com/".
|
||||
//
|
||||
// The following are examples of valid patterns, along with the scheme,
|
||||
// hostname, and path that they match.
|
||||
//
|
||||
// Pattern │ Scheme │ Hostname │ Path
|
||||
// ─────────────────────────────┼────────┼──────────┼─────────────
|
||||
// /file │ gemini │ * │ /file
|
||||
// /directory/ │ gemini │ * │ /directory/*
|
||||
// hostname/file │ gemini │ hostname │ /file
|
||||
// hostname/directory/ │ gemini │ hostname │ /directory/*
|
||||
// scheme://hostname/file │ scheme │ hostname │ /file
|
||||
// scheme://hostname/directory/ │ scheme │ hostname │ /directory/*
|
||||
// //hostname/file │ * │ hostname │ /file
|
||||
// //hostname/directory/ │ * │ hostname │ /directory/*
|
||||
// scheme:///file │ scheme │ * │ /file
|
||||
// scheme:///directory/ │ scheme │ * │ /directory/*
|
||||
// ///file │ * │ * │ /file
|
||||
// ///directory/ │ * │ * │ /directory/*
|
||||
//
|
||||
// A pattern without a hostname will match any hostname.
|
||||
// If a pattern begins with "//", it will match any scheme.
|
||||
// Otherwise, a pattern with no scheme is treated as though it has a
|
||||
// scheme of "gemini".
|
||||
// Wildcard patterns can be used to match multiple hostnames. For example,
|
||||
// the pattern "*.example.com" will match requests for "blog.example.com"
|
||||
// and "gemini.example.com", but not "example.org".
|
||||
//
|
||||
// If a subtree has been registered and a request is received naming the
|
||||
// subtree root without its trailing slash, Mux redirects that
|
||||
|
@ -71,19 +55,19 @@ import (
|
|||
// to an equivalent, cleaner URL.
|
||||
type Mux struct {
|
||||
mu sync.RWMutex
|
||||
m map[muxKey]Handler
|
||||
m map[hostpath]Handler
|
||||
es []muxEntry // slice of entries sorted from longest to shortest
|
||||
}
|
||||
|
||||
type muxKey struct {
|
||||
scheme string
|
||||
host string
|
||||
path string
|
||||
type hostpath struct {
|
||||
host string
|
||||
path string
|
||||
}
|
||||
|
||||
type muxEntry struct {
|
||||
handler Handler
|
||||
key muxKey
|
||||
host string
|
||||
path string
|
||||
}
|
||||
|
||||
// cleanPath returns the canonical path for p, eliminating . and .. elements.
|
||||
|
@ -110,24 +94,17 @@ func cleanPath(p string) string {
|
|||
|
||||
// Find a handler on a handler map given a path string.
|
||||
// Most-specific (longest) pattern wins.
|
||||
func (mux *Mux) match(key muxKey) Handler {
|
||||
func (mux *Mux) match(host, path string) Handler {
|
||||
// Check for exact match first.
|
||||
if r, ok := mux.m[key]; ok {
|
||||
return r
|
||||
} else if r, ok := mux.m[muxKey{"", key.host, key.path}]; ok {
|
||||
return r
|
||||
} else if r, ok := mux.m[muxKey{key.scheme, "", key.path}]; ok {
|
||||
return r
|
||||
} else if r, ok := mux.m[muxKey{"", "", key.path}]; ok {
|
||||
return r
|
||||
if h, ok := mux.m[hostpath{host, path}]; ok {
|
||||
return h
|
||||
}
|
||||
|
||||
// Check for longest valid match. mux.es contains all patterns
|
||||
// that end in / sorted from longest to shortest.
|
||||
for _, e := range mux.es {
|
||||
if (e.key.scheme == "" || key.scheme == e.key.scheme) &&
|
||||
(e.key.host == "" || key.host == e.key.host) &&
|
||||
strings.HasPrefix(key.path, e.key.path) {
|
||||
if len(e.host) == len(host) && e.host == host &&
|
||||
strings.HasPrefix(path, e.path) {
|
||||
return e.handler
|
||||
}
|
||||
}
|
||||
|
@ -138,31 +115,32 @@ func (mux *Mux) match(key muxKey) Handler {
|
|||
// This occurs when a handler for path + "/" was already registered, but
|
||||
// not for path itself. If the path needs appending to, it creates a new
|
||||
// URL, setting the path to u.Path + "/" and returning true to indicate so.
|
||||
func (mux *Mux) redirectToPathSlash(key muxKey, u *url.URL) (*url.URL, bool) {
|
||||
func (mux *Mux) redirectToPathSlash(host, path string, u *url.URL) (*url.URL, bool) {
|
||||
mux.mu.RLock()
|
||||
shouldRedirect := mux.shouldRedirectRLocked(key)
|
||||
shouldRedirect := mux.shouldRedirectRLocked(host, path)
|
||||
mux.mu.RUnlock()
|
||||
if !shouldRedirect {
|
||||
return u, false
|
||||
}
|
||||
return u.ResolveReference(&url.URL{Path: key.path + "/"}), true
|
||||
return u.ResolveReference(&url.URL{Path: path + "/"}), true
|
||||
}
|
||||
|
||||
// shouldRedirectRLocked reports whether the given path and host should be redirected to
|
||||
// path+"/". This should happen if a handler is registered for path+"/" but
|
||||
// not path -- see comments at Mux.
|
||||
func (mux *Mux) shouldRedirectRLocked(key muxKey) bool {
|
||||
if _, exist := mux.m[key]; exist {
|
||||
func (mux *Mux) shouldRedirectRLocked(host, path string) bool {
|
||||
if _, exist := mux.m[hostpath{host, path}]; exist {
|
||||
return false
|
||||
}
|
||||
|
||||
n := len(key.path)
|
||||
n := len(path)
|
||||
if n == 0 {
|
||||
return false
|
||||
}
|
||||
if _, exist := mux.m[muxKey{key.scheme, key.host, key.path + "/"}]; exist {
|
||||
return key.path[n-1] != '/'
|
||||
if _, exist := mux.m[hostpath{host, path + "/"}]; exist {
|
||||
return path[n-1] != '/'
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
|
@ -182,13 +160,17 @@ func getWildcard(hostname string) (string, bool) {
|
|||
// internally-generated handler that redirects to the canonical path. If the
|
||||
// host contains a port, it is ignored when matching handlers.
|
||||
func (mux *Mux) Handler(r *Request) Handler {
|
||||
scheme := r.URL.Scheme
|
||||
// Disallow non-Gemini schemes
|
||||
if r.URL.Scheme != "gemini" {
|
||||
return NotFoundHandler()
|
||||
}
|
||||
|
||||
host := r.URL.Hostname()
|
||||
path := cleanPath(r.URL.Path)
|
||||
|
||||
// If the given path is /tree and its handler is not registered,
|
||||
// redirect for /tree/.
|
||||
if u, ok := mux.redirectToPathSlash(muxKey{scheme, host, path}, r.URL); ok {
|
||||
if u, ok := mux.redirectToPathSlash(host, path, r.URL); ok {
|
||||
return StatusHandler(StatusPermanentRedirect, u.String())
|
||||
}
|
||||
|
||||
|
@ -201,16 +183,30 @@ func (mux *Mux) Handler(r *Request) Handler {
|
|||
mux.mu.RLock()
|
||||
defer mux.mu.RUnlock()
|
||||
|
||||
h := mux.match(muxKey{scheme, host, path})
|
||||
h := mux.match(host, path)
|
||||
|
||||
if h == nil {
|
||||
// Try wildcard
|
||||
if wildcard, ok := getWildcard(host); ok {
|
||||
h = mux.match(muxKey{scheme, wildcard, path})
|
||||
if u, ok := mux.redirectToPathSlash(wildcard, path, r.URL); ok {
|
||||
return StatusHandler(StatusPermanentRedirect, u.String())
|
||||
}
|
||||
h = mux.match(wildcard, path)
|
||||
}
|
||||
}
|
||||
|
||||
if h == nil {
|
||||
// Try empty host
|
||||
if u, ok := mux.redirectToPathSlash("", path, r.URL); ok {
|
||||
return StatusHandler(StatusPermanentRedirect, u.String())
|
||||
}
|
||||
h = mux.match("", path)
|
||||
}
|
||||
|
||||
if h == nil {
|
||||
h = NotFoundHandler()
|
||||
}
|
||||
|
||||
return h
|
||||
}
|
||||
|
||||
|
@ -234,48 +230,32 @@ func (mux *Mux) Handle(pattern string, handler Handler) {
|
|||
mux.mu.Lock()
|
||||
defer mux.mu.Unlock()
|
||||
|
||||
var key muxKey
|
||||
if strings.HasPrefix(pattern, "//") {
|
||||
// match any scheme
|
||||
key.scheme = ""
|
||||
pattern = pattern[2:]
|
||||
} else {
|
||||
// extract scheme
|
||||
cut := strings.Index(pattern, "://")
|
||||
if cut == -1 {
|
||||
// default scheme of gemini
|
||||
key.scheme = "gemini"
|
||||
} else {
|
||||
key.scheme = pattern[:cut]
|
||||
pattern = pattern[cut+3:]
|
||||
}
|
||||
}
|
||||
|
||||
var host, path string
|
||||
// extract hostname and path
|
||||
cut := strings.Index(pattern, "/")
|
||||
if cut == -1 {
|
||||
key.host = pattern
|
||||
key.path = "/"
|
||||
host = pattern
|
||||
path = "/"
|
||||
} else {
|
||||
key.host = pattern[:cut]
|
||||
key.path = pattern[cut:]
|
||||
host = pattern[:cut]
|
||||
path = pattern[cut:]
|
||||
}
|
||||
|
||||
// strip port from hostname
|
||||
if hostname, _, err := net.SplitHostPort(key.host); err == nil {
|
||||
key.host = hostname
|
||||
if hostname, _, err := net.SplitHostPort(host); err == nil {
|
||||
host = hostname
|
||||
}
|
||||
|
||||
if _, exist := mux.m[key]; exist {
|
||||
if _, exist := mux.m[hostpath{host, path}]; exist {
|
||||
panic("gemini: multiple registrations for " + pattern)
|
||||
}
|
||||
|
||||
if mux.m == nil {
|
||||
mux.m = make(map[muxKey]Handler)
|
||||
mux.m = make(map[hostpath]Handler)
|
||||
}
|
||||
mux.m[key] = handler
|
||||
e := muxEntry{handler, key}
|
||||
if key.path[len(key.path)-1] == '/' {
|
||||
mux.m[hostpath{host, path}] = handler
|
||||
e := muxEntry{handler, host, path}
|
||||
if path[len(path)-1] == '/' {
|
||||
mux.es = appendSorted(mux.es, e)
|
||||
}
|
||||
}
|
||||
|
@ -283,9 +263,7 @@ func (mux *Mux) Handle(pattern string, handler Handler) {
|
|||
func appendSorted(es []muxEntry, e muxEntry) []muxEntry {
|
||||
n := len(es)
|
||||
i := sort.Search(n, func(i int) bool {
|
||||
return len(es[i].key.scheme) < len(e.key.scheme) ||
|
||||
len(es[i].key.host) < len(es[i].key.host) ||
|
||||
len(es[i].key.path) < len(e.key.path)
|
||||
return len(es[i].path) < len(e.path)
|
||||
})
|
||||
if i == n {
|
||||
return append(es, e)
|
||||
|
|
407
mux_test.go
407
mux_test.go
|
@ -2,6 +2,7 @@ package gemini
|
|||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
"net/url"
|
||||
"testing"
|
||||
)
|
||||
|
@ -10,6 +11,221 @@ type nopHandler struct{}
|
|||
|
||||
func (*nopHandler) ServeGemini(context.Context, ResponseWriter, *Request) {}
|
||||
|
||||
type nopResponseWriter struct {
|
||||
Status Status
|
||||
Meta string
|
||||
}
|
||||
|
||||
func (w *nopResponseWriter) WriteHeader(status Status, meta string) {
|
||||
w.Status = status
|
||||
w.Meta = meta
|
||||
}
|
||||
|
||||
func (nopResponseWriter) SetMediaType(mediatype string) {}
|
||||
func (nopResponseWriter) Write(b []byte) (int, error) { return 0, io.EOF }
|
||||
func (nopResponseWriter) Flush() error { return nil }
|
||||
|
||||
func TestMux(t *testing.T) {
|
||||
type Test struct {
|
||||
URL string
|
||||
Pattern string
|
||||
Redirect string
|
||||
NotFound bool
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
Patterns []string
|
||||
Tests []Test
|
||||
}{
|
||||
{
|
||||
Patterns: []string{"/a", "/b/", "/b/c/d", "/b/c/d/"},
|
||||
Tests: []Test{
|
||||
{
|
||||
URL: "gemini://example.com",
|
||||
Redirect: "gemini://example.com/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/",
|
||||
NotFound: true,
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/c",
|
||||
NotFound: true,
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/a",
|
||||
Pattern: "/a",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/a/",
|
||||
NotFound: true,
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/b",
|
||||
Redirect: "gemini://example.com/b/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/b/",
|
||||
Pattern: "/b/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/b/c",
|
||||
Pattern: "/b/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/b/c/d",
|
||||
Pattern: "/b/c/d",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/b/c/d/e/",
|
||||
Pattern: "/b/c/d/",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Patterns: []string{
|
||||
"/", "/a", "/b/",
|
||||
"example.com", "example.com/a", "example.com/b/",
|
||||
"*.example.com", "*.example.com/a", "*.example.com/b/",
|
||||
},
|
||||
Tests: []Test{
|
||||
{
|
||||
URL: "gemini://example.net/",
|
||||
Pattern: "/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.net/a",
|
||||
Pattern: "/a",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.net/b",
|
||||
Redirect: "gemini://example.net/b/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.net/b/",
|
||||
Pattern: "/b/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/",
|
||||
Pattern: "example.com",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/b",
|
||||
Redirect: "gemini://example.com/b/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/b/",
|
||||
Pattern: "example.com/b/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://a.example.com/",
|
||||
Pattern: "*.example.com",
|
||||
},
|
||||
{
|
||||
URL: "gemini://b.example.com/a",
|
||||
Pattern: "*.example.com/a",
|
||||
},
|
||||
{
|
||||
URL: "gemini://c.example.com/b",
|
||||
Redirect: "gemini://c.example.com/b/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://d.example.com/b/",
|
||||
Pattern: "*.example.com/b/",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Patterns: []string{"example.net", "*.example.org"},
|
||||
Tests: []Test{
|
||||
{
|
||||
// The following redirect occurs as a result of cleaning
|
||||
// the path provided to the Mux. This happens even if there
|
||||
// are no matching handlers.
|
||||
URL: "gemini://example.com",
|
||||
Redirect: "gemini://example.com/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.com/",
|
||||
NotFound: true,
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.net",
|
||||
Redirect: "gemini://example.net/",
|
||||
},
|
||||
{
|
||||
URL: "gemini://example.org/",
|
||||
NotFound: true,
|
||||
},
|
||||
{
|
||||
URL: "gemini://gemini.example.org",
|
||||
Redirect: "gemini://gemini.example.org/",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
type handler struct {
|
||||
nopHandler
|
||||
Pattern string
|
||||
}
|
||||
|
||||
mux := &Mux{}
|
||||
for _, pattern := range test.Patterns {
|
||||
mux.Handle(pattern, &handler{
|
||||
Pattern: pattern,
|
||||
})
|
||||
}
|
||||
|
||||
for _, test := range test.Tests {
|
||||
u, err := url.Parse(test.URL)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
req := &Request{URL: u}
|
||||
|
||||
h := mux.Handler(req)
|
||||
|
||||
if h, ok := h.(*handler); ok {
|
||||
if h.Pattern != test.Pattern {
|
||||
t.Errorf("wrong pattern for %q: expected %q, got %q", test.URL, test.Pattern, h.Pattern)
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
// Check redirects and NotFounds
|
||||
w := &nopResponseWriter{}
|
||||
h.ServeGemini(context.Background(), w, req)
|
||||
|
||||
switch w.Status {
|
||||
case StatusNotFound:
|
||||
if !test.NotFound {
|
||||
t.Errorf("expected pattern for %q, got NotFound", test.URL)
|
||||
}
|
||||
|
||||
case StatusPermanentRedirect:
|
||||
if test.Redirect == "" {
|
||||
t.Errorf("expected pattern for %q, got redirect to %q", test.URL, w.Meta)
|
||||
break
|
||||
}
|
||||
|
||||
res, err := url.Parse(test.Redirect)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
if w.Meta != res.String() {
|
||||
t.Errorf("bad redirect for %q: expected %q, got %q", test.URL, res.String(), w.Meta)
|
||||
}
|
||||
|
||||
default:
|
||||
t.Errorf("unexpected response for %q: %d %s", test.URL, w.Status, w.Meta)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestMuxMatch(t *testing.T) {
|
||||
type Match struct {
|
||||
URL string
|
||||
|
@ -21,7 +237,7 @@ func TestMuxMatch(t *testing.T) {
|
|||
Matches []Match
|
||||
}{
|
||||
{
|
||||
// scheme: gemini, hostname: *, path: /*
|
||||
// hostname: *, path: /*
|
||||
Pattern: "/",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/path", true},
|
||||
|
@ -34,7 +250,7 @@ func TestMuxMatch(t *testing.T) {
|
|||
},
|
||||
},
|
||||
{
|
||||
// scheme: gemini, hostname: *, path: /path
|
||||
// hostname: *, path: /path
|
||||
Pattern: "/path",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/path", true},
|
||||
|
@ -47,7 +263,7 @@ func TestMuxMatch(t *testing.T) {
|
|||
},
|
||||
},
|
||||
{
|
||||
// scheme: gemini, hostname: *, path: /subtree/*
|
||||
// hostname: *, path: /subtree/*
|
||||
Pattern: "/subtree/",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/subtree/", true},
|
||||
|
@ -62,7 +278,7 @@ func TestMuxMatch(t *testing.T) {
|
|||
},
|
||||
},
|
||||
{
|
||||
// scheme: gemini, hostname: example.com, path: /*
|
||||
// hostname: example.com, path: /*
|
||||
Pattern: "example.com",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/path", true},
|
||||
|
@ -75,7 +291,7 @@ func TestMuxMatch(t *testing.T) {
|
|||
},
|
||||
},
|
||||
{
|
||||
// scheme: gemini, hostname: example.com, path: /path
|
||||
// hostname: example.com, path: /path
|
||||
Pattern: "example.com/path",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/path", true},
|
||||
|
@ -88,7 +304,7 @@ func TestMuxMatch(t *testing.T) {
|
|||
},
|
||||
},
|
||||
{
|
||||
// scheme: gemini, hostname: example.com, path: /subtree/*
|
||||
// hostname: example.com, path: /subtree/*
|
||||
Pattern: "example.com/subtree/",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/subtree/", true},
|
||||
|
@ -102,170 +318,6 @@ func TestMuxMatch(t *testing.T) {
|
|||
{"http://example.com/subtree/", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: http, hostname: example.com, path: /*
|
||||
Pattern: "http://example.com",
|
||||
Matches: []Match{
|
||||
{"http://example.com/path", true},
|
||||
{"http://example.com/", true},
|
||||
{"http://example.com/path.gmi", true},
|
||||
{"http://example.com/path/", true},
|
||||
{"http://example.org/path", false},
|
||||
{"gemini://example.com/path", false},
|
||||
{"gemini://example.org/path", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: http, hostname: example.com, path: /path
|
||||
Pattern: "http://example.com/path",
|
||||
Matches: []Match{
|
||||
{"http://example.com/path", true},
|
||||
{"http://example.com/", false},
|
||||
{"http://example.com/path.gmi", false},
|
||||
{"http://example.com/path/", false},
|
||||
{"http://example.org/path", false},
|
||||
{"gemini://example.com/path", false},
|
||||
{"gemini://example.org/path", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: http, hostname: example.com, path: /subtree/*
|
||||
Pattern: "http://example.com/subtree/",
|
||||
Matches: []Match{
|
||||
{"http://example.com/subtree/", true},
|
||||
{"http://example.com/subtree/nested/", true},
|
||||
{"http://example.com/subtree/nested/file", true},
|
||||
{"http://example.org/subtree/", false},
|
||||
{"http://example.org/subtree/nested/", false},
|
||||
{"http://example.org/subtree/nested/file", false},
|
||||
{"http://example.com/subtree", false},
|
||||
{"http://www.example.com/subtree/", false},
|
||||
{"gemini://example.com/subtree/", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: *, hostname: example.com, path: /*
|
||||
Pattern: "//example.com",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/path", true},
|
||||
{"gemini://example.com/", true},
|
||||
{"gemini://example.com/path.gmi", true},
|
||||
{"gemini://example.com/path/", true},
|
||||
{"gemini://example.org/path", false},
|
||||
{"http://example.com/path", true},
|
||||
{"http://example.org/path", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: *, hostname: example.com, path: /path
|
||||
Pattern: "//example.com/path",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/path", true},
|
||||
{"gemini://example.com/", false},
|
||||
{"gemini://example.com/path.gmi", false},
|
||||
{"gemini://example.com/path/", false},
|
||||
{"gemini://example.org/path", false},
|
||||
{"http://example.com/path", true},
|
||||
{"http://example.org/path", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: *, hostname: example.com, path: /subtree/*
|
||||
Pattern: "//example.com/subtree/",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/subtree/", true},
|
||||
{"gemini://example.com/subtree/nested/", true},
|
||||
{"gemini://example.com/subtree/nested/file", true},
|
||||
{"gemini://example.org/subtree/", false},
|
||||
{"gemini://example.org/subtree/nested/", false},
|
||||
{"gemini://example.org/subtree/nested/file", false},
|
||||
{"gemini://example.com/subtree", false},
|
||||
{"gemini://www.example.com/subtree/", false},
|
||||
{"http://example.com/subtree/", true},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: http, hostname: *, path: /*
|
||||
Pattern: "http://",
|
||||
Matches: []Match{
|
||||
{"http://example.com/path", true},
|
||||
{"http://example.com/", true},
|
||||
{"http://example.com/path.gmi", true},
|
||||
{"http://example.com/path/", true},
|
||||
{"http://example.org/path", true},
|
||||
{"gemini://example.com/path", false},
|
||||
{"gemini://example.org/path", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: http, hostname: *, path: /path
|
||||
Pattern: "http:///path",
|
||||
Matches: []Match{
|
||||
{"http://example.com/path", true},
|
||||
{"http://example.com/", false},
|
||||
{"http://example.com/path.gmi", false},
|
||||
{"http://example.com/path/", false},
|
||||
{"http://example.org/path", true},
|
||||
{"gemini://example.com/path", false},
|
||||
{"gemini://example.org/path", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: http, hostname: *, path: /subtree/*
|
||||
Pattern: "http:///subtree/",
|
||||
Matches: []Match{
|
||||
{"http://example.com/subtree/", true},
|
||||
{"http://example.com/subtree/nested/", true},
|
||||
{"http://example.com/subtree/nested/file", true},
|
||||
{"http://example.org/subtree/", true},
|
||||
{"http://example.org/subtree/nested/", true},
|
||||
{"http://example.org/subtree/nested/file", true},
|
||||
{"http://example.com/subtree", false},
|
||||
{"http://www.example.com/subtree/", true},
|
||||
{"gemini://example.com/subtree/", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: *, hostname: *, path: /*
|
||||
Pattern: "//",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/path", true},
|
||||
{"gemini://example.com/", true},
|
||||
{"gemini://example.com/path.gmi", true},
|
||||
{"gemini://example.com/path/", true},
|
||||
{"gemini://example.org/path", true},
|
||||
{"http://example.com/path", true},
|
||||
{"http://example.org/path", true},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: *, hostname: *, path: /path
|
||||
Pattern: "///path",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/path", true},
|
||||
{"gemini://example.com/", false},
|
||||
{"gemini://example.com/path.gmi", false},
|
||||
{"gemini://example.com/path/", false},
|
||||
{"gemini://example.org/path", true},
|
||||
{"http://example.com/path", true},
|
||||
{"http://example.org/path", true},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: *, hostname: *, path: /subtree/*
|
||||
Pattern: "///subtree/",
|
||||
Matches: []Match{
|
||||
{"gemini://example.com/subtree/", true},
|
||||
{"gemini://example.com/subtree/nested/", true},
|
||||
{"gemini://example.com/subtree/nested/file", true},
|
||||
{"gemini://example.org/subtree/", true},
|
||||
{"gemini://example.org/subtree/nested/", true},
|
||||
{"gemini://example.org/subtree/nested/file", true},
|
||||
{"gemini://example.com/subtree", false},
|
||||
{"gemini://www.example.com/subtree/", true},
|
||||
{"http://example.com/subtree/", true},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: gemini, hostname: *.example.com, path: /*
|
||||
Pattern: "*.example.com",
|
||||
|
@ -277,25 +329,14 @@ func TestMuxMatch(t *testing.T) {
|
|||
{"http://www.example.com/", false},
|
||||
},
|
||||
},
|
||||
{
|
||||
// scheme: http, hostname: *.example.com, path: /*
|
||||
Pattern: "http://*.example.com",
|
||||
Matches: []Match{
|
||||
{"http://mail.example.com/", true},
|
||||
{"http://www.example.com/index.gmi", true},
|
||||
{"http://example.com/", false},
|
||||
{"http://a.b.example.com/", false},
|
||||
{"gemini://www.example.com/", false},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for i, test := range tests {
|
||||
for _, test := range tests {
|
||||
h := &nopHandler{}
|
||||
var mux Mux
|
||||
mux.Handle(test.Pattern, h)
|
||||
|
||||
for _, match := range tests[i].Matches {
|
||||
for _, match := range test.Matches {
|
||||
u, err := url.Parse(match.URL)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
|
|
25
request.go
25
request.go
|
@ -4,7 +4,6 @@ import (
|
|||
"bufio"
|
||||
"crypto/tls"
|
||||
"io"
|
||||
"net"
|
||||
"net/url"
|
||||
)
|
||||
|
||||
|
@ -28,8 +27,7 @@ type Request struct {
|
|||
// This field is ignored by the Gemini server.
|
||||
Certificate *tls.Certificate
|
||||
|
||||
conn net.Conn
|
||||
tls *tls.ConnectionState
|
||||
TLS *tls.ConnectionState
|
||||
}
|
||||
|
||||
// NewRequest returns a new request.
|
||||
|
@ -98,30 +96,11 @@ func (r *Request) WriteTo(w io.Writer) (int64, error) {
|
|||
return wrote, bw.Flush()
|
||||
}
|
||||
|
||||
// Conn returns the network connection on which the request was received.
|
||||
// Conn returns nil for client requests.
|
||||
func (r *Request) Conn() net.Conn {
|
||||
return r.conn
|
||||
}
|
||||
|
||||
// TLS returns information about the TLS connection on which the
|
||||
// request was received.
|
||||
// TLS returns nil for client requests.
|
||||
func (r *Request) TLS() *tls.ConnectionState {
|
||||
if r.tls == nil {
|
||||
if tlsConn, ok := r.conn.(*tls.Conn); ok {
|
||||
state := tlsConn.ConnectionState()
|
||||
r.tls = &state
|
||||
}
|
||||
}
|
||||
return r.tls
|
||||
}
|
||||
|
||||
// ServerName returns the value of the TLS Server Name Indication extension
|
||||
// sent by the client.
|
||||
// ServerName returns an empty string for client requests.
|
||||
func (r *Request) ServerName() string {
|
||||
if tls := r.TLS(); tls != nil {
|
||||
if tls := r.TLS; tls != nil {
|
||||
return tls.ServerName
|
||||
}
|
||||
return ""
|
||||
|
|
|
@ -371,7 +371,10 @@ func (srv *Server) goServeConn(ctx context.Context, conn net.Conn) error {
|
|||
w.WriteHeader(StatusBadRequest, "Bad request")
|
||||
return w.Flush()
|
||||
}
|
||||
req.conn = conn
|
||||
if tlsConn, ok := conn.(*tls.Conn); ok {
|
||||
state := tlsConn.ConnectionState()
|
||||
req.TLS = &state
|
||||
}
|
||||
|
||||
h := srv.Handler
|
||||
if h == nil {
|
||||
|
|
4
text.go
4
text.go
|
@ -125,8 +125,8 @@ func ParseLines(r io.Reader, handler func(Line)) error {
|
|||
name = strings.TrimLeft(name, spacetab)
|
||||
line = LineLink{url, name}
|
||||
}
|
||||
} else if strings.HasPrefix(text, "*") {
|
||||
text = text[1:]
|
||||
} else if strings.HasPrefix(text, "* ") {
|
||||
text = text[2:]
|
||||
text = strings.TrimLeft(text, spacetab)
|
||||
line = LineListItem(text)
|
||||
} else if strings.HasPrefix(text, "###") {
|
||||
|
|
Loading…
Reference in New Issue