dlg_list.c File Reference

Mailing-list action dialog. More...

#include "config.h"
#include <stddef.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "index/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "send/lib.h"
#include "module_data.h"
#include "mutt_logging.h"
#include "mx.h"

Include dependency graph for dlg_list.c:

Go to the source code of this file.

Data Structures
struct	ListAction
	A mailing-list action in the dialog. More...
struct	ListData
	Private data for the Mailing-list action dialog. More...
struct	ListFunction
	A list dialog function. More...

Functions
static char **	get_action_value (struct Rfc2369ListHeaders *headers, const struct ListAction *action)
	Get the stored value for a mailing-list action.
static void	list_data_free (struct Menu *menu, void **ptr)
	Free list dialog data - Implements Menu::mdata_free() -.
static int	list_make_entry (struct Menu *menu, int line, int max_cols, struct Buffer *buf)
	Format a mailing-list action for the dialog - Implements Menu::make_entry() -.
static bool	compose_list_action (struct ListData *ld, const struct ListAction *action)
	Compose a message for a mailing-list action.
static int	op_exit (struct ListData *ld, const struct KeyEvent *event)
	Exit the list dialog.
static int	op_select_action (struct ListData *ld, const struct KeyEvent *event)
	Execute the selected mailing-list action.
static int	list_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a List dialog function - Implements function_dispatcher_t -.
void	dlg_list (struct Mailbox *m, struct Email *e)
	Display mailing-list actions for an email -.

Variables
static const struct Mapping	ListHelp []
	Help Bar for the Mailing-list action dialog.
static const struct ListAction	ListActions []
	Mailing-list actions shown in the dialog.
static const struct ListFunction	ListFunctions []
	Functions handled by the list dialog.

Detailed Description

Mailing-list action dialog.

Authors

• 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 dlg_list.c.

Function Documentation

get_action_value()

static char ** get_action_value ( struct Rfc2369ListHeaders * headers, const struct ListAction * action )

static

Get the stored value for a mailing-list action.

Parameters

headers	Parsed List-* headers
action	Action definition

Return values

ptr	Pointer to the stored header value

Definition at line 92 of file dlg_list.c.

{
  return (char **) (((char *) headers) + action->offset);
}

Here is the caller graph for this function:

compose_list_action()

static bool compose_list_action ( struct ListData * ld, const struct ListAction * action )

static

Compose a message for a mailing-list action.

Parameters

ld	Dialog state
action	Mailing-list action

Return values

true	The dialog should exit
false	The dialog should remain open

Definition at line 139 of file dlg_list.c.

{
  char *mailto = *get_action_value(&ld->headers, action);
  if (!mailto)
  {
    mutt_error(_("No list action available for %s"), _(action->name));
    return false;
  }
 
  if (url_check_scheme(mailto) != U_MAILTO)
  {
    mutt_error(_("List actions only support mailto: URIs. (Try a browser?)"));
    return true;
  }
 
  struct Email *e = email_new();
  e->env = mutt_env_new();
 
  char *body = NULL;
  if (!mutt_parse_mailto(e->env, &body, mailto))
  {
    mutt_error(_("Could not parse mailto: URI"));
    FREE(&body);
    email_free(&e);
    return true;
  }
 
  e->body = mutt_body_new();
  char ctype[] = "text/plain";
  mutt_parse_content_type(ctype, e->body);
  e->body->use_disp = false;
  e->body->disposition = DISP_INLINE;
 
  struct Buffer *tempfile = buf_pool_get();
  buf_mktemp_draft(tempfile);
  FILE *fp = mutt_file_fopen(buf_string(tempfile), "w+");
  if (!fp)
  {
    mutt_perror("%s", buf_string(tempfile));
    FREE(&body);
    email_free(&e);
    buf_pool_release(&tempfile);
    return true;
  }
 
  if (body)
    fprintf(fp, "%s\n", body);
  mutt_file_fclose(&fp);
  FREE(&body);
 
  e->body->filename = buf_strdup(tempfile);
  e->body->unlink = true;
  buf_pool_release(&tempfile);
 
  (void) mutt_send_message(SEND_DRAFT_FILE, e, NULL, ld->mailbox, NULL, NeoMutt->sub);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

op_exit()

static int op_exit ( struct ListData * ld, const struct KeyEvent * event )

static

Exit the list dialog.

Parameters

ld	Dialog state
event	Event being handled

Return values

enum	FunctionRetval

Definition at line 203 of file dlg_list.c.

{
  ld->done = true;
  return FR_SUCCESS;
}

op_select_action()

static int op_select_action ( struct ListData * ld, const struct KeyEvent * event )

static

Execute the selected mailing-list action.

Parameters

ld	Dialog state
event	Event being handled

Return values

enum	FunctionRetval

Definition at line 215 of file dlg_list.c.

{
  const int index = menu_get_index(ld->menu);
  if ((index < 0) || (index >= (int) countof(ListActions)))
    return FR_NO_ACTION;
 
  ld->done = compose_list_action(ld, &ListActions[index]);
  return FR_SUCCESS;
}

Here is the call graph for this function:

Variable Documentation

ListHelp

const struct Mapping ListHelp[]

static

Initial value:

= {
  
  { N_("Exit"),        OP_EXIT },
  { N_("Archive"),     OP_LIST_ARCHIVE },
  { N_("Help"),        OP_LIST_HELP },
  { N_("Owner"),       OP_LIST_OWNER },
  { N_("Post"),        OP_LIST_POST },
  { N_("Subscribe"),   OP_LIST_SUBSCRIBE },
  { N_("Unsubscribe"), OP_LIST_UNSUBSCRIBE },
  { NULL, 0 },
  
}

Help Bar for the Mailing-list action dialog.

Definition at line 39 of file dlg_list.c.

                                         {
  // clang-format off
  { N_("Exit"),        OP_EXIT },
  { N_("Archive"),     OP_LIST_ARCHIVE },
  { N_("Help"),        OP_LIST_HELP },
  { N_("Owner"),       OP_LIST_OWNER },
  { N_("Post"),        OP_LIST_POST },
  { N_("Subscribe"),   OP_LIST_SUBSCRIBE },
  { N_("Unsubscribe"), OP_LIST_UNSUBSCRIBE },
  { NULL, 0 },
  // clang-format on
};

ListActions

const struct ListAction ListActions[]

static

Initial value:

= {
  
  { N_("Help"),        OP_LIST_HELP,        offsetof(struct Rfc2369ListHeaders, help)        },
  { N_("Post"),        OP_LIST_POST,        offsetof(struct Rfc2369ListHeaders, post)        },
  { N_("Subscribe"),   OP_LIST_SUBSCRIBE,   offsetof(struct Rfc2369ListHeaders, subscribe)   },
  { N_("Unsubscribe"), OP_LIST_UNSUBSCRIBE, offsetof(struct Rfc2369ListHeaders, unsubscribe) },
  { N_("Archives"),    OP_LIST_ARCHIVE,     offsetof(struct Rfc2369ListHeaders, archive)     },
  { N_("Owner"),       OP_LIST_OWNER,       offsetof(struct Rfc2369ListHeaders, owner)       },
  
}

Mailing-list actions shown in the dialog.

Definition at line 63 of file dlg_list.c.

                                               {
  // clang-format off
  { N_("Help"),        OP_LIST_HELP,        offsetof(struct Rfc2369ListHeaders, help)        },
  { N_("Post"),        OP_LIST_POST,        offsetof(struct Rfc2369ListHeaders, post)        },
  { N_("Subscribe"),   OP_LIST_SUBSCRIBE,   offsetof(struct Rfc2369ListHeaders, subscribe)   },
  { N_("Unsubscribe"), OP_LIST_UNSUBSCRIBE, offsetof(struct Rfc2369ListHeaders, unsubscribe) },
  { N_("Archives"),    OP_LIST_ARCHIVE,     offsetof(struct Rfc2369ListHeaders, archive)     },
  { N_("Owner"),       OP_LIST_OWNER,       offsetof(struct Rfc2369ListHeaders, owner)       },
  // clang-format on
};

ListFunctions

const struct ListFunction ListFunctions[]

static

Initial value:

= {
  
  { OP_EXIT,                 op_exit          },
  { OP_GENERIC_SELECT_ENTRY, op_select_action },
  { OP_LIST_ARCHIVE,         op_select_action },
  { OP_LIST_HELP,            op_select_action },
  { OP_LIST_OWNER,           op_select_action },
  { OP_LIST_POST,            op_select_action },
  { OP_LIST_SUBSCRIBE,       op_select_action },
  { OP_LIST_UNSUBSCRIBE,     op_select_action },
  { 0, NULL },
  
}

Functions handled by the list dialog.

Definition at line 235 of file dlg_list.c.

                                                   {
  // clang-format off
  { OP_EXIT,                 op_exit          },
  { OP_GENERIC_SELECT_ENTRY, op_select_action },
  { OP_LIST_ARCHIVE,         op_select_action },
  { OP_LIST_HELP,            op_select_action },
  { OP_LIST_OWNER,           op_select_action },
  { OP_LIST_POST,            op_select_action },
  { OP_LIST_SUBSCRIBE,       op_select_action },
  { OP_LIST_UNSUBSCRIBE,     op_select_action },
  { 0, NULL },
  // clang-format on
};