* sbr/m_draft.c, sbr/utils.c, uip/folder.c, uip/inc.c, uip/mhstoresbr.c,
[mmh] / uip / folder.c
1
2 /*
3  * folder(s).c -- set/list the current message and/or folder
4  *             -- push/pop a folder onto/from the folder stack
5  *             -- list the folder stack
6  *
7  * $Id$
8  *
9  * This code is Copyright (c) 2002, by the authors of nmh.  See the
10  * COPYRIGHT file in the root directory of the nmh distribution for
11  * complete copyright information.
12  */
13
14 #include <h/mh.h>
15 #include <h/utils.h>
16 #include <errno.h>
17
18 static struct swit switches[] = {
19 #define ALLSW           0
20     { "all", 0 },
21 #define NALLSW          1
22     { "noall", 0 },
23 #define CREATSW         2
24     { "create", 0 },
25 #define NCREATSW        3
26     { "nocreate", 0 },
27 #define FASTSW          4
28     { "fast", 0 },
29 #define NFASTSW         5
30     { "nofast", 0 },
31 #define HDRSW           6
32     { "header", 0 },
33 #define NHDRSW          7
34     { "noheader", 0 },
35 #define PACKSW          8
36     { "pack", 0 },
37 #define NPACKSW         9
38     { "nopack", 0 },
39 #define VERBSW         10
40     { "verbose", 0 },
41 #define NVERBSW        11
42     { "noverbose", 0 },
43 #define RECURSW        12
44     { "recurse", 0 },
45 #define NRECRSW        13
46     { "norecurse", 0 },
47 #define TOTALSW        14
48     { "total", 0 },
49 #define NTOTLSW        15
50     { "nototal", 0 },
51 #define LISTSW         16
52     { "list", 0 },
53 #define NLISTSW        17
54     { "nolist", 0 },
55 #define PRNTSW         18
56     { "print", 0 },
57 #define NPRNTSW        19
58     { "noprint", -4 },
59 #define PUSHSW         20
60     { "push", 0 },
61 #define POPSW          21
62     { "pop", 0 },
63 #define VERSIONSW      22
64     { "version", 0 },
65 #define HELPSW         23
66     { "help", 0 },
67     { NULL, 0 }
68 };
69
70 static int fshort   = 0;        /* output only folder names                 */
71 static int fcreat   = 0;        /* should we ask to create new folders?     */
72 static int fpack    = 0;        /* are we packing the folder?               */
73 static int fverb    = 0;        /* print actions taken while packing folder */
74 static int fheader  = 0;        /* should we output a header?               */
75 static int frecurse = 0;        /* recurse through subfolders               */
76 static int ftotal   = 0;        /* should we output the totals?             */
77 static int all      = 0;        /* should we output all folders             */
78
79 static int total_folders = 0;   /* total number of folders                  */
80
81 static int start = 0;
82 static int foldp = 0;
83
84 static char *nmhdir;
85 static char *stack = "Folder-Stack";
86 static char folder[BUFSIZ];
87
88 #define NUMFOLDERS 100
89
90 /*
91  * This is how many folders we currently can hold in the array
92  * `folds'.  We increase this amount by NUMFOLDERS at a time.
93  */
94 static int maxfolders;
95 static char **folds;
96
97 /*
98  * Structure to hold information about
99  * folders as we scan them.
100  */
101 struct FolderInfo {
102     char *name;
103     int nummsg;
104     int curmsg;
105     int lowmsg;
106     int hghmsg;
107     int others;         /* others == 1 if other files in folder */
108     int error;          /* error == 1 for unreadable folder     */
109 };
110
111 /*
112  * Dynamically allocated space to hold
113  * all the folder information.
114  */
115 static struct FolderInfo *fi;
116 static int maxFolderInfo;
117
118 /*
119  * static prototypes
120  */
121 static void dodir (char *);
122 static int get_folder_info (char *, char *);
123 static void print_folders (void);
124 static int num_digits (int);
125 static int sfold (struct msgs *, char *);
126 static void addir (char *);
127 static void addfold (char *);
128 static int compare (char *, char *);
129 static void readonly_folders (void);
130
131
132 int
133 main (int argc, char **argv)
134 {
135     int printsw = 0, listsw = 0;
136     int pushsw = 0, popsw = 0;
137     char *cp, *dp, *msg = NULL, *argfolder = NULL;
138     char **ap, **argp, buf[BUFSIZ], **arguments;
139     struct stat st;
140
141 #ifdef LOCALE
142     setlocale(LC_ALL, "");
143 #endif
144     invo_name = r1bindex (argv[0], '/');
145
146     /* read user profile/context */
147     context_read();
148
149     /*
150      * If program was invoked with name ending
151      * in `s', then add switch `-all'.
152      */
153     if (argv[0][strlen (argv[0]) - 1] == 's')
154         all = 1;
155
156     arguments = getarguments (invo_name, argc, argv, 1);
157     argp = arguments;
158
159     while ((cp = *argp++)) {
160         if (*cp == '-') {
161             switch (smatch (++cp, switches)) {
162                 case AMBIGSW: 
163                     ambigsw (cp, switches);
164                     done (1);
165                 case UNKWNSW: 
166                     adios (NULL, "-%s unknown", cp);
167
168                 case HELPSW: 
169                     snprintf (buf, sizeof(buf), "%s [+folder] [msg] [switches]",
170                         invo_name);
171                     print_help (buf, switches, 1);
172                     done (1);
173                 case VERSIONSW:
174                     print_version(invo_name);
175                     done (1);
176
177                 case ALLSW: 
178                     all = 1;
179                     continue;
180
181                 case NALLSW:
182                     all = 0;
183                     continue;
184
185                 case CREATSW: 
186                     fcreat = 1;
187                     continue;
188                 case NCREATSW: 
189                     fcreat = -1;
190                     continue;
191
192                 case FASTSW: 
193                     fshort++;
194                     continue;
195                 case NFASTSW: 
196                     fshort = 0;
197                     continue;
198
199                 case HDRSW: 
200                     fheader = 1;
201                     continue;
202                 case NHDRSW: 
203                     fheader = -1;
204                     continue;
205
206                 case PACKSW: 
207                     fpack++;
208                     continue;
209                 case NPACKSW: 
210                     fpack = 0;
211                     continue;
212
213                 case VERBSW:
214                     fverb++;
215                     continue;
216                 case NVERBSW:
217                     fverb = 0;
218                     continue;
219
220                 case RECURSW: 
221                     frecurse++;
222                     continue;
223                 case NRECRSW: 
224                     frecurse = 0;
225                     continue;
226
227                 case TOTALSW: 
228                     ftotal = 1;
229                     continue;
230                 case NTOTLSW: 
231                     ftotal = -1;
232                     continue;
233
234                 case PRNTSW: 
235                     printsw = 1;
236                     continue;
237                 case NPRNTSW: 
238                     printsw = 0;
239                     continue;
240
241                 case LISTSW: 
242                     listsw = 1;
243                     continue;
244                 case NLISTSW: 
245                     listsw = 0;
246                     continue;
247
248                 case PUSHSW: 
249                     pushsw = 1;
250                     listsw = 1;
251                     popsw  = 0;
252                     continue;
253                 case POPSW: 
254                     popsw  = 1;
255                     listsw = 1;
256                     pushsw = 0;
257                     continue;
258             }
259         }
260         if (*cp == '+' || *cp == '@') {
261             if (argfolder)
262                 adios (NULL, "only one folder at a time!");
263             else
264                 argfolder = path (cp + 1, *cp == '+' ? TFOLDER : TSUBCWF);
265         } else {
266             if (msg)
267                 adios (NULL, "only one (current) message at a time!");
268             else
269                 msg = cp;
270         }
271     }
272
273     if (!context_find ("path"))
274         free (path ("./", TFOLDER));
275     nmhdir = concat (m_maildir (""), "/", NULL);
276
277     /*
278      * If we aren't working with the folder stack
279      * (-push, -pop, -list) then the default is to print.
280      */
281     if (pushsw == 0 && popsw == 0 && listsw == 0)
282         printsw++;
283
284     /* Pushing a folder onto the folder stack */
285     if (pushsw) {
286         if (!argfolder) {
287             /* If no folder is given, the current folder and */
288             /* the top of the folder stack are swapped.      */
289             if ((cp = context_find (stack))) {
290                 dp = getcpy (cp);
291                 ap = brkstring (dp, " ", "\n");
292                 argfolder = getcpy(*ap++);
293             } else {
294                 adios (NULL, "no other folder");
295             }
296             for (cp = getcpy (getfolder (1)); *ap; ap++)
297                 cp = add (*ap, add (" ", cp));
298             free (dp);
299             context_replace (stack, cp);        /* update folder stack */
300         } else {
301             /* update folder stack */
302             context_replace (stack,
303                     (cp = context_find (stack))
304                     ? concat (getfolder (1), " ", cp, NULL)
305                     : getcpy (getfolder (1)));
306         }
307     }
308
309     /* Popping a folder off of the folder stack */
310     if (popsw) {
311         if (argfolder)
312             adios (NULL, "sorry, no folders allowed with -pop");
313         if ((cp = context_find (stack))) {
314             dp = getcpy (cp);
315             ap = brkstring (dp, " ", "\n");
316             argfolder = getcpy(*ap++);
317         } else {
318             adios (NULL, "folder stack empty");
319         }
320         if (*ap) {
321             /* if there's anything left in the stack */
322             cp = getcpy (*ap++);
323             for (; *ap; ap++)
324                 cp = add (*ap, add (" ", cp));
325             context_replace (stack, cp);        /* update folder stack */
326         } else {
327             context_del (stack);        /* delete folder stack entry from context */
328         }
329         free (dp);
330     }
331     if (pushsw || popsw) {
332         cp = m_maildir(argfolder);
333         if (access (cp, F_OK) == NOTOK)
334             adios (cp, "unable to find folder");
335         context_replace (pfolder, argfolder);   /* update current folder   */
336         context_save ();                /* save the context file   */
337         argfolder = NULL;
338     }
339
340     /* Listing the folder stack */
341     if (listsw) {
342         printf ("%s", argfolder ? argfolder : getfolder (1));
343         if ((cp = context_find (stack))) {
344             dp = getcpy (cp);
345             for (ap = brkstring (dp, " ", "\n"); *ap; ap++)
346                 printf (" %s", *ap);
347             free (dp);
348         }
349         printf ("\n");
350
351         if (!printsw)
352             done (0);
353     }
354
355     /* Allocate initial space to record folder names */
356     maxfolders = NUMFOLDERS;
357     folds = mh_xmalloc (maxfolders * sizeof(char *));
358
359     /* Allocate initial space to record folder information */
360     maxFolderInfo = NUMFOLDERS;
361     fi = mh_xmalloc (maxFolderInfo * sizeof(*fi));
362
363     /*
364      * Scan the folders
365      */
366     if (all || ftotal > 0) {
367         /*
368          * If no folder is given, do them all
369          */
370         if (!argfolder) {
371             if (msg)
372                 admonish (NULL, "no folder given for message %s", msg);
373             readonly_folders (); /* do any readonly folders */
374             strncpy (folder, (cp = context_find (pfolder)) ? cp : "", sizeof(folder));
375             dodir (".");
376         } else {
377             strncpy (folder, argfolder, sizeof(folder));
378             if (get_folder_info (argfolder, msg)) {
379                 context_replace (pfolder, argfolder);/* update current folder */
380                 context_save ();                     /* save the context file */
381             }
382             /*
383              * Since recurse wasn't done in get_folder_info(),
384              * we still need to list all level-1 sub-folders.
385              */
386             if (!frecurse)
387                 dodir (folder);
388         }
389     } else {
390         strncpy (folder, argfolder ? argfolder : getfolder (1), sizeof(folder));
391
392         /*
393          * Check if folder exists.  If not, then see if
394          * we should create it, or just exit.
395          */
396         create_folder (m_maildir (folder), fcreat, done);
397
398         if (get_folder_info (folder, msg) && argfolder) {
399             /* update current folder */
400             context_replace (pfolder, argfolder);
401             }
402     }
403
404     /*
405      * Print out folder information
406      */
407     print_folders();
408
409     context_save ();    /* save the context file */
410     return done (0);
411 }
412
413 /*
414  * Base routine for scanning a folder
415  */
416
417 static void
418 dodir (char *dir)
419 {
420     int i;
421     int os = start;
422     int of = foldp;
423     char buffer[BUFSIZ];
424
425     start = foldp;
426
427     /* change directory to base of nmh directory */
428     if (chdir (nmhdir) == NOTOK)
429         adios (nmhdir, "unable to change directory to");
430
431     addir (strncpy (buffer, dir, sizeof(buffer)));
432
433     for (i = start; i < foldp; i++) {
434         get_folder_info (folds[i], NULL);
435         fflush (stdout);
436     }
437
438     start = os;
439     foldp = of;
440 }
441
442 static int
443 get_folder_info (char *fold, char *msg)
444 {
445     int i, retval = 1;
446     char *mailfile;
447     struct msgs *mp = NULL;
448
449     i = total_folders++;
450
451     /*
452      * if necessary, reallocate the space
453      * for folder information
454      */
455     if (total_folders >= maxFolderInfo) {
456         maxFolderInfo += NUMFOLDERS;
457         fi = mh_xrealloc (fi, maxFolderInfo * sizeof(*fi));
458     }
459
460     fi[i].name   = fold;
461     fi[i].nummsg = 0;
462     fi[i].curmsg = 0;
463     fi[i].lowmsg = 0;
464     fi[i].hghmsg = 0;
465     fi[i].others = 0;
466     fi[i].error  = 0;
467
468     mailfile = m_maildir (fold);
469
470     if (!chdir (mailfile)) {
471         if ((ftotal > 0) || !fshort || msg || fpack) {
472             /*
473              * create message structure and get folder info
474              */
475             if (!(mp = folder_read (fold))) {
476                 admonish (NULL, "unable to read folder %s", fold);
477                 return 0;
478             }
479
480             /* set the current message */
481             if (msg && !sfold (mp, msg))
482                 retval = 0;
483
484             if (fpack) {
485                 if (folder_pack (&mp, fverb) == -1)
486                     done (1);
487                 seq_save (mp);          /* synchronize the sequences */
488                 context_save ();        /* save the context file     */
489             }
490
491             /* record info for this folder */
492             if ((ftotal > 0) || !fshort) {
493                 fi[i].nummsg = mp->nummsg;
494                 fi[i].curmsg = mp->curmsg;
495                 fi[i].lowmsg = mp->lowmsg;
496                 fi[i].hghmsg = mp->hghmsg;
497                 fi[i].others = other_files (mp);
498             }
499
500             folder_free (mp); /* free folder/message structure */
501         }
502     } else {
503         fi[i].error = 1;
504     }
505
506     if (frecurse && (fshort || fi[i].others) && (fi[i].error == 0))
507         dodir (fold);
508     return retval;
509 }
510
511 /*
512  * Print folder information
513  */
514
515 static void
516 print_folders (void)
517 {
518     int i, len, hasempty = 0, curprinted;
519     int maxlen = 0, maxnummsg = 0, maxlowmsg = 0;
520     int maxhghmsg = 0, maxcurmsg = 0, total_msgs = 0;
521     int nummsgdigits, lowmsgdigits;
522     int hghmsgdigits, curmsgdigits;
523     char tmpname[BUFSIZ];
524
525     /*
526      * compute a few values needed to for
527      * printing various fields
528      */
529     for (i = 0; i < total_folders; i++) {
530         /* length of folder name */
531         len = strlen (fi[i].name);
532         if (len > maxlen)
533             maxlen = len;
534
535         /* If folder has error, skip the rest */
536         if (fi[i].error)
537             continue;
538
539         /* calculate total number of messages */
540         total_msgs += fi[i].nummsg;
541
542         /* maximum number of messages */
543         if (fi[i].nummsg > maxnummsg)
544             maxnummsg = fi[i].nummsg;
545
546         /* maximum low message */
547         if (fi[i].lowmsg > maxlowmsg)
548             maxlowmsg = fi[i].lowmsg;
549
550         /* maximum high message */
551         if (fi[i].hghmsg > maxhghmsg)
552             maxhghmsg = fi[i].hghmsg;
553
554         /* maximum current message */
555         if (fi[i].curmsg >= fi[i].lowmsg &&
556             fi[i].curmsg <= fi[i].hghmsg &&
557             fi[i].curmsg > maxcurmsg)
558             maxcurmsg = fi[i].curmsg;
559
560         /* check for empty folders */
561         if (fi[i].nummsg == 0)
562             hasempty = 1;
563     }
564     nummsgdigits = num_digits (maxnummsg);
565     lowmsgdigits = num_digits (maxlowmsg);
566     hghmsgdigits = num_digits (maxhghmsg);
567     curmsgdigits = num_digits (maxcurmsg);
568
569     if (hasempty && nummsgdigits < 2)
570         nummsgdigits = 2;
571
572     /*
573      * Print the header
574      */
575     if (fheader > 0 || (all && !fshort && fheader >= 0))
576         printf ("%-*s %*s %-*s; %-*s %*s\n",
577                 maxlen+1, "FOLDER",
578                 nummsgdigits + 13, "# MESSAGES",
579                 lowmsgdigits + hghmsgdigits + 4, " RANGE",
580                 curmsgdigits + 4, "CUR",
581                 9, "(OTHERS)");
582
583     /*
584      * Print folder information
585      */
586     if (all || fshort || ftotal < 1) {
587         for (i = 0; i < total_folders; i++) {
588             if (fshort) {
589                 printf ("%s\n", fi[i].name);
590                 continue;
591             }
592
593             /* Add `+' to end of name, if folder is current */
594             if (strcmp (folder, fi[i].name))
595                 snprintf (tmpname, sizeof(tmpname), "%s", fi[i].name);
596             else
597                 snprintf (tmpname, sizeof(tmpname), "%s+", fi[i].name);
598
599             if (fi[i].error) {
600                 printf ("%-*s is unreadable\n", maxlen+1, tmpname);
601                 continue;
602             }
603
604             printf ("%-*s ", maxlen+1, tmpname);
605
606             curprinted = 0; /* remember if we print cur */
607             if (fi[i].nummsg == 0) {
608                 printf ("has %*s messages%*s",
609                         nummsgdigits, "no",
610                         fi[i].others ? lowmsgdigits + hghmsgdigits + 5 : 0, "");
611             } else {
612                 printf ("has %*d message%s  (%*d-%*d)",
613                         nummsgdigits, fi[i].nummsg,
614                         (fi[i].nummsg == 1) ? " " : "s",
615                         lowmsgdigits, fi[i].lowmsg,
616                         hghmsgdigits, fi[i].hghmsg);
617                 if (fi[i].curmsg >= fi[i].lowmsg && fi[i].curmsg <= fi[i].hghmsg) {
618                     curprinted = 1;
619                     printf ("; cur=%*d", curmsgdigits, fi[i].curmsg);
620                 }
621             }
622
623             if (fi[i].others)
624                 printf (";%*s (others)", curprinted ? 0 : curmsgdigits + 6, "");
625             printf (".\n");
626         }
627     }
628
629     /*
630      * Print folder/message totals
631      */
632     if (ftotal > 0 || (all && !fshort && ftotal >= 0)) {
633         if (all)
634             printf ("\n");
635         printf ("TOTAL = %d message%c in %d folder%s.\n",
636                 total_msgs, total_msgs != 1 ? 's' : ' ',
637                 total_folders, total_folders != 1 ? "s" : "");
638     }
639
640     fflush (stdout);
641 }
642
643 /*
644  * Calculate the number of digits in a nonnegative integer
645  */
646 int
647 num_digits (int n)
648 {
649     int ndigits = 0;
650
651     /* Sanity check */
652     if (n < 0)
653         adios (NULL, "oops, num_digits called with negative value");
654
655     if (n == 0)
656         return 1;
657
658     while (n) {
659         n /= 10;
660         ndigits++;
661     }
662
663     return ndigits;
664 }
665
666 /*
667  * Set the current message and sychronize sequences
668  */
669
670 static int
671 sfold (struct msgs *mp, char *msg)
672 {
673     /* parse the message range/sequence/name and set SELECTED */
674     if (!m_convert (mp, msg))
675         return 0;
676
677     if (mp->numsel > 1) {
678         admonish (NULL, "only one message at a time!");
679         return 0;
680     }
681     seq_setprev (mp);           /* set the previous-sequence     */
682     seq_setcur (mp, mp->lowsel);/* set current message           */
683     seq_save (mp);              /* synchronize message sequences */
684     context_save ();            /* save the context file         */
685
686     return 1;
687 }
688
689
690 static void
691 addir (char *name)
692 {
693     int nlink;
694     char *base, *cp;
695     struct stat st;
696     struct dirent *dp;
697     DIR * dd;
698
699     cp = name + strlen (name);
700     *cp++ = '/';
701     *cp = '\0';
702
703     /*
704      * A hack to skip over a leading
705      * "./" in folder names.
706      */
707     base = strcmp (name, "./") ? name : name + 2;
708
709    /* short-cut to see if directory has any sub-directories */
710     if (stat (name, &st) != -1 && st.st_nlink == 2)
711         return;
712  
713     if (!(dd = opendir (name))) {
714         admonish (name, "unable to read directory ");
715         return;
716     }
717
718     /*
719      * Keep track of the number of directories we've seen
720      * so we can quit stat'ing early, if we've seen them all.
721      */
722     nlink = st.st_nlink;
723
724     while (nlink && (dp = readdir (dd))) {
725         if (!strcmp (dp->d_name, ".") || !strcmp (dp->d_name, "..")) {
726             nlink--;
727             continue;
728         }
729         if (cp + NLENGTH(dp) + 2 >= name + BUFSIZ)
730             continue;
731         strcpy (cp, dp->d_name);
732         if (stat (name, &st) != -1 && S_ISDIR(st.st_mode)) {
733             /*
734              * Check if this was really a symbolic link pointing at
735              * a directory.  If not, then decrement link count.
736              */
737             if (lstat (name, &st) == -1)
738                 nlink--;
739             addfold (base);
740         }
741     }
742
743     closedir (dd);
744     *--cp = '\0';
745 }
746
747 /*
748  * Add the folder name into the
749  * list in a sorted fashion.
750  */
751
752 static void
753 addfold (char *fold)
754 {
755     register int i, j;
756     register char *cp;
757
758     /* if necessary, reallocate the space for folder names */
759     if (foldp >= maxfolders) {
760         maxfolders += NUMFOLDERS;
761         folds = mh_xrealloc (folds, maxfolders * sizeof(char *));
762     }
763
764     cp = getcpy (fold);
765     for (i = start; i < foldp; i++)
766         if (compare (cp, folds[i]) < 0) {
767             for (j = foldp - 1; j >= i; j--)
768                 folds[j + 1] = folds[j];
769             foldp++;
770             folds[i] = cp;
771             return;
772         }
773
774     folds[foldp++] = cp;
775 }
776
777
778 static int
779 compare (char *s1, char *s2)
780 {
781     register int i;
782
783     while (*s1 || *s2)
784         if ((i = *s1++ - *s2++))
785             return i;
786
787     return 0;
788 }
789
790 /*
791  * Do the read only folders
792  */
793
794 static void
795 readonly_folders (void)
796 {
797     int atrlen;
798     char atrcur[BUFSIZ];
799     register struct node *np;
800
801     snprintf (atrcur, sizeof(atrcur), "atr-%s-", current);
802     atrlen = strlen (atrcur);
803
804     for (np = m_defs; np; np = np->n_next)
805         if (ssequal (atrcur, np->n_name)
806                 && !ssequal (nmhdir, np->n_name + atrlen))
807             get_folder_info (np->n_name + atrlen, NULL);
808 }