test: Test upgrade to ghost messages feature
[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 http://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 regex_t regex;
28
29 /* Non-zero return indicates an error in retrieving the message,
30  * or in applying the tags.  Missing messages are reported, but not
31  * considered errors.
32  */
33 static int
34 tag_message (unused (void *ctx),
35              notmuch_database_t *notmuch,
36              const char *message_id,
37              tag_op_list_t *tag_ops,
38              tag_op_flag_t flags)
39 {
40     notmuch_status_t status;
41     notmuch_message_t *message = NULL;
42     int ret = 0;
43
44     status = notmuch_database_find_message (notmuch, message_id, &message);
45     if (status) {
46         fprintf (stderr, "Error applying tags to message %s: %s\n",
47                  message_id, notmuch_status_to_string (status));
48         return 1;
49     }
50     if (message == NULL) {
51         fprintf (stderr, "Warning: cannot apply tags to missing message: %s\n",
52                  message_id);
53         /* We consider this a non-fatal error. */
54         return 0;
55     }
56
57     /* In order to detect missing messages, this check/optimization is
58      * intentionally done *after* first finding the message. */
59     if ((flags & TAG_FLAG_REMOVE_ALL) || tag_op_list_size (tag_ops))
60         ret = tag_op_list_apply (message, tag_ops, flags);
61
62     notmuch_message_destroy (message);
63
64     return ret;
65 }
66
67 /* Sup dump output is one line per message. We match a sequence of
68  * non-space characters for the message-id, then one or more
69  * spaces, then a list of space-separated tags as a sequence of
70  * characters within literal '(' and ')'. */
71
72 static int
73 parse_sup_line (void *ctx, char *line,
74                 char **query_str, tag_op_list_t *tag_ops)
75 {
76
77     regmatch_t match[3];
78     char *file_tags;
79     int rerr;
80
81     tag_op_list_reset (tag_ops);
82
83     chomp_newline (line);
84
85     /* Silently ignore blank lines */
86     if (line[0] == '\0') {
87         return 1;
88     }
89
90     rerr = xregexec (&regex, line, 3, match, 0);
91     if (rerr == REG_NOMATCH) {
92         fprintf (stderr, "Warning: Ignoring invalid sup format line: %s\n",
93                  line);
94         return 1;
95     }
96
97     *query_str = talloc_strndup_debug (ctx, line + match[1].rm_so,
98                                        match[1].rm_eo - match[1].rm_so);
99
100     file_tags = talloc_strndup_debug (ctx, line + match[2].rm_so,
101                                       match[2].rm_eo - match[2].rm_so);
102
103     char *tok = file_tags;
104     size_t tok_len = 0;
105
106     tag_op_list_reset (tag_ops);
107
108     while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {
109
110         if (*(tok + tok_len) != '\0') {
111             *(tok + tok_len) = '\0';
112             tok_len++;
113         }
114
115         if (tag_op_list_append (tag_ops, tok, FALSE))
116             return -1;
117     }
118
119     return 0;
120
121 }
122
123 int
124 notmuch_restore_command (notmuch_config_t *config, int argc, char *argv[])
125 {
126     notmuch_database_t *notmuch;
127     notmuch_bool_t accumulate = FALSE;
128     tag_op_flag_t flags = 0;
129     tag_op_list_t *tag_ops;
130
131     char *input_file_name = NULL;
132     const char *name_for_error = NULL;
133     gzFile input = NULL;
134     char *line = NULL;
135     void *line_ctx = NULL;
136     ssize_t line_len;
137
138     int ret = 0;
139     int opt_index;
140     int input_format = DUMP_FORMAT_AUTO;
141
142     if (notmuch_database_open (notmuch_config_get_database_path (config),
143                                NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
144         return EXIT_FAILURE;
145
146     if (notmuch_config_get_maildir_synchronize_flags (config))
147         flags |= TAG_FLAG_MAILDIR_SYNC;
148
149     notmuch_opt_desc_t options[] = {
150         { NOTMUCH_OPT_KEYWORD, &input_format, "format", 'f',
151           (notmuch_keyword_t []){ { "auto", DUMP_FORMAT_AUTO },
152                                   { "batch-tag", DUMP_FORMAT_BATCH_TAG },
153                                   { "sup", DUMP_FORMAT_SUP },
154                                   { 0, 0 } } },
155         { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 },
156         { NOTMUCH_OPT_BOOLEAN,  &accumulate, "accumulate", 'a', 0 },
157         { 0, 0, 0, 0, 0 }
158     };
159
160     opt_index = parse_arguments (argc, argv, options, 1);
161     if (opt_index < 0) {
162         ret = EXIT_FAILURE;
163         goto DONE;
164     }
165
166     name_for_error = input_file_name ? input_file_name : "stdin";
167
168     if (! accumulate)
169         flags |= TAG_FLAG_REMOVE_ALL;
170
171     errno = 0;
172     if (input_file_name)
173         input = gzopen (input_file_name, "r");
174     else {
175         int infd = dup (STDIN_FILENO);
176         if (infd < 0) {
177             fprintf (stderr, "Error duping stdin: %s\n",
178                      strerror (errno));
179             ret = EXIT_FAILURE;
180             goto DONE;
181         }
182         input = gzdopen (infd, "r");
183         if (! input)
184             close (infd);
185     }
186
187     if (input == NULL) {
188         fprintf (stderr, "Error opening %s for (gzip) reading: %s\n",
189                  name_for_error, strerror (errno));
190         ret = EXIT_FAILURE;
191         goto DONE;
192     }
193
194     if (opt_index < argc) {
195         fprintf (stderr, "Unused positional parameter: %s\n", argv[opt_index]);
196         ret = EXIT_FAILURE;
197         goto DONE;
198     }
199
200     tag_ops = tag_op_list_create (config);
201     if (tag_ops == NULL) {
202         fprintf (stderr, "Out of memory.\n");
203         ret = EXIT_FAILURE;
204         goto DONE;
205     }
206
207     do {
208         util_status_t status;
209
210         status = gz_getline (line_ctx, &line, &line_len, input);
211
212         /* empty input file not considered an error */
213         if (status == UTIL_EOF) {
214             ret = EXIT_SUCCESS;
215             goto DONE;
216         }
217
218         if (status) {
219             fprintf (stderr, "Error reading (gzipped) input: %s\n",
220                      gz_error_string(status, input));
221             ret = EXIT_FAILURE;
222             goto DONE;
223         }
224     } while ((line_len == 0) ||
225              (line[0] == '#') ||
226              /* the cast is safe because we checked about for line_len < 0 */
227              (strspn (line, " \t\n") == (unsigned)line_len));
228
229     char *p;
230     for (p = line; (input_format == DUMP_FORMAT_AUTO) && *p; p++) {
231         if (*p == '(')
232             input_format = DUMP_FORMAT_SUP;
233     }
234
235     if (input_format == DUMP_FORMAT_AUTO)
236         input_format = DUMP_FORMAT_BATCH_TAG;
237
238     if (input_format == DUMP_FORMAT_SUP)
239         if ( xregcomp (&regex,
240                        "^([^ ]+) \\(([^)]*)\\)$",
241                        REG_EXTENDED) )
242             INTERNAL_ERROR ("compile time constant regex failed.");
243
244     do {
245         char *query_string, *prefix, *term;
246
247         if (line_ctx != NULL)
248             talloc_free (line_ctx);
249
250         line_ctx = talloc_new (config);
251         if (input_format == DUMP_FORMAT_SUP) {
252             ret = parse_sup_line (line_ctx, line, &query_string, tag_ops);
253         } else {
254             ret = parse_tag_line (line_ctx, line, TAG_FLAG_BE_GENEROUS,
255                                   &query_string, tag_ops);
256
257             if (ret == 0) {
258                 ret = parse_boolean_term (line_ctx, query_string,
259                                           &prefix, &term);
260                 if (ret && errno == EINVAL) {
261                     fprintf (stderr, "Warning: cannot parse query: %s (skipping)\n", query_string);
262                     continue;
263                 } else if (ret) {
264                     /* This is more fatal (e.g., out of memory) */
265                     fprintf (stderr, "Error parsing query: %s\n",
266                              strerror (errno));
267                     ret = 1;
268                     break;
269                 } else if (strcmp ("id", prefix) != 0) {
270                     fprintf (stderr, "Warning: not an id query: %s (skipping)\n", query_string);
271                     continue;
272                 }
273                 query_string = term;
274             }
275         }
276
277         if (ret > 0)
278             continue;
279
280         if (ret < 0)
281             break;
282
283         ret = tag_message (line_ctx, notmuch, query_string,
284                            tag_ops, flags);
285         if (ret)
286             break;
287
288     }  while (! (ret = gz_getline (line_ctx, &line, &line_len, input)));
289     
290
291     /* EOF is normal loop termination condition, UTIL_SUCCESS is
292      * impossible here */
293     if (ret == UTIL_EOF) {
294         ret = EXIT_SUCCESS;
295     } else {
296         fprintf (stderr, "Error reading (gzipped) input: %s\n",
297                  gz_error_string (ret, input));
298         ret = EXIT_FAILURE;
299     }
300
301     /* currently this should not be after DONE: since we don't 
302      * know if the xregcomp was reached
303      */
304
305     if (input_format == DUMP_FORMAT_SUP)
306         regfree (&regex);
307
308  DONE:
309     if (line_ctx != NULL)
310         talloc_free (line_ctx);
311
312     if (notmuch)
313         notmuch_database_destroy (notmuch);
314
315     if (input && gzclose_r (input)) {
316         fprintf (stderr, "Error closing %s: %s\n",
317                  name_for_error, gzerror (input, NULL));
318         ret = EXIT_FAILURE;
319     }
320
321     return ret ? EXIT_FAILURE : EXIT_SUCCESS;
322 }