2 * Copyright notice from original mutt:
3 * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
4 * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
5 * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
7 * This file is part of mutt-ng, see http://www.muttng.org/.
8 * It's licensed under the GNU General Public License,
9 * please see the file GPL in the top level source directory.
13 #endif /* HAVE_CONFIG_H */
17 #define MUTTNG_HCACHE_ID "0x004"
20 # include <inttypes.h>
52 #include "lib/debug.h"
75 char lockfile[_POSIX_PATH_MAX];
80 struct timeval timeval;
81 unsigned long uid_validity;
84 static void *lazy_malloc (size_t siz)
86 if (0 < siz && siz < 4096) {
90 return mem_malloc (siz);
93 static void lazy_realloc (void *ptr, size_t siz)
95 void **p = (void **) ptr;
97 if (p != NULL && 0 < siz && siz < 4096) {
101 mem_realloc (ptr, siz);
104 static unsigned char *dump_int (unsigned int i, unsigned char *d, int *off)
106 lazy_realloc (&d, *off + sizeof (int));
107 memcpy (d + *off, &i, sizeof (int));
108 (*off) += sizeof (int);
113 static void restore_int (unsigned int *i, const unsigned char *d, int *off)
115 memcpy (i, d + *off, sizeof (int));
116 (*off) += sizeof (int);
119 static unsigned char *dump_char (char *c, unsigned char *d, int *off)
125 d = dump_int (size, d, off);
129 size = str_len (c) + 1;
130 d = dump_int (size, d, off);
131 lazy_realloc (&d, *off + size);
132 memcpy (d + *off, c, size);
139 static unsigned char *dump_char_size (char *c, unsigned char *d, int *off,
144 d = dump_int (size, d, off);
148 d = dump_int (size, d, off);
149 lazy_realloc (&d, *off + size);
150 memcpy (d + *off, c, size);
157 static void restore_char (char **c, const unsigned char *d, int *off)
161 restore_int (&size, d, off);
168 *c = mem_malloc (size);
169 memcpy (*c, d + *off, size);
173 static unsigned char *dump_address (ADDRESS * a, unsigned char *d, int *off)
175 unsigned int counter = 0;
176 unsigned int start_off = *off;
178 d = dump_int (0xdeadbeef, d, off);
181 d = dump_char (a->personal, d, off);
182 d = dump_char (a->mailbox, d, off);
183 d = dump_int (a->group, d, off);
188 memcpy (d + start_off, &counter, sizeof (int));
193 static void restore_address (ADDRESS ** a, const unsigned char *d, int *off)
195 unsigned int counter;
197 restore_int (&counter, d, off);
200 *a = mem_malloc (sizeof (ADDRESS));
201 restore_char (&(*a)->personal, d, off);
202 restore_char (&(*a)->mailbox, d, off);
203 restore_int ((unsigned int *) &(*a)->group, d, off);
211 static unsigned char *dump_list (LIST * l, unsigned char *d, int *off)
213 unsigned int counter = 0;
214 unsigned int start_off = *off;
216 d = dump_int (0xdeadbeef, d, off);
219 d = dump_char (l->data, d, off);
224 memcpy (d + start_off, &counter, sizeof (int));
229 static void restore_list (LIST ** l, const unsigned char *d, int *off)
231 unsigned int counter;
233 restore_int (&counter, d, off);
236 *l = mem_malloc (sizeof (LIST));
237 restore_char (&(*l)->data, d, off);
246 static unsigned char *dump_buffer (BUFFER * b, unsigned char *d, int *off)
249 d = dump_int (0, d, off);
253 d = dump_int (1, d, off);
256 d = dump_char_size (b->data, d, off, b->dsize + 1);
257 d = dump_int (b->dptr - b->data, d, off);
258 d = dump_int (b->dsize, d, off);
259 d = dump_int (b->destroy, d, off);
264 static void restore_buffer (BUFFER ** b, const unsigned char *d, int *off)
269 restore_int (&used, d, off);
274 *b = mem_malloc (sizeof (BUFFER));
276 restore_char (&(*b)->data, d, off);
277 restore_int (&offset, d, off);
278 (*b)->dptr = (*b)->data + offset;
279 restore_int (&(*b)->dsize, d, off);
280 restore_int ((unsigned int *) &(*b)->destroy, d, off);
284 static unsigned char *dump_parameter (PARAMETER * p, unsigned char *d,
287 unsigned int counter = 0;
288 unsigned int start_off = *off;
290 d = dump_int (0xdeadbeef, d, off);
293 d = dump_char (p->attribute, d, off);
294 d = dump_char (p->value, d, off);
299 memcpy (d + start_off, &counter, sizeof (int));
305 restore_parameter (PARAMETER ** p, const unsigned char *d, int *off)
307 unsigned int counter;
309 restore_int (&counter, d, off);
312 *p = mem_malloc (sizeof (PARAMETER));
313 restore_char (&(*p)->attribute, d, off);
314 restore_char (&(*p)->value, d, off);
322 static unsigned char *dump_body (BODY * c, unsigned char *d, int *off)
324 lazy_realloc (&d, *off + sizeof (BODY));
325 memcpy (d + *off, c, sizeof (BODY));
326 *off += sizeof (BODY);
328 d = dump_char (c->xtype, d, off);
329 d = dump_char (c->subtype, d, off);
331 d = dump_parameter (c->parameter, d, off);
333 d = dump_char (c->description, d, off);
334 d = dump_char (c->form_name, d, off);
335 d = dump_char (c->filename, d, off);
336 d = dump_char (c->d_filename, d, off);
341 static void restore_body (BODY * c, const unsigned char *d, int *off)
343 memcpy (c, d + *off, sizeof (BODY));
344 *off += sizeof (BODY);
346 restore_char (&c->xtype, d, off);
347 restore_char (&c->subtype, d, off);
349 restore_parameter (&c->parameter, d, off);
351 restore_char (&c->description, d, off);
352 restore_char (&c->form_name, d, off);
353 restore_char (&c->filename, d, off);
354 restore_char (&c->d_filename, d, off);
357 static unsigned char *dump_envelope (ENVELOPE * e, unsigned char *d, int *off)
359 d = dump_address (e->return_path, d, off);
360 d = dump_address (e->from, d, off);
361 d = dump_address (e->to, d, off);
362 d = dump_address (e->cc, d, off);
363 d = dump_address (e->bcc, d, off);
364 d = dump_address (e->sender, d, off);
365 d = dump_address (e->reply_to, d, off);
366 d = dump_address (e->mail_followup_to, d, off);
368 d = dump_char (e->subject, d, off);
370 d = dump_int (e->real_subj - e->subject, d, off);
373 d = dump_int (-1, d, off);
375 d = dump_char (e->message_id, d, off);
376 d = dump_char (e->supersedes, d, off);
377 d = dump_char (e->date, d, off);
378 d = dump_char (e->x_label, d, off);
379 d = dump_char (e->list_post, d, off);
382 d = dump_char (e->newsgroups, d, off);
383 d = dump_char (e->xref, d, off);
384 d = dump_char (e->followup_to, d, off);
385 d = dump_char (e->x_comment_to, d, off);
388 d = dump_list (e->references, d, off);
389 d = dump_list (e->in_reply_to, d, off);
390 d = dump_list (e->userhdrs, d, off);
395 static void restore_envelope (ENVELOPE * e, const unsigned char *d, int *off)
399 restore_address (&e->return_path, d, off);
400 restore_address (&e->from, d, off);
401 restore_address (&e->to, d, off);
402 restore_address (&e->cc, d, off);
403 restore_address (&e->bcc, d, off);
404 restore_address (&e->sender, d, off);
405 restore_address (&e->reply_to, d, off);
406 restore_address (&e->mail_followup_to, d, off);
408 restore_char (&e->subject, d, off);
409 restore_int ((unsigned int *) (&real_subj_off), d, off);
410 if (0 <= real_subj_off) {
411 e->real_subj = e->subject + real_subj_off;
416 restore_char (&e->message_id, d, off);
417 restore_char (&e->supersedes, d, off);
418 restore_char (&e->date, d, off);
419 restore_char (&e->x_label, d, off);
420 restore_char (&e->list_post, d, off);
423 restore_char (&e->newsgroups, d, off);
424 restore_char (&e->xref, d, off);
425 restore_char (&e->followup_to, d, off);
426 restore_char (&e->x_comment_to, d, off);
429 restore_list (&e->references, d, off);
430 restore_list (&e->in_reply_to, d, off);
431 restore_list (&e->userhdrs, d, off);
435 unsigned int crc32 (unsigned int crc, unsigned char const *p, size_t len)
441 for (i = 0; i < 8; i++)
442 crc = (crc >> 1) ^ ((crc & 1) ? 0xedb88320 : 0);
447 static int generate_crc32 ()
451 crc = crc32 (crc, (unsigned char const *)
452 MUTTNG_HCACHE_ID "sithglan@stud.uni-erlangen.de[sithglan]|hcache.c|20041108231548|29613",
454 (MUTTNG_HCACHE_ID "sithglan@stud.uni-erlangen.de[sithglan]|hcache.c|20041108231548|29613"));
456 #if HAVE_LANGINFO_CODESET
457 crc = crc32 (crc, (unsigned char const *) Charset, str_len (Charset));
459 crc32 (crc, (unsigned char const *) "HAVE_LANGINFO_CODESET",
460 str_len ("HAVE_LANGINFO_CODESET"));
465 crc32 (crc, (unsigned char const *) "USE_POP", str_len ("USE_POP"));
470 crc32 (crc, (unsigned char const *) "MIXMASTER",
471 str_len ("MIXMASTER"));
476 crc32 (crc, (unsigned char const *) "USE_IMAP", str_len ("USE_IMAP"));
481 crc32 (crc, (unsigned char const *) "USE_NNTP", str_len ("USE_NNTP"));
486 static int crc32_matches (const char *d, unsigned int crc)
488 int off = sizeof (validate);
489 unsigned int mycrc = 0;
495 restore_int (&mycrc, (unsigned char *) d, &off);
497 return (crc == mycrc);
500 /* Append md5sumed folder to path if path is a directory. */
501 static const char *mutt_hcache_per_folder (const char *path,
504 static char mutt_hcache_per_folder_path[_POSIX_PATH_MAX];
505 struct stat path_stat;
507 unsigned char md5sum[16];
510 ret = stat (path, &path_stat);
515 if (!S_ISDIR (path_stat.st_mode)) {
520 MD5Update (&md5, (unsigned char *) folder, str_len (folder));
521 MD5Final (md5sum, &md5);
523 ret = snprintf (mutt_hcache_per_folder_path, _POSIX_PATH_MAX,
524 "%s/%02x%02x%02x%02x%02x%02x%02x%02x"
525 "%02x%02x%02x%02x%02x%02x%02x%02x",
526 path, md5sum[0], md5sum[1], md5sum[2], md5sum[3],
527 md5sum[4], md5sum[5], md5sum[6], md5sum[7], md5sum[8],
528 md5sum[9], md5sum[10], md5sum[11], md5sum[12],
529 md5sum[13], md5sum[14], md5sum[15]);
535 return mutt_hcache_per_folder_path;
538 /* This function transforms a header into a char so that it is useable by
540 static void *mutt_hcache_dump (void *_db, HEADER * h, int *off,
541 unsigned long uid_validity)
543 struct header_cache *db = _db;
544 unsigned char *d = NULL;
548 d = lazy_malloc (sizeof (validate));
551 memcpy (d, &uid_validity, sizeof (unsigned long));
556 gettimeofday (&now, NULL);
557 memcpy (d, &now, sizeof (struct timeval));
559 *off += sizeof (validate);
561 d = dump_int (db->crc, d, off);
563 lazy_realloc (&d, *off + sizeof (HEADER));
564 memcpy (d + *off, h, sizeof (HEADER));
565 *off += sizeof (HEADER);
567 d = dump_envelope (h->env, d, off);
568 d = dump_body (h->content, d, off);
569 d = dump_char (h->maildir_flags, d, off);
574 HEADER *mutt_hcache_restore (const unsigned char *d, HEADER ** oh)
577 HEADER *h = mutt_new_header ();
580 off += sizeof (validate);
583 off += sizeof (unsigned int);
585 memcpy (h, d + off, sizeof (HEADER));
586 off += sizeof (HEADER);
588 h->env = mutt_new_envelope ();
589 restore_envelope (h->env, d, &off);
591 h->content = mutt_new_body ();
592 restore_body (h->content, d, &off);
594 restore_char (&h->maildir_flags, d, &off);
596 /* this is needed for maildir style mailboxes */
599 h->path = str_dup ((*oh)->path);
600 mutt_free_header (oh);
608 mutt_hcache_open(const char *path, const char *folder)
610 struct header_cache *h = mem_calloc(1, sizeof (HEADER_CACHE));
611 int flags = VL_OWRITER | VL_OCREAT;
613 h->folder = str_dup(folder);
614 h->crc = generate_crc32();
616 if (!path || path[0] == '\0')
618 mem_free(&h->folder);
623 path = mutt_hcache_per_folder(path, folder);
625 if (option(OPTHCACHECOMPRESS))
628 h->db = vlopen(path, flags, VL_CMPLEX);
633 mem_free(&h->folder);
641 mutt_hcache_close(void *db)
643 struct header_cache *h = db;
649 mem_free(&h->folder);
654 mutt_hcache_fetch(void *db, const char *filename,
655 size_t(*keylen) (const char *fn))
657 struct header_cache *h = db;
658 char path[_POSIX_PATH_MAX];
665 strncpy(path, h->folder, sizeof (path));
666 str_cat(path, sizeof (path), filename);
668 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
670 data = vlget(h->db, path, ksize, NULL);
672 if (! crc32_matches(data, h->crc))
682 mutt_hcache_store(void *db, const char *filename, HEADER * header,
683 unsigned long uid_validity,
684 size_t(*keylen) (const char *fn))
686 struct header_cache *h = db;
687 char path[_POSIX_PATH_MAX];
695 strncpy(path, h->folder, sizeof (path));
696 str_cat(path, sizeof (path), filename);
698 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
700 data = mutt_hcache_dump(db, header, &dsize, uid_validity);
702 ret = vlput(h->db, path, ksize, data, dsize, VL_DOVER);
710 mutt_hcache_delete(void *db, const char *filename,
711 size_t(*keylen) (const char *fn))
713 struct header_cache *h = db;
714 char path[_POSIX_PATH_MAX];
720 strncpy(path, h->folder, sizeof (path));
721 str_cat(path, sizeof (path), filename);
723 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
725 return vlout(h->db, path, ksize);
730 void *mutt_hcache_open (const char *path, const char *folder)
732 struct header_cache *h = mem_calloc (1, sizeof (HEADER_CACHE));
734 atoi (HeaderCachePageSize) ? atoi (HeaderCachePageSize) : 16384;
736 h->folder = str_dup (folder);
737 h->crc = generate_crc32 ();
739 if (!path || path[0] == '\0') {
740 mem_free (&h->folder);
745 path = mutt_hcache_per_folder (path, folder);
747 h->db = gdbm_open ((char *) path, pagesize, GDBM_WRCREAT, 00600, NULL);
752 /* if rw failed try ro */
753 h->db = gdbm_open ((char *) path, pagesize, GDBM_READER, 00600, NULL);
758 mem_free (&h->folder);
765 void mutt_hcache_close (void *db)
767 struct header_cache *h = db;
774 mem_free (&h->folder);
778 void *mutt_hcache_fetch (void *db, const char *filename,
779 size_t (*keylen) (const char *fn))
781 struct header_cache *h = db;
784 char path[_POSIX_PATH_MAX];
790 strncpy (path, h->folder, sizeof (path));
791 strncat (path, filename, sizeof (path) - str_len (path));
794 key.dsize = keylen (path);
796 data = gdbm_fetch (h->db, key);
798 if (!crc32_matches (data.dptr, h->crc)) {
799 mem_free(&data.dptr);
807 mutt_hcache_store (void *db, const char *filename, HEADER * header,
808 unsigned long uid_validity, size_t (*keylen) (const char *fn))
810 struct header_cache *h = db;
813 char path[_POSIX_PATH_MAX];
820 strncpy (path, h->folder, sizeof (path));
821 strncat (path, filename, sizeof (path) - str_len (path));
824 key.dsize = keylen (path);
826 data.dptr = mutt_hcache_dump (db, header, &data.dsize, uid_validity);
828 ret = gdbm_store (h->db, key, data, GDBM_REPLACE);
830 mem_free (&data.dptr);
836 mutt_hcache_delete (void *db, const char *filename,
837 size_t (*keylen) (const char *fn))
840 struct header_cache *h = db;
841 char path[_POSIX_PATH_MAX];
847 strncpy (path, h->folder, sizeof (path));
848 strncat (path, filename, sizeof (path) - str_len (path));
851 key.dsize = keylen (path);
853 return gdbm_delete (h->db, key);
857 static void mutt_hcache_dbt_init (DBT * dbt, void *data, size_t len)
860 dbt->size = dbt->ulen = len;
861 dbt->dlen = dbt->doff = 0;
862 dbt->flags = DB_DBT_USERMEM;
865 static void mutt_hcache_dbt_empty_init (DBT * dbt)
868 dbt->size = dbt->ulen = dbt->dlen = dbt->doff = 0;
872 void *mutt_hcache_open (const char *path, const char *folder)
875 u_int32_t createflags = DB_CREATE;
877 struct header_cache *h = calloc (1, sizeof (HEADER_CACHE));
878 int pagesize = atoi (HeaderCachePageSize);
881 h->crc = generate_crc32 ();
883 if (!path || path[0] == '\0') {
888 path = mutt_hcache_per_folder (path, folder);
890 snprintf (h->lockfile, _POSIX_PATH_MAX, "%s-lock-hack", path);
892 h->fd = open (h->lockfile, O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR);
898 if (mx_lock_file (h->lockfile, h->fd, 1, 0, 5)) {
904 ret = db_env_create (&h->env, 0);
906 mx_unlock_file (h->lockfile, h->fd, 0);
913 (h->env->open)(h->env, NULL, DB_INIT_MPOOL | DB_CREATE | DB_PRIVATE, 0600);
915 ret = db_create (&h->db, h->env, 0);
917 h->env->close (h->env, 0);
918 mx_unlock_file (h->lockfile, h->fd, 0);
925 if (stat (path, &sb) != 0 && errno == ENOENT) {
926 createflags |= DB_EXCL;
927 h->db->set_pagesize (h->db, pagesize);
930 ret = (h->db->open)(h->db, NULL, path, folder, DB_BTREE, createflags, 0600);
932 h->db->close (h->db, 0);
933 h->env->close (h->env, 0);
934 mx_unlock_file (h->lockfile, h->fd, 0);
943 void mutt_hcache_close (void *db)
945 struct header_cache *h = db;
951 h->db->close (h->db, 0);
952 h->env->close (h->env, 0);
953 mx_unlock_file (h->lockfile, h->fd, 0);
958 void *mutt_hcache_fetch (void *db, const char *filename,
959 size_t (*keylen) (const char *fn))
963 struct header_cache *h = db;
969 filename++; /* skip '/' */
971 mutt_hcache_dbt_init (&key, (void *) filename, keylen (filename));
972 mutt_hcache_dbt_empty_init (&data);
973 data.flags = DB_DBT_MALLOC;
975 h->db->get (h->db, NULL, &key, &data, 0);
977 if (!crc32_matches (data.data, h->crc)) {
978 mem_free(&data.data);
986 mutt_hcache_store (void *db, const char *filename, HEADER * header,
987 unsigned long uid_validity, size_t (*keylen) (const char *fn))
992 struct header_cache *h = db;
998 filename++; /* skip '/' */
1000 mutt_hcache_dbt_init (&key, (void *) filename, keylen (filename));
1002 mutt_hcache_dbt_empty_init (&data);
1003 data.flags = DB_DBT_USERMEM;
1005 mutt_hcache_dump (db, header, (signed int *) &data.size, uid_validity);
1006 data.ulen = data.size;
1008 ret = h->db->put (h->db, NULL, &key, &data, 0);
1010 mem_free (&data.data);
1016 mutt_hcache_delete (void *db, const char *filename,
1017 size_t (*keylen) (const char *fn))
1020 struct header_cache *h = db;
1026 filename++; /* skip '/' */
1028 mutt_hcache_dbt_init (&key, (void *) filename, keylen (filename));
1029 return h->db->del (h->db, NULL, &key, 0);
1033 #endif /* USE_HCACHE */