test: add known broken for n_m_get_flag on closed db
[notmuch] / notmuch-restore.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
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.
9  *
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.
14  *
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/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #include "notmuch-client.h"
22 #include "hex-escape.h"
23 #include "tag-util.h"
24 #include "string-util.h"
25 #include "zlib-extra.h"
26
27 static int
28 process_config_line (notmuch_database_t *notmuch, const char *line)
29 {
30     const char *key_p, *val_p;
31     char *key, *val;
32     size_t key_len, val_len;
33     const char *delim = " \t\n";
34     int ret = EXIT_FAILURE;
35
36     void *local = talloc_new (NULL);
37
38     key_p = strtok_len_c (line, delim, &key_len);
39     val_p = strtok_len_c (key_p + key_len, delim, &val_len);
40
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);
46         goto DONE;
47     }
48
49     if (print_status_database ("notmuch restore", notmuch,
50                                notmuch_database_set_config (notmuch, key, val)))
51         goto DONE;
52
53     ret = EXIT_SUCCESS;
54
55   DONE:
56     talloc_free (local);
57     return ret;
58 }
59
60 static int
61 process_properties_line (notmuch_database_t *notmuch, const char *line)
62 {
63     const char *id_p, *tok;
64     size_t id_len = 0, tok_len = 0;
65     char *id;
66
67     notmuch_message_t *message = NULL;
68     const char *delim = " \t\n";
69     int ret = EXIT_FAILURE;
70
71     void *local = talloc_new (NULL);
72
73     id_p = strtok_len_c (line, delim, &id_len);
74     id = talloc_strndup (local, id_p, id_len);
75     if (hex_decode_inplace (id) != HEX_SUCCESS) {
76         fprintf (stderr, "hex decoding failure on line %s\n", line);
77         goto DONE;
78     }
79
80     if (print_status_database ("notmuch restore", notmuch,
81                                notmuch_database_find_message (notmuch, id, &message)))
82         goto DONE;
83
84     if (print_status_database ("notmuch restore", notmuch,
85                                notmuch_message_remove_all_properties (message, NULL)))
86         goto DONE;
87
88     tok = id_p + id_len;
89
90     while ((tok = strtok_len_c (tok + tok_len, delim, &tok_len)) != NULL) {
91         char *key, *value;
92         size_t off = strcspn (tok, "=");
93         if (off > tok_len) {
94             fprintf (stderr, "unparsable token %s\n", tok);
95             goto DONE;
96         }
97
98         key = talloc_strndup (local, tok, off);
99         value = talloc_strndup (local, tok + off + 1, tok_len - off - 1);
100
101         if (hex_decode_inplace (key) != HEX_SUCCESS) {
102             fprintf (stderr, "hex decoding failure on key %s\n", key);
103             goto DONE;
104         }
105
106         if (hex_decode_inplace (value) != HEX_SUCCESS) {
107             fprintf (stderr, "hex decoding failure on value %s\n", value);
108             goto DONE;
109         }
110
111         if (print_status_database ("notmuch restore", notmuch,
112                                    notmuch_message_add_property (message, key, value)))
113             goto DONE;
114
115     }
116
117     ret = EXIT_SUCCESS;
118
119   DONE:
120     talloc_free (local);
121     return ret;
122 }
123
124
125 static regex_t regex;
126
127 /* Non-zero return indicates an error in retrieving the message,
128  * or in applying the tags.  Missing messages are reported, but not
129  * considered errors.
130  */
131 static int
132 tag_message (unused (void *ctx),
133              notmuch_database_t *notmuch,
134              const char *message_id,
135              tag_op_list_t *tag_ops,
136              tag_op_flag_t flags)
137 {
138     notmuch_status_t status;
139     notmuch_message_t *message = NULL;
140     int ret = 0;
141
142     status = notmuch_database_find_message (notmuch, message_id, &message);
143     if (status) {
144         fprintf (stderr, "Error applying tags to message %s: %s\n",
145                  message_id, notmuch_status_to_string (status));
146         return 1;
147     }
148     if (message == NULL) {
149         fprintf (stderr, "Warning: cannot apply tags to missing message: %s\n",
150                  message_id);
151         /* We consider this a non-fatal error. */
152         return 0;
153     }
154
155     /* In order to detect missing messages, this check/optimization is
156      * intentionally done *after* first finding the message. */
157     if ((flags & TAG_FLAG_REMOVE_ALL) || tag_op_list_size (tag_ops))
158         ret = tag_op_list_apply (message, tag_ops, flags);
159
160     notmuch_message_destroy (message);
161
162     return ret;
163 }
164
165 /* Sup dump output is one line per message. We match a sequence of
166  * non-space characters for the message-id, then one or more
167  * spaces, then a list of space-separated tags as a sequence of
168  * characters within literal '(' and ')'. */
169
170 static int
171 parse_sup_line (void *ctx, char *line,
172                 char **query_str, tag_op_list_t *tag_ops)
173 {
174
175     regmatch_t match[3];
176     char *file_tags;
177     int rerr;
178
179     tag_op_list_reset (tag_ops);
180
181     chomp_newline (line);
182
183     /* Silently ignore blank lines */
184     if (line[0] == '\0') {
185         return 1;
186     }
187
188     rerr = xregexec (&regex, line, 3, match, 0);
189     if (rerr == REG_NOMATCH) {
190         fprintf (stderr, "Warning: Ignoring invalid sup format line: %s\n",
191                  line);
192         return 1;
193     }
194
195     *query_str = talloc_strndup_debug (ctx, line + match[1].rm_so,
196                                        match[1].rm_eo - match[1].rm_so);
197
198     file_tags = talloc_strndup_debug (ctx, line + match[2].rm_so,
199                                       match[2].rm_eo - match[2].rm_so);
200
201     char *tok = file_tags;
202     size_t tok_len = 0;
203
204     tag_op_list_reset (tag_ops);
205
206     while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {
207
208         if (*(tok + tok_len) != '\0') {
209             *(tok + tok_len) = '\0';
210             tok_len++;
211         }
212
213         if (tag_op_list_append (tag_ops, tok, false))
214             return -1;
215     }
216
217     return 0;
218
219 }
220
221 int
222 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[])
223 {
224     notmuch_database_t *notmuch;
225     bool accumulate = false;
226     tag_op_flag_t flags = 0;
227     tag_op_list_t *tag_ops;
228
229     const char *input_file_name = NULL;
230     const char *name_for_error = NULL;
231     gzFile input = NULL;
232     char *line = NULL;
233     void *line_ctx = NULL;
234     ssize_t line_len;
235
236     int ret = 0;
237     int opt_index;
238     int include = 0;
239     int input_format = DUMP_FORMAT_AUTO;
240     int errnum;
241
242     if (notmuch_database_open (notmuch_config_get_database_path (config),
243                                NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
244         return EXIT_FAILURE;
245
246     if (notmuch_config_get_maildir_synchronize_flags (config))
247         flags |= TAG_FLAG_MAILDIR_SYNC;
248
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 },
254                                       { 0, 0 } } },
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 } } },
259
260         { .opt_string = &input_file_name, .name = "input" },
261         { .opt_bool = &accumulate, .name = "accumulate" },
262         { .opt_inherit = notmuch_shared_options },
263         { }
264     };
265
266     opt_index = parse_arguments (argc, argv, options, 1);
267     if (opt_index < 0) {
268         ret = EXIT_FAILURE;
269         goto DONE;
270     }
271
272     notmuch_process_shared_options (argv[0]);
273     notmuch_exit_if_unmatched_db_uuid (notmuch);
274
275     if (include == 0) {
276         include = DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_PROPERTIES | DUMP_INCLUDE_TAGS;
277     }
278
279     name_for_error = input_file_name ? input_file_name : "stdin";
280
281     if (! accumulate)
282         flags |= TAG_FLAG_REMOVE_ALL;
283
284     errno = 0;
285     if (input_file_name)
286         input = gzopen (input_file_name, "r");
287     else {
288         int infd = dup (STDIN_FILENO);
289         if (infd < 0) {
290             fprintf (stderr, "Error duping stdin: %s\n",
291                      strerror (errno));
292             ret = EXIT_FAILURE;
293             goto DONE;
294         }
295         input = gzdopen (infd, "r");
296         if (! input)
297             close (infd);
298     }
299
300     if (input == NULL) {
301         fprintf (stderr, "Error opening %s for (gzip) reading: %s\n",
302                  name_for_error, strerror (errno));
303         ret = EXIT_FAILURE;
304         goto DONE;
305     }
306
307     if (opt_index < argc) {
308         fprintf (stderr, "Unused positional parameter: %s\n", argv[opt_index]);
309         ret = EXIT_FAILURE;
310         goto DONE;
311     }
312
313     tag_ops = tag_op_list_create (config);
314     if (tag_ops == NULL) {
315         fprintf (stderr, "Out of memory.\n");
316         ret = EXIT_FAILURE;
317         goto DONE;
318     }
319
320     do {
321         util_status_t status;
322
323         status = gz_getline (line_ctx, &line, &line_len, input);
324
325         /* empty input file not considered an error */
326         if (status == UTIL_EOF) {
327             ret = EXIT_SUCCESS;
328             goto DONE;
329         }
330
331         if (status) {
332             fprintf (stderr, "Error reading (gzipped) input: %s\n",
333                      gz_error_string (status, input));
334             ret = EXIT_FAILURE;
335             goto DONE;
336         }
337
338         if ((include & DUMP_INCLUDE_CONFIG) && line_len >= 2 && line[0] == '#' && line[1] == '@') {
339             ret = process_config_line (notmuch, line + 2);
340             if (ret)
341                 goto DONE;
342         }
343         if ((include & DUMP_INCLUDE_PROPERTIES) && line_len >= 2 && line[0] == '#' && line[1] == '=') {
344             ret = process_properties_line (notmuch, line + 2);
345             if (ret)
346                 goto DONE;
347         }
348
349     } while ((line_len == 0) ||
350              (line[0] == '#') ||
351              /* the cast is safe because we checked about for line_len < 0 */
352              (strspn (line, " \t\n") == (unsigned) line_len));
353
354     if (! ((include & DUMP_INCLUDE_TAGS) || (include & DUMP_INCLUDE_PROPERTIES))) {
355         ret = EXIT_SUCCESS;
356         goto DONE;
357     }
358
359     char *p;
360     for (p = line; (input_format == DUMP_FORMAT_AUTO) && *p; p++) {
361         if (*p == '(')
362             input_format = DUMP_FORMAT_SUP;
363     }
364
365     if (input_format == DUMP_FORMAT_AUTO)
366         input_format = DUMP_FORMAT_BATCH_TAG;
367
368     if (input_format == DUMP_FORMAT_SUP)
369         if ( xregcomp (&regex,
370                        "^([^ ]+) \\(([^)]*)\\)$",
371                        REG_EXTENDED) )
372             INTERNAL_ERROR ("compile time constant regex failed.");
373
374     do {
375         char *query_string, *prefix, *term;
376
377         if (line_ctx != NULL)
378             talloc_free (line_ctx);
379
380         line_ctx = talloc_new (config);
381
382         if ((include & DUMP_INCLUDE_PROPERTIES) && line_len >= 2 && line[0] == '#' && line[1] == '=') {
383             ret = process_properties_line (notmuch, line + 2);
384             if (ret)
385                 goto DONE;
386         }
387
388         if (input_format == DUMP_FORMAT_SUP) {
389             ret = parse_sup_line (line_ctx, line, &query_string, tag_ops);
390         } else {
391             ret = parse_tag_line (line_ctx, line, TAG_FLAG_BE_GENEROUS,
392                                   &query_string, tag_ops);
393
394             if (ret == 0) {
395                 ret = parse_boolean_term (line_ctx, query_string,
396                                           &prefix, &term);
397                 if (ret && errno == EINVAL) {
398                     fprintf (stderr, "Warning: cannot parse query: %s (skipping)\n", query_string);
399                     continue;
400                 } else if (ret) {
401                     /* This is more fatal (e.g., out of memory) */
402                     fprintf (stderr, "Error parsing query: %s\n",
403                              strerror (errno));
404                     ret = 1;
405                     break;
406                 } else if (strcmp ("id", prefix) != 0) {
407                     fprintf (stderr, "Warning: not an id query: %s (skipping)\n", query_string);
408                     continue;
409                 }
410                 query_string = term;
411             }
412         }
413
414         if (ret > 0)
415             continue;
416
417         if (ret < 0)
418             break;
419
420         ret = tag_message (line_ctx, notmuch, query_string,
421                            tag_ops, flags);
422         if (ret)
423             break;
424
425     }  while (! (ret = gz_getline (line_ctx, &line, &line_len, input)));
426
427
428     /* EOF is normal loop termination condition, UTIL_SUCCESS is
429      * impossible here */
430     if (ret == UTIL_EOF) {
431         ret = EXIT_SUCCESS;
432     } else {
433         fprintf (stderr, "Error reading (gzipped) input: %s\n",
434                  gz_error_string (ret, input));
435         ret = EXIT_FAILURE;
436     }
437
438     /* currently this should not be after DONE: since we don't
439      * know if the xregcomp was reached
440      */
441
442     if (input_format == DUMP_FORMAT_SUP)
443         regfree (&regex);
444
445   DONE:
446     if (line_ctx != NULL)
447         talloc_free (line_ctx);
448
449     if (notmuch)
450         notmuch_database_destroy (notmuch);
451
452     if (input) {
453         errnum = gzclose_r (input);
454         if (errnum) {
455             fprintf (stderr, "Error closing %s: %d\n",
456                      name_for_error, errnum);
457             ret = EXIT_FAILURE;
458         }
459     }
460
461     return ret ? EXIT_FAILURE : EXIT_SUCCESS;
462 }