aboutsummaryrefslogtreecommitdiffhomepage
path: root/tag-util.c
blob: 3bde4097372ab827e91e23ff963f6c5413652f9b (plain)
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
#include <assert.h>
#include "string-util.h"
#include "tag-util.h"
#include "hex-escape.h"

#define TAG_OP_LIST_INITIAL_SIZE 10

struct _tag_operation_t {
    const char *tag;
    notmuch_bool_t remove;
};

struct _tag_op_list_t {
    tag_operation_t *ops;
    size_t count;
    size_t size;
};

static tag_parse_status_t
line_error (tag_parse_status_t status,
	    const char *line,
	    const char *format, ...)
{
    va_list va_args;

    va_start (va_args, format);

    fprintf (stderr, status < 0 ? "Error: " : "Warning: ");
    vfprintf (stderr, format, va_args);
    fprintf (stderr, " [%s]\n", line);
    return status;
}

/*
 * Test tags for some forbidden cases.
 *
 * return: NULL if OK,
 *	   explanatory message otherwise.
 */

static const char *
illegal_tag (const char *tag, notmuch_bool_t remove)
{

    if (*tag == '\0' && ! remove)
	return "empty tag forbidden";

    /* This disallows adding tags starting with "-", in particular the
     * non-removable tag "-" and enables notmuch tag to take long
     * options more easily.
     */

    if (*tag == '-' && ! remove)
	return "tag starting with '-' forbidden";

    return NULL;
}

tag_parse_status_t
parse_tag_line (void *ctx, char *line,
		tag_op_flag_t flags,
		char **query_string,
		tag_op_list_t *tag_ops)
{
    char *tok = line;
    size_t tok_len = 0;
    char *line_for_error;
    tag_parse_status_t ret = TAG_PARSE_SUCCESS;

    chomp_newline (line);

    line_for_error = talloc_strdup (ctx, line);
    if (line_for_error == NULL) {
	fprintf (stderr, "Error: out of memory\n");
	return TAG_PARSE_OUT_OF_MEMORY;
    }

    /* remove leading space */
    while (*tok == ' ' || *tok == '\t')
	tok++;

    /* Skip empty and comment lines. */
    if (*tok == '\0' || *tok == '#') {
	ret = TAG_PARSE_SKIPPED;
	goto DONE;
    }

    tag_op_list_reset (tag_ops);

    /* Parse tags. */
    while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {
	notmuch_bool_t remove;
	char *tag;

	/* Optional explicit end of tags marker. */
	if (tok_len == 2 && strncmp (tok, "--", tok_len) == 0) {
	    tok = strtok_len (tok + tok_len, " ", &tok_len);
	    if (tok == NULL) {
		ret = line_error (TAG_PARSE_INVALID, line_for_error,
				  "no query string after --");
		goto DONE;
	    }
	    break;
	}

	/* Implicit end of tags. */
	if (*tok != '-' && *tok != '+')
	    break;

	/* If tag is terminated by NUL, there's no query string. */
	if (*(tok + tok_len) == '\0') {
	    ret = line_error (TAG_PARSE_INVALID, line_for_error,
			      "no query string");
	    goto DONE;
	}

	/* Terminate, and start next token after terminator. */
	*(tok + tok_len++) = '\0';

	remove = (*tok == '-');
	tag = tok + 1;

	/* Maybe refuse illegal tags. */
	if (! (flags & TAG_FLAG_BE_GENEROUS)) {
	    const char *msg = illegal_tag (tag, remove);
	    if (msg) {
		ret = line_error (TAG_PARSE_INVALID, line_for_error, msg);
		goto DONE;
	    }
	}

	/* Decode tag. */
	if (hex_decode_inplace (tag) != HEX_SUCCESS) {
	    ret = line_error (TAG_PARSE_INVALID, line_for_error,
			      "hex decoding of tag %s failed", tag);
	    goto DONE;
	}

	if (tag_op_list_append (tag_ops, tag, remove)) {
	    ret = line_error (TAG_PARSE_OUT_OF_MEMORY, line_for_error,
			      "aborting");
	    goto DONE;
	}
    }

    if (tok == NULL) {
	/* use a different error message for testing */
	ret = line_error (TAG_PARSE_INVALID, line_for_error,
			  "missing query string");
	goto DONE;
    }

    /* tok now points to the query string */
    *query_string = tok;

  DONE:
    talloc_free (line_for_error);
    return ret;
}

tag_parse_status_t
parse_tag_command_line (void *ctx, int argc, char **argv,
			char **query_str, tag_op_list_t *tag_ops)
{

    int i;

    for (i = 0; i < argc; i++) {
	if (strcmp (argv[i], "--") == 0) {
	    i++;
	    break;
	}

	if (argv[i][0] != '+' && argv[i][0] != '-')
	    break;

	notmuch_bool_t is_remove = argv[i][0] == '-';
	const char *msg;

	msg = illegal_tag (argv[i] + 1, is_remove);
	if (msg) {
	    fprintf (stderr, "Error: %s", msg);
	    return TAG_PARSE_INVALID;
	}

	tag_op_list_append (tag_ops, argv[i] + 1, is_remove);
    }

    *query_str = query_string_from_args (ctx, argc - i, &argv[i]);

    if (*query_str == NULL) {
	fprintf (stderr, "Out of memory.\n");
	return TAG_PARSE_OUT_OF_MEMORY;
    }

    return TAG_PARSE_SUCCESS;
}


static inline void
message_error (notmuch_message_t *message,
	       notmuch_status_t status,
	       const char *format, ...)
{
    va_list va_args;

    va_start (va_args, format);

    vfprintf (stderr, format, va_args);
    fprintf (stderr, "Message-ID: %s\n", notmuch_message_get_message_id (message));
    fprintf (stderr, "Status: %s\n", notmuch_status_to_string (status));
}

static int
makes_changes (notmuch_message_t *message,
	       tag_op_list_t *list,
	       tag_op_flag_t flags)
{

    size_t i;

    notmuch_tags_t *tags;
    notmuch_bool_t changes = FALSE;

    /* First, do we delete an existing tag? */
    changes = FALSE;
    for (tags = notmuch_message_get_tags (message);
	 ! changes && notmuch_tags_valid (tags);
	 notmuch_tags_move_to_next (tags)) {
	const char *cur_tag = notmuch_tags_get (tags);
	int last_op =  (flags & TAG_FLAG_REMOVE_ALL) ? -1 : 0;

	/* scan backwards to get last operation */
	i = list->count;
	while (i > 0) {
	    i--;
	    if (strcmp (cur_tag, list->ops[i].tag) == 0) {
		last_op = list->ops[i].remove ? -1 : 1;
		break;
	    }
	}

	changes = (last_op == -1);
    }
    notmuch_tags_destroy (tags);

    if (changes)
	return TRUE;

    /* Now check for adding new tags */
    for (i = 0; i < list->count; i++) {
	notmuch_bool_t exists = FALSE;

	if (list->ops[i].remove)
	    continue;

	for (tags = notmuch_message_get_tags (message);
	     notmuch_tags_valid (tags);
	     notmuch_tags_move_to_next (tags)) {
	    const char *cur_tag = notmuch_tags_get (tags);
	    if (strcmp (cur_tag, list->ops[i].tag) == 0) {
		exists = TRUE;
		break;
	    }
	}
	notmuch_tags_destroy (tags);

	/* the following test is conservative,
	 * in the sense it ignores cases like +foo ... -foo
	 * but this is OK from a correctness point of view
	 */
	if (! exists)
	    return TRUE;
    }
    return FALSE;

}

notmuch_status_t
tag_op_list_apply (notmuch_message_t *message,
		   tag_op_list_t *list,
		   tag_op_flag_t flags)
{
    size_t i;
    notmuch_status_t status = 0;
    tag_operation_t *tag_ops = list->ops;

    if (! (flags & TAG_FLAG_PRE_OPTIMIZED) && ! makes_changes (message, list, flags))
	return NOTMUCH_STATUS_SUCCESS;

    status = notmuch_message_freeze (message);
    if (status) {
	message_error (message, status, "freezing message");
	return status;
    }

    if (flags & TAG_FLAG_REMOVE_ALL) {
	status = notmuch_message_remove_all_tags (message);
	if (status) {
	    message_error (message, status, "removing all tags");
	    return status;
	}
    }

    for (i = 0; i < list->count; i++) {
	if (tag_ops[i].remove) {
	    status = notmuch_message_remove_tag (message, tag_ops[i].tag);
	    if (status) {
		message_error (message, status, "removing tag %s", tag_ops[i].tag);
		return status;
	    }
	} else {
	    status = notmuch_message_add_tag (message, tag_ops[i].tag);
	    if (status) {
		message_error (message, status, "adding tag %s", tag_ops[i].tag);
		return status;
	    }

	}
    }

    status = notmuch_message_thaw (message);
    if (status) {
	message_error (message, status, "thawing message");
	return status;
    }


    if (flags & TAG_FLAG_MAILDIR_SYNC) {
	status = notmuch_message_tags_to_maildir_flags (message);
	if (status) {
	    message_error (message, status, "synching tags to maildir");
	    return status;
	}
    }

    return NOTMUCH_STATUS_SUCCESS;

}


/* Array of tagging operations (add or remove.  Size will be increased
 * as necessary. */

tag_op_list_t *
tag_op_list_create (void *ctx)
{
    tag_op_list_t *list;

    list = talloc (ctx, tag_op_list_t);
    if (list == NULL)
	return NULL;

    list->size = TAG_OP_LIST_INITIAL_SIZE;
    list->count = 0;

    list->ops = talloc_array (list, tag_operation_t, list->size);
    if (list->ops == NULL)
	return NULL;

    return list;
}


int
tag_op_list_append (tag_op_list_t *list,
		    const char *tag,
		    notmuch_bool_t remove)
{
    /* Make room if current array is full.  This should be a fairly
     * rare case, considering the initial array size.
     */

    if (list->count == list->size) {
	list->size *= 2;
	list->ops = talloc_realloc (list, list->ops, tag_operation_t,
				    list->size);
	if (list->ops == NULL) {
	    fprintf (stderr, "Out of memory.\n");
	    return 1;
	}
    }

    /* add the new operation */

    list->ops[list->count].tag = tag;
    list->ops[list->count].remove = remove;
    list->count++;
    return 0;
}

/*
 *   Is the i'th tag operation a remove?
 */

notmuch_bool_t
tag_op_list_isremove (const tag_op_list_t *list, size_t i)
{
    assert (i < list->count);
    return list->ops[i].remove;
}

/*
 * Reset a list to contain no operations
 */

void
tag_op_list_reset (tag_op_list_t *list)
{
    list->count = 0;
}

/*
 * Return the number of operations in a list
 */

size_t
tag_op_list_size (const tag_op_list_t *list)
{
    return list->count;
}

/*
 *   return the i'th tag in the list
 */

const char *
tag_op_list_tag (const tag_op_list_t *list, size_t i)
{
    assert (i < list->count);
    return list->ops[i].tag;
}