/
external.c
1224 lines (1076 loc) · 32.5 KB
/
external.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @file
* Manage where the email is piped to external commands
*
* @authors
* Copyright (C) 2017-2023 Richard Russon <rich@flatcap.org>
* Copyright (C) 2018-2023 Pietro Cerutti <gahr@gahr.ch>
* Copyright (C) 2021 Eric Blake <eblake@redhat.com>
* Copyright (C) 2021 Ihor Antonov <ihor@antonovs.family>
*
* @copyright
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation, either version 2 of the License, or (at your option) any later
* version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along with
* this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @page neo_external Manage where the email is piped to external commands
*
* Manage where the email is piped to external commands
*/
#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#include <sys/stat.h>
#include <sys/types.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "alias/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "external.h"
#include "attach/lib.h"
#include "browser/lib.h"
#include "complete/lib.h"
#include "editor/lib.h"
#include "history/lib.h"
#include "imap/lib.h"
#include "ncrypt/lib.h"
#include "parse/lib.h"
#include "progress/lib.h"
#include "question/lib.h"
#include "send/lib.h"
#include "copy.h"
#include "globals.h"
#include "hook.h"
#include "mutt_logging.h"
#include "mutt_mailbox.h"
#include "mutt_thread.h"
#include "muttlib.h"
#include "mx.h"
#include "protos.h"
#ifdef USE_NOTMUCH
#include "notmuch/lib.h"
#endif
#ifdef ENABLE_NLS
#include <libintl.h>
#endif
/// The folder the user last saved to. Used by ci_save_message()
static struct Buffer LastSaveFolder = { 0 };
/**
* external_cleanup - Clean up commands globals
*/
void external_cleanup(void)
{
buf_dealloc(&LastSaveFolder);
}
/**
* index_bounce_message - Bounce an email
* @param m Mailbox
* @param ea Array of Emails to bounce
*/
void index_bounce_message(struct Mailbox *m, struct EmailArray *ea)
{
if (!m || !ea || ARRAY_EMPTY(ea))
return;
struct Buffer *buf = buf_pool_get();
struct Buffer *prompt = buf_pool_get();
struct AddressList al = TAILQ_HEAD_INITIALIZER(al);
char *err = NULL;
int rc;
int msg_count = 0;
struct Email **ep = NULL;
ARRAY_FOREACH(ep, ea)
{
struct Email *e = *ep;
/* RFC5322 mandates a From: header,
* so warn before bouncing messages without one */
if (TAILQ_EMPTY(&e->env->from))
mutt_error(_("Warning: message contains no From: header"));
msg_count++;
}
if (msg_count == 1)
buf_strcpy(prompt, _("Bounce message to: "));
else
buf_strcpy(prompt, _("Bounce tagged messages to: "));
rc = mw_get_field(buf_string(prompt), buf, MUTT_COMP_NO_FLAGS, HC_ALIAS,
&CompleteAliasOps, NULL);
if ((rc != 0) || buf_is_empty(buf))
goto done;
mutt_addrlist_parse2(&al, buf_string(buf));
if (TAILQ_EMPTY(&al))
{
mutt_error(_("Error parsing address"));
goto done;
}
mutt_expand_aliases(&al);
if (mutt_addrlist_to_intl(&al, &err) < 0)
{
mutt_error(_("Bad IDN: '%s'"), err);
FREE(&err);
goto done;
}
buf_reset(buf);
mutt_addrlist_write(&al, buf, true);
buf_printf(prompt, ngettext("Bounce message to %s?", "Bounce messages to %s?", msg_count),
buf_string(buf));
if (query_quadoption(buf_string(prompt), NeoMutt->sub, "bounce") != MUTT_YES)
{
msgwin_clear_text(NULL);
mutt_message(ngettext("Message not bounced", "Messages not bounced", msg_count));
goto done;
}
msgwin_clear_text(NULL);
struct Message *msg = NULL;
ARRAY_FOREACH(ep, ea)
{
struct Email *e = *ep;
msg = mx_msg_open(m, e);
if (!msg)
{
rc = -1;
break;
}
rc = mutt_bounce_message(msg->fp, m, e, &al, NeoMutt->sub);
mx_msg_close(m, &msg);
if (rc < 0)
break;
}
/* If no error, or background, display message. */
if ((rc == 0) || (rc == S_BKG))
mutt_message(ngettext("Message bounced", "Messages bounced", msg_count));
done:
mutt_addrlist_clear(&al);
buf_pool_release(&buf);
buf_pool_release(&prompt);
}
/**
* pipe_set_flags - Generate flags for copy header/message
* @param[in] decode If true decode the message
* @param[in] print If true, mark the message for printing
* @param[out] cmflags Flags, see #CopyMessageFlags
* @param[out] chflags Flags, see #CopyHeaderFlags
*/
static void pipe_set_flags(bool decode, bool print, CopyMessageFlags *cmflags,
CopyHeaderFlags *chflags)
{
if (decode)
{
*chflags |= CH_DECODE | CH_REORDER;
*cmflags |= MUTT_CM_DECODE | MUTT_CM_CHARCONV;
const bool c_print_decode_weed = cs_subset_bool(NeoMutt->sub, "print_decode_weed");
const bool c_pipe_decode_weed = cs_subset_bool(NeoMutt->sub, "pipe_decode_weed");
if (print ? c_print_decode_weed : c_pipe_decode_weed)
{
*chflags |= CH_WEED;
*cmflags |= MUTT_CM_WEED;
}
/* Just as with copy-decode, we need to update the mime fields to avoid
* confusing programs that may process the email. However, we don't want
* to force those fields to appear in printouts. */
if (!print)
*chflags |= CH_MIME | CH_TXTPLAIN;
}
if (print)
*cmflags |= MUTT_CM_PRINTING;
}
/**
* pipe_msg - Pipe a message
* @param m Mailbox
* @param e Email to pipe
* @param msg Message
* @param fp File to write to
* @param decode If true, decode the message
* @param print If true, message is for printing
*/
static void pipe_msg(struct Mailbox *m, struct Email *e, struct Message *msg,
FILE *fp, bool decode, bool print)
{
CopyMessageFlags cmflags = MUTT_CM_NO_FLAGS;
CopyHeaderFlags chflags = CH_FROM;
pipe_set_flags(decode, print, &cmflags, &chflags);
if ((WithCrypto != 0) && decode && e->security & SEC_ENCRYPT)
{
if (!crypt_valid_passphrase(e->security))
return;
mutt_endwin();
}
const bool own_msg = !msg;
if (own_msg)
{
msg = mx_msg_open(m, e);
if (!msg)
{
return;
}
}
if (decode)
{
mutt_parse_mime_message(e, msg->fp);
}
mutt_copy_message(fp, e, msg, cmflags, chflags, 0);
if (own_msg)
{
mx_msg_close(m, &msg);
}
}
/**
* pipe_message - Pipe message to a command
* @param m Mailbox
* @param ea Array of Emails to pipe
* @param cmd Command to pipe to
* @param decode Should the message be decrypted
* @param print True if this is a print job
* @param split Should a separator be sent between messages?
* @param sep Separator string
* @retval 0 Success
* @retval 1 Error
*
* The following code is shared between printing and piping.
*/
static int pipe_message(struct Mailbox *m, struct EmailArray *ea, const char *cmd,
bool decode, bool print, bool split, const char *sep)
{
if (!m || !ea || ARRAY_EMPTY(ea))
return 1;
int rc = 0;
pid_t pid;
FILE *fp_out = NULL;
if (ARRAY_SIZE(ea) == 1)
{
struct Email *e = *ARRAY_GET(ea, 0);
/* handle a single message */
mutt_message_hook(m, e, MUTT_MESSAGE_HOOK);
struct Message *msg = mx_msg_open(m, e);
if (msg && (WithCrypto != 0) && decode)
{
mutt_parse_mime_message(e, msg->fp);
if ((e->security & SEC_ENCRYPT) && !crypt_valid_passphrase(e->security))
{
mx_msg_close(m, &msg);
return 1;
}
}
mutt_endwin();
pid = filter_create(cmd, &fp_out, NULL, NULL, EnvList);
if (pid < 0)
{
mutt_perror(_("Can't create filter process"));
mx_msg_close(m, &msg);
return 1;
}
OptKeepQuiet = true;
pipe_msg(m, e, msg, fp_out, decode, print);
mx_msg_close(m, &msg);
mutt_file_fclose(&fp_out);
rc = filter_wait(pid);
OptKeepQuiet = false;
}
else
{
/* handle tagged messages */
if ((WithCrypto != 0) && decode)
{
struct Email **ep = NULL;
ARRAY_FOREACH(ep, ea)
{
struct Email *e = *ep;
struct Message *msg = mx_msg_open(m, e);
if (msg)
{
mutt_parse_mime_message(e, msg->fp);
mutt_message_hook(m, e, MUTT_MESSAGE_HOOK);
mx_msg_close(m, &msg);
}
if ((e->security & SEC_ENCRYPT) && !crypt_valid_passphrase(e->security))
{
return 1;
}
}
}
if (split)
{
struct Email **ep = NULL;
ARRAY_FOREACH(ep, ea)
{
struct Email *e = *ep;
mutt_message_hook(m, e, MUTT_MESSAGE_HOOK);
mutt_endwin();
pid = filter_create(cmd, &fp_out, NULL, NULL, EnvList);
if (pid < 0)
{
mutt_perror(_("Can't create filter process"));
return 1;
}
OptKeepQuiet = true;
pipe_msg(m, e, NULL, fp_out, decode, print);
/* add the message separator */
if (sep)
fputs(sep, fp_out);
mutt_file_fclose(&fp_out);
if (filter_wait(pid) != 0)
rc = 1;
OptKeepQuiet = false;
}
}
else
{
mutt_endwin();
pid = filter_create(cmd, &fp_out, NULL, NULL, EnvList);
if (pid < 0)
{
mutt_perror(_("Can't create filter process"));
return 1;
}
OptKeepQuiet = true;
struct Email **ep = NULL;
ARRAY_FOREACH(ep, ea)
{
struct Email *e = *ep;
mutt_message_hook(m, e, MUTT_MESSAGE_HOOK);
pipe_msg(m, e, NULL, fp_out, decode, print);
/* add the message separator */
if (sep)
fputs(sep, fp_out);
}
mutt_file_fclose(&fp_out);
if (filter_wait(pid) != 0)
rc = 1;
OptKeepQuiet = false;
}
}
const bool c_wait_key = cs_subset_bool(NeoMutt->sub, "wait_key");
if ((rc != 0) || c_wait_key)
mutt_any_key_to_continue(NULL);
return rc;
}
/**
* mutt_pipe_message - Pipe a message
* @param m Mailbox
* @param ea Array of Emails to pipe
*/
void mutt_pipe_message(struct Mailbox *m, struct EmailArray *ea)
{
if (!m || !ea)
return;
struct Buffer *buf = buf_pool_get();
if (mw_get_field(_("Pipe to command: "), buf, MUTT_COMP_NO_FLAGS,
HC_EXT_COMMAND, &CompleteFileOps, NULL) != 0)
{
goto cleanup;
}
if (buf_is_empty(buf))
goto cleanup;
buf_expand_path(buf);
const bool c_pipe_decode = cs_subset_bool(NeoMutt->sub, "pipe_decode");
const bool c_pipe_split = cs_subset_bool(NeoMutt->sub, "pipe_split");
const char *const c_pipe_sep = cs_subset_string(NeoMutt->sub, "pipe_sep");
pipe_message(m, ea, buf_string(buf), c_pipe_decode, false, c_pipe_split, c_pipe_sep);
cleanup:
buf_pool_release(&buf);
}
/**
* mutt_print_message - Print a message
* @param m Mailbox
* @param ea Array of Emails to print
*/
void mutt_print_message(struct Mailbox *m, struct EmailArray *ea)
{
if (!m || !ea)
return;
const enum QuadOption c_print = cs_subset_quad(NeoMutt->sub, "print");
const char *const c_print_command = cs_subset_string(NeoMutt->sub, "print_command");
if (c_print && !c_print_command)
{
mutt_message(_("No printing command has been defined"));
return;
}
int msg_count = ARRAY_SIZE(ea);
const char *msg = ngettext("Print message?", "Print tagged messages?", msg_count);
if (query_quadoption(msg, NeoMutt->sub, "print") != MUTT_YES)
{
return;
}
const bool c_print_decode = cs_subset_bool(NeoMutt->sub, "print_decode");
const bool c_print_split = cs_subset_bool(NeoMutt->sub, "print_split");
if (pipe_message(m, ea, c_print_command, c_print_decode, true, c_print_split, "\f") == 0)
{
mutt_message(ngettext("Message printed", "Messages printed", msg_count));
}
else
{
mutt_message(ngettext("Message could not be printed",
"Messages could not be printed", msg_count));
}
}
/**
* mutt_select_sort - Ask the user for a sort method
* @param reverse If true make it a reverse sort
* @retval true The sort type changed
*/
bool mutt_select_sort(bool reverse)
{
enum SortType sort = SORT_DATE;
switch (mw_multi_choice(reverse ?
/* L10N: The highlighted letters must match the "Sort" options */
_("Rev-Sort (d)ate,(f)rm,(r)ecv,(s)ubj,t(o),(t)hread,(u)nsort,si(z)e,s(c)ore,s(p)am,(l)abel?") :
/* L10N: The highlighted letters must match the "Rev-Sort" options */
_("Sort (d)ate,(f)rm,(r)ecv,(s)ubj,t(o),(t)hread,(u)nsort,si(z)e,s(c)ore,s(p)am,(l)abel?"),
/* L10N: These must match the highlighted letters from "Sort" and "Rev-Sort" */
_("dfrsotuzcpl")))
{
case -1: /* abort - don't resort */
return false;
case 1: /* (d)ate */
sort = SORT_DATE;
break;
case 2: /* (f)rm */
sort = SORT_FROM;
break;
case 3: /* (r)ecv */
sort = SORT_RECEIVED;
break;
case 4: /* (s)ubj */
sort = SORT_SUBJECT;
break;
case 5: /* t(o) */
sort = SORT_TO;
break;
case 6: /* (t)hread */
sort = SORT_THREADS;
break;
case 7: /* (u)nsort */
sort = SORT_ORDER;
break;
case 8: /* si(z)e */
sort = SORT_SIZE;
break;
case 9: /* s(c)ore */
sort = SORT_SCORE;
break;
case 10: /* s(p)am */
sort = SORT_SPAM;
break;
case 11: /* (l)abel */
sort = SORT_LABEL;
break;
}
const unsigned char c_use_threads = cs_subset_enum(NeoMutt->sub, "use_threads");
const enum SortType c_sort = cs_subset_sort(NeoMutt->sub, "sort");
int rc = CSR_ERR_CODE;
if ((sort != SORT_THREADS) || (c_use_threads == UT_UNSET))
{
if ((sort != SORT_THREADS) && (c_sort & SORT_LAST))
sort |= SORT_LAST;
if (reverse)
sort |= SORT_REVERSE;
rc = cs_subset_str_native_set(NeoMutt->sub, "sort", sort, NULL);
}
else
{
ASSERT((c_sort & SORT_MASK) != SORT_THREADS); /* See index_config_observer() */
/* Preserve the value of $sort, and toggle whether we are threaded. */
switch (c_use_threads)
{
case UT_FLAT:
rc = cs_subset_str_native_set(NeoMutt->sub, "use_threads",
reverse ? UT_REVERSE : UT_THREADS, NULL);
break;
case UT_THREADS:
rc = cs_subset_str_native_set(NeoMutt->sub, "use_threads",
reverse ? UT_REVERSE : UT_FLAT, NULL);
break;
case UT_REVERSE:
rc = cs_subset_str_native_set(NeoMutt->sub, "use_threads",
reverse ? UT_FLAT : UT_THREADS, NULL);
break;
default:
ASSERT(false);
}
}
return ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE));
}
/**
* mutt_shell_escape - Invoke a command in a subshell
* @retval true A command was invoked (no matter what its result)
* @retval false No command was invoked
*/
bool mutt_shell_escape(void)
{
bool rc = false;
struct Buffer *buf = buf_pool_get();
if (mw_get_field(_("Shell command: "), buf, MUTT_COMP_NO_FLAGS,
HC_EXT_COMMAND, &CompleteFileOps, NULL) != 0)
{
goto done;
}
if (buf_is_empty(buf))
{
const char *const c_shell = cs_subset_string(NeoMutt->sub, "shell");
buf_strcpy(buf, c_shell);
}
if (buf_is_empty(buf))
{
goto done;
}
msgwin_clear_text(NULL);
mutt_endwin();
fflush(stdout);
int rc2 = mutt_system(buf_string(buf));
if (rc2 == -1)
mutt_debug(LL_DEBUG1, "Error running \"%s\"\n", buf_string(buf));
const bool c_wait_key = cs_subset_bool(NeoMutt->sub, "wait_key");
if ((rc2 != 0) || c_wait_key)
mutt_any_key_to_continue(NULL);
rc = true;
done:
buf_pool_release(&buf);
return rc;
}
/**
* mutt_enter_command - Enter a neomutt command
*/
void mutt_enter_command(void)
{
struct Buffer *buf = buf_pool_get();
struct Buffer *err = buf_pool_get();
window_redraw(NULL);
/* if enter is pressed after : with no command, just return */
if ((mw_get_field(":", buf, MUTT_COMP_NO_FLAGS, HC_NEO_COMMAND,
&CompleteCommandOps, NULL) != 0) ||
buf_is_empty(buf))
{
goto done;
}
enum CommandResult rc = parse_rc_line(buf_string(buf), err);
if (!buf_is_empty(err))
{
if (rc == MUTT_CMD_SUCCESS) /* command succeeded with message */
mutt_message("%s", buf_string(err));
else if (rc == MUTT_CMD_ERROR)
mutt_error("%s", buf_string(err));
else if (rc == MUTT_CMD_WARNING)
mutt_warning("%s", buf_string(err));
}
if (NeoMutt)
{
// Running commands could cause anything to change, so let others know
notify_send(NeoMutt->notify, NT_GLOBAL, NT_GLOBAL_COMMAND, NULL);
}
done:
buf_pool_release(&buf);
buf_pool_release(&err);
}
/**
* mutt_display_address - Display the address of a message
* @param env Envelope containing address
*/
void mutt_display_address(struct Envelope *env)
{
const char *pfx = NULL;
struct AddressList *al = mutt_get_address(env, &pfx);
if (!al)
return;
/* Note: We don't convert IDNA to local representation this time.
* That is intentional, so the user has an opportunity to copy &
* paste the on-the-wire form of the address to other, IDN-unable
* software. */
struct Buffer *buf = buf_pool_get();
mutt_addrlist_write(al, buf, false);
mutt_message("%s: %s", pfx, buf_string(buf));
buf_pool_release(&buf);
}
/**
* set_copy_flags - Set the flags for a message copy
* @param[in] e Email
* @param[in] transform_opt Transformation, e.g. #TRANSFORM_DECRYPT
* @param[out] cmflags Flags, see #CopyMessageFlags
* @param[out] chflags Flags, see #CopyHeaderFlags
*/
static void set_copy_flags(struct Email *e, enum MessageTransformOpt transform_opt,
CopyMessageFlags *cmflags, CopyHeaderFlags *chflags)
{
*cmflags = MUTT_CM_NO_FLAGS;
*chflags = CH_UPDATE_LEN;
const bool need_decrypt = (transform_opt == TRANSFORM_DECRYPT) &&
(e->security & SEC_ENCRYPT);
const bool want_pgp = (WithCrypto & APPLICATION_PGP);
const bool want_smime = (WithCrypto & APPLICATION_SMIME);
const bool is_pgp = mutt_is_application_pgp(e->body) & SEC_ENCRYPT;
const bool is_smime = mutt_is_application_smime(e->body) & SEC_ENCRYPT;
if (need_decrypt && want_pgp && mutt_is_multipart_encrypted(e->body))
{
*chflags = CH_NONEWLINE | CH_XMIT | CH_MIME;
*cmflags = MUTT_CM_DECODE_PGP;
}
else if (need_decrypt && want_pgp && is_pgp)
{
*chflags = CH_XMIT | CH_MIME | CH_TXTPLAIN;
*cmflags = MUTT_CM_DECODE | MUTT_CM_CHARCONV;
}
else if (need_decrypt && want_smime && is_smime)
{
*chflags = CH_NONEWLINE | CH_XMIT | CH_MIME;
*cmflags = MUTT_CM_DECODE_SMIME;
}
else if (transform_opt == TRANSFORM_DECODE)
{
*chflags = CH_XMIT | CH_MIME | CH_TXTPLAIN | CH_DECODE; // then decode RFC2047
*cmflags = MUTT_CM_DECODE | MUTT_CM_CHARCONV;
const bool c_copy_decode_weed = cs_subset_bool(NeoMutt->sub, "copy_decode_weed");
if (c_copy_decode_weed)
{
*chflags |= CH_WEED; // and respect $weed
*cmflags |= MUTT_CM_WEED;
}
}
}
/**
* mutt_save_message_mbox - Save a message to a given mailbox
* @param m_src Mailbox to copy from
* @param e Email
* @param save_opt Copy or move, e.g. #SAVE_MOVE
* @param transform_opt Transformation, e.g. #TRANSFORM_DECRYPT
* @param m_dst Mailbox to save to
* @retval 0 Success
* @retval -1 Error
*/
int mutt_save_message_mbox(struct Mailbox *m_src, struct Email *e, enum MessageSaveOpt save_opt,
enum MessageTransformOpt transform_opt, struct Mailbox *m_dst)
{
CopyMessageFlags cmflags = MUTT_CM_NO_FLAGS;
CopyHeaderFlags chflags = CH_NO_FLAGS;
int rc;
set_copy_flags(e, transform_opt, &cmflags, &chflags);
struct Message *msg = mx_msg_open(m_src, e);
if (msg && transform_opt != TRANSFORM_NONE)
{
mutt_parse_mime_message(e, msg->fp);
}
rc = mutt_append_message(m_dst, m_src, e, msg, cmflags, chflags);
mx_msg_close(m_src, &msg);
if (rc != 0)
return rc;
if (save_opt == SAVE_MOVE)
{
mutt_set_flag(m_src, e, MUTT_DELETE, true, true);
mutt_set_flag(m_src, e, MUTT_PURGE, true, true);
const bool c_delete_untag = cs_subset_bool(NeoMutt->sub, "delete_untag");
if (c_delete_untag)
mutt_set_flag(m_src, e, MUTT_TAG, false, true);
}
return 0;
}
/**
* mutt_save_message - Save an email
* @param m Mailbox
* @param ea Array of Emails to save
* @param save_opt Copy or move, e.g. #SAVE_MOVE
* @param transform_opt Transformation, e.g. #TRANSFORM_DECRYPT
* @retval 0 Copy/save was successful
* @retval -1 Error/abort
*/
int mutt_save_message(struct Mailbox *m, struct EmailArray *ea,
enum MessageSaveOpt save_opt, enum MessageTransformOpt transform_opt)
{
if (!ea || ARRAY_EMPTY(ea))
return -1;
int rc = -1;
int tagged_progress_count = 0;
unsigned int msg_count = ARRAY_SIZE(ea);
struct Mailbox *m_save = NULL;
struct Buffer *buf = buf_pool_get();
struct stat st = { 0 };
struct Email *e_cur = *ARRAY_GET(ea, 0);
const SecurityFlags security_flags = WithCrypto ? e_cur->security : SEC_NO_FLAGS;
const bool is_passphrase_needed = security_flags & SEC_ENCRYPT;
const char *prompt = NULL;
const char *progress_msg = NULL;
// Set prompt and progress_msg
switch (save_opt)
{
case SAVE_COPY:
// L10N: Progress meter message when copying tagged messages
progress_msg = (msg_count > 1) ? _("Copying tagged messages...") : NULL;
switch (transform_opt)
{
case TRANSFORM_NONE:
prompt = (msg_count > 1) ? _("Copy tagged to mailbox") : _("Copy to mailbox");
break;
case TRANSFORM_DECRYPT:
prompt = (msg_count > 1) ? _("Decrypt-copy tagged to mailbox") :
_("Decrypt-copy to mailbox");
break;
case TRANSFORM_DECODE:
prompt = (msg_count > 1) ? _("Decode-copy tagged to mailbox") :
_("Decode-copy to mailbox");
break;
}
break;
case SAVE_MOVE:
// L10N: Progress meter message when saving tagged messages
progress_msg = (msg_count > 1) ? _("Saving tagged messages...") : NULL;
switch (transform_opt)
{
case TRANSFORM_NONE:
prompt = (msg_count > 1) ? _("Save tagged to mailbox") : _("Save to mailbox");
break;
case TRANSFORM_DECRYPT:
prompt = (msg_count > 1) ? _("Decrypt-save tagged to mailbox") :
_("Decrypt-save to mailbox");
break;
case TRANSFORM_DECODE:
prompt = (msg_count > 1) ? _("Decode-save tagged to mailbox") :
_("Decode-save to mailbox");
break;
}
break;
}
mutt_message_hook(m, e_cur, MUTT_MESSAGE_HOOK);
mutt_default_save(buf, e_cur);
buf_pretty_mailbox(buf);
if (mw_enter_fname(prompt, buf, false, NULL, false, NULL, NULL, MUTT_SEL_NO_FLAGS) == -1)
{
goto cleanup;
}
size_t pathlen = buf_len(buf);
if (pathlen == 0)
goto cleanup;
mutt_path_tidy(buf, true);
/* This is an undocumented feature of ELM pointed out to me by Felix von
* Leitner <leitner@prz.fu-berlin.de> */
if (buf_is_empty(&LastSaveFolder))
buf_alloc(&LastSaveFolder, PATH_MAX);
if (mutt_str_equal(buf_string(buf), "."))
buf_copy(buf, &LastSaveFolder);
else
buf_strcpy(&LastSaveFolder, buf_string(buf));
buf_expand_path(buf);
/* check to make sure that this file is really the one the user wants */
if (mutt_save_confirm(buf_string(buf), &st) != 0)
goto cleanup;
if (is_passphrase_needed && (transform_opt != TRANSFORM_NONE) &&
!crypt_valid_passphrase(security_flags))
{
rc = -1;
goto errcleanup;
}
mutt_message(_("Copying to %s..."), buf_string(buf));
enum MailboxType mailbox_type = imap_path_probe(buf_string(buf), NULL);
if ((m->type == MUTT_IMAP) && (transform_opt == TRANSFORM_NONE) && (mailbox_type == MUTT_IMAP))
{
rc = imap_copy_messages(m, ea, buf_string(buf), save_opt);
switch (rc)
{
/* success */
case 0:
mutt_clear_error();
rc = 0;
if (save_opt == SAVE_MOVE)
{
const bool c_delete_untag = cs_subset_bool(NeoMutt->sub, "delete_untag");
if (c_delete_untag)
{
struct Email **ep = NULL;
ARRAY_FOREACH(ep, ea)
{
mutt_set_flag(m, *ep, MUTT_TAG, false, true);
}
}
}
goto cleanup;
/* non-fatal error: continue to fetch/append */
case 1:
break;
/* fatal error, abort */
case -1:
goto errcleanup;
}
}
mutt_file_resolve_symlink(buf);
m_save = mx_path_resolve(buf_string(buf));
bool old_append = m_save->append;
OpenMailboxFlags mbox_flags = MUTT_NEWFOLDER;
/* Display a tagged message progress counter, rather than (for
* IMAP) a per-message progress counter */
if (msg_count > 1)
mbox_flags |= MUTT_QUIET;
if (!mx_mbox_open(m_save, mbox_flags))
{
rc = -1;
mailbox_free(&m_save);
goto errcleanup;
}
m_save->append = true;
/* If we're saving to a compressed mailbox, the stats won't be updated
* until the next open. Until then, improvise. */
struct Mailbox *m_comp = NULL;
if (m_save->compress_info)
{
m_comp = mailbox_find(m_save->realpath);
}
/* We probably haven't been opened yet */
if (m_comp && (m_comp->msg_count == 0))
m_comp = NULL;
if (msg_count == 1)
{
rc = mutt_save_message_mbox(m, e_cur, save_opt, transform_opt, m_save);
if (rc != 0)
{
mx_mbox_close(m_save);
m_save->append = old_append;
goto errcleanup;
}
if (m_comp)
{
m_comp->msg_count++;
if (!e_cur->read)
{
m_comp->msg_unread++;
if (!e_cur->old)
m_comp->msg_new++;
}
if (e_cur->flagged)
m_comp->msg_flagged++;
}
}
else
{
rc = 0;
#ifdef USE_NOTMUCH
if (m->type == MUTT_NOTMUCH)
nm_db_longrun_init(m, true);
#endif
struct Progress *progress = progress_new(MUTT_PROGRESS_WRITE, msg_count);
progress_set_message(progress, "%s", progress_msg);
struct Email **ep = NULL;
ARRAY_FOREACH(ep, ea)
{
struct Email *e = *ep;
progress_update(progress, ++tagged_progress_count, -1);
mutt_message_hook(m, e, MUTT_MESSAGE_HOOK);
rc = mutt_save_message_mbox(m, e, save_opt, transform_opt, m_save);
if (rc != 0)
break;
if (m_comp)
{
struct Email *e2 = e;
m_comp->msg_count++;
if (!e2->read)
{
m_comp->msg_unread++;
if (!e2->old)
m_comp->msg_new++;
}
if (e2->flagged)
m_comp->msg_flagged++;
}
}
progress_free(&progress);
#ifdef USE_NOTMUCH
if (m->type == MUTT_NOTMUCH)
nm_db_longrun_done(m);