Compare commits

...

34 commits
v0.7 ... master

Author SHA1 Message Date
Thomas Hochstein 09d51964aa Update POD documentation (URLs).
Signed-off-by: Thomas Hochstein <thh@thh.name>
2024-05-27 01:01:08 +02:00
Thomas Hochstein 99d4cbcae2 Add README.
Signed-off-by: Thomas Hochstein <thh@thh.name>
2024-05-26 00:33:07 +02:00
Thomas Hochstein 4fe0c455ea Change mail address.
Signed-off-by: Thomas Hochstein <thh@thh.name>
2020-08-23 22:47:56 +02:00
Thomas Hochstein 15dd22593e Don't warn for missing optional encoding setting.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2017-08-19 16:21:14 +02:00
Thomas Hochstein 6e49580a28 Mark yapfaq.pl executable.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2017-08-19 16:10:43 +02:00
Thomas Hochstein 3b06ebf93a Add Charset setting to config file.
Fixes .

Signed-off-by: Thomas Hochstein <thh@inter.net>
2017-08-19 15:52:23 +02:00
Thomas Hochstein cc74e2f92b Bump version, copyright; update URLs.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2017-08-19 15:32:13 +02:00
Thomas Hochstein 04eac1b541 Fix typo in POD.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2012-10-12 20:12:11 +02:00
Thomas Hochstein 9224368882 Release 0.9.1 (Maintenance Release)
Add changelog entry.

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-11-01 18:01:32 +01:00
Thomas Hochstein 0b68926d7c Test mode: Add X-Supersedes only if Supersedes would be set.
Fixes .

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-10-31 18:42:52 +01:00
Thomas Hochstein 373681d034 Bump version number to 0.91.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-10-31 18:42:17 +01:00
Thomas Hochstein bd3a4c3841 Release 0.9
Add changelog entries.
Bump version number.

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-09-11 23:58:15 +02:00
Thomas Hochstein f5a291096e Drop use of Fcntl (not needed).
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-06-15 22:30:11 +02:00
Thomas Hochstein c4765a39f3 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 .

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-15 19:16:40 +02:00
Thomas Hochstein 8f65a0a519 Change default Message-ID format.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-15 19:04:24 +02:00
Thomas Hochstein b146f21475 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 .

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-15 17:22:20 +02:00
Thomas Hochstein 3b2e5e066d Change: Drop %LM from subject if Last-Modified is not found.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-15 16:36:52 +02:00
Thomas Hochstein b16eb1aec4 Fix: Accept leading/trailing whitespace for Last-modified pseudo header.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-15 16:32:58 +02:00
Thomas Hochstein dc66bfa3f5 Bump version (0.9-prelease).
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-14 22:15:31 +02:00
Thomas Hochstein 994d975969 Release 0.8.1 (Maintenance Release)
Add changelog entries.
Bump version number.

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-14 22:04:00 +02:00
Thomas Hochstein ba8ae1cfe5 Fix broken implementation of "Program" in .yapfaqrc.
Fixes .

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-14 21:58:15 +02:00
Thomas Hochstein cdfec198d6 Release 0.8
Add changelog entries.
Bump version number.

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-13 22:00:21 +02:00
Thomas Hochstein 2d8e5cdbc7 Documentation: Add Git repository and bug tracker.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-13 19:33:40 +02:00
Thomas Hochstein bdbb9d7043 Making use of Getopt::Std's --help and --version.
Fixes .

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-13 19:33:25 +02:00
Thomas Hochstein 39cb5672df Add "Program" to .yapfaqrc.
Fixes .

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-13 19:31:49 +02:00
Thomas Hochstein 0e741504fe Drop PGP support.
You may use tinews.pl from
ftp://ftp.tin.org/tin/tools/tinews.pl instead.

Fixes .

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-05-13 19:24:44 +02:00
Thomas Hochstein 8f067a2ffb Fix: Consistency check for MID-Format fixed (regexp).
Signed-off-by: Thomas Hochstein <thh@inter.net>

Fix.
2010-04-14 23:31:37 +02:00
Thomas Hochstein 13ce8c26a3 Add: MID-Format may now contain %t for a Unix timestamp.
%t will be replaced by the number of seconds since the epoch.

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-04-14 23:31:23 +02:00
Thomas Hochstein 605916ef61 Add comments pointing to .yapfaqrc to source.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-04-14 10:10:28 +02:00
Thomas Hochstein 9817f98a91 Fix: Add "-V", NNTPSERVER to documentation, add more examples.
Added examples for -s and -c.

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-04-14 10:02:48 +02:00
Thomas Hochstein b802358a60 readconfig(): Add file name to verbose output.
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-04-14 09:38:23 +02:00
Thomas Hochstein 7ef63844b5 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.

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-04-14 09:11:45 +02:00
Thomas Hochstein e16539c99c Change sample yapfaq.cfg (mark optional settings).
Optional settings are mostly commented out.

Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-04-14 09:10:05 +02:00
Thomas Hochstein 647af2ea07 Bump version (0.8-prelease).
Signed-off-by: Thomas Hochstein <thh@inter.net>
2010-04-14 09:07:19 +02:00
8 changed files with 271 additions and 280 deletions

View file

@ -1,17 +0,0 @@
NNTPServer = 'localhost'
NNTPUser = ''
NNTPPass = ''
Sender = ''
ConfigFile = 'yapfaq.cfg'
UsePGP = 0
################################## PGP-Config #################################
pgp = '/usr/bin/pgp' # path to pgp
PGPVersion = '2' # Use 2 for 2.X 5 for PGP > 2.X and GPG for GPG
PGPSigner = '' # sign as who?
PGPPass = '' # pgp2 only
PathtoPGPPass = '' # pgp2 pgp5 and gpg
pgpbegin = '-----BEGIN PGP SIGNATURE-----' # Begin of PGP-Signature
pgpend = '-----END PGP SIGNATURE-----' # End of PGP-Signature
pgptmpf = 'pgptmp' # temporary file for PGP.
pgpheader = 'X-PGP-Sig'

6
.yapfaqrc.sample Normal file
View file

@ -0,0 +1,6 @@
NNTPServer = 'localhost'
NNTPUser = ''
NNTPPass = ''
Sender = ''
ConfigFile = 'yapfaq.cfg.sample'
Program = ''

108
ChangeLog
View file

@ -1,3 +1,111 @@
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.

13
README.md Normal file
View 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
View file

@ -0,0 +1,9 @@
Last-modified: 2010-05-15
This is a test message.
Foo.
Bar.
That's quite enought, isn't it?

View file

@ -1,11 +0,0 @@
Last-modified: 2003-01-11
Dies ist ein Test-Artikel. Klasse, was?
Bla.
Noch mehr foo.
Bar.
Nu reicht's.

View file

@ -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'

366
yapfaq.pl Normal file → Executable file
View file

@ -1,63 +1,43 @@
#! /usr/bin/perl -W
#
# yapfaq Version 0.7 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.7";
our $VERSION = "0.10";
# Please do not change this setting!
# You may override the default .rc file (.yapfaqrc) by using "-c .rc file"
my $RCFile = '.yapfaqrc';
my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile',
'UsePGP','pgp','PGPVersion','PGPSigner','PGPPass',
'PathtoPGPPass','pgpbegin','pgpend','pgptmpf','pgpheader');
# Valid configuration variables for use in a .rc file
my @ValidConfVars = ('NNTPServer','NNTPUser','NNTPPass','Sender','ConfigFile','Program');
################################### 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 => "",
ConfigFile => "yapfaq.cfg",
UsePGP => 0,
Program => "");
################################## PGP-Config #################################
pgp => '/usr/bin/pgp', # path to pgp
PGPVersion => '2', # Use 2 for 2.X, 5 for PGP > 2.X and GPG for GPG
PGPSigner => '', # sign as who?
PGPPass => '', # pgp2 only
PathtoPGPPass => '', # pgp2, pgp5 and gpg
pgpbegin => '-----BEGIN PGP SIGNATURE-----', # Begin of PGP-Signature
pgpend => '-----END PGP SIGNATURE-----', # End of PGP-Signature
pgptmpf => 'pgptmp', # temporary file for PGP.
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
@ -65,7 +45,7 @@ my %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 Thomas Hochstein <thh\@inter.net>\n";
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);
}
@ -85,6 +65,8 @@ if (-f $RCFile) {
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);
@ -100,7 +82,7 @@ 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
@ -129,7 +111,7 @@ foreach (@Config) {
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,\$Config{'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";
@ -166,7 +148,7 @@ sub readconfig{
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>) {
@ -210,9 +192,9 @@ sub readconfig{
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{2,}\.\S{2,}>$/) {
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-%d.%m.%y@'.hostfqdn.'>'; # set default if mid-format is invalid
$$Config[$i]{'mid-format'} = '<%n-%y-%m-%d@'.hostfqdn.'>'; # set default if mid-format is invalid
}
}
$Error .= "-" x 25 . 'program terminated' . "-" x 25 . "\n" if $Error;
@ -256,7 +238,7 @@ sub updatestatus {
# 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);
print "$$ActName: Preparing to post.\n" if($Options{'v'});
@ -264,13 +246,15 @@ sub postfaq {
#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); # set to default if unset
$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");
@ -278,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;
@ -307,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:
@ -326,16 +321,15 @@ 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);
}
# sign article if $UsePGP is true
my @Article = ($Config{'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);
@ -399,169 +393,6 @@ sub post {
return $failure;
}
#-------- 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 ($Config{'PathtoPGPPass'} && !$Config{'PGPPass'}) {
open (PGPPW, $Config{'PathtoPGPPass'}) or die "$0: E: Can't open $Config{'PathtoPGPPass'}: $!";
Config{'$PGPPass'} = <PGPPW>;
close PGPPW;
}
if (Config{'$PGPPass'}) {
$PGPCommand = "PGPPASS=\"".$Config{'PGPPass'}."\" ".$Config{'pgp'}." -u \"".$Config{'PGPSigner'}."\" +verbose=0 language='en' -saft <".$Config{'pgptmpf'}.".txt >".$Config{'pgptmpf'}.".txt.asc";
} else {
die "$0: E: PGP-Passphrase is unknown!\n";
}
} elsif ($PGPVersion eq '5') {
if ($Config{'PathtoPGPPass'}) {
$PGPCommand = "PGPPASSFD=2 ".$Config{'pgp'}."s -u \"".$Config{'PGPSigner'}."\" -t --armor -o ".$Config{'pgptmpf'}.".txt.asc -z -f < ".$Config{'pgptmpf'}.".txt 2<".$Config{'PathtoPGPPass'};
} else {
die "$0: E: PGP-Passphrase is unknown!\n";
}
} elsif ($PGPVersion =~ m/GPG/io) {
if (Config{'$PathtoPGPPass'}) {
$PGPCommand = $Config{'pgp'}." --digest-algo MD5 -a -u \"".$Config{'PGPSigner'}."\" -o ".$Config{'pgptmpf'}.".txt.asc --no-tty --batch --passphrase-fd 2 2<".$Config{'PathtoPGPPass'}." --clearsign ".$Config{'pgptmpf'}.".txt";
} else {
die "$0: E: Passphrase is unknown!\n";
}
} else {
die "$0: E: Unknown PGP-Version $PGPVersion!";
}
return $PGPCommand;
}
#-------- 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";
} else {
$$HeaderR{lc($currentheader)} .= $line;
}
}
foreach (@PGPSignHeaders) {
if (defined($$HeaderR{lc($_)}) && $$HeaderR{lc($_)} =~ m/^[^\s:]+: .+/o) {
push @signheaders, $_;
}
}
$pgpbody = join ("", @$BodyR);
# Delete and create the temporary pgp-Files
unlink "$Config{'pgptmpf'}.txt";
unlink "$Config{'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, ">" . $Config{'pgptmpf'} . ".txt") or die "$0: E: can't open $Config{'pgptmpf'}: $!\n";
print FH $pgphead, "\n", $pgpbody;
print FH "\n" if ($Config{'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($Config{'PGPVersion'});
`$PGPCommand`;
open (FH, "<" . $Config{'pgptmpf'} . ".txt.asc") or die "$0: E: can't open ".$Config{'pgptmpf'}.".txt.asc: $!\n";
$/ = "$Config{'pgpbegin'}\n";
$_ = <FH>;
unless (m/\Q$Config{'pgpbegin'}\E$/o) {
# unlink $Config{'pgptmpf'} . ".txt";
# unlink $Config{'pgptmpf'} . ".txt.asc";
die "$0: E: $Config{'pgpbegin'} not found in ".$Config{'pgptmpf'}.".txt.asc\n"
}
unlink($Config{'pgptmpf'} . ".txt") or warn "$0: W: Couldn't unlink $Config{'pgptmpf'}.txt: $!\n";
$/ = "\n";
$_ = <FH>;
unless (m/^Version: (\S+)(?:\s(\S+))?/o) {
unlink $Config{'pgptmpf'} . ".txt";
unlink $Config{'pgptmpf'} . ".txt.asc";
die "$0: E: didn't find PGP Version line where expected.\n";
}
if (defined($2)) {
$$HeaderR{$Config{'pgpheader'}} = $1."-".$2." ".$signheaders;
} else {
$$HeaderR{$Config{'pgpheader'}} = $1." ".$signheaders;
}
do { # skip other pgp headers like
$_ = <FH>; # "charset:"||"comment:" until empty line
} while ! /^$/;
while (<FH>) {
chomp;
last if /^\Q$Config{'pgpend'}\E$/;
$$HeaderR{$Config{'pgpheader'}} .= "\n\t$_";
}
$$HeaderR{$Config{'pgpheader'}} .= "\n" unless ($$HeaderR{$Config{'pgpheader'}} =~ /\n$/s);
$_ = <FH>;
unless (eof(FH)) {
unlink $Config{'pgptmpf'} . ".txt";
unlink $Config{'pgptmpf'} . ".txt.asc";
die "$0: E: unexpected data following $Config{'pgpend'}\n";
}
close(FH);
unlink "$Config{'pgptmpf'}.txt.asc";
my $tmppgpheader = $Config{'pgpheader'} . ": " . $$HeaderR{$Config{'pgpheader'}};
delete $$HeaderR{$Config{'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: " . $Config{'PGPSigner'} . "\n"), $tmppgpheader;
undef $tmppgpheader;
@pgpbody = split /$/m, $pgpbody;
my @pgpmessage = (@pgphead, "\n", @pgpbody);
return \@pgpmessage;
}
__END__
################################ Documentation #################################
@ -572,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<-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
@ -684,15 +515,24 @@ 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 setting is optional; the default is '<%n-%d.%m.%y@I<YOURHOST>>'
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<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
@ -744,6 +584,10 @@ This setting is optional.
# Message-ID ("%n" is $Name)
# 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
@ -821,17 +665,12 @@ This setting is optional.
The configuration file defining the FAQ(s) to post. Must be set (or
omitted; the default is "yapfaq.cfg").
=item B<UsePGP> = I<whether to add a digital signature> (optional)
=item B<Program> = I<file name> (optional)
Boolean value (0 or 1) controlling whether the FAQs will get digitally
signed via an X-PGP-Sig header.
A program the article is piped to instead of posting it to Usenet.
See option "-f" below (which takes preference).
This setting is optional; the default is 0.
If you have set I<UsePGP> to 1, you must also supply the necessary
information on your PGP oder GPG installation; please refer to the
sample F<.yapfaqrc> file (see below) for more information on this
topic.
This setting is optional.
=back
@ -842,18 +681,7 @@ topic.
NNTPPass = ''
Sender = ''
ConfigFile = 'yapfaq.cfg'
UsePGP = 0
################################## PGP-Config #################################
pgp = '/usr/bin/pgp' # path to pgp
PGPVersion = '2' # Use 2 for 2.X 5 for PGP > 2.X and GPG for GPG
PGPSigner = '' # sign as who?
PGPPass = '' # pgp2 only
PathtoPGPPass = '' # pgp2 pgp5 and gpg
pgpbegin = '-----BEGIN PGP SIGNATURE-----' # Begin of PGP-Signature
pgpend = '-----END PGP SIGNATURE-----' # End of PGP-Signature
pgptmpf = 'pgptmp' # temporary file for PGP.
pgpheader = 'X-PGP-Sig'
Program = ''
=head3 Using more than one runtime configuration
@ -890,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).
@ -915,6 +748,13 @@ 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>.
@ -924,6 +764,19 @@ 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
Post all FAQs that are due for posting:
@ -944,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
@ -977,16 +847,20 @@ 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 (up to version 0.5b, dating from 2003):
Marc Brockschmidt <marc@marcbrockschmidt.de>
@ -995,7 +869,7 @@ Marc Brockschmidt <marc@marcbrockschmidt.de>
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.