dlg_browser.c File Reference

File/Mailbox Browser Dialog. More...

#include "config.h"
#include <dirent.h>
#include <errno.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 "conn/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "expando/lib.h"
#include "imap/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "nntp/lib.h"
#include "expando.h"
#include "functions.h"
#include "globals.h"
#include "mutt_logging.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 dlg_browser.c:

Go to the source code of this file.

Functions
static void	init_lastdir (void)
	Initialise the browser directories.
void	mutt_browser_cleanup (void)
	Clean up working Buffers.
bool	link_is_dir (const char *folder, const char *path)
	Does this symlink point to a directory?
void	browser_add_folder (const struct Menu *menu, struct BrowserState *state, const char *name, const char *desc, const struct stat *st, struct Mailbox *m, void *data)
	Add a folder to the browser list.
void	init_state (struct BrowserState *state)
	Initialise a browser state.
int	examine_directory (struct Mailbox *m, struct Menu *menu, struct BrowserState *state, const char *dirname, const char *prefix)
	Get list of all files/newsgroups with mask.
int	examine_mailboxes (struct Mailbox *m, struct Menu *menu, struct BrowserState *state)
	Get list of mailboxes/subscribed newsgroups.
static int	select_file_search (struct Menu *menu, regex_t *rx, int line)
	Menu search callback for matching files - Implements Menu::search() -.
static int	folder_make_entry (struct Menu *menu, int line, int max_cols, struct Buffer *buf)
	Format a Folder for the Menu - Implements Menu::make_entry() -.
void	browser_highlight_default (struct BrowserState *state, struct Menu *menu)
	Decide which browser item should be highlighted.
void	init_menu (struct BrowserState *state, struct Menu *menu, struct Mailbox *m, struct MuttWindow *sbar)
	Set up a new menu.
static int	file_tag (struct Menu *menu, int sel, int act)
	Tag an entry in the menu - Implements Menu::tag() -.
static int	browser_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
static int	browser_mailbox_observer (struct NotifyCallback *nc)
	Notification that a Mailbox has changed - Implements observer_t -.
static int	browser_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
void	mutt_browser_select_dir (const char *f)
	Remember the last directory selected.
void	dlg_browser (struct Buffer *file, SelectFileFlags flags, struct Mailbox *m, char ***files, int *numfiles)
	Let the user select a file -.

Variables
static const struct Mapping	FolderHelp []
	Help Bar for the File/Dir/Mailbox browser dialog.
static const struct Mapping	FolderNewsHelp []
	Help Bar for the NNTP Mailbox browser dialog.
struct Buffer	LastDir = { 0 }
	Browser: previous selected directory.
struct Buffer	LastDirBackup = { 0 }
	Browser: backup copy of the current directory.

Detailed Description

File/Mailbox Browser Dialog.

Authors

• Pierre-Elliott Bécue
• Richard Russon
• Austin Ray
• Pietro Cerutti
• R Primus
• Carlos Henrique Lima Melara
• Leon Philman
• наб
• 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_browser.c.

Function Documentation

init_lastdir()

static void init_lastdir ( void )

static

Initialise the browser directories.

These keep track of where the browser used to be looking.

Definition at line 144 of file dlg_browser.c.

{
  static bool done = false;
  if (!done)
  {
    buf_alloc(&LastDir, PATH_MAX);
    buf_alloc(&LastDirBackup, PATH_MAX);
    done = true;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_browser_cleanup()

void mutt_browser_cleanup

(

void

)

Clean up working Buffers.

Definition at line 158 of file dlg_browser.c.

{
  buf_dealloc(&LastDir);
  buf_dealloc(&LastDirBackup);
}

Here is the call graph for this function:

Here is the caller graph for this function:

link_is_dir()

bool link_is_dir	(	const char *	folder,
		const char *	path )

Does this symlink point to a directory?

Parameters

folder	Folder
path	Link name

Return values

true	Links to a directory
false	Otherwise

Definition at line 171 of file dlg_browser.c.

{
  struct stat st = { 0 };
  bool rc = false;
 
  struct Buffer *fullpath = buf_pool_get();
  buf_concat_path(fullpath, folder, path);
 
  if (stat(buf_string(fullpath), &st) == 0)
    rc = S_ISDIR(st.st_mode);
 
  buf_pool_release(&fullpath);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_add_folder()

void browser_add_folder	(	const struct Menu *	menu,
		struct BrowserState *	state,
		const char *	name,
		const char *	desc,
		const struct stat *	st,
		struct Mailbox *	m,
		void *	data )

Add a folder to the browser list.

Parameters

menu	Menu to use
state	Browser state
name	Name of folder
desc	Description of folder
st	stat info for the folder
m	Mailbox
data	Data to associate with the folder

Definition at line 197 of file dlg_browser.c.

{
  if ((!menu || state->is_mailbox_list) && m && !m->visible)
  {
    return;
  }
 
  struct FolderFile ff = { 0 };
 
  if (st)
  {
    ff.mode = st->st_mode;
    ff.mtime = st->st_mtime;
    ff.size = st->st_size;
    ff.gid = st->st_gid;
    ff.uid = st->st_uid;
    ff.nlink = st->st_nlink;
    ff.local = true;
  }
  else
  {
    ff.local = false;
  }
 
  if (m)
  {
    ff.has_mailbox = true;
    ff.gen = m->gen;
    ff.has_new_mail = m->has_new;
    ff.msg_count = m->msg_count;
    ff.msg_unread = m->msg_unread;
    ff.notify_user = m->notify_user;
    ff.poll_new_mail = m->poll_new_mail;
  }
 
  ff.name = mutt_str_dup(name);
  ff.desc = mutt_str_dup(desc ? desc : name);
  ff.imap = false;
  if (OptNews)
    ff.nd = data;
 
  ARRAY_ADD(&state->entry, ff);
}

Here is the call graph for this function:

Here is the caller graph for this function:

init_state()

void init_state

(

struct BrowserState *

state

)

Initialise a browser state.

Parameters

state

BrowserState to initialise

Definition at line 247 of file dlg_browser.c.

{
  ARRAY_INIT(&state->entry);
  ARRAY_RESERVE(&state->entry, 256);
  state->imap_browse = false;
}

Here is the caller graph for this function:

examine_directory()

int examine_directory	(	struct Mailbox *	m,
		struct Menu *	menu,
		struct BrowserState *	state,
		const char *	dirname,
		const char *	prefix )

Get list of all files/newsgroups with mask.

Parameters

m	Mailbox
menu	Current Menu
state	State of browser
dirname	Directory
prefix	Files/newsgroups must match this prefix

Return values

0	Success
-1	Error

Definition at line 264 of file dlg_browser.c.

{
  int rc = -1;
  struct Buffer *buf = buf_pool_get();
  if (OptNews)
  {
    struct NntpAccountData *adata = CurrentNewsSrv;
 
    init_state(state);
 
    const struct Regex *c_mask = cs_subset_regex(NeoMutt->sub, "mask");
    for (unsigned int i = 0; i < adata->groups_num; i++)
    {
      struct NntpMboxData *mdata = adata->groups_list[i];
      if (!mdata)
        continue;
      if (prefix && *prefix && !mutt_str_startswith(mdata->group, prefix))
        continue;
      if (!mutt_regex_match(c_mask, mdata->group))
      {
        continue;
      }
      browser_add_folder(menu, state, mdata->group, NULL, NULL, NULL, mdata);
    }
  }
  else
  {
    struct stat st = { 0 };
    DIR *dir = NULL;
    struct dirent *de = NULL;
 
    while (stat(dirname, &st) == -1)
    {
      if (errno == ENOENT)
      {
        /* The last used directory is deleted, try to use the parent dir. */
        char *c = strrchr(dirname, '/');
 
        if (c && (c > dirname))
        {
          *c = '\0';
          continue;
        }
      }
      mutt_perror("%s", dirname);
      goto ed_out;
    }
 
    if (!S_ISDIR(st.st_mode))
    {
      mutt_error(_("%s is not a directory"), dirname);
      goto ed_out;
    }
 
    if (m)
      mutt_mailbox_check(m, MUTT_MAILBOX_CHECK_NO_FLAGS);
 
    dir = mutt_file_opendir(dirname, MUTT_OPENDIR_NONE);
    if (!dir)
    {
      mutt_perror("%s", dirname);
      goto ed_out;
    }
 
    init_state(state);
 
    struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
 
    const struct Regex *c_mask = cs_subset_regex(NeoMutt->sub, "mask");
    while ((de = readdir(dir)))
    {
      if (mutt_str_equal(de->d_name, "."))
        continue; /* we don't need . */
 
      if (prefix && *prefix && !mutt_str_startswith(de->d_name, prefix))
      {
        continue;
      }
      if (!mutt_regex_match(c_mask, de->d_name))
      {
        continue;
      }
 
      buf_concat_path(buf, dirname, de->d_name);
      if (lstat(buf_string(buf), &st) == -1)
        continue;
 
      /* No size for directories or symlinks */
      if (S_ISDIR(st.st_mode) || S_ISLNK(st.st_mode))
        st.st_size = 0;
      else if (!S_ISREG(st.st_mode))
        continue;
 
      struct Mailbox **mp = NULL;
      ARRAY_FOREACH(mp, &ma)
      {
        if (mutt_str_equal(buf_string(buf), mailbox_path(*mp)))
          break;
      }
 
      struct Mailbox *m_match = mp ? *mp : NULL;
      if (m_match && m && m->poll_new_mail && mutt_str_equal(m_match->realpath, m->realpath))
      {
        m_match->msg_count = m->msg_count;
        m_match->msg_unread = m->msg_unread;
      }
      browser_add_folder(menu, state, de->d_name, NULL, &st, m_match, NULL);
    }
    ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
    closedir(dir);
  }
  browser_sort(state);
  rc = 0;
ed_out:
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

examine_mailboxes()

int examine_mailboxes	(	struct Mailbox *	m,
		struct Menu *	menu,
		struct BrowserState *	state )

Get list of mailboxes/subscribed newsgroups.

Parameters

m	Mailbox
menu	Current menu
state	State of browser

Return values

0	Success
-1	Error

Definition at line 391 of file dlg_browser.c.

{
  struct stat st = { 0 };
  struct Buffer *md = NULL;
  struct Buffer *mailbox = NULL;
 
  if (OptNews)
  {
    struct NntpAccountData *adata = CurrentNewsSrv;
 
    init_state(state);
 
    const bool c_show_only_unread = cs_subset_bool(NeoMutt->sub, "show_only_unread");
    for (unsigned int i = 0; i < adata->groups_num; i++)
    {
      struct NntpMboxData *mdata = adata->groups_list[i];
      if (mdata && (mdata->has_new_mail ||
                    (mdata->subscribed && (mdata->unread || !c_show_only_unread))))
      {
        browser_add_folder(menu, state, mdata->group, NULL, NULL, NULL, mdata);
      }
    }
  }
  else
  {
    init_state(state);
 
    if (ARRAY_EMPTY(&NeoMutt->accounts))
      return -1;
 
    mailbox = buf_pool_get();
    md = buf_pool_get();
 
    mutt_mailbox_check(m, MUTT_MAILBOX_CHECK_NO_FLAGS);
 
    struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
    const bool c_browser_abbreviate_mailboxes = cs_subset_bool(NeoMutt->sub, "browser_abbreviate_mailboxes");
 
    struct Mailbox **mp = NULL;
    ARRAY_FOREACH(mp, &ma)
    {
      struct Mailbox *m_match = *mp;
 
      if (m && m->poll_new_mail && mutt_str_equal(m_match->realpath, m->realpath))
      {
        m_match->msg_count = m->msg_count;
        m_match->msg_unread = m->msg_unread;
      }
 
      buf_strcpy(mailbox, mailbox_path(m_match));
      if (c_browser_abbreviate_mailboxes)
        buf_pretty_mailbox(mailbox);
 
      switch (m_match->type)
      {
        case MUTT_IMAP:
        case MUTT_POP:
          browser_add_folder(menu, state, buf_string(mailbox), m_match->name,
                             NULL, m_match, NULL);
          continue;
        case MUTT_NOTMUCH:
        case MUTT_NNTP:
          browser_add_folder(menu, state, mailbox_path(m_match), m_match->name,
                             NULL, m_match, NULL);
          continue;
        default: /* Continue */
          break;
      }
 
      if (lstat(mailbox_path(m_match), &st) == -1)
        continue;
 
      if ((!S_ISREG(st.st_mode)) && (!S_ISDIR(st.st_mode)) && (!S_ISLNK(st.st_mode)))
        continue;
 
      if (m_match->type == MUTT_MAILDIR)
      {
        struct stat st2 = { 0 };
 
        buf_printf(md, "%s/new", mailbox_path(m_match));
        if (stat(buf_string(md), &st) < 0)
          st.st_mtime = 0;
        buf_printf(md, "%s/cur", mailbox_path(m_match));
        if (stat(buf_string(md), &st2) < 0)
          st2.st_mtime = 0;
        if (st2.st_mtime > st.st_mtime)
          st.st_mtime = st2.st_mtime;
      }
 
      browser_add_folder(menu, state, buf_string(mailbox), m_match->name, &st, m_match, NULL);
    }
    ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
  }
  browser_sort(state);
 
  buf_pool_release(&mailbox);
  buf_pool_release(&md);
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

browser_highlight_default()

void browser_highlight_default	(	struct BrowserState *	state,
		struct Menu *	menu )

Decide which browser item should be highlighted.

Parameters

state	Browser state
menu	Current Menu

This function takes a menu and a state and defines the current entry that should be highlighted.

Definition at line 556 of file dlg_browser.c.

{
  menu->top = 0;
  /* Reset menu position to 1.
   * We do not risk overflow as the init_menu function changes
   * current if it is bigger than state->entrylen.  */
  if (!ARRAY_EMPTY(&state->entry) &&
      (mutt_str_equal(ARRAY_FIRST(&state->entry)->desc, "..") ||
       mutt_str_equal(ARRAY_FIRST(&state->entry)->desc, "../")))
  {
    /* Skip the first entry, unless there's only one entry. */
    menu_set_index(menu, (menu->max > 1));
  }
  else
  {
    menu_set_index(menu, 0);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

init_menu()

void init_menu	(	struct BrowserState *	state,
		struct Menu *	menu,
		struct Mailbox *	m,
		struct MuttWindow *	sbar )

Set up a new menu.

Parameters

state	Browser state
menu	Current menu
m	Mailbox
sbar	Status bar

Definition at line 582 of file dlg_browser.c.

{
  char title[256] = { 0 };
  menu->max = ARRAY_SIZE(&state->entry);
 
  int index = menu_get_index(menu);
  if (index >= menu->max)
    menu_set_index(menu, menu->max - 1);
  if (index < 0)
    menu_set_index(menu, 0);
  if (menu->top > index)
    menu->top = 0;
 
  menu->num_tagged = 0;
 
  if (OptNews)
  {
    if (state->is_mailbox_list)
    {
      snprintf(title, sizeof(title), _("Subscribed newsgroups"));
    }
    else
    {
      snprintf(title, sizeof(title), _("Newsgroups on server [%s]"),
               CurrentNewsSrv->conn->account.host);
    }
  }
  else
  {
    if (state->is_mailbox_list)
    {
      snprintf(title, sizeof(title), _("Mailboxes [%d]"),
               mutt_mailbox_check(m, MUTT_MAILBOX_CHECK_NO_FLAGS));
    }
    else
    {
      struct Buffer *path = buf_pool_get();
      buf_copy(path, &LastDir);
      buf_pretty_mailbox(path);
      const struct Regex *c_mask = cs_subset_regex(NeoMutt->sub, "mask");
      const bool c_imap_list_subscribed = cs_subset_bool(NeoMutt->sub, "imap_list_subscribed");
      if (state->imap_browse && c_imap_list_subscribed)
      {
        snprintf(title, sizeof(title), _("Subscribed [%s], File mask: %s"),
                 buf_string(path), NONULL(c_mask ? c_mask->pattern : NULL));
      }
      else
      {
        snprintf(title, sizeof(title), _("Directory [%s], File mask: %s"),
                 buf_string(path), NONULL(c_mask ? c_mask->pattern : NULL));
      }
      buf_pool_release(&path);
    }
  }
  sbar_set_title(sbar, title);
 
  /* Browser tracking feature.
   * The goal is to highlight the good directory if LastDir is the parent dir
   * of LastDirBackup (this occurs mostly when one hit "../"). It should also work
   * properly when the user is in examine_mailboxes-mode.  */
  if (mutt_str_startswith(buf_string(&LastDirBackup), buf_string(&LastDir)))
  {
    char target_dir[PATH_MAX] = { 0 };
 
    /* Check what kind of dir LastDirBackup is. */
    if (imap_path_probe(buf_string(&LastDirBackup), NULL) == MUTT_IMAP)
    {
      mutt_str_copy(target_dir, buf_string(&LastDirBackup), sizeof(target_dir));
      imap_clean_path(target_dir, sizeof(target_dir));
    }
    else
    {
      mutt_str_copy(target_dir, strrchr(buf_string(&LastDirBackup), '/') + 1,
                    sizeof(target_dir));
    }
 
    /* If we get here, it means that LastDir is the parent directory of
     * LastDirBackup.  I.e., we're returning from a subdirectory, and we want
     * to position the cursor on the directory we're returning from. */
    bool matched = false;
    struct FolderFile *ff = NULL;
    ARRAY_FOREACH(ff, &state->entry)
    {
      if (mutt_str_equal(ff->name, target_dir))
      {
        menu_set_index(menu, ARRAY_FOREACH_IDX_ff);
        matched = true;
        break;
      }
    }
    if (!matched)
      browser_highlight_default(state, menu);
  }
  else
  {
    browser_highlight_default(state, menu);
  }
 
  menu_queue_redraw(menu, MENU_REDRAW_FULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_browser_select_dir()

void mutt_browser_select_dir

(

const char *

f

)

Remember the last directory selected.

Parameters

f	Directory name to save

This function helps the browser to know which directory has been selected. It should be called anywhere a confirm hit is done to open a new directory/file which is a maildir/mbox.

We could check if the sort method is appropriate with this feature.

Definition at line 827 of file dlg_browser.c.

{
  init_lastdir();
 
  buf_strcpy(&LastDirBackup, f);
 
  /* Method that will fetch the parent path depending on the type of the path. */
  char buf[PATH_MAX] = { 0 };
  mutt_get_parent_path(buf_string(&LastDirBackup), buf, sizeof(buf));
  buf_strcpy(&LastDir, buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

FolderHelp

const struct Mapping FolderHelp[]

static

Initial value:

= {
  
  { N_("Exit"),  OP_EXIT },
  { N_("Chdir"), OP_CHANGE_DIRECTORY },
  { N_("Goto"),  OP_BROWSER_GOTO_FOLDER },
  { N_("Mask"),  OP_ENTER_MASK },
  { N_("Help"),  OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the File/Dir/Mailbox browser dialog.

Definition at line 109 of file dlg_browser.c.

                                           {
  // clang-format off
  { N_("Exit"),  OP_EXIT },
  { N_("Chdir"), OP_CHANGE_DIRECTORY },
  { N_("Goto"),  OP_BROWSER_GOTO_FOLDER },
  { N_("Mask"),  OP_ENTER_MASK },
  { N_("Help"),  OP_HELP },
  { NULL, 0 },
  // clang-format on
};

FolderNewsHelp

const struct Mapping FolderNewsHelp[]

static

Initial value:

= {
  
  { N_("Exit"),        OP_EXIT },
  { N_("List"),        OP_TOGGLE_MAILBOXES },
  { N_("Subscribe"),   OP_BROWSER_SUBSCRIBE },
  { N_("Unsubscribe"), OP_BROWSER_UNSUBSCRIBE },
  { N_("Catchup"),     OP_CATCHUP },
  { N_("Mask"),        OP_ENTER_MASK },
  { N_("Help"),        OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the NNTP Mailbox browser dialog.

Definition at line 121 of file dlg_browser.c.

                                               {
  // clang-format off
  { N_("Exit"),        OP_EXIT },
  { N_("List"),        OP_TOGGLE_MAILBOXES },
  { N_("Subscribe"),   OP_BROWSER_SUBSCRIBE },
  { N_("Unsubscribe"), OP_BROWSER_UNSUBSCRIBE },
  { N_("Catchup"),     OP_CATCHUP },
  { N_("Mask"),        OP_ENTER_MASK },
  { N_("Help"),        OP_HELP },
  { NULL, 0 },
  // clang-format on
};

LastDir

struct Buffer LastDir = { 0 }

Browser: previous selected directory.

Definition at line 135 of file dlg_browser.c.

{ 0 };

LastDirBackup

struct Buffer LastDirBackup = { 0 }

Browser: backup copy of the current directory.

Definition at line 137 of file dlg_browser.c.

{ 0 };