1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
| | /* notmuch - Not much of an email program, (just index and search)
*
* Copyright © 2009 Carl Worth
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see https://www.gnu.org/licenses/ .
*
* Author: Carl Worth <cworth@cworth.org>
*/
#include "notmuch-client.h"
#include "hex-escape.h"
#include "string-util.h"
#include "zlib-extra.h"
static int
database_dump_config (notmuch_database_t *notmuch, gzFile output)
{
notmuch_config_list_t *list;
int ret = EXIT_FAILURE;
char *buffer = NULL;
size_t buffer_size = 0;
if (print_status_database ("notmuch dump", notmuch,
notmuch_database_get_config_list (notmuch, NULL, &list)))
goto DONE;
for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
if (hex_encode (notmuch, notmuch_config_list_key (list),
&buffer, &buffer_size) != HEX_SUCCESS) {
fprintf (stderr, "Error: failed to hex-encode config key %s\n",
notmuch_config_list_key (list));
goto DONE;
}
GZPRINTF (output, "#@ %s", buffer);
if (hex_encode (notmuch, notmuch_config_list_value (list),
&buffer, &buffer_size) != HEX_SUCCESS) {
fprintf (stderr, "Error: failed to hex-encode config value %s\n",
notmuch_config_list_value (list) );
goto DONE;
}
GZPUTS (output, " ");
GZPUTS (output, buffer);
GZPUTS (output, "\n");
}
ret = EXIT_SUCCESS;
DONE:
if (list)
notmuch_config_list_destroy (list);
if (buffer)
talloc_free (buffer);
return ret;
}
static void
print_dump_header (gzFile output, int output_format, int include)
{
const char *sep = "";
GZPRINTF (output, "#notmuch-dump %s:%d ",
(output_format == DUMP_FORMAT_SUP) ? "sup" : "batch-tag",
NOTMUCH_DUMP_VERSION);
if (include & DUMP_INCLUDE_CONFIG) {
GZPUTS (output, "config");
sep = ",";
}
if (include & DUMP_INCLUDE_PROPERTIES) {
GZPRINTF (output, "%sproperties", sep);
sep = ",";
}
if (include & DUMP_INCLUDE_TAGS) {
GZPRINTF (output, "%stags", sep);
}
GZPUTS (output, "\n");
}
static int
dump_properties_message (void *ctx,
notmuch_message_t *message,
gzFile output,
char **buffer_p, size_t *size_p)
{
const char *message_id;
notmuch_message_properties_t *list;
bool first = true;
message_id = notmuch_message_get_message_id (message);
if (strchr (message_id, '\n')) {
fprintf (stderr, "Warning: skipping message id containing line break: \"%s\"\n", message_id);
return 0;
}
for (list = notmuch_message_get_properties (message, "", false);
notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
const char *key, *val;
if (first) {
if (hex_encode (ctx, message_id, buffer_p, size_p) != HEX_SUCCESS) {
fprintf (stderr, "Error: failed to hex-encode message-id %s\n", message_id);
return 1;
}
GZPRINTF (output, "#= %s", *buffer_p);
first = false;
}
key = notmuch_message_properties_key (list);
val = notmuch_message_properties_value (list);
if (hex_encode (ctx, key, buffer_p, size_p) != HEX_SUCCESS) {
fprintf (stderr, "Error: failed to hex-encode key %s\n", key);
return 1;
}
GZPRINTF (output, " %s", *buffer_p);
if (hex_encode (ctx, val, buffer_p, size_p) != HEX_SUCCESS) {
fprintf (stderr, "Error: failed to hex-encode value %s\n", val);
return 1;
}
GZPRINTF (output, "=%s", *buffer_p);
}
notmuch_message_properties_destroy (list);
if (! first)
GZPRINTF (output, "\n", *buffer_p);
return 0;
}
static int
dump_tags_message (void *ctx,
notmuch_message_t *message, int output_format,
gzFile output,
char **buffer_p, size_t *size_p)
{
int first = 1;
const char *message_id;
message_id = notmuch_message_get_message_id (message);
if (output_format == DUMP_FORMAT_BATCH_TAG &&
strchr (message_id, '\n')) {
/* This will produce a line break in the output, which
* would be difficult to handle in tools. However, it's
* also impossible to produce an email containing a line
* break in a message ID because of unfolding, so we can
* safely disallow it. */
fprintf (stderr, "Warning: skipping message id containing line break: \"%s\"\n", message_id);
return EXIT_SUCCESS;
}
if (output_format == DUMP_FORMAT_SUP) {
GZPRINTF (output, "%s (", message_id);
}
for (notmuch_tags_t *tags = notmuch_message_get_tags (message);
notmuch_tags_valid (tags);
notmuch_tags_move_to_next (tags)) {
const char *tag_str = notmuch_tags_get (tags);
if (! first)
GZPUTS (output, " ");
first = 0;
if (output_format == DUMP_FORMAT_SUP) {
GZPUTS (output, tag_str);
} else {
if (hex_encode (ctx, tag_str,
buffer_p, size_p) != HEX_SUCCESS) {
fprintf (stderr, "Error: failed to hex-encode tag %s\n",
tag_str);
return EXIT_FAILURE;
}
GZPRINTF (output, "+%s", *buffer_p);
}
}
if (output_format == DUMP_FORMAT_SUP) {
GZPUTS (output, ")\n");
} else {
if (make_boolean_term (ctx, "id", message_id,
buffer_p, size_p)) {
fprintf (stderr, "Error quoting message id %s: %s\n",
message_id, strerror (errno));
return EXIT_FAILURE;
}
GZPRINTF (output, " -- %s\n", *buffer_p);
}
return EXIT_SUCCESS;
}
static int
database_dump_file (notmuch_database_t *notmuch, gzFile output,
const char *query_str, int output_format, int include)
{
notmuch_query_t *query;
notmuch_messages_t *messages;
notmuch_message_t *message;
notmuch_status_t status;
char *buffer = NULL;
size_t buffer_size = 0;
print_dump_header (output, output_format, include);
if (include & DUMP_INCLUDE_CONFIG) {
if (print_status_database ("notmuch dump", notmuch,
database_dump_config (notmuch, output)))
return EXIT_FAILURE;
}
if (! (include & (DUMP_INCLUDE_TAGS | DUMP_INCLUDE_PROPERTIES)))
return EXIT_SUCCESS;
if (! query_str)
query_str = "";
query = notmuch_query_create (notmuch, query_str);
if (query == NULL) {
fprintf (stderr, "Out of memory\n");
return EXIT_FAILURE;
}
/* Don't ask xapian to sort by Message-ID. Xapian optimizes returning the
* first results quickly at the expense of total time.
*/
notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);
status = notmuch_query_search_messages (query, &messages);
if (print_status_query ("notmuch dump", query, status))
return EXIT_FAILURE;
for (;
notmuch_messages_valid (messages);
notmuch_messages_move_to_next (messages)) {
message = notmuch_messages_get (messages);
if ((include & DUMP_INCLUDE_TAGS) &&
dump_tags_message (notmuch, message, output_format, output,
&buffer, &buffer_size))
return EXIT_FAILURE;
if ((include & DUMP_INCLUDE_PROPERTIES) &&
dump_properties_message (notmuch, message, output,
&buffer, &buffer_size))
return EXIT_FAILURE;
notmuch_message_destroy (message);
}
notmuch_query_destroy (query);
return EXIT_SUCCESS;
}
/* Dump database into output_file_name if it's non-NULL, stdout
* otherwise.
*/
int
notmuch_database_dump (notmuch_database_t *notmuch,
const char *output_file_name,
const char *query_str,
dump_format_t output_format,
dump_include_t include,
bool gzip_output)
{
gzFile output = NULL;
const char *mode = gzip_output ? "w9" : "wT";
const char *name_for_error = output_file_name ? output_file_name : "stdout";
char *tempname = NULL;
int outfd = -1;
int ret = -1;
if (output_file_name) {
tempname = talloc_asprintf (notmuch, "%s.XXXXXX", output_file_name);
outfd = mkstemp (tempname);
} else {
outfd = dup (STDOUT_FILENO);
}
if (outfd < 0) {
fprintf (stderr, "Bad output file %s\n", name_for_error);
goto DONE;
}
output = gzdopen (outfd, mode);
if (output == NULL) {
fprintf (stderr, "Error opening %s for (gzip) writing: %s\n",
name_for_error, strerror (errno));
if (close (outfd))
fprintf (stderr, "Error closing %s during shutdown: %s\n",
name_for_error, strerror (errno));
goto DONE;
}
ret = database_dump_file (notmuch, output, query_str, output_format, include);
if (ret) goto DONE;
ret = gzflush (output, Z_FINISH);
if (ret) {
fprintf (stderr, "Error flushing output: %s\n", gzerror_str (output));
goto DONE;
}
if (output_file_name) {
ret = fsync (outfd);
if (ret) {
fprintf (stderr, "Error syncing %s to disk: %s\n",
name_for_error, strerror (errno));
goto DONE;
}
}
ret = gzclose_w (output);
if (ret) {
fprintf (stderr, "Error closing %s: %s\n", name_for_error,
gzerror_str (output));
ret = EXIT_FAILURE;
output = NULL;
goto DONE;
} else
output = NULL;
if (output_file_name) {
ret = rename (tempname, output_file_name);
if (ret) {
fprintf (stderr, "Error renaming %s to %s: %s\n",
tempname, output_file_name, strerror (errno));
goto DONE;
}
}
DONE:
if (ret != EXIT_SUCCESS && output)
(void) gzclose_w (output);
if (ret != EXIT_SUCCESS && output_file_name)
(void) unlink (tempname);
return ret;
}
int
notmuch_dump_command (notmuch_database_t *notmuch, int argc, char *argv[])
{
const char *query_str = NULL;
int ret;
notmuch_exit_if_unmatched_db_uuid (notmuch);
const char *output_file_name = NULL;
int opt_index;
int output_format = DUMP_FORMAT_BATCH_TAG;
int include = 0;
bool gzip_output = 0;
notmuch_opt_desc_t options[] = {
{ .opt_keyword = &output_format, .name = "format", .keywords =
(notmuch_keyword_t []){ { "sup", DUMP_FORMAT_SUP },
{ "batch-tag", DUMP_FORMAT_BATCH_TAG },
{ 0, 0 } } },
{ .opt_flags = &include, .name = "include", .keywords =
(notmuch_keyword_t []){ { "config", DUMP_INCLUDE_CONFIG },
{ "properties", DUMP_INCLUDE_PROPERTIES },
{ "tags", DUMP_INCLUDE_TAGS } } },
{ .opt_string = &output_file_name, .name = "output" },
{ .opt_bool = &gzip_output, .name = "gzip" },
{ .opt_inherit = notmuch_shared_options },
{ }
};
opt_index = parse_arguments (argc, argv, options, 1);
if (opt_index < 0)
return EXIT_FAILURE;
notmuch_process_shared_options (argv[0]);
if (include == 0)
include = DUMP_INCLUDE_CONFIG | DUMP_INCLUDE_TAGS | DUMP_INCLUDE_PROPERTIES;
if (opt_index < argc) {
query_str = query_string_from_args (notmuch, argc - opt_index, argv + opt_index);
if (query_str == NULL) {
fprintf (stderr, "Out of memory.\n");
return EXIT_FAILURE;
}
}
ret = notmuch_database_dump (notmuch, output_file_name, query_str,
output_format, include, gzip_output);
notmuch_database_destroy (notmuch);
return ret;
}
|