2 # Copyright (C) 2019-2020 all contributors <meta@public-inbox.org>
3 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
5 # Used for editing messages in a public-inbox.
6 # Supports v2 inboxes only, for now.
9 use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
10 use PublicInbox::AdminEdit;
11 use File::Temp 0.19 (); # 0.19 for TMPDIR
12 use PublicInbox::ContentId qw(content_id);
13 use PublicInbox::MID qw(mid_clean mids);
14 PublicInbox::Admin::check_require('-index');
15 use PublicInbox::MIME;
16 use PublicInbox::InboxWritable;
17 use PublicInbox::Import;
19 my $usage = "$0 -m MESSAGE_ID [--all] [INBOX_DIRS]";
20 my $opt = { verbose => 1, all => 0, -min_inbox_version => 2, raw => 0 };
21 my @opt = qw(mid|m=s file|F=s raw);
22 GetOptions($opt, @PublicInbox::AdminEdit::OPT, @opt) or
23 die "bad command-line args\n$usage\n";
25 my $cfg = eval { PublicInbox::Config->new };
26 my $editor = $ENV{MAIL_EDITOR}; # e.g. "mutt -f"
27 unless (defined $editor) {
28 my $k = 'publicinbox.mailEditor';
29 $editor = $cfg->{lc($k)} if $cfg;
30 unless (defined $editor) {
31 warn "\`$k' not configured, trying \`git var GIT_EDITOR'\n";
32 chomp($editor = `git var GIT_EDITOR`);
33 warn "Will use $editor to edit mail\n";
37 my $mid = $opt->{mid};
38 my $file = $opt->{file};
39 if (defined $mid && defined $file) {
40 die "the --mid and --file options are mutually exclusive\n";
43 my @ibxs = PublicInbox::Admin::resolve_inboxes(\@ARGV, $opt, $cfg);
44 PublicInbox::AdminEdit::check_editable(\@ibxs);
46 my $found = {}; # cid => [ [ibx, smsg] [, [ibx, smsg] ] ]
49 my ($found, $mid, $ibxs) = @_;
50 foreach my $ibx (@$ibxs) {
51 my $over = $ibx->over;
53 while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
54 my $ref = $ibx->msg_by_smsg($smsg);
55 my $mime = PublicInbox::MIME->new($ref);
56 my $cid = content_id($mime);
57 my $tuple = [ $ibx, $smsg ];
58 push @{$found->{$cid} ||= []}, $tuple
60 PublicInbox::InboxWritable::cleanup($ibx);
66 my ($ibx, $smsg) = @_;
67 " GIT_DIR=$ibx->{inboxdir}/all.git \\\n git show $smsg->{blob}\n";
72 foreach my $to_edit (values %$found) {
73 foreach my $tuple (@$to_edit) {
74 my ($ibx, $smsg) = @$tuple;
75 warn show_cmd($ibx, $smsg);
81 $mid = mid_clean($mid);
82 find_mid($found, $mid, \@ibxs);
83 my $nr = scalar(keys %$found);
84 die "No message found for <$mid>\n" unless $nr;
87 Multiple messages with different content found matching
91 die "Use --force to edit all of them\n" if !$opt->{force};
92 warn "Will edit all of them\n";
95 open my $fh, '<', $file or die "open($file) failed: $!";
96 my $orig = do { local $/; <$fh> };
97 my $mime = PublicInbox::MIME->new(\$orig);
98 my $mids = mids($mime->header_obj);
99 find_mid($found, $_, \@ibxs) for (@$mids); # populates $found
100 my $cid = content_id($mime);
101 my $to_edit = $found->{$cid};
103 my $nr = scalar(keys %$found);
106 $nr matches to Message-ID(s) in $file, but none matched content
107 Partial matches below:
111 $mids = join('', map { " <$_>\n" } @$mids);
113 No matching messages found matching Message-ID(s) in $file
119 $found = { $cid => $to_edit };
123 TEMPLATE => 'public-inbox-edit-XXXXXX',
125 SUFFIX => $opt->{raw} ? '.eml' : '.mbox',
128 foreach my $to_edit (values %$found) {
129 my $edit_fh = File::Temp->new(%tmpopt);
130 $edit_fh->autoflush(1);
131 my $edit_fn = $edit_fh->filename;
132 my ($ibx, $smsg) = @{$to_edit->[0]};
133 my $old_raw = $ibx->msg_by_smsg($smsg);
134 PublicInbox::InboxWritable::cleanup($ibx);
138 my $oid = $smsg->{blob};
139 print $edit_fh "From mboxrd\@$oid Thu Jan 1 00:00:00 1970\n"
140 or die "failed to write From_ line: $!";
141 $tmp =~ s/^(>*From )/>$1/gm;
143 print $edit_fh $tmp or
144 die "failed to write tempfile for editing: $!";
146 # run the editor, respecting spaces/quote
148 if (system(qw(sh -c), $editor.' "$@"', $editor, $edit_fn)) {
149 if (!(-t STDIN) && !$opt->{force}) {
150 die "E: $editor failed: $?\n";
152 print STDERR "$editor failed, ";
153 print STDERR "continuing as forced\n" if $opt->{force};
154 while (!$opt->{force}) {
155 print STDERR "(r)etry, (c)ontinue, (q)uit?\n";
156 chomp(my $op = <STDIN> || '');
158 goto retry_edit if $op eq 'r';
160 # n.b. we'll lose the exit signal, here,
161 # oh well; "q" is user-specified anyways.
164 last if $op eq 'c'; # continuing
165 print STDERR "\`$op' not recognized\n";
169 # reread the edited file, not using $edit_fh since $EDITOR may
170 # rename/relink $edit_fn
171 open my $new_fh, '<', $edit_fn or
172 die "can't read edited file ($edit_fn): $!\n";
173 my $new_raw = do { local $/; <$new_fh> };
176 # get rid of the From we added
177 $new_raw =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
179 # check if user forgot to purge (in mutt) after editing
180 if ($new_raw =~ /^From /sm) {
183 Extra "From " lines detected in new mbox.
184 Did you forget to purge the original message from the mbox after editing?
188 (y)es to re-edit, (n)o to continue
190 chomp(my $op = <STDIN> || '');
192 goto retry_edit if $op eq 'y';
193 last if $op eq 'n'; # continuing
194 print STDERR "\`$op' not recognized\n";
196 } else { # non-interactive path
197 # unlikely to happen, as extra From lines are
198 # only a common mistake (for me) with
201 W: possible message boundary splitting error
205 # unescape what we escaped:
206 $new_raw =~ s/^>(>*From )/$1/gm;
209 my $new_mime = PublicInbox::MIME->new(\$new_raw);
210 my $old_mime = PublicInbox::MIME->new($old_raw);
212 # make sure we don't compare unwanted headers, since mutt adds
213 # Content-Length, Status, and Lines headers:
214 PublicInbox::Import::drop_unwanted_headers($new_mime);
215 PublicInbox::Import::drop_unwanted_headers($old_mime);
217 # allow changing Received: and maybe other headers which can
218 # contain sensitive info.
219 my $nhdr = $new_mime->header_obj;
220 my $ohdr = $old_mime->header_obj;
221 if (($nhdr->as_string eq $ohdr->as_string) &&
222 (content_id($new_mime) eq content_id($old_mime))) {
223 warn "No change detected to:\n", show_cmd($ibx, $smsg);
225 next unless $opt->{verbose};
226 # should we consider this machine-parseable?
227 PublicInbox::AdminEdit::show_rewrites(\*STDOUT, $ibx, []);
231 foreach my $tuple (@$to_edit) {
232 $ibx = PublicInbox::InboxWritable->new($tuple->[0]);
234 my $im = $ibx->importer(0);
235 my $commits = $im->replace($old_mime, $new_mime);
238 warn "Failed to replace:\n", show_cmd($ibx, $smsg);
241 next unless $opt->{verbose};
242 # should we consider this machine-parseable?
243 PublicInbox::AdminEdit::show_rewrites(\*STDOUT, $ibx, $commits);