git.notmuchmail.org Git - notmuch/blob - lib/query.cc

   1 /* query.cc - Support for searching a notmuch database
   2  *
   3  * Copyright © 2009 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #include "notmuch-private.h"
  22 #include "database-private.h"
  23
  24 #include <glib.h> /* GHashTable, GPtrArray */
  25
  26 #include <xapian.h>
  27
  28 struct _notmuch_query {
  29     notmuch_database_t *notmuch;
  30     const char *query_string;
  31     notmuch_sort_t sort;
  32 };
  33
  34 struct _notmuch_messages {
  35     notmuch_database_t *notmuch;
  36     Xapian::MSetIterator iterator;
  37     Xapian::MSetIterator iterator_end;
  38 };
  39
  40 struct _notmuch_threads {
  41     notmuch_database_t *notmuch;
  42     GPtrArray *threads;
  43     unsigned int index;
  44 };
  45
  46 notmuch_query_t *
  47 notmuch_query_create (notmuch_database_t *notmuch,
  48                       const char *query_string)
  49 {
  50     notmuch_query_t *query;
  51
  52 #ifdef DEBUG_QUERY
  53     fprintf (stderr, "Query string is:\n%s\n", query_string);
  54 #endif
  55
  56     query = talloc (NULL, notmuch_query_t);
  57     if (unlikely (query == NULL))
  58         return NULL;
  59
  60     query->notmuch = notmuch;
  61
  62     query->query_string = talloc_strdup (query, query_string);
  63
  64     query->sort = NOTMUCH_SORT_DATE;
  65
  66     return query;
  67 }
  68
  69 void
  70 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort)
  71 {
  72     query->sort = sort;
  73 }
  74
  75 notmuch_messages_t *
  76 notmuch_query_search_messages (notmuch_query_t *query,
  77                                int first,
  78                                int max_messages)
  79 {
  80     notmuch_database_t *notmuch = query->notmuch;
  81     const char *query_string = query->query_string;
  82     notmuch_message_list_t *message_list;
  83     Xapian::MSetIterator i;
  84
  85     message_list = _notmuch_message_list_create (query);
  86     if (unlikely (message_list == NULL))
  87         return NULL;
  88
  89     try {
  90         Xapian::Enquire enquire (*notmuch->xapian_db);
  91         Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
  92                                                    _find_prefix ("type"),
  93                                                    "mail"));
  94         Xapian::Query string_query, final_query;
  95         Xapian::MSet mset;
  96         unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN |
  97                               Xapian::QueryParser::FLAG_PHRASE |
  98                               Xapian::QueryParser::FLAG_LOVEHATE |
  99                               Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE |
 100                               Xapian::QueryParser::FLAG_WILDCARD);
 101
 102         if (strcmp (query_string, "") == 0) {
 103             final_query = mail_query;
 104         } else {
 105             string_query = notmuch->query_parser->
 106                 parse_query (query_string, flags);
 107             final_query = Xapian::Query (Xapian::Query::OP_AND,
 108                                          mail_query, string_query);
 109         }
 110
 111         switch (query->sort) {
 112         case NOTMUCH_SORT_DATE:
 113             enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, FALSE);
 114             break;
 115         case NOTMUCH_SORT_DATE_REVERSE:
 116             enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, TRUE);
 117             break;
 118         case NOTMUCH_SORT_MESSAGE_ID:
 119             enquire.set_sort_by_value (NOTMUCH_VALUE_MESSAGE_ID, FALSE);
 120             break;
 121         }
 122
 123 #if DEBUG_QUERY
 124         fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str());
 125 #endif
 126
 127         enquire.set_query (final_query);
 128
 129         if (max_messages == -1)
 130             max_messages = notmuch->xapian_db->get_doccount ();
 131         mset = enquire.get_mset (first, max_messages);
 132
 133         for (i = mset.begin (); i != mset.end (); i++) {
 134             notmuch_message_t *message;
 135             notmuch_private_status_t status;
 136
 137             message = _notmuch_message_create (message_list, notmuch,
 138                                                *i, &status);
 139             if (message == NULL)
 140             {
 141                 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
 142                     INTERNAL_ERROR ("A message iterator contains a "
 143                                     "non-existent document ID.\n");
 144                 break;
 145             }
 146
 147             _notmuch_message_list_add_message (message_list, message);
 148         }
 149
 150     } catch (const Xapian::Error &error) {
 151         fprintf (stderr, "A Xapian exception occurred: %s\n",
 152                  error.get_msg().c_str());
 153     }
 154
 155     return _notmuch_messages_create (message_list);
 156 }
 157
 158 /* Glib objects force use to use a talloc destructor as well, (but not
 159  * nearly as ugly as the for messages due to C++ objects). At
 160  * this point, I'd really like to have some talloc-friendly
 161  * equivalents for the few pieces of glib that I'm using. */
 162 static int
 163 _notmuch_threads_destructor (notmuch_threads_t *threads)
 164 {
 165     g_ptr_array_free (threads->threads, TRUE);
 166
 167     return 0;
 168 }
 169
 170 notmuch_threads_t *
 171 notmuch_query_search_threads (notmuch_query_t *query,
 172                               int first,
 173                               int max_threads)
 174 {
 175     notmuch_threads_t *threads;
 176     notmuch_thread_t *thread;
 177     const char *thread_id;
 178     notmuch_messages_t *messages;
 179     notmuch_message_t *message;
 180     GHashTable *seen;
 181     int messages_seen = 0, threads_seen = 0;
 182
 183     threads = talloc (query, notmuch_threads_t);
 184     if (threads == NULL)
 185         return NULL;
 186
 187     threads->notmuch = query->notmuch;
 188     threads->threads = g_ptr_array_new ();
 189     threads->index = 0;
 190
 191     talloc_set_destructor (threads, _notmuch_threads_destructor);
 192
 193     seen = g_hash_table_new_full (g_str_hash, g_str_equal,
 194                                   free, NULL);
 195
 196     while (max_threads < 0 || threads_seen < first + max_threads)
 197     {
 198         int messages_seen_previously = messages_seen;
 199
 200         for (messages = notmuch_query_search_messages (query,
 201                                                        messages_seen,
 202                                                        max_threads);
 203              notmuch_messages_has_more (messages);
 204              notmuch_messages_advance (messages))
 205         {
 206             message = notmuch_messages_get (messages);
 207
 208             thread_id = notmuch_message_get_thread_id (message);
 209
 210             if (! g_hash_table_lookup_extended (seen,
 211                                                 thread_id, NULL,
 212                                                 (void **) &thread))
 213             {
 214                 if (threads_seen >= first) {
 215                     thread = _notmuch_thread_create (query, query->notmuch,
 216                                                      thread_id,
 217                                                      query->query_string);
 218                     g_ptr_array_add (threads->threads, thread);
 219                 } else {
 220                     thread = NULL;
 221                 }
 222
 223                 g_hash_table_insert (seen, xstrdup (thread_id), thread);
 224
 225                 threads_seen++;
 226             }
 227
 228             notmuch_message_destroy (message);
 229
 230             messages_seen++;
 231
 232             if (max_threads >= 0 && threads_seen >= first + max_threads)
 233                 break;
 234         }
 235
 236         /* Stop if we're not seeing any more messages. */
 237         if (messages_seen == messages_seen_previously)
 238             break;
 239     }
 240
 241     g_hash_table_unref (seen);
 242
 243     return threads;
 244 }
 245
 246 void
 247 notmuch_query_destroy (notmuch_query_t *query)
 248 {
 249     talloc_free (query);
 250 }
 251
 252 notmuch_bool_t
 253 notmuch_threads_has_more (notmuch_threads_t *threads)
 254 {
 255     return (threads->index < threads->threads->len);
 256 }
 257
 258 notmuch_thread_t *
 259 notmuch_threads_get (notmuch_threads_t *threads)
 260 {
 261     if (! notmuch_threads_has_more (threads))
 262         return NULL;
 263
 264     return (notmuch_thread_t *) g_ptr_array_index (threads->threads,
 265                                                    threads->index);
 266 }
 267
 268 void
 269 notmuch_threads_advance (notmuch_threads_t *threads)
 270 {
 271     threads->index++;
 272 }
 273
 274 void
 275 notmuch_threads_destroy (notmuch_threads_t *threads)
 276 {
 277     talloc_free (threads);
 278 }