quit.c

   1 /*@ S-nail - a mail user agent derived from Berkeley Mail.
   2  *@ Termination processing.
   3  *
   4  * Copyright (c) 2000-2004 Gunnar Ritter, Freiburg i. Br., Germany.
   5  * Copyright (c) 2012 - 2015 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. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35 #undef n_FILE
  36 #define n_FILE quit
  37
  38 #ifndef HAVE_AMALGAMATION
  39 # include "nail.h"
  40 #endif
  41
  42 #include <utime.h>
  43
  44 enum quitflags {
  45    QUITFLAG_HOLD      = 1<<0,
  46    QUITFLAG_KEEP      = 1<<1,
  47    QUITFLAG_KEEPSAVE  = 1<<2,
  48    QUITFLAG_APPEND    = 1<<3,
  49    QUITFLAG_EMPTYBOX  = 1<<4
  50 };
  51
  52 struct quitnames {
  53    enum quitflags flag;
  54    enum okeys     okey;
  55 };
  56
  57 static struct quitnames const _quitnames[] = {
  58    {QUITFLAG_HOLD, ok_b_hold},
  59    {QUITFLAG_KEEP, ok_b_keep},
  60    {QUITFLAG_KEEPSAVE, ok_b_keepsave},
  61    {QUITFLAG_APPEND, ok_b_append},
  62    {QUITFLAG_EMPTYBOX, ok_b_emptybox} /* TODO obsolete emptybox */
  63 };
  64
  65 static char _mboxname[PATH_MAX];  /* Name of mbox */
  66
  67 /* Touch the indicated file */
  68 static void _alter(char const *name);
  69
  70 /* Preserve all the appropriate messages back in the system mailbox, and print
  71  * a nice message indicated how many were saved.  On any error, just return -1.
  72  * Else return 0.  Incorporate the any new mail that we found */
  73 static int  writeback(FILE *res, FILE *obuf);
  74
  75 /* Terminate an editing session by attempting to write out the user's file from
  76  * the temporary.  Save any new stuff appended to the file */
  77 static bool_t edstop(void);
  78
  79 /* Remove "mailname", unless *keep* says otherwise; force truncation, then */
  80 static void _demail(void);
  81
  82 static void
  83 _alter(char const *name) /* TODO error handling */
  84 {
  85 #ifdef HAVE_UTIMENSAT
  86    struct timespec tsa[2];
  87 #else
  88    struct stat sb;
  89    struct utimbuf utb;
  90 #endif
  91    NYD_ENTER;
  92
  93 #ifdef HAVE_UTIMENSAT
  94    tsa[0].tv_sec = n_time_epoch() + 1;
  95    tsa[0].tv_nsec = 0;
  96    tsa[1].tv_nsec = UTIME_OMIT;
  97    utimensat(AT_FDCWD, name, tsa, 0);
  98 #else
  99    if (!stat(name, &sb)) {
 100       utb.actime = n_time_epoch() + 1;
 101       utb.modtime = sb.st_mtime;
 102       utime(name, &utb);
 103    }
 104 #endif
 105    NYD_LEAVE;
 106 }
 107
 108 static int
 109 writeback(FILE *res, FILE *obuf)
 110 {
 111    struct message *mp;
 112    int rv = -1, p, c;
 113    NYD_ENTER;
 114
 115    if (fseek(obuf, 0L, SEEK_SET) == -1)
 116       goto jleave;
 117
 118 #ifndef APPEND
 119    if (res != NULL)
 120       while ((c = getc(res)) != EOF)
 121          putc(c, obuf);
 122 #endif
 123    srelax_hold();
 124    for (p = 0, mp = message; PTRCMP(mp, <, message + msgCount); ++mp)
 125       if ((mp->m_flag & MPRESERVE) || !(mp->m_flag & MTOUCH)) {
 126          ++p;
 127          if (sendmp(mp, obuf, NULL, NULL, SEND_MBOX, NULL) < 0) {
 128             n_perr(mailname, 0);
 129             srelax_rele();
 130             goto jerror;
 131          }
 132          srelax();
 133       }
 134    srelax_rele();
 135 #ifdef APPEND
 136    if (res != NULL)
 137       while ((c = getc(res)) != EOF)
 138          putc(c, obuf);
 139 #endif
 140    ftrunc(obuf);
 141
 142    if (ferror(obuf)) {
 143       n_perr(mailname, 0);
 144 jerror:
 145       fseek(obuf, 0L, SEEK_SET);
 146       goto jleave;
 147    }
 148    if (fseek(obuf, 0L, SEEK_SET) == -1)
 149       goto jleave;
 150
 151    _alter(mailname);
 152    if (p == 1)
 153       printf(_("Held 1 message in %s\n"), displayname);
 154    else
 155       printf(_("Held %d messages in %s\n"), p, displayname);
 156    rv = 0;
 157 jleave:
 158    if (res != NULL)
 159       Fclose(res);
 160    NYD_LEAVE;
 161    return rv;
 162 }
 163
 164 static bool_t
 165 edstop(void) /* TODO oh my god */
 166 {
 167    int gotcha, c;
 168    struct message *mp;
 169    FILE *obuf = NULL, *ibuf = NULL;
 170    struct stat statb;
 171    bool_t rv;
 172    NYD_ENTER;
 173
 174    rv = TRU1;
 175
 176    if (mb.mb_perm == 0)
 177       goto j_leave;
 178
 179    hold_sigs();
 180
 181    for (mp = message, gotcha = 0; PTRCMP(mp, <, message + msgCount); ++mp) {
 182       if (mp->m_flag & MNEW) {
 183          mp->m_flag &= ~MNEW;
 184          mp->m_flag |= MSTATUS;
 185       }
 186       if (mp->m_flag & (MODIFY | MDELETED | MSTATUS | MFLAG | MUNFLAG |
 187             MANSWER | MUNANSWER | MDRAFT | MUNDRAFT))
 188          ++gotcha;
 189    }
 190    if (!gotcha)
 191       goto jleave;
 192
 193    rv = FAL0;
 194
 195    /* TODO This is too simple minded?  We should regenerate an index file
 196     * TODO to be able to truly tell wether *anything* has changed!
 197     * TODO (Or better: only come here.. then!  It is an *object method!* */
 198    /* TODO Ignoring stat error is easy, huh? */
 199    if (!stat(mailname, &statb) && statb.st_size > mailsize) {
 200       if ((obuf = Ftmp(NULL, "edstop", OF_RDWR | OF_UNLINK | OF_REGISTER)) ==
 201             NULL) {
 202          n_perr(_("tmpfile"), 0);
 203          goto jleave;
 204       }
 205       if ((ibuf = Zopen(mailname, "r")) == NULL) {
 206          n_perr(mailname, 0);
 207          Fclose(obuf);
 208          goto jleave;
 209       }
 210
 211       n_file_lock(fileno(ibuf), FLT_READ, 0,0, 1); /* TODO ign. lock error! */
 212       fseek(ibuf, (long)mailsize, SEEK_SET);
 213       while ((c = getc(ibuf)) != EOF) /* xxx bytewise??? TODO ... I/O error? */
 214          putc(c, obuf);
 215       Fclose(ibuf);
 216       ibuf = obuf;
 217       fflush_rewind(obuf);
 218    }
 219
 220    printf(_("\"%s\" "), displayname);
 221    fflush(stdout);
 222
 223    if ((obuf = Zopen(mailname, "r+")) == NULL) {
 224       n_perr(mailname, 0);
 225       goto jleave;
 226    }
 227
 228    n_file_lock(fileno(obuf), FLT_WRITE, 0,0, 1); /* TODO ignoring lock error! */
 229    ftrunc(obuf);
 230
 231    srelax_hold();
 232    c = 0;
 233    for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp) {
 234       if (mp->m_flag & MDELETED)
 235          continue;
 236       ++c;
 237       if (sendmp(mp, obuf, NULL, NULL, SEND_MBOX, NULL) < 0) {
 238          n_perr(mailname, 0);
 239          srelax_rele();
 240          goto jleave;
 241       }
 242       srelax();
 243    }
 244    srelax_rele();
 245
 246    gotcha = (c == 0 && ibuf == NULL);
 247    if (ibuf != NULL) {
 248       while ((c = getc(ibuf)) != EOF)
 249          putc(c, obuf);
 250    }
 251    fflush(obuf);
 252    if (ferror(obuf)) {
 253       n_perr(mailname, 0);
 254       goto jleave;
 255    }
 256    Fclose(obuf);
 257
 258    if (gotcha && !ok_blook(keep) && !ok_blook(emptybox)/* TODO obsolete eb*/) {
 259       bool_t rms;
 260
 261       if ((rms = n_path_rm(mailname)) == TRU1)
 262          printf((ok_blook(bsdcompat) || ok_blook(bsdmsgs))
 263             ? _("removed\n") : _("removed.\n"));
 264       else {
 265          int e = errno;
 266          printf(_("removal error (ignored)\n"));
 267          n_err(_("Error removing \"%s\" (ignored):"), mailname); /* TODO */
 268          n_perr(NULL, e); /* TODO */
 269       }
 270    } else
 271       printf((ok_blook(bsdcompat) || ok_blook(bsdmsgs))
 272          ? _("complete\n") : _("updated.\n"));
 273    fflush(stdout);
 274
 275    rv = TRU1;
 276 jleave:
 277    if (ibuf != NULL)
 278       Fclose(ibuf);
 279    rele_sigs();
 280
 281    if(!rv){
 282       /* TODO The codebase aborted by jumping to the main loop here.
 283        * TODO The OpenBSD mailx simply ignores this error.
 284        * TODO For now we follow the latter unless we are interactive,
 285        * TODO in which case we ask the user wether the error is to be
 286        * TODO ignored or not.  More of this around here in this file! */
 287       rv = getapproval(_("Continue, possibly loosing changes"), TRU1);
 288    }
 289 j_leave:
 290    NYD_LEAVE;
 291    return rv;
 292 }
 293
 294 static void
 295 _demail(void) /* TODO error handling */
 296 {
 297    NYD2_ENTER;
 298    if (ok_blook(keep) || n_path_rm(mailname) <= FAL0) {
 299       /* TODO demail(): try use f?truncate(2) instead?! */
 300       int fd = open(mailname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
 301       if (fd >= 0)
 302          close(fd);
 303    }
 304    NYD2_LEAVE;
 305 }
 306
 307 FL bool_t
 308 quit(void)
 309 {
 310    int p, modify, anystat, c;
 311    FILE *fbuf = NULL, *lckfp = NULL, *rbuf, *abuf;
 312    struct message *mp;
 313    struct stat minfo;
 314    bool_t rv;
 315    NYD_ENTER;
 316
 317    rv = FAL0;
 318    temporary_localopts_folder_hook_unroll();
 319
 320    /* If we are read only, we can't do anything, so just return quickly */
 321    /* TODO yet we cannot return quickly if resources have to be released!
 322     * TODO somewhen it'll be mailbox->quit() anyway, for now do it by hand
 323     *if (mb.mb_perm == 0)
 324     *   goto jleave;*/
 325    p = (mb.mb_perm == 0);
 326
 327    /* TODO lex.c:setfile() has just called hold_sigs(); before it called
 328     * TODO us, but this causes uninterruptible hangs due to blocked sigs
 329     * TODO anywhere except for MB_FILE (all others install their own
 330     * TODO handlers, as it seems, properly); marked YYY */
 331    switch (mb.mb_type) {
 332    case MB_FILE:
 333       break;
 334    case MB_MAILDIR:
 335       rele_sigs(); /* YYY */
 336       rv = maildir_quit();
 337       hold_sigs(); /* YYY */
 338       goto jleave;
 339 #ifdef HAVE_POP3
 340    case MB_POP3:
 341       rele_sigs(); /* YYY */
 342       rv = pop3_quit();
 343       hold_sigs(); /* YYY */
 344       goto jleave;
 345 #endif
 346    case MB_VOID:
 347    default:
 348       goto jleave;
 349    }
 350    if (p) {
 351       rv = TRU1;
 352       goto jleave; /* TODO */
 353    }
 354
 355    /* If editing (not reading system mail box), then do the work in edstop() */
 356    if (pstate & PS_EDIT) {
 357       rv = edstop();
 358       goto jleave;
 359    }
 360
 361    /* See if there any messages to save in mbox.  If no, we
 362     * can save copying mbox to /tmp and back.
 363     *
 364     * Check also to see if any files need to be preserved.
 365     * Delete all untouched messages to keep them out of mbox.
 366     * If all the messages are to be preserved, just exit with
 367     * a message */
 368    fbuf = Zopen(mailname, "r+");
 369    if (fbuf == NULL) {
 370       if (errno != ENOENT)
 371 jnewmail:
 372          printf(_("Thou hast new mail.\n"));
 373       rv = TRU1;
 374       goto jleave;
 375    }
 376
 377    if ((lckfp = n_dotlock(mailname, fileno(fbuf), FLT_WRITE, 0,0, 1)) == NULL) {
 378       n_perr(_("Unable to (dot) lock mailbox"), 0);
 379       Fclose(fbuf);
 380       fbuf = NULL;
 381       rv = getapproval(_("Continue, possibly loosing changes"), TRU1);
 382       goto jleave;
 383    }
 384
 385    rbuf = NULL;
 386    if (!fstat(fileno(fbuf), &minfo) && minfo.st_size > mailsize) {
 387       printf(_("New mail has arrived.\n"));
 388       rbuf = Ftmp(NULL, "quit", OF_RDWR | OF_UNLINK | OF_REGISTER);
 389       if (rbuf == NULL || fbuf == NULL)
 390          goto jnewmail;
 391 #ifdef APPEND
 392       fseek(fbuf, (long)mailsize, SEEK_SET);
 393       while ((c = getc(fbuf)) != EOF)
 394          putc(c, rbuf);
 395 #else
 396       p = minfo.st_size - mailsize;
 397       while (p-- > 0) {
 398          c = getc(fbuf);
 399          if (c == EOF)
 400             goto jnewmail;
 401          putc(c, rbuf);
 402       }
 403 #endif
 404       fflush_rewind(rbuf);
 405    }
 406
 407    anystat = holdbits();
 408    modify = 0;
 409    for (c = 0, p = 0, mp = message; PTRCMP(mp, <, message + msgCount); ++mp) {
 410       if (mp->m_flag & MBOX)
 411          c++;
 412       if (mp->m_flag & MPRESERVE)
 413          p++;
 414       if (mp->m_flag & MODIFY)
 415          modify++;
 416    }
 417    if (p == msgCount && !modify && !anystat) {
 418       rv = TRU1;
 419       if (p == 1)
 420          printf(_("Held 1 message in %s\n"), displayname);
 421       else if (p > 1)
 422          printf(_("Held %d messages in %s\n"), p, displayname);
 423       goto jleave;
 424    }
 425
 426    if (c == 0) {
 427       if (p != 0) {
 428          if (writeback(rbuf, fbuf) >= 0)
 429             rv = TRU1;
 430          else
 431             rv = getapproval(_("Continue, possibly loosing changes"), TRU1);
 432          goto jleave;
 433       }
 434       goto jcream;
 435    }
 436
 437    if (makembox() == STOP) {
 438       rv = getapproval(_("Continue, possibly loosing changes"), TRU1);
 439       goto jleave;
 440    }
 441
 442    /* Now we are ready to copy back preserved files to the system mailbox, if
 443     * any were requested */
 444    if (p != 0) {
 445       if (writeback(rbuf, fbuf) < 0)
 446          rv = getapproval(_("Continue, possibly loosing changes"), TRU1);
 447       goto jleave;
 448    }
 449
 450    /* Finally, remove his file.  If new mail has arrived, copy it back */
 451 jcream:
 452    if (rbuf != NULL) {
 453       abuf = fbuf;
 454       fseek(abuf, 0L, SEEK_SET);
 455       while ((c = getc(rbuf)) != EOF)
 456          putc(c, abuf);
 457       Fclose(rbuf);
 458       ftrunc(abuf);
 459       _alter(mailname);
 460       rv = TRU1;
 461    } else {
 462       _demail();
 463       rv = TRU1;
 464    }
 465 jleave:
 466    if (fbuf != NULL) {
 467       Fclose(fbuf);
 468       if (lckfp != NULL && lckfp != (FILE*)-1)
 469          Pclose(lckfp, FAL0);
 470    }
 471    NYD_LEAVE;
 472    return rv;
 473 }
 474
 475 FL int
 476 holdbits(void)
 477 {
 478    struct message *mp;
 479    int anystat, autohold, holdbit, nohold;
 480    NYD_ENTER;
 481
 482    anystat = 0;
 483    autohold = ok_blook(hold);
 484    holdbit = autohold ? MPRESERVE : MBOX;
 485    nohold = MBOX | MSAVED | MDELETED | MPRESERVE;
 486    if (ok_blook(keepsave))
 487       nohold &= ~MSAVED;
 488    for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp) {
 489       if (mp->m_flag & MNEW) {
 490          mp->m_flag &= ~MNEW;
 491          mp->m_flag |= MSTATUS;
 492       }
 493       if (mp->m_flag & (MSTATUS | MFLAG | MUNFLAG | MANSWER | MUNANSWER |
 494             MDRAFT | MUNDRAFT))
 495          ++anystat;
 496       if (!(mp->m_flag & MTOUCH))
 497          mp->m_flag |= MPRESERVE;
 498       if (!(mp->m_flag & nohold))
 499          mp->m_flag |= holdbit;
 500    }
 501    NYD_LEAVE;
 502    return anystat;
 503 }
 504
 505 FL enum okay
 506 makembox(void) /* TODO oh my god */
 507 {
 508    struct message *mp;
 509    char *mbox, *tempQuit;
 510    int mcount, c;
 511    FILE *ibuf = NULL, *obuf, *abuf;
 512    enum okay rv = STOP;
 513    NYD_ENTER;
 514
 515    mbox = _mboxname;
 516    mcount = 0;
 517    if (!ok_blook(append)) {
 518       if ((obuf = Ftmp(&tempQuit, "makembox",
 519             OF_WRONLY | OF_HOLDSIGS | OF_REGISTER)) == NULL) {
 520          n_perr(_("temporary mail quit file"), 0);
 521          goto jleave;
 522       }
 523       if ((ibuf = Fopen(tempQuit, "r")) == NULL)
 524          n_perr(tempQuit, 0);
 525       Ftmp_release(&tempQuit);
 526       if (ibuf == NULL) {
 527          Fclose(obuf);
 528          goto jleave;
 529       }
 530
 531       if ((abuf = Zopen(mbox, "r")) != NULL) {
 532          while ((c = getc(abuf)) != EOF)
 533             putc(c, obuf);
 534          Fclose(abuf);
 535       }
 536       if (ferror(obuf)) {
 537          n_perr(_("temporary mail quit file"), 0);
 538          Fclose(ibuf);
 539          Fclose(obuf);
 540          goto jleave;
 541       }
 542       Fclose(obuf);
 543
 544       if ((c = open(mbox, O_CREAT | O_TRUNC | O_WRONLY, 0666)) != -1)
 545          close(c);
 546       if ((obuf = Zopen(mbox, "r+")) == NULL) {
 547          n_perr(mbox, 0);
 548          Fclose(ibuf);
 549          goto jleave;
 550       }
 551    } else {
 552       if ((obuf = Zopen(mbox, "a")) == NULL) {
 553          n_perr(mbox, 0);
 554          goto jleave;
 555       }
 556    }
 557
 558    srelax_hold();
 559    for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp) {
 560       if (mp->m_flag & MBOX) {
 561          ++mcount;
 562          if (sendmp(mp, obuf, saveignore, NULL, SEND_MBOX, NULL) < 0) {
 563             n_perr(mbox, 0);
 564             srelax_rele();
 565             if (ibuf != NULL)
 566                Fclose(ibuf);
 567             Fclose(obuf);
 568             goto jleave;
 569          }
 570          mp->m_flag |= MBOXED;
 571          srelax();
 572       }
 573    }
 574    srelax_rele();
 575
 576    /* Copy the user's old mbox contents back to the end of the stuff we just
 577     * saved.  If we are appending, this is unnecessary */
 578    if (!ok_blook(append)) {
 579       rewind(ibuf);
 580       c = getc(ibuf);
 581       while (c != EOF) {
 582          putc(c, obuf);
 583          if (ferror(obuf))
 584             break;
 585          c = getc(ibuf);
 586       }
 587       Fclose(ibuf);
 588       fflush(obuf);
 589    }
 590    ftrunc(obuf);
 591    if (ferror(obuf)) {
 592       n_perr(mbox, 0);
 593       Fclose(obuf);
 594       goto jleave;
 595    }
 596    if (Fclose(obuf) != 0) {
 597       n_perr(mbox, 0);
 598       goto jleave;
 599    }
 600    if (mcount == 1)
 601       printf(_("Saved 1 message in mbox\n"));
 602    else
 603       printf(_("Saved %d messages in mbox\n"), mcount);
 604    rv = OKAY;
 605 jleave:
 606    NYD_LEAVE;
 607    return rv;
 608 }
 609
 610 FL void
 611 save_mbox_for_possible_quitstuff(void) /* TODO try to get rid of that */
 612 {
 613    char const *cp;
 614    NYD_ENTER;
 615
 616    if ((cp = expand("&")) == NULL)
 617       cp = "";
 618    n_strscpy(_mboxname, cp, sizeof _mboxname);
 619    NYD_LEAVE;
 620 }
 621
 622 FL int
 623 savequitflags(void)
 624 {
 625    enum quitflags qf = 0;
 626    size_t i;
 627    NYD_ENTER;
 628
 629    for (i = 0; i < NELEM(_quitnames); ++i)
 630       if (n_var_oklook(_quitnames[i].okey) != NULL)
 631          qf |= _quitnames[i].flag;
 632    NYD_LEAVE;
 633    return qf;
 634 }
 635
 636 FL void
 637 restorequitflags(int qf)
 638 {
 639    size_t i;
 640    NYD_ENTER;
 641
 642    for (i = 0;  i < NELEM(_quitnames); ++i) {
 643       char *x = n_var_oklook(_quitnames[i].okey);
 644       if (qf & _quitnames[i].flag) {
 645          if (x == NULL)
 646             n_var_okset(_quitnames[i].okey, TRU1);
 647       } else if (x != NULL)
 648          n_var_okclear(_quitnames[i].okey);
 649    }
 650    NYD_LEAVE;
 651 }
 652
 653 /* s-it-mode */