X-Git-Url: https://code.th-h.de/?p=usenet%2Fyapfaq.git;a=blobdiff_plain;f=yapfaq.pl;h=d4e381eec37e472e9489f6e7e45b7b6b33faaeaa;hp=23f7e5ae7f3e8e2b2596036d9f86507844edc3be;hb=13ce8c26a3ae0e0d875905741c354c889e2a7903;hpb=d60c2d5fdfb9bde091cd788893dd5c7e442a58e0

diff --git a/yapfaq.pl b/yapfaq.pl
index 23f7e5a..d4e381e 100644
--- a/yapfaq.pl
+++ b/yapfaq.pl
@@ -1,6 +1,6 @@
 #! /usr/bin/perl -W
 #
-# yapfaq Version 0.6 by Thomas Hochstein
+# yapfaq Version 0.7 by Thomas Hochstein
 # (Original author: Marc Brockschmidt)
 #
 # This script posts any project described in its config-file. Most people
@@ -12,15 +12,20 @@
 # It can be redistributed and/or modified under the same terms under 
 # which Perl itself is published.
 
-my $Version = "0.6.2";
+my $Version = "0.8-prelease";
 
+# Please do not change this setting!
+# You may override the default .rc file (.yapfaqrc) by using "-c .rc file"
 my $RCFile = '.yapfaqrc';
+# Valid configuration variables for use in a .rc file
 my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile',
                      'UsePGP','pgp','PGPVersion','PGPSigner','PGPPass',
                      'PathtoPGPPass','pgpbegin','pgpend','pgptmpf','pgpheader');
 
-################################### Defaults ##################################
-my %Config = (NNTPServer => "localhost",
+################################### Defaults ###################################
+# Please do not change anything in here!
+# Use a runtime configuration file (.yapfaqrc by default) to override defaults.
+my %Config = (NNTPServer => "",
               NNTPUser   => "",
               NNTPPass   => "",
               Sender     => "",
@@ -50,7 +55,7 @@ my @PGPorderheaders = ('from', 'newsgroups', 'subject', 'control',
 	'content-transfer-encoding', 'summary', 'keywords', 'cancel-lock',
 	'cancel-key', 'also-control', 'x-pgp', 'user-agent');
 
-############################# End of Configuration #############################
+################################# Main program #################################
 
 use strict;
 use Net::NNTP;
@@ -62,7 +67,7 @@ my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date
 
 # read commandline options
 my %Options;
-getopts('Vhvpdt:f:s:', \%Options);
+getopts('Vhvpdt:f:c: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";
@@ -78,7 +83,12 @@ if ($Options{'h'}) {
 my ($Faq) = $Options{'f'} if ($Options{'f'});
 
 # read runtime configuration (configuration variables)
-readrc (\$RCFile,\%Config) if -f $RCFile;
+$RCFile = $Options{'c'} if ($Options{'c'});
+if (-f $RCFile) {
+  readrc (\$RCFile,\%Config);
+} else {
+  warn "$0: W: .rc file $RCFile does not exist!\n";
+}
 
 # read configuration (configured FAQs)
 my @Config;
@@ -161,7 +171,7 @@ sub readconfig{
   my ($File, $Config, $Faq) = @_;
   my ($LastEntry, $Error, $i) = ('','',0);
 
-  print "Reading configuration.\n" if($Options{'v'});
+  print "Reading configuration from $$File.\n" if($Options{'v'});
 
   open FH, "<$$File" or die "$0: E: Can't open $$File: $!";
   while (<FH>) {
@@ -202,10 +212,12 @@ sub readconfig{
       $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*$/) {
-	  warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
+      warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
+      $$Config[$i]{'expires'} = '3m'; # set default (3 month) if expires is unset or invalid
     }
-    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";
+    unless(!$$Config[$i]{'mid-format'} || $$Config[$i]{'mid-format'} =~ /^<\S+\@\S{2,}\.\S{2,}>$/) {
+      warn "$0: W: The Message-ID format for your project \"$$Config[$i]{'name'}\" seems to be invalid - set to default.\n";
+      $$Config[$i]{'mid-format'} = '<%n-%d.%m.%y@'.hostfqdn.'>'; # set default if mid-format is invalid
     }
   }
   $Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
@@ -227,6 +239,21 @@ sub calcdelta {
   }
   return ($NYear, $NMonth, $NDay);
 }
+
+################################ updatestatus ###############################
+# Takes a MID and a status file name
+# and writes status information to disk
+
+sub updatestatus {
+  my ($ActName, $File, $date, $MID) = @_;
+  
+  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: $date\n";
+  print FH "##;; LastMID: $MID\n";
+  close FH;
+}
   
 ################################## postfaq ##################################
 # Takes a filename and many other vars.
@@ -242,13 +269,15 @@ sub postfaq {
   #Prepare MID:
   $$TDM = ($$TDM < 10 && $$TDM !~ /^0/) ? "0" . $$TDM : $$TDM;
   $$TDD = ($$TDD < 10 && $$TDD !~ /^0/) ? "0" . $$TDD : $$TDD;
+  my $Timestamp = time;
 
   $MID = $$MIDF;
-  $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID);
+  $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID); # set to default if unset
   $MID =~ s/\%n/$$ActName/g;
   $MID =~ s/\%d/$$TDD/g;
   $MID =~ s/\%m/$$TDM/g;
   $MID =~ s/\%y/$$TDY/g;
+  $MID =~ s/\%t/$Timestamp/g;
 
   #Now get the body:
   open (FH, "<$$File");
@@ -316,18 +345,13 @@ sub postfaq {
   
   # 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";
-  close FH;
+  my $failure = post(\@Article);
+  
+  if ($failure) {
+    print "$$ActName: Posting failed, ERROR.dat may have more information.\n" if($Options{'v'} && (!defined($Options{'t'}) || $Options{'t'} !~ /console/i));
+  } else {
+    updatestatus($ActName, $File, "$day.$month.$year", $MID) if !defined($Options{'t'});
+  }
 }
 
 ################################## post ##################################
@@ -337,42 +361,49 @@ sub postfaq {
 
 sub post {
   my ($ArticleR) = @_;
+  my ($failure) = -1;
 
-  # Test mode?
+  # test mode - print article to console
   if(defined($Options{'t'}) and $Options{'t'} =~ /console/i) {
     print "-----BEGIN--------------------------------------------------\n";
-	print @$ArticleR;
+    print @$ArticleR;
     print "------END---------------------------------------------------\n";
-	return;
-  }
-
-  # pipe to script?
-  if(defined($Options{'s'})) {
+  # pipe article to script
+  } elsif(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($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";
-    print FH $NewsConnection->code();
-    print FH $NewsConnection->message();
-    print FH "\n";
-    print FH @$ArticleR;
-    print FH "-" x 80, "\n";
-    close FH;
+    if ($? == 0) {
+      $failure = 0;
+    } else {
+      warn "$0: W: $Options{'s'} exited with status ", ($? >> 8), "\n";
+      $failure = $?;
+    }
+  # post article
+  } else {
+    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();
+
+    if ($NewsConnection->ok()) {
+      $failure = 0;
+    # Posting failed? Save to ERROR.dat
+    } else {
+	  warn "$0: W: Posting failed!\n";
+      open FH, ">>ERROR.dat";
+      print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n";
+      print FH $NewsConnection->code();
+      print FH $NewsConnection->message();
+      print FH "\n";
+      print FH @$ArticleR;
+      print FH "-" x 80, "\n";
+      close FH;
+    }
+    $NewsConnection->quit();
   }
-
-  $NewsConnection->quit();
+  return $failure;
 }
 
 #-------- sub getpgpcommand
@@ -548,7 +579,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<-s> I<program>]
+B<yapfaq> [B<-Vhvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>] [B<-s> I<program>] [B<-c> I<.rc file>]
 
 =head1 REQUIREMENTS
 
@@ -584,7 +615,8 @@ headers as defined in its config file (by default F<yapfaq.cfg>).
 
 F<yapfaq.cfg> consists of one or more blocks, separated by C<=====> on
 a single line, each containing the configuration for one FAQ as a set
-of definitions in the form of I<param = value>.
+of definitions in the form of I<param = value>. Everything after a "#"
+sign is ignored so you may comment your configuration file.
 
 =over 4
 
@@ -612,7 +644,7 @@ or I<B<m>onths> or I<B<y>ears>.
 
 This value must be set.
 
-=item B<Expires> = I<time period>
+=item B<Expires> = I<time period> (optional)
 
 The period of time after which your message will expire. An Expires
 header will be calculated adding this time period to today's date.
@@ -620,7 +652,7 @@ header will be calculated adding this time period to today's date.
 You can declare this  time period either in I<B<d>ays> or I<B<w>weeks>
 or I<B<m>onths> or I<B<y>ears>.
 
-This setting is optional; the default  is 3 months.
+This setting is optional; the default is 3 months.
 
 =item B<From> = I<author>
 
@@ -646,32 +678,37 @@ appear in the Newsgroups header of the message.
 
 This value must be set.
 
-=item B<Fup2> = I<newsgroup | poster>
+=item B<Fup2> = I<newsgroup | poster>  (optional)
 
 A comma-separated list of newsgroup(s) or the special string I<poster>
 as it will appear in the Followup-To header of the message.
 
 This setting is optional.
 
-=item B<MID-Format> = I<pattern>
+=item B<MID-Format> = I<pattern>  (optional)
 
 A pattern from which the message ID is generated as it will appear in
 the Message-ID header of the message.
 
 You may use the special strings C<%n> for the I<Name> of your project,
-C<%d> for the date the message is posted, C<%m> for the month and
-C<%y> for the year, respectively.
+C<%d> for the date the message is posted, C<%m> for the month, C<%y>
+for the year and C<%t> for a time stamp (number of seconds since the
+epoch), respectively.
 
-This value must be set.
+This setting is optional; the default is '<%n-%d.%m.%y@I<YOURHOST>>'
+where I<YOURHOST> is the fully qualified domain name (FQDN) of the
+host B<yapfaq> is running on. Obviously that will only work if you
+have defined a reasonable hostname that the hostfqdn() function of
+Net::Domain can return.
 
-=item B<Supersede> = I<yes>
+=item B<Supersede> = I<yes>  (optional)
 
 Add Supersedes header to the message containing the Message-ID header
 of the last posting.
 
 This setting is optional; you should set it to yes or leave it out.
 
-=item B<ExtraHeader> = I<additional headers>
+=item B<ExtraHeader> = I<additional headers>  (optional)
 
 The contents of I<ExtraHeader> is added verbatim to the headers of
 your message so you can add custom headers like Approved.
@@ -680,7 +717,7 @@ This setting is optional.
 
 =back
 
-=head2 Example configuration file
+=head3 Example configuration file
 
     # name of your project
     Name = 'testpost'
@@ -695,7 +732,7 @@ This setting is optional.
     
     # time period after which the posting should expire
     # use (d)ay OR (w)eek OR (m)onth OR (y)ear
-    Expires = '3m'
+    # Expires = '3m'
     
     # header "From:"
     From = 'test@domain.invalid'
@@ -710,10 +747,10 @@ This setting is optional.
     NGs = 'de.test'
     
     # header "Followup-To:"
-    Fup2 = 'poster'
+    # Fup2 = 'poster'
     
     # Message-ID ("%n" is $Name)
-    MID-Format = '<%n-%d.%m.%y@domain.invalid>'
+    # MID-Format = '<%n-%d.%m.%y@domain.invalid>'
     
     # Supersede last posting?
     Supersede = yes
@@ -736,12 +773,101 @@ This setting is optional.
     MID-Format = '<%n-%m.%y@domain.invalid>'
     Supersede = yes
 
+=head3 Status Information
+
 Information about the last post and about how to form message IDs for
 posts is stored in a file named F<I<project name>.cfg> which will be
 generated if it does not exist. Each of those status files will
 contain two lines, the first being the date of the last time the FAQ
 was posted and the second being the message ID of that incarnation.
 
+=head2 Runtime Configuration
+
+Apart from configuring which FAQ(s) to post you may (re)set some
+runtime configuration variables via the .rcfile (by default
+F<.yapfaqrc>). F<.yapfaqrc> must contain one definition in the form of
+I<param = value> on each line; everything after a "#" sign is ignored.
+
+If you omit some settings they will be set to default values hardcoded
+in F<yapfaq.pl>.
+
+B<Please note that all parameter names are case-sensitive!>
+
+=over 4
+
+=item B<NNTPServer> = I<NNTP server> (mandatory)
+
+Host name of the NNTP server to post to. Must be set (or omitted; the
+default is "localhost"); if set to en empty string, B<yapfaq> falls
+back to Perl's build-in defaults (contents of environment variables
+NNTPSERVER and NEWSHOST; if not set, default from Net::Config; if not
+set, "news" is used).
+
+=item B<NNTPUser> = I<user name> (optional)
+
+User name used for authentication with the NNTP server (I<AUTHINFO
+USER>).
+
+This setting is optional; if it is not set, I<NNTPPass> is ignored and
+no authentication is tried.
+
+=item B<NNTPPass> = I<password> (optional)
+
+Password used for authentication with the NNTP server (I<AUTHINFO
+PASS>).
+
+This setting is optional; it must be set if I<NNTPUser> is present.
+
+=item B<Sender> = I<Sender header> (optional)
+
+The Sender header that will be added to every posted message.
+
+This setting is optional.
+
+=item B<ConfigFile> = I<configuration file> (mandatory)
+
+The configuration file defining the FAQ(s) to post. Must be set (or
+omitted; the default is "yapfaq.cfg").
+
+=item B<UsePGP> = I<whether to add a digital signature> (optional)
+
+Boolean value (0 or 1) controlling whether the FAQs will get digitally
+signed via an X-PGP-Sig header.
+
+This setting is optional; the default is 0.
+
+If you have set I<UsePGP> to 1, you must also supply the necessary
+information on your PGP oder GPG installation; please refer to the
+sample F<.yapfaqrc> file (see below) for more information on this
+topic.
+
+=back
+
+=head3 Example runtime configuration file
+
+    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'
+
+=head3 Using more than one runtime configuration
+
+You may use more than one runtime configuration file with the B<-c>
+option (see below).
+
 =head1 OPTIONS
 
 =over 3
@@ -797,6 +923,13 @@ 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.
 
+=item B<-c> I<.rc file>
+
+Load another runtime configuration file (.rc file) than F<.yaofaq.rc>.
+
+You may for example define another usenet server to post your FAQ(s)
+to or load another configuration file defining (an)other FAQ(s).
+
 =back
 
 =head1 EXAMPLES
@@ -819,9 +952,26 @@ if it is due:
 
     yapfaq -t de.test -f myfaq
 
+Post all FAQs (that are due for posting) using inews from INN:
+
+    yapfaq -s inews
+
+Do a dry run using a runtime configuration from .alternaterc, showing
+which FAQs would be posted:
+
+    yapfaq -dvc .alternaterc
+
 =head1 ENVIRONMENT
 
-There are no special environment variables used by B<yapfaq>.
+=over 4
+
+=item NNTPSERVER
+
+The default NNTP server to post to, used by the Net::NNTP module. You
+can also  specify the server using the runtime configuration file (by
+default F<.yapfaqrc>).
+
+=back
 
 =head1 FILES
 
@@ -831,6 +981,10 @@ There are no special environment variables used by B<yapfaq>.
 
 The script itself.
 
+=item F<.yapfaqrc>
+
+Runtime configuration file for B<yapfaq>.
+
 =item F<yapfaq.cfg>
 
 Configuration file for B<yapfaq>.
@@ -859,10 +1013,9 @@ version of this program.
 
 Thomas Hochstein <thh@inter.net>
 
-Original author (until version 0.5b from 2003):
+Original author (up to version 0.5b, dating from 2003):
 Marc Brockschmidt <marc@marcbrockschmidt.de>
 
-
 =head1 COPYRIGHT AND LICENSE
 
 Copyright (c) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>