dlg_alias.c File Reference

Address book. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.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 "lib.h"
#include "expando/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "pattern/lib.h"
#include "send/lib.h"
#include "alias.h"
#include "expando.h"
#include "functions.h"
#include "gui.h"
#include "module_data.h"
#include "mutt_logging.h"

Include dependency graph for dlg_alias.c:

Go to the source code of this file.

Functions
static int	alias_make_entry (struct Menu *menu, int line, int max_cols, struct Buffer *buf)
	Format an Alias for the Menu - Implements Menu::make_entry() -.
static int	alias_tag (struct Menu *menu, int sel, int act)
	Tag some aliases - Implements Menu::tag() -.
static int	alias_alias_observer (struct NotifyCallback *nc)
	Notification that an Alias has changed - Implements observer_t -.
static int	alias_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
static struct SimpleDialogWindows	alias_dialog_new (struct AliasMenuData *mdata)
	Create an Alias Selection Dialog.
static bool	dlg_alias (struct AliasMenuData *mdata)
	Display a menu of Aliases -.
int	alias_complete (struct Buffer *buf, struct ConfigSubset *sub)
	Alias completion routine.
void	alias_dialog (struct Mailbox *m, struct ConfigSubset *sub)
	Open the aliases dialog.

Variables
static const struct Mapping	AliasHelp []
	Help Bar for the Alias dialog (address book)

Detailed Description

Address book.

Authors

• Richard Russon
• Romeu Vieira
• Pietro Cerutti
• Anna Figueiredo Gomes
• Dennis Schön
• Tóth János

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

Function Documentation

alias_dialog_new()

static struct SimpleDialogWindows alias_dialog_new ( struct AliasMenuData * mdata )

static

Create an Alias Selection Dialog.

Parameters

mdata

Menu data holding Aliases

Return values

obj	SimpleDialogWindows Tuple containing Dialog, SimpleBar and Menu pointers

Definition at line 232 of file dlg_alias.c.

{
  struct AliasModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_ALIAS);
  ASSERT(mod_data);
 
  struct SimpleDialogWindows sdw = simple_dialog_new(mod_data->menu_alias,
                                                     WT_DLG_ALIAS, AliasHelp);
 
  struct Menu *menu = sdw.menu;
 
  menu->make_entry = alias_make_entry;
  menu->tag = alias_tag;
  menu->max = alias_array_count_visible(&mdata->ava);
  menu->mdata = mdata;
  menu->mdata_free = NULL; // Menu doesn't own the data
 
  struct MuttWindow *win_menu = menu->win;
 
  // Override the Simple Dialog's recalc()
  win_menu->recalc = alias_recalc;
 
  alias_set_title(sdw.sbar, mdata->title, mdata->limit);
 
  // NT_COLOR is handled by the SimpleDialog
  notify_observer_add(NeoMutt->notify, NT_ALIAS, alias_alias_observer, menu);
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, alias_config_observer, menu);
  notify_observer_add(win_menu->notify, NT_WINDOW, alias_window_observer, win_menu);
 
  return sdw;
}

Here is the call graph for this function:

Here is the caller graph for this function:

alias_complete()

int alias_complete	(	struct Buffer *	buf,
		struct ConfigSubset *	sub )

Alias completion routine.

Parameters

buf	Partial Alias to complete
sub	Config items

Return values

1	Success
0	Error

Given a partial alias, this routine attempts to fill in the alias from the alias list as much as possible. if given empty search string or found nothing, present all aliases

Definition at line 345 of file dlg_alias.c.

{
  char bestname[8192] = { 0 };
  struct Alias *a_best = NULL;
  int count = 0;
 
  struct AliasMenuData mdata = { ARRAY_HEAD_INITIALIZER, NULL, sub };
  mdata.limit = buf_strdup(buf);
  mdata.search_state = search_state_new();
 
  struct AliasModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_ALIAS);
  ASSERT(mod_data);
 
  if (buf_at(buf, 0) != '\0')
  {
    struct Alias **ap = NULL;
    ARRAY_FOREACH(ap, &mod_data->aliases)
    {
      struct Alias *a = *ap;
      if (a->name && mutt_strn_equal(a->name, buf_string(buf), buf_len(buf)))
      {
        a_best = a;
        count++;
 
        if (bestname[0] == '\0') /* init */
        {
          mutt_str_copy(bestname, a->name, MIN(mutt_str_len(a->name) + 1, sizeof(bestname)));
        }
        else
        {
          int i;
          for (i = 0; a->name[i] && (a->name[i] == bestname[i]); i++)
            ; // do nothing
 
          bestname[i] = '\0';
        }
      }
    }
 
    // Exactly one match, so expand the Alias and return
    if (count == 1)
    {
      buf_reset(buf);
      mutt_addrlist_write(&a_best->addr, buf, true);
      buf_addstr(buf, ", ");
      FREE(&mdata.limit);
      search_state_free(&mdata.search_state);
      return 1;
    }
 
    if (bestname[0] == '\0')
    {
      // Create a View Array of all the Aliases
      FREE(&mdata.limit);
      ARRAY_FOREACH(ap, &mod_data->aliases)
      {
        alias_array_alias_add(&mdata.ava, *ap);
      }
    }
    else
    {
      /* fake the pattern for menu title */
      char *mtitle = NULL;
      mutt_str_asprintf(&mtitle, "~f ^%s", buf_string(buf));
      FREE(&mdata.limit);
      mdata.limit = mtitle;
 
      if (!mutt_str_equal(bestname, buf_string(buf)))
      {
        /* we are adding something to the completion */
        buf_strcpy_n(buf, bestname, mutt_str_len(bestname) + 1);
        FREE(&mdata.limit);
        search_state_free(&mdata.search_state);
        return 1;
      }
 
      /* build alias list and show it */
      ARRAY_FOREACH(ap, &mod_data->aliases)
      {
        struct Alias *a = *ap;
        int aasize = alias_array_alias_add(&mdata.ava, a);
 
        struct AliasView *av = ARRAY_GET(&mdata.ava, aasize - 1);
 
        if (a->name && !mutt_strn_equal(a->name, buf_string(buf), buf_len(buf)))
        {
          av->is_visible = false;
        }
      }
    }
  }
 
  if (ARRAY_EMPTY(&mdata.ava))
  {
    struct Alias **ap = NULL;
    ARRAY_FOREACH(ap, &mod_data->aliases)
    {
      alias_array_alias_add(&mdata.ava, *ap);
    }
 
    mutt_pattern_alias_func(NULL, &mdata, PAA_VISIBLE, NULL);
  }
 
  if (!dlg_alias(&mdata))
    goto done;
 
  buf_reset(buf);
 
  // Extract the selected aliases
  struct Buffer *tmpbuf = buf_pool_get();
  struct AliasView *avp = NULL;
  ARRAY_FOREACH(avp, &mdata.ava)
  {
    if (!avp->is_tagged)
      continue;
 
    mutt_addrlist_write(&avp->alias->addr, tmpbuf, true);
    buf_addstr(tmpbuf, ", ");
  }
  buf_copy(buf, tmpbuf);
  buf_pool_release(&tmpbuf);
 
done:
  // Process any deleted aliases
  ARRAY_FOREACH(avp, &mdata.ava)
  {
    if (!avp->is_deleted)
      continue;
 
    // Find and remove the alias from the Aliases array
    struct Alias **ap = NULL;
    ARRAY_FOREACH(ap, &mod_data->aliases)
    {
      if (*ap == avp->alias)
      {
        ARRAY_REMOVE(&mod_data->aliases, ap);
        break;
      }
    }
    alias_free(&avp->alias);
  }
 
  ARRAY_FREE(&mdata.ava);
  FREE(&mdata.limit);
  FREE(&mdata.title);
  search_state_free(&mdata.search_state);
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

alias_dialog()

void alias_dialog	(	struct Mailbox *	m,
		struct ConfigSubset *	sub )

Open the aliases dialog.

Parameters

m	Mailbox
sub	Config item

Definition at line 500 of file dlg_alias.c.

{
  struct Alias **ap = NULL;
 
  struct AliasMenuData mdata = { ARRAY_HEAD_INITIALIZER, NULL, sub };
  mdata.search_state = search_state_new();
 
  struct AliasModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_ALIAS);
  ASSERT(mod_data);
 
  // Create a View Array of all the Aliases
  ARRAY_FOREACH(ap, &mod_data->aliases)
  {
    alias_array_alias_add(&mdata.ava, *ap);
  }
 
  if (!dlg_alias(&mdata))
    goto done;
 
  // Prepare the "To:" field of a new email
  struct Email *e = email_new();
  e->env = mutt_env_new();
 
  struct AliasView *avp = NULL;
  ARRAY_FOREACH(avp, &mdata.ava)
  {
    if (!avp->is_tagged)
      continue;
 
    struct AddressList al_copy = TAILQ_HEAD_INITIALIZER(al_copy);
    if (alias_to_addrlist(&al_copy, avp->alias))
    {
      mutt_addrlist_copy(&e->env->to, &al_copy, false);
      mutt_addrlist_clear(&al_copy);
    }
  }
 
  mutt_send_message(SEND_REVIEW_TO, e, NULL, m, NULL, sub);
 
done:
  // Process any deleted aliases
  ARRAY_FOREACH(avp, &mdata.ava)
  {
    if (avp->is_deleted)
    {
      // Find and remove the alias from the Aliases array
      ARRAY_FOREACH(ap, &mod_data->aliases)
      {
        if (*ap == avp->alias)
        {
          ARRAY_REMOVE(&mod_data->aliases, ap);
          break;
        }
      }
      alias_free(&avp->alias);
    }
  }
 
  ARRAY_FREE(&mdata.ava);
  FREE(&mdata.limit);
  FREE(&mdata.title);
  search_state_free(&mdata.search_state);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

AliasHelp

const struct Mapping AliasHelp[]

static

Initial value:

= {
  
  { N_("Exit"),     OP_EXIT },
  { N_("Del"),      OP_DELETE },
  { N_("Undel"),    OP_UNDELETE },
  { N_("Sort"),     OP_SORT },
  { N_("Rev-Sort"), OP_SORT_REVERSE },
  { N_("Select"),   OP_GENERIC_SELECT_ENTRY },
  { N_("Help"),     OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the Alias dialog (address book)

Definition at line 100 of file dlg_alias.c.

                                          {
  // clang-format off
  { N_("Exit"),     OP_EXIT },
  { N_("Del"),      OP_DELETE },
  { N_("Undel"),    OP_UNDELETE },
  { N_("Sort"),     OP_SORT },
  { N_("Rev-Sort"), OP_SORT_REVERSE },
  { N_("Select"),   OP_GENERIC_SELECT_ENTRY },
  { N_("Help"),     OP_HELP },
  { NULL, 0 },
  // clang-format on
};