X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-dump.c;h=505c1469657cfac48945bd394a1aef06d7f74ee2;hp=9c6ad7f47b0fde514a5e64c96705d598f2eee7ec;hb=33382c2b5ba2537952a60ea378feff36961e4713;hpb=bbbdf0478ea6109afc1ca5a26a8d1cd86b600e2a diff --git a/notmuch-dump.c b/notmuch-dump.c index 9c6ad7f4..505c1469 100644 --- a/notmuch-dump.c +++ b/notmuch-dump.c @@ -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 */ @@ -23,15 +23,209 @@ #include "string-util.h" #include +static int +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) +{ + const char *sep = ""; + + gzprintf (output, "#notmuch-dump %s:%d ", + (output_format == DUMP_FORMAT_SUP) ? "sup" : "batch-tag", + NOTMUCH_DUMP_VERSION); + + if (include & DUMP_INCLUDE_CONFIG) { + gzputs (output, "config"); + sep = ","; + } + if (include & DUMP_INCLUDE_PROPERTIES) { + gzprintf (output, "%sproperties", sep); + sep = ","; + } + if (include & DUMP_INCLUDE_TAGS) { + gzprintf (output, "%stags", sep); + } + gzputs (output, "\n"); +} + +static int +dump_properties_message (void *ctx, + notmuch_message_t *message, + gzFile output, + char **buffer_p, size_t *size_p) +{ + const char *message_id; + notmuch_message_properties_t *list; + bool first = true; + + message_id = notmuch_message_get_message_id (message); + + if (strchr (message_id, '\n')) { + fprintf (stderr, "Warning: skipping message id containing line break: \"%s\"\n", message_id); + return 0; + } + + for (list = notmuch_message_get_properties (message, "", false); + notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) { + const char *key, *val; + + if (first) { + if (hex_encode (ctx, message_id, buffer_p, size_p) != HEX_SUCCESS) { + fprintf (stderr, "Error: failed to hex-encode message-id %s\n", message_id); + return 1; + } + gzprintf (output, "#= %s", *buffer_p); + first = false; + } + + key = notmuch_message_properties_key (list); + val = notmuch_message_properties_value (list); + + if (hex_encode (ctx, key, buffer_p, size_p) != HEX_SUCCESS) { + fprintf (stderr, "Error: failed to hex-encode key %s\n", key); + return 1; + } + gzprintf (output, " %s", *buffer_p); + + if (hex_encode (ctx, val, buffer_p, size_p) != HEX_SUCCESS) { + fprintf (stderr, "Error: failed to hex-encode value %s\n", val); + return 1; + } + gzprintf (output, "=%s", *buffer_p); + } + notmuch_message_properties_destroy (list); + + if (! first) + gzprintf (output, "\n", *buffer_p); + + return 0; +} + +static int +dump_tags_message (void *ctx, + notmuch_message_t *message, int output_format, + gzFile output, + char **buffer_p, size_t *size_p) +{ + int first = 1; + const char *message_id; + + message_id = notmuch_message_get_message_id (message); + + if (output_format == DUMP_FORMAT_BATCH_TAG && + strchr (message_id, '\n')) { + /* This will produce a line break in the output, which + * would be difficult to handle in tools. However, it's + * also impossible to produce an email containing a line + * break in a message ID because of unfolding, so we can + * safely disallow it. */ + fprintf (stderr, "Warning: skipping message id containing line break: \"%s\"\n", message_id); + return EXIT_SUCCESS; + } + + if (output_format == DUMP_FORMAT_SUP) { + gzprintf (output, "%s (", message_id); + } + + for (notmuch_tags_t *tags = notmuch_message_get_tags (message); + notmuch_tags_valid (tags); + notmuch_tags_move_to_next (tags)) { + const char *tag_str = notmuch_tags_get (tags); + + if (! first) + gzputs (output, " "); + + first = 0; + + if (output_format == DUMP_FORMAT_SUP) { + gzputs (output, tag_str); + } else { + if (hex_encode (ctx, tag_str, + buffer_p, size_p) != HEX_SUCCESS) { + fprintf (stderr, "Error: failed to hex-encode tag %s\n", + tag_str); + return EXIT_FAILURE; + } + gzprintf (output, "+%s", *buffer_p); + } + } + + if (output_format == DUMP_FORMAT_SUP) { + gzputs (output, ")\n"); + } else { + if (make_boolean_term (ctx, "id", message_id, + buffer_p, size_p)) { + fprintf (stderr, "Error quoting message id %s: %s\n", + message_id, strerror (errno)); + return EXIT_FAILURE; + } + gzprintf (output, " -- %s\n", *buffer_p); + } + return EXIT_SUCCESS; +} static int database_dump_file (notmuch_database_t *notmuch, gzFile output, - const char *query_str, int output_format) + 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; + notmuch_status_t status; + char *buffer = NULL; + size_t buffer_size = 0; + + 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 | DUMP_INCLUDE_PROPERTIES))) + return EXIT_SUCCESS; if (! query_str) query_str = ""; @@ -46,68 +240,25 @@ database_dump_file (notmuch_database_t *notmuch, gzFile output, */ notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED); - char *buffer = NULL; - size_t buffer_size = 0; + status = notmuch_query_search_messages (query, &messages); + if (print_status_query ("notmuch dump", query, status)) + return EXIT_FAILURE; - for (messages = notmuch_query_search_messages (query); + for (; notmuch_messages_valid (messages); notmuch_messages_move_to_next (messages)) { - int first = 1; - const char *message_id; message = notmuch_messages_get (messages); - message_id = notmuch_message_get_message_id (message); - - if (output_format == DUMP_FORMAT_BATCH_TAG && - strchr (message_id, '\n')) { - /* This will produce a line break in the output, which - * would be difficult to handle in tools. However, it's - * also impossible to produce an email containing a line - * break in a message ID because of unfolding, so we can - * safely disallow it. */ - fprintf (stderr, "Warning: skipping message id containing line break: \"%s\"\n", message_id); - notmuch_message_destroy (message); - continue; - } - - if (output_format == DUMP_FORMAT_SUP) { - gzprintf (output, "%s (", message_id); - } - for (tags = notmuch_message_get_tags (message); - notmuch_tags_valid (tags); - notmuch_tags_move_to_next (tags)) { - const char *tag_str = notmuch_tags_get (tags); - - if (! first) - gzputs (output, " "); - - first = 0; - - if (output_format == DUMP_FORMAT_SUP) { - gzputs (output, tag_str); - } else { - if (hex_encode (notmuch, tag_str, - &buffer, &buffer_size) != HEX_SUCCESS) { - fprintf (stderr, "Error: failed to hex-encode tag %s\n", - tag_str); - return EXIT_FAILURE; - } - gzprintf (output, "+%s", buffer); - } - } + if ((include & DUMP_INCLUDE_TAGS) && + dump_tags_message (notmuch, message, output_format, output, + &buffer, &buffer_size)) + return EXIT_FAILURE; - if (output_format == DUMP_FORMAT_SUP) { - gzputs (output, ")\n"); - } else { - if (make_boolean_term (notmuch, "id", message_id, - &buffer, &buffer_size)) { - fprintf (stderr, "Error quoting message id %s: %s\n", - message_id, strerror (errno)); - return EXIT_FAILURE; - } - gzprintf (output, " -- %s\n", buffer); - } + if ((include & DUMP_INCLUDE_PROPERTIES) && + dump_properties_message (notmuch, message, output, + &buffer, &buffer_size)) + return EXIT_FAILURE; notmuch_message_destroy (message); } @@ -125,7 +276,8 @@ notmuch_database_dump (notmuch_database_t *notmuch, const char *output_file_name, const char *query_str, dump_format_t output_format, - notmuch_bool_t gzip_output) + dump_include_t include, + bool gzip_output) { gzFile output = NULL; const char *mode = gzip_output ? "w9" : "wT"; @@ -155,11 +307,11 @@ notmuch_database_dump (notmuch_database_t *notmuch, name_for_error, strerror (errno)); if (close (outfd)) fprintf (stderr, "Error closing %s during shutdown: %s\n", - name_for_error, strerror (errno)); + name_for_error, strerror (errno)); goto DONE; } - ret = database_dump_file (notmuch, output, query_str, output_format); + ret = database_dump_file (notmuch, output, query_str, output_format, include); if (ret) goto DONE; ret = gzflush (output, Z_FINISH); @@ -194,7 +346,7 @@ notmuch_database_dump (notmuch_database_t *notmuch, } } - DONE: + DONE: if (ret != EXIT_SUCCESS && output) (void) gzclose_w (output); @@ -215,26 +367,39 @@ notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]) NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much)) return EXIT_FAILURE; - char *output_file_name = NULL; + notmuch_exit_if_unmatched_db_uuid (notmuch); + + const char *output_file_name = NULL; int opt_index; int output_format = DUMP_FORMAT_BATCH_TAG; - notmuch_bool_t gzip_output = 0; + int include = 0; + bool 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_STRING, &output_file_name, "output", 'o', 0 }, - { NOTMUCH_OPT_BOOLEAN, &gzip_output, "gzip", 'z', 0 }, - { 0, 0, 0, 0, 0 } + { .opt_keyword = &output_format, .name = "format", .keywords = + (notmuch_keyword_t []){ { "sup", DUMP_FORMAT_SUP }, + { "batch-tag", DUMP_FORMAT_BATCH_TAG }, + { 0, 0 } } }, + { .opt_flags = &include, .name = "include", .keywords = + (notmuch_keyword_t []){ { "config", DUMP_INCLUDE_CONFIG }, + { "properties", DUMP_INCLUDE_PROPERTIES }, + { "tags", DUMP_INCLUDE_TAGS } } }, + { .opt_string = &output_file_name, .name = "output" }, + { .opt_bool = &gzip_output, .name = "gzip" }, + { .opt_inherit = notmuch_shared_options }, + { } }; opt_index = parse_arguments (argc, argv, options, 1); if (opt_index < 0) return EXIT_FAILURE; + notmuch_process_shared_options (argv[0]); + + if (include == 0) + include = DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_TAGS | DUMP_INCLUDE_PROPERTIES; + if (opt_index < argc) { query_str = query_string_from_args (notmuch, argc - opt_index, argv + opt_index); if (query_str == NULL) { @@ -244,7 +409,7 @@ notmuch_dump_command (notmuch_config_t *config, int argc, char *argv[]) } ret = notmuch_database_dump (notmuch, output_file_name, query_str, - output_format, gzip_output); + output_format, include, gzip_output); notmuch_database_destroy (notmuch);