hcache.c File Reference

Header cache multiplexor. More...

#include "config.h"
#include <errno.h>
#include <limits.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.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 "compress/lib.h"
#include "store/lib.h"
#include "hcache/hcversion.h"
#include "muttlib.h"
#include "serialize.h"

Include dependency graph for hcache.c:

Go to the source code of this file.

Data Structures
struct	RealKey
	Hcache key name (including compression method) More...

Functions
static struct RealKey *	realkey (struct HeaderCache *hc, const char *key, size_t keylen, bool compress)
	Compute the real key used in the backend, taking into account the compression method.
static void	hcache_free (struct HeaderCache **ptr)
	Free a header cache.
static struct HeaderCache *	hcache_new (void)
	Create a new header cache.
static size_t	header_size (void)
	Compute the size of the header with uuid validity and crc.
static uint32_t	email_pack_flags (const struct Email *e)
	Pack the Email flags into a uint32_t.
static void	email_unpack_flags (struct Email *e, uint32_t packed)
	Unpack the Email flags from a uint32_t.
static uint32_t	email_pack_timezone (const struct Email *e)
	Pack the Email timezone into a uint32_t.
static void	email_unpack_timezone (struct Email *e, uint32_t packed)
	Unpack the Email timezone from a uint32_t.
static void *	dump_email (struct HeaderCache *hc, const struct Email *e, int *off, uint32_t uidvalidity)
	Serialise an Email object.
static struct Email *	restore_email (const unsigned char *d)
	Restore an Email from data retrieved from the cache.
static bool	create_hcache_dir (const char *path)
	Create parent dirs for the hcache database.
static void	hcache_per_folder (struct HeaderCache *hc, struct Buffer *hcpath, const char *path, hcache_namer_t namer)
	Generate the hcache pathname.
static char *	get_foldername (const char *folder)
	Where should the cache be stored?
static void	free_raw (struct HeaderCache *hc, void **data)
	Multiplexor for StoreOps::free.
static unsigned int	generate_hcachever (void)
	Calculate hcache version from dynamic configuration.
struct HeaderCache *	hcache_open (const char *path, const char *folder, hcache_namer_t namer, bool create)
	Multiplexor for StoreOps::open.
void	hcache_close (struct HeaderCache **ptr)
	Multiplexor for StoreOps::close.
struct HCacheEntry	hcache_fetch_email (struct HeaderCache *hc, const char *key, size_t keylen, uint32_t uidvalidity)
	Multiplexor for StoreOps::fetch.
bool	hcache_fetch_raw_obj_full (struct HeaderCache *hc, const char *key, size_t keylen, void *dst, size_t dstlen)
	Fetch a message's header from the cache into a destination object.
char *	hcache_fetch_raw_str (struct HeaderCache *hc, const char *key, size_t keylen)
	Fetch a string from the cache.
int	hcache_store_email (struct HeaderCache *hc, const char *key, size_t keylen, struct Email *e, uint32_t uidvalidity)
	Multiplexor for StoreOps::store.
int	hcache_store_raw (struct HeaderCache *hc, const char *key, size_t keylen, void *data, size_t dlen)
	Store a key / data pair.
int	hcache_delete_email (struct HeaderCache *hc, const char *key, size_t keylen)
	Multiplexor for StoreOps::delete_record.
int	hcache_delete_raw (struct HeaderCache *hc, const char *key, size_t keylen)
	Multiplexor for StoreOps::delete_record.

Variables
static unsigned int	HcacheVer = 0x0
	Header Cache version.

Detailed Description

Header cache multiplexor.

Authors

• Pietro Cerutti
• Richard Russon
• Tino Reichardt

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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

Function Documentation

realkey()

static struct RealKey * realkey ( struct HeaderCache * hc, const char * key, size_t keylen, bool compress )

static

Compute the real key used in the backend, taking into account the compression method.

Parameters

hc	Header cache handle
key	Original key
keylen	Length of original key
compress	Will the data be compressed?

Return values

ptr	Static location holding data and length of the real key

Definition at line 80 of file hcache.c.

{
  static struct RealKey rk;
 
  int n = snprintf(rk.key, sizeof(rk.key), "%s/%.*s", hc->folder, (int) keylen, key);
  if (n < 0)
    n = 0;
  rk.keylen = MIN((size_t) n, sizeof(rk.key) - 1);
 
#ifdef USE_HCACHE_COMPRESSION
  if (compress && hc->compr_ops)
  {
    // Append the compression type, e.g. "-zstd"
    n = snprintf(rk.key + rk.keylen, sizeof(rk.key) - rk.keylen, "-%s",
                 hc->compr_ops->name);
    if (n > 0)
      rk.keylen += MIN((size_t) n, sizeof(rk.key) - 1 - rk.keylen);
  }
#endif
 
  return &rk;
}

Here is the caller graph for this function:

hcache_free()

static void hcache_free ( struct HeaderCache ** ptr )

static

Free a header cache.

Parameters

ptr	header cache to free

Definition at line 108 of file hcache.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct HeaderCache *hc = *ptr;
  FREE(&hc->folder);
 
  FREE(ptr);
}

Here is the caller graph for this function:

hcache_new()

static struct HeaderCache * hcache_new ( void )

static

Create a new header cache.

Return values

ptr	Newly created header cache

Definition at line 123 of file hcache.c.

{
  return MUTT_MEM_CALLOC(1, struct HeaderCache);
}

Here is the caller graph for this function:

header_size()

static size_t header_size ( void )

static

Compute the size of the header with uuid validity and crc.

Return values

num	Size of the header

Definition at line 132 of file hcache.c.

{
  return sizeof(int) + sizeof(uint32_t);
}

Here is the caller graph for this function:

email_pack_flags()

static uint32_t email_pack_flags ( const struct Email * e )

inlinestatic

Pack the Email flags into a uint32_t.

Parameters

e	Email to pack

Return values

num	uint32_t of packed flags

Note

Order of packing must match email_unpack_flags()

Definition at line 144 of file hcache.c.

{
  if (!e)
    return 0;
 
  // clang-format off
  return e->security +
        (e->expired    << 16) +
        (e->flagged    << 17) +
        (e->mime       << 18) +
        (e->old        << 19) +
        (e->read       << 20) +
        (e->replied    << 21) +
        (e->superseded << 22) +
        (e->trash      << 23);
  // clang-format on
}

Here is the caller graph for this function:

email_unpack_flags()

static void email_unpack_flags ( struct Email * e, uint32_t packed )

inlinestatic

Unpack the Email flags from a uint32_t.

Parameters

e	Email to unpack into
packed	Packed flags

Note

Order of packing must match email_pack_flags()

Definition at line 169 of file hcache.c.

{
  if (!e)
    return;
 
  // clang-format off
  e->security   = (packed & ((1 << 16) - 1)); // bits 0-15
  e->expired    = (packed & (1 << 16));
  e->flagged    = (packed & (1 << 17));
  e->mime       = (packed & (1 << 18));
  e->old        = (packed & (1 << 19));
  e->read       = (packed & (1 << 20));
  e->replied    = (packed & (1 << 21));
  e->superseded = (packed & (1 << 22));
  e->trash      = (packed & (1 << 23));
  // clang-format on
}

Here is the caller graph for this function:

email_pack_timezone()

static uint32_t email_pack_timezone ( const struct Email * e )

inlinestatic

Pack the Email timezone into a uint32_t.

Parameters

e	Email to pack

Return values

num	uint32_t of packed timezone

Note

Order of packing must match email_unpack_timezone()

Definition at line 194 of file hcache.c.

{
  if (!e)
    return 0;
 
  return e->zhours + (e->zminutes << 5) + (e->zoccident << 11);
}

Here is the caller graph for this function:

email_unpack_timezone()

static void email_unpack_timezone ( struct Email * e, uint32_t packed )

inlinestatic

Unpack the Email timezone from a uint32_t.

Parameters

e	Email to unpack into
packed	Packed timezone

Note

Order of packing must match email_pack_timezone()

Definition at line 209 of file hcache.c.

{
  if (!e)
    return;
 
  // clang-format off
  e->zhours    =  (packed       & ((1 << 5) - 1)); // bits 0-4 (5)
  e->zminutes  = ((packed >> 5) & ((1 << 6) - 1)); // bits 5-10 (6)
  e->zoccident =  (packed       &  (1 << 11));     // bit  11 (1)
  // clang-format on
}

Here is the caller graph for this function:

dump_email()

static void * dump_email ( struct HeaderCache * hc, const struct Email * e, int * off, uint32_t uidvalidity )

static

Serialise an Email object.

Parameters

hc	Header cache handle
e	Email to serialise
off	Size of the binary blob
uidvalidity	IMAP server identifier

Return values

ptr	Binary blob representing the Email

This function transforms an Email into a binary string so that it can be saved to a database.

Definition at line 232 of file hcache.c.

{
  bool convert = !CharsetIsUtf8;
 
  *off = 0;
  unsigned char *d = MUTT_MEM_MALLOC(4096, unsigned char);
 
  d = serial_dump_uint32_t((uidvalidity != 0) ? uidvalidity : mutt_date_now(), d, off);
  d = serial_dump_int(hc->crc, d, off);
 
  ASSERT((size_t) *off == header_size());
 
  uint32_t packed = email_pack_flags(e);
  d = serial_dump_uint32_t(packed, d, off);
 
  packed = email_pack_timezone(e);
  d = serial_dump_uint32_t(packed, d, off);
 
  uint64_t big = e->date_sent;
  d = serial_dump_uint64_t(big, d, off);
  big = e->received;
  d = serial_dump_uint64_t(big, d, off);
 
  d = serial_dump_int(e->lines, d, off);
 
  d = serial_dump_envelope(e->env, d, off, convert);
  d = serial_dump_body(e->body, d, off, convert);
  d = serial_dump_tags(&e->tags, d, off);
 
  return d;
}

Here is the call graph for this function:

Here is the caller graph for this function:

restore_email()

static struct Email * restore_email ( const unsigned char * d )

static

Restore an Email from data retrieved from the cache.

Parameters

d	Data retrieved using hcache_fetch_email()

Return values

ptr	Success, the restored header (can't be NULL)

Note

The returned Email must be free'd by caller code with email_free()

Definition at line 272 of file hcache.c.

{
  int off = 0;
  struct Email *e = email_new();
  bool convert = !CharsetIsUtf8;
 
  off += sizeof(uint32_t);     // skip validate
  off += sizeof(unsigned int); // skip crc
 
  uint32_t packed = 0;
  serial_restore_uint32_t(&packed, d, &off);
  email_unpack_flags(e, packed);
 
  packed = 0;
  serial_restore_uint32_t(&packed, d, &off);
  email_unpack_timezone(e, packed);
 
  uint64_t big = 0;
  serial_restore_uint64_t(&big, d, &off);
  e->date_sent = big;
 
  big = 0;
  serial_restore_uint64_t(&big, d, &off);
  e->received = big;
 
  unsigned int num = 0;
  serial_restore_int(&num, d, &off);
  e->lines = num;
 
  e->env = mutt_env_new();
  serial_restore_envelope(e->env, d, &off, convert);
 
  e->body = mutt_body_new();
  serial_restore_body(e->body, d, &off, convert);
  serial_restore_tags(&e->tags, d, &off);
 
  return e;
}

Here is the call graph for this function:

Here is the caller graph for this function:

create_hcache_dir()

static bool create_hcache_dir ( const char * path )

static

Create parent dirs for the hcache database.

Parameters

path	Database filename

Return values

true	Success
false	Failure (errno set)

Definition at line 317 of file hcache.c.

{
  char *dir = mutt_str_dup(path);
  if (!dir)
    return false;
 
  char *p = strrchr(dir, '/');
  if (!p)
  {
    FREE(&dir);
    return true;
  }
 
  *p = '\0';
 
  int rc = mutt_file_mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO);
  if (rc != 0)
    mutt_error(_("Can't create %s: %s"), dir, strerror(errno));
 
  FREE(&dir);
  return (rc == 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_per_folder()

static void hcache_per_folder ( struct HeaderCache * hc, struct Buffer * hcpath, const char * path, hcache_namer_t namer )

static

Generate the hcache pathname.

Parameters

hc	Header cache handle
hcpath	Buffer for the result
path	Base directory, from $header_cache
namer	Callback to generate database filename - Implements hcache_namer_t

Generate the pathname for the hcache database, it will be of the form: BASE/FOLDER/NAME

• BASE: Base directory (path)
• FOLDER: Mailbox name (hc->folder)
• NAME: Create by namer, or md5sum of hc->folder

This function will create any parent directories needed, so the caller just needs to create the database file.

If path exists and is a directory, it is used. If path has a trailing '/' it is assumed to be a directory. Otherwise path is assumed to be a file.

Definition at line 361 of file hcache.c.

{
  struct stat st = { 0 };
 
  int plen = mutt_str_len(path);
  int rc = stat(path, &st);
  bool slash = (path[plen - 1] == '/');
 
  if (((rc == 0) && !S_ISDIR(st.st_mode)) || ((rc == -1) && !slash))
  {
    /* An existing file or a non-existing path not ending with a slash */
    mutt_encode_path(hcpath, path);
    create_hcache_dir(buf_string(hcpath));
    return;
  }
 
  /* We have a directory - no matter whether it exists, or not */
  struct Buffer *hcfile = buf_pool_get();
  if (namer)
  {
    namer(hc->store_ops, hc->folder, hcfile);
    mutt_encode_path(hcfile, buf_string(hcfile));
    buf_concat_path(hcpath, path, buf_string(hcfile));
  }
  else
  {
    unsigned char m[16]; /* binary md5sum */
    struct Buffer *name = buf_pool_get();
 
#ifdef USE_HCACHE_COMPRESSION
    const char *cm = hc->compr_ops ? hc->compr_ops->name : "";
    buf_printf(name, "%s|%s%s", hc->store_ops->name, hc->folder, cm);
#else
    buf_printf(name, "%s|%s", hc->store_ops->name, hc->folder);
#endif
    mutt_md5(buf_string(name), m);
    buf_reset(name);
    mutt_md5_toascii(m, name->data);
    mutt_encode_path(name, buf_string(name));
    buf_printf(hcpath, "%s%s%s", path, slash ? "" : "/", buf_string(name));
    buf_pool_release(&name);
  }
 
  create_hcache_dir(buf_string(hcpath));
  buf_pool_release(&hcfile);
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_foldername()

static char * get_foldername ( const char * folder )

static

Where should the cache be stored?

Parameters

folder

Path to be canonicalised

Return values

ptr	New string with canonical path

Definition at line 414 of file hcache.c.

{
  /* if the folder is local, canonify the path to ensure equivalent paths share
   * the hcache */
  char *p = MUTT_MEM_MALLOC(PATH_MAX + 1, char);
  if (!realpath(folder, p))
    mutt_str_replace(&p, folder);
 
  return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

free_raw()

static void free_raw ( struct HeaderCache * hc, void ** data )

static

Multiplexor for StoreOps::free.

Definition at line 428 of file hcache.c.

{
  hc->store_ops->free(hc->store_handle, data);
}

Here is the caller graph for this function:

generate_hcachever()

static unsigned int generate_hcachever ( void )

static

Calculate hcache version from dynamic configuration.

Return values

num	Header cache version

< MD5 digest as a string

< MD5 digest as an integer

Definition at line 437 of file hcache.c.

{
  union
  {
    unsigned char charval[16]; 
    unsigned int intval;       
  } digest;
  struct Md5Ctx md5ctx = { 0 };
 
  mutt_md5_init_ctx(&md5ctx);
 
  /* Seed with the compiled-in header structure hash */
  unsigned int ver = HCACHEVER;
  mutt_md5_process_bytes(&ver, sizeof(ver), &md5ctx);
 
  struct EmailModuleData *md = neomutt_get_module_data(NeoMutt, MODULE_ID_EMAIL);
  ASSERT(md);
 
  /* Mix in user's spam list */
  struct Replace *sp = NULL;
  STAILQ_FOREACH(sp, &md->spam, entries)
  {
    mutt_md5_process(sp->regex->pattern, &md5ctx);
    mutt_md5_process(sp->templ, &md5ctx);
  }
 
  /* Mix in user's nospam list */
  struct RegexNode *np = NULL;
  STAILQ_FOREACH(np, &md->no_spam, entries)
  {
    mutt_md5_process(np->regex->pattern, &md5ctx);
  }
 
  /* Get a hash and take its bytes as an (unsigned int) hash version */
  mutt_md5_finish_ctx(&md5ctx, digest.charval);
 
  return digest.intval;
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_open()

struct HeaderCache * hcache_open	(	const char *	path,
		const char *	folder,
		hcache_namer_t	namer,
		bool	create )

Multiplexor for StoreOps::open.

Open the connection to the header cache.

Definition at line 479 of file hcache.c.

{
  if (!path || (path[0] == '\0'))
    return NULL;
 
  if (HcacheVer == 0x0)
    HcacheVer = generate_hcachever();
 
  struct HeaderCache *hc = hcache_new();
 
  hc->folder = get_foldername(folder);
  hc->crc = HcacheVer;
 
  const char *const c_header_cache_backend = cs_subset_string(NeoMutt->sub, "header_cache_backend");
  hc->store_ops = store_get_backend_ops(c_header_cache_backend);
  if (!hc->store_ops)
  {
    hcache_free(&hc);
    return NULL;
  }
 
#ifdef USE_HCACHE_COMPRESSION
  const char *const c_header_cache_compress_method = cs_subset_string(NeoMutt->sub, "header_cache_compress_method");
  if (c_header_cache_compress_method)
  {
    hc->compr_ops = compress_get_ops(c_header_cache_compress_method);
 
    const short c_header_cache_compress_level = cs_subset_number(NeoMutt->sub, "header_cache_compress_level");
    hc->compr_handle = hc->compr_ops->open(c_header_cache_compress_level);
    if (!hc->compr_handle)
    {
      hcache_free(&hc);
      return NULL;
    }
 
    /* remember the buffer of database backend */
    mutt_debug(LL_DEBUG3, "Header cache will use %s compression\n",
               hc->compr_ops->name);
  }
#endif
 
  struct Buffer *hcpath = buf_pool_get();
  hcache_per_folder(hc, hcpath, path, namer);
 
  hc->store_handle = hc->store_ops->open(buf_string(hcpath), create);
  if (!hc->store_handle)
  {
    /* remove a possibly incompatible version */
    if (unlink(buf_string(hcpath)) == 0)
    {
      hc->store_handle = hc->store_ops->open(buf_string(hcpath), create);
    }
  }
 
  if (!hc->store_handle)
  {
    if (hc->compr_ops)
    {
      hc->compr_ops->close(&hc->compr_handle);
    }
    hcache_free(&hc);
  }
 
  buf_pool_release(&hcpath);
  return hc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_close()

void hcache_close

(

struct HeaderCache **

ptr

)

Multiplexor for StoreOps::close.

Close the connection to the header cache.

Definition at line 550 of file hcache.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct HeaderCache *hc = *ptr;
 
#ifdef USE_HCACHE_COMPRESSION
  if (hc->compr_ops)
    hc->compr_ops->close(&hc->compr_handle);
#endif
 
  hc->store_ops->close(&hc->store_handle);
 
  hcache_free(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_fetch_email()

struct HCacheEntry hcache_fetch_email	(	struct HeaderCache *	hc,
		const char *	key,
		size_t	keylen,
		uint32_t	uidvalidity )

Multiplexor for StoreOps::fetch.

Fetch and validate a message's header from the cache.

Definition at line 570 of file hcache.c.

{
  struct HCacheEntry hce = { 0 };
  if (!hc)
    return hce;
 
  size_t dlen = 0;
  struct RealKey *rk = realkey(hc, key, keylen, true);
  void *data = hc->store_ops->fetch(hc->store_handle, rk->key, rk->keylen, &dlen);
  void *to_free = data;
  if (!data)
  {
    goto end;
  }
 
  /* restore uidvalidity and crc */
  size_t hlen = header_size();
  if (hlen > dlen)
  {
    goto end;
  }
  int off = 0;
  serial_restore_uint32_t(&hce.uidvalidity, data, &off);
  serial_restore_int(&hce.crc, data, &off);
  ASSERT((size_t) off == hlen);
  if ((hce.crc != hc->crc) || ((uidvalidity != 0) && (uidvalidity != hce.uidvalidity)))
  {
    goto end;
  }
 
#ifdef USE_HCACHE_COMPRESSION
  if (hc->compr_ops)
  {
    void *dblob = hc->compr_ops->decompress(hc->compr_handle,
                                            (char *) data + hlen, dlen - hlen);
    if (!dblob)
    {
      goto end;
    }
    data = (char *) dblob - hlen; /* restore skips uidvalidity and crc */
  }
#endif
 
  hce.email = restore_email(data);
 
end:
  free_raw(hc, &to_free);
  return hce;
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_fetch_raw_obj_full()

bool hcache_fetch_raw_obj_full	(	struct HeaderCache *	hc,
		const char *	key,
		size_t	keylen,
		void *	dst,
		size_t	dstlen )

Fetch a message's header from the cache into a destination object.

Parameters

[in]	hc	Pointer to the struct HeaderCache structure got by hcache_open()
[in]	key	Message identification string
[in]	keylen	Length of the string pointed to by key
[out]	dst	Pointer to the destination object
[in]	dstlen	Size of the destination object

Return values

true	Success, the data was found and the length matches
false	Otherwise

Definition at line 631 of file hcache.c.

{
  if (!hc)
    return false;
 
  bool rc = true;
  size_t srclen = 0;
 
  struct RealKey *rk = realkey(hc, key, keylen, false);
  void *src = hc->store_ops->fetch(hc->store_handle, rk->key, rk->keylen, &srclen);
 
  if (src && (srclen == dstlen))
  {
    memcpy(dst, src, dstlen);
  }
  else
  {
    rc = false;
  }
  free_raw(hc, &src);
  return rc;
}

Here is the call graph for this function:

hcache_fetch_raw_str()

char * hcache_fetch_raw_str	(	struct HeaderCache *	hc,
		const char *	key,
		size_t	keylen )

Fetch a string from the cache.

Parameters

[in]	hc	Pointer to the struct HeaderCache structure got by hcache_open()
[in]	key	Message identification string
[in]	keylen	Length of the string pointed to by key

Return values

ptr	Success, the data if found
NULL	Otherwise

Definition at line 663 of file hcache.c.

{
  if (!hc)
    return NULL;
 
  char *res = NULL;
  size_t dlen = 0;
 
  struct RealKey *rk = realkey(hc, key, keylen, false);
  void *data = hc->store_ops->fetch(hc->store_handle, rk->key, rk->keylen, &dlen);
  if (data)
  {
    res = mutt_strn_dup(data, dlen);
    free_raw(hc, &data);
  }
  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_store_email()

int hcache_store_email	(	struct HeaderCache *	hc,
		const char *	key,
		size_t	keylen,
		struct Email *	e,
		uint32_t	uidvalidity )

Multiplexor for StoreOps::store.

Store a Header along with a validity datum.

Definition at line 684 of file hcache.c.

{
  if (!hc)
    return -1;
 
  int dlen = 0;
  char *data = dump_email(hc, e, &dlen, uidvalidity);
 
#ifdef USE_HCACHE_COMPRESSION
  if (hc->compr_ops)
  {
    /* We don't compress uidvalidity and the crc, so we can check them before
     * decompressing on fetch().  */
    size_t hlen = header_size();
 
    /* data / dlen gets ptr to compressed data here */
    size_t clen = dlen;
    void *cdata = hc->compr_ops->compress(hc->compr_handle, data + hlen, dlen - hlen, &clen);
    if (!cdata)
    {
      FREE(&data);
      return -1;
    }
 
    char *whole = MUTT_MEM_MALLOC(hlen + clen, char);
    memcpy(whole, data, hlen);
    memcpy(whole + hlen, cdata, clen);
 
    FREE(&data);
 
    data = whole;
    dlen = hlen + clen;
  }
#endif
 
  struct RealKey *rk = realkey(hc, key, keylen, true);
  int rc = hc->store_ops->store(hc->store_handle, rk->key, rk->keylen, data, dlen);
 
  FREE(&data);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_store_raw()

int hcache_store_raw	(	struct HeaderCache *	hc,
		const char *	key,
		size_t	keylen,
		void *	data,
		size_t	dlen )

Store a key / data pair.

Parameters

hc	Pointer to the struct HeaderCache structure got by hcache_open()
key	Message identification string
keylen	Length of the string pointed to by key
data	Payload to associate with key
dlen	Length of the buffer pointed to by the data parameter

Return values

0	Success
num	Generic or backend-specific error code otherwise

Definition at line 738 of file hcache.c.

{
  if (!hc)
    return -1;
 
  struct RealKey *rk = realkey(hc, key, keylen, false);
  int rc = hc->store_ops->store(hc->store_handle, rk->key, rk->keylen, data, dlen);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_delete_email()

int hcache_delete_email	(	struct HeaderCache *	hc,
		const char *	key,
		size_t	keylen )

Multiplexor for StoreOps::delete_record.

Delete a key / data pair.

Definition at line 753 of file hcache.c.

{
  if (!hc)
    return -1;
 
  struct RealKey *rk = realkey(hc, key, keylen, true);
 
  return hc->store_ops->delete_record(hc->store_handle, rk->key, rk->keylen);
}

Here is the call graph for this function:

Here is the caller graph for this function:

hcache_delete_raw()

int hcache_delete_raw	(	struct HeaderCache *	hc,
		const char *	key,
		size_t	keylen )

Multiplexor for StoreOps::delete_record.

Delete a key / data pair.

Definition at line 766 of file hcache.c.

{
  if (!hc)
    return -1;
 
  struct RealKey *rk = realkey(hc, key, keylen, false);
 
  return hc->store_ops->delete_record(hc->store_handle, rk->key, rk->keylen);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

HcacheVer

unsigned int HcacheVer = 0x0

static

Header Cache version.

Definition at line 61 of file hcache.c.