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',
# 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 <marc\@marcbrockschmidt.de>\nCopyright (c) 2010 Thomas Hochstein <thh\@inter.net>\n";
# -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";
+}
+
# read configuration (configured FAQs)
my @Config;
-readconfig (\$ConfigFile, \@Config, \$Faq);
+readconfig (\$Config{'ConfigFile'}, \@Config, \$Faq);
# for each FAQ:
# - parse configuration
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";
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
}
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.
}
# sign article if $UsePGP is true
- my @Article = ($UsePGP)?@{signpgp(\@Header, \@Body)}:(@Header, "\n", @Body);
+ 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: $!";
- 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 ##################################
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();
-
- # 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;
+ 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 {
+ 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
my $PGPCommand;
if ($PGPVersion eq '2') {
- if ($PathtoPGPPass && !$PGPPass) {
- open (PGPPW, $PathtoPGPPass) or die "$0: E: Can't open $PathtoPGPPass: $!";
+ 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";
}
$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";
}
}
- 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
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) {
}
}
- push @pgphead, ("X-PGP-Key: " . $PGPSigner . "\n"), $tmppgpheader;
+ push @pgphead, ("X-PGP-Key: " . $Config{'PGPSigner'} . "\n"), $tmppgpheader;
undef $tmppgpheader;
@pgpbody = split /$/m, $pgpbody;
=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>] [B<-c> I<.rc file>]
=head1 REQUIREMENTS
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
=back
-=head2 Example configuration file
+=head3 Example configuration file
# name of your project
Name = 'testpost'
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
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.
+
+=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
The script itself.
+=item F<.yapfaqrc>
+
+Runtime configuration file for B<yapfaq>.
+
=item F<yapfaq.cfg>
Configuration file for B<yapfaq>.
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>
projects / usenet / yapfaq.git / blobdiff