hook.h File Reference

Parse and execute user-defined hooks. More...

#include "config.h"
#include <stdint.h>
#include "core/lib.h"

Include dependency graph for hook.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MUTT_HOOK_NO_FLAGS   0
	No flags are set.
#define	MUTT_FOLDER_HOOK   (1 << 0)
	folder-hook: when entering a mailbox
#define	MUTT_MBOX_HOOK   (1 << 1)
	mbox-hook: move messages after reading them
#define	MUTT_SEND_HOOK   (1 << 2)
	send-hook: when composing a new email
#define	MUTT_FCC_HOOK   (1 << 3)
	fcc-hook: to save outgoing email
#define	MUTT_SAVE_HOOK   (1 << 4)
	save-hook: set a default folder when saving an email
#define	MUTT_CHARSET_HOOK   (1 << 5)
	charset-hook: create a charset alias for malformed emails
#define	MUTT_ICONV_HOOK   (1 << 6)
	iconv-hook: create a system charset alias
#define	MUTT_MESSAGE_HOOK   (1 << 7)
	message-hook: run before displaying a message
#define	MUTT_CRYPT_HOOK   (1 << 8)
	crypt-hook: automatically select a PGP/SMIME key
#define	MUTT_ACCOUNT_HOOK   (1 << 9)
	account-hook: when changing between accounts
#define	MUTT_REPLY_HOOK   (1 << 10)
	reply-hook: when replying to an email
#define	MUTT_SEND2_HOOK   (1 << 11)
	send2-hook: when changing fields in the compose menu
#define	MUTT_OPEN_HOOK   (1 << 12)
	open-hook: to read a compressed mailbox
#define	MUTT_APPEND_HOOK   (1 << 13)
	append-hook: append to a compressed mailbox
#define	MUTT_CLOSE_HOOK   (1 << 14)
	close-hook: write to a compressed mailbox
#define	MUTT_IDXFMTHOOK   (1 << 15)
	index-format-hook: customise the format of the index
#define	MUTT_TIMEOUT_HOOK   (1 << 16)
	timeout-hook: run a command periodically
#define	MUTT_STARTUP_HOOK   (1 << 17)
	startup-hook: run when starting NeoMutt
#define	MUTT_SHUTDOWN_HOOK   (1 << 18)
	shutdown-hook: run when leaving NeoMutt

Typedefs
typedef uint32_t	HookFlags
	Flags for parse_hook(), e.g. MUTT_FOLDER_HOOK.

Functions
void	hooks_init (void)
	Setup feature commands.
enum CommandResult	parse_hook_charset (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse charset hook commands - Implements Command::parse() -.
enum CommandResult	parse_hook_compress (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse compress hook commands - Implements Command::parse() -.
enum CommandResult	parse_hook_crypt (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse crypt hook commands - Implements Command::parse() -.
enum CommandResult	parse_hook_folder (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse folder hook command - Implements Command::parse() -.
enum CommandResult	parse_hook_global (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse global hook commands - Implements Command::parse() -.
enum CommandResult	parse_hook_index (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse the index format hook command - Implements Command::parse() -.
enum CommandResult	parse_hook_mailbox (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse mailbox pattern hook commands - Implements Command::parse() -.
enum CommandResult	parse_hook_mbox (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse mbox hook command - Implements Command::parse() -.
enum CommandResult	parse_hook_pattern (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse pattern-based hook commands - Implements Command::parse() -.
enum CommandResult	parse_hook_regex (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse regex-based hook command - Implements Command::parse() -.
enum CommandResult	parse_unhook (const struct Command *cmd, struct Buffer *line, struct Buffer *err)
	Parse the unhook command - Implements Command::parse() -.
void	mutt_account_hook (const char *url)
	Perform an account hook.
void	mutt_crypt_hook (struct ListHead *list, struct Address *addr)
	Find crypto hooks for an Address.
void	mutt_default_save (struct Buffer *path, struct Email *e)
	Find the default save path for an email.
void	mutt_delete_hooks (HookFlags type)
	Delete matching hooks.
char *	mutt_find_hook (HookFlags type, const char *pat)
	Find a matching hook.
void	mutt_folder_hook (const char *path, const char *desc)
	Perform a folder hook.
const struct Expando *	mutt_idxfmt_hook (const char *name, struct Mailbox *m, struct Email *e)
	Get index-format-hook format string.
void	mutt_message_hook (struct Mailbox *m, struct Email *e, HookFlags type)
	Perform a message hook.
void	mutt_select_fcc (struct Buffer *path, struct Email *e)
	Select the FCC path for an email.
void	mutt_startup_shutdown_hook (HookFlags type)
	Execute any startup/shutdown hooks.
void	mutt_timeout_hook (void)
	Execute any timeout hooks.

Detailed Description

Parse and execute user-defined hooks.

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 hook.h.

Macro Definition Documentation

MUTT_HOOK_NO_FLAGS

#define MUTT_HOOK_NO_FLAGS   0

No flags are set.

Definition at line 36 of file hook.h.

MUTT_FOLDER_HOOK

#define MUTT_FOLDER_HOOK   (1 << 0)

folder-hook: when entering a mailbox

Definition at line 37 of file hook.h.

MUTT_MBOX_HOOK

#define MUTT_MBOX_HOOK   (1 << 1)

mbox-hook: move messages after reading them

Definition at line 38 of file hook.h.

MUTT_SEND_HOOK

#define MUTT_SEND_HOOK   (1 << 2)

send-hook: when composing a new email

Definition at line 39 of file hook.h.

MUTT_FCC_HOOK

#define MUTT_FCC_HOOK   (1 << 3)

fcc-hook: to save outgoing email

Definition at line 40 of file hook.h.

MUTT_SAVE_HOOK

#define MUTT_SAVE_HOOK   (1 << 4)

save-hook: set a default folder when saving an email

Definition at line 41 of file hook.h.

MUTT_CHARSET_HOOK

#define MUTT_CHARSET_HOOK   (1 << 5)

charset-hook: create a charset alias for malformed emails

Definition at line 42 of file hook.h.

MUTT_ICONV_HOOK

#define MUTT_ICONV_HOOK   (1 << 6)

iconv-hook: create a system charset alias

Definition at line 43 of file hook.h.

MUTT_MESSAGE_HOOK

#define MUTT_MESSAGE_HOOK   (1 << 7)

message-hook: run before displaying a message

Definition at line 44 of file hook.h.

MUTT_CRYPT_HOOK

#define MUTT_CRYPT_HOOK   (1 << 8)

crypt-hook: automatically select a PGP/SMIME key

Definition at line 45 of file hook.h.

MUTT_ACCOUNT_HOOK

#define MUTT_ACCOUNT_HOOK   (1 << 9)

account-hook: when changing between accounts

Definition at line 46 of file hook.h.

MUTT_REPLY_HOOK

#define MUTT_REPLY_HOOK   (1 << 10)

reply-hook: when replying to an email

Definition at line 47 of file hook.h.

MUTT_SEND2_HOOK

#define MUTT_SEND2_HOOK   (1 << 11)

send2-hook: when changing fields in the compose menu

Definition at line 48 of file hook.h.

MUTT_OPEN_HOOK

#define MUTT_OPEN_HOOK   (1 << 12)

open-hook: to read a compressed mailbox

Definition at line 49 of file hook.h.

MUTT_APPEND_HOOK

#define MUTT_APPEND_HOOK   (1 << 13)

append-hook: append to a compressed mailbox

Definition at line 50 of file hook.h.

MUTT_CLOSE_HOOK

#define MUTT_CLOSE_HOOK   (1 << 14)

close-hook: write to a compressed mailbox

Definition at line 51 of file hook.h.

MUTT_IDXFMTHOOK

#define MUTT_IDXFMTHOOK   (1 << 15)

index-format-hook: customise the format of the index

Definition at line 52 of file hook.h.

MUTT_TIMEOUT_HOOK

#define MUTT_TIMEOUT_HOOK   (1 << 16)

timeout-hook: run a command periodically

Definition at line 53 of file hook.h.

MUTT_STARTUP_HOOK

#define MUTT_STARTUP_HOOK   (1 << 17)

startup-hook: run when starting NeoMutt

Definition at line 54 of file hook.h.

MUTT_SHUTDOWN_HOOK

#define MUTT_SHUTDOWN_HOOK   (1 << 18)

shutdown-hook: run when leaving NeoMutt

Definition at line 55 of file hook.h.

Typedef Documentation

HookFlags

typedef uint32_t HookFlags

Flags for parse_hook(), e.g. MUTT_FOLDER_HOOK.

Definition at line 35 of file hook.h.

Function Documentation

hooks_init()

void hooks_init

(

void

)

Setup feature commands.

Definition at line 1769 of file hook.c.

{
  commands_register(&NeoMutt->commands, HookCommands);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_account_hook()

void mutt_account_hook

(

const char *

url

)

Perform an account hook.

Parameters

url	Account URL to match

Definition at line 1547 of file hook.c.

{
  /* parsing commands with URLs in an account hook can cause a recursive
   * call. We just skip processing if this occurs. Typically such commands
   * belong in a folder-hook -- perhaps we should warn the user. */
  static bool inhook = false;
  if (inhook)
    return;
 
  struct Hook *hook = NULL;
  struct Buffer *err = buf_pool_get();
 
  TAILQ_FOREACH(hook, &Hooks, entries)
  {
    if (!(hook->command && (hook->type & MUTT_ACCOUNT_HOOK)))
      continue;
 
    if (mutt_regex_match(&hook->regex, url))
    {
      inhook = true;
      mutt_debug(LL_DEBUG1, "account-hook '%s' matches '%s'\n", hook->regex.pattern, url);
      mutt_debug(LL_DEBUG5, "    %s\n", hook->command);
 
      if (parse_rc_line_cwd(hook->command, hook->source_file, err) == MUTT_CMD_ERROR)
      {
        mutt_error("%s", buf_string(err));
        buf_pool_release(&err);
 
        inhook = false;
        goto done;
      }
 
      inhook = false;
    }
  }
done:
  buf_pool_release(&err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_crypt_hook()

void mutt_crypt_hook	(	struct ListHead *	list,
		struct Address *	addr )

Find crypto hooks for an Address.

Parameters

[out]	list	List of keys
[in]	addr	Address to match

The crypt-hook associates keys with addresses.

Definition at line 1538 of file hook.c.

{
  list_hook(list, buf_string(addr->mailbox), MUTT_CRYPT_HOOK);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_default_save()

void mutt_default_save	(	struct Buffer *	path,
		struct Email *	e )

Find the default save path for an email.

Parameters

path	Buffer for the path
e	Email

Definition at line 1438 of file hook.c.

{
  struct Mailbox *m_cur = get_current_mailbox();
  if (addr_hook(path, MUTT_SAVE_HOOK, m_cur, e) == 0)
    return;
 
  struct Envelope *env = e->env;
  const struct Address *from = TAILQ_FIRST(&env->from);
  const struct Address *reply_to = TAILQ_FIRST(&env->reply_to);
  const struct Address *to = TAILQ_FIRST(&env->to);
  const struct Address *cc = TAILQ_FIRST(&env->cc);
  const struct Address *addr = NULL;
  bool from_me = mutt_addr_is_user(from);
 
  if (!from_me && reply_to && reply_to->mailbox)
    addr = reply_to;
  else if (!from_me && from && from->mailbox)
    addr = from;
  else if (to && to->mailbox)
    addr = to;
  else if (cc && cc->mailbox)
    addr = cc;
  else
    addr = NULL;
  if (addr)
  {
    struct Buffer *tmp = buf_pool_get();
    mutt_safe_path(tmp, addr);
    buf_add_printf(path, "=%s", buf_string(tmp));
    buf_pool_release(&tmp);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_delete_hooks()

void mutt_delete_hooks

(

HookFlags

type

)

Delete matching hooks.

Parameters

type	Hook type to delete, see HookFlags

If MUTT_HOOK_NO_FLAGS is passed, all the hooks will be deleted.

Definition at line 1029 of file hook.c.

{
  struct Hook *h = NULL;
  struct Hook *tmp = NULL;
 
  TAILQ_FOREACH_SAFE(h, &Hooks, entries, tmp)
  {
    if ((type == MUTT_HOOK_NO_FLAGS) || (type == h->type))
    {
      TAILQ_REMOVE(&Hooks, h, entries);
      hook_free(&h);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_find_hook()

char * mutt_find_hook	(	HookFlags	type,
		const char *	pat )

Find a matching hook.

Parameters

type	Hook type, see HookFlags
pat	Pattern to match

Return values

ptr	Command string

Note

The returned string must not be freed.

Definition at line 1339 of file hook.c.

{
  struct Hook *tmp = NULL;
 
  TAILQ_FOREACH(tmp, &Hooks, entries)
  {
    if (tmp->type & type)
    {
      if (mutt_regex_match(&tmp->regex, pat))
        return tmp->command;
    }
  }
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_folder_hook()

void mutt_folder_hook	(	const char *	path,
		const char *	desc )

Perform a folder hook.

Parameters

path	Path to potentially match
desc	Description to potentially match

Definition at line 1291 of file hook.c.

{
  if (!path && !desc)
    return;
 
  struct Hook *hook = NULL;
  struct Buffer *err = buf_pool_get();
 
  CurrentHookType = MUTT_FOLDER_HOOK;
 
  TAILQ_FOREACH(hook, &Hooks, entries)
  {
    if (!hook->command)
      continue;
 
    if (!(hook->type & MUTT_FOLDER_HOOK))
      continue;
 
    const char *match = NULL;
    if (mutt_regex_match(&hook->regex, path))
      match = path;
    else if (mutt_regex_match(&hook->regex, desc))
      match = desc;
 
    if (match)
    {
      mutt_debug(LL_DEBUG1, "folder-hook '%s' matches '%s'\n", hook->regex.pattern, match);
      mutt_debug(LL_DEBUG5, "    %s\n", hook->command);
      if (parse_rc_line_cwd(hook->command, hook->source_file, err) == MUTT_CMD_ERROR)
      {
        mutt_error("%s", buf_string(err));
        break;
      }
    }
  }
  buf_pool_release(&err);
 
  CurrentHookType = MUTT_HOOK_NO_FLAGS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_idxfmt_hook()

const struct Expando * mutt_idxfmt_hook	(	const char *	name,
		struct Mailbox *	m,
		struct Email *	e )

Get index-format-hook format string.

Parameters

name	Hook name
m	Mailbox
e	Email

Return values

ptr	Expando
NULL	No matching hook

Definition at line 1651 of file hook.c.

{
  if (!IdxFmtHooks)
    return NULL;
 
  struct HookList *hl = mutt_hash_find(IdxFmtHooks, name);
  if (!hl)
    return NULL;
 
  CurrentHookType = MUTT_IDXFMTHOOK;
 
  struct PatternCache cache = { 0 };
  const struct Expando *exp = NULL;
  struct Hook *hook = NULL;
 
  TAILQ_FOREACH(hook, hl, entries)
  {
    struct Pattern *pat = SLIST_FIRST(hook->pattern);
    if ((mutt_pattern_exec(pat, 0, m, e, &cache) > 0) ^ hook->regex.pat_not)
    {
      exp = hook->expando;
      break;
    }
  }
 
  CurrentHookType = MUTT_HOOK_NO_FLAGS;
 
  return exp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_message_hook()

void mutt_message_hook	(	struct Mailbox *	m,
		struct Email *	e,
		HookFlags	type )

Perform a message hook.

Parameters

m	Mailbox
e	Email
type	Hook type, see HookFlags

Definition at line 1360 of file hook.c.

{
  struct Hook *hook = NULL;
  struct PatternCache cache = { 0 };
  struct Buffer *err = buf_pool_get();
 
  CurrentHookType = type;
 
  TAILQ_FOREACH(hook, &Hooks, entries)
  {
    if (!hook->command)
      continue;
 
    if (hook->type & type)
    {
      if ((mutt_pattern_exec(SLIST_FIRST(hook->pattern), 0, m, e, &cache) > 0) ^
          hook->regex.pat_not)
      {
        if (parse_rc_line_cwd(hook->command, hook->source_file, err) == MUTT_CMD_ERROR)
        {
          mutt_error("%s", buf_string(err));
          CurrentHookType = MUTT_HOOK_NO_FLAGS;
          buf_pool_release(&err);
 
          return;
        }
        /* Executing arbitrary commands could affect the pattern results,
         * so the cache has to be wiped */
        memset(&cache, 0, sizeof(cache));
      }
    }
  }
  buf_pool_release(&err);
 
  CurrentHookType = MUTT_HOOK_NO_FLAGS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_select_fcc()

void mutt_select_fcc	(	struct Buffer *	path,
		struct Email *	e )

Select the FCC path for an email.

Parameters

path	Buffer for the path
e	Email

Definition at line 1476 of file hook.c.

{
  buf_alloc(path, PATH_MAX);
 
  if (addr_hook(path, MUTT_FCC_HOOK, NULL, e) != 0)
  {
    const struct Address *to = TAILQ_FIRST(&e->env->to);
    const struct Address *cc = TAILQ_FIRST(&e->env->cc);
    const struct Address *bcc = TAILQ_FIRST(&e->env->bcc);
    const bool c_save_name = cs_subset_bool(NeoMutt->sub, "save_name");
    const bool c_force_name = cs_subset_bool(NeoMutt->sub, "force_name");
    const char *const c_record = cs_subset_string(NeoMutt->sub, "record");
    if ((c_save_name || c_force_name) && (to || cc || bcc))
    {
      const struct Address *addr = to ? to : (cc ? cc : bcc);
      struct Buffer *buf = buf_pool_get();
      mutt_safe_path(buf, addr);
      const char *const c_folder = cs_subset_string(NeoMutt->sub, "folder");
      buf_concat_path(path, NONULL(c_folder), buf_string(buf));
      buf_pool_release(&buf);
      if (!c_force_name && (mx_access(buf_string(path), W_OK) != 0))
        buf_strcpy(path, c_record);
    }
    else
    {
      buf_strcpy(path, c_record);
    }
  }
  else
  {
    buf_fix_dptr(path);
  }
 
  buf_pretty_mailbox(path);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_startup_shutdown_hook()

void mutt_startup_shutdown_hook

(

HookFlags

type

)

Execute any startup/shutdown hooks.

Parameters

type	Hook type: MUTT_STARTUP_HOOK or MUTT_SHUTDOWN_HOOK

The user can configure hooks to be run on startup/shutdown. This function finds all the matching hooks and executes them.

Definition at line 1624 of file hook.c.

{
  struct Hook *hook = NULL;
  struct Buffer *err = buf_pool_get();
 
  TAILQ_FOREACH(hook, &Hooks, entries)
  {
    if (!(hook->command && (hook->type & type)))
      continue;
 
    if (parse_rc_line_cwd(hook->command, hook->source_file, err) == MUTT_CMD_ERROR)
    {
      mutt_error("%s", buf_string(err));
      buf_reset(err);
    }
  }
  buf_pool_release(&err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_timeout_hook()

void mutt_timeout_hook

(

void

)

Execute any timeout hooks.

The user can configure hooks to be run on timeout. This function finds all the matching hooks and executes them.

Definition at line 1592 of file hook.c.

{
  struct Hook *hook = NULL;
  struct Buffer *err = buf_pool_get();
 
  TAILQ_FOREACH(hook, &Hooks, entries)
  {
    if (!(hook->command && (hook->type & MUTT_TIMEOUT_HOOK)))
      continue;
 
    if (parse_rc_line_cwd(hook->command, hook->source_file, err) == MUTT_CMD_ERROR)
    {
      mutt_error("%s", buf_string(err));
      buf_reset(err);
 
      /* The hooks should be independent of each other, so even though this on
       * failed, we'll carry on with the others. */
    }
  }
  buf_pool_release(&err);
 
  /* Delete temporary attachment files */
  mutt_temp_attachments_cleanup();
}

Here is the call graph for this function:

Here is the caller graph for this function: