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)))
62 /* Non-zero return indicates an error in retrieving the message,
63 * or in applying the tags. Missing messages are reported, but not
67 tag_message (unused (void *ctx),
68 notmuch_database_t *notmuch,
69 const char *message_id,
70 tag_op_list_t *tag_ops,
73 notmuch_status_t status;
74 notmuch_message_t *message = NULL;
77 status = notmuch_database_find_message (notmuch, message_id, &message);
79 fprintf (stderr, "Error applying tags to message %s: %s\n",
80 message_id, notmuch_status_to_string (status));
83 if (message == NULL) {
84 fprintf (stderr, "Warning: cannot apply tags to missing message: %s\n",
86 /* We consider this a non-fatal error. */
90 /* In order to detect missing messages, this check/optimization is
91 * intentionally done *after* first finding the message. */
92 if ((flags & TAG_FLAG_REMOVE_ALL) || tag_op_list_size (tag_ops))
93 ret = tag_op_list_apply (message, tag_ops, flags);
95 notmuch_message_destroy (message);
100 /* Sup dump output is one line per message. We match a sequence of
101 * non-space characters for the message-id, then one or more
102 * spaces, then a list of space-separated tags as a sequence of
103 * characters within literal '(' and ')'. */
106 parse_sup_line (void *ctx, char *line,
107 char **query_str, tag_op_list_t *tag_ops)
114 tag_op_list_reset (tag_ops);
116 chomp_newline (line);
118 /* Silently ignore blank lines */
119 if (line[0] == '\0') {
123 rerr = xregexec (®ex, line, 3, match, 0);
124 if (rerr == REG_NOMATCH) {
125 fprintf (stderr, "Warning: Ignoring invalid sup format line: %s\n",
130 *query_str = talloc_strndup_debug (ctx, line + match[1].rm_so,
131 match[1].rm_eo - match[1].rm_so);
133 file_tags = talloc_strndup_debug (ctx, line + match[2].rm_so,
134 match[2].rm_eo - match[2].rm_so);
136 char *tok = file_tags;
139 tag_op_list_reset (tag_ops);
141 while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {
143 if (*(tok + tok_len) != '\0') {
144 *(tok + tok_len) = '\0';
148 if (tag_op_list_append (tag_ops, tok, FALSE))
157 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[])
159 notmuch_database_t *notmuch;
160 notmuch_bool_t accumulate = FALSE;
161 tag_op_flag_t flags = 0;
162 tag_op_list_t *tag_ops;
164 char *input_file_name = NULL;
165 const char *name_for_error = NULL;
168 void *line_ctx = NULL;
174 int input_format = DUMP_FORMAT_AUTO;
176 if (notmuch_database_open (notmuch_config_get_database_path (config),
177 NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much))
180 if (notmuch_config_get_maildir_synchronize_flags (config))
181 flags |= TAG_FLAG_MAILDIR_SYNC;
183 notmuch_opt_desc_t options[] = {
184 { NOTMUCH_OPT_KEYWORD, &input_format, "format", 'f',
185 (notmuch_keyword_t []){ { "auto", DUMP_FORMAT_AUTO },
186 { "batch-tag", DUMP_FORMAT_BATCH_TAG },
187 { "sup", DUMP_FORMAT_SUP },
189 { NOTMUCH_OPT_KEYWORD_FLAGS, &include, "include", 'I',
190 (notmuch_keyword_t []){ { "config", DUMP_INCLUDE_CONFIG },
191 { "tags", DUMP_INCLUDE_TAGS} } },
193 { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 },
194 { NOTMUCH_OPT_BOOLEAN, &accumulate, "accumulate", 'a', 0 },
195 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
199 opt_index = parse_arguments (argc, argv, options, 1);
205 notmuch_process_shared_options (argv[0]);
206 notmuch_exit_if_unmatched_db_uuid (notmuch);
209 include = DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_TAGS;
212 name_for_error = input_file_name ? input_file_name : "stdin";
215 flags |= TAG_FLAG_REMOVE_ALL;
219 input = gzopen (input_file_name, "r");
221 int infd = dup (STDIN_FILENO);
223 fprintf (stderr, "Error duping stdin: %s\n",
228 input = gzdopen (infd, "r");
234 fprintf (stderr, "Error opening %s for (gzip) reading: %s\n",
235 name_for_error, strerror (errno));
240 if (opt_index < argc) {
241 fprintf (stderr, "Unused positional parameter: %s\n", argv[opt_index]);
246 tag_ops = tag_op_list_create (config);
247 if (tag_ops == NULL) {
248 fprintf (stderr, "Out of memory.\n");
254 util_status_t status;
256 status = gz_getline (line_ctx, &line, &line_len, input);
258 /* empty input file not considered an error */
259 if (status == UTIL_EOF) {
265 fprintf (stderr, "Error reading (gzipped) input: %s\n",
266 gz_error_string(status, input));
271 if ((include & DUMP_INCLUDE_CONFIG) && line_len >= 2 && line[0] == '#' && line[1] == '@') {
272 ret = process_config_line(notmuch, line+2);
277 } while ((line_len == 0) ||
279 /* the cast is safe because we checked about for line_len < 0 */
280 (strspn (line, " \t\n") == (unsigned)line_len));
282 if (! (include & DUMP_INCLUDE_TAGS)) {
288 for (p = line; (input_format == DUMP_FORMAT_AUTO) && *p; p++) {
290 input_format = DUMP_FORMAT_SUP;
293 if (input_format == DUMP_FORMAT_AUTO)
294 input_format = DUMP_FORMAT_BATCH_TAG;
296 if (input_format == DUMP_FORMAT_SUP)
297 if ( xregcomp (®ex,
298 "^([^ ]+) \\(([^)]*)\\)$",
300 INTERNAL_ERROR ("compile time constant regex failed.");
303 char *query_string, *prefix, *term;
305 if (line_ctx != NULL)
306 talloc_free (line_ctx);
308 line_ctx = talloc_new (config);
309 if (input_format == DUMP_FORMAT_SUP) {
310 ret = parse_sup_line (line_ctx, line, &query_string, tag_ops);
312 ret = parse_tag_line (line_ctx, line, TAG_FLAG_BE_GENEROUS,
313 &query_string, tag_ops);
316 ret = parse_boolean_term (line_ctx, query_string,
318 if (ret && errno == EINVAL) {
319 fprintf (stderr, "Warning: cannot parse query: %s (skipping)\n", query_string);
322 /* This is more fatal (e.g., out of memory) */
323 fprintf (stderr, "Error parsing query: %s\n",
327 } else if (strcmp ("id", prefix) != 0) {
328 fprintf (stderr, "Warning: not an id query: %s (skipping)\n", query_string);
341 ret = tag_message (line_ctx, notmuch, query_string,
346 } while (! (ret = gz_getline (line_ctx, &line, &line_len, input)));
349 /* EOF is normal loop termination condition, UTIL_SUCCESS is
351 if (ret == UTIL_EOF) {
354 fprintf (stderr, "Error reading (gzipped) input: %s\n",
355 gz_error_string (ret, input));
359 /* currently this should not be after DONE: since we don't
360 * know if the xregcomp was reached
363 if (input_format == DUMP_FORMAT_SUP)
367 if (line_ctx != NULL)
368 talloc_free (line_ctx);
371 notmuch_database_destroy (notmuch);
373 if (input && gzclose_r (input)) {
374 fprintf (stderr, "Error closing %s: %s\n",
375 name_for_error, gzerror (input, NULL));
379 return ret ? EXIT_FAILURE : EXIT_SUCCESS;