feat: add browser search engines via opensearch description https://developer.mozilla.org/en-US/docs/Web/OpenSearch
Alan Pearce alan@alanpearce.eu
Wed, 15 May 2024 20:17:06 +0200
5 files changed, 77 insertions(+), 3 deletions(-)
M frontend/templates/blocks/search.gotmpl → frontend/templates/blocks/search.gotmpl
@@ -11,6 +11,6 @@ {{ block "results" . }}{{ end }} {{- end }} {{- end }} -{{- define "js" }} +{{- define "head" }} <script src="/static/search.js" defer></script> {{- end }}
M frontend/templates/index.gotmpl → frontend/templates/index.gotmpl
@@ -6,9 +6,17 @@ <meta name="viewport" content="width=device-width, initial-scale=1" /> <title>Searchix</title> <link href="/static/base.css" rel="stylesheet" /> <link href="/static/style.css" rel="stylesheet" /> - {{ block "js" . }} + {{ block "head" . }} {{ end }} {{ .ExtraHeadHTML }} + {{- range $key, $value := .Sources }} + <link + rel="search" + type="application/opensearchdescription+xml" + title="Searchix {{ $value.Name }}" + href="/options/{{ $key }}/opensearch.xml" + /> + {{- end }} </head> <body> <header>
A frontend/templates/opensearch.xml.gotmpl
@@ -0,0 +1,16 @@+<OpenSearchDescription + xmlns="http://a9.com/-/spec/opensearch/1.1/" + xmlns:moz="http://www.mozilla.org/2006/browser/search/" +> + <ShortName>Searchix {{ .Source.Name }}</ShortName> + <LongName>Search {{ .Source.Name }} options with Searchix</LongName> + <Description>Search options {{ .Source.Name }}</Description> + <Url + type="text/html" + method="get" + template="{{ .BaseURL }}/options/{{ .Source.Key }}/search?query={searchTerms}&from=opensearch" + /> + <moz:SearchForm + >{{ .BaseURL }}/options/{{ .Source.Key }}/search</moz:SearchForm + > +</OpenSearchDescription>
M internal/server/mux.go → internal/server/mux.go
@@ -229,6 +229,42 @@ } } }) + mux.HandleFunc( + "/options/{source}/opensearch.xml", + func(w http.ResponseWriter, r *http.Request) { + type openSearchData struct { + BaseURL string + Source *config.Source + } + + sourceKey := r.PathValue("source") + source := cfg.Importer.Sources[sourceKey] + if source == nil { + errorHandler(w, r, "Source not found", http.StatusNotFound) + + return + } + + w.Header().Set("Content-Type", "application/opensearchdescription+xml") + err := templates["opensearch.xml"].ExecuteTemplate( + w, + "opensearch.xml.gotmpl", + openSearchData{ + BaseURL: cfg.Web.BaseURL.String(), + Source: source, + }, + ) + if err != nil { + // no errorHandler; HTML does not make sense here + http.Error( + w, + fmt.Sprintf("Template render error: %v", err), + http.StatusInternalServerError, + ) + } + }, + ) + mux.Handle("/static/", http.FileServer(http.FS(frontend.Files))) if liveReload {
M internal/server/templates.go → internal/server/templates.go
@@ -81,8 +81,22 @@ return nil, err } templates["index"] = index - glob := path.Join(templateDir, "blocks", "*.gotmpl") + glob := path.Join(templateDir, "*.gotmpl") templatePaths, err := fs.Glob(frontend.Files, glob) + if err != nil { + return nil, errors.WithMessage(err, "could not glob main templates") + } + for _, fullname := range templatePaths { + tpl, err := loadTemplate(layoutFile, fullname) + if err != nil { + return nil, err + } + name, _ := strings.CutSuffix(path.Base(fullname), ".gotmpl") + templates[name] = tpl + } + + glob = path.Join(templateDir, "blocks", "*.gotmpl") + templatePaths, err = fs.Glob(frontend.Files, glob) if err != nil { return nil, errors.WithMessage(err, "could not glob block templates") }