diplodocus.org Git - nmh/blob - uip/new.c

   1 /* new.c -- as new,    list all folders with unseen messages
   2  *       -- as fnext,  move to next folder with unseen messages
   3  *       -- as fprev,  move to previous folder with unseen messages
   4  *       -- as unseen, scan all unseen messages
   5  * This code is Copyright (c) 2008, by the authors of nmh.  See the
   6  * COPYRIGHT file in the root directory of the nmh distribution for
   7  * complete copyright information.
   8  *
   9  * Inspired by Luke Mewburn's new: http://www.mewburn.net/luke/src/new
  10  */
  11
  12 #include <sys/types.h>
  13
  14 #include <h/mh.h>
  15 #include <h/crawl_folders.h>
  16 #include <h/utils.h>
  17 #include "../sbr/lock_file.h"
  18 #include "../sbr/m_maildir.h"
  19
  20 #define NEW_SWITCHES \
  21     X("mode", 1, MODESW) \
  22     X("folders", 1, FOLDERSSW) \
  23     X("version", 1, VERSIONSW) \
  24     X("help", 1, HELPSW) \
  25
  26 #define X(sw, minchars, id) id,
  27 DEFINE_SWITCH_ENUM(NEW);
  28 #undef X
  29
  30 #define X(sw, minchars, id) { sw, minchars, id },
  31 DEFINE_SWITCH_ARRAY(NEW, switches);
  32 #undef X
  33
  34 /* What to do, based on argv[0]. */
  35 static enum {
  36     RM_NEW,
  37     RM_FNEXT,
  38     RM_FPREV,
  39     RM_UNSEEN
  40 } run_mode = RM_NEW;
  41
  42 /* check_folders uses this to maintain state with both .folders list of
  43  * folders and with crawl_folders. */
  44 struct list_state {
  45     struct node **first, **cur_node;
  46     size_t *maxlen;
  47     char *cur;
  48     char **sequences;
  49     struct node *node;
  50 };
  51
  52 /* Return the number of messages in a string list of message numbers. */
  53 static int
  54 count_messages(char *field)
  55 {
  56     int total = 0;
  57     int j, k;
  58     char *cp, **ap;
  59
  60     field = getcpy(field);
  61
  62     /* copied from seq_read.c:seq_init */
  63     for (ap = brkstring (field, " ", "\n"); *ap; ap++) {
  64         if ((cp = strchr(*ap, '-')))
  65             *cp++ = '\0';
  66         if ((j = m_atoi (*ap)) > 0) {
  67             k = cp ? m_atoi (cp) : j;
  68
  69             total += k - j + 1;
  70         }
  71     }
  72
  73     free(field);
  74
  75     return total;
  76 }
  77
  78 /* Return TRUE if the sequence 'name' is in 'sequences'. */
  79 static boolean
  80 seq_in_list(char *name, char *sequences[])
  81 {
  82     int i;
  83
  84     for (i = 0; sequences[i] != NULL; i++) {
  85         if (strcmp(name, sequences[i]) == 0) {
  86             return TRUE;
  87         }
  88     }
  89
  90     return FALSE;
  91 }
  92
  93 /* Return the string list of message numbers from the sequences file, or NULL
  94  * if none. */
  95 static char *
  96 get_msgnums(char *folder, char *sequences[])
  97 {
  98     char *seqfile = NULL;
  99     FILE *fp;
 100     int state;
 101     char name[NAMESZ], field[NMH_BUFSIZ];
 102     char *cp;
 103     char *msgnums = NULL, *this_msgnums, *old_msgnums;
 104     int failed_to_lock = 0;
 105     m_getfld_state_t gstate = 0;
 106
 107     /* copied from seq_read.c:seq_public */
 108     /*
 109      * If mh_seq == NULL or if *mh_seq == '\0' (the user has defined
 110      * the "mh-sequences" profile entry, but left it empty),
 111      * then just return, and do not initialize any public sequences.
 112      */
 113     if (mh_seq == NULL || *mh_seq == '\0')
 114         return NULL;
 115
 116     /* get filename of sequence file */
 117     seqfile = concat(m_maildir(folder), "/", mh_seq, (void *)NULL);
 118
 119     if (seqfile == NULL)
 120         return NULL;
 121
 122     if ((fp = lkfopendata (seqfile, "r", & failed_to_lock)) == NULL) {
 123
 124         if (failed_to_lock) {
 125             adios (seqfile, "failed to lock");
 126         } else {
 127             free(seqfile);
 128             return NULL;
 129         }
 130     }
 131
 132     /* Use m_getfld to scan sequence file */
 133     for (;;) {
 134         int fieldsz = sizeof field;
 135         switch (state = m_getfld (&gstate, name, field, &fieldsz, fp)) {
 136             case FLD:
 137             case FLDPLUS:
 138                 if (state == FLDPLUS) {
 139                     cp = getcpy (field);
 140                     while (state == FLDPLUS) {
 141                         fieldsz = sizeof field;
 142                         state = m_getfld (&gstate, name, field, &fieldsz, fp);
 143                         cp = add (field, cp);
 144                     }
 145
 146                     /* Here's where we differ from seq_public: if it's in a
 147                      * sequence we want, save the list of messages. */
 148                     if (seq_in_list(name, sequences)) {
 149                         this_msgnums = trimcpy(cp);
 150                         if (msgnums == NULL) {
 151                             msgnums = this_msgnums;
 152                         } else {
 153                             old_msgnums = msgnums;
 154                             msgnums = concat(old_msgnums, " ",
 155                                              this_msgnums, (void *)NULL);
 156                             free(old_msgnums);
 157                             free(this_msgnums);
 158                         }
 159                     }
 160                     free (cp);
 161                 } else {
 162                     /* and here */
 163                     if (seq_in_list(name, sequences)) {
 164                         this_msgnums = trimcpy(field);
 165                         if (msgnums == NULL) {
 166                             msgnums = this_msgnums;
 167                         } else {
 168                             old_msgnums = msgnums;
 169                             msgnums = concat(old_msgnums, " ",
 170                                              this_msgnums, (void *)NULL);
 171                             free(old_msgnums);
 172                             free(this_msgnums);
 173                         }
 174                     }
 175                 }
 176
 177                 continue;
 178
 179             case BODY:
 180                 adios (NULL, "no blank lines are permitted in %s", seqfile);
 181                 break;
 182
 183             case FILEEOF:
 184                 break;
 185
 186             default:
 187                 adios (NULL, "%s is poorly formatted", seqfile);
 188         }
 189         break;  /* break from for loop */
 190     }
 191     m_getfld_state_destroy (&gstate);
 192
 193     lkfclosedata (fp, seqfile);
 194
 195     free(seqfile);
 196
 197     return msgnums;
 198 }
 199
 200 /* Check `folder' (of length `len') for interesting messages, filling in the
 201  * list in `b'. */
 202 static void
 203 check_folder(char *folder, size_t len, struct list_state *b)
 204 {
 205     char *msgnums = get_msgnums(folder, b->sequences);
 206     int is_cur = strcmp(folder, b->cur) == 0;
 207
 208     if (is_cur || msgnums != NULL) {
 209         if (*b->first == NULL) {
 210             NEW(b->node);
 211             *b->first = b->node;
 212         } else {
 213             NEW(b->node->n_next);
 214             b->node = b->node->n_next;
 215         }
 216         b->node->n_name = folder;
 217         b->node->n_field = msgnums;
 218
 219         if (*b->maxlen < len) {
 220             *b->maxlen = len;
 221         }
 222     }
 223
 224     /* Save the node for the current folder, so we can fall back to it. */
 225     if (is_cur) {
 226         *b->cur_node = b->node;
 227     }
 228 }
 229
 230 static boolean
 231 crawl_callback(char *folder, void *baton)
 232 {
 233     check_folder(folder, strlen(folder), baton);
 234     return TRUE;
 235 }
 236
 237 /* Scan folders, returning:
 238  * first        -- list of nodes for all folders which have desired messages;
 239  *                 if the current folder is listed in .folders, it is also in
 240  *                 the list regardless of whether it has any desired messages
 241  * last         -- last node in list
 242  * cur_node     -- node of current folder, if listed in .folders
 243  * maxlen       -- length of longest folder name
 244  *
 245  * `cur' points to the name of the current folder, `folders' points to the
 246  * name of a .folder (if NULL, crawl all folders), and `sequences' points to
 247  * the array of sequences for which to look.
 248  *
 249  * An empty list is returned as first=last=NULL.
 250  */
 251 static void
 252 check_folders(struct node **first, struct node **last,
 253               struct node **cur_node, size_t *maxlen,
 254               char *cur, char *folders, char *sequences[])
 255 {
 256     struct list_state b;
 257     FILE *fp;
 258     char *line;
 259     size_t len;
 260
 261     *first = *last = *cur_node = NULL;
 262     *maxlen = 0;
 263
 264     b.first = first;
 265     b.cur_node = cur_node;
 266     b.maxlen = maxlen;
 267     b.cur = cur;
 268     b.sequences = sequences;
 269
 270     if (folders == NULL) {
 271         if (chdir(m_maildir("")) < 0) {
 272             advise (m_maildir(""), "chdir");
 273         }
 274         crawl_folders(".", crawl_callback, &b);
 275     } else {
 276         fp = fopen(folders, "r");
 277         if (fp  == NULL) {
 278             adios(NULL, "failed to read %s", folders);
 279         }
 280         while (vfgets(fp, &line) == OK) {
 281             len = strlen(line) - 1;
 282             line[len] = '\0';
 283             check_folder(mh_xstrdup(line), len, &b);
 284         }
 285         fclose(fp);
 286     }
 287
 288     if (*first != NULL) {
 289         b.node->n_next = NULL;
 290         *last = b.node;
 291     }
 292 }
 293
 294 /* Return a single string of the `sequences' joined by a space (' '). */
 295 static char *
 296 join_sequences(char *sequences[])
 297 {
 298     int i;
 299     size_t len = 0;
 300     char *result, *cp;
 301
 302     for (i = 0; sequences[i] != NULL; i++) {
 303         len += strlen(sequences[i]) + 1;
 304     }
 305     result = mh_xmalloc(len + 1);
 306
 307     for (i = 0, cp = result; sequences[i] != NULL; i++, cp += len + 1) {
 308         len = strlen(sequences[i]);
 309         memcpy(cp, sequences[i], len);
 310         cp[len] = ' ';
 311     }
 312     /* -1 to overwrite the last delimiter */
 313     *--cp = '\0';
 314
 315     return result;
 316 }
 317
 318 /* Return a struct node for the folder to change to.  This is the next
 319  * (previous, if RM_FPREV mode) folder with desired messages, or the current
 320  * folder if no folders have desired.  If RM_NEW or RM_UNSEEN mode, print the
 321  * output but don't change folders.
 322  *
 323  * n_name is the folder to change to, and n_field is the string list of
 324  * desired message numbers.
 325  */
 326 static struct node *
 327 doit(char *cur, char *folders, char *sequences[])
 328 {
 329     struct node *first, *cur_node, *node, *last, *prev;
 330     size_t folder_len;
 331     int count, total = 0;
 332     char *command = NULL, *sequences_s = NULL;
 333
 334     if (cur == NULL || cur[0] == '\0') {
 335         cur = "inbox";
 336     }
 337
 338     check_folders(&first, &last, &cur_node, &folder_len, cur,
 339                   folders, sequences);
 340
 341     if (run_mode == RM_FNEXT || run_mode == RM_FPREV) {
 342         if (first == NULL) {
 343             /* No folders at all... */
 344             return NULL;
 345         }
 346         if (first->n_next == NULL) {
 347             /* We have only one node; any desired messages in it? */
 348             if (first->n_field == NULL) {
 349                 return NULL;
 350             }
 351             return first;
 352         }
 353         if (cur_node == NULL) {
 354             /* Current folder is not listed in .folders, return first. */
 355             return first;
 356         }
 357     } else if (run_mode == RM_UNSEEN) {
 358         sequences_s = join_sequences(sequences);
 359     }
 360
 361     for (node = first, prev = NULL;
 362          node != NULL;
 363          prev = node, node = node->n_next) {
 364         if (run_mode == RM_FNEXT) {
 365             /* If we have a previous node and it is the current
 366              * folder, return this node. */
 367             if (prev != NULL && strcmp(prev->n_name, cur) == 0) {
 368                 return node;
 369             }
 370         } else if (run_mode == RM_FPREV) {
 371             if (strcmp(node->n_name, cur) == 0) {
 372                 /* Found current folder in fprev mode; if we have a
 373                  * previous node in the list, return it; else return
 374                  * the last node. */
 375                 if (prev == NULL) {
 376                     return last;
 377                 }
 378                 return prev;
 379             }
 380         } else if (run_mode == RM_UNSEEN) {
 381             int status;
 382
 383             if (node->n_field == NULL) {
 384                 continue;
 385             }
 386
 387             printf("\n%d %s messages in %s",
 388                    count_messages(node->n_field),
 389                    sequences_s,
 390                    node->n_name);
 391             if (strcmp(node->n_name, cur) == 0) {
 392                 puts(" (*: current folder)");
 393             } else {
 394                 putchar('\n');
 395             }
 396             fflush(stdout);
 397
 398             /* TODO: Split enough of scan.c out so that we can call it here. */
 399             command = concat("scan +", node->n_name, " ", sequences_s,
 400                              (void *)NULL);
 401             status = system(command);
 402             if (! WIFEXITED (status)) {
 403                 adios (command, "system");
 404             }
 405             free(command);
 406         } else {
 407             if (node->n_field == NULL) {
 408                 continue;
 409             }
 410
 411             count = count_messages(node->n_field);
 412             total += count;
 413
 414             printf("%-*s %6d.%c %s\n",
 415                    (int) folder_len, node->n_name,
 416                    count,
 417                    (strcmp(node->n_name, cur) == 0 ? '*' : ' '),
 418                    node->n_field);
 419         }
 420     }
 421
 422     /* If we're fnext, we haven't checked the last node yet.  If it's the
 423      * current folder, return the first node. */
 424     if (run_mode == RM_FNEXT) {
 425         assert(last != NULL);
 426         if (strcmp(last->n_name, cur) == 0) {
 427             return first;
 428         }
 429     }
 430
 431     if (run_mode == RM_NEW) {
 432         printf("%-*s %6d.\n", (int) folder_len, " total", total);
 433     }
 434
 435     return cur_node;
 436 }
 437
 438 int
 439 main(int argc, char **argv)
 440 {
 441     char **ap, *cp, **argp, **arguments;
 442     char help[BUFSIZ];
 443     char *folders = NULL;
 444     svector_t sequences = svector_create (0);
 445     int i = 0;
 446     char *unseen;
 447     struct node *folder;
 448
 449     if (nmh_init(argv[0], 1)) { return 1; }
 450
 451     arguments = getarguments (invo_name, argc, argv, 1);
 452     argp = arguments;
 453
 454     /*
 455      * Parse arguments
 456      */
 457     while ((cp = *argp++)) {
 458         if (*cp == '-') {
 459             switch (smatch (++cp, switches)) {
 460             case AMBIGSW:
 461                 ambigsw (cp, switches);
 462                 done (1);
 463             case UNKWNSW:
 464                 adios (NULL, "-%s unknown", cp);
 465
 466             case HELPSW:
 467                 snprintf (help, sizeof(help), "%s [switches] [sequences]",
 468                           invo_name);
 469                 print_help (help, switches, 1);
 470                 done (0);
 471             case VERSIONSW:
 472                 print_version(invo_name);
 473                 done (0);
 474
 475             case FOLDERSSW:
 476                 if (!(folders = *argp++) || *folders == '-')
 477                     adios(NULL, "missing argument to %s", argp[-2]);
 478                 continue;
 479             case MODESW:
 480                 if (!(invo_name = *argp++) || *invo_name == '-')
 481                     adios(NULL, "missing argument to %s", argp[-2]);
 482                 invo_name = r1bindex(invo_name, '/');
 483                 continue;
 484             }
 485         }
 486         /* have a sequence argument */
 487         if (!seq_in_list(cp, svector_strs (sequences))) {
 488             svector_push_back (sequences, cp);
 489             ++i;
 490         }
 491     }
 492
 493     if (strcmp(invo_name, "fnext") == 0) {
 494         run_mode = RM_FNEXT;
 495     } else if (strcmp(invo_name, "fprev") == 0) {
 496         run_mode = RM_FPREV;
 497     } else if (strcmp(invo_name, "unseen") == 0) {
 498         run_mode = RM_UNSEEN;
 499     }
 500
 501     if (folders == NULL) {
 502         /* will flists */
 503     } else {
 504         if (folders[0] != '/') {
 505             folders = m_maildir(folders);
 506         }
 507     }
 508
 509     if (i == 0) {
 510         /* no sequence arguments; use unseen */
 511         unseen = context_find(usequence);
 512         if (unseen == NULL || unseen[0] == '\0') {
 513             adios(NULL, "must specify sequences or set %s", usequence);
 514         }
 515         for (ap = brkstring(unseen, " ", "\n"); *ap; ap++) {
 516             svector_push_back (sequences, *ap);
 517             ++i;
 518         }
 519     }
 520
 521     folder = doit(context_find(pfolder), folders, svector_strs (sequences));
 522     if (folder == NULL) {
 523         done(0);
 524         return 1;
 525     }
 526
 527     if (run_mode == RM_UNSEEN) {
 528         /* All the scan(1)s it runs change the current folder, so we
 529          * need to put it back.  Unfortunately, context_replace lamely
 530          * ignores the new value you give it if it is the same one it
 531          * has in memory.  So, we'll be lame, too.  I'm not sure if i
 532          * should just change context_replace... */
 533         context_replace(pfolder, "defeat_context_replace_optimization");
 534     }
 535
 536     /* update current folder */
 537     context_replace(pfolder, folder->n_name);
 538
 539     if (run_mode == RM_FNEXT || run_mode == RM_FPREV) {
 540         printf("%s  %s\n", folder->n_name, folder->n_field);
 541     }
 542
 543     context_save();
 544
 545     svector_free (sequences);
 546     done (0);
 547     return 1;
 548 }