mda+learn: add --help / -h support

[public-inbox.git] / script / public-inbox-learn

diff --git a/script/public-inbox-learn b/script/public-inbox-learn
old mode 100644 (file)
new mode 100755 (executable)
index 4c10b68..fb2d86e
--- a/script/public-inbox-learn
+++ b/script/public-inbox-learn
@@ -4,23 +4,41 @@
 #
 # Used for training spam (via SpamAssassin) and removing messages from a
 # public-inbox
-my $usage = "$0 <spam|ham|rm> </path/to/message";
+my $help = <<EOF;
+usage: public-inbox-learn [OPTIONS] [spam|ham|rm] </path/to/RFC2822_message
+
+required action argument:
+
+   spam  unindex the message and train as spam
+     rm  remove the message without training as spam
+    ham  index the message (based on To:/Cc: headers) and train as ham
+
+options:
+
+  --all  scan all inboxes on `rm'
+
+See public-inbox-learn(1) man page for full documentation.
+EOF
 use strict;
-use warnings;
 use PublicInbox::Config;
 use PublicInbox::InboxWritable;
-use PublicInbox::MIME;
+use PublicInbox::Eml;
 use PublicInbox::Address;
 use PublicInbox::Spamcheck::Spamc;
-my $train = shift or die "usage: $usage\n";
+use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
+my %opt = (all => 0);
+GetOptions(\%opt, qw(all help|h)) or die $help;
+
+my $train = shift or die $help;
 if ($train !~ /\A(?:ham|spam|rm)\z/) {
-       die "`$train' not recognized.\nusage: $usage\n";
+       die "`$train' not recognized.\n$help";
 }
+die "--all only works with `rm'\n" if $opt{all} && $train ne 'rm';
 
 my $spamc = PublicInbox::Spamcheck::Spamc->new;
 my $pi_config = PublicInbox::Config->new;
 my $err;
-my $mime = PublicInbox::MIME->new(do{
+my $mime = PublicInbox::Eml->new(do{
        local $/;
        my $data = <STDIN>;
        $data =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
@@ -68,12 +86,12 @@ sub remove_or_add ($$$$) {
 }
 
 # spam is removed from all known inboxes since it is often Bcc:-ed
-if ($train eq 'spam') {
+if ($train eq 'spam' || ($train eq 'rm' && $opt{all})) {
        $pi_config->each_inbox(sub {
                my ($ibx) = @_;
                $ibx = PublicInbox::InboxWritable->new($ibx);
                my $im = $ibx->importer(0);
-               $im->remove($mime, 'spam');
+               $im->remove($mime, $train);
                $im->done;
        });
 } else {
@@ -97,7 +115,7 @@ if ($train eq 'spam') {
        }
        my $dests = PublicInbox::MDA->inboxes_for_list_id($pi_config, $mime);
        for my $ibx (@$dests) {
-               next if !$seen{"$ibx"}++;
+               next if $seen{"$ibx"}++;
                remove_or_add($ibx, $train, $mime, $ibx->{-primary_address});
        }
 }