git.notmuchmail.org Git - notmuch/blob - tag-util.c

   1 #include <assert.h>
   2 #include "string-util.h"
   3 #include "tag-util.h"
   4 #include "hex-escape.h"
   5
   6 #define TAG_OP_LIST_INITIAL_SIZE 10
   7
   8 struct _tag_operation_t {
   9     const char *tag;
  10     notmuch_bool_t remove;
  11 };
  12
  13 struct _tag_op_list_t {
  14     tag_operation_t *ops;
  15     size_t count;
  16     size_t size;
  17 };
  18
  19 static tag_parse_status_t
  20 line_error (tag_parse_status_t status,
  21             const char *line,
  22             const char *format, ...)
  23 {
  24     va_list va_args;
  25
  26     va_start (va_args, format);
  27
  28     fprintf (stderr, status < 0 ? "Error: " : "Warning: ");
  29     vfprintf (stderr, format, va_args);
  30     fprintf (stderr, " [%s]\n", line);
  31
  32     va_end (va_args);
  33
  34     return status;
  35 }
  36
  37 const char *
  38 illegal_tag (const char *tag, notmuch_bool_t remove)
  39 {
  40     if (*tag == '\0' && ! remove)
  41         return "empty tag forbidden";
  42
  43     /* This disallows adding tags starting with "-", in particular the
  44      * non-removable tag "-" and enables notmuch tag to take long
  45      * options more easily.
  46      */
  47
  48     if (*tag == '-' && ! remove)
  49         return "tag starting with '-' forbidden";
  50
  51     return NULL;
  52 }
  53
  54 tag_parse_status_t
  55 parse_tag_line (void *ctx, char *line,
  56                 tag_op_flag_t flags,
  57                 char **query_string,
  58                 tag_op_list_t *tag_ops)
  59 {
  60     char *tok = line;
  61     size_t tok_len = 0;
  62     char *line_for_error;
  63     tag_parse_status_t ret = TAG_PARSE_SUCCESS;
  64
  65     chomp_newline (line);
  66
  67     line_for_error = talloc_strdup (ctx, line);
  68     if (line_for_error == NULL) {
  69         fprintf (stderr, "Error: out of memory\n");
  70         return TAG_PARSE_OUT_OF_MEMORY;
  71     }
  72
  73     /* remove leading space */
  74     while (*tok == ' ' || *tok == '\t')
  75         tok++;
  76
  77     /* Skip empty and comment lines. */
  78     if (*tok == '\0' || *tok == '#') {
  79         ret = TAG_PARSE_SKIPPED;
  80         goto DONE;
  81     }
  82
  83     tag_op_list_reset (tag_ops);
  84
  85     /* Parse tags. */
  86     while ((tok = strtok_len (tok + tok_len, " ", &tok_len)) != NULL) {
  87         notmuch_bool_t remove;
  88         char *tag;
  89
  90         /* Optional explicit end of tags marker. */
  91         if (tok_len == 2 && strncmp (tok, "--", tok_len) == 0) {
  92             tok = strtok_len (tok + tok_len, " ", &tok_len);
  93             if (tok == NULL) {
  94                 ret = line_error (TAG_PARSE_INVALID, line_for_error,
  95                                   "no query string after --");
  96                 goto DONE;
  97             }
  98             break;
  99         }
 100
 101         /* Implicit end of tags. */
 102         if (*tok != '-' && *tok != '+')
 103             break;
 104
 105         /* If tag is terminated by NUL, there's no query string. */
 106         if (*(tok + tok_len) == '\0') {
 107             ret = line_error (TAG_PARSE_INVALID, line_for_error,
 108                               "no query string");
 109             goto DONE;
 110         }
 111
 112         /* Terminate, and start next token after terminator. */
 113         *(tok + tok_len++) = '\0';
 114
 115         remove = (*tok == '-');
 116         tag = tok + 1;
 117
 118         /* Maybe refuse illegal tags. */
 119         if (! (flags & TAG_FLAG_BE_GENEROUS)) {
 120             const char *msg = illegal_tag (tag, remove);
 121             if (msg) {
 122                 ret = line_error (TAG_PARSE_INVALID, line_for_error, msg);
 123                 goto DONE;
 124             }
 125         }
 126
 127         /* Decode tag. */
 128         if (hex_decode_inplace (tag) != HEX_SUCCESS) {
 129             ret = line_error (TAG_PARSE_INVALID, line_for_error,
 130                               "hex decoding of tag %s failed", tag);
 131             goto DONE;
 132         }
 133
 134         if (tag_op_list_append (tag_ops, tag, remove)) {
 135             ret = line_error (TAG_PARSE_OUT_OF_MEMORY, line_for_error,
 136                               "aborting");
 137             goto DONE;
 138         }
 139     }
 140
 141     if (tok == NULL) {
 142         /* use a different error message for testing */
 143         ret = line_error (TAG_PARSE_INVALID, line_for_error,
 144                           "missing query string");
 145         goto DONE;
 146     }
 147
 148     /* tok now points to the query string */
 149     *query_string = tok;
 150
 151   DONE:
 152     talloc_free (line_for_error);
 153     return ret;
 154 }
 155
 156 tag_parse_status_t
 157 parse_tag_command_line (void *ctx, int argc, char **argv,
 158                         char **query_str, tag_op_list_t *tag_ops)
 159 {
 160     int i;
 161
 162     for (i = 0; i < argc; i++) {
 163         if (strcmp (argv[i], "--") == 0) {
 164             i++;
 165             break;
 166         }
 167
 168         if (argv[i][0] != '+' && argv[i][0] != '-')
 169             break;
 170
 171         notmuch_bool_t is_remove = argv[i][0] == '-';
 172         const char *msg;
 173
 174         msg = illegal_tag (argv[i] + 1, is_remove);
 175         if (msg) {
 176             fprintf (stderr, "Error: %s\n", msg);
 177             return TAG_PARSE_INVALID;
 178         }
 179
 180         tag_op_list_append (tag_ops, argv[i] + 1, is_remove);
 181     }
 182
 183     *query_str = query_string_from_args (ctx, argc - i, &argv[i]);
 184
 185     if (*query_str == NULL) {
 186         fprintf (stderr, "Out of memory.\n");
 187         return TAG_PARSE_OUT_OF_MEMORY;
 188     }
 189
 190     return TAG_PARSE_SUCCESS;
 191 }
 192
 193
 194 static inline void
 195 message_error (notmuch_message_t *message,
 196                notmuch_status_t status,
 197                const char *format, ...)
 198 {
 199     va_list va_args;
 200
 201     va_start (va_args, format);
 202
 203     vfprintf (stderr, format, va_args);
 204     fprintf (stderr, "Message-ID: %s\n", notmuch_message_get_message_id (message));
 205     fprintf (stderr, "Status: %s\n", notmuch_status_to_string (status));
 206
 207     va_end (va_args);
 208 }
 209
 210 static int
 211 makes_changes (notmuch_message_t *message,
 212                tag_op_list_t *list,
 213                tag_op_flag_t flags)
 214 {
 215     size_t i;
 216
 217     notmuch_tags_t *tags;
 218     notmuch_bool_t changes = FALSE;
 219
 220     /* First, do we delete an existing tag? */
 221     changes = FALSE;
 222     for (tags = notmuch_message_get_tags (message);
 223          ! changes && notmuch_tags_valid (tags);
 224          notmuch_tags_move_to_next (tags)) {
 225         const char *cur_tag = notmuch_tags_get (tags);
 226         int last_op =  (flags & TAG_FLAG_REMOVE_ALL) ? -1 : 0;
 227
 228         /* scan backwards to get last operation */
 229         i = list->count;
 230         while (i > 0) {
 231             i--;
 232             if (strcmp (cur_tag, list->ops[i].tag) == 0) {
 233                 last_op = list->ops[i].remove ? -1 : 1;
 234                 break;
 235             }
 236         }
 237
 238         changes = (last_op == -1);
 239     }
 240     notmuch_tags_destroy (tags);
 241
 242     if (changes)
 243         return TRUE;
 244
 245     /* Now check for adding new tags */
 246     for (i = 0; i < list->count; i++) {
 247         notmuch_bool_t exists = FALSE;
 248
 249         if (list->ops[i].remove)
 250             continue;
 251
 252         for (tags = notmuch_message_get_tags (message);
 253              notmuch_tags_valid (tags);
 254              notmuch_tags_move_to_next (tags)) {
 255             const char *cur_tag = notmuch_tags_get (tags);
 256             if (strcmp (cur_tag, list->ops[i].tag) == 0) {
 257                 exists = TRUE;
 258                 break;
 259             }
 260         }
 261         notmuch_tags_destroy (tags);
 262
 263         /* the following test is conservative,
 264          * in the sense it ignores cases like +foo ... -foo
 265          * but this is OK from a correctness point of view
 266          */
 267         if (! exists)
 268             return TRUE;
 269     }
 270     return FALSE;
 271
 272 }
 273
 274 notmuch_status_t
 275 tag_op_list_apply (notmuch_message_t *message,
 276                    tag_op_list_t *list,
 277                    tag_op_flag_t flags)
 278 {
 279     size_t i;
 280     notmuch_status_t status = 0;
 281     tag_operation_t *tag_ops = list->ops;
 282
 283     if (! (flags & TAG_FLAG_PRE_OPTIMIZED) && ! makes_changes (message, list, flags))
 284         return NOTMUCH_STATUS_SUCCESS;
 285
 286     status = notmuch_message_freeze (message);
 287     if (status) {
 288         message_error (message, status, "freezing message");
 289         return status;
 290     }
 291
 292     if (flags & TAG_FLAG_REMOVE_ALL) {
 293         status = notmuch_message_remove_all_tags (message);
 294         if (status) {
 295             message_error (message, status, "removing all tags");
 296             return status;
 297         }
 298     }
 299
 300     for (i = 0; i < list->count; i++) {
 301         if (tag_ops[i].remove) {
 302             status = notmuch_message_remove_tag (message, tag_ops[i].tag);
 303             if (status) {
 304                 message_error (message, status, "removing tag %s", tag_ops[i].tag);
 305                 return status;
 306             }
 307         } else {
 308             status = notmuch_message_add_tag (message, tag_ops[i].tag);
 309             if (status) {
 310                 message_error (message, status, "adding tag %s", tag_ops[i].tag);
 311                 return status;
 312             }
 313
 314         }
 315     }
 316
 317     status = notmuch_message_thaw (message);
 318     if (status) {
 319         message_error (message, status, "thawing message");
 320         return status;
 321     }
 322
 323
 324     if (flags & TAG_FLAG_MAILDIR_SYNC) {
 325         status = notmuch_message_tags_to_maildir_flags (message);
 326         if (status) {
 327             message_error (message, status, "synching tags to maildir");
 328             return status;
 329         }
 330     }
 331
 332     return NOTMUCH_STATUS_SUCCESS;
 333
 334 }
 335
 336
 337 /* Array of tagging operations (add or remove.  Size will be increased
 338  * as necessary. */
 339
 340 tag_op_list_t *
 341 tag_op_list_create (void *ctx)
 342 {
 343     tag_op_list_t *list;
 344
 345     list = talloc (ctx, tag_op_list_t);
 346     if (list == NULL)
 347         return NULL;
 348
 349     list->size = TAG_OP_LIST_INITIAL_SIZE;
 350     list->count = 0;
 351
 352     list->ops = talloc_array (list, tag_operation_t, list->size);
 353     if (list->ops == NULL)
 354         return NULL;
 355
 356     return list;
 357 }
 358
 359
 360 int
 361 tag_op_list_append (tag_op_list_t *list,
 362                     const char *tag,
 363                     notmuch_bool_t remove)
 364 {
 365     /* Make room if current array is full.  This should be a fairly
 366      * rare case, considering the initial array size.
 367      */
 368
 369     if (list->count == list->size) {
 370         list->size *= 2;
 371         list->ops = talloc_realloc (list, list->ops, tag_operation_t,
 372                                     list->size);
 373         if (list->ops == NULL) {
 374             fprintf (stderr, "Out of memory.\n");
 375             return 1;
 376         }
 377     }
 378
 379     /* add the new operation */
 380
 381     list->ops[list->count].tag = tag;
 382     list->ops[list->count].remove = remove;
 383     list->count++;
 384     return 0;
 385 }
 386
 387 /*
 388  *   Is the i'th tag operation a remove?
 389  */
 390
 391 notmuch_bool_t
 392 tag_op_list_isremove (const tag_op_list_t *list, size_t i)
 393 {
 394     assert (i < list->count);
 395     return list->ops[i].remove;
 396 }
 397
 398 /*
 399  * Reset a list to contain no operations
 400  */
 401
 402 void
 403 tag_op_list_reset (tag_op_list_t *list)
 404 {
 405     list->count = 0;
 406 }
 407
 408 /*
 409  * Return the number of operations in a list
 410  */
 411
 412 size_t
 413 tag_op_list_size (const tag_op_list_t *list)
 414 {
 415     return list->count;
 416 }
 417
 418 /*
 419  *   return the i'th tag in the list
 420  */
 421
 422 const char *
 423 tag_op_list_tag (const tag_op_list_t *list, size_t i)
 424 {
 425     assert (i < list->count);
 426     return list->ops[i].tag;
 427 }