c6bcf473cbd109f01bf6bd4be9f4068e74b42c11
[koha-equinox.git] / 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 Koha::Items;
36 use Pod::Usage;
37
38
39 sub usage {
40     pod2usage( -verbose => 2 );
41     exit;
42 }
43
44 # Database handle
45 my $dbh = C4::Context->dbh;
46
47 # Benchmarking variables
48 my $startime = time();
49 my $goodcount = 0;
50 my $badcount = 0;
51 my $totalcount = 0;
52
53 # Options
54 my $verbose;
55 my $whereclause = '';
56 my $help;
57 my $outfile;
58
59 GetOptions(
60   'o|output:s' => \$outfile,
61   'v' => \$verbose,
62   'where:s' => \$whereclause,
63   'help|h'   => \$help,
64 );
65
66 usage() if $help;
67
68 if ($whereclause) {
69    $whereclause = "WHERE $whereclause";
70 }
71
72 # output log or STDOUT
73 if (defined $outfile) {
74    open (OUT, ">$outfile") || die ("Cannot open output file");
75 } else {
76    open(OUT, ">&STDOUT") || die ("Couldn't duplicate STDOUT: $!");
77 }
78
79 # FIXME Would be better to call Koha::Items->search here
80 my $sth_fetch = $dbh->prepare("SELECT biblionumber, itemnumber, itemcallnumber FROM items $whereclause");
81 $sth_fetch->execute();
82
83 # fetch info from the search
84 while (my ($biblionumber, $itemnumber, $itemcallnumber) = $sth_fetch->fetchrow_array){
85    
86   eval { Koha::Items->find($itemnumber)->itemcallnumber($itemcallnumber)->store; };
87   my $modok = $@ ? 0 : 1;
88
89   if ($modok) {
90      $goodcount++;
91      print OUT "Touched item $itemnumber\n" if (defined $verbose);
92   } else {
93      $badcount++;
94      print OUT "ERROR WITH ITEM $itemnumber !!!!\n";
95   }
96
97   $totalcount++;
98
99 }
100
101 # Benchmarking
102 my $endtime = time();
103 my $time = $endtime-$startime;
104 my $accuracy = ($goodcount / $totalcount) * 100; # this is a percentage
105 my $averagetime = 0;
106 $averagetime = $time / $totalcount if $totalcount;
107 print "Good: $goodcount, Bad: $badcount (of $totalcount) in $time seconds\n";
108 printf "Accuracy: %.2f%%\nAverage time per record: %.6f seconds\n", $accuracy, $averagetime if (defined $verbose);
109
110 =head1 NAME
111
112 touch_all_items.pl
113
114 =head1 SYNOPSIS
115
116   touch_all_items.pl
117   touch_all_items.pl -v
118   touch_all_items.pl --where=STRING
119
120 =head1 DESCRIPTION
121
122 When changes are made to ModItem (or the routines that are called by it), it is
123 sometimes necessary to run ModItem on all or some records in the catalog when
124 upgrading. This script does that.
125
126 =over 8
127
128 =item B<--help>
129
130 Prints this help
131
132 =item B<-v>
133
134 Provide verbose log information.
135
136 =item B<--where>
137
138 Limits the search with a user-specified WHERE clause.
139
140 =back
141
142 =cut
143