Add sample .yapfaqrc with defaults.
[usenet/yapfaq.git] / yapfaq.pl
index a2042db..23f7e5a 100644 (file)
--- a/yapfaq.pl
+++ b/yapfaq.pl
 
 my $Version = "0.6.2";
 
-my $NNTPServer = "localhost";
-my $NNTPUser = "";
-my $NNTPPass = "";
-my $Sender = "";
-my $ConfigFile = "yapfaq.cfg";
-my $UsePGP = 0;
-
-################################## PGP-Config #################################
-
-my $pgp                  = '/usr/bin/pgp';            # path to pgp
-my $PGPVersion    = '2';                       # Use 2 for 2.X, 5 for PGP > 2.X and GPG for GPG
-
-my $PGPSigner     = '';                        # sign as who?
-my $PGPPass       = '';                        # pgp2 only
-my $PathtoPGPPass = '';                               # pgp2, pgp5 and gpg
-
-
-my $pgpbegin  ='-----BEGIN PGP SIGNATURE-----';# Begin of PGP-Signature
-my $pgpend    ='-----END PGP SIGNATURE-----';  # End of PGP-Signature
-my $pgptmpf   ='pgptmp';                       # temporary file for PGP.
-my $pgpheader ='X-PGP-Sig';
+my $RCFile = '.yapfaqrc';
+my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile',
+                     'UsePGP','pgp','PGPVersion','PGPSigner','PGPPass',
+                     'PathtoPGPPass','pgpbegin','pgpend','pgptmpf','pgpheader');
+
+################################### Defaults ##################################
+my %Config = (NNTPServer => "localhost",
+              NNTPUser   => "",
+              NNTPPass   => "",
+              Sender     => "",
+              ConfigFile => "yapfaq.cfg",
+              UsePGP     => 0,
+
+              ################################## PGP-Config #################################
+              pgp           => '/usr/bin/pgp',                  # path to pgp
+              PGPVersion    => '2',                             # Use 2 for 2.X, 5 for PGP > 2.X and GPG for GPG
+              PGPSigner     => '',                              # sign as who?
+              PGPPass       => '',                              # pgp2 only
+              PathtoPGPPass => '',                              # pgp2, pgp5 and gpg
+              pgpbegin      => '-----BEGIN PGP SIGNATURE-----', # Begin of PGP-Signature
+              pgpend        => '-----END PGP SIGNATURE-----',   # End of PGP-Signature
+              pgptmpf       => 'pgptmp',                        # temporary file for PGP.
+              pgpheader     => 'X-PGP-Sig');
 
 my @PGPSignHeaders = ('From', 'Newsgroups', 'Subject', 'Control',
        'Supersedes', 'Followup-To', 'Date', 'Sender', 'Approved',
@@ -58,17 +60,34 @@ use Fcntl ':flock'; # import LOCK_* constants
 use Getopt::Std;
 my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date
 
+# read commandline options
 my %Options;
-getopts('hvpdt:f:', \%Options);
+getopts('Vhvpdt:f:s:', \%Options);
+# -V: print version / copyright information
+if ($Options{'V'}) {
+  print "$0 v $Version\nCopyright (c) 2003 Marc Brockschmidt <marc\@marcbrockschmidt.de>\nCopyright (c) 2010 Thomas Hochstein <thh\@inter.net>\n";
+  print "This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.\n";
+  exit(0);
+}
+# -h: feed myself to perldoc
 if ($Options{'h'}) {
-  print "$0 v $Version\nUsage: $0 [-hvpd] [-t <newsgroups>] [-f <faq>]\n";
+  exec ('perldoc', $0);
   exit(0);
 };
+# -f: set $Faq
 my ($Faq) = $Options{'f'} if ($Options{'f'});
 
+# read runtime configuration (configuration variables)
+readrc (\$RCFile,\%Config) if -f $RCFile;
+
+# read configuration (configured FAQs)
 my @Config;
-readconfig (\$ConfigFile, \@Config, \$Faq);
+readconfig (\$Config{'ConfigFile'}, \@Config, \$Faq);
 
+# for each FAQ:
+# - parse configuration
+# - read status data
+# - if FAQ is due: call postfaq()
 foreach (@Config) { 
   my ($LPD,$LPM,$LPY) = (01, 01, 0001);  #LP: Last posting-date
   my ($NPY,$NPM,$NPD);                   #NP: Next posting-date
@@ -79,8 +98,10 @@ foreach (@Config) {
   my ($MIDF,$ReplyTo,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'extraheader'});
   my ($Supersede)            =($$_{'supersede'});
 
+  # -f: loop if not FAQ to post
   next if (defined($Faq) && $ActName ne $Faq);
        
+  # read status data
   if (open (FH, "<$File.cfg")) {
     while(<FH>){
       if (/##;; Lastpost:\s*(\d{1,2})\.(\d{1,2})\.(\d{2}(\d{2})?)/){
@@ -98,11 +119,12 @@ foreach (@Config) {
 
   ($NPY,$NPM,$NPD) = calcdelta ($LPY,$LPM,$LPD,$PFreq);
 
+  # if FAQ is due: get it out
   if (Delta_Days($NPY,$NPM,$NPD,$TDY,$TDM,$TDD) >= 0 or ($Options{'p'})) {
     if($Options{'d'}) {
          print "$ActName: Would be posted now (but running in simulation mode [$0 -d]).\n" if $Options{'v'};
        } else {
-      postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Sender,\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
+      postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Config{'Sender'},\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
        }
   } elsif($Options{'v'}) {
     print "$ActName: Nothing to do.\n";
@@ -111,6 +133,26 @@ foreach (@Config) {
 
 exit;
 
+#################################### readrc ####################################
+# Takes a filename and the reference to an array which contains the valid options
+
+sub readrc{
+  my ($File, $Config) = @_;
+
+  print "Reading $$File.\n" if($Options{'v'});
+
+  open FH, "<$$File" or die "$0: Can't open $$File: $!";
+  while (<FH>) {
+    if (/^\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)/) {
+      if (grep(/$1/,@ValidConfVars)) {
+        $$Config{$1} = $2 if $2 ne '';
+      } else {
+        warn "$0: W: $1 is not a valid configuration variable (reading from $$File)\n";
+      }
+    }
+  }
+}
+
 ################################## readconfig ##################################
 # Takes a filename, a reference to an array, which will hold hashes with
 # the data from $File, and - optionally - the name of the (single) FAQ to post
@@ -138,16 +180,25 @@ sub readconfig{
   #Check saved values:
   for $i (0..$i){
     next if (defined($$Faq) && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
-    unless($$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) {
-      $Error .= "E: The From-header for your project \"$$Config[$i]{'name'}\" seems to be incorrect.\n"
+    unless(defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} =~ /^\S+$/) {
+      $Error .= "E: The name of your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
+    }
+    unless(defined($$Config[$i]{'file'}) && -f $$Config[$i]{'file'}) {
+      $Error .= "E: The file to post for your project \"$$Config[$i]{'name'}\" is not defined or does not exist.\n"
+    }
+    unless(defined($$Config[$i]{'from'}) && $$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) {
+      $Error .= "E: The From header for your project \"$$Config[$i]{'name'}\" seems to be incorrect.\n"
+    }
+    unless(defined($$Config[$i]{'ngs'}) && $$Config[$i]{'ngs'} =~ /^\S+$/) {
+      $Error .= "E: The Newsgroups header for your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
     }
-    unless($$Config[$i]{'ngs'} =~ /^\S+$/) {
-      $Error .= "E: The Newsgroups-header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
+    unless(defined($$Config[$i]{'subject'})) {
+      $Error .= "E: The Subject header for your project \"$$Config[$i]{'name'}\" is not defined.\n"
     }
     unless(!$$Config[$i]{'fup2'} || $$Config[$i]{'fup2'} =~ /^\S+$/) {
-      $Error .= "E: The Followup-To-header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
+      $Error .= "E: The Followup-To header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
     }
-    unless($$Config[$i]{'posting-frequency'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
+    unless(defined($$Config[$i]{'posting-frequency'}) && $$Config[$i]{'posting-frequency'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
       $Error .= "E: The Posting-frequency for your project \"$$Config[$i]{'name'}\" is invalid.\n"
     }
     unless(!$$Config[$i]{'expires'} || $$Config[$i]{'expires'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
@@ -156,8 +207,8 @@ sub readconfig{
     unless(defined($$Config[$i]{'mid-format'}) && $$Config[$i]{'mid-format'} =~ /^<\S+\@\S{2,}\.\S{2,}>$/) {
          warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" seems to be invalid - set to default.\n";
     }
-    $Error .= "-" x 25 . "\n" if $Error;
   }
+  $Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
   die $Error if $Error;
 }
 
@@ -193,12 +244,12 @@ sub postfaq {
   $$TDD = ($$TDD < 10 && $$TDD !~ /^0/) ? "0" . $$TDD : $$TDD;
 
   $MID = $$MIDF;
+  $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID);
   $MID =~ s/\%n/$$ActName/g;
   $MID =~ s/\%d/$$TDD/g;
   $MID =~ s/\%m/$$TDM/g;
   $MID =~ s/\%y/$$TDY/g;
 
-
   #Now get the body:
   open (FH, "<$$File");
   while (<FH>){  
@@ -260,14 +311,17 @@ sub postfaq {
     push @Header, "$_\n" for (split /\n/, $$ExtraHeaders);
   }
 
-  my @Article = ($UsePGP)?@{signpgp(\@Header, \@Body)}:(@Header, "\n", @Body);
+  # sign article if $UsePGP is true
+  my @Article = ($Config{'UsePGP'})?@{signpgp(\@Header, \@Body)}:(@Header, "\n", @Body);
   
+  # post article
   print "$$ActName: Posting article ...\n" if($Options{'v'});
   post(\@Article);
 
   # Test mode?
   return if($Options{'t'});
 
+  # otherwise: update status data
   print "$$ActName: Save status information.\n" if($Options{'v'});
 
   open (FH, ">$$File.cfg") or die "$0: E: Can't open $$File.cfg: $!";
@@ -286,20 +340,27 @@ sub post {
 
   # Test mode?
   if(defined($Options{'t'}) and $Options{'t'} =~ /console/i) {
-    print "\n-----BEGIN--------------------------------------------------\n";
+    print "-----BEGIN--------------------------------------------------\n";
        print @$ArticleR;
-    print "\n------END---------------------------------------------------\n";
+    print "------END---------------------------------------------------\n";
        return;
   }
 
-  my $NewsConnection = Net::NNTP->new($NNTPServer, Reader => 1)
-    or die "$0: E: Can't connect to news server '$NNTPServer'!\n";
+  # pipe to script?
+  if(defined($Options{'s'})) {
+    open (POST, "| $Options{'s'}") or die "$0: E: Cannot fork $Options{'s'}: $!\n";
+    print POST @$ArticleR;
+    close POST;
+    return;
+  }
 
-  $NewsConnection->authinfo ($NNTPUser, $NNTPPass);
+  my $NewsConnection = Net::NNTP->new($Config{'NNTPServer'}, Reader => 1)    or die "$0: E: Can't connect to news server '$Config{'NNTPServer'}'!\n";
+  $NewsConnection->authinfo ($Config{'NNTPUser'}, $Config{'NNTPPass'}) if (defined($Config{'NNTPUser'}));
   $NewsConnection->post();
   $NewsConnection->datasend (@$ArticleR);
   $NewsConnection->dataend();
 
+  # Posting failed? Save to ERROR.dat
   if (!$NewsConnection->ok()) {
     open FH, ">>ERROR.dat";
     print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n";
@@ -324,26 +385,26 @@ sub getpgpcommand {
   my $PGPCommand;
 
   if ($PGPVersion eq '2') {
-    if ($PathtoPGPPass && !$PGPPass) {
-      open (PGPPW, $PathtoPGPPass) or die "$0: E: Can't open $PathtoPGPPass: $!";
-      $PGPPass = <PGPPW>;
+    if ($Config{'PathtoPGPPass'} && !$Config{'PGPPass'}) {
+      open (PGPPW, $Config{'PathtoPGPPass'}) or die "$0: E: Can't open $Config{'PathtoPGPPass'}: $!";
+      Config{'$PGPPass'} = <PGPPW>;
       close PGPPW;
     }
   
-    if ($PGPPass) {
-      $PGPCommand = "PGPPASS=\"".$PGPPass."\" ".$pgp." -u \"".$PGPSigner."\" +verbose=0 language='en' -saft <".$pgptmpf.".txt >".$pgptmpf.".txt.asc";
+    if (Config{'$PGPPass'}) {
+      $PGPCommand = "PGPPASS=\"".$Config{'PGPPass'}."\" ".$Config{'pgp'}." -u \"".$Config{'PGPSigner'}."\" +verbose=0 language='en' -saft <".$Config{'pgptmpf'}.".txt >".$Config{'pgptmpf'}.".txt.asc";
     } else {
       die "$0: E: PGP-Passphrase is unknown!\n";
     }
   } elsif ($PGPVersion eq '5') {
-    if ($PathtoPGPPass) {
-      $PGPCommand = "PGPPASSFD=2 ".$pgp."s -u \"".$PGPSigner."\" -t --armor -o ".$pgptmpf.".txt.asc -z -f < ".$pgptmpf.".txt 2<".$PathtoPGPPass;
+    if ($Config{'PathtoPGPPass'}) {
+      $PGPCommand = "PGPPASSFD=2 ".$Config{'pgp'}."s -u \"".$Config{'PGPSigner'}."\" -t --armor -o ".$Config{'pgptmpf'}.".txt.asc -z -f < ".$Config{'pgptmpf'}.".txt 2<".$Config{'PathtoPGPPass'};
     } else {
       die "$0: E: PGP-Passphrase is unknown!\n";
     }
   } elsif ($PGPVersion =~ m/GPG/io) {
-    if ($PathtoPGPPass) {
-      $PGPCommand = $pgp." --digest-algo MD5 -a -u \"".$PGPSigner."\" -o ".$pgptmpf.".txt.asc --no-tty --batch --passphrase-fd 2 2<".$PathtoPGPPass." --clearsign ".$pgptmpf.".txt";
+    if (Config{'$PathtoPGPPass'}) {
+      $PGPCommand = $Config{'pgp'}." --digest-algo MD5 -a -u \"".$Config{'PGPSigner'}."\" -o ".$Config{'pgptmpf'}.".txt.asc --no-tty --batch --passphrase-fd 2 2<".$Config{'PathtoPGPPass'}." --clearsign ".$Config{'pgptmpf'}.".txt";
     } else {
       die "$0: E: Passphrase is unknown!\n";
     }
@@ -386,8 +447,8 @@ sub signpgp {
   $pgpbody = join ("", @$BodyR);
 
   # Delete and create the temporary pgp-Files
-  unlink "$pgptmpf.txt";
-  unlink "$pgptmpf.txt.asc";
+  unlink "$Config{'pgptmpf'}.txt";
+  unlink "$Config{'pgptmpf'}.txt.asc";
   $signheaders = join(",", @signheaders);
 
   $pgphead = "X-Signed-Headers: $signheaders\n";
@@ -397,37 +458,37 @@ sub signpgp {
     }
   }
 
-  open(FH, ">" . $pgptmpf . ".txt") or die "$0: E: can't open $pgptmpf: $!\n";
+  open(FH, ">" . $Config{'pgptmpf'} . ".txt") or die "$0: E: can't open $Config{'pgptmpf'}: $!\n";
   print FH $pgphead, "\n", $pgpbody;
-  print FH "\n" if ($PGPVersion =~ m/GPG/io);  # workaround a pgp/gpg incompatibility - should IMHO be fixed in pgpverify
+  print FH "\n" if ($Config{'PGPVersion'} =~ m/GPG/io);        # workaround a pgp/gpg incompatibility - should IMHO be fixed in pgpverify
   close(FH) or warn "$0: W: Couldn't close TMP: $!\n";
 
   # Start PGP, then read the signature;
-  my $PGPCommand = getpgpcommand($PGPVersion);
+  my $PGPCommand = getpgpcommand($Config{'PGPVersion'});
   `$PGPCommand`;
 
-  open (FH, "<" . $pgptmpf . ".txt.asc") or die "$0: E: can't open ".$pgptmpf.".txt.asc: $!\n";
-  $/ = "$pgpbegin\n";
+  open (FH, "<" . $Config{'pgptmpf'} . ".txt.asc") or die "$0: E: can't open ".$Config{'pgptmpf'}.".txt.asc: $!\n";
+  $/ = "$Config{'pgpbegin'}\n";
   $_ = <FH>;
-  unless (m/\Q$pgpbegin\E$/o) {
-#    unlink $pgptmpf . ".txt";
-#    unlink $pgptmpf . ".txt.asc";
-    die "$0: E: $pgpbegin not found in ".$pgptmpf.".txt.asc\n"
+  unless (m/\Q$Config{'pgpbegin'}\E$/o) {
+#    unlink $Config{'pgptmpf'} . ".txt";
+#    unlink $Config{'pgptmpf'} . ".txt.asc";
+    die "$0: E: $Config{'pgpbegin'} not found in ".$Config{'pgptmpf'}.".txt.asc\n"
   }
-  unlink($pgptmpf . ".txt") or warn "$0: W: Couldn't unlink $pgptmpf.txt: $!\n";
+  unlink($Config{'pgptmpf'} . ".txt") or warn "$0: W: Couldn't unlink $Config{'pgptmpf'}.txt: $!\n";
 
   $/ = "\n";
   $_ = <FH>;
   unless (m/^Version: (\S+)(?:\s(\S+))?/o) {
-    unlink $pgptmpf . ".txt";
-    unlink $pgptmpf . ".txt.asc";
+    unlink $Config{'pgptmpf'} . ".txt";
+    unlink $Config{'pgptmpf'} . ".txt.asc";
     die "$0: E: didn't find PGP Version line where expected.\n";
   }
   
   if (defined($2)) {
-    $$HeaderR{$pgpheader} = $1."-".$2." ".$signheaders;
+    $$HeaderR{$Config{'pgpheader'}} = $1."-".$2." ".$signheaders;
   } else {
-    $$HeaderR{$pgpheader} = $1." ".$signheaders;
+    $$HeaderR{$Config{'pgpheader'}} = $1." ".$signheaders;
   }
   
   do {          # skip other pgp headers like
@@ -436,23 +497,23 @@ sub signpgp {
 
   while (<FH>) {
     chomp;
-    last if /^\Q$pgpend\E$/;
-    $$HeaderR{$pgpheader} .= "\n\t$_";
+    last if /^\Q$Config{'pgpend'}\E$/;
+    $$HeaderR{$Config{'pgpheader'}} .= "\n\t$_";
   }
   
-  $$HeaderR{$pgpheader} .= "\n" unless ($$HeaderR{$pgpheader} =~ /\n$/s);
+  $$HeaderR{$Config{'pgpheader'}} .= "\n" unless ($$HeaderR{$Config{'pgpheader'}} =~ /\n$/s);
 
   $_ = <FH>;
   unless (eof(FH)) {
-    unlink $pgptmpf . ".txt";
-    unlink $pgptmpf . ".txt.asc";
-    die "$0: E: unexpected data following $pgpend\n";
+    unlink $Config{'pgptmpf'} . ".txt";
+    unlink $Config{'pgptmpf'} . ".txt.asc";
+    die "$0: E: unexpected data following $Config{'pgpend'}\n";
   }
   close(FH);
-  unlink "$pgptmpf.txt.asc";
+  unlink "$Config{'pgptmpf'}.txt.asc";
 
-  my $tmppgpheader = $pgpheader . ": " . $$HeaderR{$pgpheader};
-  delete $$HeaderR{$pgpheader};
+  my $tmppgpheader = $Config{'pgpheader'} . ": " . $$HeaderR{$Config{'pgpheader'}};
+  delete $$HeaderR{$Config{'pgpheader'}};
 
   @pgphead = ();
   foreach $header (@PGPorderheaders) {
@@ -469,7 +530,7 @@ sub signpgp {
     }
   }
 
-  push @pgphead, ("X-PGP-Key: " . $PGPSigner . "\n"), $tmppgpheader;
+  push @pgphead, ("X-PGP-Key: " . $Config{'PGPSigner'} . "\n"), $tmppgpheader;
   undef $tmppgpheader;
 
   @pgpbody = split /$/m, $pgpbody;
@@ -487,7 +548,7 @@ yapfaq - Post Usenet FAQs I<(yet another postfaq)>
 
 =head1 SYNOPSIS
 
-B<yapfaq> [B<-hvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>]
+B<yapfaq> [B<-hvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>] [B<-s> I<program>]
 
 =head1 REQUIREMENTS
 
@@ -685,9 +746,13 @@ was posted and the second being the message ID of that incarnation.
 
 =over 3
 
+=item B<-V> (version)
+
+Print out version and copyright information on B<yapfaq> and exit.
+
 =item B<-h> (help)
 
-Print out version and usage information on B<yapfaq> and exit.
+Print this man page and exit.
 
 =item B<-v> (verbose)
 
@@ -726,6 +791,12 @@ will be posted unconditionally. That may not be what you want to
 achieve, so you can limit the operation of B<yapfaq> to the named FAQ
 only.
 
+=item B<-s> I<program> (pipe to script)
+
+Instead of posting the article(s) to Usenet pipe them to the external
+I<program> on STDIN (which may post the article(s) then). A return
+value of 0 will be considered success.
+
 =back
 
 =head1 EXAMPLES
This page took 0.01772 seconds and 4 git commands to generate.