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);
281 find_thread_id (Xapian::Database db,
283 const char *message_id)
285 Xapian::PostingIterator child, children_end;
286 Xapian::Document doc;
287 GHashTable *thread_ids;
289 GString *result = NULL;
291 const char *parent_message_id;
293 thread_ids = g_hash_table_new (g_str_hash, g_str_equal);
295 find_messages_by_term (db, "ref", message_id, &child, &children_end);
296 for ( ; child != children_end; child++) {
297 doc = find_message_by_docid (db, *child);
298 insert_thread_id (thread_ids, doc);
301 for (i = 0; i < parents->len; i++) {
302 parent_message_id = (char *) g_ptr_array_index (parents, i);
303 doc = find_message_by_message_id (db, parent_message_id);
304 insert_thread_id (thread_ids, doc);
307 keys = g_hash_table_get_keys (thread_ids);
308 for (l = keys; l; l = l->next) {
309 char *id = (char *) l->data;
310 if (result == NULL) {
311 result = g_string_new (id);
313 g_string_append_printf (result, ",%s", id);
319 return g_string_free (result, FALSE);
324 /* Add a term for each message-id in the References header of the
327 parse_references (GPtrArray *array,
328 const char *refs_str)
330 GMimeReferences *refs, *r;
331 const char *message_id;
333 if (refs_str == NULL)
336 refs = g_mime_references_decode (refs_str);
338 for (r = refs; r; r = r->next) {
339 message_id = g_mime_references_get_message_id (r);
340 g_ptr_array_add (array, g_strdup (message_id));
343 g_mime_references_free (refs);
346 /* Given a string representing the body of a message, generate terms
347 * for it, (skipping quoted portions and signatures). */
349 gen_terms_body_str (Xapian::TermGenerator term_gen,
352 char *line, *line_end, *next_line;
364 next_line = strchr (line, '\n');
365 if (next_line == NULL) {
366 next_line = line + strlen (line);
368 line_end = next_line - 1;
370 /* Trim whitespace. */
371 while (*next_line && isspace (*next_line))
374 /* Skip lines that are quotes. */
378 /* Also skip lines introducing a quote on the next line. */
379 while (line_end > line && isspace (*line_end))
382 if (*line_end == ':' && *next_line == '>')
385 /* Finally, bail as soon as we see a signature. */
386 /* XXX: Should only do this if "near" the end of the message. */
387 if (strncmp (line, "-- ", 3) == 0 ||
388 strncmp (line, "----------", 10) == 0 ||
389 strncmp (line, "__________", 10) == 0)
392 *(line_end + 1) = '\0';
393 gen_terms (term_gen, "body", line);
398 /* Callback to generate terms for each mime part of a message. */
400 gen_terms_part (GMimeObject *parent,
404 Xapian::TermGenerator *term_gen = (Xapian::TermGenerator *) user_data;
406 GMimeDataWrapper *wrapper;
407 GByteArray *byte_array;
410 if (! GMIME_IS_PART (part)) {
411 fprintf (stderr, "Warning: Not indexing unknown mime part: %s.\n",
412 g_type_name (G_OBJECT_TYPE (part)));
416 byte_array = g_byte_array_new ();
418 stream = g_mime_stream_mem_new_with_byte_array (byte_array);
419 g_mime_stream_mem_set_owner (GMIME_STREAM_MEM (stream), FALSE);
420 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
421 g_mime_data_wrapper_write_to_stream (wrapper, stream);
423 g_object_unref (stream);
425 body = (char *) g_byte_array_free (byte_array, FALSE);
427 gen_terms_body_str (*term_gen, body);
433 index_file (Xapian::WritableDatabase db,
434 Xapian::TermGenerator term_gen,
435 const char *filename)
437 Xapian::Document doc;
441 GMimeMessage *message;
442 InternetAddressList *addresses;
447 const char *subject, *refs, *in_reply_to, *from;
448 const char *message_id, *thread_id;
451 struct tm gm_time_tm;
452 char date_str[16]; /* YYYYMMDDHHMMSS + 1 for Y100k compatibility ;-) */
455 file = fopen (filename, "r");
457 fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
461 stream = g_mime_stream_file_new (file);
463 parser = g_mime_parser_new_with_stream (stream);
465 message = g_mime_parser_construct_message (parser);
467 doc = Xapian::Document ();
469 doc.set_data (filename);
471 term_gen.set_stemmer (Xapian::Stem ("english"));
473 term_gen.set_document (doc);
475 from = g_mime_message_get_sender (message);
476 addresses = internet_address_list_parse_string (from);
478 gen_terms_address_names (term_gen, addresses, "from_name");
480 addresses = g_mime_message_get_all_recipients (message);
481 gen_terms_address_names (term_gen, addresses, "to_name");
483 subject = g_mime_message_get_subject (message);
484 subject = skip_re_in_subject (subject);
485 gen_terms (term_gen, "subject", subject);
486 gen_terms (term_gen, "body", subject);
488 g_mime_message_foreach (message, gen_terms_part, &term_gen);
490 parents = g_ptr_array_new ();
492 refs = g_mime_object_get_header (GMIME_OBJECT (message), "references");
493 parse_references (parents, refs);
495 in_reply_to = g_mime_object_get_header (GMIME_OBJECT (message),
497 parse_references (parents, in_reply_to);
499 for (i = 0; i < parents->len; i++)
500 add_term (doc, "ref", (char *) g_ptr_array_index (parents, i));
502 message_id = g_mime_message_get_message_id (message);
504 thread_id = find_thread_id (db, parents, message_id);
506 for (i = 0; i < parents->len; i++)
507 g_free (g_ptr_array_index (parents, i));
508 g_ptr_array_free (parents, TRUE);
510 from = g_mime_message_get_sender (message);
511 addresses = internet_address_list_parse_string (from);
513 add_terms_address_addrs (doc, addresses, "from_email");
515 add_terms_address_addrs (doc,
516 g_mime_message_get_all_recipients (message),
519 g_mime_message_get_date (message, &time, NULL);
521 gmtime_r (&time, &gm_time_tm);
523 if (strftime (date_str, sizeof (date_str),
524 "%Y%m%d%H%M%S", &gm_time_tm) == 0) {
525 fprintf (stderr, "Internal error formatting time\n");
529 add_term (doc, "date", date_str);
531 add_term (doc, "label", "inbox");
532 add_term (doc, "label", "unread");
533 add_term (doc, "type", "mail");
534 add_term (doc, "source_id", "1");
536 add_term (doc, "msgid", message_id);
537 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
540 add_term (doc, "thread", thread_id);
541 doc.add_value (NOTMUCH_VALUE_THREAD, thread_id);
542 free ((void *) thread_id);
544 /* If not referenced thread, use the message ID */
545 add_term (doc, "thread", message_id);
546 doc.add_value (NOTMUCH_VALUE_THREAD, message_id);
549 doc.add_value (NOTMUCH_VALUE_DATE, Xapian::sortable_serialise (time));
551 db.add_document (doc);
553 g_object_unref (message);
554 g_object_unref (parser);
555 g_object_unref (stream);
559 usage (const char *argv0)
561 fprintf (stderr, "Usage: %s <path-to-xapian-database>\n", argv0);
562 fprintf (stderr, "\n");
563 fprintf (stderr, "Messages to be indexed are read from stdnin as absolute filenames\n");
564 fprintf (stderr, "one file per line.");
568 main (int argc, char **argv)
570 const char *database_path;
573 GIOStatus gio_status;
574 GError *error = NULL;
581 database_path = argv[1];
586 Xapian::WritableDatabase db;
587 Xapian::TermGenerator term_gen;
589 db = Xapian::WritableDatabase (database_path,
590 Xapian::DB_CREATE_OR_OPEN);
592 term_gen = Xapian::TermGenerator ();
594 channel = g_io_channel_unix_new (fileno (stdin));
597 gio_status = g_io_channel_read_line (channel, &filename,
599 if (gio_status == G_IO_STATUS_EOF)
601 if (gio_status != G_IO_STATUS_NORMAL) {
602 fprintf (stderr, "An error occurred reading from stdin: %s\n",
607 g_strchomp (filename);
608 index_file (db, term_gen, filename);
613 } catch (const Xapian::Error &error) {
614 cerr << "A Xapian exception occurred: " << error.get_msg () << endl;