Add oddmu-releases(7)

Since prefixes always have to match, the boolean expression can be
simplified and tests still pass.

Makefile

@@ -8,7 +8,7 @@ help:
 	@echo "    runs program, offline"
 	@echo
 	@echo make test
-	@echo "    runs the tests"
+	@echo "    runs the tests without log output"
 	@echo
 	@echo make docs
 	@echo "    create man pages from text files"
@@ -26,12 +26,12 @@ run:
 	go run .
 
 test:
-	go test
+	go test -shuffle on .
 
 upload:
 	go build
 	rsync --itemize-changes --archive oddmu sibirocobombus.root:/home/oddmu/
-	ssh sibirocobombus.root "systemctl restart oddmu; systemctl restart alex; systemctl restart claudia"
+	ssh sibirocobombus.root "systemctl restart oddmu; systemctl restart alex; systemctl restart claudia; systemctl restart campaignwiki"
 	@echo Changes to the template files need careful consideration
 
 docs:

README.md

@@ -59,6 +59,10 @@ indexes – lists of page links. These are important for feeds.
 [oddmu-search(7)](/oddmu.git/blob/main/man/oddmu-search.7.txt): This
 man page documents how search and scoring work.
 
+[oddmu-filter(7)](/oddmu.git/blob/main/man/oddmu-filter.7.txt): This
+man page documents how to exclude subdirectories from search and
+archiving.
+
 [oddmu-replace(1)](/oddmu.git/blob/main/man/oddmu-replace.1.txt): This
 man page documents the "replace" subcommand to make mass changes to
 the files much like find(1), grep(1) and sed(1) or perl(1).
@@ -122,29 +126,57 @@ If you spot any, [contact](https://alexschroeder.ch/wiki/Contact) me.
 If you're interested in making changes to the code, here's a
 high-level introduction to the various source files.
 
-- *_test.go are the test files; a few library functions are defined in
-  wiki_test.go.
-- *_cmd.go are the files implementing the various subcommands with
+- `*_test.go` are the test files; a few library functions are defined
+  in `wiki_test.go`.
+- `*_cmd.go` are the files implementing the various subcommands with
   matching names
-- accounts.go implements the webfinger code to fetch fediverse account
-  link destinations with the URI provided by webfinger
-- add_append.go implements the /add and /append handlers
-- diff.go implements the /diff handler
-- edit_save.go implements the /edit and /save handlers
-- feed.go implements the feed for a page based on the links it lists
-- highlight.go implements the bold tags for matches when showing
+- `accounts.go` implements the webfinger code to fetch fediverse
+  account link destinations with the URI provided by webfinger
+- `add_append.go` implements the `/add` and `/append` handlers
+- `archive.go` implements the `/archive` handler
+- `diff.go` implements the `/diff` handler
+- `edit_save.go` implements the `/edit` and `/save` handlers
+- `feed.go` implements the feed for a page based on the links it lists
+- `highlight.go` implements the bold tags for matches when showing
   search results
-- index.go implements the index of all the hashtags
-- languages.go implements the language detection
-- page.go implements the page loading and saving
-- parser.go implements the Markdown parsing
-- score.go implements the page scoring when showing search results
-- search.go implements the /search handler
-- snippets.go implements the page summaries for search results
-- tokenizer.go implements the various tokenizers used
-- upload_drop.go implements the /upload and /drop handlers
-- view.go implements the /view handler
-- wiki.go implements the main function
+- `index.go` implements the index of all the hashtags
+- `languages.go` implements the language detection
+- `page.go` implements the page loading and saving
+- `parser.go` implements the Markdown parsing
+- `score.go` implements the page scoring when showing search results
+- `search.go` implements the `/search` handler
+- `snippets.go` implements the page summaries for search results
+- `templates.go` implements template loading and reloading
+- `tokenizer.go` implements the various tokenizers used
+- `upload_drop.go` implements the `/upload` and `/drop` handlers
+- `view.go` implements the `/view` handler
+- `watch.go` implements the filesystem notification watch
+- `wiki.go` implements the main function
+
+If you want to change the markup rules, your starting point should be
+`parser.go`. Make sure you read the documentation of [Go
+Markdown](https://github.com/gomarkdown/markdown) and note that it
+offers MathJax support (needs a change to the `view.html` template so
+that the MathJax Javascript gets loaded) and
+[MMark](https://mmark.miek.nl/post/syntax/) support, and it shows how
+extensions can be added.
+
+One of the sad parts of the code is the distinction between path and
+filepath. On a Linux system, this doesn't matter. I suspect that it
+also doesn't matter on MacOS and Windows because the file systems
+handle forward slashes just fine. The code still tries to do the right
+thing. A path that is derived from a URL is a path with slashes.
+Before accessing a file, it has to be turned into a filepath using
+`filepath.FromSlashes` and in the rare case where the inverse happens,
+use `filepath.ToSlashes`. Any path received via the URL path uses
+slashes and needs to be converted to a filepath before passing it to
+any `os` function. Any path received within a `path/filepath.WalkFunc`
+is a filepath and needs to be converted to use slashes when used in
+HTML output.
+
+If you need to access the page name in code that is used from a
+template, you have to decode the path. See the code in `diff.go` for
+an example.
 
 ## References
 

RELEASE

@@ -0,0 +1,12 @@
+When preparing a new release
+----------------------------
+
+1. Run tests
+
+2. Make docs
+
+3. Make sure all files are checked in
+
+4. Update man/oddmu-releases.7.txt
+
+5. Tag the release and push the tag to all remotes

accounts.go

@@ -11,18 +11,15 @@ import (
 	"sync"
 )
 
-// useWebfinger indicates whether Oddmu looks up the profile pages of
-// fediverse accounts. To enable this, set the environment variable
-// ODDMU_WEBFINGER to "1".
+// useWebfinger indicates whether Oddmu looks up the profile pages of fediverse accounts. To enable this, set the
+// environment variable ODDMU_WEBFINGER to "1".
 var useWebfinger = false
 
-// Accounts contains the map used to set the usernames. Make sure to
-// lock and unlock as appropriate.
+// Accounts contains the map used to set the usernames. Make sure to lock and unlock as appropriate.
 type Accounts struct {
 	sync.RWMutex
 
-	// uris is a map, mapping account names likes
-	// "@alex@alexschroeder.ch" to URIs like
+	// uris is a map, mapping account names likes "@alex@alexschroeder.ch" to URIs like
 	// "https://social.alexschroeder.ch/@alex".
 	uris map[string]string
 }
@@ -30,23 +27,19 @@ type Accounts struct {
 // accounts holds the global mapping of accounts to profile URIs.
 var accounts Accounts
 
-// initAccounts sets up the accounts map. This is called once at
-// startup and therefore does not need to be locked. On ever restart,
-// this map starts empty and is slowly repopulated as pages are
-// visited.
-func initAccounts() {
+// This is called once at startup and therefore does not need to be locked. On every restart, this map starts empty and
+// is slowly repopulated as pages are visited.
+func init() {
 	if os.Getenv("ODDMU_WEBFINGER") == "1" {
 		accounts.uris = make(map[string]string)
 		useWebfinger = true
 	}
 }
 
-// account links a social media account like @account@domain to a
-// profile page like https://domain/user/account. Any account seen for
-// the first time uses a best guess profile URI. It is also looked up
-// using webfinger, in parallel. See lookUpAccountUri. If the lookup
-// succeeds, the best guess is replaced with the new URI so on
-// subsequent requests, the URI is correct.
+// account links a social media account like @account@domain to a profile page like https://domain/user/account. Any
+// account seen for the first time uses a best guess profile URI. It is also looked up using webfinger, in parallel. See
+// lookUpAccountUri. If the lookup succeeds, the best guess is replaced with the new URI so on subsequent requests, the
+// URI is correct.
 func account(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
 	data = data[offset:]
 	i := 1 // skip @ of username
@@ -97,10 +90,8 @@ func account(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
 	return i, link
 }
 
-// lookUpAccountUri is called for accounts that haven't been seen
-// before. It calls webfinger and parses the JSON. If possible, it
-// extracts the link to the profile page and replaces the entry in
-// accounts.
+// lookUpAccountUri is called for accounts that haven't been seen before. It calls webfinger and parses the JSON. If
+// possible, it extracts the link to the profile page and replaces the entry in accounts.
 func lookUpAccountUri(account, domain string) {
 	uri := "https://" + domain + "/.well-known/webfinger"
 	resp, err := http.Get(uri + "?resource=acct:" + account)
@@ -144,9 +135,8 @@ type WebFinger struct {
 	Links   []Link   `json:"links"`
 }
 
-// parseWebFinger parses the web finger JSON and returns the profile
-// page URI. For unmarshalling the JSON, it uses the Link and
-// WebFinger structs.
+// parseWebFinger parses the web finger JSON and returns the profile page URI. For unmarshalling the JSON, it uses the
+// Link and WebFinger structs.
 func parseWebFinger(body []byte) (string, error) {
 	var wf WebFinger
 	err := json.Unmarshal(body, &wf)

accounts_test.go

@@ -5,16 +5,6 @@ import (
 	"testing"
 )
 
-// This causes network access!
-// func TestPageAccount(t *testing.T) {
-// 	initAccounts()
-// 	p := &Page{Body: []byte(`@alex, @alex@alexschroeder.ch said`)}
-// 	p.renderHtml()
-// 	r := `<p>@alex, <a href="https://alexschroeder.ch/users/alex">@alex</a> said</p>
-// `
-// 	assert.Equal(t, r, string(p.Html))
-// }
-
 func TestWebfingerParsing(t *testing.T) {
 	body := []byte(`{
   "subject": "acct:Gargron@mastodon.social",

add_append.go

@@ -16,11 +16,11 @@ func addHandler(w http.ResponseWriter, r *http.Request, name string) {
 	} else {
 		p.handleTitle(false)
 	}
-	renderTemplate(w, "add", p)
+	renderTemplate(w, p.Dir(), "add", p)
 }
 
-// appendHandler takes the "body" form parameter and appends it. The
-// browser is redirected to the page view.
+// appendHandler takes the "body" form parameter and appends it. The browser is redirected to the page view. This is
+// similar to the saveHandler.
 func appendHandler(w http.ResponseWriter, r *http.Request, name string) {
 	body := r.FormValue("body")
 	p, err := loadPage(name)
@@ -35,10 +35,17 @@ func appendHandler(w http.ResponseWriter, r *http.Request, name string) {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 		return
 	}
+	username, _, ok := r.BasicAuth()
+	if ok {
+		log.Println("Save", name, "by", username)
+	} else {
+		log.Println("Save", name)
+	}
 	if r.FormValue("notify") == "on" {
 		err = p.notify()
 		if err != nil {
-			log.Println("notify:", err)
+			http.Error(w, err.Error(), http.StatusInternalServerError)
+			return
 		}
 	}
 	http.Redirect(w, r, "/view/"+name, http.StatusFound)

add_append_test.go

@@ -24,7 +24,6 @@ Into the oven`)
 func TestAddAppend(t *testing.T) {
 	cleanup(t, "testdata/add")
 	index.load()
-
 	p := &Page{Name: "testdata/add/fire", Body: []byte(`# Fire
 Orange sky above
 Reflects a distant fire
@@ -48,30 +47,26 @@ It's not `)}
 }
 
 func TestAddAppendChanges(t *testing.T) {
-	cleanup(t, "testdata/notification2", "changes.md", "changes.md~")
-	restore(t, "index.md")
-	os.Remove("changes.md")
+	cleanup(t, "testdata/append")
 	today := time.Now().Format(time.DateOnly)
-
-	p := &Page{Name: "testdata/notification2/" + today + "-water", Body: []byte(`# Water
+	p := &Page{Name: "testdata/append/" + today + "-water", Body: []byte(`# Water
 Sunlight dancing fast
 Blue and green and pebbles gray
 `)}
 	p.save()
-
 	data := url.Values{}
 	data.Set("body", "Stand in cold water")
 	data.Add("notify", "on")
 	HTTPRedirectTo(t, makeHandler(appendHandler, true),
-		"POST", "/append/testdata/notification2/"+today+"-water",
-		data, "/view/testdata/notification2/"+today+"-water")
+		"POST", "/append/testdata/append/"+today+"-water",
+		data, "/view/testdata/append/"+today+"-water")
 	// The changes.md file was created
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/append/changes.md")
 	assert.NoError(t, err)
-	d := time.Now().Format(time.DateOnly)
-	assert.Equal(t, "# Changes\n\n## "+d+"\n* [Water](testdata/notification2/"+today+"-water)\n", string(s))
+	assert.Equal(t, "# Changes\n\n## "+today+"\n* [Water]("+today+"-water)\n", string(s))
 	// Link added to index.md file
-	s, err = os.ReadFile("index.md")
+	s, err = os.ReadFile("testdata/append/index.md")
 	assert.NoError(t, err)
-	assert.Contains(t, string(s), "\n* [Water](testdata/notification2/"+today+"-water)\n")
+	// New index contains just the link
+	assert.Equal(t, string(s), "* [Water]("+today+"-water)\n")
 }

archive.go

@@ -0,0 +1,69 @@
+package main
+
+import (
+	"archive/zip"
+	"io"
+	"io/fs"
+	"log"
+	"net/http"
+	"os"
+	"path/filepath"
+	"regexp"
+	"strings"
+)
+
+// archiveHandler serves a zip file. Directories starting with a period are skipped. Filenames starting with a period
+// are skipped. If the environment variable ODDMU_FILTER is a regular expression that matches the starting directory,
+// this is a "separate site"; if the regular expression does not match, this is the "main site" and page names must also
+// not match the regular expression.
+func archiveHandler(w http.ResponseWriter, r *http.Request, path string) {
+	filter := os.Getenv("ODDMU_FILTER")
+	re, err := regexp.Compile(filter)
+	if err != nil {
+		log.Println("ODDMU_FILTER does not compile:", filter, err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+	matches := re.MatchString(path)
+	dir := filepath.Dir(filepath.FromSlash(path))
+	z := zip.NewWriter(w)
+	err = filepath.Walk(dir, func (path string, info fs.FileInfo, err error) error {
+			if err != nil {
+				return err
+			}
+			if info.IsDir() {
+				if path != "." && strings.HasPrefix(filepath.Base(path), ".") {
+					return filepath.SkipDir
+				}
+			} else if !strings.HasPrefix(filepath.Base(path), ".") &&
+				(matches || !re.MatchString(path)) {
+				zf, err := z.Create(path)
+				if err != nil {
+					log.Println(err)
+					return err
+				}
+				file, err := os.Open(path)
+				if err != nil {
+					log.Println(err)
+					return err
+				}
+				_, err = io.Copy(zf, file)
+				if err != nil {
+					log.Println(err)
+					return err
+				}
+			}
+			return nil
+		})
+	if err != nil {
+		log.Println(err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+	err = z.Close()
+	if err != nil {
+		log.Println(err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+}

archive_test.go

@@ -0,0 +1,27 @@
+package main
+
+import (
+	"archive/zip"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"testing"
+	"strings"
+)
+
+func TestArchive(t *testing.T) {
+	cleanup(t, "testdata/archive")
+	assert.NoError(t, os.MkdirAll("testdata/archive/public", 0755))
+	assert.NoError(t, os.MkdirAll("testdata/archive/secret", 0755))
+	assert.NoError(t, os.WriteFile("testdata/archive/public/index.md", []byte("# Public\nChurch tower bells ringing\nA cold wind biting my ears\nWalk across the square"), 0644))
+	assert.NoError(t, os.WriteFile("testdata/archive/secret/index.md", []byte("# Secret\nMany years ago I danced\nSpending nights in clubs and bars\nIt is my secret"), 0644))
+	os.Setenv("ODDMU_FILTER", "^testdata/archive/secret/")
+	body := assert.HTTPBody(makeHandler(archiveHandler, true), "GET", "/archive/testdata/data.zip", nil)
+	r, err := zip.NewReader(strings.NewReader(body), int64(len(body)))
+	assert.NoError(t, err, "Unzip")
+	names := []string{}
+	for _, file := range r.File {
+		names = append(names, file.Name)
+	}
+	assert.Contains(t, names, "testdata/archive/public/index.md")
+	assert.NotContains(t, names, "testdata/archive/secret/index.md")
+}

changes.go

@@ -1,42 +1,48 @@
 package main
 
 import (
+	"log"
 	"path"
 	"regexp"
 	"strings"
 	"time"
 )
 
-// notify adds a link to the "changes" page, as well as to all the existing hashtag pages. If the "changes" page does
-// not exist, it is created. If the hashtag page does not exist, it is not. Hashtag pages are considered optional.
+// notify adds a link to the "changes" page, the "index" page, as well as to all the existing hashtag pages. The link to
+// the "index" page is only added if the page being edited is a blog page for the current year. The link to existing
+// hashtag pages is only added for blog pages. If the "changes" page does not exist, it is created. If the hashtag page
+// does not exist, it is not. Hashtag pages are considered optional. If the page that's being edited is in a
+// subdirectory, then the "changes", "index" and hashtag pages of that particular subdirectory are affected. Every
+// subdirectory is treated like a potentially independent wiki. Errors are logged before being returned because the
+// error messages are confusing from the point of view of the saveHandler.
 func (p *Page) notify() error {
 	p.handleTitle(false)
 	if p.Title == "" {
 		p.Title = p.Name
 	}
-	esc := nameEscape(p.Name)
+	esc := nameEscape(path.Base(p.Name))
 	link := "* [" + p.Title + "](" + esc + ")\n"
 	re := regexp.MustCompile(`(?m)^\* \[[^\]]+\]\(` + esc + `\)\n`)
 	dir := path.Dir(p.Name)
-	// Recent changes for all pages
-	err := addLinkWithDate("changes", link, re)
+	err := addLinkWithDate(path.Join(dir, "changes"), link, re)
 	if err != nil {
+		log.Printf("Updating changes in %s failed: %s", dir, err)
 		return err
 	}
-	// For blog pages only…
 	if p.isBlog() {
 		// Add to the index only if the blog post is for the current year
 		if strings.HasPrefix(path.Base(p.Name), time.Now().Format("2006")) {
-			err := addLink("index", link, re)
+			err := addLink(path.Join(dir, "index"), true, link, re)
 			if err != nil {
+				log.Printf("Updating index in %s failed: %s", dir, err)
 				return err
 			}
 		}
-		// Update hashtag pages
 		p.renderHtml() // to set hashtags
 		for _, hashtag := range p.Hashtags {
-			err := addLink(path.Join(dir, hashtag), link, re)
+			err := addLink(path.Join(dir, hashtag), false, link, re)
 			if err != nil {
+				log.Printf("Updating hashtag %s in %s failed: %s", hashtag, dir, err)
 				return err
 			}
 		}
@@ -50,40 +56,40 @@ func (p *Page) notify() error {
 func addLinkWithDate(name, link string, re *regexp.Regexp) error {
 	date := time.Now().Format(time.DateOnly)
 	org := ""
-	c, err := loadPage(name)
+	p, err := loadPage(name)
 	if err != nil {
 		// create a new page
-		c = &Page{Name: "changes", Body: []byte("# Changes\n\n## " + date + "\n" + link)}
+		p = &Page{Name: name, Body: []byte("# Changes\n\n## " + date + "\n" + link)}
 	} else {
-		org = string(c.Body)
+		org = string(p.Body)
 		// remove the old match, if one exists
-		loc := re.FindIndex(c.Body)
+		loc := re.FindIndex(p.Body)
 		if loc != nil {
-			r := c.Body[:loc[0]]
-			if loc[1] < len(c.Body) {
-				r = append(r, c.Body[loc[1]:]...)
+			r := p.Body[:loc[0]]
+			if loc[1] < len(p.Body) {
+				r = append(r, p.Body[loc[1]:]...)
 			}
-			c.Body = r
-			if loc[0] >= 14 && len(c.Body) >= loc[0]+15 {
+			p.Body = r
+			if loc[0] >= 14 && len(p.Body) >= loc[0]+15 {
 				// remove the preceding date if there are now two dates following each other
 				re := regexp.MustCompile(`(?m)^## (\d\d\d\d-\d\d-\d\d)\n\n## (\d\d\d\d-\d\d-\d\d)\n`)
-				if re.Match(c.Body[loc[0]-14 : loc[0]+15]) {
-					c.Body = append(c.Body[0:loc[0]-14], c.Body[loc[0]+1:]...)
+				if re.Match(p.Body[loc[0]-14 : loc[0]+15]) {
+					p.Body = append(p.Body[0:loc[0]-14], p.Body[loc[0]+1:]...)
 				}
-			} else if len(c.Body) == loc[0] {
+			} else if len(p.Body) == loc[0] {
 				// remove a trailing date
 				re := regexp.MustCompile(`## (\d\d\d\d-\d\d-\d\d)\n`)
-				if re.Match(c.Body[loc[0]-14 : loc[0]]) {
-					c.Body = c.Body[0 : loc[0]-14]
+				if re.Match(p.Body[loc[0]-14 : loc[0]]) {
+					p.Body = p.Body[0 : loc[0]-14]
 				}
 			}
 		}
 		// locate the beginning of the list to insert the line
 		re := regexp.MustCompile(`(?m)^\* \[[^\]]+\]\([^\)]+\)\n`)
-		loc = re.FindIndex(c.Body)
+		loc = re.FindIndex(p.Body)
 		if loc == nil {
 			// if no list was found, use the end of the page
-			loc = []int{len(c.Body)}
+			loc = []int{len(p.Body)}
 		}
 		// start with new page content
 		r := []byte("")
@@ -91,10 +97,10 @@ func addLinkWithDate(name, link string, re *regexp.Regexp) error {
 		addDate := true
 		if loc[0] >= 14 {
 			re := regexp.MustCompile(`(?m)^## (\d\d\d\d-\d\d-\d\d)\n`)
-			m := re.Find(c.Body[loc[0]-14 : loc[0]])
+			m := re.Find(p.Body[loc[0]-14 : loc[0]])
 			if m == nil {
 				// not a date: insert date, don't move insertion point
-			} else if string(c.Body[loc[0]-11:loc[0]-1]) == date {
+			} else if string(p.Body[loc[0]-11:loc[0]-1]) == date {
 				// if the date is our date, don't add it, don't move insertion point
 				addDate = false
 			} else {
@@ -103,7 +109,7 @@ func addLinkWithDate(name, link string, re *regexp.Regexp) error {
 			}
 		}
 		// append up to the insertion point
-		r = append(r, c.Body[:loc[0]]...)
+		r = append(r, p.Body[:loc[0]]...)
 		// append date, if necessary
 		if addDate {
 			// ensure paragraph break
@@ -120,39 +126,44 @@ func addLinkWithDate(name, link string, re *regexp.Regexp) error {
 		// append link
 		r = append(r, []byte(link)...)
 		// if we just added a date, add an empty line after the single-element list
-		if len(c.Body) > loc[0] && c.Body[loc[0]] != '*' {
+		if len(p.Body) > loc[0] && p.Body[loc[0]] != '*' {
 			r = append(r, '\n')
 		}
 		// append the rest
-		r = append(r, c.Body[loc[0]:]...)
-		c.Body = r
+		r = append(r, p.Body[loc[0]:]...)
+		p.Body = r
 	}
 	// only save if something changed
-	if string(c.Body) != org {
-		return c.save()
+	if string(p.Body) != org {
+		return p.save()
 	}
 	return nil
 }
 
 // addLink adds a link to a named page, if the page exists and doesn't contain the link. If the link exists but with a
 // different title, the title is fixed.
-func addLink(name, link string, re *regexp.Regexp) error {
-	c, err := loadPage(name)
+func addLink(name string, mandatory bool, link string, re *regexp.Regexp) error {
+	p, err := loadPage(name)
 	if err != nil {
-		// Skip non-existing files: no error
-		return nil
+		if mandatory {
+			p = &Page{Name: name, Body: []byte(link)}
+			return p.save()
+		} else {
+			// Skip non-existing files: no error
+			return nil
+		}
 	}
-	org := string(c.Body)
+	org := string(p.Body)
 	// if a link exists, that's the place to insert the new link (in which case loc[0] and loc[1] differ)
-	loc := re.FindIndex(c.Body)
+	loc := re.FindIndex(p.Body)
 	// if no link exists, find a good place to insert it
 	if loc == nil {
 		// locate the beginning of the list to insert the line
 		re = regexp.MustCompile(`(?m)^\* \[[^\]]+\]\([^\)]+\)\n`)
-		loc = re.FindIndex(c.Body)
+		loc = re.FindIndex(p.Body)
 		if loc == nil {
 			// if no list was found, use the end of the page
-			m := len(c.Body)
+			m := len(p.Body)
 			loc = []int{m, m}
 		} else {
 			// if a list item was found, use just the beginning as insertion point
@@ -162,15 +173,15 @@ func addLink(name, link string, re *regexp.Regexp) error {
 	// start with new page content
 	r := []byte("")
 	// append up to the insertion point
-	r = append(r, c.Body[:loc[0]]...)
+	r = append(r, p.Body[:loc[0]]...)
 	// append link
 	r = append(r, []byte(link)...)
 	// append the rest
-	r = append(r, c.Body[loc[1]:]...)
-	c.Body = r
+	r = append(r, p.Body[loc[1]:]...)
+	p.Body = r
 	// only save if something changed
-	if string(c.Body) != org {
-		return c.save()
+	if string(p.Body) != org {
+		return p.save()
 	}
 	return nil
 }

changes_test.go

@@ -10,32 +10,29 @@ import (
 // Note TestEditSaveChanges and TestAddAppendChanges.
 
 func TestChanges(t *testing.T) {
-	cleanup(t, "changes.md", "changes.md~")
-	restore(t, "index.md")
-	os.Remove("changes.md")
+	cleanup(t, "testdata/washing")
 	today := time.Now().Format(time.DateOnly)
-	p := &Page{Name: "testdata/" + today + "-machine",
+	p := &Page{Name: "testdata/washing/" + today + "-machine",
 		Body: []byte(`# Washing machine
 Churning growling thing
 Water spraying in a box 
 Out of sight and dark`)}
 	p.notify()
 	// Link added to changes.md file
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/washing/changes.md")
 	assert.NoError(t, err)
-	assert.Contains(t, string(s), "[Washing machine](testdata/"+today+"-machine)")
+	assert.Contains(t, string(s), "[Washing machine]("+today+"-machine)")
 	// Link added to index.md file
-	s, err = os.ReadFile("index.md")
+	s, err = os.ReadFile("testdata/washing/index.md")
 	assert.NoError(t, err)
-	assert.Contains(t, string(s), "\n* [Washing machine](testdata/"+today+"-machine)\n")
+	// New index contains just the link
+	assert.Equal(t, string(s), "* [Washing machine]("+today+"-machine)\n")
 }
 
 func TestChangesWithHashtag(t *testing.T) {
-	cleanup(t, "changes.md", "changes.md~")
-	restore(t, "index.md")
-	os.Remove("changes.md")
+	cleanup(t, "testdata/changes")
 	intro := "# Haiku\n"
-	line := "* [Hotel room](testdata/changes/2023-10-27-hotel)\n"
+	line := "* [Hotel room](2023-10-27-hotel)\n"
 	h := &Page{Name: "testdata/changes/Haiku", Body: []byte(intro)}
 	h.save()
 	p := &Page{Name: "testdata/changes/2023-10-27-hotel",
@@ -46,7 +43,7 @@ Home away from home
 
 #Haiku #Poetry`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
 	assert.Contains(t, string(s), line)
 	s, err = os.ReadFile("testdata/changes/Haiku.md")
@@ -56,144 +53,154 @@ Home away from home
 }
 
 func TestChangesWithList(t *testing.T) {
-	cleanup(t, "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	intro := "# Changes\n\nThis is a paragraph.\n\n"
-	line := "* [a change](change)\n"
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	os.WriteFile("changes.md", []byte(intro+d+line), 0644)
+	line := "* [a change](change)\n"
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(intro+d+line), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte(`Hallo!`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
-	new_line := "* [testdata/changes/alex](testdata/changes/alex)\n"
+	new_line := "* [testdata/changes/alex](alex)\n"
 	// new line was added at the beginning of the list
 	assert.Equal(t, intro+d+new_line+line, string(s))
 }
 
 func TestChangesWithOldList(t *testing.T) {
-	cleanup(t, "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	intro := "# Changes\n\nThis is a paragraph.\n\n"
 	line := "* [a change](change)\n"
 	y := "## " + time.Now().Add(-24*time.Hour).Format(time.DateOnly) + "\n"
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	os.WriteFile("changes.md", []byte(intro+y+line), 0644)
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(intro+y+line), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte(`Hallo!`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
-	new_line := "* [testdata/changes/alex](testdata/changes/alex)\n"
+	new_line := "* [testdata/changes/alex](alex)\n"
 	// new line was added at the beginning of the list
 	assert.Equal(t, intro+d+new_line+"\n"+y+line, string(s))
 }
 
 func TestChangesWithOldDisappearingListAtTheEnd(t *testing.T) {
-	cleanup(t, "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	intro := "# Changes\n\nThis is a paragraph.\n\n"
-	line := "* [a change](testdata/changes/alex)\n"
+	line := "* [a change](alex)\n"
 	y := "## " + time.Now().Add(-24*time.Hour).Format(time.DateOnly) + "\n"
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	os.WriteFile("changes.md", []byte(intro+y+line), 0644)
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(intro+y+line), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte(`Hallo!`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
-	new_line := "* [testdata/changes/alex](testdata/changes/alex)\n"
+	new_line := "* [testdata/changes/alex](alex)\n"
 	// new line was added at the beginning of the list, with the new date, and the old date disappeared
 	assert.Equal(t, intro+d+new_line, string(s))
 }
 
 func TestChangesWithOldDisappearingListInTheMiddle(t *testing.T) {
-	cleanup(t, "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	intro := "# Changes\n\nThis is a paragraph.\n\n"
-	line := "* [a change](testdata/changes/alex)\n"
-	other := "* [other change](testdata/changes/whatever)\n"
+	line := "* [a change](alex)\n"
+	other := "* [other change](whatever)\n"
 	yy := "## " + time.Now().Add(-48*time.Hour).Format(time.DateOnly) + "\n"
 	y := "## " + time.Now().Add(-24*time.Hour).Format(time.DateOnly) + "\n"
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	os.WriteFile("changes.md", []byte(intro+y+line+"\n"+yy+other), 0644)
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(intro+y+line+"\n"+yy+other), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte(`Hallo!`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
-	new_line := "* [testdata/changes/alex](testdata/changes/alex)\n"
+	new_line := "* [testdata/changes/alex](alex)\n"
 	// new line was added at the beginning of the list, with the new date, and the old date disappeared
 	assert.Equal(t, intro+d+new_line+"\n"+yy+other, string(s))
 }
 
 func TestChangesWithListAtTheTop(t *testing.T) {
-	cleanup(t, "testdata/changes", "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	line := "* [a change](change)\n"
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	os.WriteFile("changes.md", []byte(line), 0644)
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(line), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte(`Hallo!`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
-	new_line := "* [testdata/changes/alex](testdata/changes/alex)\n"
+	new_line := "* [testdata/changes/alex](alex)\n"
 	// new line was added at the top, no error due to missing introduction
 	assert.Equal(t, d+new_line+line, string(s))
 }
 
 func TestChangesWithNoList(t *testing.T) {
-	cleanup(t, "testdata/changes", "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	intro := "# Changes\n\nThis is a paragraph."
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	os.WriteFile("changes.md", []byte(intro), 0644)
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(intro), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte(`Hallo!`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
-	new_line := "* [testdata/changes/alex](testdata/changes/alex)\n"
+	new_line := "* [testdata/changes/alex](alex)\n"
 	// into is still there and a new list was started
 	assert.Equal(t, intro+"\n\n"+d+new_line, string(s))
 }
 
 func TestChangesWithUpdate(t *testing.T) {
-	cleanup(t, "testdata/changes", "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	intro := "# Changes\n\nThis is a paragraph.\n\n"
-	other := "* [other change](testdata/changes/whatever)\n"
+	other := "* [other change](whatever)\n"
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	line := "* [a change](testdata/changes/alex)\n"
-	os.WriteFile("changes.md", []byte(intro+d+other+line), 0644)
+	line := "* [a change](alex)\n"
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(intro+d+other+line), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte(`Hallo!`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
-	new_line := "* [testdata/changes/alex](testdata/changes/alex)\n"
+	new_line := "* [testdata/changes/alex](alex)\n"
 	// the change was already listed, but now it moved up and has a new title
 	assert.Equal(t, intro+d+new_line+other, string(s))
 }
 
 func TestChangesWithNoChangeToTheOrder(t *testing.T) {
-	cleanup(t, "testdata/changes", "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	intro := "# Changes\n\nThis is a paragraph.\n\n"
-	other := "* [other change](testdata/changes/whatever)\n"
-	line := "* [a change](testdata/changes/alex)\n"
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	os.WriteFile("changes.md", []byte(intro+d+line+other), 0644)
+	line := "* [a change](alex)\n"
+	other := "* [other change](whatever)\n"
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(intro+d+line+other), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte(`Hallo!`)}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
-	new_line := "* [testdata/changes/alex](testdata/changes/alex)\n"
+	new_line := "* [testdata/changes/alex](alex)\n"
 	// the change was already listed at the top, so just use the new title
 	assert.Equal(t, intro+d+new_line+other, string(s))
+	// since the file has changed, a backup was necessary
+	assert.FileExists(t, "testdata/changes/changes.md~")
 }
 
 func TestChangesWithNoChanges(t *testing.T) {
-	cleanup(t, "testdata/changes", "changes.md", "changes.md~")
+	cleanup(t, "testdata/changes")
 	intro := "# Changes\n\nThis is a paragraph.\n\n"
-	other := "* [other change](testdata/changes/whatever)\n"
-	line := "* [a change](testdata/changes/alex)\n"
 	d := "## " + time.Now().Format(time.DateOnly) + "\n"
-	os.Remove("changes.md~")
-	os.WriteFile("changes.md", []byte(intro+d+line+other), 0644)
+	line := "* [a change](alex)\n"
+	other := "* [other change](whatever)\n"
+	assert.NoError(t, os.MkdirAll("testdata/changes", 0755))
+	assert.NoError(t, os.WriteFile("testdata/changes/changes.md", []byte(intro+d+line+other), 0644))
 	p := &Page{Name: "testdata/changes/alex", Body: []byte("# a change\nHallo!")}
 	p.notify()
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/changes/changes.md")
 	assert.NoError(t, err)
 	// the change was already listed at the top, so no change was necessary
 	assert.Equal(t, intro+d+line+other, string(s))
 	// since the file hasn't changed, no backup was necessary
-	assert.NoFileExists(t, "changes.md~")
+	assert.NoFileExists(t, "testdata/changes/changes.md~")
 }

concurrency_test.go

@@ -1,15 +0,0 @@
-package main
-
-import (
-	"github.com/stretchr/testify/assert"
-	"testing"
-)
-
-// Use go test -race to see whether this is a race condition.
-func TestLoadAndSearch(t *testing.T) {
-	index.reset()
-	go index.load()
-	q := "Oddµ"
-	pages, _ := search(q, "", 1, false)
-	assert.Zero(t, len(pages))
-}

diff.go

@@ -8,6 +8,7 @@ import (
 	"net/http"
 	"net/url"
 	"os"
+	"path/filepath"
 	"strings"
 )
 
@@ -19,21 +20,22 @@ func diffHandler(w http.ResponseWriter, r *http.Request, name string) {
 	}
 	p.handleTitle(true)
 	p.renderHtml()
-	renderTemplate(w, "diff", p)
+	renderTemplate(w, p.Dir(), "diff", p)
 }
 
 // Diff computes the diff for a page. At this point, renderHtml has already been called so the Name is escaped.
 func (p *Page) Diff() template.HTML {
-	name, err := url.PathUnescape(p.Name)
+	path, err := url.PathUnescape(p.Name)
 	if err != nil {
 		return template.HTML("Cannot unescape " + p.Name)
 	}
-	a := name + ".md~"
+	fp := filepath.FromSlash(path)
+	a := fp + ".md~"
 	t1, err := os.ReadFile(a)
 	if err != nil {
 		return template.HTML("Cannot read " + a + ", so the page is new.")
 	}
-	b := name + ".md"
+	b := fp + ".md"
 	t2, err := os.ReadFile(b)
 	if err != nil {
 		return template.HTML("Cannot read " + b + ", so the page was deleted.")

diff.html

@@ -6,7 +6,7 @@
     <meta name="viewport" content="width=device-width">
     <title>{{.Title}}</title>
     <style>
-html { max-width: 65ch; padding: 1ch; margin: auto; color: #111; background-color: #ffe; }
+html { max-width: 70ch; padding: 1ch; margin: auto; color: #111; background-color: #ffe; }
 body { hyphens: auto; }
 del  { background-color: #fab }
 ins  { background-color: #af8 }

edit.html

@@ -16,7 +16,7 @@ form, textarea { width: 100%; }
       <textarea name="body" rows="20" cols="80" placeholder="# Title
 
 Text" lang="" autofocus>{{printf "%s" .Body}}</textarea>
-      <p><label><input type="checkbox" name="notify" checked> Add link to <a href="/view/changes">the list of changes</a>.</label></p>
+      <p><label><input type="checkbox" name="notify" checked> Add link to <a href="changes">the list of changes</a>.</label></p>
       <p><input type="submit" value="Save">
         <a href="/view/{{.Name}}"><button type="button">Cancel</button></a></p>
     </form>

edit_save.go

@@ -5,10 +5,8 @@ import (
 	"net/http"
 )
 
-// editHandler uses the "edit.html" template to present an edit page.
-// When editing, the page title is not overriden by a title in the
-// text. Instead, the page name is used. The edit is saved using the
-// saveHandler.
+// editHandler uses the "edit.html" template to present an edit page. When editing, the page title is not overriden by a
+// title in the text. Instead, the page name is used. The edit is saved using the saveHandler.
 func editHandler(w http.ResponseWriter, r *http.Request, name string) {
 	p, err := loadPage(name)
 	if err != nil {
@@ -16,23 +14,31 @@ func editHandler(w http.ResponseWriter, r *http.Request, name string) {
 	} else {
 		p.handleTitle(false)
 	}
-	renderTemplate(w, "edit", p)
+	renderTemplate(w, p.Dir(), "edit", p)
 }
 
-// saveHandler takes the "body" form parameter and saves it. The
-// browser is redirected to the page view.
+// saveHandler takes the "body" form parameter and saves it. The browser is redirected to the page view. This is similar
+// to the appendHandler.
 func saveHandler(w http.ResponseWriter, r *http.Request, name string) {
 	body := r.FormValue("body")
 	p := &Page{Name: name, Body: []byte(body)}
 	err := p.save()
 	if err != nil {
+		log.Println(err)
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 		return
 	}
+	username, _, ok := r.BasicAuth()
+	if ok {
+		log.Println("Save", name, "by", username)
+	} else {
+		log.Println("Save", name)
+	}
 	if r.FormValue("notify") == "on" {
-		err = p.notify()
+		err = p.notify() // errors have already been logged, so no logging here
 		if err != nil {
-			log.Println("notify:", err)
+			http.Error(w, err.Error(), http.StatusInternalServerError)
+			return
 		}
 	}
 	http.Redirect(w, r, "/view/"+name, http.StatusFound)

edit_save_test.go

@@ -37,26 +37,40 @@ func TestEditSave(t *testing.T) {
 }
 
 func TestEditSaveChanges(t *testing.T) {
-	cleanup(t, "testdata/notification", "changes.md")
-	restore(t, "index.md")
-	os.Remove("changes.md")
+	cleanup(t, "testdata/notification")
 	data := url.Values{}
 	data.Set("body", "Hallo!")
 	data.Add("notify", "on")
+	today := time.Now().Format("2006-01-02")
 	// Posting to the save URL saves a page
 	HTTPRedirectTo(t, makeHandler(saveHandler, true),
-		"POST", "/save/testdata/notification/2023-10-28-alex",
-		data, "/view/testdata/notification/2023-10-28-alex")
+		"POST", "/save/testdata/notification/"+today,
+		data, "/view/testdata/notification/"+today)
 	// The changes.md file was created
-	s, err := os.ReadFile("changes.md")
+	s, err := os.ReadFile("testdata/notification/changes.md")
 	assert.NoError(t, err)
 	d := time.Now().Format(time.DateOnly)
 	assert.Equal(t, "# Changes\n\n## "+d+
-		"\n* [testdata/notification/2023-10-28-alex](testdata/notification/2023-10-28-alex)\n",
+		"\n* [testdata/notification/"+today+"]("+today+")\n",
 		string(s))
 	// Link added to index.md file
-	s, err = os.ReadFile("index.md")
+	s, err = os.ReadFile("testdata/notification/index.md")
 	assert.NoError(t, err)
-	assert.Contains(t, string(s),
-		"\n* [testdata/notification/2023-10-28-alex](testdata/notification/2023-10-28-alex)\n")
+	// New index contains just the link
+	assert.Equal(t, string(s), "* [testdata/notification/"+today+"]("+today+")\n")
+}
+
+// Test the following view.html:
+// <form action="/edit/" method="GET">
+//
+//	<label for="id">New page:</label>
+//	<input id="id" type="text" spellcheck="false" name="id" accesskey="g" value="{{.Dir}}/{{.Today}}" required>
+//	<button>Edit</button>
+//
+// </form>
+func TestEditId(t *testing.T) {
+	cleanup(t, "testdata/id")
+	assert.Contains(t, assert.HTTPBody(makeHandler(editHandler, true),
+		"GET", "/edit/?id=testdata/id/alex", nil),
+		"Editing testdata/id/alex")
 }

feed.go

@@ -7,6 +7,7 @@ import (
 	"html/template"
 	"os"
 	"path"
+	"path/filepath"
 	"time"
 )
 
@@ -46,7 +47,7 @@ func feed(p *Page, ti time.Time) *Feed {
 			return ast.GoToNext
 		}
 		name := path.Join(path.Dir(p.Name), string(link.Destination))
-		fi, err := os.Stat(name + ".md")
+		fi, err := os.Stat(filepath.FromSlash(name) + ".md")
 		if err != nil {
 			return ast.GoToNext
 		}

go.mod

@@ -6,20 +6,21 @@ require (
 	github.com/anthonynsimon/bild v0.13.0
 	github.com/bashdrew/goheif v0.0.0-20230406184952-7a08ca9c9bdd
 	github.com/charmbracelet/lipgloss v0.9.1
-	github.com/gomarkdown/markdown v0.0.0-20231115200524-a660076da3fd
+	github.com/gomarkdown/markdown v0.0.0-20231222211730-1d6d20845b47
 	github.com/google/subcommands v1.2.0
 	github.com/hexops/gotextdiff v1.0.3
 	github.com/microcosm-cc/bluemonday v1.0.26
 	github.com/pemistahl/lingua-go v1.4.0
 	github.com/sergi/go-diff v1.3.1
 	github.com/stretchr/testify v1.8.4
-	golang.org/x/exp v0.0.0-20231206192017-f3f8817b8deb
+	golang.org/x/exp v0.0.0-20240119083558-1b970713d09a
 )
 
 require (
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
 	github.com/aymerick/douceur v0.2.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/gorilla/css v1.0.1 // indirect
 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
@@ -27,12 +28,12 @@ require (
 	github.com/muesli/reflow v0.3.0 // indirect
 	github.com/muesli/termenv v0.15.2 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/rivo/uniseg v0.4.4 // indirect
+	github.com/rivo/uniseg v0.4.6 // indirect
 	github.com/rwcarlsen/goexif v0.0.0-20190401172101-9e8deecbddbd // indirect
 	github.com/shopspring/decimal v1.3.1 // indirect
-	golang.org/x/image v0.14.0 // indirect
-	golang.org/x/net v0.19.0 // indirect
-	golang.org/x/sys v0.15.0 // indirect
-	google.golang.org/protobuf v1.31.0 // indirect
+	golang.org/x/image v0.15.0 // indirect
+	golang.org/x/net v0.20.0 // indirect
+	golang.org/x/sys v0.16.0 // indirect
+	google.golang.org/protobuf v1.32.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -18,10 +18,10 @@ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
-github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
-github.com/gomarkdown/markdown v0.0.0-20231115200524-a660076da3fd h1:PppHBegd3uPZ3Y/Iax/2mlCFJm1w4Qf/zP1MdW4ju2o=
-github.com/gomarkdown/markdown v0.0.0-20231115200524-a660076da3fd/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA=
-github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=
+github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM=
+github.com/gomarkdown/markdown v0.0.0-20231222211730-1d6d20845b47 h1:k4Tw0nt6lwro3Uin8eqoET7MDA4JnT8YgbCjc/g5E3k=
+github.com/gomarkdown/markdown v0.0.0-20231222211730-1d6d20845b47/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA=
 github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
 github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/subcommands v1.2.0 h1:vWQspBTo2nEqTUFita5/KeEWlUL8kQObDFbub/EN9oE=
@@ -60,8 +60,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
-github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis=
-github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
+github.com/rivo/uniseg v0.4.6 h1:Sovz9sDSwbOz9tgUy8JpT+KgCkPYJEN/oYzlJiYTNLg=
+github.com/rivo/uniseg v0.4.6/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/rwcarlsen/goexif v0.0.0-20190401172101-9e8deecbddbd h1:CmH9+J6ZSsIjUK3dcGsnCnO41eRBOnY12zwkn5qVwgc=
 github.com/rwcarlsen/goexif v0.0.0-20190401172101-9e8deecbddbd/go.mod h1:hPqNNc0+uJM6H+SuU8sEs5K5IQeKccPqeSjfgcKGgPk=
@@ -83,22 +83,20 @@ github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXl
 github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
 github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
 golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
-golang.org/x/exp v0.0.0-20231206192017-f3f8817b8deb h1:c0vyKkb6yr3KR7jEfJaOSv4lG7xPkbN6r52aJz1d8a8=
-golang.org/x/exp v0.0.0-20231206192017-f3f8817b8deb/go.mod h1:iRJReGqOEeBhDZGkGbynYwcHlctCvnjTYIamk7uXpHI=
+golang.org/x/exp v0.0.0-20240119083558-1b970713d09a h1:Q8/wZp0KX97QFTc2ywcOE0YRjZPVIx+MXInMzdvQqcA=
+golang.org/x/exp v0.0.0-20240119083558-1b970713d09a/go.mod h1:idGWGoKP1toJGkd5/ig9ZLuPcZBC3ewk7SzmH0uou08=
 golang.org/x/image v0.0.0-20190703141733-d6a02ce849c9/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
-golang.org/x/image v0.14.0 h1:tNgSxAFe3jC4uYqvZdTr84SZoM1KfwdC9SKIFrLjFn4=
-golang.org/x/image v0.14.0/go.mod h1:HUYqC05R2ZcZ3ejNQsIHQDQiwWM4JBqmm6MKANTp4LE=
-golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
-golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
+golang.org/x/image v0.15.0 h1:kOELfmgrmJlw4Cdb7g/QGuB3CvDrXbqEIww/pNtNBm8=
+golang.org/x/image v0.15.0/go.mod h1:HUYqC05R2ZcZ3ejNQsIHQDQiwWM4JBqmm6MKANTp4LE=
+golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
+golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
 golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
-golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
+golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
-google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
-google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+google.golang.org/protobuf v1.32.0 h1:pPC6BG5ex8PDFnkbrGU3EixyhKcQ2aDuBS36lqK/C7I=
+google.golang.org/protobuf v1.32.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

html_cmd.go

@@ -16,8 +16,8 @@ type htmlCmd struct {
 func (*htmlCmd) Name() string     { return "html" }
 func (*htmlCmd) Synopsis() string { return "render a page as HTML" }
 func (*htmlCmd) Usage() string {
-	return `html [-view] <page name>:
-  Render a page as HTML.
+	return `html [-view] <page name> ...:
+  Render one or more pages as HTML.
 `
 }
 
@@ -36,13 +36,12 @@ func htmlCli(w io.Writer, useTemplate bool, args []string) subcommands.ExitStatu
 			fmt.Fprintf(os.Stderr, "Cannot load %s: %s\n", arg, err)
 			return subcommands.ExitFailure
 		}
-		initAccounts()
 		if useTemplate {
 			p.handleTitle(true)
 			p.renderHtml()
 			t := "view.html"
-			templates := loadTemplates()
-			err := templates.ExecuteTemplate(w, t, p)
+			loadTemplates()
+			err := templates.template[t].Execute(w, p)
 			if err != nil {
 				fmt.Fprintf(os.Stderr, "Cannot execute %s template for %s: %s\n", t, arg, err)
 				return subcommands.ExitFailure

index.go

@@ -36,15 +36,19 @@ type Index struct {
 
 var index Index
 
-// reset resets the Index. This assumes that the index is locked!
-func (idx *Index) reset() {
-	idx.token = nil
-	idx.documents = nil
-	idx.titles = nil
+func init() {
+	index.reset()
 }
 
-// addDocument adds the text as a new document. This assumes that the
-// index is locked!
+// reset the index. This assumes that the index is locked. It's useful for tests.
+func (idx *Index) reset() {
+	idx.next_id = 0
+	idx.token = make(map[string][]docid)
+	idx.documents = make(map[docid]string)
+	idx.titles = make(map[string]string)
+}
+
+// addDocument adds the text as a new document. This assumes that the index is locked!
 func (idx *Index) addDocument(text []byte) docid {
 	id := idx.next_id
 	idx.next_id++
@@ -53,7 +57,7 @@ func (idx *Index) addDocument(text []byte) docid {
 		// Don't add same ID more than once. Checking the last
 		// position of the []docid works because the id is
 		// always a new one, i.e. the last one, if at all.
-		if ids != nil && ids[len(ids)-1] == id {
+		if len(ids) > 0 && ids[len(ids)-1] == id {
 			continue
 		}
 		idx.token[token] = append(ids, id)
@@ -61,148 +65,124 @@ func (idx *Index) addDocument(text []byte) docid {
 	return id
 }
 
-// deleteDocument deletes the text as a new document. The id can no
-// longer be used. This assumes that the index is locked!
-func (idx *Index) deleteDocument(text []byte, id docid) {
-	for _, token := range hashtags(text) {
-		ids := index.token[token]
-		// Tokens can appear multiple times in a text but they
-		// can only be deleted once. deleted.
-		if ids == nil {
-			continue
-		}
-		// If the token appears only in this document, remove
-		// the whole entry.
+// deleteDocument deletes all references to the id. The id can no longer be used. This assumes that the index is locked.
+func (idx *Index) deleteDocument(id docid) {
+	// Looping through all tokens makes sense if there are few tokens (like hashtags). It doesn't make sense if the
+	// number of tokens is large (like for full-text search or a trigram index).
+	for token, ids := range idx.token {
+		// If the token appears only in this document, remove the whole entry.
 		if len(ids) == 1 && ids[0] == id {
-			delete(index.token, token)
+			delete(idx.token, token)
 			continue
 		}
 		// Otherwise, remove the token from the index.
 		i := sort.Search(len(ids), func(i int) bool { return ids[i] >= id })
 		if i != -1 && i < len(ids) && ids[i] == id {
 			copy(ids[i:], ids[i+1:])
-			index.token[token] = ids[:len(ids)-1]
+			idx.token[token] = ids[:len(ids)-1]
 			continue
 		}
-		// If none of the above, then our docid wasn't
-		// indexed. This shouldn't happen, either.
-		log.Printf("The index for token %s does not contain doc id %d", token, id)
 	}
-	delete(index.documents, id)
 }
 
-// add reads a file and adds it to the index. This must happen while
-// the idx is locked.
-func (idx *Index) add(path string, info fs.FileInfo, err error) error {
-	if err != nil {
-		return err
+// deletePageName determines the document id based on the page name and calls deleteDocument to delete all references.
+// This assumes that the index is unlocked.
+func (idx *Index) deletePageName(name string) {
+	idx.Lock()
+	defer idx.Unlock()
+	var id docid
+	// Reverse lookup! At least it's in memory.
+	for key, value := range idx.documents {
+		if value == name {
+			id = key
+			break
+		}
 	}
-	filename := path
-	if info.IsDir() || strings.HasPrefix(filename, ".") || !strings.HasSuffix(filename, ".md") {
-		return nil
+	if id != 0 {
+		idx.deleteDocument(id)
+		delete(idx.documents, id)
 	}
-	name := strings.TrimSuffix(filename, ".md")
-	p, err := loadPage(name)
-	if err != nil {
-		return err
-	}
-	p.handleTitle(false)
-
-	id := idx.addDocument(p.Body)
-	idx.documents[id] = p.Name
-	idx.titles[p.Name] = p.Title
-	return nil
+	delete(idx.titles, name)
 }
 
-// load loads all the pages and indexes them. This takes a while.
-// It returns the number of pages indexed.
+// remove the page from the index. Do this when deleting a page. This assumes that the index is unlocked.
+func (idx *Index) remove(p *Page) {
+	idx.deletePageName(p.Name)
+}
+
+// load loads all the pages and indexes them. This takes a while. It returns the number of pages indexed.
 func (idx *Index) load() (int, error) {
 	idx.Lock()
 	defer idx.Unlock()
-	idx.token = make(map[string][]docid)
-	idx.documents = make(map[docid]string)
-	idx.titles = make(map[string]string)
-	err := filepath.Walk(".", idx.add)
+	err := filepath.Walk(".", idx.walk)
 	if err != nil {
-		idx.reset()
 		return 0, err
 	}
 	n := len(idx.documents)
 	return n, nil
 }
 
-// dump prints the index to the log for debugging. Must already be readlocked.
+// walk reads a file and adds it to the index. This assumes that the index is locked.
+func (idx *Index) walk(path string, info fs.FileInfo, err error) error {
+	if err != nil {
+		return err
+	}
+	// skip hidden directories and files
+	if path != "." && strings.HasPrefix(filepath.Base(path), ".") {
+		if info.IsDir() {
+			return filepath.SkipDir
+		} else {
+			return nil
+		}
+	}
+	// skipp all but page files
+	if !strings.HasSuffix(path, ".md") {
+		return nil
+	}
+	p, err := loadPage(strings.TrimSuffix(path, ".md"))
+	if err != nil {
+		return err
+	}
+	p.handleTitle(false)
+	idx.addPage(p)
+	return nil
+}
+
+// addPage adds a page to the index. This assumes that the index is locked.
+func (idx *Index) addPage(p *Page) {
+	id := idx.addDocument(p.Body)
+	idx.documents[id] = p.Name
+	p.handleTitle(false)
+	idx.titles[p.Name] = p.Title
+}
+
+// add a page to the index. This assumes that the index is unlocked.
+func (idx *Index) add(p *Page) {
+	idx.Lock()
+	defer idx.Unlock()
+	idx.addPage(p)
+}
+
+// dump prints the index to the log for debugging.
 func (idx *Index) dump() {
-	index.RLock()
-	defer index.RUnlock()
+	idx.RLock()
+	defer idx.RUnlock()
 	for token, ids := range idx.token {
 		log.Printf("%s: %v", token, ids)
 	}
 }
 
-// updateIndex updates the index for a single page. The old text is
-// loaded from the disk and removed from the index first, if it
-// exists.
-func (p *Page) updateIndex() {
-	index.Lock()
-	defer index.Unlock()
-	var id docid
-	// Reverse lookup! At least it's in memory.
-	for docId, name := range index.documents {
-		if name == p.Name {
-			id = docId
-			break
-		}
-	}
-	if id == 0 {
-		id = index.addDocument(p.Body)
-		index.documents[id] = p.Name
-		index.titles[p.Name] = p.Title
-	} else {
-		if o, err := loadPage(p.Name); err == nil {
-			index.deleteDocument(o.Body, id)
-		}
-		// Do not reuse the old id. We need a new one for
-		// indexing to work.
-		id = index.addDocument(p.Body)
-		// The page name stays the same but the title may have
-		// changed.
-		index.documents[id] = p.Name
-		p.handleTitle(false)
-		index.titles[p.Name] = p.Title
-	}
-}
-
-// removeFromIndex removes the page from the index. Do this when
-// deleting a page.
-func (p *Page) removeFromIndex() {
-	index.Lock()
-	defer index.Unlock()
-	var id docid
-	// Reverse lookup! At least it's in memory.
-	for docId, name := range index.documents {
-		if name == p.Name {
-			id = docId
-			break
-		}
-	}
-	if id == 0 {
-		log.Printf("Page %s is not indexed", p.Name)
-		return
-	}
-	o, err := loadPage(p.Name)
-	if err != nil {
-		log.Printf("Page %s cannot removed from the index: %s", p.Name, err)
-		return
-	}
-	index.deleteDocument(o.Body, id)
+// updateIndex updates the index for a single page.
+func (idx *Index) update(p *Page) {
+	idx.remove(p)
+	idx.add(p)
 }
 
 // search searches the index for a query string and returns page
 // names.
 func (idx *Index) search(q string) []string {
-	index.RLock()
-	defer index.RUnlock()
+	idx.RLock()
+	defer idx.RUnlock()
 	names := make([]string, 0)
 	hashtags := hashtags([]byte(q))
 	if len(hashtags) > 0 {

index_test.go

@@ -6,11 +6,23 @@ import (
 	"testing"
 )
 
+func TestIndexAdd(t *testing.T) {
+	idx := &Index{}
+	idx.reset()
+	idx.Lock()
+	defer idx.Unlock()
+	tag := "#hello"
+	id := idx.addDocument([]byte("oh hi " + tag))
+	assert.Contains(t, idx.token, tag)
+	idx.deleteDocument(id)
+	assert.NotContains(t, idx.token, tag)
+}
+
 // TestIndex relies on README.md being indexed
 func TestIndex(t *testing.T) {
 	index.load()
 	q := "Oddµ"
-	pages, _ := search(q, "", 1, false)
+	pages, _ := search(q, "", "", 1, false)
 	assert.NotZero(t, len(pages))
 	for _, p := range pages {
 		assert.NotContains(t, p.Title, "<b>")
@@ -22,7 +34,7 @@ func TestIndex(t *testing.T) {
 func TestSearchHashtag(t *testing.T) {
 	index.load()
 	q := "#like_this"
-	pages, _ := search(q, "", 1, false)
+	pages, _ := search(q, "", "", 1, false)
 	assert.NotZero(t, len(pages))
 }
 
@@ -34,7 +46,7 @@ func TestIndexUpdates(t *testing.T) {
 	p.save()
 
 	// Find the phrase
-	pages, _ := search("This is a test", "", 1, false)
+	pages, _ := search("This is a test", "", "", 1, false)
 	found := false
 	for _, p := range pages {
 		if p.Name == name {
@@ -45,7 +57,7 @@ func TestIndexUpdates(t *testing.T) {
 	assert.True(t, found)
 
 	// Find the phrase, case insensitive
-	pages, _ = search("this is a test", "", 1, false)
+	pages, _ = search("this is a test", "", "", 1, false)
 	found = false
 	for _, p := range pages {
 		if p.Name == name {
@@ -56,7 +68,7 @@ func TestIndexUpdates(t *testing.T) {
 	assert.True(t, found)
 
 	// Find some words
-	pages, _ = search("this test", "", 1, false)
+	pages, _ = search("this test", "", "", 1, false)
 	found = false
 	for _, p := range pages {
 		if p.Name == name {
@@ -69,7 +81,7 @@ func TestIndexUpdates(t *testing.T) {
 	// Update the page and no longer find it with the old phrase
 	p = &Page{Name: name, Body: []byte("# New page\nGuvf vf n grfg.")}
 	p.save()
-	pages, _ = search("This is a test", "", 1, false)
+	pages, _ = search("This is a test", "", "", 1, false)
 	found = false
 	for _, p := range pages {
 		if p.Name == name {
@@ -80,7 +92,7 @@ func TestIndexUpdates(t *testing.T) {
 	assert.False(t, found)
 
 	// Find page using a new word
-	pages, _ = search("Guvf", "", 1, false)
+	pages, _ = search("Guvf", "", "", 1, false)
 	found = false
 	for _, p := range pages {
 		if p.Name == name {
@@ -93,5 +105,5 @@ func TestIndexUpdates(t *testing.T) {
 	// Make sure the title was updated
 	index.RLock()
 	defer index.RUnlock()
-	assert.Equal(t, index.titles[name], "New page")
+	assert.Equal(t, "New page", index.titles[name])
 }

languages.go

@@ -7,8 +7,7 @@ import (
 	"strings"
 )
 
-// getLangauges returns the environment variable ODDMU_LANGUAGES or
-// all languages.
+// getLanguages returns the environment variable ODDMU_LANGUAGES or all languages.
 func getLanguages() ([]lingua.Language, error) {
 	v := os.Getenv("ODDMU_LANGUAGES")
 	if v == "" {
@@ -29,8 +28,9 @@ func getLanguages() ([]lingua.Language, error) {
 // detector is the LanguageDetector initialized at startup by loadLanguages.
 var detector lingua.LanguageDetector
 
-// loadLanguages initializes the detector using the languages returned
-// by getLanguages and returns the number of languages loaded.
+// loadLanguages initializes the detector using the languages returned by getLanguages and returns the number of
+// languages loaded. If this is skipped, no language detection happens and the templates cannot use {{.Language}} to use
+// this. Usually this is used for correct hyphenation by the browser.
 func loadLanguages() int {
 	langs, err := getLanguages()
 	if err == nil {

list_cmd.go

@@ -50,10 +50,11 @@ func listCli(w io.Writer, dir string, args []string) subcommands.ExitStatus {
 	return subcommands.ExitSuccess
 }
 
-// checkDir returns an error if the directory doesn't exist. If if exists, it returns a copy ending in a slash.
-func checkDir (dir string) (string, error) {
+// checkDir returns an error if the directory doesn't exist. If if exists, it returns a copy ending in a slash suiteable
+// for substring matching of page names.
+func checkDir(dir string) (string, error) {
 	if dir != "" {
-		fi, err := os.Stat(dir)
+		fi, err := os.Stat(filepath.FromSlash(dir))
 		if err != nil {
 			fmt.Println(err)
 			return "", err
@@ -62,8 +63,7 @@ func checkDir (dir string) (string, error) {
 			fmt.Println("This is not a sub-directory:", dir)
 			return "", err
 		}
-		dir = filepath.ToSlash(dir);
-		if (!strings.HasSuffix(dir, "/")) {
+		if !strings.HasSuffix(dir, "/") {
 			dir += "/"
 		}
 	}

man/.gitignore

@@ -0,0 +1 @@
+*.md

man/Makefile

@@ -1,6 +1,35 @@
-docs: oddmu-apache.5 oddmu-html.1 oddmu-missing.1 oddmu-notify.1 \
-	oddmu-replace.1 oddmu-search.1 oddmu-search.7 oddmu-static.1 \
-	oddmu-list.1 oddmu-templates.5 oddmu.1 oddmu.5 oddmu.service.5
+TEXT=$(wildcard *.txt)
+MAN=$(patsubst %.txt,%,${TEXT})
+HTML=$(patsubst %.txt,%.html,${TEXT})
+MD=$(patsubst %.txt,%.md,${TEXT})
 
-oddmu%: oddmu%.txt
+man: ${MAN}
+
+%: %.txt
 	scdoc < $< > $@
+
+html: ${HTML}
+
+%.html: %
+	groff -mandoc -Dutf8 -Thtml $< | sed 's/<style type="text\/css">/<style type="text\/css">\n       body {font-family: mono; max-width: 80ch }/' > $@
+
+md: ${MD}
+
+%.md: %.txt
+	sed --regexp-extended \
+	  -e 's/\*([^*]+)\*/**\1**/g' \
+	  -e 's/_(oddmu[a-z.-]*)_\(([1-9])\)/[\1(\2)](\1.\2)/g' \
+	  -e 's/\b_([^_]+)_\b/*\1*/g' \
+	  -e 's/^#/##/' \
+	  -e 's/^([A-Z.-]*\([1-9]\))( ".*")?$$/# \1/' \
+	  < $< > $@
+
+upload: ${MD}
+	rsync --itemize-changes --archive *.md sibirocobombus:alexschroeder.ch/wiki/oddmu/
+	make clean
+
+clean:
+	rm --force ${HTML} ${MD}
+
+realclean: clean
+	rm --force ${MAN}

man/oddmu-apache.5

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-APACHE" "5" "2023-11-05"
+.TH "ODDMU-APACHE" "5" "2024-02-17"
 .PP
 .SH NAME
 .PP
@@ -15,6 +15,8 @@ oddmu-apache - how to setup Apache as a reverse proxy for Oddmu
 .PP
 The oddmu program serves the current working directory as a wiki on port 8080.\&
 This is an unpriviledged port so an ordinary user account can do this.\&
+Alternatively, you can reverse proxy HTTP over a Unix-domain socket,
+as shown later.\&
 .PP
 The best way to protect the wiki against vandalism and spam is to use a regular
 web server as reverse proxy.\& This page explains how to setup Apache on Debian to
@@ -26,25 +28,28 @@ HTTPS is not part of Oddmu.\& You probably want to configure this in your
 webserver.\& I guess you could use stunnel, too.\& If you'\&re using Apache, you can
 use "mod_md" to manage your domain.\&
 .PP
-In the example below, the site is configured in a file called
-"/etc/apache2/sites-available/500-transjovian.\&conf" and a link poins there from
+The examples below use the domain "transjovian.\&org" and the Apache installation
+is the one that comes with Debian.\&
+.PP
+The site itself is configured in a file called
+"/etc/apache2/sites-available/transjovian.\&conf" and a link points there from
 "/etc/apache2/sites-enabled".\& Create this link using \fIa2ensite\fR(1).\&
 .PP
 .nf
 .RS 4
 MDomain transjovian\&.org
 MDCertificateAgreement accepted
+ServerAdmin alex@alexschroeder\&.ch
 
 <VirtualHost *:80>
-    ServerName transjovian\&.org
-    RewriteEngine on
-    RewriteRule ^/(\&.*) https://%{HTTP_HOST}/$1 [redirect]
+  ServerName transjovian\&.org
+  Redirect "/" "https://transjovian\&.org/"
 </VirtualHost>
 <VirtualHost *:443>
-    ServerAdmin alex@alexschroeder\&.ch
-    ServerName transjovian\&.org
-    SSLEngine on
-    ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(\&.*))?$" "http://localhost:8080/$1"
+  ServerName transjovian\&.org
+  SSLEngine on
+  ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search|archive)/(\&.*))?$" 
+                 "http://localhost:8080/$1"
 </VirtualHost>
 .fi
 .RE
@@ -53,7 +58,7 @@ First, it manages the domain, getting the necessary certificates.\& It redirects
 regular HTTP traffic from port 80 to port 443.\& It turns on the SSL engine for
 port 443.\& It proxies the requests for Oddmu to port 8080.\& Importantly, it
 doesn'\&t send \fIall\fR the requests to Oddmu.\& This allows us to still host static
-files using the web server.\&
+files using the web server (see \fBServe static files\fR).\&
 .PP
 This is what happens:
 .PP
@@ -76,16 +81,135 @@ apachectl graceful
 .fi
 .RE
 .PP
-To serve both HTTP and HTTPS, don'\&t redirect from the first virtual host to the
-second – instead just proxy to the wiki like you did for the second virtual
-host: use a copy of the "ProxyPassMatch" directive instead of "RewriteEngine on"
-and "RewriteRule".\&
+In a situation where Apache acts as a reverse proxy, you can prevent some
+actions from being proxied.\& If you don'\&t want to allow strangers to make
+changes, search or archive the site, use a limited setup like the following:
+.PP
+.nf
+.RS 4
+MDomain transjovian\&.org
+MDCertificateAgreement accepted
+ServerAdmin alex@alexschroeder\&.ch
+
+<VirtualHost *:80>
+  ServerName transjovian\&.org
+  Redirect "/" "https://transjovian\&.org/"
+</VirtualHost>
+<VirtualHost *:443>
+  ServerName transjovian\&.org
+  SSLEngine on
+  ProxyPassMatch "^/(view/\&.*)?$" "http://localhost:8080/$1"
+</VirtualHost>
+.fi
+.RE
+.PP
+You'\&ll need to edit the source pages some other way.\& Edit them locally and
+upload them using rsync; edit them remotely using an editor that can do this;
+use SSHFS to mount the remote directory locally for editing; use \fIstunnel\fR(8) to
+access the remote wiki on the local port 8080 for editing.\& There are probably a
+lot more such options available.\& All of them have the drawback that they'\&re
+probably not easy to use when on a mobile phone.\&
+.PP
+.SS Allow HTTP for viewing
+.PP
+When looking at pages, you might want to allow HTTP since no password is
+required.\& Therefore, proxy the read-only requests from the virtual host on port
+80 to the wiki instead of redirecting them to port 443.\&
+.PP
+.nf
+.RS 4
+MDomain transjovian\&.org
+MDCertificateAgreement accepted
+ServerAdmin alex@alexschroeder\&.ch
+
+<VirtualHost *:80>
+  ServerName transjovian\&.org
+  ProxyPassMatch "^/((view|diff|search|archive)/(\&.*))?$" 
+                 "http://localhost:8080/$1"
+  RedirectMatch  "^/((edit|save|add|append|upload|drop)/(\&.*))?$" 
+                 "https://transjovian\&.org/$1"
+</VirtualHost>
+<VirtualHost *:443>
+  ServerName transjovian\&.org
+  SSLEngine on
+  ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search|archive)/(\&.*))?$" 
+                 "http://localhost:8080/$1"
+</VirtualHost>
+.fi
+.RE
+.PP
+.SS Using a Unix-domain Socket
+.PP
+Instead of having Oddmu listen on a TCP port, you can have it listen on a
+Unix-domain socket.\& This requires socket activation.\& An example of configuring
+the service is given in \fIoddmu.\&service(5)\fR.\&
+.PP
+To test just the unix domain socket, use \fIncat(1)\fR:
+.PP
+.nf
+.RS 4
+echo -e "GET /view/index HTTP/1\&.1rnHost: localhostrnrn" 
+  | ncat --unixsock /run/oddmu/oddmu\&.sock
+.fi
+.RE
+.PP
+On the Apache side, you can proxy to the socket directly.\& This sends all
+requests to the socket:
+.PP
+.nf
+.RS 4
+ProxyPass "/" "unix:/run/oddmu/oddmu\&.sock|http://localhost/"
+.fi
+.RE
+.PP
+Now, all traffic between the web server and the wiki goes over the socket at
+"/run/oddmu/oddmu.\&sock".\&
+.PP
+To test it on the command-line, use a tool like \fIcurl(1)\fR.\& Make sure to provide
+the correct servername!\&
+.PP
+.nf
+.RS 4
+curl http://transjovian\&.org/view/index
+.fi
+.RE
+.PP
+You probably want to serve some static files as well (see \fBServe static files\fR).\&
+In that case, you need to use the ProxyPassMatch directive.\&
+.PP
+.nf
+.RS 4
+ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search|archive)/(\&.*))?$" 
+               "unix:/run/oddmu/oddmu\&.sock|http://localhost/$1"
+.fi
+.RE
+.PP
+There'\&s a curious problem with this expression, however.\& If you use \fIcurl(1)\fR to
+get the root path, Apache hangs:
+.PP
+.nf
+.RS 4
+curl http://transjovian\&.org/
+.fi
+.RE
+.PP
+A workaround is to add the redirect manually and drop the question-mark:
+.PP
+.nf
+.RS 4
+RedirectMatch "^/$" "/view/index"
+ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search|archive)/(\&.*))$" 
+               "unix:/run/oddmu/oddmu\&.sock|http://localhost/$1"
+.fi
+.RE
+.PP
+If you know why this is happening, let me know.\&
 .PP
 .SS Access
 .PP
 Access control is not part of Oddmu.\& By default, the wiki is editable by all.\&
 This is most likely not what you want unless you'\&re running it stand-alone,
-unconnected to the Internet – a person memex on your laptop, for example.\&
+unconnected to the Internet – a personal memex on your laptop, for example.\&
 .PP
 The following instructions create user accounts with passwords just for Oddmu.\&
 These users are not real users on the web server and don'\&t have access to a
@@ -133,6 +257,41 @@ to your "<VirtualHost *:443>" section:
 .fi
 .RE
 .PP
+The way Oddmu handles subdirectories is that all files and directories are
+visible, except for "hidden" files and directories (whose name starts with a
+period).\& Specifically, do not rely on Apache to hide locations in subdirectories
+from public view.\& Search reveals the existence of these pages and produces an
+extract, even if users cannot follow the links.\& Archive links pack all the
+subdirectories, including locations you may have hidden from view using Apache.\&
+.PP
+If you to treat subdirectories as separate sites, you need to set the
+environment variable ODDMU_FILTER to a regular expression matching the those
+directories.\& If search starts in a directory that doesn'\&t match the regular
+expression, all directories matching the regular expression are excluded.\& See
+\fIoddmu-filter\fR(7).\&
+.PP
+In the following example, ODDMU_FILTER is set to "^secret/".\&
+.PP
+http://transjovian.\&org/search/index?\&q=something does not search the "secret/"
+directory and its subdirectories are excluded.\&
+.PP
+http://transjovian.\&org/search/secret/index?\&q=something searches just the
+"secret" directory and its subdirectories.\&
+.PP
+You need to configure the web server to prevent access to the "secret/"
+directory:
+.PP
+.nf
+.RS 4
+<LocationMatch "^/(edit|save|add|append|upload|drop|(view|search|archive)/secret)/">
+  AuthType Basic
+  AuthName "Password Required"
+  AuthUserFile /home/oddmu/\&.htpasswd
+  Require valid-user
+</LocationMatch>
+.fi
+.RE
+.PP
 .SS Serve static files
 .PP
 If you want to serve static files as well, add a document root to your webserver
@@ -143,15 +302,15 @@ data files are.\& Apache does not serve files such as ".\&htpasswd".\&
 .RS 4
 DocumentRoot /home/oddmu
 <Directory /home/oddmu>
-    Require all granted
+  Require all granted
 </Directory>
 .fi
 .RE
 .PP
 Make sure that none of the subdirectories look like the wiki paths "/view/",
-"/diff/", "/edit/", "/save/", "/add/", "/append/", "/upload/", "/drop/" or
-"/search/".\& For example, create a file called "robots.\&txt" containing the
-following, telling all robots that they'\&re not welcome.\&
+"/diff/", "/edit/", "/save/", "/add/", "/append/", "/upload/", "/drop/",
+"/search/" or "/archive/".\& For example, create a file called "robots.\&txt"
+containing the following, telling all robots that they'\&re not welcome.\&
 .PP
 .nf
 .RS 4
@@ -160,12 +319,34 @@ Disallow: /
 .fi
 .RE
 .PP
-You site now serves "/robots.\&txt" without interfering with the wiki, and without
-needing a wiki page.\&
+Your site now serves "/robots.\&txt" without interfering with the wiki, and
+without needing a wiki page.\&
 .PP
 Another option would be to create a CSS file and use it with a <link> element in
 all the templates instead of relying on the <style> element.\&
 .PP
+The "view.\&html" template would start as follows:
+.PP
+.nf
+.RS 4
+<!DOCTYPE html>
+<html lang="{{\&.Language}}">
+  <head>
+    <meta charset="utf-8">
+    <meta name="format-detection" content="telephone=no">
+    <meta name="viewport" content="width=device-width">
+    <title>{{\&.Title}}</title>
+    <link href="/css/oddmu-2023\&.css" rel="stylesheet" />
+    <link rel="alternate" type="application/rss+xml" title="Alex Schroeder: {{\&.Title}}" href="/view/{{\&.Name}}\&.rss" />
+  </head>
+…
+.fi
+.RE
+.PP
+In this case, "/css/oddmu-2023.\&css" would be the name of your stylesheet.\& If
+your document root is "/home/oddmu", then the filename of your stylesheet would
+have to be "/home/oddmu/css/oddmu-2023.\&css" for this to work.\&
+.PP
 .SS Different logins for different access rights
 .PP
 What if you have a site with various subdirectories and each subdirectory is for
@@ -185,8 +366,8 @@ This requires a valid login by the user "alex" or "berta":
 .PP
 .SS Private wikis
 .PP
-Based on the above, you can prevent people from \fIreading\fR the wiki.\& The
-"LocationMatch" must cover all the URLs in order to protect everything.\&
+Based on the above, you can prevent people from \fIreading\fR the wiki.\& The location
+must cover all the URLs in order to protect everything.\&
 .PP
 .nf
 .RS 4
@@ -209,7 +390,7 @@ such that ever domain acts as a reverse proxy to a different Oddmu instance.\&
 .PP
 .SH SEE ALSO
 .PP
-\fIoddmu\fR(1)
+\fIoddmu\fR(1), \fIoddmu-filter\fR(7)
 .PP
 "Apache Core Features".\&
 https://httpd.\&apache.\&org/docs/current/mod/core.\&html

man/oddmu-apache.5.txt

@@ -8,6 +8,8 @@ oddmu-apache - how to setup Apache as a reverse proxy for Oddmu
 
 The oddmu program serves the current working directory as a wiki on port 8080.
 This is an unpriviledged port so an ordinary user account can do this.
+Alternatively, you can reverse proxy HTTP over a Unix-domain socket,
+as shown later.
 
 The best way to protect the wiki against vandalism and spam is to use a regular
 web server as reverse proxy. This page explains how to setup Apache on Debian to
@@ -19,24 +21,27 @@ HTTPS is not part of Oddmu. You probably want to configure this in your
 webserver. I guess you could use stunnel, too. If you're using Apache, you can
 use "mod_md" to manage your domain.
 
-In the example below, the site is configured in a file called
-"/etc/apache2/sites-available/500-transjovian.conf" and a link poins there from
+The examples below use the domain "transjovian.org" and the Apache installation
+is the one that comes with Debian.
+
+The site itself is configured in a file called
+"/etc/apache2/sites-available/transjovian.conf" and a link points there from
 "/etc/apache2/sites-enabled". Create this link using _a2ensite_(1).
 
 ```
 MDomain transjovian.org
 MDCertificateAgreement accepted
+ServerAdmin alex@alexschroeder.ch
 
 <VirtualHost *:80>
-    ServerName transjovian.org
-    RewriteEngine on
-    RewriteRule ^/(.*) https://%{HTTP_HOST}/$1 [redirect]
+  ServerName transjovian.org
+  Redirect "/" "https://transjovian.org/"
 </VirtualHost>
 <VirtualHost *:443>
-    ServerAdmin alex@alexschroeder.ch
-    ServerName transjovian.org
-    SSLEngine on
-    ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search)/(.*))?$" "http://localhost:8080/$1"
+  ServerName transjovian.org
+  SSLEngine on
+  ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search|archive)/(.*))?$" \
+                 "http://localhost:8080/$1"
 </VirtualHost>
 ```
 
@@ -44,7 +49,7 @@ First, it manages the domain, getting the necessary certificates. It redirects
 regular HTTP traffic from port 80 to port 443. It turns on the SSL engine for
 port 443. It proxies the requests for Oddmu to port 8080. Importantly, it
 doesn't send _all_ the requests to Oddmu. This allows us to still host static
-files using the web server.
+files using the web server (see *Serve static files*).
 
 This is what happens:
 
@@ -59,16 +64,119 @@ Restart the server, gracefully:
 apachectl graceful
 ```
 
-To serve both HTTP and HTTPS, don't redirect from the first virtual host to the
-second – instead just proxy to the wiki like you did for the second virtual
-host: use a copy of the "ProxyPassMatch" directive instead of "RewriteEngine on"
-and "RewriteRule".
+In a situation where Apache acts as a reverse proxy, you can prevent some
+actions from being proxied. If you don't want to allow strangers to make
+changes, search or archive the site, use a limited setup like the following:
+
+```
+MDomain transjovian.org
+MDCertificateAgreement accepted
+ServerAdmin alex@alexschroeder.ch
+
+<VirtualHost *:80>
+  ServerName transjovian.org
+  Redirect "/" "https://transjovian.org/"
+</VirtualHost>
+<VirtualHost *:443>
+  ServerName transjovian.org
+  SSLEngine on
+  ProxyPassMatch "^/(view/.*)?$" "http://localhost:8080/$1"
+</VirtualHost>
+```
+
+You'll need to edit the source pages some other way. Edit them locally and
+upload them using rsync; edit them remotely using an editor that can do this;
+use SSHFS to mount the remote directory locally for editing; use _stunnel_(8) to
+access the remote wiki on the local port 8080 for editing. There are probably a
+lot more such options available. All of them have the drawback that they're
+probably not easy to use when on a mobile phone.
+
+## Allow HTTP for viewing
+
+When looking at pages, you might want to allow HTTP since no password is
+required. Therefore, proxy the read-only requests from the virtual host on port
+80 to the wiki instead of redirecting them to port 443.
+
+```
+MDomain transjovian.org
+MDCertificateAgreement accepted
+ServerAdmin alex@alexschroeder.ch
+
+<VirtualHost *:80>
+  ServerName transjovian.org
+  ProxyPassMatch "^/((view|diff|search|archive)/(.*))?$" \
+                 "http://localhost:8080/$1"
+  RedirectMatch  "^/((edit|save|add|append|upload|drop)/(.*))?$" \
+                 "https://transjovian.org/$1"
+</VirtualHost>
+<VirtualHost *:443>
+  ServerName transjovian.org
+  SSLEngine on
+  ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search|archive)/(.*))?$" \
+                 "http://localhost:8080/$1"
+</VirtualHost>
+```
+
+## Using a Unix-domain Socket
+
+Instead of having Oddmu listen on a TCP port, you can have it listen on a
+Unix-domain socket. This requires socket activation. An example of configuring
+the service is given in _oddmu.service(5)_.
+
+To test just the unix domain socket, use _ncat(1)_:
+
+```
+echo -e "GET /view/index HTTP/1.1\r\nHost: localhost\r\n\r\n" \
+  | ncat --unixsock /run/oddmu/oddmu.sock
+```
+
+On the Apache side, you can proxy to the socket directly. This sends all
+requests to the socket:
+
+```
+ProxyPass "/" "unix:/run/oddmu/oddmu.sock|http://localhost/"
+```
+
+Now, all traffic between the web server and the wiki goes over the socket at
+"/run/oddmu/oddmu.sock".
+
+To test it on the command-line, use a tool like _curl(1)_. Make sure to provide
+the correct servername!
+
+```
+curl http://transjovian.org/view/index
+```
+
+You probably want to serve some static files as well (see *Serve static files*).
+In that case, you need to use the ProxyPassMatch directive.
+
+```
+ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search|archive)/(.*))?$" \
+               "unix:/run/oddmu/oddmu.sock|http://localhost/$1"
+```
+
+There's a curious problem with this expression, however. If you use _curl(1)_ to
+get the root path, Apache hangs:
+
+```
+curl http://transjovian.org/
+```
+
+A workaround is to add the redirect manually and drop the question-mark:
+
+```
+RedirectMatch "^/$" "/view/index"
+ProxyPassMatch "^/((view|diff|edit|save|add|append|upload|drop|search|archive)/(.*))$" \
+               "unix:/run/oddmu/oddmu.sock|http://localhost/$1"
+```
+
+If you know why this is happening, let me know.
 
 ## Access
 
 Access control is not part of Oddmu. By default, the wiki is editable by all.
 This is most likely not what you want unless you're running it stand-alone,
-unconnected to the Internet – a person memex on your laptop, for example.
+unconnected to the Internet – a personal memex on your laptop, for example.
 
 The following instructions create user accounts with passwords just for Oddmu.
 These users are not real users on the web server and don't have access to a
@@ -108,6 +216,39 @@ to your "<VirtualHost \*:443>" section:
 </LocationMatch>
 ```
 
+The way Oddmu handles subdirectories is that all files and directories are
+visible, except for "hidden" files and directories (whose name starts with a
+period). Specifically, do not rely on Apache to hide locations in subdirectories
+from public view. Search reveals the existence of these pages and produces an
+extract, even if users cannot follow the links. Archive links pack all the
+subdirectories, including locations you may have hidden from view using Apache.
+
+If you to treat subdirectories as separate sites, you need to set the
+environment variable ODDMU_FILTER to a regular expression matching the those
+directories. If search starts in a directory that doesn't match the regular
+expression, all directories matching the regular expression are excluded. See
+_oddmu-filter_(7).
+
+In the following example, ODDMU_FILTER is set to "^secret/".
+
+http://transjovian.org/search/index?q=something does not search the "secret/"
+directory and its subdirectories are excluded.
+
+http://transjovian.org/search/secret/index?q=something searches just the
+"secret" directory and its subdirectories.
+
+You need to configure the web server to prevent access to the "secret/"
+directory:
+
+```
+<LocationMatch "^/(edit|save|add|append|upload|drop|(view|search|archive)/secret)/">
+  AuthType Basic
+  AuthName "Password Required"
+  AuthUserFile /home/oddmu/.htpasswd
+  Require valid-user
+</LocationMatch>
+```
+
 ## Serve static files
 
 If you want to serve static files as well, add a document root to your webserver
@@ -117,26 +258,46 @@ data files are. Apache does not serve files such as ".htpasswd".
 ```
 DocumentRoot /home/oddmu
 <Directory /home/oddmu>
-    Require all granted
+  Require all granted
 </Directory>
 ```
 
 Make sure that none of the subdirectories look like the wiki paths "/view/",
-"/diff/", "/edit/", "/save/", "/add/", "/append/", "/upload/", "/drop/" or
-"/search/". For example, create a file called "robots.txt" containing the
-following, telling all robots that they're not welcome.
+"/diff/", "/edit/", "/save/", "/add/", "/append/", "/upload/", "/drop/",
+"/search/" or "/archive/". For example, create a file called "robots.txt"
+containing the following, telling all robots that they're not welcome.
 
 ```
 User-agent: *
 Disallow: /
 ```
 
-You site now serves "/robots.txt" without interfering with the wiki, and without
-needing a wiki page.
+Your site now serves "/robots.txt" without interfering with the wiki, and
+without needing a wiki page.
 
 Another option would be to create a CSS file and use it with a <link> element in
 all the templates instead of relying on the <style> element.
 
+The "view.html" template would start as follows:
+
+```
+<!DOCTYPE html>
+<html lang="{{.Language}}">
+  <head>
+    <meta charset="utf-8">
+    <meta name="format-detection" content="telephone=no">
+    <meta name="viewport" content="width=device-width">
+    <title>{{.Title}}</title>
+    <link href="/css/oddmu-2023.css" rel="stylesheet" />
+    <link rel="alternate" type="application/rss+xml" title="Alex Schroeder: {{.Title}}" href="/view/{{.Name}}.rss" />
+  </head>
+…
+```
+
+In this case, "/css/oddmu-2023.css" would be the name of your stylesheet. If
+your document root is "/home/oddmu", then the filename of your stylesheet would
+have to be "/home/oddmu/css/oddmu-2023.css" for this to work.
+
 ## Different logins for different access rights
 
 What if you have a site with various subdirectories and each subdirectory is for
@@ -154,8 +315,8 @@ This requires a valid login by the user "alex" or "berta":
 
 ## Private wikis
 
-Based on the above, you can prevent people from _reading_ the wiki. The
-"LocationMatch" must cover all the URLs in order to protect everything.
+Based on the above, you can prevent people from _reading_ the wiki. The location
+must cover all the URLs in order to protect everything.
 
 ```
 <Location />
@@ -176,7 +337,7 @@ such that ever domain acts as a reverse proxy to a different Oddmu instance.
 
 # SEE ALSO
 
-_oddmu_(1)
+_oddmu_(1), _oddmu-filter_(7)
 
 "Apache Core Features".
 https://httpd.apache.org/docs/current/mod/core.html

man/oddmu-filter.7

@@ -0,0 +1,63 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-FILTER" "7" "2024-02-17"
+.PP
+.SH NAME
+.PP
+oddmu-filter - keeping subdirectories separate
+.PP
+.SH DESCRIPTION
+.PP
+There are actions such as searching and archiving that act on multiple pages,
+not just a single page.\& These actions walk the directory tree, including all
+subdirectories.\& In some cases, this is not desirable.\&
+.PP
+Sometimes, subdirectories are separate sites, like the sites of other projects
+or different people.\& Essentially, the subdirectory acts as a different site.\&
+Depending on how you think about it, you might not want to include those "sites"
+in searches or archives of the whole site.\&
+.PP
+What'\&s important in this situation is whether the visitor is looking at the
+"main site" (a page further up in the directory tree) or at a particular page in
+a "separate site".\&
+.PP
+Since directory tree actions always start in the directory the visitor is
+currenly looking at, directory tree actions starting in a "separate site"
+automatically act as expected.\& The action is limited to that subdirectory tree.\&
+.PP
+When visitors look at a page in the "main site", however, directory tree actions
+must skip any sub directories that are part of a "separate site".\&
+.PP
+The way to identify separate sates is via the environment variable ODDMU_FILTER.\&
+It'\&s value is a regular expression matching separate sites.\&
+.PP
+.SH EXAMPLES
+.PP
+"ODDMU_FILTER=^project/" means that a directory tree action outside the
+"project/" directory does not include pages in the "project/" directory.\&
+.PP
+In other words, http://localhost:8080/search/?\&q=oddmu skips any pages in
+"project/".\&
+.PP
+At the same time, http://localhost:8080/search/project/?\&q=oddmu works like it
+always does: search is limited to "project/" and its subdirectories.\&
+.PP
+.SH SECURITY
+.PP
+If the subdirectory is a private site, then you need to use ODDMU_FILTER to
+exclude it from directory tree actions in the main site, and you need to
+configure your web server such that it doesn'\&t allow visitors access to the
+directory tree without authentication.\& See \fIoddmu-apache\fR(5).\&
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1), \fIoddmu-search\fR(7), \fIoddmu-apache\fR(5)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-filter.7.txt

@@ -0,0 +1,56 @@
+ODDMU-FILTER(7)
+
+# NAME
+
+oddmu-filter - keeping subdirectories separate
+
+# DESCRIPTION
+
+There are actions such as searching and archiving that act on multiple pages,
+not just a single page. These actions walk the directory tree, including all
+subdirectories. In some cases, this is not desirable.
+
+Sometimes, subdirectories are separate sites, like the sites of other projects
+or different people. Essentially, the subdirectory acts as a different site.
+Depending on how you think about it, you might not want to include those "sites"
+in searches or archives of the whole site.
+
+What's important in this situation is whether the visitor is looking at the
+"main site" (a page further up in the directory tree) or at a particular page in
+a "separate site".
+
+Since directory tree actions always start in the directory the visitor is
+currenly looking at, directory tree actions starting in a "separate site"
+automatically act as expected. The action is limited to that subdirectory tree.
+
+When visitors look at a page in the "main site", however, directory tree actions
+must skip any sub directories that are part of a "separate site".
+
+The way to identify separate sates is via the environment variable ODDMU_FILTER.
+It's value is a regular expression matching separate sites.
+
+# EXAMPLES
+
+"ODDMU_FILTER=^project/" means that a directory tree action outside the
+"project/" directory does not include pages in the "project/" directory.
+
+In other words, http://localhost:8080/search/?q=oddmu skips any pages in
+"project/".
+
+At the same time, http://localhost:8080/search/project/?q=oddmu works like it
+always does: search is limited to "project/" and its subdirectories.
+
+# SECURITY
+
+If the subdirectory is a private site, then you need to use ODDMU_FILTER to
+exclude it from directory tree actions in the main site, and you need to
+configure your web server such that it doesn't allow visitors access to the
+directory tree without authentication. See _oddmu-apache_(5).
+
+# SEE ALSO
+
+_oddmu_(1), _oddmu-search_(7), _oddmu-apache_(5)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-html.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-HTML" "1" "2023-10-09"
+.TH "ODDMU-HTML" "1" "2024-02-17"
 .PP
 .SH NAME
 .PP

man/oddmu-list.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-LIST" "1" "2023-12-20"
+.TH "ODDMU-LIST" "1" "2024-02-17"
 .PP
 .SH NAME
 .PP

man/oddmu-missing.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-MISSING" "1" "2023-11-05"
+.TH "ODDMU-MISSING" "1" "2024-02-17"
 .PP
 .SH NAME
 .PP

man/oddmu-notify.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-NOTIFY" "1" "2023-11-06"
+.TH "ODDMU-NOTIFY" "1" "2024-02-17"
 .PP
 .SH NAME
 .PP
@@ -20,20 +20,22 @@ oddmu-notify - add links to changes.\&md, index.\&md, and hashtag pages
 The "notify" subcommand takes all the page names provided (without the ".\&md"
 extension) and adds links to it from other pages.\&
 .PP
-A new link is added to the \fBchanges\fR page if it doesn'\&t exist.\& The current date
-of the machine Oddmu is running on is used as the heading.\& If the requested link
-already exists on the changes page, it is moved up to the current date.\& If that
-leaves an old date without any links, that date heading is removed.\&
+A new link is added to the \fBchanges\fR page in the current directory if it doesn'\&t
+exist.\& The current date of the machine Oddmu is running on is used as the
+heading.\& If the requested link already exists on the changes page, it is moved
+up to the current date.\& If that leaves an old date without any links, that date
+heading is removed.\&
 .PP
 A page whose name starts with an ISO date (YYYY-MM-DD, e.\&g.\& "2023-10-28") is
 called a \fBblog\fR page.\&
 .PP
-A link is created from the \fBindex\fR page to blog pages if and only if the blog
-pages are from the current year.\& The idea is that the front page contains a lot
-of links to blog posts but eventually the blog post links are moved onto archive
-pages (one per year, for example), or simply deleted.\& As when editing older
-pages, links to those pages should not get added to the index as if those older
-pages were new again.\& A link on the changes page is enough.\&
+A link is created from the \fBindex\fR page in the current directory to blog pages
+if and only if the blog pages are from the current year.\& The idea is that the
+front page contains a lot of links to blog posts but eventually the blog post
+links are moved onto archive pages (one per year, for example), or simply
+deleted.\& As when editing older pages, links to those pages should not get added
+to the index as if those older pages were new again.\& A link on the changes page
+is enough.\&
 .PP
 For every \fBhashtag\fR used on the pages named, another link might be created.\& If a
 page named like the hashtag exists, a backlink is added to it.\& A hashtag
@@ -59,6 +61,44 @@ oddmu notify 2023-11-05-climate
 .fi
 .RE
 .PP
+The changes file might look as follows:
+.PP
+.nf
+.RS 4
+# Changes
+
+This page lists all the changes made to the wiki\&.
+
+## 2023-11-05
+
+* [Global warming](2023-11-05-climate)
+.fi
+.RE
+.PP
+The index file might look as follows:
+.PP
+.nf
+.RS 4
+# Blog
+
+This page links to all the blog posts\&.
+
+* [Global warming](2023-11-05-climate)
+.fi
+.RE
+.PP
+The hashtag file might look as follows:
+.PP
+.nf
+.RS 4
+# Climate
+
+This page links to all the blog posts tagged #Climate\&.
+
+* [Global warming](2023-11-05-climate)
+.fi
+.RE
+.PP
 .SH SEE ALSO
 .PP
 \fIoddmu\fR(1)

man/oddmu-notify.1.txt

@@ -13,20 +13,22 @@ oddmu-notify - add links to changes.md, index.md, and hashtag pages
 The "notify" subcommand takes all the page names provided (without the ".md"
 extension) and adds links to it from other pages.
 
-A new link is added to the *changes* page if it doesn't exist. The current date
-of the machine Oddmu is running on is used as the heading. If the requested link
-already exists on the changes page, it is moved up to the current date. If that
-leaves an old date without any links, that date heading is removed.
+A new link is added to the *changes* page in the current directory if it doesn't
+exist. The current date of the machine Oddmu is running on is used as the
+heading. If the requested link already exists on the changes page, it is moved
+up to the current date. If that leaves an old date without any links, that date
+heading is removed.
 
 A page whose name starts with an ISO date (YYYY-MM-DD, e.g. "2023-10-28") is
 called a *blog* page.
 
-A link is created from the *index* page to blog pages if and only if the blog
-pages are from the current year. The idea is that the front page contains a lot
-of links to blog posts but eventually the blog post links are moved onto archive
-pages (one per year, for example), or simply deleted. As when editing older
-pages, links to those pages should not get added to the index as if those older
-pages were new again. A link on the changes page is enough.
+A link is created from the *index* page in the current directory to blog pages
+if and only if the blog pages are from the current year. The idea is that the
+front page contains a lot of links to blog posts but eventually the blog post
+links are moved onto archive pages (one per year, for example), or simply
+deleted. As when editing older pages, links to those pages should not get added
+to the index as if those older pages were new again. A link on the changes page
+is enough.
 
 For every *hashtag* used on the pages named, another link might be created. If a
 page named like the hashtag exists, a backlink is added to it. A hashtag
@@ -50,6 +52,38 @@ it exists):
 oddmu notify 2023-11-05-climate
 ```
 
+The changes file might look as follows:
+
+```
+# Changes
+
+This page lists all the changes made to the wiki.
+
+## 2023-11-05
+
+* [Global warming](2023-11-05-climate)
+```
+
+The index file might look as follows:
+
+```
+# Blog
+
+This page links to all the blog posts.
+
+* [Global warming](2023-11-05-climate)
+```
+
+The hashtag file might look as follows:
+
+```
+# Climate
+
+This page links to all the blog posts tagged #Climate.
+
+* [Global warming](2023-11-05-climate)
+```
+
 # SEE ALSO
 
 _oddmu_(1)

man/oddmu-releases.7

@@ -0,0 +1,160 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-RELEASES" "7" "2024-02-17"
+.PP
+.SH NAME
+.PP
+oddmu-releases - what'\&s new in this releases?\&
+.PP
+.SH DESCRIPTION
+.PP
+This page lists user-visible features.\&
+.PP
+.SS 1.6 (unrelease)
+.PP
+Add \fIarchive\fR action to serve a zip file.\&
+.PP
+.SS 1.5 (2024)
+.PP
+Filtering separate sites in subdirectories via the ODDMU_FILTER environment
+variable in order to exclude them from the \fIsearch\fR action.\&
+.PP
+Add \fIversion\fR subcommand.\&
+.PP
+Add filesystem watchers to automatically reindex changed pages and reload
+changed templates.\&
+.PP
+When rendering a page, use templates in the same directory, if available.\&
+.PP
+Delete uploaded files by uploading a file with zero bytes.\&
+.PP
+.SS 1.4 (2024)
+.PP
+If stdin is a Unix-domain socket, use that to serve the site.\& Otherwise, allow
+specifying a listen address via the ODDMU_ADDRESS environment variable.\&
+.PP
+.SS 1.3 (2024)
+.PP
+Add support for resizing HEIC images (and saving them as JPG files).\&
+.PP
+.SS 1.2 (2023)
+.PP
+Add \fIlist\fR subcommand.\&
+.PP
+.SS 1.1 (2023)
+.PP
+Rewrote most of the README into man pages.\&
+.PP
+Add fediverse account rendering if ODDMU_WEBFINGER is set.\&
+.PP
+Add notifications when saving files: adding links to \fIindex\fR, \fIchanges\fR and
+\fIhashtag\fR pages.\&
+.PP
+Add \fIreplace\fR subcommand.\& Add \fImissing\fR subcommand.\& Add \fInotify\fR command.\& Add
+\fIstatic\fR command.\&
+.PP
+Add \fIdiff\fR action.\&
+.PP
+Add feed generation based on the local links from a page.\&
+.PP
+Add caching support by considering the If-Modified-Since header in requests and
+providing a Last-Modified header in responses.\&
+.PP
+Handle HEAD requests.\&
+.PP
+Remove HTML sanitization.\&
+.PP
+Remove MathJax support from the wiki parser.\& The templates never included the
+necessary MathJax JavaScript anyway so the special handling of $ was just an
+annoyance.\&
+.PP
+Drop trigram index and just search all the files.\& This takes much less RAM and
+doesn'\&t take too much time even with a few thousand pages.\&
+.PP
+Add "blog:true" and "blog:false" predicates to search.\&
+.PP
+Limit search to the current directory tree.\&
+.PP
+Do not overwrite fresh backups: there must be a 1h break before the backup is
+overwritten.\&
+.PP
+.SS 1.0 (2023)
+.PP
+Paginate search results and no longer sort search results by score.\&
+.PP
+.SS 0.9 (2023)
+.PP
+Add image resizing.\&
+.PP
+Add wiki links in double square brackets to the parser.\&
+.PP
+.SS 0.8 (2023)
+.PP
+Rename files to backups before saving.\&
+.PP
+Rename the \fIsaveUpload\fR action to \fIdrop\fR.\&
+.PP
+Add the \fIsearch\fR subcommand.\&
+.PP
+.SS 0.7 (2023)
+.PP
+Add \fIupload\fR and \fIsaveUpload\fR action so that one can upload files.\&
+.PP
+Add \fIhtml\fR subcommand.\&
+.PP
+.SS 0.6 (2003)
+.PP
+Add \fIadd\fR and \fIappend\fR action so that one can add to an existing page.\& This is
+important for me as editing pages on the phone can be cumbersome but leaving
+comments on my own site has always been easy to do.\&
+.PP
+Serve all existing files, not just text files.\&
+.PP
+Save an empty page to delete it.\&
+.PP
+Changed default permissions from 600 to 644 for files and from 700 to 755 for
+directories.\&
+.PP
+Make language detection configurable using an environment variable.\&
+.PP
+.SS 0.5 (2023)
+.PP
+Add hyphenation to templates using Peter M.\& Stahl'\&s Lingua library.\&
+.PP
+.SS 0.4 (2023)
+.PP
+Create subdirectories as necessary.\&
+.PP
+.SS 0.3 (2023)
+.PP
+Add \fIsearch\fR action using Damian Gryski'\&s trigram indexing, with scoring,
+highlighting and snippet extraction.\&
+.PP
+.SS 0.2 (2023)
+.PP
+Switch to Krzysztof Kowalczyk'\&s Go Markdown fork of Blackfriday to render
+Markdown.\& Use Dee'\&s Bluemonday to sanitize HTML.\&
+.PP
+Switch to GNU Affero GPL 3 license.\&
+.PP
+Serve text files (.\&txt).\&
+.PP
+Support serving on any port via the environment variable ODDMU_PORT.\&
+.PP
+.SS 0.1 (2015)
+.PP
+A web server that allows editing files in Wiki Creole Matt Self'\&s Cajun library.\&
+Supported actions are \fIedit\fR, \fIsave\fR, and \fIview\fR.\&
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-releases.7.txt

@@ -0,0 +1,157 @@
+ODDMU-RELEASES(7)
+
+# NAME
+
+oddmu-releases - what's new in this releases?
+
+# DESCRIPTION
+
+This page lists user-visible features.
+
+## Next
+
+
+
+## 1.6 (2024)
+
+Add _archive_ action to serve a zip file.
+
+## 1.5 (2024)
+
+Filtering separate sites in subdirectories via the ODDMU_FILTER environment
+variable in order to exclude them from the _search_ action.
+
+Add _version_ subcommand.
+
+Add filesystem watchers to automatically reindex changed pages and reload
+changed templates.
+
+When rendering a page, use templates in the same directory, if available.
+
+Delete uploaded files by uploading a file with zero bytes.
+
+## 1.4 (2024)
+
+If stdin is a Unix-domain socket, use that to serve the site. Otherwise, allow
+specifying a listen address via the ODDMU_ADDRESS environment variable.
+
+## 1.3 (2024)
+
+Add support for resizing HEIC images (and saving them as JPG files).
+
+## 1.2 (2023)
+
+Add _list_ subcommand.
+
+## 1.1 (2023)
+
+Rewrote most of the README into man pages.
+
+Add fediverse account rendering if ODDMU_WEBFINGER is set.
+
+Add notifications when saving files: adding links to _index_, _changes_ and
+_hashtag_ pages.
+
+Add _replace_ subcommand. Add _missing_ subcommand. Add _notify_ command. Add
+_static_ command.
+
+Add _diff_ action.
+
+Add feed generation based on the local links from a page.
+
+Add caching support by considering the If-Modified-Since header in requests and
+providing a Last-Modified header in responses.
+
+Handle HEAD requests.
+
+Remove HTML sanitization.
+
+Remove MathJax support from the wiki parser. The templates never included the
+necessary MathJax JavaScript anyway so the special handling of $ was just an
+annoyance.
+
+Drop trigram index and just search all the files. This takes much less RAM and
+doesn't take too much time even with a few thousand pages.
+
+Add "blog:true" and "blog:false" predicates to search.
+
+Limit search to the current directory tree.
+
+Do not overwrite fresh backups: there must be a 1h break before the backup is
+overwritten.
+
+## 1.0 (2023)
+
+Paginate search results and no longer sort search results by score.
+
+## 0.9 (2023)
+
+Add image resizing.
+
+Add wiki links in double square brackets to the parser.
+
+## 0.8 (2023)
+
+Rename files to backups before saving.
+
+Rename the _saveUpload_ action to _drop_.
+
+Add the _search_ subcommand.
+
+## 0.7 (2023)
+
+Add _upload_ and _saveUpload_ action so that one can upload files.
+
+Add _html_ subcommand.
+
+## 0.6 (2003)
+
+Add _add_ and _append_ action so that one can add to an existing page. This is
+important for me as editing pages on the phone can be cumbersome but leaving
+comments on my own site has always been easy to do.
+
+Serve all existing files, not just text files.
+
+Save an empty page to delete it.
+
+Changed default permissions from 600 to 644 for files and from 700 to 755 for
+directories.
+
+Make language detection configurable using an environment variable.
+
+## 0.5 (2023)
+
+Add hyphenation to templates using Peter M. Stahl's Lingua library.
+
+## 0.4 (2023)
+
+Create subdirectories as necessary.
+
+## 0.3 (2023)
+
+Add _search_ action using Damian Gryski's trigram indexing, with scoring,
+highlighting and snippet extraction.
+
+## 0.2 (2023)
+
+Switch to Krzysztof Kowalczyk's Go Markdown fork of Blackfriday to render
+Markdown. Use Dee's Bluemonday to sanitize HTML.
+
+Switch to GNU Affero GPL 3 license.
+
+Serve text files (.txt).
+
+Support serving on any port via the environment variable ODDMU_PORT.
+
+## 0.1 (2015)
+
+A web server that allows editing files in Wiki Creole Matt Self's Cajun library.
+Supported actions are _edit_, _save_, and _view_.
+
+# SEE ALSO
+
+_oddmu_(1)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu-replace.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-REPLACE" "1" "2023-11-24"
+.TH "ODDMU-REPLACE" "1" "2024-02-17"
 .PP
 .SH NAME
 .PP

man/oddmu-search.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-SEARCH" "1" "2023-12-20"
+.TH "ODDMU-SEARCH" "1" "2024-02-17"
 .PP
 .SH NAME
 .PP

man/oddmu-search.7

@@ -1,20 +1,16 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-SEARCH" "7" "2023-10-28"
+.TH "ODDMU-SEARCH" "7" "2024-02-17"
 .PP
 .SH NAME
 .PP
 oddmu-search - understanding the Oddmu search engine
 .PP
-.SH SYNOPSIS
-.PP
-\fBoddmu search\fR \fIterms\fR.\&.\&.\&
-.PP
 .SH DESCRIPTION
 .PP
 The wiki keeps an index of all the hash tags and page titles in memory.\& Using
@@ -89,9 +85,22 @@ A document with content "This is a test" when searched with the phrase "this
 test" therefore gets a score of 8: the entire phrase does not match but each
 word gets four points.\&
 .PP
+.SH ENVIRONMENT
+.PP
+To exclude subdirectories from searches, use the ODDMU_FILTER environment
+variable.\& Set it to a regular expression matching sub-directories such as
+"^projects/".\& If search starts in a directory matching the regular expression,
+it is limited to the directory tree, as always.\& However, if search starts in a
+directory that doesn'\&t match, subdirectories that do match are skipped.\& See
+\fIoddmu-filter\fR(7).\&
+.PP
+To prevent access to a private directory tree, you must configure the web server
+in addition to setting the ODDMU_FILTER environment variable.\& See
+\fIoddmu-apache\fR(5) for more.\&
+.PP
 .SH SEE ALSO
 .PP
-\fIoddmu\fR(1), \fIoddmu-search\fR(1)
+\fIoddmu\fR(1), \fIoddmu-search\fR(1), \fIoddmu-filter\fR(7), \fIoddmu-apache\fR(5)
 .PP
 .SH AUTHORS
 .PP

man/oddmu-search.7.txt

@@ -4,10 +4,6 @@ ODDMU-SEARCH(7)
 
 oddmu-search - understanding the Oddmu search engine
 
-# SYNOPSIS
-
-*oddmu search* _terms_...
-
 # DESCRIPTION
 
 The wiki keeps an index of all the hash tags and page titles in memory. Using
@@ -69,9 +65,22 @@ A document with content "This is a test" when searched with the phrase "this
 test" therefore gets a score of 8: the entire phrase does not match but each
 word gets four points.
 
+# ENVIRONMENT
+
+To exclude subdirectories from searches, use the ODDMU_FILTER environment
+variable. Set it to a regular expression matching sub-directories such as
+"^projects/". If search starts in a directory matching the regular expression,
+it is limited to the directory tree, as always. However, if search starts in a
+directory that doesn't match, subdirectories that do match are skipped. See
+_oddmu-filter_(7).
+
+To prevent access to a private directory tree, you must configure the web server
+in addition to setting the ODDMU_FILTER environment variable. See
+_oddmu-apache_(5) for more.
+
 # SEE ALSO
 
-_oddmu_(1), _oddmu-search_(1)
+_oddmu_(1), _oddmu-search_(1), _oddmu-filter_(7), _oddmu-apache_(5)
 
 # AUTHORS
 

man/oddmu-static.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-STATIC" "1" "2023-11-05"
+.TH "ODDMU-STATIC" "1" "2024-02-17"
 .PP
 .SH NAME
 .PP
@@ -18,8 +18,8 @@ oddmu-static - create a static copy of the site
 .SH DESCRIPTION
 .PP
 The "static" subcommand generates a static copy of the pages in the current
-directory and saves them in the given target directory.\& The target directory
-must not exist to unser no existing files are clobbered.\&
+directory and saves them in the given destination directory.\& The destination
+directory must not exist.\&
 .PP
 All pages (files with the ".\&md" extension) are turned into HTML files (with the
 ".\&html" extension) using the "static.\&html" template.\& Links pointing to existing
@@ -28,7 +28,23 @@ pages get ".\&html" appended.\&
 Hidden files and directories (starting with a ".\&") and backup files (ending with
 a "~") are skipped.\&
 .PP
-All other files are \fIlinked\fR into the same directory.\&
+All other files are \fIhard linked\fR.\& This is done to save space: on a typical blog
+the images take a lot more space than the text.\& On my blog in 2023 I had 2.\&62
+GiB of JPG files and 0.\&02 GiB of Markdown files.\& There is no point in copying
+all those images, most of the time.\&
+.PP
+Note, however: Hard links cannot span filesystems.\& A hard link is just an extra
+name for the same file.\& This is why the destination directory for the static
+site has to be on same filesystem as the current directory, if it contains any
+other files besides Markdown files.\&
+.PP
+Furthermore, in-place editing changes the file for all names.\& Avoid editing the
+hard-linked files (anything that'\&s not a HTML file) in the destination
+directory, just to be on the safe side.\& Usually you should be fine, as an editor
+moves the file that'\&s being edited to a backup file and creates a new file.\& But
+then again, who knows.\& A SQLite file, for example, would change in-place, and
+therefore making changes to it in the destination directory would change the
+original, too.\&
 .PP
 .SH EXAMPLE
 .PP
@@ -51,7 +67,14 @@ you to migrate static folders and applications.\&
 .SH ENVIRONMENT
 .PP
 The ODDMU_WEBFINGER environment variable has no effect in this situation.\&
-Fediverse accounts are not linked to their profile pages.\&
+Fediverse accounts are not linked to their profile pages.\& Since the data isn'\&t
+cached, every run of this command would trigger a webfinger request for every
+fediverse account mentioned.\&
+.PP
+If the site is large, determining the language of a page slows things down.\& Set
+the ODDMU_LANGUAGES environment variable to a comma-separated list of ISO 639-1
+codes, e.\&g.\& "en" or "en,de,fr,pt" to limit the languages loaded and thereby
+speed language determination up.\&
 .PP
 .SH SEE ALSO
 .PP

man/oddmu-static.1.txt

@@ -11,8 +11,8 @@ oddmu-static - create a static copy of the site
 # DESCRIPTION
 
 The "static" subcommand generates a static copy of the pages in the current
-directory and saves them in the given target directory. The target directory
-must not exist to unser no existing files are clobbered.
+directory and saves them in the given destination directory. The destination
+directory must not exist.
 
 All pages (files with the ".md" extension) are turned into HTML files (with the
 ".html" extension) using the "static.html" template. Links pointing to existing
@@ -21,7 +21,23 @@ pages get ".html" appended.
 Hidden files and directories (starting with a ".") and backup files (ending with
 a "~") are skipped.
 
-All other files are _linked_ into the same directory.
+All other files are _hard linked_. This is done to save space: on a typical blog
+the images take a lot more space than the text. On my blog in 2023 I had 2.62
+GiB of JPG files and 0.02 GiB of Markdown files. There is no point in copying
+all those images, most of the time.
+
+Note, however: Hard links cannot span filesystems. A hard link is just an extra
+name for the same file. This is why the destination directory for the static
+site has to be on same filesystem as the current directory, if it contains any
+other files besides Markdown files.
+
+Furthermore, in-place editing changes the file for all names. Avoid editing the
+hard-linked files (anything that's not a HTML file) in the destination
+directory, just to be on the safe side. Usually you should be fine, as an editor
+moves the file that's being edited to a backup file and creates a new file. But
+then again, who knows. A SQLite file, for example, would change in-place, and
+therefore making changes to it in the destination directory would change the
+original, too.
 
 # EXAMPLE
 
@@ -42,7 +58,14 @@ you to migrate static folders and applications.
 # ENVIRONMENT
 
 The ODDMU_WEBFINGER environment variable has no effect in this situation.
-Fediverse accounts are not linked to their profile pages.
+Fediverse accounts are not linked to their profile pages. Since the data isn't
+cached, every run of this command would trigger a webfinger request for every
+fediverse account mentioned.
+
+If the site is large, determining the language of a page slows things down. Set
+the ODDMU_LANGUAGES environment variable to a comma-separated list of ISO 639-1
+codes, e.g. "en" or "en,de,fr,pt" to limit the languages loaded and thereby
+speed language determination up.
 
 # SEE ALSO
 

man/oddmu-templates.5

@@ -1,16 +1,22 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU-TEMPLATES" "5" "2023-10-29" "File Formats Manual"
+.TH "ODDMU-TEMPLATES" "5" "2024-02-17" "File Formats Manual"
 .PP
 .SH NAME
 .PP
 oddmu-templates - how to write the templates
 .PP
+.SH SYNOPSIS
+.PP
+These files act as HTML templates: add.\&html, diff.\&html, edit.\&html, feed.\&html,
+search.\&html, static.\&html, upload.\&html and view.\&html.\& They contain special
+placeholders in double bracers {{like this}}.\&
+.PP
 .SH SYNTAX
 .PP
 The templates can refer to the following properties of a page:
@@ -24,6 +30,9 @@ extension.\&
 .PP
 \fI{{.\&Dir}}\fR is the page directory, percent-escaped except for the slashes.\&
 .PP
+\fI{{.\&Base}}\fR is the basename of the current file (without the directory and
+without the \fI.\&md\fR extension), escaped for use in URLs.\&
+.PP
 \fI{{.\&Today}}\fR is the current date, in ISO format.\& This is useful for "new page"
 like links or forms (see \fBEXAMPLE\fR below).\&
 .PP
@@ -90,25 +99,6 @@ For items in the feed:
 .PP
 The \fIupload.\&html\fR template cannot refer to anything.\&
 .PP
-When calling the \fIsave\fR and \fIappend\fR action, the page name is taken from the URL
-path and the page content is taken from the \fIbody\fR form parameter.\& To
-illustrate, here'\&s how to edit the "welcome" page using \fIcurl\fR:
-.PP
-.nf
-.RS 4
-curl --form body="Did you bring a towel?" 
-  http://localhost:8080/save/welcome
-.fi
-.RE
-.PP
-When calling the \fIsearch\fR action, the query is taken from the URL parameter \fIq\fR.\&
-.PP
-.nf
-.RS 4
-curl http://localhost:8080/search/?q=towel
-.fi
-.RE
-.PP
 .SS Non-English hyphenation
 .PP
 Automatic hyphenation by the browser requires two things: The style sheet must
@@ -159,16 +149,22 @@ The following form allows people to edit the suggested page name.\&
 .PP
 .SH NOTES
 .PP
-The template are always used as-is, irrespective of the current directory.\&
+The templates are always used as-is, irrespective of the current directory.\&
 Therefore, a link to a specific page must be \fIabsolute\fR or it'\&ll point to a
 different page depending on the current directory.\&
 .PP
 Consider the link to "/view/index".\& No matter what page a visitor is looking,
 this takes visitors to the top "index" page.\& If the link points to "index"
-instead, it takes a visitor to the "index" page of the current directory.\&
+instead, it takes a visitor to the "index" page of the current directory.\& In
+this case, a visitor looking at "/view/projects/wiki" following a link to
+"index" ends up on "/view/projects/index", not on "/view/index".\&
 .PP
-Example: If a visitor is looking at "/view/projects/wiki" and follows a link to
-"index", they end up on "/view/projects/index", not on "/view/index".\&
+It'\&s up to you to decide what'\&s best for your site, of course.\&
+.PP
+Templates can be changed by uploading new copies of the template files.\&
+.PP
+Subdirectories can have their own copies of template files.\& One example use for
+this is that they can point to a different CSS file.\&
 .PP
 .SH SEE ALSO
 .PP

man/oddmu-templates.5.txt

@@ -4,6 +4,12 @@ ODDMU-TEMPLATES(5) "File Formats Manual"
 
 oddmu-templates - how to write the templates
 
+# SYNOPSIS
+
+These files act as HTML templates: add.html, diff.html, edit.html, feed.html,
+search.html, static.html, upload.html and view.html. They contain special
+placeholders in double bracers {{like this}}.
+
 # SYNTAX
 
 The templates can refer to the following properties of a page:
@@ -17,6 +23,9 @@ extension.
 
 _{{.Dir}}_ is the page directory, percent-escaped except for the slashes.
 
+_{{.Base}}_ is the basename of the current file (without the directory and
+without the _.md_ extension), escaped for use in URLs.
+
 _{{.Today}}_ is the current date, in ISO format. This is useful for "new page"
 like links or forms (see *EXAMPLE* below).
 
@@ -83,21 +92,6 @@ _{{.Date}}_, the date of the last update to this page, in RFC 822 format.
 
 The _upload.html_ template cannot refer to anything.
 
-When calling the _save_ and _append_ action, the page name is taken from the URL
-path and the page content is taken from the _body_ form parameter. To
-illustrate, here's how to edit the "welcome" page using _curl_:
-
-```
-curl --form body="Did you bring a towel?" \
-  http://localhost:8080/save/welcome
-```
-
-When calling the _search_ action, the query is taken from the URL parameter _q_.
-
-```
-curl http://localhost:8080/search/?q=towel
-```
-
 ## Non-English hyphenation
 
 Automatic hyphenation by the browser requires two things: The style sheet must
@@ -144,16 +138,22 @@ The following form allows people to edit the suggested page name.
 
 # NOTES
 
-The template are always used as-is, irrespective of the current directory.
+The templates are always used as-is, irrespective of the current directory.
 Therefore, a link to a specific page must be _absolute_ or it'll point to a
 different page depending on the current directory.
 
 Consider the link to "/view/index". No matter what page a visitor is looking,
 this takes visitors to the top "index" page. If the link points to "index"
-instead, it takes a visitor to the "index" page of the current directory.
+instead, it takes a visitor to the "index" page of the current directory. In
+this case, a visitor looking at "/view/projects/wiki" following a link to
+"index" ends up on "/view/projects/index", not on "/view/index".
 
-Example: If a visitor is looking at "/view/projects/wiki" and follows a link to
-"index", they end up on "/view/projects/index", not on "/view/index".
+It's up to you to decide what's best for your site, of course.
+
+Templates can be changed by uploading new copies of the template files.
+
+Subdirectories can have their own copies of template files. One example use for
+this is that they can point to a different CSS file.
 
 # SEE ALSO
 

man/oddmu-version.1

@@ -0,0 +1,38 @@
+.\" Generated by scdoc 1.11.3
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "ODDMU-VERSION" "1" "2024-02-17"
+.PP
+.SH NAME
+.PP
+oddmu-version - print build info on the command-line
+.PP
+.SH SYNOPSIS
+.PP
+\fBoddmu version\fR
+.PP
+.SH DESCRIPTION
+.PP
+The "version" subcommand prints a lot of stuff used to build the binary,
+including the git revision, git repository, versions of dependencies used and
+more.\&
+.PP
+It'\&s the equivalent of running this:
+.PP
+.nf
+.RS 4
+go version -m oddmu
+.fi
+.RE
+.PP
+.SH SEE ALSO
+.PP
+\fIoddmu\fR(1)
+.PP
+.SH AUTHORS
+.PP
+Maintained by Alex Schroeder <alex@gnu.\&org>.\&

man/oddmu-version.1.txt

@@ -0,0 +1,29 @@
+ODDMU-VERSION(1)
+
+# NAME
+
+oddmu-version - print build info on the command-line
+
+# SYNOPSIS
+
+*oddmu version*
+
+# DESCRIPTION
+
+The "version" subcommand prints a lot of stuff used to build the binary,
+including the git revision, git repository, versions of dependencies used and
+more.
+
+It's the equivalent of running this:
+
+```
+go version -m oddmu
+```
+
+# SEE ALSO
+
+_oddmu_(1)
+
+# AUTHORS
+
+Maintained by Alex Schroeder <alex@gnu.org>.

man/oddmu.1

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU" "1" "2023-12-17"
+.TH "ODDMU" "1" "2024-02-17"
 .PP
 .SH NAME
 .PP
@@ -19,14 +19,21 @@ Oddmu is sometimes written Oddµ because µ is the letter mu.\&
 .PP
 .SH DESCRIPTION
 .PP
-The oddmu program serves the current working directory as a wiki on port 8080.\&
-Point your browser to http://localhost:8080/ to get started.\& This is equivalent
-to http://localhost:8080/view/index – the first page you'\&ll create, most likely.\&
+Oddmu can be used as a static site generator, turning Markdown files into HTML
+files, or it can be used as a public or a private wiki server.\& If it runs as a
+public wiki server, a regular webserver should be used as reverse proxy.\&
 .PP
-If you request a page that doesn'\&t exist, oddmu tries to find a matching
+Run Oddmu without any arguments to serve the current working directory as a wiki
+on port 8080.\& Point your browser to http://localhost:8080/ to use it.\& This
+redirects you to http://localhost:8080/view/index – the first page you'\&ll
+create, most likely.\&
+.PP
+See \fIoddmu\fR(5) for details about the page formatting.\&
+.PP
+If you request a page that doesn'\&t exist, Oddmu tries to find a matching
 Markdown file by appending the extension ".\&md" to the page name.\& In the example
-above, the page name requested is "index" and the file name oddmu tries to read
-is "index.\&md".\& If no such file exists, oddmu offers you to create the page.\&
+above, the page name requested is "index" and the file name Oddmu tries to read
+is "index.\&md".\& If no such file exists, Oddmu offers you to create the page.\&
 .PP
 If your files don'\&t provide their own title ("# title"), the file name (without
 ".\&md") is used for the page title.\&
@@ -37,22 +44,126 @@ feed items are based on links in bullet lists using the asterix
 .PP
 Subdirectories are created as necessary.\&
 .PP
-See \fIoddmu\fR(5) for details about the page formatting.\&
+The wiki knows the following actions for a given page name and (optional)
+directory:
+.PP
+.PD 0
+.IP \(bu 4
+\fI/\fR redirects to /view/index
+.IP \(bu 4
+\fI/view/dir/\fR redirects to /view/dir/index
+.IP \(bu 4
+\fI/view/dir/name\fR shows a page
+.IP \(bu 4
+\fI/view/dir/name.\&md\fR shows the source text of a page
+.IP \(bu 4
+\fI/view/dir/name.\&rss\fR shows  the RSS feed for the pages linked
+.IP \(bu 4
+\fI/diff/dir/name\fR shows the last change to a page
+.IP \(bu 4
+\fI/edit/dir/name\fR shows a form to edit a page
+.IP \(bu 4
+\fI/save/dir/name\fR saves an edit
+.IP \(bu 4
+\fI/add/dir/name\fR shows a form to add to a page
+.IP \(bu 4
+\fI/append/dir/name\fR appends an addition to a page
+.IP \(bu 4
+\fI/upload/dir/name\fR shows a form to upload a file
+.IP \(bu 4
+\fI/drop/dir/name\fR saves an upload
+.IP \(bu 4
+\fI/search/dir/?\&q=term\fR to search for a term
+.IP \(bu 4
+\fI/archive/dir/name.\&zip\fR to download a zip file of a directory
+.PD
+.PP
+When calling the \fIsave\fR and \fIappend\fR action, the page name is taken from the URL
+path and the page content is taken from the \fIbody\fR form parameter.\& To
+illustrate, here'\&s how to edit the "welcome" page using \fIcurl\fR:
+.PP
+.nf
+.RS 4
+curl --form body="Did you bring a towel?" 
+  http://localhost:8080/save/welcome
+.fi
+.RE
+.PP
+When calling the \fIdrop\fR action, the query parameters used are \fIname\fR for the
+target filename, \fIfile\fR for the file to upload.\& If the query parameter
+\fImaxwidth\fR is set, an attempt is made to decode and resize the image.\& JPG, PNG
+and HEIC files can be decoded.\& Only JPG and PNG files can be encoded, however.\&
+If the target name ends in \fI.\&jpg\fR, the \fIquality\fR query parameter is also taken
+into account.\& To upload some thumbnails:
+.PP
+.nf
+.RS 4
+for f in *\&.jpg; do
+  curl --form name="$f" --form file=@"$f" --form maxwidth=100 
+    http://localhost:8080/drop/
+done
+.fi
+.RE
+.PP
+When calling the \fIsearch\fR action, the search terms are taken from the query
+parameter \fIq\fR.\&
+.PP
+.nf
+.RS 4
+curl \&'http://localhost:8080/search/?q=towel\&'
+.fi
+.RE
+.PP
+The page name to act upon is optionally taken from the query parameter \fIid\fR.\& In
+this case, the directory must also be part of the query parameter and not of the
+URL path.\&
+.PP
+.nf
+.RS 4
+curl \&'http://localhost:8080/view/?id=man/oddmu\&.1\&.txt\&'
+.fi
+.RE
+.PP
+The base name for the \fIarchive\fR action is used by the browser to save the
+downloaded file.\& For Oddmu, only the directory is important.\& The following zips
+the \fIman\fR directory and saves it as \fIman.\&zip\fR.\&
+.PP
+.nf
+.RS 4
+curl --remote-name \&'http://localhost:8080/archive/man/man\&.zip
+.fi
+.RE
 .PP
 .SH CONFIGURATION
 .PP
 The template files are the HTML files in the working directory:
-"add.\&html", "diff.\&html", "edit.\&html", "search.\&html", "upload.\&html" and
-"view.\&html".\& Feel free to change the templates and restart the server.\&
 .PP
-The first change you should make is to replace the name and email
-address in the footer of "view.\&html".\& Look for "Your Name" and
-"example.\&org".\&
+.PD 0
+.IP \(bu 4
+\fIview.\&html\fR shows a page
+.IP \(bu 4
+\fIdiff.\&html\fR shows the last change to a page
+.IP \(bu 4
+\fIedit.\&html\fR shows a form to edit a page
+.IP \(bu 4
+\fIadd.\&html\fR shows a form to add to a page
+.IP \(bu 4
+\fIupload.\&html\fR shows a form to upload a file
+.IP \(bu 4
+\fIsearch.\&html\fR shows the search results
+.IP \(bu 4
+\fIstatic.\&html\fR is used to generate a static site
+.IP \(bu 4
+\fIfeed.\&html\fR is used to generate a RSS feed
+.PD
 .PP
-The second change you should make is to replace the name, email
-address and domain name in "feed.\&html".\& Look for "Your Name" and
-"example.\&org".\& This second template is used to generate the RSS feeds
-(despite its ".\&html" extension).\&
+Please change the templates!\&
+.PP
+The first change you should make is to replace the name and email address in the
+footer of \fIview.\&html\fR.\& Look for "Your Name" and "example.\&org".\&
+.PP
+The second change you should make is to replace the name, email address and
+domain name in "feed.\&html".\& Look for "Your Name" and "example.\&org".\&
 .PP
 See \fIoddmu-templates\fR(5) for more.\&
 .PP
@@ -60,6 +171,21 @@ See \fIoddmu-templates\fR(5) for more.\&
 .PP
 You can change the port served by setting the ODDMU_PORT environment variable.\&
 .PP
+You can change the address served by setting the ODDMU_ADDRESS environment
+variable to either an IPv4 address or an IPv6 address.\& If ODDMU_ADDRESS is
+unset, then the program listens on all available unicast addresses, both IPv4
+and IPv6.\& Here are a few example addresses:
+.PP
+.nf
+.RS 4
+ODDMU_ADDRESS=127\&.0\&.0\&.1      # The loopback IPv4 address\&.
+ODDMU_ADDRESS=2001:db8::3:1  # An IPv6 address\&.
+.fi
+.RE
+.PP
+See the Socket Activation section for an alternative method of listening which
+supports Unix-domain sockets.\&
+.PP
 In order to limit language-detection to the languages you actually use, set the
 environment variable ODDMU_LANGUAGES to a comma-separated list of ISO 639-1
 codes, e.\&g.\& "en" or "en,de,fr,pt".\&
@@ -67,6 +193,21 @@ codes, e.\&g.\& "en" or "en,de,fr,pt".\&
 You can enable webfinger to link fediverse accounts to their correct profile
 pages by setting ODDMU_WEBFINGER to "1".\& See \fIoddmu\fR(5).\&
 .PP
+If you use secret subdirectories, you cannot rely on the web server to hide
+those pages because some actions such as searching and archiving include
+subdirectories.\& They act upon a whole tree of pages, not just a single page.\& The
+ODDMU_FILTER can be used to exclude subdirectories from such tree actions.\& See
+\fIoddmu-filter\fR(7) and \fIoddmu-apache\fR(5).\&
+.PP
+.SH Socket Activation
+.PP
+Instead of specifying ODDMU_ADDRESS or ODDMU_PORT, you can start the service
+through socket activation.\& The advantage of this method is that you can use a
+Unix-domain socket instead of a TCP socket, and the permissions and ownership of
+the socket are set before the program starts.\& See \fIoddmu.\&service\fR(5) and
+\fIoddmu-apache\fR(5) for an example of how to use socket activation with a
+Unix-domain socket under systemd and Apache.\&
+.PP
 .SH SECURITY
 .PP
 If the machine you are running Oddmu on is accessible from the Internet, you
@@ -79,9 +220,11 @@ Oddmu assumes that all the users that can edit pages or upload files are trusted
 users and therefore their content is trusted.\& Therefore, Oddmu doesn'\&t perform
 HTML sanitization!\&
 .PP
+For an extra dose of security, consider using a Unix-domain socket.\&
+.PP
 .SH OPTIONS
 .PP
-The oddmu program can be run on the command-line using various subcommands.\&
+Oddmu can be run on the command-line using various subcommands.\&
 .PP
 .PD 0
 .IP \(bu 4
@@ -132,7 +275,7 @@ on your point of view.\& See \fIoddmu-apache\fR(5).\&
 .SH NOTES
 .PP
 Page names are filenames with ".\&md" appended.\& If your filesystem cannot handle
-it, it can'\&t be a page name.\& Filenames can contain slashes and oddmu creates
+it, it can'\&t be a page name.\& Filenames can contain slashes and Oddmu creates
 subdirectories as necessary.\&
 .PP
 Files may not end with a tilde ('\&~'\&) – these are backup files.\& When saving pages
@@ -187,17 +330,21 @@ A hashtag consists of a number sign ('\&#'\&) followed by Unicode letters, numbe
 or the underscore ('\&_'\&).\& Thus, a hashtag ends with punctuation or whitespace.\&
 .PP
 The page names, titles and hashtags are loaded into memory when the server
-starts.\& If you have a lot of pages, this takes a lot of memory.\& If you change
-the files while the wiki runs, changes to names (creating, renaming or deleting
-files), titles or hashtags confuse Oddmu.\& Restart the program in order to
-resolve this.\&
+starts.\& If you have a lot of pages, this takes a lot of memory.\&
+.PP
+Oddmu watches the working directory and any subdirectories for changes made
+directly.\& Thus, in theory, it'\&s not necessary to restart it after making such
+changes.\&
 .PP
 You cannot edit uploaded files.\& If you upload a file called "hello.\&txt" and
 attempt to edit it by using "/edit/hello.\&txt" you create a page with the name
 "hello.\&txt.\&md" instead.\&
 .PP
-You cannot delete uploaded files via the web – but you can delete regular wiki
-pages by saving an empty page.\&
+In order to delete uploaded files via the web, create an empty file and upload
+it.\& In order to delete a wiki page, save an empty page.\&
+.PP
+Note that some HTML file names are special: they act as templates.\& See
+\fIoddmu-templates\fR(5) for their names and their use.\&
 .PP
 .SH SEE ALSO
 .PP
@@ -209,12 +356,16 @@ pages by saving an empty page.\&
 .IP \(bu 4
 \fIoddmu-apache\fR(5), on how to set up a web server such as Apache
 .IP \(bu 4
+\fIoddmu-filter\fR(7), on how to treat subdirectories as separate sites
+.IP \(bu 4
 \fIoddmu-html\fR(1), on how to render a page from the command-line
 .IP \(bu 4
 \fIoddmu-list\fR(1), on how to list pages and titles from the command-line
 .IP \(bu 4
 \fIoddmu-missing\fR(1), on how to find broken local links from the command-line
 .IP \(bu 4
+\fIoddmu-releases\fR(7), on what features are part of the latest release
+.IP \(bu 4
 \fIoddmu-replace\fR(1), on how to search and replace text from the command-line
 .IP \(bu 4
 \fIoddmu-search\fR(1), on how to run a search from the command-line
@@ -223,7 +374,12 @@ pages by saving an empty page.\&
 .IP \(bu 4
 \fIoddmu-static\fR(1), on generating a static site from the command-line
 .IP \(bu 4
+\fIoddmu-notify\fR(1), on updating index, changes and hashtag pages from the
+command-line
+.IP \(bu 4
 \fIoddmu-templates\fR(5), on how to write the HTML templates
+.IP \(bu 4
+\fIoddmu-version\fR(1), on how to get all the build information from the binary
 .PD
 .PP
 .SH AUTHORS

man/oddmu.1.txt

@@ -12,14 +12,21 @@ Oddmu is sometimes written Oddµ because µ is the letter mu.
 
 # DESCRIPTION
 
-The oddmu program serves the current working directory as a wiki on port 8080.
-Point your browser to http://localhost:8080/ to get started. This is equivalent
-to http://localhost:8080/view/index – the first page you'll create, most likely.
+Oddmu can be used as a static site generator, turning Markdown files into HTML
+files, or it can be used as a public or a private wiki server. If it runs as a
+public wiki server, a regular webserver should be used as reverse proxy.
 
-If you request a page that doesn't exist, oddmu tries to find a matching
+Run Oddmu without any arguments to serve the current working directory as a wiki
+on port 8080. Point your browser to http://localhost:8080/ to use it. This
+redirects you to http://localhost:8080/view/index – the first page you'll
+create, most likely.
+
+See _oddmu_(5) for details about the page formatting.
+
+If you request a page that doesn't exist, Oddmu tries to find a matching
 Markdown file by appending the extension ".md" to the page name. In the example
-above, the page name requested is "index" and the file name oddmu tries to read
-is "index.md". If no such file exists, oddmu offers you to create the page.
+above, the page name requested is "index" and the file name Oddmu tries to read
+is "index.md". If no such file exists, Oddmu offers you to create the page.
 
 If your files don't provide their own title ("# title"), the file name (without
 ".md") is used for the page title.
@@ -30,22 +37,90 @@ feed items are based on links in bullet lists using the asterix
 
 Subdirectories are created as necessary.
 
-See _oddmu_(5) for details about the page formatting.
+The wiki knows the following actions for a given page name and (optional)
+directory:
+
+- _/_ redirects to /view/index
+- _/view/dir/_ redirects to /view/dir/index
+- _/view/dir/name_ shows a page
+- _/view/dir/name.md_ shows the source text of a page
+- _/view/dir/name.rss_ shows  the RSS feed for the pages linked
+- _/diff/dir/name_ shows the last change to a page
+- _/edit/dir/name_ shows a form to edit a page
+- _/save/dir/name_ saves an edit
+- _/add/dir/name_ shows a form to add to a page
+- _/append/dir/name_ appends an addition to a page
+- _/upload/dir/name_ shows a form to upload a file
+- _/drop/dir/name_ saves an upload
+- _/search/dir/?q=term_ to search for a term
+- _/archive/dir/name.zip_ to download a zip file of a directory
+
+When calling the _save_ and _append_ action, the page name is taken from the URL
+path and the page content is taken from the _body_ form parameter. To
+illustrate, here's how to edit the "welcome" page using _curl_:
+
+```
+curl --form body="Did you bring a towel?" \
+  http://localhost:8080/save/welcome
+```
+
+When calling the _drop_ action, the query parameters used are _name_ for the
+target filename, _file_ for the file to upload. If the query parameter
+_maxwidth_ is set, an attempt is made to decode and resize the image. JPG, PNG
+and HEIC files can be decoded. Only JPG and PNG files can be encoded, however.
+If the target name ends in _.jpg_, the _quality_ query parameter is also taken
+into account. To upload some thumbnails:
+
+```
+for f in *.jpg; do
+  curl --form name="$f" --form file=@"$f" --form maxwidth=100 \
+    http://localhost:8080/drop/
+done
+```
+
+When calling the _search_ action, the search terms are taken from the query
+parameter _q_.
+
+```
+curl 'http://localhost:8080/search/?q=towel'
+```
+
+The page name to act upon is optionally taken from the query parameter _id_. In
+this case, the directory must also be part of the query parameter and not of the
+URL path.
+
+```
+curl 'http://localhost:8080/view/?id=man/oddmu.1.txt'
+```
+
+The base name for the _archive_ action is used by the browser to save the
+downloaded file. For Oddmu, only the directory is important. The following zips
+the _man_ directory and saves it as _man.zip_.
+
+```
+curl --remote-name 'http://localhost:8080/archive/man/man.zip
+```
 
 # CONFIGURATION
 
 The template files are the HTML files in the working directory:
-"add.html", "diff.html", "edit.html", "search.html", "upload.html" and
-"view.html". Feel free to change the templates and restart the server.
 
-The first change you should make is to replace the name and email
-address in the footer of "view.html". Look for "Your Name" and
-"example.org".
+- _view.html_ shows a page
+- _diff.html_ shows the last change to a page
+- _edit.html_ shows a form to edit a page
+- _add.html_ shows a form to add to a page
+- _upload.html_ shows a form to upload a file
+- _search.html_ shows the search results
+- _static.html_ is used to generate a static site
+- _feed.html_ is used to generate a RSS feed
 
-The second change you should make is to replace the name, email
-address and domain name in "feed.html". Look for "Your Name" and
-"example.org". This second template is used to generate the RSS feeds
-(despite its ".html" extension).
+Please change the templates!
+
+The first change you should make is to replace the name and email address in the
+footer of _view.html_. Look for "Your Name" and "example.org".
+
+The second change you should make is to replace the name, email address and
+domain name in "feed.html". Look for "Your Name" and "example.org".
 
 See _oddmu-templates_(5) for more.
 
@@ -53,6 +128,19 @@ See _oddmu-templates_(5) for more.
 
 You can change the port served by setting the ODDMU_PORT environment variable.
 
+You can change the address served by setting the ODDMU_ADDRESS environment
+variable to either an IPv4 address or an IPv6 address. If ODDMU_ADDRESS is
+unset, then the program listens on all available unicast addresses, both IPv4
+and IPv6. Here are a few example addresses:
+
+```
+ODDMU_ADDRESS=127.0.0.1      # The loopback IPv4 address.
+ODDMU_ADDRESS=2001:db8::3:1  # An IPv6 address.
+```
+
+See the Socket Activation section for an alternative method of listening which
+supports Unix-domain sockets.
+
 In order to limit language-detection to the languages you actually use, set the
 environment variable ODDMU_LANGUAGES to a comma-separated list of ISO 639-1
 codes, e.g. "en" or "en,de,fr,pt".
@@ -60,6 +148,21 @@ codes, e.g. "en" or "en,de,fr,pt".
 You can enable webfinger to link fediverse accounts to their correct profile
 pages by setting ODDMU_WEBFINGER to "1". See _oddmu_(5).
 
+If you use secret subdirectories, you cannot rely on the web server to hide
+those pages because some actions such as searching and archiving include
+subdirectories. They act upon a whole tree of pages, not just a single page. The
+ODDMU_FILTER can be used to exclude subdirectories from such tree actions. See
+_oddmu-filter_(7) and _oddmu-apache_(5).
+
+# Socket Activation
+
+Instead of specifying ODDMU_ADDRESS or ODDMU_PORT, you can start the service
+through socket activation. The advantage of this method is that you can use a
+Unix-domain socket instead of a TCP socket, and the permissions and ownership of
+the socket are set before the program starts. See _oddmu.service_(5) and
+_oddmu-apache_(5) for an example of how to use socket activation with a
+Unix-domain socket under systemd and Apache.
+
 # SECURITY
 
 If the machine you are running Oddmu on is accessible from the Internet, you
@@ -72,9 +175,11 @@ Oddmu assumes that all the users that can edit pages or upload files are trusted
 users and therefore their content is trusted. Therefore, Oddmu doesn't perform
 HTML sanitization!
 
+For an extra dose of security, consider using a Unix-domain socket.
+
 # OPTIONS
 
-The oddmu program can be run on the command-line using various subcommands.
+Oddmu can be run on the command-line using various subcommands.
 
 - to generate the HTML for a single page, see _oddmu-html_(1)
 - to generate the HTML for the entire site, using Oddmu as a static site
@@ -115,7 +220,7 @@ on your point of view. See _oddmu-apache_(5).
 # NOTES
 
 Page names are filenames with ".md" appended. If your filesystem cannot handle
-it, it can't be a page name. Filenames can contain slashes and oddmu creates
+it, it can't be a page name. Filenames can contain slashes and Oddmu creates
 subdirectories as necessary.
 
 Files may not end with a tilde ('~') – these are backup files. When saving pages
@@ -170,31 +275,40 @@ A hashtag consists of a number sign ('#') followed by Unicode letters, numbers
 or the underscore ('\_'). Thus, a hashtag ends with punctuation or whitespace.
 
 The page names, titles and hashtags are loaded into memory when the server
-starts. If you have a lot of pages, this takes a lot of memory. If you change
-the files while the wiki runs, changes to names (creating, renaming or deleting
-files), titles or hashtags confuse Oddmu. Restart the program in order to
-resolve this.
+starts. If you have a lot of pages, this takes a lot of memory.
+
+Oddmu watches the working directory and any subdirectories for changes made
+directly. Thus, in theory, it's not necessary to restart it after making such
+changes.
 
 You cannot edit uploaded files. If you upload a file called "hello.txt" and
 attempt to edit it by using "/edit/hello.txt" you create a page with the name
 "hello.txt.md" instead.
 
-You cannot delete uploaded files via the web – but you can delete regular wiki
-pages by saving an empty page.
+In order to delete uploaded files via the web, create an empty file and upload
+it. In order to delete a wiki page, save an empty page.
+
+Note that some HTML file names are special: they act as templates. See
+_oddmu-templates_(5) for their names and their use.
 
 # SEE ALSO
 
 - _oddmu_(5), about the markup syntax and how feeds are generated based on link lists
 - _oddmu.service_(5), on how to run the service under systemd
 - _oddmu-apache_(5), on how to set up a web server such as Apache
+- _oddmu-filter_(7), on how to treat subdirectories as separate sites
 - _oddmu-html_(1), on how to render a page from the command-line
 - _oddmu-list_(1), on how to list pages and titles from the command-line
 - _oddmu-missing_(1), on how to find broken local links from the command-line
+- _oddmu-releases_(7), on what features are part of the latest release
 - _oddmu-replace_(1), on how to search and replace text from the command-line
 - _oddmu-search_(1), on how to run a search from the command-line
 - _oddmu-search_(7), on how search works
 - _oddmu-static_(1), on generating a static site from the command-line
+- _oddmu-notify_(1), on updating index, changes and hashtag pages from the
+  command-line
 - _oddmu-templates_(5), on how to write the HTML templates
+- _oddmu-version_(1), on how to get all the build information from the binary
 
 # AUTHORS
 

man/oddmu.5

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU" "5" "2023-11-12" "File Formats Manual"
+.TH "ODDMU" "5" "2024-02-17" "File Formats Manual"
 .PP
 .SH NAME
 .PP

man/oddmu.service.5

@@ -1,11 +1,11 @@
-.\" Generated by scdoc 1.11.2
+.\" Generated by scdoc 1.11.3
 .\" Complete documentation for this program is not available as a GNU info page
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .nh
 .ad l
 .\" Begin generated content:
-.TH "ODDMU.SERVICE" "5" "2023-10-28"
+.TH "ODDMU.SERVICE" "5" "2024-02-17"
 .PP
 .SH NAME
 .PP
@@ -80,9 +80,30 @@ sudo ln -sf /home/oddmu/oddmu\&.service
 .fi
 .RE
 .PP
+.SH Socket Activation
+.PP
+Alternatively, you can let systemd handle the creation of the listening socket,
+passing it to Oddmu.\& See "oddmu-unix-domain.\&service" and
+"oddmu-unix-domain.\&socket" for a fully worked example of how to do this with a
+Unix domain socket.\& Take note of "Accept=no" in the .\&socket file and
+"StandardInput=socket" in the .\&service file.\& The option "StandardInput=socket"
+tells systemd to pass the socket to the service as its standard input.\&
+"Accept=no" tells systemd to pass a listening socket, rather than to try calling
+Oddmu for each connection.\&
+.PP
+The instructions for starting and enabling the systemd service are almost
+exactly the same as those in the previous section, with "oddmu.\&service" replaced
+by "oddmu-unix-domain.\&service".\& You'\&ll also need to run the following:
+.PP
+.nf
+.RS 4
+ln -s /home/oddmu/oddmu-unix-domain\&.socket /etc/systemd/system
+.fi
+.RE
+.PP
 .SH SEE ALSO
 .PP
-\fIoddmu\fR(1), \fIsystemd.\&exec\fR(5), \fIcapabilities\fR(7)
+\fIoddmu\fR(1), \fIsystemd.\&exec\fR(5), \fIsystemd.\&socket(5), \fRcapabilities_(7)
 .PP
 .SH AUTHORS
 .PP

man/oddmu.service.5.txt

@@ -61,9 +61,28 @@ sudo ln -sf /home/oddmu/oddmu.service \
   /etc/systemd/system/multi-user.target.wants/
 ```
 
+# Socket Activation
+
+Alternatively, you can let systemd handle the creation of the listening socket,
+passing it to Oddmu. See "oddmu-unix-domain.service" and
+"oddmu-unix-domain.socket" for a fully worked example of how to do this with a
+Unix domain socket. Take note of "Accept=no" in the .socket file and
+"StandardInput=socket" in the .service file. The option "StandardInput=socket"
+tells systemd to pass the socket to the service as its standard input.
+"Accept=no" tells systemd to pass a listening socket, rather than to try calling
+Oddmu for each connection.
+
+The instructions for starting and enabling the systemd service are almost
+exactly the same as those in the previous section, with "oddmu.service" replaced
+by "oddmu-unix-domain.service". You'll also need to run the following:
+
+```
+ln -s /home/oddmu/oddmu-unix-domain.socket /etc/systemd/system
+```
+
 # SEE ALSO
 
-_oddmu_(1), _systemd.exec_(5), _capabilities_(7)
+_oddmu_(1), _systemd.exec_(5), _systemd.socket(5), _capabilities_(7)
 
 # AUTHORS
 

man_test.go

@@ -0,0 +1,31 @@
+package main
+
+import (
+	"github.com/stretchr/testify/assert"
+	"io/fs"
+	"path/filepath"
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestManPages(t *testing.T) {
+	b, err := os.ReadFile("man/oddmu.1.txt");
+	main := string(b)
+	assert.NoError(t, err)
+	filepath.Walk("man", func (path string, info fs.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if strings.HasSuffix(path, ".txt") &&
+			path != "man/oddmu.1.txt" {
+			s := strings.TrimPrefix(path, "man/")
+			s = strings.TrimSuffix(s, ".txt")
+			i := strings.LastIndex(s, ".")
+			ref := "_" + s[:i] + "_(" + s[i+1:] + ")"
+			assert.Contains(t, main, ref, ref)
+		}
+		return nil
+	})
+}
+

missing_cmd.go

@@ -39,15 +39,19 @@ func missingCli(w io.Writer, args []string) subcommands.ExitStatus {
 		if err != nil {
 			return err
 		}
-		filename := path
-		if info.IsDir() || strings.HasPrefix(filename, ".") {
-			return nil
+		// skip hidden directories and files
+		if path != "." && strings.HasPrefix(filepath.Base(path), ".") {
+			if info.IsDir() {
+				return filepath.SkipDir
+			} else {
+				return nil
+			}
 		}
-		if strings.HasSuffix(filename, ".md") {
-			name := strings.TrimSuffix(filename, ".md")
+		if strings.HasSuffix(path, ".md") {
+			name := filepath.ToSlash(strings.TrimSuffix(path, ".md"))
 			names[name] = true
 		} else {
-			names[filename] = false
+			names[path] = false
 		}
 		return nil
 	})
@@ -62,13 +66,13 @@ func missingCli(w io.Writer, args []string) subcommands.ExitStatus {
 		}
 		p, err := loadPage(name)
 		if err != nil {
-			fmt.Fprintf(os.Stderr, "Loading %s: %s\n", name, err)
+			fmt.Fprintf(os.Stderr, "Loading %s: %s\n", p.Name, err)
 			return subcommands.ExitFailure
 		}
 		for _, link := range p.links() {
 			u, err := url.Parse(link)
 			if err != nil {
-				fmt.Fprintln(os.Stderr, name, err)
+				fmt.Fprintln(os.Stderr, p.Name, err)
 				return subcommands.ExitFailure
 			}
 			if u.Scheme == "" && u.Path != "" && !strings.HasPrefix(u.Path, "/") {
@@ -90,7 +94,7 @@ func missingCli(w io.Writer, args []string) subcommands.ExitStatus {
 						fmt.Fprintln(w, "Page\tMissing")
 						found = true
 					}
-					fmt.Fprintf(w, "%s\t%s\n", name, link)
+					fmt.Fprintf(w, "%s\t%s\n", p.Name, link)
 				}
 			}
 		}

oddmu-unix-domain.service

@@ -0,0 +1,53 @@
+[Unit]
+Description=Oddmu
+After=network.target
+Requires=oddmu-unix-domain.socket
+[Install]
+WantedBy=multi-user.target
+[Service]
+Type=simple
+Restart=always
+StandardInput=socket
+StandardOutput=journal
+StandardError=journal
+DynamicUser=true
+MemoryMax=256M
+MemoryHigh=128M
+ExecStart=/home/oddmu/oddmu
+WorkingDirectory=/home/oddmu
+Environment="ODDMU_PORT=8080"
+Environment="ODDMU_WEBFINGER=1"
+
+# (man "systemd.exec")
+ReadWritePaths=/home/oddmu
+ProtectHostname=yes
+RestrictSUIDSGID=yes
+RemoveIPC=yes
+MemoryDenyWriteExecute=yes
+
+# Sandboxing options to harden security
+NoNewPrivileges=yes
+PrivateTmp=yes
+PrivateDevices=yes
+RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6
+RestrictNamespaces=yes
+RestrictRealtime=yes
+DevicePolicy=closed
+ProtectSystem=full
+ProtectControlGroups=yes
+ProtectKernelModules=yes
+ProtectKernelTunables=yes
+LockPersonality=yes
+SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap
+
+# Denying access to capabilities that should not be relevant
+# (man "capabilities")
+CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD
+CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE
+CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT
+CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK
+CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM
+CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
+CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE
+CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW
+CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG

oddmu-unix-domain.socket

@@ -0,0 +1,14 @@
+[Unit]
+Description=Oddmu server socket
+
+[Socket]
+ListenStream=/run/oddmu/oddmu.sock
+SocketGroup=www-data
+# Systemd manages the socket, so may as well let it be owned by root.
+SocketUser=root
+# But it needs to be readable and writable by the web server.
+SocketMode=0660
+Accept=no
+
+[Install]
+WantedBy=sockets.target

page.go

@@ -16,7 +16,7 @@ import (
 
 // Page is a struct containing information about a single page. Title
 // is the title extracted from the page content using titleRegexp.
-// Name is the filename without extension (so a filename of "foo.md"
+// Name is the path without extension (so a path of "foo.md"
 // results in the Name "foo"). Body is the Markdown content of the
 // page and Html is the rendered HTML for that Markdown. Score is a
 // number indicating how well the page matched for a search query.
@@ -47,8 +47,7 @@ func unsafeBytes(bytes []byte) template.HTML {
 	return template.HTML(bytes)
 }
 
-// nameEscape returns the page name safe for use in URLs. That is,
-// percent escaping is used except for the slashes.
+// nameEscape returns the page name safe for use in URLs. That is, percent escaping is used except for the slashes.
 func nameEscape(s string) string {
 	parts := strings.Split(s, "/")
 	for i, part := range parts {
@@ -57,57 +56,60 @@ func nameEscape(s string) string {
 	return strings.Join(parts, "/")
 }
 
-// save saves a Page. The filename is based on the Page.Name and gets
-// the ".md" extension. Page.Body is saved, without any carriage
-// return characters ("\r"). Page.Title and Page.Html are not saved.
-// There is no caching. Before removing or writing a file, the old
-// copy is renamed to a backup, appending "~". There is no error
-// checking for this.
+// save saves a Page. The path is based on the Page.Name and gets the ".md" extension. Page.Body is saved, without any
+// carriage return characters ("\r"). Page.Title and Page.Html are not saved. There is no caching. Before removing or
+// writing a file, the old copy is renamed to a backup, appending "~". Errors are not logged but returned.
 func (p *Page) save() error {
-	filename := p.Name + ".md"
+	fp := filepath.FromSlash(p.Name + ".md")
+	watches.ignore(fp)
 	s := bytes.ReplaceAll(p.Body, []byte{'\r'}, []byte{})
 	if len(s) == 0 {
-		p.removeFromIndex()
-		return os.Rename(filename, filename+"~")
+		log.Println("Delete", p.Name)
+		index.remove(p)
+		return os.Rename(fp, fp+"~")
 	}
 	p.Body = s
-	p.updateIndex()
-	d := filepath.Dir(filename)
+	index.update(p)
+	d := filepath.Dir(fp)
 	if d != "." {
 		err := os.MkdirAll(d, 0755)
 		if err != nil {
-			log.Printf("Creating directory %s failed: %s", d, err)
 			return err
 		}
 	}
-	backup(filename)
-	return os.WriteFile(filename, s, 0644)
+	err := backup(fp)
+	if err != nil {
+		return err
+	}
+	return os.WriteFile(fp, s, 0644)
 }
 
 // backup a file by renaming (!) it unless the existing backup is less than an hour old. A backup gets a tilde appended
 // to it ("~"). This is true even if the file refers to a binary file like "image.png" and most applications don't know
-// what to do with a file called "image.png~".
-func backup(filename string) error {
-	backup := filename + "~"
-	fi, err := os.Stat(backup)
+// what to do with a file called "image.png~". This expects a file path. Use filepath.FromSlash(path) if necessary.
+func backup(fp string) error {
+	_, err := os.Stat(fp)		
+	if err != nil {
+		return nil
+	}
+	bp := fp + "~"
+	fi, err := os.Stat(bp)
 	if err != nil || time.Since(fi.ModTime()).Minutes() >= 60 {
-		return os.Rename(filename, backup)
+		return os.Rename(fp, bp)
 	}
 	return nil
 }
 
-// loadPage loads a Page given a name. The filename loaded is that
-// Page.Name with the ".md" extension. The Page.Title is set to the
-// Page.Name (and possibly changed, later). The Page.Body is set to
-// the file content. The Page.Html remains undefined (there is no
-// caching).
-func loadPage(name string) (*Page, error) {
-	filename := name + ".md"
-	body, err := os.ReadFile(filename)
+// loadPage loads a Page given a name. The path loaded is that Page.Name with the ".md" extension. The Page.Title is set
+// to the Page.Name (and possibly changed, later). The Page.Body is set to the file content. The Page.Html remains
+// undefined (there is no caching).
+func loadPage(path string) (*Page, error) {
+	path = strings.TrimPrefix(path, "./") // result of a filepath.TreeWalk starting with "."
+	body, err := os.ReadFile(filepath.FromSlash(path+".md"))
 	if err != nil {
 		return nil, err
 	}
-	return &Page{Title: name, Name: name, Body: body, Language: ""}, nil
+	return &Page{Title: path, Name: path, Body: body, Language: ""}, nil
 }
 
 // handleTitle extracts the title from a Page and sets Page.Title, if any. If replace is true, the page title is also
@@ -154,6 +156,16 @@ func (p *Page) Dir() string {
 	return d + "/"
 }
 
+// Base returns the basename of the page name: no directory and no extension. This is used to create the upload link
+// in "view.html", for example.
+func (p *Page) Base() string {
+	n := filepath.Base(p.Name)
+	if n == "." {
+		return ""
+	}
+	return n
+}
+
 // Today returns the date, as a string, for use in templates.
 func (p *Page) Today() string {
 	return time.Now().Format(time.DateOnly)

replace_cmd.go

@@ -59,7 +59,16 @@ func replaceCli(w io.Writer, isConfirmed bool, isRegexp bool, args []string) sub
 		if err != nil {
 			return err
 		}
-		if info.IsDir() || strings.HasPrefix(path, ".") || !strings.HasSuffix(path, ".md") {
+		// skip hidden directories and files
+		if path != "." && strings.HasPrefix(filepath.Base(path), ".") {
+			if info.IsDir() {
+				return filepath.SkipDir
+			} else {
+				return nil
+			}
+		}
+		// skipp all but page files
+		if !strings.HasSuffix(path, ".md") {
 			return nil
 		}
 		body, err := os.ReadFile(path)

search.go

@@ -3,6 +3,7 @@ package main
 import (
 	"log"
 	"net/http"
+	"os"
 	"path"
 	"regexp"
 	"slices"
@@ -93,15 +94,17 @@ const itemsPerPage = 20
 // size is 20. Specify either the page number to return, or that all the results should be returned. Only ask for all
 // results if runtime is not an issue, like on the command line. The boolean return value indicates whether there are
 // more results.
-func search(q string, dir string, page int, all bool) ([]*Page, bool) {
+func search(q, dir, filter string, page int, all bool) ([]*Page, bool) {
 	if len(q) == 0 {
 		return make([]*Page, 0), false
 	}
 	names := index.search(q) // hashtags or all names
-	names = filterPrefix(names, dir)
+	names = filterPath(names, dir, filter)
 	predicates, terms := predicatesAndTokens(q)
 	names = filterNames(names, predicates)
+	index.RLock()
 	slices.SortFunc(names, sortNames(terms))
+	index.RUnlock()
 	names, keepFirst := prependQueryPage(names, dir, q)
 	from := itemsPerPage * (page - 1)
 	to := from + itemsPerPage - 1
@@ -113,16 +116,27 @@ func search(q string, dir string, page int, all bool) ([]*Page, bool) {
 	return items, more
 }
 
-// filterPrefix filters the names by prefix. A prefix of "." means
-// that all the names are returned, since this is what path.Dir
-// returns for "no directory".
-func filterPrefix(names []string, prefix string) []string {
-	if prefix == "." {
-		return names
+// filterPath filters the names by prefix and by a regular expression. A prefix of "." means that all the names are
+// returned, since this is what path.Dir returns for "no directory".
+//
+// The regular expression can be used to ensure that search does not descend into subdirectories unless the search
+// already starts there. Given the pages a, public/b and secret/c and ODDMU_FILTER=^secret/ then if search starts in the
+// root directory /, search does not enter secret/, but if search starts in secret/, search does search the pages in
+// secret/ – it us up to the web server to ensure access to secret/ is limited. More specifically: the page names must
+// match the prefix, always; if prefix also matches the filter, this means the page names are all part of a "separate
+// site"; if the prefix does not match the filter, then the page names must also not match the filter since only the
+// "main site" is shown. If the filter is empty, all prefixes and all page names match, so no problem.
+func filterPath(names []string, prefix, filter string) []string {
+	re, err := regexp.Compile(filter)
+	if err != nil {
+		log.Println("ODDMU_FILTER does not compile:", filter, err)
+		return []string{}
 	}
+	matches := re.MatchString(prefix)
 	r := make([]string, 0)
 	for _, name := range names {
-		if strings.HasPrefix(name, prefix) {
+		if strings.HasPrefix(name, prefix) &&
+			(matches || !re.MatchString(name)) {
 			r = append(r, name)
 		}
 	}
@@ -225,18 +239,20 @@ func prependQueryPage(names []string, dir, q string) ([]string, bool) {
 	return names, false
 }
 
-// searchHandler presents a search result. It uses the query string in
-// the form parameter "q" and the template "search.html". For each
-// page found, the HTML is just an extract of the actual body.
-// Search is limited to a directory and its subdirectories.
+// searchHandler presents a search result. It uses the query string in the form parameter "q" and the template
+// "search.html". For each page found, the HTML is just an extract of the actual body. Search is limited to a directory
+// and its subdirectories.
+//
+// A filter can be defined using the environment variable ODDMU_FILTER. It is passed on to search.
 func searchHandler(w http.ResponseWriter, r *http.Request, dir string) {
 	q := r.FormValue("q")
 	page, err := strconv.Atoi(r.FormValue("page"))
 	if err != nil {
 		page = 1
 	}
-	items, more := search(q, dir, page, false)
+	filter := os.Getenv("ODDMU_FILTER")
+	items, more := search(q, dir, filter, page, false)
 	s := &Search{Query: q, Dir: dir, Items: items, Previous: page - 1, Page: page, Next: page + 1,
 		Results: len(items) > 0, More: more}
-	renderTemplate(w, "search", s)
+	renderTemplate(w, dir, "search", s)
 }

search.html

@@ -6,7 +6,7 @@
     <meta name="viewport" content="width=device-width">
     <title>Search for {{.Query}}</title>
     <style>
-html { max-width: 65ch; padding: 2ch; margin: auto; color: #111; background-color: #ffe; }
+html { max-width: 70ch; padding: 2ch; margin: auto; color: #111; background-color: #ffe; }
 body { hyphens: auto; }
 header a { margin-right: 1ch; }
 form { display: inline-block; }

search_cmd.go

@@ -48,9 +48,10 @@ func searchCli(w io.Writer, dir string, n int, all, extract bool, quiet bool, ar
 	if err != nil {
 		return subcommands.ExitFailure
 	}
+	index.reset()
 	index.load()
 	q := strings.Join(args, " ")
-	items, more := search(q, dir, n, true)
+	items, more := search(q, dir, "", n, true)
 	if !quiet {
 		fmt.Fprint(os.Stderr, "Search for ", q)
 		if !all {

search_test.go

@@ -10,10 +10,10 @@ import (
 
 func TestSortNames(t *testing.T) {
 	index.Lock()
+	defer index.Unlock()
 	for _, s := range []string{"Alex", "Berta", "Chris", "2015-06-14", "2023-09-26"} {
 		index.titles[s] = s
 	}
-	index.Unlock()
 	terms := []string{"Z"}
 	fn := sortNames(terms)
 	assert.Equal(t, 1, fn("Berta", "Alex"), "B is after A")
@@ -56,6 +56,10 @@ func TestPrependMatches(t *testing.T) {
 }
 
 func TestSearch(t *testing.T) {
+	// working in the main directory
+	index.reset()
+	index.load()
+
 	data := url.Values{}
 	data.Set("q", "oddµ")
 
@@ -67,12 +71,83 @@ func TestSearch(t *testing.T) {
 	assert.NotContains(t, body, "Welcome")
 }
 
+func TestSearchFilter(t *testing.T) {
+	names := []string{"a", "public/b", "secret/c"}
+
+	f := filterPath(names, "", "")
+	assert.Equal(t, names, f)
+
+	f = filterPath(names, "public/", "")
+	assert.Equal(t, []string{"public/b"}, f)
+
+	f = filterPath(names, "secret/", "")
+	assert.Equal(t, []string{"secret/c"}, f)
+
+	// critically, this no longer returns c
+	f = filterPath(names, "", "^secret/")
+	assert.Equal(t, []string{"a", "public/b"}, f)
+
+	// unchanged
+	f = filterPath(names, "public/", "^secret/")
+	assert.Equal(t, []string{"public/b"}, f)
+
+	// unchanged
+	f = filterPath(names, "secret/", "^secret/")
+	assert.Equal(t, []string{"secret/c"}, f)
+
+}
+
+func TestSearchFilterLong(t *testing.T) {
+	cleanup(t, "testdata/filter")
+	p := &Page{Name: "testdata/filter/one", Body: []byte(`# One
+
+One day, I heard you say
+Just one more day and I'd know
+But that was last spring`)}
+	p.save()
+	p = &Page{Name: "testdata/filter/public/two", Body: []byte(`# Two
+Oh, the two of us
+Have often seen this forest
+But this bird is new`)}
+	p.save()
+	p = &Page{Name: "testdata/filter/secret/three", Body: []byte(`# Three
+Three years have gone by
+And we're good, we live, we breathe
+But we don't say it`)}
+	p.save()
+
+	// normal search works
+	items, _ := search("spring", "testdata/", "", 1, false)
+	assert.Equal(t, len(items), 1)
+	assert.Equal(t, "One", items[0].Title)
+
+	// not found because it's in /secret and we start at /
+	items, _ = search("year", "testdata/", "^testdata/filter/secret/", 1, false)
+	assert.Equal(t, 0, len(items))
+
+	// only found two because the third one is in /secret and we start at /
+	items, _ = search("but", "testdata/", "^testdata/filter/secret/", 1, false)
+	assert.Equal(t, 2, len(items))
+	assert.Equal(t, "One", items[0].Title)
+	assert.Equal(t, "Two", items[1].Title)
+
+	// starting in the public/ directory, we find only one page
+	items, _ = search("but", "testdata/filter/public/", "^testdata/filter/secret/", 1, false)
+	assert.Equal(t, 1, len(items))
+	assert.Equal(t, "Two", items[0].Title)
+
+	// starting in the secret/ directory, we find only one page
+	items, _ = search("but", "testdata/filter/secret/", "^testdata/filter/secret/", 1, false)
+	assert.Equal(t, 1, len(items))
+	assert.Contains(t, "Three", items[0].Title)
+}
+
 func TestSearchDir(t *testing.T) {
 	cleanup(t, "testdata/dir")
 	p := &Page{Name: "testdata/dir/dice", Body: []byte(`# Dice
 
 A tiny drum roll
-Dice rolling bouncing stopping 
+Dice rolling bouncing stopping
 Where is lady luck?`)}
 	p.save()
 
@@ -93,17 +168,21 @@ Where is lady luck?`)}
 }
 
 func TestTitleSearch(t *testing.T) {
-	items, more := search("title:readme", "", 1, false)
+	// working in the main directory
+	index.reset()
+	index.load()
+
+	items, more := search("title:readme", "", "", 1, false)
 	assert.Equal(t, 0, len(items), "no page found")
 	assert.False(t, more)
 
-	items, more = search("title:wel", "", 1, false) // README also contains "wel"
+	items, more = search("title:wel", "", "", 1, false) // README also contains "wel"
 	assert.Equal(t, 1, len(items), "one page found")
 	assert.Equal(t, "index", items[0].Name, "Welcome to Oddµ")
 	assert.Greater(t, items[0].Score, 0, "matches result in a score")
 	assert.False(t, more)
 
-	items, more = search("wel", "", 1, false)
+	items, more = search("wel", "", "", 1, false)
 	assert.Greater(t, len(items), 1, "two pages found")
 	assert.False(t, more)
 }
@@ -117,12 +196,12 @@ Was it 2015
 We met in the park?`)}
 	p.save()
 
-	items, _ := search("blog:false", "", 1, false)
+	items, _ := search("blog:false", "", "", 1, false)
 	for _, item := range items {
 		assert.NotEqual(t, "Back then", item.Title, item.Name)
 	}
 
-	items, _ = search("blog:true", "", 1, false)
+	items, _ = search("blog:true", "", "", 1, false)
 	assert.Equal(t, 1, len(items), "one blog page found")
 	assert.Equal(t, "Back then", items[0].Title, items[0].Name)
 }
@@ -142,7 +221,7 @@ A quick sip too quick
 #Haiku`)}
 	p.save()
 
-	items, _ := search("#Haiku", "testdata/hashtag", 1, false)
+	items, _ := search("#Haiku", "testdata/hashtag", "", 1, false)
 	assert.Equal(t, 2, len(items), "two pages found")
 	assert.Equal(t, "Haikus", items[0].Title, items[0].Name)
 	assert.Equal(t, "Tea", items[1].Title, items[1].Name)
@@ -174,18 +253,18 @@ func TestSearchPagination(t *testing.T) {
 		p.save()
 	}
 
-	items, more := search("secretA", "", 1, false)
+	items, more := search("secretA", "", "", 1, false)
 	assert.Equal(t, 1, len(items), "one page found, %v", items)
 	assert.Equal(t, "testdata/pagination/A", items[0].Name)
 	assert.False(t, more)
 
-	items, more = search("secretX", "", 1, false)
+	items, more = search("secretX", "", "", 1, false)
 	assert.Equal(t, itemsPerPage, len(items))
 	assert.Equal(t, "testdata/pagination/A", items[0].Name)
 	assert.Equal(t, "testdata/pagination/T", items[itemsPerPage-1].Name)
 	assert.True(t, more)
 
-	items, more = search("secretX", "", 2, false)
+	items, more = search("secretX", "", "", 2, false)
 	assert.Equal(t, 6, len(items))
 	assert.Equal(t, "testdata/pagination/U", items[0].Name)
 	assert.Equal(t, "testdata/pagination/Z", items[5].Name)

static_cmd.go

@@ -9,7 +9,6 @@ import (
 	"github.com/gomarkdown/markdown/ast"
 	"github.com/gomarkdown/markdown/html"
 	"github.com/google/subcommands"
-	"html/template"
 	"io/fs"
 	"net/url"
 	"os"
@@ -37,20 +36,25 @@ func (cmd *staticCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface
 		fmt.Println("Exactly one target directory is required")
 		return subcommands.ExitFailure
 	}
-	return staticCli(filepath.Clean(args[0]))
+	return staticCli(filepath.Clean(args[0]), false)
 }
 
-func staticCli(dir string) subcommands.ExitStatus {
-	err := os.Mkdir(dir, 0755)
-	if err != nil {
-		fmt.Println(err)
-		return subcommands.ExitFailure
-	}
-	initAccounts()
-	templates := loadTemplates();
-	err = filepath.Walk(".", func(path string, info fs.FileInfo, err error) error {
-		return staticFile(path, dir, info, templates, err)
+// staticCli generates a static site in the designated directory. The quiet flag is used to suppress output when running
+// tests.
+func staticCli(dir string, quiet bool) subcommands.ExitStatus {
+	loadLanguages()
+	loadTemplates()
+	n := 0
+	err := filepath.Walk(".", func(path string, info fs.FileInfo, err error) error {
+		n++
+		if !quiet && (n < 100 || n < 1000 && n%10 == 0 || n%100 == 0) {
+			fmt.Fprintf(os.Stdout, "\r%d", n)
+		}
+		return staticFile(path, dir, info, err)
 	})
+	if !quiet {
+		fmt.Printf("\r%d\n", n)
+	}
 	if err != nil {
 		fmt.Println(err)
 		return subcommands.ExitFailure
@@ -60,33 +64,38 @@ func staticCli(dir string) subcommands.ExitStatus {
 
 // staticFile is used to walk the file trees and do the right thing for the destination directory: create
 // subdirectories, link files, render HTML files.
-func staticFile(path, dir string, info fs.FileInfo, templates *template.Template, err error) error {
+func staticFile(path, dir string, info fs.FileInfo, err error) error {
 	if err != nil {
 		return err
 	}
-	filename := path
-	// skip "hidden" files and backup files, avoid recursion
-	if strings.HasPrefix(filename, ".") ||
-		strings.HasSuffix(filename, "~") ||
-		strings.HasPrefix(filename, dir) {
+	// skip hidden directories and files
+	if path != "." && strings.HasPrefix(filepath.Base(path), ".") {
+		if info.IsDir() {
+			return filepath.SkipDir
+		} else {
+			return nil
+		}
+	}
+	// skip backup files, avoid recursion
+	if strings.HasSuffix(path, "~") || strings.HasPrefix(path, dir) {
 		return nil
 	}
 	// recreate subdirectories
 	if info.IsDir() {
-		return os.Mkdir(filepath.Join(dir, filename), 0755)
+		return os.Mkdir(filepath.Join(dir, path), 0755)
 	}
 	// render pages
-	if strings.HasSuffix(filename, ".md") {
-		return staticPage(filename, dir, templates)
+	if strings.HasSuffix(path, ".md") {
+		return staticPage(path, dir)
 	}
 	// remaining files are linked
-	return os.Link(filename, filepath.Join(dir, filename))
+	return os.Link(path, filepath.Join(dir, path))
 }
 
 // staticPage takes the filename of a page (ending in ".md") and generates a static HTML page.
-func staticPage(filename, dir string, templates *template.Template) error {
-	name := strings.TrimSuffix(filename, ".md")
-	p, err := loadPage(name)
+func staticPage(path, dir string) error {
+	name := strings.TrimSuffix(path, ".md")
+	p, err := loadPage(filepath.ToSlash(name))
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Cannot load %s: %s\n", name, err)
 		return err
@@ -105,7 +114,7 @@ func staticPage(filename, dir string, templates *template.Template) error {
 	p.Html = unsafeBytes(maybeUnsafeHTML)
 	p.Language = language(p.plainText())
 	p.Hashtags = *hashtags
-	return p.write(filepath.Join(dir, name+".html"), templates)
+	return p.write(filepath.Join(dir, name+".html"))
 }
 
 // staticLinks checks a node and if it is a link to a local page, it appends ".html" to the link destination.
@@ -133,14 +142,14 @@ func staticLinks(node ast.Node, entering bool) ast.WalkStatus {
 	return ast.GoToNext
 }
 
-func (p *Page) write(destination string, templates *template.Template) error {
+func (p *Page) write(destination string) error {
 	t := "static.html"
 	f, err := os.Create(destination)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Cannot create %s.html: %s\n", destination, err)
 		return err
 	}
-	err = templates.ExecuteTemplate(f, t, p)
+	err = templates.template[t].Execute(f, p)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Cannot execute %s template for %s: %s\n", t, destination, err)
 		return err

static_cmd_test.go

@@ -8,7 +8,7 @@ import (
 
 func TestStatusCmd(t *testing.T) {
 	cleanup(t, "testdata/static")
-	s := staticCli("testdata/static")
+	s := staticCli("testdata/static", true)
 	assert.Equal(t, subcommands.ExitSuccess, s)
 	// pages
 	assert.FileExists(t, "testdata/static/index.html")

templates.go

@@ -0,0 +1,110 @@
+package main
+
+import (
+	"html/template"
+	"io/fs"
+	"log"
+	"net/http"
+	"path"
+	"path/filepath"
+	"slices"
+	"strings"
+	"sync"
+)
+
+// templateFiles are the various HTML template files used. These files must exist in the root directory for Oddmu to be
+// able to generate HTML output. This always requires a template.
+var templateFiles = []string{"edit.html", "add.html", "view.html",
+	"diff.html", "search.html", "static.html", "upload.html", "feed.html"}
+
+// templates are the parsed HTML templates used. See renderTemplate and loadTemplates. Subdirectories may contain their
+// own templates which override the templates in the root directory. If so, they are not filepaths. Use
+// filepath.ToSlash() if necessary.
+type Template struct {
+	sync.RWMutex
+	template map[string]*template.Template
+}
+
+var templates Template
+
+// loadTemplates loads the templates. If templates have already been loaded, return immediately.
+func loadTemplates() {
+	if templates.template != nil {
+		return
+	}
+	templates.Lock()
+	defer templates.Unlock()
+	// walk the directory, load templates and add directories
+	templates.template = make(map[string]*template.Template)
+	filepath.Walk(".", loadTemplate)
+	log.Println(len(templates.template), "templates loaded")
+}
+
+// loadTemplate is used to walk the directory. It loads all the template files it finds, including the ones in
+// subdirectories. This is called with templates already locked.
+func loadTemplate(fp string, info fs.FileInfo, err error) error {
+	if err != nil {
+		return err
+	}
+	if strings.HasSuffix(fp, ".html") &&
+		slices.Contains(templateFiles, filepath.Base(fp)) {
+		t, err := template.ParseFiles(fp)
+		if err != nil {
+			log.Println("Cannot parse template:", fp, err)
+			// ignore error
+		} else {
+			// log.Println("Parse template:", path)
+			templates.template[filepath.ToSlash(fp)] = t
+		}
+	}
+	return nil
+}
+
+// updateTemplate checks whether this is a valid template file and if so, reloads it.
+func updateTemplate(fp string) {
+	if strings.HasSuffix(fp, ".html") &&
+		slices.Contains(templateFiles, filepath.Base(fp)) {
+		t, err := template.ParseFiles(fp)
+		if err != nil {
+			log.Println("Template:", fp, err)
+		} else {
+			templates.Lock()
+			defer templates.Unlock()
+			templates.template[filepath.ToSlash(fp)] = t
+			log.Println("Parse template:", fp)
+		}
+	}
+}
+
+// removeTemplate removes a template unless it's a root template because that would result in the site being unusable.
+func removeTemplate(fp string) {
+	if slices.Contains(templateFiles, filepath.Base(fp)) &&
+		filepath.Dir(fp) != "." {
+		templates.Lock()
+		defer templates.Unlock()
+		delete(templates.template, filepath.ToSlash(fp))
+		log.Println("Discard template:", fp)
+	}
+}
+
+// renderTemplate is the helper that is used to render the templates with data.
+// A template in the same directory is preferred, if it exists.
+func renderTemplate(w http.ResponseWriter, dir, tmpl string, data any) {
+	loadTemplates()
+	base := tmpl + ".html"
+	templates.RLock()
+	defer templates.RUnlock()
+	t := templates.template[path.Join(dir, base)]
+	if t == nil {
+		t = templates.template[base]
+	}
+	if t == nil {
+		log.Println("Template not found:", base)
+		http.Error(w, "Template not found", http.StatusInternalServerError)
+		return
+	}
+	err := t.Execute(w, data)
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+	}
+}

templates_test.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"bytes"
+	"github.com/stretchr/testify/assert"
+	"mime/multipart"
+	"testing"
+)
+
+func TestTemplates(t *testing.T) {
+	cleanup(t, "testdata/templates")
+	// save a file to create the directory
+	p := &Page{Name: "testdata/templates/snow", Body: []byte(`# Snow
+
+A blob on the grass
+Covered in needles and dust
+Memories of cold
+`)}
+	p.save()
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/templates/snow", nil),
+		"Skip navigation")
+	// save a new view handler
+	html := "<body><h1>{{.Title}}</h1>{{.Html}}"
+	form := new(bytes.Buffer)
+	writer := multipart.NewWriter(form)
+	field, err := writer.CreateFormField("name")
+	assert.NoError(t, err)
+	field.Write([]byte("view.html"))
+	file, err := writer.CreateFormFile("file", "test.html")
+	assert.NoError(t, err)
+	n, err := file.Write([]byte(html))
+	assert.NoError(t, err)
+	assert.Equal(t, len(html), n)
+	writer.Close()
+	HTTPUploadLocation(t, makeHandler(dropHandler, false), "/drop/testdata/templates/", writer.FormDataContentType(), form)
+	assert.FileExists(t, "view.html", "original view.html still exists")
+	assert.FileExists(t, "testdata/templates/view.html", "new view.html also exists")
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(viewHandler, false), "GET", "/view/testdata/templates/view.html", nil),
+		html)
+	// verify that it works
+	body := assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/templates/snow", nil)
+	assert.Contains(t, body, "<h1>Snow</h1>")
+	assert.NotContains(t, body, "Skip")
+	// verify that the top level still uses the old template
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/index", nil),
+		"Skip navigation")
+}

upload_drop.go

@@ -7,6 +7,7 @@ import (
 	"image/jpeg"
 	"image/png"
 	"io"
+	"log"
 	"net/http"
 	"net/url"
 	"os"
@@ -41,8 +42,10 @@ func uploadHandler(w http.ResponseWriter, r *http.Request, dir string) {
 	if quality != "" {
 		data.Quality = quality
 	}
-	last := r.FormValue("last")
-	if last != "" {
+	name := r.FormValue("filename")
+	if name != "" {
+		data.Name = name
+	} else if last := r.FormValue("last"); last != "" {
 		ext := strings.ToLower(filepath.Ext(last))
 		switch ext {
 		case ".png", ".jpg", ".jpeg":
@@ -57,42 +60,50 @@ func uploadHandler(w http.ResponseWriter, r *http.Request, dir string) {
 			}
 		}
 	}
-	renderTemplate(w, "upload", data)
+	renderTemplate(w, dir, "upload", data)
 }
 
 // dropHandler takes the "name" form field and the "file" form file and saves the file under the given name. The browser
-// is redirected to the view of that file.
+// is redirected to the view of that file. Some errors are for the users and some are for users and the admins. Those
+// later errors are printed, too.
 func dropHandler(w http.ResponseWriter, r *http.Request, dir string) {
-	d := path.Dir(dir)
+	d := filepath.Dir(filepath.FromSlash(dir))
 	// ensure the directory exists
 	fi, err := os.Stat(d)
 	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
+		http.Error(w, err.Error(), http.StatusBadRequest)
 		return
 	}
 	if !fi.IsDir() {
-		http.Error(w, "file exists", http.StatusInternalServerError)
+		http.Error(w, "directory does not exist", http.StatusBadRequest)
 		return
 	}
 	data := url.Values{}
 	name := r.FormValue("name")
 	data.Set("last", name)
 	filename := filepath.Base(name)
-	if filename == "." || filepath.Dir(name) != "." {
-		http.Error(w, "no filename", http.StatusInternalServerError)
+	// no overwriting of hidden files or adding subdirectories
+	if strings.HasPrefix(filename, ".") || filepath.Dir(name) != "." {
+		http.Error(w, "no filename", http.StatusForbidden)
 		return
 	}
 	file, _, err := r.FormFile("file")
 	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
+		http.Error(w, err.Error(), http.StatusBadRequest)
 		return
 	}
 	defer file.Close()
-	backup(filename)
-	// create the new file
-	path := d + "/" + filename
+	path := filepath.Join(d, filename)
+	watches.ignore(path)
+	err = backup(path)
+	if err != nil {
+		log.Println(err)
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
 	dst, err := os.Create(path)
 	if err != nil {
+		log.Println(err)
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 		return
 	}
@@ -102,7 +113,7 @@ func dropHandler(w http.ResponseWriter, r *http.Request, dir string) {
 	if len(maxwidth) > 0 {
 		mw, err := strconv.Atoi(maxwidth)
 		if err != nil {
-			http.Error(w, err.Error(), http.StatusInternalServerError)
+			http.Error(w, err.Error(), http.StatusBadRequest)
 			return
 		}
 		data.Add("maxwidth", maxwidth)
@@ -118,14 +129,14 @@ func dropHandler(w http.ResponseWriter, r *http.Request, dir string) {
 			if len(quality) > 0 {
 				q, err = strconv.Atoi(quality)
 				if err != nil {
-					http.Error(w, err.Error(), http.StatusInternalServerError)
+					http.Error(w, err.Error(), http.StatusBadRequest)
 					return
 				}
 				data.Add("quality", quality)
 			}
 			encoder = imgio.JPEGEncoder(q)
 		default:
-			http.Error(w, "Resizing images requires a .png, .jpg or .jpeg extension for the filename", http.StatusInternalServerError)
+			http.Error(w, "Resizing images requires a .png, .jpg or .jpeg extension for the filename", http.StatusBadRequest)
 			return
 		}
 		// try and decode the data in various formats
@@ -137,7 +148,8 @@ func dropHandler(w http.ResponseWriter, r *http.Request, dir string) {
 			img, err = goheif.Decode(file)
 		}
 		if err != nil {
-			http.Error(w, "The image could not be decoded (only PNG, JPG and HEIC formats are supported for resizing)", http.StatusInternalServerError)
+			http.Error(w, "The image could not be decoded (only PNG, JPG and HEIC formats are supported for resizing)", http.StatusBadRequest)
+			return
 		}
 		rect := img.Bounds()
 		width := rect.Max.X - rect.Min.X
@@ -145,19 +157,39 @@ func dropHandler(w http.ResponseWriter, r *http.Request, dir string) {
 			height := (rect.Max.Y - rect.Min.Y) * mw / width
 			img = transform.Resize(img, mw, height, transform.Linear)
 			if err := imgio.Save(path, img, encoder); err != nil {
+				log.Println(err)
 				http.Error(w, err.Error(), http.StatusInternalServerError)
 				return
 			}
 		} else {
-			http.Error(w, "The file is too small for this", http.StatusInternalServerError)
+			http.Error(w, "The file is too small for this", http.StatusBadRequest)
 			return
 		}
 	} else {
 		// just copy the bytes
-		if _, err := io.Copy(dst, file); err != nil {
+		n, err := io.Copy(dst, file)
+		if err != nil {
+			log.Println(err)
 			http.Error(w, err.Error(), http.StatusInternalServerError)
 			return
 		}
+		// if zero bytes were copied, delete the file instead
+		if n == 0 {
+			err := os.Remove(path)
+			if err != nil {
+				log.Println(err)
+				http.Error(w, err.Error(), http.StatusInternalServerError)
+				return
+			}
+			log.Println("Delete", path)
+		}
 	}
-	http.Redirect(w, r, "/upload/"+d+"/?"+data.Encode(), http.StatusFound)
+	username, _, ok := r.BasicAuth()
+	if ok {
+		log.Println("Save", path, "by", username)
+	} else {
+		log.Println("Save", path)
+	}
+	updateTemplate(path)
+	http.Redirect(w, r, "/upload/"+dir+"?"+data.Encode(), http.StatusFound)
 }

upload_drop_test.go

@@ -25,7 +25,8 @@ func TestUpload(t *testing.T) {
 	assert.NoError(t, err)
 	file, err := writer.CreateFormFile("file", "example.txt")
 	assert.NoError(t, err)
-	file.Write([]byte("Hello!"))
+	_, err = file.Write([]byte("Hello!"))
+	assert.NoError(t, err)
 	err = writer.Close()
 	assert.NoError(t, err)
 	HTTPUploadAndRedirectTo(t, makeHandler(dropHandler, false), "/drop/testdata/files/",
@@ -67,6 +68,30 @@ func TestUploadJpg(t *testing.T) {
 		writer.FormDataContentType(), form, "/upload/testdata/jpg/?last=ok.jpg")
 }
 
+func TestDeleteFile(t *testing.T) {
+	cleanup(t, "testdata/delete")
+	os.MkdirAll("testdata/delete", 0755)
+	assert.NoError(t, os.WriteFile("testdata/delete/nothing.txt", []byte(`# Nothing
+
+I pause and look up
+Look at the mountains you say
+What happened just now?`), 0644))
+	// check that it worked
+	assert.FileExists(t, "testdata/delete/nothing.txt")
+	// delete it by upload a zero byte file
+	form := new(bytes.Buffer)
+	writer := multipart.NewWriter(form)
+	field, _ := writer.CreateFormField("name")
+	field.Write([]byte("nothing.txt"))
+	file, _ := writer.CreateFormFile("file", "test.txt")
+	file.Write([]byte(""))
+	writer.Close()
+	HTTPUploadAndRedirectTo(t, makeHandler(dropHandler, false), "/drop/testdata/delete/",
+		writer.FormDataContentType(), form, "/upload/testdata/delete/?last=nothing.txt")
+	// check that it worked
+	assert.NoFileExists(t, "testdata/delete/nothing.txt")
+}
+
 func TestUploadMultiple(t *testing.T) {
 	cleanup(t, "testdata/multi")
 	p := &Page{Name: "testdata/multi/culture", Body: []byte(`# Culture
@@ -78,7 +103,7 @@ But here: jasmin dreams`)}
 
 	// check location for upload
 	body := assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/multi/culture", nil)
-	assert.Contains(t, body, `href="/upload/testdata/multi/"`)
+	assert.Contains(t, body, `href="/upload/testdata/multi/?filename=culture-1.jpg"`)
 
 	// check location for drop
 	body = assert.HTTPBody(makeHandler(uploadHandler, false), "GET", "/upload/testdata/multi/", nil)
@@ -115,11 +140,8 @@ But here: jasmin dreams`)}
 }
 
 func TestUploadDir(t *testing.T) {
-	t.Cleanup(func() {
-		assert.NoError(t, os.Remove("test.md"))
-		assert.NoError(t, os.Remove("test.jpg"))
-	})
-	p := &Page{Name: "test", Body: []byte(`# Test
+	cleanup(t, "testdata/dir")
+	p := &Page{Name: "testdata/dir/test", Body: []byte(`# Test
 
 Eyes are an abyss
 We stare into each other
@@ -127,12 +149,12 @@ There is no answer`)}
 	p.save()
 
 	// check location for upload
-	body := assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/test", nil)
-	assert.Contains(t, body, `href="/upload/"`)
+	body := assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/dir/test", nil)
+	assert.Contains(t, body, `href="/upload/testdata/dir/?filename=test-1.jpg"`)
 
 	// check location for drop
-	body = assert.HTTPBody(makeHandler(uploadHandler, false), "GET", "/upload/", nil)
-	assert.Contains(t, body, `action="/drop/"`)
+	body = assert.HTTPBody(makeHandler(uploadHandler, false), "GET", "/upload/testdata/dir/", nil)
+	assert.Contains(t, body, `action="/drop/testdata/dir/"`)
 
 	// actually do the upload
 	form := new(bytes.Buffer)
@@ -143,14 +165,14 @@ There is no answer`)}
 	img := image.NewRGBA(image.Rect(0, 0, 20, 20))
 	jpeg.Encode(file, img, &jpeg.Options{Quality: 90})
 	writer.Close()
-	location := HTTPUploadLocation(t, makeHandler(dropHandler, false), "/drop/",
+	location := HTTPUploadLocation(t, makeHandler(dropHandler, false), "/drop/testdata/dir/",
 		writer.FormDataContentType(), form)
 	url, _ := url.Parse(location)
-	assert.Equal(t, "/upload/", url.Path, "Redirect to upload location")
+	assert.Equal(t, "/upload/testdata/dir/", url.Path, "Redirect to upload location")
 	values := url.Query()
 	assert.Equal(t, "test.jpg", values.Get("last"))
 
 	// check the result page
 	body = assert.HTTPBody(makeHandler(uploadHandler, false), "GET", url.Path, values)
-	assert.Contains(t, body, `src="/view/test.jpg"`)
+	assert.Contains(t, body, `src="/view/testdata/dir/test.jpg"`)
 }

version_cmd.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"github.com/google/subcommands"
+	"io"
+	"os"
+	"runtime/debug"
+)
+
+type versionCmd struct {
+}
+
+func (cmd *versionCmd) SetFlags(f *flag.FlagSet) {
+}
+
+func (*versionCmd) Name() string     { return "version" }
+func (*versionCmd) Synopsis() string { return "report build information" }
+func (*versionCmd) Usage() string {
+	return `version:
+  Report all the debug information about this build.
+`
+}
+
+func (cmd *versionCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
+	return versionCli(os.Stdout, f.Args())
+}
+
+func versionCli(w io.Writer, args []string) subcommands.ExitStatus {
+	if len(args) > 0 {
+		fmt.Fprintln(os.Stderr, "Version takes no arguments.")
+		return subcommands.ExitFailure
+	}
+	info, _ := debug.ReadBuildInfo()
+	fmt.Println(info)
+	return subcommands.ExitSuccess
+}

version_cmd_test.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"bytes"
+	"github.com/google/subcommands"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestVersionCmd(t *testing.T) {
+	b := new(bytes.Buffer)
+	s := versionCli(b, nil)
+	assert.Equal(t, subcommands.ExitSuccess, s)
+	assert.Contains(t, "vcs.revision", b.String())
+}

view.go

@@ -1,89 +1,126 @@
 package main
 
 import (
+	"io"
 	"net/http"
 	"os"
-	"path"
+	urlpath "path"
+	"path/filepath"
 	"strings"
 	"time"
 )
 
-// rootHandler just redirects to /view/index.
+// rootHandler just redirects to /view/index. The root handler handles requests to the root path, and – implicity – all
+// unhandled request. Thus, if the URL path is not "/", return a 404 NOT FOUND response.
 func rootHandler(w http.ResponseWriter, r *http.Request) {
-	http.Redirect(w, r, "/view/index", http.StatusFound)
+	if r.URL.Path != "/" {
+		http.NotFound(w, r)
+	} else {
+		http.Redirect(w, r, "/view/index", http.StatusFound)
+	}
 }
 
-// viewHandler serves pages. If the requested URL maps to an existing file, it is served. If the requested URL maps to a
-// directory, the browser is redirected to the index page. If the requested URL ends in ".rss" and the corresponding
-// file ending with ".md" exists, a feed is generated and the "feed.html" template is used (it is used to generate a RSS
-// 2.0 feed, no matter what the template's extension is). If the requested URL maps to a page name, the corresponding
-// file (ending in ".md") is loaded and served using the "view.html" template. If none of the above, the browser is
-// redirected to an edit page.
+// viewHandler serves pages. If the requested URL ends in ".rss" and the corresponding file ending with ".md" exists, a
+// feed is generated and the "feed.html" template is used (it is used to generate a RSS 2.0 feed, even if the extension
+// is ".html"). If the requested URL maps to a page name, the corresponding file (by appending ".md") is loaded and
+// served using the "view.html" template. If the requested URL maps to an existing file, it is served (you can therefore
+// request the ".md" files directly). If the requested URL maps to a directory, the browser is redirected to the index
+// page. If none of the above, the browser is redirected to an edit page.
+//
+// Uploading files ending in ".rss" does not prevent RSS feed generation.
 //
 // Caching: a 304 NOT MODIFIED is returned if the request has an If-Modified-Since header that matches the file's
 // modification time, truncated to one second. Truncation is required because the file's modtime has sub-second
 // precision and the HTTP timestamp for the Last-Modified header has not.
-func viewHandler(w http.ResponseWriter, r *http.Request, name string) {
-	file := true
-	rss := false
-	if name == "" {
-		name = "."
-	}
-	fn := name
-	fi, err := os.Stat(fn)
-	if err != nil {
-		file = false
-		if strings.HasSuffix(fn, ".rss") {
-			rss = true
-			name = fn[0 : len(fn)-4]
-			fn = name
-		}
-		fn += ".md"
-		fi, err = os.Stat(fn)
-	} else if fi.IsDir() {
-		http.Redirect(w, r, path.Join("/view", name, "index"), http.StatusFound)
-		return
+func viewHandler(w http.ResponseWriter, r *http.Request, path string) {
+	const (
+		unknown = iota
+		file
+		page
+		rss
+		dir
+	)
+	t := unknown
+	if strings.HasSuffix(path, ".rss") {
+		path = path[:len(path)-4]
+		t = rss
 	}
+	fp := filepath.FromSlash(path)
+	fi, err := os.Stat(fp+".md")
 	if err == nil {
-		h, ok := r.Header["If-Modified-Since"]
-		if ok {
-			ti, err := http.ParseTime(h[0])
-			if err == nil && !fi.ModTime().Truncate(time.Second).After(ti) {
-				w.WriteHeader(http.StatusNotModified)
-				return
+		if fi.IsDir() {
+			t = dir // directory ending in ".md"
+		} else if t == unknown {
+			t = page
+		}
+		// otherwise t == rss
+	} else {
+		if fp == "" {
+			fp = "." // make sure Stat works
+		}
+		fi, err = os.Stat(fp)
+		if err == nil {
+			if fi.IsDir() {
+				t = dir
+			} else {
+				t = file
 			}
 		}
-		w.Header().Set("Last-Modified", fi.ModTime().UTC().Format(http.TimeFormat))
 	}
-	if r.Method == http.MethodHead {
-		if err == nil {
-			return
-		}
-		http.Redirect(w, r, "/edit/"+name, http.StatusFound)
-	}
-	if file {
-		body, err := os.ReadFile(fn)
-		if err != nil {
-			// This is an internal error because os.Stat
-			// says there is a file. Non-existent files
-			// are treated like pages.
-			http.Error(w, err.Error(), http.StatusInternalServerError)
-		}
-		w.Write(body)
+	// if nothing was found, offer to create it
+	if t == unknown {
+		http.Redirect(w, r, "/edit/"+path, http.StatusFound)
 		return
 	}
-	p, err := loadPage(name)
+	// directories are redirected to the index page
+	if t == dir {
+		http.Redirect(w, r, urlpath.Join("/view", path, "index"), http.StatusFound)
+		return
+	}
+	// if the page has not been modified, return (file, rss or page)
+	h, ok := r.Header["If-Modified-Since"]
+	if ok {
+		ti, err := http.ParseTime(h[0])
+		if err == nil && !fi.ModTime().Truncate(time.Second).After(ti) {
+			w.WriteHeader(http.StatusNotModified)
+			return
+		}
+	}
+	// if only the headers were requested, return
+	w.Header().Set("Last-Modified", fi.ModTime().UTC().Format(http.TimeFormat))
+	if r.Method == http.MethodHead {
+		w.WriteHeader(http.StatusOK)
+		return
+	}
+	if t == file {
+		file, err := os.Open(fp)
+		if err != nil {
+			http.Error(w, err.Error(), http.StatusInternalServerError)
+			return
+		}
+		_, err = io.Copy(w, file)
+		if err != nil {
+			http.Error(w, err.Error(), http.StatusInternalServerError)
+			return
+		}
+		return
+	}
+	p, err := loadPage(path)
 	if err != nil {
-		http.Redirect(w, r, "/edit/"+name, http.StatusFound)
+		if t == rss {
+			http.Error(w, err.Error(), http.StatusNotFound)
+			return
+		}
+		http.Redirect(w, r, "/edit/"+path, http.StatusFound)
 		return
 	}
 	p.handleTitle(true)
-	if rss {
+	if t == rss {
 		it := feed(p, fi.ModTime())
 		w.Write([]byte(`<?xml version="1.0" encoding="UTF-8"?>`))
-		renderTemplate(w, "feed", it)
+		renderTemplate(w, p.Dir(), "feed", it)
 		return
 	}
 	p.renderHtml()
-	renderTemplate(w, "view", p)
+	renderTemplate(w, p.Dir(), "view", p)
 }

view.html

@@ -6,7 +6,7 @@
     <meta name="viewport" content="width=device-width">
     <title>{{.Title}}</title>
     <style>
-html { max-width: 65ch; padding: 1ch; margin: auto; color: #111; background-color: #ffe; }
+html { max-width: 70ch; padding: 1ch; margin: auto; color: #111; background-color: #ffe; }
 body { hyphens: auto; }
 header a { margin-right: 1ch; }
 form { display: inline-block; }
@@ -19,11 +19,12 @@ img { max-width: 100%; }
   <body>
     <header>
       <a href="#main">Skip navigation</a>
-      <a href="/view/index">Home</a>
+      <a href="index">Home</a>
       <a href="/edit/{{.Name}}" accesskey="e">Edit</a>
       <a href="/add/{{.Name}}" accesskey="a">Add</a>
       <a href="/diff/{{.Name}}" accesskey="d">Diff</a>
-      <a href="/upload/{{.Dir}}" accesskey="u">Upload</a>
+      <a href="/archive/{{.Dir}}data.zip" accesskey="z">Zip</a>
+      <a href="/upload/{{.Dir}}?filename={{.Base}}-1.jpg" accesskey="u">Upload</a>
       <form role="search" action="/search/{{.Dir}}" method="GET">
         <label for="search">Search:</label>
         <input id="search" type="text" spellcheck="false" name="q" accesskey="f" placeholder="term #tag title:term blog:true" required>

view_test.go

@@ -5,7 +5,6 @@ import (
 	"net/http"
 	"net/url"
 	"os"
-	"regexp"
 	"testing"
 )
 
@@ -15,22 +14,42 @@ func TestRootHandler(t *testing.T) {
 
 // relies on index.md in the current directory!
 func TestViewHandler(t *testing.T) {
-	assert.Regexp(t, regexp.MustCompile("Welcome to Oddµ"),
-		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/index", nil))
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/index", nil),
+		"Welcome to Oddµ")
 }
 
 func TestViewHandlerDir(t *testing.T) {
+	cleanup(t, "testdata/dir")
 	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/", nil, "/view/index")
-	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/man", nil, "/view/man/index")
-	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/man/", nil, "/view/man/index")
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata", nil, "/view/testdata/index")
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata/", nil, "/view/testdata/index")
+	assert.NoError(t, os.Mkdir("testdata/dir", 0755))
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata/dir", nil, "/view/testdata/dir/index")
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata/dir/", nil, "/view/testdata/dir/index")
+	assert.NoError(t, os.Mkdir("testdata/dir/dir", 0755))
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata/dir", nil, "/view/testdata/dir/index")
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata/dir/", nil, "/view/testdata/dir/index")
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata/dir/dir", nil, "/view/testdata/dir/dir/index")
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata/dir/dir/", nil, "/view/testdata/dir/dir/index")
+	assert.NoError(t, os.WriteFile("testdata/dir/dir.md", []byte(`# Blackbird
+
+The oven hums and
+the music plays, coffee smells
+blackbirds sing outside
+`), 0644))
+	assert.Contains(t, assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/dir/dir", nil), "<h1>Blackbird</h1>")
+	assert.Contains(t, assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/dir/dir.md", nil), "# Blackbird")
+	HTTPRedirectTo(t, makeHandler(viewHandler, true), "GET", "/view/testdata/dir/dir/", nil, "/view/testdata/dir/dir/index")
 }
 
 // relies on index.md in the current directory!
 func TestViewHandlerWithId(t *testing.T) {
 	data := make(url.Values)
 	data.Set("id", "index")
-	assert.Regexp(t, regexp.MustCompile("Welcome to Oddµ"),
-		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/", data))
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/", data),
+		"Welcome to Oddµ")
 }
 
 func TestPageTitleWithAmp(t *testing.T) {
@@ -39,14 +58,16 @@ func TestPageTitleWithAmp(t *testing.T) {
 	p := &Page{Name: "testdata/amp/Rock & Roll", Body: []byte("Dancing")}
 	p.save()
 
-	assert.Regexp(t, regexp.MustCompile("Rock &amp; Roll"),
-		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/amp/Rock%20%26%20Roll", nil))
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/amp/Rock%20%26%20Roll", nil),
+		"Rock &amp; Roll")
 
 	p = &Page{Name: "testdata/amp/Rock & Roll", Body: []byte("# Sex & Drugs & Rock'n'Roll\nOh no!")}
 	p.save()
 
-	assert.Regexp(t, regexp.MustCompile("Sex &amp; Drugs"),
-		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/amp/Rock%20%26%20Roll", nil))
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/amp/Rock%20%26%20Roll", nil),
+		"Sex &amp; Drugs")
 }
 
 func TestPageTitleWithQuestionMark(t *testing.T) {
@@ -76,7 +97,13 @@ In the autumn chill
 	HTTPStatusCodeIfModifiedSince(t, h, "/view/testdata/file-mod/now.txt", fi.ModTime())
 }
 
-// wipes testdata
+func TestForbidden(t *testing.T) {
+	assert.HTTPStatusCode(t, makeHandler(viewHandler, true), "GET", "/view/", nil, http.StatusFound)
+	assert.HTTPStatusCode(t, makeHandler(viewHandler, true), "GET", "/view/.", nil, http.StatusForbidden)
+	assert.HTTPStatusCode(t, makeHandler(viewHandler, true), "GET", "/view/.htaccess", nil, http.StatusForbidden)
+	assert.HTTPStatusCode(t, makeHandler(viewHandler, true), "GET", "/view/.git/description", nil, http.StatusForbidden)
+}
+
 func TestPageLastModified(t *testing.T) {
 	cleanup(t, "testdata/page-mod")
 	p := &Page{Name: "testdata/page-mod/now", Body: []byte(`

watch.go

@@ -0,0 +1,206 @@
+package main
+
+import (
+ 	"github.com/fsnotify/fsnotify"
+	"io/fs"
+ 	"log"
+	"os"
+	"path/filepath"
+ 	"slices"
+ 	"strings"
+ 	"sync"
+ 	"time"
+)
+
+// Watches holds a map and a mutex. The map contains the template names that have been requested and the exact time at
+// which they have been requested. Adding the same file multiple times, such as when the watch function sees multiple
+// Write events for the same file, the time keeps getting updated so that when the go routine runs, it only acts on
+// files that haven't been updated in the last second. The go routine is what forces us to use the RWMutex for the map.
+type Watches struct {
+ 	sync.RWMutex
+	ignores map[string]time.Time
+	files map[string]time.Time
+	watcher *fsnotify.Watcher
+}
+
+var watches Watches
+
+func init() {
+	watches.ignores = make(map[string]time.Time)
+	watches.files = make(map[string]time.Time)
+}
+
+// install initializes watches and installs watchers for all directories and subdirectories.
+func (w *Watches) install() (int, error) {
+	// create a watcher for the root directory and never close it
+	var err error
+	w.watcher, err = fsnotify.NewWatcher()
+	if err != nil {
+		log.Println("Creating a watcher for file changes:", err)
+		return 0, err
+	}
+	go w.watch()
+	err = filepath.Walk(".", w.add)
+	if err != nil {
+		return 0, err
+	}
+	return len(w.watcher.WatchList()), nil
+}
+
+// add installs a watch for every directory that isn't hidden. Note that the root directory (".") is not skipped.
+func (w *Watches) add(path string, info fs.FileInfo, err error) error {
+	if err != nil {
+		return err
+	}
+	if info.IsDir() {
+		if path != "." && strings.HasPrefix(filepath.Base(path), ".") {
+			return filepath.SkipDir
+		}
+		err := w.watcher.Add(path)
+		if err != nil {
+			log.Println("Cannot add watch:", path)
+			return err
+		}
+		// log.Println("Watching", path)
+	}
+	return nil
+}
+
+// watch reloads templates that have changed and reindexes fils that have changed. Since there can be multiple writes to
+// a file, there's a 1s delay before a file is actually handled. The reason is that writing a file can cause multiple
+// Write events and we don't want to keep reloading the template while it is being written. Instead, each Write event
+// adds an entry to the files map, or updates the file's time, and starts a go routine. Example: If a file gets three
+// consecutive Write events, the first two go routine invocations won't do anything, since the time kept getting
+// updated. Only the last invocation will act upon the event.
+func (w *Watches) watch() {
+	for {
+		select {
+		case err, ok := <-w.watcher.Errors:
+			if !ok {
+				return
+			}
+			log.Println("Watcher:", err)
+		case e, ok := <-w.watcher.Events:
+			if !ok {
+				return
+			}
+			w.watchHandle(e)
+		}
+	}
+}
+
+// watchHandle is called for every fsnotify.Event. It handles template updates, page updates (both on a 1s timer), and
+// the creation of pages and directories (immediately). Files and directories starting with a dot are skipped.
+// Incidentally, this also prevents rsync updates from generating activity ("stat ./.index.md.tTfPFg: no such file or
+// directory"). Note the painful details: If moving a file into a watched directory, a Create event is received. If a
+// new file is created in a watched directory, a Create event and one or more Write events is received.
+func (w *Watches) watchHandle(e fsnotify.Event) {
+	path := strings.TrimPrefix(e.Name, "./")
+	if strings.HasPrefix(filepath.Base(path), ".") {
+		return;
+	}
+	// log.Println(e)
+	w.Lock()
+	defer w.Unlock()
+	if e.Op.Has(fsnotify.Create | fsnotify.Write) &&
+		(strings.HasSuffix(path, ".html") &&
+			slices.Contains(templateFiles, filepath.Base(path)) ||
+			strings.HasSuffix(path, ".md")) {
+		w.files[path] = time.Now()
+		timer := time.NewTimer(time.Second)
+		go func() {
+			<-timer.C
+			w.Lock()
+			defer w.Unlock()
+			w.watchTimer(path)
+		}()
+	} else if e.Op.Has(fsnotify.Rename | fsnotify.Remove) {
+		w.watchDoRemove(path)
+	} else if e.Op.Has(fsnotify.Create) &&
+		!slices.Contains(w.watcher.WatchList(), path) {
+		fi, err := os.Stat(path)
+		if err != nil {
+			log.Println(err)
+		} else if fi.IsDir() {
+			log.Println("Add watch for", path)
+			w.watcher.Add(path)
+		}
+	}
+}
+
+// watchTimer checks if the file hasn't been updated in 1s and if so, it calls watchDoUpdate. If another write has
+// updated the file, do nothing because another watchTimer will run at the appropriate time and check again.
+func (w *Watches) watchTimer(path string) {
+	t, ok := w.files[path]
+	if ok && t.Add(time.Second).Before(time.Now().Add(time.Nanosecond)) {
+		delete(w.files, path)
+		w.watchDoUpdate(path)
+	}
+}
+
+// Do the right thing right now. For Create events such as directories being created or files being moved into a watched
+// directory, this is the right thing to do. When a file is being written to, watchHandle will have started a timer and
+// will call this function after 1s of no more writes. If, however, the path is in the ignores map, do nothing.
+func (w *Watches) watchDoUpdate(path string) {
+	_, ignored := w.ignores[path]
+	if ignored {
+		return
+	} else if strings.HasSuffix(path, ".html") {
+		updateTemplate(path)
+	} else if strings.HasSuffix(path, ".md") {
+		p, err := loadPage(path[:len(path)-3]) // page name without ".md"
+		if err != nil {
+			log.Println("Cannot load page", path)
+		} else {
+			log.Println("Update index for", path)
+			index.update(p)
+		}
+	} else if !slices.Contains(w.watcher.WatchList(), path) {
+		fi, err := os.Stat(path)
+		if err != nil {
+			log.Println(err)
+			return
+		}
+		if fi.IsDir() {
+			log.Println("Add watch for", path)
+			w.watcher.Add(path)
+		}
+	}
+}
+
+// watchDoRemove removes files from the index or discards templates. If the path in question is in the ignores map, do
+// nothing.
+func (w *Watches) watchDoRemove(path string) {
+	_, ignored := w.ignores[path]
+	if ignored {
+		return
+	} else if strings.HasSuffix(path, ".html") {
+		removeTemplate(path)
+	} else if strings.HasSuffix(path, ".md") {
+		_, err := os.Stat(path)
+		if err == nil {
+			log.Println("Cannot remove existing page from the index", path)
+		} else {
+			log.Println("Deindex", path)
+			index.deletePageName(path[:len(path)-3]) // page name without ".md"
+		}
+	}
+}
+
+// ignore is before code that is known suspected save files and trigger watchHandle eventhough the code already handles
+// this. This is achieved by adding the path to the ignores map for 1s.
+func (w *Watches) ignore(path string) {
+	w.Lock()
+	defer w.Unlock()
+	w.ignores[path] = time.Now()
+	timer := time.NewTimer(time.Second)
+	go func() {
+		<-timer.C
+		w.Lock()
+		defer w.Unlock()
+		t := w.ignores[path]
+		if t.Add(time.Second).Before(time.Now().Add(time.Nanosecond)) {
+			delete(w.ignores, path)
+		}
+	}()
+}

watch_test.go

@@ -0,0 +1,89 @@
+package main
+
+import (
+	"github.com/stretchr/testify/assert"
+	"os"
+	"testing"
+ 	"time"
+)
+
+func TestWatchedPageUpdate(t *testing.T) {
+	dir := "testdata/watched-page"
+	path := dir + "/haiku.md"
+	cleanup(t, dir)
+	index.load()
+	watches.install()
+	assert.NoError(t, os.MkdirAll(dir, 0755))
+	time.Sleep(time.Millisecond)
+	assert.Contains(t, watches.watcher.WatchList(), dir)
+
+	haiku := []byte(`# Pine cones
+
+Soft steps on the trail
+Up and up in single file
+Who ate half a cone?`)
+	assert.NoError(t, os.WriteFile(path, haiku, 0644))
+
+	time.Sleep(time.Millisecond)
+
+	watches.RLock()
+	assert.Contains(t, watches.files, path)
+	watches.RUnlock()
+
+	watches.Lock()
+	watches.files[path] = watches.files[path].Add(-2 * time.Second)
+	watches.Unlock()
+
+	watches.watchTimer(path)
+
+	index.RLock()
+	assert.Contains(t, index.titles, path[:len(path)-3])
+	index.RUnlock()
+}
+
+func TestWatchedTemplateUpdate(t *testing.T) {
+	dir := "testdata/watched-template"
+	name := dir + "/raclette"
+	path := dir + "/view.html"
+	cleanup(t, dir)
+	index.load()
+	watches.install()
+	assert.NoError(t, os.MkdirAll(dir, 0755))
+
+	time.Sleep(time.Millisecond)
+
+	assert.Contains(t, watches.watcher.WatchList(), dir)
+
+	p := &Page{Name: name, Body: []byte(`# Raclette
+
+The heat element
+glows red and the cheese bubbles
+the smell is everywhere
+`)}
+	p.save()
+	assert.Contains(t,
+		assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/testdata/watched-template/raclette", nil),
+		"Skip navigation")
+	
+	// save a new view handler directly
+	assert.NoError(t,
+		os.WriteFile(path,
+			[]byte("<body><h1>{{.Title}}</h1>{{.Html}}"),
+			0644))
+
+	time.Sleep(time.Millisecond)
+
+	watches.RLock()
+	assert.Contains(t, watches.files, path)
+	watches.RUnlock()
+
+	watches.Lock()
+	watches.files[path] = watches.files[path].Add(-2 * time.Second)
+	watches.Unlock()
+
+	watches.watchTimer(path)
+	
+	body := assert.HTTPBody(makeHandler(viewHandler, true), "GET", "/view/" + name, nil)
+	assert.Contains(t, body, "<h1>Raclette</h1>") // page text is still there
+	assert.NotContains(t, body, "Skip") // but the header is not
+}

wiki.go

@@ -3,12 +3,15 @@ package main
 import (
 	"context"
 	"flag"
+	"fmt"
 	"github.com/google/subcommands"
-	"html/template"
+	"io/fs"
 	"log"
+	"net"
 	"net/http"
 	"os"
 	"regexp"
+	"strings"
 )
 
 // validPath is a regular expression where the second group matches a page, so when the editHandler is called, a URL
@@ -21,22 +24,19 @@ var validPath = regexp.MustCompile("^/([^/]+)/(.*)$")
 // instead.
 var titleRegexp = regexp.MustCompile("(?m)^#\\s*(.*)\n+")
 
-// renderTemplate is the helper that is used render the templates with data. If the templates cannot be found, that's
-// fatal.
-func renderTemplate(w http.ResponseWriter, tmpl string, data any) {
-	templates := loadTemplates()
-	err := templates.ExecuteTemplate(w, tmpl+".html", data)
-	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
-	}
-}
-
 // makeHandler returns a handler that uses the URL path without the first path element as its argument, e.g. if the URL
 // path is /edit/foo/bar, the editHandler is called with "foo/bar" as its argument. This uses the second group from the
 // validPath regular expression. The boolean argument indicates whether the following path is required. When false, a
 // URL like /upload/ is OK. The argument can also be provided using a form parameter, i.e. call /edit/?id=foo/bar.
 func makeHandler(fn func(http.ResponseWriter, *http.Request, string), required bool) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		// no hidden files or directories
+		for _, segment := range strings.Split(r.URL.Path, "/") {
+			if strings.HasPrefix(segment, ".") {
+				http.Error(w, "can neither confirm nor deny the existence of this resource", http.StatusForbidden)
+				return
+			}
+		}
 		m := validPath.FindStringSubmatch(r.URL.Path)
 		if m != nil && (!required || len(m[2]) > 0) {
 			fn(w, r, m[2])
@@ -48,6 +48,13 @@ func makeHandler(fn func(http.ResponseWriter, *http.Request, string), required b
 			return
 		}
 		id := r.Form.Get("id")
+		// no hidden files or directories
+		for _, segment := range strings.Split(id, "/") {
+			if strings.HasPrefix(segment, ".") {
+				http.Error(w, "can neither confirm nor deny the existence of this resource", http.StatusForbidden)
+				return
+			}
+		}
 		if m != nil {
 			fn(w, r, id)
 			return
@@ -65,6 +72,37 @@ func getPort() string {
 	return port
 }
 
+// When stdin is a socket, getListener returns a listener that listens
+// on the socket passed as stdin.  This allows systemd-style socket
+// activation.
+// Otherwise, getListener returns a net.Listener listening on the address from
+// ODDMU_ADDRESS and the port from ODDMU_PORT.
+// ODDMU_ADDRESS may be either an IPV4 address or an IPv6 address.
+// If ODDMU_ADDRESS is unspecified, then the
+// listener listens on all available unicast addresses, both IPv4 and IPv6.
+func getListener() (net.Listener, error) {
+	address := os.Getenv("ODDMU_ADDRESS")
+	port := getPort()
+
+	stat, err := os.Stdin.Stat()
+	if stat == nil {
+		return nil, err
+	}
+	if stat.Mode().Type() == fs.ModeSocket {
+		// Listening socket passed on stdin, through systemd socket
+		// activation or similar:
+		log.Println("Serving a wiki on a listening socket passed by systemd.")
+		return net.FileListener(os.Stdin)
+	}
+	if strings.ContainsRune(address, ':') {
+		address = fmt.Sprintf("[%s]:%s", address, port)
+	} else {
+		address = fmt.Sprintf("%s:%s", address, port)
+	}
+	log.Printf("Serving a wiki at address %s", address)
+	return net.Listen("tcp", address)
+}
+
 // scheduleLoadIndex calls index.load and prints some messages before and after. For testing, call index.load directly
 // and skip the messages.
 func scheduleLoadIndex() {
@@ -85,20 +123,25 @@ func scheduleLoadLanguages() {
 	log.Printf("Loaded %d languages", n)
 }
 
-// loadTemplates loads the templates. These aren't always required. If the templates are required and cannot be loaded,
-// this a fatal error and the program exits.
-func loadTemplates() *template.Template {
-	templates, err := template.ParseFiles("edit.html", "add.html", "view.html",
-		"diff.html", "search.html", "static.html", "upload.html", "feed.html")
-	if err != nil {
-		log.Println("Templates:", err)
-		os.Exit(1)
+// scheduleInstallWatcher calls watches.install and prints some messages before and after. For testing, call watch.init
+// directly and skip the messages.
+func scheduleInstallWatcher() {
+	log.Print("Installing watcher")
+	n, err := watches.install()
+	if err == nil {
+		if n == 1 {
+			log.Println("Installed watchers for one directory")
+		} else {
+			log.Printf("Installed watchers for %d directories", n)
+		}
+	} else {
+		log.Printf("Installing watcher failed: %s", err)
 	}
-	return templates
 }
 
 func serve() {
 	http.HandleFunc("/", rootHandler)
+	http.HandleFunc("/archive/", makeHandler(archiveHandler, true))
 	http.HandleFunc("/view/", makeHandler(viewHandler, true))
 	http.HandleFunc("/diff/", makeHandler(diffHandler, true))
 	http.HandleFunc("/edit/", makeHandler(editHandler, true))
@@ -110,12 +153,15 @@ func serve() {
 	http.HandleFunc("/search/", makeHandler(searchHandler, false))
 	go scheduleLoadIndex()
 	go scheduleLoadLanguages()
-	initAccounts()
-	port := getPort()
-	log.Printf("Serving a wiki on port %s", port)
-	err := http.ListenAndServe(":"+port, nil)
-	if err != nil {
+	go scheduleInstallWatcher()
+	listener, err := getListener()
+	if listener == nil {
 		log.Println(err)
+	} else {
+		err := http.Serve(listener, nil)
+		if err != nil {
+			log.Println(err)
+		}
 	}
 }
 
@@ -127,11 +173,12 @@ func commands() {
 	subcommands.Register(subcommands.CommandsCommand(), "")
 	subcommands.Register(&htmlCmd{}, "")
 	subcommands.Register(&listCmd{}, "")
-	subcommands.Register(&staticCmd{}, "")
-	subcommands.Register(&searchCmd{}, "")
-	subcommands.Register(&replaceCmd{}, "")
 	subcommands.Register(&missingCmd{}, "")
 	subcommands.Register(&notifyCmd{}, "")
+	subcommands.Register(&replaceCmd{}, "")
+	subcommands.Register(&searchCmd{}, "")
+	subcommands.Register(&staticCmd{}, "")
+	subcommands.Register(&versionCmd{}, "")
 
 	flag.Parse()
 	ctx := context.Background()

wiki_test.go

@@ -86,63 +86,22 @@ func HTTPStatusCodeIfModifiedSince(t *testing.T, handler http.HandlerFunc, url s
 	assert.Equal(t, http.StatusNotModified, w.Code)
 }
 
-// restore remembers the file content before the test starts and restores the file at the end. Important for files such
-// as "index.md".
-func restore(t *testing.T, files ...string) {
-	data := make(map[string][]byte)
-	stat := make(map[string]os.FileInfo)
-	for _, file := range files {
-		s, err := os.Stat(file)
-		if err != nil {
-			t.Log("Could not stat ", file, ": ", err)
-			continue
-		}
-		c, err := os.ReadFile(file)
-		if err != nil {
-			t.Log("Could not read ", file, ": ", err)
-			continue
-		}
-		stat[file] = s
-		data[file] = c
-
-	}
+// cleanup deletes a directory mentioned and removes all pages in that directory from the index.
+func cleanup(t *testing.T, dir string) {
 	t.Cleanup(func() {
-		for file, c := range data {
-			m := stat[file].Mode()
-			err := os.WriteFile(file, c, m)
-			if err != nil {
-				t.Log("Could not restore ", file, ": ", err)
-			}
-			t := stat[file].ModTime()
-			os.Chtimes(file, t, t)
-		}
-	})
-}
-
-// cleanup deletes any directories mentioned and removes all pages in those directories from the index. Incidentally, if
-// a filename such as "changes.md" or "changes.md~" is provided instead of a directory, then that page file is removed
-// and any mention of it is removed from the index.
-func cleanup(t *testing.T, dirs ...string) {
-	t.Cleanup(func() {
-		for _, dir := range dirs {
-			_ = os.RemoveAll(dir)
-		}
+		_ = os.RemoveAll(dir)
 		index.Lock()
 		defer index.Unlock()
 		for name := range index.titles {
-			for _, dir := range dirs {
-				if strings.HasPrefix(name, dir) {
-					delete(index.titles, name)
-				}
+			if strings.HasPrefix(name, dir) {
+				delete(index.titles, name)
 			}
 		}
 		ids := []docid{}
 		for id, name := range index.documents {
-			for _, dir := range dirs {
-				if strings.HasPrefix(name, dir) {
-					delete(index.documents, id)
-					ids = append(ids, id)
-				}
+			if strings.HasPrefix(name, dir) {
+				delete(index.documents, id)
+				ids = append(ids, id)
 			}
 		}
 		for hashtag, docs := range index.token {