Validate a config variable. More...

Collaboration diagram for validator():

Functions
int	charset_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "charset" config variable - Implements ConfigDef::validator() -. More...

int	charset_slist_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "charset" config variable - Implements ConfigDef::validator() - This is a version for charset options is Slist. More...

static int	hcache_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "header_cache_backend" config variable - Implements ConfigDef::validator() -. More...

static int	compress_method_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "header_cache_compress_method" config variable - Implements ConfigDef::validator() -. More...

static int	compress_level_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "header_cache_compress_level" config variable - Implements ConfigDef::validator() -. More...

static int	imap_auth_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "imap_authenticators" config variable - Implements ConfigDef::validator() -. More...

static int	multipart_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "show_multipart_alternative" config variable - Implements ConfigDef::validator() -. More...

static int	reply_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "reply_regex" config variable - Implements ConfigDef::validator() -. More...

int	level_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "debug_level" config variable - Implements ConfigDef::validator() -. More...

int	sort_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate values of "sort" - Implements ConfigDef::validator() -. More...

static int	nm_default_url_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Ensure nm_default_url is of the form notmuch://[absolute path] - Implements ConfigDef::validator() -. More...

static int	nm_query_window_timebase_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Ensures nm_query_window_timebase matches allowed values - Implements ConfigDef::validator() -. More...

static int	pop_auth_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "pop_authenticators" config variable - Implements ConfigDef::validator() -. More...

static int	wrapheaders_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "wrap_headers" config variable - Implements ConfigDef::validator() -. More...

static int	smtp_auth_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "smtp_authenticators" config variable - Implements ConfigDef::validator() -. More...

static int	simple_command_validator (const struct ConfigSet cs, const struct ConfigDef cdef, intptr_t value, struct Buffer *err)
	Validate the "sendmail" and "inews" config variables - Implements ConfigDef::validator() -. More...

Detailed Description

Validate a config variable.

Parameters

cs	Config items
cdef	Config definition
value	Native value
err	Message for the user

Return values

CSR_SUCCESS	Success
CSR_ERR_INVALID	Failure

Function Documentation

◆ charset_validator()

int charset_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "charset" config variable - Implements ConfigDef::validator() -.

Definition at line 40 of file charset.c.

{
  if (value == 0)
    return CSR_SUCCESS;
 
  const char *str = (const char *) value;
 
  if ((cdef->type & DT_CHARSET_SINGLE) && strchr(str, ':'))
  {
    mutt_buffer_printf(err, _("'charset' must contain exactly one character set name"));
    return CSR_ERR_INVALID;
  }
 
  int rc = CSR_SUCCESS;
  bool strict = (cdef->type & DT_CHARSET_STRICT);
  char *q = NULL;
  char *s = mutt_str_dup(str);
 
  for (char *p = strtok_r(s, ":", &q); p; p = strtok_r(NULL, ":", &q))
  {
    if (*p == '\0')
      continue; // LCOV_EXCL_LINE
    if (!mutt_ch_check_charset(p, strict))
    {
      rc = CSR_ERR_INVALID;
      mutt_buffer_printf(err, _("Invalid value for option %s: %s"), cdef->name, p);
      break;
    }
  }
 
  FREE(&s);
  return rc;
}

Here is the call graph for this function:

◆ charset_slist_validator()

int charset_slist_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "charset" config variable - Implements ConfigDef::validator() - This is a version for charset options is Slist.

Definition at line 79 of file charset.c.

{
  if (value == 0)
    return CSR_SUCCESS;
 
  const struct Slist *list = (const struct Slist *) value;
 
  int rc = CSR_SUCCESS;
  bool strict = (cdef->type & DT_CHARSET_STRICT);
 
  const struct ListNode *np = NULL;
  STAILQ_FOREACH(np, &list->head, entries)
  {
    char const *charset = np->data;
    if (!mutt_ch_check_charset(charset, strict))
    {
      rc = CSR_ERR_INVALID;
      mutt_buffer_printf(err, _("Invalid value for option %s: %s"), cdef->name, charset);
      break;
    }
  }
 
  return rc;
}

Here is the call graph for this function:

◆ hcache_validator()

static int hcache_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "header_cache_backend" config variable - Implements ConfigDef::validator() -.

Definition at line 42 of file config.c.

{
#ifdef USE_HCACHE
  if (value == 0)
    return CSR_SUCCESS;
 
  const char *str = (const char *) value;
 
  if (store_is_valid_backend(str))
    return CSR_SUCCESS;
 
  mutt_buffer_printf(err, _("Invalid value for option %s: %s"), cdef->name, str);
  return CSR_ERR_INVALID;
#else
  return CSR_SUCCESS;
#endif
}

Here is the call graph for this function:

◆ compress_method_validator()

static int compress_method_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "header_cache_compress_method" config variable - Implements ConfigDef::validator() -.

Definition at line 65 of file config.c.

{
#ifdef USE_HCACHE_COMPRESSION
  if (value == 0)
    return CSR_SUCCESS;
 
  const char *str = (const char *) value;
 
  if (compress_get_ops(str))
    return CSR_SUCCESS;
 
  mutt_buffer_printf(err, _("Invalid value for option %s: %s"), cdef->name, str);
  return CSR_ERR_INVALID;
#else
  return CSR_SUCCESS;
#endif
}

Here is the call graph for this function:

◆ compress_level_validator()

static int compress_level_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "header_cache_compress_level" config variable - Implements ConfigDef::validator() -.

Definition at line 88 of file config.c.

{
#ifdef USE_HCACHE_COMPRESSION
  const char *const c_header_cache_compress_method = cs_subset_string(NeoMutt->sub, "header_cache_compress_method");
  if (!c_header_cache_compress_method)
  {
    mutt_buffer_printf(err, _("Set option %s before setting %s"),
                       "header_cache_compress_method", cdef->name);
    return CSR_ERR_INVALID;
  }
 
  const struct ComprOps *cops = compress_get_ops(c_header_cache_compress_method);
  if (!cops)
  {
    mutt_buffer_printf(err, _("Invalid value for option %s: %s"),
                       "header_cache_compress_method", c_header_cache_compress_method);
    return CSR_ERR_INVALID;
  }
 
  if ((value < cops->min_level) || (value > cops->max_level))
  {
    // L10N: This applies to the "$header_cache_compress_level" config variable.
    //       It shows the minimum and maximum values, e.g. 'between 1 and 22'
    mutt_buffer_printf(err, _("Option %s must be between %d and %d inclusive"),
                       cdef->name, cops->min_level, cops->max_level);
    return CSR_ERR_INVALID;
  }
#endif
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ imap_auth_validator()

static int imap_auth_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "imap_authenticators" config variable - Implements ConfigDef::validator() -.

Definition at line 43 of file config.c.

{
  const struct Slist *imap_auth_methods = (const struct Slist *) value;
  if (!imap_auth_methods || (imap_auth_methods->count == 0))
    return CSR_SUCCESS;
 
  struct ListNode *np = NULL;
  STAILQ_FOREACH(np, &imap_auth_methods->head, entries)
  {
    if (imap_auth_is_valid(np->data))
      continue;
#ifdef USE_SASL_CYRUS
    if (sasl_auth_validator(np->data))
      continue;
#endif
    mutt_buffer_printf(err, _("Option %s: %s is not a valid authenticator"),
                       cdef->name, np->data);
    return CSR_ERR_INVALID;
  }
 
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ multipart_validator()

static int multipart_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "show_multipart_alternative" config variable - Implements ConfigDef::validator() -.

Definition at line 98 of file mutt_config.c.

{
  if (value == 0)
    return CSR_SUCCESS;
 
  const char *str = (const char *) value;
 
  if (mutt_str_equal(str, "inline") || mutt_str_equal(str, "info"))
    return CSR_SUCCESS;
 
  mutt_buffer_printf(err, _("Invalid value for option %s: %s"), cdef->name, str);
  return CSR_ERR_INVALID;
}

Here is the call graph for this function:

◆ reply_validator()

static int reply_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "reply_regex" config variable - Implements ConfigDef::validator() -.

Definition at line 116 of file mutt_config.c.

{
  if (!OptAttachMsg)
    return CSR_SUCCESS;
 
  mutt_buffer_printf(err, _("Option %s may not be set when in attach-message mode"),
                     cdef->name);
  return CSR_ERR_INVALID;
}

Here is the call graph for this function:

◆ level_validator()

int level_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "debug_level" config variable - Implements ConfigDef::validator() -.

Definition at line 272 of file mutt_logging.c.

{
  if ((value < 0) || (value >= LL_MAX))
  {
    mutt_buffer_printf(err, _("Invalid value for option %s: %ld"), cdef->name, value);
    return CSR_ERR_INVALID;
  }
 
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ sort_validator()

int sort_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate values of "sort" - Implements ConfigDef::validator() -.

Definition at line 115 of file mutt_thread.c.

{
  if (((value & SORT_MASK) == SORT_THREADS) && (value & SORT_LAST))
  {
    mutt_buffer_printf(err, _("Cannot use 'last-' prefix with 'threads' for %s"), cdef->name);
    return CSR_ERR_INVALID;
  }
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ nm_default_url_validator()

static int nm_default_url_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Ensure nm_default_url is of the form notmuch://[absolute path] - Implements ConfigDef::validator() -.

Definition at line 53 of file config.c.

{
#ifdef USE_NOTMUCH
  const char *url = (const char *) value;
  if (!is_valid_notmuch_url(url))
  {
    mutt_buffer_printf(err, _("nm_default_url must be: notmuch://<absolute path> . Current: %s"),
                       url);
    return CSR_ERR_INVALID;
  }
#endif
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ nm_query_window_timebase_validator()

static int nm_query_window_timebase_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Ensures nm_query_window_timebase matches allowed values - Implements ConfigDef::validator() -.

Allowed values:

hour
day
week
month
year

Definition at line 78 of file config.c.

{
#ifdef USE_NOTMUCH
  const char *timebase = (const char *) value;
  if (!nm_query_window_check_timebase(timebase))
  {
    mutt_buffer_printf(
        // L10N: The values 'hour', 'day', 'week', 'month', 'year' are literal.
        //       They should not be translated.
        err, _("Invalid nm_query_window_timebase value (valid values are: "
               "hour, day, week, month, year)"));
    return CSR_ERR_INVALID;
  }
#endif
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ pop_auth_validator()

static int pop_auth_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "pop_authenticators" config variable - Implements ConfigDef::validator() -.

Definition at line 41 of file config.c.

{
  const struct Slist *pop_auth_methods = (const struct Slist *) value;
  if (!pop_auth_methods || (pop_auth_methods->count == 0))
    return CSR_SUCCESS;
 
  struct ListNode *np = NULL;
  STAILQ_FOREACH(np, &pop_auth_methods->head, entries)
  {
    if (pop_auth_is_valid(np->data))
      continue;
#ifdef USE_SASL_CYRUS
    if (sasl_auth_validator(np->data))
      continue;
#endif
    mutt_buffer_printf(err, _("Option %s: %s is not a valid authenticator"),
                       cdef->name, np->data);
    return CSR_ERR_INVALID;
  }
 
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ wrapheaders_validator()

static int wrapheaders_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "wrap_headers" config variable - Implements ConfigDef::validator() -.

Definition at line 44 of file config.c.

{
  const int min_length = 78; // Recommendations from RFC5233
  const int max_length = 998;
 
  if ((value >= min_length) && (value <= max_length))
    return CSR_SUCCESS;
 
  // L10N: This applies to the "$wrap_headers" config variable.
  mutt_buffer_printf(err, _("Option %s must be between %d and %d inclusive"),
                     cdef->name, min_length, max_length);
  return CSR_ERR_INVALID;
}

Here is the call graph for this function:

◆ smtp_auth_validator()

static int smtp_auth_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "smtp_authenticators" config variable - Implements ConfigDef::validator() -.

Definition at line 62 of file config.c.

{
  const struct Slist *smtp_auth_methods = (const struct Slist *) value;
  if (!smtp_auth_methods || (smtp_auth_methods->count == 0))
    return CSR_SUCCESS;
 
  struct ListNode *np = NULL;
  STAILQ_FOREACH(np, &smtp_auth_methods->head, entries)
  {
    if (smtp_auth_is_valid(np->data))
      continue;
#ifdef USE_SASL_CYRUS
    if (sasl_auth_validator(np->data))
      continue;
#endif
    mutt_buffer_printf(err, _("Option %s: %s is not a valid authenticator"),
                       cdef->name, np->data);
    return CSR_ERR_INVALID;
  }
 
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ simple_command_validator()

static int simple_command_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Validate the "sendmail" and "inews" config variables - Implements ConfigDef::validator() -.

Definition at line 89 of file config.c.

{
  // Check for shell metacharacters that won't do what the user expects
  const char *valstr = (const char *) value;
  if (!valstr)
    return CSR_SUCCESS;
 
  const char c = valstr[strcspn(valstr, "|&;()<>[]{}$`'~\"\\*?")];
  if (c == '\0')
    return CSR_SUCCESS;
 
  // L10N: This applies to the "$sendmail" and "$inews" config variables.
  mutt_buffer_printf(err, _("Option %s must not contain shell metacharacters: %c"),
                     cdef->name, c);
  return CSR_ERR_INVALID;
}

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ charset_validator()

◆ charset_slist_validator()

◆ hcache_validator()

◆ compress_method_validator()

◆ compress_level_validator()

◆ imap_auth_validator()

◆ multipart_validator()

◆ reply_validator()

◆ level_validator()

◆ sort_validator()

◆ nm_default_url_validator()

◆ nm_query_window_timebase_validator()

◆ pop_auth_validator()

◆ wrapheaders_validator()

◆ smtp_auth_validator()

◆ simple_command_validator()