buffy.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
   4  *
   5  * Parts were written/modified by:
   6  * Rocco Rutte <pdmef@cs.tu-berlin.de>
   7  *
   8  * This file is part of mutt-ng, see http://www.muttng.org/.
   9  * It's licensed under the GNU General Public License,
  10  * please see the file GPL in the top level source directory.
  11  */
  12
  13 #if HAVE_CONFIG_H
  14 # include "config.h"
  15 #endif
  16
  17 #include "mutt.h"
  18 #include "buffy.h"
  19 #include "mx.h"
  20 #include "mh.h"
  21 #include "sidebar.h"
  22
  23 #include "mutt_curses.h"
  24
  25 #ifdef USE_IMAP
  26 #include "imap.h"
  27 #endif
  28
  29 #include "lib/mem.h"
  30 #include "lib/intl.h"
  31
  32 #include <string.h>
  33 #include <sys/stat.h>
  34 #include <dirent.h>
  35 #include <utime.h>
  36 #include <ctype.h>
  37 #include <unistd.h>
  38
  39 #include <stdio.h>
  40
  41 static time_t BuffyTime = 0;    /* last time we started checking for mail */
  42
  43 #ifdef USE_IMAP
  44 static time_t ImapBuffyTime = 0;        /* last time we started checking for mail */
  45 #endif
  46 static short BuffyCount = 0;    /* how many boxes with new mail */
  47 static short BuffyNotify = 0;   /* # of unnotified new boxes */
  48
  49 #ifdef BUFFY_SIZE
  50
  51 /* Find the last message in the file.
  52  * upon success return 0. If no message found - return -1 */
  53
  54 static int fseek_last_message (FILE * f)
  55 {
  56   long int pos;
  57   char buffer[BUFSIZ + 9];      /* 7 for "\n\nFrom " */
  58   int bytes_read;
  59   int i;                        /* Index into `buffer' for scanning.  */
  60
  61   memset (buffer, 0, sizeof (buffer));
  62   fseek (f, 0, SEEK_END);
  63   pos = ftell (f);
  64
  65   /* Set `bytes_read' to the size of the last, probably partial, buffer; 0 <
  66    * `bytes_read' <= `BUFSIZ'.  */
  67   bytes_read = pos % BUFSIZ;
  68   if (bytes_read == 0)
  69     bytes_read = BUFSIZ;
  70   /* Make `pos' a multiple of `BUFSIZ' (0 if the file is short), so that all
  71    * reads will be on block boundaries, which might increase efficiency.  */
  72   while ((pos -= bytes_read) >= 0) {
  73     /* we save in the buffer at the end the first 7 chars from the last read */
  74     strncpy (buffer + BUFSIZ, buffer, 5 + 2);   /* 2 == 2 * safe_strlen(CRLF) */
  75     fseek (f, pos, SEEK_SET);
  76     bytes_read = fread (buffer, sizeof (char), bytes_read, f);
  77     if (bytes_read == -1)
  78       return -1;
  79     for (i = bytes_read; --i >= 0;)
  80       if (!safe_strncmp (buffer + i, "\n\nFrom ", safe_strlen ("\n\nFrom "))) { /* found it - go to the beginning of the From */
  81         fseek (f, pos + i + 2, SEEK_SET);
  82         return 0;
  83       }
  84     bytes_read = BUFSIZ;
  85   }
  86
  87   /* here we are at the beginning of the file */
  88   if (!safe_strncmp ("From ", buffer, 5)) {
  89     fseek (f, 0, 0);
  90     return (0);
  91   }
  92
  93   return (-1);
  94 }
  95
  96 /* Return 1 if the last message is new */
  97 static int test_last_status_new (FILE * f)
  98 {
  99   HEADER *hdr;
 100   ENVELOPE *tmp_envelope;
 101   int result = 0;
 102
 103   if (fseek_last_message (f) == -1)
 104     return (0);
 105
 106   hdr = mutt_new_header ();
 107   tmp_envelope = mutt_read_rfc822_header (f, hdr, 0, 0);
 108   if (!(hdr->read || hdr->old))
 109     result = 1;
 110
 111   mutt_free_envelope (&tmp_envelope);
 112   mutt_free_header (&hdr);
 113
 114   return result;
 115 }
 116
 117 static int test_new_folder (const char *path)
 118 {
 119   FILE *f;
 120   int rc = 0;
 121   int typ;
 122
 123   typ = mx_get_magic (path);
 124
 125   if (typ != M_MBOX && typ != M_MMDF)
 126     return 0;
 127
 128   if ((f = fopen (path, "rb"))) {
 129     rc = test_last_status_new (f);
 130     fclose (f);
 131   }
 132
 133   return rc;
 134 }
 135
 136 BUFFY *buffy_find_mailbox (const char *path)
 137 {
 138   struct stat sb;
 139   struct stat tmp_sb;
 140   int i = 0;
 141
 142   if (stat (path, &sb) != 0)
 143     return NULL;
 144
 145   if (!list_empty(Incoming)) {
 146     for (i = 0; i < Incoming->length; i++) {
 147       if (stat (Incoming->data[i], &tmp_sb) == 0 &&
 148           sb.st_dev == tmp_sb.st_dev && sb.st_ino == tmp_sb.st_ino)
 149         return ((BUFFY*) Incoming->data[i]);
 150     }
 151   }
 152   return (NULL);
 153 }
 154
 155 void buffy_update_mailbox (BUFFY * b)
 156 {
 157   struct stat sb;
 158
 159   if (!b)
 160     return;
 161
 162   if (stat (b->path, &sb) == 0)
 163     b->size = (long) sb.st_size;
 164   else
 165     b->size = 0;
 166   return;
 167 }
 168 #endif
 169
 170 /* func to free buffy for list_del() */
 171 static void buffy_free (void** p) {
 172   FREE(&(*((BUFFY**) p))->path);
 173   FREE(p);
 174 }
 175
 176 int buffy_lookup (const char* path) {
 177   int i = 0;
 178   if (list_empty(Incoming) || !path || !*path)
 179     return (-1);
 180   for (i = 0; i < Incoming->length; i++) {
 181     if (safe_strcmp (((BUFFY*) Incoming->data[i])->path, path) == 0)
 182       return (i);
 183   }
 184   return (-1);
 185 }
 186
 187 int buffy_parse_mailboxes (BUFFER * path, BUFFER * s, unsigned long data,
 188                           BUFFER * err)
 189 {
 190   BUFFY* tmp;
 191   char buf[_POSIX_PATH_MAX];
 192   int i = 0;
 193 #ifdef BUFFY_SIZE
 194   struct stat sb;
 195 #endif /* BUFFY_SIZE */
 196
 197   while (MoreArgs (s)) {
 198     mutt_extract_token (path, s, 0);
 199     strfcpy (buf, path->data, sizeof (buf));
 200
 201     if (data == M_UNMAILBOXES && safe_strcmp (buf, "*") == 0) {
 202       list_del (&Incoming, buffy_free);
 203       return 0;
 204     }
 205
 206     /* Skip empty tokens. */
 207     if (!*buf)
 208       continue;
 209
 210     mutt_expand_path (buf, sizeof (buf));
 211     i = buffy_lookup (buf);
 212
 213     if (data == M_UNMAILBOXES) {
 214       if (i >= 0) {
 215         tmp = (BUFFY*) list_pop_idx (Incoming, i);
 216         buffy_free (&tmp);
 217       }
 218       continue;
 219     }
 220
 221     if (i < 0) {
 222       tmp = safe_calloc (1, sizeof (BUFFY));
 223       tmp->path = safe_strdup (buf);
 224       tmp->magic = 0;
 225       list_push_back (&Incoming, tmp);
 226       i = Incoming->length-1;
 227     } else
 228       tmp = (BUFFY*) Incoming->data[i];
 229
 230     tmp->new = 0;
 231     tmp->notified = 1;
 232     tmp->newly_created = 0;
 233
 234 #ifdef BUFFY_SIZE
 235     /* for buffy_size, it is important that if the folder is new (tested by
 236      * reading it), the size is set to 0 so that later when we check we see
 237      * that it increased .  without buffy_size we probably don't care.
 238      */
 239     if (stat (tmp->path, &sb) == 0 && !test_new_folder (tmp->path)) {
 240       /* some systems out there don't have an off_t type */
 241       tmp->size = (long) sb.st_size;
 242     }
 243     else
 244       tmp->size = 0;
 245 #endif /* BUFFY_SIZE */
 246   }
 247   return 0;
 248 }
 249
 250 #ifdef BUFFY_SIZE
 251 /* people use buffy_size on systems where modified time attributes are BADLY
 252  * broken. Ignore them.
 253  */
 254 #define STAT_CHECK (sb.st_size > tmp->size)
 255 #else
 256 #define STAT_CHECK (sb.st_mtime > sb.st_atime || (tmp->newly_created && sb.st_ctime == sb.st_mtime && sb.st_ctime == sb.st_atime))
 257 #endif /* BUFFY_SIZE */
 258
 259 /* values for force:
 260  * 0    don't force any checks + update sidebar
 261  * 1    force all checks + update sidebar
 262  * 2    force all checks + _don't_ update sidebar
 263  */
 264 int buffy_check (int force)
 265 {
 266   BUFFY *tmp;
 267   struct stat sb;
 268   struct dirent *de;
 269   DIR *dirp;
 270   char path[_POSIX_PATH_MAX];
 271   struct stat contex_sb;
 272   time_t now, last1;
 273   CONTEXT *ctx;
 274   int i = 0, local = 0, count = 0;
 275 #ifdef USE_IMAP
 276   time_t last2;
 277
 278   /* update postponed count as well, on force */
 279   if (force != 0)
 280     mutt_update_num_postponed ();
 281 #endif
 282
 283   /* fastest return if there are no mailboxes */
 284   if (list_empty(Incoming))
 285     return 0;
 286   now = time (NULL);
 287   if (force == 0 && (now - BuffyTime < BuffyTimeout)
 288 #ifdef USE_IMAP
 289       && (now - ImapBuffyTime < ImapBuffyTimeout))
 290 #else
 291     )
 292 #endif
 293     return BuffyCount;
 294
 295   last1 = BuffyTime;
 296   if (force != 0 || now - BuffyTime >= BuffyTimeout)
 297     BuffyTime = now;
 298 #ifdef USE_IMAP
 299   last2 = ImapBuffyTime;
 300   if (force != 0 || now - ImapBuffyTime >= ImapBuffyTimeout)
 301     ImapBuffyTime = now;
 302 #endif
 303   BuffyCount = 0;
 304   BuffyNotify = 0;
 305
 306   count = sidebar_need_count ();
 307
 308   if (!Context || !Context->path ||
 309       (mx_is_local (Context->magic-1) && stat (Context->path, &contex_sb) != 0)) {
 310     /* check device ID and serial number instead of comparing paths */
 311     contex_sb.st_dev = 0;
 312     contex_sb.st_ino = 0;
 313   }
 314
 315   for (i = 0; i < Incoming->length; i++) {
 316     tmp = (BUFFY*) Incoming->data[i];
 317     tmp->magic = mx_get_magic (tmp->path);
 318     local = mx_is_local (tmp->magic-1);
 319     if ((tmp->magic <= 0 || local) && (stat (tmp->path, &sb) != 0 || sb.st_size == 0)) {
 320       /* if the mailbox still doesn't exist, set the newly created flag to
 321        * be ready for when it does. */
 322       tmp->newly_created = 1;
 323       tmp->magic = -1;
 324 #ifdef BUFFY_SIZE
 325       tmp->size = 0;
 326 #endif
 327       continue;
 328     }
 329
 330     /* check to see if the folder is the currently selected folder
 331      * before polling */
 332     if (!Context || !Context->path || (local ? (sb.st_dev != contex_sb.st_dev ||
 333                                                 sb.st_ino != contex_sb.st_ino) :
 334                                        safe_strcmp (tmp->path, Context->path))) {
 335       switch (tmp->magic) {
 336       case M_MBOX:
 337       case M_MMDF:
 338         /* only check on force or $mail_check reached */
 339         if (force != 0 || (now - last1 >= BuffyTimeout)) {
 340           if (!count) {
 341             if (STAT_CHECK) {
 342               BuffyCount++;
 343               tmp->new = 1;
 344             }
 345 #ifdef BUFFY_SIZE
 346             else {
 347               /* some other program has deleted mail from the folder */
 348               tmp->size = (long) sb.st_size;
 349             }
 350 #endif
 351           }
 352           else if (STAT_CHECK || tmp->msgcount == 0) {
 353             /* sidebar visible */
 354             BuffyCount++;
 355             if ((ctx =
 356                  mx_open_mailbox (tmp->path, M_READONLY | M_QUIET | M_NOSORT | M_COUNT,
 357                                   NULL)) != NULL) {
 358               tmp->msgcount = ctx->msgcount;
 359               tmp->new = ctx->new;
 360               tmp->msg_unread = ctx->new;       /* for sidebar, wtf? */
 361               tmp->msg_flagged = ctx->flagged;
 362               mx_close_mailbox (ctx, 0);
 363             }
 364           }
 365           if (tmp->newly_created &&
 366               (sb.st_ctime != sb.st_mtime || sb.st_ctime != sb.st_atime))
 367             tmp->newly_created = 0;
 368         }
 369         else if (tmp->new > 0)
 370           BuffyCount++;
 371         break;
 372
 373       case M_MAILDIR:
 374         /* only check on force or $mail_check reached */
 375         if (force != 0 || (now - last1 >= BuffyTimeout)) {
 376           snprintf (path, sizeof (path), "%s/new", tmp->path);
 377           if ((dirp = opendir (path)) == NULL) {
 378             tmp->magic = 0;
 379             break;
 380           }
 381           tmp->new = 0;
 382           tmp->msg_unread = 0;
 383           tmp->msgcount = 0;
 384           while ((de = readdir (dirp)) != NULL) {
 385             char *p;
 386
 387             if (*de->d_name != '.' &&
 388                 (!(p = strstr (de->d_name, ":2,")) || !strchr (p + 3, 'T'))) {
 389               /* one new and undeleted message is enough */
 390               if (tmp->new == 0) {
 391                 BuffyCount++;
 392                 tmp->new = 1;
 393                 if (!count)
 394                   /* if sidebar invisible -> done */
 395                   break;
 396               }
 397               tmp->msgcount++;
 398               tmp->msg_unread++;
 399               tmp->new++;
 400             }
 401           }
 402           closedir (dirp);
 403
 404           if (count) {
 405             /* only count total mail if sidebar visible */
 406             snprintf (path, sizeof (path), "%s/cur", tmp->path);
 407             if ((dirp = opendir (path)) == NULL) {
 408               tmp->magic = 0;
 409               break;
 410             }
 411             tmp->msg_flagged = 0;
 412             while ((de = readdir (dirp)) != NULL) {
 413               char *p;
 414
 415               if (*de->d_name != '.'
 416                   && (p = strstr (de->d_name, ":2,")) != NULL) {
 417                 if (!strchr (p + 3, 'T'))
 418                   tmp->msgcount++;
 419                 if (strchr (p + 3, 'F'))
 420                   tmp->msg_flagged++;
 421               }
 422             }
 423             closedir (dirp);
 424           }
 425         }
 426         else if (tmp->new > 0)
 427           /* keep current stats if !force and !$mail_check reached */
 428           BuffyCount++;
 429         break;
 430
 431       case M_MH:
 432         /* only check on force or $mail_check reached */
 433         if (force != 0 || (now - last1 >= BuffyTimeout)) {
 434           if ((tmp->new = mh_buffy (tmp->path)) > 0)
 435             BuffyCount++;
 436           if (count) {
 437             DIR *dp;
 438             struct dirent *de;
 439
 440             if ((dp = opendir (path)) == NULL)
 441               break;
 442             tmp->new = 0;
 443             tmp->msgcount = 0;
 444             tmp->msg_unread = 0;
 445             while ((de = readdir (dp))) {
 446               if (mh_valid_message (de->d_name)) {
 447                 tmp->msgcount++;
 448                 tmp->msg_unread++;
 449                 tmp->new++;
 450               }
 451             }
 452             closedir (dp);
 453           }
 454         }
 455         else if (tmp->new > 0)
 456           /* keep current stats if !force and !$mail_check reached */
 457           BuffyCount++;
 458         break;
 459
 460 #ifdef USE_IMAP
 461       case M_IMAP:
 462         /* only check on force or $imap_mail_check reached */
 463         if (force != 0 || (now - last2 >= ImapBuffyTimeout)) {
 464           tmp->msgcount = imap_mailbox_check (tmp->path, 0);
 465           if ((tmp->new = imap_mailbox_check (tmp->path, 1)) > 0) {
 466             BuffyCount++;
 467             tmp->msg_unread = tmp->new; /* for sidebar; wtf? */
 468           }
 469           else {
 470             tmp->new = 0;
 471             tmp->msg_unread = 0;
 472           }
 473         }
 474         else if (tmp->new > 0)
 475           /* keep current stats if !force and !$imap_mail_check reached */
 476           BuffyCount++;
 477         break;
 478 #endif
 479
 480       }
 481     }
 482 #ifdef BUFFY_SIZE
 483     else if (Context && Context->path)
 484       tmp->size = (long) sb.st_size;    /* update the size */
 485 #endif
 486
 487     if (tmp->new <= 0)
 488       tmp->notified = 0;
 489     else if (!tmp->notified)
 490       BuffyNotify++;
 491     tmp->has_new = tmp->new > 0;
 492   }
 493   if (BuffyCount > 0 && force != 2)
 494     sidebar_draw (CurrentMenu);
 495   return (BuffyCount);
 496 }
 497
 498 int buffy_list (void)
 499 {
 500   BUFFY *tmp;
 501   char path[_POSIX_PATH_MAX];
 502   char buffylist[160];
 503   int pos;
 504   int first;
 505   int have_unnotified = BuffyNotify;
 506   int i = 0;
 507
 508   if (option (OPTFORCEBUFFYCHECK))
 509     buffy_check (1);
 510
 511   pos = 0;
 512   first = 1;
 513   buffylist[0] = 0;
 514   pos += safe_strlen (strncat (buffylist, _("New mail in "), sizeof (buffylist) - 1 - pos)); /* __STRNCAT_CHECKED__ */
 515   if (Incoming) {
 516     for (i = 0; i < Incoming->length; i++) {
 517       tmp = (BUFFY*) Incoming->data[i];
 518       /* Is there new mail in this mailbox? */
 519       if (tmp->new <= 0 || (have_unnotified && tmp->notified))
 520         continue;
 521
 522       strfcpy (path, tmp->path, sizeof (path));
 523       mutt_pretty_mailbox (path);
 524
 525       if (!first && pos + safe_strlen (path) >= COLS - 7)
 526         break;
 527
 528       if (!first)
 529         pos += safe_strlen (strncat (buffylist + pos, ", ", sizeof (buffylist) - 1 - pos));    /* __STRNCAT_CHECKED__ */
 530
 531       /* Prepend an asterisk to mailboxes not already notified */
 532       if (!tmp->notified) {
 533         /* pos += safe_strlen (strncat(buffylist + pos, "*", sizeof(buffylist)-1-pos));  __STRNCAT_CHECKED__ */
 534         tmp->notified = 1;
 535         BuffyNotify--;
 536       }
 537       pos += safe_strlen (strncat (buffylist + pos, path, sizeof (buffylist) - 1 - pos));      /* __STRNCAT_CHECKED__ */
 538       first = 0;
 539     }
 540   }
 541   if (!first && i < Incoming->length) {
 542     strncat (buffylist + pos, ", ...", sizeof (buffylist) - 1 - pos);   /* __STRNCAT_CHECKED__ */
 543   }
 544   if (!first) {
 545     /* on new mail: redraw sidebar */
 546     sidebar_draw (CurrentMenu);
 547     mutt_message ("%s", buffylist);
 548     return (1);
 549   }
 550   /* there were no mailboxes needing to be notified, so clean up since
 551    * BuffyNotify has somehow gotten out of sync
 552    */
 553   BuffyNotify = 0;
 554   return (0);
 555 }
 556
 557 int buffy_notify (void)
 558 {
 559   if (buffy_check (0) && BuffyNotify) {
 560     return (buffy_list ());
 561   }
 562   return (0);
 563 }
 564
 565 /*
 566  * mutt_buffy() -- incoming folders completion routine
 567  *
 568  * given a folder name, this routine gives the next incoming folder with new
 569  * new mail.
 570  */
 571 void buffy_next (char *s, size_t slen)
 572 {
 573   int i = 0, c = 0;
 574
 575   if (list_empty(Incoming))
 576     return;
 577
 578   mutt_expand_path (s, _POSIX_PATH_MAX);
 579   if (buffy_check (0) == 0) {
 580     *s = '\0';
 581     return;
 582   }
 583
 584   i = buffy_lookup (s);
 585   c = i == Incoming->length-1 ? 0 : i+1;
 586   while (((BUFFY*) Incoming->data[c])->new <= 0) {
 587     c = (c+1) % Incoming->length;
 588     if (c == i)
 589       break;    /* tried all once */
 590   }
 591   if (c == i) {
 592     *s = '\0';
 593     /* something went wrong since we're here when buffy_check
 594      * reported new mail */
 595     buffy_check (0);
 596   } else {
 597     strfcpy (s, ((BUFFY*) Incoming->data[c])->path, slen);
 598     mutt_pretty_mailbox (s);
 599   }
 600 }