]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch.c
Add public notmuch_thread_get_subject
[notmuch] / notmuch.c
index d4e0745369b57b82069260c8ffd2a45b088a476b..ae1d5976b71f426329e09964b9c412ba854ab606 100644 (file)
--- a/notmuch.c
+++ b/notmuch.c
 
 #include <talloc.h>
 
-#include <glib.h> /* g_strdup_printf */
+#define unused(x) x __attribute__ ((unused))
+
+/* There's no point in continuing when we've detected that we've done
+ * something wrong internally (as opposed to the user passing in a
+ * bogus value).
+ *
+ * Note that __location__ comes from talloc.h.
+ */
+#define INTERNAL_ERROR(format, ...)                    \
+    do {                                               \
+       fprintf(stderr,                                 \
+               "Internal error: " format " (%s)\n",    \
+               ##__VA_ARGS__, __location__);           \
+       exit (1);                                       \
+    } while (0)
 
 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
 
@@ -54,6 +68,9 @@ typedef struct command {
 } command_t;
 
 typedef struct {
+    int ignore_read_only_directories;
+    int saw_read_only_directory;
+
     int total_files;
     int processed_files;
     int added_messages;
@@ -68,14 +85,14 @@ chomp_newline (char *str)
 }
 
 /* Compute the number of seconds elapsed from start to end. */
-double
+static double
 tv_elapsed (struct timeval start, struct timeval end)
 {
     return ((end.tv_sec - start.tv_sec) +
            (end.tv_usec - start.tv_usec) / 1e6);
 }
 
-void
+static void
 print_formatted_seconds (double seconds)
 {
     int hours;
@@ -101,7 +118,7 @@ print_formatted_seconds (double seconds)
     printf ("%ds", (int) seconds);
 }
 
-void
+static void
 add_files_print_progress (add_files_state_t *state)
 {
     struct timeval tv_now;
@@ -142,32 +159,36 @@ add_files_print_progress (add_files_state_t *state)
  *         same function.
  *
  *   o Tell the database to update its time of 'path' to 'path_mtime'
+ *
+ * The 'struct stat *st' must point to a structure that has already
+ * been initialized for 'path' by calling stat().
  */
-notmuch_status_t
-add_files (notmuch_database_t *notmuch, const char *path,
-          add_files_state_t *state)
+static notmuch_status_t
+add_files_recursive (notmuch_database_t *notmuch,
+                    const char *path,
+                    struct stat *st,
+                    add_files_state_t *state)
 {
     DIR *dir = NULL;
     struct dirent *e, *entry = NULL;
     int entry_length;
     int err;
     char *next = NULL;
-    struct stat st;
     time_t path_mtime, path_dbtime;
     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
 
-    if (stat (path, &st)) {
-       fprintf (stderr, "Error reading directory %s: %s\n",
-                path, strerror (errno));
-       return NOTMUCH_STATUS_FILE_ERROR;
-    }
-
-    if (! S_ISDIR (st.st_mode)) {
-       fprintf (stderr, "Error: %s is not a directory.\n", path);
-       return NOTMUCH_STATUS_FILE_ERROR;
+    /* If we're told to, we bail out on encountering a read-only
+     * directory, (with this being a clear clue from the user to
+     * Notmuch that new mail won't be arriving there and we need not
+     * look. */
+    if (state->ignore_read_only_directories &&
+       (st->st_mode & S_IWUSR) == 0)
+    {
+       state->saw_read_only_directory = TRUE;
+       goto DONE;
     }
 
-    path_mtime = st.st_mtime;
+    path_mtime = st->st_mtime;
 
     path_dbtime = notmuch_database_get_timestamp (notmuch, path);
 
@@ -213,19 +234,19 @@ add_files (notmuch_database_t *notmuch, const char *path,
            continue;
        }
 
-       next = g_strdup_printf ("%s/%s", path, entry->d_name);
+       next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
 
-       if (stat (next, &st)) {
+       if (stat (next, st)) {
            fprintf (stderr, "Error reading %s: %s\n",
                     next, strerror (errno));
            ret = NOTMUCH_STATUS_FILE_ERROR;
            continue;
        }
 
-       if (S_ISREG (st.st_mode)) {
+       if (S_ISREG (st->st_mode)) {
            /* If the file hasn't been modified since the last
             * add_files, then we need not look at it. */
-           if (st.st_mtime > path_dbtime) {
+           if (st->st_mtime > path_dbtime) {
                state->processed_files++;
 
                status = notmuch_database_add_message (notmuch, next);
@@ -244,32 +265,39 @@ add_files (notmuch_database_t *notmuch, const char *path,
                        break;
                    /* Fatal issues. Don't process anymore. */
                    case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
-                       fprintf (stderr, "A Xapian error was encountered. Halting processing.\n");
+                   case NOTMUCH_STATUS_OUT_OF_MEMORY:
+                       fprintf (stderr, "Error: %s. Halting processing.\n",
+                                notmuch_status_to_string (status));
                        ret = status;
                        goto DONE;
                    default:
-                       fprintf (stderr, "Internal error: add_message returned unexpected value: %d\n",  status);
-                       ret = status;
+                   case NOTMUCH_STATUS_FILE_ERROR:
+                   case NOTMUCH_STATUS_NULL_POINTER:
+                   case NOTMUCH_STATUS_TAG_TOO_LONG:
+                   case NOTMUCH_STATUS_LAST_STATUS:
+                       INTERNAL_ERROR ("add_message returned unexpected value: %d",  status);
                        goto DONE;
                }
                if (state->processed_files % 1000 == 0)
                    add_files_print_progress (state);
            }
-       } else if (S_ISDIR (st.st_mode)) {
-           status = add_files (notmuch, next, state);
+       } else if (S_ISDIR (st->st_mode)) {
+           status = add_files_recursive (notmuch, next, st, state);
            if (status && ret == NOTMUCH_STATUS_SUCCESS)
                ret = status;
        }
 
-       free (next);
+       talloc_free (next);
        next = NULL;
     }
 
-    notmuch_database_set_timestamp (notmuch, path, path_mtime);
+    status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
+    if (status && ret == NOTMUCH_STATUS_SUCCESS)
+       ret = status;
 
   DONE:
     if (next)
-       free (next);
+       talloc_free (next);
     if (entry)
        free (entry);
     if (dir)
@@ -278,15 +306,41 @@ add_files (notmuch_database_t *notmuch, const char *path,
     return ret;
 }
 
+/* This is the top-level entry point for add_files. It does a couple
+ * of error checks, and then calls into the recursive function,
+ * (avoiding the repeating of these error checks at every
+ * level---which would be useless becaues we already do a stat() at
+ * the level above). */
+static notmuch_status_t
+add_files (notmuch_database_t *notmuch,
+          const char *path,
+          add_files_state_t *state)
+{
+    struct stat st;
+
+    if (stat (path, &st)) {
+       fprintf (stderr, "Error reading directory %s: %s\n",
+                path, strerror (errno));
+       return NOTMUCH_STATUS_FILE_ERROR;
+    }
+
+    if (! S_ISDIR (st.st_mode)) {
+       fprintf (stderr, "Error: %s is not a directory.\n", path);
+       return NOTMUCH_STATUS_FILE_ERROR;
+    }
+
+    return add_files_recursive (notmuch, path, &st, state);
+}
+
 /* Recursively count all regular files in path and all sub-direcotries
  * of path.  The result is added to *count (which should be
  * initialized to zero by the top-level caller before calling
  * count_files). */
-void
+static void
 count_files (const char *path, int *count)
 {
     DIR *dir;
-    struct dirent *entry, *e;
+    struct dirent *e, *entry = NULL;
     int entry_length;
     int err;
     char *next;
@@ -297,7 +351,7 @@ count_files (const char *path, int *count)
     if (dir == NULL) {
        fprintf (stderr, "Warning: failed to open directory %s: %s\n",
                 path, strerror (errno));
-       return;
+       goto DONE;
     }
 
     entry_length = offsetof (struct dirent, d_name) +
@@ -310,7 +364,7 @@ count_files (const char *path, int *count)
            fprintf (stderr, "Error reading directory: %s\n",
                     strerror (errno));
            free (entry);
-           return;
+           goto DONE;
        }
 
        if (e == NULL)
@@ -328,7 +382,12 @@ count_files (const char *path, int *count)
            continue;
        }
 
-       next = g_strdup_printf ("%s/%s", path, entry->d_name);
+       if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
+           next = NULL;
+           fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
+                    path, entry->d_name);
+           continue;
+       }
 
        stat (next, &st);
 
@@ -345,13 +404,15 @@ count_files (const char *path, int *count)
        free (next);
     }
 
-    free (entry);
+  DONE:
+    if (entry)
+       free (entry);
 
     closedir (dir);
 }
 
-int
-setup_command (int argc, char *argv[])
+static int
+setup_command (unused (int argc), unused (char *argv[]))
 {
     notmuch_database_t *notmuch = NULL;
     char *default_path, *mail_directory = NULL;
@@ -429,6 +490,8 @@ setup_command (int argc, char *argv[])
 
     printf ("Next, we'll inspect the messages and create a database of threads:\n");
 
+    add_files_state.ignore_read_only_directories = FALSE;
+    add_files_state.saw_read_only_directory = FALSE;
     add_files_state.total_files = count;
     add_files_state.processed_files = 0;
     add_files_state.added_messages = 0;
@@ -439,7 +502,9 @@ setup_command (int argc, char *argv[])
     gettimeofday (&tv_now, NULL);
     elapsed = tv_elapsed (add_files_state.tv_start,
                          tv_now);
-    printf ("Processed %d total files in ", add_files_state.processed_files);
+    printf ("Processed %d %s in ", add_files_state.processed_files,
+           add_files_state.processed_files == 1 ?
+           "file" : "total files");
     print_formatted_seconds (elapsed);
     if (elapsed > 1) {
        printf (" (%d files/sec.).                 \n",
@@ -447,11 +512,15 @@ setup_command (int argc, char *argv[])
     } else {
        printf (".                    \n");
     }
-    printf ("Added %d unique messages to the database.\n\n",
-           add_files_state.added_messages);
+    if (add_files_state.added_messages) {
+       printf ("Added %d %s to the database.\n\n",
+               add_files_state.added_messages,
+               add_files_state.added_messages == 1 ?
+               "message" : "unique messages");
+    }
 
     printf ("When new mail is delivered to %s in the future,\n"
-           "run \"notmuch new\" to add it to the database.\n",
+           "run \"notmuch new\" to add it to the database.\n\n",
            mail_directory);
 
     if (ret) {
@@ -468,8 +537,8 @@ setup_command (int argc, char *argv[])
     return ret;
 }
 
-int
-new_command (int argc, char *argv[])
+static int
+new_command (unused (int argc), unused (char *argv[]))
 {
     notmuch_database_t *notmuch;
     const char *mail_directory;
@@ -486,6 +555,8 @@ new_command (int argc, char *argv[])
 
     mail_directory = notmuch_database_get_path (notmuch);
 
+    add_files_state.ignore_read_only_directories = TRUE;
+    add_files_state.saw_read_only_directory = FALSE;
     add_files_state.total_files = 0;
     add_files_state.processed_files = 0;
     add_files_state.added_messages = 0;
@@ -497,7 +568,9 @@ new_command (int argc, char *argv[])
     elapsed = tv_elapsed (add_files_state.tv_start,
                          tv_now);
     if (add_files_state.processed_files) {
-       printf ("Processed %d total files in ", add_files_state.processed_files);
+       printf ("Processed %d %s in ", add_files_state.processed_files,
+               add_files_state.processed_files == 1 ?
+               "file" : "total files");
        print_formatted_seconds (elapsed);
        if (elapsed > 1) {
            printf (" (%d files/sec.).                 \n",
@@ -507,14 +580,23 @@ new_command (int argc, char *argv[])
        }
     }
     if (add_files_state.added_messages) {
-       printf ("Added %d new messages to the database (not much, really).\n",
-               add_files_state.added_messages);
+       printf ("Added %d new %s to the database (not much, really).\n",
+               add_files_state.added_messages,
+               add_files_state.added_messages == 1 ?
+               "message" : "messages");
     } else {
-       printf ("No new mail---and that's not much!\n");
+       printf ("No new mail---and that's not much.\n");
+    }
+
+    if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
+       printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
+               "they will never receive new mail), marking these directores as\n"
+               "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
+               "much more efficient (it won't even look in those directories).\n");
     }
 
     if (ret) {
-       printf ("Note: At least one error was encountered: %s\n",
+       printf ("\nNote: At least one error was encountered: %s\n",
                notmuch_status_to_string (ret));
     }
 
@@ -525,27 +607,93 @@ new_command (int argc, char *argv[])
     return ret;
 }
 
-int
+static int
 search_command (int argc, char *argv[])
 {
-    fprintf (stderr, "Error: search is not implemented yet.\n");
-    return 1;
+    void *local = talloc_new (NULL);
+    notmuch_database_t *notmuch = NULL;
+    notmuch_query_t *query;
+    notmuch_thread_results_t *results;
+    notmuch_thread_t *thread;
+    notmuch_tags_t *tags;
+    char *query_str;
+    int i;
+    notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
+
+    notmuch = notmuch_database_open (NULL);
+    if (notmuch == NULL) {
+       ret = 1;
+       goto DONE;
+    }
+
+    /* XXX: Should add xtalloc wrappers here and use them. */
+    query_str = talloc_strdup (local, "");
+
+    for (i = 0; i < argc; i++) {
+       if (i != 0)
+           query_str = talloc_asprintf_append (query_str, " ");
+
+       query_str = talloc_asprintf_append (query_str, "%s", argv[i]);
+    }
+
+    query = notmuch_query_create (notmuch, query_str);
+    if (query == NULL) {
+       fprintf (stderr, "Out of memory\n");
+       ret = 1;
+       goto DONE;
+    }
+
+    for (results = notmuch_query_search_threads (query);
+        notmuch_thread_results_has_more (results);
+        notmuch_thread_results_advance (results))
+    {
+       int first = 1;
+
+       thread = notmuch_thread_results_get (results);
+
+       printf ("%s %s",
+               notmuch_thread_get_thread_id (thread),
+               _notmuch_thread_get_subject (thread));
+
+       printf (" (");
+       for (tags = notmuch_thread_get_tags (thread);
+            notmuch_tags_has_more (tags);
+            notmuch_tags_advance (tags))
+       {
+           if (! first)
+               printf (" ");
+           printf ("%s", notmuch_tags_get (tags));
+           first = 0;
+       }
+       printf (")\n");
+
+       notmuch_thread_destroy (thread);
+    }
+
+    notmuch_query_destroy (query);
+
+  DONE:
+    if (notmuch)
+       notmuch_database_close (notmuch);
+    talloc_free (local);
+
+    return ret;
 }
 
-int
-show_command (int argc, char *argv[])
+static int
+show_command (unused (int argc), unused (char *argv[]))
 {
     fprintf (stderr, "Error: show is not implemented yet.\n");
     return 1;
 }
 
-int
+static int
 dump_command (int argc, char *argv[])
 {
-    FILE *output;
-    notmuch_database_t *notmuch;
+    FILE *output = NULL;
+    notmuch_database_t *notmuch = NULL;
     notmuch_query_t *query;
-    notmuch_results_t *results;
+    notmuch_message_results_t *results;
     notmuch_message_t *message;
     notmuch_tags_t *tags;
     int ret = 0;
@@ -577,12 +725,12 @@ dump_command (int argc, char *argv[])
 
     notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID);
 
-    for (results = notmuch_query_search (query);
-        notmuch_results_has_more (results);
-        notmuch_results_advance (results))
+    for (results = notmuch_query_search_messages (query);
+        notmuch_message_results_has_more (results);
+        notmuch_message_results_advance (results))
     {
        int first = 1;
-       message = notmuch_results_get (results);
+       message = notmuch_message_results_get (results);
 
        fprintf (output,
                 "%s (", notmuch_message_get_message_id (message));
@@ -609,19 +757,20 @@ dump_command (int argc, char *argv[])
   DONE:
     if (notmuch)
        notmuch_database_close (notmuch);
-    if (output != stdout)
+    if (output && output != stdout)
        fclose (output);
 
     return ret;
 }
 
-int
+static int
 restore_command (int argc, char *argv[])
 {
-    FILE *input;
-    notmuch_database_t *notmuch;
+    FILE *input = NULL;
+    notmuch_database_t *notmuch = NULL;
     char *line = NULL;
-    size_t line_size, line_len;
+    size_t line_size;
+    ssize_t line_len;
     regex_t regex;
     int rerr;
     int ret = 0;
@@ -697,7 +846,8 @@ restore_command (int argc, char *argv[])
                                 notmuch_status_to_string (status));
                    }
                } else {
-                   fprintf (stderr, "%s ", tag);
+                   fprintf (stderr, "%s%s",
+                            tag == tags ? "" : " ", tag);
                }
            }
 
@@ -717,17 +867,23 @@ restore_command (int argc, char *argv[])
        free (line);
     if (notmuch)
        notmuch_database_close (notmuch);
+    if (input && input != stdin)
+       fclose (input);
 
     return ret;
 }
 
 command_t commands[] = {
     { "setup", setup_command,
-      "Interactively setup notmuch for first use.\n"
+      "Interactively setup notmuch for first use.\n\n"
       "\t\tInvoking notmuch with no command argument will run setup if\n"
       "\t\tthe setup command has not previously been completed." },
     { "new", new_command,
-      "Find and import any new messages."},
+      "Find and import any new messages.\n\n"
+      "\t\tScans all sub-directories of the database, adding new files\n"
+      "\t\tthat are found. Note: \"notmuch new\" will skip any\n"
+      "\t\tread-only directories, so you can use that to mark\n"
+      "\t\tdirectories that will not receive any new mail."},
     { "search", search_command,
       "<search-term> [...]\n\n"
       "\t\tSearch for threads matching the given search terms.\n"
@@ -750,11 +906,11 @@ command_t commands[] = {
       "\t\tRestore the tags from the given dump file (see 'dump')." }
 };
 
-void
+static void
 usage (void)
 {
     command_t *command;
-    int i;
+    unsigned int i;
 
     fprintf (stderr, "Usage: notmuch <command> [args...]\n");
     fprintf (stderr, "\n");
@@ -772,7 +928,7 @@ int
 main (int argc, char *argv[])
 {
     command_t *command;
-    int i;
+    unsigned int i;
 
     if (argc == 1)
        return setup_command (0, NULL);
@@ -790,11 +946,11 @@ main (int argc, char *argv[])
        strcmp (argv[1], "--help") == 0)
     {
        fprintf (stderr, "The notmuch mail system.\n\n");
+       usage ();
+       return 0;
     } else {
        fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]);
+       usage ();
+       return 1;
     }
-    usage ();
-    exit (1);
-
-    return 0;
 }