]> git.notmuchmail.org Git - notmuch/blob - notmuch-restore.c
notmuch-restore: handle empty input file, leading blank lines and comments.
[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 "dump-restore-private.h"
23 #include "tag-util.h"
24 #include "string-util.h"
25
26 static regex_t regex;
27
28 /* Non-zero return indicates an error in retrieving the message,
29  * or in applying the tags.
30  */
31 static int
32 tag_message (unused (void *ctx),
33              notmuch_database_t *notmuch,
34              const char *message_id,
35              tag_op_list_t *tag_ops,
36              tag_op_flag_t flags)
37 {
38     notmuch_status_t status;
39     notmuch_message_t *message = NULL;
40     int ret = 0;
41
42     status = notmuch_database_find_message (notmuch, message_id, &message);
43     if (status || message == NULL) {
44         fprintf (stderr, "Warning: cannot apply tags to %smessage: %s\n",
45                  message ? "" : "missing ", message_id);
46         if (status)
47             fprintf (stderr, "%s\n", notmuch_status_to_string (status));
48         return 1;
49     }
50
51     /* In order to detect missing messages, this check/optimization is
52      * intentionally done *after* first finding the message. */
53     if ((flags & TAG_FLAG_REMOVE_ALL) || tag_op_list_size (tag_ops))
54         ret = tag_op_list_apply (message, tag_ops, flags);
55
56     notmuch_message_destroy (message);
57
58     return ret;
59 }
60
61 /* Sup dump output is one line per message. We match a sequence of
62  * non-space characters for the message-id, then one or more
63  * spaces, then a list of space-separated tags as a sequence of
64  * characters within literal '(' and ')'. */
65
66 static int
67 parse_sup_line (void *ctx, char *line,
68                 char **query_str, tag_op_list_t *tag_ops)
69 {
70
71     regmatch_t match[3];
72     char *file_tags;
73     int rerr;
74
75     tag_op_list_reset (tag_ops);
76
77     chomp_newline (line);
78
79     /* Silently ignore blank lines */
80     if (line[0] == '\0') {
81         return 1;
82     }
83
84     rerr = xregexec (&regex, line, 3, match, 0);
85     if (rerr == REG_NOMATCH) {
86         fprintf (stderr, "Warning: Ignoring invalid sup format line: %s\n",
87                  line);
88         return 1;
89     }
90
91     *query_str = talloc_strndup_debug (ctx, line + match[1].rm_so,
92                                        match[1].rm_eo - match[1].rm_so);
93
94     file_tags = talloc_strndup_debug (ctx, line + match[2].rm_so,
95                                       match[2].rm_eo - match[2].rm_so);
96
97     char *tok = file_tags;
98     size_t tok_len = 0;
99
100     tag_op_list_reset (tag_ops);
101
102     while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {
103
104         if (*(tok + tok_len) != '\0') {
105             *(tok + tok_len) = '\0';
106             tok_len++;
107         }
108
109         if (tag_op_list_append (tag_ops, tok, FALSE))
110             return -1;
111     }
112
113     return 0;
114
115 }
116
117 int
118 notmuch_restore_command (unused (void *ctx), int argc, char *argv[])
119 {
120     notmuch_config_t *config;
121     notmuch_database_t *notmuch;
122     notmuch_bool_t accumulate = FALSE;
123     tag_op_flag_t flags = 0;
124     tag_op_list_t *tag_ops;
125
126     char *input_file_name = NULL;
127     FILE *input = stdin;
128     char *line = NULL;
129     void *line_ctx = NULL;
130     size_t line_size;
131     ssize_t line_len;
132
133     int ret = 0;
134     int opt_index;
135     int input_format = DUMP_FORMAT_AUTO;
136
137     config = notmuch_config_open (ctx, NULL, NULL);
138     if (config == NULL)
139         return 1;
140
141     if (notmuch_database_open (notmuch_config_get_database_path (config),
142                                NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
143         return 1;
144
145     if (notmuch_config_get_maildir_synchronize_flags (config))
146         flags |= TAG_FLAG_MAILDIR_SYNC;
147
148     notmuch_opt_desc_t options[] = {
149         { NOTMUCH_OPT_KEYWORD, &input_format, "format", 'f',
150           (notmuch_keyword_t []){ { "auto", DUMP_FORMAT_AUTO },
151                                   { "batch-tag", DUMP_FORMAT_BATCH_TAG },
152                                   { "sup", DUMP_FORMAT_SUP },
153                                   { 0, 0 } } },
154         { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 },
155         { NOTMUCH_OPT_BOOLEAN,  &accumulate, "accumulate", 'a', 0 },
156         { 0, 0, 0, 0, 0 }
157     };
158
159     opt_index = parse_arguments (argc, argv, options, 1);
160
161     if (opt_index < 0) {
162         /* diagnostics already printed */
163         return 1;
164     }
165
166     if (! accumulate)
167         flags |= TAG_FLAG_REMOVE_ALL;
168
169     if (input_file_name) {
170         input = fopen (input_file_name, "r");
171         if (input == NULL) {
172             fprintf (stderr, "Error opening %s for reading: %s\n",
173                      input_file_name, strerror (errno));
174             return 1;
175         }
176     }
177
178     if (opt_index < argc) {
179         fprintf (stderr,
180                  "Unused positional parameter: %s\n",
181                  argv[opt_index]);
182         return 1;
183     }
184
185     tag_ops = tag_op_list_create (ctx);
186     if (tag_ops == NULL) {
187         fprintf (stderr, "Out of memory.\n");
188         return 1;
189     }
190
191     do {
192         line_len = getline (&line, &line_size, input);
193
194         /* empty input file not considered an error */
195         if (line_len < 0)
196             return 0;
197
198     } while ((line_len == 0) ||
199              (line[0] == '#') ||
200              /* the cast is safe because we checked about for line_len < 0 */
201              (strspn (line, " \t\n") == (unsigned)line_len));
202
203     char *p;
204     for (p = line; (input_format == DUMP_FORMAT_AUTO) && *p; p++) {
205         if (*p == '(')
206             input_format = DUMP_FORMAT_SUP;
207     }
208
209     if (input_format == DUMP_FORMAT_AUTO)
210         input_format = DUMP_FORMAT_BATCH_TAG;
211
212     if (input_format == DUMP_FORMAT_SUP)
213         if ( xregcomp (&regex,
214                        "^([^ ]+) \\(([^)]*)\\)$",
215                        REG_EXTENDED) )
216             INTERNAL_ERROR ("compile time constant regex failed.");
217
218     do {
219         char *query_string;
220
221         if (line_ctx != NULL)
222             talloc_free (line_ctx);
223
224         line_ctx = talloc_new (ctx);
225         if (input_format == DUMP_FORMAT_SUP) {
226             ret = parse_sup_line (line_ctx, line, &query_string, tag_ops);
227         } else {
228             ret = parse_tag_line (line_ctx, line, TAG_FLAG_BE_GENEROUS,
229                                   &query_string, tag_ops);
230
231             if (ret == 0) {
232                 if (strncmp ("id:", query_string, 3) != 0) {
233                     fprintf (stderr, "Warning: unsupported query: %s\n", query_string);
234                     continue;
235                 }
236                 /* delete id: from front of string; tag_message
237                  * expects a raw message-id.
238                  *
239                  * XXX: Note that query string id:foo and bar will be
240                  * interpreted as a message id "foo and bar". This
241                  * should eventually be fixed to give a better error
242                  * message.
243                  */
244                 query_string = query_string + 3;
245             }
246         }
247
248         if (ret > 0)
249             continue;
250
251         if (ret < 0)
252             break;
253
254         ret = tag_message (line_ctx, notmuch, query_string,
255                            tag_ops, flags);
256         if (ret)
257             break;
258
259     }  while ((line_len = getline (&line, &line_size, input)) != -1);
260
261     if (line_ctx != NULL)
262         talloc_free (line_ctx);
263
264     if (input_format == DUMP_FORMAT_SUP)
265         regfree (&regex);
266
267     if (line)
268         free (line);
269
270     notmuch_database_destroy (notmuch);
271
272     if (input != stdin)
273         fclose (input);
274
275     return ret;
276 }