Add default ledger & queries to archetypes

1. error handling for all routes & models function
2. rename scripts -> queries
3. use [][2]string instead of map[string]string to provide ordered
   queries list

.gitignore

@@ -1,5 +1,4 @@
 .env
-test.txt
 ledger-quicknote
-*.txt
 .htpasswd
+data

archetypes/.ledgerrc

@@ -0,0 +1 @@
+--file ledger.txt

archetypes/ledger.txt

@@ -0,0 +1,13 @@
+account assets
+account liabilities
+account income
+account expenses
+account equity
+account assets:savings
+    alias savings
+account assets:checking
+    alias checking
+account expenses:cash
+    alias cash
+account expenses:food
+    alias food

archetypes/queries.txt

@@ -0,0 +1,5 @@
+資產餘額:b assets
+本月開支:b -b "this month"
+上月開支:b -b "last month" -e "this month"
+記錄列表:r
+過去七天:r -b "last 7 days"

config.go

@@ -5,3 +5,8 @@ var SCRIPTS = map[string]string{
 	"register":           "r --tail 10",
 	"balance this month": "b -b \"this month\"",
 }
+
+const QUERIES_FILE = "queries.txt"
+const HTPASSWD_FILE = ".htpasswd"
+const DEFAULT_JOURNAL = "ledger.txt"
+const ARCHETYPES_DIR = "archetypes"

go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/mattn/go-isatty v0.0.14 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/otiai10/copy v1.9.0 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.1 // indirect
 	github.com/ugorji/go/codec v1.2.7 // indirect
 	golang.org/x/crypto v0.1.0 // indirect

go.sum

@@ -37,6 +37,12 @@ github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OH
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
 github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M=
 github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
+github.com/otiai10/copy v1.9.0 h1:7KFNiCgZ91Ru4qW4CWPf/7jqtxLagGRmIxWldPP9VY4=
+github.com/otiai10/copy v1.9.0/go.mod h1:hsfX19wcn0UWIHUQ3/4fHuehhk2UyArQ9dVFAn3FczI=
+github.com/otiai10/curr v0.0.0-20150429015615-9b4961190c95/go.mod h1:9qAhocn7zKJG+0mI8eUu6xqkFDYS2kb2saOteoSB3cE=
+github.com/otiai10/curr v1.0.0/go.mod h1:LskTG5wDwr8Rs+nNQ+1LlxRjAtTZZjtJW4rMXl6j4vs=
+github.com/otiai10/mint v1.3.0/go.mod h1:F5AjcsTsWUqX+Na9fpHb52P8pcRX2CI6A3ctIT91xUo=
+github.com/otiai10/mint v1.4.0/go.mod h1:gifjb2MYOoULtKLqUAEILUG/9KONW6f7YsJ6vQLTlFI=
 github.com/pelletier/go-toml/v2 v2.0.1 h1:8e3L2cCQzLFi2CR4g7vGFuFxX7Jl1kKX8gW+iV0GUKU=
 github.com/pelletier/go-toml/v2 v2.0.1/go.mod h1:r9LEWfGN8R5k0VXJ+0BkIe7MYkRdwZOjgMj2KwnJFUo=
 github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
@@ -63,6 +69,7 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U=
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=

main.go

@@ -4,13 +4,13 @@ import (
 	"encoding/base64"
 	"flag"
 	"log"
+	"path"
 	"text/template"
 
 	"github.com/gorilla/securecookie"
 	"github.com/lancatlin/ledger-quicknote/auth"
 )
 
-var ledgerTpl *template.Template
 var htmlTpl *template.Template
 
 var DATA_DIR string
@@ -18,11 +18,7 @@ var HOST string
 
 var store auth.AuthStore
 
-const HTPASSWD_FILE = ".htpasswd"
-const DEFAULT_JOURNAL = "ledger.txt"
-
 func init() {
-	ledgerTpl = template.Must(template.ParseGlob("tx/*"))
 	flag.StringVar(&DATA_DIR, "d", "data", "data folder")
 	flag.StringVar(&HOST, "b", "127.0.0.1:8000", "binding address")
 	var hashKeyString string
@@ -41,7 +37,7 @@ func init() {
 			panic(err)
 		}
 	}
-	store, err = auth.New(HTPASSWD_FILE, hashKey)
+	store, err = auth.New(path.Join(DATA_DIR, HTPASSWD_FILE), hashKey)
 	if err != nil {
 		panic(err)
 	}

models.go

@@ -0,0 +1,166 @@
+package main
+
+import (
+	"bufio"
+	"bytes"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"os"
+	"os/exec"
+	"path"
+	"strings"
+	"text/template"
+	"time"
+
+	cp "github.com/otiai10/copy"
+)
+
+type User struct {
+	IsLogin  bool
+	Email    string `form:"email" binding:"required"`
+	Password string `form:"password" binding:"required"`
+}
+
+func (u *User) Dir() string {
+	dir := path.Join(DATA_DIR, u.Email)
+	return dir
+}
+
+func (u *User) Mkdir() error {
+	return cp.Copy(ARCHETYPES_DIR, u.Dir())
+}
+
+func (u *User) FilePath(name string) string {
+	return path.Join(u.Dir(), name)
+}
+
+func (u *User) File(name string, mode int) (*os.File, error) {
+	return os.OpenFile(u.FilePath(name), mode, 0644)
+}
+
+func (u *User) AppendFile(name string) (*os.File, error) {
+	return u.File(name, os.O_WRONLY|os.O_CREATE|os.O_APPEND)
+}
+
+func (u *User) ReadFile(name string) (*os.File, error) {
+	return u.File(name, os.O_RDONLY|os.O_CREATE)
+}
+
+func (u *User) WriteFile(name string) (*os.File, error) {
+	return u.File(name, os.O_WRONLY|os.O_CREATE|os.O_TRUNC)
+}
+
+func (u *User) List() ([]string, error) {
+	files, err := os.ReadDir(u.Dir())
+	if err != nil {
+		return []string{}, fmt.Errorf("Failed to open directory: %w", err)
+	}
+	result := make([]string, len(files))
+	for i, v := range files {
+		result[i] = v.Name()
+	}
+	return result, nil
+}
+
+func (u *User) readAllFile(name string) (data []byte, err error) {
+	f, err := u.ReadFile(name)
+	if err != nil {
+		return
+	}
+	defer f.Close()
+	data, err = ioutil.ReadAll(f)
+	return
+}
+
+func (u *User) appendToFile(tx string) (err error) {
+	f, err := u.AppendFile(DEFAULT_JOURNAL)
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+
+	buf := strings.NewReader(strings.ReplaceAll(tx, "\r", "")) // Remove CR generated from browser
+	_, err = io.Copy(f, buf)
+	return err
+}
+
+func (u *User) overwriteFile(filename string, tx string) (err error) {
+	f, err := u.WriteFile(filename)
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+
+	buf := strings.NewReader(strings.ReplaceAll(tx, "\r", "")) // Remove CR generated from browser
+	_, err = io.Copy(f, buf)
+	return err
+}
+
+func (u *User) query(query string) (result string, err error) {
+	var buf bytes.Buffer
+
+	cmd := exec.Command("ledger")
+	cmd.Dir = u.Dir()
+	cmd.Stdin = strings.NewReader(query)
+	cmd.Stdout = &buf
+	cmd.Stderr = &buf
+	err = cmd.Run()
+	return buf.String(), err
+}
+
+func (u *User) queries() (queries [][2]string, err error) {
+	f, err := u.ReadFile(QUERIES_FILE)
+	if err != nil {
+		err = fmt.Errorf("Failed to read queries file: %w", err)
+		return
+	}
+	defer f.Close()
+
+	fileScanner := bufio.NewScanner(f)
+	fileScanner.Split(bufio.ScanLines)
+
+	queries = make([][2]string, 0)
+	for fileScanner.Scan() {
+		arr := strings.SplitN(fileScanner.Text(), ":", 2)
+		if len(arr) < 2 {
+			continue
+		}
+		queries = append(queries, [2]string{arr[0], arr[1]})
+	}
+	return
+}
+
+func (u *User) templates() (templates []string, err error) {
+	files, err := u.List()
+	if err != nil {
+		return
+	}
+	for _, v := range files {
+		if strings.HasSuffix(v, ".tpl") {
+			templates = append(templates, v)
+		}
+	}
+	return
+}
+
+type TxData struct {
+	Action      string `form:"action" binding:"required"`
+	Name        string `form:"name"`
+	Date        string
+	Amount      string `form:"amount" binding:"required"`
+	Destination string `form:"dest"`
+	Source      string `form:"src"`
+}
+
+func (u *User) newTx(data TxData) (result string, err error) {
+	data.Date = time.Now().Format("2006/01/02")
+	var buf bytes.Buffer
+	tpl, err := template.ParseFiles(u.FilePath(data.Action))
+	if err != nil {
+		return
+	}
+	err = tpl.ExecuteTemplate(&buf, data.Action, data)
+	result = buf.String()
+	return
+}

route.go

@@ -1,10 +1,7 @@
 package main
 
 import (
-	"fmt"
-	"io/ioutil"
 	"log"
-	"text/template"
 
 	"github.com/gin-gonic/gin"
 )
@@ -32,12 +29,20 @@ func router() *gin.Engine {
 	authZone := r.Group("", authenticate)
 
 	authZone.GET("/dashboard", func(c *gin.Context) {
-		HTML(c, 200, "dashboard.html", struct {
+		user := getUser(c)
-			Templates []*template.Template
+		queries, err := user.queries()
-			Scripts   map[string]string
+		if err != nil {
-		}{
+			c.AbortWithError(500, err)
-			ledgerTpl.Templates(),
+			return
-			SCRIPTS,
+		}
+		templates, err := user.templates()
+		if err != nil {
+			c.AbortWithError(500, err)
+			return
+		}
+		HTML(c, 200, "dashboard.html", gin.H{
+			"Queries":   queries,
+			"Templates": templates,
 		})
 	})
 
@@ -47,15 +52,16 @@ func router() *gin.Engine {
 			c.AbortWithError(400, err)
 			return
 		}
-		tx, err := newTx(data)
+		user := getUser(c)
+		tx, err := user.newTx(data)
 		if err != nil {
 			c.AbortWithError(400, err)
 			log.Println(err, c.Request.Form)
 			return
 		}
-		HTML(c, 200, "new.html", struct {
+		HTML(c, 200, "new.html", gin.H{
-			Tx string
+			"Tx": tx,
-		}{tx})
+		})
 	})
 	authZone.POST("/submit", func(c *gin.Context) {
 		user := getUser(c)
@@ -65,33 +71,23 @@ func router() *gin.Engine {
 			return
 		}
 
-		HTML(c, 200, "success.html", struct {
+		c.Redirect(303, "/dashboard")
-			Tx string
-		}{tx})
 	})
 
 	authZone.GET("/edit", func(c *gin.Context) {
-		c.Redirect(303, fmt.Sprintf("/edit/%s", DEFAULT_JOURNAL))
-	})
-
-	authZone.GET("/edit/:filename", func(c *gin.Context) {
 		user := getUser(c)
-		filename := c.Param("filename")
+		filename := c.Query("filename")
 		list, err := user.List()
 		if err != nil {
-			panic(err)
+			c.AbortWithError(500, err)
+			return
 		}
 		exists := contain(list, filename)
 		var data []byte
 		if exists {
-			f, err := user.ReadFile(filename)
+			data, err = user.readAllFile(filename)
 			if err != nil {
-				panic(err)
+				c.AbortWithError(500, err)
-			}
-			defer f.Close()
-			data, err = ioutil.ReadAll(f)
-			if err != nil {
-				panic(err)
 			}
 		}
 
@@ -103,17 +99,19 @@ func router() *gin.Engine {
 		})
 	})
 
-	authZone.POST("/edit/:filename", func(c *gin.Context) {
+	authZone.POST("/edit", func(c *gin.Context) {
 		user := getUser(c)
-		filename := c.Param("filename")
+		filename := c.PostForm("filename")
 		data := c.PostForm("data")
 		err := user.overwriteFile(filename, data)
 		if err != nil {
-			panic(err)
+			c.AbortWithError(500, err)
+			return
 		}
-		HTML(c, 200, "success.html", struct {
+		HTML(c, 200, "success.html", gin.H{
-			Tx string
+			"FileName": filename,
-		}{data})
+			"Tx":       data,
+		})
 	})
 
 	authZone.GET("/download", func(c *gin.Context) {
@@ -122,19 +120,25 @@ func router() *gin.Engine {
 	})
 
 	authZone.GET("/query", func(c *gin.Context) {
+		user := getUser(c)
 		response := struct {
 			Query   string
 			Result  string
-			Scripts map[string]string
+			Queries [][2]string
-		}{Scripts: SCRIPTS}
+		}{}
-		user := getUser(c)
 		var ok bool
 		var err error
+		response.Queries, err = user.queries()
+		if err != nil {
+			c.AbortWithError(500, err)
+			return
+		}
 		response.Query, ok = c.GetQuery("query")
 		if ok && response.Query != "" {
 			response.Result, err = user.query(response.Query)
 			if err != nil {
-				panic(err)
+				c.AbortWithError(500, err)
+				return
 			}
 		}
 		HTML(c, 200, "query.html", response)

session.go

@@ -37,6 +37,9 @@ func signup(c *gin.Context) {
 		HTML(c, 400, "signup.html", err)
 		return
 	}
+	if err := user.Mkdir(); err != nil {
+		return
+	}
 	signin(c)
 }
 

templates/dashboard.html

@@ -3,7 +3,7 @@
 <form action="/new" method="POST">
     <label>選擇模板：
         {{ range .Templates }}
-        <input type="radio" name="action" value="{{ .Name }}">{{ .Name }}</option>
+        <input type="radio" name="action" value="{{ . }}">{{ . }}</option>
         {{ end }}
     </label><br>
     <label>金額：<input name="amount" type="number"></label><br>
@@ -12,5 +12,5 @@
     <label>名稱：<input name="name" type="text"></label></br>
     <input type="submit" value="新增記錄">
 </form>
-{{ template "scripts" .Scripts }}
+{{ template "queries" .Queries }}
 {{ end }}

templates/edit.html

@@ -1,18 +1,18 @@
 {{ define "title" }}編輯{{ end }}
 {{ define "main" }}
-<h1>編輯帳本</h1>
+<h1>編輯檔案</h1>
 <aside>
     <ul>
         {{ range .FileList }}
-        <li><a href="/edit/{{ . }}">{{ . }}</a></li>
+        <li><a href="/edit?filename={{ . }}">{{ . }}</a></li>
         {{ end }}
     </ul>
+    <p><a href="/edit">新檔案</a></p>
 </aside>
 
-<p>{{ .FileName }}{{ if not .Exists }} - New file{{ end }}</p>
+<form action="/edit" method="POST">
-
+    <label>Filename: <input type="text" name="filename" value="{{ .FileName }}"></label><br>
-<form action="/edit/{{ .FileName }}" method="POST">
     <textarea name="data" rows="15" cols="40">{{ .Data }}</textarea><br>
-    <input type="submit" value="儲存">
+    <input type="submit" value="{{ if .Exists }}儲存{{ else }}新增{{ end }}">
 </form>
 {{ end }}

templates/layouts/queries.html

@@ -0,0 +1,8 @@
+{{ define "queries" }}
+<h3>快速查詢</h3>
+<ul>
+    {{ range . }}
+    <li><a href="/query?query={{ index . 1 | urlquery  }}">{{ index . 0 }}</a></li>
+    {{ end }}
+</ul>
+{{ end }}

templates/layouts/scripts.html

@@ -1,8 +0,0 @@
-{{ define "scripts" }}
-<h3>快速查詢</h3>
-<ul>
-    {{ range $k, $v := . }}
-    <li><a href="/query?query={{ urlquery $v }}">{{ $k }}</a></li>
-    {{ end }}
-</ul>
-{{ end }}

templates/query.html

@@ -8,5 +8,5 @@
     <input type="text" name="query" value="{{ .Query }}" autofocus>
     <input type="submit" value="查詢">
 </form>
-{{ template "scripts" .Scripts }}
+{{ template "queries" .Queries }}
 {{ end }}

templates/success.html

@@ -1,6 +1,6 @@
 {{ define "title" }}Success{{ end }}
 {{ define "main" }}
 <p><strong>Success</strong></p>
+{{ with .FileName }}<p><a href="/edit?filename={{ . }}">繼續編輯</a></p>{{ end }}
 <pre><code>{{ .Tx }}</code></pre>
-<p><a href="/dashboard">Back to home</a></p>
 {{ end }}

tx.go

@@ -1,61 +0,0 @@
-package main
-
-import (
-	"bytes"
-	"io"
-	"os/exec"
-	"strings"
-	"time"
-)
-
-type TxData struct {
-	Action      string `form:"action" binding:"required"`
-	Name        string `form:"name"`
-	Date        string
-	Amount      string `form:"amount" binding:"required"`
-	Destination string `form:"dest"`
-	Source      string `form:"src"`
-}
-
-func newTx(data TxData) (result string, err error) {
-	data.Date = time.Now().Format("2006/01/02")
-	var buf bytes.Buffer
-	err = ledgerTpl.ExecuteTemplate(&buf, data.Action, data)
-	return buf.String(), nil
-}
-
-func (u *User) appendToFile(tx string) (err error) {
-	f, err := u.AppendFile(DEFAULT_JOURNAL)
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-
-	buf := strings.NewReader(strings.ReplaceAll(tx, "\r", "")) // Remove CR generated from browser
-	_, err = io.Copy(f, buf)
-	return err
-}
-
-func (u *User) overwriteFile(filename string, tx string) (err error) {
-	f, err := u.WriteFile(filename)
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-
-	buf := strings.NewReader(strings.ReplaceAll(tx, "\r", "")) // Remove CR generated from browser
-	_, err = io.Copy(f, buf)
-	return err
-}
-
-func (u *User) query(query string) (result string, err error) {
-	var buf bytes.Buffer
-
-	cmd := exec.Command("ledger", "--file", DEFAULT_JOURNAL)
-	cmd.Dir = u.Dir()
-	cmd.Stdin = strings.NewReader(query)
-	cmd.Stdout = &buf
-	cmd.Stderr = &buf
-	err = cmd.Run()
-	return buf.String(), err
-}

tx/cash.txt

@@ -1,4 +0,0 @@
-{{ .Date }} * cash
-    cash    ${{ .Amount }}
-    assets:cash
-

tx/expense.txt

@@ -1,4 +0,0 @@
-{{ .Date }} {{ with .Name }}{{ . }}{{ else }}{{ .Destination }}{{ end }}
-    {{ .Destination }}      ${{ .Amount }}
-    {{ with .Source }}{{ . }}{{ else }}cash{{ end }}
-

tx/withdraw.txt

@@ -1,4 +0,0 @@
-{{ .Date }} * withdraw
-    assets:cash     ${{ .Amount }}
-    assets:checking
-

user.go

@@ -1,52 +0,0 @@
-package main
-
-import (
-	"os"
-	"path"
-)
-
-type User struct {
-	IsLogin  bool
-	Email    string `form:"email" binding:"required"`
-	Password string `form:"password" binding:"required"`
-}
-
-func (u *User) Dir() string {
-	dir := path.Join(DATA_DIR, u.Email)
-	if err := os.MkdirAll(dir, 0755); err != nil {
-		panic(err)
-	}
-	return dir
-}
-
-func (u *User) FilePath(name string) string {
-	return path.Join(u.Dir(), name)
-}
-
-func (u *User) File(name string, mode int) (*os.File, error) {
-	return os.OpenFile(u.FilePath(name), mode, 0644)
-}
-
-func (u *User) AppendFile(name string) (*os.File, error) {
-	return u.File(name, os.O_WRONLY|os.O_CREATE|os.O_APPEND)
-}
-
-func (u *User) ReadFile(name string) (*os.File, error) {
-	return u.File(name, os.O_RDONLY|os.O_CREATE)
-}
-
-func (u *User) WriteFile(name string) (*os.File, error) {
-	return u.File(name, os.O_WRONLY|os.O_CREATE|os.O_TRUNC)
-}
-
-func (u *User) List() ([]string, error) {
-	files, err := os.ReadDir(u.Dir())
-	if err != nil {
-		panic(err)
-	}
-	result := make([]string, len(files))
-	for i, v := range files {
-		result[i] = v.Name()
-	}
-	return result, nil
-}