lex.c

   1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
   2  *@ (Lexical processing of) Commands, and the event mainloop.
   3  *
   4  * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
   5  * Copyright (c) 2012 - 2014 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
   6  */
   7 /*
   8  * Copyright (c) 1980, 1993
   9  * The Regents of the University of California.  All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *    This product includes software developed by the University of
  22  *    California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  */
  39
  40 #ifndef HAVE_AMALGAMATION
  41 # include "nail.h"
  42 #endif
  43
  44 #include <fcntl.h>
  45
  46 struct cmd {
  47    char const     *name;         /* Name of command */
  48    int            (*func)(void*); /* Implementor of command */
  49    enum argtype   argtype;       /* Arglist type (see below) */
  50    short          msgflag;       /* Required flags of msgs*/
  51    short          msgmask;       /* Relevant flags of msgs */
  52 #ifdef HAVE_DOCSTRINGS
  53    int            docid;         /* Translation id of .doc */
  54    char const     *doc;          /* One line doc for command */
  55 #endif
  56 };
  57 /* Yechh, can't initialize unions */
  58 #define minargs   msgflag        /* Minimum argcount for RAWLIST */
  59 #define maxargs   msgmask        /* Max argcount for RAWLIST */
  60
  61 struct cmd_ghost {
  62    struct cmd_ghost  *next;
  63    struct str        cmd;        /* Data follows after .name */
  64    char              name[VFIELD_SIZE(sizeof(size_t))];
  65 };
  66
  67 static int              *_msgvec;
  68 static int              _reset_on_stop;   /* do a reset() if stopped */
  69 static sighandler_type  _oldpipe;
  70 static struct cmd_ghost *_cmd_ghosts;
  71 /* _cmd_tab[] after fun protos */
  72 static int              _lex_inithdr;     /* am printing startup headers */
  73
  74 /* Update mailname (if name != NULL) and displayname, return wether displayname
  75  * was large enough to swallow mailname */
  76 static bool_t  _update_mailname(char const *name);
  77 #ifdef HAVE_C90AMEND1 /* TODO unite __narrow_{pre,suf}fix() into one fun! */
  78 SINLINE size_t __narrow_prefix(char const *cp, size_t maxl);
  79 SINLINE size_t __narrow_suffix(char const *cp, size_t cpl, size_t maxl);
  80 #endif
  81
  82 /* Isolate the command from the arguments */
  83 static char *  _lex_isolate(char const *comm);
  84
  85 /* Get first-fit, or NULL */
  86 static struct cmd const * _lex(char const *comm);
  87
  88 /* Command ghost handling */
  89 static int     _ghost(void *v);
  90 static int     _unghost(void *v);
  91
  92 /* Print a list of all commands */
  93 static int     _pcmdlist(void *v);
  94 static int     __pcmd_cmp(void const *s1, void const *s2);
  95
  96 /* Print the binaries compiled-in features */
  97 static int     _features(void *v);
  98
  99 /* Print the binaries version number */
 100 static int     _version(void *v);
 101
 102 /* When we wake up after ^Z, reprint the prompt */
 103 static void    stop(int s);
 104
 105 /* Branch here on hangup signal and simulate "exit" */
 106 static void    hangup(int s);
 107
 108 /* List of all commands */
 109 static struct cmd const _cmd_tab[] = {
 110 #include "cmd_tab.h"
 111 };
 112
 113 #ifdef HAVE_C90AMEND1
 114 SINLINE size_t
 115 __narrow_prefix(char const *cp, size_t maxl)
 116 {
 117    int err;
 118    size_t i, ok;
 119    NYD_ENTER;
 120
 121    for (err = ok = i = 0; i < maxl;) {
 122       int ml = mblen(cp, maxl - i);
 123       if (ml < 0) { /* XXX _narrow_prefix(): mblen() error; action? */
 124          (void)mblen(NULL, 0);
 125          err = 1;
 126          ml = 1;
 127       } else {
 128          if (!err)
 129             ok = i;
 130          err = 0;
 131          if (ml == 0)
 132             break;
 133       }
 134       cp += ml;
 135       i += ml;
 136    }
 137    NYD_LEAVE;
 138    return ok;
 139 }
 140
 141 SINLINE size_t
 142 __narrow_suffix(char const *cp, size_t cpl, size_t maxl)
 143 {
 144    int err;
 145    size_t i, ok;
 146    NYD_ENTER;
 147
 148    for (err = ok = i = 0; cpl > maxl || err;) {
 149       int ml = mblen(cp, cpl);
 150       if (ml < 0) { /* XXX _narrow_suffix(): mblen() error; action? */
 151          (void)mblen(NULL, 0);
 152          err = 1;
 153          ml = 1;
 154       } else {
 155          if (!err)
 156             ok = i;
 157          err = 0;
 158          if (ml == 0)
 159             break;
 160       }
 161       cp += ml;
 162       i += ml;
 163       cpl -= ml;
 164    }
 165    NYD_LEAVE;
 166    return ok;
 167 }
 168 #endif /* HAVE_C90AMEND1 */
 169
 170 static bool_t
 171 _update_mailname(char const *name)
 172 {
 173    char tbuf[PATH_MAX], *mailp, *dispp;
 174    size_t i, j;
 175    bool_t rv = TRU1;
 176    NYD_ENTER;
 177
 178    /* Don't realpath(3) if it's only an update request */
 179    if (name != NULL) {
 180 #ifdef HAVE_REALPATH
 181       enum protocol p = which_protocol(name);
 182       if (p == PROTO_FILE || p == PROTO_MAILDIR) {
 183          if (realpath(name, mailname) == NULL) {
 184             fprintf(stderr, tr(151, "Can't canonicalize `%s'\n"), name);
 185             rv = FAL0;
 186             goto jdocopy;
 187          }
 188       } else
 189 jdocopy:
 190 #endif
 191          n_strlcpy(mailname, name, sizeof(mailname));
 192    }
 193
 194    mailp = mailname;
 195    dispp = displayname;
 196
 197    /* Don't display an absolute path but "+FOLDER" if under *folder* */
 198    if (getfold(tbuf, sizeof tbuf)) {
 199       i = strlen(tbuf);
 200       if (i < sizeof(tbuf) - 1)
 201          tbuf[i++] = '/';
 202       if (strncmp(tbuf, mailp, i) == 0) {
 203          mailp += i;
 204          *dispp++ = '+';
 205       }
 206    }
 207
 208    /* We want to see the name of the folder .. on the screen */
 209    i = strlen(mailp);
 210    if (i < sizeof(displayname) - 1)
 211       memcpy(dispp, mailp, i + 1);
 212    else {
 213       rv = FAL0;
 214       /* Avoid disrupting multibyte sequences (if possible) */
 215 #ifndef HAVE_C90AMEND1
 216       j = sizeof(displayname) / 3 - 1;
 217       i -= sizeof(displayname) - (1/* + */ + 3) - j;
 218 #else
 219       j = __narrow_prefix(mailp, sizeof(displayname) / 3);
 220       i = j + __narrow_suffix(mailp + j, i - j,
 221          sizeof(displayname) - (1/* + */ + 3 + 1) - j);
 222 #endif
 223       snprintf(dispp, sizeof(displayname), "%.*s...%s",
 224          (int)j, mailp, mailp + i);
 225    }
 226    NYD_LEAVE;
 227    return rv;
 228 }
 229
 230 static char *
 231 _lex_isolate(char const *comm)
 232 {
 233    NYD_ENTER;
 234    while (*comm != '\0' &&
 235          strchr("~|?&% \t0123456789$^.:/-+*'\",;(`", *comm) == NULL)
 236       ++comm;
 237    NYD_LEAVE;
 238    return UNCONST(comm);
 239 }
 240
 241 static struct cmd const *
 242 _lex(char const *comm) /* TODO **command hashtable**! linear list search!!! */
 243 {
 244    struct cmd const *cp;
 245    NYD_ENTER;
 246
 247    for (cp = _cmd_tab; cp->name != NULL; ++cp)
 248       if (*comm == *cp->name && is_prefix(comm, cp->name))
 249          goto jleave;
 250    cp = NULL;
 251 jleave:
 252    NYD_LEAVE;
 253    return cp;
 254 }
 255
 256 static int
 257 _ghost(void *v)
 258 {
 259    char const **argv = (char const **)v;
 260    struct cmd_ghost *lcg, *cg;
 261    size_t nl, cl;
 262    NYD_ENTER;
 263
 264    /* Show the list? */
 265    if (*argv == NULL) {
 266       printf(tr(144, "Command ghosts are:\n"));
 267       for (nl = 0, cg = _cmd_ghosts; cg != NULL; cg = cg->next) {
 268          cl = strlen(cg->name) + 5 + cg->cmd.l + 3;
 269          nl += cl;
 270          if (UICMP(z, nl, >=, scrnwidth)) {
 271             nl = cl;
 272             printf("\n");
 273          }
 274          printf((cg->next != NULL ? "%s -> <%s>, " : "%s -> <%s>\n"),
 275             cg->name, cg->cmd.s);
 276       }
 277       v = NULL;
 278       goto jleave;
 279    }
 280
 281    /* Request to add new ghost */
 282    if (argv[1] == NULL || argv[1][0] == '\0' || argv[2] != NULL) {
 283       fprintf(stderr, tr(159, "Usage: %s\n"),
 284          tr(425, "Define a <ghost> of <command>, or list all ghosts"));
 285       v = NULL;
 286       goto jleave;
 287    }
 288
 289    /* Check that we can deal with this one */
 290    if (argv[0] == _lex_isolate(argv[0])) {
 291       fprintf(stderr, tr(151, "Can't canonicalize `%s'\n"), argv[0]);
 292       v = NULL;
 293       goto jleave;
 294    }
 295
 296    /* Always recreate */
 297    for (lcg = NULL, cg = _cmd_ghosts; cg != NULL; lcg = cg, cg = cg->next)
 298       if (!strcmp(cg->name, argv[0])) {
 299          if (lcg != NULL)
 300             lcg->next = cg->next;
 301          else
 302             _cmd_ghosts = cg->next;
 303          free(cg);
 304          break;
 305       }
 306
 307    /* Need a new one */
 308    nl = strlen(argv[0]) + 1;
 309    cl = strlen(argv[1]) + 1;
 310    cg = smalloc(sizeof(*cg) - VFIELD_SIZEOF(struct cmd_ghost, name) + nl + cl);
 311    cg->next = _cmd_ghosts;
 312    memcpy(cg->name, argv[0], nl);
 313    cg->cmd.s = cg->name + nl;
 314    cg->cmd.l = cl - 1;
 315    memcpy(cg->cmd.s, argv[1], cl);
 316
 317    _cmd_ghosts = cg;
 318 jleave:
 319    NYD_LEAVE;
 320    return (v == NULL);
 321 }
 322
 323 static int
 324 _unghost(void *v)
 325 {
 326    int rv = 0;
 327    char const **argv = v, *cp;
 328    struct cmd_ghost *lcg, *cg;
 329    NYD_ENTER;
 330
 331    while ((cp = *argv++) != NULL) {
 332       for (lcg = NULL, cg = _cmd_ghosts; cg != NULL; lcg = cg, cg = cg->next)
 333          if (!strcmp(cg->name, cp)) {
 334             if (lcg != NULL)
 335                lcg->next = cg->next;
 336             else
 337                _cmd_ghosts = cg->next;
 338             free(cg);
 339             goto jouter;
 340          }
 341       fprintf(stderr, tr(91, "Unknown command: `%s'\n"), cp);
 342       rv = 1;
 343 jouter:
 344       ;
 345    }
 346    NYD_LEAVE;
 347    return rv;
 348 }
 349
 350 static int
 351 __pcmd_cmp(void const *s1, void const *s2)
 352 {
 353    struct cmd const * const *c1 = s1, * const *c2 = s2;
 354    int rv;
 355    NYD_ENTER;
 356
 357    rv = strcmp((*c1)->name, (*c2)->name);
 358    NYD_LEAVE;
 359    return rv;
 360 }
 361
 362 static int
 363 _pcmdlist(void *v)
 364 {
 365    struct cmd const **cpa, *cp, **cursor;
 366    size_t i;
 367    NYD_ENTER;
 368    UNUSED(v);
 369
 370    for (i = 0; _cmd_tab[i].name != NULL; ++i)
 371       ;
 372    ++i;
 373    cpa = ac_alloc(sizeof(cp) * i);
 374
 375    for (i = 0; (cp = _cmd_tab + i)->name != NULL; ++i)
 376       cpa[i] = cp;
 377    cpa[i] = NULL;
 378
 379    qsort(cpa, i, sizeof(cp), &__pcmd_cmp);
 380
 381    printf(tr(14, "Commands are:\n"));
 382    for (i = 0, cursor = cpa; (cp = *cursor++) != NULL;) {
 383       size_t j;
 384       if (cp->func == &c_cmdnotsupp)
 385          continue;
 386       j = strlen(cp->name) + 2;
 387       if ((i += j) > 72) {
 388          i = j;
 389          printf("\n");
 390       }
 391       printf((*cursor != NULL ? "%s, " : "%s\n"), cp->name);
 392    }
 393
 394    ac_free(cpa);
 395    NYD_LEAVE;
 396    return 0;
 397 }
 398
 399 static int
 400 _features(void *v)
 401 {
 402    NYD_ENTER;
 403    UNUSED(v);
 404    printf(tr(523, "Features: %s\n"), features);
 405    NYD_LEAVE;
 406    return 0;
 407 }
 408
 409 static int
 410 _version(void *v)
 411 {
 412    NYD_ENTER;
 413    UNUSED(v);
 414    printf(tr(111, "Version %s\n"), version);
 415    NYD_LEAVE;
 416    return 0;
 417 }
 418
 419 static void
 420 stop(int s)
 421 {
 422    sighandler_type old_action;
 423    sigset_t nset;
 424    NYD_X; /* Signal handler */
 425
 426    old_action = safe_signal(s, SIG_DFL);
 427
 428    sigemptyset(&nset);
 429    sigaddset(&nset, s);
 430    sigprocmask(SIG_UNBLOCK, &nset, NULL);
 431    kill(0, s);
 432    sigprocmask(SIG_BLOCK, &nset, NULL);
 433    safe_signal(s, old_action);
 434    if (_reset_on_stop) {
 435       _reset_on_stop = 0;
 436       reset(0);
 437    }
 438 }
 439
 440 static void
 441 hangup(int s)
 442 {
 443    NYD_X; /* Signal handler */
 444    UNUSED(s);
 445    /* nothing to do? */
 446    exit(1);
 447 }
 448
 449 FL int
 450 setfile(char const *name, int nmail) /* TODO oh my god */
 451 {
 452    static int shudclob;
 453
 454    struct stat stb;
 455    struct flock flp;
 456    FILE *ibuf = NULL;
 457    int rv, i, compressed = 0, omsgCount = 0;
 458    bool_t isedit;
 459    char const *who;
 460    size_t offset;
 461    struct shortcut *sh;
 462    NYD_ENTER;
 463
 464    /* Note we don't 'userid(myname) != getuid()', preliminary steps are usually
 465     * necessary to make a mailbox accessible by a different user, and if that
 466     * has happened, let's just let the usual file perms decide */
 467    who = (name[1] != '\0') ? name + 1 : myname;
 468    isedit = (*name != '%' && ((sh = get_shortcut(name)) == NULL ||
 469          *sh->sh_long != '%'));
 470    if ((name = expand(name)) == NULL)
 471       goto jem1;
 472
 473    switch (which_protocol(name)) {
 474    case PROTO_FILE:
 475       break;
 476    case PROTO_MAILDIR:
 477       rv = maildir_setfile(name, nmail, isedit);
 478       goto jleave;
 479 #ifdef HAVE_POP3
 480    case PROTO_POP3:
 481       shudclob = 1;
 482       rv = pop3_setfile(name, nmail, isedit);
 483       goto jleave;
 484 #endif
 485 #ifdef HAVE_IMAP
 486    case PROTO_IMAP:
 487       shudclob = 1;
 488       if (nmail && mb.mb_type == MB_CACHE)
 489          rv = 1;
 490       else
 491          rv = imap_setfile(name, nmail, isedit);
 492       goto jleave;
 493 #endif
 494    default:
 495       fprintf(stderr, tr(217, "Cannot handle protocol: %s\n"), name);
 496       goto jem1;
 497    }
 498
 499    /* FIXME this FILE leaks if quit()->edstop() reset()s!  This entire code
 500     * FIXME here is total crap, below we open(2) the same name again just to
 501     * FIXME close it right away etc.  The normal thing would be to (1) finalize
 502     * FIXME the current box and (2) open the new box; yet, since (2) may fail
 503     * FIXME we terribly need our VOID box to make this logic order possible! */
 504    if ((ibuf = Zopen(name, "r", &compressed)) == NULL) {
 505       if ((!isedit && errno == ENOENT) || nmail) {
 506          if (nmail)
 507             goto jnonmail;
 508          goto jnomail;
 509       }
 510       perror(name);
 511       goto jem1;
 512    }
 513
 514    if (fstat(fileno(ibuf), &stb) < 0) {
 515       if (nmail)
 516          goto jnonmail;
 517       perror("fstat");
 518       goto jem1;
 519    }
 520
 521    if (S_ISDIR(stb.st_mode)) {
 522       if (nmail)
 523          goto jnonmail;
 524       errno = EISDIR;
 525       perror(name);
 526       goto jem1;
 527    } else if (S_ISREG(stb.st_mode)) {
 528       /*EMPTY*/
 529    } else {
 530       if (nmail)
 531          goto jnonmail;
 532       errno = EINVAL;
 533       perror(name);
 534       goto jem1;
 535    }
 536
 537    /* Looks like all will be well.  We must now relinquish our hold on the
 538     * current set of stuff.  Must hold signals while we are reading the new
 539     * file, else we will ruin the message[] data structure */
 540
 541    hold_sigs(); /* TODO note on this one in quit.c:quit() */
 542    if (shudclob && !nmail)
 543       quit();
 544 #ifdef HAVE_SOCKETS
 545    if (!nmail && mb.mb_sock.s_fd >= 0)
 546       sclose(&mb.mb_sock);
 547 #endif
 548
 549    /* Copy the messages into /tmp and set pointers */
 550    flp.l_type = F_RDLCK;
 551    flp.l_start = 0;
 552    flp.l_whence = SEEK_SET;
 553    if (!nmail) {
 554       mb.mb_type = MB_FILE;
 555       mb.mb_perm = (options & OPT_R_FLAG) ? 0 : MB_DELE | MB_EDIT;
 556       mb.mb_compressed = compressed;
 557       if (compressed) {
 558          if (compressed & 0200)
 559             mb.mb_perm = 0;
 560       } else {
 561          if ((i = open(name, O_WRONLY)) < 0)
 562             mb.mb_perm = 0;
 563          else
 564             close(i);
 565       }
 566       if (shudclob) {
 567          if (mb.mb_itf) {
 568             fclose(mb.mb_itf);
 569             mb.mb_itf = NULL;
 570          }
 571          if (mb.mb_otf) {
 572             fclose(mb.mb_otf);
 573             mb.mb_otf = NULL;
 574          }
 575       }
 576       shudclob = 1;
 577       edit = isedit;
 578       initbox(name);
 579       offset = 0;
 580       flp.l_len = 0;
 581       if (!edit && fcntl(fileno(ibuf), F_SETLKW, &flp) == -1) {
 582          perror("Unable to lock mailbox");
 583          rele_sigs();
 584          goto jem1;
 585       }
 586    } else /* nmail */{
 587       fseek(mb.mb_otf, 0L, SEEK_END);
 588       fseek(ibuf, mailsize, SEEK_SET);
 589       offset = mailsize;
 590       omsgCount = msgCount;
 591       flp.l_len = offset;
 592       if (!edit && fcntl(fileno(ibuf), F_SETLKW, &flp) == -1) {
 593          rele_sigs();
 594          goto jnonmail;
 595       }
 596    }
 597    mailsize = fsize(ibuf);
 598
 599    if (nmail && UICMP(z, mailsize, <=, offset)) {
 600       rele_sigs();
 601       goto jnonmail;
 602    }
 603    setptr(ibuf, offset);
 604    setmsize(msgCount);
 605    if (nmail && mb.mb_sorted) {
 606       mb.mb_threaded = 0;
 607       c_sort((void*)-1);
 608    }
 609
 610    Fclose(ibuf);
 611    ibuf = NULL;
 612    rele_sigs();
 613    if (!nmail)
 614       sawcom = FAL0;
 615
 616    if ((!edit || nmail) && msgCount == 0) {
 617 jnonmail:
 618       if (!nmail) {
 619          if (!ok_blook(emptystart))
 620 jnomail:
 621             fprintf(stderr, tr(88, "No mail for %s\n"), who);
 622       }
 623       rv = 1;
 624       goto jleave;
 625    }
 626    if (nmail)
 627       newmailinfo(omsgCount);
 628
 629    rv = 0;
 630 jleave:
 631    if (ibuf != NULL)
 632       Fclose(ibuf);
 633    NYD_LEAVE;
 634    return rv;
 635 jem1:
 636    rv = -1;
 637    goto jleave;
 638 }
 639
 640 FL int
 641 newmailinfo(int omsgCount)
 642 {
 643    int mdot, i;
 644    NYD_ENTER;
 645
 646    for (i = 0; i < omsgCount; i++)
 647       message[i].m_flag &= ~MNEWEST;
 648    if (msgCount > omsgCount) {
 649       for (i = omsgCount; i < msgCount; i++)
 650          message[i].m_flag |= MNEWEST;
 651       printf(tr(158, "New mail has arrived.\n"));
 652       if (msgCount - omsgCount == 1)
 653          printf(tr(214, "Loaded 1 new message.\n"));
 654       else
 655          printf(tr(215, "Loaded %d new messages.\n"), msgCount - omsgCount);
 656    } else
 657       printf(tr(224, "Loaded %d messages.\n"), msgCount);
 658    callhook(mailname, 1);
 659    mdot = getmdot(1);
 660    if (ok_blook(header))
 661       print_headers(omsgCount + 1, msgCount);
 662    NYD_LEAVE;
 663    return mdot;
 664 }
 665
 666 FL void
 667 commands(void)
 668 {
 669    struct eval_ctx ev;
 670    int n;
 671    NYD_ENTER;
 672
 673    if (!sourcing) {
 674       if (safe_signal(SIGINT, SIG_IGN) != SIG_IGN)
 675          safe_signal(SIGINT, onintr);
 676       if (safe_signal(SIGHUP, SIG_IGN) != SIG_IGN)
 677          safe_signal(SIGHUP, hangup);
 678       /* TODO We do a lot of redundant signal handling, especially
 679        * TODO with the command line editor(s); try to merge this */
 680       safe_signal(SIGTSTP, stop);
 681       safe_signal(SIGTTOU, stop);
 682       safe_signal(SIGTTIN, stop);
 683    }
 684    _oldpipe = safe_signal(SIGPIPE, SIG_IGN);
 685    safe_signal(SIGPIPE, _oldpipe);
 686
 687    memset(&ev, 0, sizeof ev);
 688
 689    setexit();
 690    for (;;) {
 691       interrupts = 0;
 692       handlerstacktop = NULL;
 693
 694       if (!sourcing && (options & OPT_INTERACTIVE)) {
 695          char *cp;
 696
 697          if ((cp = ok_vlook(newmail)) == NULL)
 698             cp = ok_vlook(autoinc); /* TODO legacy */
 699          if ((options & OPT_TTYIN) && (cp != NULL || mb.mb_type == MB_IMAP)) {
 700             struct stat st;
 701
 702             n = (cp != NULL && strcmp(cp, "noimap") && strcmp(cp, "nopoll"));
 703             if ((mb.mb_type == MB_FILE && stat(mailname, &st) == 0 &&
 704                      st.st_size > mailsize) ||
 705 #ifdef HAVE_IMAP
 706                   (mb.mb_type == MB_IMAP && imap_newmail(n) > (cp == NULL)) ||
 707 #endif
 708                   (mb.mb_type == MB_MAILDIR && n != 0)) {
 709                size_t odot = PTR2SIZE(dot - message);
 710                bool_t odid = did_print_dot;
 711
 712                setfile(mailname, 1);
 713                if (mb.mb_type != MB_IMAP) {
 714                   dot = message + odot;
 715                   did_print_dot = odid;
 716                }
 717             }
 718          }
 719
 720          _reset_on_stop = 1;
 721          exit_status = 0;
 722       }
 723
 724 #ifdef HAVE_COLOUR
 725       colour_table = NULL; /* XXX intermediate hack */
 726 #endif
 727       sreset(sourcing);
 728       if (!sourcing) {
 729          char *cp;
 730
 731          /* TODO Note: this buffer may contain a password.  We should redefine
 732           * TODO the code flow which has to do that */
 733          if ((cp = termios_state.ts_linebuf) != NULL) {
 734             termios_state.ts_linebuf = NULL;
 735             termios_state.ts_linesize = 0;
 736             free(cp); /* TODO pool give-back */
 737          }
 738          /* TODO Due to expand-on-tab of NCL the buffer may grow */
 739          if (ev.ev_line.l > LINESIZE * 3) {
 740             free(ev.ev_line.s); /* TODO pool! but what? */
 741             ev.ev_line.s = NULL;
 742             ev.ev_line.l = 0;
 743          }
 744       }
 745
 746       /* Read a line of commands and handle end of file specially */
 747 jreadline:
 748       n = readline_input(NULL, TRU1, &ev.ev_line.s, &ev.ev_line.l,
 749             ev.ev_new_content);
 750       _reset_on_stop = 0;
 751       if (n < 0) {
 752          /* EOF */
 753          if (loading)
 754             break;
 755          if (sourcing) {
 756             unstack();
 757             continue;
 758          }
 759          if ((options & OPT_INTERACTIVE) && ok_blook(ignoreeof)) {
 760             printf(tr(89, "Use `quit' to quit.\n"));
 761             continue;
 762          }
 763          break;
 764       }
 765
 766       inhook = 0;
 767       if (evaluate(&ev))
 768          break;
 769       if (exit_status != EXIT_OK && (options & OPT_BATCH_FLAG) &&
 770             ok_blook(batch_exit_on_error))
 771          break;
 772       if (!sourcing && (options & OPT_INTERACTIVE)) {
 773          if (ev.ev_new_content != NULL)
 774             goto jreadline;
 775          if (ev.ev_add_history)
 776             tty_addhist(ev.ev_line.s);
 777       }
 778    }
 779
 780    if (ev.ev_line.s != NULL)
 781       free(ev.ev_line.s);
 782    if (sourcing)
 783       sreset(FAL0);
 784    NYD_LEAVE;
 785 }
 786
 787 FL int
 788 execute(char *linebuf, int contxt, size_t linesize) /* XXX LEGACY */
 789 {
 790    struct eval_ctx ev;
 791 #ifdef HAVE_COLOUR
 792    struct colour_table *ct_save;
 793 #endif
 794    int rv;
 795    NYD_ENTER;
 796
 797    /* TODO Maybe recursion from within collect.c!  As long as we don't have
 798     * TODO a value carrier that transports the entire state of a recursion
 799     * TODO we need to save away also the colour table */
 800 #ifdef HAVE_COLOUR
 801    ct_save = colour_table;
 802    colour_table = NULL;
 803 #endif
 804
 805    memset(&ev, 0, sizeof ev);
 806    ev.ev_line.s = linebuf;
 807    ev.ev_line.l = linesize;
 808    ev.ev_is_recursive = (contxt != 0);
 809    rv = evaluate(&ev);
 810
 811 #ifdef HAVE_COLOUR
 812    colour_table = ct_save;
 813 #endif
 814    NYD_LEAVE;
 815    return rv;
 816 }
 817
 818 FL int
 819 evaluate(struct eval_ctx *evp)
 820 {
 821    struct str line;
 822    char _wordbuf[2], *arglist[MAXARGC], *cp, *word;
 823    struct cmd_ghost *cg = NULL;
 824    struct cmd const *com = NULL;
 825    int muvec[2], c, e = 1;
 826    NYD_ENTER;
 827
 828    line = evp->ev_line; /* XXX don't change original (buffer pointer) */
 829    evp->ev_add_history = FAL0;
 830    evp->ev_new_content = NULL;
 831
 832    /* Command ghosts that refer to shell commands or macro expansion restart */
 833 jrestart:
 834
 835    /* Strip the white space away from the beginning of the command */
 836    for (cp = line.s; whitechar(*cp); ++cp)
 837       ;
 838    line.l -= PTR2SIZE(cp - line.s);
 839
 840    /* Ignore comments */
 841    if (*cp == '#')
 842       goto jleave0;
 843
 844    /* Handle ! differently to get the correct lexical conventions */
 845    if (*cp == '!') {
 846       if (sourcing) {
 847          fprintf(stderr, tr(90, "Can't `!' while sourcing\n"));
 848          goto jleave;
 849       }
 850       c_shell(++cp);
 851       evp->ev_add_history = TRU1;
 852       goto jleave0;
 853    }
 854
 855    /* Isolate the actual command; since it may not necessarily be
 856     * separated from the arguments (as in `p1') we need to duplicate it to
 857     * be able to create a NUL terminated version.
 858     * We must be aware of several special one letter commands here */
 859    arglist[0] = cp;
 860    if ((cp = _lex_isolate(cp)) == arglist[0] &&
 861          (*cp == '|' || *cp == '~' || *cp == '?'))
 862       ++cp;
 863    c = (int)PTR2SIZE(cp - arglist[0]);
 864    line.l -= c;
 865    word = UICMP(z, c, <, sizeof _wordbuf) ? _wordbuf : salloc(c + 1);
 866    memcpy(word, arglist[0], c);
 867    word[c] = '\0';
 868
 869    /* Look up the command; if not found, bitch.
 870     * Normally, a blank command would map to the first command in the
 871     * table; while sourcing, however, we ignore blank lines to eliminate
 872     * confusion; act just the same for ghosts */
 873    if (*word == '\0') {
 874       if (sourcing || cg != NULL)
 875          goto jleave0;
 876       com = _cmd_tab + 0;
 877       goto jexec;
 878    }
 879
 880    /* If this is the first evaluation, check command ghosts */
 881    if (cg == NULL) {
 882       /* TODO relink list head, so it's sorted on usage over time?
 883        * TODO in fact, there should be one hashmap over all commands and ghosts
 884        * TODO so that the lookup could be made much more efficient than it is
 885        * TODO now (two adjacent list searches! */
 886       for (cg = _cmd_ghosts; cg != NULL; cg = cg->next)
 887          if (!strcmp(word, cg->name)) {
 888             if (line.l > 0) {
 889                size_t i = cg->cmd.l;
 890                line.s = salloc(i + 1 + line.l +1);
 891                memcpy(line.s, cg->cmd.s, i);
 892                line.s[i++] = ' ';
 893                memcpy(line.s + i, cp, line.l);
 894                line.s[i += line.l] = '\0';
 895                line.l = i;
 896             } else {
 897                line.s = cg->cmd.s;
 898                line.l = cg->cmd.l;
 899             }
 900             goto jrestart;
 901          }
 902    }
 903
 904    if ((com = _lex(word)) == NULL || com->func == &c_cmdnotsupp) {
 905       fprintf(stderr, tr(91, "Unknown command: `%s'\n"), word);
 906       if (com != NULL) {
 907          c_cmdnotsupp(NULL);
 908          com = NULL;
 909       }
 910       goto jleave;
 911    }
 912
 913    /* See if we should execute the command -- if a conditional we always
 914     * execute it, otherwise, check the state of cond */
 915 jexec:
 916    if (!(com->argtype & ARG_F)) {
 917       if (condstack_isskip())
 918          goto jleave0;
 919    }
 920
 921    /* Process the arguments to the command, depending on the type he expects.
 922     * Default to an error.
 923     * If we are sourcing an interactive command, it's an error */
 924    if ((options & OPT_SENDMODE) && !(com->argtype & ARG_M)) {
 925       fprintf(stderr, tr(92, "May not execute `%s' while sending\n"),
 926          com->name);
 927       goto jleave;
 928    }
 929    if (sourcing && (com->argtype & ARG_I)) {
 930       fprintf(stderr, tr(93, "May not execute `%s' while sourcing\n"),
 931          com->name);
 932       goto jleave;
 933    }
 934    if (!(mb.mb_perm & MB_DELE) && (com->argtype & ARG_W)) {
 935       fprintf(stderr, tr(94, "May not execute `%s' -- "
 936          "message file is read only\n"), com->name);
 937       goto jleave;
 938    }
 939    if (evp->ev_is_recursive && (com->argtype & ARG_R)) {
 940       fprintf(stderr, tr(95, "Cannot recursively invoke `%s'\n"), com->name);
 941       goto jleave;
 942    }
 943    if (mb.mb_type == MB_VOID && (com->argtype & ARG_A)) {
 944       fprintf(stderr, tr(257, "Cannot execute `%s' without active mailbox\n"),
 945          com->name);
 946       goto jleave;
 947    }
 948
 949    if (com->argtype & ARG_V)
 950       temporary_arg_v_store = NULL;
 951
 952    switch (com->argtype & ARG_ARGMASK) {
 953    case ARG_MSGLIST:
 954       /* Message list defaulting to nearest forward legal message */
 955       if (_msgvec == 0)
 956          goto je96;
 957       if ((c = getmsglist(cp, _msgvec, com->msgflag)) < 0)
 958          break;
 959       if (c == 0) {
 960          *_msgvec = first(com->msgflag, com->msgmask);
 961          if (*_msgvec != 0)
 962             _msgvec[1] = 0;
 963       }
 964       if (*_msgvec == 0) {
 965          if (!inhook)
 966             printf(tr(97, "No applicable messages\n"));
 967          break;
 968       }
 969       e = (*com->func)(_msgvec);
 970       break;
 971
 972    case ARG_NDMLIST:
 973       /* Message list with no defaults, but no error if none exist */
 974       if (_msgvec == 0) {
 975 je96:
 976          fprintf(stderr, tr(96, "Illegal use of `message list'\n"));
 977          break;
 978       }
 979       if ((c = getmsglist(cp, _msgvec, com->msgflag)) < 0)
 980          break;
 981       e = (*com->func)(_msgvec);
 982       break;
 983
 984    case ARG_STRLIST:
 985       /* Just the straight string, with leading blanks removed */
 986       while (whitechar(*cp))
 987          ++cp;
 988       e = (*com->func)(cp);
 989       break;
 990
 991    case ARG_RAWLIST:
 992    case ARG_ECHOLIST:
 993       /* A vector of strings, in shell style */
 994       if ((c = getrawlist(cp, line.l, arglist, NELEM(arglist),
 995             ((com->argtype & ARG_ARGMASK) == ARG_ECHOLIST))) < 0)
 996          break;
 997       if (c < com->minargs) {
 998          fprintf(stderr, tr(99, "`%s' requires at least %d arg(s)\n"),
 999             com->name, com->minargs);
1000          break;
1001       }
1002       if (c > com->maxargs) {
1003          fprintf(stderr, tr(100, "`%s' takes no more than %d arg(s)\n"),
1004             com->name, com->maxargs);
1005          break;
1006       }
1007       e = (*com->func)(arglist);
1008       break;
1009
1010    case ARG_NOLIST:
1011       /* Just the constant zero, for exiting, eg. */
1012       e = (*com->func)(0);
1013       break;
1014
1015    default:
1016       panic(tr(101, "Unknown argument type"));
1017    }
1018
1019    if (e == 0 && (com->argtype & ARG_V) &&
1020          (cp = temporary_arg_v_store) != NULL) {
1021       temporary_arg_v_store = NULL;
1022       evp->ev_new_content = cp;
1023       goto jleave0;
1024    }
1025    if (!(com->argtype & ARG_H) && !list_saw_numbers)
1026       evp->ev_add_history = TRU1;
1027
1028 jleave:
1029    /* Exit the current source file on error */
1030    if ((exec_last_comm_error = (e != 0))) {
1031       if (e < 0 || loading) {
1032          e = 1;
1033          goto jret;
1034       }
1035       if (sourcing)
1036          unstack();
1037       goto jret0;
1038    }
1039    if (com == NULL)
1040       goto jret0;
1041    if ((com->argtype & ARG_P) && ok_blook(autoprint))
1042       if (visible(dot)) {
1043          muvec[0] = (int)PTR2SIZE(dot - message + 1);
1044          muvec[1] = 0;
1045          c_type(muvec);
1046       }
1047    if (!sourcing && !inhook && (com->argtype & ARG_T) == 0)
1048       sawcom = TRU1;
1049 jleave0:
1050    exec_last_comm_error = 0;
1051 jret0:
1052    e = 0;
1053 jret:
1054    NYD_LEAVE;
1055    return e;
1056 }
1057
1058 FL void
1059 setmsize(int sz)
1060 {
1061    NYD_ENTER;
1062    if (_msgvec != 0)
1063       free(_msgvec);
1064    _msgvec = scalloc(sz + 1, sizeof *_msgvec);
1065    NYD_LEAVE;
1066 }
1067
1068 FL void
1069 onintr(int s)
1070 {
1071    NYD_X; /* Signal handler */
1072
1073    if (handlerstacktop != NULL) {
1074       handlerstacktop(s);
1075       return;
1076    }
1077    safe_signal(SIGINT, onintr);
1078    noreset = 0;
1079    if (!_lex_inithdr)
1080       sawcom = TRU1;
1081    _lex_inithdr = 0;
1082    while (sourcing)
1083       unstack();
1084
1085    termios_state_reset();
1086    close_all_files();
1087
1088    if (image >= 0) {
1089       close(image);
1090       image = -1;
1091    }
1092    if (interrupts != 1)
1093       fprintf(stderr, tr(102, "Interrupt\n"));
1094    safe_signal(SIGPIPE, _oldpipe);
1095    reset(0);
1096 }
1097
1098 FL void
1099 announce(int printheaders)
1100 {
1101    int vec[2], mdot;
1102    NYD_ENTER;
1103
1104    mdot = newfileinfo();
1105    vec[0] = mdot;
1106    vec[1] = 0;
1107    dot = &message[mdot - 1];
1108    if (printheaders && msgCount > 0 && ok_blook(header)) {
1109       ++_lex_inithdr;
1110       c_headers(vec);
1111       _lex_inithdr = 0;
1112    }
1113    NYD_LEAVE;
1114 }
1115
1116 FL int
1117 newfileinfo(void)
1118 {
1119    struct message *mp;
1120    int u, n, mdot, d, s, hidden, moved;
1121    NYD_ENTER;
1122
1123    if (mb.mb_type == MB_VOID) {
1124       mdot = 1;
1125       goto jleave;
1126    }
1127
1128    mdot = getmdot(0);
1129    s = d = hidden = moved =0;
1130    for (mp = message, n = 0, u = 0; PTRCMP(mp, <, message + msgCount); ++mp) {
1131       if (mp->m_flag & MNEW)
1132          ++n;
1133       if ((mp->m_flag & MREAD) == 0)
1134          ++u;
1135       if ((mp->m_flag & (MDELETED | MSAVED)) == (MDELETED | MSAVED))
1136          ++moved;
1137       if ((mp->m_flag & (MDELETED | MSAVED)) == MDELETED)
1138          ++d;
1139       if ((mp->m_flag & (MDELETED | MSAVED)) == MSAVED)
1140          ++s;
1141       if (mp->m_flag & MHIDDEN)
1142          ++hidden;
1143    }
1144
1145    /* If displayname gets truncated the user effectively has no option to see
1146     * the full pathname of the mailbox, so print it at least for '? fi' */
1147    printf(tr(103, "\"%s\": "),
1148       (_update_mailname(NULL) ? displayname : mailname));
1149    if (msgCount == 1)
1150       printf(tr(104, "1 message"));
1151    else
1152       printf(tr(105, "%d messages"), msgCount);
1153    if (n > 0)
1154       printf(tr(106, " %d new"), n);
1155    if (u-n > 0)
1156       printf(tr(107, " %d unread"), u);
1157    if (d > 0)
1158       printf(tr(108, " %d deleted"), d);
1159    if (s > 0)
1160       printf(tr(109, " %d saved"), s);
1161    if (moved > 0)
1162       printf(tr(136, " %d moved"), moved);
1163    if (hidden > 0)
1164       printf(tr(139, " %d hidden"), hidden);
1165    if (mb.mb_type == MB_CACHE)
1166       printf(" [Disconnected]");
1167    else if (mb.mb_perm == 0)
1168       printf(tr(110, " [Read only]"));
1169    printf("\n");
1170 jleave:
1171    NYD_LEAVE;
1172    return mdot;
1173 }
1174
1175 FL int
1176 getmdot(int nmail)
1177 {
1178    struct message *mp;
1179    char *cp;
1180    int mdot;
1181    enum mflag avoid = MHIDDEN | MDELETED;
1182    NYD_ENTER;
1183
1184    if (!nmail) {
1185       if (ok_blook(autothread))
1186          c_thread(NULL);
1187       else if ((cp = ok_vlook(autosort)) != NULL) {
1188          free(mb.mb_sorted);
1189          mb.mb_sorted = sstrdup(cp);
1190          c_sort(NULL);
1191       }
1192    }
1193    if (mb.mb_type == MB_VOID) {
1194       mdot = 1;
1195       goto jleave;
1196    }
1197
1198    if (nmail)
1199       for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp)
1200          if ((mp->m_flag & (MNEWEST | avoid)) == MNEWEST)
1201             break;
1202
1203    if (!nmail || PTRCMP(mp, >=, message + msgCount)) {
1204       if (mb.mb_threaded) {
1205          for (mp = threadroot; mp != NULL; mp = next_in_thread(mp))
1206             if ((mp->m_flag & (MNEW | avoid)) == MNEW)
1207                break;
1208       } else {
1209          for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp)
1210             if ((mp->m_flag & (MNEW | avoid)) == MNEW)
1211                break;
1212       }
1213    }
1214
1215    if ((mb.mb_threaded ? (mp == NULL) : PTRCMP(mp, >=, message + msgCount))) {
1216       if (mb.mb_threaded) {
1217          for (mp = threadroot; mp != NULL; mp = next_in_thread(mp))
1218             if (mp->m_flag & MFLAGGED)
1219                break;
1220       } else {
1221          for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp)
1222             if (mp->m_flag & MFLAGGED)
1223                break;
1224       }
1225    }
1226
1227    if ((mb.mb_threaded ? (mp == NULL) : PTRCMP(mp, >=, message + msgCount))) {
1228       if (mb.mb_threaded) {
1229          for (mp = threadroot; mp != NULL; mp = next_in_thread(mp))
1230             if (!(mp->m_flag & (MREAD | avoid)))
1231                break;
1232       } else {
1233          for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp)
1234             if (!(mp->m_flag & (MREAD | avoid)))
1235                break;
1236       }
1237    }
1238
1239    if ((mb.mb_threaded ? (mp != NULL) : PTRCMP(mp, <, message + msgCount)))
1240       mdot = (int)PTR2SIZE(mp - message + 1);
1241    else if (ok_blook(showlast)) {
1242       if (mb.mb_threaded) {
1243          for (mp = this_in_thread(threadroot, -1); mp;
1244                mp = prev_in_thread(mp))
1245             if (!(mp->m_flag & avoid))
1246                break;
1247          mdot = (mp != NULL) ? (int)PTR2SIZE(mp - message + 1) : msgCount;
1248       } else {
1249          for (mp = message + msgCount - 1; mp >= message; --mp)
1250             if (!(mp->m_flag & avoid))
1251                break;
1252          mdot = (mp >= message) ? (int)PTR2SIZE(mp - message + 1) : msgCount;
1253       }
1254    } else if (mb.mb_threaded) {
1255       for (mp = threadroot; mp; mp = next_in_thread(mp))
1256          if (!(mp->m_flag & avoid))
1257             break;
1258       mdot = (mp != NULL) ? (int)PTR2SIZE(mp - message + 1) : 1;
1259    } else {
1260       for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp)
1261          if (!(mp->m_flag & avoid))
1262             break;
1263       mdot = PTRCMP(mp, <, message + msgCount)
1264             ? (int)PTR2SIZE(mp - message + 1) : 1;
1265    }
1266 jleave:
1267    NYD_LEAVE;
1268    return mdot;
1269 }
1270
1271 FL void
1272 initbox(char const *name)
1273 {
1274    char *tempMesg;
1275    NYD_ENTER;
1276
1277    if (mb.mb_type != MB_VOID)
1278       n_strlcpy(prevfile, mailname, PATH_MAX);
1279
1280    _update_mailname(name != mailname ? name : NULL);
1281
1282    if ((mb.mb_otf = Ftmp(&tempMesg, "tmpbox", OF_WRONLY | OF_HOLDSIGS, 0600)) ==
1283          NULL) {
1284       perror(tr(87, "temporary mail message file"));
1285       exit(1);
1286    }
1287    if ((mb.mb_itf = safe_fopen(tempMesg, "r", NULL)) == NULL) {
1288       perror(tr(87, "temporary mail message file"));
1289       exit(1);
1290    }
1291    Ftmp_release(&tempMesg);
1292
1293    message_reset();
1294    mb.mb_threaded = 0;
1295    if (mb.mb_sorted != NULL) {
1296       free(mb.mb_sorted);
1297       mb.mb_sorted = NULL;
1298    }
1299 #ifdef HAVE_IMAP
1300    mb.mb_flags = MB_NOFLAGS;
1301 #endif
1302    prevdot = NULL;
1303    dot = NULL;
1304    did_print_dot = FAL0;
1305    NYD_LEAVE;
1306 }
1307
1308 #ifdef HAVE_DOCSTRINGS
1309 FL bool_t
1310 print_comm_docstr(char const *comm)
1311 {
1312    bool_t rv = FAL0;
1313    struct cmd_ghost *cg;
1314    struct cmd const *cp;
1315    NYD_ENTER;
1316
1317    /* Ghosts take precedence */
1318    for (cg = _cmd_ghosts; cg != NULL; cg = cg->next)
1319       if (!strcmp(comm, cg->name)) {
1320          printf("%s -> <%s>\n", comm, cg->cmd.s);
1321          rv = TRU1;
1322          goto jleave;
1323       }
1324
1325    for (cp = _cmd_tab; cp->name != NULL; ++cp) {
1326       if (cp->func == &c_cmdnotsupp)
1327          continue;
1328       if (!strcmp(comm, cp->name))
1329          printf("%s: %s\n", comm, tr(cp->docid, cp->doc));
1330       else if (is_prefix(comm, cp->name))
1331          printf("%s (%s): %s\n", comm, cp->name, tr(cp->docid, cp->doc));
1332       else
1333          continue;
1334       rv = TRU1;
1335       break;
1336    }
1337 jleave:
1338    NYD_LEAVE;
1339    return rv;
1340 }
1341 #endif
1342
1343 /* vim:set fenc=utf-8:s-it-mode */