2 * flist.c -- list nmh folders containing messages
3 * -- in a given sequence
6 * David Nichols, Xerox-PARC, November, 1992
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
25 * We allocate space to record the names of folders
26 * (foldersToDo array), this number of elements at a time.
28 #define MAXFOLDERS 100
31 static struct swit switches[] = {
33 { "sequence name", 0 },
66 char *name; /* name of folder */
68 int error; /* error == 1 for unreadable folder */
69 int nMsgs; /* number of messages in folder */
70 int nSeq[NUMATTRS]; /* number of messages in each sequence */
71 int private[NUMATTRS]; /* is given sequence, public or private */
74 static struct Folder *orders = NULL;
75 static int nOrders = 0;
76 static int nOrdersAlloced = 0;
77 static struct Folder *folders = NULL;
78 static int nFolders = 0;
79 static int nFoldersAlloced = 0;
81 /* info on folders to search */
82 static char **foldersToDo;
83 static int numfolders;
84 static int maxfolders;
86 /* info on sequences to search for */
87 static char *sequencesToDo[NUMATTRS];
88 static int numsequences;
90 static int all = FALSE; /* scan all folders in top level? */
91 static int alphaOrder = FALSE; /* want alphabetical order only */
92 static int recurse = FALSE; /* show nested folders? */
93 static int showzero = TRUE; /* show folders even if no messages in seq? */
94 static int Total = TRUE; /* display info on number of messages in *
95 * sequence found, and total num messages */
97 static char curfolder[BUFSIZ]; /* name of the current folder */
98 static char *nmhdir; /* base nmh mail directory */
101 * Type for a compare function for qsort. This keeps
102 * the compiler happy.
104 typedef int (*qsort_comp) (const void *, const void *);
109 int CompareFolders(struct Folder *, struct Folder *);
110 void GetFolderOrder(void);
111 void ScanFolders(void);
112 int AddFolder(char *, int);
113 void BuildFolderList(char *, int);
114 void BuildFolderListRecurse(char *, struct stat *, int);
115 void PrintFolders(void);
116 static int num_digits (int);
117 void AllocFolders(struct Folder **, int *, int);
118 int AssignPriority(char *);
119 static void do_readonly_folders(void);
124 main(int argc, char **argv)
131 setlocale(LC_ALL, "");
133 invo_name = r1bindex(argv[0], '/');
135 /* read user profile/context */
139 * If program was invoked with name ending
140 * in `s', then add switch `-all'.
142 if (argv[0][strlen (argv[0]) - 1] == 's')
145 arguments = getarguments (invo_name, argc, argv, 1);
148 /* allocate the initial space to record the folder names */
150 maxfolders = MAXFOLDERS;
151 if (!(foldersToDo = (char **) malloc ((size_t) (maxfolders * sizeof(*foldersToDo)))))
152 adios (NULL, "unable to allocate folder storage");
154 /* no sequences yet */
157 /* parse arguments */
158 while ((cp = *argp++)) {
160 switch (smatch(++cp, switches)) {
162 ambigsw(cp, switches);
165 adios(NULL, "-%s unknown", cp);
168 snprintf(buf, sizeof(buf), "%s [+folder1 [+folder2 ...]][switches]",
170 print_help(buf, switches, 1);
173 print_version(invo_name);
177 if (!(cp = *argp++) || *cp == '-')
178 adios (NULL, "missing argument to %s", argp[-2]);
180 /* check if too many sequences specified */
181 if (numsequences >= NUMATTRS)
182 adios (NULL, "too many sequences (more than %d) specified", NUMATTRS);
183 sequencesToDo[numsequences++] = cp;
226 * Check if we need to allocate more space
229 if (numfolders >= maxfolders) {
230 maxfolders += MAXFOLDERS;
231 if (!(foldersToDo = (char **) realloc (foldersToDo,
232 (size_t) (maxfolders * sizeof(*foldersToDo)))))
233 adios (NULL, "unable to reallocate folder name storage");
237 foldersToDo[numfolders++] = cp;
241 if (!context_find ("path"))
242 free (path ("./", TFOLDER));
244 /* get current folder */
245 strncpy (curfolder, getfolder(1), sizeof(curfolder));
247 /* get nmh base directory */
248 nmhdir = m_maildir ("");
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.
257 if (numsequences == 0) {
258 if ((cp = context_find(usequence)) && *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);
268 sequencesToDo[numsequences++] = *ap;
271 adios (NULL, "no sequence specified or %s profile entry found", usequence);
277 qsort(folders, nFolders, sizeof(struct Folder), (qsort_comp) CompareFolders);
283 * Read the Flist-Order profile entry to determine
284 * how to sort folders for output.
294 if (!(p = context_find("Flist-Order")))
300 while (*p && !isspace(*p))
304 AllocFolders(&orders, &nOrdersAlloced, nOrders + 1);
305 o = &orders[nOrders++];
306 o->priority = priority++;
307 o->name = (char *) malloc(p - s + 1);
308 strncpy(o->name, s, p - s);
316 * Scan all the necessary folders
325 * change directory to base of nmh directory
327 if (chdir (nmhdir) == NOTOK)
328 adios (nmhdir, "unable to change directory to");
330 if (numfolders > 0) {
332 strncpy (curfolder, foldersToDo[numfolders - 1], sizeof(curfolder));
333 context_replace (pfolder, curfolder);/* update current folder */
334 context_save (); /* save the context file */
337 * Scan each given folder. If -all is given,
338 * then also scan the 1st level subfolders under
341 for (i = 0; i < numfolders; ++i)
342 BuildFolderList(foldersToDo[i], all ? 1 : 0);
346 * Do the readonly folders
348 do_readonly_folders();
351 * Now scan the entire nmh directory for folders
353 BuildFolderList(".", 0);
356 * Else scan current folder
358 BuildFolderList(curfolder, 0);
364 * Initial building of folder list for
365 * the top of our search tree.
369 BuildFolderList(char *dirName, int searchdepth)
373 /* Make sure we have a directory */
374 if ((stat(dirName, &st) == -1) || !S_ISDIR(st.st_mode))
378 * If base directory, don't add it to the
379 * folder list. We just recurse into it.
381 if (!strcmp (dirName, ".")) {
382 BuildFolderListRecurse (".", &st, 0);
387 * Add this folder to the list.
388 * If recursing and directory has subfolders,
389 * then build folder list for subfolders.
391 if (AddFolder(dirName, showzero) && (recurse || searchdepth) && st.st_nlink > 2)
392 BuildFolderListRecurse(dirName, &st, searchdepth - 1);
396 * Recursive building of folder list
400 BuildFolderListRecurse(char *dirName, struct stat *s, int searchdepth)
402 char *base, name[PATH_MAX];
409 * Keep track of number of directories we've seen so we can
410 * stop stat'ing entries in this directory once we've seen
411 * them all. This optimization will fail if you have extra
412 * directories beginning with ".", since we don't bother to
413 * stat them. But that shouldn't generally be a problem.
415 nlinks = s->st_nlink;
417 if (!(dir = opendir(dirName)))
418 adios(dirName, "can't open directory");
421 * A hack so that we don't see a
422 * leading "./" in folder names.
424 base = strcmp (dirName, ".") ? dirName : dirName + 1;
426 while (nlinks && (dp = readdir(dir))) {
427 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, "..")) {
431 if (dp->d_name[0] == '.')
433 strncpy (name, base, sizeof(name) - 2);
436 strncat(name, dp->d_name, sizeof(name) - strlen(name) - 1);
437 if ((stat(name, &st) != -1) && S_ISDIR(st.st_mode)) {
439 * Check if this was really a symbolic link pointing
440 * to a directory. If not, then decrement link count.
442 if (lstat (name, &st) == -1)
444 /* Add this folder to the list */
445 if (AddFolder(name, showzero) &&
446 (recurse || searchdepth) && st.st_nlink > 2)
447 BuildFolderListRecurse(name, &st, searchdepth - 1);
454 * Add this folder to our list, counting the total number of
455 * messages and the number of messages in each sequence.
459 AddFolder(char *name, int force)
461 int i, msgnum, nonzero;
462 int seqnum[NUMATTRS], nSeq[NUMATTRS];
466 /* Read folder and create message structure */
467 if (!(mp = folder_read (name))) {
468 /* Oops, error occurred. Record it and continue. */
469 AllocFolders(&folders, &nFoldersAlloced, nFolders + 1);
470 f = &folders[nFolders++];
471 f->name = getcpy(name);
473 f->priority = AssignPriority(f->name);
477 for (i = 0; i < numsequences; i++) {
478 /* Convert sequences to their sequence numbers */
479 if (sequencesToDo[i])
480 seqnum[i] = seq_getnum(mp, sequencesToDo[i]);
484 /* Now count messages in this sequence */
486 if (mp->nummsg > 0 && seqnum[i] != -1) {
487 for (msgnum = mp->lowmsg; msgnum <= mp->hghmsg; msgnum++) {
488 if (in_sequence(mp, seqnum[i], msgnum))
494 /* Check if any of the sequence checks were nonzero */
496 for (i = 0; i < numsequences; i++) {
503 if (nonzero || force) {
504 /* save general folder information */
505 AllocFolders(&folders, &nFoldersAlloced, nFolders + 1);
506 f = &folders[nFolders++];
507 f->name = getcpy(name);
508 f->nMsgs = mp->nummsg;
510 f->priority = AssignPriority(f->name);
512 /* record the sequence information */
513 for (i = 0; i < numsequences; i++) {
514 f->nSeq[i] = nSeq[i];
515 f->private[i] = (seqnum[i] != -1) ? is_seq_private(mp, seqnum[i]) : 0;
519 folder_free (mp); /* free folder/message structure */
524 * Print the folder/sequence information
530 char tmpname[BUFSIZ];
531 int i, j, len, has_private = 0;
532 int maxfolderlen = 0, maxseqlen = 0;
533 int maxnum = 0, maxseq = 0;
536 for (i = 0; i < nFolders; i++)
537 printf("%s\n", folders[i].name);
542 * Find the width we need for various fields
544 for (i = 0; i < nFolders; ++i) {
545 /* find the length of longest folder name */
546 len = strlen(folders[i].name);
547 if (len > maxfolderlen)
550 /* If folder had error, skip the rest */
551 if (folders[i].error)
554 /* find the maximum total messages */
555 if (folders[i].nMsgs > maxnum)
556 maxnum = folders[i].nMsgs;
558 for (j = 0; j < numsequences; j++) {
559 /* find maximum width of sequence name */
560 len = strlen (sequencesToDo[j]);
561 if ((folders[i].nSeq[j] > 0 || showzero) && (len > maxseqlen))
564 /* find the maximum number of messages in sequence */
565 if (folders[i].nSeq[j] > maxseq)
566 maxseq = folders[i].nSeq[j];
568 /* check if this sequence is private in any of the folders */
569 if (folders[i].private[j])
574 /* Now print all the folder/sequence information */
575 for (i = 0; i < nFolders; i++) {
576 for (j = 0; j < numsequences; j++) {
577 if (folders[i].nSeq[j] > 0 || showzero) {
578 /* Add `+' to end of name of current folder */
579 if (strcmp(curfolder, folders[i].name))
580 snprintf(tmpname, sizeof(tmpname), "%s", folders[i].name);
582 snprintf(tmpname, sizeof(tmpname), "%s+", folders[i].name);
584 if (folders[i].error) {
585 printf("%-*s is unreadable\n", maxfolderlen+1, tmpname);
589 printf("%-*s has %*d in sequence %-*s%s; out of %*d\n",
590 maxfolderlen+1, tmpname,
591 num_digits(maxseq), folders[i].nSeq[j],
592 maxseqlen, sequencesToDo[j],
593 !has_private ? "" : folders[i].private[j] ? " (private)" : " ",
594 num_digits(maxnum), folders[i].nMsgs);
601 * Calculate the number of digits in a nonnegative integer
610 adios (NULL, "oops, num_digits called with negative value");
624 * Put them in priority order.
628 CompareFolders(struct Folder *f1, struct Folder *f2)
630 if (!alphaOrder && f1->priority != f2->priority)
631 return f1->priority - f2->priority;
633 return strcmp(f1->name, f2->name);
637 * Make sure we have at least n folders allocated.
641 AllocFolders(struct Folder **f, int *nfa, int n)
647 *f = (struct Folder *) malloc (*nfa * (sizeof(struct Folder)));
650 *f = (struct Folder *) realloc (*f, *nfa * (sizeof(struct Folder)));
655 * Return the priority for a name. The highest comes from an exact match.
656 * After that, the longest match (then first) assigns the priority.
659 AssignPriority(char *name)
667 for (i = 0; i < nOrders; ++i) {
669 if (!strcmp(name, o->name))
671 ol = strlen(o->name);
676 if (o->name[0] == '*' && !strcmp(o->name + 1, name + (nl - ol + 1))) {
679 } else if (o->name[ol - 1] == '*' && strncmp(o->name, name, ol - 1) == 0) {
688 * Do the read only folders
692 do_readonly_folders (void)
696 register struct node *np;
698 /* sanity check - check that context has been read */
700 adios (NULL, "oops, context hasn't been read yet");
702 snprintf (atrcur, sizeof(atrcur), "atr-%s-", current);
703 atrlen = strlen (atrcur);
705 for (np = m_defs; np; np = np->n_next)
706 if (ssequal (atrcur, np->n_name)
707 && !ssequal (nmhdir, np->n_name + atrlen))
708 BuildFolderList (np->n_name + atrlen, 0);