3b09df995ec58005b37db4269b428e9c996e03d1
[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 http://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     int ret = NOTMUCH_STATUS_SUCCESS;
101
102     if (! (flags & TAG_FLAG_REMOVE_ALL)) {
103         /* Optimize the query so it excludes messages that already
104          * have the specified set of tags. */
105         query_string = _optimize_tag_query (ctx, query_string, tag_ops);
106         if (query_string == NULL) {
107             fprintf (stderr, "Out of memory.\n");
108             return 1;
109         }
110         flags |= TAG_FLAG_PRE_OPTIMIZED;
111     }
112
113     query = notmuch_query_create (notmuch, query_string);
114     if (query == NULL) {
115         fprintf (stderr, "Out of memory.\n");
116         return 1;
117     }
118
119     /* tagging is not interested in any special sort order */
120     notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);
121
122     for (messages = notmuch_query_search_messages (query);
123          notmuch_messages_valid (messages) && ! interrupted;
124          notmuch_messages_move_to_next (messages)) {
125         message = notmuch_messages_get (messages);
126         ret = tag_op_list_apply (message, tag_ops, flags);
127         notmuch_message_destroy (message);
128         if (ret != NOTMUCH_STATUS_SUCCESS)
129             break;
130     }
131
132     notmuch_query_destroy (query);
133
134     return ret || interrupted;
135 }
136
137 static int
138 tag_file (void *ctx, notmuch_database_t *notmuch, tag_op_flag_t flags,
139           FILE *input)
140 {
141     char *line = NULL;
142     char *query_string = NULL;
143     size_t line_size = 0;
144     ssize_t line_len;
145     int ret = 0;
146     int warn = 0;
147     tag_op_list_t *tag_ops;
148
149     tag_ops = tag_op_list_create (ctx);
150     if (tag_ops == NULL) {
151         fprintf (stderr, "Out of memory.\n");
152         return 1;
153     }
154
155     while ((line_len = getline (&line, &line_size, input)) != -1 &&
156            ! interrupted) {
157
158         ret = parse_tag_line (ctx, line, TAG_FLAG_NONE,
159                               &query_string, tag_ops);
160
161         if (ret > 0) {
162             if (ret != TAG_PARSE_SKIPPED)
163                 /* remember there has been problematic lines */
164                 warn = 1;
165             ret = 0;
166             continue;
167         }
168
169         if (ret < 0)
170             break;
171
172         ret = tag_query (ctx, notmuch, query_string, tag_ops, flags);
173         if (ret)
174             break;
175     }
176
177     if (line)
178         free (line);
179
180     return ret || warn;
181 }
182
183 int
184 notmuch_tag_command (notmuch_config_t *config, int argc, char *argv[])
185 {
186     tag_op_list_t *tag_ops = NULL;
187     char *query_string = NULL;
188     notmuch_database_t *notmuch;
189     struct sigaction action;
190     tag_op_flag_t tag_flags = TAG_FLAG_NONE;
191     notmuch_bool_t batch = FALSE;
192     notmuch_bool_t remove_all = FALSE;
193     FILE *input = stdin;
194     char *input_file_name = NULL;
195     int opt_index;
196     int ret = 0;
197
198     /* Setup our handler for SIGINT */
199     memset (&action, 0, sizeof (struct sigaction));
200     action.sa_handler = handle_sigint;
201     sigemptyset (&action.sa_mask);
202     action.sa_flags = SA_RESTART;
203     sigaction (SIGINT, &action, NULL);
204
205     notmuch_opt_desc_t options[] = {
206         { NOTMUCH_OPT_BOOLEAN, &batch, "batch", 0, 0 },
207         { NOTMUCH_OPT_STRING, &input_file_name, "input", 'i', 0 },
208         { NOTMUCH_OPT_BOOLEAN, &remove_all, "remove-all", 0, 0 },
209         { 0, 0, 0, 0, 0 }
210     };
211
212     opt_index = parse_arguments (argc, argv, options, 1);
213     if (opt_index < 0)
214         return 1;
215
216     if (input_file_name) {
217         batch = TRUE;
218         input = fopen (input_file_name, "r");
219         if (input == NULL) {
220             fprintf (stderr, "Error opening %s for reading: %s\n",
221                      input_file_name, strerror (errno));
222             return 1;
223         }
224     }
225
226     if (batch) {
227         if (opt_index != argc) {
228             fprintf (stderr, "Can't specify both cmdline and stdin!\n");
229             return 1;
230         }
231         if (remove_all) {
232             fprintf (stderr, "Can't specify both --remove-all and --batch\n");
233             return 1;
234         }
235     } else {
236         tag_ops = tag_op_list_create (config);
237         if (tag_ops == NULL) {
238             fprintf (stderr, "Out of memory.\n");
239             return 1;
240         }
241
242         if (parse_tag_command_line (config, argc - opt_index, argv + opt_index,
243                                     &query_string, tag_ops))
244             return 1;
245
246         if (tag_op_list_size (tag_ops) == 0 && ! remove_all) {
247             fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");
248             return 1;
249         }
250
251         if (*query_string == '\0') {
252             fprintf (stderr, "Error: notmuch tag requires at least one search term.\n");
253             return 1;
254         }
255     }
256
257     if (notmuch_database_open (notmuch_config_get_database_path (config),
258                                NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
259         return 1;
260
261     if (notmuch_config_get_maildir_synchronize_flags (config))
262         tag_flags |= TAG_FLAG_MAILDIR_SYNC;
263
264     if (remove_all)
265         tag_flags |= TAG_FLAG_REMOVE_ALL;
266
267     if (batch)
268         ret = tag_file (config, notmuch, tag_flags, input);
269     else
270         ret = tag_query (config, notmuch, query_string, tag_ops, tag_flags);
271
272     notmuch_database_destroy (notmuch);
273
274     if (input != stdin)
275         fclose (input);
276
277     return ret || interrupted;
278 }