2009-01-17 [colin] 3.7.0cvs37
[claws.git] / src / mbox.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2009 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                 claws_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                         claws_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                         claws_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                                 claws_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
270                 folder_item_set_batch(dropfolder, FALSE);
271                 procmsg_msglist_filter(to_filter, account, 
272                                 &filtered, &unfiltered, TRUE);
273                 folder_item_set_batch(dropfolder, TRUE);
274
275                 filtering_move_and_copy_msgs(to_filter);
276                 for (cur = filtered; cur; cur = g_slist_next(cur)) {
277                         MsgInfo *info = (MsgInfo *)cur->data;
278                         procmsg_msginfo_free(info);
279                 }
280
281                 unfiltered = g_slist_reverse(unfiltered);
282                 folder_item_move_msgs(dest, unfiltered);
283                 for (cur = unfiltered; cur; cur = g_slist_next(cur)) {
284                         MsgInfo *info = (MsgInfo *)cur->data;
285                         procmsg_msginfo_free(info);
286                 }
287
288                 g_slist_free(unfiltered);
289                 g_slist_free(filtered);
290                 g_slist_free(to_filter);
291         } else if (to_add) {
292                 folder_item_add_msgs(dropfolder, to_add, TRUE);
293                 procmsg_message_file_list_free(to_add);
294                 to_add = NULL;
295         }
296
297         folder_item_update_thaw();
298         
299         g_free(tmp_file);
300         fclose(mbox_fp);
301         debug_print("%d messages found.\n", msgs);
302
303         return msgs;
304 }
305
306 gint lock_mbox(const gchar *base, LockType type)
307 {
308 #ifdef G_OS_UNIX
309         gint retval = 0;
310
311         if (type == LOCK_FILE) {
312                 gchar *lockfile, *locklink;
313                 gint retry = 0;
314                 FILE *lockfp;
315
316                 lockfile = g_strdup_printf("%s.%d", base, getpid());
317                 if ((lockfp = g_fopen(lockfile, "wb")) == NULL) {
318                         FILE_OP_ERROR(lockfile, "fopen");
319                         g_warning("can't create lock file %s\n", lockfile);
320                         g_warning("use 'flock' instead of 'file' if possible.\n");
321                         g_free(lockfile);
322                         return -1;
323                 }
324
325                 if (fprintf(lockfp, "%d\n", getpid()) < 0 ||
326                     fclose(lockfp) == EOF) {
327                         FILE_OP_ERROR(lockfile, "fopen||fclose");
328                         g_free(lockfile);
329                         return -1;
330                 }
331
332                 locklink = g_strconcat(base, ".lock", NULL);
333                 while (link(lockfile, locklink) < 0) {
334                         FILE_OP_ERROR(lockfile, "link");
335                         if (retry >= 5) {
336                                 g_warning("can't create %s\n", lockfile);
337                                 claws_unlink(lockfile);
338                                 g_free(lockfile);
339                                 return -1;
340                         }
341                         if (retry == 0)
342                                 g_warning("mailbox is owned by another"
343                                             " process, waiting...\n");
344                         retry++;
345                         sleep(5);
346                 }
347                 claws_unlink(lockfile);
348                 g_free(lockfile);
349         } else if (type == LOCK_FLOCK) {
350                 gint lockfd;
351                 gboolean fcntled = FALSE;
352 #if HAVE_FCNTL_H && !defined(G_OS_WIN32)
353                 struct flock fl;
354                 fl.l_type = F_WRLCK;
355                 fl.l_whence = SEEK_SET;
356                 fl.l_start = 0;
357                 fl.l_len = 0;
358 #endif
359
360 #if HAVE_FLOCK
361                 if ((lockfd = g_open(base, O_RDWR)) < 0) {
362 #else
363                 if ((lockfd = g_open(base, O_RDWR)) < 0) {
364 #endif
365                         FILE_OP_ERROR(base, "open");
366                         return -1;
367                 }
368                 
369 #if HAVE_FCNTL_H && !defined(G_OS_WIN32)
370                 if (fcntl(lockfd, F_SETLK, &fl) == -1) {
371                         g_warning("can't fnctl %s (%s)", base, strerror(errno));
372                         return -1;
373                 } else {
374                         fcntled = TRUE;
375                 }
376 #endif
377
378 #if HAVE_FLOCK
379                 if (flock(lockfd, LOCK_EX|LOCK_NB) < 0 && !fcntled) {
380                         perror("flock");
381 #else
382 #if HAVE_LOCKF
383                 if (lockf(lockfd, F_TLOCK, 0) < 0 && !fcntled) {
384                         perror("lockf");
385 #else
386                 {
387 #endif
388 #endif /* HAVE_FLOCK */
389                         g_warning("can't lock %s\n", base);
390                         if (close(lockfd) < 0)
391                                 perror("close");
392                         return -1;
393                 }
394                 retval = lockfd;
395         } else {
396                 g_warning("invalid lock type\n");
397                 return -1;
398         }
399
400         return retval;
401 #else
402         return -1;
403 #endif /* G_OS_UNIX */
404 }
405
406 gint unlock_mbox(const gchar *base, gint fd, LockType type)
407 {
408         if (type == LOCK_FILE) {
409                 gchar *lockfile;
410
411                 lockfile = g_strconcat(base, ".lock", NULL);
412                 if (claws_unlink(lockfile) < 0) {
413                         FILE_OP_ERROR(lockfile, "unlink");
414                         g_free(lockfile);
415                         return -1;
416                 }
417                 g_free(lockfile);
418
419                 return 0;
420         } else if (type == LOCK_FLOCK) {
421                 gboolean fcntled = FALSE;
422 #if HAVE_FCNTL_H && !defined(G_OS_WIN32)
423                 struct flock fl;
424                 fl.l_type = F_UNLCK;
425                 fl.l_whence = SEEK_SET;
426                 fl.l_start = 0;
427                 fl.l_len = 0;
428
429                 if (fcntl(fd, F_SETLK, &fl) == -1) {
430                         g_warning("can't fnctl %s", base);
431                 } else {
432                         fcntled = TRUE;
433                 }
434 #endif
435 #if HAVE_FLOCK
436                 if (flock(fd, LOCK_UN) < 0 && !fcntled) {
437                         perror("flock");
438 #else
439 #if HAVE_LOCKF
440                 if (lockf(fd, F_ULOCK, 0) < 0 && !fcntled) {
441                         perror("lockf");
442 #else
443                 {
444 #endif
445 #endif /* HAVE_FLOCK */
446                         g_warning("can't unlock %s\n", base);
447                         if (close(fd) < 0)
448                                 perror("close");
449                         return -1;
450                 }
451
452                 if (close(fd) < 0) {
453                         perror("close");
454                         return -1;
455                 }
456
457                 return 0;
458         }
459
460         g_warning("invalid lock type\n");
461         return -1;
462 }
463
464 gint copy_mbox(gint srcfd, const gchar *dest)
465 {
466         FILE *dest_fp;
467         ssize_t n_read;
468         gchar buf[BUFSIZ];
469         gboolean err = FALSE;
470         int save_errno = 0;
471
472         if (srcfd < 0) {
473                 return -1;
474         }
475
476         if ((dest_fp = g_fopen(dest, "wb")) == NULL) {
477                 FILE_OP_ERROR(dest, "fopen");
478                 return -1;
479         }
480
481         if (change_file_mode_rw(dest_fp, dest) < 0) {
482                 FILE_OP_ERROR(dest, "chmod");
483                 g_warning("can't change file mode\n");
484         }
485
486         while ((n_read = read(srcfd, buf, sizeof(buf))) > 0) {
487                 if (n_read == -1 && errno != 0) {
488                         save_errno = errno;
489                         break;
490                 }
491                 if (fwrite(buf, 1, n_read, dest_fp) < n_read) {
492                         g_warning("writing to %s failed.\n", dest);
493                         fclose(dest_fp);
494                         claws_unlink(dest);
495                         return -1;
496                 }
497         }
498
499         if (save_errno != 0) {
500                 g_warning("error %d reading mbox: %s\n", save_errno,
501                                 strerror(save_errno));
502                 err = TRUE;
503         }
504
505         if (fclose(dest_fp) == EOF) {
506                 FILE_OP_ERROR(dest, "fclose");
507                 err = TRUE;
508         }
509
510         if (err) {
511                 claws_unlink(dest);
512                 return -1;
513         }
514
515         return 0;
516 }
517
518 void empty_mbox(const gchar *mbox)
519 {
520         FILE *fp;
521
522         if ((fp = g_fopen(mbox, "wb")) == NULL) {
523                 FILE_OP_ERROR(mbox, "fopen");
524                 g_warning("can't truncate mailbox to zero.\n");
525                 return;
526         }
527         fclose(fp);
528 }
529
530 gint export_list_to_mbox(GSList *mlist, const gchar *mbox)
531 /* return values: -2 skipped, -1 error, 0 OK */
532 {
533         GSList *cur;
534         MsgInfo *msginfo;
535         FILE *msg_fp;
536         FILE *mbox_fp;
537         gchar buf[BUFFSIZE];
538         int err = 0;
539
540         gint msgs = 1, total = g_slist_length(mlist);
541         if (g_file_test(mbox, G_FILE_TEST_EXISTS) == TRUE) {
542                 if (alertpanel_full(_("Overwrite mbox file"),
543                                         _("This file already exists. Do you want to overwrite it?"),
544                                         GTK_STOCK_CANCEL, _("Overwrite"), NULL, FALSE,
545                                         NULL, ALERT_WARNING, G_ALERTDEFAULT)
546                                 != G_ALERTALTERNATE) {
547                         return -2;
548                 }
549         }
550
551         if ((mbox_fp = g_fopen(mbox, "wb")) == NULL) {
552                 FILE_OP_ERROR(mbox, "fopen");
553                 alertpanel_error(_("Could not create mbox file:\n%s\n"), mbox);
554                 return -1;
555         }
556
557 #ifdef HAVE_FGETS_UNLOCKED
558         flockfile(mbox_fp);
559 #endif
560
561         statuswindow_print_all(_("Exporting to mbox..."));
562         for (cur = mlist; cur != NULL; cur = cur->next) {
563                 int len;
564                 gchar buft[BUFFSIZE];
565                 msginfo = (MsgInfo *)cur->data;
566
567                 msg_fp = procmsg_open_message(msginfo);
568                 if (!msg_fp) {
569                         continue;
570                 }
571
572 #ifdef HAVE_FGETS_UNLOCKED
573                 flockfile(msg_fp);
574 #endif
575                 strncpy2(buf,
576                          msginfo->from ? msginfo->from :
577                          cur_account && cur_account->address ?
578                          cur_account->address : "unknown",
579                          sizeof(buf));
580                 extract_address(buf);
581
582                 if (fprintf(mbox_fp, "From %s %s",
583                         buf, ctime_r(&msginfo->date_t, buft)) < 0) {
584                         err = -1;
585 #ifdef HAVE_FGETS_UNLOCKED
586                         funlockfile(msg_fp);
587 #endif
588                         fclose(msg_fp);
589                         goto out;
590                 }
591
592                 buf[0] = '\0';
593                 
594                 /* write email to mboxrc */
595                 while (SC_FGETS(buf, sizeof(buf), msg_fp) != NULL) {
596                         /* quote any From, >From, >>From, etc., according to mbox format specs */
597                         int offset;
598
599                         offset = 0;
600                         /* detect leading '>' char(s) */
601                         while ((buf[offset] == '>')) {
602                                 offset++;
603                         }
604                         if (!strncmp(buf+offset, "From ", 5)) {
605                                 if (SC_FPUTC('>', mbox_fp) == EOF) {
606                                         err = -1;
607 #ifdef HAVE_FGETS_UNLOCKED
608                                         funlockfile(msg_fp);
609 #endif
610                                         fclose(msg_fp);
611                                         goto out;
612                                 }
613                         }
614                         if (SC_FPUTS(buf, mbox_fp) == EOF) {
615                                 err = -1;
616 #ifdef HAVE_FGETS_UNLOCKED
617                                 funlockfile(msg_fp);
618 #endif
619                                 fclose(msg_fp);
620                                 goto out;
621                         }
622                 }
623
624                 /* force last line to end w/ a newline */
625                 len = strlen(buf);
626                 if (len > 0) {
627                         len--;
628                         if ((buf[len] != '\n') && (buf[len] != '\r')) {
629                                 if (SC_FPUTC('\n', mbox_fp) == EOF) {
630                                         err = -1;
631 #ifdef HAVE_FGETS_UNLOCKED
632                                         funlockfile(msg_fp);
633 #endif
634                                         fclose(msg_fp);
635                                         goto out;
636                                 }
637                         }
638                 }
639
640                 /* add a trailing empty line */
641                 if (SC_FPUTC('\n', mbox_fp) == EOF) {
642                         err = -1;
643 #ifdef HAVE_FGETS_UNLOCKED
644                         funlockfile(msg_fp);
645 #endif
646                         fclose(msg_fp);
647                         goto out;
648                 }
649
650 #ifdef HAVE_FGETS_UNLOCKED
651                 funlockfile(msg_fp);
652 #endif
653                 fclose(msg_fp);
654                 statusbar_progress_all(msgs++,total, 500);
655                 if (msgs%500 == 0)
656                         GTK_EVENTS_FLUSH();
657         }
658
659 out:
660         statusbar_progress_all(0,0,0);
661         statuswindow_pop_all();
662
663 #ifdef HAVE_FGETS_UNLOCKED
664         funlockfile(mbox_fp);
665 #endif
666         fclose(mbox_fp);
667
668         return err;
669 }
670
671 /* read all messages in SRC, and store them into one MBOX file. */
672 /* return values: -2 skipped, -1 error, 0 OK */
673 gint export_to_mbox(FolderItem *src, const gchar *mbox)
674 {
675         GSList *mlist;
676         gint ret;
677         
678         g_return_val_if_fail(src != NULL, -1);
679         g_return_val_if_fail(src->folder != NULL, -1);
680         g_return_val_if_fail(mbox != NULL, -1);
681
682         debug_print("Exporting messages from %s into %s...\n",
683                     src->path, mbox);
684
685         mlist = folder_item_get_msg_list(src);
686
687         folder_item_update_freeze();
688         ret = export_list_to_mbox(mlist, mbox);
689         folder_item_update_thaw();
690
691         procmsg_msg_list_free(mlist);
692
693         return ret;
694 }