NeoMutt  2025-12-11-117-gc1a713
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
mbox_check_stats()

Check the Mailbox statistics. More...

+ Collaboration diagram for mbox_check_stats():

Functions

static enum MxStatus imap_mbox_check_stats (struct Mailbox *m, uint8_t flags)
 Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.
 
enum MxStatus maildir_mbox_check_stats (struct Mailbox *m, uint8_t flags)
 Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.
 
static enum MxStatus mbox_mbox_check_stats (struct Mailbox *m, uint8_t flags)
 Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.
 
static enum MxStatus mh_mbox_check_stats (struct Mailbox *m, uint8_t flags)
 Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.
 
static enum MxStatus nm_mbox_check_stats (struct Mailbox *m, uint8_t flags)
 Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.
 

Detailed Description

Check the Mailbox statistics.

Parameters
mMailbox to check
flagsFunction flags
Return values
enumMxStatus
Precondition
m is not NULL

Function Documentation

◆ imap_mbox_check_stats()

static enum MxStatus imap_mbox_check_stats ( struct Mailbox * m,
uint8_t flags )
static

Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.

Definition at line 1264 of file imap.c.

1265{
1266 const bool queue = (flags & MUTT_MAILBOX_CHECK_IMMEDIATE) == 0;
1267 const int new_msgs = imap_mailbox_status(m, queue);
1268 if (new_msgs == -1)
1269 return MX_STATUS_ERROR;
1270 if (new_msgs == 0)
1271 return MX_STATUS_OK;
1272 return MX_STATUS_NEW_MAIL;
1273}
int imap_mailbox_status(struct Mailbox *m, bool queue)
Refresh the number of total and new messages.
Definition imap.c:1316
#define MUTT_MAILBOX_CHECK_IMMEDIATE
Don't postpone the actual checking.
Definition mxapi.h:53
@ MX_STATUS_ERROR
An error occurred.
Definition mxapi.h:61
@ MX_STATUS_OK
No changes.
Definition mxapi.h:62
@ MX_STATUS_NEW_MAIL
New mail received in Mailbox.
Definition mxapi.h:63
+ Here is the call graph for this function:

◆ maildir_mbox_check_stats()

enum MxStatus maildir_mbox_check_stats ( struct Mailbox * m,
uint8_t flags )

Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.

Definition at line 814 of file mailbox.c.

815{
816 bool check_stats = flags & MUTT_MAILBOX_CHECK_STATS;
817 bool check_new = true;
818
819 if (check_stats)
820 {
821 m->msg_new = 0;
822 m->msg_count = 0;
823 m->msg_unread = 0;
824 m->msg_flagged = 0;
825 }
826
827 maildir_check_dir(m, "new", check_new, check_stats);
828
829 const bool c_maildir_check_cur = cs_subset_bool(NeoMutt->sub, "maildir_check_cur");
830 check_new = !m->has_new && c_maildir_check_cur;
831 if (check_new || check_stats)
832 maildir_check_dir(m, "cur", check_new, check_stats);
833
835}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition helpers.c:47
static void maildir_check_dir(struct Mailbox *m, const char *dir_name, bool check_new, bool check_stats)
Check for new mail / mail counts.
Definition mailbox.c:390
#define MUTT_MAILBOX_CHECK_STATS
Ignore mail_check_stats and calculate statistics (used by <check-stats>)
Definition mxapi.h:52
bool has_new
Mailbox has new mail.
Definition mailbox.h:85
int msg_new
Number of new messages.
Definition mailbox.h:92
int msg_count
Total number of messages.
Definition mailbox.h:88
int msg_flagged
Number of flagged messages.
Definition mailbox.h:90
int msg_unread
Number of unread messages.
Definition mailbox.h:89
Container for Accounts, Notifications.
Definition neomutt.h:128
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:134
+ Here is the call graph for this function:

◆ mbox_mbox_check_stats()

static enum MxStatus mbox_mbox_check_stats ( struct Mailbox * m,
uint8_t flags )
static

Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.

Definition at line 1650 of file mbox.c.

1651{
1652 struct stat st = { 0 };
1653 if (stat(mailbox_path(m), &st) != 0)
1654 return MX_STATUS_ERROR;
1655
1656 bool new_or_changed;
1657
1658 const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
1659 if (c_check_mbox_size)
1660 {
1661 new_or_changed = (st.st_size > m->size);
1662 }
1663 else
1664 {
1665 new_or_changed =
1667 (m->newly_created &&
1670 }
1671
1672 if (new_or_changed)
1673 {
1674 const bool c_mail_check_recent = cs_subset_bool(NeoMutt->sub, "mail_check_recent");
1675 if (!c_mail_check_recent ||
1677 {
1678 m->has_new = true;
1679 }
1680 }
1681 else if (c_check_mbox_size)
1682 {
1683 /* some other program has deleted mail from the folder */
1684 m->size = (off_t) st.st_size;
1685 }
1686
1687 if (m->newly_created && ((st.st_ctime != st.st_mtime) || (st.st_ctime != st.st_atime)))
1688 m->newly_created = false;
1689
1690 if (flags & MUTT_MAILBOX_CHECK_STATS)
1691 {
1694 &adata->stats_last_checked) > 0)
1695 {
1696 bool old_peek = m->peekonly;
1698 mx_mbox_close(m);
1699 m->peekonly = old_peek;
1700 mutt_time_now(&adata->stats_last_checked);
1701 }
1702 }
1703
1704 if (m->has_new || m->msg_new)
1705 return MX_STATUS_NEW_MAIL;
1706 return MX_STATUS_OK;
1707}
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition mailbox.h:214
int mutt_file_stat_compare(struct stat *st1, enum MuttStatType st1_type, struct stat *st2, enum MuttStatType st2_type)
Compare two stat infos.
Definition file.c:1535
int mutt_file_stat_timespec_compare(struct stat *st, enum MuttStatType type, struct timespec *b)
Compare stat info with a time value.
Definition file.c:1513
@ MUTT_STAT_CTIME
File/dir's ctime - creation time.
Definition file.h:55
@ MUTT_STAT_ATIME
File/dir's atime - last accessed time.
Definition file.h:53
@ MUTT_STAT_MTIME
File/dir's mtime - last modified time.
Definition file.h:54
static struct MboxAccountData * mbox_adata_get(struct Mailbox *m)
Get the private data associated with a Mailbox.
Definition mbox.c:124
void mutt_time_now(struct timespec *tp)
Set the provided time field to the current time.
Definition date.c:481
bool mx_mbox_open(struct Mailbox *m, OpenMailboxFlags flags)
Open a mailbox and parse it.
Definition mx.c:288
enum MxStatus mx_mbox_close(struct Mailbox *m)
Save changes and close mailbox.
Definition mx.c:598
#define MUTT_QUIET
Do not print any messages.
Definition mxapi.h:44
#define MUTT_PEEK
Revert atime back after taking a look (if applicable)
Definition mxapi.h:45
#define MUTT_NOSORT
Do not sort the mailbox after opening it.
Definition mxapi.h:41
void * adata
Private data (for Mailbox backends)
Definition account.h:42
bool newly_created
Mbox or mmdf just popped into existence.
Definition mailbox.h:103
bool peekonly
Just taking a glance, revert atime.
Definition mailbox.h:114
off_t size
Size of the Mailbox.
Definition mailbox.h:84
struct timespec last_visited
Time of last exit from this mailbox.
Definition mailbox.h:104
Mbox-specific Account data -.
Definition lib.h:50
+ Here is the call graph for this function:

◆ mh_mbox_check_stats()

static enum MxStatus mh_mbox_check_stats ( struct Mailbox * m,
uint8_t flags )
static

Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.

Definition at line 142 of file mh.c.

143{
144 struct MhSequences mhs = { 0 };
145 DIR *dir = NULL;
146 struct dirent *de = NULL;
147
148 /* when $mail_check_recent is set and the .mh_sequences file hasn't changed
149 * since the last m visit, there is no "new mail" */
150 const bool c_mail_check_recent = cs_subset_bool(NeoMutt->sub, "mail_check_recent");
151 if (c_mail_check_recent && (mh_seq_changed(m) <= 0))
152 {
153 return MX_STATUS_OK;
154 }
155
156 if (mh_seq_read(&mhs, mailbox_path(m)) < 0)
157 return MX_STATUS_ERROR;
158
159 m->msg_count = 0;
160 m->msg_unread = 0;
161 m->msg_flagged = 0;
162
163 enum MxStatus rc = MX_STATUS_OK;
164 bool check_new = true;
165 for (int i = mhs.max; i > 0; i--)
166 {
167 if ((mh_seq_check(&mhs, i) & MH_SEQ_FLAGGED))
168 m->msg_flagged++;
169 if (mh_seq_check(&mhs, i) & MH_SEQ_UNSEEN)
170 {
171 m->msg_unread++;
172 if (check_new)
173 {
174 /* if the first unseen message we encounter was in the m during the
175 * last visit, don't notify about it */
176 if (!c_mail_check_recent || (mh_already_notified(m, i) == 0))
177 {
178 m->has_new = true;
180 }
181 /* Because we are traversing from high to low, we can stop
182 * checking for new mail after the first unseen message.
183 * Whether it resulted in "new mail" or not. */
184 check_new = false;
185 }
186 }
187 }
188
189 mh_seq_free(&mhs);
190
192 if (dir)
193 {
194 while ((de = readdir(dir)))
195 {
196 if (*de->d_name == '.')
197 continue;
198 if (mh_valid_message(de->d_name))
199 m->msg_count++;
200 }
201 closedir(dir);
202 }
203
204 return rc;
205}
DIR * mutt_file_opendir(const char *path, enum MuttOpenDirMode mode)
Open a directory.
Definition file.c:543
@ MUTT_OPENDIR_NONE
Plain opendir()
Definition file.h:63
static bool mh_valid_message(const char *s)
Is this a valid MH message filename.
Definition mh.c:101
static int mh_already_notified(struct Mailbox *m, int msgno)
Has the message changed.
Definition mh.c:79
MxStatus
Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close()
Definition mxapi.h:60
MhSeqFlags mh_seq_check(struct MhSequences *mhs, int i)
Get the flags for a given sequence.
Definition sequence.c:79
void mh_seq_free(struct MhSequences *mhs)
Free some sequences.
Definition sequence.c:68
int mh_seq_changed(struct Mailbox *m)
Has the mailbox changed.
Definition sequence.c:439
int mh_seq_read(struct MhSequences *mhs, const char *path)
Read a set of MH sequences.
Definition sequence.c:378
#define MH_SEQ_UNSEEN
Email hasn't been read.
Definition sequence.h:33
#define MH_SEQ_FLAGGED
Email is flagged.
Definition sequence.h:35
Set of MH sequence numbers.
Definition sequence.h:41
int max
Number of flags stored.
Definition sequence.h:42
+ Here is the call graph for this function:

◆ nm_mbox_check_stats()

static enum MxStatus nm_mbox_check_stats ( struct Mailbox * m,
uint8_t flags )
static

Check the Mailbox statistics - Implements MxOps::mbox_check_stats() -.

Definition at line 1803 of file notmuch.c.

1804{
1805 struct UrlQuery *item = NULL;
1806 struct Url *url = NULL;
1807 const char *db_filename = NULL;
1808 char *db_query = NULL;
1809 notmuch_database_t *db = NULL;
1810 enum MxStatus rc = MX_STATUS_ERROR;
1811 const short c_nm_db_limit = cs_subset_number(NeoMutt->sub, "nm_db_limit");
1812 int limit = c_nm_db_limit;
1813 mutt_debug(LL_DEBUG1, "nm: count\n");
1814
1815 url = url_parse(mailbox_path(m));
1816 if (!url)
1817 {
1818 mutt_error(_("failed to parse notmuch url: %s"), mailbox_path(m));
1819 goto done;
1820 }
1821
1822 STAILQ_FOREACH(item, &url->query_strings, entries)
1823 {
1824 if (item->value && (mutt_str_equal(item->name, "query")))
1825 {
1826 db_query = item->value;
1827 }
1828 else if (item->value && (mutt_str_equal(item->name, "limit")))
1829 {
1830 // Try to parse the limit
1831 if (!mutt_str_atoi_full(item->value, &limit))
1832 {
1833 mutt_error(_("failed to parse limit: %s"), item->value);
1834 goto done;
1835 }
1836 }
1837 }
1838
1839 if (!db_query)
1840 goto done;
1841
1842 db_filename = url->path;
1843 if (!db_filename)
1844 db_filename = nm_db_get_filename(m);
1845
1846 /* don't be verbose about connection, as we're called from
1847 * sidebar/mailbox very often */
1848 db = nm_db_do_open(db_filename, false, false);
1849 if (!db)
1850 goto done;
1851
1852 /* all emails */
1853 m->msg_count = count_query(db, db_query, limit);
1855
1856 // holder variable for extending query to unread/flagged
1857 char *qstr = NULL;
1858
1859 // unread messages
1860 const char *const c_nm_unread_tag = cs_subset_string(NeoMutt->sub, "nm_unread_tag");
1861 mutt_str_asprintf(&qstr, "( %s ) tag:%s", db_query, c_nm_unread_tag);
1862 m->msg_unread = count_query(db, qstr, limit);
1863 FREE(&qstr);
1864
1865 // flagged messages
1866 const char *const c_nm_flagged_tag = cs_subset_string(NeoMutt->sub, "nm_flagged_tag");
1867 mutt_str_asprintf(&qstr, "( %s ) tag:%s", db_query, c_nm_flagged_tag);
1868 m->msg_flagged = count_query(db, qstr, limit);
1869 FREE(&qstr);
1870
1871 rc = (m->msg_new > 0) ? MX_STATUS_NEW_MAIL : MX_STATUS_OK;
1872done:
1873 if (db)
1874 {
1875 nm_db_free(db);
1876 mutt_debug(LL_DEBUG1, "nm: count close DB\n");
1877 }
1878 url_free(&url);
1879
1880 mutt_debug(LL_DEBUG1, "nm: count done [rc=%d]\n", rc);
1881 return rc;
1882}
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition helpers.c:291
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition helpers.c:143
#define mutt_error(...)
Definition logging2.h:94
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
@ LL_DEBUG1
Log at debug level 1.
Definition logging2.h:45
#define FREE(x)
Definition memory.h:63
#define _(a)
Definition message.h:28
int mutt_str_asprintf(char **strp, const char *fmt,...)
Definition string.c:805
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:662
void mx_alloc_memory(struct Mailbox *m, int req_size)
Create storage for the emails.
Definition mx.c:1211
notmuch_database_t * nm_db_do_open(const char *filename, bool writable, bool verbose)
Open a Notmuch database.
Definition db.c:115
const char * nm_db_get_filename(struct Mailbox *m)
Get the filename of the Notmuch database.
Definition db.c:58
void nm_db_free(notmuch_database_t *db)
Decoupled way to close a Notmuch database.
Definition db.c:250
static unsigned int count_query(notmuch_database_t *db, const char *qstr, int limit)
Count the results of a query.
Definition notmuch.c:1451
#define STAILQ_FOREACH(var, head, field)
Definition queue.h:390
Parsed Query String.
Definition url.h:58
char * name
Query name.
Definition url.h:59
char * value
Query value.
Definition url.h:60
A parsed URL proto://user:password@host:port/path?a=1&b=2
Definition url.h:69
struct UrlQueryList query_strings
List of query strings.
Definition url.h:76
char * path
Path.
Definition url.h:75
struct Url * url_parse(const char *src)
Fill in Url.
Definition url.c:239
void url_free(struct Url **ptr)
Free the contents of a URL.
Definition url.c:124
+ Here is the call graph for this function: