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