NeoMutt  2022-04-29-247-gc6aae8
Teaching an old dog new tricks
DOXYGEN
path_probe()

Does this Mailbox type recognise this path? More...

+ Collaboration diagram for path_probe():

Functions

static enum MailboxType comp_path_probe (const char *path, const struct stat *st)
 Is this a compressed Mailbox? - Implements MxOps::path_probe() -. More...
 
enum MailboxType imap_path_probe (const char *path, const struct stat *st)
 Is this an IMAP Mailbox? - Implements MxOps::path_probe() -. More...
 
static enum MailboxType maildir_path_probe (const char *path, const struct stat *st)
 Is this a Maildir Mailbox? - Implements MxOps::path_probe() -. More...
 
static enum MailboxType mh_path_probe (const char *path, const struct stat *st)
 Is this an mh Mailbox? - Implements MxOps::path_probe() -. More...
 
enum MailboxType mbox_path_probe (const char *path, const struct stat *st)
 Is this an mbox Mailbox? - Implements MxOps::path_probe() -. More...
 
enum MailboxType nntp_path_probe (const char *path, const struct stat *st)
 Is this an NNTP Mailbox? - Implements MxOps::path_probe() -. More...
 
enum MailboxType nm_path_probe (const char *path, const struct stat *st)
 Is this a Notmuch Mailbox? - Implements MxOps::path_probe() -. More...
 
enum MailboxType pop_path_probe (const char *path, const struct stat *st)
 Is this a POP Mailbox? - Implements MxOps::path_probe() -. More...
 

Detailed Description

Does this Mailbox type recognise this path?

Parameters
pathPath to examine
ststat buffer (for local filesystems)
Return values
numType, e.g. MUTT_IMAP

Contract

Function Documentation

◆ comp_path_probe()

static enum MailboxType comp_path_probe ( const char *  path,
const struct stat *  st 
)
static

Is this a compressed Mailbox? - Implements MxOps::path_probe() -.

Definition at line 880 of file compress.c.

881{
882 if (!st || !S_ISREG(st->st_mode))
883 return MUTT_UNKNOWN;
884
885 if (mutt_comp_can_read(path))
886 return MUTT_COMPRESSED;
887
888 return MUTT_UNKNOWN;
889}
bool mutt_comp_can_read(const char *path)
Can we read from this file?
Definition: compress.c:391
@ MUTT_COMPRESSED
Compressed file Mailbox type.
Definition: mailbox.h:53
@ MUTT_UNKNOWN
Mailbox wasn't recognised.
Definition: mailbox.h:44
+ Here is the call graph for this function:

◆ imap_path_probe()

enum MailboxType imap_path_probe ( const char *  path,
const struct stat *  st 
)

Is this an IMAP Mailbox? - Implements MxOps::path_probe() -.

Definition at line 2400 of file imap.c.

2401{
2402 if (mutt_istr_startswith(path, "imap://"))
2403 return MUTT_IMAP;
2404
2405 if (mutt_istr_startswith(path, "imaps://"))
2406 return MUTT_IMAP;
2407
2408 return MUTT_UNKNOWN;
2409}
@ MUTT_IMAP
'IMAP' Mailbox type
Definition: mailbox.h:50
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:239
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ maildir_path_probe()

static enum MailboxType maildir_path_probe ( const char *  path,
const struct stat *  st 
)
static

Is this a Maildir Mailbox? - Implements MxOps::path_probe() -.

Definition at line 1626 of file maildir.c.

1627{
1628 if (!st || !S_ISDIR(st->st_mode))
1629 return MUTT_UNKNOWN;
1630
1631 char cur[PATH_MAX] = { 0 };
1632 snprintf(cur, sizeof(cur), "%s/cur", path);
1633
1634 struct stat st_cur = { 0 };
1635 if ((stat(cur, &st_cur) == 0) && S_ISDIR(st_cur.st_mode))
1636 return MUTT_MAILDIR;
1637
1638 return MUTT_UNKNOWN;
1639}
@ MUTT_MAILDIR
'Maildir' Mailbox type
Definition: mailbox.h:48
#define PATH_MAX
Definition: mutt.h:40

◆ mh_path_probe()

static enum MailboxType mh_path_probe ( const char *  path,
const struct stat *  st 
)
static

Is this an mh Mailbox? - Implements MxOps::path_probe() -.

Definition at line 1214 of file mh.c.

1215{
1216 if (!st || !S_ISDIR(st->st_mode))
1217 return MUTT_UNKNOWN;
1218
1219 char tmp[PATH_MAX] = { 0 };
1220
1221 snprintf(tmp, sizeof(tmp), "%s/.mh_sequences", path);
1222 if (access(tmp, F_OK) == 0)
1223 return MUTT_MH;
1224
1225 snprintf(tmp, sizeof(tmp), "%s/.xmhcache", path);
1226 if (access(tmp, F_OK) == 0)
1227 return MUTT_MH;
1228
1229 snprintf(tmp, sizeof(tmp), "%s/.mew_cache", path);
1230 if (access(tmp, F_OK) == 0)
1231 return MUTT_MH;
1232
1233 snprintf(tmp, sizeof(tmp), "%s/.mew-cache", path);
1234 if (access(tmp, F_OK) == 0)
1235 return MUTT_MH;
1236
1237 snprintf(tmp, sizeof(tmp), "%s/.sylpheed_cache", path);
1238 if (access(tmp, F_OK) == 0)
1239 return MUTT_MH;
1240
1241 /* ok, this isn't an mh folder, but mh mode can be used to read
1242 * Usenet news from the spool. */
1243
1244 snprintf(tmp, sizeof(tmp), "%s/.overview", path);
1245 if (access(tmp, F_OK) == 0)
1246 return MUTT_MH;
1247
1248 return MUTT_UNKNOWN;
1249}
@ MUTT_MH
'MH' Mailbox type
Definition: mailbox.h:47

◆ mbox_path_probe()

enum MailboxType mbox_path_probe ( const char *  path,
const struct stat *  st 
)

Is this an mbox Mailbox? - Implements MxOps::path_probe() -.

Definition at line 1643 of file mbox.c.

1644{
1645 if (!st)
1646 return MUTT_UNKNOWN;
1647
1648 if (S_ISDIR(st->st_mode))
1649 return MUTT_UNKNOWN;
1650
1651 if (st->st_size == 0)
1652 return MUTT_MBOX;
1653
1654 FILE *fp = fopen(path, "r");
1655 if (!fp)
1656 return MUTT_UNKNOWN;
1657
1658 int ch;
1659 while ((ch = fgetc(fp)) != EOF)
1660 {
1661 /* Some mailbox creation tools erroneously append a blank line to
1662 * a file before appending a mail message. This allows neomutt to
1663 * detect type for and thus open those files. */
1664 if ((ch != '\n') && (ch != '\r'))
1665 {
1666 ungetc(ch, fp);
1667 break;
1668 }
1669 }
1670
1671 enum MailboxType type = MUTT_UNKNOWN;
1672 char tmp[256] = { 0 };
1673 if (fgets(tmp, sizeof(tmp), fp))
1674 {
1675 if (mutt_str_startswith(tmp, "From "))
1676 type = MUTT_MBOX;
1677 else if (mutt_str_equal(tmp, MMDF_SEP))
1678 type = MUTT_MMDF;
1679 }
1680 mutt_file_fclose(&fp);
1681
1682 const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
1683 if (!c_check_mbox_size)
1684 {
1685 /* need to restore the times here, the file was not really accessed,
1686 * only the type was accessed. This is important, because detection
1687 * of "new mail" depends on those times set correctly. */
1688#ifdef HAVE_UTIMENSAT
1689 struct timespec ts[2];
1692 utimensat(AT_FDCWD, path, ts, 0);
1693#else
1694 struct utimbuf times;
1695 times.actime = st->st_atime;
1696 times.modtime = st->st_mtime;
1697 utime(path, &times);
1698#endif
1699 }
1700
1701 return type;
1702}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:73
void mutt_file_get_stat_timespec(struct timespec *dest, struct stat *st, enum MuttStatType type)
Read the stat() time into a time value.
Definition: file.c:1611
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:152
@ MUTT_STAT_ATIME
File/dir's atime - last accessed time.
Definition: file.h:62
@ MUTT_STAT_MTIME
File/dir's mtime - last modified time.
Definition: file.h:63
MailboxType
Supported mailbox formats.
Definition: mailbox.h:41
@ MUTT_MMDF
'mmdf' Mailbox type
Definition: mailbox.h:46
@ MUTT_MBOX
'mbox' Mailbox type
Definition: mailbox.h:45
#define MMDF_SEP
Definition: lib.h:61
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:807
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition: string.c:227
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
Time value with nanosecond precision.
Definition: file.h:49
+ Here is the call graph for this function:

◆ nntp_path_probe()

enum MailboxType nntp_path_probe ( const char *  path,
const struct stat *  st 
)

Is this an NNTP Mailbox? - Implements MxOps::path_probe() -.

Definition at line 2701 of file nntp.c.

2702{
2703 if (mutt_istr_startswith(path, "news://"))
2704 return MUTT_NNTP;
2705
2706 if (mutt_istr_startswith(path, "snews://"))
2707 return MUTT_NNTP;
2708
2709 return MUTT_UNKNOWN;
2710}
@ MUTT_NNTP
'NNTP' (Usenet) Mailbox type
Definition: mailbox.h:49
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nm_path_probe()

enum MailboxType nm_path_probe ( const char *  path,
const struct stat *  st 
)

Is this a Notmuch Mailbox? - Implements MxOps::path_probe() -.

Definition at line 2433 of file notmuch.c.

2434{
2436 return MUTT_UNKNOWN;
2437
2438 return MUTT_NOTMUCH;
2439}
@ MUTT_NOTMUCH
'Notmuch' (virtual) Mailbox type
Definition: mailbox.h:51
const char NmUrlProtocol[]
Definition: notmuch.c:93
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ pop_path_probe()

enum MailboxType pop_path_probe ( const char *  path,
const struct stat *  st 
)

Is this a POP Mailbox? - Implements MxOps::path_probe() -.

Definition at line 1157 of file pop.c.

1158{
1159 if (mutt_istr_startswith(path, "pop://"))
1160 return MUTT_POP;
1161
1162 if (mutt_istr_startswith(path, "pops://"))
1163 return MUTT_POP;
1164
1165 return MUTT_UNKNOWN;
1166}
@ MUTT_POP
'POP3' Mailbox type
Definition: mailbox.h:52
+ Here is the call graph for this function:
+ Here is the caller graph for this function: