commands.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "commands/lib.h"
#include "parse/lib.h"
#include "group.h"
#include "ignore.h"
#include "module_data.h"
#include "score.h"
#include "spam.h"

enum CommandResult parse_list(const struct Command *cmd, struct Buffer *line,
                              const struct ParseContext *pc, struct ParseError *pe)
{
  struct EmailModuleData *md = neomutt_get_module_data(NeoMutt, MODULE_ID_EMAIL);
  ASSERT(md);
 
  switch (cmd->id)
  {
    case CMD_ALTERNATIVE_ORDER:
      return parse_stailq(cmd, line, &md->alternative_order, pc, pe);
 
    case CMD_AUTO_VIEW:
      return parse_stailq(cmd, line, &md->auto_view, pc, pe);
 
    case CMD_HEADER_ORDER:
      return parse_stailq(cmd, line, &md->header_order, pc, pe);
 
    case CMD_MAILTO_ALLOW:
      return parse_stailq(cmd, line, &md->mail_to_allow, pc, pe);
 
    default:
      ASSERT(false);
  }
 
  return MUTT_CMD_ERROR;
}

enum CommandResult parse_unlist(const struct Command *cmd, struct Buffer *line,
                                const struct ParseContext *pc, struct ParseError *pe)
{
  struct EmailModuleData *md = neomutt_get_module_data(NeoMutt, MODULE_ID_EMAIL);
  ASSERT(md);
 
  switch (cmd->id)
  {
    case CMD_UNALTERNATIVE_ORDER:
      return parse_unstailq(cmd, line, &md->alternative_order, pc, pe);
 
    case CMD_UNAUTO_VIEW:
      return parse_unstailq(cmd, line, &md->auto_view, pc, pe);
 
    case CMD_UNHEADER_ORDER:
      return parse_unstailq(cmd, line, &md->header_order, pc, pe);
 
    case CMD_UNMAILTO_ALLOW:
      return parse_unstailq(cmd, line, &md->mail_to_allow, pc, pe);
 
    default:
      ASSERT(false);
  }
 
  return MUTT_CMD_ERROR;
}

enum CommandResult parse_tag_formats(const struct Command *cmd, struct Buffer *line,
                                     const struct ParseContext *pc, struct ParseError *pe)
{
  struct Buffer *err = pe->message;
 
  if (!MoreArgs(line))
  {
    buf_printf(err, _("%s: too few arguments"), cmd->name);
    return MUTT_CMD_WARNING;
  }
 
  struct Buffer *tag = buf_pool_get();
  struct Buffer *fmt = buf_pool_get();
 
  struct EmailModuleData *md = neomutt_get_module_data(NeoMutt, MODULE_ID_EMAIL);
  ASSERT(md);
 
  while (MoreArgs(line))
  {
    parse_extract_token(tag, line, TOKEN_NO_FLAGS);
    if (buf_is_empty(tag))
      continue;
 
    parse_extract_token(fmt, line, TOKEN_NO_FLAGS);
 
    /* avoid duplicates */
    const char *tmp = mutt_hash_find(md->tag_formats, buf_string(fmt));
    if (tmp)
    {
      mutt_warning(_("tag format '%s' already registered as '%s'"), buf_string(fmt), tmp);
      continue;
    }
 
    mutt_hash_insert(md->tag_formats, buf_string(fmt), buf_strdup(tag));
  }
 
  buf_pool_release(&tag);
  buf_pool_release(&fmt);
  return MUTT_CMD_SUCCESS;
}

enum CommandResult parse_tag_transforms(const struct Command *cmd, struct Buffer *line,
                                        const struct ParseContext *pc,
                                        struct ParseError *pe)
{
  struct Buffer *err = pe->message;
 
  if (!MoreArgs(line))
  {
    buf_printf(err, _("%s: too few arguments"), cmd->name);
    return MUTT_CMD_WARNING;
  }
 
  struct Buffer *tag = buf_pool_get();
  struct Buffer *trans = buf_pool_get();
 
  struct EmailModuleData *md = neomutt_get_module_data(NeoMutt, MODULE_ID_EMAIL);
  ASSERT(md);
 
  while (MoreArgs(line))
  {
    parse_extract_token(tag, line, TOKEN_NO_FLAGS);
    if (buf_is_empty(tag))
      continue;
 
    parse_extract_token(trans, line, TOKEN_NO_FLAGS);
    const char *trn = buf_string(trans);
 
    /* avoid duplicates */
    const char *tmp = mutt_hash_find(md->tag_transforms, buf_string(tag));
    if (tmp)
    {
      mutt_warning(_("tag transform '%s' already registered as '%s'"),
                   buf_string(tag), tmp);
      continue;
    }
 
    mutt_hash_insert(md->tag_transforms, buf_string(tag), mutt_str_dup(trn));
  }
 
  buf_pool_release(&tag);
  buf_pool_release(&trans);
  return MUTT_CMD_SUCCESS;
}

const struct Command EmailCommands[] = {
  // clang-format off
  { "alternative-order", CMD_ALTERNATIVE_ORDER, parse_list,
        N_("Set preference order for multipart alternatives"),
        N_("alternative-order <mime-type>[/<mime-subtype> ] [ ... ]"),
        "mimesupport.html#alternative-order" },
  { "auto-view", CMD_AUTO_VIEW, parse_list,
        N_("Automatically display specified MIME types inline"),
        N_("auto-view <mime-type>[/<mime-subtype> ] [ ... ]"),
        "mimesupport.html#auto-view" },
  { "group", CMD_GROUP, parse_group,
        N_("Add addresses to an address group"),
        N_("group [ -group <name> ... ] { -rx <regex> ... | -addr <address> ... }"),
        "configuration.html#addrgroup" },
  { "header-order", CMD_HEADER_ORDER, parse_list,
        N_("Define custom order of headers displayed"),
        N_("header-order <header> [ <header> ... ]"),
        "configuration.html#header-order" },
  { "ignore", CMD_IGNORE, parse_ignore,
        N_("Hide specified headers when displaying messages"),
        N_("ignore <string> [ <string> ...]"),
        "configuration.html#ignore" },
  { "lists", CMD_LISTS, parse_lists,
        N_("Add address to the list of mailing lists"),
        N_("lists [ -group <name> ... ] <regex> [ ... ]"),
        "configuration.html#lists" },
  { "mailto-allow", CMD_MAILTO_ALLOW, parse_list,
        N_("Permit specific header-fields in mailto URL processing"),
        N_("mailto-allow { * | <header-field> ... }"),
        "configuration.html#mailto-allow" },
  { "nospam", CMD_NOSPAM, parse_nospam,
        N_("Remove a spam detection rule"),
        N_("nospam { * | <regex> }"),
        "configuration.html#spam" },
  { "score", CMD_SCORE, parse_score,
        N_("Set a score value on emails matching a pattern"),
        N_("score <pattern> <value>"),
        "configuration.html#score-command" },
  { "spam", CMD_SPAM, parse_spam,
        N_("Define rules to parse spam detection headers"),
        N_("spam <regex> [ <format> ]"),
        "configuration.html#spam" },
  { "tag-formats", CMD_TAG_FORMATS, parse_tag_formats,
        N_("Define expandos tags"),
        N_("tag-formats <tag> <format-string> [ ... ] }"),
        "optionalfeatures.html#custom-tags" },
  { "tag-transforms", CMD_TAG_TRANSFORMS, parse_tag_transforms,
        N_("Rules to transform tags into icons"),
        N_("tag-transforms <tag> <transformed-string> [ ... ]"),
        "optionalfeatures.html#custom-tags" },
  { "unalternative-order", CMD_UNALTERNATIVE_ORDER, parse_unlist,
        N_("Remove MIME types from preference order"),
        N_("unalternative-order { * | [ <mime-type>[/<mime-subtype> ] ... ] }"),
        "mimesupport.html#alternative-order" },
  { "unauto-view", CMD_UNAUTO_VIEW, parse_unlist,
        N_("Remove MIME types from `auto-view` list"),
        N_("unauto-view { * | [ <mime-type>[/<mime-subtype> ] ... ] }"),
        "mimesupport.html#auto-view" },
  { "ungroup", CMD_UNGROUP, parse_group,
        N_("Remove addresses from an address `group`"),
        N_("ungroup [ -group <name> ... ] { * | -rx <regex> ... | -addr <address> ... }"),
        "configuration.html#addrgroup" },
  { "unheader-order", CMD_UNHEADER_ORDER, parse_unlist,
        N_("Remove header from `header-order` list"),
        N_("unheader-order { * | <header> ... }"),
        "configuration.html#header-order" },
  { "unignore", CMD_UNIGNORE, parse_unignore,
        N_("Remove a header from the `header-order` list"),
        N_("unignore { * | <string> ... }"),
        "configuration.html#ignore" },
  { "unlists", CMD_UNLISTS, parse_unlists,
        N_("Remove address from the list of mailing lists"),
        N_("unlists { * | <regex> ... }"),
        "configuration.html#lists" },
  { "unmailto-allow", CMD_UNMAILTO_ALLOW, parse_unlist,
        N_("Disallow header-fields in mailto processing"),
        N_("unmailto-allow { * | <header-field> ... }"),
        "configuration.html#mailto-allow" },
  { "unscore", CMD_UNSCORE, parse_unscore,
        N_("Remove scoring rules for matching patterns"),
        N_("unscore { * | <pattern> ... }"),
        "configuration.html#score-command" },
 
  // Deprecated
  { "alternative_order",   CMD_NONE, NULL, "alternative-order",   NULL, NULL, CF_SYNONYM },
  { "auto_view",           CMD_NONE, NULL, "auto-view",           NULL, NULL, CF_SYNONYM },
  { "hdr_order",           CMD_NONE, NULL, "header-order",        NULL, NULL, CF_SYNONYM },
  { "mailto_allow",        CMD_NONE, NULL, "mailto-allow",        NULL, NULL, CF_SYNONYM },
  { "unalternative_order", CMD_NONE, NULL, "unalternative-order", NULL, NULL, CF_SYNONYM },
  { "unauto_view",         CMD_NONE, NULL, "unauto-view",         NULL, NULL, CF_SYNONYM },
  { "unhdr_order",         CMD_NONE, NULL, "unheader-order",      NULL, NULL, CF_SYNONYM },
  { "unmailto_allow",      CMD_NONE, NULL, "unmailto-allow",      NULL, NULL, CF_SYNONYM },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NO_FLAGS },
  // clang-format on
};