NeoMutt  2023-05-17-56-ga67199
Teaching an old dog new tricks
DOXYGEN
Body Cache Callback API

Prototype for a mutt_bcache_list() callback function. More...

Functions

static int msg_cache_clean_cb (const char *id, struct BodyCache *bcache, void *data)
 Delete an entry from the message cache - Implements bcache_list_t -. More...
 
static int nntp_bcache_delete (const char *id, struct BodyCache *bcache, void *data)
 Remove bcache file - Implements bcache_list_t -. More...
 
static int msg_cache_check (const char *id, struct BodyCache *bcache, void *data)
 Check the Body Cache for an ID - Implements bcache_list_t -. More...
 

Detailed Description

Prototype for a mutt_bcache_list() callback function.

Parameters
idCache id
bcacheBody Cache from mutt_bcache_open()
dataData to pass to the callback function
Return values
-1Failure
>=0count of matching items

mutt_bcache_list() will call this function once for each item in the cache.

Function Documentation

◆ msg_cache_clean_cb()

static int msg_cache_clean_cb ( const char *  id,
struct BodyCache bcache,
void *  data 
)
static

Delete an entry from the message cache - Implements bcache_list_t -.

Return values
0Always

Definition at line 166 of file message.c.

167{
168 uint32_t uv;
169 unsigned int uid;
170 struct ImapMboxData *mdata = data;
171
172 if (sscanf(id, "%u-%u", &uv, &uid) != 2)
173 return 0;
174
175 /* bad UID */
176 if ((uv != mdata->uidvalidity) || !mutt_hash_int_find(mdata->uid_hash, uid))
178
179 return 0;
180}
int mutt_bcache_del(struct BodyCache *bcache, const char *id)
Delete a file from the Body Cache.
Definition: bcache.c:263
void * mutt_hash_int_find(const struct HashTable *table, unsigned int intkey)
Find the HashElem data in a Hash Table element using a key.
Definition: hash.c:392
IMAP-specific Mailbox data -.
Definition: mdata.h:39
struct BodyCache * bcache
Email body cache.
Definition: mdata.h:60
void * mdata
Driver specific data.
Definition: mailbox.h:132
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ nntp_bcache_delete()

static int nntp_bcache_delete ( const char *  id,
struct BodyCache bcache,
void *  data 
)
static

Remove bcache file - Implements bcache_list_t -.

Return values
0Always

Definition at line 785 of file newsrc.c.

786{
787 struct NntpMboxData *mdata = data;
788 anum_t anum;
789 char c;
790
791 if (!mdata || (sscanf(id, ANUM "%c", &anum, &c) != 1) ||
792 (anum < mdata->first_message) || (anum > mdata->last_message))
793 {
794 if (mdata)
795 mutt_debug(LL_DEBUG2, "mutt_bcache_del %s\n", id);
797 }
798 return 0;
799}
#define mutt_debug(LEVEL,...)
Definition: logging2.h:87
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.h:44
#define ANUM
Definition: lib.h:61
#define anum_t
Definition: lib.h:60
NNTP-specific Mailbox data -.
Definition: mdata.h:33
struct BodyCache * bcache
Definition: mdata.h:49
anum_t first_message
Definition: mdata.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ msg_cache_check()

static int msg_cache_check ( const char *  id,
struct BodyCache bcache,
void *  data 
)
static

Check the Body Cache for an ID - Implements bcache_list_t -.

Definition at line 254 of file pop.c.

255{
256 struct Mailbox *m = data;
257 if (!m)
258 return -1;
259
261 if (!adata)
262 return -1;
263
264#ifdef USE_HCACHE
265 /* keep hcache file if hcache == bcache */
266 if (mutt_str_equal(HC_FNAME "." HC_FEXT, id))
267 return 0;
268#endif
269
270 for (int i = 0; i < m->msg_count; i++)
271 {
272 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
273 /* if the id we get is known for a header: done (i.e. keep in cache) */
274 if (edata->uid && mutt_str_equal(edata->uid, id))
275 return 0;
276 }
277
278 /* message not found in context -> remove it from cache
279 * return the result of bcache, so we stop upon its first error */
280 return mutt_bcache_del(bcache, cache_id(id));
281}
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:798
struct PopAccountData * pop_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:73
struct PopEmailData * pop_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:65
#define HC_FNAME
Definition: pop.c:70
static const char * cache_id(const char *id)
Make a message-cache-compatible id.
Definition: pop.c:82
#define HC_FEXT
Definition: pop.c:71
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
void * edata
Driver-specific data.
Definition: email.h:72
A mailbox.
Definition: mailbox.h:79
int msg_count
Total number of messages.
Definition: mailbox.h:88
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
POP-specific Account data -.
Definition: adata.h:37
POP-specific Email data -.
Definition: edata.h:32
+ Here is the call graph for this function:
+ Here is the caller graph for this function: