Compare commits
52 commits
Author | SHA1 | Date | |
---|---|---|---|
|
09d51964aa | ||
|
99d4cbcae2 | ||
|
4fe0c455ea | ||
|
15dd22593e | ||
|
6e49580a28 | ||
|
3b06ebf93a | ||
|
cc74e2f92b | ||
|
04eac1b541 | ||
|
9224368882 | ||
|
0b68926d7c | ||
|
373681d034 | ||
|
bd3a4c3841 | ||
|
f5a291096e | ||
|
c4765a39f3 | ||
|
8f65a0a519 | ||
|
b146f21475 | ||
|
3b2e5e066d | ||
|
b16eb1aec4 | ||
|
dc66bfa3f5 | ||
|
994d975969 | ||
|
ba8ae1cfe5 | ||
|
cdfec198d6 | ||
|
2d8e5cdbc7 | ||
|
bdbb9d7043 | ||
|
39cb5672df | ||
|
0e741504fe | ||
|
8f067a2ffb | ||
|
13ce8c26a3 | ||
|
605916ef61 | ||
|
9817f98a91 | ||
|
b802358a60 | ||
|
7ef63844b5 | ||
|
e16539c99c | ||
|
647af2ea07 | ||
|
ace701c4a6 | ||
|
ac69c3ee90 | ||
|
2ef9b9cd23 | ||
|
5a6670c7ff | ||
|
227afd47f6 | ||
|
86c0a10044 | ||
|
6f235aca38 | ||
|
d60c2d5fdf | ||
|
2507947f17 | ||
|
b855559ee3 | ||
|
55bfbd3cde | ||
|
b955062245 | ||
|
a052296f3b | ||
|
ae3b1b7906 | ||
|
d69ba0bb34 | ||
|
dbca4ad8a1 | ||
|
40847f71a0 | ||
|
366322b2c8 |
6
.yapfaqrc.sample
Normal file
6
.yapfaqrc.sample
Normal file
|
@ -0,0 +1,6 @@
|
|||
NNTPServer = 'localhost'
|
||||
NNTPUser = ''
|
||||
NNTPPass = ''
|
||||
Sender = ''
|
||||
ConfigFile = 'yapfaq.cfg.sample'
|
||||
Program = ''
|
175
ChangeLog
175
ChangeLog
|
@ -1,3 +1,178 @@
|
|||
yapfaq 0.10 (unreleased)
|
||||
|
||||
* Add: Charset definition.
|
||||
Fixes #29.
|
||||
|
||||
* Mark yapfaq.pl executable.
|
||||
|
||||
* Change mail address.
|
||||
|
||||
|
||||
Version 0.9.1
|
||||
|
||||
* Fix: Test mode: Add X-Supersedes only if Supersedes would be set.
|
||||
Fixes #28.
|
||||
Thomas Hochstein <thh@inter.net> Sun Oct 31 18:42:52 2010 +0100
|
||||
|
||||
|
||||
Version 0.9
|
||||
|
||||
* Drop use of Fcntl (not needed).
|
||||
Thomas Hochstein <thh@inter.net> Tue Jun 15 22:30:11 2010 +0200
|
||||
|
||||
* Changed packaging.
|
||||
- Drop .yapfaqrc and yapfaq.cfg in favor of .yapfaqrc.sample
|
||||
and yapfaq.cfg.sample; rename test.txt to sample.txt.
|
||||
- Change contents of these files to reflect the new names.
|
||||
- Update some defaults, change sample.txt contents to English.
|
||||
- Add "INSTALLATION" chapter to documentation.
|
||||
Fixes #7.
|
||||
Thomas Hochstein <thh@inter.net> Sat May 15 19:16:40 2010 +0200
|
||||
|
||||
* Change default Message-ID format.
|
||||
Thomas Hochstein <thh@inter.net> Sat May 15 19:04:24 2010 +0200
|
||||
|
||||
* Change: Modify headers for test posts.
|
||||
- Change MID so you can do multiple tests.
|
||||
- Replace Supersedes with X-Supersedes so you do not delete
|
||||
postings while testing.
|
||||
- Add remark ("This is a test message.").
|
||||
- Change documentation accordingly.
|
||||
Fixes #6.
|
||||
Thomas Hochstein <thh@inter.net> Sat May 15 17:22:20 2010 +0200
|
||||
|
||||
* Change: Drop %LM from subject if Last-Modified is not found.
|
||||
Thomas Hochstein <thh@inter.net> Sat May 15 16:36:52 2010 +0200
|
||||
|
||||
|
||||
Version 0.8.2
|
||||
|
||||
* Fix: Accept leading/trailing whitespace for Last-modified pseudo header.
|
||||
Fixes #5.
|
||||
Thomas Hochstein <thh@inter.net> Sat May 15 16:32:58 2010 +0200
|
||||
|
||||
|
||||
Version 0.8.1
|
||||
|
||||
* Fix broken implementation of "Program" in .yapfaqrc.
|
||||
Fixes #4.
|
||||
Thomas Hochstein <thh@inter.net> 2010-05-14 21:58:15
|
||||
|
||||
|
||||
Version 0.8
|
||||
|
||||
* Documentation: Add Git repository and bug tracker.
|
||||
Thomas Hochstein <thh@inter.net> Thu May 13 19:21:05 2010 +0200
|
||||
|
||||
* Making use of Getopt::Std's --help and --version.
|
||||
Fixes #3.
|
||||
Thomas Hochstein <thh@inter.net> Thu May 13 19:33:25 2010 +0200
|
||||
|
||||
* New: Add "Program" to .yapfaqrc.
|
||||
Fixes #2.
|
||||
Thomas Hochstein <thh@inter.net> Thu May 13 19:31:49 2010 +0200
|
||||
|
||||
* Change: Drop PGP support.
|
||||
You may use tinews.pl from
|
||||
ftp://ftp.tin.org/tin/tools/tinews.pl instead.
|
||||
Fixes #1.
|
||||
Thomas Hochstein <thh@inter.net> Thu May 13 19:24:44 2010 +0200
|
||||
|
||||
* Fix: Consistency check for MID-Format fixed (regexp).
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 14 23:17:16 2010 +0200
|
||||
|
||||
* New: MID-Format may now contain %t for a Unix timestamp.
|
||||
%t will be replaced by the number of seconds since the epoch.
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 14 23:18:04 2010 +0200
|
||||
|
||||
* Documentation changes
|
||||
- Change sample yapfaq.cfg (mark optional settings).
|
||||
Optional settings are mostly commented out.
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 14 09:10:05 2010 +0200
|
||||
- Fix: Add "-V", NNTPSERVER to documentation, add more examples.
|
||||
Added examples for -s and -c.
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 14 10:02:48 2010 +0200
|
||||
- Add comments pointing to .yapfaqrc to source.
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 14 10:10:28 2010 +0200
|
||||
|
||||
* readconfig(): Add file name to verbose output.
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 14 09:38:23 2010 +0200
|
||||
|
||||
* Change: Reset default for NNTPServer to "unset".
|
||||
Since yapfaq fill fall back to Perl's build-in defaults,
|
||||
that should be no problem; furthermore user may now
|
||||
override this setting via .yapfaqrc without changing
|
||||
the code.
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 14 09:11:45 2010 +0200
|
||||
|
||||
|
||||
Version 0.7
|
||||
|
||||
* Change: readconfig(): Make mid-format optional.
|
||||
Set defaults for expires and mid-format when they're invalid
|
||||
(defaults were already set in postfaq() if undefined).
|
||||
Change documentation accordingly; make it more clear if
|
||||
parameters are optional or mandatory.
|
||||
Thomas Hochstein <thh@inter.net> Tue Apr 13 23:59:43 2010 +0200
|
||||
|
||||
* Fix: Save status information only after successful posting.
|
||||
- New Function: updatestaus
|
||||
Move status information save to updatestatus.
|
||||
- post() now returns exit code.
|
||||
- postfaq() will update status information only
|
||||
when post() was successful.
|
||||
Thomas Hochstein <thh@inter.net> Sat Apr 10 23:19:44 2010 +0200
|
||||
|
||||
* New: Add option '-s': pipe article to script.
|
||||
Use an external program to post - or otherwise handle -
|
||||
the article.
|
||||
Amend documentation.
|
||||
Thomas Hochstein <thh@inter.net> Sat Apr 10 02:14:59 2010 +0200
|
||||
|
||||
* New: runtime configuration
|
||||
- Moved configuration to a hash (%Config).
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 7 22:09:15 2010 +0200
|
||||
- Add rcfile (.yapfaqrc) for configuration.
|
||||
All configuration data is read from .yapfaqrc
|
||||
with defaults set in yapfaq.pl
|
||||
Thomas Hochstein <thh@inter.net> Sat Apr 10 22:02:24 2010 +0200
|
||||
- Add sample .yapfaqrc with defaults.
|
||||
Thomas Hochstein <thh@inter.net> Wed Apr 7 23:16:20 2010 +0200
|
||||
- Add option '-c': define another .rcfile.
|
||||
Thomas Hochstein <thh@inter.net> Thu Apr 8 07:41:43 2010 +0200
|
||||
- Update documentation for .rcfile.
|
||||
Add the according sections to the POD documentation.
|
||||
Fix some wording.
|
||||
Thomas Hochstein <thh@inter.net> Sat Apr 10 02:17:00 2010 +0200
|
||||
|
||||
* Small changes.
|
||||
-t CONSOLE: Change delimiter.
|
||||
No leading \n is necessary.
|
||||
Add some more comments.
|
||||
Thomas Hochstein <thh@inter.net> Sat Apr 10 01:43:19 2010 +0200
|
||||
|
||||
* Add option '-V': print version and copyright information.
|
||||
Thomas Hochstein <thh@inter.net> Thu Apr 8 07:36:11 2010 +0200
|
||||
|
||||
* Change: -h: Replace version/usage information with man page.
|
||||
Feed script to perldoc when called with -h.
|
||||
Thomas Hochstein <thh@inter.net> Thu Apr 8 06:21:05 2010 +0200
|
||||
|
||||
* Change: Authenticate only if $NNTPUser is set.
|
||||
Thomas Hochstein <thh@inter.net> Sat Apr 10 00:49:24 2010 +0200
|
||||
|
||||
* Add check for MID-Format and fallback to FQDN.
|
||||
Uses hostfqdn from Net::Domain.
|
||||
Thomas Hochstein <thh@inter.net> Thu Apr 8 08:33:01 2010 +0200
|
||||
|
||||
* Add checks for mandatory content in configuration file.
|
||||
Enhance and optimize existing checks.
|
||||
Thomas Hochstein <thh@inter.net> Thu Apr 8 08:30:21 2010 +0200
|
||||
|
||||
* Code optimisation (verbose output).
|
||||
Thomas Hochstein <thh@inter.net> Thu Apr 8 08:00:04 2010 +0200
|
||||
|
||||
|
||||
Version 0.6.2
|
||||
|
||||
* Fix default for Expires.
|
||||
|
|
13
README.md
Normal file
13
README.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
# yapfaq
|
||||
|
||||
**yapfaq** can post FAQs from text files to Usenet at configurable intervals and automatically adds the necessary headers.
|
||||
|
||||
## Description
|
||||
|
||||
With **yapfaq**, FAQs or other texts can be posted regularly (every x days, weeks, months or years) to one or more newsgroups. Posting frequency as well as the necessary headers - including the format of the `Message-ID:` headers that will be generated - can be defined in a configuration file. `Expires:` and `Supersedes:` will be set automatically by the script.
|
||||
|
||||
The text can either be posted via NNTP or piped to another programme (like `inews` or `tinews.pl`).
|
||||
|
||||
## More information
|
||||
|
||||
Please see the [distribution page](https://th-h.de/net/software/yapfaq/) (in German).
|
9
sample.txt
Normal file
9
sample.txt
Normal file
|
@ -0,0 +1,9 @@
|
|||
Last-modified: 2010-05-15
|
||||
|
||||
This is a test message.
|
||||
|
||||
Foo.
|
||||
|
||||
Bar.
|
||||
|
||||
That's quite enought, isn't it?
|
11
test.txt
11
test.txt
|
@ -1,11 +0,0 @@
|
|||
Last-modified: 2003-01-11
|
||||
|
||||
Dies ist ein Test-Artikel. Klasse, was?
|
||||
|
||||
Bla.
|
||||
|
||||
Noch mehr foo.
|
||||
|
||||
Bar.
|
||||
|
||||
Nu reicht's.
|
|
@ -1,9 +1,9 @@
|
|||
# name of your project
|
||||
Name = 'testpost'
|
||||
Name = 'sample'
|
||||
|
||||
# file to post (complete body and pseudo-headers)
|
||||
# ($File.cfg contains data on last posting and last MID)
|
||||
File = 'test.txt'
|
||||
File = 'sample.txt'
|
||||
|
||||
# how often your project should be posted
|
||||
# use (d)ay OR (w)eek OR (m)onth OR (y)ear
|
||||
|
@ -11,10 +11,11 @@ Posting-frequency = '1d'
|
|||
|
||||
# time period after which the posting should expire
|
||||
# use (d)ay OR (w)eek OR (m)onth OR (y)ear
|
||||
Expires = '3m'
|
||||
# This setting is optional. Default: 3m
|
||||
# Expires = '3m'
|
||||
|
||||
# header "From:"
|
||||
From = 'test@domain.invalid'
|
||||
From = 'John Doe <john-doe@example.com>'
|
||||
|
||||
# header "Subject:"
|
||||
# (may contain "%LM" which will be replaced by the contents of the
|
||||
|
@ -26,16 +27,24 @@ Subject = 'test noreply ignore'
|
|||
NGs = 'de.test'
|
||||
|
||||
# header "Followup-To:"
|
||||
Fup2 = 'poster'
|
||||
# This setting is optional. Default: unset
|
||||
# Fup2 = 'poster'
|
||||
|
||||
# Message-ID ("%n" is $Name)
|
||||
MID-Format = '<%n-%d.%m.%y@domain.invalid>'
|
||||
# This setting is optional. Default: <%n-%y-%m-%d@YOURHOST>
|
||||
# MID-Format = '<%n-%y-%m-%d@domain.invalid>'
|
||||
|
||||
# Character Encoding
|
||||
# This setting is optional. Default: UTF-8
|
||||
# Charset = ISO-8859-15
|
||||
|
||||
# Supersede last posting?
|
||||
# This setting is optional. Default: unset
|
||||
Supersede = yes
|
||||
|
||||
# extra headers (appended verbatim)
|
||||
# use this for custom headers like "Approved:"
|
||||
# This setting is optional. Default: unset
|
||||
ExtraHeader = 'Approved: moderator@domain.invalid
|
||||
X-Header: Some text'
|
||||
|
647
yapfaq.pl
Normal file → Executable file
647
yapfaq.pl
Normal file → Executable file
|
@ -1,73 +1,80 @@
|
|||
#! /usr/bin/perl -W
|
||||
#
|
||||
# yapfaq Version 0.6 by Thomas Hochstein
|
||||
# yapfaq Version 0.10 by Thomas Hochstein
|
||||
# (Original author: Marc Brockschmidt)
|
||||
#
|
||||
# This script posts any project described in its config-file. Most people
|
||||
# will use it in combination with cron(8).
|
||||
#
|
||||
# Copyright (C) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
|
||||
# Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
|
||||
# Copyright (c) 2010-2017 Thomas Hochstein <thh@thh.name>
|
||||
#
|
||||
# It can be redistributed and/or modified under the same terms under
|
||||
# which Perl itself is published.
|
||||
|
||||
my $Version = "0.6.2";
|
||||
our $VERSION = "0.10";
|
||||
|
||||
my $NNTPServer = "localhost";
|
||||
my $NNTPUser = "";
|
||||
my $NNTPPass = "";
|
||||
my $Sender = "";
|
||||
my $ConfigFile = "yapfaq.cfg";
|
||||
my $UsePGP = 0;
|
||||
# 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','Program');
|
||||
|
||||
################################## PGP-Config #################################
|
||||
################################### 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 => "",
|
||||
ConfigFile => "yapfaq.cfg",
|
||||
Program => "");
|
||||
|
||||
my $pgp = '/usr/bin/pgp'; # path to pgp
|
||||
my $PGPVersion = '2'; # Use 2 for 2.X, 5 for PGP > 2.X and GPG for GPG
|
||||
|
||||
my $PGPSigner = ''; # sign as who?
|
||||
my $PGPPass = ''; # pgp2 only
|
||||
my $PathtoPGPPass = ''; # pgp2, pgp5 and gpg
|
||||
|
||||
|
||||
my $pgpbegin ='-----BEGIN PGP SIGNATURE-----';# Begin of PGP-Signature
|
||||
my $pgpend ='-----END PGP SIGNATURE-----'; # End of PGP-Signature
|
||||
my $pgptmpf ='pgptmp'; # temporary file for PGP.
|
||||
my $pgpheader ='X-PGP-Sig';
|
||||
|
||||
my @PGPSignHeaders = ('From', 'Newsgroups', 'Subject', 'Control',
|
||||
'Supersedes', 'Followup-To', 'Date', 'Sender', 'Approved',
|
||||
'Message-ID', 'Reply-To', 'Cancel-Lock', 'Cancel-Key',
|
||||
'Also-Control', 'Distribution');
|
||||
|
||||
my @PGPorderheaders = ('from', 'newsgroups', 'subject', 'control',
|
||||
'supersedes', 'followup-To', 'date', 'organization', 'lines',
|
||||
'sender', 'approved', 'distribution', 'message-id',
|
||||
'references', 'reply-to', 'mime-version', 'content-type',
|
||||
'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;
|
||||
use Net::Domain qw(hostfqdn);
|
||||
use Date::Calc qw(Add_Delta_YM Add_Delta_Days Delta_Days Today);
|
||||
use Fcntl ':flock'; # import LOCK_* constants
|
||||
use Getopt::Std;
|
||||
$Getopt::Std::STANDARD_HELP_VERSION = 1;
|
||||
my ($TDY, $TDM, $TDD) = Today(); #TD: Today's date
|
||||
|
||||
# read commandline options
|
||||
my %Options;
|
||||
getopts('hvpdt:f:', \%Options);
|
||||
getopts('Vhvpdt:f:c:s:', \%Options);
|
||||
# -V: print version / copyright information
|
||||
if ($Options{'V'}) {
|
||||
print "$0 v $VERSION\nCopyright (c) 2003 Marc Brockschmidt <marc\@marcbrockschmidt.de>\nCopyright (c) 2010-2017 Thomas Hochstein <thh\@thh.name>\n";
|
||||
print "This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.\n";
|
||||
exit(0);
|
||||
}
|
||||
# -h: feed myself to perldoc
|
||||
if ($Options{'h'}) {
|
||||
print "$0 v $Version\nUsage: $0 [-hvpd] [-t <newsgroups>] [-f <faq>]\n";
|
||||
exec ('perldoc', $0);
|
||||
exit(0);
|
||||
};
|
||||
# -f: set $Faq
|
||||
my ($Faq) = $Options{'f'} if ($Options{'f'});
|
||||
|
||||
my @Config;
|
||||
readconfig (\$ConfigFile, \@Config, \$Faq);
|
||||
# read runtime configuration (configuration variables)
|
||||
$RCFile = $Options{'c'} if ($Options{'c'});
|
||||
if (-f $RCFile) {
|
||||
readrc (\$RCFile,\%Config);
|
||||
} else {
|
||||
warn "$0: W: .rc file $RCFile does not exist!\n";
|
||||
}
|
||||
|
||||
$Options{'s'} = $Config{'Program'} if (defined($Config{'Program'}) && $Config{'Program'} && !defined($Options{'s'}));
|
||||
|
||||
# read configuration (configured FAQs)
|
||||
my @Config;
|
||||
readconfig (\$Config{'ConfigFile'}, \@Config, \$Faq);
|
||||
|
||||
# for each FAQ:
|
||||
# - parse configuration
|
||||
# - read status data
|
||||
# - if FAQ is due: call postfaq()
|
||||
foreach (@Config) {
|
||||
my ($LPD,$LPM,$LPY) = (01, 01, 0001); #LP: Last posting-date
|
||||
my ($NPY,$NPM,$NPD); #NP: Next posting-date
|
||||
|
@ -75,11 +82,13 @@ foreach (@Config) {
|
|||
|
||||
my ($ActName,$File,$PFreq,$Expire) =($$_{'name'},$$_{'file'},$$_{'posting-frequency'},$$_{'expires'});
|
||||
my ($From,$Subject,$NG,$Fup2)=($$_{'from'},$$_{'subject'},$$_{'ngs'},$$_{'fup2'});
|
||||
my ($MIDF,$ReplyTo,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'extraheader'});
|
||||
my ($MIDF,$ReplyTo,$Charset,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'charset'},$$_{'extraheader'});
|
||||
my ($Supersede) =($$_{'supersede'});
|
||||
|
||||
# -f: loop if not FAQ to post
|
||||
next if (defined($Faq) && $ActName ne $Faq);
|
||||
|
||||
# read status data
|
||||
if (open (FH, "<$File.cfg")) {
|
||||
while(<FH>){
|
||||
if (/##;; Lastpost:\s*(\d{1,2})\.(\d{1,2})\.(\d{2}(\d{2})?)/){
|
||||
|
@ -97,11 +106,12 @@ foreach (@Config) {
|
|||
|
||||
($NPY,$NPM,$NPD) = calcdelta ($LPY,$LPM,$LPD,$PFreq);
|
||||
|
||||
# if FAQ is due: get it out
|
||||
if (Delta_Days($NPY,$NPM,$NPD,$TDY,$TDM,$TDD) >= 0 or ($Options{'p'})) {
|
||||
if($Options{'d'}) {
|
||||
print "$ActName: Would be posted now (but running in simulation mode [$0 -d]).\n" if $Options{'v'};
|
||||
} else {
|
||||
postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Sender,\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
|
||||
postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$Charset,\$ExtHea,\$Config{'Sender'},\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
|
||||
}
|
||||
} elsif($Options{'v'}) {
|
||||
print "$ActName: Nothing to do.\n";
|
||||
|
@ -110,6 +120,26 @@ foreach (@Config) {
|
|||
|
||||
exit;
|
||||
|
||||
#################################### readrc ####################################
|
||||
# Takes a filename and the reference to an array which contains the valid options
|
||||
|
||||
sub readrc{
|
||||
my ($File, $Config) = @_;
|
||||
|
||||
print "Reading $$File.\n" if($Options{'v'});
|
||||
|
||||
open FH, "<$$File" or die "$0: Can't open $$File: $!";
|
||||
while (<FH>) {
|
||||
if (/^\s*(\S+)\s*=\s*'?(.*?)'?\s*(#.*$|$)/) {
|
||||
if (grep(/$1/,@ValidConfVars)) {
|
||||
$$Config{$1} = $2 if $2 ne '';
|
||||
} else {
|
||||
warn "$0: W: $1 is not a valid configuration variable (reading from $$File)\n";
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
################################## readconfig ##################################
|
||||
# Takes a filename, a reference to an array, which will hold hashes with
|
||||
# the data from $File, and - optionally - the name of the (single) FAQ to post
|
||||
|
@ -118,9 +148,7 @@ sub readconfig{
|
|||
my ($File, $Config, $Faq) = @_;
|
||||
my ($LastEntry, $Error, $i) = ('','',0);
|
||||
|
||||
if($Options{'v'}) {
|
||||
print "Reading configuration.\n";
|
||||
}
|
||||
print "Reading configuration from $$File.\n" if($Options{'v'});
|
||||
|
||||
open FH, "<$$File" or die "$0: E: Can't open $$File: $!";
|
||||
while (<FH>) {
|
||||
|
@ -139,23 +167,37 @@ sub readconfig{
|
|||
#Check saved values:
|
||||
for $i (0..$i){
|
||||
next if (defined($$Faq) && defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} ne $$Faq );
|
||||
unless($$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) {
|
||||
$Error .= "E: The From-header for your project \"$$Config[$i]{'name'}\" seems to be incorrect.\n"
|
||||
unless(defined($$Config[$i]{'name'}) && $$Config[$i]{'name'} =~ /^\S+$/) {
|
||||
$Error .= "E: The name of your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
|
||||
}
|
||||
unless($$Config[$i]{'ngs'} =~ /^\S+$/) {
|
||||
$Error .= "E: The Newsgroups-header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
|
||||
unless(defined($$Config[$i]{'file'}) && -f $$Config[$i]{'file'}) {
|
||||
$Error .= "E: The file to post for your project \"$$Config[$i]{'name'}\" is not defined or does not exist.\n"
|
||||
}
|
||||
unless(defined($$Config[$i]{'from'}) && $$Config[$i]{'from'} =~ /\S+\@(\S+\.)?\S{2,}\.\S{2,}/) {
|
||||
$Error .= "E: The From header for your project \"$$Config[$i]{'name'}\" seems to be incorrect.\n"
|
||||
}
|
||||
unless(defined($$Config[$i]{'ngs'}) && $$Config[$i]{'ngs'} =~ /^\S+$/) {
|
||||
$Error .= "E: The Newsgroups header for your project \"$$Config[$i]{'name'}\" is not defined or contains whitespaces.\n"
|
||||
}
|
||||
unless(defined($$Config[$i]{'subject'})) {
|
||||
$Error .= "E: The Subject header for your project \"$$Config[$i]{'name'}\" is not defined.\n"
|
||||
}
|
||||
unless(!$$Config[$i]{'fup2'} || $$Config[$i]{'fup2'} =~ /^\S+$/) {
|
||||
$Error .= "E: The Followup-To-header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
|
||||
$Error .= "E: The Followup-To header for your project \"$$Config[$i]{'name'}\" contains whitespaces.\n"
|
||||
}
|
||||
unless($$Config[$i]{'posting-frequency'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
|
||||
unless(defined($$Config[$i]{'posting-frequency'}) && $$Config[$i]{'posting-frequency'} =~ /^\s*\d+\s*[dwmy]\s*$/) {
|
||||
$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(!$$Config[$i]{'mid-format'} || $$Config[$i]{'mid-format'} =~ /^<\S+\@(\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-%y-%m-%d@'.hostfqdn.'>'; # set default if mid-format is invalid
|
||||
}
|
||||
$Error .= "-" x 25 . "\n" if $Error;
|
||||
}
|
||||
$Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
|
||||
die $Error if $Error;
|
||||
}
|
||||
|
||||
|
@ -174,6 +216,21 @@ sub calcdelta {
|
|||
}
|
||||
return ($NYear, $NMonth, $NDay);
|
||||
}
|
||||
|
||||
################################ updatestatus ###############################
|
||||
# Takes a MID and a status file name
|
||||
# and writes status information to disk
|
||||
|
||||
sub updatestatus {
|
||||
my ($ActName, $File, $date, $MID) = @_;
|
||||
|
||||
print "$$ActName: Save status information.\n" if($Options{'v'});
|
||||
|
||||
open (FH, ">$$File.cfg") or die "$0: E: Can't open $$File.cfg: $!";
|
||||
print FH "##;; Lastpost: $date\n";
|
||||
print FH "##;; LastMID: $MID\n";
|
||||
close FH;
|
||||
}
|
||||
|
||||
################################## postfaq ##################################
|
||||
# Takes a filename and many other vars.
|
||||
|
@ -181,23 +238,23 @@ sub calcdelta {
|
|||
# It reads the data-file $File and then posts the article.
|
||||
|
||||
sub postfaq {
|
||||
my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
|
||||
my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$Charset,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
|
||||
my (@Header,@Body,$MID,$InRealBody,$LastModified);
|
||||
|
||||
if($Options{'v'}) {
|
||||
print "$$ActName: Preparing to post.\n";
|
||||
}
|
||||
print "$$ActName: Preparing to post.\n" if($Options{'v'});
|
||||
|
||||
#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-%y-%m-%d@'.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");
|
||||
|
@ -205,7 +262,7 @@ sub postfaq {
|
|||
s/\r//;
|
||||
push (@Body, $_), next if $InRealBody;
|
||||
$InRealBody++ if /^$/;
|
||||
$LastModified = $1 if /^Last-modified: (\S+)$/i;
|
||||
$LastModified = $1 if /^Last-modified:\s*(\S+)\s*$/i;
|
||||
push @Body, $_;
|
||||
}
|
||||
close FH;
|
||||
|
@ -234,11 +291,22 @@ sub postfaq {
|
|||
#Replace %LM by the content of the news.answer-pseudo-header Last-modified:
|
||||
if ($LastModified) {
|
||||
$$Subject =~ s/\%LM/$LastModified/;
|
||||
} else {
|
||||
$$Subject =~ s/[<\[{\(]?\%LM[>\]}\)]?//;
|
||||
}
|
||||
|
||||
# Set Charset
|
||||
$$Charset = 'UTF-8' if !$$Charset;
|
||||
my $ContentType = sprintf('text/plain; charset=%s',$$Charset);
|
||||
|
||||
# Test mode?
|
||||
if($Options{'t'} and $Options{'t'} !~ /console/i) {
|
||||
$$NG = $Options{'t'};
|
||||
$MID =~ s/@/-$Timestamp-test@/g;
|
||||
$$ExtraHeaders .= "\n" if $$ExtraHeaders;
|
||||
$$ExtraHeaders .= "X-Supersedes: $$Supersedes\n" if $$Supersedes;
|
||||
$$ExtraHeaders .= "X-yapfaq-Remark: This is only a test message.";
|
||||
undef $$Supersedes;
|
||||
}
|
||||
|
||||
#Now create the complete Header:
|
||||
|
@ -253,31 +321,24 @@ sub postfaq {
|
|||
push @Header, "Sender: $$Sender\n" if $$Sender;
|
||||
push @Header, "Mime-Version: 1.0\n";
|
||||
push @Header, "Reply-To: $$ReplyTo\n" if $$ReplyTo;
|
||||
push @Header, "Content-Type: text/plain; charset=ISO-8859-15\n";
|
||||
push @Header, "Content-Type: $ContentType\n";
|
||||
push @Header, "Content-Transfer-Encoding: 8bit\n";
|
||||
push @Header, "User-Agent: yapfaq/$Version\n";
|
||||
push @Header, "User-Agent: yapfaq/$VERSION\n";
|
||||
if ($$ExtraHeaders) {
|
||||
push @Header, "$_\n" for (split /\n/, $$ExtraHeaders);
|
||||
}
|
||||
|
||||
my @Article = ($UsePGP)?@{signpgp(\@Header, \@Body)}:(@Header, "\n", @Body);
|
||||
my @Article = (@Header, "\n", @Body);
|
||||
|
||||
# post article
|
||||
print "$$ActName: Posting article ...\n" if($Options{'v'});
|
||||
my $failure = post(\@Article);
|
||||
|
||||
if($Options{'v'}) {
|
||||
print "$$ActName: Posting article ...\n";
|
||||
if ($failure) {
|
||||
print "$$ActName: Posting failed, ERROR.dat may have more information.\n" if($Options{'v'} && (!defined($Options{'t'}) || $Options{'t'} !~ /console/i));
|
||||
} else {
|
||||
updatestatus($ActName, $File, "$day.$month.$year", $MID) if !defined($Options{'t'});
|
||||
}
|
||||
post(\@Article);
|
||||
|
||||
# Test mode?
|
||||
return if($Options{'t'});
|
||||
|
||||
if($Options{'v'}) {
|
||||
print "$$ActName: Save status information.\n";
|
||||
}
|
||||
|
||||
open (FH, ">$$File.cfg") or die "$0: E: Can't open $$File.cfg: $!";
|
||||
print FH "##;; Lastpost: $day.$month.$year\n";
|
||||
print FH "##;; LastMID: $MID\n";
|
||||
close FH;
|
||||
}
|
||||
|
||||
################################## post ##################################
|
||||
|
@ -287,198 +348,49 @@ sub postfaq {
|
|||
|
||||
sub post {
|
||||
my ($ArticleR) = @_;
|
||||
my ($failure) = -1;
|
||||
|
||||
# Test mode?
|
||||
# test mode - print article to console
|
||||
if(defined($Options{'t'}) and $Options{'t'} =~ /console/i) {
|
||||
print "\n-----BEGIN--------------------------------------------------\n";
|
||||
print @$ArticleR;
|
||||
print "\n------END---------------------------------------------------\n";
|
||||
return;
|
||||
}
|
||||
|
||||
my $NewsConnection = Net::NNTP->new($NNTPServer, Reader => 1)
|
||||
or die "$0: E: Can't connect to news server '$NNTPServer'!\n";
|
||||
|
||||
$NewsConnection->authinfo ($NNTPUser, $NNTPPass);
|
||||
$NewsConnection->post();
|
||||
$NewsConnection->datasend (@$ArticleR);
|
||||
$NewsConnection->dataend();
|
||||
|
||||
if (!$NewsConnection->ok()) {
|
||||
open FH, ">>ERROR.dat";
|
||||
print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n";
|
||||
print FH $NewsConnection->code();
|
||||
print FH $NewsConnection->message();
|
||||
print FH "\n";
|
||||
print FH @$ArticleR;
|
||||
print FH "-" x 80, "\n";
|
||||
close FH;
|
||||
}
|
||||
|
||||
$NewsConnection->quit();
|
||||
}
|
||||
|
||||
#-------- sub getpgpcommand
|
||||
# getpgpcommand generates the command to sign the message and returns it.
|
||||
#
|
||||
# Receives:
|
||||
# - $PGPVersion: A scalar holding the PGPVersion
|
||||
sub getpgpcommand {
|
||||
my ($PGPVersion) = @_;
|
||||
my $PGPCommand;
|
||||
|
||||
if ($PGPVersion eq '2') {
|
||||
if ($PathtoPGPPass && !$PGPPass) {
|
||||
open (PGPPW, $PathtoPGPPass) or die "$0: E: Can't open $PathtoPGPPass: $!";
|
||||
$PGPPass = <PGPPW>;
|
||||
close PGPPW;
|
||||
}
|
||||
|
||||
if ($PGPPass) {
|
||||
$PGPCommand = "PGPPASS=\"".$PGPPass."\" ".$pgp." -u \"".$PGPSigner."\" +verbose=0 language='en' -saft <".$pgptmpf.".txt >".$pgptmpf.".txt.asc";
|
||||
print "-----BEGIN--------------------------------------------------\n";
|
||||
print @$ArticleR;
|
||||
print "------END---------------------------------------------------\n";
|
||||
# pipe article to script
|
||||
} elsif(defined($Options{'s'})) {
|
||||
open (POST, "| $Options{'s'}") or die "$0: E: Cannot fork $Options{'s'}: $!\n";
|
||||
print POST @$ArticleR;
|
||||
close POST;
|
||||
if ($? == 0) {
|
||||
$failure = 0;
|
||||
} else {
|
||||
die "$0: E: PGP-Passphrase is unknown!\n";
|
||||
}
|
||||
} elsif ($PGPVersion eq '5') {
|
||||
if ($PathtoPGPPass) {
|
||||
$PGPCommand = "PGPPASSFD=2 ".$pgp."s -u \"".$PGPSigner."\" -t --armor -o ".$pgptmpf.".txt.asc -z -f < ".$pgptmpf.".txt 2<".$PathtoPGPPass;
|
||||
} else {
|
||||
die "$0: E: PGP-Passphrase is unknown!\n";
|
||||
}
|
||||
} elsif ($PGPVersion =~ m/GPG/io) {
|
||||
if ($PathtoPGPPass) {
|
||||
$PGPCommand = $pgp." --digest-algo MD5 -a -u \"".$PGPSigner."\" -o ".$pgptmpf.".txt.asc --no-tty --batch --passphrase-fd 2 2<".$PathtoPGPPass." --clearsign ".$pgptmpf.".txt";
|
||||
} else {
|
||||
die "$0: E: Passphrase is unknown!\n";
|
||||
warn "$0: W: $Options{'s'} exited with status ", ($? >> 8), "\n";
|
||||
$failure = $?;
|
||||
}
|
||||
# post article
|
||||
} else {
|
||||
die "$0: E: Unknown PGP-Version $PGPVersion!";
|
||||
}
|
||||
return $PGPCommand;
|
||||
}
|
||||
my $NewsConnection = Net::NNTP->new($Config{'NNTPServer'}, Reader => 1) or die "$0: E: Can't connect to news server '$Config{'NNTPServer'}'!\n";
|
||||
$NewsConnection->authinfo ($Config{'NNTPUser'}, $Config{'NNTPPass'}) if (defined($Config{'NNTPUser'}));
|
||||
$NewsConnection->post();
|
||||
$NewsConnection->datasend (@$ArticleR);
|
||||
$NewsConnection->dataend();
|
||||
|
||||
|
||||
#-------- sub signarticle
|
||||
# signarticle signs an articel and returns a reference to an array
|
||||
# containing the whole signed Message.
|
||||
#
|
||||
# Receives:
|
||||
# - $HeaderAR: A reference to a array containing the articles headers.
|
||||
# - $BodyR: A reference to an array containing the body.
|
||||
#
|
||||
# Returns:
|
||||
# - $MessageRef: A reference to an array containing the whole message.
|
||||
sub signpgp {
|
||||
my ($HeaderAR, $BodyR) = @_;
|
||||
my (@pgphead, @pgpbody, $pgphead, $pgpbody, $header, $signheaders, @signheaders, $currentheader, $HeaderR, $line);
|
||||
|
||||
foreach my $line (@$HeaderAR) {
|
||||
if ($line =~ /^(\S+):\s+(.*)$/s) {
|
||||
$currentheader = $1;
|
||||
$$HeaderR{lc($currentheader)} = "$1: $2";
|
||||
if ($NewsConnection->ok()) {
|
||||
$failure = 0;
|
||||
# Posting failed? Save to ERROR.dat
|
||||
} else {
|
||||
$$HeaderR{lc($currentheader)} .= $line;
|
||||
warn "$0: W: Posting failed!\n";
|
||||
open FH, ">>ERROR.dat";
|
||||
print FH "\nPosting failed! Saving to ERROR.dat. Response from news server:\n";
|
||||
print FH $NewsConnection->code();
|
||||
print FH $NewsConnection->message();
|
||||
print FH "\n";
|
||||
print FH @$ArticleR;
|
||||
print FH "-" x 80, "\n";
|
||||
close FH;
|
||||
}
|
||||
$NewsConnection->quit();
|
||||
}
|
||||
|
||||
foreach (@PGPSignHeaders) {
|
||||
if (defined($$HeaderR{lc($_)}) && $$HeaderR{lc($_)} =~ m/^[^\s:]+: .+/o) {
|
||||
push @signheaders, $_;
|
||||
}
|
||||
}
|
||||
|
||||
$pgpbody = join ("", @$BodyR);
|
||||
|
||||
# Delete and create the temporary pgp-Files
|
||||
unlink "$pgptmpf.txt";
|
||||
unlink "$pgptmpf.txt.asc";
|
||||
$signheaders = join(",", @signheaders);
|
||||
|
||||
$pgphead = "X-Signed-Headers: $signheaders\n";
|
||||
foreach $header (@signheaders) {
|
||||
if ($$HeaderR{lc($header)} =~ m/^[^\s:]+: (.+?)\n?$/so) {
|
||||
$pgphead .= $header.": ".$1."\n";
|
||||
}
|
||||
}
|
||||
|
||||
open(FH, ">" . $pgptmpf . ".txt") or die "$0: E: can't open $pgptmpf: $!\n";
|
||||
print FH $pgphead, "\n", $pgpbody;
|
||||
print FH "\n" if ($PGPVersion =~ m/GPG/io); # workaround a pgp/gpg incompatibility - should IMHO be fixed in pgpverify
|
||||
close(FH) or warn "$0: W: Couldn't close TMP: $!\n";
|
||||
|
||||
# Start PGP, then read the signature;
|
||||
my $PGPCommand = getpgpcommand($PGPVersion);
|
||||
`$PGPCommand`;
|
||||
|
||||
open (FH, "<" . $pgptmpf . ".txt.asc") or die "$0: E: can't open ".$pgptmpf.".txt.asc: $!\n";
|
||||
$/ = "$pgpbegin\n";
|
||||
$_ = <FH>;
|
||||
unless (m/\Q$pgpbegin\E$/o) {
|
||||
# unlink $pgptmpf . ".txt";
|
||||
# unlink $pgptmpf . ".txt.asc";
|
||||
die "$0: E: $pgpbegin not found in ".$pgptmpf.".txt.asc\n"
|
||||
}
|
||||
unlink($pgptmpf . ".txt") or warn "$0: W: Couldn't unlink $pgptmpf.txt: $!\n";
|
||||
|
||||
$/ = "\n";
|
||||
$_ = <FH>;
|
||||
unless (m/^Version: (\S+)(?:\s(\S+))?/o) {
|
||||
unlink $pgptmpf . ".txt";
|
||||
unlink $pgptmpf . ".txt.asc";
|
||||
die "$0: E: didn't find PGP Version line where expected.\n";
|
||||
}
|
||||
|
||||
if (defined($2)) {
|
||||
$$HeaderR{$pgpheader} = $1."-".$2." ".$signheaders;
|
||||
} else {
|
||||
$$HeaderR{$pgpheader} = $1." ".$signheaders;
|
||||
}
|
||||
|
||||
do { # skip other pgp headers like
|
||||
$_ = <FH>; # "charset:"||"comment:" until empty line
|
||||
} while ! /^$/;
|
||||
|
||||
while (<FH>) {
|
||||
chomp;
|
||||
last if /^\Q$pgpend\E$/;
|
||||
$$HeaderR{$pgpheader} .= "\n\t$_";
|
||||
}
|
||||
|
||||
$$HeaderR{$pgpheader} .= "\n" unless ($$HeaderR{$pgpheader} =~ /\n$/s);
|
||||
|
||||
$_ = <FH>;
|
||||
unless (eof(FH)) {
|
||||
unlink $pgptmpf . ".txt";
|
||||
unlink $pgptmpf . ".txt.asc";
|
||||
die "$0: E: unexpected data following $pgpend\n";
|
||||
}
|
||||
close(FH);
|
||||
unlink "$pgptmpf.txt.asc";
|
||||
|
||||
my $tmppgpheader = $pgpheader . ": " . $$HeaderR{$pgpheader};
|
||||
delete $$HeaderR{$pgpheader};
|
||||
|
||||
@pgphead = ();
|
||||
foreach $header (@PGPorderheaders) {
|
||||
if ($$HeaderR{$header} && $$HeaderR{$header} ne "\n") {
|
||||
push(@pgphead, "$$HeaderR{$header}");
|
||||
delete $$HeaderR{$header};
|
||||
}
|
||||
}
|
||||
|
||||
foreach $header (keys %$HeaderR) {
|
||||
if ($$HeaderR{$header} && $$HeaderR{$header} ne "\n") {
|
||||
push(@pgphead, "$$HeaderR{$header}");
|
||||
delete $$HeaderR{$header};
|
||||
}
|
||||
}
|
||||
|
||||
push @pgphead, ("X-PGP-Key: " . $PGPSigner . "\n"), $tmppgpheader;
|
||||
undef $tmppgpheader;
|
||||
|
||||
@pgpbody = split /$/m, $pgpbody;
|
||||
my @pgpmessage = (@pgphead, "\n", @pgpbody);
|
||||
return \@pgpmessage;
|
||||
return $failure;
|
||||
}
|
||||
|
||||
__END__
|
||||
|
@ -491,7 +403,7 @@ yapfaq - Post Usenet FAQs I<(yet another postfaq)>
|
|||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<yapfaq> [B<-hvpd>] [B<-t> I<newsgroups> | CONSOLE] [B<-f> I<project name>]
|
||||
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
|
||||
|
||||
|
@ -527,7 +439,8 @@ headers as defined in its config file (by default F<yapfaq.cfg>).
|
|||
|
||||
F<yapfaq.cfg> consists of one or more blocks, separated by C<=====> on
|
||||
a single line, each containing the configuration for one FAQ as a set
|
||||
of definitions in the form of I<param = value>.
|
||||
of definitions in the form of I<param = value>. Everything after a "#"
|
||||
sign is ignored so you may comment your configuration file.
|
||||
|
||||
=over 4
|
||||
|
||||
|
@ -555,7 +468,7 @@ or I<B<m>onths> or I<B<y>ears>.
|
|||
|
||||
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.
|
||||
|
@ -563,7 +476,7 @@ 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>
|
||||
|
||||
|
@ -589,32 +502,45 @@ appear in the Newsgroups header of the message.
|
|||
|
||||
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-%y-%m-%d@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<Charset> = I<encoding> (optional)
|
||||
|
||||
The character encoding of your FAQ. This setting is optional, but
|
||||
should match the encoding of your FAQ B<File>. Default is set to
|
||||
I<UTF-8>.
|
||||
|
||||
This setting is copied verbatim to the I<Content-Type> header.
|
||||
|
||||
=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.
|
||||
|
@ -623,7 +549,7 @@ This setting is optional.
|
|||
|
||||
=back
|
||||
|
||||
=head2 Example configuration file
|
||||
=head3 Example configuration file
|
||||
|
||||
# name of your project
|
||||
Name = 'testpost'
|
||||
|
@ -638,7 +564,7 @@ This setting is optional.
|
|||
|
||||
# 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'
|
||||
|
@ -653,10 +579,14 @@ This setting is optional.
|
|||
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>'
|
||||
|
||||
# Character Encoding
|
||||
# This setting is optional. Default: UTF-8
|
||||
# Charset = ISO-8859-15
|
||||
|
||||
# Supersede last posting?
|
||||
Supersede = yes
|
||||
|
@ -679,19 +609,96 @@ This setting is optional.
|
|||
MID-Format = '<%n-%m.%y@domain.invalid>'
|
||||
Supersede = yes
|
||||
|
||||
=head3 Status Information
|
||||
|
||||
Information about the last post and about how to form message IDs for
|
||||
posts is stored in a file named F<I<project name>.cfg> which will be
|
||||
generated if it does not exist. Each of those status files will
|
||||
contain two lines, the first being the date of the last time the FAQ
|
||||
was posted and the second being the message ID of that incarnation.
|
||||
|
||||
=head2 Runtime Configuration
|
||||
|
||||
Apart from configuring which FAQ(s) to post you may (re)set some
|
||||
runtime configuration variables via the .rcfile (by default
|
||||
F<.yapfaqrc>). F<.yapfaqrc> must contain one definition in the form of
|
||||
I<param = value> on each line; everything after a "#" sign is ignored.
|
||||
|
||||
If you omit some settings they will be set to default values hardcoded
|
||||
in F<yapfaq.pl>.
|
||||
|
||||
B<Please note that all parameter names are case-sensitive!>
|
||||
|
||||
=over 4
|
||||
|
||||
=item B<NNTPServer> = I<NNTP server> (mandatory)
|
||||
|
||||
Host name of the NNTP server to post to. Must be set (or omitted; the
|
||||
default is "localhost"); if set to en empty string, B<yapfaq> falls
|
||||
back to Perl's build-in defaults (contents of environment variables
|
||||
NNTPSERVER and NEWSHOST; if not set, default from Net::Config; if not
|
||||
set, "news" is used).
|
||||
|
||||
=item B<NNTPUser> = I<user name> (optional)
|
||||
|
||||
User name used for authentication with the NNTP server (I<AUTHINFO
|
||||
USER>).
|
||||
|
||||
This setting is optional; if it is not set, I<NNTPPass> is ignored and
|
||||
no authentication is tried.
|
||||
|
||||
=item B<NNTPPass> = I<password> (optional)
|
||||
|
||||
Password used for authentication with the NNTP server (I<AUTHINFO
|
||||
PASS>).
|
||||
|
||||
This setting is optional; it must be set if I<NNTPUser> is present.
|
||||
|
||||
=item B<Sender> = I<Sender header> (optional)
|
||||
|
||||
The Sender header that will be added to every posted message.
|
||||
|
||||
This setting is optional.
|
||||
|
||||
=item B<ConfigFile> = I<configuration file> (mandatory)
|
||||
|
||||
The configuration file defining the FAQ(s) to post. Must be set (or
|
||||
omitted; the default is "yapfaq.cfg").
|
||||
|
||||
=item B<Program> = I<file name> (optional)
|
||||
|
||||
A program the article is piped to instead of posting it to Usenet.
|
||||
See option "-f" below (which takes preference).
|
||||
|
||||
This setting is optional.
|
||||
|
||||
=back
|
||||
|
||||
=head3 Example runtime configuration file
|
||||
|
||||
NNTPServer = 'localhost'
|
||||
NNTPUser = ''
|
||||
NNTPPass = ''
|
||||
Sender = ''
|
||||
ConfigFile = 'yapfaq.cfg'
|
||||
Program = ''
|
||||
|
||||
=head3 Using more than one runtime configuration
|
||||
|
||||
You may use more than one runtime configuration file with the B<-c>
|
||||
option (see below).
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
=over 3
|
||||
|
||||
=item B<-V> (version)
|
||||
|
||||
Print out version and copyright information on B<yapfaq> and exit.
|
||||
|
||||
=item B<-h> (help)
|
||||
|
||||
Print out version and usage information on B<yapfaq> and exit.
|
||||
Print this man page and exit.
|
||||
|
||||
=item B<-v> (verbose)
|
||||
|
||||
|
@ -711,11 +718,16 @@ update any status information.
|
|||
=item B<-t> I<newsgroup(s) | CONSOLE> (test)
|
||||
|
||||
Don't post to the newsgroups defined in F<yqpfaq.cfg>, but to the
|
||||
newsgroups given after B<-t> as a comma-separated list or print the
|
||||
FAQs to STDOUT separated by lines of dashes if the special string
|
||||
C<CONSOLE> is given. This can be used to preview what B<yapfaq> would
|
||||
do without embarassing yourself on Usenet. The status files are not
|
||||
updated when this option is given.
|
||||
(test) newsgroup(s) given after B<-t> as a comma-separated list or
|
||||
print the FAQs to STDOUT separated by lines of dashes if the special
|
||||
string C<CONSOLE> is given. This can be used to preview what
|
||||
B<yapfaq> would do without embarassing yourself on Usenet.
|
||||
|
||||
The status files are not updated when this option is given.
|
||||
|
||||
When this option is used to post to some other newsgroup(s), a(nother)
|
||||
timestamp is added to the Message-ID header and the Supersedes header
|
||||
is replaced by a special X-Supersedes header.
|
||||
|
||||
You may want to use this with the B<-f> option (see below).
|
||||
|
||||
|
@ -730,6 +742,39 @@ will be posted unconditionally. That may not be what you want to
|
|||
achieve, so you can limit the operation of B<yapfaq> to the named FAQ
|
||||
only.
|
||||
|
||||
=item B<-s> I<program> (pipe to script)
|
||||
|
||||
Instead of posting the article(s) to Usenet pipe them to the external
|
||||
I<program> on STDIN (which may post the article(s) then). A return
|
||||
value of 0 will be considered success.
|
||||
|
||||
For example, you may want to use the I<inews> utility from the INN package
|
||||
or the much more powerful replacement I<tinews.pl> from
|
||||
I<ftp://ftp.tin.org/tin/tools/tinews.pl> which is able to sign postings.
|
||||
|
||||
If I<Program> is also defined in the runtime configuration file (by default
|
||||
F<.yapfaqrc>), B<-s> takes preference.
|
||||
|
||||
=item B<-c> I<.rc file>
|
||||
|
||||
Load another runtime configuration file (.rc file) than F<.yaofaq.rc>.
|
||||
|
||||
You may for example define another usenet server to post your FAQ(s)
|
||||
to or load another configuration file defining (an)other FAQ(s).
|
||||
|
||||
=back
|
||||
|
||||
=head1 INSTALLATION
|
||||
|
||||
Just copy the contents of the tarball in some directory and get started.
|
||||
|
||||
You can post your first test with
|
||||
|
||||
yapfaq -c .yapfaqrc.sample
|
||||
|
||||
or copy F<.yapfaqrc.sample> to F<.yapfaqrc> and F<yapfaq.cfg.sample>
|
||||
to F<yapfaq.cfg>, edit those files and get really started!
|
||||
|
||||
=back
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
@ -752,9 +797,26 @@ if it is due:
|
|||
|
||||
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
|
||||
|
||||
|
@ -764,6 +826,10 @@ There are no special environment variables used by B<yapfaq>.
|
|||
|
||||
The script itself.
|
||||
|
||||
=item F<.yapfaqrc>
|
||||
|
||||
Runtime configuration file for B<yapfaq>.
|
||||
|
||||
=item F<yapfaq.cfg>
|
||||
|
||||
Configuration file for B<yapfaq>.
|
||||
|
@ -781,26 +847,29 @@ the last post of that FAQ.
|
|||
|
||||
=head1 BUGS
|
||||
|
||||
Many, I'm sure.
|
||||
Please report any bugs or feature requests to the author or use the
|
||||
bug tracker at L<https://code.virtcomm.de/thh/yapfaq/issues>!
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<http://th-h.de/download/scripts.php> will have the current
|
||||
L<https://th-h.de/net/software/yapfaq/> will have the current
|
||||
version of this program.
|
||||
|
||||
This program is maintained using the Git version control system at
|
||||
L<https://code.virtcomm.de/thh/yapfaq/>.
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Thomas Hochstein <thh@inter.net>
|
||||
Thomas Hochstein <thh@thh.name>
|
||||
|
||||
Original author (until version 0.5b from 2003):
|
||||
Original author (up to version 0.5b, dating from 2003):
|
||||
Marc Brockschmidt <marc@marcbrockschmidt.de>
|
||||
|
||||
|
||||
=head1 COPYRIGHT AND LICENSE
|
||||
|
||||
Copyright (c) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
|
||||
|
||||
Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
|
||||
Copyright (c) 2010-2017 Thomas Hochstein <thh@thh.name>
|
||||
|
||||
This program is free software; you may redistribute it and/or modify it
|
||||
under the same terms as Perl itself.
|
||||
|
|
Loading…
Reference in a new issue