NeoMutt  2024-10-02-37-gfa9146
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 1155 of file imap.c.

1156{
1157 const bool queue = (flags & MUTT_MAILBOX_CHECK_IMMEDIATE) == 0;
1158 const int new_msgs = imap_mailbox_status(m, queue);
1159 if (new_msgs == -1)
1160 return MX_STATUS_ERROR;
1161 if (new_msgs == 0)
1162 return MX_STATUS_OK;
1163 return MX_STATUS_NEW_MAIL;
1164}
int imap_mailbox_status(struct Mailbox *m, bool queue)
Refresh the number of total and new messages.
Definition: imap.c:1207
#define MUTT_MAILBOX_CHECK_IMMEDIATE
Don't postpone the actual checking.
Definition: mxapi.h:56
@ MX_STATUS_ERROR
An error occurred.
Definition: mxapi.h:64
@ MX_STATUS_OK
No changes.
Definition: mxapi.h:65
@ MX_STATUS_NEW_MAIL
New mail received in Mailbox.
Definition: mxapi.h:66
+ 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 809 of file mailbox.c.

810{
811 bool check_stats = flags & MUTT_MAILBOX_CHECK_STATS;
812 bool check_new = true;
813
814 if (check_stats)
815 {
816 m->msg_new = 0;
817 m->msg_count = 0;
818 m->msg_unread = 0;
819 m->msg_flagged = 0;
820 }
821
822 maildir_check_dir(m, "new", check_new, check_stats);
823
824 const bool c_maildir_check_cur = cs_subset_bool(NeoMutt->sub, "maildir_check_cur");
825 check_new = !m->has_new && c_maildir_check_cur;
826 if (check_new || check_stats)
827 maildir_check_dir(m, "cur", check_new, check_stats);
828
830}
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:385
#define MUTT_MAILBOX_CHECK_STATS
Ignore mail_check_stats and calculate statistics (used by <check-stats>)
Definition: mxapi.h:55
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:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
+ 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 1651 of file mbox.c.

1652{
1653 struct stat st = { 0 };
1654 if (stat(mailbox_path(m), &st) != 0)
1655 return MX_STATUS_ERROR;
1656
1657 bool new_or_changed;
1658
1659 const bool c_check_mbox_size = cs_subset_bool(NeoMutt->sub, "check_mbox_size");
1660 if (c_check_mbox_size)
1661 {
1662 new_or_changed = (st.st_size > m->size);
1663 }
1664 else
1665 {
1666 new_or_changed =
1668 (m->newly_created &&
1671 }
1672
1673 if (new_or_changed)
1674 {
1675 const bool c_mail_check_recent = cs_subset_bool(NeoMutt->sub, "mail_check_recent");
1676 if (!c_mail_check_recent ||
1678 {
1679 m->has_new = true;
1680 }
1681 }
1682 else if (c_check_mbox_size)
1683 {
1684 /* some other program has deleted mail from the folder */
1685 m->size = (off_t) st.st_size;
1686 }
1687
1688 if (m->newly_created && ((st.st_ctime != st.st_mtime) || (st.st_ctime != st.st_atime)))
1689 m->newly_created = false;
1690
1691 if (flags & MUTT_MAILBOX_CHECK_STATS)
1692 {
1695 &adata->stats_last_checked) > 0)
1696 {
1697 bool old_peek = m->peekonly;
1699 mx_mbox_close(m);
1700 m->peekonly = old_peek;
1701 mutt_time_now(&adata->stats_last_checked);
1702 }
1703 }
1704
1705 if (m->has_new || m->msg_new)
1706 return MX_STATUS_NEW_MAIL;
1707 return MX_STATUS_OK;
1708}
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition: mailbox.h:223
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:1641
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:1619
@ 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:125
void mutt_time_now(struct timespec *tp)
Set the provided time field to the current time.
Definition: date.c:480
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:48
#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:49
+ 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 143 of file mh.c.

144{
145 struct MhSequences mhs = { 0 };
146 DIR *dir = NULL;
147 struct dirent *de = NULL;
148
149 /* when $mail_check_recent is set and the .mh_sequences file hasn't changed
150 * since the last m visit, there is no "new mail" */
151 const bool c_mail_check_recent = cs_subset_bool(NeoMutt->sub, "mail_check_recent");
152 if (c_mail_check_recent && (mh_seq_changed(m) <= 0))
153 {
154 return MX_STATUS_OK;
155 }
156
157 if (mh_seq_read(&mhs, mailbox_path(m)) < 0)
158 return MX_STATUS_ERROR;
159
160 m->msg_count = 0;
161 m->msg_unread = 0;
162 m->msg_flagged = 0;
163
164 enum MxStatus rc = MX_STATUS_OK;
165 bool check_new = true;
166 for (int i = mhs.max; i > 0; i--)
167 {
168 if ((mh_seq_check(&mhs, i) & MH_SEQ_FLAGGED))
169 m->msg_flagged++;
170 if (mh_seq_check(&mhs, i) & MH_SEQ_UNSEEN)
171 {
172 m->msg_unread++;
173 if (check_new)
174 {
175 /* if the first unseen message we encounter was in the m during the
176 * last visit, don't notify about it */
177 if (!c_mail_check_recent || (mh_already_notified(m, i) == 0))
178 {
179 m->has_new = true;
181 }
182 /* Because we are traversing from high to low, we can stop
183 * checking for new mail after the first unseen message.
184 * Whether it resulted in "new mail" or not. */
185 check_new = false;
186 }
187 }
188 }
189
190 mh_seq_free(&mhs);
191
193 if (dir)
194 {
195 while ((de = readdir(dir)))
196 {
197 if (*de->d_name == '.')
198 continue;
199 if (mh_valid_message(de->d_name))
200 m->msg_count++;
201 }
202 closedir(dir);
203 }
204
205 return rc;
206}
DIR * mutt_file_opendir(const char *path, enum MuttOpenDirMode mode)
Open a directory.
Definition: file.c:642
@ 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:102
static int mh_already_notified(struct Mailbox *m, int msgno)
Has the message changed.
Definition: mh.c:80
MxStatus
Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close()
Definition: mxapi.h:63
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 1788 of file notmuch.c.

1789{
1790 struct UrlQuery *item = NULL;
1791 struct Url *url = NULL;
1792 const char *db_filename = NULL;
1793 char *db_query = NULL;
1794 notmuch_database_t *db = NULL;
1795 enum MxStatus rc = MX_STATUS_ERROR;
1796 const short c_nm_db_limit = cs_subset_number(NeoMutt->sub, "nm_db_limit");
1797 int limit = c_nm_db_limit;
1798 mutt_debug(LL_DEBUG1, "nm: count\n");
1799
1800 url = url_parse(mailbox_path(m));
1801 if (!url)
1802 {
1803 mutt_error(_("failed to parse notmuch url: %s"), mailbox_path(m));
1804 goto done;
1805 }
1806
1807 STAILQ_FOREACH(item, &url->query_strings, entries)
1808 {
1809 if (item->value && (mutt_str_equal(item->name, "query")))
1810 {
1811 db_query = item->value;
1812 }
1813 else if (item->value && (mutt_str_equal(item->name, "limit")))
1814 {
1815 // Try to parse the limit
1816 if (!mutt_str_atoi_full(item->value, &limit))
1817 {
1818 mutt_error(_("failed to parse limit: %s"), item->value);
1819 goto done;
1820 }
1821 }
1822 }
1823
1824 if (!db_query)
1825 goto done;
1826
1827 db_filename = url->path;
1828 if (!db_filename)
1829 db_filename = nm_db_get_filename(m);
1830
1831 /* don't be verbose about connection, as we're called from
1832 * sidebar/mailbox very often */
1833 db = nm_db_do_open(db_filename, false, false);
1834 if (!db)
1835 goto done;
1836
1837 /* all emails */
1838 m->msg_count = count_query(db, db_query, limit);
1840
1841 // holder variable for extending query to unread/flagged
1842 char *qstr = NULL;
1843
1844 // unread messages
1845 const char *const c_nm_unread_tag = cs_subset_string(NeoMutt->sub, "nm_unread_tag");
1846 mutt_str_asprintf(&qstr, "( %s ) tag:%s", db_query, c_nm_unread_tag);
1847 m->msg_unread = count_query(db, qstr, limit);
1848 FREE(&qstr);
1849
1850 // flagged messages
1851 const char *const c_nm_flagged_tag = cs_subset_string(NeoMutt->sub, "nm_flagged_tag");
1852 mutt_str_asprintf(&qstr, "( %s ) tag:%s", db_query, c_nm_flagged_tag);
1853 m->msg_flagged = count_query(db, qstr, limit);
1854 FREE(&qstr);
1855
1856 rc = (m->msg_new > 0) ? MX_STATUS_NEW_MAIL : MX_STATUS_OK;
1857done:
1858 if (db)
1859 {
1860 nm_db_free(db);
1861 mutt_debug(LL_DEBUG1, "nm: count close DB\n");
1862 }
1863 url_free(&url);
1864
1865 mutt_debug(LL_DEBUG1, "nm: count done [rc=%d]\n", rc);
1866 return rc;
1867}
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:92
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
#define FREE(x)
Definition: memory.h:45
#define _(a)
Definition: message.h:28
int mutt_str_asprintf(char **strp, const char *fmt,...)
Definition: string.c:803
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
void mx_alloc_memory(struct Mailbox *m, int req_size)
Create storage for the emails.
Definition: mx.c:1206
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:1436
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
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: