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