feat: add option --theme-dir

Add `--theme-dir` for developing and debugger theme files. Outout content
will be evaluated for each request. If request a page rendering,
template parsing will also performed.

Author: marjune163

README.md

@@ -215,8 +215,18 @@ server [options]
     Specify key file of TLS certificate.
 
 --theme <file>
-    Use a custom theme file for rendering pages, instead of builtin one.
+    Specify a zip archive file as custom theme for rendering page and assets, instead of builtin ones.
     Theme contents are cached in memory at runtime.
+--theme-dir <directory>
+    Specify a directory which contains theme files.
+    Theme contents will be evaluated for each request.
+    It is convenient for developing themes.
+
+    Notes for theme options:
+        --theme and --theme-dir are mutually exclusive.
+        --theme-dir is prior.
+        Page template filename is always "index.html".
+        Use "?asset=<asset-path>" to reference an asset in theme.
 
 --hsts
     Enable HSTS(HTTP Strict Transport Security).

README.zh-CN.md

@@ -213,8 +213,18 @@ server [选项]
     指定TLS私钥文件。
 
 --theme <主题文件>
-    指定用于渲染页面的自定义主题，代替内建主题。
+    指定用于渲染页面和静态资源的自定义主题zip压缩文件，代替内建主题。
     主题的内容在运行时一直缓存在内存中。
+--theme-dir <主题目录>
+    指定主题文件所在的目录。
+    每次请求时主题内容都会重新计算。
+    这为开发主题提供了便利。
+
+    主题选项注意事项：
+        --theme和--theme-dir是互斥的。
+        --theme-dir更为优先。
+        页面模板文件名固定为“index.html”。
+        使用“?asset=<asset-path>”格式来引用主题中的静态资源。
 
 --hsts
     启用HSTS(HTTP Strict Transport Security)。

src/app/main.go

@@ -53,7 +53,9 @@ func NewApp(params []*param.Param) *App {
 
 		// theme
 		var theme tpl.Theme
-		if len(p.Theme) == 0 {
+		if len(p.ThemeDir) > 0 {
+			theme = tpl.DirTheme(p.ThemeDir)
+		} else if len(p.Theme) == 0 {
 			theme = tpl.DefaultTheme
 		} else {
 			themeKey, err := filepath.Abs(p.Theme)

src/param/cli.go

@@ -134,6 +134,9 @@ func init() {
 	err = options.AddFlagValue("theme", "--theme", "GHFS_THEME", "", "external theme file")
 	serverErrHandler.CheckFatal(err)
 
+	err = options.AddFlagValue("themedir", "--theme-dir", "GHFS_THEME_DIR", "", "external theme directory")
+	serverErrHandler.CheckFatal(err)
+
 	err = options.AddFlag("globalhsts", "--hsts", "GHFS_HSTS", "enable HSTS(HTTP Strict Transport Security)")
 	serverErrHandler.CheckFatal(err)
 
@@ -248,6 +251,7 @@ func doParseCli() []*Param {
 		param.GlobalAuth = result.HasKey("globalauth")
 		param.HostNames, _ = result.GetStrings("hostnames")
 		param.Theme, _ = result.GetString("theme")
+		param.ThemeDir, _ = result.GetString("themedir")
 		param.AccessLog, _ = result.GetString("accesslog")
 		param.ErrorLog, _ = result.GetString("errorlog")
 

src/param/main.go

@@ -55,6 +55,7 @@ type Param struct {
 	ListensTLS   []string
 	HostNames    []string
 	Theme        string
+	ThemeDir     string
 
 	GlobalHsts  bool
 	GlobalHttps bool

src/tpl/dirTheme.go

@@ -0,0 +1,32 @@
+package tpl
+
+import (
+	"io"
+	"net/http"
+	"os"
+	"path"
+	"strings"
+)
+
+type DirTheme string
+
+func (dir DirTheme) RenderPage(w io.Writer, data interface{}) error {
+	filename := string(dir) + "/" + templateFilename
+	tplStr, err := os.ReadFile(filename)
+	if err != nil {
+		return err
+	}
+
+	tpl, err := ParsePageTpl(string(tplStr))
+	if err != nil {
+		return err
+	}
+
+	tpl.Execute(w, data)
+	return nil
+}
+
+func (dir DirTheme) RenderAsset(w http.ResponseWriter, r *http.Request, assetPath string) {
+	filename := string(dir) + "/" + strings.Replace(path.Clean(assetPath), "../", "", -1)
+	http.ServeFile(w, r, filename)
+}

src/tpl/memTheme.go

@@ -42,7 +42,7 @@ func LoadMemTheme(themePath string) (theme MemTheme, err error) {
 		if err != nil {
 			return
 		}
-		if f.Name == "index.html" {
+		if f.Name == templateFilename {
 			currentTheme.template, err = ParsePageTpl(string(raw))
 			if err != nil {
 				return
@@ -57,7 +57,7 @@ func LoadMemTheme(themePath string) (theme MemTheme, err error) {
 		return
 	}
 
-	err = errors.New("lacks of page template 'index.html' in theme")
+	err = errors.New("lacks of page template '" + templateFilename + "' in theme")
 	return
 }
 

src/tpl/theme.go

@@ -5,6 +5,8 @@ import (
 	"net/http"
 )
 
+const templateFilename = "index.html"
+
 type Theme interface {
 	RenderPage(w io.Writer, data interface{}) error
 	RenderAsset(w http.ResponseWriter, r *http.Request, assetPath string)

test/case/027.custom.theme-dir.bash

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+source "$root"/lib.bash
+
+"$ghfs" -l 3003 -r "$fs"/vhost1 --hostname 127.0.0.1 ,,  -l 3003 -r "$fs"/vhost2 --hostname 127.0.0.2 --theme-dir theme-dir &
+sleep 0.05 # wait server ready
+
+(curl_get_body 'http://127.0.0.1:3003/' | grep -q -F '<meta http-equiv="comment" content="index.html from custom theme"/>') &&
+	fail "Should not use custom theme for vhost 1"
+
+(curl_get_body 'http://127.0.0.1:3003/?asset=index.css' | grep -q -F '/* index.css from custom theme */') &&
+	fail "Should not use custom theme for vhost 1"
+
+(curl_get_body 'http://127.0.0.1:3003/?asset=index.js' | grep -q -F '/* index.js from custom theme */') &&
+	fail "Should not use custom theme for vhost 1"
+
+(curl_get_body 'http://127.0.0.2:3003/' | grep -q -F '<meta http-equiv="comment" content="index.html from custom theme"/>') ||
+	fail "Should use custom theme for vhost 2"
+
+(curl_get_body 'http://127.0.0.2:3003/?asset=index.css' | grep -q -F '/* index.css from custom theme */') ||
+	fail "Should use custom theme for vhost 2"
+
+(curl_get_body 'http://127.0.0.2:3003/?asset=index.js' | grep -q -F '/* index.js from custom theme */') ||
+	fail "Should use custom theme for vhost 2"
+
+jobs -p | xargs kill