src/mbox.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2007 Hiroyuki Yamamoto and the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #endif
  23
  24
  25 #define _GNU_SOURCE
  26 #include <stdio.h>
  27
  28 #include "defs.h"
  29 #include <glib.h>
  30 #include <glib/gi18n.h>
  31 #include <stdlib.h>
  32 #include <unistd.h>
  33 #include <string.h>
  34 #include <fcntl.h>
  35 #include <sys/file.h>
  36 #include <ctype.h>
  37 #include <time.h>
  38 #include <errno.h>
  39
  40 #ifdef G_OS_WIN32
  41 #  include <w32lib.h>
  42 #endif
  43
  44 #include "mbox.h"
  45 #include "procmsg.h"
  46 #include "folder.h"
  47 #include "prefs_common.h"
  48 #include "prefs_account.h"
  49 #include "account.h"
  50 #include "utils.h"
  51 #include "filtering.h"
  52 #include "alertpanel.h"
  53 #include "statusbar.h"
  54
  55 #define MSGBUFSIZE      8192
  56
  57 #ifdef HAVE_FGETS_UNLOCKED
  58 #define SC_FGETS fgets_unlocked
  59 #define SC_FPUTS fputs_unlocked
  60 #define SC_FPUTC fputc_unlocked
  61 #else
  62 #define SC_FGETS fgets
  63 #define SC_FPUTS fputs
  64 #define SC_FPUTC fputc
  65 #endif
  66
  67 #define FPUTS_TO_TMP_ABORT_IF_FAIL(s) \
  68 { \
  69         lines++; \
  70         if (fputs(s, tmp_fp) == EOF) { \
  71                 g_warning("can't write to temporary file\n"); \
  72                 fclose(tmp_fp); \
  73                 fclose(mbox_fp); \
  74                 g_unlink(tmp_file); \
  75                 g_free(tmp_file); \
  76                 return -1; \
  77         } \
  78 }
  79
  80 gint proc_mbox(FolderItem *dest, const gchar *mbox, gboolean apply_filter,
  81                PrefsAccount *account)
  82 /* return values: -1 error, >=0 number of msgs added */
  83 {
  84         FILE *mbox_fp;
  85         gchar buf[MSGBUFSIZE];
  86         gchar *tmp_file;
  87         gint msgs = 0;
  88         gint lines;
  89         MsgInfo *msginfo;
  90         gboolean more;
  91         GSList *to_filter = NULL, *filtered = NULL, *unfiltered = NULL, *cur, *to_add = NULL;
  92         gboolean printed = FALSE;
  93         FolderItem *dropfolder;
  94
  95         g_return_val_if_fail(dest != NULL, -1);
  96         g_return_val_if_fail(mbox != NULL, -1);
  97
  98         debug_print("Getting messages from %s into %s...\n", mbox, dest->path);
  99
 100         if ((mbox_fp = g_fopen(mbox, "rb")) == NULL) {
 101                 FILE_OP_ERROR(mbox, "fopen");
 102                 alertpanel_error(_("Could not open mbox file:\n%s\n"), mbox);
 103                 return -1;
 104         }
 105
 106         /* ignore empty lines on the head */
 107         do {
 108                 if (fgets(buf, sizeof(buf), mbox_fp) == NULL) {
 109                         g_warning("can't read mbox file.\n");
 110                         fclose(mbox_fp);
 111                         return -1;
 112                 }
 113         } while (buf[0] == '\n' || buf[0] == '\r');
 114
 115         if (strncmp(buf, "From ", 5) != 0) {
 116                 g_warning("invalid mbox format: %s\n", mbox);
 117                 fclose(mbox_fp);
 118                 return -1;
 119         }
 120
 121         tmp_file = get_tmp_file();
 122
 123         folder_item_update_freeze();
 124
 125         if (apply_filter)
 126                 dropfolder = folder_get_default_processing();
 127         else
 128                 dropfolder = dest;
 129
 130         do {
 131                 FILE *tmp_fp;
 132                 gint empty_lines;
 133                 gint msgnum;
 134
 135                 if (msgs > 0 && msgs%500 == 0) {
 136                         if (printed)
 137                                 statusbar_pop_all();
 138                         statusbar_print_all(_("Importing from mbox... (%d mails imported)"), msgs);
 139                         printed=TRUE;
 140                         GTK_EVENTS_FLUSH();
 141                 }
 142
 143                 if ((tmp_fp = g_fopen(tmp_file, "wb")) == NULL) {
 144                         FILE_OP_ERROR(tmp_file, "fopen");
 145                         g_warning("can't open temporary file\n");
 146                         fclose(mbox_fp);
 147                         g_free(tmp_file);
 148                         return -1;
 149                 }
 150                 if (change_file_mode_rw(tmp_fp, tmp_file) < 0) {
 151                         FILE_OP_ERROR(tmp_file, "chmod");
 152                 }
 153
 154                 empty_lines = 0;
 155                 lines = 0;
 156                 more = FALSE;
 157
 158                 /* process all lines from mboxrc file */
 159                 while (fgets(buf, sizeof(buf), mbox_fp) != NULL) {
 160                         int offset;
 161
 162                         /* eof not reached, expect more lines */
 163                         more = TRUE;
 164
 165                         /* eat empty lines */
 166                         if (buf[0] == '\n' || buf[0] == '\r') {
 167                                 empty_lines++;
 168                                 continue;
 169                         }
 170
 171                         /* From separator or quoted From */
 172                         offset = 0;
 173                         /* detect leading '>' char(s) */
 174                         while ((buf[offset] == '>')) {
 175                                 offset++;
 176                         }
 177                         if (!strncmp(buf+offset, "From ", 5)) {
 178                                 /* From separator: */
 179                                 if (offset == 0) {
 180                                         /* expect next mbox item */
 181                                         break;
 182                                 }
 183
 184                                 /* quoted From: */
 185                                 /* flush any eaten empty line */
 186                                 if (empty_lines > 0) {
 187                                         while (empty_lines-- > 0) {
 188                                                 FPUTS_TO_TMP_ABORT_IF_FAIL("\n");
 189                                 }
 190                                         empty_lines = 0;
 191                                 }
 192                                 /* store the unquoted line */
 193                                 FPUTS_TO_TMP_ABORT_IF_FAIL(buf + 1);
 194                                 continue;
 195                         }
 196
 197                         /* other line */
 198                         /* flush any eaten empty line */
 199                         if (empty_lines > 0) {
 200                                 while (empty_lines-- > 0) {
 201                                         FPUTS_TO_TMP_ABORT_IF_FAIL("\n");
 202                         }
 203                                 empty_lines = 0;
 204                         }
 205                         /* store the line itself */
 206                                         FPUTS_TO_TMP_ABORT_IF_FAIL(buf);
 207                 }
 208                 /* end of mbox item or end of mbox */
 209
 210                 /* flush any eaten empty line (but the last one) */
 211                 if (empty_lines > 0) {
 212                         while (--empty_lines > 0) {
 213                                 FPUTS_TO_TMP_ABORT_IF_FAIL("\n");
 214                         }
 215                 }
 216
 217                 /* more emails to expect? */
 218                 more = !feof(mbox_fp);
 219
 220                 /* warn if email part is empty (it's the minimum check
 221                    we can do */
 222                 if (lines == 0) {
 223                         g_warning("malformed mbox: %s: message %d is empty\n", mbox, msgs);
 224                         fclose(tmp_fp);
 225                         fclose(mbox_fp);
 226                         g_unlink(tmp_file);
 227                         return -1;
 228                 }
 229
 230                 if (fclose(tmp_fp) == EOF) {
 231                         FILE_OP_ERROR(tmp_file, "fclose");
 232                         g_warning("can't write to temporary file\n");
 233                         fclose(mbox_fp);
 234                         g_unlink(tmp_file);
 235                         g_free(tmp_file);
 236                         return -1;
 237                 }
 238
 239                 if (apply_filter) {
 240                         if ((msgnum = folder_item_add_msg(dropfolder, tmp_file, NULL, TRUE)) < 0) {
 241                                 fclose(mbox_fp);
 242                                 g_unlink(tmp_file);
 243                                 g_free(tmp_file);
 244                                 return -1;
 245                         }
 246                         msginfo = folder_item_get_msginfo(dropfolder, msgnum);
 247                         to_filter = g_slist_prepend(to_filter, msginfo);
 248                 } else {
 249                         MsgFileInfo *finfo = g_new0(MsgFileInfo, 1);
 250                         finfo->file = tmp_file;
 251
 252                         to_add = g_slist_prepend(to_add, finfo);
 253                         tmp_file = get_tmp_file();
 254
 255                         /* flush every 500 */
 256                         if (msgs > 0 && msgs % 500 == 0) {
 257                                 folder_item_add_msgs(dropfolder, to_add, TRUE);
 258                                 procmsg_message_file_list_free(to_add);
 259                                 to_add = NULL;
 260                         }
 261                 }
 262                 msgs++;
 263         } while (more);
 264
 265         if (printed)
 266                 statusbar_pop_all();
 267
 268         if (apply_filter) {
 269                 procmsg_msglist_filter(to_filter, account,
 270                                 &filtered, &unfiltered, TRUE);
 271
 272                 filtering_move_and_copy_msgs(to_filter);
 273                 for (cur = filtered; cur; cur = g_slist_next(cur)) {
 274                         MsgInfo *info = (MsgInfo *)cur->data;
 275                         procmsg_msginfo_free(info);
 276                 }
 277
 278                 unfiltered = g_slist_reverse(unfiltered);
 279                 folder_item_move_msgs(dest, unfiltered);
 280                 for (cur = unfiltered; cur; cur = g_slist_next(cur)) {
 281                         MsgInfo *info = (MsgInfo *)cur->data;
 282                         procmsg_msginfo_free(info);
 283                 }
 284
 285                 g_slist_free(unfiltered);
 286                 g_slist_free(filtered);
 287                 g_slist_free(to_filter);
 288         } else if (to_add) {
 289                 folder_item_add_msgs(dropfolder, to_add, TRUE);
 290                 procmsg_message_file_list_free(to_add);
 291                 to_add = NULL;
 292         }
 293
 294         folder_item_update_thaw();
 295
 296         g_free(tmp_file);
 297         fclose(mbox_fp);
 298         debug_print("%d messages found.\n", msgs);
 299
 300         return msgs;
 301 }
 302
 303 gint lock_mbox(const gchar *base, LockType type)
 304 {
 305 #ifdef G_OS_UNIX
 306         gint retval = 0;
 307
 308         if (type == LOCK_FILE) {
 309                 gchar *lockfile, *locklink;
 310                 gint retry = 0;
 311                 FILE *lockfp;
 312
 313                 lockfile = g_strdup_printf("%s.%d", base, getpid());
 314                 if ((lockfp = g_fopen(lockfile, "wb")) == NULL) {
 315                         FILE_OP_ERROR(lockfile, "fopen");
 316                         g_warning("can't create lock file %s\n", lockfile);
 317                         g_warning("use 'flock' instead of 'file' if possible.\n");
 318                         g_free(lockfile);
 319                         return -1;
 320                 }
 321
 322                 fprintf(lockfp, "%d\n", getpid());
 323                 fclose(lockfp);
 324
 325                 locklink = g_strconcat(base, ".lock", NULL);
 326                 while (link(lockfile, locklink) < 0) {
 327                         FILE_OP_ERROR(lockfile, "link");
 328                         if (retry >= 5) {
 329                                 g_warning("can't create %s\n", lockfile);
 330                                 g_unlink(lockfile);
 331                                 g_free(lockfile);
 332                                 return -1;
 333                         }
 334                         if (retry == 0)
 335                                 g_warning("mailbox is owned by another"
 336                                             " process, waiting...\n");
 337                         retry++;
 338                         sleep(5);
 339                 }
 340                 g_unlink(lockfile);
 341                 g_free(lockfile);
 342         } else if (type == LOCK_FLOCK) {
 343                 gint lockfd;
 344                 gboolean fcntled = FALSE;
 345 #if HAVE_FCNTL_H && !defined(G_OS_WIN32)
 346                 struct flock fl;
 347                 fl.l_type = F_WRLCK;
 348                 fl.l_whence = SEEK_SET;
 349                 fl.l_start = 0;
 350                 fl.l_len = 0;
 351 #endif
 352
 353 #if HAVE_FLOCK
 354                 if ((lockfd = open(base, O_RDWR)) < 0) {
 355 #else
 356                 if ((lockfd = open(base, O_RDWR)) < 0) {
 357 #endif
 358                         FILE_OP_ERROR(base, "open");
 359                         return -1;
 360                 }
 361
 362 #if HAVE_FCNTL_H && !defined(G_OS_WIN32)
 363                 if (fcntl(lockfd, F_SETLK, &fl) == -1) {
 364                         g_warning("can't fnctl %s (%s)", base, strerror(errno));
 365                         return -1;
 366                 } else {
 367                         fcntled = TRUE;
 368                 }
 369 #endif
 370
 371 #if HAVE_FLOCK
 372                 if (flock(lockfd, LOCK_EX|LOCK_NB) < 0 && !fcntled) {
 373                         perror("flock");
 374 #else
 375 #if HAVE_LOCKF
 376                 if (lockf(lockfd, F_TLOCK, 0) < 0 && !fcntled) {
 377                         perror("lockf");
 378 #else
 379                 {
 380 #endif
 381 #endif /* HAVE_FLOCK */
 382                         g_warning("can't lock %s\n", base);
 383                         if (close(lockfd) < 0)
 384                                 perror("close");
 385                         return -1;
 386                 }
 387                 retval = lockfd;
 388         } else {
 389                 g_warning("invalid lock type\n");
 390                 return -1;
 391         }
 392
 393         return retval;
 394 #else
 395         return -1;
 396 #endif /* G_OS_UNIX */
 397 }
 398
 399 gint unlock_mbox(const gchar *base, gint fd, LockType type)
 400 {
 401         if (type == LOCK_FILE) {
 402                 gchar *lockfile;
 403
 404                 lockfile = g_strconcat(base, ".lock", NULL);
 405                 if (g_unlink(lockfile) < 0) {
 406                         FILE_OP_ERROR(lockfile, "unlink");
 407                         g_free(lockfile);
 408                         return -1;
 409                 }
 410                 g_free(lockfile);
 411
 412                 return 0;
 413         } else if (type == LOCK_FLOCK) {
 414                 gboolean fcntled = FALSE;
 415 #if HAVE_FCNTL_H && !defined(G_OS_WIN32)
 416                 struct flock fl;
 417                 fl.l_type = F_UNLCK;
 418                 fl.l_whence = SEEK_SET;
 419                 fl.l_start = 0;
 420                 fl.l_len = 0;
 421
 422                 if (fcntl(fd, F_SETLK, &fl) == -1) {
 423                         g_warning("can't fnctl %s", base);
 424                 } else {
 425                         fcntled = TRUE;
 426                 }
 427 #endif
 428 #if HAVE_FLOCK
 429                 if (flock(fd, LOCK_UN) < 0 && !fcntled) {
 430                         perror("flock");
 431 #else
 432 #if HAVE_LOCKF
 433                 if (lockf(fd, F_ULOCK, 0) < 0 && !fcntled) {
 434                         perror("lockf");
 435 #else
 436                 {
 437 #endif
 438 #endif /* HAVE_FLOCK */
 439                         g_warning("can't unlock %s\n", base);
 440                         if (close(fd) < 0)
 441                                 perror("close");
 442                         return -1;
 443                 }
 444
 445                 if (close(fd) < 0) {
 446                         perror("close");
 447                         return -1;
 448                 }
 449
 450                 return 0;
 451         }
 452
 453         g_warning("invalid lock type\n");
 454         return -1;
 455 }
 456
 457 gint copy_mbox(gint srcfd, const gchar *dest)
 458 {
 459         FILE *dest_fp;
 460         ssize_t n_read;
 461         gchar buf[BUFSIZ];
 462         gboolean err = FALSE;
 463         int save_errno = 0;
 464
 465         if (srcfd < 0) {
 466                 return -1;
 467         }
 468
 469         if ((dest_fp = g_fopen(dest, "wb")) == NULL) {
 470                 FILE_OP_ERROR(dest, "fopen");
 471                 return -1;
 472         }
 473
 474         if (change_file_mode_rw(dest_fp, dest) < 0) {
 475                 FILE_OP_ERROR(dest, "chmod");
 476                 g_warning("can't change file mode\n");
 477         }
 478
 479         while ((n_read = read(srcfd, buf, sizeof(buf))) > 0) {
 480                 if (n_read == -1 && errno != 0) {
 481                         save_errno = errno;
 482                         break;
 483                 }
 484                 if (fwrite(buf, 1, n_read, dest_fp) < n_read) {
 485                         g_warning("writing to %s failed.\n", dest);
 486                         fclose(dest_fp);
 487                         g_unlink(dest);
 488                         return -1;
 489                 }
 490         }
 491
 492         if (save_errno != 0) {
 493                 g_warning("error %d reading mbox: %s\n", save_errno,
 494                                 strerror(save_errno));
 495                 err = TRUE;
 496         }
 497
 498         if (fclose(dest_fp) == EOF) {
 499                 FILE_OP_ERROR(dest, "fclose");
 500                 err = TRUE;
 501         }
 502
 503         if (err) {
 504                 g_unlink(dest);
 505                 return -1;
 506         }
 507
 508         return 0;
 509 }
 510
 511 void empty_mbox(const gchar *mbox)
 512 {
 513         FILE *fp;
 514
 515         if ((fp = g_fopen(mbox, "wb")) == NULL) {
 516                 FILE_OP_ERROR(mbox, "fopen");
 517                 g_warning("can't truncate mailbox to zero.\n");
 518                 return;
 519         }
 520         fclose(fp);
 521 }
 522
 523 gint export_list_to_mbox(GSList *mlist, const gchar *mbox)
 524 /* return values: -2 skipped, -1 error, 0 OK */
 525 {
 526         GSList *cur;
 527         MsgInfo *msginfo;
 528         FILE *msg_fp;
 529         FILE *mbox_fp;
 530         gchar buf[BUFFSIZE];
 531         gint msgs = 1, total = g_slist_length(mlist);
 532         if (g_file_test(mbox, G_FILE_TEST_EXISTS) == TRUE) {
 533                 if (alertpanel_full(_("Overwrite mbox file"),
 534                                         _("This file already exists. Do you want to overwrite it?"),
 535                                         GTK_STOCK_CANCEL, _("Overwrite"), NULL, FALSE,
 536                                         NULL, ALERT_WARNING, G_ALERTDEFAULT)
 537                                 != G_ALERTALTERNATE) {
 538                         return -2;
 539                 }
 540         }
 541
 542         if ((mbox_fp = g_fopen(mbox, "wb")) == NULL) {
 543                 FILE_OP_ERROR(mbox, "fopen");
 544                 alertpanel_error(_("Could not create mbox file:\n%s\n"), mbox);
 545                 return -1;
 546         }
 547
 548 #ifdef HAVE_FGETS_UNLOCKED
 549         flockfile(mbox_fp);
 550 #endif
 551
 552         statusbar_print_all(_("Exporting to mbox..."));
 553         for (cur = mlist; cur != NULL; cur = cur->next) {
 554                 int len;
 555                 gchar buft[BUFFSIZE];
 556                 msginfo = (MsgInfo *)cur->data;
 557
 558                 msg_fp = procmsg_open_message(msginfo);
 559                 if (!msg_fp) {
 560                         continue;
 561                 }
 562
 563 #ifdef HAVE_FGETS_UNLOCKED
 564                 flockfile(msg_fp);
 565 #endif
 566                 strncpy2(buf,
 567                          msginfo->from ? msginfo->from :
 568                          cur_account && cur_account->address ?
 569                          cur_account->address : "unknown",
 570                          sizeof(buf));
 571                 extract_address(buf);
 572
 573                 fprintf(mbox_fp, "From %s %s",
 574                         buf, ctime_r(&msginfo->date_t, buft));
 575
 576                 buf[0] = '\0';
 577
 578                 /* write email to mboxrc */
 579                 while (SC_FGETS(buf, sizeof(buf), msg_fp) != NULL) {
 580                         /* quote any From, >From, >>From, etc., according to mbox format specs */
 581                         int offset;
 582
 583                         offset = 0;
 584                         /* detect leading '>' char(s) */
 585                         while ((buf[offset] == '>')) {
 586                                 offset++;
 587                         }
 588                         if (!strncmp(buf+offset, "From ", 5))
 589                                 SC_FPUTC('>', mbox_fp);
 590                         SC_FPUTS(buf, mbox_fp);
 591                 }
 592
 593                 /* force last line to end w/ a newline */
 594                 len = strlen(buf);
 595                 if (len > 0) {
 596                         len--;
 597                         if ((buf[len] != '\n') && (buf[len] != '\r'))
 598                                 SC_FPUTC('\n', mbox_fp);
 599                 }
 600
 601                 /* add a trailing empty line */
 602                 SC_FPUTC('\n', mbox_fp);
 603
 604 #ifdef HAVE_FGETS_UNLOCKED
 605                 funlockfile(msg_fp);
 606 #endif
 607                 fclose(msg_fp);
 608                 statusbar_progress_all(msgs++,total, 500);
 609                 if (msgs%500 == 0)
 610                         GTK_EVENTS_FLUSH();
 611         }
 612         statusbar_progress_all(0,0,0);
 613         statusbar_pop_all();
 614
 615 #ifdef HAVE_FGETS_UNLOCKED
 616         funlockfile(mbox_fp);
 617 #endif
 618         fclose(mbox_fp);
 619
 620         return 0;
 621 }
 622
 623 /* read all messages in SRC, and store them into one MBOX file. */
 624 /* return values: -2 skipped, -1 error, 0 OK */
 625 gint export_to_mbox(FolderItem *src, const gchar *mbox)
 626 {
 627         GSList *mlist;
 628         gint ret;
 629
 630         g_return_val_if_fail(src != NULL, -1);
 631         g_return_val_if_fail(src->folder != NULL, -1);
 632         g_return_val_if_fail(mbox != NULL, -1);
 633
 634         debug_print("Exporting messages from %s into %s...\n",
 635                     src->path, mbox);
 636
 637         mlist = folder_item_get_msg_list(src);
 638
 639         folder_item_update_freeze();
 640         ret = export_list_to_mbox(mlist, mbox);
 641         folder_item_update_thaw();
 642
 643         procmsg_msg_list_free(mlist);
 644
 645         return ret;
 646 }