Replace mh_xmalloc() with mh_xcalloc()
[mmh] / uip / sortm.c
1 /*
2 ** sortm.c -- sort messages in a folder by date/time
3 **
4 ** This code is Copyright (c) 2002, by the authors of nmh.  See the
5 ** COPYRIGHT file in the root directory of the nmh distribution for
6 ** complete copyright information.
7 */
8
9 #include <h/mh.h>
10 #include <h/tws.h>
11 #include <h/utils.h>
12 #include <unistd.h>
13 #include <ctype.h>
14 #include <sys/stat.h>
15 #include <locale.h>
16 #include <sysexits.h>
17
18 #ifdef HAVE_SYS_PARAM_H
19 # include <sys/param.h>
20 #endif
21
22 static struct swit switches[] = {
23 #define DATESW  0
24          { "datefield field", 0 },
25 #define TEXTSW  1
26          { "textfield field", 0 },
27 #define NSUBJSW  2
28          { "notextfield", 2 },
29 #define LIMSW  3
30          { "limit days", 0 },
31 #define NLIMSW  4
32          { "nolimit", 2 },
33 #define VERBSW  5
34          { "verbose", 0 },
35 #define NVERBSW  6
36          { "noverbose", 2 },
37 #define VERSIONSW  7
38          { "Version", 0 },
39 #define HELPSW  8
40          { "help", 0 },
41          { NULL, 0 }
42 };
43
44 struct smsg {
45         int s_msg;
46         time_t s_clock;
47         char *s_subj;
48 };
49
50 static struct smsg *smsgs;
51 int nmsgs;
52
53 char *subjsort = NULL;  /* sort on subject if != 0 */
54 time_t datelimit = 0;
55 int submajor = 0;  /* if true, sort on subject-major */
56 int verbose;
57
58 /* This keeps compiler happy on calls to qsort */
59 typedef int (*qsort_comp) (const void *, const void *);
60
61 /*
62 ** static prototypes
63 */
64 static int read_hdrs(struct msgs *, char *);
65 static int get_fields(char *, int, struct smsg *);
66 static int dsort(struct smsg **, struct smsg **);
67 static int subsort(struct smsg **, struct smsg **);
68 static int txtsort(struct smsg **, struct smsg **);
69 static void rename_chain(struct msgs *, struct smsg **, int, int);
70 static void rename_msgs(struct msgs *, struct smsg **);
71
72
73 int
74 main(int argc, char **argv)
75 {
76         int i, msgnum;
77         unsigned char *cp;
78         char *maildir, *datesw = NULL;
79         char *folder = NULL, buf[BUFSIZ], **argp;
80         char **arguments;
81         struct msgs_array msgs = { 0, 0, NULL };
82         struct msgs *mp;
83         struct smsg **dlist;
84
85         setlocale(LC_ALL, "");
86         invo_name = mhbasename(argv[0]);
87
88         /* read user profile/context */
89         context_read();
90
91         arguments = getarguments(invo_name, argc, argv, 1);
92         argp = arguments;
93
94         /*
95         ** Parse arguments
96         */
97         while ((cp = *argp++)) {
98                 if (*cp == '-') {
99                         switch (smatch(++cp, switches)) {
100                         case AMBIGSW:
101                                 ambigsw(cp, switches);
102                                 exit(EX_USAGE);
103                         case UNKWNSW:
104                                 adios(EX_USAGE, NULL, "-%s unknown", cp);
105
106                         case HELPSW:
107                                 snprintf(buf, sizeof(buf), "%s [+folder] [msgs] [switches]", invo_name);
108                                 print_help(buf, switches, 1);
109                                 exit(argc == 2 ? EX_OK : EX_USAGE);
110                         case VERSIONSW:
111                                 print_version(invo_name);
112                                 exit(argc == 2 ? EX_OK : EX_USAGE);
113
114                         case DATESW:
115                                 if (datesw)
116                                         adios(EX_USAGE, NULL, "only one date field at a time");
117                                 if (!(datesw = *argp++) || *datesw == '-')
118                                         adios(EX_USAGE, NULL, "missing argument to %s",
119                                                         argp[-2]);
120                                 continue;
121
122                         case TEXTSW:
123                                 if (subjsort)
124                                         adios(EX_USAGE, NULL, "only one text field at a time");
125                                 if (!(subjsort = *argp++) || *subjsort == '-')
126                                         adios(EX_USAGE, NULL, "missing argument to %s",
127                                                         argp[-2]);
128                                 continue;
129
130                         case NSUBJSW:
131                                 subjsort = NULL;
132                                 continue;
133
134                         case LIMSW:
135                                 if (!(cp = *argp++) || *cp == '-')
136                                                 adios(EX_USAGE, NULL, "missing argument to %s", argp[-2]);
137                                 while (*cp == '0')
138                                         cp++;  /* skip any leading zeros */
139                                 if (!*cp) {  /* hit end of string */
140                                         submajor++;  /* sort subject-major */
141                                         continue;
142                                 }
143                                 if (!isdigit(*cp) || !(datelimit = atoi(cp)))
144                                         adios(EX_USAGE, NULL, "impossible limit %s", cp);
145                                 datelimit *= 60*60*24;
146                                 continue;
147                         case NLIMSW:
148                                 submajor = 0;  /* use date-major, but */
149                                 datelimit = 0;  /* use no limit */
150                                 continue;
151
152                         case VERBSW:
153                                 verbose++;
154                                 continue;
155                         case NVERBSW:
156                                 verbose = 0;
157                                 continue;
158                         }
159                 }
160                 if (*cp == '+' || *cp == '@') {
161                         if (folder)
162                                 adios(EX_USAGE, NULL, "only one folder at a time!");
163                         else
164                                 folder = getcpy(expandfol(cp));
165                 } else
166                         app_msgarg(&msgs, cp);
167         }
168
169         if (!msgs.size)
170                 app_msgarg(&msgs, seq_all);
171         if (!datesw)
172                 datesw = "date";
173         if (!folder)
174                 folder = getcurfol();
175         maildir = toabsdir(folder);
176
177         if (chdir(maildir) == NOTOK)
178                 adios(EX_OSERR, maildir, "unable to change directory to");
179
180         /* read folder and create message structure */
181         if (!(mp = folder_read(folder)))
182                 adios(EX_IOERR, NULL, "unable to read folder %s", folder);
183
184         /* check for empty folder */
185         if (mp->nummsg == 0)
186                 adios(EX_DATAERR, NULL, "no messages in %s", folder);
187
188         /* parse all the message ranges/sequences and set SELECTED */
189         for (msgnum = 0; msgnum < msgs.size; msgnum++)
190                 if (!m_convert(mp, msgs.msgs[msgnum]))
191                         exit(EX_USAGE);
192         seq_setprev(mp);  /* set the previous sequence */
193
194         if ((nmsgs = read_hdrs(mp, datesw)) <= 0)
195                 adios(EX_DATAERR, NULL, "no messages to sort");
196
197         /*
198         ** sort a list of pointers to our "messages to be sorted".
199         */
200         dlist = (struct smsg **) mh_xcalloc((size_t) (nmsgs+1), sizeof(*dlist));
201         for (i = 0; i < nmsgs; i++)
202                 dlist[i] = &smsgs[i];
203         dlist[nmsgs] = 0;
204
205         if (verbose) {  /* announce what we're doing */
206                 if (subjsort)
207                         printf("sorting by %s-major %s-minor\n",
208                                 submajor ? subjsort : datesw,
209                                 submajor ? datesw : subjsort);
210                 else
211                         printf("sorting by datefield %s\n", datesw);
212         }
213
214         /* first sort by date, or by subject-major, date-minor */
215         qsort((char *) dlist, nmsgs, sizeof(*dlist),
216                         (qsort_comp) (submajor && subjsort ? txtsort : dsort));
217
218         /*
219         ** if we're sorting on subject, we need another list
220         ** in subject order, then a merge pass to collate the
221         ** two sorts.
222         */
223         if (!submajor && subjsort) {  /* already date sorted */
224                 struct smsg **slist, **flist;
225                 struct smsg ***il, **fp, **dp;
226
227                 slist = (struct smsg **) mh_xcalloc(nmsgs+1, sizeof(*slist));
228                 memcpy((char *)slist, (char *)dlist, (nmsgs+1)*sizeof(*slist));
229                 qsort((char *)slist, nmsgs, sizeof(*slist),
230                                 (qsort_comp) subsort);
231
232                 /*
233                 ** make an inversion list so we can quickly find
234                 ** the collection of messages with the same subj
235                 ** given a message number.
236                 */
237                 il = (struct smsg ***) mh_xcalloc(mp->hghsel+1, sizeof(*il));
238                 if (! il)
239                         adios(EX_OSERR, NULL, "couldn't allocate msg list");
240                 for (i = 0; i < nmsgs; i++)
241                         il[slist[i]->s_msg] = &slist[i];
242                 /*
243                 ** make up the final list, chronological but with
244                 ** all the same subjects grouped together.
245                 */
246                 flist = (struct smsg **) mh_xcalloc(nmsgs+1, sizeof(*flist));
247                 fp = flist;
248                 for (dp = dlist; *dp;) {
249                         struct smsg **s = il[(*dp++)->s_msg];
250
251                         /* see if we already did this guy */
252                         if (! s)
253                                 continue;
254
255                         *fp++ = *s++;
256                         /*
257                         ** take the next message(s) if there is one,
258                         ** its subject isn't null and its subject
259                         ** is the same as this one and it's not too
260                         ** far away in time.
261                         */
262                         while (*s && (*s)->s_subj[0] && strcmp((*s)->s_subj, s[-1]->s_subj) == 0 && (datelimit == 0 || (*s)->s_clock - s[-1]->s_clock <= datelimit)) {
263                                 il[(*s)->s_msg] = 0;
264                                 *fp++ = *s++;
265                         }
266                 }
267                 *fp = 0;
268                 free(slist);
269                 free(dlist);
270                 dlist = flist;
271         }
272
273         /*
274         ** At this point, dlist is a sorted array of pointers to smsg
275         ** structures, each of which contains a message number.
276         */
277
278         rename_msgs(mp, dlist);
279
280         context_replace(curfolder, folder);  /* update current folder */
281         seq_save(mp);  /* synchronize message sequences */
282         context_save();  /* save the context file */
283         folder_free(mp);  /* free folder/message structure */
284         return 0;
285 }
286
287 static int
288 read_hdrs(struct msgs *mp, char *datesw)
289 {
290         int msgnum;
291         struct tws tb;
292         struct smsg *s;
293
294         twscopy(&tb, dlocaltimenow());
295
296         smsgs = (struct smsg *) mh_xcalloc((size_t) (mp->hghsel - mp->lowsel + 2),
297                         sizeof(*smsgs));
298
299         s = smsgs;
300         for (msgnum = mp->lowsel; msgnum <= mp->hghsel; msgnum++) {
301                 if (is_selected(mp, msgnum)) {
302                         if (get_fields(datesw, msgnum, s)) {
303                                 s->s_msg = msgnum;
304                                 s++;
305                         }
306                 }
307         }
308         s->s_msg = 0;
309         return(s - smsgs);
310 }
311
312
313 /*
314 ** Parse the message and get the data or subject field,
315 ** if needed.
316 */
317
318 static int
319 get_fields(char *datesw, int msg, struct smsg *smsg)
320 {
321         int state;
322         int compnum;
323         char *msgnam, buf[BUFSIZ], nam[NAMESZ];
324         struct tws *tw;
325         char *datecomp = NULL, *subjcomp = NULL;
326         FILE *in;
327
328         if ((in = fopen(msgnam = m_name(msg), "r")) == NULL) {
329                 admonish(msgnam, "unable to read message");
330                 return (0);
331         }
332         for (compnum = 1, state = FLD;;) {
333                 switch (state = m_getfld(state, nam, buf, sizeof(buf), in)) {
334                 case FLD:
335                 case FLDPLUS:
336                         compnum++;
337                         if (!mh_strcasecmp(nam, datesw)) {
338                                 datecomp = add(buf, datecomp);
339                                 while (state == FLDPLUS) {
340                                         state = m_getfld(state, nam, buf,
341                                                         sizeof(buf), in);
342                                         datecomp = add(buf, datecomp);
343                                 }
344                                 if (!subjsort || subjcomp)
345                                         break;
346                         } else if (subjsort && !mh_strcasecmp(nam, subjsort)) {
347                                 subjcomp = add(buf, subjcomp);
348                                 while (state == FLDPLUS) {
349                                         state = m_getfld(state, nam, buf,
350                                                         sizeof(buf), in);
351                                         subjcomp = add(buf, subjcomp);
352                                 }
353                                 if (datecomp)
354                                         break;
355                         } else {
356                                 /* just flush this guy */
357                                 while (state == FLDPLUS)
358                                         state = m_getfld(state, nam, buf,
359                                                         sizeof(buf), in);
360                         }
361                         continue;
362
363                 case BODY:
364                 case FILEEOF:
365                         break;
366
367                 case LENERR:
368                 case FMTERR:
369                         if (state == LENERR || state == FMTERR)
370                                 admonish(NULL, "format error in message %d (header #%d)", msg, compnum);
371                         if (datecomp)
372                                 free(datecomp);
373                         if (subjcomp)
374                                 free(subjcomp);
375                         fclose(in);
376                         return (0);
377
378                 default:
379                         adios(EX_SOFTWARE, NULL, "internal error -- you lose");
380                 }
381                 break;
382         }
383
384         /*
385         ** If no date component, then use the modification
386         ** time of the file as its date
387         */
388         if (!datecomp || (tw = dparsetime(datecomp)) == NULL) {
389                 struct stat st;
390
391                 admonish(NULL, "can't parse %s field in message %d",
392                                 datesw, msg);
393                 fstat(fileno(in), &st);
394                 smsg->s_clock = st.st_mtime;
395         } else {
396                 smsg->s_clock = dmktime(tw);
397         }
398
399         if (subjsort) {
400                 if (subjcomp) {
401                         /*
402                         ** try to make the subject "canonical": delete
403                         ** leading "re:", everything but letters & smash
404                         ** letters to lower case.
405                         */
406                         char  *cp, *cp2;
407                         unsigned char c;
408
409                         cp = subjcomp;
410                         cp2 = subjcomp;
411                         if (strcmp(subjsort, "subject") == 0) {
412                                 while ((c = *cp)) {
413                                         if (! isspace(c)) {
414                                                 if(uprf(cp, "re:"))
415                                                         cp += 2;
416                                                 else
417                                                         break;
418                                         }
419                                         cp++;
420                                 }
421                         }
422
423                         while ((c = *cp++)) {
424                                 if (isalnum(c))
425                                         *cp2++ = isupper(c) ? tolower(c) : c;
426                         }
427
428                         *cp2 = '\0';
429                 } else
430                         subjcomp = "";
431
432                 smsg->s_subj = subjcomp;
433         }
434         fclose(in);
435         if (datecomp)
436                 free(datecomp);
437
438         return (1);
439 }
440
441 /*
442 ** sort on dates.
443 */
444 static int
445 dsort(struct smsg **a, struct smsg **b)
446 {
447         if ((*a)->s_clock < (*b)->s_clock)
448                 return (-1);
449         else if ((*a)->s_clock > (*b)->s_clock)
450                 return (1);
451         else if ((*a)->s_msg < (*b)->s_msg)
452                 return (-1);
453         else
454                 return (1);
455 }
456
457 /*
458 ** sort on subjects.
459 */
460 static int
461 subsort(struct smsg **a, struct smsg **b)
462 {
463         int i;
464
465         if ((i = strcmp((*a)->s_subj, (*b)->s_subj)))
466                 return (i);
467
468         return (dsort(a, b));
469 }
470
471 static int
472 txtsort(struct smsg **a, struct smsg **b)
473 {
474         int i;
475
476         if ((i = strcmp((*a)->s_subj, (*b)->s_subj)))
477                 return (i);
478         else if ((*a)->s_msg < (*b)->s_msg)
479                 return (-1);
480         else
481                 return (1);
482 }
483
484 static void
485 rename_chain(struct msgs *mp, struct smsg **mlist, int msg, int endmsg)
486 {
487         int nxt, old, new;
488         char *newname, oldname[BUFSIZ];
489         char newbuf[MAXPATHLEN + 1];
490
491         for (;;) {
492                 nxt = mlist[msg] - smsgs;  /* mlist[msg] is a ptr into smsgs */
493                 mlist[msg] = (struct smsg *)0;
494                 old = smsgs[nxt].s_msg;
495                 new = smsgs[msg].s_msg;
496                 strncpy(oldname, m_name(old), sizeof(oldname));
497                 newname = m_name(new);
498                 if (verbose)
499                         printf("message %d becomes message %d\n", old, new);
500
501                 snprintf(oldname, sizeof (oldname), "%s/%d",
502                                 mp->foldpath, old);
503                 snprintf(newbuf, sizeof (newbuf), "%s/%d", mp->foldpath, new);
504                 ext_hook("ref-hook", oldname, newbuf);
505
506                 if (rename(oldname, newname) == NOTOK)
507                         adios(EX_IOERR, newname, "unable to rename %s to", oldname);
508
509                 copy_msg_flags(mp, new, old);
510                 if (mp->curmsg == old)
511                         seq_setcur(mp, new);
512
513                 if (nxt == endmsg)
514                         break;
515
516                 msg = nxt;
517         }
518 /* if (nxt != endmsg); */
519 /* rename_chain(mp, mlist, nxt, endmsg); */
520 }
521
522 static void
523 rename_msgs(struct msgs *mp, struct smsg **mlist)
524 {
525         int i, j, old, new;
526         seqset_t tmpset;
527         char f1[BUFSIZ], tmpfil[BUFSIZ];
528         char newbuf[MAXPATHLEN + 1];
529         struct smsg *sp;
530
531         strncpy(tmpfil, m_name(mp->hghmsg + 1), sizeof(tmpfil));
532
533         for (i = 0; i < nmsgs; i++) {
534                 if (! (sp = mlist[i]))
535                         continue;   /* did this one */
536
537                 j = sp - smsgs;
538                 if (j == i)
539                         continue;   /* this one doesn't move */
540
541                 /*
542                 ** the guy that was msg j is about to become msg i.
543                 ** rename 'j' to make a hole, then recursively rename
544                 ** guys to fill up the hole.
545                 */
546                 old = smsgs[j].s_msg;
547                 new = smsgs[i].s_msg;
548                 strncpy(f1, m_name(old), sizeof(f1));
549
550                 if (verbose)
551                         printf("renaming message chain from %d to %d\n",
552                                         old, new);
553
554                 /*
555                 ** Run the external hook to refile the old message as the
556                 ** temporary message number that is off of the end of the
557                 ** messages in the folder.
558                 */
559
560                 snprintf(f1, sizeof (f1), "%s/%d", mp->foldpath, old);
561                 snprintf(newbuf, sizeof (newbuf), "%s/%d",
562                                 mp->foldpath, mp->hghmsg + 1);
563                 ext_hook("ref-hook", f1, newbuf);
564
565                 if (rename(f1, tmpfil) == NOTOK)
566                         adios(EX_IOERR, tmpfil, "unable to rename %s to ", f1);
567
568                 get_msg_flags(mp, &tmpset, old);
569
570                 rename_chain(mp, mlist, j, i);
571
572                 /*
573                 ** Run the external hook to refile the temorary message number
574                 ** to the real place.
575                 */
576
577                 snprintf(f1, sizeof (f1), "%s/%d", mp->foldpath, new);
578                 ext_hook("ref-hook", newbuf, f1);
579
580                 if (rename(tmpfil, m_name(new)) == NOTOK)
581                         adios(EX_IOERR, m_name(new), "unable to rename %s to", tmpfil);
582
583                 set_msg_flags(mp, &tmpset, new);
584                 mp->msgflags |= SEQMOD;
585         }
586 }