buffy.c

   1 /*
   2  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
   3  *
   4  *     This program is free software; you can redistribute it and/or modify
   5  *     it under the terms of the GNU General Public License as published by
   6  *     the Free Software Foundation; either version 2 of the License, or
   7  *     (at your option) any later version.
   8  *
   9  *     This program is distributed in the hope that it will be useful,
  10  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *     GNU General Public License for more details.
  13  *
  14  *     You should have received a copy of the GNU General Public License
  15  *     along with this program; if not, write to the Free Software
  16  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  */
  18
  19 #if HAVE_CONFIG_H
  20 # include "config.h"
  21 #endif
  22
  23 #include "mutt.h"
  24 #include "buffy.h"
  25 #include "mailbox.h"
  26 #include "mx.h"
  27
  28 #include "mutt_curses.h"
  29
  30 #ifdef USE_IMAP
  31 #include "imap.h"
  32 #endif
  33
  34 #include <string.h>
  35 #include <sys/stat.h>
  36 #include <dirent.h>
  37 #include <utime.h>
  38 #include <ctype.h>
  39 #include <unistd.h>
  40
  41 #include <stdio.h>
  42
  43 static time_t BuffyTime = 0;    /* last time we started checking for mail */
  44 time_t BuffyDoneTime = 0;       /* last time we knew for sure how much mail there was. */
  45 static short BuffyCount = 0;    /* how many boxes with new mail */
  46 static short BuffyNotify = 0;   /* # of unnotified new boxes */
  47
  48 static BUFFY* buffy_get (const char *path);
  49
  50 /* Find the last message in the file.
  51  * upon success return 0. If no message found - return -1 */
  52
  53 static int fseek_last_message (FILE * f)
  54 {
  55   LOFF_T pos;
  56   char buffer[BUFSIZ + 9];      /* 7 for "\n\nFrom " */
  57   int bytes_read;
  58   int i;                        /* Index into `buffer' for scanning.  */
  59
  60   memset (buffer, 0, sizeof(buffer));
  61   fseek (f, 0, SEEK_END);
  62   pos = ftello (f);
  63
  64   /* Set `bytes_read' to the size of the last, probably partial, buffer; 0 <
  65    * `bytes_read' <= `BUFSIZ'.  */
  66   bytes_read = pos % BUFSIZ;
  67   if (bytes_read == 0)
  68     bytes_read = BUFSIZ;
  69   /* Make `pos' a multiple of `BUFSIZ' (0 if the file is short), so that all
  70    * reads will be on block boundaries, which might increase efficiency.  */
  71   while ((pos -= bytes_read) >= 0)
  72   {
  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 * mutt_strlen(CRLF) */
  75     fseeko (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 (!mutt_strncmp (buffer + i, "\n\nFrom ", mutt_strlen ("\n\nFrom ")))
  81       {                         /* found it - go to the beginning of the From */
  82         fseeko (f, pos + i + 2, SEEK_SET);
  83         return 0;
  84       }
  85     bytes_read = BUFSIZ;
  86   }
  87
  88   /* here we are at the beginning of the file */
  89   if (!mutt_strncmp ("From ", buffer, 5))
  90   {
  91     fseek (f, 0, 0);
  92     return (0);
  93   }
  94
  95   return (-1);
  96 }
  97
  98 /* Return 1 if the last message is new */
  99 static int test_last_status_new (FILE * f)
 100 {
 101   HEADER *hdr;
 102   ENVELOPE* tmp_envelope;
 103   int result = 0;
 104
 105   if (fseek_last_message (f) == -1)
 106     return (0);
 107
 108   hdr = mutt_new_header ();
 109   tmp_envelope = mutt_read_rfc822_header (f, hdr, 0, 0);
 110   if (!(hdr->read || hdr->old))
 111     result = 1;
 112
 113   mutt_free_envelope(&tmp_envelope);
 114   mutt_free_header (&hdr);
 115
 116   return result;
 117 }
 118
 119 static int test_new_folder (const char *path)
 120 {
 121   FILE *f;
 122   int rc = 0;
 123   int typ;
 124
 125   typ = mx_get_magic (path);
 126
 127   if (typ != M_MBOX && typ != M_MMDF)
 128     return 0;
 129
 130   if ((f = fopen (path, "rb")))
 131   {
 132     rc = test_last_status_new (f);
 133     safe_fclose (&f);
 134   }
 135
 136   return rc;
 137 }
 138
 139 void mutt_buffy_cleanup (const char *buf, struct stat *st)
 140 {
 141   struct utimbuf ut;
 142   BUFFY *tmp;
 143
 144   if (option(OPTCHECKMBOXSIZE))
 145   {
 146     tmp = mutt_find_mailbox (buf);
 147     if (tmp && !tmp->new)
 148       mutt_update_mailbox (tmp);
 149   }
 150   else
 151   {
 152     /* fix up the times so buffy won't get confused */
 153     if (st->st_mtime > st->st_atime)
 154     {
 155       ut.actime = st->st_atime;
 156       ut.modtime = time (NULL);
 157       utime (buf, &ut);
 158     }
 159     else
 160       utime (buf, NULL);
 161   }
 162 }
 163
 164 BUFFY *mutt_find_mailbox (const char *path)
 165 {
 166   BUFFY *tmp = NULL;
 167   struct stat sb;
 168   struct stat tmp_sb;
 169
 170   if (stat (path,&sb) != 0)
 171     return NULL;
 172
 173   for (tmp = Incoming; tmp; tmp = tmp->next)
 174   {
 175     if (stat (tmp->path,&tmp_sb) ==0 &&
 176         sb.st_dev == tmp_sb.st_dev && sb.st_ino == tmp_sb.st_ino)
 177       break;
 178   }
 179   return tmp;
 180 }
 181
 182 void mutt_update_mailbox (BUFFY * b)
 183 {
 184   struct stat sb;
 185
 186   if (!b)
 187     return;
 188
 189   if (stat (b->path, &sb) == 0)
 190     b->size = (off_t) sb.st_size;
 191   else
 192     b->size = 0;
 193   return;
 194 }
 195
 196 static BUFFY *buffy_new (const char *path)
 197 {
 198   BUFFY* buffy;
 199
 200   buffy = (BUFFY *) safe_calloc (1, sizeof (BUFFY));
 201   strfcpy (buffy->path, path, sizeof (buffy->path));
 202   buffy->next = NULL;
 203   buffy->magic = 0;
 204
 205   return buffy;
 206 }
 207
 208 static void buffy_free (BUFFY **mailbox)
 209 {
 210   FREE (mailbox); /* __FREE_CHECKED__ */
 211 }
 212
 213 int mutt_parse_mailboxes (BUFFER *path, BUFFER *s, unsigned long data, BUFFER *err)
 214 {
 215   BUFFY **tmp,*tmp1;
 216   char buf[_POSIX_PATH_MAX];
 217   struct stat sb;
 218   char f1[PATH_MAX], f2[PATH_MAX];
 219   char *p, *q;
 220
 221   while (MoreArgs (s))
 222   {
 223     mutt_extract_token (path, s, 0);
 224     strfcpy (buf, path->data, sizeof (buf));
 225
 226     if(data == M_UNMAILBOXES && mutt_strcmp(buf,"*") == 0)
 227     {
 228       for (tmp = &Incoming; *tmp;)
 229       {
 230         tmp1=(*tmp)->next;
 231         buffy_free (tmp);
 232         *tmp=tmp1;
 233       }
 234       return 0;
 235     }
 236
 237     mutt_expand_path (buf, sizeof (buf));
 238
 239     /* Skip empty tokens. */
 240     if(!*buf) continue;
 241
 242     /* avoid duplicates */
 243     p = realpath (buf, f1);
 244     for (tmp = &Incoming; *tmp; tmp = &((*tmp)->next))
 245     {
 246       q = realpath ((*tmp)->path, f2);
 247       if (mutt_strcmp (p ? p : buf, q ? q : (*tmp)->path) == 0)
 248       {
 249         dprint(3,(debugfile,"mailbox '%s' already registered as '%s'\n", buf, (*tmp)->path));
 250         break;
 251       }
 252     }
 253
 254     if(data == M_UNMAILBOXES)
 255     {
 256       if(*tmp)
 257       {
 258         tmp1=(*tmp)->next;
 259         buffy_free (tmp);
 260         *tmp=tmp1;
 261       }
 262       continue;
 263     }
 264
 265     if (!*tmp)
 266       *tmp = buffy_new (buf);
 267
 268     (*tmp)->new = 0;
 269     (*tmp)->notified = 1;
 270     (*tmp)->newly_created = 0;
 271
 272     /* for check_mbox_size, it is important that if the folder is new (tested by
 273      * reading it), the size is set to 0 so that later when we check we see
 274      * that it increased .  without check_mbox_size we probably don't care.
 275      */
 276     if (option(OPTCHECKMBOXSIZE) &&
 277         stat ((*tmp)->path, &sb) == 0 && !test_new_folder ((*tmp)->path))
 278     {
 279       /* some systems out there don't have an off_t type */
 280       (*tmp)->size = (off_t) sb.st_size;
 281     }
 282     else
 283       (*tmp)->size = 0;
 284   }
 285   return 0;
 286 }
 287
 288 /* returns 1 if maildir has new mail */
 289 static int buffy_maildir_hasnew (BUFFY* mailbox)
 290 {
 291   char path[_POSIX_PATH_MAX];
 292   DIR *dirp;
 293   struct dirent *de;
 294   char *p;
 295   int rc = 0;
 296   struct stat sb;
 297
 298   snprintf (path, sizeof (path), "%s/new", mailbox->path);
 299
 300   /* when $mail_check_recent is set, if the new/ directory hasn't been modified since
 301    * the user last exited the mailbox, then we know there is no recent mail.
 302    */
 303   if (option(OPTMAILCHECKRECENT))
 304   {
 305     if (stat(path, &sb) == 0 && sb.st_mtime < mailbox->last_visited)
 306       return 0;
 307   }
 308
 309   if ((dirp = opendir (path)) == NULL)
 310   {
 311     mailbox->magic = 0;
 312     return 0;
 313   }
 314
 315   while ((de = readdir (dirp)) != NULL)
 316   {
 317     if (*de->d_name == '.')
 318       continue;
 319
 320     if (!(p = strstr (de->d_name, ":2,")) || !strchr (p + 3, 'T'))
 321     {
 322       if (option(OPTMAILCHECKRECENT))
 323       {
 324         char msgpath[_POSIX_PATH_MAX];
 325
 326         snprintf(msgpath, sizeof(msgpath), "%s/%s", path, de->d_name);
 327         /* ensure this message was received since leaving this mailbox */
 328         if (stat(msgpath, &sb) == 0 && (sb.st_ctime <= mailbox->last_visited))
 329           continue;
 330       }
 331       /* one new and undeleted message is enough */
 332       mailbox->new = 1;
 333       rc = 1;
 334       break;
 335     }
 336   }
 337
 338   closedir (dirp);
 339
 340   return rc;
 341 }
 342
 343 /* returns 1 if mailbox has new mail */
 344 static int buffy_mbox_hasnew (BUFFY* mailbox, struct stat *sb)
 345 {
 346   int rc = 0;
 347   int statcheck;
 348
 349   if (option (OPTCHECKMBOXSIZE))
 350     statcheck = sb->st_size > mailbox->size;
 351   else
 352     statcheck = sb->st_mtime > sb->st_atime
 353       || (mailbox->newly_created && sb->st_ctime == sb->st_mtime && sb->st_ctime == sb->st_atime);
 354   if (statcheck)
 355   {
 356     if (!option(OPTMAILCHECKRECENT) || sb->st_mtime > mailbox->last_visited)
 357     {
 358       rc = 1;
 359       mailbox->new = 1;
 360     }
 361   }
 362   else if (option(OPTCHECKMBOXSIZE))
 363   {
 364     /* some other program has deleted mail from the folder */
 365     mailbox->size = (off_t) sb->st_size;
 366   }
 367   if (mailbox->newly_created &&
 368       (sb->st_ctime != sb->st_mtime || sb->st_ctime != sb->st_atime))
 369     mailbox->newly_created = 0;
 370
 371   return rc;
 372 }
 373
 374 int mutt_buffy_check (int force)
 375 {
 376   BUFFY *tmp;
 377   struct stat sb;
 378   struct stat contex_sb;
 379   time_t t;
 380
 381   sb.st_size=0;
 382   contex_sb.st_dev=0;
 383   contex_sb.st_ino=0;
 384
 385 #ifdef USE_IMAP
 386   /* update postponed count as well, on force */
 387   if (force)
 388     mutt_update_num_postponed ();
 389 #endif
 390
 391   /* fastest return if there are no mailboxes */
 392   if (!Incoming)
 393     return 0;
 394   t = time (NULL);
 395   if (!force && (t - BuffyTime < BuffyTimeout))
 396     return BuffyCount;
 397
 398   BuffyTime = t;
 399   BuffyCount = 0;
 400   BuffyNotify = 0;
 401
 402 #ifdef USE_IMAP
 403   BuffyCount += imap_buffy_check (force);
 404 #endif
 405
 406   /* check device ID and serial number instead of comparing paths */
 407   if (!Context || Context->magic == M_IMAP || Context->magic == M_POP
 408       || stat (Context->path, &contex_sb) != 0)
 409   {
 410     contex_sb.st_dev=0;
 411     contex_sb.st_ino=0;
 412   }
 413
 414   for (tmp = Incoming; tmp; tmp = tmp->next)
 415   {
 416     if (tmp->magic != M_IMAP)
 417     {
 418       tmp->new = 0;
 419 #ifdef USE_POP
 420       if (mx_is_pop (tmp->path))
 421         tmp->magic = M_POP;
 422       else
 423 #endif
 424       if (stat (tmp->path, &sb) != 0 || (S_ISREG(sb.st_mode) && sb.st_size == 0) ||
 425           (!tmp->magic && (tmp->magic = mx_get_magic (tmp->path)) <= 0))
 426       {
 427         /* if the mailbox still doesn't exist, set the newly created flag to
 428          * be ready for when it does. */
 429         tmp->newly_created = 1;
 430         tmp->magic = 0;
 431         tmp->size = 0;
 432         continue;
 433       }
 434     }
 435
 436     /* check to see if the folder is the currently selected folder
 437      * before polling */
 438     if (!Context || !Context->path ||
 439         (( tmp->magic == M_IMAP || tmp->magic == M_POP )
 440             ? mutt_strcmp (tmp->path, Context->path) :
 441               (sb.st_dev != contex_sb.st_dev || sb.st_ino != contex_sb.st_ino)))
 442     {
 443       switch (tmp->magic)
 444       {
 445       case M_MBOX:
 446       case M_MMDF:
 447         if (buffy_mbox_hasnew (tmp, &sb) > 0)
 448           BuffyCount++;
 449         break;
 450
 451       case M_MAILDIR:
 452         if (buffy_maildir_hasnew (tmp) > 0)
 453           BuffyCount++;
 454         break;
 455
 456       case M_MH:
 457         if ((tmp->new = mh_buffy (tmp->path)) > 0)
 458           BuffyCount++;
 459         break;
 460       }
 461     }
 462     else if (option(OPTCHECKMBOXSIZE) && Context && Context->path)
 463       tmp->size = (off_t) sb.st_size;   /* update the size of current folder */
 464
 465     if (!tmp->new)
 466       tmp->notified = 0;
 467     else if (!tmp->notified)
 468       BuffyNotify++;
 469   }
 470
 471   BuffyDoneTime = BuffyTime;
 472   return (BuffyCount);
 473 }
 474
 475 int mutt_buffy_list (void)
 476 {
 477   BUFFY *tmp;
 478   char path[_POSIX_PATH_MAX];
 479   char buffylist[2*STRING];
 480   size_t pos = 0;
 481   int first = 1;
 482
 483   int have_unnotified = BuffyNotify;
 484
 485   buffylist[0] = 0;
 486   pos += strlen (strncat (buffylist, _("New mail in "), sizeof (buffylist) - 1 - pos)); /* __STRNCAT_CHECKED__ */
 487   for (tmp = Incoming; tmp; tmp = tmp->next)
 488   {
 489     /* Is there new mail in this mailbox? */
 490     if (!tmp->new || (have_unnotified && tmp->notified))
 491       continue;
 492
 493     strfcpy (path, tmp->path, sizeof (path));
 494     mutt_pretty_mailbox (path, sizeof (path));
 495
 496     if (!first && (COLS - 7 >= 0) && (pos + strlen (path) >= (size_t)COLS - 7))
 497       break;
 498
 499     if (!first)
 500       pos += strlen (strncat(buffylist + pos, ", ", sizeof(buffylist)-1-pos)); /* __STRNCAT_CHECKED__ */
 501
 502     /* Prepend an asterisk to mailboxes not already notified */
 503     if (!tmp->notified)
 504     {
 505       /* pos += strlen (strncat(buffylist + pos, "*", sizeof(buffylist)-1-pos));  __STRNCAT_CHECKED__ */
 506       tmp->notified = 1;
 507       BuffyNotify--;
 508     }
 509     pos += strlen (strncat(buffylist + pos, path, sizeof(buffylist)-1-pos)); /* __STRNCAT_CHECKED__ */
 510     first = 0;
 511   }
 512   if (!first && tmp)
 513   {
 514     strncat (buffylist + pos, ", ...", sizeof (buffylist) - 1 - pos); /* __STRNCAT_CHECKED__ */
 515   }
 516   if (!first)
 517   {
 518     mutt_message ("%s", buffylist);
 519     return (1);
 520   }
 521   /* there were no mailboxes needing to be notified, so clean up since
 522    * BuffyNotify has somehow gotten out of sync
 523    */
 524   BuffyNotify = 0;
 525   return (0);
 526 }
 527
 528 void mutt_buffy_setnotified (const char *path)
 529 {
 530   BUFFY *buffy;
 531
 532   buffy = buffy_get(path);
 533   if (!buffy)
 534     return;
 535
 536   buffy->notified = 1;
 537   time(&buffy->last_visited);
 538 }
 539
 540 int mutt_buffy_notify (void)
 541 {
 542   if (mutt_buffy_check (0) && BuffyNotify)
 543   {
 544     return (mutt_buffy_list ());
 545   }
 546   return (0);
 547 }
 548
 549 /*
 550  * mutt_buffy() -- incoming folders completion routine
 551  *
 552  * given a folder name, this routine gives the next incoming folder with new
 553  * mail.
 554  */
 555 void mutt_buffy (char *s, size_t slen)
 556 {
 557   BUFFY *tmp = Incoming;
 558   int pass, found = 0;
 559
 560   mutt_expand_path (s, slen);
 561
 562   if (mutt_buffy_check (0))
 563   {
 564     for (pass = 0; pass < 2; pass++)
 565       for (tmp = Incoming; tmp; tmp = tmp->next)
 566       {
 567         mutt_expand_path (tmp->path, sizeof (tmp->path));
 568         if ((found || pass) && tmp->new)
 569         {
 570           strfcpy (s, tmp->path, slen);
 571           mutt_pretty_mailbox (s, slen);
 572           return;
 573         }
 574         if (mutt_strcmp (s, tmp->path) == 0)
 575           found = 1;
 576       }
 577
 578     mutt_buffy_check (1); /* buffy was wrong - resync things */
 579   }
 580
 581   /* no folders with new mail */
 582   *s = '\0';
 583 }
 584
 585 /* fetch buffy object for given path, if present */
 586 static BUFFY* buffy_get (const char *path)
 587 {
 588   BUFFY *cur;
 589   char *epath;
 590
 591   if (!path)
 592     return NULL;
 593
 594   epath = safe_strdup(path);
 595   mutt_expand_path(epath, mutt_strlen(epath));
 596
 597   for (cur = Incoming; cur; cur = cur->next)
 598   {
 599     /* must be done late because e.g. IMAP delimiter may change */
 600     mutt_expand_path (cur->path, sizeof (cur->path));
 601     if (!mutt_strcmp(cur->path, path))
 602     {
 603       FREE (&epath);
 604       return cur;
 605     }
 606   }
 607
 608   FREE (&epath);
 609   return NULL;
 610 }