X-Git-Url: https://code.th-h.de/?p=usenet%2Fyapfaq.git;a=blobdiff_plain;f=yapfaq.pl;h=685395ace777232dc4f05648f9a8698efb3c127c;hp=084c77edc2acb5073c9d44cd2ab471951b3adc39;hb=bdbb9d7043b46b337971a45bc41934c5679490cc;hpb=a052296f3b55e5f07e7d70b53c988721b129b0bc;ds=sidebyside diff --git a/yapfaq.pl b/yapfaq.pl index 084c77e..685395a 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,43 +12,25 @@ # It can be redistributed and/or modified under the same terms under # which Perl itself is published. -my $Version = "0.6.2"; +our $VERSION = "0.8-prelease"; -my $NNTPServer = "localhost"; -my $NNTPUser = ""; -my $NNTPPass = ""; -my $Sender = ""; -my $ConfigFile = "yapfaq.cfg"; -my $UsePGP = 0; +# 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','Program'); -################################## PGP-Config ################################# +################################### 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 => "", + ConfigFile => "yapfaq.cfg", + Program => ""); -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 @PGPSignHeaders = ('From', 'Newsgroups', 'Subject', 'Control', - 'Supersedes', 'Followup-To', 'Date', 'Sender', 'Approved', - 'Message-ID', 'Reply-To', 'Cancel-Lock', 'Cancel-Key', - 'Also-Control', 'Distribution'); - -my @PGPorderheaders = ('from', 'newsgroups', 'subject', 'control', - 'supersedes', 'followup-To', 'date', 'organization', 'lines', - 'sender', 'approved', 'distribution', 'message-id', - 'references', 'reply-to', 'mime-version', 'content-type', - '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; @@ -56,24 +38,44 @@ 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; +$Getopt::Std::STANDARD_HELP_VERSION = 1; my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date +# read commandline options my %Options; -getopts('Vhvpdt:f:', \%Options); +getopts('Vhvpdt:f:c:s:', \%Options); +# -V: print version / copyright information if ($Options{'V'}) { - print "$0 v $Version\nCopyright (c) 2003 Marc Brockschmidt \nCopyright (c) 2010 Thomas Hochstein \n"; + print "$0 v $VERSION\nCopyright (c) 2003 Marc Brockschmidt \nCopyright (c) 2010 Thomas Hochstein \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 runtime configuration (configuration variables) +$RCFile = $Options{'c'} if ($Options{'c'}); +if (-f $RCFile) { + readrc (\$RCFile,\%Config); +} else { + warn "$0: W: .rc file $RCFile does not exist!\n"; +} + +$Options{'s'} = $Config{'Program'} if (!defined($Options{'s'})); + +# 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 @@ -84,8 +86,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(){ if (/##;; Lastpost:\s*(\d{1,2})\.(\d{1,2})\.(\d{2}(\d{2})?)/){ @@ -103,11 +107,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"; @@ -116,6 +121,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 () { + 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 @@ -124,7 +149,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 () { @@ -165,10 +190,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+\.)?\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; @@ -190,6 +217,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. @@ -205,14 +247,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"); @@ -270,25 +313,22 @@ sub postfaq { push @Header, "Reply-To: $$ReplyTo\n" if $$ReplyTo; push @Header, "Content-Type: text/plain; charset=ISO-8859-15\n"; push @Header, "Content-Transfer-Encoding: 8bit\n"; - push @Header, "User-Agent: yapfaq/$Version\n"; + push @Header, "User-Agent: yapfaq/$VERSION\n"; if ($$ExtraHeaders) { push @Header, "$_\n" for (split /\n/, $$ExtraHeaders); } - my @Article = ($UsePGP)?@{signpgp(\@Header, \@Body)}:(@Header, "\n", @Body); - - print "$$ActName: Posting article ...\n" if($Options{'v'}); - post(\@Article); - - # Test mode? - return if($Options{'t'}); + my @Article = (@Header, "\n", @Body); - 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; + # post article + print "$$ActName: Posting article ...\n" if($Options{'v'}); + 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 ################################## @@ -298,198 +338,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 "\n-----BEGIN--------------------------------------------------\n"; - print @$ArticleR; - print "\n------END---------------------------------------------------\n"; - 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) if (defined($NNTPUser)); - $NewsConnection->post(); - $NewsConnection->datasend (@$ArticleR); - $NewsConnection->dataend(); - - 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; - } - - $NewsConnection->quit(); -} - -#-------- sub getpgpcommand -# getpgpcommand generates the command to sign the message and returns it. -# -# Receives: -# - $PGPVersion: A scalar holding the PGPVersion -sub getpgpcommand { - my ($PGPVersion) = @_; - my $PGPCommand; - - if ($PGPVersion eq '2') { - if ($PathtoPGPPass && !$PGPPass) { - open (PGPPW, $PathtoPGPPass) or die "$0: E: Can't open $PathtoPGPPass: $!"; - $PGPPass = ; - close PGPPW; - } - - if ($PGPPass) { - $PGPCommand = "PGPPASS=\"".$PGPPass."\" ".$pgp." -u \"".$PGPSigner."\" +verbose=0 language='en' -saft <".$pgptmpf.".txt >".$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; + print "-----BEGIN--------------------------------------------------\n"; + print @$ArticleR; + print "------END---------------------------------------------------\n"; + # 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; + if ($? == 0) { + $failure = 0; } 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"; - } else { - die "$0: E: Passphrase is unknown!\n"; + warn "$0: W: $Options{'s'} exited with status ", ($? >> 8), "\n"; + $failure = $?; } + # post article } else { - die "$0: E: Unknown PGP-Version $PGPVersion!"; - } - return $PGPCommand; -} - - -#-------- sub signarticle -# signarticle signs an articel and returns a reference to an array -# containing the whole signed Message. -# -# Receives: -# - $HeaderAR: A reference to a array containing the articles headers. -# - $BodyR: A reference to an array containing the body. -# -# Returns: -# - $MessageRef: A reference to an array containing the whole message. -sub signpgp { - my ($HeaderAR, $BodyR) = @_; - my (@pgphead, @pgpbody, $pgphead, $pgpbody, $header, $signheaders, @signheaders, $currentheader, $HeaderR, $line); - - foreach my $line (@$HeaderAR) { - if ($line =~ /^(\S+):\s+(.*)$/s) { - $currentheader = $1; - $$HeaderR{lc($currentheader)} = "$1: $2"; + 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 { - $$HeaderR{lc($currentheader)} .= $line; - } - } - - foreach (@PGPSignHeaders) { - if (defined($$HeaderR{lc($_)}) && $$HeaderR{lc($_)} =~ m/^[^\s:]+: .+/o) { - push @signheaders, $_; + 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(); } - - $pgpbody = join ("", @$BodyR); - - # Delete and create the temporary pgp-Files - unlink "$pgptmpf.txt"; - unlink "$pgptmpf.txt.asc"; - $signheaders = join(",", @signheaders); - - $pgphead = "X-Signed-Headers: $signheaders\n"; - foreach $header (@signheaders) { - if ($$HeaderR{lc($header)} =~ m/^[^\s:]+: (.+?)\n?$/so) { - $pgphead .= $header.": ".$1."\n"; - } - } - - open(FH, ">" . $pgptmpf . ".txt") or die "$0: E: can't open $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 - close(FH) or warn "$0: W: Couldn't close TMP: $!\n"; - - # Start PGP, then read the signature; - my $PGPCommand = getpgpcommand($PGPVersion); - `$PGPCommand`; - - open (FH, "<" . $pgptmpf . ".txt.asc") or die "$0: E: can't open ".$pgptmpf.".txt.asc: $!\n"; - $/ = "$pgpbegin\n"; - $_ = ; - unless (m/\Q$pgpbegin\E$/o) { -# unlink $pgptmpf . ".txt"; -# unlink $pgptmpf . ".txt.asc"; - die "$0: E: $pgpbegin not found in ".$pgptmpf.".txt.asc\n" - } - unlink($pgptmpf . ".txt") or warn "$0: W: Couldn't unlink $pgptmpf.txt: $!\n"; - - $/ = "\n"; - $_ = ; - unless (m/^Version: (\S+)(?:\s(\S+))?/o) { - unlink $pgptmpf . ".txt"; - unlink $pgptmpf . ".txt.asc"; - die "$0: E: didn't find PGP Version line where expected.\n"; - } - - if (defined($2)) { - $$HeaderR{$pgpheader} = $1."-".$2." ".$signheaders; - } else { - $$HeaderR{$pgpheader} = $1." ".$signheaders; - } - - do { # skip other pgp headers like - $_ = ; # "charset:"||"comment:" until empty line - } while ! /^$/; - - while () { - chomp; - last if /^\Q$pgpend\E$/; - $$HeaderR{$pgpheader} .= "\n\t$_"; - } - - $$HeaderR{$pgpheader} .= "\n" unless ($$HeaderR{$pgpheader} =~ /\n$/s); - - $_ = ; - unless (eof(FH)) { - unlink $pgptmpf . ".txt"; - unlink $pgptmpf . ".txt.asc"; - die "$0: E: unexpected data following $pgpend\n"; - } - close(FH); - unlink "$pgptmpf.txt.asc"; - - my $tmppgpheader = $pgpheader . ": " . $$HeaderR{$pgpheader}; - delete $$HeaderR{$pgpheader}; - - @pgphead = (); - foreach $header (@PGPorderheaders) { - if ($$HeaderR{$header} && $$HeaderR{$header} ne "\n") { - push(@pgphead, "$$HeaderR{$header}"); - delete $$HeaderR{$header}; - } - } - - foreach $header (keys %$HeaderR) { - if ($$HeaderR{$header} && $$HeaderR{$header} ne "\n") { - push(@pgphead, "$$HeaderR{$header}"); - delete $$HeaderR{$header}; - } - } - - push @pgphead, ("X-PGP-Key: " . $PGPSigner . "\n"), $tmppgpheader; - undef $tmppgpheader; - - @pgpbody = split /$/m, $pgpbody; - my @pgpmessage = (@pgphead, "\n", @pgpbody); - return \@pgpmessage; + return $failure; } __END__ @@ -502,7 +393,7 @@ yapfaq - Post Usenet FAQs I<(yet another postfaq)> =head1 SYNOPSIS -B [B<-hvpd>] [B<-t> I | CONSOLE] [B<-f> I] +B [B<-Vhvpd>] [B<-t> I | CONSOLE] [B<-f> I] [B<-s> I] [B<-c> I<.rc file>] =head1 REQUIREMENTS @@ -538,7 +429,8 @@ headers as defined in its config file (by default F). F 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. +of definitions in the form of I. Everything after a "#" +sign is ignored so you may comment your configuration file. =over 4 @@ -566,7 +458,7 @@ or Ionths> or Iears>. This value must be set. -=item B = I