Add option '-s': pipe article to script.
[usenet/yapfaq.git] / yapfaq.pl
index 67e8cb3..c36be30 100644 (file)
--- a/yapfaq.pl
+++ b/yapfaq.pl
@@ -12,7 +12,7 @@
 # It can be redistributed and/or modified under the same terms under 
 # which Perl itself is published.
 
-my $Version = "0.6-unreleased";
+my $Version = "0.6.2";
 
 my $NNTPServer = "localhost";
 my $NNTPUser = "";
@@ -52,23 +52,51 @@ my @PGPorderheaders = ('from', 'newsgroups', 'subject', 'control',
 
 use strict;
 use Net::NNTP;
+use Net::Domain qw(hostfqdn);
 use Date::Calc qw(Add_Delta_YM Add_Delta_Days Delta_Days Today);
 use Fcntl ':flock'; # import LOCK_* constants
+use Getopt::Std;
 my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date
 
+# read commandline options
+my %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'}) {
+  exec ('perldoc', $0);
+  exit(0);
+};
+# -f: set $Faq
+my ($Faq) = $Options{'f'} if ($Options{'f'});
+
+# read configuration (configured FAQs)
 my @Config;
-readconfig (\$ConfigFile, \@Config);
+readconfig (\$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
   my $SupersedeMID;
   
-  my ($ActName,$File,$PFreq) =($$_{'name'},$$_{'file'},$$_{'posting-frequency'});
+  my ($ActName,$File,$PFreq,$Expire) =($$_{'name'},$$_{'file'},$$_{'posting-frequency'},$$_{'expires'});
   my ($From,$Subject,$NG,$Fup2)=($$_{'from'},$$_{'subject'},$$_{'ngs'},$$_{'fup2'});
   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})?)/){
@@ -84,29 +112,35 @@ foreach (@Config) {
 
   $SupersedeMID = "" unless $Supersede;
 
-  if ($PFreq =~ /(\d+)\s*([dw])/) { # Is counted in days or weeks: Use Add_Delta_Days.
-    ($NPY,$NPM,$NPD) = Add_Delta_Days($LPY, $LPM, $LPD, (($2 eq "w")?$1 * 7: $1 * 1));
-  } elsif ($PFreq =~ /(\d+)\s*([my])/) { #Is counted in months or years: Use Add_Delta_YM
-    ($NPY,$NPM,$NPD) = Add_Delta_YM($LPY, $LPM, $LPD, (($2 eq "m")?(0,$1):($1,0)));
-  }
-    
-  if (Delta_Days($NPY,$NPM,$NPD,$TDY,$TDM,$TDD) >= 0 ) {
-    postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Sender,\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID);
+  ($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);
+       }
+  } elsif($Options{'v'}) {
+    print "$ActName: Nothing to do.\n";
   }
 }
 
 exit;
 
 ################################## readconfig ##################################
-# Takes a filename and the reference to an array, which will hold hashes with
-# the data from $File.
+# 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
 
 sub readconfig{
-  my ($File, $Config) = @_;
+  my ($File, $Config, $Faq) = @_;
   my ($LastEntry, $Error, $i) = ('','',0);
 
+  print "Reading configuration.\n" if($Options{'v'});
+
   open FH, "<$$File" or die "$0: E: Can't open $$File: $!";
   while (<FH>) {
+    next if (defined($$Faq) && !/^\s*=====\s*$/ && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
     if (/^(\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)|^(.*?)'?\s*(#.*$|$))/ && not /^\s*$/) {
       $LastEntry = lc($2) if $2;
       $$Config[$i]{$LastEntry} .= $3 if $3;  
@@ -120,43 +154,77 @@ sub readconfig{
 
   #Check saved values:
   for $i (0..$i){
-    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"
+    next if (defined($$Faq) && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
+    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"
     }
-    $Error .= "-" x 25 . "\n" if $Error;
+    unless(!$$Config[$i]{'expires'} || $$Config[$i]{'expires'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
+         warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
+    }
+    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 . 'program terminated' . "-" x 25 . "\n" if $Error;
   die $Error if $Error;
 }
 
+################################# calcdelta #################################
+# Takes a date (year,  month and day) and a time period (1d, 1w, 1m, 1y, ...)
+# and adds the latter to the former
+
+sub calcdelta {
+  my ($Year, $Month, $Day, $Period) = @_;
+  my ($NYear, $NMonth, $NDay);
+
+  if ($Period =~ /(\d+)\s*([dw])/) { # Is counted in days or weeks: Use Add_Delta_Days.
+    ($NYear, $NMonth, $NDay) = Add_Delta_Days($Year, $Month, $Day, (($2 eq "w")?$1 * 7: $1 * 1));
+  } elsif ($Period =~ /(\d+)\s*([my])/) { #Is counted in months or years: Use Add_Delta_YM
+    ($NYear, $NMonth, $NDay) = Add_Delta_YM($Year, $Month, $Day, (($2 eq "m")?(0,$1):($1,0)));
+  }
+  return ($NYear, $NMonth, $NDay);
+}
+  
 ################################## postfaq ##################################
 # Takes a filename and many other vars.
 #
 # It reads the data-file $File and then posts the article.
 
 sub postfaq {
-  my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes) = @_;
+  my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
   my (@Header,@Body,$MID,$InRealBody,$LastModified);
 
+  print "$$ActName: Preparing to post.\n" if($Options{'v'});
+  
   #Prepare MID:
   $$TDM = ($$TDM < 10 && $$TDM !~ /^0/) ? "0" . $$TDM : $$TDM;
   $$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>){  
@@ -180,18 +248,25 @@ sub postfaq {
   my $wday = ("Sun","Mon","Tue","Wed","Thu","Fri","Sat")[$time[6]];
   my $year = (1900 + $time[5]);
   my $tz = $time[8] ? " +0200" : " +0100";
-  
-  my ($expY,$expM,$expD) = Add_Delta_YM($year, $month, $day, 0, 3);
+
+  $$Expire = '3m' if !$$Expire; # set default if unset: 3 month
+
+  my ($expY,$expM,$expD) = calcdelta ($year,$month,$day,$$Expire);
   my $expmonthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$expM-1];
 
   my $date = "$day $monthN $year " . $hh . ":" . $mm . ":" . $ss . $tz;
   my $expdate = "$expD $expmonthN $expY $hh:$mm:$ss$tz";
-
   #Replace %LM by the content of the news.answer-pseudo-header Last-modified:
   if ($LastModified) {
     $$Subject =~ s/\%LM/$LastModified/;
   }
 
+  # Test mode?
+  if($Options{'t'} and $Options{'t'} !~ /console/i) {
+    $$NG = $Options{'t'};
+  }
+
   #Now create the complete Header:
   push @Header, "From: $$From\n";
   push @Header, "Newsgroups: $$NG\n";
@@ -211,10 +286,19 @@ sub postfaq {
     push @Header, "$_\n" for (split /\n/, $$ExtraHeaders);
   }
 
+  # sign article if $UsePGP is true
   my @Article = ($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: $!";
   print FH "##;; Lastpost: $day.$month.$year\n";
   print FH "##;; LastMID: $MID\n";
@@ -229,14 +313,31 @@ sub postfaq {
 sub post {
   my ($ArticleR) = @_;
 
+  # Test mode?
+  if(defined($Options{'t'}) and $Options{'t'} =~ /console/i) {
+    print "-----BEGIN--------------------------------------------------\n";
+       print @$ArticleR;
+    print "------END---------------------------------------------------\n";
+       return;
+  }
+
+  # 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;
+  }
+
   my $NewsConnection = Net::NNTP->new($NNTPServer, Reader => 1)
     or die "$0: E: Can't connect to news server '$NNTPServer'!\n";
 
-  $NewsConnection->authinfo ($NNTPUser, $NNTPPass);
+  $NewsConnection->authinfo ($NNTPUser, $NNTPPass) if (defined($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";
@@ -424,7 +525,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
 
@@ -622,9 +723,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)
 
@@ -663,6 +768,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.014316 seconds and 4 git commands to generate.