]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-insert.c
cli/insert: use a single recursive mkdir function
[notmuch] / notmuch-insert.c
index 1228afaccec39fa6f1a8f255251457446dddf715..cdeeb415ca3b3417f5903ac5e325a22579c0062f 100644 (file)
@@ -67,20 +67,116 @@ safe_gethostname (char *hostname, size_t len)
 static notmuch_bool_t
 sync_dir (const char *dir)
 {
-    notmuch_bool_t ret;
-    int fd;
+    int fd, r;
 
     fd = open (dir, O_RDONLY);
     if (fd == -1) {
-       fprintf (stderr, "Error: open() dir failed: %s\n", strerror (errno));
+       fprintf (stderr, "Error: open %s: %s\n", dir, strerror (errno));
        return FALSE;
     }
-    ret = (fsync (fd) == 0);
-    if (! ret) {
-       fprintf (stderr, "Error: fsync() dir failed: %s\n", strerror (errno));
-    }
+
+    r = fsync (fd);
+    if (r)
+       fprintf (stderr, "Error: fsync %s: %s\n", dir, strerror (errno));
+
     close (fd);
-    return ret;
+
+    return r == 0;
+}
+
+/*
+ * Check the specified folder name does not contain a directory
+ * component ".." to prevent writes outside of the Maildir
+ * hierarchy. Return TRUE on valid folder name, FALSE otherwise.
+ */
+static notmuch_bool_t
+is_valid_folder_name (const char *folder)
+{
+    const char *p = folder;
+
+    for (;;) {
+       if ((p[0] == '.') && (p[1] == '.') && (p[2] == '\0' || p[2] == '/'))
+           return FALSE;
+       p = strchr (p, '/');
+       if (!p)
+           return TRUE;
+       p++;
+    }
+}
+
+/*
+ * Make the given directory and its parents as necessary, using the
+ * given mode. Return TRUE on success, FALSE otherwise. Partial
+ * results are not cleaned up on errors.
+ */
+static notmuch_bool_t
+mkdir_recursive (const void *ctx, const char *path, int mode)
+{
+    struct stat st;
+    int r;
+    char *parent = NULL, *slash;
+
+    /* First check the common case: directory already exists. */
+    r = stat (path, &st);
+    if (r == 0) {
+        if (! S_ISDIR (st.st_mode)) {
+           fprintf (stderr, "Error: '%s' is not a directory: %s\n",
+                    path, strerror (EEXIST));
+           return FALSE;
+       }
+
+       return TRUE;
+    } else if (errno != ENOENT) {
+       fprintf (stderr, "Error: stat '%s': %s\n", path, strerror (errno));
+       return FALSE;
+    }
+
+    /* mkdir parents, if any */
+    slash = strrchr (path, '/');
+    if (slash && slash != path) {
+       parent = talloc_strndup (ctx, path, slash - path);
+       if (! parent) {
+           fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
+           return FALSE;
+       }
+
+       if (! mkdir_recursive (ctx, parent, mode))
+           return FALSE;
+    }
+
+    if (mkdir (path, mode)) {
+       fprintf (stderr, "Error: mkdir '%s': %s\n", path, strerror (errno));
+       return FALSE;
+    }
+
+    return parent ? sync_dir (parent) : TRUE;
+}
+
+/*
+ * Create the given maildir folder, i.e. maildir and its
+ * subdirectories cur/new/tmp. Return TRUE on success, FALSE
+ * otherwise. Partial results are not cleaned up on errors.
+ */
+static notmuch_bool_t
+maildir_create_folder (const void *ctx, const char *maildir)
+{
+    const char *subdirs[] = { "cur", "new", "tmp" };
+    const int mode = 0700;
+    char *subdir;
+    unsigned int i;
+
+    for (i = 0; i < ARRAY_SIZE (subdirs); i++) {
+       subdir = talloc_asprintf (ctx, "%s/%s", maildir, subdirs[i]);
+       if (! subdir) {
+           fprintf (stderr, "Error: %s\n", strerror (ENOMEM));
+           return FALSE;
+       }
+
+       if (! mkdir_recursive (ctx, subdir, mode))
+           return FALSE;
+    }
+
+    return TRUE;
 }
 
 /* Open a unique file in the 'tmp' sub-directory of dir.
@@ -138,11 +234,12 @@ maildir_open_tmp_file (void *ctx, const char *dir,
     return fd;
 }
 
-/* Copy the contents of standard input (fdin) into fdout.
- * Returns TRUE if a non-empty file was written successfully.
- * Otherwise, return FALSE. */
+/*
+ * Copy fdin to fdout, return TRUE on success, and FALSE on errors and
+ * empty input.
+ */
 static notmuch_bool_t
-copy_stdin (int fdin, int fdout)
+copy_fd (int fdout, int fdin)
 {
     notmuch_bool_t empty = TRUE;
 
@@ -181,65 +278,21 @@ copy_stdin (int fdin, int fdout)
     return (!interrupted && !empty);
 }
 
-/* Add the specified message file to the notmuch database, applying tags.
- * The file is renamed to encode notmuch tags as maildir flags. */
-static void
-add_file_to_database (notmuch_database_t *notmuch, const char *path,
-                     tag_op_list_t *tag_ops)
-{
-    notmuch_message_t *message;
-    notmuch_status_t status;
-
-    status = notmuch_database_add_message (notmuch, path, &message);
-    switch (status) {
-    case NOTMUCH_STATUS_SUCCESS:
-    case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
-       break;
-    default:
-    case NOTMUCH_STATUS_FILE_NOT_EMAIL:
-    case NOTMUCH_STATUS_READ_ONLY_DATABASE:
-    case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
-    case NOTMUCH_STATUS_OUT_OF_MEMORY:
-    case NOTMUCH_STATUS_FILE_ERROR:
-    case NOTMUCH_STATUS_NULL_POINTER:
-    case NOTMUCH_STATUS_TAG_TOO_LONG:
-    case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
-    case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
-    case NOTMUCH_STATUS_LAST_STATUS:
-       fprintf (stderr, "Error: failed to add `%s' to notmuch database: %s\n",
-                path, notmuch_status_to_string (status));
-       return;
-    }
-
-    if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
-       /* Don't change tags of an existing message. */
-       status = notmuch_message_tags_to_maildir_flags (message);
-       if (status != NOTMUCH_STATUS_SUCCESS)
-           fprintf (stderr, "Error: failed to sync tags to maildir flags\n");
-    } else {
-       tag_op_list_apply (message, tag_ops, TAG_FLAG_MAILDIR_SYNC);
-    }
-
-    notmuch_message_destroy (message);
-}
-
 static notmuch_bool_t
-insert_message (void *ctx, notmuch_database_t *notmuch, int fdin,
-               const char *dir, tag_op_list_t *tag_ops)
+write_message (void *ctx, int fdin, const char *dir, char **newpath)
 {
     char *tmppath;
-    char *newpath;
     char *newdir;
-    int fdout;
     char *cleanup_path;
+    int fdout;
 
-    fdout = maildir_open_tmp_file (ctx, dir, &tmppath, &newpath, &newdir);
+    fdout = maildir_open_tmp_file (ctx, dir, &tmppath, newpath, &newdir);
     if (fdout < 0)
        return FALSE;
 
     cleanup_path = tmppath;
 
-    if (! copy_stdin (fdin, fdout))
+    if (! copy_fd (fdout, fdin))
        goto FAIL;
 
     if (fsync (fdout) != 0) {
@@ -255,20 +308,16 @@ insert_message (void *ctx, notmuch_database_t *notmuch, int fdin,
      * simply use rename() instead of link() and unlink().
      * See also: http://wiki.dovecot.org/MailboxFormat/Maildir#Mail_delivery
      */
-    if (rename (tmppath, newpath) != 0) {
+    if (rename (tmppath, *newpath) != 0) {
        fprintf (stderr, "Error: rename() failed: %s\n", strerror (errno));
        goto FAIL;
     }
 
-    cleanup_path = newpath;
+    cleanup_path = *newpath;
 
     if (! sync_dir (newdir))
        goto FAIL;
 
-    /* Even if adding the message to the notmuch database fails,
-     * the message is on disk and we consider the delivery completed. */
-    add_file_to_database (notmuch, newpath, tag_ops);
-
     return TRUE;
 
   FAIL:
@@ -278,6 +327,52 @@ insert_message (void *ctx, notmuch_database_t *notmuch, int fdin,
     return FALSE;
 }
 
+/* Add the specified message file to the notmuch database, applying tags.
+ * The file is renamed to encode notmuch tags as maildir flags. */
+static void
+add_file_to_database (notmuch_database_t *notmuch, const char *path,
+                     tag_op_list_t *tag_ops, notmuch_bool_t synchronize_flags)
+{
+    notmuch_message_t *message;
+    notmuch_status_t status;
+
+    status = notmuch_database_add_message (notmuch, path, &message);
+    switch (status) {
+    case NOTMUCH_STATUS_SUCCESS:
+    case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
+       break;
+    default:
+    case NOTMUCH_STATUS_FILE_NOT_EMAIL:
+    case NOTMUCH_STATUS_READ_ONLY_DATABASE:
+    case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
+    case NOTMUCH_STATUS_OUT_OF_MEMORY:
+    case NOTMUCH_STATUS_FILE_ERROR:
+    case NOTMUCH_STATUS_NULL_POINTER:
+    case NOTMUCH_STATUS_TAG_TOO_LONG:
+    case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
+    case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
+    case NOTMUCH_STATUS_LAST_STATUS:
+       fprintf (stderr, "Error: failed to add `%s' to notmuch database: %s\n",
+                path, notmuch_status_to_string (status));
+       return;
+    }
+
+    if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
+       /* Don't change tags of an existing message. */
+       if (synchronize_flags) {
+           status = notmuch_message_tags_to_maildir_flags (message);
+           if (status != NOTMUCH_STATUS_SUCCESS)
+               fprintf (stderr, "Error: failed to sync tags to maildir flags\n");
+       }
+    } else {
+       tag_op_flag_t flags = synchronize_flags ? TAG_FLAG_MAILDIR_SYNC : 0;
+
+       tag_op_list_apply (message, tag_ops, flags);
+    }
+
+    notmuch_message_destroy (message);
+}
+
 int
 notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
 {
@@ -288,34 +383,71 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
     size_t new_tags_length;
     tag_op_list_t *tag_ops;
     char *query_string = NULL;
+    const char *folder = NULL;
+    notmuch_bool_t create_folder = FALSE;
+    notmuch_bool_t synchronize_flags;
     const char *maildir;
-    int opt_index = 1;
+    char *newpath;
+    int opt_index;
     unsigned int i;
-    notmuch_bool_t ret;
+
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_STRING, &folder, "folder", 0, 0 },
+       { NOTMUCH_OPT_BOOLEAN, &create_folder, "create-folder", 0, 0 },
+       { NOTMUCH_OPT_END, 0, 0, 0, 0 }
+    };
+
+    opt_index = parse_arguments (argc, argv, options, 1);
+    if (opt_index < 0)
+       return EXIT_FAILURE;
 
     db_path = notmuch_config_get_database_path (config);
     new_tags = notmuch_config_get_new_tags (config, &new_tags_length);
+    synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
 
     tag_ops = tag_op_list_create (config);
     if (tag_ops == NULL) {
        fprintf (stderr, "Out of memory.\n");
-       return 1;
+       return EXIT_FAILURE;
     }
     for (i = 0; i < new_tags_length; i++) {
+       const char *error_msg;
+
+       error_msg = illegal_tag (new_tags[i], FALSE);
+       if (error_msg) {
+           fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
+                    new_tags[i],  error_msg);
+           return EXIT_FAILURE;
+       }
+
        if (tag_op_list_append (tag_ops, new_tags[i], FALSE))
-           return 1;
+           return EXIT_FAILURE;
     }
 
     if (parse_tag_command_line (config, argc - opt_index, argv + opt_index,
                                &query_string, tag_ops))
-       return 1;
+       return EXIT_FAILURE;
 
     if (*query_string != '\0') {
        fprintf (stderr, "Error: unexpected query string: %s\n", query_string);
-       return 1;
+       return EXIT_FAILURE;
     }
 
-    maildir = db_path;
+    if (folder == NULL) {
+       maildir = db_path;
+    } else {
+       if (! is_valid_folder_name (folder)) {
+           fprintf (stderr, "Error: invalid folder name: '%s'\n", folder);
+           return EXIT_FAILURE;
+       }
+       maildir = talloc_asprintf (config, "%s/%s", db_path, folder);
+       if (! maildir) {
+           fprintf (stderr, "Out of memory\n");
+           return EXIT_FAILURE;
+       }
+       if (create_folder && ! maildir_create_folder (config, maildir))
+           return EXIT_FAILURE;
+    }
 
     /* Setup our handler for SIGINT. We do not set SA_RESTART so that copying
      * from standard input may be interrupted. */
@@ -327,11 +459,20 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])
 
     if (notmuch_database_open (notmuch_config_get_database_path (config),
                               NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
-       return 1;
+       return EXIT_FAILURE;
 
-    ret = insert_message (config, notmuch, STDIN_FILENO, maildir, tag_ops);
+    /* Write the message to the Maildir new directory. */
+    if (! write_message (config, STDIN_FILENO, maildir, &newpath)) {
+       notmuch_database_destroy (notmuch);
+       return EXIT_FAILURE;
+    }
 
-    notmuch_database_destroy (notmuch);
+    /* Add the message to the index.
+     * Even if adding the message to the notmuch database fails,
+     * the message is on disk and we consider the delivery completed. */
+    add_file_to_database (notmuch, newpath, tag_ops,
+                                   synchronize_flags);
 
-    return (ret) ? 0 : 1;
+    notmuch_database_destroy (notmuch);
+    return EXIT_SUCCESS;
 }