compose.c File Reference

Compose Email Dialog. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "attach/lib.h"
#include "envelope/lib.h"
#include "index/lib.h"
#include "menu/lib.h"
#include "ncrypt/lib.h"
#include "attach_data.h"
#include "cbar.h"
#include "functions.h"
#include "hook.h"
#include "keymap.h"
#include "mutt_logging.h"
#include "opcodes.h"
#include "options.h"
#include "shared_data.h"

Include dependency graph for compose.c:

Go to the source code of this file.

Functions
static int	compose_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -. More...
static int	compose_email_observer (struct NotifyCallback *nc)
	Notification that an Email has changed - Implements observer_t -. More...
static int	compose_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -. More...
static void	gen_attach_list (struct AttachCtx *actx, struct Body *m, int parent_type, int level)
	Generate the attachment list for the compose screen. More...
void	update_menu (struct AttachCtx *actx, struct Menu *menu, bool init)
	Redraw the compose window. More...
static struct MuttWindow *	compose_dlg_init (struct ConfigSubset *sub, struct Email *e, struct Buffer *fcc)
	Allocate the Windows for Compose. More...
int	mutt_compose_menu (struct Email *e, struct Buffer *fcc, uint8_t flags, struct ConfigSubset *sub)
	Allow the user to edit the message envelope. More...

Variables
static const struct Mapping	ComposeHelp []
	Help Bar for the Compose dialog. More...
static const struct Mapping	ComposeNewsHelp []
	Help Bar for the News Compose dialog. More...

Detailed Description

Compose Email Dialog.

Authors

• Michael R. Elkins
• g10 Code GmbH
• Pietro Cerutti
• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file compose.c.

Function Documentation

gen_attach_list()

static void gen_attach_list ( struct AttachCtx *  actx, struct Body *  m, int  parent_type, int  level  )

static

Generate the attachment list for the compose screen.

Parameters

actx	Attachment context
m	Attachment
parent_type	Attachment type, e.g TYPE_MULTIPART
level	Nesting depth of attachment

Definition at line 198 of file compose.c.

{
  for (; m; m = m->next)
  {
    struct AttachPtr *ap = mutt_aptr_new();
    mutt_actx_add_attach(actx, ap);
    ap->body = m;
    m->aptr = ap;
    ap->parent_type = parent_type;
    ap->level = level;
    if ((m->type == TYPE_MULTIPART) && m->parts &&
        (!(WithCrypto & APPLICATION_PGP) || !mutt_is_multipart_encrypted(m)))
    {
      gen_attach_list(actx, m->parts, m->type, level + 1);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

update_menu()

void update_menu	(	struct AttachCtx *	actx,
		struct Menu *	menu,
		bool	init
	)

Redraw the compose window.

Parameters

actx	Attachment context
menu	Current menu
init	If true, initialise the attachment list

Definition at line 222 of file compose.c.

{
  if (init)
  {
    gen_attach_list(actx, actx->email->body, -1, 0);
    mutt_attach_init(actx);
 
    struct ComposeAttachData *adata = menu->mdata;
    adata->actx = actx;
  }
 
  mutt_update_tree(actx);
 
  menu->max = actx->vcount;
  if (menu->max)
  {
    int index = menu_get_index(menu);
    if (index >= menu->max)
      menu_set_index(menu, menu->max - 1);
  }
  else
    menu_set_index(menu, 0);
 
  menu_queue_redraw(menu, MENU_REDRAW_INDEX);
}

Here is the call graph for this function:

Here is the caller graph for this function:

compose_dlg_init()

static struct MuttWindow * compose_dlg_init ( struct ConfigSubset *  sub, struct Email *  e, struct Buffer *  fcc  )

static

Allocate the Windows for Compose.

Parameters

sub	ConfigSubset
e	Email
fcc	Buffer to save FCC

Return values

ptr	Dialog containing nested Windows

Definition at line 255 of file compose.c.

{
  struct ComposeSharedData *shared = compose_shared_data_new();
  shared->sub = sub;
  shared->email = e;
 
  struct MuttWindow *dlg = mutt_window_new(WT_DLG_COMPOSE, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                           MUTT_WIN_SIZE_UNLIMITED);
  dlg->wdata = shared;
  dlg->wdata_free = compose_shared_data_free;
 
  struct MuttWindow *win_env = env_window_new(e, fcc, sub);
  struct MuttWindow *win_attach = attach_new(dlg, shared);
  struct MuttWindow *win_cbar = cbar_new(shared);
  struct MuttWindow *win_abar = sbar_new();
  sbar_set_title(win_abar, _("-- Attachments"));
 
  const bool c_status_on_top = cs_subset_bool(sub, "status_on_top");
  if (c_status_on_top)
  {
    mutt_window_add_child(dlg, win_cbar);
    mutt_window_add_child(dlg, win_env);
    mutt_window_add_child(dlg, win_abar);
    mutt_window_add_child(dlg, win_attach);
  }
  else
  {
    mutt_window_add_child(dlg, win_env);
    mutt_window_add_child(dlg, win_abar);
    mutt_window_add_child(dlg, win_attach);
    mutt_window_add_child(dlg, win_cbar);
  }
 
  dlg->help_data = ComposeHelp;
  dlg->help_menu = MENU_COMPOSE;
  dlg->focus = win_attach;
 
  return dlg;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_compose_menu()

int mutt_compose_menu	(	struct Email *	e,
		struct Buffer *	fcc,
		uint8_t	flags,
		struct ConfigSubset *	sub
	)

Allow the user to edit the message envelope.

Parameters

e	Email to fill
fcc	Buffer to save FCC
flags	Flags, e.g. MUTT_COMPOSE_NOFREEHEADER
sub	ConfigSubset

Return values

1	Message should be postponed
0	Normal exit
-1	Abort message

Definition at line 307 of file compose.c.

{
  struct MuttWindow *dlg = compose_dlg_init(sub, e, fcc);
  struct ComposeSharedData *shared = dlg->wdata;
  shared->mailbox = get_current_mailbox();
  shared->email = e;
  shared->sub = sub;
  shared->fcc = fcc;
  shared->fcc_set = false;
  shared->flags = flags;
  shared->rc = -1;
 
  notify_observer_add(NeoMutt->notify, NT_CONFIG, compose_config_observer, dlg);
  notify_observer_add(e->notify, NT_ALL, compose_email_observer, shared);
  notify_observer_add(dlg->notify, NT_WINDOW, compose_window_observer, dlg);
  dialog_push(dlg);
 
#ifdef USE_NNTP
  if (OptNewsSend)
    dlg->help_data = ComposeNewsHelp;
  else
#endif
    dlg->help_data = ComposeHelp;
  dlg->help_menu = MENU_COMPOSE;
 
  struct Menu *menu = shared->adata->menu;
  update_menu(shared->adata->actx, menu, true);
  notify_send(shared->email->notify, NT_EMAIL, NT_EMAIL_CHANGE, NULL);
 
  struct MuttWindow *win_env = window_find_child(dlg, WT_CUSTOM);
 
  // ---------------------------------------------------------------------------
  // Event Loop
  int rc = 0;
  int op = OP_NULL;
  do
  {
#ifdef USE_NNTP
    OptNews = false; /* for any case */
#endif
    menu_tagging_dispatcher(menu->win, op);
    window_redraw(NULL);
 
    op = km_dokey(MENU_COMPOSE);
    mutt_debug(LL_DEBUG1, "Got op %s (%d)\n", opcodes_get_name(op), op);
    if (op < 0)
      continue;
    if (op == OP_NULL)
    {
      km_error_key(MENU_COMPOSE);
      continue;
    }
    mutt_clear_error();
 
    rc = compose_function_dispatcher(dlg, op);
    if (rc == FR_UNKNOWN)
      rc = env_function_dispatcher(win_env, op);
    if (rc == FR_UNKNOWN)
      rc = menu_function_dispatcher(menu->win, op);
    if (rc == FR_UNKNOWN)
      rc = global_function_dispatcher(NULL, op);
  } while (rc != FR_DONE);
  // ---------------------------------------------------------------------------
 
#ifdef USE_AUTOCRYPT
  /* This is a fail-safe to make sure the bit isn't somehow turned
   * on.  The user could have disabled the option after setting SEC_AUTOCRYPT,
   * or perhaps resuming or replying to an autocrypt message.  */
  const bool c_autocrypt = cs_subset_bool(sub, "autocrypt");
  if (!c_autocrypt)
    e->security &= ~SEC_AUTOCRYPT;
#endif
 
  if (shared->adata->actx->idxlen)
    e->body = shared->adata->actx->idx[0]->body;
  else
    e->body = NULL;
 
  rc = shared->rc;
 
  dialog_pop();
  mutt_window_free(&dlg);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ComposeHelp

const struct Mapping ComposeHelp[]

static

Initial value:

= {
  
  { N_("Send"),        OP_COMPOSE_SEND_MESSAGE },
  { N_("Abort"),       OP_EXIT },
  
  { N_("To"),          OP_ENVELOPE_EDIT_TO },
  
  { N_("CC"),          OP_ENVELOPE_EDIT_CC },
  
  { N_("Subj"),        OP_ENVELOPE_EDIT_SUBJECT },
  { N_("Attach file"), OP_ATTACHMENT_ATTACH_FILE },
  { N_("Descrip"),     OP_ATTACHMENT_EDIT_DESCRIPTION },
  { N_("Help"),        OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the Compose dialog.

Definition at line 94 of file compose.c.

ComposeNewsHelp

const struct Mapping ComposeNewsHelp[]

static

Initial value:

= {
  
  { N_("Send"),        OP_COMPOSE_SEND_MESSAGE },
  { N_("Abort"),       OP_EXIT },
  { N_("Newsgroups"),  OP_ENVELOPE_EDIT_NEWSGROUPS },
  { N_("Subj"),        OP_ENVELOPE_EDIT_SUBJECT },
  { N_("Attach file"), OP_ATTACHMENT_ATTACH_FILE },
  { N_("Descrip"),     OP_ATTACHMENT_EDIT_DESCRIPTION },
  { N_("Help"),        OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the News Compose dialog.

Definition at line 113 of file compose.c.