functions.c File Reference

Browser functions. More...

#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "functions.h"
#include "lib.h"
#include "attach/lib.h"
#include "editor/lib.h"
#include "history/lib.h"
#include "imap/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "nntp/lib.h"
#include "pattern/lib.h"
#include "question/lib.h"
#include "send/lib.h"
#include "globals.h"
#include "module_data.h"
#include "mutt_mailbox.h"
#include "muttlib.h"
#include "mx.h"
#include "nntp/adata.h"
#include "nntp/mdata.h"
#include "private_data.h"
#include "sort.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
static int	op_subscribe_pattern (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Subscribe to newsgroups matching a pattern - Implements browser_function_t -.
void	browser_init_keys (struct NeoMutt *n, struct SubMenu *sm_generic)
	Initialise the Browser Keybindings - Implements ::init_keys_api.
void	destroy_state (struct BrowserState *state)
	Free the BrowserState.
static int	browser_add_selection (struct FolderFilePtrArray *ffpa, struct BrowserState *state, struct Menu *menu, bool tagged, int count)
	Build a working set of FolderFile pointers for an action.
static int	op_browser_new_file (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Select a new file in this directory - Implements browser_function_t -.
static void	browser_apply_subscribe_nntp (struct FolderFilePtrArray *ffpa, struct NntpAccountData *adata, bool subscribe)
	Subscribe/unsubscribe to NNTP newsgroups.
static void	browser_apply_subscribe_imap (struct FolderFilePtrArray *ffpa, bool subscribe)
	Subscribe/unsubscribe to IMAP mailboxes.
static int	op_browser_subscribe (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Subscribe to current mbox (IMAP/NNTP only) - Implements browser_function_t -.
static int	op_browser_tell (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Display the currently selected file's name - Implements browser_function_t -.
static int	op_browser_toggle_lsub (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Toggle view all/subscribed mailboxes (IMAP only) - Implements browser_function_t -.
static int	op_browser_view_file (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	View file - Implements browser_function_t -.
static struct NntpMboxData *	browser_apply_catchup (struct FolderFilePtrArray *ffpa, struct Mailbox *m, struct NntpAccountData *adata, bool up)
	(Un)catchup a working set of newsgroups
static int	op_catchup (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Mark all articles in newsgroup as read - Implements browser_function_t -.
static int	op_change_directory (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Change directories - Implements browser_function_t -.
static int	op_create_mailbox (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Create a new mailbox (IMAP only) - Implements browser_function_t -.
static int	browser_apply_delete_mailbox (struct FolderFilePtrArray *ffpa, struct BrowserState *state, struct Mailbox *m, int *num_failed)
	Delete a working set of IMAP mailboxes.
static int	op_delete_mailbox (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Delete the current mailbox (IMAP only) - Implements browser_function_t -.
static int	op_enter_mask (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Enter a file mask - Implements browser_function_t -.
static int	op_quit (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Save changes and exit this dialog - Implements browser_function_t -.
static int	op_jump (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Jump to an index number - Implements browser_function_t -.
static int	op_generic_select_entry (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Select the current entry - Implements browser_function_t -.
static int	op_load_active (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Load list of all newsgroups from NNTP server - Implements browser_function_t -.
static int	op_mailbox_list (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	List mailboxes with new mail - Implements browser_function_t -.
static int	op_rename_mailbox (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Rename the current mailbox (IMAP only) - Implements browser_function_t -.
static int	op_sort (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Sort messages - Implements browser_function_t -.
static int	op_toggle_mailboxes (struct BrowserPrivateData *priv, const struct KeyEvent *event)
	Toggle whether to browse mailboxes or all files - Implements browser_function_t -.
int	browser_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Browser function.

Variables
static const struct MenuFuncOp	OpBrowser []
	Functions for the file Browser Menu.
static const struct MenuOpSeq	BrowserDefaultBindings []
	Key bindings for the file Browser Menu.
static const struct BrowserFunction	BrowserFunctions []
	All the NeoMutt functions that the Browser supports.

Detailed Description

Browser functions.

Authors

• Richard Russon
• Dennis Schön

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

browser_init_keys()

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

Initialise the Browser Keybindings - Implements ::init_keys_api.

Definition at line 127 of file functions.c.

{
  struct BrowserModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_BROWSER);
  ASSERT(mod_data);
 
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
 
  sm = km_register_submenu(OpBrowser);
  md = km_register_menu(MENU_BROWSER, "browser");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, sm_generic);
  km_menu_add_bindings(md, BrowserDefaultBindings);
 
  mod_data->menu_browser = md;
}

Here is the call graph for this function:

Here is the caller graph for this function:

destroy_state()

void destroy_state

(

struct BrowserState *

state

)

Free the BrowserState.

Parameters

state

State to free

Frees up the memory allocated for the local-global variables.

Definition at line 150 of file functions.c.

{
  struct FolderFile *ff = NULL;
  ARRAY_FOREACH(ff, &state->entry)
  {
    FREE(&ff->name);
    FREE(&ff->desc);
  }
  ARRAY_FREE(&state->entry);
  FREE(&state->folder);
}

Here is the caller graph for this function:

browser_add_selection()

static int browser_add_selection ( struct FolderFilePtrArray * ffpa, struct BrowserState * state, struct Menu * menu, bool tagged, int count )

static

Build a working set of FolderFile pointers for an action.

Parameters

ffpa	FolderFile Array to populate
state	Browser state (source of entries)
menu	Menu
tagged	Use tagged entries (tag-prefix)
count	Repeat-count (0 or 1 == just the current selection)

Return values

num	Number of entries added

If tagged is true, the array is filled with the tagged entries (in source order) and count is ignored.

Otherwise the array is filled with the current selection and the next count - 1 entries. Overruns are silently capped at the end of the list.

Definition at line 179 of file functions.c.

{
  if (!ffpa || !state || !menu)
    return 0;
 
  const int max = ARRAY_SIZE(&state->entry);
 
  if (tagged)
  {
    struct FolderFile *ff = NULL;
    ARRAY_FOREACH(ff, &state->entry)
    {
      if (ff->tagged)
        ARRAY_ADD(ffpa, ff);
    }
  }
  else
  {
    const int index = menu_get_index(menu);
    if ((index < 0) || (index >= max))
      return 0;
 
    int n = (count > 1) ? count : 1;
    if ((index + n) > max)
      n = max - index;
 
    for (int i = 0; i < n; i++)
    {
      struct FolderFile *ff = ARRAY_GET(&state->entry, index + i);
      if (ff)
        ARRAY_ADD(ffpa, ff);
    }
  }
 
  return ARRAY_SIZE(ffpa);
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_apply_subscribe_nntp()

static void browser_apply_subscribe_nntp ( struct FolderFilePtrArray * ffpa, struct NntpAccountData * adata, bool subscribe )

static

Subscribe/unsubscribe to NNTP newsgroups.

Parameters

ffpa	Working set of FolderFiles
adata	NNTP account
subscribe	true to subscribe, false to unsubscribe

Definition at line 247 of file functions.c.

{
  if (!ffpa || !adata)
    return;
 
  struct FolderFile **ffp = NULL;
  ARRAY_FOREACH(ffp, ffpa)
  {
    struct FolderFile *ff = *ffp;
    if (!ff || !ff->name)
      continue;
    if (subscribe)
      mutt_newsgroup_subscribe(adata, ff->name);
    else
      mutt_newsgroup_unsubscribe(adata, ff->name);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_apply_subscribe_imap()

static void browser_apply_subscribe_imap ( struct FolderFilePtrArray * ffpa, bool subscribe )

static

Subscribe/unsubscribe to IMAP mailboxes.

Parameters

ffpa	Working set of FolderFiles
subscribe	true to subscribe, false to unsubscribe

Definition at line 271 of file functions.c.

{
  if (!ffpa)
    return;
 
  struct Buffer *buf = buf_pool_get();
  struct FolderFile **ffp = NULL;
  ARRAY_FOREACH(ffp, ffpa)
  {
    struct FolderFile *ff = *ffp;
    if (!ff || !ff->name)
      continue;
    buf_strcpy(buf, ff->name);
    expand_path(buf, false);
    imap_subscribe(buf_string(buf), subscribe);
  }
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_apply_catchup()

static struct NntpMboxData * browser_apply_catchup ( struct FolderFilePtrArray * ffpa, struct Mailbox * m, struct NntpAccountData * adata, bool up )

static

(Un)catchup a working set of newsgroups

Parameters

ffpa	Working set of FolderFiles
m	Mailbox
adata	NNTP account
up	true to catchup, false to uncatchup

Return values

ptr	Last NntpMboxData touched (NULL if nothing changed)

Definition at line 436 of file functions.c.

{
  if (!ffpa || !adata)
    return NULL;
 
  struct NntpMboxData *mdata = NULL;
  struct FolderFile **ffp = NULL;
  ARRAY_FOREACH(ffp, ffpa)
  {
    struct FolderFile *ff = *ffp;
    if (!ff || !ff->name)
      continue;
    if (up)
      mdata = mutt_newsgroup_catchup(m, adata, ff->name);
    else
      mdata = mutt_newsgroup_uncatchup(m, adata, ff->name);
  }
  return mdata;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_apply_delete_mailbox()

static int browser_apply_delete_mailbox ( struct FolderFilePtrArray * ffpa, struct BrowserState * state, struct Mailbox * m, int * num_failed )

static

Delete a working set of IMAP mailboxes.

Parameters

[in]	ffpa	Working set of FolderFiles (ascending source order)
[in]	state	Browser state (source array)
[in]	m	Current mailbox
[out]	num_failed	Number of mailbox deletions that failed

Return values

num	Number of mailboxes successfully deleted (and removed from state)

Iterates the working set in reverse so that ARRAY_REMOVE() does not invalidate the pointers we still need.

Definition at line 676 of file functions.c.

{
  int deleted = 0;
  int failed = 0;
 
  if (ffpa && state)
  {
    struct FolderFile **ffp = NULL;
    ARRAY_FOREACH_REVERSE(ffp, ffpa)
    {
      struct FolderFile *ff = *ffp;
      if (!ff || !ff->name)
        continue;
      if (imap_delete_mailbox(m, ff->name) != 0)
      {
        failed++;
        continue;
      }
      FREE(&ff->name);
      FREE(&ff->desc);
      ARRAY_REMOVE(&state->entry, ff);
      deleted++;
    }
  }
 
  if (num_failed)
    *num_failed = failed;
  return deleted;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_function_dispatcher()

int browser_function_dispatcher	(	struct MuttWindow *	win,
		const struct KeyEvent *	event )

Perform a Browser function.

Parameters

win	Window for the Browser
event	Event to process

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 1441 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct BrowserPrivateData *priv = menu->mdata;
  if (!priv)
    return FR_ERROR;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; BrowserFunctions[i].op != OP_NULL; i++)
  {
    const struct BrowserFunction *fn = &BrowserFunctions[i];
    if (fn->op == event->op)
    {
      rc = fn->function(priv, event);
      break;
    }
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

OpBrowser

const struct MenuFuncOp OpBrowser[]

static

Initial value:

= { 
  { "catchup",                       OP_CATCHUP },
  { "change-dir",                    OP_CHANGE_DIRECTORY },
  { "check-new",                     OP_CHECK_NEW },
  { "create-mailbox",                OP_CREATE_MAILBOX },
  { "delete-mailbox",                OP_DELETE_MAILBOX },
  { "descend-directory",             OP_DESCEND_DIRECTORY },
  { "display-filename",              OP_BROWSER_TELL },
  { "enter-mask",                    OP_ENTER_MASK },
  { "goto-folder",                   OP_BROWSER_GOTO_FOLDER },
  { "goto-parent",                   OP_GOTO_PARENT },
  { "mailbox-list",                  OP_MAILBOX_LIST },
  { "reload-active",                 OP_LOAD_ACTIVE },
  { "rename-mailbox",                OP_RENAME_MAILBOX },
  { "select-new",                    OP_BROWSER_NEW_FILE },
  { "sort",                          OP_SORT },
  { "sort-reverse",                  OP_SORT_REVERSE },
  { "subscribe",                     OP_BROWSER_SUBSCRIBE },
  { "subscribe-pattern",             OP_SUBSCRIBE_PATTERN },
  { "toggle-mailboxes",              OP_TOGGLE_MAILBOXES },
  { "toggle-subscribed",             OP_BROWSER_TOGGLE_LSUB },
  { "uncatchup",                     OP_UNCATCHUP },
  { "unsubscribe",                   OP_BROWSER_UNSUBSCRIBE },
  { "unsubscribe-pattern",           OP_UNSUBSCRIBE_PATTERN },
  { "view-file",                     OP_BROWSER_VIEW_FILE },
  
  { "buffy-list",                    OP_MAILBOX_LIST, MFF_DEPRECATED },
  { NULL, 0 },
}

Functions for the file Browser Menu.

Definition at line 69 of file functions.c.

                                             { /* map: browser */
  { "catchup",                       OP_CATCHUP },
  { "change-dir",                    OP_CHANGE_DIRECTORY },
  { "check-new",                     OP_CHECK_NEW },
  { "create-mailbox",                OP_CREATE_MAILBOX },
  { "delete-mailbox",                OP_DELETE_MAILBOX },
  { "descend-directory",             OP_DESCEND_DIRECTORY },
  { "display-filename",              OP_BROWSER_TELL },
  { "enter-mask",                    OP_ENTER_MASK },
  { "goto-folder",                   OP_BROWSER_GOTO_FOLDER },
  { "goto-parent",                   OP_GOTO_PARENT },
  { "mailbox-list",                  OP_MAILBOX_LIST },
  { "reload-active",                 OP_LOAD_ACTIVE },
  { "rename-mailbox",                OP_RENAME_MAILBOX },
  { "select-new",                    OP_BROWSER_NEW_FILE },
  { "sort",                          OP_SORT },
  { "sort-reverse",                  OP_SORT_REVERSE },
  { "subscribe",                     OP_BROWSER_SUBSCRIBE },
  { "subscribe-pattern",             OP_SUBSCRIBE_PATTERN },
  { "toggle-mailboxes",              OP_TOGGLE_MAILBOXES },
  { "toggle-subscribed",             OP_BROWSER_TOGGLE_LSUB },
  { "uncatchup",                     OP_UNCATCHUP },
  { "unsubscribe",                   OP_BROWSER_UNSUBSCRIBE },
  { "unsubscribe-pattern",           OP_UNSUBSCRIBE_PATTERN },
  { "view-file",                     OP_BROWSER_VIEW_FILE },
  // Deprecated
  { "buffy-list",                    OP_MAILBOX_LIST, MFF_DEPRECATED },
  { NULL, 0 },
};

BrowserDefaultBindings

const struct MenuOpSeq BrowserDefaultBindings[]

static

Initial value:

= { 
  { OP_BROWSER_GOTO_FOLDER,                "=" },
  { OP_BROWSER_NEW_FILE,                   "N" },
  { OP_BROWSER_SUBSCRIBE,                  "s" },
  { OP_BROWSER_TELL,                       "@" },
  { OP_BROWSER_TOGGLE_LSUB,                "T" },
  { OP_BROWSER_UNSUBSCRIBE,                "u" },
  { OP_BROWSER_VIEW_FILE,                  " " },              
  { OP_CHANGE_DIRECTORY,                   "c" },
  { OP_CREATE_MAILBOX,                     "C" },
  { OP_DELETE_MAILBOX,                     "d" },
  { OP_ENTER_MASK,                         "m" },
  { OP_GOTO_PARENT,                        "p" },
  { OP_MAILBOX_LIST,                       "." },
  { OP_RENAME_MAILBOX,                     "r" },
  { OP_SORT,                               "o" },
  { OP_SORT_REVERSE,                       "O" },
  { OP_TOGGLE_MAILBOXES,                   "\t" },             
  { 0, NULL },
}

Key bindings for the file Browser Menu.

Definition at line 102 of file functions.c.

                                                         { /* map: browser */
  { OP_BROWSER_GOTO_FOLDER,                "=" },
  { OP_BROWSER_NEW_FILE,                   "N" },
  { OP_BROWSER_SUBSCRIBE,                  "s" },
  { OP_BROWSER_TELL,                       "@" },
  { OP_BROWSER_TOGGLE_LSUB,                "T" },
  { OP_BROWSER_UNSUBSCRIBE,                "u" },
  { OP_BROWSER_VIEW_FILE,                  " " },              // <Space>
  { OP_CHANGE_DIRECTORY,                   "c" },
  { OP_CREATE_MAILBOX,                     "C" },
  { OP_DELETE_MAILBOX,                     "d" },
  { OP_ENTER_MASK,                         "m" },
  { OP_GOTO_PARENT,                        "p" },
  { OP_MAILBOX_LIST,                       "." },
  { OP_RENAME_MAILBOX,                     "r" },
  { OP_SORT,                               "o" },
  { OP_SORT_REVERSE,                       "O" },
  { OP_TOGGLE_MAILBOXES,                   "\t" },             // <Tab>
  { 0, NULL },
};

BrowserFunctions

const struct BrowserFunction BrowserFunctions[]

static

All the NeoMutt functions that the Browser supports.

Definition at line 1402 of file functions.c.

                                                         {
  // clang-format off
  { OP_BROWSER_GOTO_FOLDER,  op_toggle_mailboxes },
  { OP_BROWSER_NEW_FILE,     op_browser_new_file },
  { OP_BROWSER_SUBSCRIBE,    op_browser_subscribe },
  { OP_BROWSER_TELL,         op_browser_tell },
  { OP_BROWSER_TOGGLE_LSUB,  op_browser_toggle_lsub },
  { OP_BROWSER_UNSUBSCRIBE,  op_browser_subscribe },
  { OP_BROWSER_VIEW_FILE,    op_browser_view_file },
  { OP_CATCHUP,              op_catchup },
  { OP_CHANGE_DIRECTORY,     op_change_directory },
  { OP_CHECK_NEW,            op_toggle_mailboxes },
  { OP_CREATE_MAILBOX,       op_create_mailbox },
  { OP_DELETE_MAILBOX,       op_delete_mailbox },
  { OP_DESCEND_DIRECTORY,    op_generic_select_entry },
  { OP_ENTER_MASK,           op_enter_mask },
  { OP_EXIT,                 op_quit },
  { OP_GENERIC_SELECT_ENTRY, op_generic_select_entry },
  { OP_GOTO_PARENT,          op_change_directory },
  { OP_LOAD_ACTIVE,          op_load_active },
  { OP_MAILBOX_LIST,         op_mailbox_list },
  { OP_QUIT,                 op_quit },
  { OP_RENAME_MAILBOX,       op_rename_mailbox },
  { OP_SORT,                 op_sort },
  { OP_SORT_REVERSE,         op_sort },
  { OP_SUBSCRIBE_PATTERN,    op_subscribe_pattern },
  { OP_TOGGLE_MAILBOXES,     op_toggle_mailboxes },
  { OP_UNCATCHUP,            op_catchup },
  { OP_UNSUBSCRIBE_PATTERN,  op_subscribe_pattern },
  { 0, NULL },
  // clang-format on
};