thh/newsstats
1
0
Fork 0
Code Issues 4 Pull requests Packages Projects Releases Activity

Merge branch 'thh-small-changes' into next

Browse source 
* thh-small-changes:
  Fix displayed path in install.
  Update INSTALL documentation.
  Fix documentation relating to conffile location.
  Fix --conffile in POD.
  Bump version numbers.
  Fix forgotten dates.
  Fix ea91003a99.
This commit is contained in:
Thomas Hochstein 2018-01-01 16:58:25 +01:00
parent 599fefbf6a fd0717a15c
commit 91c674c4fe
6 changed files with 34 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
bin/feedlog.pl
View file

@ -13,7 +13,7 @@
# which Perl itself is published. # which Perl itself is published.
BEGIN { BEGIN {
our $VERSION = "0.01"; our $VERSION = "0.02";
use File::Basename; use File::Basename;
# we're in .../bin, so our module is in ../lib # we're in .../bin, so our module is in ../lib
push(@INC, dirname($0).'/../lib'); push(@INC, dirname($0).'/../lib');
@ -153,7 +153,7 @@ feedlog - log data from an INN feed to a database
=head1 SYNOPSIS =head1 SYNOPSIS
B<feedlog> [B<-Vhdq>] [--conffile I<filename>] B<feedlog> [B<-Vhdq>] [B<--conffile> I<filename>]
=head1 REQUIREMENTS =head1 REQUIREMENTS
@ -174,7 +174,8 @@ terminating would only result in a rapid respawn.
=head2 Configuration =head2 Configuration
B<feedlog> will read its configuration from F<newsstats.conf> which B<feedlog> will read its configuration from F<newsstats.conf> which
should be present in the same directory via Config::Auto. should be present in etc/ via Config::Auto or from a configuration file
submitted by the B<--conffile> option.
See L<doc/INSTALL> for an overview of possible configuration options. See L<doc/INSTALL> for an overview of possible configuration options.
@ -265,7 +266,7 @@ Thomas Hochstein <thh@inter.net>
=head1 COPYRIGHT AND LICENSE =head1 COPYRIGHT AND LICENSE
Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net> Copyright (c) 2010-2013 Thomas Hochstein <thh@inter.net>
This program is free software; you may redistribute it and/or modify it This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself. under the same terms as Perl itself.

9
bin/gatherstats.pl
View file

@ -13,7 +13,7 @@
# which Perl itself is published. # which Perl itself is published.
BEGIN { BEGIN {
our $VERSION = "0.01"; our $VERSION = "0.02";
use File::Basename; use File::Basename;
# we're in .../bin, so our module is in ../lib # we're in .../bin, so our module is in ../lib
push(@INC, dirname($0).'/../lib'); push(@INC, dirname($0).'/../lib');
@ -210,7 +210,7 @@ gatherstats - process statistical data from a raw source
=head1 SYNOPSIS =head1 SYNOPSIS
B<gatherstats> [B<-Vhdt>] [B<-m> I<YYYY-MM> | I<YYYY-MM:YYYY-MM>] [B<-s> I<stats>] [B<-c> I<filename template>]] [B<--hierarchy> I<TLH>] [B<--rawdb> I<database table>] [B<-groupsdb> I<database table>] [B<--clientsdb> I<database table>] [B<--hostsdb> I<database table>] [--conffile I<filename>] B<gatherstats> [B<-Vhdt>] [B<-m> I<YYYY-MM> | I<YYYY-MM:YYYY-MM>] [B<-s> I<stats>] [B<-c> I<filename template>]] [B<--hierarchy> I<TLH>] [B<--rawdb> I<database table>] [B<-groupsdb> I<database table>] [B<--clientsdb> I<database table>] [B<--hostsdb> I<database table>] [B<--conffile> I<filename>]
=head1 REQUIREMENTS =head1 REQUIREMENTS
@ -261,7 +261,8 @@ override that default through the B<--groupsdb> option.
=head2 Configuration =head2 Configuration
B<gatherstats> will read its configuration from F<newsstats.conf> B<gatherstats> will read its configuration from F<newsstats.conf>
which should be present in the same directory via Config::Auto. which should be present in etc/ via Config::Auto or from a configuration file
submitted by the B<--conffile> option.
See L<doc/INSTALL> for an overview of possible configuration options. See L<doc/INSTALL> for an overview of possible configuration options.
@ -417,7 +418,7 @@ Thomas Hochstein <thh@inter.net>
=head1 COPYRIGHT AND LICENSE =head1 COPYRIGHT AND LICENSE
Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net> Copyright (c) 2010-2013 Thomas Hochstein <thh@inter.net>
This program is free software; you may redistribute it and/or modify it This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself. under the same terms as Perl itself.

13
bin/groupstats.pl
View file

@ -13,7 +13,7 @@
# which Perl itself is published. # which Perl itself is published.
BEGIN { BEGIN {
our $VERSION = "0.01"; our $VERSION = "0.02";
use File::Basename; use File::Basename;
# we're in .../bin, so our module is in ../lib # we're in .../bin, so our module is in ../lib
push(@INC, dirname($0).'/../lib'); push(@INC, dirname($0).'/../lib');
@ -140,8 +140,8 @@ $OptGroupBy = 'newsgroup' if (!$OptGroupBy and
$OptBoundType and $OptBoundType ne 'default'); $OptBoundType and $OptBoundType ne 'default');
# default to 'newsgroup' if $OptGroupBy is not set and # default to 'newsgroup' if $OptGroupBy is not set and
# just one newsgroup is requested, but more than one month # just one newsgroup is requested, but more than one month
$OptGroupBy = 'newsgroup' if (!$OptGroupBy and $OptGroupBy = 'newsgroup' if (!$OptGroupBy and $OptMonth and $OptMonth =~ /:/
$OptMonth =~ /:/ and $OptNewsgroups !~ /[:*%]/); and $OptNewsgroups and $OptNewsgroups !~ /[:*%]/);
# parse $OptGroupBy to $GroupBy, create ORDER BY clause $SQLOrderClause # parse $OptGroupBy to $GroupBy, create ORDER BY clause $SQLOrderClause
# if $OptGroupBy is still not set, SQLSortOrder() will default to 'month' # if $OptGroupBy is still not set, SQLSortOrder() will default to 'month'
my ($GroupBy,$SQLOrderClause) = SQLSortOrder($OptGroupBy, $OptOrderBy); my ($GroupBy,$SQLOrderClause) = SQLSortOrder($OptGroupBy, $OptOrderBy);
@ -277,7 +277,7 @@ groupstats - create reports on newsgroup usage
=head1 SYNOPSIS =head1 SYNOPSIS
B<groupstats> [B<-Vhcs> B<--comments>] [B<-m> I<YYYY-MM>[:I<YYYY-MM>] | I<all>] [B<-n> I<newsgroup(s)>] [B<--checkgroups> I<checkgroups file>] [B<-r> I<report type>] [B<-l> I<lower boundary>] [B<-u> I<upper boundary>] [B<-b> I<boundary type>] [B<-g> I<group by>] [B<-o> I<order by>] [B<-f> I<output format>] [B<--filetemplate> I<filename template>] [B<--groupsdb> I<database table>] [--conffile I<filename>] B<groupstats> [B<-Vhcs> B<--comments>] [B<-m> I<YYYY-MM>[:I<YYYY-MM>] | I<all>] [B<-n> I<newsgroup(s)>] [B<--checkgroups> I<checkgroups file>] [B<-r> I<report type>] [B<-l> I<lower boundary>] [B<-u> I<upper boundary>] [B<-b> I<boundary type>] [B<-g> I<group by>] [B<-o> I<order by>] [B<-f> I<output format>] [B<--filetemplate> I<filename template>] [B<--groupsdb> I<database table>] [B<--conffile> I<filename>]
=head1 REQUIREMENTS =head1 REQUIREMENTS
@ -342,7 +342,8 @@ Captions and comments are automatically disabled in this case.
=head2 Configuration =head2 Configuration
B<groupstats> will read its configuration from F<newsstats.conf> B<groupstats> will read its configuration from F<newsstats.conf>
which should be present in the same directory via Config::Auto. which should be present in etc/ via Config::Auto or from a configuration file
submitted by the B<--conffile> option.
See doc/INSTALL for an overview of possible configuration options. See doc/INSTALL for an overview of possible configuration options.
@ -704,7 +705,7 @@ Thomas Hochstein <thh@inter.net>
=head1 COPYRIGHT AND LICENSE =head1 COPYRIGHT AND LICENSE
Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net> Copyright (c) 2010-2013 Thomas Hochstein <thh@inter.net>
This program is free software; you may redistribute it and/or modify it This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself. under the same terms as Perl itself.

14
doc/INSTALL
View file

@ -28,21 +28,21 @@ INSTALLATION INSTRUCTIONS
* Copy the sample configuration file newsstats.conf.sample to * Copy the sample configuration file newsstats.conf.sample to
newsstats.conf and modify it for your purposes: newsstats.conf and modify it for your purposes:
# cp newsstats.conf.sample newsstats.conf # cp etc/newsstats.conf.sample etc/newsstats.conf
# vim newsstats.conf # vim etc/newsstats.conf
a) Mandatory configuration options a) Mandatory configuration options
* DBDriver = mysql * DBDriver = mysql
Database driver used; currently only mysql is supported. Database driver used; currently only mysql is supported.
* DBHost = localhost * DBHost = localhost
The host your mysql server is running on. The host your mysql server is running on.
* DBUser = * DBUser =
The username to connect to the database server. The username to connect to the database server.
* DBPw = * DBPw =
Matching password for your username. Matching password for your username.
* DBDatabase = newsstats * DBDatabase = newsstats
@ -61,17 +61,17 @@ INSTALLATION INSTRUCTIONS
* TLH = de * TLH = de
Limit examination to that top-level hierarchy. Limit examination to that top-level hierarchy.
3) Database (mysql) setup 3) Database (mysql) setup
* Setup your database server with a username, password and * Setup your database server with a username, password and
database matching the NewsStats configuration (see 2 a). database matching the NewsStats configuration (see 2 a).
* Start the installation script: * Start the installation script:
# install/install.pl # install/install.pl
It will setup the necessary database tables and display some It will setup the necessary database tables and display some
information on the next steps. information on the next steps.
4) Feed (INN) setup 4) Feed (INN) setup

19
install/install.pl
View file

@ -12,7 +12,7 @@
# which Perl itself is published. # which Perl itself is published.
BEGIN { BEGIN {
our $VERSION = "0.01"; our $VERSION = "0.02";
use File::Basename; use File::Basename;
# we're in .../install, so our module is in ../lib # we're in .../install, so our module is in ../lib
push(@INC, dirname($0).'/../lib'); push(@INC, dirname($0).'/../lib');
@ -22,8 +22,6 @@ use warnings;
use NewsStats qw(:DEFAULT); use NewsStats qw(:DEFAULT);
use Cwd;
use DBI; use DBI;
use Getopt::Long qw(GetOptions); use Getopt::Long qw(GetOptions);
Getopt::Long::config ('bundling'); Getopt::Long::config ('bundling');
@ -37,10 +35,6 @@ GetOptions ('u|update=s' => \$OptUpdate,
'h|help' => \&ShowPOD, 'h|help' => \&ShowPOD,
'V|version' => \&ShowVersion) or exit 1; 'V|version' => \&ShowVersion) or exit 1;
### change working directory to .. (as we're in .../install)
chdir dirname($FullPath).'/..';
my $Path = cwd();
### read configuration ### read configuration
print("Reading configuration.\n"); print("Reading configuration.\n");
my %Conf = %{ReadConfig($OptConfFile)}; my %Conf = %{ReadConfig($OptConfFile)};
@ -109,7 +103,7 @@ Things left to do:
## gather statistics for NewsStats ## gather statistics for NewsStats
newsstats!\\ newsstats!\\
:!*,de.*\\ :!*,de.*\\
:Tc,WmtfbsPNH,Ac:$Path/feedlog.pl :Tc,WmtfbsPNH,Ac:$HomePath/bin/feedlog.pl
Please Please
@ -256,7 +250,7 @@ install - installation script
=head1 SYNOPSIS =head1 SYNOPSIS
B<install> [B<-Vh> [--update I<version>] [--conffile I<filename>] B<install> [B<-Vh> [--update I<version>] [B<--conffile> I<filename>]
=head1 REQUIREMENTS =head1 REQUIREMENTS
@ -268,8 +262,9 @@ This script will create database tables as necessary and configured.
=head2 Configuration =head2 Configuration
B<install> will read its configuration from F<newsstats.conf> via B<install> will read its configuration from F<newsstats.conf> which should
Config::Auto. be present in etc/ via Config::Auto or from a configuration file submitted
by the B<--conffile> option.
See L<doc/INSTALL> for an overview of possible configuration options. See L<doc/INSTALL> for an overview of possible configuration options.
@ -340,7 +335,7 @@ Thomas Hochstein <thh@inter.net>
=head1 COPYRIGHT AND LICENSE =head1 COPYRIGHT AND LICENSE
Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net> Copyright (c) 2010-2013 Thomas Hochstein <thh@inter.net>
This program is free software; you may redistribute it and/or modify it This program is free software; you may redistribute it and/or modify it
under the same terms as Perl itself. under the same terms as Perl itself.

6
lib/NewsStats.pm
View file

@ -49,8 +49,8 @@ require Exporter;
Output => [qw(OutputData FormatOutput)], Output => [qw(OutputData FormatOutput)],
SQLHelper => [qw(SQLHierarchies SQLSortOrder SQLGroupList SQLHelper => [qw(SQLHierarchies SQLSortOrder SQLGroupList
SQLSetBounds SQLBuildClause GetMaxLength)]); SQLSetBounds SQLBuildClause GetMaxLength)]);
$VERSION = '0.01'; $VERSION = '0.02';
our $PackageVersion = '0.01'; our $PackageVersion = '0.02';
use Data::Dumper; use Data::Dumper;
use File::Basename; use File::Basename;
@ -80,7 +80,7 @@ sub ShowVersion {
################################################################################ ################################################################################
### display version and exit ### display version and exit
print "NewsStats v$PackageVersion\n$MyVersion\n"; print "NewsStats v$PackageVersion\n$MyVersion\n";
print "Copyright (c) 2010-2012 Thomas Hochstein <thh\@inter.net>\n"; print "Copyright (c) 2010-2013 Thomas Hochstein <thh\@inter.net>\n";
print "This program is free software; you may redistribute it ". print "This program is free software; you may redistribute it ".
"and/or modify it under the same terms as Perl itself.\n"; "and/or modify it under the same terms as Perl itself.\n";
exit(100); exit(100);