Introduce end-of-line normalization and add .gitattributes.
[usenet/newsstats.git] / install / install.pl
index 1417e5f..d45d911 100755 (executable)
-#! /usr/bin/perl -W\r
-#\r
-# install.pl\r
-#\r
-# This script will create database tables as necessary.\r
-# \r
-# It is part of the NewsStats package.\r
-#\r
-# Copyright (c) 2010 Thomas Hochstein <thh@inter.net>\r
-#\r
-# It can be redistributed and/or modified under the same terms under \r
-# which Perl itself is published.\r
-\r
-BEGIN {\r
-  our $VERSION = "0.01";\r
-  use File::Basename;\r
-  # we're in .../install, so our module is in ..\r
-  push(@INC, dirname($0).'/..');\r
-}\r
-use strict;\r
-\r
-use NewsStats qw(:DEFAULT);\r
-\r
-use Cwd;\r
-\r
-use DBI;\r
-\r
-################################# Main program #################################\r
-\r
-### read commandline options\r
-my %Options = &ReadOptions('');\r
-\r
-### change working directory to .. (as we're in .../install)\r
-chdir dirname($0).'/..';\r
-\r
-### read configuration\r
-print("Reading configuration.\n");\r
-my %Conf = %{ReadConfig('newsstats.conf')};\r
-\r
-##### --------------------------------------------------------------------------\r
-##### Database table definitions\r
-##### --------------------------------------------------------------------------\r
-\r
-my %DBCreate = ('DBTableRaw'  => <<RAW, 'DBTableGrps' => <<GRPS);\r
--- \r
--- Table structure for table DBTableRaw\r
--- \r
-\r
-CREATE TABLE IF NOT EXISTS `$Conf{'DBTableRaw'}` (\r
-  `id` bigint(20) unsigned NOT NULL auto_increment,\r
-  `day` date NOT NULL,\r
-  `mid` varchar(250) character set ascii NOT NULL,\r
-  `date` datetime NOT NULL,\r
-  `timestamp` bigint(20) NOT NULL,\r
-  `token` varchar(80) character set ascii NOT NULL,\r
-  `size` bigint(20) NOT NULL,\r
-  `peer` varchar(250) NOT NULL,\r
-  `path` varchar(1000) NOT NULL,\r
-  `newsgroups` varchar(1000) NOT NULL,\r
-  `headers` longtext NOT NULL,\r
-  `disregard` tinyint(1) default '0',\r
-  PRIMARY KEY  (`id`),\r
-  KEY `day` (`day`),\r
-  KEY `mid` (`mid`),\r
-  KEY `peer` (`peer`)\r
-) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COMMENT='Raw data';\r
-RAW\r
--- \r
--- Table structure for table DBTableGrps\r
--- \r
-\r
-CREATE TABLE IF NOT EXISTS `$Conf{'DBTableGrps'}` (\r
-  `id` bigint(20) unsigned NOT NULL auto_increment,\r
-  `month` varchar(7) character set ascii NOT NULL,\r
-  `newsgroup` varchar(100) NOT NULL,\r
-  `postings` int(11) NOT NULL,\r
-  `revision` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,\r
-  PRIMARY KEY  (`id`),\r
-  UNIQUE KEY `month_newsgroup` (`month`,`newsgroup`),\r
-  KEY `newsgroup` (`newsgroup`),\r
-  KEY `postings` (`postings`)\r
-) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COMMENT='Postings per newsgroup';\r
-GRPS\r
-\r
-##### --------------------------- End of definitions ---------------------------\r
-\r
-### create database tables\r
-print "-----\nStarting database table generation.\n";\r
-# DB init\r
-my $DBHandle = InitDB(\%Conf,1);\r
-\r
-# read tables\r
-my %TablesInDB = %{$DBHandle->table_info('%', '%', '%', 'TABLE')->fetchall_hashref('TABLE_NAME')};\r
-\r
-# check for tables and create them, if they don't exist yet\r
-foreach my $Table (keys %DBCreate) {\r
-  if (defined($TablesInDB{$Conf{$Table}})) {\r
-    printf("Database table %s.%s already exists, skipping ....\n",$Conf{'DBDatabase'},$Conf{$Table});\r
-    next;\r
-  };\r
-  my $DBQuery = $DBHandle->prepare($DBCreate{$Table});\r
-  $DBQuery->execute() or die sprintf("$MySelf: E: Can't create table %s in database %s: %s%\n",$Table,$Conf{'DBDatabase'},$DBI::errstr);\r
-  printf("Database table %s.%s created succesfully.\n",$Conf{'DBDatabase'},$Conf{$Table});\r
-};\r
-\r
-# close handle\r
-$DBHandle->disconnect;\r
-print "Database table generation done.\n";\r
-\r
-### output information on other necessary steps\r
-my $Path = cwd();\r
-print <<TODO;\r
------\r
-Things left to do:\r
-\r
-1) Setup an INN feed to feedlog.pl\r
-\r
-   a) Edit your 'newsfeeds' file and insert something like\r
-\r
-          ## gather statistics for NewsStats\r
-          newsstats!\\r
-                  :!*,de.*\\r
-                  :Tc,WmtfbsPNH,Ac:$Path/feedlog.pl\r
-\r
-      Please\r
-\r
-      * check that you got the path to feedlog.pl right\r
-      * check that feedlog.pl can be executed by the news user\r
-      * adapt the pattern (here: 'de.*') to your needs\r
-\r
-   b) Check your 'newsfeeds' syntax:\r
-\r
-         # ctlinnd checkfile\r
-\r
-      and reload 'newsfeeds':\r
-\r
-         # ctlinnd reload newsfeeds 'Adding newsstats! feed'\r
-\r
-   c) Watch your 'news.notice' and 'errlog' files:\r
-\r
-         # tail -f /var/log/news/news.notice\r
-         ...\r
-         # tail -f /var/log/news/errlog\r
-\r
-2) Watch your $Conf{'DBTableRaw'} table fill.\r
-\r
-3) Read the documentation. ;)\r
-\r
-Enjoy!\r
-\r
--thh <thh\@inter.net>\r
-TODO\r
-\r
-__END__\r
-\r
-################################ Documentation #################################\r
-\r
-=head1 NAME\r
-\r
-install - installation script\r
-\r
-=head1 SYNOPSIS\r
-\r
-B<install> [B<-Vh>]\r
-\r
-=head1 REQUIREMENTS\r
-\r
-See doc/README: Perl 5.8.x itself and the following modules from CPAN:\r
-\r
-=over 2\r
-\r
-=item -\r
-\r
-Config::Auto\r
-\r
-=item -\r
-\r
-DBI\r
-\r
-=back\r
-\r
-=head1 DESCRIPTION\r
-\r
-This script will create database tables as necessary and configured.\r
-\r
-=head2 Configuration\r
-\r
-F<install.pl> will read its configuration from F<newsstats.conf> via\r
-Config::Auto.\r
-\r
-See doc/INSTALL for an overview of possible configuration options.\r
-\r
-=head1 OPTIONS\r
-\r
-=over 3\r
-\r
-=item B<-V> (version)\r
-\r
-Print out version and copyright information on B<yapfaq> and exit.\r
-\r
-=item B<-h> (help)\r
-\r
-Print this man page and exit.\r
-\r
-=back\r
-\r
-=head1 FILES\r
-\r
-=over 4\r
-\r
-=item F<install.pl>\r
-\r
-The script itself.\r
-\r
-=item F<NewsStats.pm>\r
-\r
-Library functions for the NewsStats package.\r
-\r
-=item F<newsstats.conf>\r
-\r
-Runtime configuration file for B<yapfaq>.\r
-\r
-=back\r
-\r
-=head1 BUGS\r
-\r
-Please report any bugs or feature requests to the author or use the\r
-bug tracker at L<http://bugs.th-h.de/>!\r
-\r
-=head1 SEE ALSO\r
-\r
-=over 2\r
-\r
-=item -\r
-\r
-doc/README\r
-\r
-=item -\r
-\r
-doc/INSTALL\r
-\r
-=back\r
-\r
-This script is part of the B<NewsStats> package.\r
-\r
-=head1 AUTHOR\r
-\r
-Thomas Hochstein <thh@inter.net>\r
-\r
-=head1 COPYRIGHT AND LICENSE\r
-\r
-Copyright (c) 2010 Thomas Hochstein <thh@inter.net>\r
-\r
-This program is free software; you may redistribute it and/or modify it\r
-under the same terms as Perl itself.\r
-\r
-=cut\r
+#! /usr/bin/perl -W
+#
+# 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>
+#
+# 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;
+
+################################# Main program #################################
+
+### read commandline options
+my %Options = &ReadOptions('');
+
+### change working directory to .. (as we're in .../install)
+chdir dirname($0).'/..';
+
+### read configuration
+print("Reading configuration.\n");
+my %Conf = %{ReadConfig('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
+
+##### --------------------------- 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";
+
+### output information on other necessary steps
+my $Path = cwd();
+print <<TODO;
+-----
+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>
+TODO
+
+__END__
+
+################################ Documentation #################################
+
+=head1 NAME
+
+install - installation script
+
+=head1 SYNOPSIS
+
+B<install> [B<-Vh>]
+
+=head1 REQUIREMENTS
+
+See doc/README: Perl 5.8.x itself and the following modules from CPAN:
+
+=over 2
+
+=item -
+
+Config::Auto
+
+=item -
+
+DBI
+
+=back
+
+=head1 DESCRIPTION
+
+This script will create database tables as necessary and configured.
+
+=head2 Configuration
+
+F<install.pl> will read its configuration from F<newsstats.conf> via
+Config::Auto.
+
+See doc/INSTALL for an overview of possible configuration options.
+
+=head1 OPTIONS
+
+=over 3
+
+=item B<-V> (version)
+
+Print out version and copyright information on B<yapfaq> and exit.
+
+=item B<-h> (help)
+
+Print this man page and exit.
+
+=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 for B<yapfaq>.
+
+=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 -
+
+doc/README
+
+=item -
+
+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 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
This page took 0.020518 seconds and 4 git commands to generate.