git.notmuchmail.org Git - notmuch/blob - notmuch-search.c

   1 /* notmuch - Not much of an email program, (just index and search)
   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-client.h"
  22
  23 typedef enum {
  24     OUTPUT_SUMMARY,
  25     OUTPUT_THREADS,
  26     OUTPUT_MESSAGES,
  27     OUTPUT_FILES,
  28     OUTPUT_TAGS
  29 } output_t;
  30
  31 typedef struct search_format {
  32     const char *results_start;
  33     const char *item_start;
  34     void (*item_id) (const void *ctx,
  35                      const char *item_type,
  36                      const char *item_id);
  37     void (*thread_summary) (const void *ctx,
  38                             const char *thread_id,
  39                             const time_t date,
  40                             const int matched,
  41                             const int total,
  42                             const char *authors,
  43                             const char *subject);
  44     const char *tag_start;
  45     const char *tag;
  46     const char *tag_sep;
  47     const char *tag_end;
  48     const char *item_sep;
  49     const char *item_end;
  50     const char *results_end;
  51     const char *results_null;
  52 } search_format_t;
  53
  54 static void
  55 format_item_id_text (const void *ctx,
  56                      const char *item_type,
  57                      const char *item_id);
  58
  59 static void
  60 format_thread_text (const void *ctx,
  61                     const char *thread_id,
  62                     const time_t date,
  63                     const int matched,
  64                     const int total,
  65                     const char *authors,
  66                     const char *subject);
  67 static const search_format_t format_text = {
  68     "",
  69         "",
  70             format_item_id_text,
  71             format_thread_text,
  72             " (",
  73                 "%s", " ",
  74             ")", "\n",
  75         "",
  76     "\n",
  77     "",
  78 };
  79
  80 static void
  81 format_item_id_json (const void *ctx,
  82                      const char *item_type,
  83                      const char *item_id);
  84
  85 static void
  86 format_thread_json (const void *ctx,
  87                     const char *thread_id,
  88                     const time_t date,
  89                     const int matched,
  90                     const int total,
  91                     const char *authors,
  92                     const char *subject);
  93 static const search_format_t format_json = {
  94     "[",
  95         "{",
  96             format_item_id_json,
  97             format_thread_json,
  98             "\"tags\": [",
  99                 "\"%s\"", ", ",
 100             "]", ",\n",
 101         "}",
 102     "]\n",
 103     "]\n",
 104 };
 105
 106 static void
 107 format_item_id_text (unused (const void *ctx),
 108                      const char *item_type,
 109                      const char *item_id)
 110 {
 111     printf ("%s%s", item_type, item_id);
 112 }
 113
 114 static char *
 115 sanitize_string (const void *ctx, const char *str)
 116 {
 117     char *out, *loop;
 118
 119     if (NULL == str)
 120         return NULL;
 121
 122     loop = out = talloc_strdup (ctx, str);
 123
 124     for (; *loop; loop++) {
 125         if ((unsigned char)(*loop) < 32)
 126             *loop = '?';
 127     }
 128     return out;
 129 }
 130
 131 static void
 132 format_thread_text (const void *ctx,
 133                     const char *thread_id,
 134                     const time_t date,
 135                     const int matched,
 136                     const int total,
 137                     const char *authors,
 138                     const char *subject)
 139 {
 140     void *ctx_quote = talloc_new (ctx);
 141
 142     printf ("thread:%s %12s [%d/%d] %s; %s",
 143             thread_id,
 144             notmuch_time_relative_date (ctx, date),
 145             matched,
 146             total,
 147             sanitize_string (ctx_quote, authors),
 148             sanitize_string (ctx_quote, subject));
 149
 150     talloc_free (ctx_quote);
 151 }
 152
 153 static void
 154 format_item_id_json (const void *ctx,
 155                      unused (const char *item_type),
 156                      const char *item_id)
 157 {
 158     void *ctx_quote = talloc_new (ctx);
 159
 160     printf ("%s", json_quote_str (ctx_quote, item_id));
 161
 162     talloc_free (ctx_quote);
 163
 164 }
 165
 166 static void
 167 format_thread_json (const void *ctx,
 168                     const char *thread_id,
 169                     const time_t date,
 170                     const int matched,
 171                     const int total,
 172                     const char *authors,
 173                     const char *subject)
 174 {
 175     void *ctx_quote = talloc_new (ctx);
 176
 177     printf ("\"thread\": %s,\n"
 178             "\"timestamp\": %ld,\n"
 179             "\"matched\": %d,\n"
 180             "\"total\": %d,\n"
 181             "\"authors\": %s,\n"
 182             "\"subject\": %s,\n",
 183             json_quote_str (ctx_quote, thread_id),
 184             date,
 185             matched,
 186             total,
 187             json_quote_str (ctx_quote, authors),
 188             json_quote_str (ctx_quote, subject));
 189
 190     talloc_free (ctx_quote);
 191 }
 192
 193 static int
 194 do_search_threads (const search_format_t *format,
 195                    notmuch_query_t *query,
 196                    notmuch_sort_t sort,
 197                    output_t output,
 198                    int offset,
 199                    int limit)
 200 {
 201     notmuch_thread_t *thread;
 202     notmuch_threads_t *threads;
 203     notmuch_tags_t *tags;
 204     time_t date;
 205     int first_thread = 1;
 206     int i;
 207
 208     if (offset < 0) {
 209         offset += notmuch_query_count_threads (query);
 210         if (offset < 0)
 211             offset = 0;
 212     }
 213
 214     threads = notmuch_query_search_threads (query);
 215     if (threads == NULL)
 216         return 1;
 217
 218     fputs (format->results_start, stdout);
 219
 220     for (i = 0;
 221          notmuch_threads_valid (threads) && (limit < 0 || i < offset + limit);
 222          notmuch_threads_move_to_next (threads), i++)
 223     {
 224         int first_tag = 1;
 225
 226         thread = notmuch_threads_get (threads);
 227
 228         if (i < offset) {
 229             notmuch_thread_destroy (thread);
 230             continue;
 231         }
 232
 233         if (! first_thread)
 234             fputs (format->item_sep, stdout);
 235
 236         if (output == OUTPUT_THREADS) {
 237             format->item_id (thread, "thread:",
 238                              notmuch_thread_get_thread_id (thread));
 239         } else { /* output == OUTPUT_SUMMARY */
 240             fputs (format->item_start, stdout);
 241
 242             if (sort == NOTMUCH_SORT_OLDEST_FIRST)
 243                 date = notmuch_thread_get_oldest_date (thread);
 244             else
 245                 date = notmuch_thread_get_newest_date (thread);
 246
 247             format->thread_summary (thread,
 248                                     notmuch_thread_get_thread_id (thread),
 249                                     date,
 250                                     notmuch_thread_get_matched_messages (thread),
 251                                     notmuch_thread_get_total_messages (thread),
 252                                     notmuch_thread_get_authors (thread),
 253                                     notmuch_thread_get_subject (thread));
 254
 255             fputs (format->tag_start, stdout);
 256
 257             for (tags = notmuch_thread_get_tags (thread);
 258                  notmuch_tags_valid (tags);
 259                  notmuch_tags_move_to_next (tags))
 260             {
 261                 if (! first_tag)
 262                     fputs (format->tag_sep, stdout);
 263                 printf (format->tag, notmuch_tags_get (tags));
 264                 first_tag = 0;
 265             }
 266
 267             fputs (format->tag_end, stdout);
 268
 269             fputs (format->item_end, stdout);
 270         }
 271
 272         first_thread = 0;
 273
 274         notmuch_thread_destroy (thread);
 275     }
 276
 277     if (first_thread)
 278         fputs (format->results_null, stdout);
 279     else
 280         fputs (format->results_end, stdout);
 281
 282     return 0;
 283 }
 284
 285 static int
 286 do_search_messages (const search_format_t *format,
 287                     notmuch_query_t *query,
 288                     output_t output,
 289                     int offset,
 290                     int limit)
 291 {
 292     notmuch_message_t *message;
 293     notmuch_messages_t *messages;
 294     notmuch_filenames_t *filenames;
 295     int first_message = 1;
 296     int i;
 297
 298     if (offset < 0) {
 299         offset += notmuch_query_count_messages (query);
 300         if (offset < 0)
 301             offset = 0;
 302     }
 303
 304     messages = notmuch_query_search_messages (query);
 305     if (messages == NULL)
 306         return 1;
 307
 308     fputs (format->results_start, stdout);
 309
 310     for (i = 0;
 311          notmuch_messages_valid (messages) && (limit < 0 || i < offset + limit);
 312          notmuch_messages_move_to_next (messages), i++)
 313     {
 314         if (i < offset)
 315             continue;
 316
 317         message = notmuch_messages_get (messages);
 318
 319         if (output == OUTPUT_FILES) {
 320             filenames = notmuch_message_get_filenames (message);
 321
 322             for (;
 323                  notmuch_filenames_valid (filenames);
 324                  notmuch_filenames_move_to_next (filenames))
 325             {
 326                 if (! first_message)
 327                     fputs (format->item_sep, stdout);
 328
 329                 format->item_id (message, "",
 330                                  notmuch_filenames_get (filenames));
 331
 332                 first_message = 0;
 333             }
 334
 335             notmuch_filenames_destroy( filenames );
 336
 337         } else { /* output == OUTPUT_MESSAGES */
 338             if (! first_message)
 339                 fputs (format->item_sep, stdout);
 340
 341             format->item_id (message, "id:",
 342                              notmuch_message_get_message_id (message));
 343             first_message = 0;
 344         }
 345
 346         notmuch_message_destroy (message);
 347     }
 348
 349     notmuch_messages_destroy (messages);
 350
 351     if (first_message)
 352         fputs (format->results_null, stdout);
 353     else
 354         fputs (format->results_end, stdout);
 355
 356     return 0;
 357 }
 358
 359 static int
 360 do_search_tags (notmuch_database_t *notmuch,
 361                 const search_format_t *format,
 362                 notmuch_query_t *query)
 363 {
 364     notmuch_messages_t *messages = NULL;
 365     notmuch_tags_t *tags;
 366     const char *tag;
 367     int first_tag = 1;
 368
 369     /* Special-case query of "*" for better performance. */
 370     if (strcmp (notmuch_query_get_query_string (query), "*") == 0) {
 371         tags = notmuch_database_get_all_tags (notmuch);
 372     } else {
 373         messages = notmuch_query_search_messages (query);
 374         if (messages == NULL)
 375             return 1;
 376
 377         tags = notmuch_messages_collect_tags (messages);
 378     }
 379     if (tags == NULL)
 380         return 1;
 381
 382     fputs (format->results_start, stdout);
 383
 384     for (;
 385          notmuch_tags_valid (tags);
 386          notmuch_tags_move_to_next (tags))
 387     {
 388         tag = notmuch_tags_get (tags);
 389
 390         if (! first_tag)
 391             fputs (format->item_sep, stdout);
 392
 393         format->item_id (tags, "", tag);
 394
 395         first_tag = 0;
 396     }
 397
 398     notmuch_tags_destroy (tags);
 399
 400     if (messages)
 401         notmuch_messages_destroy (messages);
 402
 403     if (first_tag)
 404         fputs (format->results_null, stdout);
 405     else
 406         fputs (format->results_end, stdout);
 407
 408     return 0;
 409 }
 410
 411 int
 412 notmuch_search_command (void *ctx, int argc, char *argv[])
 413 {
 414     notmuch_config_t *config;
 415     notmuch_database_t *notmuch;
 416     notmuch_query_t *query;
 417     char *query_str;
 418     char *opt;
 419     notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST;
 420     const search_format_t *format = &format_text;
 421     int i, ret;
 422     output_t output = OUTPUT_SUMMARY;
 423     int offset = 0;
 424     int limit = -1; /* unlimited */
 425
 426     argc--; argv++; /* skip subcommand argument */
 427
 428     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
 429         if (strcmp (argv[i], "--") == 0) {
 430             i++;
 431             break;
 432         }
 433         if (STRNCMP_LITERAL (argv[i], "--sort=") == 0) {
 434             opt = argv[i] + sizeof ("--sort=") - 1;
 435             if (strcmp (opt, "oldest-first") == 0) {
 436                 sort = NOTMUCH_SORT_OLDEST_FIRST;
 437             } else if (strcmp (opt, "newest-first") == 0) {
 438                 sort = NOTMUCH_SORT_NEWEST_FIRST;
 439             } else {
 440                 fprintf (stderr, "Invalid value for --sort: %s\n", opt);
 441                 return 1;
 442             }
 443         } else if (STRNCMP_LITERAL (argv[i], "--offset=") == 0) {
 444             char *p;
 445             opt = argv[i] + sizeof ("--offset=") - 1;
 446             offset = strtol (opt, &p, 10);
 447             if (*opt == '\0' || p == opt || *p != '\0') {
 448                 fprintf (stderr, "Invalid value for --offset: %s\n", opt);
 449                 return 1;
 450             }
 451         } else if (STRNCMP_LITERAL (argv[i], "--limit=") == 0) {
 452             char *p;
 453             opt = argv[i] + sizeof ("--limit=") - 1;
 454             limit = strtoul (opt, &p, 10);
 455             if (*opt == '\0' || p == opt || *p != '\0') {
 456                 fprintf (stderr, "Invalid value for --limit: %s\n", opt);
 457                 return 1;
 458             }
 459         } else if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
 460             opt = argv[i] + sizeof ("--format=") - 1;
 461             if (strcmp (opt, "text") == 0) {
 462                 format = &format_text;
 463             } else if (strcmp (opt, "json") == 0) {
 464                 format = &format_json;
 465             } else {
 466                 fprintf (stderr, "Invalid value for --format: %s\n", opt);
 467                 return 1;
 468             }
 469         } else if (STRNCMP_LITERAL (argv[i], "--output=") == 0) {
 470             opt = argv[i] + sizeof ("--output=") - 1;
 471             if (strcmp (opt, "summary") == 0) {
 472                 output = OUTPUT_SUMMARY;
 473             } else if (strcmp (opt, "threads") == 0) {
 474                 output = OUTPUT_THREADS;
 475             } else if (strcmp (opt, "messages") == 0) {
 476                 output = OUTPUT_MESSAGES;
 477             } else if (strcmp (opt, "files") == 0) {
 478                 output = OUTPUT_FILES;
 479             } else if (strcmp (opt, "tags") == 0) {
 480                 output = OUTPUT_TAGS;
 481             } else {
 482                 fprintf (stderr, "Invalid value for --output: %s\n", opt);
 483                 return 1;
 484             }
 485         } else {
 486             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
 487             return 1;
 488         }
 489     }
 490
 491     argc -= i;
 492     argv += i;
 493
 494     config = notmuch_config_open (ctx, NULL, NULL);
 495     if (config == NULL)
 496         return 1;
 497
 498     notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
 499                                      NOTMUCH_DATABASE_MODE_READ_ONLY);
 500     if (notmuch == NULL)
 501         return 1;
 502
 503     query_str = query_string_from_args (notmuch, argc, argv);
 504     if (query_str == NULL) {
 505         fprintf (stderr, "Out of memory.\n");
 506         return 1;
 507     }
 508     if (*query_str == '\0') {
 509         fprintf (stderr, "Error: notmuch search requires at least one search term.\n");
 510         return 1;
 511     }
 512
 513     query = notmuch_query_create (notmuch, query_str);
 514     if (query == NULL) {
 515         fprintf (stderr, "Out of memory\n");
 516         return 1;
 517     }
 518
 519     notmuch_query_set_sort (query, sort);
 520
 521     switch (output) {
 522     default:
 523     case OUTPUT_SUMMARY:
 524     case OUTPUT_THREADS:
 525         ret = do_search_threads (format, query, sort, output, offset, limit);
 526         break;
 527     case OUTPUT_MESSAGES:
 528     case OUTPUT_FILES:
 529         ret = do_search_messages (format, query, output, offset, limit);
 530         break;
 531     case OUTPUT_TAGS:
 532         ret = do_search_tags (notmuch, format, query);
 533         break;
 534     }
 535
 536     notmuch_query_destroy (query);
 537     notmuch_database_close (notmuch);
 538
 539     return ret;
 540 }