feat(tpls): show escape char in filename

Author: marjune163

src/tpl/assert/main.css

@@ -191,6 +191,14 @@ input, button {
 	word-break: break-all;
 }
 
+.item-list .name em {
+	font-style: normal;
+	font-weight: normal;
+	padding: 0 0.2em;
+	border: 1px #ddd solid;
+	border-radius: 3px;
+}
+
 .item-list .size {
 	white-space: nowrap;
 	text-align: right;

src/tpl/assert/main.css.go

@@ -165,6 +165,13 @@ font-size: 1.5em;
 white-space: pre-wrap;
 word-break: break-all;
 }
+.item-list .name em {
+font-style: normal;
+font-weight: normal;
+padding: 0 0.2em;
+border: 1px #ddd solid;
+border-radius: 3px;
+}
 .item-list .size {
 white-space: nowrap;
 text-align: right;

src/tpl/page.html

@@ -49,7 +49,7 @@
 		{{$isDir := .IsDir}}
 		<li>
 			<a href="{{$subItemPrefix}}{{.Name}}{{if $isDir}}/{{end}}" class="item {{if $isDir}}item-dir{{else}}item-file{{end}}">
-				<span class="name">{{.Name}}{{if $isDir}}/{{end}}</span>
+				<span class="name">{{fmtFilename .Name}}{{if $isDir}}/{{end}}</span>
 				<span class="size">{{if not $isDir}}{{fmtSize .Size}}{{end}}</span>
 				<span class="time">{{fmtTime .ModTime}}</span>
 			</a>

src/tpl/page.html.go

@@ -54,7 +54,7 @@ const pageTplStr = `
 {{$isDir := .IsDir}}
 <li>
 <a href="{{$subItemPrefix}}{{.Name}}{{if $isDir}}/{{end}}" class="item {{if $isDir}}item-dir{{else}}item-file{{end}}">
-<span class="name">{{.Name}}{{if $isDir}}/{{end}}</span>
+<span class="name">{{fmtFilename .Name}}{{if $isDir}}/{{end}}</span>
 <span class="size">{{if not $isDir}}{{fmtSize .Size}}{{end}}</span>
 <span class="time">{{fmtTime .ModTime}}</span>
 </a>
@@ -100,7 +100,8 @@ func LoadPage(tplPath string) (*template.Template, error) {
 
 func addFuncMap(tpl *template.Template) *template.Template {
 	return tpl.Funcs(template.FuncMap{
-		"fmtSize": util.FormatSize,
-		"fmtTime": util.FormatTimeMinute,
+		"fmtFilename": util.FormatFilename,
+		"fmtSize":     util.FormatSize,
+		"fmtTime":     util.FormatTimeMinute,
 	})
 }

src/util/formatFilename.go

@@ -0,0 +1,19 @@
+package util
+
+import (
+	"html/template"
+	"strings"
+)
+
+var filenameReplacer = strings.NewReplacer(
+	"\r", "<em>\\r</em>",
+	"\n", "<em>\\n</em>",
+	"\a", "<em>\\a</em>",
+	"\v", "<em>\\v</em>",
+)
+
+func FormatFilename(filename string) template.HTML {
+	escaped := template.HTMLEscapeString(filename)
+	escaped = filenameReplacer.Replace(escaped)
+	return template.HTML(escaped)
+}

src/util/formatFilename_test.go

@@ -0,0 +1,14 @@
+package util
+
+import (
+	"html/template"
+	"testing"
+)
+
+func TestFormatFilename(t *testing.T) {
+	raw := "a\rb\nc"
+	replaced := FormatFilename(raw)
+	if replaced != template.HTML("a<em>\\r</em>b<em>\\n</em>c") {
+		t.Error(replaced)
+	}
+}