package config import ( "bytes" "fmt" "path" "regexp" "strconv" "strings" "text/template" "time" "git.sr.ht/~rjarry/aerc/lib/templates" "git.sr.ht/~rjarry/aerc/log" "github.com/emersion/go-message/mail" "github.com/gdamore/tcell/v2" "github.com/go-ini/ini" ) type UIConfig struct { IndexColumns []*ColumnDef `ini:"index-columns" parse:"ParseIndexColumns" default:"date<20,name<17,flags>4,subject<*"` ColumnSeparator string `ini:"column-separator" default:" "` DirListLeft *template.Template `ini:"dirlist-left" default:"{{.Folder}}"` DirListRight *template.Template `ini:"dirlist-right" default:"{{if .Unread}}{{humanReadable .Unread}}/{{end}}{{if .Exists}}{{humanReadable .Exists}}{{end}}"` AutoMarkRead bool `ini:"auto-mark-read" default:"true"` TimestampFormat string `ini:"timestamp-format" default:"2006-01-02 03:04 PM"` ThisDayTimeFormat string `ini:"this-day-time-format"` ThisWeekTimeFormat string `ini:"this-week-time-format"` ThisYearTimeFormat string `ini:"this-year-time-format"` MessageViewTimestampFormat string `ini:"message-view-timestamp-format"` MessageViewThisDayTimeFormat string `ini:"message-view-this-day-time-format"` MessageViewThisWeekTimeFormat string `ini:"message-view-this-week-time-format"` MessageViewThisYearTimeFormat string `ini:"message-view-this-year-time-format"` PinnedTabMarker string "ini:\"pinned-tab-marker\" default:\"`\"" SidebarWidth int `ini:"sidebar-width" default:"20"` EmptyMessage string `ini:"empty-message" default:"(no messages)"` EmptyDirlist string `ini:"empty-dirlist" default:"(no folders)"` MouseEnabled bool `ini:"mouse-enabled"` ThreadingEnabled bool `ini:"threading-enabled"` ForceClientThreads bool `ini:"force-client-threads"` ClientThreadsDelay time.Duration `ini:"client-threads-delay" default:"50ms"` FuzzyComplete bool `ini:"fuzzy-complete"` NewMessageBell bool `ini:"new-message-bell" default:"true"` Spinner string `ini:"spinner" default:"[..] , [..] , [..] , [..] , [..], [..] , [..] , [..] "` SpinnerDelimiter string `ini:"spinner-delimiter" default:","` SpinnerInterval time.Duration `ini:"spinner-interval" default:"200ms"` IconUnencrypted string `ini:"icon-unencrypted"` IconEncrypted string `ini:"icon-encrypted" default:"[e]"` IconSigned string `ini:"icon-signed" default:"[s]"` IconSignedEncrypted string `ini:"icon-signed-encrypted"` IconUnknown string `ini:"icon-unknown" default:"[s?]"` IconInvalid string `ini:"icon-invalid" default:"[s!]"` IconAttachment string `ini:"icon-attachment" default:"a"` DirListDelay time.Duration `ini:"dirlist-delay" default:"200ms"` DirListTree bool `ini:"dirlist-tree"` DirListCollapse int `ini:"dirlist-collapse"` Sort []string `ini:"sort" delim:" "` NextMessageOnDelete bool `ini:"next-message-on-delete" default:"true"` CompletionDelay time.Duration `ini:"completion-delay" default:"250ms"` CompletionMinChars int `ini:"completion-min-chars" default:"1"` CompletionPopovers bool `ini:"completion-popovers" default:"true"` StyleSetDirs []string `ini:"stylesets-dirs" delim:":"` StyleSetName string `ini:"styleset-name" default:"default"` style StyleSet // customize border appearance BorderCharVertical rune `ini:"border-char-vertical" default:" " type:"rune"` BorderCharHorizontal rune `ini:"border-char-horizontal" default:" " type:"rune"` ReverseOrder bool `ini:"reverse-msglist-order"` ReverseThreadOrder bool `ini:"reverse-thread-order"` SortThreadSiblings bool `ini:"sort-thread-siblings"` // Tab Templates TabTitleAccount *template.Template `ini:"tab-title-account" default:"{{.Account}}"` TabTitleComposer *template.Template `ini:"tab-title-composer" default:"{{.Subject}}"` // private contextualUis []*UiConfigContext contextualCounts map[uiContextType]int contextualCache map[uiContextKey]*UIConfig } type uiContextType int const ( uiContextFolder uiContextType = iota uiContextAccount ) type UiConfigContext struct { ContextType uiContextType Regex *regexp.Regexp UiConfig *UIConfig Section ini.Section } type uiContextKey struct { ctxType uiContextType value string } const unreadExists string = `{{if .Unread}}{{humanReadable .Unread}}/{{end}}{{if .Exists}}{{humanReadable .Exists}}{{end}}` var Ui = &UIConfig{ contextualCounts: make(map[uiContextType]int), contextualCache: make(map[uiContextKey]*UIConfig), } var uiContextualSectionRe = regexp.MustCompile(`^ui:(account|folder|subject)([~=])(.+)$`) func parseUi(file *ini.File) error { if err := Ui.parse(file.Section("ui")); err != nil { return err } var ctxSubjectSections []*ini.Section for _, section := range file.Sections() { var err error groups := uiContextualSectionRe.FindStringSubmatch(section.Name()) if groups == nil { continue } ctx, separator, value := groups[1], groups[2], groups[3] if ctx == "subject" { log.Warnf( "%s contextual subject config has been replaced by dynamic msglist_* styles.", section.Name()) ctxSubjectSections = append(ctxSubjectSections, section) continue } uiSubConfig := UIConfig{} if err = uiSubConfig.parse(section); err != nil { return err } contextualUi := UiConfigContext{ UiConfig: &uiSubConfig, Section: *section, } switch ctx { case "account": contextualUi.ContextType = uiContextAccount case "folder": contextualUi.ContextType = uiContextFolder } if separator == "=" { value = "^" + regexp.QuoteMeta(value) + "$" } contextualUi.Regex, err = regexp.Compile(value) if err != nil { return err } Ui.contextualUis = append(Ui.contextualUis, &contextualUi) Ui.contextualCounts[contextualUi.ContextType]++ } if len(ctxSubjectSections) > 0 { f := ini.Empty() for _, sec := range ctxSubjectSections { s, _ := f.NewSection(sec.Name()) for k, v := range sec.KeysHash() { s.NewKey(k, v) //nolint:errcheck // who cares? } } var buf bytes.Buffer f.WriteTo(&buf) //nolint:errcheck // who cares? w := Warning{ Title: "DEPRECATION WARNING: SUBJECT UI SECTIONS", Body: fmt.Sprintf(` Contextual UI configuration based on subject value has been deprecated and replaced by dynamic msglist_* styles in stylesets. The following configuration sections from aerc.conf have been ignored: %sYou should remove them to get rid of that warning and update your styleset(s) accordingly. See aerc-stylesets(7) for more details.`, buf.String()), } Warnings = append(Warnings, w) } // append default paths to styleset-dirs for _, dir := range SearchDirs { Ui.StyleSetDirs = append( Ui.StyleSetDirs, path.Join(dir, "stylesets"), ) } if err := Ui.loadStyleSet(Ui.StyleSetDirs); err != nil { return err } for _, contextualUi := range Ui.contextualUis { if contextualUi.UiConfig.StyleSetName == "" && len(contextualUi.UiConfig.StyleSetDirs) == 0 { continue // no need to do anything if nothing is overridden } // fill in the missing part from the base if contextualUi.UiConfig.StyleSetName == "" { contextualUi.UiConfig.StyleSetName = Ui.StyleSetName } else if len(contextualUi.UiConfig.StyleSetDirs) == 0 { contextualUi.UiConfig.StyleSetDirs = Ui.StyleSetDirs } // since at least one of them has changed, load the styleset if err := contextualUi.UiConfig.loadStyleSet( contextualUi.UiConfig.StyleSetDirs); err != nil { return err } } log.Debugf("aerc.conf: [ui] %#v", Ui) return nil } func (config *UIConfig) parse(section *ini.Section) error { if err := MapToStruct(section, config, section.Name() == "ui"); err != nil { return err } if config.MessageViewTimestampFormat == "" { config.MessageViewTimestampFormat = config.TimestampFormat } if key, err := section.GetKey("index-format"); err == nil { columns, err := convertIndexFormat(key.String()) if err != nil { return err } config.IndexColumns = columns log.Warnf("%s %s", "The index-format setting has been replaced by index-columns.", "index-format will be removed in aerc 0.17.") w := Warning{ Title: "DEPRECATION WARNING: [" + section.Name() + "].index-format", Body: fmt.Sprintf(` The index-format setting is deprecated. It has been replaced by index-columns. Your configuration in this instance was automatically converted to: [%s] %s Your configuration file was not changed. To make this change permanent and to dismiss this deprecation warning on launch, copy the above lines into aerc.conf and remove index-format from it. See aerc-config(5) for more details. index-format will be removed in aerc 0.17. `, section.Name(), ColumnDefsToIni(columns, "index-columns")), } Warnings = append(Warnings, w) } if key, err := section.GetKey("dirlist-format"); err == nil { left, right := convertDirlistFormat(key.String()) l, err := templates.ParseTemplate(left, left) if err != nil { return err } r, err := templates.ParseTemplate(right, right) if err != nil { return err } config.DirListLeft = l config.DirListRight = r log.Warnf("%s %s", "The dirlist-format setting has been replaced by dirlist-left and dirlist-right.", "dirlist-format will be removed in aerc 0.17.") w := Warning{ Title: "DEPRECATION WARNING: [" + section.Name() + "].dirlist-format", Body: fmt.Sprintf(` The dirlist-format setting is deprecated. It has been replaced by dirlist-left and dirlist-right. Your configuration in this instance was automatically converted to: [%s] dirlist-left = %s dirlist-right = %s Your configuration file was not changed. To make this change permanent and to dismiss this deprecation warning on launch, copy the above lines into aerc.conf and remove dirlist-format from it. See aerc-config(5) for more details. dirlist-format will be removed in aerc 0.17. `, section.Name(), left, right), } Warnings = append(Warnings, w) } return nil } func (*UIConfig) ParseIndexColumns(section *ini.Section, key *ini.Key) ([]*ColumnDef, error) { if !section.HasKey("column-date") { _, _ = section.NewKey("column-date", `{{.DateAutoFormat .Date.Local}}`) } if !section.HasKey("column-name") { _, _ = section.NewKey("column-name", `{{index (.From | names) 0}}`) } if !section.HasKey("column-flags") { _, _ = section.NewKey("column-flags", `{{.Flags | join ""}}`) } if !section.HasKey("column-subject") { _, _ = section.NewKey("column-subject", `{{.ThreadPrefix}}{{if .ThreadFolded}}{{printf "{%d}" .ThreadCount}}{{end}}{{.Subject}}`) } return ParseColumnDefs(key, section) } var indexFmtRegexp = regexp.MustCompile(`%(-?\d+)?(\.\d+)?([ACDFRTZadfgilnrstuv])`) func convertIndexFormat(indexFormat string) ([]*ColumnDef, error) { matches := indexFmtRegexp.FindAllStringSubmatch(indexFormat, -1) if matches == nil { return nil, fmt.Errorf("invalid index-format") } var columns []*ColumnDef for _, m := range matches { alignWidth := m[1] verb := m[3] var width float64 = 0 var flags ColumnFlags = ALIGN_LEFT f, name := indexVerbToTemplate([]rune(verb)[0]) if verb == "Z" { width = 4 flags = ALIGN_RIGHT } t, err := templates.ParseTemplate(fmt.Sprintf("column-%s", name), f) if err != nil { return nil, err } if alignWidth != "" { width, err = strconv.ParseFloat(alignWidth, 64) if err != nil { return nil, err } if width < 0 { width = -width } else { flags = ALIGN_RIGHT } } if width == 0 { flags |= WIDTH_AUTO } else { flags |= WIDTH_EXACT } columns = append(columns, &ColumnDef{ Name: name, Width: width, Flags: flags, Template: t, }) } return columns, nil } func indexVerbToTemplate(verb rune) (f, name string) { switch verb { case '%': f = string(verb) case 'a': f = `{{(index .From 0).Address}}` name = "sender" case 'A': f = `{{if eq (len .ReplyTo) 0}}{{(index .From 0).Address}}{{else}}{{(index .ReplyTo 0).Address}}{{end}}` name = "reply-to" case 'C': f = "{{.Number}}" name = "num" case 'd', 'D': f = "{{.DateAutoFormat .Date.Local}}" name = "date" case 'f': f = `{{index (.From | persons) 0}}` name = "from" case 'F': f = `{{.Peer | names | join ", "}}` name = "peers" case 'g': f = `{{.Labels | join ", "}}` name = "labels" case 'i': f = "{{.MessageId}}" name = "msg-id" case 'n': f = `{{index (.From | names) 0}}` name = "name" case 'r': f = `{{.To | persons | join ", "}}` name = "to" case 'R': f = `{{.Cc | persons | join ", "}}` name = "cc" case 's': f = "{{.ThreadPrefix}}{{.Subject}}" name = "subject" case 't': f = "{{(index .To 0).Address}}" name = "to0" case 'T': f = "{{.Account}}" name = "account" case 'u': f = "{{index (.From | mboxes) 0}}" name = "mboxes" case 'v': f = "{{index (.From | names) 0}}" name = "name" case 'Z': f = `{{.Flags | join ""}}` name = "flags" case 'l': f = "{{.Size}}" name = "size" default: f = "%" + string(verb) } if name == "" { name = columnNameFromTemplate(f) } return } func convertDirlistFormat(format string) (string, string) { tmpl := regexp.MustCompile(`%>?[Nnr]`).ReplaceAllStringFunc( format, func(s string) string { runes := []rune(s) switch runes[len(runes)-1] { case 'N': s = `{{.Folder | compactDir}}` case 'n': s = `{{.Folder}}` case 'r': s = unreadExists default: return s } if strings.HasPrefix(string(runes), "%>") { s = "%>" + s } return s }, ) tokens := strings.SplitN(tmpl, "%>", 2) switch len(tokens) { case 2: return strings.TrimSpace(tokens[0]), strings.TrimSpace(tokens[1]) case 1: return strings.TrimSpace(tokens[0]), "" default: return "", "" } } func (ui *UIConfig) loadStyleSet(styleSetDirs []string) error { ui.style = NewStyleSet() err := ui.style.LoadStyleSet(ui.StyleSetName, styleSetDirs) if err != nil { return fmt.Errorf("Unable to load %q styleset: %w", ui.StyleSetName, err) } return nil } func (base *UIConfig) mergeContextual( contextType uiContextType, s string, ) *UIConfig { for _, contextualUi := range base.contextualUis { if contextualUi.ContextType != contextType { continue } if !contextualUi.Regex.Match([]byte(s)) { continue } ui := *base err := ui.parse(&contextualUi.Section) if err != nil { log.Warnf("merge ui failed: %v", err) } ui.contextualCache = make(map[uiContextKey]*UIConfig) ui.contextualCounts = base.contextualCounts ui.contextualUis = base.contextualUis if contextualUi.UiConfig.StyleSetName != "" { ui.style = contextualUi.UiConfig.style } return &ui } return base } func (uiConfig *UIConfig) GetUserStyle(name string) tcell.Style { return uiConfig.style.UserStyle(name) } func (uiConfig *UIConfig) GetStyle(so StyleObject) tcell.Style { return uiConfig.style.Get(so, nil) } func (uiConfig *UIConfig) GetStyleSelected(so StyleObject) tcell.Style { return uiConfig.style.Selected(so, nil) } func (uiConfig *UIConfig) GetComposedStyle(base StyleObject, styles []StyleObject, ) tcell.Style { return uiConfig.style.Compose(base, styles, nil) } func (uiConfig *UIConfig) GetComposedStyleSelected( base StyleObject, styles []StyleObject, ) tcell.Style { return uiConfig.style.ComposeSelected(base, styles, nil) } func (uiConfig *UIConfig) MsgComposedStyle( base StyleObject, styles []StyleObject, h *mail.Header, ) tcell.Style { return uiConfig.style.Compose(base, styles, h) } func (uiConfig *UIConfig) MsgComposedStyleSelected( base StyleObject, styles []StyleObject, h *mail.Header, ) tcell.Style { return uiConfig.style.ComposeSelected(base, styles, h) } func (uiConfig *UIConfig) StyleSetPath() string { return uiConfig.style.path } func (base *UIConfig) contextual(ctxType uiContextType, value string) *UIConfig { if base.contextualCounts[ctxType] == 0 { // shortcut if no contextual ui for that type return base } key := uiContextKey{ctxType: ctxType, value: value} c, found := base.contextualCache[key] if !found { c = base.mergeContextual(ctxType, value) base.contextualCache[key] = c } return c } func (base *UIConfig) ForAccount(account string) *UIConfig { return base.contextual(uiContextAccount, account) } func (base *UIConfig) ForFolder(folder string) *UIConfig { return base.contextual(uiContextFolder, folder) }