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 */
18 # include <inttypes.h>
50 #include "lib/debug.h"
73 char lockfile[_POSIX_PATH_MAX];
78 struct timeval timeval;
79 unsigned long uid_validity;
82 static void *lazy_malloc (size_t siz)
84 if (0 < siz && siz < 4096) {
88 return mem_malloc (siz);
91 static void lazy_realloc (void *ptr, size_t siz)
93 void **p = (void **) ptr;
95 if (p != NULL && 0 < siz && siz < 4096) {
99 mem_realloc (ptr, siz);
102 static unsigned char *dump_int (unsigned int i, unsigned char *d, int *off)
104 lazy_realloc (&d, *off + sizeof (int));
105 memcpy (d + *off, &i, sizeof (int));
106 (*off) += sizeof (int);
111 static void restore_int (unsigned int *i, const unsigned char *d, int *off)
113 memcpy (i, d + *off, sizeof (int));
114 (*off) += sizeof (int);
117 static unsigned char *dump_char (char *c, unsigned char *d, int *off)
123 d = dump_int (size, d, off);
127 size = str_len (c) + 1;
128 d = dump_int (size, d, off);
129 lazy_realloc (&d, *off + size);
130 memcpy (d + *off, c, size);
137 static unsigned char *dump_char_size (char *c, unsigned char *d, int *off,
142 d = dump_int (size, d, off);
146 d = dump_int (size, d, off);
147 lazy_realloc (&d, *off + size);
148 memcpy (d + *off, c, size);
155 static void restore_char (char **c, const unsigned char *d, int *off)
159 restore_int (&size, d, off);
166 *c = mem_malloc (size);
167 memcpy (*c, d + *off, size);
171 static unsigned char *dump_address (ADDRESS * a, unsigned char *d, int *off)
173 unsigned int counter = 0;
174 unsigned int start_off = *off;
176 d = dump_int (0xdeadbeef, d, off);
179 d = dump_char (a->personal, d, off);
180 d = dump_char (a->mailbox, d, off);
181 d = dump_int (a->group, d, off);
186 memcpy (d + start_off, &counter, sizeof (int));
191 static void restore_address (ADDRESS ** a, const unsigned char *d, int *off)
193 unsigned int counter;
195 restore_int (&counter, d, off);
198 *a = mem_malloc (sizeof (ADDRESS));
199 restore_char (&(*a)->personal, d, off);
200 restore_char (&(*a)->mailbox, d, off);
201 restore_int ((unsigned int *) &(*a)->group, d, off);
209 static unsigned char *dump_list (LIST * l, unsigned char *d, int *off)
211 unsigned int counter = 0;
212 unsigned int start_off = *off;
214 d = dump_int (0xdeadbeef, d, off);
217 d = dump_char (l->data, d, off);
222 memcpy (d + start_off, &counter, sizeof (int));
227 static void restore_list (LIST ** l, const unsigned char *d, int *off)
229 unsigned int counter;
231 restore_int (&counter, d, off);
234 *l = mem_malloc (sizeof (LIST));
235 restore_char (&(*l)->data, d, off);
244 static unsigned char *dump_buffer (BUFFER * b, unsigned char *d, int *off)
247 d = dump_int (0, d, off);
251 d = dump_int (1, d, off);
254 d = dump_char_size (b->data, d, off, b->dsize + 1);
255 d = dump_int (b->dptr - b->data, d, off);
256 d = dump_int (b->dsize, d, off);
257 d = dump_int (b->destroy, d, off);
262 static void restore_buffer (BUFFER ** b, const unsigned char *d, int *off)
267 restore_int (&used, d, off);
272 *b = mem_malloc (sizeof (BUFFER));
274 restore_char (&(*b)->data, d, off);
275 restore_int (&offset, d, off);
276 (*b)->dptr = (*b)->data + offset;
277 restore_int (&(*b)->dsize, d, off);
278 restore_int ((unsigned int *) &(*b)->destroy, d, off);
282 static unsigned char *dump_parameter (PARAMETER * p, unsigned char *d,
285 unsigned int counter = 0;
286 unsigned int start_off = *off;
288 d = dump_int (0xdeadbeef, d, off);
291 d = dump_char (p->attribute, d, off);
292 d = dump_char (p->value, d, off);
297 memcpy (d + start_off, &counter, sizeof (int));
303 restore_parameter (PARAMETER ** p, const unsigned char *d, int *off)
305 unsigned int counter;
307 restore_int (&counter, d, off);
310 *p = mem_malloc (sizeof (PARAMETER));
311 restore_char (&(*p)->attribute, d, off);
312 restore_char (&(*p)->value, d, off);
320 static unsigned char *dump_body (BODY * c, unsigned char *d, int *off)
322 lazy_realloc (&d, *off + sizeof (BODY));
323 memcpy (d + *off, c, sizeof (BODY));
324 *off += sizeof (BODY);
326 d = dump_char (c->xtype, d, off);
327 d = dump_char (c->subtype, d, off);
329 d = dump_parameter (c->parameter, d, off);
331 d = dump_char (c->description, d, off);
332 d = dump_char (c->form_name, d, off);
333 d = dump_char (c->filename, d, off);
334 d = dump_char (c->d_filename, d, off);
339 static void restore_body (BODY * c, const unsigned char *d, int *off)
341 memcpy (c, d + *off, sizeof (BODY));
342 *off += sizeof (BODY);
344 restore_char (&c->xtype, d, off);
345 restore_char (&c->subtype, d, off);
347 restore_parameter (&c->parameter, d, off);
349 restore_char (&c->description, d, off);
350 restore_char (&c->form_name, d, off);
351 restore_char (&c->filename, d, off);
352 restore_char (&c->d_filename, d, off);
355 static unsigned char *dump_envelope (ENVELOPE * e, unsigned char *d, int *off)
357 d = dump_address (e->return_path, d, off);
358 d = dump_address (e->from, d, off);
359 d = dump_address (e->to, d, off);
360 d = dump_address (e->cc, d, off);
361 d = dump_address (e->bcc, d, off);
362 d = dump_address (e->sender, d, off);
363 d = dump_address (e->reply_to, d, off);
364 d = dump_address (e->mail_followup_to, d, off);
366 d = dump_char (e->subject, d, off);
368 d = dump_int (e->real_subj - e->subject, d, off);
371 d = dump_int (-1, d, off);
373 d = dump_char (e->message_id, d, off);
374 d = dump_char (e->supersedes, d, off);
375 d = dump_char (e->date, d, off);
376 d = dump_char (e->x_label, d, off);
379 d = dump_char (e->newsgroups, d, off);
380 d = dump_char (e->xref, d, off);
381 d = dump_char (e->followup_to, d, off);
382 d = dump_char (e->x_comment_to, d, off);
385 d = dump_list (e->references, d, off);
386 d = dump_list (e->in_reply_to, d, off);
387 d = dump_list (e->userhdrs, d, off);
392 static void restore_envelope (ENVELOPE * e, const unsigned char *d, int *off)
396 restore_address (&e->return_path, d, off);
397 restore_address (&e->from, d, off);
398 restore_address (&e->to, d, off);
399 restore_address (&e->cc, d, off);
400 restore_address (&e->bcc, d, off);
401 restore_address (&e->sender, d, off);
402 restore_address (&e->reply_to, d, off);
403 restore_address (&e->mail_followup_to, d, off);
405 restore_char (&e->subject, d, off);
406 restore_int ((unsigned int *) (&real_subj_off), d, off);
407 if (0 <= real_subj_off) {
408 e->real_subj = e->subject + real_subj_off;
413 restore_char (&e->message_id, d, off);
414 restore_char (&e->supersedes, d, off);
415 restore_char (&e->date, d, off);
416 restore_char (&e->x_label, d, off);
419 restore_char (&e->newsgroups, d, off);
420 restore_char (&e->xref, d, off);
421 restore_char (&e->followup_to, d, off);
422 restore_char (&e->x_comment_to, d, off);
425 restore_list (&e->references, d, off);
426 restore_list (&e->in_reply_to, d, off);
427 restore_list (&e->userhdrs, d, off);
431 unsigned int crc32 (unsigned int crc, unsigned char const *p, size_t len)
437 for (i = 0; i < 8; i++)
438 crc = (crc >> 1) ^ ((crc & 1) ? 0xedb88320 : 0);
443 static int generate_crc32 ()
447 crc = crc32 (crc, (unsigned char const *)
448 "sithglan@stud.uni-erlangen.de[sithglan]|hcache.c|20041108231548|29613",
450 ("sithglan@stud.uni-erlangen.de[sithglan]|hcache.c|20041108231548|29613"));
452 #if HAVE_LANGINFO_CODESET
453 crc = crc32 (crc, (unsigned char const *) Charset, str_len (Charset));
455 crc32 (crc, (unsigned char const *) "HAVE_LANGINFO_CODESET",
456 str_len ("HAVE_LANGINFO_CODESET"));
461 crc32 (crc, (unsigned char const *) "USE_POP", str_len ("USE_POP"));
466 crc32 (crc, (unsigned char const *) "MIXMASTER",
467 str_len ("MIXMASTER"));
472 crc32 (crc, (unsigned char const *) "USE_IMAP", str_len ("USE_IMAP"));
477 crc32 (crc, (unsigned char const *) "USE_NNTP", str_len ("USE_NNTP"));
482 static int crc32_matches (const char *d, unsigned int crc)
484 int off = sizeof (validate);
485 unsigned int mycrc = 0;
491 restore_int (&mycrc, (unsigned char *) d, &off);
493 return (crc == mycrc);
496 /* Append md5sumed folder to path if path is a directory. */
497 static const char *mutt_hcache_per_folder (const char *path,
500 static char mutt_hcache_per_folder_path[_POSIX_PATH_MAX];
501 struct stat path_stat;
503 unsigned char md5sum[16];
506 ret = stat (path, &path_stat);
511 if (!S_ISDIR (path_stat.st_mode)) {
516 MD5Update (&md5, (unsigned char *) folder, str_len (folder));
517 MD5Final (md5sum, &md5);
519 ret = snprintf (mutt_hcache_per_folder_path, _POSIX_PATH_MAX,
520 "%s/%02x%02x%02x%02x%02x%02x%02x%02x"
521 "%02x%02x%02x%02x%02x%02x%02x%02x",
522 path, md5sum[0], md5sum[1], md5sum[2], md5sum[3],
523 md5sum[4], md5sum[5], md5sum[6], md5sum[7], md5sum[8],
524 md5sum[9], md5sum[10], md5sum[11], md5sum[12],
525 md5sum[13], md5sum[14], md5sum[15]);
531 return mutt_hcache_per_folder_path;
534 /* This function transforms a header into a char so that it is useable by
536 static void *mutt_hcache_dump (void *_db, HEADER * h, int *off,
537 unsigned long uid_validity)
539 struct header_cache *db = _db;
540 unsigned char *d = NULL;
544 d = lazy_malloc (sizeof (validate));
547 memcpy (d, &uid_validity, sizeof (unsigned long));
552 gettimeofday (&now, NULL);
553 memcpy (d, &now, sizeof (struct timeval));
555 *off += sizeof (validate);
557 d = dump_int (db->crc, d, off);
559 lazy_realloc (&d, *off + sizeof (HEADER));
560 memcpy (d + *off, h, sizeof (HEADER));
561 *off += sizeof (HEADER);
563 d = dump_envelope (h->env, d, off);
564 d = dump_body (h->content, d, off);
565 d = dump_char (h->maildir_flags, d, off);
570 HEADER *mutt_hcache_restore (const unsigned char *d, HEADER ** oh)
573 HEADER *h = mutt_new_header ();
576 off += sizeof (validate);
579 off += sizeof (unsigned int);
581 memcpy (h, d + off, sizeof (HEADER));
582 off += sizeof (HEADER);
584 h->env = mutt_new_envelope ();
585 restore_envelope (h->env, d, &off);
587 h->content = mutt_new_body ();
588 restore_body (h->content, d, &off);
590 restore_char (&h->maildir_flags, d, &off);
592 /* this is needed for maildir style mailboxes */
595 h->path = str_dup ((*oh)->path);
596 mutt_free_header (oh);
604 mutt_hcache_open(const char *path, const char *folder)
606 struct header_cache *h = mem_calloc(1, sizeof (HEADER_CACHE));
607 int flags = VL_OWRITER | VL_OCREAT;
609 h->folder = str_dup(folder);
610 h->crc = generate_crc32();
612 if (!path || path[0] == '\0')
614 mem_free(&h->folder);
619 path = mutt_hcache_per_folder(path, folder);
621 if (option(OPTHCACHECOMPRESS))
624 h->db = vlopen(path, flags, VL_CMPLEX);
629 mem_free(&h->folder);
637 mutt_hcache_close(void *db)
639 struct header_cache *h = db;
645 mem_free(&h->folder);
650 mutt_hcache_fetch(void *db, const char *filename,
651 size_t(*keylen) (const char *fn))
653 struct header_cache *h = db;
654 char path[_POSIX_PATH_MAX];
661 strncpy(path, h->folder, sizeof (path));
662 str_cat(path, sizeof (path), filename);
664 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
666 data = vlget(h->db, path, ksize, NULL);
668 if (! crc32_matches(data, h->crc))
678 mutt_hcache_store(void *db, const char *filename, HEADER * header,
679 unsigned long uid_validity,
680 size_t(*keylen) (const char *fn))
682 struct header_cache *h = db;
683 char path[_POSIX_PATH_MAX];
691 strncpy(path, h->folder, sizeof (path));
692 str_cat(path, sizeof (path), filename);
694 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
696 data = mutt_hcache_dump(db, header, &dsize, uid_validity);
698 ret = vlput(h->db, path, ksize, data, dsize, VL_DOVER);
706 mutt_hcache_delete(void *db, const char *filename,
707 size_t(*keylen) (const char *fn))
709 struct header_cache *h = db;
710 char path[_POSIX_PATH_MAX];
716 strncpy(path, h->folder, sizeof (path));
717 str_cat(path, sizeof (path), filename);
719 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
721 return vlout(h->db, path, ksize);
726 void *mutt_hcache_open (const char *path, const char *folder)
728 struct header_cache *h = mem_calloc (1, sizeof (HEADER_CACHE));
730 atoi (HeaderCachePageSize) ? atoi (HeaderCachePageSize) : 16384;
732 h->folder = str_dup (folder);
733 h->crc = generate_crc32 ();
735 if (!path || path[0] == '\0') {
736 mem_free (&h->folder);
741 path = mutt_hcache_per_folder (path, folder);
743 h->db = gdbm_open ((char *) path, pagesize, GDBM_WRCREAT, 00600, NULL);
748 /* if rw failed try ro */
749 h->db = gdbm_open ((char *) path, pagesize, GDBM_READER, 00600, NULL);
754 mem_free (&h->folder);
761 void mutt_hcache_close (void *db)
763 struct header_cache *h = db;
770 mem_free (&h->folder);
774 void *mutt_hcache_fetch (void *db, const char *filename,
775 size_t (*keylen) (const char *fn))
777 struct header_cache *h = db;
780 char path[_POSIX_PATH_MAX];
786 strncpy (path, h->folder, sizeof (path));
787 strncat (path, filename, sizeof (path) - str_len (path));
790 key.dsize = keylen (path);
792 data = gdbm_fetch (h->db, key);
794 if (!crc32_matches (data.dptr, h->crc)) {
795 mem_free(&data.dptr);
803 mutt_hcache_store (void *db, const char *filename, HEADER * header,
804 unsigned long uid_validity, size_t (*keylen) (const char *fn))
806 struct header_cache *h = db;
809 char path[_POSIX_PATH_MAX];
816 strncpy (path, h->folder, sizeof (path));
817 strncat (path, filename, sizeof (path) - str_len (path));
820 key.dsize = keylen (path);
822 data.dptr = mutt_hcache_dump (db, header, &data.dsize, uid_validity);
824 ret = gdbm_store (h->db, key, data, GDBM_REPLACE);
826 mem_free (&data.dptr);
832 mutt_hcache_delete (void *db, const char *filename,
833 size_t (*keylen) (const char *fn))
836 struct header_cache *h = db;
837 char path[_POSIX_PATH_MAX];
843 strncpy (path, h->folder, sizeof (path));
844 strncat (path, filename, sizeof (path) - str_len (path));
847 key.dsize = keylen (path);
849 return gdbm_delete (h->db, key);
853 static void mutt_hcache_dbt_init (DBT * dbt, void *data, size_t len)
856 dbt->size = dbt->ulen = len;
857 dbt->dlen = dbt->doff = 0;
858 dbt->flags = DB_DBT_USERMEM;
861 static void mutt_hcache_dbt_empty_init (DBT * dbt)
864 dbt->size = dbt->ulen = dbt->dlen = dbt->doff = 0;
868 void *mutt_hcache_open (const char *path, const char *folder)
871 u_int32_t createflags = DB_CREATE;
873 struct header_cache *h = calloc (1, sizeof (HEADER_CACHE));
874 int pagesize = atoi (HeaderCachePageSize);
877 h->crc = generate_crc32 ();
879 if (!path || path[0] == '\0') {
884 path = mutt_hcache_per_folder (path, folder);
886 snprintf (h->lockfile, _POSIX_PATH_MAX, "%s-lock-hack", path);
888 h->fd = open (h->lockfile, O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR);
894 if (mx_lock_file (h->lockfile, h->fd, 1, 0, 5)) {
900 ret = db_env_create (&h->env, 0);
902 mx_unlock_file (h->lockfile, h->fd, 0);
909 (h->env->open)(h->env, NULL, DB_INIT_MPOOL | DB_CREATE | DB_PRIVATE, 0600);
911 ret = db_create (&h->db, h->env, 0);
913 h->env->close (h->env, 0);
914 mx_unlock_file (h->lockfile, h->fd, 0);
921 if (stat (path, &sb) != 0 && errno == ENOENT) {
922 createflags |= DB_EXCL;
923 h->db->set_pagesize (h->db, pagesize);
926 ret = (h->db->open)(h->db, NULL, path, folder, DB_BTREE, createflags, 0600);
928 h->db->close (h->db, 0);
929 h->env->close (h->env, 0);
930 mx_unlock_file (h->lockfile, h->fd, 0);
939 void mutt_hcache_close (void *db)
941 struct header_cache *h = db;
947 h->db->close (h->db, 0);
948 h->env->close (h->env, 0);
949 mx_unlock_file (h->lockfile, h->fd, 0);
954 void *mutt_hcache_fetch (void *db, const char *filename,
955 size_t (*keylen) (const char *fn))
959 struct header_cache *h = db;
965 filename++; /* skip '/' */
967 mutt_hcache_dbt_init (&key, (void *) filename, keylen (filename));
968 mutt_hcache_dbt_empty_init (&data);
969 data.flags = DB_DBT_MALLOC;
971 h->db->get (h->db, NULL, &key, &data, 0);
973 if (!crc32_matches (data.data, h->crc)) {
974 mem_free(&data.data);
982 mutt_hcache_store (void *db, const char *filename, HEADER * header,
983 unsigned long uid_validity, size_t (*keylen) (const char *fn))
988 struct header_cache *h = db;
994 filename++; /* skip '/' */
996 mutt_hcache_dbt_init (&key, (void *) filename, keylen (filename));
998 mutt_hcache_dbt_empty_init (&data);
999 data.flags = DB_DBT_USERMEM;
1001 mutt_hcache_dump (db, header, (signed int *) &data.size, uid_validity);
1002 data.ulen = data.size;
1004 ret = h->db->put (h->db, NULL, &key, &data, 0);
1006 mem_free (&data.data);
1012 mutt_hcache_delete (void *db, const char *filename,
1013 size_t (*keylen) (const char *fn))
1016 struct header_cache *h = db;
1022 filename++; /* skip '/' */
1024 mutt_hcache_dbt_init (&key, (void *) filename, keylen (filename));
1025 return h->db->del (h->db, NULL, &key, 0);
1029 #endif /* USE_HCACHE */