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.
12 #include <lib-lib/lib-lib.h>
16 #define MUTTNG_HCACHE_ID "0x004"
18 #if defined(HAVE_QDBM)
22 #elif defined(HAVE_GDBM)
26 #include <imap/message.h>
34 #if defined(HAVE_QDBM)
38 #elif defined(HAVE_GDBM)
46 struct timeval timeval;
47 unsigned long uid_validity;
50 #define UPPER4K(i) ((i & ~(4096 - 1)) + 4096)
52 static unsigned char *lazy_malloc(ssize_t siz)
54 return p_new(unsigned char, UPPER4K(siz));
57 static void lazy_realloc(unsigned char **p, ssize_t siz)
59 p_realloc(p, UPPER4K(siz));
62 static unsigned char *dump_int (unsigned int i, unsigned char *d, int *off)
64 lazy_realloc (&d, *off + sizeof (int));
65 memcpy (d + *off, &i, sizeof (int));
66 (*off) += sizeof (int);
71 static void restore_int (unsigned int *i, const unsigned char *d, int *off)
73 memcpy (i, d + *off, sizeof (int));
74 (*off) += sizeof (int);
77 static unsigned char *dump_char (char *c, unsigned char *d, int *off)
83 d = dump_int (size, d, off);
87 size = m_strlen(c) + 1;
88 d = dump_int (size, d, off);
89 lazy_realloc (&d, *off + size);
90 memcpy (d + *off, c, size);
96 static void restore_char (char **c, const unsigned char *d, int *off)
100 restore_int (&size, d, off);
107 *c = p_dup(d + *off, size);
111 static unsigned char *dump_address (address_t * a, unsigned char *d, int *off)
113 unsigned int counter = 0;
114 unsigned int start_off = *off;
116 d = dump_int (0xdeadbeef, d, off);
119 d = dump_char (a->personal, d, off);
120 d = dump_char (a->mailbox, d, off);
121 d = dump_int (a->group, d, off);
126 memcpy (d + start_off, &counter, sizeof (int));
131 static void restore_address (address_t ** a, const unsigned char *d, int *off)
133 unsigned int counter;
135 restore_int (&counter, d, off);
138 *a = p_new(address_t, 1);
139 restore_char (&(*a)->personal, d, off);
140 restore_char (&(*a)->mailbox, d, off);
141 restore_int ((unsigned int *) &(*a)->group, d, off);
149 static unsigned char *dump_list (string_list_t * l, unsigned char *d, int *off)
151 unsigned int counter = 0;
152 unsigned int start_off = *off;
154 d = dump_int (0xdeadbeef, d, off);
157 d = dump_char (l->data, d, off);
162 memcpy (d + start_off, &counter, sizeof (int));
167 static void restore_list (string_list_t ** l, const unsigned char *d, int *off)
169 unsigned int counter;
171 restore_int (&counter, d, off);
174 *l = p_new(string_list_t, 1);
175 restore_char (&(*l)->data, d, off);
183 static unsigned char *dump_parameter (parameter_t * p, unsigned char *d,
186 unsigned int counter = 0;
187 unsigned int start_off = *off;
189 d = dump_int (0xdeadbeef, d, off);
192 d = dump_char (p->attribute, d, off);
193 d = dump_char (p->value, d, off);
198 memcpy (d + start_off, &counter, sizeof (int));
204 restore_parameter (parameter_t ** p, const unsigned char *d, int *off)
206 unsigned int counter;
208 restore_int (&counter, d, off);
211 *p = parameter_new();
212 restore_char (&(*p)->attribute, d, off);
213 restore_char (&(*p)->value, d, off);
219 static unsigned char *dump_body (BODY * c, unsigned char *d, int *off)
221 lazy_realloc (&d, *off + sizeof (BODY));
222 memcpy (d + *off, c, sizeof (BODY));
223 *off += sizeof (BODY);
225 d = dump_char (c->xtype, d, off);
226 d = dump_char (c->subtype, d, off);
228 d = dump_parameter (c->parameter, d, off);
230 d = dump_char (c->description, d, off);
231 d = dump_char (c->form_name, d, off);
232 d = dump_char (c->filename, d, off);
233 d = dump_char (c->d_filename, d, off);
238 static void restore_body (BODY * c, const unsigned char *d, int *off)
240 memcpy (c, d + *off, sizeof (BODY));
241 *off += sizeof (BODY);
243 restore_char (&c->xtype, d, off);
244 restore_char (&c->subtype, d, off);
246 restore_parameter (&c->parameter, d, off);
248 restore_char (&c->description, d, off);
249 restore_char (&c->form_name, d, off);
250 restore_char (&c->filename, d, off);
251 restore_char (&c->d_filename, d, off);
254 static unsigned char *dump_envelope (ENVELOPE * e, unsigned char *d, int *off)
256 d = dump_address (e->return_path, d, off);
257 d = dump_address (e->from, d, off);
258 d = dump_address (e->to, d, off);
259 d = dump_address (e->cc, d, off);
260 d = dump_address (e->bcc, d, off);
261 d = dump_address (e->sender, d, off);
262 d = dump_address (e->reply_to, d, off);
263 d = dump_address (e->mail_followup_to, d, off);
265 d = dump_char (e->subject, d, off);
267 d = dump_int (e->real_subj - e->subject, d, off);
270 d = dump_int (-1, d, off);
272 d = dump_char (e->message_id, d, off);
273 d = dump_char (e->supersedes, d, off);
274 d = dump_char (e->date, d, off);
275 d = dump_char (e->x_label, d, off);
276 d = dump_char (e->list_post, d, off);
279 d = dump_char (e->newsgroups, d, off);
280 d = dump_char (e->xref, d, off);
281 d = dump_char (e->followup_to, d, off);
282 d = dump_char (e->x_comment_to, d, off);
285 d = dump_list (e->references, d, off);
286 d = dump_list (e->in_reply_to, d, off);
287 d = dump_list (e->userhdrs, d, off);
292 static void restore_envelope (ENVELOPE * e, const unsigned char *d, int *off)
296 restore_address (&e->return_path, d, off);
297 restore_address (&e->from, d, off);
298 restore_address (&e->to, d, off);
299 restore_address (&e->cc, d, off);
300 restore_address (&e->bcc, d, off);
301 restore_address (&e->sender, d, off);
302 restore_address (&e->reply_to, d, off);
303 restore_address (&e->mail_followup_to, d, off);
305 restore_char (&e->subject, d, off);
306 restore_int ((unsigned int *) (&real_subj_off), d, off);
307 if (0 <= real_subj_off) {
308 e->real_subj = e->subject + real_subj_off;
313 restore_char (&e->message_id, d, off);
314 restore_char (&e->supersedes, d, off);
315 restore_char (&e->date, d, off);
316 restore_char (&e->x_label, d, off);
317 restore_char (&e->list_post, d, off);
320 restore_char (&e->newsgroups, d, off);
321 restore_char (&e->xref, d, off);
322 restore_char (&e->followup_to, d, off);
323 restore_char (&e->x_comment_to, d, off);
326 restore_list (&e->references, d, off);
327 restore_list (&e->in_reply_to, d, off);
328 restore_list (&e->userhdrs, d, off);
332 unsigned int crc32 (unsigned int crc, unsigned char const *p, ssize_t len)
338 for (i = 0; i < 8; i++)
339 crc = (crc >> 1) ^ ((crc & 1) ? 0xedb88320 : 0);
344 static int generate_crc32 ()
348 crc = crc32 (crc, (unsigned char const *)
349 MUTTNG_HCACHE_ID "sithglan@stud.uni-erlangen.de[sithglan]|hcache.c|20041108231548|29613",
351 (MUTTNG_HCACHE_ID "sithglan@stud.uni-erlangen.de[sithglan]|hcache.c|20041108231548|29613"));
353 #ifdef HAVE_LANGINFO_CODESET
354 crc = crc32(crc, (unsigned char const *) MCharset.charset, m_strlen(MCharset.charset));
355 crc = crc32(crc, (unsigned char const *) "HAVE_LANGINFO_CODESET",
356 m_strlen("HAVE_LANGINFO_CODESET"));
359 crc = crc32(crc, (unsigned char const *) "USE_POP", m_strlen("USE_POP"));
361 crc = crc32(crc, (unsigned char const *) "MIXMASTER",
362 m_strlen("MIXMASTER"));
364 crc = crc32(crc, (unsigned char const *) "USE_IMAP", m_strlen("USE_IMAP"));
367 crc = crc32(crc, (unsigned char const *) "USE_NNTP", m_strlen("USE_NNTP"));
372 static int crc32_matches (const char *d, unsigned int crc)
374 int off = sizeof (validate);
375 unsigned int mycrc = 0;
381 restore_int (&mycrc, (unsigned char *) d, &off);
383 return (crc == mycrc);
386 /* Append md5sumed folder to path if path is a directory. */
387 static const char *mutt_hcache_per_folder (const char *path,
390 static char mutt_hcache_per_folder_path[_POSIX_PATH_MAX];
391 struct stat path_stat;
393 unsigned char md5sum[16];
396 ret = stat (path, &path_stat);
401 if (!S_ISDIR (path_stat.st_mode)) {
406 MD5Update (&md5, (unsigned char *) folder, m_strlen(folder));
407 MD5Final (md5sum, &md5);
409 ret = snprintf (mutt_hcache_per_folder_path, _POSIX_PATH_MAX,
410 "%s/%02x%02x%02x%02x%02x%02x%02x%02x"
411 "%02x%02x%02x%02x%02x%02x%02x%02x",
412 path, md5sum[0], md5sum[1], md5sum[2], md5sum[3],
413 md5sum[4], md5sum[5], md5sum[6], md5sum[7], md5sum[8],
414 md5sum[9], md5sum[10], md5sum[11], md5sum[12],
415 md5sum[13], md5sum[14], md5sum[15]);
421 return mutt_hcache_per_folder_path;
424 /* This function transforms a header into a char so that it is useable by
426 static void *mutt_hcache_dump (void *_db, HEADER * h, int *off,
427 unsigned long uid_validity)
429 struct header_cache *db = _db;
430 unsigned char *d = NULL;
434 d = lazy_malloc (sizeof (validate));
437 memcpy (d, &uid_validity, sizeof (unsigned long));
442 gettimeofday (&now, NULL);
443 memcpy (d, &now, sizeof (struct timeval));
445 *off += sizeof (validate);
447 d = dump_int (db->crc, d, off);
449 lazy_realloc (&d, *off + sizeof (HEADER));
450 memcpy (d + *off, h, sizeof (HEADER));
451 *off += sizeof (HEADER);
453 d = dump_envelope (h->env, d, off);
454 d = dump_body (h->content, d, off);
455 d = dump_char (h->maildir_flags, d, off);
460 HEADER *mutt_hcache_restore (const unsigned char *d, HEADER ** oh)
463 HEADER *h = header_new();
466 off += sizeof (validate);
469 off += sizeof (unsigned int);
471 memcpy (h, d + off, sizeof (HEADER));
472 off += sizeof (HEADER);
474 h->env = envelope_new();
475 restore_envelope (h->env, d, &off);
477 h->content = body_new();
478 restore_body (h->content, d, &off);
480 restore_char (&h->maildir_flags, d, &off);
482 /* this is needed for maildir style mailboxes */
485 h->path = m_strdup((*oh)->path);
492 #if defined(HAVE_QDBM)
494 mutt_hcache_open(const char *path, const char *folder)
496 struct header_cache *h = p_new(struct header_cache, 1);
497 int flags = VL_OWRITER | VL_OCREAT;
499 h->folder = m_strdup(folder);
500 h->crc = generate_crc32();
502 if (!path || path[0] == '\0')
504 p_delete(&h->folder);
509 path = mutt_hcache_per_folder(path, folder);
511 if (option(OPTHCACHECOMPRESS))
514 h->db = vlopen(path, flags, VL_CMPLEX);
519 p_delete(&h->folder);
527 mutt_hcache_close(void *db)
529 struct header_cache *h = db;
535 p_delete(&h->folder);
540 mutt_hcache_fetch(void *db, const char *filename,
541 ssize_t(*keylen) (const char *fn))
543 struct header_cache *h = db;
544 char path[_POSIX_PATH_MAX];
551 m_strcpy(path, sizeof(path), h->folder);
552 m_strcat(path, sizeof(path), filename);
554 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
556 data = vlget(h->db, path, ksize, NULL);
558 if (!crc32_matches(data, h->crc))
568 mutt_hcache_store(void *db, const char *filename, HEADER * header,
569 unsigned long uid_validity,
570 ssize_t(*keylen) (const char *fn))
572 struct header_cache *h = db;
573 char path[_POSIX_PATH_MAX];
581 m_strcpy(path, sizeof(path), h->folder);
582 m_strcat(path, sizeof(path), filename);
584 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
586 data = mutt_hcache_dump(db, header, &dsize, uid_validity);
588 ret = vlput(h->db, path, ksize, data, dsize, VL_DOVER);
596 mutt_hcache_delete(void *db, const char *filename,
597 ssize_t(*keylen) (const char *fn))
599 struct header_cache *h = db;
600 char path[_POSIX_PATH_MAX];
606 m_strcpy(path, sizeof(path), h->folder);
607 m_strcat(path, sizeof(path), filename);
609 ksize = strlen(h->folder) + keylen(path + strlen(h->folder));
611 return vlout(h->db, path, ksize);
614 #elif defined(HAVE_GDBM)
616 void *mutt_hcache_open (const char *path, const char *folder)
618 struct header_cache *h = p_new(struct header_cache, 1);
620 atoi (HeaderCachePageSize) ? atoi (HeaderCachePageSize) : 16384;
622 h->folder = m_strdup(folder);
623 h->crc = generate_crc32 ();
625 if (!path || path[0] == '\0') {
626 p_delete(&h->folder);
631 path = mutt_hcache_per_folder (path, folder);
633 h->db = gdbm_open ((char *) path, pagesize, GDBM_WRCREAT, 00600, NULL);
638 /* if rw failed try ro */
639 h->db = gdbm_open ((char *) path, pagesize, GDBM_READER, 00600, NULL);
644 p_delete(&h->folder);
651 void mutt_hcache_close (void *db)
653 struct header_cache *h = db;
660 p_delete(&h->folder);
664 void *mutt_hcache_fetch (void *db, const char *filename,
665 ssize_t (*keylen) (const char *fn))
667 struct header_cache *h = db;
670 char path[_POSIX_PATH_MAX];
676 m_strcpy(path, sizeof(path), h->folder);
677 strncat (path, filename, sizeof (path) - m_strlen(path));
680 key.dsize = keylen (path);
682 data = gdbm_fetch (h->db, key);
684 if (!crc32_matches (data.dptr, h->crc)) {
685 p_delete(&data.dptr);
693 mutt_hcache_store (void *db, const char *filename, HEADER * header,
694 unsigned long uid_validity, ssize_t (*keylen) (const char *fn))
696 struct header_cache *h = db;
699 char path[_POSIX_PATH_MAX];
706 m_strcpy(path, sizeof(path), h->folder);
707 strncat (path, filename, sizeof (path) - m_strlen(path));
710 key.dsize = keylen (path);
712 data.dptr = mutt_hcache_dump (db, header, &data.dsize, uid_validity);
714 ret = gdbm_store (h->db, key, data, GDBM_REPLACE);
716 p_delete(&data.dptr);
722 mutt_hcache_delete (void *db, const char *filename,
723 ssize_t (*keylen) (const char *fn))
726 struct header_cache *h = db;
727 char path[_POSIX_PATH_MAX];
733 m_strcpy(path, sizeof(path), h->folder);
734 strncat (path, filename, sizeof (path) - m_strlen(path));
737 key.dsize = keylen (path);
739 return gdbm_delete (h->db, key);
743 #endif /* USE_HCACHE */