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 void 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)
  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 void
 165 edstop(void) /* TODO oh my god - and REMOVE that CRAPPY reset(0) jump!! */
 166 {
 167    int gotcha, c;
 168    struct message *mp;
 169    FILE *obuf = NULL, *ibuf = NULL;
 170    struct stat statb;
 171    bool_t doreset;
 172    NYD_ENTER;
 173
 174    hold_sigs();
 175    doreset = FAL0;
 176
 177    if (mb.mb_perm == 0)
 178       goto jleave;
 179
 180    for (mp = message, gotcha = 0; PTRCMP(mp, <, message + msgCount); ++mp) {
 181       if (mp->m_flag & MNEW) {
 182          mp->m_flag &= ~MNEW;
 183          mp->m_flag |= MSTATUS;
 184       }
 185       if (mp->m_flag & (MODIFY | MDELETED | MSTATUS | MFLAG | MUNFLAG |
 186             MANSWER | MUNANSWER | MDRAFT | MUNDRAFT))
 187          ++gotcha;
 188    }
 189    if (!gotcha)
 190       goto jleave;
 191
 192    doreset = TRU1;
 193
 194    /* TODO This is too simple minded?  We should regenerate an index file
 195     * TODO to be able to truly tell wether *anything* has changed!
 196     * TODO (Or better: only come here.. then!  It is an *object method!* */
 197    /* TODO Ignoring stat error is easy, huh? */
 198    if (!stat(mailname, &statb) && statb.st_size > mailsize) {
 199       if ((obuf = Ftmp(NULL, "edstop", OF_RDWR | OF_UNLINK | OF_REGISTER)) ==
 200             NULL) {
 201          n_perr(_("tmpfile"), 0);
 202          goto jleave;
 203       }
 204       if ((ibuf = Zopen(mailname, "r")) == NULL) {
 205          n_perr(mailname, 0);
 206          Fclose(obuf);
 207          goto jleave;
 208       }
 209
 210       file_lock(fileno(ibuf), FLT_READ, 0,0, 1); /* TODO ignoring lock error! */
 211       fseek(ibuf, (long)mailsize, SEEK_SET);
 212       while ((c = getc(ibuf)) != EOF) /* xxx bytewise??? TODO ... I/O error? */
 213          putc(c, obuf);
 214       Fclose(ibuf);
 215       ibuf = obuf;
 216       fflush_rewind(obuf);
 217    }
 218
 219    printf(_("\"%s\" "), displayname);
 220    fflush(stdout);
 221    if ((obuf = Zopen(mailname, "r+")) == NULL) {
 222       n_perr(mailname, 0);
 223       goto jleave;
 224    }
 225
 226    file_lock(fileno(obuf), FLT_WRITE, 0,0, 1); /* TODO ignoring lock error! */
 227    ftrunc(obuf);
 228
 229    srelax_hold();
 230    c = 0;
 231    for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp) {
 232       if (mp->m_flag & MDELETED)
 233          continue;
 234       ++c;
 235       if (sendmp(mp, obuf, NULL, NULL, SEND_MBOX, NULL) < 0) {
 236          n_perr(mailname, 0);
 237          srelax_rele();
 238          goto jleave;
 239       }
 240       srelax();
 241    }
 242    srelax_rele();
 243
 244    gotcha = (c == 0 && ibuf == NULL);
 245    if (ibuf != NULL) {
 246       while ((c = getc(ibuf)) != EOF)
 247          putc(c, obuf);
 248    }
 249    fflush(obuf);
 250    if (ferror(obuf)) {
 251       n_perr(mailname, 0);
 252       goto jleave;
 253    }
 254    Fclose(obuf);
 255
 256    doreset = FAL0;
 257
 258    if (gotcha && !ok_blook(keep) && !ok_blook(emptybox)/* TODO obsolete eb*/) {
 259       rm(mailname);
 260       printf((ok_blook(bsdcompat) || ok_blook(bsdmsgs))
 261          ? _("removed\n") : _("removed.\n"));
 262    } else
 263       printf((ok_blook(bsdcompat) || ok_blook(bsdmsgs))
 264          ? _("complete\n") : _("updated.\n"));
 265    fflush(stdout);
 266 jleave:
 267    if (ibuf != NULL)
 268       Fclose(ibuf);
 269    rele_sigs();
 270    NYD_LEAVE;
 271    if (doreset)
 272       reset(0);
 273 }
 274
 275 static void
 276 _demail(void)
 277 {
 278    NYD2_ENTER;
 279    if (ok_blook(keep) || rm(mailname) < 0) {
 280       /* TODO demail(): try use f?truncate(2) instead?! */
 281       int fd = open(mailname, O_WRONLY | O_CREAT | O_TRUNC, 0600);
 282       if (fd >= 0)
 283          close(fd);
 284    }
 285    NYD2_LEAVE;
 286 }
 287
 288 FL void
 289 quit(void)
 290 {
 291    int p, modify, anystat, c;
 292    FILE *fbuf = NULL, *lckfp = NULL, *rbuf, *abuf;
 293    struct message *mp;
 294    struct stat minfo;
 295    NYD_ENTER;
 296
 297    temporary_localopts_folder_hook_unroll();
 298
 299    /* If we are read only, we can't do anything, so just return quickly */
 300    /* TODO yet we cannot return quickly if resources have to be released!
 301     * TODO somewhen it'll be mailbox->quit() anyway, for now do it by hand
 302     *if (mb.mb_perm == 0)
 303     *   goto jleave;*/
 304    p = (mb.mb_perm == 0);
 305
 306    /* TODO lex.c:setfile() has just called hold_sigs(); before it called
 307     * TODO us, but this causes uninterruptible hangs due to blocked sigs
 308     * TODO anywhere except for MB_FILE (all others install their own
 309     * TODO handlers, as it seems, properly); marked YYY */
 310    switch (mb.mb_type) {
 311    case MB_FILE:
 312       break;
 313    case MB_MAILDIR:
 314       rele_sigs(); /* YYY */
 315       maildir_quit();
 316       hold_sigs(); /* YYY */
 317       goto jleave;
 318 #ifdef HAVE_POP3
 319    case MB_POP3:
 320       rele_sigs(); /* YYY */
 321       pop3_quit();
 322       hold_sigs(); /* YYY */
 323       goto jleave;
 324 #endif
 325    case MB_VOID:
 326    default:
 327       goto jleave;
 328    }
 329    if (p) goto jleave; /* TODO */
 330
 331    /* If editing (not reading system mail box), then do the work in edstop() */
 332    if (pstate & PS_EDIT) {
 333       edstop();
 334       goto jleave;
 335    }
 336
 337    /* See if there any messages to save in mbox.  If no, we
 338     * can save copying mbox to /tmp and back.
 339     *
 340     * Check also to see if any files need to be preserved.
 341     * Delete all untouched messages to keep them out of mbox.
 342     * If all the messages are to be preserved, just exit with
 343     * a message */
 344    fbuf = Zopen(mailname, "r+");
 345    if (fbuf == NULL) {
 346       if (errno == ENOENT)
 347          goto jleave;
 348 jnewmail:
 349       printf(_("Thou hast new mail.\n"));
 350       goto jleave;
 351    }
 352
 353    if ((lckfp = dot_lock(mailname, fileno(fbuf), FLT_WRITE, 0,0, 1)) == NULL) {
 354       n_perr(_("Unable to (dot) lock mailbox, aborting operation"), 0);
 355       Fclose(fbuf);
 356       fbuf = NULL;
 357       goto jleave;
 358    }
 359
 360    rbuf = NULL;
 361    if (!fstat(fileno(fbuf), &minfo) && minfo.st_size > mailsize) {
 362       printf(_("New mail has arrived.\n"));
 363       rbuf = Ftmp(NULL, "quit", OF_RDWR | OF_UNLINK | OF_REGISTER);
 364       if (rbuf == NULL || fbuf == NULL)
 365          goto jnewmail;
 366 #ifdef APPEND
 367       fseek(fbuf, (long)mailsize, SEEK_SET);
 368       while ((c = getc(fbuf)) != EOF)
 369          putc(c, rbuf);
 370 #else
 371       p = minfo.st_size - mailsize;
 372       while (p-- > 0) {
 373          c = getc(fbuf);
 374          if (c == EOF)
 375             goto jnewmail;
 376          putc(c, rbuf);
 377       }
 378 #endif
 379       fflush_rewind(rbuf);
 380    }
 381
 382    anystat = holdbits();
 383    modify = 0;
 384    for (c = 0, p = 0, mp = message; PTRCMP(mp, <, message + msgCount); ++mp) {
 385       if (mp->m_flag & MBOX)
 386          c++;
 387       if (mp->m_flag & MPRESERVE)
 388          p++;
 389       if (mp->m_flag & MODIFY)
 390          modify++;
 391    }
 392    if (p == msgCount && !modify && !anystat) {
 393       if (p == 1)
 394          printf(_("Held 1 message in %s\n"), displayname);
 395       else if (p > 1)
 396          printf(_("Held %d messages in %s\n"), p, displayname);
 397       goto jleave;
 398    }
 399    if (c == 0) {
 400       if (p != 0) {
 401          writeback(rbuf, fbuf);
 402          goto jleave;
 403       }
 404       goto jcream;
 405    }
 406
 407    if (makembox() == STOP)
 408       goto jleave;
 409
 410    /* Now we are ready to copy back preserved files to the system mailbox, if
 411     * any were requested */
 412    if (p != 0) {
 413       writeback(rbuf, fbuf);
 414       goto jleave;
 415    }
 416
 417    /* Finally, remove his file.  If new mail has arrived, copy it back */
 418 jcream:
 419    if (rbuf != NULL) {
 420       abuf = fbuf;
 421       fseek(abuf, 0L, SEEK_SET);
 422       while ((c = getc(rbuf)) != EOF)
 423          putc(c, abuf);
 424       Fclose(rbuf);
 425       ftrunc(abuf);
 426       _alter(mailname);
 427       goto jleave;
 428    }
 429    _demail();
 430 jleave:
 431    if (fbuf != NULL) {
 432       Fclose(fbuf);
 433       if (lckfp != NULL && lckfp != (FILE*)-1)
 434          Pclose(lckfp, FAL0);
 435    }
 436    NYD_LEAVE;
 437 }
 438
 439 FL int
 440 holdbits(void)
 441 {
 442    struct message *mp;
 443    int anystat, autohold, holdbit, nohold;
 444    NYD_ENTER;
 445
 446    anystat = 0;
 447    autohold = ok_blook(hold);
 448    holdbit = autohold ? MPRESERVE : MBOX;
 449    nohold = MBOX | MSAVED | MDELETED | MPRESERVE;
 450    if (ok_blook(keepsave))
 451       nohold &= ~MSAVED;
 452    for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp) {
 453       if (mp->m_flag & MNEW) {
 454          mp->m_flag &= ~MNEW;
 455          mp->m_flag |= MSTATUS;
 456       }
 457       if (mp->m_flag & (MSTATUS | MFLAG | MUNFLAG | MANSWER | MUNANSWER |
 458             MDRAFT | MUNDRAFT))
 459          ++anystat;
 460       if (!(mp->m_flag & MTOUCH))
 461          mp->m_flag |= MPRESERVE;
 462       if (!(mp->m_flag & nohold))
 463          mp->m_flag |= holdbit;
 464    }
 465    NYD_LEAVE;
 466    return anystat;
 467 }
 468
 469 FL enum okay
 470 makembox(void) /* TODO oh my god */
 471 {
 472    struct message *mp;
 473    char *mbox, *tempQuit;
 474    int mcount, c;
 475    FILE *ibuf = NULL, *obuf, *abuf;
 476    enum okay rv = STOP;
 477    NYD_ENTER;
 478
 479    mbox = _mboxname;
 480    mcount = 0;
 481    if (!ok_blook(append)) {
 482       if ((obuf = Ftmp(&tempQuit, "makembox",
 483             OF_WRONLY | OF_HOLDSIGS | OF_REGISTER)) == NULL) {
 484          n_perr(_("temporary mail quit file"), 0);
 485          goto jleave;
 486       }
 487       if ((ibuf = Fopen(tempQuit, "r")) == NULL)
 488          n_perr(tempQuit, 0);
 489       Ftmp_release(&tempQuit);
 490       if (ibuf == NULL) {
 491          Fclose(obuf);
 492          goto jleave;
 493       }
 494
 495       if ((abuf = Zopen(mbox, "r")) != NULL) {
 496          while ((c = getc(abuf)) != EOF)
 497             putc(c, obuf);
 498          Fclose(abuf);
 499       }
 500       if (ferror(obuf)) {
 501          n_perr(_("temporary mail quit file"), 0);
 502          Fclose(ibuf);
 503          Fclose(obuf);
 504          goto jleave;
 505       }
 506       Fclose(obuf);
 507
 508       if ((c = open(mbox, O_CREAT | O_TRUNC | O_WRONLY, 0600)) != -1)
 509          close(c);
 510       if ((obuf = Zopen(mbox, "r+")) == NULL) {
 511          n_perr(mbox, 0);
 512          Fclose(ibuf);
 513          goto jleave;
 514       }
 515    } else {
 516       if ((obuf = Zopen(mbox, "a")) == NULL) {
 517          n_perr(mbox, 0);
 518          goto jleave;
 519       }
 520       fchmod(fileno(obuf), 0600);
 521    }
 522
 523    srelax_hold();
 524    for (mp = message; PTRCMP(mp, <, message + msgCount); ++mp) {
 525       if (mp->m_flag & MBOX) {
 526          ++mcount;
 527          if (sendmp(mp, obuf, saveignore, NULL, SEND_MBOX, NULL) < 0) {
 528             n_perr(mbox, 0);
 529             srelax_rele();
 530             if (ibuf != NULL)
 531                Fclose(ibuf);
 532             Fclose(obuf);
 533             goto jleave;
 534          }
 535          mp->m_flag |= MBOXED;
 536          srelax();
 537       }
 538    }
 539    srelax_rele();
 540
 541    /* Copy the user's old mbox contents back to the end of the stuff we just
 542     * saved.  If we are appending, this is unnecessary */
 543    if (!ok_blook(append)) {
 544       rewind(ibuf);
 545       c = getc(ibuf);
 546       while (c != EOF) {
 547          putc(c, obuf);
 548          if (ferror(obuf))
 549             break;
 550          c = getc(ibuf);
 551       }
 552       Fclose(ibuf);
 553       fflush(obuf);
 554    }
 555    ftrunc(obuf);
 556    if (ferror(obuf)) {
 557       n_perr(mbox, 0);
 558       Fclose(obuf);
 559       goto jleave;
 560    }
 561    if (Fclose(obuf) != 0) {
 562       n_perr(mbox, 0);
 563       goto jleave;
 564    }
 565    if (mcount == 1)
 566       printf(_("Saved 1 message in mbox\n"));
 567    else
 568       printf(_("Saved %d messages in mbox\n"), mcount);
 569    rv = OKAY;
 570 jleave:
 571    NYD_LEAVE;
 572    return rv;
 573 }
 574
 575 FL void
 576 save_mbox_for_possible_quitstuff(void) /* TODO try to get rid of that */
 577 {
 578    char const *cp;
 579    NYD_ENTER;
 580
 581    if ((cp = expand("&")) == NULL)
 582       cp = "";
 583    n_strscpy(_mboxname, cp, sizeof _mboxname);
 584    NYD_LEAVE;
 585 }
 586
 587 FL int
 588 savequitflags(void)
 589 {
 590    enum quitflags qf = 0;
 591    size_t i;
 592    NYD_ENTER;
 593
 594    for (i = 0; i < NELEM(_quitnames); ++i)
 595       if (_var_oklook(_quitnames[i].okey) != NULL)
 596          qf |= _quitnames[i].flag;
 597    NYD_LEAVE;
 598    return qf;
 599 }
 600
 601 FL void
 602 restorequitflags(int qf)
 603 {
 604    size_t i;
 605    NYD_ENTER;
 606
 607    for (i = 0;  i < NELEM(_quitnames); ++i) {
 608       char *x = _var_oklook(_quitnames[i].okey);
 609       if (qf & _quitnames[i].flag) {
 610          if (x == NULL)
 611             _var_okset(_quitnames[i].okey, TRU1);
 612       } else if (x != NULL)
 613          _var_okclear(_quitnames[i].okey);
 614    }
 615    NYD_LEAVE;
 616 }
 617
 618 /* s-it-mode */