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

   1 /*
   2  * flist.c -- list nmh folders containing messages
   3  *         -- in a given sequence
   4  *
   5  * originally by
   6  * David Nichols, Xerox-PARC, November, 1992
   7  *
   8  * Copyright (c) 1994 Xerox Corporation.
   9  * Use and copying of this software and preparation of derivative works based
  10  * upon this software are permitted. Any distribution of this software or
  11  * derivative works must comply with all applicable United States export
  12  * control laws. This software is made available AS IS, and Xerox Corporation
  13  * makes no warranty about the software, its performance or its conformity to
  14  * any specification.
  15  *
  16  *  $Id$
  17  */
  18
  19 #include <h/mh.h>
  20 #include <h/utils.h>
  21
  22 #define FALSE   0
  23 #define TRUE    1
  24
  25 /*
  26  * We allocate space to record the names of folders
  27  * (foldersToDo array), this number of elements at a time.
  28  */
  29 #define MAXFOLDERS  100
  30
  31
  32 static struct swit switches[] = {
  33 #define SEQSW           0
  34     { "sequence name", 0 },
  35 #define ALLSW           1
  36     { "all", 0 },
  37 #define NOALLSW         2
  38     { "noall", 0 },
  39 #define RECURSE         3
  40     { "recurse", 0 },
  41 #define NORECURSE       4
  42     { "norecurse", 0 },
  43 #define SHOWZERO        5
  44     { "showzero", 0 },
  45 #define NOSHOWZERO      6
  46     { "noshowzero", 0 },
  47 #define ALPHASW         7
  48     { "alpha", 0 },
  49 #define NOALPHASW       8
  50     { "noalpha", 0 },
  51 #define FASTSW          9
  52     { "fast", 0 },
  53 #define NOFASTSW        10
  54     { "nofast", 0 },
  55 #define TOTALSW         11
  56     { "total", -5 },
  57 #define NOTOTALSW       12
  58     { "nototal", -7 },
  59 #define VERSIONSW       13
  60     { "version", 0 },
  61 #define HELPSW          14
  62     { "help", 0 },
  63     { NULL, 0 }
  64 };
  65
  66 struct Folder {
  67     char *name;                 /* name of folder */
  68     int priority;
  69     int error;                  /* error == 1 for unreadable folder     */
  70     int nMsgs;                  /* number of messages in folder         */
  71     int nSeq[NUMATTRS];         /* number of messages in each sequence  */
  72     int private[NUMATTRS];      /* is given sequence, public or private */
  73 };
  74
  75 static struct Folder *orders = NULL;
  76 static int nOrders = 0;
  77 static int nOrdersAlloced = 0;
  78 static struct Folder *folders = NULL;
  79 static int nFolders = 0;
  80 static int nFoldersAlloced = 0;
  81
  82 /* info on folders to search */
  83 static char **foldersToDo;
  84 static int numfolders;
  85 static int maxfolders;
  86
  87 /* info on sequences to search for */
  88 static char *sequencesToDo[NUMATTRS];
  89 static int numsequences;
  90
  91 static int all        = FALSE;  /* scan all folders in top level?           */
  92 static int alphaOrder = FALSE;  /* want alphabetical order only             */
  93 static int recurse    = FALSE;  /* show nested folders?                     */
  94 static int showzero   = TRUE;   /* show folders even if no messages in seq? */
  95 static int Total      = TRUE;   /* display info on number of messages in    *
  96                                  * sequence found, and total num messages   */
  97
  98 static char curfolder[BUFSIZ];  /* name of the current folder */
  99 static char *nmhdir;            /* base nmh mail directory    */
 100
 101 /*
 102  * Type for a compare function for qsort.  This keeps
 103  * the compiler happy.
 104  */
 105 typedef int (*qsort_comp) (const void *, const void *);
 106
 107 /*
 108  * prototypes
 109  */
 110 int CompareFolders(struct Folder *, struct Folder *);
 111 void GetFolderOrder(void);
 112 void ScanFolders(void);
 113 int AddFolder(char *, int);
 114 void BuildFolderList(char *, int);
 115 void BuildFolderListRecurse(char *, struct stat *, int);
 116 void PrintFolders(void);
 117 void AllocFolders(struct Folder **, int *, int);
 118 int AssignPriority(char *);
 119 static void do_readonly_folders(void);
 120
 121
 122
 123 int
 124 main(int argc, char **argv)
 125 {
 126     char *cp, **argp;
 127     char **arguments;
 128     char buf[BUFSIZ];
 129
 130 #ifdef LOCALE
 131     setlocale(LC_ALL, "");
 132 #endif
 133     invo_name = r1bindex(argv[0], '/');
 134
 135     /* read user profile/context */
 136     context_read();
 137
 138     /*
 139      * If program was invoked with name ending
 140      * in `s', then add switch `-all'.
 141      */
 142     if (argv[0][strlen (argv[0]) - 1] == 's')
 143         all = TRUE;
 144
 145     arguments = getarguments (invo_name, argc, argv, 1);
 146     argp = arguments;
 147
 148     /* allocate the initial space to record the folder names */
 149     numfolders = 0;
 150     maxfolders = MAXFOLDERS;
 151     foldersToDo = (char **) mh_xmalloc ((size_t) (maxfolders * sizeof(*foldersToDo)));
 152
 153     /* no sequences yet */
 154     numsequences = 0;
 155
 156     /* parse arguments */
 157     while ((cp = *argp++)) {
 158         if (*cp == '-') {
 159             switch (smatch(++cp, switches)) {
 160             case AMBIGSW:
 161                 ambigsw(cp, switches);
 162                 done(1);
 163             case UNKWNSW:
 164                 adios(NULL, "-%s unknown", cp);
 165
 166             case HELPSW:
 167                 snprintf(buf, sizeof(buf), "%s [+folder1 [+folder2 ...]][switches]",
 168                         invo_name);
 169                 print_help(buf, switches, 1);
 170                 done(1);
 171             case VERSIONSW:
 172                 print_version(invo_name);
 173                 done (1);
 174
 175             case SEQSW:
 176                 if (!(cp = *argp++) || *cp == '-')
 177                     adios (NULL, "missing argument to %s", argp[-2]);
 178
 179                 /* check if too many sequences specified */
 180                 if (numsequences >= NUMATTRS)
 181                     adios (NULL, "too many sequences (more than %d) specified", NUMATTRS);
 182                 sequencesToDo[numsequences++] = cp;
 183                 break;
 184
 185             case ALLSW:
 186                 all = TRUE;
 187                 break;
 188             case NOALLSW:
 189                 all = FALSE;
 190                 break;
 191
 192             case SHOWZERO:
 193                 showzero = TRUE;
 194                 break;
 195             case NOSHOWZERO:
 196                 showzero = FALSE;
 197                 break;
 198
 199             case ALPHASW:
 200                 alphaOrder = TRUE;
 201                 break;
 202             case NOALPHASW:
 203                 alphaOrder = FALSE;
 204                 break;
 205
 206             case NOFASTSW:
 207             case TOTALSW:
 208                 Total = TRUE;
 209                 break;
 210
 211             case FASTSW:
 212             case NOTOTALSW:
 213                 Total = FALSE;
 214                 break;
 215
 216             case RECURSE:
 217                 recurse = TRUE;
 218                 break;
 219             case NORECURSE:
 220                 recurse = FALSE;
 221                 break;
 222             }
 223         } else {
 224             /*
 225              * Check if we need to allocate more space
 226              * for folder names.
 227              */
 228             if (numfolders >= maxfolders) {
 229                 maxfolders += MAXFOLDERS;
 230                 foldersToDo = (char **) mh_xrealloc (foldersToDo,
 231                     (size_t) (maxfolders * sizeof(*foldersToDo)));
 232             }
 233             if (*cp == '+' || *cp == '@') {
 234                 foldersToDo[numfolders++] =
 235                     pluspath (cp);
 236             } else
 237                 foldersToDo[numfolders++] = cp;
 238         }
 239     }
 240
 241     if (!context_find ("path"))
 242         free (path ("./", TFOLDER));
 243
 244     /* get current folder */
 245     strncpy (curfolder, getfolder(1), sizeof(curfolder));
 246
 247     /* get nmh base directory */
 248     nmhdir = m_maildir ("");
 249
 250     /*
 251      * If we didn't specify any sequences, we search
 252      * for the "Unseen-Sequence" profile entry and use
 253      * all the sequences defined there.  We check to
 254      * make sure that the Unseen-Sequence entry doesn't
 255      * contain more than NUMATTRS sequences.
 256      */
 257     if (numsequences == 0) {
 258         if ((cp = context_find(usequence)) && *cp) {
 259             char **ap, *dp;
 260
 261             dp = getcpy(cp);
 262             ap = brkstring (dp, " ", "\n");
 263             for (; ap && *ap; ap++) {
 264                 if (numsequences >= NUMATTRS)
 265                     adios (NULL, "too many sequences (more than %d) in %s profile entry",
 266                            NUMATTRS, usequence);
 267                 else
 268                     sequencesToDo[numsequences++] = *ap;
 269             }
 270         } else {
 271             adios (NULL, "no sequence specified or %s profile entry found", usequence);
 272         }
 273     }
 274
 275     GetFolderOrder();
 276     ScanFolders();
 277     qsort(folders, nFolders, sizeof(struct Folder), (qsort_comp) CompareFolders);
 278     PrintFolders();
 279     done (0);
 280     return 1;
 281 }
 282
 283 /*
 284  * Read the Flist-Order profile entry to determine
 285  * how to sort folders for output.
 286  */
 287
 288 void
 289 GetFolderOrder(void)
 290 {
 291     unsigned char *p, *s;
 292     int priority = 1;
 293     struct Folder *o;
 294
 295     if (!(p = context_find("Flist-Order")))
 296         return;
 297     for (;;) {
 298         while (isspace(*p))
 299             ++p;
 300         s = p;
 301         while (*p && !isspace(*p))
 302             ++p;
 303         if (p != s) {
 304             /* Found one. */
 305             AllocFolders(&orders, &nOrdersAlloced, nOrders + 1);
 306             o = &orders[nOrders++];
 307             o->priority = priority++;
 308             o->name = (char *) mh_xmalloc(p - s + 1);
 309             strncpy(o->name, s, p - s);
 310             o->name[p - s] = 0;
 311         } else
 312             break;
 313     }
 314 }
 315
 316 /*
 317  * Scan all the necessary folders
 318  */
 319
 320 void
 321 ScanFolders(void)
 322 {
 323     int i;
 324
 325     /*
 326      * change directory to base of nmh directory
 327      */
 328     if (chdir (nmhdir) == NOTOK)
 329         adios (nmhdir, "unable to change directory to");
 330
 331     if (numfolders > 0) {
 332         /* Update context */
 333         strncpy (curfolder, foldersToDo[numfolders - 1], sizeof(curfolder));
 334         context_replace (pfolder, curfolder);/* update current folder */
 335         context_save ();                     /* save the context file */
 336
 337         /*
 338          * Scan each given folder.  If -all is given,
 339          * then also scan the 1st level subfolders under
 340          * each given folder.
 341          */
 342         for (i = 0; i < numfolders; ++i)
 343             BuildFolderList(foldersToDo[i], all ? 1 : 0);
 344     } else {
 345         if (all) {
 346             /*
 347              * Do the readonly folders
 348              */
 349             do_readonly_folders();
 350
 351             /*
 352              * Now scan the entire nmh directory for folders
 353              */
 354             BuildFolderList(".", 0);
 355         } else {
 356             /*
 357              * Else scan current folder
 358              */
 359             BuildFolderList(curfolder, 0);
 360         }
 361     }
 362 }
 363
 364 /*
 365  * Initial building of folder list for
 366  * the top of our search tree.
 367  */
 368
 369 void
 370 BuildFolderList(char *dirName, int searchdepth)
 371 {
 372     struct stat st;
 373
 374     /* Make sure we have a directory */
 375     if ((stat(dirName, &st) == -1) || !S_ISDIR(st.st_mode))
 376         return;
 377
 378     /*
 379      * If base directory, don't add it to the
 380      * folder list. We just recurse into it.
 381      */
 382     if (!strcmp (dirName, ".")) {
 383         BuildFolderListRecurse (".", &st, 0);
 384         return;
 385     }
 386
 387     /*
 388      * Add this folder to the list.
 389      * If recursing and directory has subfolders,
 390      * then build folder list for subfolders.
 391      */
 392     if (AddFolder(dirName, showzero) && (recurse || searchdepth) && st.st_nlink > 2)
 393         BuildFolderListRecurse(dirName, &st, searchdepth - 1);
 394 }
 395
 396 /*
 397  * Recursive building of folder list
 398  */
 399
 400 void
 401 BuildFolderListRecurse(char *dirName, struct stat *s, int searchdepth)
 402 {
 403     char *base, name[PATH_MAX];
 404     unsigned char *n;
 405     int nlinks;
 406     DIR *dir;
 407     struct dirent *dp;
 408     struct stat st;
 409
 410     /*
 411      * Keep track of number of directories we've seen so we can
 412      * stop stat'ing entries in this directory once we've seen
 413      * them all.  This optimization will fail if you have extra
 414      * directories beginning with ".", since we don't bother to
 415      * stat them.  But that shouldn't generally be a problem.
 416      */
 417     nlinks = s->st_nlink;
 418
 419     if (!(dir = opendir(dirName)))
 420         adios(dirName, "can't open directory");
 421
 422     /*
 423      * A hack so that we don't see a
 424      * leading "./" in folder names.
 425      */
 426     base = strcmp (dirName, ".") ? dirName : dirName + 1;
 427
 428     while (nlinks && (dp = readdir(dir))) {
 429         if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, "..")) {
 430             nlinks--;
 431             continue;
 432         }
 433         if (dp->d_name[0] == '.')
 434             continue;
 435         /* Check to see if the name of the file is a number
 436          * if it is, we assume it's a mail file and skip it
 437          */
 438         for (n = dp->d_name; *n && isdigit(*n); n++);
 439         if (!*n)
 440             continue;
 441         strncpy (name, base, sizeof(name) - 2);
 442         if (*base)
 443             strcat(name, "/");
 444         strncat(name, dp->d_name, sizeof(name) - strlen(name) - 1);
 445         if ((stat(name, &st) != -1) && S_ISDIR(st.st_mode)) {
 446             /*
 447              * Check if this was really a symbolic link pointing
 448              * to a directory.  If not, then decrement link count.
 449              */
 450             if (lstat (name, &st) == -1)
 451                 nlinks--;
 452             /* Add this folder to the list */
 453             if (AddFolder(name, showzero) &&
 454                         (recurse || searchdepth) && st.st_nlink > 2)
 455                 BuildFolderListRecurse(name, &st, searchdepth - 1);
 456         }
 457     }
 458     closedir(dir);
 459 }
 460
 461 /*
 462  * Add this folder to our list, counting the total number of
 463  * messages and the number of messages in each sequence.
 464  */
 465
 466 int
 467 AddFolder(char *name, int force)
 468 {
 469     int i, msgnum, nonzero;
 470     int seqnum[NUMATTRS], nSeq[NUMATTRS];
 471     struct Folder *f;
 472     struct msgs *mp;
 473
 474     /* Read folder and create message structure */
 475     if (!(mp = folder_read (name))) {
 476         /* Oops, error occurred.  Record it and continue. */
 477         AllocFolders(&folders, &nFoldersAlloced, nFolders + 1);
 478         f = &folders[nFolders++];
 479         f->name = getcpy(name);
 480         f->error = 1;
 481         f->priority = AssignPriority(f->name);
 482         return 0;
 483     }
 484
 485     for (i = 0; i < numsequences; i++) {
 486         /* Convert sequences to their sequence numbers */
 487         if (sequencesToDo[i])
 488             seqnum[i] = seq_getnum(mp, sequencesToDo[i]);
 489         else
 490             seqnum[i] = -1;
 491
 492         /* Now count messages in this sequence */
 493         nSeq[i] = 0;
 494         if (mp->nummsg > 0 && seqnum[i] != -1) {
 495             for (msgnum = mp->lowmsg; msgnum <= mp->hghmsg; msgnum++) {
 496                 if (in_sequence(mp, seqnum[i], msgnum))
 497                     nSeq[i]++;
 498             }
 499         }
 500     }
 501
 502     /* Check if any of the sequence checks were nonzero */
 503     nonzero = 0;
 504     for (i = 0; i < numsequences; i++) {
 505         if (nSeq[i] > 0) {
 506             nonzero = 1;
 507             break;
 508         }
 509     }
 510
 511     if (nonzero || force) {
 512         /* save general folder information */
 513         AllocFolders(&folders, &nFoldersAlloced, nFolders + 1);
 514         f = &folders[nFolders++];
 515         f->name = getcpy(name);
 516         f->nMsgs = mp->nummsg;
 517         f->error = 0;
 518         f->priority = AssignPriority(f->name);
 519
 520         /* record the sequence information */
 521         for (i = 0; i < numsequences; i++) {
 522             f->nSeq[i] = nSeq[i];
 523             f->private[i] = (seqnum[i] != -1) ? is_seq_private(mp, seqnum[i]) : 0;
 524         }
 525     }
 526
 527     folder_free (mp);   /* free folder/message structure */
 528     return 1;
 529 }
 530
 531 /*
 532  * Print the folder/sequence information
 533  */
 534
 535 void
 536 PrintFolders(void)
 537 {
 538     char tmpname[BUFSIZ];
 539     int i, j, len, has_private = 0;
 540     int maxfolderlen = 0, maxseqlen = 0;
 541     int maxnum = 0, maxseq = 0;
 542
 543     if (!Total) {
 544         for (i = 0; i < nFolders; i++)
 545             printf("%s\n", folders[i].name);
 546         return;
 547     }
 548
 549     /*
 550      * Find the width we need for various fields
 551      */
 552     for (i = 0; i < nFolders; ++i) {
 553         /* find the length of longest folder name */
 554         len = strlen(folders[i].name);
 555         if (len > maxfolderlen)
 556             maxfolderlen = len;
 557
 558         /* If folder had error, skip the rest */
 559         if (folders[i].error)
 560             continue;
 561
 562         /* find the maximum total messages */
 563         if (folders[i].nMsgs > maxnum)
 564             maxnum = folders[i].nMsgs;
 565
 566         for (j = 0; j < numsequences; j++) {
 567             /* find maximum width of sequence name */
 568             len = strlen (sequencesToDo[j]);
 569             if ((folders[i].nSeq[j] > 0 || showzero) && (len > maxseqlen))
 570                 maxseqlen = len;
 571
 572             /* find the maximum number of messages in sequence */
 573             if (folders[i].nSeq[j] > maxseq)
 574                 maxseq = folders[i].nSeq[j];
 575
 576             /* check if this sequence is private in any of the folders */
 577             if (folders[i].private[j])
 578                 has_private = 1;
 579         }
 580     }
 581
 582     /* Now print all the folder/sequence information */
 583     for (i = 0; i < nFolders; i++) {
 584         for (j = 0; j < numsequences; j++) {
 585             if (folders[i].nSeq[j] > 0 || showzero) {
 586                 /* Add `+' to end of name of current folder */
 587                 if (strcmp(curfolder, folders[i].name))
 588                     snprintf(tmpname, sizeof(tmpname), "%s", folders[i].name);
 589                 else
 590                     snprintf(tmpname, sizeof(tmpname), "%s+", folders[i].name);
 591
 592                 if (folders[i].error) {
 593                     printf("%-*s is unreadable\n", maxfolderlen+1, tmpname);
 594                     continue;
 595                 }
 596
 597                 printf("%-*s has %*d in sequence %-*s%s; out of %*d\n",
 598                        maxfolderlen+1, tmpname,
 599                        num_digits(maxseq), folders[i].nSeq[j],
 600                        maxseqlen, sequencesToDo[j],
 601                        !has_private ? "" : folders[i].private[j] ? " (private)" : "          ",
 602                        num_digits(maxnum), folders[i].nMsgs);
 603             }
 604         }
 605     }
 606 }
 607
 608 /*
 609  * Put them in priority order.
 610  */
 611
 612 int
 613 CompareFolders(struct Folder *f1, struct Folder *f2)
 614 {
 615     if (!alphaOrder && f1->priority != f2->priority)
 616         return f1->priority - f2->priority;
 617     else
 618         return strcmp(f1->name, f2->name);
 619 }
 620
 621 /*
 622  * Make sure we have at least n folders allocated.
 623  */
 624
 625 void
 626 AllocFolders(struct Folder **f, int *nfa, int n)
 627 {
 628     if (n <= *nfa)
 629         return;
 630     if (*f == NULL) {
 631         *nfa = 10;
 632         *f = (struct Folder *) mh_xmalloc (*nfa * (sizeof(struct Folder)));
 633     } else {
 634         *nfa *= 2;
 635         *f = (struct Folder *) mh_xrealloc (*f, *nfa * (sizeof(struct Folder)));
 636     }
 637 }
 638
 639 /*
 640  * Return the priority for a name.  The highest comes from an exact match.
 641  * After that, the longest match (then first) assigns the priority.
 642  */
 643 int
 644 AssignPriority(char *name)
 645 {
 646     int i, ol, nl;
 647     int best = nOrders;
 648     int bestLen = 0;
 649     struct Folder *o;
 650
 651     nl = strlen(name);
 652     for (i = 0; i < nOrders; ++i) {
 653         o = &orders[i];
 654         if (!strcmp(name, o->name))
 655             return o->priority;
 656         ol = strlen(o->name);
 657         if (nl < ol - 1)
 658             continue;
 659         if (ol < bestLen)
 660             continue;
 661         if (o->name[0] == '*' && !strcmp(o->name + 1, name + (nl - ol + 1))) {
 662             best = o->priority;
 663             bestLen = ol;
 664         } else if (o->name[ol - 1] == '*' && strncmp(o->name, name, ol - 1) == 0) {
 665             best = o->priority;
 666             bestLen = ol;
 667         }
 668     }
 669     return best;
 670 }
 671
 672 /*
 673  * Do the read only folders
 674  */
 675
 676 static void
 677 do_readonly_folders (void)
 678 {
 679     int atrlen;
 680     char atrcur[BUFSIZ];
 681     register struct node *np;
 682
 683     snprintf (atrcur, sizeof(atrcur), "atr-%s-", current);
 684     atrlen = strlen (atrcur);
 685
 686     for (np = m_defs; np; np = np->n_next)
 687         if (ssequal (atrcur, np->n_name)
 688                 && !ssequal (nmhdir, np->n_name + atrlen))
 689             BuildFolderList (np->n_name + atrlen, 0);
 690 }