2 * Copyright (C) 2004 Thomas Glanzmann <sithglan@stud.uni-erlangen.de>
3 * Copyright (C) 2004 Tobias Werth <sitowert@stud.uni-erlangen.de>
4 * Copyright (C) 2004 Brian Fundakowski Feldman <green@FreeBSD.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 # include <inttypes.h>
31 #endif /* HAVE_CONFIG_H */
68 char lockfile[_POSIX_PATH_MAX];
74 struct timeval timeval;
75 uint64_t uid_validity;
79 lazy_malloc(size_t siz)
81 if (0 < siz && siz < 4096) {
85 return safe_malloc(siz);
89 lazy_realloc(void *ptr, size_t siz)
91 void **p = (void **)ptr;
99 safe_realloc(ptr, siz);
102 static unsigned char *
103 dump_int(unsigned int i, unsigned char *d, int *off)
105 lazy_realloc(&d, *off + sizeof(int));
106 memcpy(d + *off, &i, sizeof(int));
107 (*off) += sizeof(int);
113 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 *
120 dump_char(char *c, unsigned char *d, int *off)
126 d = dump_int(size, d, off);
130 size = mutt_strlen(c) + 1;
131 d = dump_int(size, d, off);
132 lazy_realloc(&d, *off + size);
133 memcpy(d + *off, c, size);
139 static unsigned char *
140 dump_char_size(char *c, unsigned char *d, int *off, ssize_t size)
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 restore_char(char **c, const unsigned char *d, int *off)
160 restore_int(&size, d, off);
167 *c = safe_malloc(size);
168 memcpy(*c, d + *off, size);
172 static unsigned char *
173 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);
182 d = dump_char(a->val, d, off);
184 d = dump_char(a->personal, d, off);
185 d = dump_char(a->mailbox, d, off);
186 d = dump_int(a->group, d, off);
191 memcpy(d + start_off, &counter, sizeof(int));
197 restore_address(ADDRESS **a, const unsigned char *d, int *off)
199 unsigned int counter;
201 restore_int(&counter, d, off);
204 *a = safe_malloc(sizeof(ADDRESS));
206 restore_char(&(*a)->val, d, off);
208 restore_char(&(*a)->personal, d, off);
209 restore_char(&(*a)->mailbox, d, off);
210 restore_int((unsigned int *)&(*a)->group, d, off);
218 static unsigned char *
219 dump_list(LIST *l, unsigned char *d, int *off)
221 unsigned int counter = 0;
222 unsigned int start_off = *off;
224 d = dump_int(0xdeadbeef, d, off);
227 d = dump_char(l->data, d, off);
232 memcpy(d + start_off, &counter, sizeof(int));
238 restore_list(LIST **l, const unsigned char *d, int *off)
240 unsigned int counter;
242 restore_int(&counter, d, off);
245 *l = safe_malloc(sizeof(LIST));
246 restore_char(&(*l)->data, d, off);
254 static unsigned char *
255 dump_buffer(BUFFER *b, unsigned char *d, int *off)
258 d = dump_int(0, d, off);
261 d = dump_int(1, d, off);
264 d = dump_char_size(b->data, d, off, b->dsize + 1);
265 d = dump_int(b->dptr - b->data, d, off);
266 d = dump_int(b->dsize, d, off);
267 d = dump_int(b->destroy, d, off);
273 restore_buffer(BUFFER **b, const unsigned char *d, int *off)
277 restore_int(&used, d, off);
282 *b = safe_malloc(sizeof(BUFFER));
284 restore_char(& (*b)->data, d, off);
285 restore_int(& offset, d, off);
286 (*b)->dptr = (*b)->data + offset;
287 restore_int(& (*b)->dsize, d, off);
288 restore_int((unsigned int *) & (*b)->destroy, d, off);
291 static unsigned char *
292 dump_parameter(PARAMETER *p, unsigned char *d, int *off)
294 unsigned int counter = 0;
295 unsigned int start_off = *off;
297 d = dump_int(0xdeadbeef, d, off);
300 d = dump_char(p->attribute, d, off);
301 d = dump_char(p->value, d, off);
306 memcpy(d + start_off, &counter, sizeof(int));
312 restore_parameter(PARAMETER **p, const unsigned char *d, int *off)
314 unsigned int counter;
316 restore_int(&counter, d, off);
319 *p = safe_malloc(sizeof(PARAMETER));
320 restore_char(&(*p)->attribute, d, off);
321 restore_char(&(*p)->value, d, off);
329 static unsigned char *
330 dump_body(BODY *c, unsigned char *d, int *off)
332 lazy_realloc(&d, *off + sizeof(BODY));
333 memcpy(d + *off, c, sizeof(BODY));
334 *off += sizeof(BODY);
336 d = dump_char(c->xtype, d, off);
337 d = dump_char(c->subtype, d, off);
339 d = dump_parameter(c->parameter, d, off);
341 d = dump_char(c->description, d, off);
342 d = dump_char(c->form_name, d, off);
343 d = dump_char(c->filename, d, off);
344 d = dump_char(c->d_filename, d, off);
350 restore_body(BODY *c, const unsigned char *d, int *off)
352 memcpy(c, d + *off, sizeof(BODY));
353 *off += sizeof(BODY);
355 restore_char(& c->xtype, d, off);
356 restore_char(& c->subtype, d, off);
358 restore_parameter(& c->parameter, d, off);
360 restore_char(& c->description, d, off);
361 restore_char(& c->form_name, d, off);
362 restore_char(& c->filename, d, off);
363 restore_char(& c->d_filename, d, off);
366 static unsigned char *
367 dump_envelope(ENVELOPE *e, unsigned char *d, int *off)
369 d = dump_address(e->return_path, d, off);
370 d = dump_address(e->from, d, off);
371 d = dump_address(e->to, d, off);
372 d = dump_address(e->cc, d, off);
373 d = dump_address(e->bcc, d, off);
374 d = dump_address(e->sender, d, off);
375 d = dump_address(e->reply_to, d, off);
376 d = dump_address(e->mail_followup_to, d, off);
378 d = dump_char(e->subject, d, off);
380 d = dump_int(e->real_subj - e->subject, d, off);
382 d = dump_int(-1, d, off);
384 d = dump_char(e->message_id, d, off);
385 d = dump_char(e->supersedes, d, off);
386 d = dump_char(e->date, d, off);
387 d = dump_char(e->x_label, d, off);
389 d = dump_list(e->references, d, off);
390 d = dump_list(e->in_reply_to, d, off);
391 d = dump_list(e->userhdrs, d, off);
397 restore_envelope(ENVELOPE *e, const unsigned char *d, int *off)
401 restore_address(& e->return_path, d, off);
402 restore_address(& e->from, d, off);
403 restore_address(& e->to, d, off);
404 restore_address(& e->cc, d, off);
405 restore_address(& e->bcc, d, off);
406 restore_address(& e->sender, d, off);
407 restore_address(& e->reply_to, d, off);
408 restore_address(& e->mail_followup_to, d, off);
410 restore_char(& e->subject, d, off);
411 restore_int((unsigned int *) (& real_subj_off), d, off);
412 if (0 <= real_subj_off) {
413 e->real_subj = e->subject + real_subj_off;
417 restore_char(& e->message_id, d, off);
418 restore_char(& e->supersedes, d, off);
419 restore_char(& e->date, d, off);
420 restore_char(& e->x_label, d, off);
422 restore_list(& e->references, d, off);
423 restore_list(& e->in_reply_to, d, off);
424 restore_list(& e->userhdrs, d, off);
428 unsigned int crc32(unsigned int crc, unsigned char const *p, size_t len)
433 for (i = 0; i < 8; i++)
434 crc = (crc >> 1) ^ ((crc & 1) ? 0xedb88320 : 0);
444 crc = crc32(crc, (unsigned char const *) "sithglan@stud.uni-erlangen.de[sithglan]|hcache.c|20041108231548|29613", mutt_strlen("sithglan@stud.uni-erlangen.de[sithglan]|hcache.c|20041108231548|29613"));
446 #if HAVE_LANGINFO_CODESET
447 crc = crc32(crc, (unsigned char const *) Charset, mutt_strlen(Charset));
448 crc = crc32(crc, (unsigned char const *) "HAVE_LANGINFO_CODESET", mutt_strlen("HAVE_LANGINFO_CODESET"));
452 crc = crc32(crc, (unsigned char const *) "EXACT_ADDRESS", mutt_strlen("EXACT_ADDRESS"));
456 crc = crc32(crc, (unsigned char const *) "USE_POP", mutt_strlen("USE_POP"));
460 crc = crc32(crc, (unsigned char const *) "MIXMASTER", mutt_strlen("MIXMASTER"));
464 crc = crc32(crc, (unsigned char const *) "USE_IMAP", mutt_strlen("USE_IMAP"));
470 crc32_matches(const char *d, unsigned int crc)
472 int off = sizeof(validate);
473 unsigned int mycrc = 0;
479 restore_int(&mycrc, (unsigned char *) d, &off);
481 return (crc == mycrc);
484 /* Append md5sumed folder to path if path is a directory. */
486 mutt_hcache_per_folder(const char *path, const char *folder)
488 static char mutt_hcache_per_folder_path[_POSIX_PATH_MAX];
489 struct stat path_stat;
491 unsigned char md5sum[16];
494 ret = stat(path, &path_stat);
499 if (! S_ISDIR(path_stat.st_mode)) {
504 MD5Update(&md5, (unsigned char *) folder, strlen(folder));
505 MD5Final(md5sum, &md5);
507 ret = snprintf(mutt_hcache_per_folder_path, _POSIX_PATH_MAX,
508 "%s/%02x%02x%02x%02x%02x%02x%02x%02x"
509 "%02x%02x%02x%02x%02x%02x%02x%02x",
510 path, md5sum[0], md5sum[1], md5sum[2], md5sum[3],
511 md5sum[4], md5sum[5], md5sum[6], md5sum[7], md5sum[8],
512 md5sum[9], md5sum[10], md5sum[11], md5sum[12],
513 md5sum[13], md5sum[14], md5sum[15]);
519 return mutt_hcache_per_folder_path;
522 /* This function transforms a header into a char so that it is useable by
525 mutt_hcache_dump(void *_db, HEADER *h, int *off, uint64_t uid_validity)
527 struct header_cache *db = _db;
528 unsigned char *d = NULL;
531 d = lazy_malloc(sizeof(validate));
534 memcpy(d, &uid_validity, sizeof(uint64_t));
537 gettimeofday(&now, NULL);
538 memcpy(d, &now, sizeof(struct timeval));
540 *off += sizeof(validate);
542 d = dump_int(db->crc, d, off);
544 lazy_realloc(&d, *off + sizeof(HEADER));
545 memcpy(d + *off, h, sizeof(HEADER));
546 *off += sizeof(HEADER);
548 d = dump_envelope(h->env, d, off);
549 d = dump_body(h->content, d, off);
550 d = dump_char(h->maildir_flags, d, off);
556 mutt_hcache_restore(const unsigned char *d, HEADER **oh)
559 HEADER *h = mutt_new_header();
562 off += sizeof(validate);
565 off += sizeof(unsigned int);
567 memcpy(h, d + off, sizeof(HEADER));
568 off += sizeof(HEADER);
570 h->env = mutt_new_envelope();
571 restore_envelope(h->env, d, &off);
573 h->content = mutt_new_body();
574 restore_body(h->content, d, &off);
576 restore_char(&h->maildir_flags, d, &off);
578 /* this is needed for maildir style mailboxes */
581 h->path = safe_strdup((*oh)->path);
582 mutt_free_header (oh);
591 mutt_hcache_open(const char *path, const char *folder)
593 struct header_cache *h = safe_calloc(1, sizeof(HEADER_CACHE));
594 int pagesize = atoi(HeaderCachePageSize) ? atoi(HeaderCachePageSize) : 16384;
596 h->folder = safe_strdup (folder);
597 h->crc = generate_crc32();
599 if (! path || path[0] == '\0') {
605 path = mutt_hcache_per_folder(path, folder);
607 h->db = gdbm_open((char *) path, pagesize, GDBM_WRCREAT, 00600, NULL);
612 /* if rw failed try ro */
613 h->db = gdbm_open((char *) path, pagesize, GDBM_READER, 00600, NULL);
625 mutt_hcache_close(void *db)
627 struct header_cache *h = db;
639 mutt_hcache_fetch(void *db, const char *filename, size_t (*keylen)(const char *fn))
641 struct header_cache *h = db;
644 char path[_POSIX_PATH_MAX];
650 strncpy(path, h->folder, sizeof(path));
651 strncat(path, filename, sizeof(path) - mutt_strlen(path));
654 key.dsize = keylen(path);
656 data = gdbm_fetch(h->db, key);
658 if (! crc32_matches(data.dptr, h->crc)) {
667 mutt_hcache_store(void *db, const char *filename, HEADER *header, uint64_t uid_validity, size_t (*keylen)(const char *fn))
669 struct header_cache *h = db;
672 char path[_POSIX_PATH_MAX];
679 strncpy(path, h->folder, sizeof(path));
680 strncat(path, filename, sizeof(path) - mutt_strlen(path));
683 key.dsize = keylen(path);
685 data.dptr = mutt_hcache_dump(db, header, &data.dsize, uid_validity);
687 ret = gdbm_store(h->db, key, data, GDBM_REPLACE);
695 mutt_hcache_delete(void *db, const char *filename, size_t (*keylen)(const char *fn))
698 struct header_cache *h = db;
699 char path[_POSIX_PATH_MAX];
705 strncpy(path, h->folder, sizeof(path));
706 strncat(path, filename, sizeof(path) - mutt_strlen(path));
709 key.dsize = keylen(path);
711 return gdbm_delete(h->db, key);
716 mutt_hcache_dbt_init(DBT *dbt, void *data, size_t len)
719 dbt->size = dbt->ulen = len;
720 dbt->dlen = dbt->doff = 0;
721 dbt->flags = DB_DBT_USERMEM;
725 mutt_hcache_dbt_empty_init(DBT *dbt)
728 dbt->size = dbt->ulen = dbt->dlen = dbt->doff = 0;
733 mutt_hcache_open(const char *path, const char *folder)
736 u_int32_t createflags = DB_CREATE;
738 struct header_cache *h = calloc(1, sizeof(HEADER_CACHE));
739 int pagesize = atoi(HeaderCachePageSize);
742 h->crc = generate_crc32();
744 if (! path || path[0] == '\0') {
749 path = mutt_hcache_per_folder(path, folder);
751 snprintf (h->lockfile, _POSIX_PATH_MAX, "%s-lock-hack", path);
753 h->fd = open(h->lockfile, O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR);
759 if (mx_lock_file(h->lockfile, h->fd, 1, 0, 5)) {
765 ret = db_env_create(&h->env, 0);
767 mx_unlock_file(h->lockfile, h->fd, 0);
773 ret = h->env->open(h->env, NULL, DB_INIT_MPOOL | DB_CREATE | DB_PRIVATE, 0600);
775 ret = db_create(&h->db, h->env, 0);
777 h->env->close(h->env, 0);
778 mx_unlock_file(h->lockfile, h->fd, 0);
785 if (stat(path, &sb) != 0 && errno == ENOENT) {
786 createflags |= DB_EXCL;
787 h->db->set_pagesize(h->db, pagesize);
790 ret = h->db->open(h->db, NULL, path, folder, DB_BTREE, createflags, 0600);
792 h->db->close(h->db, 0);
793 h->env->close(h->env, 0);
794 mx_unlock_file(h->lockfile, h->fd, 0);
804 mutt_hcache_close(void *db)
806 struct header_cache *h = db;
813 h->db->close(h->db, 0);
814 h->env->close(h->env, 0);
815 mx_unlock_file(h->lockfile, h->fd, 0);
821 mutt_hcache_fetch(void *db, const char *filename, size_t (*keylen)(const char *fn))
825 struct header_cache *h = db;
831 filename++; /* skip '/' */
833 mutt_hcache_dbt_init(&key, (void *) filename, keylen(filename));
834 mutt_hcache_dbt_empty_init(&data);
835 data.flags = DB_DBT_MALLOC;
837 h->db->get(h->db, NULL, &key, &data, 0);
839 if (! crc32_matches(data.data, h->crc)) {
848 mutt_hcache_store(void *db, const char *filename, HEADER *header, uint64_t uid_validity, size_t (*keylen)(const char *fn))
853 struct header_cache *h = db;
859 filename++; /* skip '/' */
861 mutt_hcache_dbt_init(&key, (void *) filename, keylen(filename));
863 mutt_hcache_dbt_empty_init(&data);
864 data.flags = DB_DBT_USERMEM;
865 data.data = mutt_hcache_dump(db, header, (signed int *) &data.size, uid_validity);
866 data.ulen = data.size;
868 ret = h->db->put(h->db, NULL, &key, &data, 0);
876 mutt_hcache_delete(void *db, const char *filename, size_t (*keylen)(const char *fn))
879 struct header_cache *h = db;
885 filename++; /* skip '/' */
887 mutt_hcache_dbt_init(&key, (void *) filename, keylen(filename));
888 return h->db->del(h->db, NULL, &key, 0);
892 #endif /* USE_HCACHE */