misc/maintenance/touch_all_items.pl

   1 #!/usr/bin/perl
   2 #
   3 # Copyright (C) 2011 ByWater Solutions
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use strict;
  21 use warnings;
  22 BEGIN {
  23     # find Koha's Perl modules
  24     # test carefully before changing this
  25     use FindBin;
  26     eval { require "$FindBin::Bin/../kohalib.pl" };
  27 }
  28
  29 # possible modules to use
  30 use Getopt::Long;
  31
  32 use Koha::Script;
  33 use C4::Context;
  34 use C4::Items;
  35 use Pod::Usage;
  36
  37
  38 sub usage {
  39     pod2usage( -verbose => 2 );
  40     exit;
  41 }
  42
  43 # Database handle
  44 my $dbh = C4::Context->dbh;
  45
  46 # Benchmarking variables
  47 my $startime = time();
  48 my $goodcount = 0;
  49 my $badcount = 0;
  50 my $totalcount = 0;
  51
  52 # Options
  53 my $verbose;
  54 my $whereclause = '';
  55 my $help;
  56 my $outfile;
  57
  58 GetOptions(
  59   'o|output:s' => \$outfile,
  60   'v' => \$verbose,
  61   'where:s' => \$whereclause,
  62   'help|h'   => \$help,
  63 );
  64
  65 usage() if $help;
  66
  67 if ($whereclause) {
  68    $whereclause = "WHERE $whereclause";
  69 }
  70
  71 # output log or STDOUT
  72 if (defined $outfile) {
  73    open (OUT, ">$outfile") || die ("Cannot open output file");
  74 } else {
  75    open(OUT, ">&STDOUT") || die ("Couldn't duplicate STDOUT: $!");
  76 }
  77
  78 my $sth_fetch = $dbh->prepare("SELECT biblionumber, itemnumber, itemcallnumber FROM items $whereclause");
  79 $sth_fetch->execute();
  80
  81 # fetch info from the search
  82 while (my ($biblionumber, $itemnumber, $itemcallnumber) = $sth_fetch->fetchrow_array){
  83
  84   eval { ModItem({itemcallnumber => $itemcallnumber}, $biblionumber, $itemnumber); };
  85   my $modok = $@ ? 0 : 1;
  86
  87   if ($modok) {
  88      $goodcount++;
  89      print OUT "Touched item $itemnumber\n" if (defined $verbose);
  90   } else {
  91      $badcount++;
  92      print OUT "ERROR WITH ITEM $itemnumber !!!!\n";
  93   }
  94
  95   $totalcount++;
  96
  97 }
  98
  99 # Benchmarking
 100 my $endtime = time();
 101 my $time = $endtime-$startime;
 102 my $accuracy = ($goodcount / $totalcount) * 100; # this is a percentage
 103 my $averagetime = 0;
 104 $averagetime = $time / $totalcount if $totalcount;
 105 print "Good: $goodcount, Bad: $badcount (of $totalcount) in $time seconds\n";
 106 printf "Accuracy: %.2f%%\nAverage time per record: %.6f seconds\n", $accuracy, $averagetime if (defined $verbose);
 107
 108 =head1 NAME
 109
 110 touch_all_items.pl
 111
 112 =head1 SYNOPSIS
 113
 114   touch_all_items.pl
 115   touch_all_items.pl -v
 116   touch_all_items.pl --where=STRING
 117
 118 =head1 DESCRIPTION
 119
 120 When changes are made to ModItem (or the routines that are called by it), it is
 121 sometimes necessary to run ModItem on all or some records in the catalog when
 122 upgrading. This script does that.
 123
 124 =over 8
 125
 126 =item B<--help>
 127
 128 Prints this help
 129
 130 =item B<-v>
 131
 132 Provide verbose log information.
 133
 134 =item B<--where>
 135
 136 Limits the search with a user-specified WHERE clause.
 137
 138 =back
 139
 140 =cut
 141