-#! /usr/bin/perl -W
+#! /usr/bin/perl
#
# install.pl
#
# This script will create database tables as necessary.
-#
+#
# It is part of the NewsStats package.
#
-# Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
+# Copyright (c) 2010-2013 Thomas Hochstein <thh@inter.net>
#
-# It can be redistributed and/or modified under the same terms under
+# It can be redistributed and/or modified under the same terms under
# which Perl itself is published.
BEGIN {
- our $VERSION = "0.01";
+ our $VERSION = "0.02";
use File::Basename;
- # we're in .../install, so our module is in ..
- push(@INC, dirname($0).'/..');
+ # we're in .../install, so our module is in ../lib
+ push(@INC, dirname($0).'/../lib');
}
use strict;
+use warnings;
use NewsStats qw(:DEFAULT);
-use Cwd;
-
use DBI;
+use Getopt::Long qw(GetOptions);
+Getopt::Long::config ('bundling');
################################# Main program #################################
### read commandline options
-my %Options = &ReadOptions('');
-
-### change working directory to .. (as we're in .../install)
-chdir dirname($0).'/..';
+my ($OptUpdate,$OptConfFile);
+GetOptions ('u|update=s' => \$OptUpdate,
+ 'conffile=s' => \$OptConfFile,
+ 'h|help' => \&ShowPOD,
+ 'V|version' => \&ShowVersion) or exit 1;
### read configuration
print("Reading configuration.\n");
-my %Conf = %{ReadConfig('newsstats.conf')};
+my %Conf = %{ReadConfig($OptConfFile)};
##### --------------------------------------------------------------------------
##### Database table definitions
##### --------------------------------------------------------------------------
+my $DBCreate = <<SQLDB;
+CREATE DATABASE IF NOT EXISTS `$Conf{'DBDatabase'}` DEFAULT CHARSET=utf8;
+SQLDB
+
my %DBCreate = ('DBTableRaw' => <<RAW, 'DBTableGrps' => <<GRPS);
---
+--
-- Table structure for table DBTableRaw
---
+--
CREATE TABLE IF NOT EXISTS `$Conf{'DBTableRaw'}` (
`id` bigint(20) unsigned NOT NULL auto_increment,
KEY `peer` (`peer`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Raw data';
RAW
---
+--
-- Table structure for table DBTableGrps
---
+--
CREATE TABLE IF NOT EXISTS `$Conf{'DBTableGrps'}` (
`id` bigint(20) unsigned NOT NULL auto_increment,
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postings per newsgroup';
GRPS
-##### --------------------------- End of definitions ---------------------------
-
-### create database tables
-print "-----\nStarting database table generation.\n";
-# DB init
-my $DBHandle = InitDB(\%Conf,1);
-
-# read tables
-my %TablesInDB = %{$DBHandle->table_info('%', '%', '%', 'TABLE')->fetchall_hashref('TABLE_NAME')};
-
-# check for tables and create them, if they don't exist yet
-foreach my $Table (keys %DBCreate) {
- if (defined($TablesInDB{$Conf{$Table}})) {
- printf("Database table %s.%s already exists, skipping ....\n",$Conf{'DBDatabase'},$Conf{$Table});
- next;
- };
- my $DBQuery = $DBHandle->prepare($DBCreate{$Table});
- $DBQuery->execute() or die sprintf("$MySelf: E: Can't create table %s in database %s: %s%\n",$Table,$Conf{'DBDatabase'},$DBI::errstr);
- printf("Database table %s.%s created succesfully.\n",$Conf{'DBDatabase'},$Conf{$Table});
-};
-
-# close handle
-$DBHandle->disconnect;
-print "Database table generation done.\n";
+##### --------------------------------------------------------------------------
+##### Installation / upgrade instructions
+##### --------------------------------------------------------------------------
-### output information on other necessary steps
-my $Path = cwd();
-print <<TODO;
------
+my $Install = <<INSTALL;
+----------
Things left to do:
1) Setup an INN feed to feedlog.pl
a) Edit your 'newsfeeds' file and insert something like
## gather statistics for NewsStats
- newsstats!\
- :!*,de.*\
- :Tc,WmtfbsPNH,Ac:$Path/feedlog.pl
+ newsstats!\\
+ :!*,de.*\\
+ :Tc,WmtfbsPNH,Ac:$HomePath/bin/feedlog.pl
Please
Enjoy!
-thh <thh\@inter.net>
-TODO
+INSTALL
-__END__
+my $Upgrade ='';
+if ($OptUpdate) {
+ $Upgrade = <<UPGRADE;
+----------
+Your installation was upgraded from $OptUpdate to $PackageVersion.
-################################ Documentation #################################
+Don't forget to restart your INN feed so that it can pick up the new version:
-=head1 NAME
+ # ctlinnd begin 'newsstats!'
-install - installation script
+(or whatever you called your feed).
+UPGRADE
+}
-=head1 SYNOPSIS
+##### --------------------------- End of definitions ---------------------------
-B<install> [B<-Vh>]
+### create DB, if necessary
+if (!$OptUpdate) {
+ print "----------\nStarting database creation.\n";
+ # create database
+ # we can't use InitDB() as that will use a table name of
+ # the table that doesn't exist yet ...
+ my $DBHandle = DBI->connect(sprintf('DBI:%s:host=%s',$Conf{'DBDriver'},
+ $Conf{'DBHost'}), $Conf{'DBUser'},
+ $Conf{'DBPw'}, { PrintError => 0 });
+ my $DBQuery = $DBHandle->prepare($DBCreate);
+ $DBQuery->execute() or &Bleat(2, sprintf("Can't create database %s: %s%\n",
+ $Conf{'DBDatabase'}, $DBI::errstr));
+
+ printf("Database table %s created succesfully.\n",$Conf{'DBDatabase'});
+ $DBHandle->disconnect;
+};
-=head1 REQUIREMENTS
+### DB init, read list of tables
+print "Reading database information.\n";
+my $DBHandle = InitDB(\%Conf,1);
+my %TablesInDB =
+ %{$DBHandle->table_info('%', '%', '%', 'TABLE')->fetchall_hashref('TABLE_NAME')};
+
+if (!$OptUpdate) {
+ ##### installation mode
+ # check for tables and create them, if they don't exist yet
+ foreach my $Table (keys %DBCreate) {
+ &CreateTable($Table);
+ };
+ print "Database table generation done.\n";
+
+ # Display install instructions
+ print $Install;
+} else {
+ ##### upgrade mode
+ print "----------\nStarting upgrade process.\n";
+ $PackageVersion = '0.03';
+ if ($OptUpdate < $PackageVersion) {
+ if ($OptUpdate < 0.02) {
+ # 0.01 -> 0.02
+ # &DoMySQL('...;');
+ # print "v0.02: Database upgrades ...\n";
+ # &PrintInstructions('0.02',<<" INSTRUCTIONS");
+ # INSTRUCTIONS
+ };
+ };
+ # Display general upgrade instructions
+ print $Upgrade;
+};
-See doc/README: Perl 5.8.x itself and the following modules from CPAN:
+# close handle
+$DBHandle->disconnect;
-=over 2
+exit(0);
-=item -
+################################# Subroutines ##################################
-Config::Auto
+sub CreateTable {
+ my $Table = shift;
+ if (defined($TablesInDB{$Conf{$Table}})) {
+ printf("Database table %s.%s already exists, skipping ....\n",
+ $Conf{'DBDatabase'},$Conf{$Table});
+ return;
+ };
+ my $DBQuery = $DBHandle->prepare($DBCreate{$Table});
+ $DBQuery->execute() or
+ &Bleat(2, sprintf("Can't create table %s in database %s: %s%\n",$Table,
+ $Conf{'DBDatabase'},$DBI::errstr));
+ printf("Database table %s.%s created succesfully.\n",
+ $Conf{'DBDatabase'},$Conf{$Table});
+ return;
+};
-=item -
+sub DoMySQL {
+ my $SQL = shift;
+ my $DBQuery = $DBHandle->prepare($SQL);
+ $DBQuery->execute() or &Bleat(1, sprintf("Database error: %s\n",$DBI::errstr));
+ return;
+};
-DBI
+sub PrintInstructions {
+ my ($UpVersion,$Instructions) = @_;
+ print "v$UpVersion: Upgrade Instructions >>>>>\n";
+ my $Padding = ' ' x (length($UpVersion) + 3);
+ $Instructions =~ s/^ /$Padding/mg;
+ print $Instructions;
+ print "<" x (length($UpVersion) + 29) . "\n";
+};
-=back
+
+__END__
+
+################################ Documentation #################################
+
+=head1 NAME
+
+install - installation script
+
+=head1 SYNOPSIS
+
+B<install> [B<-Vh> [--update I<version>] [B<--conffile> I<filename>]
+
+=head1 REQUIREMENTS
+
+See L<doc/README>.
=head1 DESCRIPTION
=head2 Configuration
-F<install.pl> will read its configuration from F<newsstats.conf> via
-Config::Auto.
+B<install> will read its configuration from F<newsstats.conf> 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 L<doc/INSTALL> for an overview of possible configuration options.
=head1 OPTIONS
=over 3
-=item B<-V> (version)
+=item B<-V>, B<--version>
-Print out version and copyright information on B<yapfaq> and exit.
+Print out version and copyright information and exit.
-=item B<-h> (help)
+=item B<-h>, B<--help>
Print this man page and exit.
+=item B<-u>, B<--update> I<version>
+
+Don't do a fresh install, but update from I<version>.
+
+=item B<--conffile> I<filename>
+
+Load configuration from I<filename> instead of F<newsstats.conf>.
+
=back
=head1 FILES
=over 4
-=item F<install.pl>
+=item F<install/install.pl>
The script itself.
-=item F<NewsStats.pm>
+=item F<lib/NewsStats.pm>
Library functions for the NewsStats package.
-=item F<newsstats.conf>
+=item F<etc/newsstats.conf>
-Runtime configuration file for B<yapfaq>.
+Runtime configuration file.
=back
=item -
-doc/README
+L<doc/README>
=item -
-doc/INSTALL
+L<doc/INSTALL>
=back
=head1 COPYRIGHT AND LICENSE
-Copyright (c) 2010 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
under the same terms as Perl itself.