1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
|
package commands
import (
"bytes"
"errors"
"path"
"reflect"
"sort"
"strings"
"unicode"
"git.sr.ht/~rjarry/go-opt/v2"
"git.sr.ht/~rjarry/aerc/app"
"git.sr.ht/~rjarry/aerc/config"
"git.sr.ht/~rjarry/aerc/lib/log"
"git.sr.ht/~rjarry/aerc/lib/state"
"git.sr.ht/~rjarry/aerc/lib/templates"
"git.sr.ht/~rjarry/aerc/models"
)
type CommandContext uint32
const (
NONE = 1 << iota
// available everywhere
GLOBAL
// only when a message list is focused
MESSAGE_LIST
// only when a message viewer is focused
MESSAGE_VIEWER
// only when a message composer editor is focused
COMPOSE_EDIT
// only when a message composer review screen is focused
COMPOSE_REVIEW
// only when a terminal
TERMINAL
)
func CurrentContext() CommandContext {
var context CommandContext = GLOBAL
switch tab := app.SelectedTabContent().(type) {
case *app.AccountView:
context |= MESSAGE_LIST
case *app.Composer:
if tab.Bindings() == "compose::review" {
context |= COMPOSE_REVIEW
} else {
context |= COMPOSE_EDIT
}
case *app.MessageViewer:
context |= MESSAGE_VIEWER
case *app.Terminal:
context |= TERMINAL
}
return context
}
type Command interface {
Description() string
Context() CommandContext
Aliases() []string
Execute([]string) error
}
var allCommands map[string]Command
func Register(cmd Command) {
if allCommands == nil {
allCommands = make(map[string]Command)
}
for _, alias := range cmd.Aliases() {
if allCommands[alias] != nil {
panic("duplicate command alias: " + alias)
}
allCommands[alias] = cmd
}
}
func ActiveCommands() []Command {
var cmds []Command
context := CurrentContext()
seen := make(map[reflect.Type]bool)
for _, cmd := range allCommands {
t := reflect.TypeOf(cmd)
if seen[t] {
continue
}
seen[t] = true
if cmd.Context()&context != 0 {
cmds = append(cmds, cmd)
}
}
return cmds
}
func ActiveCommandNames() []string {
var names []string
context := CurrentContext()
for alias, cmd := range allCommands {
if cmd.Context()&context != 0 {
names = append(names, alias)
}
}
return names
}
type NoSuchCommand string
func (err NoSuchCommand) Error() string {
return "Unknown command " + string(err)
}
// Expand non-ambiguous command abbreviations.
//
// q --> quit
// ar --> archive
// im --> import-mbox
func ExpandAbbreviations(name string) (string, Command, error) {
context := CurrentContext()
name = strings.TrimLeft(name, ": \t")
cmd, found := allCommands[name]
if found && cmd.Context()&context != 0 {
return name, cmd, nil
}
var candidate Command
var candidateName string
for alias, cmd := range allCommands {
if cmd.Context()&context == 0 || !strings.HasPrefix(alias, name) {
continue
}
if candidate != nil {
// We have more than one command partially
// matching the input.
return name, nil, NoSuchCommand(name)
}
// We have a partial match.
candidate = cmd
candidateName = alias
}
if candidate == nil {
return name, nil, NoSuchCommand(name)
}
return candidateName, candidate, nil
}
func ResolveCommand(
cmdline string, acct *config.AccountConfig, msg *models.MessageInfo,
) (string, Command, error) {
cmdline, err := ExpandTemplates(cmdline, acct, msg)
if err != nil {
return "", nil, err
}
name, rest, didCut := strings.Cut(cmdline, " ")
name, cmd, err := ExpandAbbreviations(name)
if err != nil {
return "", nil, err
}
cmdline = name
if didCut {
cmdline += " " + rest
}
return cmdline, cmd, nil
}
func templateData(
cfg *config.AccountConfig,
msg *models.MessageInfo,
) models.TemplateData {
var folder *models.Directory
acct := app.SelectedAccount()
if acct != nil {
folder = acct.Directories().SelectedDirectory()
}
if cfg == nil && acct != nil {
cfg = acct.AccountConfig()
}
if msg == nil && acct != nil {
msg, _ = acct.SelectedMessage()
}
data := state.NewDataSetter()
data.SetAccount(cfg)
data.SetFolder(folder)
data.SetInfo(msg, 0, false)
if acct != nil {
acct.SetStatus(func(s *state.AccountState, _ string) {
data.SetState(s)
})
}
return data.Data()
}
func ExecuteCommand(cmd Command, cmdline string) error {
args := opt.LexArgs(cmdline)
if args.Count() == 0 {
return errors.New("No arguments")
}
log.Tracef("executing command %s", args.String())
// copy zeroed struct
tmp := reflect.New(reflect.TypeOf(cmd)).Interface().(Command)
if err := opt.ArgsToStruct(args.Clone(), tmp); err != nil {
return err
}
return tmp.Execute(args.Args())
}
// expand template expressions
func ExpandTemplates(
s string, cfg *config.AccountConfig, msg *models.MessageInfo,
) (string, error) {
if strings.Contains(s, "{{") && strings.Contains(s, "}}") {
t, err := templates.ParseTemplate("execute", s)
if err != nil {
return "", err
}
data := templateData(cfg, msg)
var buf bytes.Buffer
err = templates.Render(t, &buf, data)
if err != nil {
return "", err
}
s = buf.String()
}
return s, nil
}
func GetTemplateCompletion(
cmd string,
) ([]string, string, bool) {
countLeft := strings.Count(cmd, "{{")
if countLeft == 0 {
return nil, "", false
}
countRight := strings.Count(cmd, "}}")
switch {
case countLeft > countRight:
// complete template terms
var i int
for i = len(cmd) - 1; i >= 0; i-- {
if strings.ContainsRune("{()| ", rune(cmd[i])) {
break
}
}
search, prefix := cmd[i+1:], cmd[:i+1]
padding := strings.Repeat(" ",
len(search)-len(strings.TrimLeft(search, " ")))
options := FilterList(
templates.Terms(),
strings.TrimSpace(search),
nil,
)
return options, prefix + padding, true
case countLeft == countRight:
// expand template
s, err := ExpandTemplates(cmd, nil, nil)
if err != nil {
log.Warnf("template rendering failed: %v", err)
return nil, "", false
}
return []string{s}, "", true
}
return nil, "", false
}
// GetCompletions returns the completion options and the command prefix
func GetCompletions(
cmd Command, args *opt.Args,
) (options []opt.Completion, prefix string) {
// copy zeroed struct
tmp := reflect.New(reflect.TypeOf(cmd)).Interface().(Command)
s, err := args.ArgSafe(0)
if err != nil {
log.Errorf("completions error: %v", err)
return options, prefix
}
spec := opt.NewCmdSpec(s, tmp)
return spec.GetCompletions(args)
}
func GetFolders(arg string) []string {
acct := app.SelectedAccount()
if acct == nil {
return make([]string, 0)
}
return FilterList(acct.Directories().List(), arg, nil)
}
func GetTemplates(arg string) []string {
templates := make(map[string]bool)
for _, dir := range config.Templates.TemplateDirs {
for _, f := range listDir(dir, false) {
if !isDir(path.Join(dir, f)) {
templates[f] = true
}
}
}
names := make([]string, 0, len(templates))
for n := range templates {
names = append(names, n)
}
sort.Strings(names)
return FilterList(names, arg, nil)
}
func GetLabels(arg string) []string {
acct := app.SelectedAccount()
if acct == nil {
return make([]string, 0)
}
var prefix string
if arg != "" {
// + and - are used to denote tag addition / removal and need to
// be striped only the last tag should be completed, so that
// multiple labels can be selected
switch arg[0] {
case '+':
prefix = "+"
case '-':
prefix = "-"
}
arg = strings.TrimLeft(arg, "+-")
}
return FilterList(acct.Labels(), arg, func(s string) string {
return opt.QuoteArg(prefix+s) + " "
})
}
// hasCaseSmartPrefix checks whether s starts with prefix, using a case
// sensitive match if and only if prefix contains upper case letters.
func hasCaseSmartPrefix(s, prefix string) bool {
if hasUpper(prefix) {
return strings.HasPrefix(s, prefix)
}
return strings.HasPrefix(strings.ToLower(s), strings.ToLower(prefix))
}
func hasUpper(s string) bool {
for _, r := range s {
if unicode.IsUpper(r) {
return true
}
}
return false
}
|