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
| | /* 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 "tag-util.h"
#include "string-util.h"
static volatile sig_atomic_t interrupted;
static void
handle_sigint (unused (int sig))
{
static char msg[] = "Stopping... \n";
/* This write is "opportunistic", so it's okay to ignore the
* result. It is not required for correctness, and if it does
* fail or produce a short write, we want to get out of the signal
* handler as quickly as possible, not retry it. */
IGNORE_RESULT (write (2, msg, sizeof (msg) - 1));
interrupted = 1;
}
static char *
_optimize_tag_query (void *ctx, const char *orig_query_string,
const tag_op_list_t *list)
{
/* This is subtler than it looks. Xapian ignores the '-' operator
* at the beginning both queries and parenthesized groups and,
* furthermore, the presence of a '-' operator at the beginning of
* a group can inhibit parsing of the previous operator. Hence,
* the user-provided query MUST appear first, but it is safe to
* parenthesize and the exclusion part of the query must not use
* the '-' operator (though the NOT operator is fine). */
char *escaped = NULL;
size_t escaped_len = 0;
char *query_string;
const char *join = "";
size_t i;
/* Don't optimize if there are no tag changes. */
if (tag_op_list_size (list) == 0)
return talloc_strdup (ctx, orig_query_string);
/* Build the new query string */
if (strcmp (orig_query_string, "*") == 0)
query_string = talloc_strdup (ctx, "(");
else
query_string = talloc_asprintf (ctx, "( %s ) and (", orig_query_string);
for (i = 0; i < tag_op_list_size (list) && query_string; i++) {
/* XXX in case of OOM, query_string will be deallocated when
* ctx is, which might be at shutdown */
if (make_boolean_term (ctx,
"tag", tag_op_list_tag (list, i),
&escaped, &escaped_len))
return NULL;
query_string = talloc_asprintf_append_buffer (
query_string, "%s%s%s", join,
tag_op_list_isremove (list, i) ? "" : "not ",
escaped);
join = " or ";
}
if (query_string)
query_string = talloc_strdup_append_buffer (query_string, ")");
talloc_free (escaped);
return query_string;
}
/* Tag messages matching 'query_string' according to 'tag_ops'
*/
static int
tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,
tag_op_list_t *tag_ops, tag_op_flag_t flags)
{
notmuch_query_t *query;
notmuch_messages_t *messages;
notmuch_message_t *message;
notmuch_status_t status;
int ret = NOTMUCH_STATUS_SUCCESS;
if (! (flags & TAG_FLAG_REMOVE_ALL)) {
/* Optimize the query so it excludes messages that already
* have the specified set of tags. */
query_string = _optimize_tag_query (ctx, query_string, tag_ops);
if (query_string == NULL) {
fprintf (stderr, "Out of memory.\n");
return 1;
}
flags |= TAG_FLAG_PRE_OPTIMIZED;
}
query = notmuch_query_create (notmuch, query_string);
if (query == NULL) {
fprintf (stderr, "Out of memory.\n");
return 1;
}
/* tagging is not interested in any special sort order */
notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);
status = notmuch_query_search_messages_st (query, &messages);
if (print_status_query ("notmuch tag", query, status))
return status;
for (;
notmuch_messages_valid (messages) && ! interrupted;
notmuch_messages_move_to_next (messages)) {
message = notmuch_messages_get (messages);
ret = tag_op_list_apply (message, tag_ops, flags);
notmuch_message_destroy (message);
if (ret != NOTMUCH_STATUS_SUCCESS)
break;
}
notmuch_query_destroy (query);
return ret || interrupted;
}
static int
tag_file (void *ctx, notmuch_database_t *notmuch, tag_op_flag_t flags,
FILE *input)
{
char *line = NULL;
char *query_string = NULL;
size_t line_size = 0;
ssize_t line_len;
int ret = 0;
int warn = 0;
tag_op_list_t *tag_ops;
tag_ops = tag_op_list_create (ctx);
if (tag_ops == NULL) {
fprintf (stderr, "Out of memory.\n");
return 1;
}
while ((line_len = getline (&line, &line_size, input)) != -1 &&
! interrupted) {
ret = parse_tag_line (ctx, line, TAG_FLAG_NONE,
&query_string, tag_ops);
if (ret > 0) {
if (ret != TAG_PARSE_SKIPPED)
/* remember there has been problematic lines */
warn = 1;
ret = 0;
continue;
}
if (ret < 0)
break;
ret = tag_query (ctx, notmuch, query_string, tag_ops, flags);
if (ret)
break;
}
if (line)
free (line);
return ret || warn;
}
static int
_dump_tags (notmuch_config_t *config, const char *query_string)
{
notmuch_database_t *notmuch;
notmuch_tags_t *tags;
const char *tag;
char *status_string;
notmuch_query_t *query;
if (notmuch_database_open_verbose (notmuch_config_get_database_path (config),
NOTMUCH_DATABASE_MODE_READ_ONLY,
¬much, &status_string)) {
if (status_string) {
fputs (status_string, stderr);
free (status_string);
}
return EXIT_FAILURE;
}
query = notmuch_query_create (notmuch, query_string);
if (query == NULL) {
fprintf (stderr, "Out of memory\n");
return EXIT_FAILURE;
}
if (print_status_query ("notmuch tag",
query,
notmuch_query_search_tags (query, &tags)))
return 1;
for (;
notmuch_tags_valid (tags);
notmuch_tags_move_to_next (tags))
{
tag = notmuch_tags_get (tags);
printf ("%s\n", tag);
}
notmuch_tags_destroy (tags);
return EXIT_SUCCESS;
}
int
notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[])
{
tag_op_list_t *tag_ops = NULL;
char *query_string = NULL;
notmuch_database_t *notmuch;
struct sigaction action;
tag_op_flag_t tag_flags = TAG_FLAG_NONE;
notmuch_bool_t batch = FALSE;
notmuch_bool_t remove_all = FALSE;
notmuch_bool_t with_ops = FALSE;
FILE *input = stdin;
char *input_file_name = NULL;
int opt_index;
int ret;
/* Set up our handler for SIGINT */
memset (&action, 0, sizeof (struct sigaction));
action.sa_handler = handle_sigint;
sigemptyset (&action.sa_mask);
action.sa_flags = SA_RESTART;
sigaction (SIGINT, &action, NULL);
notmuch_opt_desc_t options[] = {
{ NOTMUCH_OPT_BOOLEAN, &batch, "batch", 0, 0 },
{ NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 },
{ NOTMUCH_OPT_BOOLEAN, &remove_all, "remove-all", 0, 0 },
{ NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
{ 0, 0, 0, 0, 0 }
};
opt_index = parse_arguments (argc, argv, options, 1);
if (opt_index < 0)
return EXIT_FAILURE;
notmuch_process_shared_options (argv[0]);
if (input_file_name) {
batch = TRUE;
input = fopen (input_file_name, "r");
if (input == NULL) {
fprintf (stderr, "Error opening %s for reading: %s\n",
input_file_name, strerror (errno));
return EXIT_FAILURE;
}
}
if (batch) {
if (opt_index != argc) {
fprintf (stderr, "Can't specify both cmdline and stdin!\n");
return EXIT_FAILURE;
}
} else {
tag_ops = tag_op_list_create (config);
if (tag_ops == NULL) {
fprintf (stderr, "Out of memory.\n");
return EXIT_FAILURE;
}
if (parse_tag_command_line (config, argc - opt_index, argv + opt_index,
&query_string, tag_ops))
return EXIT_FAILURE;
if (tag_op_list_size (tag_ops) == 0 && ! remove_all)
with_ops = FALSE;
if (with_ops && *query_string == '\0') {
fprintf (stderr, "Error: notmuch tag with operations requires at least one search term.\n");
return EXIT_FAILURE;
}
}
if (! with_ops)
return _dump_tags (config, query_string);
if (notmuch_database_open (notmuch_config_get_database_path (config),
NOTMUCH_DATABASE_MODE_READ_WRITE, ¬much))
return EXIT_FAILURE;
notmuch_exit_if_unmatched_db_uuid (notmuch);
if (notmuch_config_get_maildir_synchronize_flags (config))
tag_flags |= TAG_FLAG_MAILDIR_SYNC;
if (remove_all)
tag_flags |= TAG_FLAG_REMOVE_ALL;
if (batch)
ret = tag_file (config, notmuch, tag_flags, input);
else
ret = tag_query (config, notmuch, query_string, tag_ops, tag_flags);
notmuch_database_destroy (notmuch);
if (input != stdin)
fclose (input);
return ret || interrupted ? EXIT_FAILURE : EXIT_SUCCESS;
}
|