Display a help message upon first start of Profanity - profani-tty

diff options

author	Michael Vetter <jubalh@iodoru.org>	2022-07-05 06:57:11 +0200
committer	Michael Vetter <jubalh@iodoru.org>	2022-07-05 06:57:11 +0200
commit	27a5c9d287e856bd774988b4066667db54b65de7 (patch)
tree	3917f2e1742daa06ba69569199d1e0d678d321f6
parent	6a3ea47dc0aec4c4b0d9a4160ceacfc4ab09c2de (diff)
download	profani-tty-27a5c9d287e856bd774988b4066667db54b65de7.tar.gz

Display a help message upon first start of Profanity

Explaining how to register/connect/set up an account.

Diffstat

-rw-r--r--

src/config/preferences.c

-rw-r--r--

src/ui/console.c

2 files changed, 24 insertions, 1 deletions

package widgets import ( "bufio" "bytes" "fmt" "io" "io/ioutil" "mime" "net/http" gomail "net/mail" "os" "os/exec" "path/filepath" "strings" "time" "github.com/emersion/go-message" "github.com/emersion/go-message/mail" "github.com/gdamore/tcell" "github.com/mattn/go-runewidth" "github.com/mitchellh/go-homedir" "github.com/pkg/errors" "git.sr.ht/~sircmpwn/aerc/completer" "git.sr.ht/~sircmpwn/aerc/config" "git.sr.ht/~sircmpwn/aerc/lib/templates" "git.sr.ht/~sircmpwn/aerc/lib/ui" "git.sr.ht/~sircmpwn/aerc/models" "git.sr.ht/~sircmpwn/aerc/worker/types" ) type Composer struct { editors map[string]*headerEditor acct *config.AccountConfig config *config.AercConfig aerc *Aerc attachments []string date time.Time defaults map[string]string editor *Terminal email *os.File grid *ui.Grid header *ui.Grid msgId string review *reviewMessage worker *types.Worker completer *completer.Completer layout HeaderLayout focusable []ui.MouseableDrawableInteractive focused int onClose []func(ti *Composer) width int } func NewComposer(aerc *Aerc, conf *config.AercConfig, acct *config.AccountConfig, worker *types.Worker, template string, defaults map[string]string, original models.OriginalMail) (*Composer, error) { if defaults == nil { defaults = make(map[string]string) } if from := defaults["From"]; from == "" { defaults["From"] = acct.From } templateData := templates.ParseTemplateData(defaults, original) cmpl := completer.New(conf.Compose.AddressBookCmd, func(err error) { aerc.PushError(fmt.Sprintf("could not complete header: %v", err)) worker.Logger.Printf("could not complete header: %v", err) }, aerc.Logger()) layout, editors, focusable := buildComposeHeader(conf, cmpl, defaults) email, err := ioutil.TempFile("", "aerc-compose-*.eml") if err != nil { // TODO: handle this better return nil, err } c := &Composer{ acct: acct, aerc: aerc, config: conf, date: time.Now(), defaults: defaults, editors: editors, email: email, layout: layout, msgId: mail.GenerateMessageID(), worker: worker, // You have to backtab to get to "From", since you usually don't edit it focused: 1, focusable: focusable, completer: cmpl, } c.AddSignature() if err := c.AddTemplate(template, templateData); err != nil { return nil, err } c.updateGrid() c.ShowTerminal() return c, nil } func buildComposeHeader(conf *config.AercConfig, cmpl *completer.Completer, defaults map[string]string) ( newLayout HeaderLayout, editors map[string]*headerEditor, focusable []ui.MouseableDrawableInteractive, ) { layout := conf.Compose.HeaderLayout editors = make(map[string]*headerEditor) focusable = make([]ui.MouseableDrawableInteractive, 0) for _, row := range layout { for _, h := range row { e := newHeaderEditor(h, "") if conf.Ui.CompletionPopovers { e.input.TabComplete(cmpl.ForHeader(h), conf.Ui.CompletionDelay) } editors[h] = e switch h { case "From": // Prepend From to support backtab focusable = append([]ui.MouseableDrawableInteractive{e}, focusable...) default: focusable = append(focusable, e) } } } // Add Cc/Bcc editors to layout if in defaults and not already visible for _, h := range []string{"Cc", "Bcc"} { if val, ok := defaults[h]; ok && val != "" { if _, ok := editors[h]; !ok { e := newHeaderEditor(h, "") if conf.Ui.CompletionPopovers { e.input.TabComplete(cmpl.ForHeader(h), conf.Ui.CompletionDelay) } editors[h] = e focusable = append(focusable, e) layout = append(layout, []string{h}) } } } // Set default values for all editors for key := range editors { if val, ok := defaults[key]; ok { editors[key].input.Set(val) delete(defaults, key) } } return layout, editors, focusable } // Note: this does not reload the editor. You must call this before the first // Draw() call. func (c *Composer) SetContents(reader io.Reader) *Composer { c.email.Seek(0, io.SeekStart) io.Copy(c.email, reader) c.email.Sync() c.email.Seek(0, io.SeekStart) return c } func (c *Composer) PrependContents(reader io.Reader) { buf := bytes.NewBuffer(nil) c.email.Seek(0, io.SeekStart) io.Copy(buf, c.email) c.email.Seek(0, io.SeekStart) io.Copy(c.email, reader) io.Copy(c.email, buf) c.email.Sync() } func (c *Composer) AppendContents(reader io.Reader) { c.email.Seek(0, io.SeekEnd) io.Copy(c.email, reader) c.email.Sync() } func (c *Composer) AddTemplate(template string, data interface{}) error { if template == "" { return nil } templateText, err := templates.ParseTemplateFromFile( template, c.config.Templates.TemplateDirs, data) if err != nil { return err } return c.addTemplate(templateText) } func (c *Composer) AddTemplateFromString(template string, data interface{}) error { if template == "" { return nil } templateText, err := templates.ParseTemplate(template, data) if err != nil { return err } return c.addTemplate(templateText) } func (c *Composer) addTemplate(templateText []byte) error { reader, err := mail.CreateReader(bytes.NewReader(templateText)) if err != nil { // encountering an error when reading the template probably // means the template didn't evaluate to a properly formatted // mail file. // This is fine, we still want to support simple body templates // that don't include headers. // // Just prepend the rendered template in that case. This // basically equals the previous behavior. c.PrependContents(bytes.NewReader(templateText)) return nil } defer reader.Close() // populate header editors header := reader.Header mhdr := (*message.Header)(&header.Header) for _, editor := range c.editors { if mhdr.Has(editor.name) { editor.input.Set(mhdr.Get(editor.name)) // remove header fields that have editors mhdr.Del(editor.name) } } part, err := reader.NextPart() if err != nil { return errors.Wrap(err, "reader.NextPart") } c.PrependContents(part.Body) var ( headers string fds = mhdr.Fields() ) for fds.Next() { headers += fmt.Sprintf("%s: %s\n", fds.Key(), fds.Value()) } if headers != "" { headers += "\n" } // prepend header fields without editors to message body c.PrependContents(bytes.NewReader([]byte(headers))) return nil } func (c *Composer) AddSignature() { var signature []byte if c.acct.SignatureCmd != "" { var err error signature, err = c.readSignatureFromCmd() if err != nil { signature = c.readSignatureFromFile() } } else { signature = c.readSignatureFromFile() } c.AppendContents(bytes.NewReader(signature)) } func (c *Composer) readSignatureFromCmd() ([]byte, error) { sigCmd := c.acct.SignatureCmd cmd := exec.Command("sh", "-c", sigCmd) signature, err := cmd.Output() if err != nil { return nil, err } return signature, nil } func (c *Composer) readSignatureFromFile() []byte { sigFile := c.acct.SignatureFile if sigFile == "" { return nil } sigFile, err := homedir.Expand(sigFile) if err != nil { return nil } signature, err := ioutil.ReadFile(sigFile) if err != nil { c.aerc.PushError(fmt.Sprintf(" Error loading signature from file: %v", sigFile)) return nil } return signature } func (c *Composer) FocusTerminal() *Composer { if c.editor == nil { return c } c.focusable[c.focused].Focus(false) c.focused = len(c.editors) c.focusable[c.focused].Focus(true) return c } func (c *Composer) FocusSubject() *Composer { c.focusable[c.focused].Focus(false) c.focused = 2 c.focusable[c.focused].Focus(true) return c } func (c *Composer) FocusRecipient() *Composer { c.focusable[c.focused].Focus(false) c.focused = 1 c.focusable[c.focused].Focus(true) return c } // OnHeaderChange registers an OnChange callback for the specified header. func (c *Composer) OnHeaderChange(header string, fn func(subject string)) { if editor, ok := c.editors[header]; ok { editor.OnChange(func() { fn(editor.input.String()) }) } } func (c *Composer) OnClose(fn func(composer *Composer)) { c.onClose = append(c.onClose, fn) } func (c *Composer) Draw(ctx *ui.Context) { c.width = ctx.Width() c.grid.Draw(ctx) } func (c *Composer) Invalidate() { c.grid.Invalidate() } func (c *Composer) OnInvalidate(fn func(d ui.Drawable)) { c.grid.OnInvalidate(func(_ ui.Drawable) { fn(c) }) } func (c *Composer) Close() { for _, onClose := range c.onClose { onClose(c) } if c.email != nil { path := c.email.Name() c.email.Close() os.Remove(path) c.email = nil } if c.editor != nil { c.editor.Destroy() c.editor = nil } } func (c *Composer) Bindings() string { if c.editor == nil { return "compose::review" } else if c.editor == c.focusable[c.focused] { return "compose::editor" } else { return "compose" } } func (c *Composer) Event(event tcell.Event) bool { if c.editor != nil { return c.focusable[c.focused].Event(event) } return false } func (c *Composer) MouseEvent(localX int, localY int, event tcell.Event) { c.grid.MouseEvent(localX, localY, event) for _, e := range c.focusable { he, ok := e.(*headerEditor) if ok && he.focused { c.FocusEditor(he) } } } func (c *Composer) Focus(focus bool) { c.focusable[c.focused].Focus(focus) } func (c *Composer) Config() *config.AccountConfig { return c.acct } func (c *Composer) Worker() *types.Worker { return c.worker } func (c *Composer) PrepareHeader() (*mail.Header, []string, error) { // Extract headers from the email, if present if err := c.reloadEmail(); err != nil { return nil, nil, err } var ( rcpts []string header mail.Header ) reader, err := mail.CreateReader(c.email) if err == nil { header = reader.Header defer reader.Close() } else { c.email.Seek(0, io.SeekStart) } // Update headers mhdr := (*message.Header)(&header.Header) mhdr.SetText("Message-Id", c.msgId) headerKeys := make([]string, 0, len(c.editors)) for key := range c.editors { headerKeys = append(headerKeys, key) } // Ensure headers which require special processing are included. for _, key := range []string{"To", "From", "Cc", "Bcc", "Subject", "Date"} { if _, ok := c.editors[key]; !ok { headerKeys = append(headerKeys, key) } } for _, h := range headerKeys { val := "" editor, ok := c.editors[h] if ok { val = editor.input.String() } else { val, _ = mhdr.Text(h) } switch h { case "Subject": if subject, _ := header.Subject(); subject == "" { header.SetSubject(val) } case "Date": if date, err := header.Date(); err != nil || date == (time.Time{}) { header.SetDate(c.date) } case "From", "To", "Cc", "Bcc": // Address headers if val != "" { hdrRcpts, err := gomail.ParseAddressList(val) if err != nil { return nil, nil, errors.Wrapf(err, "ParseAddressList(%s)", val) } edRcpts := make([]*mail.Address, len(hdrRcpts)) for i, addr := range hdrRcpts { edRcpts[i] = (*mail.Address)(addr) } header.SetAddressList(h, edRcpts) if h != "From" { for _, addr := range edRcpts { rcpts = append(rcpts, addr.Address) } } } default: // Handle user configured header editors. if ok && !mhdr.Header.Has(h) { if val := editor.input.String(); val != "" { mhdr.SetText(h, val) } } } } // Merge in additional headers txthdr := mhdr.Header for key, value := range c.defaults { if !txthdr.Has(key) && value != "" { mhdr.SetText(key, value) } } return &header, rcpts, nil } func (c *Composer) WriteMessage(header *mail.Header, writer io.Writer) error { if err := c.reloadEmail(); err != nil { return err } var body io.Reader reader, err := mail.CreateReader(c.email) if err == nil { // TODO: Do we want to let users write a full blown multipart email // into the editor? If so this needs to change part, err := reader.NextPart() if err != nil { return errors.Wrap(err, "reader.NextPart") } body = part.Body defer reader.Close() } else { c.email.Seek(0, io.SeekStart) body = c.email } if len(c.attachments) == 0 { // don't create a multipart email if we only have text return writeInlineBody(header, body, writer) } // otherwise create a multipart email, // with a multipart/alternative part for the text w, err := mail.CreateWriter(writer, *header) if err != nil { return errors.Wrap(err, "CreateWriter") } defer w.Close() if err := writeMultipartBody(body, w); err != nil { return errors.Wrap(err, "writeMultipartBody") } for _, a := range c.attachments { if err := writeAttachment(a, w); err != nil { return errors.Wrap(err, "writeAttachment") } } return nil } func writeInlineBody(header *mail.Header, body io.Reader, writer io.Writer) error { header.SetContentType("text/plain", map[string]string{"charset": "UTF-8"}) w, err := mail.CreateSingleInlineWriter(writer, *header) if err != nil { return errors.Wrap(err, "CreateSingleInlineWriter") } defer w.Close() if _, err := io.Copy(w, body); err != nil { return errors.Wrap(err, "io.Copy") } return nil } // write the message body to the multipart message func writeMultipartBody(body io.Reader, w *mail.Writer) error { bh := mail.InlineHeader{} bh.SetContentType("text/plain", map[string]string{"charset": "UTF-8"}) bi, err := w.CreateInline() if err != nil { return errors.Wrap(err, "CreateInline") } defer bi.Close() bw, err := bi.CreatePart(bh) if err != nil { return errors.Wrap(err, "CreatePart") } defer bw.Close() if _, err := io.Copy(bw, body); err != nil { return errors.Wrap(err, "io.Copy") } return nil } // write the attachment specified by path to the message func writeAttachment(path string, writer *mail.Writer) error { filename := filepath.Base(path) f, err := os.Open(path) if err != nil { return errors.Wrap(err, "os.Open") } defer f.Close() reader := bufio.NewReader(f) // determine the MIME type // http.DetectContentType only cares about the first 512 bytes head, err := reader.Peek(512) if err != nil && err != io.EOF { return errors.Wrap(err, "Peek") } mimeString := http.DetectContentType(head) // mimeString can contain type and params (like text encoding), // so we need to break them apart before passing them to the headers mimeType, params, err := mime.ParseMediaType(mimeString) if err != nil { return errors.Wrap(err, "ParseMediaType") } params["name"] = filename // set header fields ah := mail.AttachmentHeader{} ah.SetContentType(mimeType, params) // setting the filename auto sets the content disposition ah.SetFilename(filename) aw, err := writer.CreateAttachment(ah) if err != nil { return errors.Wrap(err, "CreateAttachment") } defer aw.Close() if _, err := reader.WriteTo(aw); err != nil { return errors.Wrap(err, "reader.WriteTo") } return nil } func (c *Composer) GetAttachments() []string { return c.attachments } func (c *Composer) AddAttachment(path string) { c.attachments = append(c.attachments, path) c.resetReview() } func (c *Composer) DeleteAttachment(path string) error { for i, a := range c.attachments { if a == path { c.attachments = append(c.attachments[:i], c.attachments[i+1:]...) c.resetReview() return nil } } return errors.New("attachment does not exist") } func (c *Composer) resetReview() { if c.review != nil { c.grid.RemoveChild(c.review) c.review = newReviewMessage(c, nil) c.grid.AddChild(c.review).At(1, 0) } } func (c *Composer) termEvent(event tcell.Event) bool { switch event := event.(type) { case *tcell.EventMouse: switch event.Buttons() { case tcell.Button1: c.FocusTerminal() return true } } return false } func (c *Composer) termClosed(err error) { c.grid.RemoveChild(c.editor) c.review = newReviewMessage(c, err) c.grid.AddChild(c.review).At(1, 0) c.editor.Destroy() c.editor = nil c.focusable = c.focusable[:len(c.focusable)-1] if c.focused >= len(c.focusable) { c.focused = len(c.focusable) - 1 } } func (c *Composer) ShowTerminal() { if c.editor != nil { return } if c.review != nil { c.grid.RemoveChild(c.review) } editorName := c.config.Compose.Editor if editorName == "" { editorName = os.Getenv("EDITOR") } if editorName == "" { editorName = "vi" } editor := exec.Command("/bin/sh", "-c", editorName+" "+c.email.Name()) c.editor, _ = NewTerminal(editor) // TODO: handle error c.editor.OnEvent = c.termEvent c.editor.OnClose = c.termClosed c.grid.AddChild(c.editor).At(1, 0) c.focusable = append(c.focusable, c.editor) } func (c *Composer) PrevField() { c.focusable[c.focused].Focus(false) c.focused-- if c.focused == -1 { c.focused = len(c.focusable) - 1 } c.focusable[c.focused].Focus(true) } func (c *Composer) NextField() { c.focusable[c.focused].Focus(false) c.focused = (c.focused + 1) % len(c.focusable) c.focusable[c.focused].Focus(true) } func (c *Composer) FocusEditor(editor *headerEditor) { c.focusable[c.focused].Focus(false) for i, e := range c.focusable { if e == editor { c.focused = i break } } c.focusable[c.focused].Focus(true) } // AddEditor appends a new header editor to the compose window. func (c *Composer) AddEditor(header string, value string, appendHeader bool) { if _, ok := c.editors[header]; ok { if appendHeader { header := c.editors[header].input.String() value = strings.TrimSpace(header) + ", " + value } c.editors[header].input.Set(value) if value == "" { c.FocusEditor(c.editors[header]) } return } e := newHeaderEditor(header, value) if c.config.Ui.CompletionPopovers { e.input.TabComplete(c.completer.ForHeader(header), c.config.Ui.CompletionDelay) } c.editors[header] = e c.layout = append(c.layout, []string{header}) // Insert focus of new editor before terminal editor c.focusable = append( c.focusable[:len(c.focusable)-1], e, c.focusable[len(c.focusable)-1], ) c.updateGrid() if value == "" { c.FocusEditor(c.editors[header]) } } // updateGrid should be called when the underlying header layout is changed. func (c *Composer) updateGrid() { header, height := c.layout.grid( func(h string) ui.Drawable { return c.editors[h] }, ) if c.grid == nil { c.grid = ui.NewGrid().Columns([]ui.GridSpec{{ui.SIZE_WEIGHT, 1}}) } c.grid.Rows([]ui.GridSpec{ {ui.SIZE_EXACT, height}, {ui.SIZE_WEIGHT, 1}, }) if c.header != nil { c.grid.RemoveChild(c.header) } c.header = header c.grid.AddChild(c.header).At(0, 0) } func (c *Composer) reloadEmail() error { name := c.email.Name() c.email.Close() file, err := os.Open(name) if err != nil { return errors.Wrap(err, "ReloadEmail") } c.email = file return nil } type headerEditor struct { name string focused bool input *ui.TextInput } func newHeaderEditor(name string, value string) *headerEditor { return &headerEditor{ input: ui.NewTextInput(value), name: name, } } func (he *headerEditor) Draw(ctx *ui.Context) { name := he.name + " " size := runewidth.StringWidth(name) ctx.Fill(0, 0, size, ctx.Height(), ' ', tcell.StyleDefault) ctx.Printf(0, 0, tcell.StyleDefault.Bold(true), "%s", name) he.input.Draw(ctx.Subcontext(size, 0, ctx.Width()-size, 1)) } func (he *headerEditor) MouseEvent(localX int, localY int, event tcell.Event) { switch event := event.(type) { case *tcell.EventMouse: switch event.Buttons() { case tcell.Button1: he.focused = true } width := runewidth.StringWidth(he.name + " ") if localX >= width { he.input.MouseEvent(localX-width, localY, event) } } } func (he *headerEditor) Invalidate() { he.input.Invalidate() } func (he *headerEditor) OnInvalidate(fn func(ui.Drawable)) { he.input.OnInvalidate(func(_ ui.Drawable) { fn(he) }) } func (he *headerEditor) Focus(focused bool) { he.focused = focused he.input.Focus(focused) } func (he *headerEditor) Event(event tcell.Event) bool { return he.input.Event(event) } func (he *headerEditor) OnChange(fn func()) { he.input.OnChange(func(_ *ui.TextInput) { fn() }) } type reviewMessage struct { composer *Composer grid *ui.Grid } func newReviewMessage(composer *Composer, err error) *reviewMessage { spec := []ui.GridSpec{{ui.SIZE_EXACT, 2}, {ui.SIZE_EXACT, 1}} for i := 0; i < len(composer.attachments)-1; i++ { spec = append(spec, ui.GridSpec{ui.SIZE_EXACT, 1}) } // make the last element fill remaining space spec = append(spec, ui.GridSpec{ui.SIZE_WEIGHT, 1}) grid := ui.NewGrid().Rows(spec).Columns([]ui.GridSpec{ {ui.SIZE_WEIGHT, 1}, }) if err != nil { grid.AddChild(ui.NewText(err.Error()). Color(tcell.ColorRed, tcell.ColorDefault)) grid.AddChild(ui.NewText("Press [q] to close this tab.")).At(1, 0) } else { // TODO: source this from actual keybindings? grid.AddChild(ui.NewText( "Send this email? [y]es/[n]o/[e]dit/[a]ttach")).At(0, 0) grid.AddChild(ui.NewText("Attachments:"). Reverse(true)).At(1, 0) if len(composer.attachments) == 0 { grid.AddChild(ui.NewText("(none)")).At(2, 0) } else { for i, a := range composer.attachments { grid.AddChild(ui.NewText(a)).At(i+2, 0) } } } return &reviewMessage{ composer: composer, grid: grid, } } func (rm *reviewMessage) Invalidate() { rm.grid.Invalidate() } func (rm *reviewMessage) OnInvalidate(fn func(ui.Drawable)) { rm.grid.OnInvalidate(func(_ ui.Drawable) { fn(rm) }) } func (rm *reviewMessage) Draw(ctx *ui.Context) { rm.grid.Draw(ctx) }


context:
space:
mode: