command_parse.c File Reference

Functions to parse commands in a config file. More...

#include "config.h"
#include <assert.h>
#include <errno.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 "gui/lib.h"
#include "mutt.h"
#include "command_parse.h"
#include "imap/lib.h"
#include "menu/lib.h"
#include "init.h"
#include "keymap.h"
#include "monitor.h"
#include "mutt_commands.h"
#include "mutt_globals.h"
#include "muttlib.h"
#include "mx.h"
#include "myvar.h"
#include "options.h"
#include "version.h"
#include <libintl.h>

Include dependency graph for command_parse.c:

Go to the source code of this file.

Macros
#define	MAX_ERRS   128

Enumerations
enum	GroupState { GS_NONE, GS_RX, GS_ADDR }
	Type of email address group. More...

Functions
static bool	is_function (const char *name)
	Is the argument a neomutt function? More...
int	parse_grouplist (struct GroupList *gl, struct Buffer *buf, struct Buffer *s, struct Buffer *err)
	Parse a group context. More...
int	source_rc (const char *rcfile_path, struct Buffer *err)
	Read an initialization file. More...
enum CommandResult	parse_cd (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'cd' command - Implements Command::parse() -. More...
enum CommandResult	parse_echo (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'echo' command - Implements Command::parse() -. More...
enum CommandResult	parse_finish (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'finish' command - Implements Command::parse() -. More...
enum CommandResult	parse_group (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'group' and 'ungroup' commands - Implements Command::parse() -. More...
enum CommandResult	parse_ifdef (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'ifdef' and 'ifndef' commands - Implements Command::parse() -The 'ifdef' command allows conditional elements in the config file. More...
enum CommandResult	parse_ignore (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'ignore' command - Implements Command::parse() -. More...
enum CommandResult	parse_lists (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'lists' command - Implements Command::parse() -. More...
enum CommandResult	parse_mailboxes (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'mailboxes' command - Implements Command::parse() -This is also used by 'virtual-mailboxes'. More...
enum CommandResult	parse_my_hdr (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'my_hdr' command - Implements Command::parse() -. More...
enum CommandResult	parse_set (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'set' family of commands - Implements Command::parse() -This is used by 'reset', 'set', 'toggle' and 'unset'. More...
enum CommandResult	parse_setenv (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'setenv' and 'unsetenv' commands - Implements Command::parse() -. More...
enum CommandResult	parse_source (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'source' command - Implements Command::parse() -. More...
enum CommandResult	parse_spam_list (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'spam' and 'nospam' commands - Implements Command::parse() -. More...
enum CommandResult	parse_stailq (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse a list command - Implements Command::parse() -This is used by 'alternative_order', 'auto_view' and several others. More...
enum CommandResult	parse_subscribe (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'subscribe' command - Implements Command::parse() -. More...
enum CommandResult	parse_subscribe_to (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'subscribe-to' command - Implements Command::parse() -The 'subscribe-to' command allows to subscribe to an IMAP-Mailbox. More...
enum CommandResult	parse_tag_formats (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'tag-formats' command - Implements Command::parse() -. More...
enum CommandResult	parse_tag_transforms (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'tag-transforms' command - Implements Command::parse() -. More...
enum CommandResult	parse_unignore (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unignore' command - Implements Command::parse() -. More...
enum CommandResult	parse_unlists (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unlists' command - Implements Command::parse() -. More...
static void	do_unmailboxes (struct Mailbox *m)
	Remove a Mailbox from the Sidebar/notifications. More...
static void	do_unmailboxes_star (void)
	Remove all Mailboxes from the Sidebar/notifications. More...
enum CommandResult	parse_unmailboxes (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unmailboxes' command - Implements Command::parse() -This is also used by 'unvirtual-mailboxes'. More...
enum CommandResult	parse_unmy_hdr (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unmy_hdr' command - Implements Command::parse() -. More...
enum CommandResult	parse_unstailq (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse an unlist command - Implements Command::parse() -This is used by 'unalternative_order', 'unauto_view' and several others. More...
enum CommandResult	parse_unsubscribe (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unsubscribe' command - Implements Command::parse() -. More...
enum CommandResult	parse_unsubscribe_from (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unsubscribe-from' command - Implements Command::parse() -The 'unsubscribe-from' command allows to unsubscribe from an IMAP-Mailbox. More...
void	clear_source_stack (void)
	Free memory from the stack used for the souce command. More...

Variables
static struct ListHead	MuttrcStack = STAILQ_HEAD_INITIALIZER(MuttrcStack)

Detailed Description

Functions to parse commands in a config file.

Authors

• Michael R. Elkins
• g10 Code GmbH
• R Primus

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

Macro Definition Documentation

MAX_ERRS

#define MAX_ERRS   128

Definition at line 67 of file command_parse.c.

Enumeration Type Documentation

GroupState

enum GroupState

Type of email address group.

Enumerator
GS_NONE	Group is missing an argument.
GS_RX	Entry is a regular expression.
GS_ADDR	Entry is an address.

Definition at line 72 of file command_parse.c.

{
  GS_NONE, 
  GS_RX,   
  GS_ADDR, 
};

Function Documentation

is_function()

static bool is_function ( const char *  name )

static

Is the argument a neomutt function?

Parameters

name	Command name to be searched for

Return values

true	Function found
false	Function not found

Definition at line 85 of file command_parse.c.

{
  for (size_t i = 0; MenuNames[i].name; i++)
  {
    const struct Binding *b = km_get_table(MenuNames[i].value);
    if (!b)
      continue;

    for (int j = 0; b[j].name; j++)
      if (mutt_str_equal(name, b[j].name))
        return true;
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_grouplist()

int parse_grouplist	(	struct GroupList *	gl,
		struct Buffer *	buf,
		struct Buffer *	s,
		struct Buffer *	err
	)

Parse a group context.

Parameters

gl	GroupList to add to
buf	Temporary Buffer space
s	Buffer containing string to be parsed
err	Buffer for error messages

Return values

0	Success
-1	Error

Definition at line 109 of file command_parse.c.

{
  while (mutt_istr_equal(buf->data, "-group"))
  {
    if (!MoreArgs(s))
    {
      mutt_buffer_strcpy(err, _("-group: no group name"));
      return -1;
    }

    mutt_extract_token(buf, s, MUTT_TOKEN_NO_FLAGS);

    mutt_grouplist_add(gl, mutt_pattern_group(buf->data));

    if (!MoreArgs(s))
    {
      mutt_buffer_strcpy(err, _("out of arguments"));
      return -1;
    }

    mutt_extract_token(buf, s, MUTT_TOKEN_NO_FLAGS);
  }

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

source_rc()

int source_rc	(	const char *	rcfile_path,
		struct Buffer *	err
	)

Read an initialization file.

Parameters

rcfile_path	Path to initialization file
err	Buffer for error messages

Return values

<0	NeoMutt should pause to let the user know

Definition at line 142 of file command_parse.c.

{
  int lineno = 0, rc = 0, warnings = 0;
  enum CommandResult line_rc;
  struct Buffer *token = NULL, *linebuf = NULL;
  char *line = NULL;
  char *currentline = NULL;
  char rcfile[PATH_MAX];
  size_t linelen = 0;
  pid_t pid;

  mutt_str_copy(rcfile, rcfile_path, sizeof(rcfile));

  size_t rcfilelen = mutt_str_len(rcfile);
  if (rcfilelen == 0)
    return -1;

  bool ispipe = rcfile[rcfilelen - 1] == '|';

  if (!ispipe)
  {
    struct ListNode *np = STAILQ_FIRST(&MuttrcStack);
    if (!mutt_path_to_absolute(rcfile, np ? NONULL(np->data) : ""))
    {
      mutt_error(_("Error: Can't build path of '%s'"), rcfile_path);
      return -1;
    }

    STAILQ_FOREACH(np, &MuttrcStack, entries)
    {
      if (mutt_str_equal(np->data, rcfile))
      {
        break;
      }
    }
    if (np)
    {
      mutt_error(_("Error: Cyclic sourcing of configuration file '%s'"), rcfile);
      return -1;
    }

    mutt_list_insert_head(&MuttrcStack, mutt_str_dup(rcfile));
  }

  mutt_debug(LL_DEBUG2, "Reading configuration file '%s'\n", rcfile);

  FILE *fp = mutt_open_read(rcfile, &pid);
  if (!fp)
  {
    mutt_buffer_printf(err, "%s: %s", rcfile, strerror(errno));
    return -1;
  }

  token = mutt_buffer_pool_get();
  linebuf = mutt_buffer_pool_get();

  while ((line = mutt_file_read_line(line, &linelen, fp, &lineno, MUTT_RL_CONT)) != NULL)
  {
    const char *const c_config_charset =
        cs_subset_string(NeoMutt->sub, "config_charset");
    const char *const c_charset = cs_subset_string(NeoMutt->sub, "charset");
    const bool conv = c_config_charset && c_charset;
    if (conv)
    {
      currentline = mutt_str_dup(line);
      if (!currentline)
        continue;
      mutt_ch_convert_string(&currentline, c_config_charset, c_charset, MUTT_ICONV_NO_FLAGS);
    }
    else
      currentline = line;

    mutt_buffer_strcpy(linebuf, currentline);

    mutt_buffer_reset(err);
    line_rc = mutt_parse_rc_buffer(linebuf, token, err);
    if (line_rc == MUTT_CMD_ERROR)
    {
      mutt_error(_("Error in %s, line %d: %s"), rcfile, lineno, err->data);
      if (--rc < -MAX_ERRS)
      {
        if (conv)
          FREE(&currentline);
        break;
      }
    }
    else if (line_rc == MUTT_CMD_WARNING)
    {
      /* Warning */
      mutt_warning(_("Warning in %s, line %d: %s"), rcfile, lineno, err->data);
      warnings++;
    }
    else if (line_rc == MUTT_CMD_FINISH)
    {
      break; /* Found "finish" command */
    }
    else
    {
      if (rc < 0)
        rc = -1;
    }
    if (conv)
      FREE(&currentline);
  }

  FREE(&line);
  mutt_file_fclose(&fp);
  if (pid != -1)
    filter_wait(pid);

  if (rc)
  {
    /* the neomuttrc source keyword */
    mutt_buffer_reset(err);
    mutt_buffer_printf(err, (rc >= -MAX_ERRS) ? _("source: errors in %s") : _("source: reading aborted due to too many errors in %s"),
                       rcfile);
    rc = -1;
  }
  else
  {
    /* Don't alias errors with warnings */
    if (warnings > 0)
    {
      mutt_buffer_printf(err, ngettext("source: %d warning in %s", "source: %d warnings in %s", warnings),
                         warnings, rcfile);
      rc = -2;
    }
  }

  if (!ispipe && !STAILQ_EMPTY(&MuttrcStack))
  {
    struct ListNode *np = STAILQ_FIRST(&MuttrcStack);
    STAILQ_REMOVE_HEAD(&MuttrcStack, entries);
    FREE(&np->data);
    FREE(&np);
  }

  mutt_buffer_pool_release(&token);
  mutt_buffer_pool_release(&linebuf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

do_unmailboxes()

static void do_unmailboxes ( struct Mailbox *  m )

static

Remove a Mailbox from the Sidebar/notifications.

Parameters

m	Mailbox to unmailboxes

Definition at line 1478 of file command_parse.c.

{
#ifdef USE_INOTIFY
  mutt_monitor_remove(m);
#endif
  m->flags = MB_HIDDEN;
  m->gen = -1;
  if (m->opened)
  {
    struct EventMailbox ev_m = { NULL };
    mutt_debug(LL_NOTIFY, "NT_MAILBOX_SWITCH: NULL\n");
    notify_send(NeoMutt->notify, NT_MAILBOX, NT_MAILBOX_SWITCH, &ev_m);
  }
  else
  {
    account_mailbox_remove(m->account, m);
    mailbox_free(&m);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

do_unmailboxes_star()

static void do_unmailboxes_star ( void  )

static

Remove all Mailboxes from the Sidebar/notifications.

Definition at line 1501 of file command_parse.c.

{
  struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
  neomutt_mailboxlist_get_all(&ml, NeoMutt, MUTT_MAILBOX_ANY);
  struct MailboxNode *np = NULL;
  struct MailboxNode *nptmp = NULL;
  STAILQ_FOREACH_SAFE(np, &ml, entries, nptmp)
  {
    do_unmailboxes(np->mailbox);
  }
  neomutt_mailboxlist_clear(&ml);
}

Here is the call graph for this function:

Here is the caller graph for this function:

clear_source_stack()

void clear_source_stack

(

void

)

Free memory from the stack used for the souce command.

Definition at line 1686 of file command_parse.c.

{
  mutt_list_free(&MuttrcStack);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MuttrcStack

struct ListHead MuttrcStack = STAILQ_HEAD_INITIALIZER(MuttrcStack)

static

Definition at line 65 of file command_parse.c.