]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-dump.c
test: silence the output of notmuch new mid-test
[notmuch] / notmuch-dump.c
index 21702d793bcf1bd0ec7c379976bb040e5903d9de..cae1db8a99dcacb8b4a20cfa06bdfa599721a32f 100644 (file)
@@ -13,7 +13,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see http://www.gnu.org/licenses/ .
+ * along with this program.  If not, see https://www.gnu.org/licenses/ .
  *
  * Author: Carl Worth <cworth@cworth.org>
  */
 #include "notmuch-client.h"
 #include "hex-escape.h"
 #include "string-util.h"
+#include <zlib.h>
 
 static int
-database_dump_file (notmuch_database_t *notmuch, FILE *output,
-                   const char *query_str, int output_format)
+database_dump_config (notmuch_database_t *notmuch, gzFile output)
+{
+    notmuch_config_list_t *list;
+    int ret = EXIT_FAILURE;
+    char *buffer = NULL;
+    size_t buffer_size = 0;
+
+    if (print_status_database ("notmuch dump", notmuch,
+                              notmuch_database_get_config_list (notmuch, NULL, &list)))
+       goto DONE;
+
+    for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
+       if (hex_encode (notmuch, notmuch_config_list_key (list),
+                       &buffer, &buffer_size) != HEX_SUCCESS) {
+           fprintf (stderr, "Error: failed to hex-encode config key %s\n",
+                    notmuch_config_list_key (list));
+           goto DONE;
+       }
+       gzprintf (output, "#@ %s", buffer);
+
+       if (hex_encode (notmuch, notmuch_config_list_value (list),
+                       &buffer, &buffer_size) != HEX_SUCCESS) {
+           fprintf (stderr, "Error: failed to hex-encode config value %s\n",
+                    notmuch_config_list_value (list) );
+           goto DONE;
+       }
+
+       gzprintf (output, " %s\n", buffer);
+    }
+
+    ret = EXIT_SUCCESS;
+
+ DONE:
+    if (list)
+       notmuch_config_list_destroy (list);
+
+    if (buffer)
+       talloc_free (buffer);
+
+    return ret;
+}
+
+static void
+print_dump_header (gzFile output, int output_format, int include)
+{
+    gzprintf (output, "#notmuch-dump %s:%d %s%s%s\n",
+             (output_format == DUMP_FORMAT_SUP) ? "sup" : "batch-tag",
+             NOTMUCH_DUMP_VERSION,
+             (include & DUMP_INCLUDE_CONFIG) ? "config" : "",
+             (include & DUMP_INCLUDE_TAGS) && (include & DUMP_INCLUDE_CONFIG) ? "," : "",
+             (include & DUMP_INCLUDE_TAGS) ? "tags" : "");
+}
+
+static int
+database_dump_file (notmuch_database_t *notmuch, gzFile output,
+                   const char *query_str, int output_format, int include)
 {
     notmuch_query_t *query;
     notmuch_messages_t *messages;
     notmuch_message_t *message;
     notmuch_tags_t *tags;
 
+    print_dump_header (output, output_format, include);
+
+    if (include & DUMP_INCLUDE_CONFIG) {
+       if (print_status_database ("notmuch dump", notmuch,
+                                  database_dump_config(notmuch,output)))
+           return EXIT_FAILURE;
+    }
+
+    if (! (include & DUMP_INCLUDE_TAGS))
+       return EXIT_SUCCESS;
+
     if (! query_str)
        query_str = "";
 
@@ -46,8 +112,13 @@ database_dump_file (notmuch_database_t *notmuch, FILE *output,
 
     char *buffer = NULL;
     size_t buffer_size = 0;
+    notmuch_status_t status;
 
-    for (messages = notmuch_query_search_messages (query);
+    status = notmuch_query_search_messages_st (query, &messages);
+    if (print_status_query ("notmuch dump", query, status))
+       return EXIT_FAILURE;
+
+    for (;
         notmuch_messages_valid (messages);
         notmuch_messages_move_to_next (messages)) {
        int first = 1;
@@ -69,7 +140,7 @@ database_dump_file (notmuch_database_t *notmuch, FILE *output,
        }
 
        if (output_format == DUMP_FORMAT_SUP) {
-           fprintf (output, "%s (", message_id);
+           gzprintf (output, "%s (", message_id);
        }
 
        for (tags = notmuch_message_get_tags (message);
@@ -78,12 +149,12 @@ database_dump_file (notmuch_database_t *notmuch, FILE *output,
            const char *tag_str = notmuch_tags_get (tags);
 
            if (! first)
-               fputs (" ", output);
+               gzputs (output, " ");
 
            first = 0;
 
            if (output_format == DUMP_FORMAT_SUP) {
-               fputs (tag_str, output);
+               gzputs (output, tag_str);
            } else {
                if (hex_encode (notmuch, tag_str,
                                &buffer, &buffer_size) != HEX_SUCCESS) {
@@ -91,12 +162,12 @@ database_dump_file (notmuch_database_t *notmuch, FILE *output,
                             tag_str);
                    return EXIT_FAILURE;
                }
-               fprintf (output, "+%s", buffer);
+               gzprintf (output, "+%s", buffer);
            }
        }
 
        if (output_format == DUMP_FORMAT_SUP) {
-           fputs (")\n", output);
+           gzputs (output, ")\n");
        } else {
            if (make_boolean_term (notmuch, "id", message_id,
                                   &buffer, &buffer_size)) {
@@ -104,7 +175,7 @@ database_dump_file (notmuch_database_t *notmuch, FILE *output,
                             message_id, strerror (errno));
                    return EXIT_FAILURE;
            }
-           fprintf (output, " -- %s\n", buffer);
+           gzprintf (output, " -- %s\n", buffer);
        }
 
        notmuch_message_destroy (message);
@@ -121,24 +192,84 @@ database_dump_file (notmuch_database_t *notmuch, FILE *output,
 int
 notmuch_database_dump (notmuch_database_t *notmuch,
                       const char *output_file_name,
-                      const char *query_str, dump_format_t output_format)
+                      const char *query_str,
+                      dump_format_t output_format,
+                      dump_include_t include,
+                      notmuch_bool_t gzip_output)
 {
-    FILE *output = stdout;
-    int ret;
+    gzFile output = NULL;
+    const char *mode = gzip_output ? "w9" : "wT";
+    const char *name_for_error = output_file_name ? output_file_name : "stdout";
+
+    char *tempname = NULL;
+    int outfd = -1;
+
+    int ret = -1;
 
     if (output_file_name) {
-       output = fopen (output_file_name, "w");
-       if (output == NULL) {
-           fprintf (stderr, "Error opening %s for writing: %s\n",
-                    output_file_name, strerror (errno));
-           return EXIT_FAILURE;
+       tempname = talloc_asprintf (notmuch, "%s.XXXXXX", output_file_name);
+       outfd = mkstemp (tempname);
+    } else {
+       outfd = dup (STDOUT_FILENO);
+    }
+
+    if (outfd < 0) {
+       fprintf (stderr, "Bad output file %s\n", name_for_error);
+       goto DONE;
+    }
+
+    output = gzdopen (outfd, mode);
+
+    if (output == NULL) {
+       fprintf (stderr, "Error opening %s for (gzip) writing: %s\n",
+                name_for_error, strerror (errno));
+       if (close (outfd))
+           fprintf (stderr, "Error closing %s during shutdown: %s\n",
+                name_for_error, strerror (errno));
+       goto DONE;
+    }
+
+    ret = database_dump_file (notmuch, output, query_str, output_format, include);
+    if (ret) goto DONE;
+
+    ret = gzflush (output, Z_FINISH);
+    if (ret) {
+       fprintf (stderr, "Error flushing output: %s\n", gzerror (output, NULL));
+       goto DONE;
+    }
+
+    if (output_file_name) {
+       ret = fsync (outfd);
+       if (ret) {
+           fprintf (stderr, "Error syncing %s to disk: %s\n",
+                    name_for_error, strerror (errno));
+           goto DONE;
        }
     }
 
-    ret = database_dump_file (notmuch, output, query_str, output_format);
+    if (gzclose_w (output) != Z_OK) {
+       fprintf (stderr, "Error closing %s: %s\n", name_for_error,
+                gzerror (output, NULL));
+       ret = EXIT_FAILURE;
+       output = NULL;
+       goto DONE;
+    }
 
-    if (output != stdout)
-       fclose (output);
+    if (output_file_name) {
+       ret = rename (tempname, output_file_name);
+       if (ret) {
+           fprintf (stderr, "Error renaming %s to %s: %s\n",
+                    tempname, output_file_name, strerror (errno));
+           goto DONE;
+       }
+
+    }
+ DONE:
+    if (ret != EXIT_SUCCESS && output)
+       (void) gzclose_w (output);
+
+    if (ret != EXIT_SUCCESS && output_file_name)
+       (void) unlink (tempname);
 
     return ret;
 }
@@ -151,20 +282,29 @@ notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[])
     int ret;
 
     if (notmuch_database_open (notmuch_config_get_database_path (config),
-                              NOTMUCH_DATABASE_MODE_READ_ONLY, &notmuch))
+                              NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
        return EXIT_FAILURE;
 
+    notmuch_exit_if_unmatched_db_uuid (notmuch);
+
     char *output_file_name = NULL;
     int opt_index;
 
     int output_format = DUMP_FORMAT_BATCH_TAG;
+    int include = 0;
+    notmuch_bool_t gzip_output = 0;
 
     notmuch_opt_desc_t options[] = {
        { NOTMUCH_OPT_KEYWORD, &output_format, "format", 'f',
          (notmuch_keyword_t []){ { "sup", DUMP_FORMAT_SUP },
                                  { "batch-tag", DUMP_FORMAT_BATCH_TAG },
                                  { 0, 0 } } },
+       { NOTMUCH_OPT_KEYWORD_FLAGS, &include, "include", 'I',
+         (notmuch_keyword_t []){ { "config", DUMP_INCLUDE_CONFIG },
+                                 { "tags", DUMP_INCLUDE_TAGS} } },
        { NOTMUCH_OPT_STRING, &output_file_name, "output", 'o', 0  },
+       { NOTMUCH_OPT_BOOLEAN, &gzip_output, "gzip", 'z', 0 },
+       { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },
        { 0, 0, 0, 0, 0 }
     };
 
@@ -172,6 +312,11 @@ notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[])
     if (opt_index < 0)
        return EXIT_FAILURE;
 
+    notmuch_process_shared_options (argv[0]);
+
+    if (include == 0)
+       include = DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_TAGS;
+
     if (opt_index < argc) {
        query_str = query_string_from_args (notmuch, argc - opt_index, argv + opt_index);
        if (query_str == NULL) {
@@ -181,7 +326,7 @@ notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[])
     }
 
     ret = notmuch_database_dump (notmuch, output_file_name, query_str,
-                                output_format);
+                                output_format, include, gzip_output);
 
     notmuch_database_destroy (notmuch);