hook.c File Reference

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

#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "alias/lib.h"
#include "mutt.h"
#include "hook.h"
#include "attach/lib.h"
#include "index/lib.h"
#include "ncrypt/lib.h"
#include "pattern/lib.h"
#include "format_flags.h"
#include "hdrline.h"
#include "init.h"
#include "mutt_globals.h"
#include "muttlib.h"
#include "mx.h"
#include "compmbox/lib.h"

Include dependency graph for hook.c:

Go to the source code of this file.

Data Structures
struct	Hook
	A list of user hooks. More...

Functions
	TAILQ_HEAD (HookList, Hook)
enum CommandResult	mutt_parse_charset_iconv_hook (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse 'charset-hook' and 'iconv-hook' commands - Implements Command::parse() -. More...
enum CommandResult	mutt_parse_hook (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'hook' family of commands - Implements Command::parse() -. More...
static void	delete_hook (struct Hook *h)
	Delete a Hook. More...
void	mutt_delete_hooks (HookFlags type)
	Delete matching hooks. More...
static void	idxfmt_hashelem_free (int type, void *obj, intptr_t data)
	Delete an index-format-hook from the Hash Table - Implements hash_hdata_free_t -. More...
static void	delete_idxfmt_hooks (void)
	Delete all the index-format-hooks. More...
enum CommandResult	mutt_parse_idxfmt_hook (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'index-format-hook' command - Implements Command::parse() -. More...
enum CommandResult	mutt_parse_unhook (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unhook' command - Implements Command::parse() -. More...
void	mutt_folder_hook (const char *path, const char *desc)
	Perform a folder hook. More...
char *	mutt_find_hook (HookFlags type, const char *pat)
	Find a matching hook. More...
void	mutt_message_hook (struct Mailbox *m, struct Email *e, HookFlags type)
	Perform a message hook. More...
static int	addr_hook (char *path, size_t pathlen, HookFlags type, struct Mailbox *m, struct Email *e)
	Perform an address hook (get a path) More...
void	mutt_default_save (char *path, size_t pathlen, struct Email *e)
	Find the default save path for an email. More...
void	mutt_select_fcc (struct Buffer *path, struct Email *e)
	Select the FCC path for an email. More...
static void	list_hook (struct ListHead *matches, const char *match, HookFlags hook)
	Find hook strings matching. More...
void	mutt_crypt_hook (struct ListHead *list, struct Address *addr)
	Find crypto hooks for an Address. More...
void	mutt_account_hook (const char *url)
	Perform an account hook. More...
void	mutt_timeout_hook (void)
	Execute any timeout hooks. More...
void	mutt_startup_shutdown_hook (HookFlags type)
	Execute any startup/shutdown hooks. More...
const char *	mutt_idxfmt_hook (const char *name, struct Mailbox *m, struct Email *e)
	Get index-format-hook format string. More...

Variables
static struct HookList	Hooks = TAILQ_HEAD_INITIALIZER(Hooks)
static struct HashTable *	IdxFmtHooks = NULL
static HookFlags	current_hook_type = MUTT_HOOK_NO_FLAGS

Detailed Description

Parse and execute user-defined hooks.

Authors

• Michael R. Elkins, and others
• Pietro Cerutti
• Oliver Bandel

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

Function Documentation

TAILQ_HEAD()

TAILQ_HEAD	(	HookList	,
		Hook
	)

delete_hook()

static void delete_hook ( struct Hook *  h )

static

Delete a Hook.

Parameters

h	Hook to delete

Definition at line 342 of file hook.c.

{
  FREE(&h->command);
  FREE(&h->regex.pattern);
  if (h->regex.regex)
  {
    regfree(h->regex.regex);
    FREE(&h->regex.regex);
  }
  mutt_pattern_free(&h->pattern);
  FREE(&h);
}

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 0 is passed, all the hooks will be deleted.

Definition at line 361 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);
      delete_hook(h);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

delete_idxfmt_hooks()

static void delete_idxfmt_hooks ( void  )

static

Delete all the index-format-hooks.

Definition at line 397 of file hook.c.

{
  mutt_hash_free(&IdxFmtHooks);
}

Here is the call 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 562 of file hook.c.

{
  if (!path && !desc)
    return;
 
  struct Hook *hook = NULL;
  struct Buffer *err = mutt_buffer_pool_get();
 
  current_hook_type = 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 (mutt_parse_rc_line(hook->command, err) == MUTT_CMD_ERROR)
      {
        mutt_error("%s", mutt_buffer_string(err));
        break;
      }
    }
  }
  mutt_buffer_pool_release(&err);
 
  current_hook_type = MUTT_HOOK_NO_FLAGS;
}

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 610 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_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 631 of file hook.c.

{
  struct Hook *hook = NULL;
  struct PatternCache cache = { 0 };
  struct Buffer *err = mutt_buffer_pool_get();
 
  current_hook_type = 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 (mutt_parse_rc_line(hook->command, err) == MUTT_CMD_ERROR)
        {
          mutt_error("%s", mutt_buffer_string(err));
          current_hook_type = MUTT_HOOK_NO_FLAGS;
          mutt_buffer_pool_release(&err);
 
          return;
        }
        /* Executing arbitrary commands could affect the pattern results,
         * so the cache has to be wiped */
        memset(&cache, 0, sizeof(cache));
      }
    }
  }
  mutt_buffer_pool_release(&err);
 
  current_hook_type = MUTT_HOOK_NO_FLAGS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

addr_hook()

static int addr_hook ( char *  path, size_t  pathlen, HookFlags  type, struct Mailbox *  m, struct Email *  e  )

static

Perform an address hook (get a path)

Parameters

path	Buffer for path
pathlen	Length of buffer
type	Hook type, see HookFlags
m	Mailbox
e	Email

Return values

0	Success
-1	Failure

Definition at line 678 of file hook.c.

{
  struct Hook *hook = NULL;
  struct PatternCache cache = { 0 };
 
  /* determine if a matching hook exists */
  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)
      {
        mutt_make_string(path, pathlen, 0, hook->command, m, -1, e, MUTT_FORMAT_PLAIN, NULL);
        return 0;
      }
    }
  }
 
  return -1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_default_save()

void mutt_default_save	(	char *	path,
		size_t	pathlen,
		struct Email *	e
	)

Find the default save path for an email.

Parameters

path	Buffer for the path
pathlen	Length of buffer
e	Email

Definition at line 710 of file hook.c.

{
  *path = '\0';
  struct Mailbox *m_cur = get_current_mailbox();
  if (addr_hook(path, pathlen, 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 = mutt_buffer_pool_get();
    mutt_safe_path(tmp, addr);
    snprintf(path, pathlen, "=%s", mutt_buffer_string(tmp));
    mutt_buffer_pool_release(&tmp);
  }
}

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 749 of file hook.c.

{
  mutt_buffer_alloc(path, PATH_MAX);
 
  if (addr_hook(path->data, path->dsize, 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 = mutt_buffer_pool_get();
      mutt_safe_path(buf, addr);
      const char *const c_folder = cs_subset_string(NeoMutt->sub, "folder");
      mutt_buffer_concat_path(path, NONULL(c_folder), mutt_buffer_string(buf));
      mutt_buffer_pool_release(&buf);
      if (!c_force_name && (mx_access(mutt_buffer_string(path), W_OK) != 0))
        mutt_buffer_strcpy(path, c_record);
    }
    else
      mutt_buffer_strcpy(path, c_record);
  }
  else
    mutt_buffer_fix_dptr(path);
 
  mutt_buffer_pretty_mailbox(path);
}

Here is the call graph for this function:

Here is the caller graph for this function:

list_hook()

static void list_hook ( struct ListHead *  matches, const char *  match, HookFlags  hook  )

static

Find hook strings matching.

Parameters

[out]	matches	List of hook strings
[in]	match	String to match
[in]	hook	Hook type, see HookFlags

Definition at line 787 of file hook.c.

{
  struct Hook *tmp = NULL;
 
  TAILQ_FOREACH(tmp, &Hooks, entries)
  {
    if ((tmp->type & hook) && mutt_regex_match(&tmp->regex, match))
    {
      mutt_list_insert_tail(matches, mutt_str_dup(tmp->command));
    }
  }
}

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 807 of file hook.c.

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

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 816 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 = mutt_buffer_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 (mutt_parse_rc_line(hook->command, err) == MUTT_CMD_ERROR)
      {
        mutt_error("%s", mutt_buffer_string(err));
        mutt_buffer_pool_release(&err);
 
        inhook = false;
        goto done;
      }
 
      inhook = false;
    }
  }
done:
  mutt_buffer_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 861 of file hook.c.

{
  struct Hook *hook = NULL;
  struct Buffer err;
  char buf[256];
 
  mutt_buffer_init(&err);
  err.data = buf;
  err.dsize = sizeof(buf);
 
  TAILQ_FOREACH(hook, &Hooks, entries)
  {
    if (!(hook->command && (hook->type & MUTT_TIMEOUT_HOOK)))
      continue;
 
    if (mutt_parse_rc_line(hook->command, &err) == MUTT_CMD_ERROR)
    {
      mutt_error("%s", err.data);
      mutt_buffer_reset(&err);
 
      /* The hooks should be independent of each other, so even though this on
       * failed, we'll carry on with the others. */
    }
  }
 
  /* Delete temporary attachment files */
  mutt_unlink_temp_attachments();
}

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 897 of file hook.c.

{
  struct Hook *hook = NULL;
  struct Buffer err = mutt_buffer_make(0);
  char buf[256];
 
  err.data = buf;
  err.dsize = sizeof(buf);
 
  TAILQ_FOREACH(hook, &Hooks, entries)
  {
    if (!(hook->command && (hook->type & type)))
      continue;
 
    if (mutt_parse_rc_line(hook->command, &err) == MUTT_CMD_ERROR)
    {
      mutt_error("%s", err.data);
      mutt_buffer_reset(&err);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_idxfmt_hook()

const char* 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	printf(3)-like format string
NULL	No matching hook

Definition at line 927 of file hook.c.

{
  if (!IdxFmtHooks)
    return NULL;
 
  struct HookList *hl = mutt_hash_find(IdxFmtHooks, name);
  if (!hl)
    return NULL;
 
  current_hook_type = MUTT_IDXFMTHOOK;
 
  struct PatternCache cache = { 0 };
  const char *fmtstring = 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)
    {
      fmtstring = hook->command;
      break;
    }
  }
 
  current_hook_type = MUTT_HOOK_NO_FLAGS;
 
  return fmtstring;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

Hooks

struct HookList Hooks = TAILQ_HEAD_INITIALIZER(Hooks)

static

Definition at line 70 of file hook.c.

IdxFmtHooks

struct HashTable* IdxFmtHooks = NULL

static

Definition at line 74 of file hook.c.

current_hook_type

HookFlags current_hook_type = MUTT_HOOK_NO_FLAGS

static

Definition at line 75 of file hook.c.