Change: Drop %LM from subject if Last-Modified is not found.
[usenet/yapfaq.git] / yapfaq.pl
CommitLineData
dc88d139
TH
1#! /usr/bin/perl -W
2#
994d9759 3# yapfaq Version 0.8.1 by Thomas Hochstein
7aaba0e0 4# (Original author: Marc Brockschmidt)
dc88d139 5#
7aaba0e0 6# This script posts any project described in its config-file. Most people
dc88d139
TH
7# will use it in combination with cron(8).
8#
9# Copyright (C) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
7aaba0e0 10# Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
dc88d139
TH
11#
12# It can be redistributed and/or modified under the same terms under
13# which Perl itself is published.
14
dc66bfa3 15our $VERSION = "0.9-prelease";
dc88d139 16
605916ef
TH
17# Please do not change this setting!
18# You may override the default .rc file (.yapfaqrc) by using "-c .rc file"
d60c2d5f 19my $RCFile = '.yapfaqrc';
605916ef 20# Valid configuration variables for use in a .rc file
39cb5672 21my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile','Program');
d60c2d5f 22
605916ef
TH
23################################### Defaults ###################################
24# Please do not change anything in here!
25# Use a runtime configuration file (.yapfaqrc by default) to override defaults.
7ef63844 26my %Config = (NNTPServer => "",
2507947f
TH
27 NNTPUser => "",
28 NNTPPass => "",
29 Sender => "",
39cb5672
TH
30 ConfigFile => "yapfaq.cfg",
31 Program => "");
dc88d139 32
605916ef 33################################# Main program #################################
dc88d139
TH
34
35use strict;
36use Net::NNTP;
40847f71 37use Net::Domain qw(hostfqdn);
dc88d139
TH
38use Date::Calc qw(Add_Delta_YM Add_Delta_Days Delta_Days Today);
39use Fcntl ':flock'; # import LOCK_* constants
4251e545 40use Getopt::Std;
bdbb9d70 41$Getopt::Std::STANDARD_HELP_VERSION = 1;
dc88d139
TH
42my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date
43
b9550622 44# read commandline options
4251e545 45my %Options;
86c0a100 46getopts('Vhvpdt:f:c:s:', \%Options);
b9550622 47# -V: print version / copyright information
a052296f 48if ($Options{'V'}) {
bdbb9d70 49 print "$0 v $VERSION\nCopyright (c) 2003 Marc Brockschmidt <marc\@marcbrockschmidt.de>\nCopyright (c) 2010 Thomas Hochstein <thh\@inter.net>\n";
a052296f
TH
50 print "This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.\n";
51 exit(0);
52}
b9550622 53# -h: feed myself to perldoc
4251e545 54if ($Options{'h'}) {
ae3b1b79 55 exec ('perldoc', $0);
4251e545
TH
56 exit(0);
57};
b9550622 58# -f: set $Faq
4251e545
TH
59my ($Faq) = $Options{'f'} if ($Options{'f'});
60
d60c2d5f 61# read runtime configuration (configuration variables)
86c0a100
TH
62$RCFile = $Options{'c'} if ($Options{'c'});
63if (-f $RCFile) {
64 readrc (\$RCFile,\%Config);
65} else {
66 warn "$0: W: .rc file $RCFile does not exist!\n";
67}
d60c2d5f 68
ba8ae1cf 69$Options{'s'} = $Config{'Program'} if (defined($Config{'Program'}) && $Config{'Program'} && !defined($Options{'s'}));
39cb5672 70
b9550622 71# read configuration (configured FAQs)
dc88d139 72my @Config;
2507947f 73readconfig (\$Config{'ConfigFile'}, \@Config, \$Faq);
dc88d139 74
b9550622
TH
75# for each FAQ:
76# - parse configuration
77# - read status data
78# - if FAQ is due: call postfaq()
dc88d139
TH
79foreach (@Config) {
80 my ($LPD,$LPM,$LPY) = (01, 01, 0001); #LP: Last posting-date
81 my ($NPY,$NPM,$NPD); #NP: Next posting-date
82 my $SupersedeMID;
83
0c6ebe78 84 my ($ActName,$File,$PFreq,$Expire) =($$_{'name'},$$_{'file'},$$_{'posting-frequency'},$$_{'expires'});
dc88d139
TH
85 my ($From,$Subject,$NG,$Fup2)=($$_{'from'},$$_{'subject'},$$_{'ngs'},$$_{'fup2'});
86 my ($MIDF,$ReplyTo,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'extraheader'});
87 my ($Supersede) =($$_{'supersede'});
4251e545 88
b9550622 89 # -f: loop if not FAQ to post
4251e545
TH
90 next if (defined($Faq) && $ActName ne $Faq);
91
b9550622 92 # read status data
dc88d139
TH
93 if (open (FH, "<$File.cfg")) {
94 while(<FH>){
95 if (/##;; Lastpost:\s*(\d{1,2})\.(\d{1,2})\.(\d{2}(\d{2})?)/){
96 ($LPD, $LPM, $LPY) = ($1, $2, $3);
97 } elsif (/^##;;\s*LastMID:\s*(<\S+@\S+>)\s*$/) {
98 $SupersedeMID = $1;
99 }
100 }
101 close FH;
102 } else {
74407146 103 warn "$0: W: Couldn't open $File.cfg: $!\n";
dc88d139
TH
104 }
105
106 $SupersedeMID = "" unless $Supersede;
107
0c6ebe78
TH
108 ($NPY,$NPM,$NPD) = calcdelta ($LPY,$LPM,$LPD,$PFreq);
109
b9550622 110 # if FAQ is due: get it out
4251e545
TH
111 if (Delta_Days($NPY,$NPM,$NPD,$TDY,$TDM,$TDD) >= 0 or ($Options{'p'})) {
112 if($Options{'d'}) {
113 print "$ActName: Would be posted now (but running in simulation mode [$0 -d]).\n" if $Options{'v'};
114 } else {
2507947f 115 postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Config{'Sender'},\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
4251e545
TH
116 }
117 } elsif($Options{'v'}) {
118 print "$ActName: Nothing to do.\n";
dc88d139
TH
119 }
120}
121
122exit;
123
d60c2d5f
TH
124#################################### readrc ####################################
125# Takes a filename and the reference to an array which contains the valid options
126
127sub readrc{
128 my ($File, $Config) = @_;
129
130 print "Reading $$File.\n" if($Options{'v'});
131
132 open FH, "<$$File" or die "$0: Can't open $$File: $!";
133 while (<FH>) {
134 if (/^\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)/) {
135 if (grep(/$1/,@ValidConfVars)) {
136 $$Config{$1} = $2 if $2 ne '';
137 } else {
138 warn "$0: W: $1 is not a valid configuration variable (reading from $$File)\n";
139 }
140 }
141 }
142}
143
dc88d139 144################################## readconfig ##################################
4251e545
TH
145# Takes a filename, a reference to an array, which will hold hashes with
146# the data from $File, and - optionally - the name of the (single) FAQ to post
dc88d139
TH
147
148sub readconfig{
4251e545 149 my ($File, $Config, $Faq) = @_;
dc88d139
TH
150 my ($LastEntry, $Error, $i) = ('','',0);
151
b802358a 152 print "Reading configuration from $$File.\n" if($Options{'v'});
4251e545 153
74407146 154 open FH, "<$$File" or die "$0: E: Can't open $$File: $!";
dc88d139 155 while (<FH>) {
4251e545 156 next if (defined($$Faq) && !/^\s*=====\s*$/ && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
dc88d139
TH
157 if (/^(\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)|^(.*?)'?\s*(#.*$|$))/ && not /^\s*$/) {
158 $LastEntry = lc($2) if $2;
159 $$Config[$i]{$LastEntry} .= $3 if $3;
160 $$Config[$i]{$LastEntry} .= "\n$5" if $5 && $5;
161 }
162 if (/^\s*=====\s*$/) {
163 $i++;
164 }
165 }
166 close FH;
167
168 #Check saved values:
169 for $i (0..$i){
4251e545 170 next if (defined($$Faq) && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
dbca4ad8
TH
171 unless(defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} =~ /^\S+$/) {
172 $Error .= "E: The name of your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
dc88d139 173 }
dbca4ad8
TH
174 unless(defined($$Config[$i]{'file'}) && -f $$Config[$i]{'file'}) {
175 $Error .= "E: The file to post for your project \"$$Config[$i]{'name'}\" is not defined or does not exist.\n"
176 }
177 unless(defined($$Config[$i]{'from'}) && $$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) {
178 $Error .= "E: The From header for your project \"$$Config[$i]{'name'}\" seems to be incorrect.\n"
179 }
180 unless(defined($$Config[$i]{'ngs'}) && $$Config[$i]{'ngs'} =~ /^\S+$/) {
181 $Error .= "E: The Newsgroups header for your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
182 }
183 unless(defined($$Config[$i]{'subject'})) {
184 $Error .= "E: The Subject header for your project \"$$Config[$i]{'name'}\" is not defined.\n"
dc88d139
TH
185 }
186 unless(!$$Config[$i]{'fup2'} || $$Config[$i]{'fup2'} =~ /^\S+$/) {
dbca4ad8 187 $Error .= "E: The Followup-To header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
dc88d139 188 }
dbca4ad8 189 unless(defined($$Config[$i]{'posting-frequency'}) && $$Config[$i]{'posting-frequency'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
74407146 190 $Error .= "E: The Posting-frequency for your project \"$$Config[$i]{'name'}\" is invalid.\n"
dc88d139 191 }
5ddba442 192 unless(!$$Config[$i]{'expires'} || $$Config[$i]{'expires'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
ac69c3ee
TH
193 warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
194 $$Config[$i]{'expires'} = '3m'; # set default (3 month) if expires is unset or invalid
0c6ebe78 195 }
8f067a2f 196 unless(!$$Config[$i]{'mid-format'} || $$Config[$i]{'mid-format'} =~ /^<\S+\@(\S+\.)?\S{2,}\.\S{2,}>/) {
ac69c3ee
TH
197 warn "$0: W: The Message-ID format for your project \"$$Config[$i]{'name'}\" seems to be invalid - set to default.\n";
198 $$Config[$i]{'mid-format'} = '<%n-%d.%m.%y@'.hostfqdn.'>'; # set default if mid-format is invalid
40847f71 199 }
dc88d139 200 }
dbca4ad8 201 $Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
dc88d139
TH
202 die $Error if $Error;
203}
204
0c6ebe78
TH
205################################# calcdelta #################################
206# Takes a date (year, month and day) and a time period (1d, 1w, 1m, 1y, ...)
207# and adds the latter to the former
208
209sub calcdelta {
210 my ($Year, $Month, $Day, $Period) = @_;
211 my ($NYear, $NMonth, $NDay);
212
213 if ($Period =~ /(\d+)\s*([dw])/) { # Is counted in days or weeks: Use Add_Delta_Days.
214 ($NYear, $NMonth, $NDay) = Add_Delta_Days($Year, $Month, $Day, (($2 eq "w")?$1 * 7: $1 * 1));
215 } elsif ($Period =~ /(\d+)\s*([my])/) { #Is counted in months or years: Use Add_Delta_YM
216 ($NYear, $NMonth, $NDay) = Add_Delta_YM($Year, $Month, $Day, (($2 eq "m")?(0,$1):($1,0)));
217 }
218 return ($NYear, $NMonth, $NDay);
219}
5a6670c7
TH
220
221################################ updatestatus ###############################
222# Takes a MID and a status file name
223# and writes status information to disk
224
225sub updatestatus {
226 my ($ActName, $File, $date, $MID) = @_;
227
228 print "$$ActName: Save status information.\n" if($Options{'v'});
229
230 open (FH, ">$$File.cfg") or die "$0: E: Can't open $$File.cfg: $!";
231 print FH "##;; Lastpost: $date\n";
232 print FH "##;; LastMID: $MID\n";
233 close FH;
234}
0c6ebe78 235
dc88d139
TH
236################################## postfaq ##################################
237# Takes a filename and many other vars.
238#
239# It reads the data-file $File and then posts the article.
240
241sub postfaq {
0c6ebe78 242 my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
dc88d139
TH
243 my (@Header,@Body,$MID,$InRealBody,$LastModified);
244
366322b2 245 print "$$ActName: Preparing to post.\n" if($Options{'v'});
4251e545 246
dc88d139
TH
247 #Prepare MID:
248 $$TDM = ($$TDM < 10 && $$TDM !~ /^0/) ? "0" . $$TDM : $$TDM;
249 $$TDD = ($$TDD < 10 && $$TDD !~ /^0/) ? "0" . $$TDD : $$TDD;
13ce8c26 250 my $Timestamp = time;
dc88d139
TH
251
252 $MID = $$MIDF;
ac69c3ee 253 $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID); # set to default if unset
dc88d139
TH
254 $MID =~ s/\%n/$$ActName/g;
255 $MID =~ s/\%d/$$TDD/g;
256 $MID =~ s/\%m/$$TDM/g;
257 $MID =~ s/\%y/$$TDY/g;
13ce8c26 258 $MID =~ s/\%t/$Timestamp/g;
dc88d139 259
dc88d139
TH
260 #Now get the body:
261 open (FH, "<$$File");
262 while (<FH>){
263 s/\r//;
264 push (@Body, $_), next if $InRealBody;
265 $InRealBody++ if /^$/;
b16eb1ae 266 $LastModified = $1 if /^Last-modified:\s*(\S+)\s*$/i;
dc88d139
TH
267 push @Body, $_;
268 }
269 close FH;
270 push @Body, "\n" if ($Body[-1] ne "\n");
271
272 #Create Date- and Expires-Header:
273 my @time = localtime;
274 my $ss = ($time[0]<10) ? "0" . $time[0] : $time[0];
275 my $mm = ($time[1]<10) ? "0" . $time[1] : $time[1];
276 my $hh = ($time[2]<10) ? "0" . $time[2] : $time[2];
277 my $day = $time[3];
278 my $month = ($time[4]+1<10) ? "0" . ($time[4]+1) : $time[4]+1;
279 my $monthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$time[4]];
280 my $wday = ("Sun","Mon","Tue","Wed","Thu","Fri","Sat")[$time[6]];
281 my $year = (1900 + $time[5]);
282 my $tz = $time[8] ? " +0200" : " +0100";
7823ece9
TH
283
284 $$Expire = '3m' if !$$Expire; # set default if unset: 3 month
285
0c6ebe78 286 my ($expY,$expM,$expD) = calcdelta ($year,$month,$day,$$Expire);
dc88d139
TH
287 my $expmonthN = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec")[$expM-1];
288
289 my $date = "$day $monthN $year " . $hh . ":" . $mm . ":" . $ss . $tz;
290 my $expdate = "$expD $expmonthN $expY $hh:$mm:$ss$tz";
0c6ebe78 291
dc88d139
TH
292 #Replace %LM by the content of the news.answer-pseudo-header Last-modified:
293 if ($LastModified) {
294 $$Subject =~ s/\%LM/$LastModified/;
3b2e5e06
TH
295 } else {
296 $$Subject =~ s/[<\[{\(]?\%LM[>\]}\)]?//;
dc88d139
TH
297 }
298
4251e545
TH
299 # Test mode?
300 if($Options{'t'} and $Options{'t'} !~ /console/i) {
301 $$NG = $Options{'t'};
302 }
303
dc88d139
TH
304 #Now create the complete Header:
305 push @Header, "From: $$From\n";
306 push @Header, "Newsgroups: $$NG\n";
307 push @Header, "Followup-To: $$Fup2\n" if $$Fup2;
308 push @Header, "Subject: $$Subject\n";
309 push @Header, "Message-ID: $MID\n";
310 push @Header, "Supersedes: $$Supersedes\n" if $$Supersedes;
311 push @Header, "Date: $date\n";
312 push @Header, "Expires: $expdate\n";
313 push @Header, "Sender: $$Sender\n" if $$Sender;
314 push @Header, "Mime-Version: 1.0\n";
315 push @Header, "Reply-To: $$ReplyTo\n" if $$ReplyTo;
316 push @Header, "Content-Type: text/plain; charset=ISO-8859-15\n";
317 push @Header, "Content-Transfer-Encoding: 8bit\n";
bdbb9d70 318 push @Header, "User-Agent: yapfaq/$VERSION\n";
dc88d139
TH
319 if ($$ExtraHeaders) {
320 push @Header, "$_\n" for (split /\n/, $$ExtraHeaders);
321 }
322
0e741504
TH
323 my @Article = (@Header, "\n", @Body);
324
b9550622 325 # post article
366322b2 326 print "$$ActName: Posting article ...\n" if($Options{'v'});
5a6670c7
TH
327 my $failure = post(\@Article);
328
329 if ($failure) {
330 print "$$ActName: Posting failed, ERROR.dat may have more information.\n" if($Options{'v'} && (!defined($Options{'t'}) || $Options{'t'} !~ /console/i));
331 } else {
332 updatestatus($ActName, $File, "$day.$month.$year", $MID) if !defined($Options{'t'});
333 }
dc88d139
TH
334}
335
336################################## post ##################################
337# Takes a complete article (Header and Body).
338#
339# It opens a connection to $NNTPServer and posts the message.
340
341sub post {
342 my ($ArticleR) = @_;
5a6670c7 343 my ($failure) = -1;
dc88d139 344
5a6670c7 345 # test mode - print article to console
4251e545 346 if(defined($Options{'t'}) and $Options{'t'} =~ /console/i) {
55bfbd3c 347 print "-----BEGIN--------------------------------------------------\n";
5a6670c7 348 print @$ArticleR;
55bfbd3c 349 print "------END---------------------------------------------------\n";
5a6670c7
TH
350 # pipe article to script
351 } elsif(defined($Options{'s'})) {
b855559e
TH
352 open (POST, "| $Options{'s'}") or die "$0: E: Cannot fork $Options{'s'}: $!\n";
353 print POST @$ArticleR;
354 close POST;
5a6670c7
TH
355 if ($? == 0) {
356 $failure = 0;
357 } else {
358 warn "$0: W: $Options{'s'} exited with status ", ($? >> 8), "\n";
359 $failure = $?;
360 }
361 # post article
362 } else {
363 my $NewsConnection = Net::NNTP->new($Config{'NNTPServer'}, Reader => 1) or die "$0: E: Can't connect to news server '$Config{'NNTPServer'}'!\n";
364 $NewsConnection->authinfo ($Config{'NNTPUser'}, $Config{'NNTPPass'}) if (defined($Config{'NNTPUser'}));
365 $NewsConnection->post();
366 $NewsConnection->datasend (@$ArticleR);
367 $NewsConnection->dataend();
368
369 if ($NewsConnection->ok()) {
370 $failure = 0;
371 # Posting failed? Save to ERROR.dat
372 } else {
373 warn "$0: W: Posting failed!\n";
374 open FH, ">>ERROR.dat";
375 print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n";
376 print FH $NewsConnection->code();
377 print FH $NewsConnection->message();
378 print FH "\n";
379 print FH @$ArticleR;
380 print FH "-" x 80, "\n";
381 close FH;
382 }
383 $NewsConnection->quit();
dc88d139 384 }
5a6670c7 385 return $failure;
dc88d139
TH
386}
387
272b0243
TH
388__END__
389
390################################ Documentation #################################
391
392=head1 NAME
393
394yapfaq - Post Usenet FAQs I<(yet another postfaq)>
395
396=head1 SYNOPSIS
397
9817f98a 398B<yapfaq> [B<-Vhvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>] [B<-s> I<program>] [B<-c> I<.rc file>]
272b0243
TH
399
400=head1 REQUIREMENTS
401
402=over 2
403
404=item -
405
406Perl 5.8 or later
407
408=item -
409
410Net::NNTP
411
412=item -
413
414Date::Calc
415
416=item -
417
418Getopt::Std
419
420=back
421
422Furthermore you need access to a news server to actually post FAQs.
423
424=head1 DESCRIPTION
425
426B<yapfaq> posts (one or more) FAQs to Usenet with a certain posting
427frequency (every n days, weeks, months or years), adding all necessary
428headers as defined in its config file (by default F<yapfaq.cfg>).
429
430=head2 Configuration
431
432F<yapfaq.cfg> consists of one or more blocks, separated by C<=====> on
433a single line, each containing the configuration for one FAQ as a set
227afd47
TH
434of definitions in the form of I<param = value>. Everything after a "#"
435sign is ignored so you may comment your configuration file.
272b0243
TH
436
437=over 4
438
439=item B<Name> = I<project name>
440
441A name referring to your FAQ, also used for generation of a Message-ID.
442
443This value must be set.
444
445=item B<File> = I<file name>
446
447A file containing the message body of your FAQ and all pseudo headers
448(subheaders in the news.answers style).
449
450This value must be set.
451
452=item B<Posting-frequency> = I<time period>
453
454The posting frequency defines how often your FAQ will be posted.
455B<yapfaq> will only post your FAQ if this period of time has passed
456since the last posting.
457
458You can declare that time period either in I<B<d>ays> or I<B<w>weeks>
459or I<B<m>onths> or I<B<y>ears>.
460
461This value must be set.
462
ac69c3ee 463=item B<Expires> = I<time period> (optional)
272b0243
TH
464
465The period of time after which your message will expire. An Expires
466header will be calculated adding this time period to today's date.
467
468You can declare this time period either in I<B<d>ays> or I<B<w>weeks>
469or I<B<m>onths> or I<B<y>ears>.
470
ac69c3ee 471This setting is optional; the default is 3 months.
272b0243
TH
472
473=item B<From> = I<author>
474
475The author of your FAQ as it will appear in the From header of the
476message.
477
478This value must be set.
479
480=item B<Subject> = I<subject>
481
482The title of your FAQ as it will appear in the Subject header of the
483message.
484
485You may use the special string C<%LM> which will be replaced with
486the contents of the Last-Modified subheader in your I<File>.
487
488This value must be set.
489
490=item B<NGs> = I<newsgroups>
491
492A comma-separated list of newsgroup(s) to post your FAQ to as it will
493appear in the Newsgroups header of the message.
494
495This value must be set.
496
ac69c3ee 497=item B<Fup2> = I<newsgroup | poster> (optional)
272b0243
TH
498
499A comma-separated list of newsgroup(s) or the special string I<poster>
500as it will appear in the Followup-To header of the message.
501
502This setting is optional.
503
ac69c3ee 504=item B<MID-Format> = I<pattern> (optional)
272b0243
TH
505
506A pattern from which the message ID is generated as it will appear in
507the Message-ID header of the message.
508
509You may use the special strings C<%n> for the I<Name> of your project,
13ce8c26
TH
510C<%d> for the date the message is posted, C<%m> for the month, C<%y>
511for the year and C<%t> for a time stamp (number of seconds since the
512epoch), respectively.
272b0243 513
ac69c3ee
TH
514This setting is optional; the default is '<%n-%d.%m.%y@I<YOURHOST>>'
515where I<YOURHOST> is the fully qualified domain name (FQDN) of the
516host B<yapfaq> is running on. Obviously that will only work if you
517have defined a reasonable hostname that the hostfqdn() function of
518Net::Domain can return.
272b0243 519
ac69c3ee 520=item B<Supersede> = I<yes> (optional)
272b0243
TH
521
522Add Supersedes header to the message containing the Message-ID header
523of the last posting.
524
525This setting is optional; you should set it to yes or leave it out.
526
ac69c3ee 527=item B<ExtraHeader> = I<additional headers> (optional)
272b0243
TH
528
529The contents of I<ExtraHeader> is added verbatim to the headers of
530your message so you can add custom headers like Approved.
531
532This setting is optional.
533
534=back
535
227afd47 536=head3 Example configuration file
272b0243
TH
537
538 # name of your project
539 Name = 'testpost'
540
541 # file to post (complete body and pseudo-headers)
542 # ($File.cfg contains data on last posting and last MID)
543 File = 'test.txt'
544
545 # how often your project should be posted
546 # use (d)ay OR (w)eek OR (m)onth OR (y)ear
547 Posting-frequency = '1d'
548
549 # time period after which the posting should expire
550 # use (d)ay OR (w)eek OR (m)onth OR (y)ear
ac69c3ee 551 # Expires = '3m'
272b0243
TH
552
553 # header "From:"
554 From = 'test@domain.invalid'
555
556 # header "Subject:"
557 # (may contain "%LM" which will be replaced by the contents of the
558 # Last-Modified pseudo header).
559 Subject = 'test noreply ignore'
560
561 # comma-separated list of newsgroup(s) to post to
562 # (header "Newsgroups:")
563 NGs = 'de.test'
564
565 # header "Followup-To:"
ac69c3ee 566 # Fup2 = 'poster'
272b0243
TH
567
568 # Message-ID ("%n" is $Name)
ac69c3ee 569 # MID-Format = '<%n-%d.%m.%y@domain.invalid>'
272b0243
TH
570
571 # Supersede last posting?
572 Supersede = yes
573
574 # extra headers (appended verbatim)
575 # use this for custom headers like "Approved:"
576 ExtraHeader = 'Approved: moderator@domain.invalid
577 X-Header: Some text'
578
579 # other projects may follow separated with "====="
580 =====
581
582 Name = 'othertest'
583 File = 'test.txt'
584 Posting-frequency = '2m'
585 From = 'My Name <my.name@domain.invalid>'
586 Subject = 'Test of yapfag <%LM>'
587 NGs = 'de.test,de.alt.test'
588 Fup2 = 'de.test'
589 MID-Format = '<%n-%m.%y@domain.invalid>'
590 Supersede = yes
591
227afd47
TH
592=head3 Status Information
593
272b0243
TH
594Information about the last post and about how to form message IDs for
595posts is stored in a file named F<I<project name>.cfg> which will be
596generated if it does not exist. Each of those status files will
597contain two lines, the first being the date of the last time the FAQ
598was posted and the second being the message ID of that incarnation.
599
227afd47
TH
600=head2 Runtime Configuration
601
602Apart from configuring which FAQ(s) to post you may (re)set some
603runtime configuration variables via the .rcfile (by default
604F<.yapfaqrc>). F<.yapfaqrc> must contain one definition in the form of
605I<param = value> on each line; everything after a "#" sign is ignored.
606
607If you omit some settings they will be set to default values hardcoded
608in F<yapfaq.pl>.
609
610B<Please note that all parameter names are case-sensitive!>
611
612=over 4
613
614=item B<NNTPServer> = I<NNTP server> (mandatory)
615
616Host name of the NNTP server to post to. Must be set (or omitted; the
617default is "localhost"); if set to en empty string, B<yapfaq> falls
618back to Perl's build-in defaults (contents of environment variables
619NNTPSERVER and NEWSHOST; if not set, default from Net::Config; if not
620set, "news" is used).
621
622=item B<NNTPUser> = I<user name> (optional)
623
624User name used for authentication with the NNTP server (I<AUTHINFO
625USER>).
626
627This setting is optional; if it is not set, I<NNTPPass> is ignored and
628no authentication is tried.
629
630=item B<NNTPPass> = I<password> (optional)
631
632Password used for authentication with the NNTP server (I<AUTHINFO
633PASS>).
634
635This setting is optional; it must be set if I<NNTPUser> is present.
636
637=item B<Sender> = I<Sender header> (optional)
638
639The Sender header that will be added to every posted message.
640
641This setting is optional.
642
643=item B<ConfigFile> = I<configuration file> (mandatory)
644
645The configuration file defining the FAQ(s) to post. Must be set (or
646omitted; the default is "yapfaq.cfg").
647
39cb5672
TH
648=item B<Program> = I<file name> (optional)
649
650A program the article is piped to instead of posting it to Usenet.
651See option "-f" below (which takes preference).
652
653This setting is optional.
654
227afd47
TH
655=back
656
657=head3 Example runtime configuration file
658
659 NNTPServer = 'localhost'
660 NNTPUser = ''
661 NNTPPass = ''
662 Sender = ''
663 ConfigFile = 'yapfaq.cfg'
39cb5672 664 Program = ''
227afd47
TH
665
666=head3 Using more than one runtime configuration
667
668You may use more than one runtime configuration file with the B<-c>
669option (see below).
670
272b0243
TH
671=head1 OPTIONS
672
673=over 3
674
a052296f
TH
675=item B<-V> (version)
676
677Print out version and copyright information on B<yapfaq> and exit.
678
272b0243
TH
679=item B<-h> (help)
680
ae3b1b79 681Print this man page and exit.
272b0243
TH
682
683=item B<-v> (verbose)
684
685Print out status information while running to STDOUT.
686
687=item B<-p> (post unconditionally)
688
689Post (all) FAQs unconditionally ignoring the posting frequency setting.
690
691You may want to use this with the B<-f> option (see below).
692
693=item B<-d> (dry run)
694
695Start B<yapfaq> in simulation mode, i.e. don't post anything and don't
696update any status information.
697
698=item B<-t> I<newsgroup(s) | CONSOLE> (test)
699
700Don't post to the newsgroups defined in F<yqpfaq.cfg>, but to the
701newsgroups given after B<-t> as a comma-separated list or print the
702FAQs to STDOUT separated by lines of dashes if the special string
703C<CONSOLE> is given. This can be used to preview what B<yapfaq> would
704do without embarassing yourself on Usenet. The status files are not
705updated when this option is given.
706
707You may want to use this with the B<-f> option (see below).
708
709=item B<-f> I<project name>
710
711Just deal with one FAQ only.
712
713By default B<yapfaq> will work on all FAQs that are defined in
714F<yapfaq.cfg>, check whether they are due for posting and - if they
715are - post them. Consequently when the B<-p> option is set all FAQs
716will be posted unconditionally. That may not be what you want to
717achieve, so you can limit the operation of B<yapfaq> to the named FAQ
718only.
719
b855559e
TH
720=item B<-s> I<program> (pipe to script)
721
722Instead of posting the article(s) to Usenet pipe them to the external
723I<program> on STDIN (which may post the article(s) then). A return
724value of 0 will be considered success.
725
0e741504
TH
726For example, you may want to use the I<inews> utility from the INN package
727or the much more powerful replacement I<tinews.pl> from
728I<ftp://ftp.tin.org/tin/tools/tinews.pl> which is able to sign postings.
729
39cb5672
TH
730If I<Program> is also defined in the runtime configuration file (by default
731F<.yapfaqrc>), B<-s> takes preference.
732
227afd47
TH
733=item B<-c> I<.rc file>
734
735Load another runtime configuration file (.rc file) than F<.yaofaq.rc>.
736
737You may for example define another usenet server to post your FAQ(s)
738to or load another configuration file defining (an)other FAQ(s).
739
272b0243
TH
740=back
741
742=head1 EXAMPLES
743
744Post all FAQs that are due for posting:
745
746 yapfaq
747
748Do a dry run, showing which FAQs would be posted:
749
750 yapfaq -dv
751
752Do a test run and print on STDOUT what the FAQ I<myfaq> would look
753like when posted, regardless whether it is due for posting or not:
754
755 yapfaq -pt CONSOLE -f myfaq
756
757Do a "real" test run and post the FAQ I<myfaq> to I<de.test>, but only
758if it is due:
759
760 yapfaq -t de.test -f myfaq
761
9817f98a
TH
762Post all FAQs (that are due for posting) using inews from INN:
763
764 yapfaq -s inews
765
766Do a dry run using a runtime configuration from .alternaterc, showing
767which FAQs would be posted:
768
769 yapfaq -dvc .alternaterc
770
272b0243
TH
771=head1 ENVIRONMENT
772
9817f98a
TH
773=over 4
774
775=item NNTPSERVER
776
777The default NNTP server to post to, used by the Net::NNTP module. You
778can also specify the server using the runtime configuration file (by
779default F<.yapfaqrc>).
780
781=back
272b0243
TH
782
783=head1 FILES
784
785=over 4
786
787=item F<yapfaq.pl>
788
789The script itself.
790
227afd47
TH
791=item F<.yapfaqrc>
792
793Runtime configuration file for B<yapfaq>.
794
272b0243
TH
795=item F<yapfaq.cfg>
796
797Configuration file for B<yapfaq>.
798
799=item F<*.cfg>
800
801Status data on FAQs.
802
803The status files will be created on successful posting if they don't
804already exist. The first line of the file will be the date of the last
805time the FAQ was posted and the second line will be the message ID of
806the last post of that FAQ.
807
808=back
809
810=head1 BUGS
811
2d8e5cdb
TH
812Please report any bugs or feature request to the author or use the
813bug tracker at L<http://bugs.th-h.de/>!
272b0243
TH
814
815=head1 SEE ALSO
816
817L<http://th-h.de/download/scripts.php> will have the current
818version of this program.
819
2d8e5cdb
TH
820This program is maintained using the Git version control system. You
821may clone L<git://code.th-h.de/usenet/yapfaq.git> to check out the
822current development tree or browse it on the web via
823L<http://code.th-h.de/?p=usenet/yapfaq.git>.
824
272b0243
TH
825=head1 AUTHOR
826
827Thomas Hochstein <thh@inter.net>
828
227afd47 829Original author (up to version 0.5b, dating from 2003):
272b0243
TH
830Marc Brockschmidt <marc@marcbrockschmidt.de>
831
272b0243
TH
832=head1 COPYRIGHT AND LICENSE
833
834Copyright (c) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
835
836Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
837
838This program is free software; you may redistribute it and/or modify it
839under the same terms as Perl itself.
840
841=cut
This page took 0.071619 seconds and 4 git commands to generate.