1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
22 #include "hex-escape.h"
24 #include "string-util.h"
25 #include "zlib-extra.h"
28 process_config_line (notmuch_database_t *notmuch, const char* line)
30 const char *key_p, *val_p;
32 size_t key_len,val_len;
33 const char *delim = " \t\n";
34 int ret = EXIT_FAILURE;
36 void *local = talloc_new(NULL);
38 key_p = strtok_len_c (line, delim, &key_len);
39 val_p = strtok_len_c (key_p+key_len, delim, &val_len);
41 key = talloc_strndup (local, key_p, key_len);
42 val = talloc_strndup (local, val_p, val_len);
43 if (hex_decode_inplace (key) != HEX_SUCCESS ||
44 hex_decode_inplace (val) != HEX_SUCCESS ) {
45 fprintf (stderr, "hex decoding failure on line %s\n", line);
49 if (print_status_database ("notmuch restore", notmuch,
50 notmuch_database_set_config (notmuch, key, val)))
61 process_properties_line (notmuch_database_t *notmuch, const char* line)
64 const char *id_p, *tok;
65 size_t id_len = 0, tok_len = 0;
68 notmuch_message_t *message = NULL;
69 const char *delim = " \t\n";
70 int ret = EXIT_FAILURE;
72 void *local = talloc_new (NULL);
74 id_p = strtok_len_c (line, delim, &id_len);
75 id = talloc_strndup (local, id_p, id_len);
76 if (hex_decode_inplace (id) != HEX_SUCCESS) {
77 fprintf (stderr, "hex decoding failure on line %s\n", line);
81 if (print_status_database ("notmuch restore", notmuch,
82 notmuch_database_find_message (notmuch, id, &message)))
85 if (print_status_database ("notmuch restore", notmuch,
86 notmuch_message_remove_all_properties (message, NULL)))
91 while ((tok = strtok_len_c (tok + tok_len, delim, &tok_len)) != NULL) {
93 size_t off = strcspn (tok, "=");
95 fprintf (stderr, "unparsable token %s\n", tok);
99 key = talloc_strndup (local, tok, off);
100 value = talloc_strndup (local, tok + off + 1, tok_len - off - 1);
102 if (hex_decode_inplace (key) != HEX_SUCCESS) {
103 fprintf (stderr, "hex decoding failure on key %s\n", key);
107 if (hex_decode_inplace (value) != HEX_SUCCESS) {
108 fprintf (stderr, "hex decoding failure on value %s\n", value);
112 if (print_status_database ("notmuch restore", notmuch,
113 notmuch_message_add_property (message, key, value)))
126 static regex_t regex;
128 /* Non-zero return indicates an error in retrieving the message,
129 * or in applying the tags. Missing messages are reported, but not
133 tag_message (unused (void *ctx),
134 notmuch_database_t *notmuch,
135 const char *message_id,
136 tag_op_list_t *tag_ops,
139 notmuch_status_t status;
140 notmuch_message_t *message = NULL;
143 status = notmuch_database_find_message (notmuch, message_id, &message);
145 fprintf (stderr, "Error applying tags to message %s: %s\n",
146 message_id, notmuch_status_to_string (status));
149 if (message == NULL) {
150 fprintf (stderr, "Warning: cannot apply tags to missing message: %s\n",
152 /* We consider this a non-fatal error. */
156 /* In order to detect missing messages, this check/optimization is
157 * intentionally done *after* first finding the message. */
158 if ((flags & TAG_FLAG_REMOVE_ALL) || tag_op_list_size (tag_ops))
159 ret = tag_op_list_apply (message, tag_ops, flags);
161 notmuch_message_destroy (message);
166 /* Sup dump output is one line per message. We match a sequence of
167 * non-space characters for the message-id, then one or more
168 * spaces, then a list of space-separated tags as a sequence of
169 * characters within literal '(' and ')'. */
172 parse_sup_line (void *ctx, char *line,
173 char **query_str, tag_op_list_t *tag_ops)
180 tag_op_list_reset (tag_ops);
182 chomp_newline (line);
184 /* Silently ignore blank lines */
185 if (line[0] == '\0') {
189 rerr = xregexec (®ex, line, 3, match, 0);
190 if (rerr == REG_NOMATCH) {
191 fprintf (stderr, "Warning: Ignoring invalid sup format line: %s\n",
196 *query_str = talloc_strndup_debug (ctx, line + match[1].rm_so,
197 match[1].rm_eo - match[1].rm_so);
199 file_tags = talloc_strndup_debug (ctx, line + match[2].rm_so,
200 match[2].rm_eo - match[2].rm_so);
202 char *tok = file_tags;
205 tag_op_list_reset (tag_ops);
207 while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {
209 if (*(tok + tok_len) != '\0') {
210 *(tok + tok_len) = '\0';
214 if (tag_op_list_append (tag_ops, tok, false))
223 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[])
225 notmuch_database_t *notmuch;
226 bool accumulate = false;
227 tag_op_flag_t flags = 0;
228 tag_op_list_t *tag_ops;
230 const char *input_file_name = NULL;
231 const char *name_for_error = NULL;
234 void *line_ctx = NULL;
240 int input_format = DUMP_FORMAT_AUTO;
242 if (notmuch_database_open (notmuch_config_get_database_path (config),
243 NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much))
246 if (notmuch_config_get_maildir_synchronize_flags (config))
247 flags |= TAG_FLAG_MAILDIR_SYNC;
249 notmuch_opt_desc_t options[] = {
250 { .opt_keyword = &input_format, .name = "format", .keywords =
251 (notmuch_keyword_t []){ { "auto", DUMP_FORMAT_AUTO },
252 { "batch-tag", DUMP_FORMAT_BATCH_TAG },
253 { "sup", DUMP_FORMAT_SUP },
255 { .opt_flags = &include, .name = "include", .keywords =
256 (notmuch_keyword_t []){ { "config", DUMP_INCLUDE_CONFIG },
257 { "properties", DUMP_INCLUDE_PROPERTIES },
258 { "tags", DUMP_INCLUDE_TAGS} } },
260 { .opt_string = &input_file_name, .name = "input" },
261 { .opt_bool = &accumulate, .name = "accumulate" },
262 { .opt_inherit = notmuch_shared_options },
266 opt_index = parse_arguments (argc, argv, options, 1);
272 notmuch_process_shared_options (argv[0]);
273 notmuch_exit_if_unmatched_db_uuid (notmuch);
276 include = DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES | DUMP_INCLUDE_TAGS;
279 name_for_error = input_file_name ? input_file_name : "stdin";
282 flags |= TAG_FLAG_REMOVE_ALL;
286 input = gzopen (input_file_name, "r");
288 int infd = dup (STDIN_FILENO);
290 fprintf (stderr, "Error duping stdin: %s\n",
295 input = gzdopen (infd, "r");
301 fprintf (stderr, "Error opening %s for (gzip) reading: %s\n",
302 name_for_error, strerror (errno));
307 if (opt_index < argc) {
308 fprintf (stderr, "Unused positional parameter: %s\n", argv[opt_index]);
313 tag_ops = tag_op_list_create (config);
314 if (tag_ops == NULL) {
315 fprintf (stderr, "Out of memory.\n");
321 util_status_t status;
323 status = gz_getline (line_ctx, &line, &line_len, input);
325 /* empty input file not considered an error */
326 if (status == UTIL_EOF) {
332 fprintf (stderr, "Error reading (gzipped) input: %s\n",
333 gz_error_string(status, input));
338 if ((include & DUMP_INCLUDE_CONFIG) && line_len >= 2 && line[0] == '#' && line[1] == '@') {
339 ret = process_config_line(notmuch, line+2);
343 if ((include & DUMP_INCLUDE_PROPERTIES) && line_len >= 2 && line[0] == '#' && line[1] == '=') {
344 ret = process_properties_line (notmuch, line + 2);
349 } while ((line_len == 0) ||
351 /* the cast is safe because we checked about for line_len < 0 */
352 (strspn (line, " \t\n") == (unsigned)line_len));
354 if (! ((include & DUMP_INCLUDE_TAGS) || (include & DUMP_INCLUDE_PROPERTIES))) {
360 for (p = line; (input_format == DUMP_FORMAT_AUTO) && *p; p++) {
362 input_format = DUMP_FORMAT_SUP;
365 if (input_format == DUMP_FORMAT_AUTO)
366 input_format = DUMP_FORMAT_BATCH_TAG;
368 if (input_format == DUMP_FORMAT_SUP)
369 if ( xregcomp (®ex,
370 "^([^ ]+) \\(([^)]*)\\)$",
372 INTERNAL_ERROR ("compile time constant regex failed.");
375 char *query_string, *prefix, *term;
377 if (line_ctx != NULL)
378 talloc_free (line_ctx);
380 line_ctx = talloc_new (config);
382 if ((include & DUMP_INCLUDE_PROPERTIES) && line_len >= 2 && line[0] == '#' && line[1] == '=') {
383 ret = process_properties_line (notmuch, line + 2);
388 if (input_format == DUMP_FORMAT_SUP) {
389 ret = parse_sup_line (line_ctx, line, &query_string, tag_ops);
391 ret = parse_tag_line (line_ctx, line, TAG_FLAG_BE_GENEROUS,
392 &query_string, tag_ops);
395 ret = parse_boolean_term (line_ctx, query_string,
397 if (ret && errno == EINVAL) {
398 fprintf (stderr, "Warning: cannot parse query: %s (skipping)\n", query_string);
401 /* This is more fatal (e.g., out of memory) */
402 fprintf (stderr, "Error parsing query: %s\n",
406 } else if (strcmp ("id", prefix) != 0) {
407 fprintf (stderr, "Warning: not an id query: %s (skipping)\n", query_string);
420 ret = tag_message (line_ctx, notmuch, query_string,
425 } while (! (ret = gz_getline (line_ctx, &line, &line_len, input)));
428 /* EOF is normal loop termination condition, UTIL_SUCCESS is
430 if (ret == UTIL_EOF) {
433 fprintf (stderr, "Error reading (gzipped) input: %s\n",
434 gz_error_string (ret, input));
438 /* currently this should not be after DONE: since we don't
439 * know if the xregcomp was reached
442 if (input_format == DUMP_FORMAT_SUP)
446 if (line_ctx != NULL)
447 talloc_free (line_ctx);
450 notmuch_database_destroy (notmuch);
452 if (input && gzclose_r (input)) {
453 fprintf (stderr, "Error closing %s: %s\n",
454 name_for_error, gzerror (input, NULL));
458 return ret ? EXIT_FAILURE : EXIT_SUCCESS;