yapfaq.pl

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