neomutt.c File Reference

Container for Accounts, Notifications. More...

#include "config.h"
#include <errno.h>
#include <locale.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "neomutt.h"
#include "account.h"
#include "command.h"
#include "mailbox.h"
#include "module_api.h"
#include "muttlib.h"

Include dependency graph for neomutt.c:

Go to the source code of this file.

Macros
#define	CONFIG_INIT_TYPE(CS, NAME)
	Register a config type in the config set.
#define	CONFIG_INIT_VARS(CS, NAME)
	Initialize config variables for a subsystem.

Functions
static bool	init_env (struct NeoMutt *n, char **envp)
	Initialise the Environment.
static bool	init_locale (struct NeoMutt *n)
	Initialise the Locale/NLS settings.
static void	localise_config (struct ConfigSet *cs)
	Localise some config.
static void	reset_tilde (struct ConfigSet *cs)
	Temporary measure.
static bool	init_config (struct NeoMutt *n)
	Initialise the config system.
static bool	init_commands (struct NeoMutt *n)
	Initialise the NeoMutt commands.
static bool	init_modules (struct NeoMutt *n)
	Initialise the Modules.
struct NeoMutt *	neomutt_new (void)
	Create the main NeoMutt object.
bool	neomutt_init (struct NeoMutt *n, char **envp, const struct Module **modules)
	Initialise NeoMutt.
static bool	cleanup_modules (struct NeoMutt *n)
	Clean up each of the Modules.
void	neomutt_cleanup (struct NeoMutt *n)
	Clean up NeoMutt and Modules.
void	neomutt_free (struct NeoMutt **ptr)
	Free a NeoMutt.
bool	neomutt_account_add (struct NeoMutt *n, struct Account *a)
	Add an Account to the global list.
void	neomutt_account_remove (struct NeoMutt *n, struct Account *a)
	Remove an Account from the global list.
void	neomutt_accounts_free (struct NeoMutt *n)
struct MailboxArray	neomutt_mailboxes_get (struct NeoMutt *n, enum MailboxType type)
	Get an Array of matching Mailboxes.
FILE *	mutt_file_fopen_masked_full (const char *path, const char *mode, const char *file, int line, const char *func)
	Wrapper around mutt_file_fopen_full()
void *	neomutt_get_module_data (struct NeoMutt *n, enum ModuleId id)
	Get the private data for a Module.
void	neomutt_set_module_data (struct NeoMutt *n, enum ModuleId id, void *data)
	Set the private data for a Module.

Variables
struct NeoMutt *	NeoMutt = NULL
	Global NeoMutt object.

Detailed Description

Container for Accounts, Notifications.

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

Macro Definition Documentation

CONFIG_INIT_TYPE

#define CONFIG_INIT_TYPE	(		CS,
			NAME )

Value:

  extern const struct ConfigSetType Cst##NAME;                                 \
  cs_register_type(CS, &Cst##NAME)

Register a config type in the config set.

Definition at line 50 of file neomutt.c.

#define CONFIG_INIT_TYPE(CS, NAME)                                             \
  extern const struct ConfigSetType Cst##NAME;                                 \
  cs_register_type(CS, &Cst##NAME)

CONFIG_INIT_VARS

#define CONFIG_INIT_VARS	(		CS,
			NAME )

Value:

  bool config_init_##NAME(struct ConfigSet *cs);                               \
  config_init_##NAME(CS)

Initialize config variables for a subsystem.

Definition at line 55 of file neomutt.c.

#define CONFIG_INIT_VARS(CS, NAME)                                             \
  bool config_init_##NAME(struct ConfigSet *cs);                               \
  config_init_##NAME(CS)

Function Documentation

init_env()

static bool init_env ( struct NeoMutt * n, char ** envp )

static

Initialise the Environment.

Parameters

n	NeoMutt
envp	External environment

Return values

true

Success

Definition at line 65 of file neomutt.c.

{
  if (!n)
    return false;
 
  mutt_str_replace(&n->username, mutt_str_getenv("USER"));
  mutt_str_replace(&n->home_dir, mutt_str_getenv("HOME"));
 
  envlist_free(&n->env);
  n->env = envlist_init(envp);
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

init_locale()

static bool init_locale ( struct NeoMutt * n )

static

Initialise the Locale/NLS settings.

Parameters

n

NeoMutt

Return values

true

Success

Definition at line 84 of file neomutt.c.

{
  if (!n)
    return false;
 
  setlocale(LC_ALL, "");
 
#ifdef ENABLE_NLS
  const char *domdir = mutt_str_getenv("TEXTDOMAINDIR");
  if (domdir)
    bindtextdomain(PACKAGE, domdir);
  else
    bindtextdomain(PACKAGE, MUTTLOCALEDIR);
  textdomain(PACKAGE);
#endif
 
  n->time_c_locale = duplocale(LC_GLOBAL_LOCALE);
  if (n->time_c_locale)
    n->time_c_locale = newlocale(LC_TIME_MASK, "C", n->time_c_locale);
 
  if (!n->time_c_locale)
  {
    mutt_error("%s", strerror(errno)); // LCOV_EXCL_LINE
    return false;                      // LCOV_EXCL_LINE
  }
 
#ifndef LOCALES_HACK
  /* Do we have a locale definition? */
  if (mutt_str_getenv("LC_ALL") || mutt_str_getenv("LANG") || mutt_str_getenv("LC_CTYPE"))
  {
    OptLocales = true;
  }
#endif
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

localise_config()

static void localise_config ( struct ConfigSet * cs )

static

Localise some config.

Parameters

cs	Config Set

Definition at line 126 of file neomutt.c.

{
  struct Buffer *value = buf_pool_get();
  struct HashElemArray hea = get_elem_list(cs, GEL_ALL_CONFIG);
  struct HashElem **hep = NULL;
 
  ARRAY_FOREACH(hep, &hea)
  {
    struct HashElem *he = *hep;
    if (!(he->type & D_L10N_STRING))
      continue;
 
    buf_reset(value);
    cs_he_initial_get(cs, he, value);
 
    // Lookup the translation
    const char *l10n = gettext(buf_string(value));
    config_he_set_initial(cs, he, l10n);
  }
 
  ARRAY_FREE(&hea);
  buf_pool_release(&value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

reset_tilde()

static void reset_tilde ( struct ConfigSet * cs )

static

Temporary measure.

Parameters

cs	Config Set

Definition at line 155 of file neomutt.c.

{
  static const char *names[] = { "folder", "mbox", "postponed", "record" };
 
  struct Buffer *value = buf_pool_get();
  for (size_t i = 0; i < countof(names); i++)
  {
    struct HashElem *he = cs_get_elem(cs, names[i]);
    if (!he)
      continue;
    buf_reset(value);
    cs_he_initial_get(cs, he, value);
    expand_path(value, false);
    config_he_set_initial(cs, he, value->data);
  }
  buf_pool_release(&value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

init_config()

static bool init_config ( struct NeoMutt * n )

static

Initialise the config system.

Parameters

n

Neomutt

Return values

true

Success

Set up the config variables in three stages:

• Create the config types
• Create the config variables
• Set some run-time defaults

Definition at line 183 of file neomutt.c.

{
  if (!n)
    return false;
 
  n->cs = cs_new(500);
 
  n->sub = cs_subset_new(NULL, NULL, n->notify);
  n->sub->scope = SET_SCOPE_NEOMUTT;
  n->sub->cs = n->cs;
 
  bool rc = true;
 
  // Set up the Config Types
  for (enum ModuleId id = MODULE_ID_MAIN; id < MODULE_ID_MAX; id++)
  {
    const struct Module *mod = n->modules[id];
    if (!mod)
      continue;
 
    if (mod->config_define_types)
    {
      mutt_debug(LL_DEBUG3, "%s:config_define_types()\n", mod->name);
      rc &= mod->config_define_types(n, n->sub->cs);
    }
  }
 
  if (!rc)
    return false;
 
  // Define the Config Variables
  for (enum ModuleId id = MODULE_ID_MAIN; id < MODULE_ID_MAX; id++)
  {
    const struct Module *mod = n->modules[id];
    if (!mod)
      continue;
 
    if (mod->config_define_variables)
    {
      mutt_debug(LL_DEBUG3, "%s:config_define_variables()\n", mod->name);
      rc &= mod->config_define_variables(n, n->sub->cs);
    }
  }
 
  if (!rc)
    return false;
 
  // Post-processing
#ifdef ENABLE_NLS
  localise_config(n->sub->cs);
#endif
  reset_tilde(n->sub->cs);
 
  /* Unset suspend by default if we're the session leader */
  if (getsid(0) == getpid())
    config_str_set_initial(n->sub->cs, "suspend", "no");
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

init_commands()

static bool init_commands ( struct NeoMutt * n )

static

Initialise the NeoMutt commands.

Parameters

n

Neomutt

Return values

true

Success

Definition at line 248 of file neomutt.c.

{
  if (!n)
    return false;
 
  struct CommandArray *ca = &n->commands;
 
  bool rc = true;
 
  // Set up the Config Types
  for (enum ModuleId id = MODULE_ID_MAIN; id < MODULE_ID_MAX; id++)
  {
    const struct Module *mod = n->modules[id];
    if (!mod)
      continue;
 
    if (mod->commands_register)
    {
      mutt_debug(LL_DEBUG3, "%s:commands_register()\n", mod->name);
      rc &= mod->commands_register(n, ca);
    }
  }
 
  return rc;
}

Here is the caller graph for this function:

init_modules()

static bool init_modules ( struct NeoMutt * n )

static

Initialise the Modules.

Parameters

n

Neomutt

Return values

true

Success

Definition at line 279 of file neomutt.c.

{
  if (!n)
    return false;
 
  bool rc = true;
 
  // Initialise the Modules
  for (enum ModuleId id = MODULE_ID_MAIN; id < MODULE_ID_MAX; id++)
  {
    const struct Module *mod = n->modules[id];
    if (!mod)
      continue;
 
    if (mod->init)
    {
      mutt_debug(LL_DEBUG3, "%s:init()\n", mod->name);
      rc &= mod->init(n);
    }
  }
 
  return rc;
}

Here is the caller graph for this function:

neomutt_new()

struct NeoMutt * neomutt_new

(

void

)

Create the main NeoMutt object.

Return values

ptr	New NeoMutt

Definition at line 307 of file neomutt.c.

{
  return MUTT_MEM_CALLOC(1, struct NeoMutt);
}

Here is the caller graph for this function:

neomutt_init()

bool neomutt_init	(	struct NeoMutt *	n,
		char **	envp,
		const struct Module **	modules )

Initialise NeoMutt.

Parameters

n	NeoMutt
envp	External environment
modules	Library modules to initialise

Return values

true

Success

Definition at line 319 of file neomutt.c.

{
  if (!n || !modules)
    return false;
 
  for (int i = 0; modules[i]; i++)
  {
    const struct Module *mod = modules[i];
 
    n->modules[mod->mid] = mod;
  }
 
  if (!init_env(n, envp))
    return false;
 
  if (!init_locale(n))
    return false;
 
  if (!init_config(n))
    return false;
 
  if (!init_commands(n))
    return false;
 
  if (!init_modules(n))
    return false;
 
  ARRAY_INIT(&n->accounts);
  n->notify = notify_new();
  notify_set_parent(n->sub->notify, n->notify);
 
  n->notify_timeout = notify_new();
  notify_set_parent(n->notify_timeout, n->notify);
 
  n->notify_resize = notify_new();
  notify_set_parent(n->notify_resize, n->notify);
 
  n->groups = groups_new();
 
  // Change the current umask, and save the original one
  n->user_default_umask = umask(077);
  mutt_debug(LL_DEBUG1, "user's umask %03o\n", n->user_default_umask);
  mutt_debug(LL_DEBUG3, "umask set to 077\n");
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cleanup_modules()

static bool cleanup_modules ( struct NeoMutt * n )

static

Clean up each of the Modules.

Parameters

n

NeoMutt

Return values

true

Success

Definition at line 371 of file neomutt.c.

{
  if (!n)
    return false;
 
  bool rc = true;
 
  // Cleanup the Modules
  for (enum ModuleId id = MODULE_ID_MAIN; id < MODULE_ID_MAX; id++)
  {
    const struct Module *mod = n->modules[id];
    if (!mod)
      continue;
 
    if (mod->cleanup)
    {
      mutt_debug(LL_DEBUG3, "%s:cleanup()\n", mod->name);
      rc &= mod->cleanup(n);
    }
 
    if (n->module_data[mod->mid])
    {
      mutt_debug(LL_DEBUG1, "Module %s didn't clean up its data\n", mod->name);
      rc = false;
    }
  }
 
  return rc;
}

Here is the caller graph for this function:

neomutt_cleanup()

void neomutt_cleanup

(

struct NeoMutt *

n

)

Clean up NeoMutt and Modules.

Parameters

n

NeoMutt

Definition at line 405 of file neomutt.c.

{
  if (!n)
    return;
 
  commands_clear(&n->commands);
  cleanup_modules(n);
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_free()

void neomutt_free

(

struct NeoMutt **

ptr

)

Free a NeoMutt.

Parameters

[out]

ptr

NeoMutt to free

Definition at line 418 of file neomutt.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct NeoMutt *n = *ptr;
 
  neomutt_accounts_free(n);
 
  if (n->sub)
  {
    struct ConfigSet *cs = n->sub->cs;
    cs_subset_free(&n->sub);
    cs_free(&cs);
  }
 
  notify_free(&n->notify_resize);
  notify_free(&n->notify_timeout);
  notify_free(&n->notify);
  if (n->time_c_locale)
    freelocale(n->time_c_locale);
 
  groups_free(&n->groups);
 
  FREE(&n->home_dir);
  FREE(&n->username);
 
  envlist_free(&n->env);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_account_add()

bool neomutt_account_add	(	struct NeoMutt *	n,
		struct Account *	a )

Add an Account to the global list.

Parameters

n	NeoMutt
a	Account to add

Return values

true	Account was added

Definition at line 456 of file neomutt.c.

{
  if (!n || !a)
    return false;
 
  ARRAY_ADD(&n->accounts, a);
  notify_set_parent(a->notify, n->notify);
 
  mutt_debug(LL_NOTIFY, "NT_ACCOUNT_ADD: %s %p\n",
             mailbox_get_type_name(a->type), (void *) a);
  struct EventAccount ev_a = { a };
  notify_send(n->notify, NT_ACCOUNT, NT_ACCOUNT_ADD, &ev_a);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_account_remove()

void neomutt_account_remove	(	struct NeoMutt *	n,
		struct Account *	a )

Remove an Account from the global list.

Parameters

n	NeoMutt
a	Account to remove

Definition at line 476 of file neomutt.c.

{
  if (!n || !a || ARRAY_EMPTY(&n->accounts))
    return;
 
  struct Account **ap = NULL;
  ARRAY_FOREACH(ap, &n->accounts)
  {
    if ((*ap) != a)
      continue;
 
    ARRAY_REMOVE(&n->accounts, ap);
    account_free(&a);
    break;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_accounts_free()

void neomutt_accounts_free

(

struct NeoMutt *

n

)

• Free all the Accounts

  Parameters

  n

  NeoMutt

Definition at line 497 of file neomutt.c.

{
  if (!n)
    return;
 
  if (!ARRAY_EMPTY(&n->accounts))
  {
    mutt_debug(LL_NOTIFY, "NT_ACCOUNT_DELETE_ALL\n");
    struct EventAccount ev_a = { NULL };
    notify_send(n->notify, NT_ACCOUNT, NT_ACCOUNT_DELETE_ALL, &ev_a);
 
    struct Account **ap = NULL;
    ARRAY_FOREACH(ap, &n->accounts)
    {
      account_free(ap);
    }
  }
 
  ARRAY_FREE(&n->accounts);
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_mailboxes_get()

struct MailboxArray neomutt_mailboxes_get	(	struct NeoMutt *	n,
		enum MailboxType	type )

Get an Array of matching Mailboxes.

Parameters

n	NeoMutt
type	Type of Account to match, see MailboxType

Return values

obj	Array of Mailboxes

Note

If type is MUTT_MAILBOX_ANY then all Mailbox types will be matched

Definition at line 526 of file neomutt.c.

{
  struct MailboxArray ma = ARRAY_HEAD_INITIALIZER;
 
  if (!n)
    return ma;
 
  struct Account **ap = NULL;
  struct Mailbox **mp = NULL;
 
  ARRAY_FOREACH(ap, &n->accounts)
  {
    struct Account *a = *ap;
    if ((type > MUTT_UNKNOWN) && (a->type != type))
      continue;
 
    ARRAY_FOREACH(mp, &a->mailboxes)
    {
      ARRAY_ADD(&ma, *mp);
    }
  }
 
  return ma;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_file_fopen_masked_full()

FILE * mutt_file_fopen_masked_full	(	const char *	path,
		const char *	mode,
		const char *	file,
		int	line,
		const char *	func )

Wrapper around mutt_file_fopen_full()

Parameters

path	Filename
mode	Mode e.g. "r" readonly; "w" read-write
file	Source file
line	Source line number
func	Source function

Return values

ptr	FILE handle
NULL	Error, see errno

Apply the user's umask, then call mutt_file_fopen_full().

Definition at line 563 of file neomutt.c.

{
  // Set the user's umask (saved on startup)
  mode_t old_umask = umask(NeoMutt->user_default_umask);
  mutt_debug(LL_DEBUG3, "umask set to %03o\n", NeoMutt->user_default_umask);
 
  // The permissions will be limited by the umask
  FILE *fp = mutt_file_fopen_full(path, mode, 0666, file, line, func);
 
  umask(old_umask); // Immediately restore the umask
  mutt_debug(LL_DEBUG3, "umask set to %03o\n", old_umask);
 
  return fp;
}

Here is the call graph for this function:

neomutt_get_module_data()

void * neomutt_get_module_data	(	struct NeoMutt *	n,
		enum ModuleId	id )

Get the private data for a Module.

Parameters

n	NeoMutt
id	Module Id

Return values

ptr	Private Module data

Definition at line 585 of file neomutt.c.

{
  if (!n)
    return NULL;
 
  return n->module_data[id];
}

neomutt_set_module_data()

void neomutt_set_module_data	(	struct NeoMutt *	n,
		enum ModuleId	id,
		void *	data )

Set the private data for a Module.

Parameters

n	NeoMutt
id	Module Id
data	Private Module data

Definition at line 599 of file neomutt.c.

{
  if (!n)
    return;
 
  n->module_data[id] = data;
}

Here is the caller graph for this function:

Variable Documentation

NeoMutt

struct NeoMutt* NeoMutt = NULL

Global NeoMutt object.

Definition at line 47 of file neomutt.c.