4 # Copyright 2000-2002 Katipo Communications
6 # This file is part of Koha.
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
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.
17 # You should have received a copy of the GNU General Public License along with
18 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
19 # Suite 330, Boston, MA 02111-1307 USA
29 use C4::Branch; # GetBranches
34 use C4::Dates qw/format_date format_date_in_iso/;
39 plugin that shows circulation stats
47 # my $debug = 1; # override for now.
49 my $fullreportname = "reports/issues_stats.tmpl";
50 my $do_it = $input->param('do_it');
51 my $line = $input->param("Line");
52 my $column = $input->param("Column");
53 my @filters = $input->param("Filter");
54 $filters[0]=format_date_in_iso($filters[0]);
55 $filters[1]=format_date_in_iso($filters[1]);
56 my $podsp = $input->param("DisplayBy");
57 my $type = $input->param("PeriodTypeSel");
58 my $daysel = $input->param("PeriodDaySel");
59 my $monthsel = $input->param("PeriodMonthSel");
60 my $calc = $input->param("Cellvalue");
61 my $output = $input->param("output");
62 my $basename = $input->param("basename");
63 my $mime = $input->param("MIME");
64 my ($template, $borrowernumber, $cookie) = get_template_and_user({
65 template_name => $fullreportname,
69 flagsrequired => {reports => 1},
72 our $sep = $input->param("sep");
73 $sep = "\t" if ($sep eq 'tabulation');
74 $template->param(do_it => $do_it,
75 DHTMLcalendar_dateformat => C4::Dates->DHTMLcalendar(),
78 my $itemtypes = GetItemTypes();
79 my $categoryloop = GetBorrowercategoryList;
81 my $ccodes = GetKohaAuthorisedValues("items.ccode");
82 my $locations = GetKohaAuthorisedValues("items.location");
84 my $Bsort1 = GetAuthorisedValues("Bsort1");
85 my $Bsort2 = GetAuthorisedValues("Bsort2");
86 my ($hassort1,$hassort2);
87 $hassort1=1 if $Bsort1;
88 $hassort2=1 if $Bsort2;
93 my $results = calculate($line, $column, $podsp, $type, $daysel, $monthsel, $calc, \@filters);
94 if ($output eq "screen"){
95 # Printing results to screen
96 $template->param(mainloop => $results);
97 output_html_with_http_headers $input, $cookie, $template->output;
99 # Printing to a csv file
100 print $input->header(-type => 'application/vnd.sun.xml.calc',
101 -encoding => 'utf-8',
102 -attachment=>"$basename.csv",
103 -filename=>"$basename.csv" );
104 my $cols = @$results[0]->{loopcol};
105 my $lines = @$results[0]->{looprow};
107 print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
109 foreach my $col ( @$cols ) {
110 print $col->{coltitle}.$sep;
114 foreach my $line ( @$lines ) {
115 my $x = $line->{loopcell};
116 print $line->{rowtitle}.$sep;
117 print map {$_->{value}.$sep} @$x;
118 print $line->{totalrow}, "\n";
122 $cols = @$results[0]->{loopfooter};
123 print map {$sep.$_->{totalcol}} @$cols;
124 print $sep.@$results[0]->{total};
126 exit(1); # exit either way after $do_it
129 my $dbh = C4::Context->dbh;
134 # create itemtype arrayref for <select>.
136 for my $itype ( sort {$itemtypes->{$a}->{description} cmp $itemtypes->{$b}->{description}} keys(%$itemtypes)) {
137 push @itemtypeloop, { code => $itype , description => $itemtypes->{$itype}->{description} } ;
142 foreach (sort keys %$locations) {
143 push @locations, { code => $_, description => "$_ - " . $locations->{$_} };
147 foreach (sort {$ccodes->{$a} cmp $ccodes->{$b}} keys %$ccodes) {
148 push @ccodes, { code => $_, description => $ccodes->{$_} };
152 my @mime = (C4::Context->preference("MIME"));
154 my $CGIextChoice=CGI::scrolling_list(
161 my $CGIsepChoice=GetDelimiterChoices;
164 categoryloop => $categoryloop,
165 itemtypeloop => \@itemtypeloop,
166 locationloop => \@locations,
167 ccodeloop => \@ccodes,
168 branchloop => GetBranchesLoop(C4::Context->userenv->{'branch'}),
169 hassort1=> $hassort1,
170 hassort2=> $hassort2,
173 CGIextChoice => $CGIextChoice,
174 CGIsepChoice => $CGIsepChoice,
176 output_html_with_http_headers $input, $cookie, $template->output;
179 my ($line, $column, $dsp, $type,$daysel,$monthsel ,$process, $filters) = @_;
187 my $dbh = C4::Context->dbh;
193 for (my $i=0;$i<=10;$i++) {
195 (@$filters[$i]) or next;
196 if (($i==1) and (@$filters[$i-1])) {
197 $cell{err} = 1 if (@$filters[$i]<@$filters[$i-1]) ;
199 # format the dates filters, otherwise just fill as is
201 $cell{filter} = @$filters[$i];
203 $cell{filter} = format_date(@$filters[$i]);
206 ($i==0) ? "Period From" :
207 ($i==1) ? "Period To" :
208 ($i==2) ? "Patron Category =" :
209 ($i==3) ? "Item Type =" :
210 ($i==4) ? "Library =" :
211 ($i==5) ? "Collection =" :
212 ($i==6) ? "Location =" :
213 ($i==7) ? "Item callnumber >=" :
214 ($i==8) ? "Item callnumber <" :
215 ($i==9) ? "sort1 =" :
216 ($i==10)? "sort2 =" :
217 ($i==11)? "Home branch =" :
218 ($i==12)? "Holding branch =" :"UNKNOWN FILTER ($i)";
219 # FIXME - no translation mechanism !
220 push @loopfilter, \%cell;
222 push @loopfilter,{crit=>"Event", filter=>$type };
223 push @loopfilter,{crit=>"Display by", filter=>$dsp } if ($dsp);
224 push @loopfilter,{crit=>"Select Day", filter=>$daysel } if ($daysel);
225 push @loopfilter,{crit=>"Select Month",filter=>$monthsel} if ($monthsel);
228 $debug and warn "filtres ". join "|", @filters;
229 my ($colsource, $linesource);
230 $linefilter[1] = @$filters[1] if ($line =~ /datetime/);
231 $linefilter[0] = ($line =~ /datetime/) ? @$filters[0] :
232 ($line =~ /category/) ? @$filters[2] :
233 ($line =~ /itemtype/) ? @$filters[3] :
234 ($line =~ /branch/ ) ? @$filters[4] :
235 ($line =~ /ccode/ ) ? @$filters[5] :
236 ($line =~ /location/) ? @$filters[6] :
237 ($line =~ /sort1/ ) ? @$filters[9] :
238 ($line =~ /sort2/ ) ? @$filters[10] :
239 ($line =~ /homebranch/) ? @$filters[11] :
240 ($line =~ /holdingbranch/) ? @$filters[12] : undef ;
241 if ($line =~ /ccode/ or $line =~ /location/ or $line =~ /homebranch/ or $line =~ /holdingbranch/) {
242 $linesource = 'items';
246 $colfilter[1] = @$filters[1] if ($column =~ /datetime/);
247 $colfilter[0] = ($column =~ /datetime/) ? @$filters[0] :
248 ($column =~ /category/) ? @$filters[2] :
249 ($column =~ /itemtype/) ? @$filters[3] :
250 ($column =~ /branch/ ) ? @$filters[4] :
251 ($column =~ /ccode/ ) ? @$filters[5] :
252 ($column =~ /location/) ? @$filters[6] :
253 ($column =~ /sort1/ ) ? @$filters[9] :
254 ($column =~ /sort1/ ) ? @$filters[10] :
255 ($column =~ /homebranch/) ? @$filters[11] :
256 ($column =~ /holdingbranch/) ? @$filters[12] : undef ;
257 if ($column =~ /ccode/ or $column =~ /location/ or $column =~ /homebranch/ or $column =~ /holdingbranch/) {
258 $colsource = 'items';
262 if ($line =~ /datetime/) {
263 # by Day, Month or Year (1,2,3 respectively)
264 $linefield = ($dsp == 1) ? " dayname($line)" :
265 ($dsp == 2) ? "monthname($line)" :
266 ($dsp == 3) ? " Year($line)" :
267 'date_format(`datetime`,"%Y-%m-%d")'; # Probably should be left alone or passed through C4::Dates
271 my $lineorder = ($linefield =~ /dayname/) ? "weekday($line)" :
272 ($linefield =~ /^month/ ) ? " month($line)" : $linefield;
274 my $strsth = "SELECT distinctrow $linefield FROM statistics, ";
275 # get stats on items if ccode or location, otherwise borrowers.
276 $strsth .= ($linesource eq 'items' ) ?
277 " items WHERE (statistics.itemnumber=items.itemnumber) " :
278 " borrowers WHERE (statistics.borrowernumber=borrowers.borrowernumber) ";
279 $strsth .= " AND $line is not null ";
281 if ($line =~ /datetime/) {
282 if ($linefilter[1] and ($linefilter[0])) {
283 $strsth .= " AND $line between ? AND ? ";
284 } elsif ($linefilter[1]) {
285 $strsth .= " AND $line < ? ";
286 } elsif ($linefilter[0]) {
287 $strsth .= " AND $line > ? ";
289 $strsth .= " AND type ='".$type."' " if $type;
290 $strsth .= " AND dayname(datetime) ='". $daysel ."' " if $daysel;
291 $strsth .= " AND monthname(datetime) ='". $monthsel ."' " if $monthsel;
292 } elsif ($linefilter[0]) {
293 $linefilter[0] =~ s/\*/%/g;
294 $strsth .= " AND $line LIKE ? ";
296 $strsth .=" group by $linefield order by $lineorder ";
297 $debug and warn $strsth;
298 push @loopfilter, {crit=>'SQL =', sql=>1, filter=>$strsth};
299 my $sth = $dbh->prepare( $strsth );
300 if ((@linefilter) and ($linefilter[1])){
301 $sth->execute($linefilter[0],$linefilter[1]);
302 } elsif ($linefilter[0]) {
303 $sth->execute($linefilter[0]);
308 while (my ($celvalue) = $sth->fetchrow) {
309 my %cell = (rowtitle => $celvalue, totalrow => 0); # we leave 'rowtitle' as hash key (used when filling the table), and add coltitle_display
310 $cell{rowtitle_display} =
311 ($line =~ /ccode/ ) ? $ccodes->{$celvalue} :
312 ($line =~ /location/) ? $locations->{$celvalue} :
313 ($line =~ /itemtype/) ? $itemtypes->{$celvalue}->{description} :
314 $celvalue; # default fallback
315 if ($line =~ /sort1/) {
317 ($celvalue eq $_->{authorised_value}) or next;
318 $cell{rowtitle_display} = $_->{lib} and last;
320 } elsif ($line =~ /sort2/) {
322 ($celvalue eq $_->{authorised_value}) or next;
323 $cell{rowtitle_display} = $_->{lib} and last;
325 } elsif ($line =~ /category/) {
326 foreach (@$categoryloop) {
327 ($celvalue eq $_->{categorycode}) or next;
328 $cell{rowtitle_display} = $_->{description} and last;
331 push @loopline, \%cell;
337 if ($column =~ /datetime/) {
338 #Display by Day, Month or Year (1,2,3 respectively)
339 $colfield = ($dsp == 1) ? " dayname($column)" :
340 ($dsp == 2) ? "monthname($column)" :
341 ($dsp == 3) ? " Year($column)" :
342 'date_format(`datetime`,"%Y-%m-%d")'; # Probably should be left alone or passed through C4::Dates
346 $colorder = ($colfield =~ /dayname/) ? "weekday($column)" :
347 ($colfield =~ /^month/ ) ? " month($column)" : $colfield;
348 my $strsth2 = "SELECT distinctrow $colfield FROM statistics, ";
349 # get stats on items if ccode or location, otherwise borrowers.
350 $strsth2 .= ($colsource eq 'items' ) ?
351 "items WHERE (statistics.itemnumber=items.itemnumber) " :
352 "borrowers WHERE (statistics.borrowernumber=borrowers.borrowernumber) ";
353 $strsth2 .= " AND $column IS NOT NULL ";
355 if ($column =~ /datetime/){
356 if (($colfilter[1]) and ($colfilter[0])){
357 $strsth2 .= " AND $column BETWEEN ? AND ? " ;
358 } elsif ($colfilter[1]) {
359 $strsth2 .= " AND $column < ? " ;
360 } elsif ($colfilter[0]) {
361 $strsth2 .= " AND $column > ? " ;
363 $strsth2 .= " AND type ='". $type ."' " if $type;
364 $strsth2 .= " AND dayname(datetime) ='". $daysel ."' " if $daysel;
365 $strsth2 .= " AND monthname(datetime) ='". $monthsel ."' " if $monthsel;
366 } elsif ($colfilter[0]) {
367 $colfilter[0] =~ s/\*/%/g;
368 $strsth2 .= " AND $column LIKE ? " ;
370 $strsth2 .=" GROUP BY $colfield ORDER BY $colorder ";
372 my $sth2 = $dbh->prepare($strsth2);
373 push @loopfilter, {crit=>'SQL =', sql=>1, filter=>$strsth2};
374 if ((@colfilter) and ($colfilter[1])){
375 $sth2->execute($colfilter[0], $colfilter[1]);
376 } elsif ($colfilter[0]) {
377 $sth2->execute($colfilter[0]);
382 while (my ($celvalue) = $sth2->fetchrow) {
383 my %cell = (coltitle => $celvalue); # we leave 'coltitle' as hash key (used when filling the table), and add coltitle_display
384 $cell{coltitle_display} =
385 ($column =~ /ccode/ ) ? $ccodes->{$celvalue} :
386 ($column =~ /location/) ? $locations->{$celvalue} :
387 ($column =~ /itemtype/) ? $itemtypes->{$celvalue}->{description} :
388 $celvalue; # default fallback
389 if ($column =~ /sort1/) {
391 ($celvalue eq $_->{authorised_value}) or next;
392 $cell{coltitle_display} = $_->{lib} and last;
394 } elsif ($column =~ /sort2/) {
396 ($celvalue eq $_->{authorised_value}) or next;
397 $cell{coltitle_display} = $_->{lib} and last;
399 } elsif ($column =~ /category/) {
400 foreach (@$categoryloop) {
401 ($celvalue eq $_->{categorycode}) or next;
402 $cell{coltitle_display} = $_->{description} and last;
405 push @loopcol, \%cell;
408 #Initialization of cell values.....
410 foreach my $row (@loopline) {
411 foreach my $col (@loopcol) {
412 $debug and warn " init table : $row->{rowtitle} ( $row->{rowtitle_display} ) / $col->{coltitle} ( $col->{coltitle_display} ) ";
413 $table{$row->{rowtitle}}->{$col->{coltitle}} = 0;
415 $table{$row->{rowtitle}}->{totalrow} = 0;
418 # preparing calculation
419 my $strcalc = "SELECT $linefield, $colfield, ";
420 $strcalc .= ($process == 1) ? " COUNT(*) " :
421 ($process == 2) ? "(COUNT(DISTINCT borrowers.borrowernumber))" :
422 ($process == 3) ? "(COUNT(DISTINCT issues.itemnumber))" : '';
424 my $rqbookcount = $dbh->prepare("SELECT count(*) FROM items");
425 $rqbookcount->execute;
426 my ($bookcount) = $rqbookcount->fetchrow;
427 $strcalc .= "100*(COUNT(DISTINCT issues.itemnumber))/ $bookcount " ;
431 LEFT JOIN borrowers ON statistics.borrowernumber=borrowers.borrowernumber
433 $strcalc .= "LEFT JOIN items ON statistics.itemnumber=items.itemnumber "
434 if ($linefield =~ /^items\./ or $colfield =~ /^items\./ or ($colsource eq 'items')
435 ||@$filters[5]||@$filters[6]||@$filters[7]||@$filters[8]);
437 $strcalc .= "WHERE 1=1 ";
438 @$filters = map {defined($_) and s/\*/%/g; $_} @$filters;
439 $strcalc .= " AND statistics.datetime > '" . @$filters[0] ."'" if (@$filters[0] );
440 $strcalc .= " AND statistics.datetime < '" . @$filters[1] ."'" if (@$filters[1] );
441 $strcalc .= " AND borrowers.categorycode LIKE '" . @$filters[2] ."'" if (@$filters[2] );
442 $strcalc .= " AND statistics.itemtype LIKE '" . @$filters[3] ."'" if (@$filters[3] );
443 $strcalc .= " AND statistics.branch LIKE '" . @$filters[4] ."'" if (@$filters[4] );
444 $strcalc .= " AND items.ccode LIKE '" . @$filters[5] ."'" if (@$filters[5] );
445 $strcalc .= " AND items.location LIKE '" . @$filters[6] ."'" if (@$filters[6] );
446 $strcalc .= " AND items.itemcallnumber >='" . @$filters[7] ."'" if (@$filters[7] );
447 $strcalc .= " AND items.itemcallnumber <'" . @$filters[8] ."'" if (@$filters[8] );
448 $strcalc .= " AND borrowers.sort1 LIKE '" . @$filters[9] ."'" if (@$filters[9] );
449 $strcalc .= " AND borrowers.sort2 LIKE '" . @$filters[10]."'" if (@$filters[10]);
450 $strcalc .= " AND dayname(datetime) LIKE '" . $daysel ."'" if ($daysel );
451 $strcalc .= " AND monthname(datetime) LIKE '" . $monthsel ."'" if ($monthsel);
452 $strcalc .= " AND statistics.type LIKE '" . $type ."'" if ($type );
454 $strcalc .= " GROUP BY $linefield, $colfield order by $lineorder,$colorder";
455 ($debug) and warn $strcalc;
456 my $dbcalc = $dbh->prepare($strcalc);
457 push @loopfilter, {crit=>'SQL =', sql=>1, filter=>$strcalc};
459 my ($emptycol,$emptyrow);
460 while (my ($row, $col, $value) = $dbcalc->fetchrow) {
461 ($debug) and warn "filling table $row / $col / $value ";
462 unless (defined $col) {
466 unless (defined $row) {
470 $table{$row}->{$col} += $value;
471 $table{$row}->{totalrow} += $value;
472 $grantotal += $value;
474 push @loopcol, {coltitle => "NULL", coltitle_display => 'NULL'} if ($emptycol);
475 push @loopline,{rowtitle => "NULL", rowtitle_display => 'NULL'} if ($emptyrow);
477 foreach my $row (@loopline) {
479 #@loopcol ensures the order for columns is common with column titles
480 # and the number matches the number of columns
481 foreach my $col (@loopcol) {
482 my $value = $table{null_to_zzempty($row->{rowtitle})}->{null_to_zzempty($col->{coltitle})};
483 push @loopcell, {value => $value};
485 my $rowtitle = ($row->{rowtitle} eq "NULL") ? "zzEMPTY" : $row->{rowtitle};
487 'rowtitle_display' => $row->{rowtitle_display},
488 'rowtitle' => $rowtitle,
489 'loopcell' => \@loopcell,
490 'totalrow' => $table{$rowtitle}->{totalrow}
493 for my $col ( @loopcol ) {
495 foreach my $row (@looprow) {
496 $total += $table{null_to_zzempty($row->{rowtitle})}->{null_to_zzempty($col->{coltitle})};
497 $debug and warn "value added ".$table{$row->{rowtitle}}->{$col->{coltitle}}. "for line ".$row->{rowtitle};
499 push @loopfooter, {'totalcol' => $total};
502 # the header of the table
503 $globalline{loopfilter}=\@loopfilter;
504 # the core of the table
505 $globalline{looprow} = \@looprow;
506 $globalline{loopcol} = \@loopcol;
507 # # the foot (totals by borrower type)
508 $globalline{loopfooter} = \@loopfooter;
509 $globalline{total} = $grantotal;
510 $globalline{line} = $line;
511 $globalline{column} = $column;
512 return [(\%globalline)];
515 sub null_to_zzempty ($) {
517 defined($string) or return 'zzEMPTY';
518 ($string eq "NULL") and return 'zzEMPTY';
519 return $string; # else return the valid value