3 # yapfaq Version 0.7 by Thomas Hochstein
4 # (Original author: Marc Brockschmidt)
6 # This script posts any project described in its config-file. Most people
7 # will use it in combination with cron(8).
9 # Copyright (C) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
10 # Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
12 # It can be redistributed and/or modified under the same terms under
13 # which Perl itself is published.
15 my $Version = "0.8-prelease";
17 # Please do not change this setting!
18 # You may override the default .rc file (.yapfaqrc) by using "-c .rc file"
19 my $RCFile = '.yapfaqrc';
20 # Valid configuration variables for use in a .rc file
21 my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile',
22 'UsePGP','pgp','PGPVersion','PGPSigner','PGPPass',
23 'PathtoPGPPass','pgpbegin','pgpend','pgptmpf','pgpheader');
25 ################################### Defaults ###################################
26 # Please do not change anything in here!
27 # Use a runtime configuration file (.yapfaqrc by default) to override defaults.
28 my %Config = (NNTPServer => "",
32 ConfigFile => "yapfaq.cfg",
35 ################################## PGP-Config #################################
36 pgp => '/usr/bin/pgp', # path to pgp
37 PGPVersion => '2', # Use 2 for 2.X, 5 for PGP > 2.X and GPG for GPG
38 PGPSigner => '', # sign as who?
39 PGPPass => '', # pgp2 only
40 PathtoPGPPass => '', # pgp2, pgp5 and gpg
41 pgpbegin => '-----BEGIN PGP SIGNATURE-----', # Begin of PGP-Signature
42 pgpend => '-----END PGP SIGNATURE-----', # End of PGP-Signature
43 pgptmpf => 'pgptmp', # temporary file for PGP.
44 pgpheader => 'X-PGP-Sig');
46 my @PGPSignHeaders = ('From', 'Newsgroups', 'Subject', 'Control',
47 'Supersedes', 'Followup-To', 'Date', 'Sender', 'Approved',
48 'Message-ID', 'Reply-To', 'Cancel-Lock', 'Cancel-Key',
49 'Also-Control', 'Distribution');
51 my @PGPorderheaders = ('from', 'newsgroups', 'subject', 'control',
52 'supersedes', 'followup-To', 'date', 'organization', 'lines',
53 'sender', 'approved', 'distribution', 'message-id',
54 'references', 'reply-to', 'mime-version', 'content-type',
55 'content-transfer-encoding', 'summary', 'keywords', 'cancel-lock',
56 'cancel-key', 'also-control', 'x-pgp', 'user-agent');
58 ################################# Main program #################################
62 use Net::Domain qw(hostfqdn);
63 use Date::Calc qw(Add_Delta_YM Add_Delta_Days Delta_Days Today);
64 use Fcntl ':flock'; # import LOCK_* constants
66 my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date
68 # read commandline options
70 getopts('Vhvpdt:f:c:s:', \%Options);
71 # -V: print version / copyright information
73 print "$0 v $Version\nCopyright (c) 2003 Marc Brockschmidt <marc\@marcbrockschmidt.de>\nCopyright (c) 2010 Thomas Hochstein <thh\@inter.net>\n";
74 print "This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.\n";
77 # -h: feed myself to perldoc
83 my ($Faq) = $Options{'f'} if ($Options{'f'});
85 # read runtime configuration (configuration variables)
86 $RCFile = $Options{'c'} if ($Options{'c'});
88 readrc (\$RCFile,\%Config);
90 warn "$0: W: .rc file $RCFile does not exist!\n";
93 # read configuration (configured FAQs)
95 readconfig (\$Config{'ConfigFile'}, \@Config, \$Faq);
98 # - parse configuration
100 # - if FAQ is due: call postfaq()
102 my ($LPD,$LPM,$LPY) = (01, 01, 0001); #LP: Last posting-date
103 my ($NPY,$NPM,$NPD); #NP: Next posting-date
106 my ($ActName,$File,$PFreq,$Expire) =($$_{'name'},$$_{'file'},$$_{'posting-frequency'},$$_{'expires'});
107 my ($From,$Subject,$NG,$Fup2)=($$_{'from'},$$_{'subject'},$$_{'ngs'},$$_{'fup2'});
108 my ($MIDF,$ReplyTo,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'extraheader'});
109 my ($Supersede) =($$_{'supersede'});
111 # -f: loop if not FAQ to post
112 next if (defined($Faq) && $ActName ne $Faq);
115 if (open (FH, "<$File.cfg")) {
117 if (/##;; Lastpost:\s*(\d{1,2})\.(\d{1,2})\.(\d{2}(\d{2})?)/){
118 ($LPD, $LPM, $LPY) = ($1, $2, $3);
119 } elsif (/^##;;\s*LastMID:\s*(<\S+@\S+>)\s*$/) {
125 warn "$0: W: Couldn't open $File.cfg: $!\n";
128 $SupersedeMID = "" unless $Supersede;
130 ($NPY,$NPM,$NPD) = calcdelta ($LPY,$LPM,$LPD,$PFreq);
132 # if FAQ is due: get it out
133 if (Delta_Days($NPY,$NPM,$NPD,$TDY,$TDM,$TDD) >= 0 or ($Options{'p'})) {
135 print "$ActName: Would be posted now (but running in simulation mode [$0 -d]).\n" if $Options{'v'};
137 postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Config{'Sender'},\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
139 } elsif($Options{'v'}) {
140 print "$ActName: Nothing to do.\n";
146 #################################### readrc ####################################
147 # Takes a filename and the reference to an array which contains the valid options
150 my ($File, $Config) = @_;
152 print "Reading $$File.\n" if($Options{'v'});
154 open FH, "<$$File" or die "$0: Can't open $$File: $!";
156 if (/^\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)/) {
157 if (grep(/$1/,@ValidConfVars)) {
158 $$Config{$1} = $2 if $2 ne '';
160 warn "$0: W: $1 is not a valid configuration variable (reading from $$File)\n";
166 ################################## readconfig ##################################
167 # Takes a filename, a reference to an array, which will hold hashes with
168 # the data from $File, and - optionally - the name of the (single) FAQ to post
171 my ($File, $Config, $Faq) = @_;
172 my ($LastEntry, $Error, $i) = ('','',0);
174 print "Reading configuration from $$File.\n" if($Options{'v'});
176 open FH, "<$$File" or die "$0: E: Can't open $$File: $!";
178 next if (defined($$Faq) && !/^\s*=====\s*$/ && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
179 if (/^(\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)|^(.*?)'?\s*(#.*$|$))/ && not /^\s*$/) {
180 $LastEntry = lc($2) if $2;
181 $$Config[$i]{$LastEntry} .= $3 if $3;
182 $$Config[$i]{$LastEntry} .= "\n$5" if $5 && $5;
184 if (/^\s*=====\s*$/) {
192 next if (defined($$Faq) && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
193 unless(defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} =~ /^\S+$/) {
194 $Error .= "E: The name of your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
196 unless(defined($$Config[$i]{'file'}) && -f $$Config[$i]{'file'}) {
197 $Error .= "E: The file to post for your project \"$$Config[$i]{'name'}\" is not defined or does not exist.\n"
199 unless(defined($$Config[$i]{'from'}) && $$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) {
200 $Error .= "E: The From header for your project \"$$Config[$i]{'name'}\" seems to be incorrect.\n"
202 unless(defined($$Config[$i]{'ngs'}) && $$Config[$i]{'ngs'} =~ /^\S+$/) {
203 $Error .= "E: The Newsgroups header for your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
205 unless(defined($$Config[$i]{'subject'})) {
206 $Error .= "E: The Subject header for your project \"$$Config[$i]{'name'}\" is not defined.\n"
208 unless(!$$Config[$i]{'fup2'} || $$Config[$i]{'fup2'} =~ /^\S+$/) {
209 $Error .= "E: The Followup-To header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
211 unless(defined($$Config[$i]{'posting-frequency'}) && $$Config[$i]{'posting-frequency'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
212 $Error .= "E: The Posting-frequency for your project \"$$Config[$i]{'name'}\" is invalid.\n"
214 unless(!$$Config[$i]{'expires'} || $$Config[$i]{'expires'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
215 warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
216 $$Config[$i]{'expires'} = '3m'; # set default (3 month) if expires is unset or invalid
218 unless(!$$Config[$i]{'mid-format'} || $$Config[$i]{'mid-format'} =~ /^<\S+\@(\S+\.)?\S{2,}\.\S{2,}>/) {
219 warn "$0: W: The Message-ID format for your project \"$$Config[$i]{'name'}\" seems to be invalid - set to default.\n";
220 $$Config[$i]{'mid-format'} = '<%n-%d.%m.%y@'.hostfqdn.'>'; # set default if mid-format is invalid
223 $Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
224 die $Error if $Error;
227 ################################# calcdelta #################################
228 # Takes a date (year, month and day) and a time period (1d, 1w, 1m, 1y, ...)
229 # and adds the latter to the former
232 my ($Year, $Month, $Day, $Period) = @_;
233 my ($NYear, $NMonth, $NDay);
235 if ($Period =~ /(\d+)\s*([dw])/) { # Is counted in days or weeks: Use Add_Delta_Days.
236 ($NYear, $NMonth, $NDay) = Add_Delta_Days($Year, $Month, $Day, (($2 eq "w")?$1 * 7: $1 * 1));
237 } elsif ($Period =~ /(\d+)\s*([my])/) { #Is counted in months or years: Use Add_Delta_YM
238 ($NYear, $NMonth, $NDay) = Add_Delta_YM($Year, $Month, $Day, (($2 eq "m")?(0,$1):($1,0)));
240 return ($NYear, $NMonth, $NDay);
243 ################################ updatestatus ###############################
244 # Takes a MID and a status file name
245 # and writes status information to disk
248 my ($ActName, $File, $date, $MID) = @_;
250 print "$$ActName: Save status information.\n" if($Options{'v'});
252 open (FH, ">$$File.cfg") or die "$0: E: Can't open $$File.cfg: $!";
253 print FH "##;; Lastpost: $date\n";
254 print FH "##;; LastMID: $MID\n";
258 ################################## postfaq ##################################
259 # Takes a filename and many other vars.
261 # It reads the data-file $File and then posts the article.
264 my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
265 my (@Header,@Body,$MID,$InRealBody,$LastModified);
267 print "$$ActName: Preparing to post.\n" if($Options{'v'});
270 $$TDM = ($$TDM < 10 && $$TDM !~ /^0/) ? "0" . $$TDM : $$TDM;
271 $$TDD = ($$TDD < 10 && $$TDD !~ /^0/) ? "0" . $$TDD : $$TDD;
272 my $Timestamp = time;
275 $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID); # set to default if unset
276 $MID =~ s/\%n/$$ActName/g;
277 $MID =~ s/\%d/$$TDD/g;
278 $MID =~ s/\%m/$$TDM/g;
279 $MID =~ s/\%y/$$TDY/g;
280 $MID =~ s/\%t/$Timestamp/g;
283 open (FH, "<$$File");
286 push (@Body, $_), next if $InRealBody;
287 $InRealBody++ if /^$/;
288 $LastModified = $1 if /^Last-modified: (\S+)$/i;
292 push @Body, "\n" if ($Body[-1] ne "\n");
294 #Create Date- and Expires-Header:
295 my @time = localtime;
296 my $ss = ($time[0]<10) ? "0" . $time[0] : $time[0];
297 my $mm = ($time[1]<10) ? "0" . $time[1] : $time[1];
298 my $hh = ($time[2]<10) ? "0" . $time[2] : $time[2];
300 my $month = ($time[4]+1<10) ? "0" . ($time[4]+1) : $time[4]+1;
301 my $monthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$time[4]];
302 my $wday = ("Sun","Mon","Tue","Wed","Thu","Fri","Sat")[$time[6]];
303 my $year = (1900 + $time[5]);
304 my $tz = $time[8] ? " +0200" : " +0100";
306 $$Expire = '3m' if !$$Expire; # set default if unset: 3 month
308 my ($expY,$expM,$expD) = calcdelta ($year,$month,$day,$$Expire);
309 my $expmonthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$expM-1];
311 my $date = "$day $monthN $year " . $hh . ":" . $mm . ":" . $ss . $tz;
312 my $expdate = "$expD $expmonthN $expY $hh:$mm:$ss$tz";
314 #Replace %LM by the content of the news.answer-pseudo-header Last-modified:
316 $$Subject =~ s/\%LM/$LastModified/;
320 if($Options{'t'} and $Options{'t'} !~ /console/i) {
321 $$NG = $Options{'t'};
324 #Now create the complete Header:
325 push @Header, "From: $$From\n";
326 push @Header, "Newsgroups: $$NG\n";
327 push @Header, "Followup-To: $$Fup2\n" if $$Fup2;
328 push @Header, "Subject: $$Subject\n";
329 push @Header, "Message-ID: $MID\n";
330 push @Header, "Supersedes: $$Supersedes\n" if $$Supersedes;
331 push @Header, "Date: $date\n";
332 push @Header, "Expires: $expdate\n";
333 push @Header, "Sender: $$Sender\n" if $$Sender;
334 push @Header, "Mime-Version: 1.0\n";
335 push @Header, "Reply-To: $$ReplyTo\n" if $$ReplyTo;
336 push @Header, "Content-Type: text/plain; charset=ISO-8859-15\n";
337 push @Header, "Content-Transfer-Encoding: 8bit\n";
338 push @Header, "User-Agent: yapfaq/$Version\n";
339 if ($$ExtraHeaders) {
340 push @Header, "$_\n" for (split /\n/, $$ExtraHeaders);
343 # sign article if $UsePGP is true
344 my @Article = ($Config{'UsePGP'})?@{signpgp(\@Header, \@Body)}:(@Header, "\n", @Body);
347 print "$$ActName: Posting article ...\n" if($Options{'v'});
348 my $failure = post(\@Article);
351 print "$$ActName: Posting failed, ERROR.dat may have more information.\n" if($Options{'v'} && (!defined($Options{'t'}) || $Options{'t'} !~ /console/i));
353 updatestatus($ActName, $File, "$day.$month.$year", $MID) if !defined($Options{'t'});
357 ################################## post ##################################
358 # Takes a complete article (Header and Body).
360 # It opens a connection to $NNTPServer and posts the message.
366 # test mode - print article to console
367 if(defined($Options{'t'}) and $Options{'t'} =~ /console/i) {
368 print "-----BEGIN--------------------------------------------------\n";
370 print "------END---------------------------------------------------\n";
371 # pipe article to script
372 } elsif(defined($Options{'s'})) {
373 open (POST, "| $Options{'s'}") or die "$0: E: Cannot fork $Options{'s'}: $!\n";
374 print POST @$ArticleR;
379 warn "$0: W: $Options{'s'} exited with status ", ($? >> 8), "\n";
384 my $NewsConnection = Net::NNTP->new($Config{'NNTPServer'}, Reader => 1) or die "$0: E: Can't connect to news server '$Config{'NNTPServer'}'!\n";
385 $NewsConnection->authinfo ($Config{'NNTPUser'}, $Config{'NNTPPass'}) if (defined($Config{'NNTPUser'}));
386 $NewsConnection->post();
387 $NewsConnection->datasend (@$ArticleR);
388 $NewsConnection->dataend();
390 if ($NewsConnection->ok()) {
392 # Posting failed? Save to ERROR.dat
394 warn "$0: W: Posting failed!\n";
395 open FH, ">>ERROR.dat";
396 print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n";
397 print FH $NewsConnection->code();
398 print FH $NewsConnection->message();
401 print FH "-" x 80, "\n";
404 $NewsConnection->quit();
409 #-------- sub getpgpcommand
410 # getpgpcommand generates the command to sign the message and returns it.
413 # - $PGPVersion: A scalar holding the PGPVersion
415 my ($PGPVersion) = @_;
418 if ($PGPVersion eq '2') {
419 if ($Config{'PathtoPGPPass'} && !$Config{'PGPPass'}) {
420 open (PGPPW, $Config{'PathtoPGPPass'}) or die "$0: E: Can't open $Config{'PathtoPGPPass'}: $!";
421 Config{'$PGPPass'} = <PGPPW>;
425 if (Config{'$PGPPass'}) {
426 $PGPCommand = "PGPPASS=\"".$Config{'PGPPass'}."\" ".$Config{'pgp'}." -u \"".$Config{'PGPSigner'}."\" +verbose=0 language='en' -saft <".$Config{'pgptmpf'}.".txt >".$Config{'pgptmpf'}.".txt.asc";
428 die "$0: E: PGP-Passphrase is unknown!\n";
430 } elsif ($PGPVersion eq '5') {
431 if ($Config{'PathtoPGPPass'}) {
432 $PGPCommand = "PGPPASSFD=2 ".$Config{'pgp'}."s -u \"".$Config{'PGPSigner'}."\" -t --armor -o ".$Config{'pgptmpf'}.".txt.asc -z -f < ".$Config{'pgptmpf'}.".txt 2<".$Config{'PathtoPGPPass'};
434 die "$0: E: PGP-Passphrase is unknown!\n";
436 } elsif ($PGPVersion =~ m/GPG/io) {
437 if (Config{'$PathtoPGPPass'}) {
438 $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";
440 die "$0: E: Passphrase is unknown!\n";
443 die "$0: E: Unknown PGP-Version $PGPVersion!";
449 #-------- sub signarticle
450 # signarticle signs an articel and returns a reference to an array
451 # containing the whole signed Message.
454 # - $HeaderAR: A reference to a array containing the articles headers.
455 # - $BodyR: A reference to an array containing the body.
458 # - $MessageRef: A reference to an array containing the whole message.
460 my ($HeaderAR, $BodyR) = @_;
461 my (@pgphead, @pgpbody, $pgphead, $pgpbody, $header, $signheaders, @signheaders, $currentheader, $HeaderR, $line);
463 foreach my $line (@$HeaderAR) {
464 if ($line =~ /^(\S+):\s+(.*)$/s) {
466 $$HeaderR{lc($currentheader)} = "$1: $2";
468 $$HeaderR{lc($currentheader)} .= $line;
472 foreach (@PGPSignHeaders) {
473 if (defined($$HeaderR{lc($_)}) && $$HeaderR{lc($_)} =~ m/^[^\s:]+: .+/o) {
474 push @signheaders, $_;
478 $pgpbody = join ("", @$BodyR);
480 # Delete and create the temporary pgp-Files
481 unlink "$Config{'pgptmpf'}.txt";
482 unlink "$Config{'pgptmpf'}.txt.asc";
483 $signheaders = join(",", @signheaders);
485 $pgphead = "X-Signed-Headers: $signheaders\n";
486 foreach $header (@signheaders) {
487 if ($$HeaderR{lc($header)} =~ m/^[^\s:]+: (.+?)\n?$/so) {
488 $pgphead .= $header.": ".$1."\n";
492 open(FH, ">" . $Config{'pgptmpf'} . ".txt") or die "$0: E: can't open $Config{'pgptmpf'}: $!\n";
493 print FH $pgphead, "\n", $pgpbody;
494 print FH "\n" if ($Config{'PGPVersion'} =~ m/GPG/io); # workaround a pgp/gpg incompatibility - should IMHO be fixed in pgpverify
495 close(FH) or warn "$0: W: Couldn't close TMP: $!\n";
497 # Start PGP, then read the signature;
498 my $PGPCommand = getpgpcommand($Config{'PGPVersion'});
501 open (FH, "<" . $Config{'pgptmpf'} . ".txt.asc") or die "$0: E: can't open ".$Config{'pgptmpf'}.".txt.asc: $!\n";
502 $/ = "$Config{'pgpbegin'}\n";
504 unless (m/\Q$Config{'pgpbegin'}\E$/o) {
505 # unlink $Config{'pgptmpf'} . ".txt";
506 # unlink $Config{'pgptmpf'} . ".txt.asc";
507 die "$0: E: $Config{'pgpbegin'} not found in ".$Config{'pgptmpf'}.".txt.asc\n"
509 unlink($Config{'pgptmpf'} . ".txt") or warn "$0: W: Couldn't unlink $Config{'pgptmpf'}.txt: $!\n";
513 unless (m/^Version: (\S+)(?:\s(\S+))?/o) {
514 unlink $Config{'pgptmpf'} . ".txt";
515 unlink $Config{'pgptmpf'} . ".txt.asc";
516 die "$0: E: didn't find PGP Version line where expected.\n";
520 $$HeaderR{$Config{'pgpheader'}} = $1."-".$2." ".$signheaders;
522 $$HeaderR{$Config{'pgpheader'}} = $1." ".$signheaders;
525 do { # skip other pgp headers like
526 $_ = <FH>; # "charset:"||"comment:" until empty line
531 last if /^\Q$Config{'pgpend'}\E$/;
532 $$HeaderR{$Config{'pgpheader'}} .= "\n\t$_";
535 $$HeaderR{$Config{'pgpheader'}} .= "\n" unless ($$HeaderR{$Config{'pgpheader'}} =~ /\n$/s);
539 unlink $Config{'pgptmpf'} . ".txt";
540 unlink $Config{'pgptmpf'} . ".txt.asc";
541 die "$0: E: unexpected data following $Config{'pgpend'}\n";
544 unlink "$Config{'pgptmpf'}.txt.asc";
546 my $tmppgpheader = $Config{'pgpheader'} . ": " . $$HeaderR{$Config{'pgpheader'}};
547 delete $$HeaderR{$Config{'pgpheader'}};
550 foreach $header (@PGPorderheaders) {
551 if ($$HeaderR{$header} && $$HeaderR{$header} ne "\n") {
552 push(@pgphead, "$$HeaderR{$header}");
553 delete $$HeaderR{$header};
557 foreach $header (keys %$HeaderR) {
558 if ($$HeaderR{$header} && $$HeaderR{$header} ne "\n") {
559 push(@pgphead, "$$HeaderR{$header}");
560 delete $$HeaderR{$header};
564 push @pgphead, ("X-PGP-Key: " . $Config{'PGPSigner'} . "\n"), $tmppgpheader;
567 @pgpbody = split /$/m, $pgpbody;
568 my @pgpmessage = (@pgphead, "\n", @pgpbody);
574 ################################ Documentation #################################
578 yapfaq - Post Usenet FAQs I<(yet another postfaq)>
582 B<yapfaq> [B<-Vhvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>] [B<-s> I<program>] [B<-c> I<.rc file>]
606 Furthermore you need access to a news server to actually post FAQs.
610 B<yapfaq> posts (one or more) FAQs to Usenet with a certain posting
611 frequency (every n days, weeks, months or years), adding all necessary
612 headers as defined in its config file (by default F<yapfaq.cfg>).
616 F<yapfaq.cfg> consists of one or more blocks, separated by C<=====> on
617 a single line, each containing the configuration for one FAQ as a set
618 of definitions in the form of I<param = value>. Everything after a "#"
619 sign is ignored so you may comment your configuration file.
623 =item B<Name> = I<project name>
625 A name referring to your FAQ, also used for generation of a Message-ID.
627 This value must be set.
629 =item B<File> = I<file name>
631 A file containing the message body of your FAQ and all pseudo headers
632 (subheaders in the news.answers style).
634 This value must be set.
636 =item B<Posting-frequency> = I<time period>
638 The posting frequency defines how often your FAQ will be posted.
639 B<yapfaq> will only post your FAQ if this period of time has passed
640 since the last posting.
642 You can declare that time period either in I<B<d>ays> or I<B<w>weeks>
643 or I<B<m>onths> or I<B<y>ears>.
645 This value must be set.
647 =item B<Expires> = I<time period> (optional)
649 The period of time after which your message will expire. An Expires
650 header will be calculated adding this time period to today's date.
652 You can declare this time period either in I<B<d>ays> or I<B<w>weeks>
653 or I<B<m>onths> or I<B<y>ears>.
655 This setting is optional; the default is 3 months.
657 =item B<From> = I<author>
659 The author of your FAQ as it will appear in the From header of the
662 This value must be set.
664 =item B<Subject> = I<subject>
666 The title of your FAQ as it will appear in the Subject header of the
669 You may use the special string C<%LM> which will be replaced with
670 the contents of the Last-Modified subheader in your I<File>.
672 This value must be set.
674 =item B<NGs> = I<newsgroups>
676 A comma-separated list of newsgroup(s) to post your FAQ to as it will
677 appear in the Newsgroups header of the message.
679 This value must be set.
681 =item B<Fup2> = I<newsgroup | poster> (optional)
683 A comma-separated list of newsgroup(s) or the special string I<poster>
684 as it will appear in the Followup-To header of the message.
686 This setting is optional.
688 =item B<MID-Format> = I<pattern> (optional)
690 A pattern from which the message ID is generated as it will appear in
691 the Message-ID header of the message.
693 You may use the special strings C<%n> for the I<Name> of your project,
694 C<%d> for the date the message is posted, C<%m> for the month, C<%y>
695 for the year and C<%t> for a time stamp (number of seconds since the
696 epoch), respectively.
698 This setting is optional; the default is '<%n-%d.%m.%y@I<YOURHOST>>'
699 where I<YOURHOST> is the fully qualified domain name (FQDN) of the
700 host B<yapfaq> is running on. Obviously that will only work if you
701 have defined a reasonable hostname that the hostfqdn() function of
702 Net::Domain can return.
704 =item B<Supersede> = I<yes> (optional)
706 Add Supersedes header to the message containing the Message-ID header
709 This setting is optional; you should set it to yes or leave it out.
711 =item B<ExtraHeader> = I<additional headers> (optional)
713 The contents of I<ExtraHeader> is added verbatim to the headers of
714 your message so you can add custom headers like Approved.
716 This setting is optional.
720 =head3 Example configuration file
722 # name of your project
725 # file to post (complete body and pseudo-headers)
726 # ($File.cfg contains data on last posting and last MID)
729 # how often your project should be posted
730 # use (d)ay OR (w)eek OR (m)onth OR (y)ear
731 Posting-frequency = '1d'
733 # time period after which the posting should expire
734 # use (d)ay OR (w)eek OR (m)onth OR (y)ear
738 From = 'test@domain.invalid'
741 # (may contain "%LM" which will be replaced by the contents of the
742 # Last-Modified pseudo header).
743 Subject = 'test noreply ignore'
745 # comma-separated list of newsgroup(s) to post to
746 # (header "Newsgroups:")
749 # header "Followup-To:"
752 # Message-ID ("%n" is $Name)
753 # MID-Format = '<%n-%d.%m.%y@domain.invalid>'
755 # Supersede last posting?
758 # extra headers (appended verbatim)
759 # use this for custom headers like "Approved:"
760 ExtraHeader = 'Approved: moderator@domain.invalid
763 # other projects may follow separated with "====="
768 Posting-frequency = '2m'
769 From = 'My Name <my.name@domain.invalid>'
770 Subject = 'Test of yapfag <%LM>'
771 NGs = 'de.test,de.alt.test'
773 MID-Format = '<%n-%m.%y@domain.invalid>'
776 =head3 Status Information
778 Information about the last post and about how to form message IDs for
779 posts is stored in a file named F<I<project name>.cfg> which will be
780 generated if it does not exist. Each of those status files will
781 contain two lines, the first being the date of the last time the FAQ
782 was posted and the second being the message ID of that incarnation.
784 =head2 Runtime Configuration
786 Apart from configuring which FAQ(s) to post you may (re)set some
787 runtime configuration variables via the .rcfile (by default
788 F<.yapfaqrc>). F<.yapfaqrc> must contain one definition in the form of
789 I<param = value> on each line; everything after a "#" sign is ignored.
791 If you omit some settings they will be set to default values hardcoded
794 B<Please note that all parameter names are case-sensitive!>
798 =item B<NNTPServer> = I<NNTP server> (mandatory)
800 Host name of the NNTP server to post to. Must be set (or omitted; the
801 default is "localhost"); if set to en empty string, B<yapfaq> falls
802 back to Perl's build-in defaults (contents of environment variables
803 NNTPSERVER and NEWSHOST; if not set, default from Net::Config; if not
804 set, "news" is used).
806 =item B<NNTPUser> = I<user name> (optional)
808 User name used for authentication with the NNTP server (I<AUTHINFO
811 This setting is optional; if it is not set, I<NNTPPass> is ignored and
812 no authentication is tried.
814 =item B<NNTPPass> = I<password> (optional)
816 Password used for authentication with the NNTP server (I<AUTHINFO
819 This setting is optional; it must be set if I<NNTPUser> is present.
821 =item B<Sender> = I<Sender header> (optional)
823 The Sender header that will be added to every posted message.
825 This setting is optional.
827 =item B<ConfigFile> = I<configuration file> (mandatory)
829 The configuration file defining the FAQ(s) to post. Must be set (or
830 omitted; the default is "yapfaq.cfg").
832 =item B<UsePGP> = I<whether to add a digital signature> (optional)
834 Boolean value (0 or 1) controlling whether the FAQs will get digitally
835 signed via an X-PGP-Sig header.
837 This setting is optional; the default is 0.
839 If you have set I<UsePGP> to 1, you must also supply the necessary
840 information on your PGP oder GPG installation; please refer to the
841 sample F<.yapfaqrc> file (see below) for more information on this
846 =head3 Example runtime configuration file
848 NNTPServer = 'localhost'
852 ConfigFile = 'yapfaq.cfg'
855 ################################## PGP-Config #################################
856 pgp = '/usr/bin/pgp' # path to pgp
857 PGPVersion = '2' # Use 2 for 2.X 5 for PGP > 2.X and GPG for GPG
858 PGPSigner = '' # sign as who?
859 PGPPass = '' # pgp2 only
860 PathtoPGPPass = '' # pgp2 pgp5 and gpg
861 pgpbegin = '-----BEGIN PGP SIGNATURE-----' # Begin of PGP-Signature
862 pgpend = '-----END PGP SIGNATURE-----' # End of PGP-Signature
863 pgptmpf = 'pgptmp' # temporary file for PGP.
864 pgpheader = 'X-PGP-Sig'
866 =head3 Using more than one runtime configuration
868 You may use more than one runtime configuration file with the B<-c>
875 =item B<-V> (version)
877 Print out version and copyright information on B<yapfaq> and exit.
881 Print this man page and exit.
883 =item B<-v> (verbose)
885 Print out status information while running to STDOUT.
887 =item B<-p> (post unconditionally)
889 Post (all) FAQs unconditionally ignoring the posting frequency setting.
891 You may want to use this with the B<-f> option (see below).
893 =item B<-d> (dry run)
895 Start B<yapfaq> in simulation mode, i.e. don't post anything and don't
896 update any status information.
898 =item B<-t> I<newsgroup(s) | CONSOLE> (test)
900 Don't post to the newsgroups defined in F<yqpfaq.cfg>, but to the
901 newsgroups given after B<-t> as a comma-separated list or print the
902 FAQs to STDOUT separated by lines of dashes if the special string
903 C<CONSOLE> is given. This can be used to preview what B<yapfaq> would
904 do without embarassing yourself on Usenet. The status files are not
905 updated when this option is given.
907 You may want to use this with the B<-f> option (see below).
909 =item B<-f> I<project name>
911 Just deal with one FAQ only.
913 By default B<yapfaq> will work on all FAQs that are defined in
914 F<yapfaq.cfg>, check whether they are due for posting and - if they
915 are - post them. Consequently when the B<-p> option is set all FAQs
916 will be posted unconditionally. That may not be what you want to
917 achieve, so you can limit the operation of B<yapfaq> to the named FAQ
920 =item B<-s> I<program> (pipe to script)
922 Instead of posting the article(s) to Usenet pipe them to the external
923 I<program> on STDIN (which may post the article(s) then). A return
924 value of 0 will be considered success.
926 =item B<-c> I<.rc file>
928 Load another runtime configuration file (.rc file) than F<.yaofaq.rc>.
930 You may for example define another usenet server to post your FAQ(s)
931 to or load another configuration file defining (an)other FAQ(s).
937 Post all FAQs that are due for posting:
941 Do a dry run, showing which FAQs would be posted:
945 Do a test run and print on STDOUT what the FAQ I<myfaq> would look
946 like when posted, regardless whether it is due for posting or not:
948 yapfaq -pt CONSOLE -f myfaq
950 Do a "real" test run and post the FAQ I<myfaq> to I<de.test>, but only
953 yapfaq -t de.test -f myfaq
955 Post all FAQs (that are due for posting) using inews from INN:
959 Do a dry run using a runtime configuration from .alternaterc, showing
960 which FAQs would be posted:
962 yapfaq -dvc .alternaterc
970 The default NNTP server to post to, used by the Net::NNTP module. You
971 can also specify the server using the runtime configuration file (by
972 default F<.yapfaqrc>).
986 Runtime configuration file for B<yapfaq>.
990 Configuration file for B<yapfaq>.
996 The status files will be created on successful posting if they don't
997 already exist. The first line of the file will be the date of the last
998 time the FAQ was posted and the second line will be the message ID of
999 the last post of that FAQ.
1009 L<http://th-h.de/download/scripts.php> will have the current
1010 version of this program.
1014 Thomas Hochstein <thh@inter.net>
1016 Original author (up to version 0.5b, dating from 2003):
1017 Marc Brockschmidt <marc@marcbrockschmidt.de>
1019 =head1 COPYRIGHT AND LICENSE
1021 Copyright (c) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
1023 Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
1025 This program is free software; you may redistribute it and/or modify it
1026 under the same terms as Perl itself.