add support for browser bar search keyword

mullender · willnorris · willnorris · commit 9d2c372f1d62 · 2022-12-05T15:01:33.000-08:00
Respect custom hostname in open search document.

Co-authored-by: Will Norris &lt;will@tailscale.com&gt;
diff --git a/golink.go b/golink.go
@@ -17,6 +17,7 @@ import (
 	"io/fs"
 	"io/ioutil"
 	"log"
+	"net"
 	"net/http"
 	"net/url"
 	"os"
@@ -32,12 +33,14 @@ import (
 	"tailscale.com/tsnet"
 )
 
+const defaultHostname = "go"
+
 var (
 	verbose    = flag.Bool("verbose", false, "be verbose")
 	sqlitefile = flag.String("sqlitedb", "", "path of SQLite database to store links")
 	dev        = flag.String("dev-listen", "", "if non-empty, listen on this addr and run in dev mode; auto-set sqlitedb if empty and don't use tsnet")
 	snapshot   = flag.String("snapshot", "", "file path of snapshot file")
-	hostname   = flag.String("hostname", "go", "service name")
+	hostname   = flag.String("hostname", defaultHostname, "service name")
 )
 
 var stats struct {
@@ -52,7 +55,7 @@ var stats struct {
 // that will be loaded on startup.
 var LastSnapshot []byte
 
-//go:embed static tmpl/*.html
+//go:embed static tmpl/*.html tmpl/*.xml
 var embeddedFS embed.FS
 
 // db stores short links.
@@ -106,9 +109,20 @@ func Run() error {
 	http.HandleFunc("/.detail/", serveDetail)
 	http.HandleFunc("/.export", serveExport)
 	http.HandleFunc("/.help", serveHelp)
+	http.HandleFunc("/.opensearch", serveOpenSearch)
 	http.Handle("/.static/", http.StripPrefix("/.", http.FileServer(http.FS(embeddedFS))))
 
 	if *dev != "" {
+		// override default hostname for dev mode
+		if *hostname == defaultHostname {
+			if h, p, err := net.SplitHostPort(*dev); err == nil {
+				if h == "" {
+					h = "localhost"
+				}
+				*hostname = fmt.Sprintf("%s:%s", h, p)
+			}
+		}
+
 		log.Printf("Running in dev mode on %s ...", *dev)
 		log.Fatal(http.ListenAndServe(*dev, nil))
 	}
@@ -154,6 +168,9 @@ var (
 
 	// helpTmpl is the template used by the http://go/.help page
 	helpTmpl *template.Template
+
+	// opensearchTmpl is the template used by the http://go/.opensearch page
+	opensearchTmpl *template.Template
 )
 
 type visitData struct {
@@ -172,6 +189,7 @@ func init() {
 	detailTmpl = template.Must(template.ParseFS(embeddedFS, "tmpl/base.html", "tmpl/detail.html"))
 	successTmpl = template.Must(template.ParseFS(embeddedFS, "tmpl/base.html", "tmpl/success.html"))
 	helpTmpl = template.Must(template.ParseFS(embeddedFS, "tmpl/base.html", "tmpl/help.html"))
+	opensearchTmpl = template.Must(template.ParseFS(embeddedFS, "tmpl/opensearch.xml"))
 }
 
 // initStats initializes the in-memory stats counter with counts from db.
@@ -244,6 +262,15 @@ func serveHelp(w http.ResponseWriter, _ *http.Request) {
 	helpTmpl.Execute(w, nil)
 }
 
+func serveOpenSearch(w http.ResponseWriter, _ *http.Request) {
+	type opensearchData struct {
+		Hostname string
+	}
+
+	w.Header().Set("Content-Type", "application/opensearchdescription+xml")
+	opensearchTmpl.Execute(w, opensearchData{Hostname: *hostname})
+}
+
 func serveGo(w http.ResponseWriter, r *http.Request) {
 	if r.RequestURI == "/" {
 		switch r.Method {
diff --git a/static/opensearch.xml b/static/opensearch.xml
@@ -0,0 +1,8 @@
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
+<ShortName>localhost</ShortName>
+<Description>localhost url redirector</Description>
+<InputEncoding>UTF-8</InputEncoding>
+<Image width="16" height="16" type="image/x-icon">https://github.com/favicon.ico</Image>
+<Url type="text/html" method="get" template="http://localhost:8080/{searchTerms}"/>
+<moz:SearchForm>http://localhost:8080/</moz:SearchForm>
+</OpenSearchDescription>
diff --git a/tmpl/base.html b/tmpl/base.html
@@ -4,6 +4,7 @@
   <title>go/</title>
   <link rel="stylesheet" href="/.static/base.css">
   <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="search" type="application/opensearchdescription+xml" title="searchTitle" href="/.opensearch" />
 </head>
 <body class="flex flex-col min-h-screen">
   <div class="bg-gray-100 border-b border-gray-200 pt-4 pb-2 mb-6">
diff --git a/tmpl/opensearch.xml b/tmpl/opensearch.xml
@@ -0,0 +1,8 @@
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
+  <ShortName>{{.Hostname}}</ShortName>
+  <Description>Private shortlinks on your tailnet</Description>
+  <InputEncoding>UTF-8</InputEncoding>
+  <Image width="16" height="16" type="image/png">http://{{.Hostname}}/.static/favicon.png</Image>
+  <Url type="text/html" method="get" template="http://{{.Hostname}}/{searchTerms}"/>
+  <moz:SearchForm>http://{{.Hostname}}/</moz:SearchForm>
+</OpenSearchDescription>
