functions.c File Reference

Autocrypt functions. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "functions.h"
#include "lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "question/lib.h"
#include "autocrypt_data.h"
#include "module_data.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
void	autocrypt_init_keys (struct NeoMutt *n, struct SubMenu *sm_generic)
	Initialise the Autocrypt Keybindings - Implements ::init_keys_api.
static bool	toggle_enabled (struct AccountEntry *entry)
	Toggle whether an Autocrypt account is enabled.
static bool	toggle_prefer_encrypt (struct AccountEntry *entry)
	Toggle whether an Autocrypt account prefers encryption.
static int	op_autocrypt_create_acct (struct AutocryptData *ad, const struct KeyEvent *event)
	Create a new autocrypt account - Implements autocrypt_function_t -.
static int	op_autocrypt_delete_acct (struct AutocryptData *ad, const struct KeyEvent *event)
	Delete the current account - Implements autocrypt_function_t -.
static int	op_autocrypt_toggle_enabled (struct AutocryptData *ad, const struct KeyEvent *event)
	Toggle the current account enabled/disabled - Implements autocrypt_function_t -.
static int	op_autocrypt_toggle_prefer (struct AutocryptData *ad, const struct KeyEvent *event)
	Toggle the current account prefer-encrypt flag - Implements autocrypt_function_t -.
static int	op_quit (struct AutocryptData *ad, const struct KeyEvent *event)
	Save changes and exit this dialog - Implements autocrypt_function_t -.
int	autocrypt_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Autocrypt function - Implements function_dispatcher_t -.

Variables
static const struct MenuFuncOp	OpAutocrypt []
	Functions for the Autocrypt Account.
static const struct MenuOpSeq	AutocryptDefaultBindings []
	Key bindings for the Autocrypt Account.
static const struct AutocryptFunction	AutocryptFunctions []
	All the NeoMutt functions that the Autocrypt supports.

Detailed Description

Autocrypt functions.

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

Function Documentation

autocrypt_init_keys()

void autocrypt_init_keys	(	struct NeoMutt *	n,
		struct SubMenu *	sm_generic )

Initialise the Autocrypt Keybindings - Implements ::init_keys_api.

Definition at line 76 of file functions.c.

{
  struct AutocryptModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_AUTOCRYPT);
  ASSERT(mod_data);
 
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
 
  sm = km_register_submenu(OpAutocrypt);
  md = km_register_menu(MENU_AUTOCRYPT, "autocrypt");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, sm_generic);
  km_menu_add_bindings(md, AutocryptDefaultBindings);
 
  mod_data->menu_autocrypt = md;
}

Here is the call graph for this function:

Here is the caller graph for this function:

toggle_enabled()

bool toggle_enabled ( struct AccountEntry * entry )

static

Toggle whether an Autocrypt account is enabled.

Parameters

entry

Menu Entry for the account

Return values

true	Success
false	Error

Definition at line 99 of file functions.c.

{
  entry->account->enabled = !entry->account->enabled;
  if (mutt_autocrypt_db_account_update(entry->account) != 0)
  {
    entry->account->enabled = !entry->account->enabled;
    /* L10N: This error message is displayed if a database update of an
       account record fails for some odd reason.  */
    mutt_error(_("Error updating account record"));
    return false;
  }
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

toggle_prefer_encrypt()

bool toggle_prefer_encrypt ( struct AccountEntry * entry )

static

Toggle whether an Autocrypt account prefers encryption.

Parameters

entry

Menu Entry for the account

Return values

true	Success
false	Error

Definition at line 120 of file functions.c.

{
  entry->account->prefer_encrypt = !entry->account->prefer_encrypt;
  if (mutt_autocrypt_db_account_update(entry->account))
  {
    entry->account->prefer_encrypt = !entry->account->prefer_encrypt;
    mutt_error(_("Error updating account record"));
    return false;
  }
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

OpAutocrypt

const struct MenuFuncOp OpAutocrypt[]

static

Initial value:

                              = { 
  { "create-account",                OP_AUTOCRYPT_CREATE_ACCT },
  { "delete-account",                OP_AUTOCRYPT_DELETE_ACCT },
  { "toggle-enabled",                OP_AUTOCRYPT_TOGGLE_ENABLED },
  { "toggle-prefer-encrypt",         OP_AUTOCRYPT_TOGGLE_PREFER },
 
  
  { "toggle-active",                 OP_AUTOCRYPT_TOGGLE_ENABLED, MFF_DEPRECATED },
  { NULL, 0 }
}

Functions for the Autocrypt Account.

Definition at line 50 of file functions.c.

                                             { /* map: autocrypt account */
  { "create-account",                OP_AUTOCRYPT_CREATE_ACCT },
  { "delete-account",                OP_AUTOCRYPT_DELETE_ACCT },
  { "toggle-enabled",                OP_AUTOCRYPT_TOGGLE_ENABLED },
  { "toggle-prefer-encrypt",         OP_AUTOCRYPT_TOGGLE_PREFER },
 
  // Deprecated
  { "toggle-active",                 OP_AUTOCRYPT_TOGGLE_ENABLED, MFF_DEPRECATED },
  { NULL, 0 }
};

AutocryptDefaultBindings

const struct MenuOpSeq AutocryptDefaultBindings[]

static

Initial value:

                             = { 
  { OP_AUTOCRYPT_CREATE_ACCT,              "c" },
  { OP_AUTOCRYPT_DELETE_ACCT,              "D" },
  { OP_AUTOCRYPT_TOGGLE_ENABLED,           "a" },
  { OP_AUTOCRYPT_TOGGLE_PREFER,            "p" },
  { 0, NULL }
}

Key bindings for the Autocrypt Account.

Definition at line 64 of file functions.c.

                                                         { /* map: autocrypt account */
  { OP_AUTOCRYPT_CREATE_ACCT,              "c" },
  { OP_AUTOCRYPT_DELETE_ACCT,              "D" },
  { OP_AUTOCRYPT_TOGGLE_ENABLED,           "a" },
  { OP_AUTOCRYPT_TOGGLE_PREFER,            "p" },
  { 0, NULL }
};

AutocryptFunctions

const struct AutocryptFunction AutocryptFunctions[]

static

Initial value:

                                     = {
  
  { OP_AUTOCRYPT_CREATE_ACCT,    op_autocrypt_create_acct },
  { OP_AUTOCRYPT_DELETE_ACCT,    op_autocrypt_delete_acct },
  { OP_AUTOCRYPT_TOGGLE_ENABLED, op_autocrypt_toggle_enabled },
  { OP_AUTOCRYPT_TOGGLE_PREFER,  op_autocrypt_toggle_prefer },
  { OP_EXIT,                     op_quit },
  { OP_QUIT,                     op_quit },
  { 0, NULL },
  
}

All the NeoMutt functions that the Autocrypt supports.

Definition at line 226 of file functions.c.

                                                           {
  // clang-format off
  { OP_AUTOCRYPT_CREATE_ACCT,    op_autocrypt_create_acct },
  { OP_AUTOCRYPT_DELETE_ACCT,    op_autocrypt_delete_acct },
  { OP_AUTOCRYPT_TOGGLE_ENABLED, op_autocrypt_toggle_enabled },
  { OP_AUTOCRYPT_TOGGLE_PREFER,  op_autocrypt_toggle_prefer },
  { OP_EXIT,                     op_quit },
  { OP_QUIT,                     op_quit },
  { 0, NULL },
  // clang-format on
};