Compare commits

..

No commits in common. "master" and "v0.8.1" have entirely different histories.

7 changed files with 44 additions and 151 deletions

View file

@ -2,5 +2,5 @@ NNTPServer = 'localhost'
NNTPUser = ''
NNTPPass = ''
Sender = ''
ConfigFile = 'yapfaq.cfg.sample'
ConfigFile = 'yapfaq.cfg'
Program = ''

View file

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

View file

@ -1,13 +0,0 @@
# 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).

View file

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

11
test.txt Normal file
View file

@ -0,0 +1,11 @@
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 = 'sample'
Name = 'testpost'
# file to post (complete body and pseudo-headers)
# ($File.cfg contains data on last posting and last MID)
File = 'sample.txt'
File = 'test.txt'
# how often your project should be posted
# use (d)ay OR (w)eek OR (m)onth OR (y)ear
@ -15,7 +15,7 @@ Posting-frequency = '1d'
# Expires = '3m'
# header "From:"
From = 'John Doe <john-doe@example.com>'
From = 'test@domain.invalid'
# header "Subject:"
# (may contain "%LM" which will be replaced by the contents of the
@ -31,12 +31,8 @@ NGs = 'de.test'
# Fup2 = 'poster'
# Message-ID ("%n" is $Name)
# 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
# This setting is optional. Default: <%n-%d.%m.%y@YOURHOST>
# MID-Format = '<%n-%d.%m.%y@domain.invalid>'
# Supersede last posting?
# This setting is optional. Default: unset

92
yapfaq.pl Executable file → Normal file
View file

@ -1,18 +1,18 @@
#! /usr/bin/perl -W
#
# yapfaq Version 0.10 by Thomas Hochstein
# yapfaq Version 0.8.1 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-2017 Thomas Hochstein <thh@thh.name>
# Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
#
# It can be redistributed and/or modified under the same terms under
# which Perl itself is published.
our $VERSION = "0.10";
our $VERSION = "0.8.1";
# Please do not change this setting!
# You may override the default .rc file (.yapfaqrc) by using "-c .rc file"
@ -36,6 +36,7 @@ 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
@ -45,7 +46,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-2017 Thomas Hochstein <thh\@thh.name>\n";
print "$0 v $VERSION\nCopyright (c) 2003 Marc Brockschmidt <marc\@marcbrockschmidt.de>\nCopyright (c) 2010 Thomas Hochstein <thh\@inter.net>\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);
}
@ -82,7 +83,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,$Charset,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'charset'},$$_{'extraheader'});
my ($MIDF,$ReplyTo,$ExtHea)=($$_{'mid-format'},$$_{'reply-to'},$$_{'extraheader'});
my ($Supersede) =($$_{'supersede'});
# -f: loop if not FAQ to post
@ -111,7 +112,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,\$Charset,\$ExtHea,\$Config{'Sender'},\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
postfaq(\$ActName,\$File,\$From,\$Subject,\$NG,\$Fup2,\$MIDF,\$ExtHea,\$Config{'Sender'},\$TDY,\$TDM,\$TDD,\$ReplyTo,\$SupersedeMID,\$Expire);
}
} elsif($Options{'v'}) {
print "$ActName: Nothing to do.\n";
@ -194,7 +195,7 @@ sub readconfig{
}
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
$$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;
@ -238,7 +239,7 @@ sub updatestatus {
# It reads the data-file $File and then posts the article.
sub postfaq {
my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$Charset,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
my ($ActName,$File,$From,$Subject,$NG,$Fup2,$MIDF,$ExtraHeaders,$Sender,$TDY,$TDM,$TDD,$ReplyTo,$Supersedes,$Expire) = @_;
my (@Header,@Body,$MID,$InRealBody,$LastModified);
print "$$ActName: Preparing to post.\n" if($Options{'v'});
@ -249,7 +250,7 @@ sub postfaq {
my $Timestamp = time;
$MID = $$MIDF;
$MID = '<%n-%y-%m-%d@'.hostfqdn.'>' if !defined($MID); # set to default if unset
$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;
@ -262,7 +263,7 @@ sub postfaq {
s/\r//;
push (@Body, $_), next if $InRealBody;
$InRealBody++ if /^$/;
$LastModified = $1 if /^Last-modified:\s*(\S+)\s*$/i;
$LastModified = $1 if /^Last-modified: (\S+)$/i;
push @Body, $_;
}
close FH;
@ -291,22 +292,11 @@ 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:
@ -321,7 +311,7 @@ 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: $ContentType\n";
push @Header, "Content-Type: text/plain; charset=ISO-8859-15\n";
push @Header, "Content-Transfer-Encoding: 8bit\n";
push @Header, "User-Agent: yapfaq/$VERSION\n";
if ($$ExtraHeaders) {
@ -519,20 +509,12 @@ 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-%y-%m-%d@I<YOURHOST>>'
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<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
@ -584,10 +566,6 @@ 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
@ -718,16 +696,11 @@ 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
(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.
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.
You may want to use this with the B<-f> option (see below).
@ -764,19 +737,6 @@ 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:
@ -847,20 +807,22 @@ the last post of that FAQ.
=head1 BUGS
Please report any bugs or feature requests to the author or use the
bug tracker at L<https://code.virtcomm.de/thh/yapfaq/issues>!
Please report any bugs or feature request to the author or use the
bug tracker at L<http://bugs.th-h.de/>!
=head1 SEE ALSO
L<https://th-h.de/net/software/yapfaq/> will have the current
L<http://th-h.de/download/scripts.php> 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/>.
This program is maintained using the Git version control system. You
may clone L<git://code.th-h.de/usenet/yapfaq.git> to check out the
current development tree or browse it on the web via
L<http://code.th-h.de/?p=usenet/yapfaq.git>.
=head1 AUTHOR
Thomas Hochstein <thh@thh.name>
Thomas Hochstein <thh@inter.net>
Original author (up to version 0.5b, dating from 2003):
Marc Brockschmidt <marc@marcbrockschmidt.de>
@ -869,7 +831,7 @@ Marc Brockschmidt <marc@marcbrockschmidt.de>
Copyright (c) 2003 Marc Brockschmidt <marc@marcbrockschmidt.de>
Copyright (c) 2010-2017 Thomas Hochstein <thh@thh.name>
Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself.