NeoMutt  2021-10-29-43-g6b8931
Teaching an old dog new tricks
DOXYGEN
bcache.c File Reference

Body Caching (local copies of email bodies) More...

#include "config.h"
#include <dirent.h>
#include <errno.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "lib.h"
#include "mutt_account.h"
#include "muttlib.h"
+ Include dependency graph for bcache.c:

Go to the source code of this file.

Data Structures

struct  BodyCache
 Local cache of email bodies. More...
 

Functions

static int bcache_path (struct ConnAccount *account, const char *mailbox, struct BodyCache *bcache)
 Create the cache path for a given account/mailbox. More...
 
static int mutt_bcache_move (struct BodyCache *bcache, const char *id, const char *newid)
 Change the id of a message in the cache. More...
 
struct BodyCachemutt_bcache_open (struct ConnAccount *account, const char *mailbox)
 Open an Email-Body Cache. More...
 
void mutt_bcache_close (struct BodyCache **bcache)
 Close an Email-Body Cache. More...
 
FILE * mutt_bcache_get (struct BodyCache *bcache, const char *id)
 Open a file in the Body Cache. More...
 
FILE * mutt_bcache_put (struct BodyCache *bcache, const char *id)
 Create a file in the Body Cache. More...
 
int mutt_bcache_commit (struct BodyCache *bcache, const char *id)
 Move a temporary file into the Body Cache. More...
 
int mutt_bcache_del (struct BodyCache *bcache, const char *id)
 Delete a file from the Body Cache. More...
 
int mutt_bcache_exists (struct BodyCache *bcache, const char *id)
 Check if a file exists in the Body Cache. More...
 
int mutt_bcache_list (struct BodyCache *bcache, bcache_list_t want_id, void *data)
 Find matching entries in the Body Cache. More...
 

Detailed Description

Body Caching (local copies of email bodies)

Authors
  • Brendan Cully
  • Rocco Rutte

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 bcache.c.

Function Documentation

◆ bcache_path()

static int bcache_path ( struct ConnAccount account,
const char *  mailbox,
struct BodyCache bcache 
)
static

Create the cache path for a given account/mailbox.

Parameters
accountAccount info
mailboxMailbox name
bcacheBody cache
Return values
0Success
-1Failure

Definition at line 63 of file bcache.c.

64 {
65  char host[256];
66  struct Url url = { 0 };
67 
68  const char *const c_message_cachedir =
69  cs_subset_path(NeoMutt->sub, "message_cachedir");
70  if (!account || !c_message_cachedir || !bcache)
71  return -1;
72 
73  struct stat st = { 0 };
74  if (!((stat(c_message_cachedir, &st) == 0) && S_ISDIR(st.st_mode)))
75  {
76  mutt_error(_("Cache disabled, $message_cachedir isn't a directory: %s"), c_message_cachedir);
77  return -1;
78  }
79 
80  /* make up a Url we can turn into a string */
81  mutt_account_tourl(account, &url);
82  /* mutt_account_tourl() just sets up some pointers;
83  * if this ever changes, we have a memleak here */
84  url.path = NULL;
85  if (url_tostring(&url, host, sizeof(host), U_PATH) < 0)
86  {
87  mutt_debug(LL_DEBUG1, "URL to string failed\n");
88  return -1;
89  }
90 
91  struct Buffer *path = mutt_buffer_pool_get();
92  struct Buffer *dst = mutt_buffer_pool_get();
93  mutt_encode_path(path, NONULL(mailbox));
94 
95  mutt_buffer_printf(dst, "%s/%s%s", c_message_cachedir, host, mutt_buffer_string(path));
96  if (*(dst->dptr - 1) != '/')
97  mutt_buffer_addch(dst, '/');
98 
99  mutt_debug(LL_DEBUG3, "path: '%s'\n", mutt_buffer_string(dst));
100  bcache->path = mutt_buffer_strdup(dst);
101 
104  return 0;
105 }
size_t mutt_buffer_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:240
char * mutt_buffer_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition: buffer.c:432
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
static const char * mutt_buffer_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:77
#define mutt_error(...)
Definition: logging.h:87
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:194
@ LL_DEBUG3
Log at debug level 3.
Definition: logging.h:42
@ LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40
#define _(a)
Definition: message.h:28
void mutt_account_tourl(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
Definition: mutt_account.c:79
void mutt_encode_path(struct Buffer *buf, const char *src)
Convert a path to 'us-ascii'.
Definition: muttlib.c:1490
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
#define NONULL(x)
Definition: string2.h:37
char * path
On-disk path to the file.
Definition: bcache.c:52
String manipulation buffer.
Definition: buffer.h:34
char * dptr
Current read/write position.
Definition: buffer.h:36
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
A parsed URL proto://user:password@host:port/path?a=1&b=2
Definition: url.h:69
char * path
Path.
Definition: url.h:75
int url_tostring(struct Url *url, char *dest, size_t len, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:418
#define U_PATH
Definition: url.h:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_bcache_move()

static int mutt_bcache_move ( struct BodyCache bcache,
const char *  id,
const char *  newid 
)
static

Change the id of a message in the cache.

Parameters
bcacheBody cache
idPer-mailbox unique identifier for the message
newidNew id for the message

Definition at line 113 of file bcache.c.

114 {
115  if (!bcache || !id || (*id == '\0') || !newid || (*newid == '\0'))
116  return -1;
117 
118  struct Buffer *path = mutt_buffer_pool_get();
119  struct Buffer *newpath = mutt_buffer_pool_get();
120 
121  mutt_buffer_printf(path, "%s%s", bcache->path, id);
122  mutt_buffer_printf(newpath, "%s%s", bcache->path, newid);
123 
124  mutt_debug(LL_DEBUG3, "bcache: mv: '%s' '%s'\n", mutt_buffer_string(path),
125  mutt_buffer_string(newpath));
126 
127  int rc = rename(mutt_buffer_string(path), mutt_buffer_string(newpath));
129  mutt_buffer_pool_release(&newpath);
130  return rc;
131 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_bcache_open()

struct BodyCache* mutt_bcache_open ( struct ConnAccount account,
const char *  mailbox 
)

Open an Email-Body Cache.

Parameters
accountcurrent mailbox' account (required)
mailboxpath to the mailbox of the account (optional)
Return values
NULLFailure

The driver using it is responsible for ensuring that hierarchies are separated by '/' (if it knows of such a concepts like mailboxes or hierarchies)

Definition at line 143 of file bcache.c.

144 {
145  if (!account)
146  return NULL;
147 
148  struct BodyCache *bcache = mutt_mem_calloc(1, sizeof(struct BodyCache));
149  if (bcache_path(account, mailbox, bcache) < 0)
150  {
151  mutt_bcache_close(&bcache);
152  return NULL;
153  }
154 
155  return bcache;
156 }
static int bcache_path(struct ConnAccount *account, const char *mailbox, struct BodyCache *bcache)
Create the cache path for a given account/mailbox.
Definition: bcache.c:63
void mutt_bcache_close(struct BodyCache **bcache)
Close an Email-Body Cache.
Definition: bcache.c:164
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
Local cache of email bodies.
Definition: bcache.c:51
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_bcache_close()

void mutt_bcache_close ( struct BodyCache **  bcache)

Close an Email-Body Cache.

Parameters
[out]bcacheBody cache

Free all memory of bcache and finally FREE() it, too.

Definition at line 164 of file bcache.c.

165 {
166  if (!bcache || !*bcache)
167  return;
168  FREE(&(*bcache)->path);
169  FREE(bcache);
170 }
#define FREE(x)
Definition: memory.h:40
+ Here is the caller graph for this function:

◆ mutt_bcache_get()

FILE* mutt_bcache_get ( struct BodyCache bcache,
const char *  id 
)

Open a file in the Body Cache.

Parameters
bcacheBody Cache from mutt_bcache_open()
idPer-mailbox unique identifier for the message
Return values
ptrSuccess
NULLFailure

Definition at line 179 of file bcache.c.

180 {
181  if (!id || (*id == '\0') || !bcache)
182  return NULL;
183 
184  struct Buffer *path = mutt_buffer_pool_get();
185  mutt_buffer_addstr(path, bcache->path);
186  mutt_buffer_addstr(path, id);
187 
188  FILE *fp = mutt_file_fopen(mutt_buffer_string(path), "r");
189 
190  mutt_debug(LL_DEBUG3, "bcache: get: '%s': %s\n", mutt_buffer_string(path),
191  fp ? "yes" : "no");
192 
194  return fp;
195 }
size_t mutt_buffer_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:225
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:593
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_bcache_put()

FILE* mutt_bcache_put ( struct BodyCache bcache,
const char *  id 
)

Create a file in the Body Cache.

Parameters
bcacheBody Cache from mutt_bcache_open()
idPer-mailbox unique identifier for the message
Return values
ptrSuccess
NULLFailure

The returned FILE* is in a temporary location. Use mutt_bcache_commit to put it into place

Definition at line 207 of file bcache.c.

208 {
209  if (!id || (*id == '\0') || !bcache)
210  return NULL;
211 
212  struct Buffer *path = mutt_buffer_pool_get();
213  mutt_buffer_printf(path, "%s%s%s", bcache->path, id, ".tmp");
214 
215  struct stat st = { 0 };
216  if (stat(bcache->path, &st) == 0)
217  {
218  if (!S_ISDIR(st.st_mode))
219  {
220  mutt_error(_("Message cache isn't a directory: %s"), bcache->path);
221  return NULL;
222  }
223  }
224  else
225  {
226  if (mutt_file_mkdir(bcache->path, S_IRWXU | S_IRWXG | S_IRWXO) < 0)
227  {
228  mutt_error(_("Can't create %s: %s"), bcache->path, strerror(errno));
229  return NULL;
230  }
231  }
232 
233  mutt_debug(LL_DEBUG3, "bcache: put: '%s'\n", path);
234 
235  FILE *fp = mutt_file_fopen(mutt_buffer_string(path), "w+");
237  return fp;
238 }
int mutt_file_mkdir(const char *path, mode_t mode)
Recursively create directories.
Definition: file.c:905
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_bcache_commit()

int mutt_bcache_commit ( struct BodyCache bcache,
const char *  id 
)

Move a temporary file into the Body Cache.

Parameters
bcacheBody Cache from mutt_bcache_open()
idPer-mailbox unique identifier for the message
Return values
0Success
-1Failure

Definition at line 247 of file bcache.c.

248 {
249  struct Buffer *tmpid = mutt_buffer_pool_get();
250  mutt_buffer_printf(tmpid, "%s.tmp", id);
251 
252  int rc = mutt_bcache_move(bcache, mutt_buffer_string(tmpid), id);
253  mutt_buffer_pool_release(&tmpid);
254  return rc;
255 }
static int mutt_bcache_move(struct BodyCache *bcache, const char *id, const char *newid)
Change the id of a message in the cache.
Definition: bcache.c:113
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_bcache_del()

int mutt_bcache_del ( struct BodyCache bcache,
const char *  id 
)

Delete a file from the Body Cache.

Parameters
bcacheBody Cache from mutt_bcache_open()
idPer-mailbox unique identifier for the message
Return values
0Success
-1Failure

Definition at line 264 of file bcache.c.

265 {
266  if (!id || (*id == '\0') || !bcache)
267  return -1;
268 
269  struct Buffer *path = mutt_buffer_pool_get();
270  mutt_buffer_addstr(path, bcache->path);
271  mutt_buffer_addstr(path, id);
272 
273  mutt_debug(LL_DEBUG3, "bcache: del: '%s'\n", mutt_buffer_string(path));
274 
275  int rc = unlink(mutt_buffer_string(path));
277  return rc;
278 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_bcache_exists()

int mutt_bcache_exists ( struct BodyCache bcache,
const char *  id 
)

Check if a file exists in the Body Cache.

Parameters
bcacheBody Cache from mutt_bcache_open()
idPer-mailbox unique identifier for the message
Return values
0Success
-1Failure

Definition at line 287 of file bcache.c.

288 {
289  if (!id || (*id == '\0') || !bcache)
290  return -1;
291 
292  struct Buffer *path = mutt_buffer_pool_get();
293  mutt_buffer_addstr(path, bcache->path);
294  mutt_buffer_addstr(path, id);
295 
296  int rc = 0;
297  struct stat st = { 0 };
298  if (stat(mutt_buffer_string(path), &st) < 0)
299  rc = -1;
300  else
301  rc = (S_ISREG(st.st_mode) && (st.st_size != 0)) ? 0 : -1;
302 
303  mutt_debug(LL_DEBUG3, "bcache: exists: '%s': %s\n", mutt_buffer_string(path),
304  (rc == 0) ? "yes" : "no");
305 
307  return rc;
308 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_bcache_list()

int mutt_bcache_list ( struct BodyCache bcache,
bcache_list_t  want_id,
void *  data 
)

Find matching entries in the Body Cache.

Parameters
bcacheBody Cache from mutt_bcache_open()
want_idCallback function called for each match
dataData to pass to the callback function
Return values
-1Failure
>=0count of matching items

This more or less "examines" the cache and calls a function with each id it finds if given.

The optional callback function gets the id of a message, the very same body cache handle mutt_bcache_list() is called with (to, perhaps, perform further operations on the bcache), and a data cookie which is just passed as-is. If the return value of the callback is non-zero, the listing is aborted and continued otherwise. The callback is optional so that this function can be used to count the items in the cache (see below for return value).

Definition at line 329 of file bcache.c.

330 {
331  DIR *d = NULL;
332  struct dirent *de = NULL;
333  int rc = -1;
334 
335  if (!bcache || !(d = opendir(bcache->path)))
336  goto out;
337 
338  rc = 0;
339 
340  mutt_debug(LL_DEBUG3, "bcache: list: dir: '%s'\n", bcache->path);
341 
342  while ((de = readdir(d)))
343  {
344  if (mutt_str_startswith(de->d_name, ".") || mutt_str_startswith(de->d_name, ".."))
345  {
346  continue;
347  }
348 
349  mutt_debug(LL_DEBUG3, "bcache: list: dir: '%s', id :'%s'\n", bcache->path, de->d_name);
350 
351  if (want_id && (want_id(de->d_name, bcache, data) != 0))
352  goto out;
353 
354  rc++;
355  }
356 
357 out:
358  if (d)
359  {
360  if (closedir(d) < 0)
361  rc = -1;
362  }
363  mutt_debug(LL_DEBUG3, "bcache: list: did %d entries\n", rc);
364  return rc;
365 }
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition: string.c:158
+ Here is the call graph for this function:
+ Here is the caller graph for this function: