parse.c File Reference

Parse user-defined Hooks. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "commands/lib.h"
#include "compmbox/lib.h"
#include "expando/lib.h"
#include "index/lib.h"
#include "parse/lib.h"
#include "pattern/lib.h"
#include "globals.h"
#include "hook.h"
#include "muttlib.h"

Include dependency graph for parse.c:

Go to the source code of this file.

Functions
enum CommandResult	parse_charset_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse charset Hook commands - Implements Command::parse() -.
enum CommandResult	parse_global_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse global Hook commands - Implements Command::parse() -.
enum CommandResult	parse_pattern_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse pattern-based Hook commands - Implements Command::parse() -.
enum CommandResult	add_mailbox_hook (enum CommandId id, struct Buffer *mailbox, struct Buffer *pattern, bool pat_not, struct Buffer *err)
	Add a Mailbox Hook.
enum CommandResult	parse_mailbox_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse mailbox pattern hook commands - Implements Command::parse() -.
enum CommandResult	parse_regex_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse regex-based hook command - Implements Command::parse() -.
enum CommandResult	parse_folder_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse folder hook command - Implements Command::parse() -.
enum CommandResult	parse_crypt_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse crypt hook commands - Implements Command::parse() -.
enum CommandResult	parse_mbox_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse mbox hook command - Implements Command::parse() -.
enum CommandResult	parse_compress_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse compress hook commands - Implements Command::parse() -.
void	mutt_delete_hooks (enum CommandId id)
	Delete matching hooks.
static void	idxfmt_hashelem_free (int type, void *obj, intptr_t data)
	Free our hash table data - Implements hash_hdata_free_t -.
static void	delete_idxfmt_hooks (void)
	Delete all the index-format-hooks.
enum CommandResult	parse_index_hook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the index format hook command - Implements Command::parse() -.
enum CommandResult	parse_unhook (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the unhook command - Implements Command::parse() -.

Variables
const struct ExpandoDefinition	IndexFormatDef []
	Expando definitions.
struct HookList	Hooks = TAILQ_HEAD_INITIALIZER(Hooks)
	All simple hooks, e.g. CMD_FOLDER_HOOK.
struct HashTable *	IdxFmtHooks = NULL
	All Index Format hooks.
enum CommandId	CurrentHookId = CMD_NONE
	The ID of the Hook currently being executed, e.g. CMD_SAVE_HOOK.

Detailed Description

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

Function Documentation

add_mailbox_hook()

enum CommandResult add_mailbox_hook	(	enum CommandId	id,
		struct Buffer *	mailbox,
		struct Buffer *	pattern,
		bool	pat_not,
		struct Buffer *	err )

Add a Mailbox Hook.

Parameters

id	CommandId, e.g. CMD_FCC_SAVE_HOOK
mailbox	Mailbox
pattern	Pattern to match
pat_not	true of Pattern is inverted
err	Buffer for error message

Return values

enum	CommandResult, e.g. MUTT_CMD_SUCCESS

Definition at line 293 of file parse.c.

{
  struct Hook *hook = NULL;
  struct PatternList *pat = NULL;
 
  /* check to make sure that a matching hook doesn't already exist */
  TAILQ_FOREACH(hook, &Hooks, entries)
  {
    if ((hook->id == id) && (hook->regex.pat_not == pat_not) &&
        mutt_str_equal(buf_string(pattern), hook->regex.pattern))
    {
      // Update an existing hook
      FREE(&hook->command);
      hook->command = buf_strdup(mailbox);
      FREE(&hook->source_file);
      hook->source_file = mutt_get_sourced_cwd();
 
      expando_free(&hook->expando);
      hook->expando = expando_parse(buf_string(mailbox), IndexFormatDef, err);
 
      return MUTT_CMD_SUCCESS;
    }
  }
 
  PatternCompFlags comp_flags;
  if (id == CMD_FCC_HOOK)
    comp_flags = MUTT_PC_NO_FLAGS;
  else
    comp_flags = MUTT_PC_FULL_MSG;
 
  struct MailboxView *mv_cur = get_current_mailbox_view();
  pat = mutt_pattern_comp(mv_cur, buf_string(pattern), comp_flags, err);
  if (!pat)
    return MUTT_CMD_ERROR;
 
  struct Expando *exp = expando_parse(buf_string(mailbox), IndexFormatDef, err);
 
  hook = hook_new();
  hook->id = id;
  hook->command = buf_strdup(mailbox);
  hook->source_file = mutt_get_sourced_cwd();
  hook->pattern = pat;
  hook->regex.pattern = buf_strdup(pattern);
  hook->regex.regex = NULL;
  hook->regex.pat_not = pat_not;
  hook->expando = exp;
 
  TAILQ_INSERT_TAIL(&Hooks, hook, entries);
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_delete_hooks()

void mutt_delete_hooks

(

enum CommandId

id

)

Delete matching hooks.

Parameters

id	Hook CommandId to delete, e.g. CMD_SEND_HOOK

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

Definition at line 1014 of file parse.c.

{
  struct Hook *h = NULL;
  struct Hook *tmp = NULL;
 
  TAILQ_FOREACH_SAFE(h, &Hooks, entries, tmp)
  {
    if ((id == CMD_NONE) || (id == h->id))
    {
      TAILQ_REMOVE(&Hooks, h, entries);
      hook_free(&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 1050 of file parse.c.

{
  mutt_hash_free(&IdxFmtHooks);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

IndexFormatDef

const struct ExpandoDefinition IndexFormatDef[]

extern

Expando definitions.

Config:

• $attribution_intro
• $attribution_trailer
• $forward_attribution_intro
• $forward_attribution_trailer
• $forward_format
• $index_format
• $message_format
• $pager_format

Note

Longer Expandos must precede any similar, but shorter Expandos

Definition at line 293 of file mutt_config.c.

                                                  {
  // clang-format off
  { "*",  "padding-soft",        ED_GLOBAL,   ED_GLO_PADDING_SOFT,        node_padding_parse },
  { ">",  "padding-hard",        ED_GLOBAL,   ED_GLO_PADDING_HARD,        node_padding_parse },
  { "|",  "padding-eol",         ED_GLOBAL,   ED_GLO_PADDING_EOL,         node_padding_parse },
  { "(",  NULL,                  ED_EMAIL,    ED_EMA_STRF_RECV_LOCAL,     parse_index_date_recv_local },
  { "@",  NULL,                  ED_EMAIL,    ED_EMA_INDEX_HOOK,          parse_index_format_hook },
  { "a",  "from",                ED_ENVELOPE, ED_ENV_FROM,                NULL },
  { "A",  "reply-to",            ED_ENVELOPE, ED_ENV_REPLY_TO,            NULL },
  { "b",  "mailbox-name",        ED_MAILBOX,  ED_MBX_MAILBOX_NAME,        NULL },
  { "B",  "list-address",        ED_ENVELOPE, ED_ENV_LIST_ADDRESS,        NULL },
  { "cr", "body-characters",     ED_EMAIL,    ED_EMA_BODY_CHARACTERS,     NULL },
  { "c",  "size",                ED_EMAIL,    ED_EMA_SIZE,                NULL },
  { "C",  "number",              ED_EMAIL,    ED_EMA_NUMBER,              NULL },
  { "d",  "date-format",         ED_EMAIL,    ED_EMA_DATE_FORMAT,         NULL },
  { "D",  "date-format-local",   ED_EMAIL,    ED_EMA_DATE_FORMAT_LOCAL,   NULL },
  { "e",  "thread-number",       ED_EMAIL,    ED_EMA_THREAD_NUMBER,       NULL },
  { "E",  "thread-count",        ED_EMAIL,    ED_EMA_THREAD_COUNT,        NULL },
  { "f",  "from-full",           ED_ENVELOPE, ED_ENV_FROM_FULL,           NULL },
  { "Fp", "sender-plain",        ED_ENVELOPE, ED_ENV_SENDER_PLAIN,        NULL },
  { "F",  "sender",              ED_ENVELOPE, ED_ENV_SENDER,              NULL },
  { "g",  "tags",                ED_EMAIL,    ED_EMA_TAGS,                NULL },
  { "G",  "tags-transformed",    ED_EMAIL,    ED_EMA_TAGS_TRANSFORMED,    parse_tags_transformed },
  { "H",  "spam",                ED_ENVELOPE, ED_ENV_SPAM,                NULL },
  { "i",  "message-id",          ED_ENVELOPE, ED_ENV_MESSAGE_ID,          NULL },
  { "I",  "initials",            ED_ENVELOPE, ED_ENV_INITIALS,            NULL },
  { "J",  "thread-tags",         ED_EMAIL,    ED_EMA_THREAD_TAGS,         NULL },
  { "K",  "list-empty",          ED_ENVELOPE, ED_ENV_LIST_EMPTY,          NULL },
  { "l",  "lines",               ED_EMAIL,    ED_EMA_LINES,               NULL },
  { "L",  "from-list",           ED_EMAIL,    ED_EMA_FROM_LIST,           NULL },
  { "m",  "message-count",       ED_MAILBOX,  ED_MBX_MESSAGE_COUNT,       NULL },
  { "M",  "thread-hidden-count", ED_EMAIL,    ED_EMA_THREAD_HIDDEN_COUNT, NULL },
  { "n",  "name",                ED_ENVELOPE, ED_ENV_NAME,                NULL },
  { "N",  "score",               ED_EMAIL,    ED_EMA_SCORE,               NULL },
  { "O",  "save-folder",         ED_EMAIL,    ED_EMA_LIST_OR_SAVE_FOLDER, NULL },
  { "P",  "percentage",          ED_MAILBOX,  ED_MBX_PERCENTAGE,          NULL },
  { "q",  "newsgroup",           ED_ENVELOPE, ED_ENV_NEWSGROUP,           NULL },
  { "r",  "to-all",              ED_ENVELOPE, ED_ENV_TO_ALL,              NULL },
  { "R",  "cc-all",              ED_ENVELOPE, ED_ENV_CC_ALL,              NULL },
  { "s",  "subject",             ED_ENVELOPE, ED_ENV_SUBJECT,             parse_subject },
  { "S",  "flag-chars",          ED_EMAIL,    ED_EMA_FLAG_CHARS,          NULL },
  { "t",  "to",                  ED_ENVELOPE, ED_ENV_TO,                  NULL },
  { "T",  "to-chars",            ED_EMAIL,    ED_EMA_TO_CHARS,            NULL },
  { "u",  "username",            ED_ENVELOPE, ED_ENV_USERNAME,            NULL },
  { "v",  "first-name",          ED_ENVELOPE, ED_ENV_FIRST_NAME,          NULL },
  { "W",  "organization",        ED_ENVELOPE, ED_ENV_ORGANIZATION,        NULL },
  { "x",  "x-comment-to",        ED_ENVELOPE, ED_ENV_X_COMMENT_TO,        NULL },
  { "X",  "attachment-count",    ED_EMAIL,    ED_EMA_ATTACHMENT_COUNT,    NULL },
  { "y",  "x-label",             ED_ENVELOPE, ED_ENV_X_LABEL,             NULL },
  { "Y",  "thread-x-label",      ED_ENVELOPE, ED_ENV_THREAD_X_LABEL,      NULL },
  { "Z",  "combined-flags",      ED_EMAIL,    ED_EMA_COMBINED_FLAGS,      NULL },
  { "zc", "crypto-flags",        ED_EMAIL,    ED_EMA_CRYPTO_FLAGS,        NULL },
  { "zs", "status-flags",        ED_EMAIL,    ED_EMA_STATUS_FLAGS,        NULL },
  { "zt", "message-flags",       ED_EMAIL,    ED_EMA_MESSAGE_FLAGS,       NULL },
  { "[",  NULL,                  ED_EMAIL,    ED_EMA_DATE_STRF_LOCAL,     parse_index_date_local },
  { "{",  NULL,                  ED_EMAIL,    ED_EMA_DATE_STRF,           parse_index_date },
  { NULL, NULL, 0, -1, NULL }
  // clang-format on
};

Hooks

struct HookList Hooks = TAILQ_HEAD_INITIALIZER(Hooks)

All simple hooks, e.g. CMD_FOLDER_HOOK.

Definition at line 49 of file parse.c.

IdxFmtHooks

struct HashTable* IdxFmtHooks = NULL

All Index Format hooks.

Definition at line 52 of file parse.c.

CurrentHookId

enum CommandId CurrentHookId = CMD_NONE

The ID of the Hook currently being executed, e.g. CMD_SAVE_HOOK.

Definition at line 55 of file parse.c.