Split off koha-common.
[koha.git] / reports / catalogue_stats.pl
1 #!/usr/bin/perl
2
3
4 # Copyright 2000-2002 Katipo Communications
5 #
6 # This file is part of Koha.
7 #
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
11 # version.
12 #
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20
21 use strict;
22 #use warnings; FIXME - Bug 2505
23 use C4::Auth;
24 use CGI;
25 use C4::Context;
26 use C4::Branch; # GetBranches
27 use C4::Output;
28 use C4::Koha;
29 use C4::Reports;
30 use C4::Circulation;
31
32 =head1 NAME
33
34 plugin that shows a stats on borrowers
35
36 =head1 DESCRIPTION
37
38 =over 2
39
40 =cut
41
42 our $debug = 0;
43 my $input = new CGI;
44 my $fullreportname = "reports/catalogue_stats.tmpl";
45 my $do_it       = $input->param('do_it');
46 my $line        = $input->param("Line");
47 my $column      = $input->param("Column");
48 my @filters     = $input->param("Filter");
49 my $deweydigits = $input->param("deweydigits");
50 my $lccndigits  = $input->param("lccndigits");
51 my $cotedigits  = $input->param("cotedigits");
52 my $output      = $input->param("output");
53 my $basename    = $input->param("basename");
54 my $mime        = $input->param("MIME");
55 our $sep        = $input->param("sep");
56 $sep = "\t" if ($sep eq 'tabulation');
57 my $item_itype;
58 if(C4::Context->preference('item-level_itypes')) {
59         $item_itype = "items\.itype"
60 } else {
61         $item_itype = "itemtype";
62 }
63
64 my ($template, $borrowernumber, $cookie)
65         = get_template_and_user({template_name => $fullreportname,
66                                 query => $input,
67                                 type => "intranet",
68                                 authnotrequired => 0,
69                                 flagsrequired => {reports => '*'},
70                                 debug => 1,
71                                 });
72 $template->param(do_it => $do_it);
73 if ($do_it) {
74         my $results = calculate($line, $column, $deweydigits, $lccndigits, $cotedigits, \@filters);
75         if ($output eq "screen"){
76                 $template->param(mainloop => $results);
77                 output_html_with_http_headers $input, $cookie, $template->output;
78                 exit(1);
79         } else {
80                 print $input->header(-type => 'application/vnd.sun.xml.calc',
81                                      -encoding    => 'utf-8',
82                                                          -attachment=>"$basename.csv",
83                                                          -name=>"$basename.csv" );
84                 my $cols  = @$results[0]->{loopcol};
85                 my $lines = @$results[0]->{looprow};
86                 print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
87                 foreach my $col ( @$cols ) {
88                         print $col->{coltitle}.$sep;
89                 }
90                 print "Total\n";
91                 foreach my $line ( @$lines ) {
92                         my $x = $line->{loopcell};
93                         print $line->{rowtitle}.$sep;
94                         foreach my $cell (@$x) {
95                                 print $cell->{value}.$sep;
96                         }
97                         print $line->{totalrow};
98                         print "\n";
99                 }
100                 print "TOTAL";
101                 $cols = @$results[0]->{loopfooter};
102                 foreach my $col ( @$cols ) {
103                         print $sep.$col->{totalcol};
104                 }
105                 print $sep.@$results[0]->{total};
106                 exit(1);
107         }
108 } else {
109         my $dbh = C4::Context->dbh;
110         my @values;
111         my %labels;
112         my $count=0;
113         my $req;
114         my @select;
115         # FIXME: no such field "dewey"
116         # $req = $dbh->prepare("select count(dewey) from biblioitems ");
117         # $req->execute;
118         my $hasdewey = 0;
119
120 # (rch) biblioitems.lccn is mapped to lccn MARC21 010$a in default framework.
121 # This is not the LC Classification.  It's the Control Number.
122 # So I'm just going to remove this bit.  Call Number is handled in itemcallnumber.
123 #
124         my $haslccn = 0;
125 #       $req = $dbh->prepare( "select count(lccn) from biblioitems ");
126 #       $req->execute;
127 #       my $hlghtlccn;
128 #       while (my ($value) =$req->fetchrow) {
129 #               $hlghtlccn = !($hasdewey);
130 #               $haslccn =1 if (($value>2) and (! $haslccn));
131 #               $count++ if (($value) and (! $haslccn));
132 #               push @select, $value;
133 #       }
134 #       my $CGIlccn=CGI::scrolling_list( -name     => 'Filter',
135 #                               -id => 'Filter',
136 #                               -values   => \@select,
137 #                               -size     => 1,
138 #                               -multiple => 0 );
139
140 # No need to test for data here.  If you don't have itemcallnumbers, you probably know it.
141 # FIXME: Hardcoding to 5 chars on itemcallnum. 
142 #
143     my $hascote = 1;
144     my $highcote = 5;
145
146         $req = $dbh->prepare("select itemtype, description from itemtypes order by description");
147         $req->execute;
148         my $CGIitemtype = $req->fetchall_arrayref({});
149
150         my $authvals = GetKohaAuthorisedValues("items.ccode");
151         my @authvals;
152         foreach (sort {$authvals->{$a} cmp $authvals->{$b} || $a cmp $b} keys %$authvals) {
153                 push @authvals, { code => $_, description => $authvals->{$_} };
154         }
155         
156         my $locations = GetKohaAuthorisedValues("items.location");
157         my @locations;
158         foreach (sort keys %$locations) {
159                 push @locations, { code => $_, description => "$_ - " . $locations->{$_} };
160         }
161         
162         my @mime  = ( map { +{type =>$_} } (split /[;:]/,C4::Context->preference("MIME")) );
163         
164         $template->param(hasdewey=>$hasdewey,
165                                         haslccn   => $haslccn,
166                                         hascote   => $hascote,
167                                         CGIItemType => $CGIitemtype,
168                                         CGIBranch    => GetBranchesLoop(C4::Context->userenv->{'branch'}),
169                                         locationloop => \@locations,
170                                         authvals     => \@authvals,
171                                         CGIextChoice => \@mime,
172                                         CGIsepChoice => GetDelimiterChoices,
173                                         item_itype => $item_itype
174                                         );
175
176 }
177 output_html_with_http_headers $input, $cookie, $template->output;
178
179 ## End of Main Body
180
181
182 sub calculate {
183         my ($line, $column, $deweydigits, $lccndigits, $cotedigits, $filters) = @_;
184         my @mainloop;
185         my @loopfooter;
186         my @loopcol;
187         my @loopline;
188         my @looprow;
189         my %globalline;
190         my $grantotal =0;
191     my $barcodelike   = @$filters[13];
192     my $barcodefilter = @$filters[14];
193     my $not;
194     
195 # extract parameters
196         my $dbh = C4::Context->dbh;
197
198 # if barcodefilter is empty set as %
199 if($barcodefilter){
200     # Check if barcodefilter is "like" or "not like"
201     if(!$barcodelike){
202         $not = "not";
203     }
204     # Change * to %
205     $barcodefilter =~ s/\*/%/g;
206 }
207
208 # Filters
209 # Checking filters
210 #
211         my @loopfilter;
212         for (my $i=0;$i<=12;$i++) {
213                 my %cell;
214                 if ( @$filters[$i] ) {
215                         if ((($i==1) or ($i==3) or ($i==5) or ($i==9)) and (@$filters[$i-1])) {
216                                 $cell{err} = 1 if (@$filters[$i]<@$filters[$i-1]) ;
217                         }
218                         $cell{filter} .= @$filters[$i];
219                         $cell{crit} .=
220                                 ($i== 0) ? "Dewey Classification From" :
221                                 ($i== 1) ? "Dewey Classification To"   :
222                                 ($i== 2) ? "Lccn Classification From"  :
223                                 ($i== 3) ? "Lccn Classification To"    :
224                                 ($i== 4) ? "Item CallNumber From"  :
225                                 ($i== 5) ? "Item CallNumber To"    :
226                                 ($i== 6) ? "Item type"             :
227                                 ($i== 7) ? "Publisher"                 :
228                                 ($i== 8) ? "Publication year From"     :
229                                 ($i== 9) ? "Publication year To"       :
230                                 ($i==10) ? "Library :"                  :
231                                 ($i==11) ? "Shelving Location :"                :
232                                 ($i==12) ? "Collection Code :"            : '';
233                         push @loopfilter, \%cell;
234                 }
235         }
236         
237 #       warn map {"filtres $_\n"} @filters[0..3];
238
239         my @linefilter;
240         $linefilter[0] = @$filters[0] if ($line =~ /dewey/ )  ;
241         $linefilter[1] = @$filters[1] if ($line =~ /dewey/ )  ;
242         $linefilter[0] = @$filters[2] if ($line =~ /lccn/ )  ;
243         $linefilter[1] = @$filters[3] if ($line =~ /lccn/ )  ;
244         $linefilter[0] = @$filters[4] if ($line =~ /items\.itemcallnumber/ )  ;
245         $linefilter[1] = @$filters[5] if ($line =~ /items\.itemcallnumber/ )  ;
246         if (C4::Context->preference('item-level_itypes')) {
247                 $linefilter[0] = @$filters[6] if ($line =~ /items\.itype/ )  ;
248         } else {
249                 $linefilter[0] = @$filters[6] if ($line =~ /itemtype/ )  ;
250         }
251         $linefilter[0] = @$filters[7] if ($line =~ /publishercode/ ) ;
252         $linefilter[0] = @$filters[8] if ($line =~ /publicationyear/ ) ;
253         $linefilter[1] = @$filters[9] if ($line =~ /publicationyear/ ) ;
254         $linefilter[0] = @$filters[10] if ($line =~ /items\.homebranch/ ) ;
255         $linefilter[0] = @$filters[11] if ($line =~ /items\.location/ ) ;
256         $linefilter[0] = @$filters[12] if ($line =~ /items\.ccode/ ) ;
257
258         my @colfilter ;
259         $colfilter[0] = @$filters[0] if ($column =~ /dewey/ )  ;
260         $colfilter[1] = @$filters[1] if ($column =~ /dewey/ )  ;
261         $colfilter[0] = @$filters[2] if ($column =~ /lccn/ )  ;
262         $colfilter[1] = @$filters[3] if ($column =~ /lccn/ )  ;
263         $colfilter[0] = @$filters[4] if ($column =~ /items\.itemcallnumber/ )  ;
264         $colfilter[1] = @$filters[5] if ($column =~ /items\.itemcallnumber/ )  ;
265         if (C4::Context->preference('item-level_itypes')) {
266                 $colfilter[0] = @$filters[6] if ($column =~ /items\.itype/ )  ;
267         } else {
268                 $colfilter[0] = @$filters[6] if ($column =~ /itemtype/ )  ;
269         }
270         $colfilter[0] = @$filters[7] if ($column =~ /publishercode/ ) ;
271         $colfilter[0] = @$filters[8] if ($column =~ /publicationyear/ ) ;
272         $colfilter[1] = @$filters[9] if ($column =~ /publicationyear/ ) ;
273         $colfilter[0] = @$filters[10] if ($column =~ /items\.homebranch/ ) ;
274         $colfilter[0] = @$filters[11] if ($column =~ /items\.location/ ) ;
275         $colfilter[0] = @$filters[12] if ($column =~ /items\.ccode/ ) ;
276
277 # 1st, loop rows.
278         my $linefield;
279         if (($line =~/dewey/)  and ($deweydigits)) {
280                 $linefield .="left($line,$deweydigits)";
281         } elsif (($line=~/lccn/) and ($lccndigits)) {
282                 $linefield .="left($line,$lccndigits)";
283         } elsif (($line=~/items.itemcallnumber/) and ($cotedigits)) {
284                 $linefield .="left($line,$cotedigits)";
285         }else {
286                 $linefield .= $line;
287         }
288
289         my $strsth = "SELECT DISTINCTROW $linefield FROM biblioitems 
290                         INNER JOIN items USING (biblioitemnumber)
291                       WHERE $line IS NOT NULL ";
292     $strsth .= " AND barcode $not LIKE ? " if ($barcodefilter);
293         if ( @linefilter ) {
294                 if ($linefilter[1]){
295                         $strsth .= " AND $line >= ? " ;
296                         $strsth .= " AND $line <= ? " ;
297                 } elsif ($linefilter[0]) {
298                         $linefilter[0] =~ s/\*/%/g;
299                         $strsth .= " AND $line LIKE ? " ;
300                 }
301         }
302         $strsth .=" ORDER BY $linefield";
303         $debug and print STDERR "catalogue_stats SQL: $strsth\n";
304
305         my $sth = $dbh->prepare( $strsth );
306         if (( @linefilter ) and ($linefilter[1])){
307                 $sth->execute($barcodefilter,$linefilter[0],$linefilter[1]);
308         } elsif ($barcodefilter,$linefilter[0]) {
309                 $sth->execute($barcodefilter,$linefilter[0]);
310         } elsif ($barcodefilter) {
311                 $sth->execute($barcodefilter);
312         }else{
313             $sth->execute();
314         }
315         while ( my ($celvalue) = $sth->fetchrow) {
316                 my %cell;
317                 if ($celvalue) {
318                         $cell{rowtitle} = $celvalue;
319 #               } else {
320 #                       $cell{rowtitle} = "";
321                 }
322                 $cell{totalrow} = 0;
323                 push @loopline, \%cell;
324         }
325
326 # 2nd, loop cols.
327         my $colfield;
328         if (($column =~/dewey/)  and ($deweydigits)) {
329                 $colfield = "left($column,$deweydigits)";
330         }elsif (($column=~/lccn/) and ($lccndigits)) {
331                 $colfield = "left($column,$lccndigits)";
332         }elsif (($column=~/itemcallnumber/) and ($cotedigits)) {
333                 $colfield = "left($column,$cotedigits)";
334         }else {
335                 $colfield = $column;
336         }
337         
338         my $strsth2 = "
339         SELECT distinctrow $colfield
340         FROM   biblioitems
341         INNER JOIN items
342                 USING (biblioitemnumber)
343         WHERE $column IS NOT NULL ";
344         $strsth2 .= " AND barcode $not LIKE ?" if $barcodefilter;
345         
346         if (( @colfilter ) and ($colfilter[1])) {
347                 $strsth2 .= " AND $column> ? AND $column< ?";
348         }elsif ($colfilter[0]){
349                 $colfilter[0] =~ s/\*/%/g;
350                 $strsth2 .= " AND $column LIKE ? ";
351         } 
352         $strsth2 .= " ORDER BY $colfield";
353         $debug and print STDERR "SQL: $strsth2";
354         my $sth2 = $dbh->prepare( $strsth2 );
355         if ((@colfilter) and ($colfilter[1])) {
356                 $sth2->execute($barcodefilter,$colfilter[0],$colfilter[1]);
357         } elsif ($colfilter[0]){
358                 $sth2->execute($barcodefilter,$colfilter[0]);
359         } elsif ($barcodefilter){
360             $sth2->execute($barcodefilter);
361         } else {
362                 $sth2->execute();
363         }
364         while (my ($celvalue) = $sth2->fetchrow) {
365                 my %cell;
366                 my %ft;
367                 if ($celvalue) {
368                         $cell{coltitle} = $celvalue;
369 #               } else {
370 #                       $cell{coltitle} = "";
371                 }
372                 $ft{totalcol} = 0;
373                 push @loopcol, \%cell;
374         }
375         
376         my $i=0;
377         my @totalcol;
378         my $hilighted=-1;
379         
380         #Initialization of cell values.....
381         my %table;
382 #       warn "init table";
383         foreach my $row ( @loopline ) {
384                 foreach my $col ( @loopcol ) {
385 #                       warn " init table : $row->{rowtitle} / $col->{coltitle} ";
386                         $table{$row->{rowtitle}}->{$col->{coltitle}}=0;
387                 }
388                 $table{$row->{rowtitle}}->{totalrow}=0;
389         }
390
391 # preparing calculation
392         my $strcalc = "SELECT $linefield, $colfield, count(*) FROM biblioitems INNER JOIN  items ON (items.biblioitemnumber = biblioitems.biblioitemnumber) WHERE 1 ";
393         $strcalc .= "AND barcode $not like ? " if ($barcodefilter); 
394         
395         if (@$filters[0]){
396                 @$filters[0]=~ s/\*/%/g;
397                 $strcalc .= " AND dewey >" . @$filters[0];
398         }
399         if (@$filters[1]){
400                 @$filters[1]=~ s/\*/%/g ;
401                 $strcalc .= " AND dewey <" . @$filters[1];
402         }
403         if (@$filters[2]){
404                 @$filters[2]=~ s/\*/%/g ;
405                 $strcalc .= " AND lccn >" . @$filters[2];
406         }
407         if (@$filters[3]){
408                 @$filters[3]=~ s/\*/%/g;
409                 $strcalc .= " AND lccn <" . @$filters[3];
410         }
411         if (@$filters[4]){
412                 @$filters[4]=~ s/\*/%/g ;
413                 $strcalc .= " AND items.itemcallnumber >=" . $dbh->quote(@$filters[4]);
414         }
415         
416         if (@$filters[5]){
417                 @$filters[5]=~ s/\*/%/g;
418                 $strcalc .= " AND items.itemcallnumber <=" . $dbh->quote(@$filters[5]);
419         }
420         
421         if (@$filters[6]){
422                 @$filters[6]=~ s/\*/%/g;
423                 $strcalc .= " AND " . 
424                         (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype')
425                         . " LIKE '" . @$filters[6] ."'";
426         }
427         
428         if (@$filters[7]){
429                 @$filters[7]=~ s/\*/%/g;
430                 @$filters[7].="%" unless @$filters[7]=~/%/;
431                 $strcalc .= " AND biblioitems.publishercode LIKE \"" . @$filters[7] ."\"";
432         }
433         if (@$filters[8]){
434                 @$filters[8]=~ s/\*/%/g;
435                 $strcalc .= " AND publicationyear >" . @$filters[8];
436         }
437         if (@$filters[9]){
438                 @$filters[9]=~ s/\*/%/g;
439                 $strcalc .= " AND publicationyear <" . @$filters[9];
440         }
441         if (@$filters[10]){
442                 @$filters[10]=~ s/\*/%/g;
443                 $strcalc .= " AND items.homebranch LIKE '" . @$filters[10] ."'";
444         }
445         if (@$filters[11]){
446                 @$filters[11]=~ s/\*/%/g;
447                 $strcalc .= " AND items.location LIKE '" . @$filters[11] ."'";
448         }
449         if (@$filters[12]){
450                 @$filters[12]=~ s/\*/%/g;
451                 $strcalc .= " AND items.ccode  LIKE '" . @$filters[12] ."'";
452         }
453         
454         $strcalc .= " group by $linefield, $colfield order by $linefield,$colfield";
455         $debug and warn "SQL: $strcalc";
456         my $dbcalc = $dbh->prepare($strcalc);
457         if($barcodefilter){
458            $dbcalc->execute($barcodefilter);
459         }else{
460            $dbcalc->execute();
461         }
462 #       warn "filling table";
463         
464         my $emptycol; 
465         while (my ($row, $col, $value) = $dbcalc->fetchrow) {
466 #               warn "filling table $row / $col / $value ";
467                 $emptycol = 1    if (!defined($col));
468                 $col = "zzEMPTY" if (!defined($col));
469                 $row = "zzEMPTY" if (!defined($row));
470                 
471                 $table{$row}->{$col}+=$value;
472                 $table{$row}->{totalrow}+=$value;
473                 $grantotal += $value;
474         }
475
476 #       my %cell = {rowtitle => 'zzROWEMPTY'};
477 #       push @loopline,\%cell;
478 #       undef %cell;
479 #       my %cell;
480 #       %cell = {coltitle => "zzEMPTY"};
481         push @loopcol,{coltitle => "NULL"} if ($emptycol);
482         
483         foreach my $row ( sort keys %table ) {
484                 my @loopcell;
485                 #@loopcol ensures the order for columns is common with column titles
486                 # and the number matches the number of columns
487                 foreach my $col ( @loopcol ) {
488                         my $value =$table{$row}->{($col->{coltitle} eq "NULL")?"zzEMPTY":$col->{coltitle}};
489                         push @loopcell, {value => $value  } ;
490                 }
491                 push @looprow,{ 'rowtitle' => ($row eq "zzEMPTY")?"NULL":$row,
492                                                 'loopcell' => \@loopcell,
493                                                 'hilighted' => ($hilighted *= -1 > 0),
494                                                 'totalrow' => $table{$row}->{totalrow}
495                                         };
496         }
497         
498 #       warn "footer processing";
499         foreach my $col ( @loopcol ) {
500                 my $total=0;
501                 foreach my $row ( @looprow ) {
502                         $total += $table{($row->{rowtitle} eq "NULL")?"zzEMPTY":$row->{rowtitle}}->{($col->{coltitle} eq "NULL")?"zzEMPTY":$col->{coltitle}};
503 #                       warn "value added ".$table{$row->{rowtitle}}->{$col->{coltitle}}. "for line ".$row->{rowtitle};
504                 }
505 #               warn "summ for column ".$col->{coltitle}."  = ".$total;
506                 push @loopfooter, {'totalcol' => $total};
507         }
508                         
509
510         # the header of the table
511         $globalline{loopfilter}=\@loopfilter;
512         # the core of the table
513         $globalline{looprow} = \@looprow;
514         $globalline{loopcol} = \@loopcol;
515 #       # the foot (totals by borrower type)
516         $globalline{loopfooter} = \@loopfooter;
517         $globalline{total}= $grantotal;
518         $globalline{line} = $line;
519         $globalline{column} = $column;
520         push @mainloop,\%globalline;
521         return \@mainloop;
522 }
523
524 1;