Adapt feedlog.pl to new coding style.
authorThomas Hochstein <thh@inter.net>
Sun, 27 May 2012 12:30:14 +0000 (14:30 +0200)
committerThomas Hochstein <thh@inter.net>
Fri, 12 Oct 2012 22:44:20 +0000 (00:44 +0200)
* Switch to Getopt::Long, change coding style;
  limit line length.

* Completely changed options due to new
  GetOpt::Long processing.

* Adapt to changes in NewsStats.pm

* Redo documentation.

* Update TODO.

Signed-off-by: Thomas Hochstein <thh@inter.net>
doc/TODO
feedlog.pl

index a30cdcd..6af50ca 100644 (file)
--- a/doc/TODO
+++ b/doc/TODO
@@ -47,7 +47,6 @@ Bug numbers refer to the Mantis issue tracker at <http://bugs.th-h.de/>.
     - General tests and optimisations
 
   + feedlog.pl
-    - Complete rewrite (like groupstats.pl, include changes in NewsStats.pm)
     - Gracefully handle interruptions to database connection, at least log
       lost postings (Bug #30).
     - Buffer output that cannot be written to database (Bug #31).
index 61311ac..1752758 100755 (executable)
@@ -7,7 +7,7 @@
 # 
 # It is part of the NewsStats package.
 #
-# Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
+# 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.
@@ -25,18 +25,24 @@ use Sys::Syslog qw(:standard :macros);
 
 use Date::Format;
 use DBI;
+use Getopt::Long qw(GetOptions);
+Getopt::Long::config ('bundling');
 
 ################################# Main program #################################
 
 ### read commandline options
-my %Options = &ReadOptions('qd');
+my ($OptDebug,$OptQuiet);
+GetOptions ('d|debug!'        => \$OptDebug,
+            'q|test!'         => \$OptQuiet,
+            'h|help'          => \&ShowPOD,
+            'V|version'       => \&ShowVersion) or exit 1;
 
 ### read configuration
-my %Conf = %{ReadConfig('newsstats.conf')};
+my %Conf = %{ReadConfig($HomePath.'/newsstats.conf')};
 
 ### init syslog
-openlog($MySelf, 'nofatal,pid', LOG_NEWS);
-syslog(LOG_NOTICE, "$MyVersion starting up.") if !$Options{'q'};
+openlog($0, 'nofatal,pid', LOG_NEWS);
+syslog(LOG_NOTICE, "$MyVersion starting up.") if !$OptQuiet;
 
 ### init database
 my $DBHandle = InitDB(\%Conf,0);
@@ -44,7 +50,11 @@ if (!$DBHandle) {
   syslog(LOG_CRIT, 'Database connection failed: %s', $DBI::errstr);
   while (1) {}; # go into endless loop to suppress further errors and respawning
 };
-my $DBQuery = $DBHandle->prepare(sprintf("INSERT INTO %s.%s (day,date,mid,timestamp,token,size,peer,path,newsgroups,headers) VALUES (?,?,?,?,?,?,?,?,?,?)",$Conf{'DBDatabase'},$Conf{'DBTableRaw'}));
+my $DBQuery = $DBHandle->prepare(sprintf("INSERT INTO %s.%s (day,date,mid,
+                                         timestamp,token,size,peer,path,
+                                         newsgroups,headers)
+                                         VALUES (?,?,?,?,?,?,?,?,?,?)",
+                                         $Conf{'DBDatabase'},$Conf{'DBTableRaw'}));
 
 ### main loop
 while (<>) {
@@ -72,17 +82,21 @@ while (<>) {
   my $Date = time2str("%Y-%m-%d %H:%M:%S", $Timestamp);
 
   # write to database
-  if (!$DBQuery->execute($Day, $Date, $Mid, $Timestamp, $Token, $Size, $Peer, $Path, $Newsgroups, $Headers)) {
+  if (!$DBQuery->execute($Day, $Date, $Mid, $Timestamp, $Token, $Size, $Peer,
+                         $Path, $Newsgroups, $Headers)) {
     syslog(LOG_ERR, 'Database error: %s', $DBI::errstr);
   };
   $DBQuery->finish;
   
-  warn sprintf("-----\nDay: %s\nDate: %s\nMID: %s\nTS: %s\nToken: %s\nSize: %s\nPeer: %s\nPath: %s\nNewsgroups: %s\nHeaders: %s\n",$Day, $Date, $Mid, $Timestamp, $Token, $Size, $Peer, $Path, $Newsgroups, $Headers) if $Options{'d'};
+  warn sprintf("-----\nDay: %s\nDate: %s\nMID: %s\nTS: %s\nToken: %s\n".
+               "Size: %s\nPeer: %s\nPath: %s\nNewsgroups: %s\nHeaders: %s\n",
+               $Day, $Date, $Mid, $Timestamp, $Token, $Size, $Peer, $Path,
+               $Newsgroups, $Headers) if $OptDebug;
 }
 
 ### close handles
 $DBHandle->disconnect;
-syslog(LOG_NOTICE, "$MySelf closing down.") if !$Options{'q'};
+syslog(LOG_NOTICE, "$0 closing down.") if !$OptQuiet;
 closelog();
 
 __END__
@@ -99,23 +113,7 @@ B<feedlog> [B<-Vhdq>]
 
 =head1 REQUIREMENTS
 
-See doc/README: Perl 5.8.x itself and the following modules from CPAN:
-
-=over 2
-
-=item -
-
-Config::Auto
-
-=item -
-
-Date::Format
-
-=item -
-
-DBI
-
-=back
+See L<doc/README>.
 
 =head1 DESCRIPTION
 
@@ -131,29 +129,29 @@ terminating would only result in a rapid respawn.
 
 =head2 Configuration
 
-F<feedlog.pl> 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.
 
-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<-d> (debug)
+=item B<-d>, B<--debug>
 
 Output debugging information to STDERR while parsing STDIN. You'll
 find that information most probably in your B<INN> F<errlog> file.
 
-=item B<-q> (quiet)
+=item B<-q>, B<--quiet>
 
 Suppress logging to syslog.
 
@@ -161,7 +159,7 @@ Suppress logging to syslog.
 
 =head1 INSTALLATION
 
-See doc/INSTALL.
+See L<doc/INSTALL.>
 
 =head1 EXAMPLES
 
@@ -172,7 +170,7 @@ Set up a feed like that in your B<INN> F<newsfeeds> file:
             :!*,de.*
             :Tc,WmtfbsPNH,Ac:/path/to/feedlog.pl
 
-See doc/INSTALL for further information.
+See L<doc/INSTALL> for further information.
 
 =head1 FILES
 
@@ -188,7 +186,7 @@ Library functions for the NewsStats package.
 
 =item F<newsstats.conf>
 
-Runtime configuration file for B<yapfaq>.
+Runtime configuration file.
 
 =back
 
@@ -203,11 +201,11 @@ bug tracker at L<http://bugs.th-h.de/>!
 
 =item -
 
-doc/README
+L<doc/README>
 
 =item -
 
-doc/INSTALL
+L<doc/INSTALL>
 
 =back
 
@@ -219,7 +217,7 @@ Thomas Hochstein <thh@inter.net>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright (c) 2010 Thomas Hochstein <thh@inter.net>
+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.
This page took 0.014103 seconds and 4 git commands to generate.