NeoMutt  2025-09-05-70-gcfdde0
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h File Reference

Select a Mailbox from a list. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
#include "mutt/lib.h"
+ Include dependency graph for lib.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Folder
 A folder/dir in the browser. More...
 
struct  FolderFile
 Browser entry representing a folder/dir. More...
 
struct  BrowserState
 State of the file/mailbox browser. More...
 

Macros

#define MUTT_SEL_NO_FLAGS   0
 No flags are set.
 
#define MUTT_SEL_MAILBOX   (1 << 0)
 Select a mailbox.
 
#define MUTT_SEL_MULTI   (1 << 1)
 Multi-selection is enabled.
 
#define MUTT_SEL_FOLDER   (1 << 2)
 Select a local directory.
 

Typedefs

typedef uint8_t SelectFileFlags
 Flags for mutt_select_file(), e.g. MUTT_SEL_MAILBOX.
 

Enumerations

enum  ExpandoDataFolder {
  ED_FOL_DATE = 1 , ED_FOL_DATE_FORMAT , ED_FOL_DATE_STRF , ED_FOL_DESCRIPTION ,
  ED_FOL_FILENAME , ED_FOL_FILE_GROUP , ED_FOL_FILE_MODE , ED_FOL_FILE_OWNER ,
  ED_FOL_FILE_SIZE , ED_FOL_FLAGS , ED_FOL_FLAGS2 , ED_FOL_HARD_LINKS ,
  ED_FOL_MESSAGE_COUNT , ED_FOL_NEWSGROUP , ED_FOL_NEW_COUNT , ED_FOL_NEW_MAIL ,
  ED_FOL_NOTIFY , ED_FOL_NUMBER , ED_FOL_POLL , ED_FOL_TAGGED ,
  ED_FOL_UNREAD_COUNT
}
 Expando UIDs for the File Browser. More...
 

Functions

 ARRAY_HEAD (BrowserEntryArray, struct FolderFile)
 
void dlg_browser (struct Buffer *file, SelectFileFlags flags, struct Mailbox *m, char ***files, int *numfiles)
 Let the user select a file -.
 
void mutt_browser_select_dir (const char *f)
 Remember the last directory selected.
 
void mutt_browser_cleanup (void)
 Clean up working Buffers.
 
void browser_sort (struct BrowserState *state)
 Sort the entries in the browser.
 
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 browser_highlight_default (struct BrowserState *state, struct Menu *menu)
 Decide which browser item should be highlighted.
 
int examine_directory (struct Mailbox *m, struct Menu *menu, struct BrowserState *state, const char *d, 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.
 
void init_menu (struct BrowserState *state, struct Menu *menu, struct Mailbox *m, struct MuttWindow *sbar)
 Set up a new menu.
 
void init_state (struct BrowserState *state)
 Initialise a browser state.
 
bool link_is_dir (const char *folder, const char *path)
 Does this symlink point to a directory?
 
void destroy_state (struct BrowserState *state)
 Free the BrowserState.
 
void dump_state (struct BrowserState *state)
 

Variables

struct Buffer LastDir
 Browser: previous selected directory.
 
struct Buffer LastDirBackup
 Browser: backup copy of the current directory.
 
const struct CompleteOps CompleteFileOps
 Auto-Completion of Files.
 
const struct CompleteOps CompleteMailboxOps
 Auto-Completion of Files / Mailboxes.
 

Detailed Description

Select a Mailbox from a list.

Authors
  • Richard Russon

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 lib.h.

Macro Definition Documentation

◆ MUTT_SEL_NO_FLAGS

#define MUTT_SEL_NO_FLAGS   0

No flags are set.

Definition at line 57 of file lib.h.

◆ MUTT_SEL_MAILBOX

#define MUTT_SEL_MAILBOX   (1 << 0)

Select a mailbox.

Definition at line 58 of file lib.h.

◆ MUTT_SEL_MULTI

#define MUTT_SEL_MULTI   (1 << 1)

Multi-selection is enabled.

Definition at line 59 of file lib.h.

◆ MUTT_SEL_FOLDER

#define MUTT_SEL_FOLDER   (1 << 2)

Select a local directory.

Definition at line 60 of file lib.h.

Typedef Documentation

◆ SelectFileFlags

typedef uint8_t SelectFileFlags

Flags for mutt_select_file(), e.g. MUTT_SEL_MAILBOX.

Definition at line 56 of file lib.h.

Enumeration Type Documentation

◆ ExpandoDataFolder

Expando UIDs for the File Browser.

See also
ED_FOLDER, ExpandoDomain
Enumerator
ED_FOL_DATE 

FolderFile.mtime.

ED_FOL_DATE_FORMAT 

FolderFile.mtime.

ED_FOL_DATE_STRF 

FolderFile.mtime.

ED_FOL_DESCRIPTION 

FolderFile.desc, FolderFile.name.

ED_FOL_FILENAME 

FolderFile.name.

ED_FOL_FILE_GROUP 

FolderFile.gid.

ED_FOL_FILE_MODE 

FolderFile.move.

ED_FOL_FILE_OWNER 

FolderFile.uid.

ED_FOL_FILE_SIZE 

FolderFile.size.

ED_FOL_FLAGS 

FolderFile.nd (NntpMboxData)

ED_FOL_FLAGS2 

FolderFile.nd (NntpMboxData)

ED_FOL_HARD_LINKS 

FolderFile.nlink.

ED_FOL_MESSAGE_COUNT 

FolderFile.msg_count.

ED_FOL_NEWSGROUP 

FolderFile.name.

ED_FOL_NEW_COUNT 

FolderFile.nd (NntpMboxData)

ED_FOL_NEW_MAIL 

FolderFile.has_new_mail.

ED_FOL_NOTIFY 

FolderFile.notify_user.

ED_FOL_NUMBER 

Folder.num.

ED_FOL_POLL 

FolderFile.poll_new_mail.

ED_FOL_TAGGED 

FolderFile.tagged.

ED_FOL_UNREAD_COUNT 

FolderFile.msg_unread.

Definition at line 115 of file lib.h.

116{
117 ED_FOL_DATE = 1,
138};
@ ED_FOL_POLL
FolderFile.poll_new_mail.
Definition lib.h:135
@ ED_FOL_NOTIFY
FolderFile.notify_user.
Definition lib.h:133
@ ED_FOL_NEW_COUNT
FolderFile.nd (NntpMboxData)
Definition lib.h:131
@ ED_FOL_FILE_OWNER
FolderFile.uid.
Definition lib.h:124
@ ED_FOL_FILE_GROUP
FolderFile.gid.
Definition lib.h:122
@ ED_FOL_FILENAME
FolderFile.name.
Definition lib.h:121
@ ED_FOL_DATE_FORMAT
FolderFile.mtime.
Definition lib.h:118
@ ED_FOL_DATE_STRF
FolderFile.mtime.
Definition lib.h:119
@ ED_FOL_UNREAD_COUNT
FolderFile.msg_unread.
Definition lib.h:137
@ ED_FOL_FLAGS2
FolderFile.nd (NntpMboxData)
Definition lib.h:127
@ ED_FOL_FILE_MODE
FolderFile.move.
Definition lib.h:123
@ ED_FOL_NEW_MAIL
FolderFile.has_new_mail.
Definition lib.h:132
@ ED_FOL_FILE_SIZE
FolderFile.size.
Definition lib.h:125
@ ED_FOL_HARD_LINKS
FolderFile.nlink.
Definition lib.h:128
@ ED_FOL_DATE
FolderFile.mtime.
Definition lib.h:117
@ ED_FOL_TAGGED
FolderFile.tagged.
Definition lib.h:136
@ ED_FOL_NUMBER
Folder.num.
Definition lib.h:134
@ ED_FOL_DESCRIPTION
FolderFile.desc, FolderFile.name.
Definition lib.h:120
@ ED_FOL_MESSAGE_COUNT
FolderFile.msg_count.
Definition lib.h:129
@ ED_FOL_NEWSGROUP
FolderFile.name.
Definition lib.h:130
@ ED_FOL_FLAGS
FolderFile.nd (NntpMboxData)
Definition lib.h:126

Function Documentation

◆ ARRAY_HEAD()

ARRAY_HEAD ( BrowserEntryArray ,
struct FolderFile  )

◆ mutt_browser_select_dir()

void mutt_browser_select_dir ( const char * f)

Remember the last directory selected.

Parameters
fDirectory 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.

828{
829 init_lastdir();
830
832
833 /* Method that will fetch the parent path depending on the type of the path. */
834 char buf[PATH_MAX] = { 0 };
835 mutt_get_parent_path(buf_string(&LastDirBackup), buf, sizeof(buf));
836 buf_strcpy(&LastDir, buf);
837}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition buffer.c:395
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
static void init_lastdir(void)
Initialise the browser directories.
struct Buffer LastDir
Browser: previous selected directory.
struct Buffer LastDirBackup
Browser: backup copy of the current directory.
#define PATH_MAX
Definition mutt.h:42
void mutt_get_parent_path(const char *path, char *buf, size_t buflen)
Find the parent of a path (or mailbox)
Definition muttlib.c:921
+ 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.

159{
162}
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition buffer.c:377
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ browser_sort()

void browser_sort ( struct BrowserState * state)

Sort the entries in the browser.

Parameters
stateBrowser state

Call to qsort using browser_sort_helper function. Some specific sort methods are not used via NNTP.

Definition at line 186 of file sort.c.

187{
188 const enum EmailSortType c_browser_sort = cs_subset_sort(NeoMutt->sub, "browser_sort");
189 switch (c_browser_sort & SORT_MASK)
190 {
193 if (OptNews)
194 return;
196 default:
197 break;
198 }
199
200 sort_t f = NULL;
201 switch (c_browser_sort & SORT_MASK)
202 {
205 break;
208 break;
211 break;
214 break;
215 case BROWSER_SORT_NEW:
217 break;
220 break;
222 default:
224 break;
225 }
226
227 struct CompareData cd = {
228 .sort_fn = f,
229 .sort_reverse = c_browser_sort & SORT_REVERSE,
230 .sort_dirs_first = cs_subset_bool(NeoMutt->sub, "browser_sort_dirs_first"),
231 };
232
233 ARRAY_SORT(&state->entry, browser_sort_helper, &cd);
234}
#define ARRAY_SORT(head, fn, sdata)
Sort an array.
Definition array.h:335
@ BROWSER_SORT_ALPHA
Sort by name.
Definition sort.h:31
@ BROWSER_SORT_UNSORTED
Sort into the raw order.
Definition sort.h:37
@ BROWSER_SORT_COUNT
Sort by total message count.
Definition sort.h:32
@ BROWSER_SORT_DATE
Sort by date.
Definition sort.h:33
@ BROWSER_SORT_NEW
Sort by count of new messages.
Definition sort.h:35
@ BROWSER_SORT_SIZE
Sort by size.
Definition sort.h:36
@ BROWSER_SORT_DESC
Sort by description.
Definition sort.h:34
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition helpers.c:47
short cs_subset_sort(const struct ConfigSubset *sub, const char *name)
Get a sort config item by name.
Definition helpers.c:266
#define SORT_MASK
Mask for the sort id.
Definition sort.h:38
#define SORT_REVERSE
Reverse the order of the sort.
Definition sort.h:39
EmailSortType
Methods for sorting Emails.
Definition sort.h:53
bool OptNews
(pseudo) used to change reader mode
Definition globals.c:64
static int browser_sort_desc(const void *a, const void *b, void *sdata)
Compare two browser entries by their descriptions - Implements sort_t -.
Definition sort.c:84
static int browser_sort_date(const void *a, const void *b, void *sdata)
Compare two browser entries by their date - Implements sort_t -.
Definition sort.c:95
static int browser_sort_count(const void *a, const void *b, void *sdata)
Compare two browser entries by their message count - Implements sort_t -.
Definition sort.c:117
static int browser_sort_size(const void *a, const void *b, void *sdata)
Compare two browser entries by their size - Implements sort_t -.
Definition sort.c:106
static int browser_sort_helper(const void *a, const void *b, void *sdata)
Helper to sort the items in the browser - Implements sort_t -.
Definition sort.c:159
static int browser_sort_new(const void *a, const void *b, void *sdata)
Compare two browser entries by their new count - Implements sort_t -.
Definition sort.c:136
static int browser_sort_subject(const void *a, const void *b, void *sdata)
Compare two browser entries by their subject - Implements sort_t -.
Definition sort.c:55
static int browser_sort_unsorted(const void *a, const void *b, void *sdata)
Compare two browser entries by their order - Implements sort_t -.
Definition sort.c:73
#define FALLTHROUGH
Definition lib.h:113
int(* sort_t)(const void *a, const void *b, void *sdata)
Definition qsort_r.h:41
struct BrowserEntryArray entry
Array of files / dirs / mailboxes.
Definition lib.h:145
Private data for browser_sort_helper()
Definition sort.c:46
Container for Accounts, Notifications.
Definition neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:46
+ 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
menuMenu to use
stateBrowser state
nameName of folder
descDescription of folder
ststat info for the folder
mMailbox
dataData to associate with the folder

Definition at line 197 of file dlg_browser.c.

200{
201 if ((!menu || state->is_mailbox_list) && m && !m->visible)
202 {
203 return;
204 }
205
206 struct FolderFile ff = { 0 };
207
208 if (st)
209 {
210 ff.mode = st->st_mode;
211 ff.mtime = st->st_mtime;
212 ff.size = st->st_size;
213 ff.gid = st->st_gid;
214 ff.uid = st->st_uid;
215 ff.nlink = st->st_nlink;
216 ff.local = true;
217 }
218 else
219 {
220 ff.local = false;
221 }
222
223 if (m)
224 {
225 ff.has_mailbox = true;
226 ff.gen = m->gen;
227 ff.has_new_mail = m->has_new;
228 ff.msg_count = m->msg_count;
229 ff.msg_unread = m->msg_unread;
230 ff.notify_user = m->notify_user;
232 }
233
234 ff.name = mutt_str_dup(name);
235 ff.desc = mutt_str_dup(desc ? desc : name);
236 ff.imap = false;
237 if (OptNews)
238 ff.nd = data;
239
240 ARRAY_ADD(&state->entry, ff);
241}
#define ARRAY_ADD(head, elem)
Add an element at the end of the array.
Definition array.h:156
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:255
bool is_mailbox_list
Viewing mailboxes.
Definition lib.h:148
Browser entry representing a folder/dir.
Definition lib.h:78
bool imap
This is an IMAP folder.
Definition lib.h:95
bool has_mailbox
This is a mailbox.
Definition lib.h:98
char * name
Name of file/dir/mailbox.
Definition lib.h:86
uid_t uid
File's User ID.
Definition lib.h:82
gid_t gid
File's Group ID.
Definition lib.h:83
bool has_new_mail
true if mailbox has "new mail"
Definition lib.h:89
bool poll_new_mail
Check mailbox for new mail.
Definition lib.h:101
bool notify_user
User will be notified of new mail.
Definition lib.h:100
nlink_t nlink
Number of hard links.
Definition lib.h:84
char * desc
Description of mailbox.
Definition lib.h:87
struct NntpMboxData * nd
Extra NNTP data.
Definition lib.h:103
off_t size
File size.
Definition lib.h:80
int gen
Unique id, used for (un)sorting.
Definition lib.h:105
bool local
Folder is on local filesystem.
Definition lib.h:99
time_t mtime
Modification time.
Definition lib.h:81
int msg_count
total number of messages
Definition lib.h:90
mode_t mode
File permissions.
Definition lib.h:79
int msg_unread
number of unread messages
Definition lib.h:91
bool has_new
Mailbox has new mail.
Definition mailbox.h:85
int msg_count
Total number of messages.
Definition mailbox.h:88
bool poll_new_mail
Check for new mail.
Definition mailbox.h:115
bool notify_user
Notify the user of new mail.
Definition mailbox.h:113
bool visible
True if a result of "mailboxes".
Definition mailbox.h:130
int msg_unread
Number of unread messages.
Definition mailbox.h:89
int gen
Generation number, for sorting.
Definition mailbox.h:147
+ 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
stateBrowser state
menuCurrent 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.

557{
558 menu->top = 0;
559 /* Reset menu position to 1.
560 * We do not risk overflow as the init_menu function changes
561 * current if it is bigger than state->entrylen. */
562 if (!ARRAY_EMPTY(&state->entry) &&
563 (mutt_str_equal(ARRAY_FIRST(&state->entry)->desc, "..") ||
564 mutt_str_equal(ARRAY_FIRST(&state->entry)->desc, "../")))
565 {
566 /* Skip the first entry, unless there's only one entry. */
567 menu_set_index(menu, (menu->max > 1));
568 }
569 else
570 {
571 menu_set_index(menu, 0);
572 }
573}
#define ARRAY_FIRST(head)
Convenience method to get the first element.
Definition array.h:135
#define ARRAY_EMPTY(head)
Check if an array is empty.
Definition array.h:74
MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
Set the current selection in the Menu.
Definition menu.c:174
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:660
int top
Entry that is the top of the current page.
Definition lib.h:90
int max
Number of entries in the menu.
Definition lib.h:81
+ Here is the call graph for this function:
+ 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
mMailbox
menuCurrent Menu
stateState of browser
dirnameDirectory
prefixFiles/newsgroups must match this prefix
Return values
0Success
-1Error

Definition at line 264 of file dlg_browser.c.

266{
267 int rc = -1;
268 struct Buffer *buf = buf_pool_get();
269 if (OptNews)
270 {
272
273 init_state(state);
274
275 const struct Regex *c_mask = cs_subset_regex(NeoMutt->sub, "mask");
276 for (unsigned int i = 0; i < adata->groups_num; i++)
277 {
278 struct NntpMboxData *mdata = adata->groups_list[i];
279 if (!mdata)
280 continue;
281 if (prefix && *prefix && !mutt_str_startswith(mdata->group, prefix))
282 continue;
283 if (!mutt_regex_match(c_mask, mdata->group))
284 {
285 continue;
286 }
287 browser_add_folder(menu, state, mdata->group, NULL, NULL, NULL, mdata);
288 }
289 }
290 else
291 {
292 struct stat st = { 0 };
293 DIR *dir = NULL;
294 struct dirent *de = NULL;
295
296 while (stat(dirname, &st) == -1)
297 {
298 if (errno == ENOENT)
299 {
300 /* The last used directory is deleted, try to use the parent dir. */
301 char *c = strrchr(dirname, '/');
302
303 if (c && (c > dirname))
304 {
305 *c = '\0';
306 continue;
307 }
308 }
309 mutt_perror("%s", dirname);
310 goto ed_out;
311 }
312
313 if (!S_ISDIR(st.st_mode))
314 {
315 mutt_error(_("%s is not a directory"), dirname);
316 goto ed_out;
317 }
318
319 if (m)
321
322 dir = mutt_file_opendir(dirname, MUTT_OPENDIR_NONE);
323 if (!dir)
324 {
325 mutt_perror("%s", dirname);
326 goto ed_out;
327 }
328
329 init_state(state);
330
331 struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
332
333 const struct Regex *c_mask = cs_subset_regex(NeoMutt->sub, "mask");
334 while ((de = readdir(dir)))
335 {
336 if (mutt_str_equal(de->d_name, "."))
337 continue; /* we don't need . */
338
339 if (prefix && *prefix && !mutt_str_startswith(de->d_name, prefix))
340 {
341 continue;
342 }
343 if (!mutt_regex_match(c_mask, de->d_name))
344 {
345 continue;
346 }
347
348 buf_concat_path(buf, dirname, de->d_name);
349 if (lstat(buf_string(buf), &st) == -1)
350 continue;
351
352 /* No size for directories or symlinks */
353 if (S_ISDIR(st.st_mode) || S_ISLNK(st.st_mode))
354 st.st_size = 0;
355 else if (!S_ISREG(st.st_mode))
356 continue;
357
358 struct Mailbox **mp = NULL;
359 ARRAY_FOREACH(mp, &ma)
360 {
361 if (mutt_str_equal(buf_string(buf), mailbox_path(*mp)))
362 break;
363 }
364
365 struct Mailbox *m_match = mp ? *mp : NULL;
366 if (m_match && m && m->poll_new_mail && mutt_str_equal(m_match->realpath, m->realpath))
367 {
368 m_match->msg_count = m->msg_count;
369 m_match->msg_unread = m->msg_unread;
370 }
371 browser_add_folder(menu, state, de->d_name, NULL, &st, m_match, NULL);
372 }
373 ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
374 closedir(dir);
375 }
376 browser_sort(state);
377 rc = 0;
378ed_out:
379 buf_pool_release(&buf);
380 return rc;
381}
#define ARRAY_FOREACH(elem, head)
Iterate over all elements of the array.
Definition array.h:214
#define ARRAY_FREE(head)
Release all memory.
Definition array.h:204
void browser_sort(struct BrowserState *state)
Sort the entries in the browser.
Definition sort.c:186
size_t buf_concat_path(struct Buffer *buf, const char *dir, const char *fname)
Join a directory name and a filename.
Definition buffer.c:509
const struct Regex * cs_subset_regex(const struct ConfigSubset *sub, const char *name)
Get a regex config item by name.
Definition helpers.c:217
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition mailbox.h:214
@ MUTT_MAILBOX_ANY
Match any Mailbox type.
Definition mailbox.h:42
void init_state(struct BrowserState *state)
Initialise a browser state.
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.
DIR * mutt_file_opendir(const char *path, enum MuttOpenDirMode mode)
Open a directory.
Definition file.c:542
@ MUTT_OPENDIR_NONE
Plain opendir()
Definition file.h:63
#define mutt_error(...)
Definition logging2.h:93
#define mutt_perror(...)
Definition logging2.h:94
#define _(a)
Definition message.h:28
bool mutt_regex_match(const struct Regex *regex, const char *str)
Shorthand to mutt_regex_capture()
Definition regex.c:613
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition string.c:232
int mutt_mailbox_check(struct Mailbox *m_cur, CheckStatsFlags flags)
Check all all Mailboxes for new mail.
#define MUTT_MAILBOX_CHECK_NO_FLAGS
No flags are set.
Definition mxapi.h:50
struct MailboxArray neomutt_mailboxes_get(struct NeoMutt *n, enum MailboxType type)
Get an Array of matching Mailboxes.
Definition neomutt.c:184
struct NntpAccountData * CurrentNewsSrv
Current NNTP news server.
Definition nntp.c:76
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:82
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:96
void * adata
Private data (for Mailbox backends)
Definition account.h:42
String manipulation buffer.
Definition buffer.h:36
A mailbox.
Definition mailbox.h:79
char * realpath
Used for duplicate detection, context comparison, and the sidebar.
Definition mailbox.h:81
void * mdata
Driver specific data.
Definition mailbox.h:132
NNTP-specific Account data -.
Definition adata.h:36
struct NntpMboxData ** groups_list
Definition adata.h:60
unsigned int groups_num
Definition adata.h:58
NNTP-specific Mailbox data -.
Definition mdata.h:34
struct NntpAccountData * adata
Definition mdata.h:48
Cached regular expression.
Definition regex3.h:86
+ 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
mMailbox
menuCurrent menu
stateState of browser
Return values
0Success
-1Error

Definition at line 391 of file dlg_browser.c.

392{
393 struct stat st = { 0 };
394 struct Buffer *md = NULL;
395 struct Buffer *mailbox = NULL;
396
397 if (OptNews)
398 {
400
401 init_state(state);
402
403 const bool c_show_only_unread = cs_subset_bool(NeoMutt->sub, "show_only_unread");
404 for (unsigned int i = 0; i < adata->groups_num; i++)
405 {
406 struct NntpMboxData *mdata = adata->groups_list[i];
407 if (mdata && (mdata->has_new_mail ||
408 (mdata->subscribed && (mdata->unread || !c_show_only_unread))))
409 {
410 browser_add_folder(menu, state, mdata->group, NULL, NULL, NULL, mdata);
411 }
412 }
413 }
414 else
415 {
416 init_state(state);
417
419 return -1;
420
421 mailbox = buf_pool_get();
422 md = buf_pool_get();
423
425
426 struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
427 const bool c_browser_abbreviate_mailboxes = cs_subset_bool(NeoMutt->sub, "browser_abbreviate_mailboxes");
428
429 struct Mailbox **mp = NULL;
430 ARRAY_FOREACH(mp, &ma)
431 {
432 struct Mailbox *m_match = *mp;
433
434 if (m && m->poll_new_mail && mutt_str_equal(m_match->realpath, m->realpath))
435 {
436 m_match->msg_count = m->msg_count;
437 m_match->msg_unread = m->msg_unread;
438 }
439
440 buf_strcpy(mailbox, mailbox_path(m_match));
441 if (c_browser_abbreviate_mailboxes)
442 buf_pretty_mailbox(mailbox);
443
444 switch (m_match->type)
445 {
446 case MUTT_IMAP:
447 case MUTT_POP:
448 browser_add_folder(menu, state, buf_string(mailbox), m_match->name,
449 NULL, m_match, NULL);
450 continue;
451 case MUTT_NOTMUCH:
452 case MUTT_NNTP:
453 browser_add_folder(menu, state, mailbox_path(m_match), m_match->name,
454 NULL, m_match, NULL);
455 continue;
456 default: /* Continue */
457 break;
458 }
459
460 if (lstat(mailbox_path(m_match), &st) == -1)
461 continue;
462
463 if ((!S_ISREG(st.st_mode)) && (!S_ISDIR(st.st_mode)) && (!S_ISLNK(st.st_mode)))
464 continue;
465
466 if (m_match->type == MUTT_MAILDIR)
467 {
468 struct stat st2 = { 0 };
469
470 buf_printf(md, "%s/new", mailbox_path(m_match));
471 if (stat(buf_string(md), &st) < 0)
472 st.st_mtime = 0;
473 buf_printf(md, "%s/cur", mailbox_path(m_match));
474 if (stat(buf_string(md), &st2) < 0)
475 st2.st_mtime = 0;
476 if (st2.st_mtime > st.st_mtime)
477 st.st_mtime = st2.st_mtime;
478 }
479
480 browser_add_folder(menu, state, buf_string(mailbox), m_match->name, &st, m_match, NULL);
481 }
482 ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
483 }
484 browser_sort(state);
485
486 buf_pool_release(&mailbox);
487 buf_pool_release(&md);
488 return 0;
489}
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition buffer.c:161
@ MUTT_NOTMUCH
'Notmuch' (virtual) Mailbox type
Definition mailbox.h:51
@ MUTT_POP
'POP3' Mailbox type
Definition mailbox.h:52
@ MUTT_NNTP
'NNTP' (Usenet) Mailbox type
Definition mailbox.h:49
@ MUTT_IMAP
'IMAP' Mailbox type
Definition mailbox.h:50
@ MUTT_MAILDIR
'Maildir' Mailbox type
Definition mailbox.h:48
void buf_pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition muttlib.c:518
enum MailboxType type
Mailbox type.
Definition mailbox.h:102
char * name
A short name for the Mailbox.
Definition mailbox.h:82
struct AccountArray accounts
All Accounts.
Definition neomutt.h:47
+ 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
stateBrowser state
menuCurrent menu
mMailbox
sbarStatus bar

Definition at line 582 of file dlg_browser.c.

584{
585 char title[256] = { 0 };
586 menu->max = ARRAY_SIZE(&state->entry);
587
588 int index = menu_get_index(menu);
589 if (index >= menu->max)
590 menu_set_index(menu, menu->max - 1);
591 if (index < 0)
592 menu_set_index(menu, 0);
593 if (menu->top > index)
594 menu->top = 0;
595
596 menu->num_tagged = 0;
597
598 if (OptNews)
599 {
600 if (state->is_mailbox_list)
601 {
602 snprintf(title, sizeof(title), _("Subscribed newsgroups"));
603 }
604 else
605 {
606 snprintf(title, sizeof(title), _("Newsgroups on server [%s]"),
607 CurrentNewsSrv->conn->account.host);
608 }
609 }
610 else
611 {
612 if (state->is_mailbox_list)
613 {
614 snprintf(title, sizeof(title), _("Mailboxes [%d]"),
616 }
617 else
618 {
619 struct Buffer *path = buf_pool_get();
620 buf_copy(path, &LastDir);
621 buf_pretty_mailbox(path);
622 const struct Regex *c_mask = cs_subset_regex(NeoMutt->sub, "mask");
623 const bool c_imap_list_subscribed = cs_subset_bool(NeoMutt->sub, "imap_list_subscribed");
624 if (state->imap_browse && c_imap_list_subscribed)
625 {
626 snprintf(title, sizeof(title), _("Subscribed [%s], File mask: %s"),
627 buf_string(path), NONULL(c_mask ? c_mask->pattern : NULL));
628 }
629 else
630 {
631 snprintf(title, sizeof(title), _("Directory [%s], File mask: %s"),
632 buf_string(path), NONULL(c_mask ? c_mask->pattern : NULL));
633 }
634 buf_pool_release(&path);
635 }
636 }
637 sbar_set_title(sbar, title);
638
639 /* Browser tracking feature.
640 * The goal is to highlight the good directory if LastDir is the parent dir
641 * of LastDirBackup (this occurs mostly when one hit "../"). It should also work
642 * properly when the user is in examine_mailboxes-mode. */
644 {
645 char target_dir[PATH_MAX] = { 0 };
646
647 /* Check what kind of dir LastDirBackup is. */
649 {
650 mutt_str_copy(target_dir, buf_string(&LastDirBackup), sizeof(target_dir));
651 imap_clean_path(target_dir, sizeof(target_dir));
652 }
653 else
654 {
655 mutt_str_copy(target_dir, strrchr(buf_string(&LastDirBackup), '/') + 1,
656 sizeof(target_dir));
657 }
658
659 /* If we get here, it means that LastDir is the parent directory of
660 * LastDirBackup. I.e., we're returning from a subdirectory, and we want
661 * to position the cursor on the directory we're returning from. */
662 bool matched = false;
663 struct FolderFile *ff = NULL;
664 ARRAY_FOREACH(ff, &state->entry)
665 {
666 if (mutt_str_equal(ff->name, target_dir))
667 {
668 menu_set_index(menu, ARRAY_FOREACH_IDX_ff);
669 matched = true;
670 break;
671 }
672 }
673 if (!matched)
674 browser_highlight_default(state, menu);
675 }
676 else
677 {
678 browser_highlight_default(state, menu);
679 }
680
682}
#define ARRAY_SIZE(head)
The number of elements stored.
Definition array.h:87
size_t buf_copy(struct Buffer *dst, const struct Buffer *src)
Copy a Buffer's contents to another Buffer.
Definition buffer.c:601
void browser_highlight_default(struct BrowserState *state, struct Menu *menu)
Decide which browser item should be highlighted.
enum MailboxType imap_path_probe(const char *path, const struct stat *st)
Is this an IMAP Mailbox?
Definition imap.c:2351
void imap_clean_path(char *path, size_t plen)
Cleans an IMAP path using imap_fix_path.
Definition util.c:191
#define MENU_REDRAW_FULL
Redraw everything.
Definition lib.h:59
void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw)
Queue a request for a redraw.
Definition menu.c:184
int menu_get_index(struct Menu *menu)
Get the current selection in the Menu.
Definition menu.c:160
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition string.c:581
void sbar_set_title(struct MuttWindow *win, const char *title)
Set the title for the Simple Bar.
Definition sbar.c:227
#define NONULL(x)
Definition string2.h:43
bool imap_browse
IMAP folder.
Definition lib.h:146
int num_tagged
Number of tagged entries.
Definition lib.h:93
char * pattern
printable version
Definition regex3.h:87
+ 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
stateBrowserState to initialise

Definition at line 247 of file dlg_browser.c.

248{
249 ARRAY_INIT(&state->entry);
250 ARRAY_RESERVE(&state->entry, 256);
251 state->imap_browse = false;
252}
#define ARRAY_RESERVE(head, num)
Reserve memory for the array.
Definition array.h:189
#define ARRAY_INIT(head)
Initialize an array.
Definition array.h:65
+ 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
folderFolder
pathLink name
Return values
trueLinks to a directory
falseOtherwise

Definition at line 171 of file dlg_browser.c.

172{
173 struct stat st = { 0 };
174 bool rc = false;
175
176 struct Buffer *fullpath = buf_pool_get();
177 buf_concat_path(fullpath, folder, path);
178
179 if (stat(buf_string(fullpath), &st) == 0)
180 rc = S_ISDIR(st.st_mode);
181
182 buf_pool_release(&fullpath);
183
184 return rc;
185}
+ 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
stateState to free

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

Definition at line 135 of file functions.c.

136{
137 struct FolderFile *ff = NULL;
138 ARRAY_FOREACH(ff, &state->entry)
139 {
140 FREE(&ff->name);
141 FREE(&ff->desc);
142 }
143 ARRAY_FREE(&state->entry);
144 FREE(&state->folder);
145}
#define FREE(x)
Definition memory.h:62
char * folder
Folder name.
Definition lib.h:147
+ Here is the caller graph for this function:

◆ dump_state()

void dump_state ( struct BrowserState * state)

Variable Documentation

◆ LastDir

struct Buffer LastDir
extern

Browser: previous selected directory.

Definition at line 135 of file dlg_browser.c.

135{ 0 };

◆ LastDirBackup

struct Buffer LastDirBackup
extern

Browser: backup copy of the current directory.

Definition at line 137 of file dlg_browser.c.

137{ 0 };

◆ CompleteFileOps

const struct CompleteOps CompleteFileOps
extern

Auto-Completion of Files.

Definition at line 152 of file complete.c.

152 {
153 .complete = complete_file_simple,
154};
enum FunctionRetval complete_file_simple(struct EnterWindowData *wdata, int op)
Complete a filename - Implements CompleteOps::complete() -.
Definition complete.c:112

◆ CompleteMailboxOps

const struct CompleteOps CompleteMailboxOps
extern

Auto-Completion of Files / Mailboxes.

Definition at line 159 of file complete.c.

159 {
160 .complete = complete_file_mbox,
161};
enum FunctionRetval complete_file_mbox(struct EnterWindowData *wdata, int op)
Complete a Mailbox - Implements CompleteOps::complete() -.
Definition complete.c:45