]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-setup.c
cli: move config open/close to main() from subcommands
[notmuch] / notmuch-setup.c
index eaadb2e390481d7c6d41df5ba9aa7e9d74ea38aa..475248b1f9735b2e10f00f013deffa0baac85e7a 100644 (file)
 
 #include "notmuch-client.h"
 
-static notmuch_status_t
-add_all_files (notmuch_database_t *notmuch,
-              const char *mail_directory,
-              int num_files)
+static const char *
+make_path_absolute (void *ctx, const char *path)
 {
-    add_files_state_t add_files_state;
-    double elapsed;
-    struct timeval tv_now;
-    notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
-
-    add_files_state.ignore_read_only_directories = FALSE;
-    add_files_state.saw_read_only_directory = FALSE;
-    add_files_state.total_files = num_files;
-    add_files_state.processed_files = 0;
-    add_files_state.added_messages = 0;
-    add_files_state.callback = NULL;
-    gettimeofday (&add_files_state.tv_start, NULL);
-
-    ret = add_files (notmuch, mail_directory, &add_files_state);
-
-    gettimeofday (&tv_now, NULL);
-    elapsed = notmuch_time_elapsed (add_files_state.tv_start,
-                                   tv_now);
-    printf ("Processed %d %s in ", add_files_state.processed_files,
-           add_files_state.processed_files == 1 ?
-           "file" : "total files");
-    notmuch_time_print_formatted_seconds (elapsed);
-    if (elapsed > 1) {
-       printf (" (%d files/sec.).                 \n",
-               (int) (add_files_state.processed_files / elapsed));
-    } else {
-       printf (".                    \n");
-    }
-    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");
-    }
+    char *cwd;
 
-    return ret;
-}
+    if (*path == '/')
+       return path;
 
-
-/* XXX: This should be merged with the existing add_files function in
- * add-files.c. */
-/* 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). */
-static void
-count_files (const char *path, int *count)
-{
-    DIR *dir;
-    struct dirent *e, *entry = NULL;
-    int entry_length;
-    int err;
-    char *next;
-    struct stat st;
-
-    dir = opendir (path);
-
-    if (dir == NULL) {
-       fprintf (stderr, "Warning: failed to open directory %s: %s\n",
-                path, strerror (errno));
-       goto DONE;
+    cwd = getcwd (NULL, 0);
+    if (cwd == NULL) {
+       fprintf (stderr, "Out of memory.\n");
+       return NULL;
     }
 
-    entry_length = offsetof (struct dirent, d_name) +
-       pathconf (path, _PC_NAME_MAX) + 1;
-    entry = malloc (entry_length);
-
-    while (1) {
-       err = readdir_r (dir, entry, &e);
-       if (err) {
-           fprintf (stderr, "Error reading directory: %s\n",
-                    strerror (errno));
-           free (entry);
-           goto DONE;
-       }
-
-       if (e == NULL)
-           break;
-
-       /* Ignore special directories to avoid infinite recursion.
-        * Also ignore the .notmuch directory.
-        */
-       /* XXX: Eventually we'll want more sophistication to let the
-        * user specify files to be ignored. */
-       if (strcmp (entry->d_name, ".") == 0 ||
-           strcmp (entry->d_name, "..") == 0 ||
-           strcmp (entry->d_name, ".notmuch") == 0)
-       {
-           continue;
-       }
-
-       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);
-
-       if (S_ISREG (st.st_mode)) {
-           *count = *count + 1;
-           if (*count % 1000 == 0) {
-               printf ("Found %d files so far.\r", *count);
-               fflush (stdout);
-           }
-       } else if (S_ISDIR (st.st_mode)) {
-           count_files (next, count);
-       }
-
-       free (next);
-    }
+    path = talloc_asprintf (ctx, "%s/%s", cwd, path);
+    if (path == NULL)
+       fprintf (stderr, "Out of memory.\n");
 
-  DONE:
-    if (entry)
-       free (entry);
+    free (cwd);
 
-    closedir (dir);
+    return path;
 }
 
 static void
-welcome_message (void)
+welcome_message_pre_setup (void)
 {
     printf (
 "Welcome to notmuch!\n\n"
+
 "The goal of notmuch is to help you manage and search your collection of\n"
 "email, and to efficiently keep up with the flow of email as it comes in.\n\n"
-"Notmuch needs to know the top-level directory of your email archive,\n"
-"(where you already have mail stored and where messages will be delivered\n"
-"in the future). This directory can contain any number of sub-directories\n"
-"and primarily just files with indvidual email messages (eg. maildir or mh\n"
-"archives are perfect). If there are other, non-email files (such as\n"
-"indexes maintained by other email programs) then notmuch will do its\n"
-"best to detect those and ignore them.\n\n"
-"Mail storage that uses mbox format, (where one mbox file contains many\n"
-"messages), will not work with notmuch. If that's how your mail is currently\n"
-"stored, we recommend you first convert it to maildir format with a utility\n"
-"such as mb2md. In that case, press Control-C now and run notmuch again\n"
-"once the conversion is complete.\n\n");
+
+"Notmuch needs to know a few things about you such as your name and email\n"
+"address, as well as the directory that contains your email. This is where\n"
+"you already have mail stored and where messages will be delivered in the\n"
+"future. This directory can contain any number of sub-directories. Regular\n"
+"files in these directories should be individual email messages. If there\n"
+"are other, non-email files (such as indexes maintained by other email\n"
+"programs) then notmuch will do its best to detect those and ignore them.\n\n"
+
+"If you already have your email being delivered to directories in either\n"
+"maildir or mh format, then that's perfect. Mail storage that uses mbox\n"
+"format, (where one mbox file contains many messages), will not work with\n"
+"notmuch. If that's how your mail is currently stored, we recommend you\n"
+"first convert it to maildir format with a utility such as mb2md. You can\n"
+"continue configuring notmuch now, but be sure to complete the conversion\n"
+"before you run \"notmuch new\" for the first time.\n\n");
 }
 
-static char *
-prompt_user_for_mail_directory ()
+static void
+welcome_message_post_setup (void)
 {
-    char *default_path, *mail_directory = NULL;
-    size_t line_size;
-
-    default_path = notmuch_database_default_path ();
-    printf ("Top-level mail directory [%s]: ", default_path);
-    fflush (stdout);
-
-    getline (&mail_directory, &line_size, stdin);
-    chomp_newline (mail_directory);
-
-    printf ("\n");
+    printf ("\n"
+"Notmuch is now configured, and the configuration settings are saved in\n"
+"a file in your home directory named .notmuch-config . If you'd like to\n"
+"change the configuration in the future, you can either edit that file\n"
+"directly or run \"notmuch setup\".  To choose an alternate configuration\n"
+"location, set ${NOTMUCH_CONFIG}.\n\n"
+
+"The next step is to run \"notmuch new\" which will create a database\n"
+"that indexes all of your mail. Depending on the amount of mail you have\n"
+"the initial indexing process can take a long time, so expect that.\n"
+"Also, the resulting database will require roughly the same amount of\n"
+"storage space as your current collection of email. So please ensure you\n"
+"have sufficient storage space available now.\n\n");
+}
 
-    if (mail_directory == NULL || strlen (mail_directory) == 0) {
-       if (mail_directory)
-           free (mail_directory);
-       mail_directory = default_path;
-    } else {
-       /* XXX: Instead of telling the user to use an environment
-        * variable here, we should really be writing out a configuration
-        * file and loading that on the next run. */
-       if (strcmp (mail_directory, default_path)) {
-           printf ("Note: Since you are not using the default path, you will want to set\n"
-                   "the NOTMUCH_BASE environment variable to %s so that\n"
-                   "future calls to notmuch commands will know where to find your mail.\n",
-                   mail_directory);
-           printf ("For example, if you are using bash for your shell, add:\n\n");
-           printf ("\texport NOTMUCH_BASE=%s\n\n", mail_directory);
-           printf ("to your ~/.bashrc file.\n\n");
-       }
-       free (default_path);
+static void
+print_tag_list (const char **tags, size_t tags_len)
+{
+    unsigned int i;
+    for (i = 0; i < tags_len; i++) {
+       if (i != 0)
+           printf (" ");
+       printf ("%s", tags[i]);
     }
+}
 
-    /* Coerce the directory into an absolute directory name. */
-    if (*mail_directory != '/') {
-       char *cwd, *absolute_mail_directory;
-
-       cwd = getcwd (NULL, 0);
-       if (cwd == NULL) {
-           fprintf (stderr, "Out of memory.\n");
-           exit (1);
-       }
-
-       if (asprintf (&absolute_mail_directory, "%s/%s",
-                     cwd, mail_directory) < 0)
-       {
-           fprintf (stderr, "Out of memory.\n");
-           exit (1);
-       }
-
-       free (cwd);
-       free (mail_directory);
-       mail_directory = absolute_mail_directory;
+static GPtrArray *
+parse_tag_list (void *ctx, char *response)
+{
+    GPtrArray *tags = g_ptr_array_new ();
+    char *tag = response;
+    char *space;
+
+    while (tag && *tag) {
+       space = strchr (tag, ' ');
+       if (space)
+           g_ptr_array_add (tags, talloc_strndup (ctx, tag, space - tag));
+       else
+           g_ptr_array_add (tags, talloc_strdup (ctx, tag));
+       tag = space;
+       while (tag && *tag == ' ')
+           tag++;
     }
 
-    return mail_directory;
+    return tags;
 }
 
 int
-notmuch_setup_command (unused (void *ctx),
+notmuch_setup_command (notmuch_config_t *config,
                       unused (int argc), unused (char *argv[]))
 {
-    notmuch_database_t *notmuch = NULL;
-    char *mail_directory = NULL;
-    int count;
-    notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
+    char *response = NULL;
+    size_t response_size = 0;
+    const char **old_other_emails;
+    size_t old_other_emails_len;
+    GPtrArray *other_emails;
+    unsigned int i;
+    const char **new_tags;
+    size_t new_tags_len;
+    const char **search_exclude_tags;
+    size_t search_exclude_tags_len;
+
+#define prompt(format, ...)                                    \
+    do {                                                       \
+       printf (format, ##__VA_ARGS__);                         \
+       fflush (stdout);                                        \
+       if (getline (&response, &response_size, stdin) < 0) {   \
+           printf ("Exiting.\n");                              \
+           exit (1);                                           \
+       }                                                       \
+       chomp_newline (response);                               \
+    } while (0)
+
+    if (notmuch_config_is_new (config))
+       welcome_message_pre_setup ();
+
+    prompt ("Your full name [%s]: ", notmuch_config_get_user_name (config));
+    if (strlen (response))
+       notmuch_config_set_user_name (config, response);
+
+    prompt ("Your primary email address [%s]: ",
+           notmuch_config_get_user_primary_email (config));
+    if (strlen (response))
+       notmuch_config_set_user_primary_email (config, response);
+
+    other_emails = g_ptr_array_new ();
+
+    old_other_emails = notmuch_config_get_user_other_email (config,
+                                            &old_other_emails_len);
+    for (i = 0; i < old_other_emails_len; i++) {
+       prompt ("Additional email address [%s]: ", old_other_emails[i]);
+       if (strlen (response))
+           g_ptr_array_add (other_emails, talloc_strdup (config, response));
+       else
+           g_ptr_array_add (other_emails, talloc_strdup (config,
+                                                        old_other_emails[i]));
+    }
 
-    welcome_message ();
+    do {
+       prompt ("Additional email address [Press 'Enter' if none]: ");
+       if (strlen (response))
+           g_ptr_array_add (other_emails, talloc_strdup (config, response));
+    } while (strlen (response));
+    if (other_emails->len)
+       notmuch_config_set_user_other_email (config,
+                                            (const char **)
+                                            other_emails->pdata,
+                                            other_emails->len);
+    g_ptr_array_free (other_emails, TRUE);
+
+    prompt ("Top-level directory of your email archive [%s]: ",
+           notmuch_config_get_database_path (config));
+    if (strlen (response)) {
+       const char *absolute_path;
+
+       absolute_path = make_path_absolute (config, response);
+       notmuch_config_set_database_path (config, absolute_path);
+    }
 
-    mail_directory = prompt_user_for_mail_directory ();
+    new_tags = notmuch_config_get_new_tags (config, &new_tags_len);
 
-    notmuch = notmuch_database_create (mail_directory);
-    if (notmuch == NULL) {
-       fprintf (stderr, "Failed to create new notmuch database at %s\n",
-                mail_directory);
-       ret = NOTMUCH_STATUS_FILE_ERROR;
-       goto DONE;
-    }
+    printf ("Tags to apply to all new messages (separated by spaces) [");
+    print_tag_list (new_tags, new_tags_len);
+    prompt ("]: ");
 
-    printf ("OK. Let's take a look at the mail we can find in the directory\n");
-    printf ("%s ...\n", mail_directory);
+    if (strlen (response)) {
+       GPtrArray *tags = parse_tag_list (config, response);
 
-    count = 0;
-    count_files (mail_directory, &count);
+       notmuch_config_set_new_tags (config, (const char **) tags->pdata,
+                                    tags->len);
+
+       g_ptr_array_free (tags, TRUE);
+    }
 
-    printf ("Found %d total files. That's not much mail.\n\n", count);
 
-    printf ("Next, we'll inspect the messages and create a database of threads:\n");
+    search_exclude_tags = notmuch_config_get_search_exclude_tags (config, &search_exclude_tags_len);
 
-    ret = add_all_files (notmuch, mail_directory, count);
+    printf ("Tags to exclude when searching messages (separated by spaces) [");
+    print_tag_list (search_exclude_tags, search_exclude_tags_len);
+    prompt ("]: ");
 
-    printf ("When new mail is delivered to %s in the future,\n"
-           "run \"notmuch new\" to add it to the database.\n\n",
-           mail_directory);
+    if (strlen (response)) {
+       GPtrArray *tags = parse_tag_list (config, response);
 
-    if (ret) {
-       printf ("Note: At least one error was encountered: %s\n",
-               notmuch_status_to_string (ret));
+       notmuch_config_set_search_exclude_tags (config,
+                                               (const char **) tags->pdata,
+                                               tags->len);
+
+       g_ptr_array_free (tags, TRUE);
     }
 
-  DONE:
-    if (mail_directory)
-       free (mail_directory);
-    if (notmuch)
-       notmuch_database_close (notmuch);
 
-    return ret;
+    if (! notmuch_config_save (config)) {
+       if (notmuch_config_is_new (config))
+         welcome_message_post_setup ();
+       return 0;
+    } else {
+       return 1;
+    }
 }