From 2a290cf1ed6113f0d01eea3f2cff446339bed0ce Mon Sep 17 00:00:00 2001 From: Robin Jarry Date: Tue, 20 Dec 2022 16:12:18 +0100 Subject: templates: split code in multiple files This makes room in preparation for more code in here. Signed-off-by: Robin Jarry Acked-by: Tim Culverhouse --- lib/templates/data.go | 80 ++++++++++++++++++++ lib/templates/functions.go | 113 ++++++++++++++++++++++++++++ lib/templates/template.go | 182 --------------------------------------------- 3 files changed, 193 insertions(+), 182 deletions(-) create mode 100644 lib/templates/data.go create mode 100644 lib/templates/functions.go (limited to 'lib/templates') diff --git a/lib/templates/data.go b/lib/templates/data.go new file mode 100644 index 00000000..5b351816 --- /dev/null +++ b/lib/templates/data.go @@ -0,0 +1,80 @@ +package templates + +import ( + "time" + + "git.sr.ht/~rjarry/aerc/models" + "github.com/emersion/go-message/mail" +) + +type TemplateData struct { + To []*mail.Address + Cc []*mail.Address + Bcc []*mail.Address + From []*mail.Address + Date time.Time + Subject string + // Only available when replying with a quote + OriginalText string + OriginalFrom []*mail.Address + OriginalDate time.Time + OriginalMIMEType string +} + +func ParseTemplateData(h *mail.Header, original models.OriginalMail) TemplateData { + // we ignore errors as this shouldn't fail the sending / replying even if + // something is wrong with the message we reply to + to, _ := h.AddressList("to") + cc, _ := h.AddressList("cc") + bcc, _ := h.AddressList("bcc") + from, _ := h.AddressList("from") + subject, err := h.Text("subject") + if err != nil { + subject = h.Get("subject") + } + + td := TemplateData{ + To: to, + Cc: cc, + Bcc: bcc, + From: from, + Date: time.Now(), + Subject: subject, + OriginalText: original.Text, + OriginalDate: original.Date, + OriginalMIMEType: original.MIMEType, + } + if original.RFC822Headers != nil { + origFrom, _ := original.RFC822Headers.AddressList("from") + td.OriginalFrom = origFrom + } + return td +} + +// DummyData provides dummy data to test template validity +func DummyData() interface{} { + from := &mail.Address{ + Name: "John Doe", + Address: "john@example.com", + } + to := &mail.Address{ + Name: "Alice Doe", + Address: "alice@example.com", + } + h := &mail.Header{} + h.SetAddressList("from", []*mail.Address{from}) + h.SetAddressList("to", []*mail.Address{to}) + + oh := &mail.Header{} + oh.SetAddressList("from", []*mail.Address{to}) + oh.SetAddressList("to", []*mail.Address{from}) + + original := models.OriginalMail{ + Date: time.Now(), + From: from.String(), + Text: "This is only a test text", + MIMEType: "text/plain", + RFC822Headers: oh, + } + return ParseTemplateData(h, original) +} diff --git a/lib/templates/functions.go b/lib/templates/functions.go new file mode 100644 index 00000000..41c899c8 --- /dev/null +++ b/lib/templates/functions.go @@ -0,0 +1,113 @@ +package templates + +import ( + "bytes" + "os/exec" + "strings" + "text/template" + "time" +) + +var version string + +// SetVersion initializes the aerc version displayed in template functions +func SetVersion(v string) { + version = v +} + +// wrap allows to chain wrapText +func wrap(lineWidth int, text string) string { + return wrapText(text, lineWidth) +} + +func wrapLine(text string, lineWidth int) string { + words := strings.Fields(text) + if len(words) == 0 { + return text + } + var wrapped strings.Builder + wrapped.WriteString(words[0]) + spaceLeft := lineWidth - wrapped.Len() + for _, word := range words[1:] { + if len(word)+1 > spaceLeft { + wrapped.WriteRune('\n') + wrapped.WriteString(word) + spaceLeft = lineWidth - len(word) + } else { + wrapped.WriteRune(' ') + wrapped.WriteString(word) + spaceLeft -= 1 + len(word) + } + } + + return wrapped.String() +} + +func wrapText(text string, lineWidth int) string { + text = strings.ReplaceAll(text, "\r\n", "\n") + text = strings.TrimRight(text, "\n") + lines := strings.Split(text, "\n") + var wrapped strings.Builder + + for _, line := range lines { + switch { + case line == "": + // deliberately left blank + case line[0] == '>': + // leave quoted text alone + wrapped.WriteString(line) + default: + wrapped.WriteString(wrapLine(line, lineWidth)) + } + wrapped.WriteRune('\n') + } + return wrapped.String() +} + +// quote prepends "> " in front of every line in text +func quote(text string) string { + text = strings.ReplaceAll(text, "\r\n", "\n") + text = strings.TrimRight(text, "\n") + lines := strings.Split(text, "\n") + var quoted strings.Builder + for _, line := range lines { + if line == "" { + quoted.WriteString(">\n") + continue + } + quoted.WriteString("> ") + quoted.WriteString(line) + quoted.WriteRune('\n') + } + + return quoted.String() +} + +// cmd allow to parse reply by shell command +// text have to be passed by cmd param +// if there is error, original string is returned +func cmd(cmd, text string) string { + var out bytes.Buffer + c := exec.Command("sh", "-c", cmd) + c.Stdin = strings.NewReader(text) + c.Stdout = &out + err := c.Run() + if err != nil { + return text + } + return out.String() +} + +func toLocal(t time.Time) time.Time { + return time.Time.In(t, time.Local) +} + +var templateFuncs = template.FuncMap{ + "quote": quote, + "wrapText": wrapText, + "wrap": wrap, + "dateFormat": time.Time.Format, + "toLocal": toLocal, + "exec": cmd, + "version": func() string { return version }, +} diff --git a/lib/templates/template.go b/lib/templates/template.go index 7254d493..baf7c2cf 100644 --- a/lib/templates/template.go +++ b/lib/templates/template.go @@ -5,166 +5,12 @@ import ( "fmt" "io" "os" - "os/exec" "path" - "strings" "text/template" - "time" - "github.com/emersion/go-message/mail" - - "git.sr.ht/~rjarry/aerc/models" "github.com/mitchellh/go-homedir" ) -var version string - -// SetVersion initializes the aerc version displayed in template functions -func SetVersion(v string) { - version = v -} - -type TemplateData struct { - To []*mail.Address - Cc []*mail.Address - Bcc []*mail.Address - From []*mail.Address - Date time.Time - Subject string - // Only available when replying with a quote - OriginalText string - OriginalFrom []*mail.Address - OriginalDate time.Time - OriginalMIMEType string -} - -func ParseTemplateData(h *mail.Header, original models.OriginalMail) TemplateData { - // we ignore errors as this shouldn't fail the sending / replying even if - // something is wrong with the message we reply to - to, _ := h.AddressList("to") - cc, _ := h.AddressList("cc") - bcc, _ := h.AddressList("bcc") - from, _ := h.AddressList("from") - subject, err := h.Text("subject") - if err != nil { - subject = h.Get("subject") - } - - td := TemplateData{ - To: to, - Cc: cc, - Bcc: bcc, - From: from, - Date: time.Now(), - Subject: subject, - OriginalText: original.Text, - OriginalDate: original.Date, - OriginalMIMEType: original.MIMEType, - } - if original.RFC822Headers != nil { - origFrom, _ := original.RFC822Headers.AddressList("from") - td.OriginalFrom = origFrom - } - return td -} - -// wrap allows to chain wrapText -func wrap(lineWidth int, text string) string { - return wrapText(text, lineWidth) -} - -func wrapLine(text string, lineWidth int) string { - words := strings.Fields(text) - if len(words) == 0 { - return text - } - var wrapped strings.Builder - wrapped.WriteString(words[0]) - spaceLeft := lineWidth - wrapped.Len() - for _, word := range words[1:] { - if len(word)+1 > spaceLeft { - wrapped.WriteRune('\n') - wrapped.WriteString(word) - spaceLeft = lineWidth - len(word) - } else { - wrapped.WriteRune(' ') - wrapped.WriteString(word) - spaceLeft -= 1 + len(word) - } - } - - return wrapped.String() -} - -func wrapText(text string, lineWidth int) string { - text = strings.ReplaceAll(text, "\r\n", "\n") - text = strings.TrimRight(text, "\n") - lines := strings.Split(text, "\n") - var wrapped strings.Builder - - for _, line := range lines { - switch { - case line == "": - // deliberately left blank - case line[0] == '>': - // leave quoted text alone - wrapped.WriteString(line) - default: - wrapped.WriteString(wrapLine(line, lineWidth)) - } - wrapped.WriteRune('\n') - } - return wrapped.String() -} - -// quote prepends "> " in front of every line in text -func quote(text string) string { - text = strings.ReplaceAll(text, "\r\n", "\n") - text = strings.TrimRight(text, "\n") - lines := strings.Split(text, "\n") - var quoted strings.Builder - for _, line := range lines { - if line == "" { - quoted.WriteString(">\n") - continue - } - quoted.WriteString("> ") - quoted.WriteString(line) - quoted.WriteRune('\n') - } - - return quoted.String() -} - -// cmd allow to parse reply by shell command -// text have to be passed by cmd param -// if there is error, original string is returned -func cmd(cmd, text string) string { - var out bytes.Buffer - c := exec.Command("sh", "-c", cmd) - c.Stdin = strings.NewReader(text) - c.Stdout = &out - err := c.Run() - if err != nil { - return text - } - return out.String() -} - -func toLocal(t time.Time) time.Time { - return time.Time.In(t, time.Local) -} - -var templateFuncs = template.FuncMap{ - "quote": quote, - "wrapText": wrapText, - "wrap": wrap, - "dateFormat": time.Time.Format, - "toLocal": toLocal, - "exec": cmd, - "version": func() string { return version }, -} - func findTemplate(templateName string, templateDirs []string) (string, error) { for _, dir := range templateDirs { templateFile, err := homedir.Expand(path.Join(dir, templateName)) @@ -182,34 +28,6 @@ func findTemplate(templateName string, templateDirs []string) (string, error) { "Can't find template %q in any of %v ", templateName, templateDirs) } -// DummyData provides dummy data to test template validity -func DummyData() interface{} { - from := &mail.Address{ - Name: "John Doe", - Address: "john@example.com", - } - to := &mail.Address{ - Name: "Alice Doe", - Address: "alice@example.com", - } - h := &mail.Header{} - h.SetAddressList("from", []*mail.Address{from}) - h.SetAddressList("to", []*mail.Address{to}) - - oh := &mail.Header{} - oh.SetAddressList("from", []*mail.Address{to}) - oh.SetAddressList("to", []*mail.Address{from}) - - original := models.OriginalMail{ - Date: time.Now(), - From: from.String(), - Text: "This is only a test text", - MIMEType: "text/plain", - RFC822Headers: oh, - } - return ParseTemplateData(h, original) -} - func ParseTemplateFromFile(templateName string, templateDirs []string, data interface{}) (io.Reader, error) { templateFile, err := findTemplate(templateName, templateDirs) if err != nil { -- cgit