test: add known broken for n_m_get_flag on closed db
[notmuch] / notmuch-tag.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 "tag-util.h"
23 #include "string-util.h"
24
25 static volatile sig_atomic_t interrupted;
26
27 static void
28 handle_sigint (unused (int sig))
29 {
30     static char msg[] = "Stopping...         \n";
31
32     /* This write is "opportunistic", so it's okay to ignore the
33      * result.  It is not required for correctness, and if it does
34      * fail or produce a short write, we want to get out of the signal
35      * handler as quickly as possible, not retry it. */
36     IGNORE_RESULT (write (2, msg, sizeof (msg) - 1));
37     interrupted = 1;
38 }
39
40
41 static char *
42 _optimize_tag_query (void *ctx, const char *orig_query_string,
43                      const tag_op_list_t *list)
44 {
45     /* This is subtler than it looks.  Xapian ignores the '-' operator
46      * at the beginning both queries and parenthesized groups and,
47      * furthermore, the presence of a '-' operator at the beginning of
48      * a group can inhibit parsing of the previous operator.  Hence,
49      * the user-provided query MUST appear first, but it is safe to
50      * parenthesize and the exclusion part of the query must not use
51      * the '-' operator (though the NOT operator is fine). */
52
53     char *escaped = NULL;
54     size_t escaped_len = 0;
55     char *query_string;
56     const char *join = "";
57     size_t i;
58
59     /* Don't optimize if there are no tag changes. */
60     if (tag_op_list_size (list) == 0)
61         return talloc_strdup (ctx, orig_query_string);
62
63     /* Build the new query string */
64     if (strcmp (orig_query_string, "*") == 0)
65         query_string = talloc_strdup (ctx, "(");
66     else
67         query_string = talloc_asprintf (ctx, "( %s ) and (", orig_query_string);
68
69     for (i = 0; i < tag_op_list_size (list) && query_string; i++) {
70         /* XXX in case of OOM, query_string will be deallocated when
71          * ctx is, which might be at shutdown */
72         if (make_boolean_term (ctx,
73                                "tag", tag_op_list_tag (list, i),
74                                &escaped, &escaped_len))
75             return NULL;
76
77         query_string = talloc_asprintf_append_buffer (
78             query_string, "%s%s%s", join,
79             tag_op_list_isremove (list, i) ? "" : "not ",
80             escaped);
81         join = " or ";
82     }
83
84     if (query_string)
85         query_string = talloc_strdup_append_buffer (query_string, ")");
86
87     talloc_free (escaped);
88     return query_string;
89 }
90
91 /* Tag messages matching 'query_string' according to 'tag_ops'
92  */
93 static int
94 tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,
95            tag_op_list_t *tag_ops, tag_op_flag_t flags)
96 {
97     notmuch_query_t *query;
98     notmuch_messages_t *messages;
99     notmuch_message_t *message;
100     notmuch_status_t status;
101
102     int ret = NOTMUCH_STATUS_SUCCESS;
103
104     if (! (flags & TAG_FLAG_REMOVE_ALL)) {
105         /* Optimize the query so it excludes messages that already
106          * have the specified set of tags. */
107         query_string = _optimize_tag_query (ctx, query_string, tag_ops);
108         if (query_string == NULL) {
109             fprintf (stderr, "Out of memory.\n");
110             return 1;
111         }
112         flags |= TAG_FLAG_PRE_OPTIMIZED;
113     }
114
115     query = notmuch_query_create (notmuch, query_string);
116     if (query == NULL) {
117         fprintf (stderr, "Out of memory.\n");
118         return 1;
119     }
120
121     /* tagging is not interested in any special sort order */
122     notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);
123
124     status = notmuch_query_search_messages (query, &messages);
125     if (print_status_query ("notmuch tag", query, status))
126         return status;
127
128     for (;
129          notmuch_messages_valid (messages) && ! interrupted;
130          notmuch_messages_move_to_next (messages)) {
131         message = notmuch_messages_get (messages);
132         ret = tag_op_list_apply (message, tag_ops, flags);
133         notmuch_message_destroy (message);
134         if (ret != NOTMUCH_STATUS_SUCCESS)
135             break;
136     }
137
138     notmuch_query_destroy (query);
139
140     return ret || interrupted;
141 }
142
143 static int
144 tag_file (void *ctx, notmuch_database_t *notmuch, tag_op_flag_t flags,
145           FILE *input)
146 {
147     char *line = NULL;
148     char *query_string = NULL;
149     size_t line_size = 0;
150     ssize_t line_len;
151     int ret = 0;
152     int warn = 0;
153     tag_op_list_t *tag_ops;
154
155     tag_ops = tag_op_list_create (ctx);
156     if (tag_ops == NULL) {
157         fprintf (stderr, "Out of memory.\n");
158         return 1;
159     }
160
161     while ((line_len = getline (&line, &line_size, input)) != -1 &&
162            ! interrupted) {
163
164         ret = parse_tag_line (ctx, line, TAG_FLAG_NONE,
165                               &query_string, tag_ops);
166
167         if (ret > 0) {
168             if (ret != TAG_PARSE_SKIPPED)
169                 /* remember there has been problematic lines */
170                 warn = 1;
171             ret = 0;
172             continue;
173         }
174
175         if (ret < 0)
176             break;
177
178         ret = tag_query (ctx, notmuch, query_string, tag_ops, flags);
179         if (ret)
180             break;
181     }
182
183     if (line)
184         free (line);
185
186     return ret || warn;
187 }
188
189 int
190 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[])
191 {
192     tag_op_list_t *tag_ops = NULL;
193     char *query_string = NULL;
194     notmuch_database_t *notmuch;
195     struct sigaction action;
196     tag_op_flag_t tag_flags = TAG_FLAG_NONE;
197     bool batch = false;
198     bool remove_all = false;
199     FILE *input = stdin;
200     const char *input_file_name = NULL;
201     int opt_index;
202     int ret;
203
204     /* Set up our handler for SIGINT */
205     memset (&action, 0, sizeof (struct sigaction));
206     action.sa_handler = handle_sigint;
207     sigemptyset (&action.sa_mask);
208     action.sa_flags = SA_RESTART;
209     sigaction (SIGINT, &action, NULL);
210
211     notmuch_opt_desc_t options[] = {
212         { .opt_bool = &batch, .name = "batch" },
213         { .opt_string = &input_file_name, .name = "input" },
214         { .opt_bool = &remove_all, .name = "remove-all" },
215         { .opt_inherit = notmuch_shared_options },
216         { }
217     };
218
219     opt_index = parse_arguments (argc, argv, options, 1);
220     if (opt_index < 0)
221         return EXIT_FAILURE;
222
223     notmuch_process_shared_options (argv[0]);
224
225     if (input_file_name) {
226         batch = true;
227         input = fopen (input_file_name, "r");
228         if (input == NULL) {
229             fprintf (stderr, "Error opening %s for reading: %s\n",
230                      input_file_name, strerror (errno));
231             return EXIT_FAILURE;
232         }
233     }
234
235     if (batch) {
236         if (opt_index != argc) {
237             fprintf (stderr, "Can't specify both cmdline and stdin!\n");
238             if (input)
239                 fclose (input);
240             return EXIT_FAILURE;
241         }
242     } else {
243         tag_ops = tag_op_list_create (config);
244         if (tag_ops == NULL) {
245             fprintf (stderr, "Out of memory.\n");
246             return EXIT_FAILURE;
247         }
248
249         if (parse_tag_command_line (config, argc - opt_index, argv + opt_index,
250                                     &query_string, tag_ops))
251             return EXIT_FAILURE;
252
253         if (tag_op_list_size (tag_ops) == 0 && ! remove_all) {
254             fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");
255             return EXIT_FAILURE;
256         }
257
258         if (*query_string == '\0') {
259             fprintf (stderr, "Error: notmuch tag requires at least one search term.\n");
260             return EXIT_FAILURE;
261         }
262     }
263
264     if (notmuch_database_open (notmuch_config_get_database_path (config),
265                                NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
266         return EXIT_FAILURE;
267
268     notmuch_exit_if_unmatched_db_uuid (notmuch);
269
270     if (notmuch_config_get_maildir_synchronize_flags (config))
271         tag_flags |= TAG_FLAG_MAILDIR_SYNC;
272
273     if (remove_all)
274         tag_flags |= TAG_FLAG_REMOVE_ALL;
275
276     if (batch)
277         ret = tag_file (config, notmuch, tag_flags, input);
278     else
279         ret = tag_query (config, notmuch, query_string, tag_ops, tag_flags);
280
281     notmuch_database_destroy (notmuch);
282
283     if (input != stdin)
284         fclose (input);
285
286     return ret || interrupted ? EXIT_FAILURE : EXIT_SUCCESS;
287 }