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

   1 /* fmttest.c -- A program to help test and debug format instructions
   2  *
   3  * This code is Copyright (c) 2012, by the authors of nmh.  See the
   4  * COPYRIGHT file in the root directory of the nmh distribution for
   5  * complete copyright information.
   6  */
   7
   8 #include "h/mh.h"
   9 #include "sbr/fmt_new.h"
  10 #include "scansbr.h"
  11 #include "sbr/m_name.h"
  12 #include "sbr/m_getfld.h"
  13 #include "sbr/getarguments.h"
  14 #include "sbr/seq_setprev.h"
  15 #include "sbr/seq_save.h"
  16 #include "sbr/smatch.h"
  17 #include "sbr/snprintb.h"
  18 #include "sbr/getcpy.h"
  19 #include "sbr/m_convert.h"
  20 #include "sbr/getfolder.h"
  21 #include "sbr/folder_read.h"
  22 #include "sbr/folder_free.h"
  23 #include "sbr/context_save.h"
  24 #include "sbr/context_replace.h"
  25 #include "sbr/context_find.h"
  26 #include "sbr/brkstring.h"
  27 #include "sbr/ambigsw.h"
  28 #include "sbr/path.h"
  29 #include "sbr/print_version.h"
  30 #include "sbr/print_help.h"
  31 #include "sbr/seq_getnum.h"
  32 #include "sbr/error.h"
  33 #include "h/fmt_scan.h"
  34 #include "h/fmt_compile.h"
  35 #include "h/utils.h"
  36 #include "h/addrsbr.h"
  37 #include "h/done.h"
  38 #include "sbr/m_maildir.h"
  39 #include "sbr/terminal.h"
  40
  41 #define FMTTEST_SWITCHES \
  42     X("form formatfile", 0, FORMSW) \
  43     X("format string", 5, FMTSW) \
  44     X("address", 0, ADDRSW) \
  45     X("raw", 0, RAWSW) \
  46     X("date", 0, DATESW) \
  47     X("message", 0, MESSAGESW) \
  48     X("file", 0, FILESW) \
  49     X("nofile", 0, NFILESW) \
  50     X("-component-name component-text", 0, OTHERSW) \
  51     X("dupaddrs", 0, DUPADDRSW) \
  52     X("nodupaddrs", 0, NDUPADDRSW) \
  53     X("ccme", 0, CCMESW) \
  54     X("noccme", 0, NCCMESW) \
  55     X("outsize size-in-characters", 0, OUTSIZESW) \
  56     X("width column-width", 0, WIDTHSW) \
  57     X("msgnum number", 0, MSGNUMSW) \
  58     X("msgcur flag", 0, MSGCURSW) \
  59     X("msgsize size", 0, MSGSIZESW) \
  60     X("unseen flag", 0, UNSEENSW) \
  61     X("dump", 0, DUMPSW) \
  62     X("nodump", 0, NDUMPSW) \
  63     X("trace", 0, TRACESW) \
  64     X("notrace", 0, NTRACESW) \
  65     X("version", 0, VERSIONSW) \
  66     X("help", 0, HELPSW) \
  67
  68 #define X(sw, minchars, id) id,
  69 DEFINE_SWITCH_ENUM(FMTTEST);
  70 #undef X
  71
  72 #define X(sw, minchars, id) { sw, minchars, id },
  73 DEFINE_SWITCH_ARRAY(FMTTEST, switches);
  74 #undef X
  75
  76 /*
  77  * An array containing labels used for branch instructions
  78  */
  79
  80 static struct format **lvec = NULL;
  81 static int lused = 0;
  82 static int lallocated = 0;
  83
  84 enum mode_t { MESSAGE, ADDRESS, DATE, RAW };
  85 #define DEFADDRFORMAT "%<{error}%{error}: %{text}%|%(putstr(proper{text}))%>"
  86 #define DEFDATEFORMAT "%<(nodate{text})error: %{text}%|%(putstr(pretty{text}))%>"
  87
  88 /*
  89  * Context structure used by the tracing routines
  90  */
  91
  92 struct trace_context {
  93     int num;
  94     char *str;
  95     char *outbuf;
  96 };
  97
  98 /*
  99  * static prototypes
 100  */
 101 static void fmt_dump (char *, struct format *);
 102 static void dumpone(struct format *);
 103 static void initlabels(struct format *);
 104 static int findlabel(struct format *);
 105 static void assignlabel(struct format *);
 106 static char *f_typestr(int);
 107 static char *c_typestr(int);
 108 static char *c_flagsstr(int);
 109 static void litputs(const char *);
 110 static void litputc(char);
 111 static void process_addresses(struct format *, struct msgs_array *,
 112                               charstring_t, int, int *,
 113                               struct fmt_callbacks *);
 114 static void process_raw(struct format *, struct msgs_array *, charstring_t,
 115                         int, int *, struct fmt_callbacks *);
 116 static void process_messages(struct format *, struct msgs_array *,
 117                              struct msgs_array *, charstring_t, char *, int,
 118                              int, int *, struct fmt_callbacks *);
 119 static void process_single_file(FILE *, struct msgs_array *, int *, int,
 120                                 struct format *, charstring_t, int,
 121                                 struct fmt_callbacks *);
 122 static void test_trace(void *, struct format *, int, char *, const char *);
 123 static char *test_formataddr(char *, char *);
 124 static char *test_concataddr(char *, char *);
 125 static int insert(struct mailname *);
 126 static void mlistfree(void);
 127
 128 static bool nodupcheck;         /* If set, no check for duplicates */
 129 static bool ccme;               /* Should I cc myself? */
 130 static struct mailname mq;      /* Mail addresses to check for duplicates */
 131 static char *dummy = "dummy";
 132
 133 int
 134 main (int argc, char **argv)
 135 {
 136     char *cp, *form = NULL, *format = NULL, *defformat = FORMAT, *folder = NULL;
 137     char buf[BUFSIZ], *nfs, **argp, **arguments;
 138     charstring_t buffer;
 139     struct format *fmt;
 140     struct comp *cptr;
 141     struct msgs_array msgs = { 0, 0, NULL }, compargs = { 0, 0, NULL};
 142     bool dump = false;
 143     int i;
 144     int outputsize = 0;
 145     bool dupaddrs = true;
 146     bool trace = false;
 147     int files = 0;
 148     int colwidth = -1, msgnum = -1, msgcur = -1, msgsize = -1, msgunseen = -1;
 149     enum mode_t mode = MESSAGE;
 150     int dat[5];
 151     struct fmt_callbacks cb, *cbp = NULL;
 152
 153     if (nmh_init(argv[0], true, true)) { return 1; }
 154
 155     arguments = getarguments (invo_name, argc, argv, 1);
 156     argp = arguments;
 157
 158     while ((cp = *argp++)) {
 159         if (*cp == '-') {
 160             /*
 161              * A -- means that we have a component name (like pick);
 162              * save the component name and the next argument for the text.
 163              */
 164             if (*++cp == '-') {
 165                 if (*++cp == '\0')
 166                     die("missing component name after --");
 167                 app_msgarg(&compargs, cp);
 168                 /* Grab next argument for component text */
 169                 if (!(cp = *argp++))
 170                     die("missing argument to %s", argp[-2]);
 171                 app_msgarg(&compargs, cp);
 172                 continue;
 173             }
 174             switch (smatch (cp, switches)) {
 175                 case AMBIGSW:
 176                     ambigsw (cp, switches);
 177                     done (1);
 178                 case UNKWNSW:
 179                     die("-%s unknown", cp);
 180
 181                 case HELPSW:
 182                     snprintf (buf, sizeof(buf), "%s [switches]", invo_name);
 183                     print_help (buf, switches, 1);
 184                     done (0);
 185                 case VERSIONSW:
 186                     print_version(invo_name);
 187                     done (0);
 188                 case OTHERSW:
 189                     die("internal argument error!");
 190                     continue;
 191
 192                 case OUTSIZESW:
 193                     if (!(cp = *argp++) || *cp == '-')
 194                         die("missing argument to %s", argp[-2]);
 195                     if (strcmp(cp, "max") == 0)
 196                         outputsize = INT_MAX;
 197                     else if (strcmp(cp, "width") == 0)
 198                         outputsize = sc_width();
 199                     else
 200                         outputsize = atoi(cp);
 201                     continue;
 202
 203                 case FORMSW:
 204                     if (!(form = *argp++) || *form == '-')
 205                         die("missing argument to %s", argp[-2]);
 206                     format = NULL;
 207                     continue;
 208                 case FMTSW:
 209                     if (!(format = *argp++) || *format == '-')
 210                         die("missing argument to %s", argp[-2]);
 211                     form = NULL;
 212                     continue;
 213
 214                 case TRACESW:
 215                     trace = true;
 216                     continue;
 217                 case NTRACESW:
 218                     trace = false;
 219                     continue;
 220
 221                 case ADDRSW:
 222                     mode = ADDRESS;
 223                     defformat = DEFADDRFORMAT;
 224                     continue;
 225                 case RAWSW:
 226                     mode = RAW;
 227                     continue;
 228                 case MESSAGESW:
 229                     mode = MESSAGE;
 230                     defformat = FORMAT;
 231                     dupaddrs = false;
 232                     continue;
 233                 case DATESW:
 234                     mode = DATE;
 235                     defformat = DEFDATEFORMAT;
 236                     continue;
 237
 238                 case FILESW:
 239                     files++;
 240                     continue;
 241                 case NFILESW:
 242                     files = 0;
 243                     continue;
 244
 245                 case DUPADDRSW:
 246                     dupaddrs = true;
 247                     continue;
 248                 case NDUPADDRSW:
 249                     dupaddrs = false;
 250                     continue;
 251
 252                 case CCMESW:
 253                     ccme = true;
 254                     continue;
 255                 case NCCMESW:
 256                     ccme = false;
 257                     continue;
 258
 259                 case WIDTHSW:
 260                     if (!(cp = *argp++) || *cp == '-')
 261                         die("missing argument to %s", argp[-2]);
 262                     colwidth = atoi(cp);
 263                     continue;
 264                 case MSGNUMSW:
 265                     if (!(cp = *argp++) || *cp == '-')
 266                         die("missing argument to %s", argp[-2]);
 267                     msgnum = atoi(cp);
 268                     continue;
 269                 case MSGCURSW:
 270                     if (!(cp = *argp++) || *cp == '-')
 271                         die("missing argument to %s", argp[-2]);
 272                     msgcur = atoi(cp);
 273                     continue;
 274                 case MSGSIZESW:
 275                     if (!(cp = *argp++) || *cp == '-')
 276                         die("missing argument to %s", argp[-2]);
 277                     msgsize = atoi(cp);
 278                     continue;
 279                 case UNSEENSW:
 280                     if (!(cp = *argp++) || *cp == '-')
 281                         die("missing argument to %s", argp[-2]);
 282                     msgunseen = atoi(cp);
 283                     continue;
 284
 285                 case DUMPSW:
 286                     dump = true;
 287                     continue;
 288                 case NDUMPSW:
 289                     dump = false;
 290                     continue;
 291
 292             }
 293         }
 294
 295         /*
 296          * Only interpret as a folder if we're in message mode
 297          */
 298
 299         if (mode == MESSAGE && !files && (*cp == '+' || *cp == '@')) {
 300             if (folder)
 301                 die("only one folder at a time!");
 302             folder = pluspath (cp);
 303         } else
 304             app_msgarg(&msgs, cp);
 305     }
 306
 307     /*
 308      * Here's our weird heuristic:
 309      *
 310      * - We allow -dump without any other arguments.
 311      * - If you've given any component arguments, we don't require any
 312      *   other arguments.
 313      * - The arguments are interpreted as folders/messages _if_ we're in
 314      *   message mode, otherwise pass as strings in the text component.
 315      */
 316
 317    if (!dump && compargs.size == 0 && msgs.size == 0) {
 318         die("usage: [switches] [+folder] msgs | strings...");
 319    }
 320
 321    /*
 322     * If you're picking "raw" as a mode, then you have to select
 323     * a format.
 324     */
 325
 326    if (mode == RAW && form == NULL && format == NULL) {
 327         die("You must specify a format with -form or -format when "
 328                "using -raw");
 329    }
 330
 331     /*
 332      * Get new format string.  Must be before chdir().
 333      */
 334     nfs = new_fs (form, format, defformat);
 335     (void) fmt_compile(nfs, &fmt, 1);
 336
 337     if (dump || trace) {
 338         initlabels(fmt);
 339         if (dump) {
 340             fmt_dump(nfs, fmt);
 341             if (compargs.size == 0 && msgs.size == 0)
 342                 done(0);
 343         }
 344     }
 345
 346     buffer = charstring_create(BUFSIZ);
 347
 348     if (outputsize == 0) {
 349         if (mode == MESSAGE)
 350             outputsize = sc_width();
 351         else
 352             outputsize = INT_MAX;
 353     }
 354
 355     dat[0] = msgnum;
 356     dat[1] = msgcur;
 357     dat[2] = msgsize;
 358     dat[3] = colwidth == -1 ? outputsize : colwidth;
 359     dat[4] = msgunseen;
 360
 361     /*
 362      * If we want to provide our own formataddr, concactaddr, or tracing
 363      * callback, do that now.  Also, prime ismymbox if we use it.
 364      */
 365
 366     if (!dupaddrs || trace) {
 367         ZERO(&cb);
 368         cbp = &cb;
 369
 370         if (!dupaddrs) {
 371             cb.formataddr = test_formataddr;
 372             cb.concataddr = test_concataddr;
 373             if (!ccme)
 374                 ismymbox(NULL);
 375         }
 376
 377         if (trace) {
 378             struct trace_context *ctx;
 379
 380             NEW(ctx);
 381             ctx->num = -1;
 382             ctx->str = dummy;
 383             ctx->outbuf = mh_xstrdup("");
 384
 385             cb.trace_func = test_trace;
 386             cb.trace_context = ctx;
 387         }
 388     }
 389
 390     if (mode == MESSAGE) {
 391         process_messages(fmt, &compargs, &msgs, buffer, folder, outputsize,
 392                          files, dat, cbp);
 393     } else {
 394         if (compargs.size) {
 395             for (i = 0; i < compargs.size; i += 2) {
 396                 cptr = fmt_findcomp(compargs.msgs[i]);
 397                 if (cptr)
 398                     cptr->c_text = getcpy(compargs.msgs[i + 1]);
 399             }
 400         }
 401
 402         if (mode == ADDRESS) {
 403             process_addresses(fmt, &msgs, buffer, outputsize, dat, cbp);
 404         } else /* Fall-through for RAW or DATE */
 405             process_raw(fmt, &msgs, buffer, outputsize, dat, cbp);
 406     }
 407
 408     charstring_free(buffer);
 409     fmt_free(fmt, 1);
 410
 411     done(0);
 412     return 1;
 413 }
 414
 415 /*
 416  * Process each address with fmt_scan().
 417  */
 418
 419 struct pqpair {
 420     char *pq_text;
 421     char *pq_error;
 422     struct pqpair *pq_next;
 423 };
 424
 425 static void
 426 process_addresses(struct format *fmt, struct msgs_array *addrs,
 427                   charstring_t buffer, int outwidth, int *dat,
 428                   struct fmt_callbacks *cb)
 429 {
 430     int i;
 431     char *cp, error[BUFSIZ];
 432     struct mailname *mp;
 433     struct pqpair *p, *q;
 434     struct pqpair pq;
 435     struct comp *c;
 436
 437     if (dat[0] == -1)
 438         dat[0] = 0;
 439     if (dat[1] == -1)
 440         dat[1] = 0;
 441     if (dat[2] == -1)
 442         dat[2] = 0;
 443     if (dat[4] == -1)
 444         dat[4] = 0;
 445
 446     for (i = 0; i < addrs->size; i++) {
 447         (q = &pq)->pq_next = NULL;
 448         while ((cp = getname(addrs->msgs[i]))) {
 449             NEW0(p);
 450             if ((mp = getm(cp, NULL, 0, error, sizeof(error))) == NULL) {
 451                 p->pq_text = mh_xstrdup(cp);
 452                 p->pq_error = mh_xstrdup(error);
 453             } else {
 454                 p->pq_text = getcpy(mp->m_text);
 455                 mnfree(mp);
 456             }
 457             q = (q->pq_next = p);
 458         }
 459
 460         for (p = pq.pq_next; p; p = q) {
 461             c = fmt_findcomp("text");
 462             if (c) {
 463                 free(c->c_text);
 464                 c->c_text = p->pq_text;
 465                 p->pq_text = NULL;
 466             }
 467             c = fmt_findcomp("error");
 468             if (c) {
 469                 free(c->c_text);
 470                 c->c_text = p->pq_error;
 471                 p->pq_error = NULL;
 472             }
 473
 474             fmt_scan(fmt, buffer, outwidth, dat, cb);
 475             fputs(charstring_buffer(buffer), stdout);
 476             mlistfree();
 477
 478             free(p->pq_text);
 479             free(p->pq_error);
 480             q = p->pq_next;
 481             free(p);
 482         }
 483     }
 484 }
 485
 486 /*
 487  * Process messages and run them through the format engine.  A lot taken
 488  * from scan.c.
 489  */
 490
 491 static void
 492 process_messages(struct format *fmt, struct msgs_array *comps,
 493                  struct msgs_array *msgs, charstring_t buffer, char *folder,
 494                  int outwidth, int files, int *dat,
 495                  struct fmt_callbacks *cb)
 496 {
 497     int i, msgnum, msgsize = dat[2], num = dat[0], cur = dat[1];
 498     int num_unseen_seq = 0;
 499     ivector_t seqnum = ivector_create (0);
 500     char *maildir, *cp;
 501     struct msgs *mp;
 502     FILE *in;
 503
 504     /*
 505      * If 'files' is set, short-circuit everything else and just process
 506      * everything now.
 507      */
 508
 509     if (files) {
 510         for (i = 0; i < msgs->size; i++) {
 511             if ((in = fopen(cp = msgs->msgs[i], "r")) == NULL) {
 512                 admonish(cp, "unable to open file");
 513                 continue;
 514             }
 515             process_single_file(in, comps, dat, msgsize, fmt, buffer,
 516                                 outwidth, cb);
 517         }
 518
 519         return;
 520     }
 521
 522     if (! folder)
 523         folder = getfolder(1);
 524
 525     maildir = m_maildir(folder);
 526
 527     if (chdir(maildir) < 0)
 528         adios(maildir, "unable to change directory to");
 529
 530     if (!(mp = folder_read(folder, 1)))
 531         die("unable to read folder %s", folder);
 532
 533     if (mp->nummsg == 0)
 534         die("no messages in %s", folder);
 535
 536     for (i = 0; i < msgs->size; i++)
 537         if (!m_convert(mp, msgs->msgs[i]))
 538             done(1);
 539     seq_setprev(mp);                    /* set the Previous-Sequence */
 540
 541     context_replace(pfolder, folder);   /* update current folder */
 542     seq_save(mp);                       /* synchronize message sequences */
 543     context_save();                     /* save the context file */
 544
 545     /*
 546      * We want to set the unseen flag if requested, so we have to check
 547      * the unseen sequence as well.
 548      */
 549
 550     if (dat[4] == -1) {
 551         if ((cp = context_find(usequence)) && *cp) {
 552             char **ap, *dp;
 553
 554             dp = mh_xstrdup(cp);
 555             ap = brkstring(dp, " ", "\n");
 556             for (i = 0; ap && *ap; i++, ap++)
 557                 ivector_push_back (seqnum, seq_getnum(mp, *ap));
 558
 559             num_unseen_seq = i;
 560             free(dp);
 561         }
 562     }
 563
 564     for (msgnum = mp->lowsel; msgnum <= mp->hghsel; msgnum++) {
 565         if (is_selected(mp, msgnum)) {
 566             if ((in = fopen(cp = m_name(msgnum), "r")) == NULL) {
 567                 admonish(cp, "unable to open message");
 568                 continue;
 569             }
 570
 571             fmt_freecomptext();
 572
 573             if (num == -1)
 574                 dat[0] = msgnum;
 575
 576             if (cur == -1)
 577                 dat[1] = msgnum == mp->curmsg;
 578
 579             /*
 580              * Check to see if this is in the unseen sequence
 581              */
 582
 583             dat[4] = 0;
 584             for (i = 0; i < num_unseen_seq; i++) {
 585                 if (in_sequence(mp, ivector_at (seqnum, i), msgnum)) {
 586                     dat[4] = 1;
 587                     break;
 588                 }
 589             }
 590
 591             /*
 592              * Read in the message and process the components
 593              */
 594
 595             process_single_file(in, comps, dat, msgsize, fmt, buffer,
 596                                 outwidth, cb);
 597         }
 598     }
 599
 600     ivector_free (seqnum);
 601     folder_free(mp);
 602 }
 603
 604 /*
 605  * Process a single file in message mode
 606  */
 607
 608 static void
 609 process_single_file(FILE *in, struct msgs_array *comps, int *dat, int msgsize,
 610                     struct format *fmt, charstring_t buffer, int outwidth,
 611                     struct fmt_callbacks *cb)
 612 {
 613     int i, state;
 614     char name[NAMESZ], rbuf[NMH_BUFSIZ];
 615     m_getfld_state_t gstate;
 616     struct comp *c;
 617     int bufsz;
 618
 619     /*
 620      * Get our size if we didn't include one
 621      */
 622
 623     if (msgsize == -1) {
 624         struct stat st;
 625
 626         if (fstat(fileno(in), &st) < 0)
 627             dat[2] = 0;
 628         else
 629             dat[2] = st.st_size;
 630     }
 631
 632     /*
 633      * Initialize everything else
 634      */
 635
 636     if (dat[0] == -1)
 637         dat[0] = 0;
 638     if (dat[1] == -1)
 639         dat[1] = 0;
 640     if (dat[4] == -1)
 641         dat[4] = 0;
 642
 643     /*
 644      * Read in the message and process the components
 645      */
 646
 647     gstate = m_getfld_state_init(in);
 648     for (;;) {
 649         bufsz = sizeof(rbuf);
 650         state = m_getfld2(&gstate, name, rbuf, &bufsz);
 651         switch (state) {
 652         case FLD:
 653         case FLDPLUS:
 654             i = fmt_addcomptext(name, rbuf);
 655             if (i != -1) {
 656                 while (state == FLDPLUS) {
 657                     bufsz = sizeof(rbuf);
 658                     state = m_getfld2(&gstate, name, rbuf, &bufsz);
 659                     fmt_appendcomp(i, name, rbuf);
 660                 }
 661             }
 662
 663             while (state == FLDPLUS) {
 664                 bufsz = sizeof(rbuf);
 665                 state = m_getfld2(&gstate, name, rbuf, &bufsz);
 666             }
 667             break;
 668
 669         case BODY:
 670             if (fmt_findcomp("body")) {
 671                 if ((i = strlen(rbuf)) < outwidth) {
 672                     bufsz = min (outwidth, (int) sizeof rbuf - i);
 673                     m_getfld2(&gstate, name, rbuf + i, &bufsz);
 674                 }
 675
 676                 fmt_addcomptext("body", rbuf);
 677             }
 678             goto finished;
 679
 680         default:
 681             goto finished;
 682         }
 683     }
 684 finished:
 685     fclose(in);
 686     m_getfld_state_destroy(&gstate);
 687
 688     /*
 689      * Do this now to override any components in the original message
 690      */
 691     if (comps->size) {
 692         for (i = 0; i < comps->size; i += 2) {
 693             c = fmt_findcomp(comps->msgs[i]);
 694             if (c) {
 695                 free(c->c_text);
 696                 c->c_text = getcpy(comps->msgs[i + 1]);
 697             }
 698         }
 699     }
 700     fmt_scan(fmt, buffer, outwidth, dat, cb);
 701     fputs(charstring_buffer (buffer), stdout);
 702     mlistfree();
 703 }
 704
 705 /*
 706  * Run text through the format engine with no special processing
 707  */
 708
 709 static void
 710 process_raw(struct format *fmt, struct msgs_array *text, charstring_t buffer,
 711             int outwidth, int *dat, struct fmt_callbacks *cb)
 712 {
 713     int i;
 714     struct comp *c;
 715
 716     if (dat[0] == -1)
 717         dat[0] = 0;
 718     if (dat[1] == -1)
 719         dat[1] = 0;
 720     if (dat[2] == -1)
 721         dat[2] = 0;
 722     if (dat[4] == -1)
 723         dat[4] = 0;
 724
 725     c = fmt_findcomp("text");
 726
 727     for (i = 0; i < text->size; i++) {
 728         if (c != NULL) {
 729             free(c->c_text);
 730             c->c_text = getcpy(text->msgs[i]);
 731         }
 732
 733         fmt_scan(fmt, buffer, outwidth, dat, cb);
 734         fputs(charstring_buffer (buffer), stdout);
 735         mlistfree();
 736     }
 737 }
 738
 739 /*
 740  * Our basic tracing support callback.
 741  *
 742  * Print out each instruction as it's executed, including the values of
 743  * the num and str registers if they've changed.
 744  */
 745
 746 static void
 747 test_trace(void *context, struct format *fmt, int num, char *str,
 748            const char *outbuf)
 749 {
 750     struct trace_context *ctx = (struct trace_context *) context;
 751     bool changed = false;
 752
 753     dumpone(fmt);
 754
 755     if (num != ctx->num) {
 756         printf("num=%d", num);
 757         ctx->num = num;
 758         changed = true;
 759     }
 760
 761     if (str != ctx->str) {
 762         if (changed)
 763             putchar(' ');
 764         changed = true;
 765         fputs("str=", stdout);
 766         litputs(str);
 767         ctx->str = str;
 768     }
 769
 770     if (changed)
 771         putchar('\n');
 772
 773     if (strcmp(outbuf, ctx->outbuf) != 0) {
 774         fputs("outbuf=", stdout);
 775         litputs(outbuf);
 776         putchar('\n');
 777         free(ctx->outbuf);
 778         ctx->outbuf = mh_xstrdup(outbuf);
 779     }
 780 }
 781
 782 static void
 783 fmt_dump (char *nfs, struct format *fmth)
 784 {
 785         struct format *fmt;
 786
 787         printf("Instruction dump of format string: \n%s\n", nfs);
 788
 789         /* Dump them out! */
 790         for (fmt = fmth; fmt; ++fmt) {
 791                 dumpone(fmt);
 792                 if (fmt->f_type == FT_DONE && fmt->f_value == 0)
 793                         break;
 794         }
 795 }
 796
 797 static void
 798 dumpone(struct format *fmt)
 799 {
 800         int i;
 801
 802         if ((i = findlabel(fmt)) >= 0)
 803                 printf("L%d:", i);
 804         putchar('\t');
 805
 806         fputs(f_typestr((int)fmt->f_type), stdout);
 807
 808         switch (fmt->f_type) {
 809
 810         case FT_COMP:
 811         case FT_LS_COMP:
 812         case FT_LV_COMPFLAG:
 813         case FT_LV_COMP:
 814                 fputs(", comp ", stdout);
 815                 litputs(fmt->f_comp->c_name);
 816                 if (fmt->f_comp->c_type)
 817                         printf(", c_type %s", c_typestr(fmt->f_comp->c_type));
 818                 if (fmt->f_comp->c_flags)
 819                         printf(", c_flags %s", c_flagsstr(fmt->f_comp->c_flags));
 820                 break;
 821
 822         case FT_LV_SEC:
 823         case FT_LV_MIN:
 824         case FT_LV_HOUR:
 825         case FT_LV_MDAY:
 826         case FT_LV_MON:
 827         case FT_LS_MONTH:
 828         case FT_LS_LMONTH:
 829         case FT_LS_ZONE:
 830         case FT_LV_YEAR:
 831         case FT_LV_WDAY:
 832         case FT_LS_DAY:
 833         case FT_LS_WEEKDAY:
 834         case FT_LV_YDAY:
 835         case FT_LV_ZONE:
 836         case FT_LV_CLOCK:
 837         case FT_LV_RCLOCK:
 838         case FT_LV_DAYF:
 839         case FT_LV_ZONEF:
 840         case FT_LV_DST:
 841         case FT_LS_822DATE:
 842         case FT_LS_PRETTY:
 843         case FT_LOCALDATE:
 844         case FT_GMTDATE:
 845         case FT_PARSEDATE:
 846                 fputs(", c_name ", stdout);
 847                 litputs(fmt->f_comp->c_name);
 848                 if (fmt->f_comp->c_type)
 849                         printf(", c_type %s", c_typestr(fmt->f_comp->c_type));
 850                 if (fmt->f_comp->c_flags)
 851                         printf(", c_flags %s", c_flagsstr(fmt->f_comp->c_flags));
 852                 break;
 853
 854         case FT_LS_ADDR:
 855         case FT_LS_PERS:
 856         case FT_LS_MBOX:
 857         case FT_LS_HOST:
 858         case FT_LS_PATH:
 859         case FT_LS_GNAME:
 860         case FT_LS_NOTE:
 861         case FT_LS_822ADDR:
 862         case FT_LV_HOSTTYPE:
 863         case FT_LV_INGRPF:
 864         case FT_LV_NOHOSTF:
 865         case FT_LS_FRIENDLY:
 866         case FT_PARSEADDR:
 867         case FT_MYMBOX:
 868         case FT_GETMYMBOX:
 869         case FT_GETMYADDR:
 870                 fputs(", c_name ", stdout);
 871                 litputs(fmt->f_comp->c_name);
 872                 if (fmt->f_comp->c_type)
 873                         printf(", c_type %s", c_typestr(fmt->f_comp->c_type));
 874                 if (fmt->f_comp->c_flags)
 875                         printf(", c_flags %s", c_flagsstr(fmt->f_comp->c_flags));
 876                 break;
 877
 878         case FT_COMPF:
 879                 printf(", width %d, fill '", fmt->f_width);
 880                 litputc(fmt->f_fill);
 881                 fputs("' name ", stdout);
 882                 litputs(fmt->f_comp->c_name);
 883                 if (fmt->f_comp->c_type)
 884                         printf(", c_type %s", c_typestr(fmt->f_comp->c_type));
 885                 if (fmt->f_comp->c_flags)
 886                         printf(", c_flags %s", c_flagsstr(fmt->f_comp->c_flags));
 887                 break;
 888
 889         case FT_STRF:
 890         case FT_NUMF:
 891                 printf(", width %d, fill '", fmt->f_width);
 892                 litputc(fmt->f_fill);
 893                 putchar('\'');
 894                 break;
 895
 896         case FT_LIT:
 897                 putchar(' ');
 898                 litputs(fmt->f_text);
 899                 break;
 900
 901         case FT_LITF:
 902                 printf(", width %d, fill '", fmt->f_width);
 903                 litputc(fmt->f_fill);
 904                 fputs("' ", stdout);
 905                 litputs(fmt->f_text);
 906                 break;
 907
 908         case FT_CHAR:
 909                 putchar(' ');
 910                 putchar('\'');
 911                 litputc(fmt->f_char);
 912                 putchar('\'');
 913                 break;
 914
 915
 916         case FT_IF_S:
 917         case FT_IF_S_NULL:
 918         case FT_IF_MATCH:
 919         case FT_IF_AMATCH:
 920                 fputs(" continue else goto", stdout);
 921                 /* FALLTHRU */
 922         case FT_GOTO:
 923                 i = findlabel(fmt + fmt->f_skip);
 924                 printf(" L%d", i);
 925                 break;
 926
 927         case FT_IF_V_EQ:
 928         case FT_IF_V_NE:
 929         case FT_IF_V_GT:
 930                 i = findlabel(fmt + fmt->f_skip);
 931                 printf(" %d continue else goto L%d", fmt->f_value, i);
 932                 break;
 933
 934         case FT_V_EQ:
 935         case FT_V_NE:
 936         case FT_V_GT:
 937         case FT_LV_LIT:
 938         case FT_LV_PLUS_L:
 939         case FT_LV_MINUS_L:
 940         case FT_LV_MULTIPLY_L:
 941         case FT_LV_DIVIDE_L:
 942         case FT_LV_MODULO_L:
 943                 printf(" value %d", fmt->f_value);
 944                 break;
 945
 946         case FT_LS_LIT:
 947                 fputs(" str ", stdout);
 948                 litputs(fmt->f_text);
 949                 break;
 950
 951         case FT_LS_GETENV:
 952                 fputs(" getenv ", stdout);
 953                 litputs(fmt->f_text);
 954                 break;
 955
 956         case FT_LS_DECODECOMP:
 957                 fputs(", comp ", stdout);
 958                 litputs(fmt->f_comp->c_name);
 959                 break;
 960
 961         case FT_LS_DECODE:
 962                 break;
 963
 964         case FT_LS_TRIM:
 965                 printf(", width %d", fmt->f_width);
 966                 break;
 967
 968         case FT_LV_DAT:
 969                 printf(", value dat[%d]", fmt->f_value);
 970                 break;
 971         }
 972         putchar('\n');
 973 }
 974
 975 /*
 976  * Iterate over all instructions and assign labels to the targets of
 977  * branch statements
 978  */
 979
 980 static void
 981 initlabels(struct format *fmth)
 982 {
 983         struct format *fmt, *addr;
 984         int i;
 985
 986         /* Assign labels */
 987         for (fmt = fmth; fmt; ++fmt) {
 988                 i = fmt->f_type;
 989                 if (i == FT_IF_S ||
 990                     i == FT_IF_S_NULL ||
 991                     i == FT_IF_V_EQ ||
 992                     i == FT_IF_V_NE ||
 993                     i == FT_IF_V_GT ||
 994                     i == FT_IF_MATCH ||
 995                     i == FT_IF_AMATCH ||
 996                     i == FT_GOTO) {
 997                         addr = fmt + fmt->f_skip;
 998                         if (findlabel(addr) < 0)
 999                                 assignlabel(addr);
1000                 }
1001                 if (fmt->f_type == FT_DONE && fmt->f_value == 0)
1002                         break;
1003         }
1004 }
1005
1006
1007 static int
1008 findlabel(struct format *addr)
1009 {
1010         int i;
1011
1012         for (i = 0; i < lused; ++i)
1013                 if (addr == lvec[i])
1014                         return i;
1015         return -1;
1016 }
1017
1018 static void
1019 assignlabel(struct format *addr)
1020 {
1021         if (lused >= lallocated) {
1022                 lallocated += 64;
1023                 lvec = (struct format **)
1024                         mh_xrealloc(lvec, sizeof(struct format *) * lallocated);
1025         }
1026
1027         lvec[lused++] = addr;
1028 }
1029
1030 static char *
1031 f_typestr(int t)
1032 {
1033         static char buf[32];
1034
1035         switch (t) {
1036         case FT_COMP: return "COMP";
1037         case FT_COMPF: return "COMPF";
1038         case FT_LIT: return "LIT";
1039         case FT_LITF: return "LITF";
1040         case FT_CHAR: return "CHAR";
1041         case FT_NUM: return "NUM";
1042         case FT_NUMF: return "NUMF";
1043         case FT_STR: return "STR";
1044         case FT_STRF: return "STRF";
1045         case FT_STRFW: return "STRFW";
1046         case FT_STRLIT: return "STRLIT";
1047         case FT_STRLITZ: return "STRLITZ";
1048         case FT_PUTADDR: return "PUTADDR";
1049         case FT_LS_COMP: return "LS_COMP";
1050         case FT_LS_LIT: return "LS_LIT";
1051         case FT_LS_GETENV: return "LS_GETENV";
1052         case FT_LS_CFIND: return "LS_CFIND";
1053         case FT_LS_DECODECOMP: return "LS_DECODECOMP";
1054         case FT_LS_DECODE: return "LS_DECODE";
1055         case FT_LS_TRIM: return "LS_TRIM";
1056         case FT_LV_COMP: return "LV_COMP";
1057         case FT_LV_COMPFLAG: return "LV_COMPFLAG";
1058         case FT_LV_LIT: return "LV_LIT";
1059         case FT_LV_DAT: return "LV_DAT";
1060         case FT_LV_STRLEN: return "LV_STRLEN";
1061         case FT_LV_PLUS_L: return "LV_PLUS_L";
1062         case FT_LV_MINUS_L: return "LV_MINUS_L";
1063         case FT_LV_MULTIPLY_L: return "LV_MULTIPLY_L";
1064         case FT_LV_DIVIDE_L: return "LV_DIVIDE_L";
1065         case FT_LV_MODULO_L: return "LV_MODULO_L";
1066         case FT_LV_CHAR_LEFT: return "LV_CHAR_LEFT";
1067         case FT_LS_MONTH: return "LS_MONTH";
1068         case FT_LS_LMONTH: return "LS_LMONTH";
1069         case FT_LS_ZONE: return "LS_ZONE";
1070         case FT_LS_DAY: return "LS_DAY";
1071         case FT_LS_WEEKDAY: return "LS_WEEKDAY";
1072         case FT_LS_822DATE: return "LS_822DATE";
1073         case FT_LS_PRETTY: return "LS_PRETTY";
1074         case FT_LS_KILO: return "LS_KILO";
1075         case FT_LS_KIBI: return "LS_KIBI";
1076         case FT_LV_SEC: return "LV_SEC";
1077         case FT_LV_MIN: return "LV_MIN";
1078         case FT_LV_HOUR: return "LV_HOUR";
1079         case FT_LV_MDAY: return "LV_MDAY";
1080         case FT_LV_MON: return "LV_MON";
1081         case FT_LV_YEAR: return "LV_YEAR";
1082         case FT_LV_YDAY: return "LV_YDAY";
1083         case FT_LV_WDAY: return "LV_WDAY";
1084         case FT_LV_ZONE: return "LV_ZONE";
1085         case FT_LV_CLOCK: return "LV_CLOCK";
1086         case FT_LV_RCLOCK: return "LV_RCLOCK";
1087         case FT_LV_DAYF: return "LV_DAYF";
1088         case FT_LV_DST: return "LV_DST";
1089         case FT_LV_ZONEF: return "LV_ZONEF";
1090         case FT_LS_PERS: return "LS_PERS";
1091         case FT_LS_MBOX: return "LS_MBOX";
1092         case FT_LS_HOST: return "LS_HOST";
1093         case FT_LS_PATH: return "LS_PATH";
1094         case FT_LS_GNAME: return "LS_GNAME";
1095         case FT_LS_NOTE: return "LS_NOTE";
1096         case FT_LS_ADDR: return "LS_ADDR";
1097         case FT_LS_822ADDR: return "LS_822ADDR";
1098         case FT_LS_FRIENDLY: return "LS_FRIENDLY";
1099         case FT_LV_HOSTTYPE: return "LV_HOSTTYPE";
1100         case FT_LV_INGRPF: return "LV_INGRPF";
1101         case FT_LS_UNQUOTE: return "LS_UNQUOTE";
1102         case FT_LV_NOHOSTF: return "LV_NOHOSTF";
1103         case FT_LOCALDATE: return "LOCALDATE";
1104         case FT_GMTDATE: return "GMTDATE";
1105         case FT_PARSEDATE: return "PARSEDATE";
1106         case FT_PARSEADDR: return "PARSEADDR";
1107         case FT_FORMATADDR: return "FORMATADDR";
1108         case FT_CONCATADDR: return "CONCATADDR";
1109         case FT_MYMBOX: return "MYMBOX";
1110         case FT_GETMYMBOX: return "GETMYMBOX";
1111         case FT_GETMYADDR: return "GETMYADDR";
1112         case FT_SAVESTR: return "SAVESTR";
1113         case FT_DONE: return "DONE";
1114         case FT_PAUSE: return "PAUSE";
1115         case FT_NOP: return "NOP";
1116         case FT_GOTO: return "GOTO";
1117         case FT_IF_S_NULL: return "IF_S_NULL";
1118         case FT_IF_S: return "IF_S";
1119         case FT_IF_V_EQ: return "IF_V_EQ";
1120         case FT_IF_V_NE: return "IF_V_NE";
1121         case FT_IF_V_GT: return "IF_V_GT";
1122         case FT_IF_MATCH: return "IF_MATCH";
1123         case FT_IF_AMATCH: return "IF_AMATCH";
1124         case FT_S_NULL: return "S_NULL";
1125         case FT_S_NONNULL: return "S_NONNULL";
1126         case FT_V_EQ: return "V_EQ";
1127         case FT_V_NE: return "V_NE";
1128         case FT_V_GT: return "V_GT";
1129         case FT_V_MATCH: return "V_MATCH";
1130         case FT_V_AMATCH: return "V_AMATCH";
1131         default:
1132                 snprintf(buf, sizeof(buf), "/* ??? #%d */", t);
1133                 return buf;
1134         }
1135 }
1136
1137 static char *
1138 c_typestr(int t)
1139 {
1140         static char buf[64];
1141
1142         snprintb(buf, sizeof(buf), t, CT_BITS);
1143         return buf;
1144 }
1145
1146 static char *
1147 c_flagsstr(int t)
1148 {
1149         static char buf[64];
1150
1151         snprintb(buf, sizeof(buf), t, CF_BITS);
1152         return buf;
1153 }
1154
1155 static void
1156 litputs(const char *s)
1157 {
1158         if (s) {
1159                 putchar('"');
1160                 while (*s)
1161                         litputc(*s++);
1162                 putchar('"');
1163         } else
1164                 fputs("<nil>", stdout);
1165 }
1166
1167 static void
1168 litputc(char c)
1169 {
1170         if (c & ~ 0177) {
1171                 printf("\\x%02x", (unsigned char) c);
1172         } else if (c < 0x20 || c == 0177) {
1173                 if (c == '\b') {
1174                         putchar('\\');
1175                         putchar('b');
1176                 } else if (c == '\f') {
1177                         putchar('\\');
1178                         putchar('f');
1179                 } else if (c == '\n') {
1180                         putchar('\\');
1181                         putchar('n');
1182                 } else if (c == '\r') {
1183                         putchar('\\');
1184                         putchar('r');
1185                 } else if (c == '\t') {
1186                         putchar('\\');
1187                         putchar('t');
1188                 } else {
1189                         putchar('^');
1190                         putchar(c ^ 0x40);      /* DEL to ?, others to alpha */
1191                 }
1192         } else
1193                 putchar(c);
1194 }
1195
1196 /*
1197  * Routines/code to support the duplicate address suppression code, adapted
1198  * from replsbr.c
1199  */
1200
1201 static char *buf;               /* our current working buffer */
1202 static char *bufend;            /* end of working buffer */
1203 static char *last_dst;          /* buf ptr at end of last call */
1204 static unsigned int bufsiz=0;   /* current size of buf */
1205
1206 #define BUFINCR 512             /* how much to expand buf when if fills */
1207
1208 #define CPY(s) { cp = (s); while ((*dst++ = *cp++)) ; --dst; }
1209
1210 /*
1211  * check if there's enough room in buf for str.
1212  * add more mem if needed
1213  */
1214 #define CHECKMEM(str) \
1215             if ((len = strlen (str)) >= bufend - dst) {\
1216                 int i = dst - buf;\
1217                 int n = last_dst - buf;\
1218                 bufsiz += ((dst + len - bufend) / BUFINCR + 1) * BUFINCR;\
1219                 buf = mh_xrealloc (buf, bufsiz);\
1220                 dst = buf + i;\
1221                 last_dst = buf + n;\
1222                 bufend = buf + bufsiz;\
1223             }
1224
1225
1226 /*
1227  * These are versions of similar routines from replsbr.c; the purpose is
1228  * to suppress duplicate addresses from being added to a list when building
1229  * up addresses for the %(formataddr) format function.  This is used by
1230  * repl to prevent duplicate addresses from being added to the "to" line.
1231  * See replsbr.c for more information.
1232  *
1233  * We can't use the functions in replsbr.c directly because they are slightly
1234  * different and depend on the rest of replsbr.c
1235  */
1236 static char *
1237 test_formataddr (char *orig, char *str)
1238 {
1239     int len;
1240     char error[BUFSIZ];
1241     bool isgroup;
1242     char *dst;
1243     char *cp;
1244     char *sp;
1245     struct mailname *mp = NULL;
1246
1247     /* if we don't have a buffer yet, get one */
1248     if (bufsiz == 0) {
1249         buf = mh_xmalloc (BUFINCR);
1250         last_dst = buf;         /* XXX */
1251         bufsiz = BUFINCR - 6;  /* leave some slop */
1252         bufend = buf + bufsiz;
1253     }
1254     /*
1255      * If "orig" points to our buffer we can just pick up where we
1256      * left off.  Otherwise we have to copy orig into our buffer.
1257      */
1258     if (orig == buf)
1259         dst = last_dst;
1260     else if (!orig || !*orig) {
1261         dst = buf;
1262         *dst = '\0';
1263     } else {
1264         dst = last_dst;         /* XXX */
1265         CHECKMEM (orig);
1266         CPY (orig);
1267     }
1268
1269     /* concatenate all the new addresses onto 'buf' */
1270     for (isgroup = false; (cp = getname (str)); ) {
1271         if ((mp = getm (cp, NULL, 0, error, sizeof(error))) == NULL) {
1272             fprintf(stderr, "bad address \"%s\" -- %s\n", cp, error);
1273             continue;
1274         }
1275         if (isgroup && (mp->m_gname || !mp->m_ingrp)) {
1276             *dst++ = ';';
1277             isgroup = false;
1278         }
1279         if (insert (mp)) {
1280             /* if we get here we're going to add an address */
1281             if (dst != buf) {
1282                 *dst++ = ',';
1283                 *dst++ = ' ';
1284             }
1285             if (mp->m_gname) {
1286                 CHECKMEM (mp->m_gname);
1287                 CPY (mp->m_gname);
1288                 isgroup = true;
1289             }
1290             sp = adrformat (mp);
1291             CHECKMEM (sp);
1292             CPY (sp);
1293         }
1294     }
1295
1296     if (isgroup)
1297         *dst++ = ';';
1298
1299     *dst = '\0';
1300     last_dst = dst;
1301     return buf;
1302 }
1303
1304
1305 /*
1306  * The companion to test_formataddr(); it behaves the same way, except doesn't
1307  * do duplicate address detection.
1308  */
1309 static char *
1310 test_concataddr(char *orig, char *str)
1311 {
1312     char *cp;
1313
1314     nodupcheck = true;
1315     cp = test_formataddr(orig, str);
1316     nodupcheck = false;
1317     return cp;
1318 }
1319
1320 static int
1321 insert (struct mailname *np)
1322 {
1323     struct mailname *mp;
1324
1325     if (nodupcheck)
1326         return 1;
1327
1328     if (np->m_mbox == NULL)
1329         return 0;
1330
1331     for (mp = &mq; mp->m_next; mp = mp->m_next) {
1332         if (!strcasecmp (FENDNULL(np->m_host),
1333                          FENDNULL(mp->m_next->m_host)) &&
1334             !strcasecmp (FENDNULL(np->m_mbox),
1335                          FENDNULL(mp->m_next->m_mbox)))
1336             return 0;
1337     }
1338     if (!ccme && ismymbox (np))
1339         return 0;
1340
1341     mp->m_next = np;
1342
1343     return 1;
1344 }
1345
1346 /*
1347  * Reset our duplicate address list
1348  */
1349
1350 void
1351 mlistfree(void)
1352 {
1353     struct mailname *mp, *mp2;
1354
1355     for (mp = mq.m_next; mp; mp = mp2) {
1356         mp2 = mp->m_next;
1357         mnfree(mp);
1358     }
1359 }