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