2 * Copyright © 2009 Carl Worth
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see http://www.gnu.org/licenses/ .
17 * Author: Carl Worth <cworth@cworth.org>
28 #include <gmime/gmime.h>
34 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
36 /* Xapian complains if we provide a term longer than this. */
37 #define NOTMUCH_MAX_TERM 245
39 /* These prefix values are specifically chosen to be compatible
40 * with sup, (http://sup.rubyforge.org), written by
41 * William Morgan <wmorgan-sup@masanjin.net>, and released
42 * under the GNU GPL v2.
50 prefix_t NORMAL_PREFIX[] = {
53 { "from_name", "FN" },
59 prefix_t BOOLEAN_PREFIX[] = {
61 { "from_email", "FE" },
67 { "attachment_extension", "O" },
73 /* Similarly, these value numbers are also chosen to be sup
77 NOTMUCH_VALUE_MESSAGE_ID = 0,
78 NOTMUCH_VALUE_THREAD = 1,
79 NOTMUCH_VALUE_DATE = 2
83 find_prefix (const char *name)
87 for (i = 0; i < ARRAY_SIZE (NORMAL_PREFIX); i++)
88 if (strcmp (name, NORMAL_PREFIX[i].name) == 0)
89 return NORMAL_PREFIX[i].prefix;
91 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX); i++)
92 if (strcmp (name, BOOLEAN_PREFIX[i].name) == 0)
93 return BOOLEAN_PREFIX[i].prefix;
98 int TERM_COMBINED = 0;
101 add_term (Xapian::Document doc,
102 const char *prefix_name,
111 prefix = find_prefix (prefix_name);
113 term = g_strdup_printf ("%s%s", prefix, value);
115 if (strlen (term) <= NOTMUCH_MAX_TERM)
122 gen_terms (Xapian::TermGenerator term_gen,
123 const char *prefix_name,
131 prefix = find_prefix (prefix_name);
133 term_gen.index_text (text, 1, prefix);
137 gen_terms_address_name (Xapian::TermGenerator term_gen,
138 InternetAddress *address,
139 const char *prefix_name)
144 name = internet_address_get_name (address);
146 /* In the absence of a name, we'll strip the part before the @
147 * from the address. */
149 InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address);
150 const char *addr = internet_address_mailbox_get_addr (mailbox);
153 at = strchr (addr, '@');
155 name = strndup (addr, at - addr);
161 gen_terms (term_gen, prefix_name, name);
164 free ((void *) name);
168 gen_terms_address_names (Xapian::TermGenerator term_gen,
169 InternetAddressList *addresses,
170 const char *address_type)
173 InternetAddress *address;
175 for (i = 0; i < internet_address_list_length (addresses); i++) {
176 address = internet_address_list_get_address (addresses, i);
177 gen_terms_address_name (term_gen, address, address_type);
178 gen_terms_address_name (term_gen, address, "name");
179 gen_terms_address_name (term_gen, address, "body");
184 add_term_address_addr (Xapian::Document doc,
185 InternetAddress *address,
186 const char *prefix_name)
188 InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address);
191 addr = internet_address_mailbox_get_addr (mailbox);
194 add_term (doc, prefix_name, addr);
198 add_terms_address_addrs (Xapian::Document doc,
199 InternetAddressList *addresses,
200 const char *address_type)
203 InternetAddress *address;
205 for (i = 0; i < internet_address_list_length (addresses); i++) {
206 address = internet_address_list_get_address (addresses, i);
207 add_term_address_addr (doc, address, address_type);
208 add_term_address_addr (doc, address, "email");
213 skip_re_in_subject (const char *subject)
215 const char *s = subject;
218 while (*s && isspace (*s))
220 if (strncasecmp (s, "re:", 3) == 0)
230 find_messages_by_term (Xapian::Database db,
231 const char *prefix_name,
233 Xapian::PostingIterator *begin,
234 Xapian::PostingIterator *end)
236 Xapian::PostingIterator i;
239 term = g_strdup_printf ("%s%s", find_prefix (prefix_name), value);
241 *begin = db.postlist_begin (term);
244 *end = db.postlist_end (term);
250 find_message_by_docid (Xapian::Database db, Xapian::docid docid)
252 return db.get_document (docid);
256 find_message_by_message_id (Xapian::Database db, const char *message_id)
258 Xapian::PostingIterator i, end;
260 find_messages_by_term (db, "msgid", message_id, &i, &end);
263 return find_message_by_docid (db, *i);
265 return Xapian::Document ();
269 insert_thread_id (GHashTable *thread_ids, Xapian::Document doc)
274 value_string = doc.get_value (NOTMUCH_VALUE_THREAD);
275 value = value_string.c_str();
277 g_hash_table_insert (thread_ids, strdup (value), NULL);
280 /* Return one or more thread_ids, (as a GPtrArray of strings), for the
281 * given message based on looking into the database for any messages
282 * referenced in parents, and also for any messages in the database
283 * referencing message_id.
285 * Caller should free all strings in the array and the array itself,
286 * (g_ptr_array_free) when done. */
288 find_thread_ids (Xapian::Database db,
290 const char *message_id)
292 Xapian::PostingIterator child, children_end;
293 Xapian::Document doc;
294 GHashTable *thread_ids;
297 const char *parent_message_id;
300 thread_ids = g_hash_table_new (g_str_hash, g_str_equal);
302 find_messages_by_term (db, "ref", message_id, &child, &children_end);
303 for ( ; child != children_end; child++) {
304 doc = find_message_by_docid (db, *child);
305 insert_thread_id (thread_ids, doc);
308 for (i = 0; i < parents->len; i++) {
309 parent_message_id = (char *) g_ptr_array_index (parents, i);
310 doc = find_message_by_message_id (db, parent_message_id);
311 insert_thread_id (thread_ids, doc);
314 result = g_ptr_array_new ();
316 keys = g_hash_table_get_keys (thread_ids);
317 for (l = keys; l; l = l->next) {
318 char *id = (char *) l->data;
319 g_ptr_array_add (result, id);
325 /* Add a term for each message-id in the References header of the
328 parse_references (GPtrArray *array,
329 const char *refs_str)
331 GMimeReferences *refs, *r;
332 const char *message_id;
334 if (refs_str == NULL)
337 refs = g_mime_references_decode (refs_str);
339 for (r = refs; r; r = r->next) {
340 message_id = g_mime_references_get_message_id (r);
341 g_ptr_array_add (array, g_strdup (message_id));
344 g_mime_references_free (refs);
347 /* Given a string representing the body of a message, generate terms
348 * for it, (skipping quoted portions and signatures). */
350 gen_terms_body_str (Xapian::TermGenerator term_gen,
353 char *line, *line_end, *next_line;
365 next_line = strchr (line, '\n');
366 if (next_line == NULL) {
367 next_line = line + strlen (line);
369 line_end = next_line - 1;
371 /* Trim whitespace. */
372 while (*next_line && isspace (*next_line))
375 /* Skip lines that are quotes. */
379 /* Also skip lines introducing a quote on the next line. */
380 if (*line_end == ':' && *next_line == '>')
383 /* Finally, bail as soon as we see a signature. */
384 /* XXX: Should only do this if "near" the end of the message. */
385 if (strncmp (line, "-- ", 3) == 0 ||
386 strncmp (line, "----------", 10) == 0 ||
387 strncmp (line, "__________", 10) == 0)
390 *(line_end + 1) = '\0';
391 gen_terms (term_gen, "body", line);
396 /* Callback to generate terms for each mime part of a message. */
398 gen_terms_part (Xapian::TermGenerator term_gen,
402 GMimeDataWrapper *wrapper;
403 GByteArray *byte_array;
406 if (GMIME_IS_MULTIPART (part)) {
407 GMimeMultipart *multipart = GMIME_MULTIPART (part);
410 for (i = 0; i < g_mime_multipart_get_count (multipart); i++) {
411 if (GMIME_IS_MULTIPART_SIGNED (multipart)) {
412 /* Don't index the signature. */
416 fprintf (stderr, "Warning: Unexpected extra parts of mutlipart/signed. Indexing anyway.\n");
418 gen_terms_part (term_gen,
419 g_mime_multipart_get_part (multipart, i));
424 if (! GMIME_IS_PART (part)) {
425 fprintf (stderr, "Warning: Not indexing unknown mime part: %s.\n",
426 g_type_name (G_OBJECT_TYPE (part)));
430 byte_array = g_byte_array_new ();
432 stream = g_mime_stream_mem_new_with_byte_array (byte_array);
433 g_mime_stream_mem_set_owner (GMIME_STREAM_MEM (stream), FALSE);
434 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
435 g_mime_data_wrapper_write_to_stream (wrapper, stream);
437 g_object_unref (stream);
439 body = (char *) g_byte_array_free (byte_array, FALSE);
441 gen_terms_body_str (term_gen, body);
447 index_file (Xapian::WritableDatabase db,
448 Xapian::TermGenerator term_gen,
449 const char *filename)
451 Xapian::Document doc;
455 GMimeMessage *message;
456 InternetAddressList *addresses;
457 GPtrArray *parents, *thread_ids;
461 const char *subject, *refs, *in_reply_to, *from;
462 const char *message_id;
465 struct tm gm_time_tm;
466 char date_str[16]; /* YYYYMMDDHHMMSS + 1 for Y100k compatibility ;-) */
469 file = fopen (filename, "r");
471 fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
475 stream = g_mime_stream_file_new (file);
477 parser = g_mime_parser_new_with_stream (stream);
479 message = g_mime_parser_construct_message (parser);
481 doc = Xapian::Document ();
483 doc.set_data (filename);
485 term_gen.set_stemmer (Xapian::Stem ("english"));
487 term_gen.set_document (doc);
489 from = g_mime_message_get_sender (message);
490 addresses = internet_address_list_parse_string (from);
492 gen_terms_address_names (term_gen, addresses, "from_name");
494 addresses = g_mime_message_get_all_recipients (message);
495 gen_terms_address_names (term_gen, addresses, "to_name");
497 subject = g_mime_message_get_subject (message);
498 subject = skip_re_in_subject (subject);
499 gen_terms (term_gen, "subject", subject);
500 gen_terms (term_gen, "body", subject);
502 gen_terms_part (term_gen, g_mime_message_get_mime_part (message));
504 parents = g_ptr_array_new ();
506 refs = g_mime_object_get_header (GMIME_OBJECT (message), "references");
507 parse_references (parents, refs);
509 in_reply_to = g_mime_object_get_header (GMIME_OBJECT (message),
511 parse_references (parents, in_reply_to);
513 for (i = 0; i < parents->len; i++)
514 add_term (doc, "ref", (char *) g_ptr_array_index (parents, i));
516 message_id = g_mime_message_get_message_id (message);
518 thread_ids = find_thread_ids (db, parents, message_id);
520 for (i = 0; i < parents->len; i++)
521 g_free (g_ptr_array_index (parents, i));
522 g_ptr_array_free (parents, TRUE);
524 from = g_mime_message_get_sender (message);
525 addresses = internet_address_list_parse_string (from);
527 add_terms_address_addrs (doc, addresses, "from_email");
529 add_terms_address_addrs (doc,
530 g_mime_message_get_all_recipients (message),
533 g_mime_message_get_date (message, &time, NULL);
535 gmtime_r (&time, &gm_time_tm);
537 if (strftime (date_str, sizeof (date_str),
538 "%Y%m%d%H%M%S", &gm_time_tm) == 0) {
539 fprintf (stderr, "Internal error formatting time\n");
543 add_term (doc, "date", date_str);
545 add_term (doc, "label", "inbox");
546 add_term (doc, "label", "unread");
547 add_term (doc, "type", "mail");
548 add_term (doc, "source_id", "1");
550 add_term (doc, "msgid", message_id);
551 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
553 if (thread_ids->len) {
558 for (i = 0; i < thread_ids->len; i++) {
559 id = (char *) thread_ids->pdata[i];
561 add_term (doc, "thread", id);
564 thread_id = g_string_new (id);
566 g_string_append_printf (thread_id, ",%s", id);
570 g_ptr_array_free (thread_ids, TRUE);
572 doc.add_value (NOTMUCH_VALUE_THREAD, thread_id->str);
574 g_string_free (thread_id, TRUE);
576 /* If not referenced thread, use the message ID */
577 add_term (doc, "thread", message_id);
578 doc.add_value (NOTMUCH_VALUE_THREAD, message_id);
581 doc.add_value (NOTMUCH_VALUE_DATE, Xapian::sortable_serialise (time));
583 db.add_document (doc);
585 g_object_unref (message);
586 g_object_unref (parser);
587 g_object_unref (stream);
591 usage (const char *argv0)
593 fprintf (stderr, "Usage: %s <path-to-xapian-database>\n", argv0);
594 fprintf (stderr, "\n");
595 fprintf (stderr, "Messages to be indexed are read from stdnin as absolute filenames\n");
596 fprintf (stderr, "one file per line.");
600 main (int argc, char **argv)
602 const char *database_path;
605 GIOStatus gio_status;
606 GError *error = NULL;
613 database_path = argv[1];
618 Xapian::WritableDatabase db;
619 Xapian::TermGenerator term_gen;
621 db = Xapian::WritableDatabase (database_path,
622 Xapian::DB_CREATE_OR_OPEN);
624 term_gen = Xapian::TermGenerator ();
626 channel = g_io_channel_unix_new (fileno (stdin));
629 gio_status = g_io_channel_read_line (channel, &filename,
631 if (gio_status == G_IO_STATUS_EOF)
633 if (gio_status != G_IO_STATUS_NORMAL) {
634 fprintf (stderr, "An error occurred reading from stdin: %s\n",
639 g_strchomp (filename);
640 index_file (db, term_gen, filename);
645 } catch (const Xapian::Error &error) {
646 cerr << "A Xapian exception occurred: " << error.get_msg () << endl;