X-Git-Url: https://code.th-h.de/?p=usenet%2Fyapfaq.git;a=blobdiff_plain;f=yapfaq.pl;h=888a4f5a7f17cee2545d3a9b0f79627fd88c3ba8;hp=a868d6f3fed3bc6f58403ab2cff38b5132f6e973;hb=ae3b1b7906bb835b80b86143c0285965afa728d8;hpb=15dd764aad1617e6b94d328c55bd30a0498ec0a6;ds=sidebyside diff --git a/yapfaq.pl b/yapfaq.pl index a868d6f..888a4f5 100644 --- a/yapfaq.pl +++ b/yapfaq.pl @@ -1,18 +1,20 @@ #! /usr/bin/perl -W # -# yapfaq Version 0.5b by Marc 'HE' Brockschmidt +# yapfaq Version 0.6 by Thomas Hochstein +# (Original author: Marc Brockschmidt) # -# This script posts any project described in it's config-file. Most persons +# This script posts any project described in its config-file. Most people # will use it in combination with cron(8). # # Copyright (C) 2003 Marc Brockschmidt +# Copyright (c) 2010 Thomas Hochstein # # It can be redistributed and/or modified under the same terms under # which Perl itself is published. -my $Version = "0.5b"; +my $Version = "0.6.2"; -my $NNTPServer = ""; +my $NNTPServer = "localhost"; my $NNTPUser = ""; my $NNTPPass = ""; my $Sender = ""; @@ -50,23 +52,35 @@ 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 +my %Options; +getopts('hvpdt:f:', \%Options); +if ($Options{'h'}) { + exec ('perldoc', $0); + exit(0); +}; +my ($Faq) = $Options{'f'} if ($Options{'f'}); + my @Config; -readconfig (\$ConfigFile, \@Config); +readconfig (\$ConfigFile, \@Config, \$Faq); 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'}); - + + next if (defined($Faq) && $ActName ne $Faq); + if (open (FH, "<$File.cfg")) { while(){ if (/##;; Lastpost:\s*(\d{1,2})\.(\d{1,2})\.(\d{2}(\d{2})?)/){ @@ -77,34 +91,39 @@ foreach (@Config) { } close FH; } else { - warn "Couldn't open $File.cfg: $!"; + warn "$0: W: Couldn't open $File.cfg: $!\n"; } $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 (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); - open FH, "<$$File" or die "$0: Can't open $$File: $!"; + print "Reading configuration.\n" if($Options{'v'}); + + open FH, "<$$File" or die "$0: E: Can't open $$File: $!"; while () { + 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; @@ -118,37 +137,72 @@ sub readconfig{ #Check saved values: for $i (0..$i){ - unless($$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) { - $Error .= "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 .= "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 .= "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*$/) { - $Error .= "The Posting-frequency for your project \"$$Config[$i]{'name'}\" is invalid.\n" + 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*$/) { + 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 . "\n" if $Error; } + $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; @@ -161,7 +215,7 @@ sub postfaq { s/\r//; push (@Body, $_), next if $InRealBody; $InRealBody++ if /^$/; - $LastModified = $1 if /^Last-modified: (\S+)$/; + $LastModified = $1 if /^Last-modified: (\S+)$/i; push @Body, $_; } close FH; @@ -178,18 +232,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,9 +272,15 @@ sub postfaq { my @Article = ($UsePGP)?@{signpgp(\@Header, \@Body)}:(@Header, "\n", @Body); + print "$$ActName: Posting article ...\n" if($Options{'v'}); post(\@Article); - open (FH, ">$$File.cfg") or die "$0: Can't open $$File.cfg: $!"; + # Test mode? + return if($Options{'t'}); + + 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; @@ -227,17 +294,25 @@ sub postfaq { sub post { my ($ArticleR) = @_; + # Test mode? + 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 "Can't connect to news server $NNTPServer!\n"; + 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(); if (!$NewsConnection->ok()) { open FH, ">>ERROR.dat"; - print FH "\nPosting failed! Response from news server:\n"; + print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n"; print FH $NewsConnection->code(); print FH $NewsConnection->message(); print FH "\n"; @@ -260,7 +335,7 @@ sub getpgpcommand { if ($PGPVersion eq '2') { if ($PathtoPGPPass && !$PGPPass) { - open (PGPPW, $PathtoPGPPass) or die "Can't open $PathtoPGPPass: $!"; + open (PGPPW, $PathtoPGPPass) or die "$0: E: Can't open $PathtoPGPPass: $!"; $PGPPass = ; close PGPPW; } @@ -268,22 +343,22 @@ sub getpgpcommand { if ($PGPPass) { $PGPCommand = "PGPPASS=\"".$PGPPass."\" ".$pgp." -u \"".$PGPSigner."\" +verbose=0 language='en' -saft <".$pgptmpf.".txt >".$pgptmpf.".txt.asc"; } else { - die "$0: PGP-Passphrase is unknown!\n"; + 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; } else { - die "$0: PGP-Passphrase is unknown!\n"; + 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: Passphrase is unknown!\n"; + die "$0: E: Passphrase is unknown!\n"; } } else { - die "$0: Unknown PGP-Version $PGPVersion!"; + die "$0: E: Unknown PGP-Version $PGPVersion!"; } return $PGPCommand; } @@ -332,31 +407,31 @@ sub signpgp { } } - open(FH, ">" . $pgptmpf . ".txt") or die "$0: can't open $pgptmpf: $!\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: Couldn't close TMP: $!\n"; + 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: can't open ".$pgptmpf.".txt.asc: $!\n"; + 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: $pgpbegin not found in ".$pgptmpf.".txt.asc\n" + die "$0: E: $pgpbegin not found in ".$pgptmpf.".txt.asc\n" } - unlink($pgptmpf . ".txt") or warn "$0: Couldn't unlink $pgptmpf.txt: $!\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: didn't find PGP Version line where expected.\n"; + die "$0: E: didn't find PGP Version line where expected.\n"; } if (defined($2)) { @@ -381,7 +456,7 @@ sub signpgp { unless (eof(FH)) { unlink $pgptmpf . ".txt"; unlink $pgptmpf . ".txt.asc"; - die "$0: unexpected data following $pgpend\n"; + die "$0: E: unexpected data following $pgpend\n"; } close(FH); unlink "$pgptmpf.txt.asc"; @@ -411,3 +486,329 @@ sub signpgp { my @pgpmessage = (@pgphead, "\n", @pgpbody); return \@pgpmessage; } + +__END__ + +################################ Documentation ################################# + +=head1 NAME + +yapfaq - Post Usenet FAQs I<(yet another postfaq)> + +=head1 SYNOPSIS + +B [B<-hvpd>] [B<-t> I | CONSOLE] [B<-f> I] + +=head1 REQUIREMENTS + +=over 2 + +=item - + +Perl 5.8 or later + +=item - + +Net::NNTP + +=item - + +Date::Calc + +=item - + +Getopt::Std + +=back + +Furthermore you need access to a news server to actually post FAQs. + +=head1 DESCRIPTION + +B posts (one or more) FAQs to Usenet with a certain posting +frequency (every n days, weeks, months or years), adding all necessary +headers as defined in its config file (by default F). + +=head2 Configuration + +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. + +=over 4 + +=item B = I + +A name referring to your FAQ, also used for generation of a Message-ID. + +This value must be set. + +=item B = I + +A file containing the message body of your FAQ and all pseudo headers +(subheaders in the news.answers style). + +This value must be set. + +=item B = I