[usenet/newsstats.git] / install / install.pl

#! /usr/bin/perl -W
#
# install.pl
#
# This script will create database tables as necessary.
# 
# It is part of the NewsStats package.
#
# Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net>
#
# It can be redistributed and/or modified under the same terms under 
# which Perl itself is published.

BEGIN {
  our $VERSION = "0.01";
  use File::Basename;
  # we're in .../install, so our module is in ..
  push(@INC, dirname($0).'/..');
}
use strict;

use NewsStats qw(:DEFAULT);

use Cwd;

use DBI;
use Getopt::Long qw(GetOptions);
Getopt::Long::config ('bundling');

################################# Main program #################################

### read commandline options
my ($OptUpdate);
GetOptions ('u|update=s' => \$OptUpdate,
            'h|help'     => \&ShowPOD,
            'V|version'  => \&ShowVersion) or exit 1;

### change working directory to .. (as we're in .../install)
chdir dirname($0).'/..';
my $Path = cwd();

### read configuration
print("Reading configuration.\n");
my %Conf = %{ReadConfig($HomePath.'/newsstats.conf')};

##### --------------------------------------------------------------------------
##### Database table definitions
##### --------------------------------------------------------------------------

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,
  `day` date NOT NULL,
  `mid` varchar(250) character set ascii NOT NULL,
  `date` datetime NOT NULL,
  `timestamp` bigint(20) NOT NULL,
  `token` varchar(80) character set ascii NOT NULL,
  `size` bigint(20) NOT NULL,
  `peer` varchar(250) NOT NULL,
  `path` varchar(1000) NOT NULL,
  `newsgroups` varchar(1000) NOT NULL,
  `headers` longtext NOT NULL,
  `disregard` tinyint(1) default '0',
  PRIMARY KEY  (`id`),
  KEY `day` (`day`),
  KEY `mid` (`mid`),
  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,
  `month` varchar(7) character set ascii NOT NULL,
  `newsgroup` varchar(100) NOT NULL,
  `postings` int(11) NOT NULL,
  `revision` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
  PRIMARY KEY  (`id`),
  UNIQUE KEY `month_newsgroup` (`month`,`newsgroup`),
  KEY `newsgroup` (`newsgroup`),
  KEY `postings` (`postings`)
) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COMMENT='Postings per newsgroup';
GRPS

##### --------------------------------------------------------------------------
##### Installation / upgrade instructions
##### --------------------------------------------------------------------------

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

      Please

      * check that you got the path to feedlog.pl right
      * check that feedlog.pl can be executed by the news user
      * adapt the pattern (here: 'de.*') to your needs

   b) Check your 'newsfeeds' syntax:

         # ctlinnd checkfile

      and reload 'newsfeeds':

         # ctlinnd reload newsfeeds 'Adding newsstats! feed'

   c) Watch your 'news.notice' and 'errlog' files:

         # tail -f /var/log/news/news.notice
         ...
         # tail -f /var/log/news/errlog

2) Watch your $Conf{'DBTableRaw'} table fill.

3) Read the documentation. ;)

Enjoy!

-thh <thh\@inter.net>
INSTALL

my $Upgrade ='';
if ($OptUpdate) {
 $Upgrade = <<UPGRADE;
----------
Your installation was upgraded from $OptUpdate to $PackageVersion.

Don't forget to restart your INN feed so that it can pick up the new version:

   # ctlinnd begin 'newsstats!'

(or whatever you called your feed).
UPGRADE
}

##### --------------------------- End of definitions ---------------------------

### 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
  print "----------\nStarting database table generation.\n";
  # 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;
};

# close handle
$DBHandle->disconnect;

exit(0);

################################# Subroutines ##################################

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;
};

sub DoMySQL {
  my $SQL = shift;
  my $DBQuery = $DBHandle->prepare($SQL);
  $DBQuery->execute() or &Bleat(1, sprintf("Database error: %s\n",$DBI::errstr));
  return;
};

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";
};


__END__

################################ Documentation #################################

=head1 NAME

install - installation script

=head1 SYNOPSIS

B<install> [B<-Vh> [--update I<version>]

=head1 REQUIREMENTS

See L<doc/README>.

=head1 DESCRIPTION

This script will create database tables as necessary and configured.

=head2 Configuration

B<install> will read its configuration from F<newsstats.conf> via
Config::Auto.

See L<doc/INSTALL> for an overview of possible configuration options.

=head1 OPTIONS

=over 3

=item B<-V>, B<--version>

Print out version and copyright information and exit.

=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>.

=back

=head1 FILES

=over 4

=item F<install.pl>

The script itself.

=item F<NewsStats.pm>

Library functions for the NewsStats package.

=item F<newsstats.conf>

Runtime configuration file.

=back

=head1 BUGS

Please report any bugs or feature requests to the author or use the
bug tracker at L<http://bugs.th-h.de/>!

=head1 SEE ALSO

=over 2

=item -

L<doc/README>

=item -

L<doc/INSTALL>

=back

This script is part of the B<NewsStats> package.

=head1 AUTHOR

Thomas Hochstein <thh@inter.net>

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2010-2012 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.

=cut
Commit	Line	Data
	1	#! /usr/bin/perl -W
	2	#
	3	# install.pl
	4	#
	5	# This script will create database tables as necessary.
	6	#
	7	# It is part of the NewsStats package.
	8	#
	9	# Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net>
	10	#
	11	# It can be redistributed and/or modified under the same terms under
	12	# which Perl itself is published.
	13
	14	BEGIN {
	15	our $VERSION = "0.01";
	16	use File::Basename;
	17	# we're in .../install, so our module is in ..
	18	push(@INC, dirname($0).'/..');
	19	}
	20	use strict;
	21
	22	use NewsStats qw(:DEFAULT);
	23
	24	use Cwd;
	25
	26	use DBI;
	27	use Getopt::Long qw(GetOptions);
	28	Getopt::Long::config ('bundling');
	29
	30	################################# Main program #################################
	31
	32	### read commandline options
	33	my ($OptUpdate);
	34	GetOptions ('u\|update=s' => \$OptUpdate,
	35	'h\|help' => \&ShowPOD,
	36	'V\|version' => \&ShowVersion) or exit 1;
	37
	38	### change working directory to .. (as we're in .../install)
	39	chdir dirname($0).'/..';
	40	my $Path = cwd();
	41
	42	### read configuration
	43	print("Reading configuration.\n");
	44	my %Conf = %{ReadConfig($HomePath.'/newsstats.conf')};
	45
	46	##### --------------------------------------------------------------------------
	47	##### Database table definitions
	48	##### --------------------------------------------------------------------------
	49
	50	my %DBCreate = ('DBTableRaw' => <<RAW, 'DBTableGrps' => <<GRPS);
	51	--
	52	-- Table structure for table DBTableRaw
	53	--
	54
	55	CREATE TABLE IF NOT EXISTS `$Conf{'DBTableRaw'}` (
	56	`id` bigint(20) unsigned NOT NULL auto_increment,
	57	`day` date NOT NULL,
	58	`mid` varchar(250) character set ascii NOT NULL,
	59	`date` datetime NOT NULL,
	60	`timestamp` bigint(20) NOT NULL,
	61	`token` varchar(80) character set ascii NOT NULL,
	62	`size` bigint(20) NOT NULL,
	63	`peer` varchar(250) NOT NULL,
	64	`path` varchar(1000) NOT NULL,
	65	`newsgroups` varchar(1000) NOT NULL,
	66	`headers` longtext NOT NULL,
	67	`disregard` tinyint(1) default '0',
	68	PRIMARY KEY (`id`),
	69	KEY `day` (`day`),
	70	KEY `mid` (`mid`),
	71	KEY `peer` (`peer`)
	72	) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Raw data';
	73	RAW
	74	--
	75	-- Table structure for table DBTableGrps
	76	--
	77
	78	CREATE TABLE IF NOT EXISTS `$Conf{'DBTableGrps'}` (
	79	`id` bigint(20) unsigned NOT NULL auto_increment,
	80	`month` varchar(7) character set ascii NOT NULL,
	81	`newsgroup` varchar(100) NOT NULL,
	82	`postings` int(11) NOT NULL,
	83	`revision` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
	84	PRIMARY KEY (`id`),
	85	UNIQUE KEY `month_newsgroup` (`month`,`newsgroup`),
	86	KEY `newsgroup` (`newsgroup`),
	87	KEY `postings` (`postings`)
	88	) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postings per newsgroup';
	89	GRPS
	90
	91	##### --------------------------------------------------------------------------
	92	##### Installation / upgrade instructions
	93	##### --------------------------------------------------------------------------
	94
	95	my $Install = <<INSTALL;
	96	----------
	97	Things left to do:
	98
	99	1) Setup an INN feed to feedlog.pl
	100
	101	a) Edit your 'newsfeeds' file and insert something like
	102
	103	## gather statistics for NewsStats
	104	newsstats!\\
	105	:!,de.\\
	106	:Tc,WmtfbsPNH,Ac:$Path/feedlog.pl
	107
	108	Please
	109
	110	* check that you got the path to feedlog.pl right
	111	* check that feedlog.pl can be executed by the news user
	112	* adapt the pattern (here: 'de.*') to your needs
	113
	114	b) Check your 'newsfeeds' syntax:
	115
	116	# ctlinnd checkfile
	117
	118	and reload 'newsfeeds':
	119
	120	# ctlinnd reload newsfeeds 'Adding newsstats! feed'
	121
	122	c) Watch your 'news.notice' and 'errlog' files:
	123
	124	# tail -f /var/log/news/news.notice
	125	...
	126	# tail -f /var/log/news/errlog
	127
	128	2) Watch your $Conf{'DBTableRaw'} table fill.
	129
	130	3) Read the documentation. ;)
	131
	132	Enjoy!
	133
	134	-thh <thh\@inter.net>
	135	INSTALL
	136
	137	my $Upgrade ='';
	138	if ($OptUpdate) {
	139	$Upgrade = <<UPGRADE;
	140	----------
	141	Your installation was upgraded from $OptUpdate to $PackageVersion.
	142
	143	Don't forget to restart your INN feed so that it can pick up the new version:
	144
	145	# ctlinnd begin 'newsstats!'
	146
	147	(or whatever you called your feed).
	148	UPGRADE
	149	}
	150
	151	##### --------------------------- End of definitions ---------------------------
	152
	153	### DB init, read list of tables
	154	print "Reading database information.\n";
	155	my $DBHandle = InitDB(\%Conf,1);
	156	my %TablesInDB =
	157	%{$DBHandle->table_info('%', '%', '%', 'TABLE')->fetchall_hashref('TABLE_NAME')};
	158
	159	if (!$OptUpdate) {
	160	##### installation mode
	161	print "----------\nStarting database table generation.\n";
	162	# check for tables and create them, if they don't exist yet
	163	foreach my $Table (keys %DBCreate) {
	164	&CreateTable($Table);
	165	};
	166	print "Database table generation done.\n";
	167
	168	# Display install instructions
	169	print $Install;
	170	} else {
	171	##### upgrade mode
	172	print "----------\nStarting upgrade process.\n";
	173	$PackageVersion = '0.03';
	174	if ($OptUpdate < $PackageVersion) {
	175	if ($OptUpdate < 0.02) {
	176	# 0.01 -> 0.02
	177	# &DoMySQL('...;');
	178	# print "v0.02: Database upgrades ...\n";
	179	# &PrintInstructions('0.02',<<" INSTRUCTIONS");
	180	# INSTRUCTIONS
	181	};
	182	};
	183	# Display general upgrade instructions
	184	print $Upgrade;
	185	};
	186
	187	# close handle
	188	$DBHandle->disconnect;
	189
	190	exit(0);
	191
	192	################################# Subroutines ##################################
	193
	194	sub CreateTable {
	195	my $Table = shift;
	196	if (defined($TablesInDB{$Conf{$Table}})) {
	197	printf("Database table %s.%s already exists, skipping ....\n",
	198	$Conf{'DBDatabase'},$Conf{$Table});
	199	return;
	200	};
	201	my $DBQuery = $DBHandle->prepare($DBCreate{$Table});
	202	$DBQuery->execute() or
	203	&Bleat(2, sprintf("Can't create table %s in database %s: %s%\n",$Table,
	204	$Conf{'DBDatabase'},$DBI::errstr));
	205	printf("Database table %s.%s created succesfully.\n",
	206	$Conf{'DBDatabase'},$Conf{$Table});
	207	return;
	208	};
	209
	210	sub DoMySQL {
	211	my $SQL = shift;
	212	my $DBQuery = $DBHandle->prepare($SQL);
	213	$DBQuery->execute() or &Bleat(1, sprintf("Database error: %s\n",$DBI::errstr));
	214	return;
	215	};
	216
	217	sub PrintInstructions {
	218	my ($UpVersion,$Instructions) = @_;
	219	print "v$UpVersion: Upgrade Instructions >>>>>\n";
	220	my $Padding = ' ' x (length($UpVersion) + 3);
	221	$Instructions =~ s/^ /$Padding/mg;
	222	print $Instructions;
	223	print "<" x (length($UpVersion) + 29) . "\n";
	224	};
	225
	226
	227	__END__
	228
	229	################################ Documentation #################################
	230
	231	=head1 NAME
	232
	233	install - installation script
	234
	235	=head1 SYNOPSIS
	236
	237	B<install> [B<-Vh> [--update I<version>]
	238
	239	=head1 REQUIREMENTS
	240
	241	See L<doc/README>.
	242
	243	=head1 DESCRIPTION
	244
	245	This script will create database tables as necessary and configured.
	246
	247	=head2 Configuration
	248
	249	B<install> will read its configuration from F<newsstats.conf> via
	250	Config::Auto.
	251
	252	See L<doc/INSTALL> for an overview of possible configuration options.
	253
	254	=head1 OPTIONS
	255
	256	=over 3
	257
	258	=item B<-V>, B<--version>
	259
	260	Print out version and copyright information and exit.
	261
	262	=item B<-h>, B<--help>
	263
	264	Print this man page and exit.
	265
	266	=item B<-u>, B<--update> I<version>
	267
	268	Don't do a fresh install, but update from I<version>.
	269
	270	=back
	271
	272	=head1 FILES
	273
	274	=over 4
	275
	276	=item F<install.pl>
	277
	278	The script itself.
	279
	280	=item F<NewsStats.pm>
	281
	282	Library functions for the NewsStats package.
	283
	284	=item F<newsstats.conf>
	285
	286	Runtime configuration file.
	287
	288	=back
	289
	290	=head1 BUGS
	291
	292	Please report any bugs or feature requests to the author or use the
	293	bug tracker at L<http://bugs.th-h.de/>!
	294
	295	=head1 SEE ALSO
	296
	297	=over 2
	298
	299	=item -
	300
	301	L<doc/README>
	302
	303	=item -
	304
	305	L<doc/INSTALL>
	306
	307	=back
	308
	309	This script is part of the B<NewsStats> package.
	310
	311	=head1 AUTHOR
	312
	313	Thomas Hochstein <thh@inter.net>
	314
	315	=head1 COPYRIGHT AND LICENSE
	316
	317	Copyright (c) 2010-2012 Thomas Hochstein <thh@inter.net>
	318
	319	This program is free software; you may redistribute it and/or modify it
	320	under the same terms as Perl itself.
	321
	322	=cut