summaryrefslogtreecommitdiff
path: root/gopher.go
diff options
context:
space:
mode:
Diffstat (limited to 'gopher.go')
-rw-r--r--gopher.go64
1 files changed, 33 insertions, 31 deletions
diff --git a/gopher.go b/gopher.go
index 3ad5ed2..d715641 100644
--- a/gopher.go
+++ b/gopher.go
@@ -3,11 +3,9 @@ package syw
import (
"bytes"
"context"
- "mime"
"os"
"path"
"path/filepath"
- "strings"
"text/template"
"tildegit.org/tjp/sliderule"
@@ -17,44 +15,48 @@ import (
// GopherRouter builds a router that will handle gopher requests in a directory of git repositories.
//
// The routes it defines are:
-// / .gph listing of the repositories in the directory
-// /:repository .gph overview of the repository
-// /:repository/branches .gph list of branches/head
-// /:repository/tags .gph listing of tags
-// /:repository/refs/:ref .gph overview of a ref
-// /:repository/refs/:ref/tree .gph listing of a ref's root directory
-// /:repository/refs/:ref/tree/*path for directories:.gph list of contents
-// for files: raw files (guessed item type text/binary/image/etc)
-// /:repository/diffstat/:fromref/:toref text diffstat between two refs
-// /:repository/diff/:fromref/:toref text diff between two refs
+//
+// / .gph listing of the repositories in the directory
+// /:repository .gph overview of the repository
+// /:repository/branches .gph list of branches/head
+// /:repository/tags .gph listing of tags
+// /:repository/refs/:ref .gph overview of a ref
+// /:repository/refs/:ref/tree .gph listing of a ref's root directory
+// /:repository/refs/:ref/tree/*path for directories:.gph list of contents
+// for files: raw files (guessed item type text/binary/image/etc)
+// /:repository/diffstat/:fromref/:toref text diffstat between two refs
+// /:repository/diff/:fromref/:toref text diff between two refs
//
// The overrides argument can provide templates to define the behavior of nearly all of the above routes.
// All of them have default implementations, so the argument can be nil, but otherwise the template names
// used are:
-// repo_root.gph gophermap at /
-// repo_home.gph gophermap at /:repository
-// branch_list.gph gophermap at /:repository/branches
-// tag_list.gph gophermap at /:repository/tags
-// ref.gph gophermap at /:repository/refs/:ref
-// tree.gph gophermap at direcotry paths under /:repository/refs/:ref/tree/*path
-// (file paths return the raw files without any template involved)
-// diffstat.gph.txt plain text diffstat at /:repository/diffstat/:fromref/:toref
-// diff.gph.txt plain text diff at /:repository/diff/:fromref/:toref
+//
+// repo_root.gph gophermap at /
+// repo_home.gph gophermap at /:repository
+// branch_list.gph gophermap at /:repository/branches
+// tag_list.gph gophermap at /:repository/tags
+// ref.gph gophermap at /:repository/refs/:ref
+// tree.gph gophermap at direcotry paths under /:repository/refs/:ref/tree/*path
+// (file paths return the raw files without any template involved)
+// diffstat.gph.txt plain text diffstat at /:repository/diffstat/:fromref/:toref
+// diff.gph.txt plain text diff at /:repository/diff/:fromref/:toref
//
// Most of the templates above are rendered with an object with 6 fields:
-// Ctx: the context.Context from the request
-// Repo: a *syw.Repository corresponding to <repodir>/:repository
-// Params: the map[string]string of the route parameters
-// Host: the hostname of the running server
-// Port: the port number of the running server
-// Selector: the selector in the current request
+//
+// Ctx: the context.Context from the request
+// Repo: a *syw.Repository corresponding to <repodir>/:repository
+// Params: the map[string]string of the route parameters
+// Host: the hostname of the running server
+// Port: the port number of the running server
+// Selector: the selector in the current request
//
// The only exception is repo_root.gph, which is instead rendered with a slice of the repo names.
//
// All templates have 3 additional functions made available to them:
-// combine: func(string, ...string) string - successively combines paths using url.URL.ResolveReference
-// join: func(string, ...string) string - successively joins path segments
-// rawtext: func(selector, host, port, text string) string renders text lines as gopher info-message lines.
+//
+// combine: func(string, ...string) string - successively combines paths using url.URL.ResolveReference
+// join: func(string, ...string) string - successively joins path segments
+// rawtext: func(selector, host, port, text string) string renders text lines as gopher info-message lines.
func GopherRouter(repodir string, overrides *template.Template) *sliderule.Router {
tmpl, err := addTemplates(gopherTemplate, overrides)
if err != nil {
@@ -116,7 +118,7 @@ func gopherTreePath(tmpl *template.Template, haspath bool) sliderule.Handler {
t := "tree"
if haspath {
var err error
- t, err = repo.Type(ctx, params["ref"] + ":" + params["path"])
+ t, err = repo.Type(ctx, params["ref"]+":"+params["path"])
if err != nil {
return gopher.Error(err).Response()
}