functions.c File Reference

Mailing-list functions. More...

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

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
void	mlist_init_keys (struct NeoMutt *n, struct SubMenu *sm_generic)
	Initialise the Mlist Keybindings - Implements ::init_keys_api.
struct ListHead *	mlist_action_value (struct Rfc2369ListHeaders *headers, const struct ListAction *action)
	Get the stored value for a mailing-list action.
static bool	compose_list_action (struct ListData *ld, const struct ListEntry *entry)
	Compose a message for a mailing-list action.
static int	op_quit (struct ListData *ld, const struct KeyEvent *event)
	Save changes and exit this dialog - Implements mlist_function_t -.
static int	op_select_action (struct ListData *ld, const struct KeyEvent *event)
	Execute the selected mailing-list action - Implements mlist_function_t -.
int	mlist_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a List dialog function - Implements function_dispatcher_t -.

Variables
const struct ListAction	ListActions []
	Mailing-list actions shown in the dialog.
const int	ListActionsCount = countof(ListActions)
	Number of entries in ListActions.
static const struct MenuFuncOp	OpList []
	Functions for the List Dialog.
static const struct MenuOpSeq	ListDefaultBindings []
	Key bindings for the List Dialog.
static const struct MlistFunction	MlistFunctions []
	All the NeoMutt functions that the List Dialog supports.

Detailed Description

Mailing-list functions.

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 functions.c.

Function Documentation

mlist_init_keys()

void mlist_init_keys	(	struct NeoMutt *	n,
		struct SubMenu *	sm_generic )

Initialise the Mlist Keybindings - Implements ::init_keys_api.

Definition at line 90 of file functions.c.

{
  struct MenuDefinition *md = NULL;
  struct MenuDefinition *md_list = NULL;
  struct SubMenu *sm_list = NULL;
 
  sm_list = km_register_submenu(OpList);
  md_list = km_register_menu(MENU_LIST, "list");
  km_menu_add_submenu(md_list, sm_list);
  km_menu_add_submenu(md_list, sm_generic);
  km_menu_add_bindings(md_list, ListDefaultBindings);
 
  struct MlistModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_MLIST);
  ASSERT(mod_data);
  mod_data->menu_mlist = md;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mlist_action_value()

struct ListHead * mlist_action_value	(	struct Rfc2369ListHeaders *	headers,
		const struct ListAction *	action )

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 values

Definition at line 113 of file functions.c.

{
  return (struct ListHead *) (((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 ListEntry * entry )

static

Compose a message for a mailing-list action.

Parameters

ld	Dialog state
entry	Mailing-list entry

Return values

true	The dialog should exit
false	The dialog should remain open

Definition at line 126 of file functions.c.

{
  if (!entry || !entry->value)
  {
    mutt_error(_("No list action available"));
    return false;
  }
 
  const char *uri = entry->value;
  if (!mutt_istr_startswith(uri, "mailto:"))
    return false;
 
  struct Email *e = email_new();
  e->env = mutt_env_new();
 
  char *body = NULL;
  if (!mutt_parse_mailto(e->env, &body, uri))
  {
    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:

Variable Documentation

ListActions

const struct ListAction ListActions[]

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 45 of file functions.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
};

ListActionsCount

const int ListActionsCount = countof(ListActions)

Number of entries in ListActions.

Definition at line 57 of file functions.c.

OpList

const struct MenuFuncOp OpList[]

static

Initial value:

= { 
  { "list-archive",                  OP_LIST_ARCHIVE },
  { "list-help",                     OP_LIST_HELP },
  { "list-owner",                    OP_LIST_OWNER },
  { "list-post",                     OP_LIST_POST },
  { "list-subscribe",                OP_LIST_SUBSCRIBE },
  { "list-unsubscribe",              OP_LIST_UNSUBSCRIBE },
  { NULL, 0 },
}

Functions for the List Dialog.

Definition at line 63 of file functions.c.

                                          { /* map: list */
  { "list-archive",                  OP_LIST_ARCHIVE },
  { "list-help",                     OP_LIST_HELP },
  { "list-owner",                    OP_LIST_OWNER },
  { "list-post",                     OP_LIST_POST },
  { "list-subscribe",                OP_LIST_SUBSCRIBE },
  { "list-unsubscribe",              OP_LIST_UNSUBSCRIBE },
  { NULL, 0 },
};

ListDefaultBindings

const struct MenuOpSeq ListDefaultBindings[]

static

Initial value:

= { 
  { OP_LIST_ARCHIVE,                       "a" },
  { OP_LIST_HELP,                          "h" },
  { OP_LIST_OWNER,                         "o" },
  { OP_LIST_POST,                          "p" },
  { OP_LIST_SUBSCRIBE,                     "s" },
  { OP_LIST_UNSUBSCRIBE,                   "u" },
  { 0, NULL },
}

Key bindings for the List Dialog.

Definition at line 76 of file functions.c.

                                                      { /* map: list */
  { OP_LIST_ARCHIVE,                       "a" },
  { OP_LIST_HELP,                          "h" },
  { OP_LIST_OWNER,                         "o" },
  { OP_LIST_POST,                          "p" },
  { OP_LIST_SUBSCRIBE,                     "s" },
  { OP_LIST_UNSUBSCRIBE,                   "u" },
  { 0, NULL },
};

MlistFunctions

const struct MlistFunction MlistFunctions[]

static

Initial value:

= {
  
  { OP_EXIT,                 op_quit          },
  { 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 },
  { OP_QUIT,                 op_quit          },
  { 0, NULL },
  
}

All the NeoMutt functions that the List Dialog supports.

Definition at line 251 of file functions.c.

                                                     {
  // clang-format off
  { OP_EXIT,                 op_quit          },
  { 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 },
  { OP_QUIT,                 op_quit          },
  { 0, NULL },
  // clang-format on
};