2 # Copyright (C) 2019-2021 all contributors <meta@public-inbox.org>
3 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
5 # Used for purging messages entirely from a public-inbox. Currently
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 PublicInbox::Admin::check_require('-index');
12 use PublicInbox::Filter::Base qw(REJECT);
14 require PublicInbox::V2Writable;
17 usage: public-inbox-purge [--all] [INBOX_DIRS] </path/to/message
19 erase message entirely from an inbox (including history)
23 --all purge from all configured inboxes
25 See public-inbox-purge(1) man page for full documentation.
28 my $opt = { verbose => 1, all => 0, -min_inbox_version => 2 };
29 GetOptions($opt, @PublicInbox::AdminEdit::OPT) or die $help;
30 if ($opt->{help}) { print $help; exit 0 };
32 my @ibxs = PublicInbox::Admin::resolve_inboxes(\@ARGV, $opt);
33 PublicInbox::AdminEdit::check_editable(\@ibxs);
35 defined(my $data = do { local $/; <STDIN> }) or die "read STDIN: $!\n";
36 $data =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
39 foreach my $ibx (@ibxs) {
40 my $mime = PublicInbox::Eml->new($data);
41 my $v2w = PublicInbox::V2Writable->new($ibx, 0);
43 my $commits = $v2w->purge($mime) || [];
45 if (my $scrub = $ibx->filter($v2w)) {
46 my $scrubbed = $scrub->scrub($mime, 1);
48 if ($scrubbed && $scrubbed != REJECT()) {
49 my $scrub_commits = $v2w->purge($scrubbed);
50 push @$commits, @$scrub_commits if $scrub_commits;
56 if ($opt->{verbose}) { # should we consider this machine-parseable?
57 PublicInbox::AdminEdit::show_rewrites(\*STDOUT, $ibx, $commits);
59 $n_purged += scalar @$commits;
63 exit(0) if ($opt->{force} || $n_purged);
65 warn "Not found\n" if $opt->{verbose};