conn_2module_8c_source.html

#include "config.h"

#include <stdbool.h>

#include <stddef.h>

#include "mutt/lib.h"

#include "config/lib.h"

#include "core/lib.h"

#ifdef USE_SASL_GNU

#include "gsasl2.h"

#endif

#ifdef USE_SASL_CYRUS

#include "sasl.h"

#endif

#include "module_data.h"


extern struct ConfigDef ConnVars[];

extern struct ConfigDef ConnVarsGetaddr[];

extern struct ConfigDef ConnVarsGnutls[];

extern struct ConfigDef ConnVarsOpenssl[];

extern struct ConfigDef ConnVarsPartial[];

extern struct ConfigDef ConnVarsSsl[];


static bool conn_init(struct NeoMutt *n)

{

  struct ConnModuleData *mod_data = MUTT_MEM_CALLOC(1, struct ConnModuleData);

  neomutt_set_module_data(n, MODULE_ID_CONN, mod_data);


#ifdef USE_SSL_OPENSSL

  mod_data->host_ex_data_index = -1;

  mod_data->skip_mode_ex_data_index = -1;

#endif


  mod_data->notify = notify_new();

  notify_set_parent(mod_data->notify, n->notify);


  return true;

}


static bool conn_config_define_variables(struct NeoMutt *n, struct ConfigSet *cs)

{

  bool rc = true;


  rc &= cs_register_variables(cs, ConnVars);


#if defined(USE_SSL)

  rc &= cs_register_variables(cs, ConnVarsSsl);

#endif


#if defined(USE_SSL_GNUTLS)

  rc &= cs_register_variables(cs, ConnVarsGnutls);

#endif


#if defined(USE_SSL_OPENSSL)

  rc &= cs_register_variables(cs, ConnVarsOpenssl);

#endif


#if defined(HAVE_SSL_PARTIAL_CHAIN)

  rc &= cs_register_variables(cs, ConnVarsPartial);

#endif


#if defined(HAVE_GETADDRINFO)

  rc &= cs_register_variables(cs, ConnVarsGetaddr);

#endif


  return rc;

}


static bool conn_cleanup(struct NeoMutt *n, void *data)

{

  struct ConnModuleData *mod_data = data;


  notify_free(&mod_data->notify);


#ifdef USE_SASL_CYRUS

  mutt_sasl_cleanup();

#endif

#ifdef USE_SASL_GNU

  mutt_gsasl_cleanup(&mod_data->mutt_gsasl_ctx);

#endif


#ifdef USE_SASL_CYRUS

  FREE(&mod_data->mutt_sasl_callbacks);

  FREE(&mod_data->secret_ptr);

#endif

  FREE(&mod_data);

  return true;

}


const struct Module ModuleConn = {

  MODULE_ID_CONN,

  "conn",

  conn_init,

  NULL, // config_define_types

  conn_config_define_variables,

  NULL, // commands_register

  NULL, // gui_init

  NULL, // gui_cleanup

  conn_cleanup,

};


lib.h
Convenience wrapper for the config headers.

cs_register_variables
bool cs_register_variables(const struct ConfigSet *cs, struct ConfigDef vars[])
Register a set of config items.
Definition set.c:290

ConnVarsSsl
struct ConfigDef ConnVarsSsl[]
General SSL Config definitions for the conn library.
Definition config.c:66

ConnVars
struct ConfigDef ConnVars[]
Config definitions for the connection library.
Definition config.c:39

ConnVarsOpenssl
struct ConfigDef ConnVarsOpenssl[]
OpenSSL Config definitions for the connection library.
Definition config.c:125

ConnVarsPartial
struct ConfigDef ConnVarsPartial[]
SSL partial chains Config definitions for the connection library.
Definition config.c:145

ConnVarsGetaddr
struct ConfigDef ConnVarsGetaddr[]
GetAddrInfo Config definitions for the connection library.
Definition config.c:159

ConnVarsGnutls
struct ConfigDef ConnVarsGnutls[]
GnuTLS Config definitions for the connection library.
Definition config.c:108

conn_cleanup
static bool conn_cleanup(struct NeoMutt *n, void *data)
Clean up a Module - Implements Module::cleanup()
Definition module.c:104

ModuleConn
const struct Module ModuleConn
Module for the Conn library.
Definition module.c:128

conn_config_define_variables
static bool conn_config_define_variables(struct NeoMutt *n, struct ConfigSet *cs)
Define the Config Variables - Implements Module::config_define_variables()
Definition module.c:72

conn_init
static bool conn_init(struct NeoMutt *n)
Initialise a Module - Implements Module::init()
Definition module.c:53

module_data.h
Conn private Module data.

lib.h
Convenience wrapper for the core headers.

gsasl2.h
GNU SASL authentication support.

mutt_gsasl_cleanup
void mutt_gsasl_cleanup(Gsasl **ctx)
Shutdown GNU SASL library.
Definition gsasl.c:151

FREE
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68

MUTT_MEM_CALLOC
#define MUTT_MEM_CALLOC(n, type)
Definition memory.h:52

MODULE_ID_CONN
@ MODULE_ID_CONN
ModuleConn, Network connections
Definition module_api.h:60

lib.h
Convenience wrapper for the library headers.

notify_new
struct Notify * notify_new(void)
Create a new notifications handler.
Definition notify.c:62

notify_set_parent
void notify_set_parent(struct Notify *notify, struct Notify *parent)
Set the parent notification handler.
Definition notify.c:95

notify_free
void notify_free(struct Notify **ptr)
Free a notification handler.
Definition notify.c:75

neomutt_set_module_data
void neomutt_set_module_data(struct NeoMutt *n, enum ModuleId id, void *data)
Set the private data for a Module.
Definition neomutt.c:677

mutt_sasl_cleanup
void mutt_sasl_cleanup(void)
Invoke when processing is complete.
Definition sasl.c:789

sasl.h
SASL authentication support.

ConfigDef
Definition set.h:65

ConfigSet
Container for lots of config items.
Definition set.h:251

ConnModuleData
Conn private Module data.
Definition module_data.h:38

ConnModuleData::notify
struct Notify * notify
Notifications.
Definition module_data.h:39

ConnModuleData::skip_mode_ex_data_index
int skip_mode_ex_data_index
OpenSSL skip mode extra data index.
Definition module_data.h:49

ConnModuleData::host_ex_data_index
int host_ex_data_index
OpenSSL host extra data index.
Definition module_data.h:48

Module
Definition module_api.h:102

NeoMutt
Container for Accounts, Notifications.
Definition neomutt.h:41

NeoMutt::notify
struct Notify * notify
Notifications handler.
Definition neomutt.h:45