Better template loading, word page

See https://stackoverflow.com/a/11468132

dict/main.go

@@ -69,10 +69,11 @@ func ParseEntry(entry jmdict.JmdictEntry) Entry {
 	}
 }
 
-func Search(query string) (exactResults []Entry, otherResults []Entry, truncated bool) {
+func Search(query string) queryResult {
 	query = strings.TrimSpace(query)
-	exactResults = make([]Entry, 0)
+	exactResults := make([]Entry, 0)
-	otherResults = make([]Entry, 0)
+	otherResults := make([]Entry, 0)
+	truncated := false
 	count := 0
 	for _, jmdictEntry := range dict.Entries {
 		exactMatch := false
@@ -105,18 +106,8 @@ func Search(query string) (exactResults []Entry, otherResults []Entry, truncated
 			break
 		}
 	}
-	return
+	return queryResult{
-}
+		Query:        query,
-
-type searchTemplateData struct {
-	ExactResults []Entry
-	OtherResults []Entry
-	Truncated    bool
-	Count        int
-}
-
-func initSearchTemplateData(exactResults []Entry, otherResults []Entry, truncated bool) searchTemplateData {
-	return searchTemplateData{
 		ExactResults: exactResults,
 		OtherResults: otherResults,
 		Truncated:    truncated,
@@ -124,6 +115,26 @@ func initSearchTemplateData(exactResults []Entry, otherResults []Entry, truncate
 	}
 }
 
+func Lookup(word string) *Entry {
+	for _, jmdictEntry := range dict.Entries {
+		entry := ParseEntry(jmdictEntry)
+		if entry.Kanji == word {
+			return &entry
+		}
+	}
+	return nil
+}
+
+type queryResult struct {
+	// Fields must be capitalized
+	// to be accessible in templates
+	Query        string
+	ExactResults []Entry
+	OtherResults []Entry
+	Truncated    bool
+	Count        int
+}
+
 func main() {
 	err := LoadDict()
 	if err != nil {
@@ -133,51 +144,80 @@ func main() {
 	fmt.Println("JMdict loaded!")
 	r := mux.NewRouter()
 	r.HandleFunc("/", httputils.GenerateHandler(
-		"index.html",
 		func(w http.ResponseWriter, r *http.Request) bool { return true },
-		func(w http.ResponseWriter, r *http.Request) any { return nil },
+		httputils.NewTemplateSet("index.html"),
+		func(w http.ResponseWriter, r *http.Request) (string, any) { return "index.html", nil },
 		[]string{http.MethodGet},
 	))
-	redirectToHome := func(w http.ResponseWriter, r *http.Request) {
+	rawSearchHandler := func(w http.ResponseWriter, r *http.Request) {
-		http.Redirect(w, r, "/", http.StatusPermanentRedirect)
+		r.ParseMultipartForm(0)
+		q := r.FormValue("q")
+		var redirect string
+		if q == "" {
+			redirect = "/"
+		} else {
+			redirect = "/search/" + q
+		}
+		http.Redirect(w, r, redirect, http.StatusMovedPermanently)
 	}
-	r.HandleFunc("/search", redirectToHome)
+	r.HandleFunc("/search", rawSearchHandler)
-	r.HandleFunc("/search/", redirectToHome)
+	r.HandleFunc("/search/", rawSearchHandler)
 	r.HandleFunc("/search/{query}", httputils.GenerateHandler(
-		"index.html",
+		// handler whether or not to use template
-		func(w http.ResponseWriter, r *http.Request) bool {
-			return true
-		},
-		func(w http.ResponseWriter, r *http.Request) any {
-			query := mux.Vars(r)["query"]
-			return struct {
-				Query   string
-				Results searchTemplateData
-			}{
-				Query:   query,
-				Results: initSearchTemplateData(Search(query)),
-			}
-		},
-		[]string{http.MethodGet},
-	))
-	r.HandleFunc("/api/search", httputils.GenerateHandler(
-		"search.html",
 		func(w http.ResponseWriter, r *http.Request) bool {
+			// If Accept: applicaiton/json we'll use the template
 			if r.Header.Get("Accept") != "application/json" {
 				return true
 			}
+
+			// Otherwise, let's send JSON
+			query := mux.Vars(r)["query"]
+			result := Search(query)
+			jsonBytes, _ := json.Marshal(append(result.ExactResults, result.OtherResults...))
+
 			w.Header().Set("Content-Type", "application/json; charset=utf-8")
-			r.ParseMultipartForm(0)
-			query := r.FormValue("q")
-			exactResults, otherResults, _ := Search(query)
-			jsonBytes, _ := json.Marshal(append(exactResults, otherResults...))
 			fmt.Fprint(w, string(jsonBytes))
+
 			return false
 		},
-		func(w http.ResponseWriter, r *http.Request) any {
+		httputils.NewTemplateSet("index.html", "search.html"),
-			r.ParseMultipartForm(0)
+		// template data
-			query := r.FormValue("q")
+		func(w http.ResponseWriter, r *http.Request) (template string, data any) {
-			return initSearchTemplateData(Search(query))
+			if r.Header.Get("HX-Request") == "" {
+				template = "search.html"
+			} else {
+				template = "search"
+			}
+			// Only runs if handler returns true
+			query := mux.Vars(r)["query"]
+			data = Search(query)
+			return
+		},
+		[]string{http.MethodGet},
+	))
+	rawWordHandler := func(w http.ResponseWriter, r *http.Request) {
+		fmt.Println("Redirecting raw word handler")
+		http.Redirect(w, r, "/", http.StatusMovedPermanently)
+	}
+	r.HandleFunc("/word", rawWordHandler)
+	r.HandleFunc("/word/", rawWordHandler)
+	r.HandleFunc("/word/{word}", httputils.GenerateHandler(
+		func(w http.ResponseWriter, r *http.Request) bool { return true },
+		// Order matters
+		// word.html overrided the results block in index.html
+		// so should be loaded second
+		httputils.NewTemplateSet("index.html", "word.html"),
+		func(w http.ResponseWriter, r *http.Request) (template string, data any) {
+			template = "word.html"
+			query := mux.Vars(r)["word"]
+			data = struct {
+				Query any
+				Entry *Entry
+			}{
+				Query: nil,
+				Entry: Lookup(query),
+			}
+			return
 		},
 		[]string{http.MethodGet},
 	))

dict/templates/index.html

@@ -1,33 +1,42 @@
+{{- define "index" -}}
 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>jidict</title>
+    <title>{{ block "title" . }}{{ template "sitetitle" . }}{{ end }}</title>
     <link rel="stylesheet" href="https://unpkg.com/missing.css@1.0.9/dist/missing.min.css">
     <style>
         li {
             margin-top: 0.75em;
         }
+        #results .box h3 a {
+            color: inherit;
+        }
+        #results .box h3 a:not(:hover) {
+            text-decoration: none;
+        }
     </style>
     <script src="https://unpkg.com/htmx.org@1.9.3"></script>
 </head>
-<body>
+<body hx-boost="true">
     <main>
         <a href="/">
             <img src="https://jichan.org/logo.svg" style="height: 4em; display: block; margin: 1em auto 1em auto">
         </a>
         <form
-            hx-get="/api/search"
+            hx-get="/search"
-            hx-on::before-request="this.setAttribute('hx-replace-url', `/search/${this.querySelector('input').value}`)"
+            hx-replace-url="true"
             hx-target="#results"
-            hx-swap="innerHTML">
+            hx-on::before-request="document.title = `${this.querySelector('input').value} search - jidict`">
-            <input type="text" name="q"{{ with .Query }} value="{{ . }}"{{ end }} placeholder="辞書をサーチする" class="width:100%" autocomplete="false">
+            <input type="text" name="q" value="{{ block "value" . }}{{ end }}" placeholder="辞書をサーチする" class="width:100%" autocomplete="false" required>
         </form>
         <div id="results">
-        {{ with .Results }}{{ template "search" . }}{{ end }}
+        {{ block "results" . }}{{ if .Query }}{{ template "search" . }}{{ end }}{{ end }}
         </div>
         <br>
     </main>
 </body>
-</html>
+</html>
+{{- end -}}
+{{- template "index" . -}}

dict/templates/partials/entry.html

@@ -0,0 +1,23 @@
+{{ define "entry" }}
+<div class="box">
+    <h3>
+        {{- if .Kanji -}}
+        <a href="/word/{{ .Kanji }}"><ruby>{{- .Kanji -}}<rp>(</rp><rt>{{- .Reading -}}</rt><rp>)</rp></ruby></a>
+        {{- else -}}
+        {{- .Reading -}}
+        {{- end -}}
+    </h3>
+    {{- $count := len .Definitions -}}
+    {{ if eq $count 1 -}}
+    <p>{{- template "definition" (index .Definitions 0) -}}</p>
+    {{- else if ne $count 0 -}}
+    <ol>
+        {{- range .Definitions }}
+        <li>
+            {{ template "definition" . }}
+        </li>
+        {{- end }}
+    </ol>
+    {{- end }}
+</div>
+{{ end }}

dict/templates/partials/entryfull.html

@@ -0,0 +1,23 @@
+{{ define "entryfull" }}
+<div class="box">
+    <h3>
+        {{- if .Kanji -}}
+        <ruby>{{- .Kanji -}}<rp>(</rp><rt>{{- .Reading -}}</rt><rp>)</rp></ruby>
+        {{- else -}}
+        {{- .Reading -}}
+        {{- end -}}
+    </h3>
+    {{- $count := len .Definitions -}}
+    {{ if eq $count 1 -}}
+    <p>{{- template "definition" (index .Definitions 0) -}}</p>
+    {{- else if ne $count 0 -}}
+    <ol>
+        {{- range .Definitions }}
+        <li>
+            {{ template "definition" . }}
+        </li>
+        {{- end }}
+    </ol>
+    {{- end }}
+</div>
+{{ end }}

dict/templates/partials/search.html

@@ -0,0 +1,11 @@
+{{- define "search" -}}
+<p><i>{{ if .Truncated }}Truncated results, showing first {{ .Count }}{{ else }}{{ if eq .Count 0 }}No results{{ else }}{{ .Count }} result{{ if ne .Count 1}}s{{ end }}{{ end }}{{ end }}.</i></p>
+{{ range .ExactResults -}}
+{{- template "entry" . -}}
+{{- end }}
+{{ if and (ne (len .ExactResults) 0) (ne (len .OtherResults) 0) }}<hr>{{ end }}
+{{ range .OtherResults -}}
+{{ template "entry" . }}
+{{- end -}}
+{{- end -}}
+{{- template "search" . -}}

dict/templates/partials/sitetitle.html

@@ -0,0 +1 @@
+{{ define "sitetitle" }}jidict{{ end }}

dict/templates/search.html

@@ -1,11 +1,9 @@
-{{- define "search" -}}
+{{- define "title" }}{{ .Query }} search - {{ template "sitetitle" . }}{{- end -}}
-<p><i>{{ if .Truncated }}Truncated results, showing first {{ .Count }}{{ else }}{{ if eq .Count 0 }}No results{{ else }}{{ .Count }} result{{ if ne .Count 1}}s{{ end }}{{ end }}{{ end }}.</i></p>
+
-{{- range .ExactResults -}}
+{{- define "value" }}{{ .Query }}{{- end -}}
-{{- template "word" . -}}
+
-{{- end }}
+{{- define "results" -}}
-<hr>
+{{- template "entryfull" .Entry -}}
-{{ range .OtherResults -}}
-{{ template "word" . }}
 {{- end -}}
-{{- end -}}
+
-{{- template "search" . -}}
+{{- template "index" . -}}

dict/templates/word.html

@@ -1,22 +1,5 @@
-{{ define "word" }}
+{{- define "title" }}{{ .Entry.Kanji }} - {{ template "sitetitle" . }}{{- end -}}
-<div class="box">
+{{- define "results" -}}
-    <h3>
+{{- template "entryfull" .Entry -}}
-        {{- if .Kanji -}}
+{{- end -}}
-        <ruby>{{- .Kanji -}}<rp>(</rp><rt>{{- .Reading -}}</rt><rp>)</rp></ruby>
+{{- template "index" . -}}
-        {{- else -}}
-        {{- .Reading -}}
-        {{- end -}}
-    </h3>
-    {{ if le (len .Definitions) 2 -}}
-    <p>{{- template "definition" (index .Definitions 0) -}}</p>
-    {{- else -}}
-    <ol>
-        {{- range .Definitions }}
-        <li>
-            {{ template "definition" . }}
-        </li>
-        {{- end }}
-    </ol>
-    {{- end }}
-</div>
-{{ end }}

httputils/handler.go

@@ -1,25 +1,21 @@
 package httputils
 
 import (
+	"bytes"
 	"fmt"
 	"net/http"
 	"os"
 	"path/filepath"
+	"reflect"
 	"strings"
-	"text/template"
 	"time"
 )
 
 type Handler = func(http.ResponseWriter, *http.Request)
 
-const templateFolder = "templates"
+func getPartials() ([]string, map[string]time.Time, error) {
-
-var templatePaths, templateModTimes, _ = getTemplates()
-var templates *template.Template = template.Must(template.ParseFiles(templatePaths...))
-
-func getTemplates() ([]string, map[string]time.Time, error) {
 	var modTimes map[string]time.Time = make(map[string]time.Time)
-	err := filepath.Walk(templateFolder, func(path string, info os.FileInfo, err error) error {
+	err := filepath.Walk(partialsFolder, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
 			return err
 		}
@@ -37,35 +33,15 @@ func getTemplates() ([]string, map[string]time.Time, error) {
 	return paths, modTimes, err
 }
 
-func reloadTemplateIfModified(path string) {
-	fileInfo, _ := os.Stat(path)
-	modTime := fileInfo.ModTime()
-	if modTime.After(templateModTimes[path]) {
-		fmt.Printf("Reloading template %s...\n", path)
-		templates.ParseFiles(path)
-		templateModTimes[path] = modTime
-	}
-}
-
-func reloadTemplatesIfModified() {
-	for _, path := range templatePaths {
-		reloadTemplateIfModified(path)
-	}
-}
-
 const reloadTemplates = true
 
 func GenerateHandler(
-	file string,
 	handler func(http.ResponseWriter, *http.Request) bool,
-	data func(http.ResponseWriter, *http.Request) any,
+	templateSet TemplateSet,
+	template func(http.ResponseWriter, *http.Request) (template string, data any),
 	methods []string,
 ) Handler {
 	return func(w http.ResponseWriter, r *http.Request) {
-		// All templates must be reloaded in case of dependencies
-		if reloadTemplates {
-			reloadTemplatesIfModified()
-		}
 		for _, method := range methods {
 			if method == r.Method {
 				goto ok
@@ -75,9 +51,18 @@ func GenerateHandler(
 		return
 	ok:
 		renderTemplate := handler(w, r)
-		if renderTemplate && file != "" {
+		if renderTemplate {
+			file_path, data := template(w, r)
+			buf := &bytes.Buffer{}
+			err := templateSet.ExecuteTemplate(buf, file_path, reflect.ValueOf(data))
+			if err != nil {
+				fmt.Println(err)
+				w.WriteHeader(http.StatusInternalServerError)
+				fmt.Fprint(w, "500 Internal Server Error")
+				return
+			}
 			w.Header().Set("Content-Type", "text/html; charset=utf-8")
-			templates.ExecuteTemplate(w, file, data(w, r))
+			fmt.Fprint(w, buf.String())
 		}
 	}
 }

httputils/templates.go

@@ -0,0 +1,86 @@
+package httputils
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"strings"
+	"text/template"
+	"time"
+)
+
+type TemplateSet struct {
+	templates *template.Template
+	paths     []string
+	modTimes  map[string]time.Time
+}
+
+func newTemplateSet(partials *TemplateSet, paths ...string) TemplateSet {
+	var partialPaths []string
+	if partials == nil {
+		partialPaths = make([]string, 0)
+	} else {
+		partialPaths = partials.paths
+	}
+	allPaths := append(partialPaths, paths...)
+	modTimes := make(map[string]time.Time)
+	for _, path := range allPaths {
+		fileInfo, _ := os.Stat(path)
+		modTimes[path] = fileInfo.ModTime()
+	}
+	templates := template.Must(template.ParseFiles(allPaths...))
+	return TemplateSet{
+		templates: templates,
+		paths:     allPaths,
+		modTimes:  modTimes,
+	}
+}
+
+func NewTemplateSet(paths ...string) TemplateSet {
+	for i, path := range paths {
+		paths[i] = fmt.Sprintf("%s/%s", templateFolder, path)
+	}
+	return newTemplateSet(&partials, paths...)
+}
+
+func (templateSet *TemplateSet) ExecuteTemplate(wr io.Writer, name string, data any) error {
+	templateSet.reloadTemplatesIfModified()
+	return templateSet.templates.ExecuteTemplate(wr, name, data)
+}
+
+func (templateSet *TemplateSet) reloadTemplateIfModified(path string) {
+	fileInfo, _ := os.Stat(path)
+	modTime := fileInfo.ModTime()
+	if modTime.After(templateSet.modTimes[path]) {
+		fmt.Printf("Reloading template %s...\n", path)
+		templateSet.templates.ParseFiles(path)
+		templateSet.modTimes[path] = modTime
+	}
+}
+
+func (templateSet *TemplateSet) reloadTemplatesIfModified() {
+	for _, path := range templateSet.paths {
+		templateSet.reloadTemplateIfModified(path)
+	}
+}
+
+func getTemplatePathsInDirectory(directory string) (paths []string, err error) {
+	paths = make([]string, 0)
+	err = filepath.Walk(directory, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if !info.IsDir() && strings.HasSuffix(path, ".html") {
+			paths = append(paths, path)
+		}
+		return nil
+	})
+	return
+}
+
+const templateFolder = "templates"
+const partialsFolder = templateFolder + "/partials"
+
+var paths, _ = getTemplatePathsInDirectory(partialsFolder)
+var partials = newTemplateSet(nil, paths...)