#! /usr/bin/perl -W
#
-# yapfaq Version 0.6 by Thomas Hochstein
+# yapfaq Version 0.7 by Thomas Hochstein
# (Original author: Marc Brockschmidt)
#
# This script posts any project described in its config-file. Most people
# It can be redistributed and/or modified under the same terms under
# which Perl itself is published.
-my $Version = "0.6.2";
+my $Version = "0.8-prelease";
+# Please do not change this setting!
+# You may override the default .rc file (.yapfaqrc) by using "-c .rc file"
my $RCFile = '.yapfaqrc';
+# Valid configuration variables for use in a .rc file
my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile',
'UsePGP','pgp','PGPVersion','PGPSigner','PGPPass',
'PathtoPGPPass','pgpbegin','pgpend','pgptmpf','pgpheader');
-################################### Defaults ##################################
-my %Config = (NNTPServer => "localhost",
+################################### Defaults ###################################
+# Please do not change anything in here!
+# Use a runtime configuration file (.yapfaqrc by default) to override defaults.
+my %Config = (NNTPServer => "",
NNTPUser => "",
NNTPPass => "",
Sender => "",
'content-transfer-encoding', 'summary', 'keywords', 'cancel-lock',
'cancel-key', 'also-control', 'x-pgp', 'user-agent');
-############################# End of Configuration #############################
+################################# Main program #################################
use strict;
use Net::NNTP;
my ($File, $Config, $Faq) = @_;
my ($LastEntry, $Error, $i) = ('','',0);
- print "Reading configuration.\n" if($Options{'v'});
+ print "Reading configuration from $$File.\n" if($Options{'v'});
open FH, "<$$File" or die "$0: E: Can't open $$File: $!";
while (<FH>) {
$Error .= "E: The Posting-frequency for your project \"$$Config[$i]{'name'}\" is invalid.\n"
}
unless(!$$Config[$i]{'expires'} || $$Config[$i]{'expires'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
- warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
+ warn "$0: W: The Expires for your project \"$$Config[$i]{'name'}\" is invalid - set to 3 month.\n";
+ $$Config[$i]{'expires'} = '3m'; # set default (3 month) if expires is unset or invalid
}
- unless(defined($$Config[$i]{'mid-format'}) && $$Config[$i]{'mid-format'} =~ /^<\S+\@\S{2,}\.\S{2,}>$/) {
- warn "$0: W: The Message-ID format for your project \"$$Config[$i]{'name'}\" seems to be undefined or invalid - set to default.\n";
+ unless(!$$Config[$i]{'mid-format'} || $$Config[$i]{'mid-format'} =~ /^<\S+\@\S{2,}\.\S{2,}>$/) {
+ warn "$0: W: The Message-ID format for your project \"$$Config[$i]{'name'}\" seems to be invalid - set to default.\n";
+ $$Config[$i]{'mid-format'} = '<%n-%d.%m.%y@'.hostfqdn.'>'; # set default if mid-format is invalid
}
}
$Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
#Prepare MID:
$$TDM = ($$TDM < 10 && $$TDM !~ /^0/) ? "0" . $$TDM : $$TDM;
$$TDD = ($$TDD < 10 && $$TDD !~ /^0/) ? "0" . $$TDD : $$TDD;
+ my $Timestamp = time;
$MID = $$MIDF;
- $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID);
+ $MID = '<%n-%d.%m.%y@'.hostfqdn.'>' if !defined($MID); # set to default if unset
$MID =~ s/\%n/$$ActName/g;
$MID =~ s/\%d/$$TDD/g;
$MID =~ s/\%m/$$TDM/g;
$MID =~ s/\%y/$$TDY/g;
+ $MID =~ s/\%t/$Timestamp/g;
#Now get the body:
open (FH, "<$$File");
=head1 SYNOPSIS
-B<yapfaq> [B<-hvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>] [B<-s> I<program>] [B<-c> I<.rc file>]
+B<yapfaq> [B<-
Vhvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>] [B<-s> I<program>] [B<-c> I<.rc file>]
=head1 REQUIREMENTS
This value must be set.
-=item B<Expires> = I<time period>
+=item B<Expires> = I<time period> (optional)
The period of time after which your message will expire. An Expires
header will be calculated adding this time period to today's date.
You can declare this time period either in I<B<d>ays> or I<B<w>weeks>
or I<B<m>onths> or I<B<y>ears>.
-This setting is optional; the default is 3 months.
+This setting is optional; the default is 3 months.
=item B<From> = I<author>
This value must be set.
-=item B<Fup2> = I<newsgroup | poster>
+=item B<Fup2> = I<newsgroup | poster> (optional)
A comma-separated list of newsgroup(s) or the special string I<poster>
as it will appear in the Followup-To header of the message.
This setting is optional.
-=item B<MID-Format> = I<pattern>
+=item B<MID-Format> = I<pattern> (optional)
A pattern from which the message ID is generated as it will appear in
the Message-ID header of the message.
You may use the special strings C<%n> for the I<Name> of your project,
-C<%d> for the date the message is posted, C<%m> for the month and
-C<%y> for the year, respectively.
+C<%d> for the date the message is posted, C<%m> for the month, C<%y>
+for the year and C<%t> for a time stamp (number of seconds since the
+epoch), respectively.
-This value must be set.
+This setting is optional; the default is '<%n-%d.%m.%y@I<YOURHOST>>'
+where I<YOURHOST> is the fully qualified domain name (FQDN) of the
+host B<yapfaq> is running on. Obviously that will only work if you
+have defined a reasonable hostname that the hostfqdn() function of
+Net::Domain can return.
-=item B<Supersede> = I<yes>
+=item B<Supersede> = I<yes> (optional)
Add Supersedes header to the message containing the Message-ID header
of the last posting.
This setting is optional; you should set it to yes or leave it out.
-=item B<ExtraHeader> = I<additional headers>
+=item B<ExtraHeader> = I<additional headers> (optional)
The contents of I<ExtraHeader> is added verbatim to the headers of
your message so you can add custom headers like Approved.
# time period after which the posting should expire
# use (d)ay OR (w)eek OR (m)onth OR (y)ear
- Expires = '3m'
+ # Expires = '3m'
# header "From:"
From = 'test@domain.invalid'
NGs = 'de.test'
# header "Followup-To:"
- Fup2 = 'poster'
+ # Fup2 = 'poster'
# Message-ID ("%n" is $Name)
- MID-Format = '<%n-%d.%m.%y@domain.invalid>'
+ # MID-Format = '<%n-%d.%m.%y@domain.invalid>'
# Supersede last posting?
Supersede = yes
yapfaq -t de.test -f myfaq
+Post all FAQs (that are due for posting) using inews from INN:
+
+ yapfaq -s inews
+
+Do a dry run using a runtime configuration from .alternaterc, showing
+which FAQs would be posted:
+
+ yapfaq -dvc .alternaterc
+
=head1 ENVIRONMENT
-There are no special environment variables used by B<yapfaq>.
+=over 4
+
+=item NNTPSERVER
+
+The default NNTP server to post to, used by the Net::NNTP module. You
+can also specify the server using the runtime configuration file (by
+default F<.yapfaqrc>).
+
+=back
=head1 FILES
projects / usenet / yapfaq.git / blobdiff