refactor(serverHandler): use pathContext to manage contextual query string

As the whole query string is output at once, "/"(like "/n") after "?"
will not be escaped. So there is no need to use `template.HTML` any more
to prevent "/" being escaped.

Author: marjune163

src/serverHandler/json.go

@@ -60,7 +60,7 @@ func getJsonData(data *responseData) *jsonResponseData {
 		Path:               data.Path,
 		Paths:              data.Paths,
 		SubItemPrefix:      data.SubItemPrefix,
-		ContextQueryString: string(data.ContextQueryString),
+		ContextQueryString: data.Context.QueryString(),
 		CanUpload:          data.CanUpload,
 		CanMkdir:           data.CanMkdir,
 		CanDelete:          data.CanDelete,

src/serverHandler/page.go

@@ -25,11 +25,7 @@ func updateSubItemsHtml(data *responseData) {
 		if info.IsDir() {
 			displayName = tplutil.FormatFilename(name) + "/"
 			typ = TypeDir
-			if len(data.ContextQueryString) > 0 {
-				url = data.SubItemPrefix + name + "/" + string(data.ContextQueryString)
-			} else {
-				url = data.SubItemPrefix + name + "/"
-			}
+			url = data.SubItemPrefix + name + "/" + data.Context.QueryString()
 		} else {
 			displayName = tplutil.FormatFilename(name)
 			typ = TypeFile

src/serverHandler/pathContext.go

@@ -0,0 +1,19 @@
+package serverHandler
+
+type pathContext struct {
+	sort string
+}
+
+func (ctx *pathContext) QueryString() string {
+	if len(ctx.sort) > 0 {
+		return "?sort=" + ctx.sort
+	} else {
+		return ""
+	}
+}
+
+func (ctx *pathContext) QueryStringOfSort(sort string) string {
+	copiedCtx := *ctx
+	copiedCtx.sort = sort
+	return copiedCtx.QueryString()
+}

src/serverHandler/pathContext_test.go

@@ -0,0 +1,22 @@
+package serverHandler
+
+import (
+	"testing"
+)
+
+func TestPathContext(t *testing.T) {
+	var result string
+
+	ctx := &pathContext{}
+	result = ctx.QueryString()
+	if result != "" {
+		t.Error(result)
+	}
+
+	ctx.sort = "/n"
+	result = ctx.QueryString()
+	if result != "?sort=/n" {
+		t.Error(result)
+	}
+
+}

src/serverHandler/responseData.go

@@ -31,19 +31,19 @@ type responseData struct {
 	errors []error
 	Status int
 
-	IsRoot             bool
-	Path               string
-	Paths              []*pathEntry
-	RootRelPath        string
-	File               *os.File
-	Item               os.FileInfo
-	ItemName           string
-	SubItems           []os.FileInfo
-	AliasSubItems      []os.FileInfo
-	SubItemsHtml       []*itemHtml
-	SubItemPrefix      string
-	SortState          SortState
-	ContextQueryString template.HTML
+	IsRoot        bool
+	Path          string
+	Paths         []*pathEntry
+	RootRelPath   string
+	File          *os.File
+	Item          os.FileInfo
+	ItemName      string
+	SubItems      []os.FileInfo
+	AliasSubItems []os.FileInfo
+	SubItemsHtml  []*itemHtml
+	SubItemPrefix string
+	SortState     SortState
+	Context       *pathContext
 
 	CanUpload    bool
 	CanMkdir     bool
@@ -340,10 +340,7 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 
 	subItemPrefix := getSubItemPrefix(rawReqPath, tailSlash)
 
-	var contextQueryString template.HTML
-	if len(rawSortBy) > 0 {
-		contextQueryString = "?sort=" + template.HTML(rawSortBy)
-	}
+	context := &pathContext{sort: rawSortBy}
 
 	canUpload := h.getCanUpload(item, rawReqPath, reqFsPath)
 	canMkdir := h.getCanMkdir(item, rawReqPath, reqFsPath)
@@ -377,19 +374,19 @@ func (h *handler) getResponseData(r *http.Request) *responseData {
 		errors: errs,
 		Status: status,
 
-		IsRoot:             isRoot,
-		Path:               rawReqPath,
-		Paths:              pathEntries,
-		RootRelPath:        rootRelPath,
-		File:               file,
-		Item:               item,
-		ItemName:           itemName,
-		SubItems:           subItems,
-		AliasSubItems:      aliasSubItems,
-		SubItemsHtml:       nil,
-		SubItemPrefix:      subItemPrefix,
-		SortState:          sortState,
-		ContextQueryString: contextQueryString,
+		IsRoot:        isRoot,
+		Path:          rawReqPath,
+		Paths:         pathEntries,
+		RootRelPath:   rootRelPath,
+		File:          file,
+		Item:          item,
+		ItemName:      itemName,
+		SubItems:      subItems,
+		AliasSubItems: aliasSubItems,
+		SubItemsHtml:  nil,
+		SubItemPrefix: subItemPrefix,
+		SortState:     sortState,
+		Context:       context,
 
 		CanUpload:    canUpload,
 		CanMkdir:     canMkdir,

src/serverHandler/sortState.go

@@ -1,7 +1,5 @@
 package serverHandler
 
-import "html/template"
-
 type dirSort int
 
 const (
@@ -15,34 +13,42 @@ type SortState struct {
 	key     byte
 }
 
-func (info SortState) mergeDirWithKey(key byte) template.HTML {
+func (info SortState) DirSort() dirSort {
+	return info.dirSort
+}
+
+func (info SortState) Key() string {
+	return string(info.key)
+}
+
+func (info SortState) mergeDirWithKey(key byte) string {
 	switch info.dirSort {
 	case dirSortFirst:
-		return "/" + template.HTML(key)
+		return "/" + string(key)
 	case dirSortLast:
-		return template.HTML(key) + "/"
+		return string(key) + "/"
 	default:
-		return template.HTML(key)
+		return string(key)
 	}
 }
 
-func (info SortState) CurrentSort() template.HTML {
+func (info SortState) CurrentSort() string {
 	return info.mergeDirWithKey(info.key)
 }
 
-func (info SortState) NextDirSort() template.HTML {
+func (info SortState) NextDirSort() string {
 	switch info.dirSort {
 	case dirSortFirst: // next is dirSortLast
-		return template.HTML(info.key) + "/"
+		return string(info.key) + "/"
 	case dirSortLast: // next is dirSortMixed
-		return template.HTML(info.key)
+		return string(info.key)
 	case dirSortMixed: // next is dirSortFirst
-		return "/" + template.HTML(info.key)
+		return "/" + string(info.key)
 	}
-	return "/" + template.HTML(info.key)
+	return "/" + string(info.key)
 }
 
-func (info SortState) NextNameSort() template.HTML {
+func (info SortState) NextNameSort() string {
 	var nextKey byte
 	switch info.key {
 	case 'n':
@@ -53,7 +59,7 @@ func (info SortState) NextNameSort() template.HTML {
 	return info.mergeDirWithKey(nextKey)
 }
 
-func (info SortState) NextSizeSort() template.HTML {
+func (info SortState) NextSizeSort() string {
 	var nextKey byte
 	switch info.key {
 	case 's':
@@ -64,7 +70,7 @@ func (info SortState) NextSizeSort() template.HTML {
 	return info.mergeDirWithKey(nextKey)
 }
 
-func (info SortState) NextTimeSort() template.HTML {
+func (info SortState) NextTimeSort() string {
 	var nextKey byte
 	switch info.key {
 	case 't':
@@ -74,11 +80,3 @@ func (info SortState) NextTimeSort() template.HTML {
 	}
 	return info.mergeDirWithKey(nextKey)
 }
-
-func (info SortState) DirSort() dirSort {
-	return info.dirSort
-}
-
-func (info SortState) Key() template.HTML {
-	return template.HTML(info.key)
-}

src/serverHandler/sortState_test.go

@@ -1,12 +1,11 @@
 package serverHandler
 
 import (
-	"html/template"
 	"testing"
 )
 
 func TestSortState_DirState(t *testing.T) {
-	var sortBy template.HTML
+	var sortBy string
 	state := SortState{dirSortFirst, 'n'}
 
 	sortBy = state.CurrentSort()
@@ -33,7 +32,7 @@ func TestSortState_DirState(t *testing.T) {
 }
 
 func TestSortState_KeyState(t *testing.T) {
-	var sortBy template.HTML
+	var sortBy string
 	state := SortState{dirSortFirst, 'n'}
 
 	sortBy = state.NextNameSort()

src/tpl/page.html

@@ -11,7 +11,7 @@
 	<link rel="stylesheet" type="text/css" href="{{.RootRelPath}}/../assert/main.css"/>
 </head>
 <body class="{{if .IsRoot}}root-dir{{else}}sub-dir{{end}}">
-{{$contextQueryString := .ContextQueryString}}
+{{$contextQueryString := .Context.QueryString}}
 <ol class="path-list">
 	{{range .Paths}}
 		<li><a href="{{.Path}}{{$contextQueryString}}">{{fmtFilename .Name}}</a></li>
@@ -56,14 +56,14 @@
 <ul class="item-list{{if .HasDeletable}} has-deletable{{end}}">
 	<li class="header">{{$dirSort := .SortState.DirSort}}{{$sortKey := .SortState.Key}}
 		<span class="detail">
-		<a class="field dir" href="{{.SubItemPrefix}}{{"?sort="}}{{.SortState.NextDirSort}}">Dir{{if eq $dirSort -1}}&uarr;{{else if eq $dirSort 1}}&darr;{{end}}</a>
-		<a class="field name" href="{{.SubItemPrefix}}{{"?sort="}}{{.SortState.NextNameSort}}">Name{{if eq $sortKey "n"}}&uarr;{{else if eq $sortKey "N"}}&darr;{{end}}</a>
-		<a class="field size" href="{{.SubItemPrefix}}{{"?sort="}}{{.SortState.NextSizeSort}}">Size{{if eq $sortKey "s"}}&uarr;{{else if eq $sortKey "S"}}&darr;{{end}}</a>
-		<a class="field time" href="{{.SubItemPrefix}}{{"?sort="}}{{.SortState.NextTimeSort}}">Time{{if eq $sortKey "t"}}&uarr;{{else if eq $sortKey "T"}}&darr;{{end}}</a>
+		<a class="field dir" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextDirSort}}">Dir{{if eq $dirSort -1}}&uarr;{{else if eq $dirSort 1}}&darr;{{end}}</a>
+		<a class="field name" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextNameSort}}">Name{{if eq $sortKey "n"}}&uarr;{{else if eq $sortKey "N"}}&darr;{{end}}</a>
+		<a class="field size" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextSizeSort}}">Size{{if eq $sortKey "s"}}&uarr;{{else if eq $sortKey "S"}}&darr;{{end}}</a>
+		<a class="field time" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextTimeSort}}">Time{{if eq $sortKey "t"}}&uarr;{{else if eq $sortKey "T"}}&darr;{{end}}</a>
 		</span>
 	</li>
 	<li class="dir parent">
-		<a href="{{if .IsRoot}}./{{else}}../{{end}}{{.ContextQueryString}}" class="detail">
+		<a href="{{if .IsRoot}}./{{else}}../{{end}}{{$contextQueryString}}" class="detail">
 			<span class="field name">../</span>
 			<span class="field size"></span>
 			<span class="field time"></span>

src/tpl/page.html.go

@@ -21,7 +21,7 @@ const pageTplStr = `
 <link rel="stylesheet" type="text/css" href="{{.RootRelPath}}?assert=main.css"/>
 </head>
 <body class="{{if .IsRoot}}root-dir{{else}}sub-dir{{end}}">
-{{$contextQueryString := .ContextQueryString}}
+{{$contextQueryString := .Context.QueryString}}
 <ol class="path-list">
 {{range .Paths}}
 <li><a href="{{.Path}}{{$contextQueryString}}">{{fmtFilename .Name}}</a></li>
@@ -62,14 +62,14 @@ return confirm('Delete?\n' + name);
 <ul class="item-list{{if .HasDeletable}} has-deletable{{end}}">
 <li class="header">{{$dirSort := .SortState.DirSort}}{{$sortKey := .SortState.Key}}
 <span class="detail">
-<a class="field dir" href="{{.SubItemPrefix}}{{"?sort="}}{{.SortState.NextDirSort}}">Dir{{if eq $dirSort -1}}&uarr;{{else if eq $dirSort 1}}&darr;{{end}}</a>
-<a class="field name" href="{{.SubItemPrefix}}{{"?sort="}}{{.SortState.NextNameSort}}">Name{{if eq $sortKey "n"}}&uarr;{{else if eq $sortKey "N"}}&darr;{{end}}</a>
-<a class="field size" href="{{.SubItemPrefix}}{{"?sort="}}{{.SortState.NextSizeSort}}">Size{{if eq $sortKey "s"}}&uarr;{{else if eq $sortKey "S"}}&darr;{{end}}</a>
-<a class="field time" href="{{.SubItemPrefix}}{{"?sort="}}{{.SortState.NextTimeSort}}">Time{{if eq $sortKey "t"}}&uarr;{{else if eq $sortKey "T"}}&darr;{{end}}</a>
+<a class="field dir" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextDirSort}}">Dir{{if eq $dirSort -1}}&uarr;{{else if eq $dirSort 1}}&darr;{{end}}</a>
+<a class="field name" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextNameSort}}">Name{{if eq $sortKey "n"}}&uarr;{{else if eq $sortKey "N"}}&darr;{{end}}</a>
+<a class="field size" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextSizeSort}}">Size{{if eq $sortKey "s"}}&uarr;{{else if eq $sortKey "S"}}&darr;{{end}}</a>
+<a class="field time" href="{{.SubItemPrefix}}{{.Context.QueryStringOfSort .SortState.NextTimeSort}}">Time{{if eq $sortKey "t"}}&uarr;{{else if eq $sortKey "T"}}&darr;{{end}}</a>
 </span>
 </li>
 <li class="dir parent">
-<a href="{{if .IsRoot}}./{{else}}../{{end}}{{.ContextQueryString}}" class="detail">
+<a href="{{if .IsRoot}}./{{else}}../{{end}}{{$contextQueryString}}" class="detail">
 <span class="field name">../</span>
 <span class="field size"></span>
 <span class="field time"></span>