reports/reserves_stats.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2010 BibLibre
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20
  21 use strict;
  22 use warnings;
  23
  24 use CGI qw ( -utf8 );
  25
  26 use C4::Auth;
  27 use C4::Debug;
  28 use C4::Context;
  29 use C4::Branch; # GetBranches
  30 use C4::Koha;
  31 use C4::Output;
  32 use C4::Reports;
  33 use C4::Members;
  34 use C4::Dates qw/format_date format_date_in_iso/;
  35 use C4::Category;
  36 use List::MoreUtils qw/any/;
  37 use YAML;
  38
  39 =head1 NAME
  40
  41 plugin that shows circulation stats
  42
  43 =head1 DESCRIPTION
  44
  45 =over 2
  46
  47 =cut
  48
  49 # my $debug = 1;        # override for now.
  50 my $input = new CGI;
  51 my $fullreportname = "reports/reserves_stats.tt";
  52 my $do_it    = $input->param('do_it');
  53 my $line     = $input->param("Line");
  54 my $column   = $input->param("Column");
  55 my $podsp    = $input->param("DisplayBy");
  56 my $type     = $input->param("PeriodTypeSel");
  57 my $daysel   = $input->param("PeriodDaySel");
  58 my $monthsel = $input->param("PeriodMonthSel");
  59 my $calc     = $input->param("Cellvalue");
  60 my $output   = $input->param("output");
  61 my $basename = $input->param("basename");
  62 my $mime     = $input->param("MIME");
  63 my $hash_params = $input->Vars;
  64 my $filter_hashref;
  65 foreach my $filter (grep {$_ =~/^filter/} keys %$hash_params){
  66         my $filterstring=$filter;
  67         $filterstring=~s/^filter_//g;
  68         $$filter_hashref{$filterstring}=$$hash_params{$filter} if (defined $$hash_params{$filter} && $$hash_params{$filter} ne "");
  69 }
  70 my ($template, $borrowernumber, $cookie) = get_template_and_user({
  71         template_name => $fullreportname,
  72         query => $input,
  73         type => "intranet",
  74         authnotrequired => 0,
  75         flagsrequired => {reports => '*'},
  76         debug => 0,
  77 });
  78 our $sep     = $input->param("sep") || '';
  79 $sep = "\t" if ($sep eq 'tabulation');
  80 $template->param(do_it => $do_it,
  81 );
  82
  83 my $itemtypes = GetItemTypes();
  84 my $categoryloop = GetBorrowercategoryList;
  85
  86 my $ccodes    = GetKohaAuthorisedValues("items.ccode");
  87 my $locations = GetKohaAuthorisedValues("items.location");
  88 my $authvalue = GetKohaAuthorisedValues("items.authvalue");
  89
  90 my $Bsort1 = GetAuthorisedValues("Bsort1");
  91 my $Bsort2 = GetAuthorisedValues("Bsort2");
  92 my ($hassort1,$hassort2);
  93 $hassort1=1 if $Bsort1;
  94 $hassort2=1 if $Bsort2;
  95
  96
  97 if ($do_it) {
  98 # Displaying results
  99         my $results = calculate($line, $column,  $calc, $filter_hashref);
 100         if ($output eq "screen"){
 101 # Printing results to screen
 102                 $template->param(mainloop => $results);
 103                 output_html_with_http_headers $input, $cookie, $template->output;
 104         } else {
 105 # Printing to a csv file
 106         print $input->header(-type => 'application/vnd.sun.xml.calc',
 107                             -encoding    => 'utf-8',
 108                             -attachment=>"$basename.csv",
 109                             -filename=>"$basename.csv" );
 110                 my $cols  = @$results[0]->{loopcol};
 111                 my $lines = @$results[0]->{looprow};
 112 # header top-right
 113                 print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
 114 # Other header
 115                 foreach my $col ( @$cols ) {
 116                         print $col->{coltitle}.$sep;
 117                 }
 118                 print "Total\n";
 119 # Table
 120                 foreach my $line ( @$lines ) {
 121                         my $x = $line->{loopcell};
 122                         print $line->{rowtitle}.$sep;
 123                         print map {$_->{value}.$sep} @$x;
 124                         print $line->{totalrow}, "\n";
 125                 }
 126 # footer
 127         print "TOTAL";
 128         $cols = @$results[0]->{loopfooter};
 129                 print map {$sep.$_->{totalcol}} @$cols;
 130         print $sep.@$results[0]->{total};
 131         }
 132         exit; # exit either way after $do_it
 133 }
 134
 135 my $dbh = C4::Context->dbh;
 136 my @values;
 137 my %labels;
 138 my %select;
 139
 140 # create itemtype arrayref for <select>.
 141 my @itemtypeloop;
 142 for my $itype ( sort {$itemtypes->{$a}->{description} cmp $itemtypes->{$b}->{description}} keys(%$itemtypes)) {
 143         push @itemtypeloop, { code => $itype , description => $itemtypes->{$itype}->{description} } ;
 144 }
 145
 146     # location list
 147 my @locations;
 148 foreach (sort keys %$locations) {
 149         push @locations, { code => $_, description => "$_ - " . $locations->{$_} };
 150 }
 151
 152 my @ccodes;
 153 foreach (sort {$ccodes->{$a} cmp $ccodes->{$b}} keys %$ccodes) {
 154         push @ccodes, { code => $_, description => $ccodes->{$_} };
 155 }
 156
 157 # various
 158 my $CGIextChoice = ( 'CSV' ); # FIXME translation
 159 my $CGIsepChoice=GetDelimiterChoices;
 160
 161 $template->param(
 162         categoryloop => $categoryloop,
 163         itemtypeloop => \@itemtypeloop,
 164         locationloop => \@locations,
 165            ccodeloop => \@ccodes,
 166           branchloop => GetBranchesLoop(C4::Context->userenv->{'branch'}),
 167         hassort1=> $hassort1,
 168         hassort2=> $hassort2,
 169         Bsort1 => $Bsort1,
 170         Bsort2 => $Bsort2,
 171         CGIextChoice => $CGIextChoice,
 172         CGIsepChoice => $CGIsepChoice,
 173 );
 174 output_html_with_http_headers $input, $cookie, $template->output;
 175
 176 sub calculate {
 177         my ($linefield, $colfield, $process, $filters_hashref) = @_;
 178         my @loopfooter;
 179         my @loopcol;
 180         my @loopline;
 181         my @looprow;
 182         my %globalline;
 183         my $grantotal =0;
 184 # extract parameters
 185         my $dbh = C4::Context->dbh;
 186
 187 # Filters
 188 # Checking filters
 189 #
 190     my @loopfilter;
 191     foreach my $filter ( keys %$filters_hashref ) {
 192         $filters_hashref->{$filter} =~ s/\*/%/;
 193         $filters_hashref->{$filter} =
 194           format_date_in_iso( $filters_hashref->{$filter} )
 195           if ( $filter =~ /date/ );
 196     }
 197
 198     #display
 199     @loopfilter = map {
 200         {
 201             crit   => $_,
 202             filter => (
 203                 $_ =~ /date/
 204                 ? format_date( $filters_hashref->{$_} )
 205                 : $filters_hashref->{$_}
 206             )
 207         }
 208     } sort keys %$filters_hashref;
 209
 210
 211
 212
 213         my $linesql=changeifreservestatus($linefield);
 214         my $colsql=changeifreservestatus($colfield);
 215         #Initialization of cell values.....
 216
 217         # preparing calculation
 218     my $strcalc = "(SELECT $linesql line, $colsql col, ";
 219         $strcalc .= ($process == 1) ? " COUNT(*)  calculation"                                 :
 220                                         ($process == 2) ? "(COUNT(DISTINCT reserves.borrowernumber)) calculation"  :
 221                                 ($process == 3) ? "(COUNT(DISTINCT reserves.itemnumber)) calculation"      :
 222                                 ($process == 4) ? "(COUNT(DISTINCT reserves.biblionumber)) calculation"    : '*';
 223         $strcalc .= "
 224         FROM reserves
 225         LEFT JOIN borrowers USING (borrowernumber)
 226         ";
 227         $strcalc .= "LEFT JOIN biblio ON reserves.biblionumber=biblio.biblionumber "
 228         if ($linefield =~ /^biblio\./ or $colfield =~ /^biblio\./ or any {$_=~/biblio/}keys %$filters_hashref);
 229         $strcalc .= "LEFT JOIN items ON reserves.itemnumber=items.itemnumber "
 230         if ($linefield =~ /^items\./ or $colfield =~ /^items\./ or any {$_=~/items/}keys %$filters_hashref);
 231
 232         my @sqlparams;
 233         my @sqlorparams;
 234         my @sqlor;
 235         my @sqlwhere;
 236         ($debug) and print STDERR Dump($filters_hashref);
 237         foreach my $filter (keys %$filters_hashref){
 238                 my $string;
 239                 my $stringfield=$filter;
 240                 $stringfield=~s/\_[a-z_]+$//;
 241                 if ($filter=~/ /){
 242                         $string=$stringfield;
 243                 }
 244                 elsif ($filter=~/_or/){
 245                          push @sqlor, qq{( }.changeifreservestatus($filter)." = ? ) ";
 246                          push @sqlorparams, $$filters_hashref{$filter};
 247                 }
 248                 elsif ($filter=~/_endex$/){
 249                         $string = " $stringfield < ? ";
 250                 }
 251                 elsif ($filter=~/_end$/){
 252                         $string = " $stringfield <= ? ";
 253                 }
 254                 elsif ($filter=~/_begin$/){
 255                         $string = " $stringfield >= ? ";
 256                 }
 257                 else {
 258                         $string = " $stringfield LIKE ? ";
 259                 }
 260                 if ($string){
 261                         push @sqlwhere, $string;
 262                         push @sqlparams, $$filters_hashref{$filter};
 263                 }
 264         }
 265
 266         $strcalc .= " WHERE ".join(" AND ",@sqlwhere) if (@sqlwhere);
 267         $strcalc .= " AND (".join(" OR ",@sqlor).")" if (@sqlor);
 268         $strcalc .= " GROUP BY line, col )";
 269         my $strcalc_old=$strcalc;
 270         $strcalc_old=~s/reserves/old_reserves/g;
 271         $strcalc.=qq{ UNION $strcalc_old ORDER BY line, col};
 272         ($debug) and print STDERR $strcalc;
 273         my $dbcalc = $dbh->prepare($strcalc);
 274         push @loopfilter, {crit=>'SQL =', sql=>1, filter=>$strcalc};
 275         @sqlparams=(@sqlparams,@sqlorparams);
 276         $dbcalc->execute(@sqlparams,@sqlparams);
 277         my ($emptycol,$emptyrow);
 278         my $data = $dbcalc->fetchall_hashref([qw(line col)]);
 279         my %cols_hash;
 280         foreach my $row (keys %$data){
 281                 push @loopline, $row;
 282                 foreach my $col (keys %{$$data{$row}}){
 283                         $$data{$row}{totalrow}+=$$data{$row}{$col}{calculation};
 284                         $grantotal+=$$data{$row}{$col}{calculation};
 285                         $cols_hash{$col}=1 ;
 286                 }
 287         }
 288         my $urlbase="do_it=1&amp;".join("&amp;",map{"filter_$_=$$filters_hashref{$_}"} keys %$filters_hashref);
 289         foreach my $row (sort @loopline) {
 290                 my @loopcell;
 291                 #@loopcol ensures the order for columns is common with column titles
 292                 # and the number matches the number of columns
 293                 foreach my $col (sort keys %cols_hash) {
 294                         push @loopcell, {value =>( $$data{$row}{$col}{calculation} or ""),
 295         #                                               url_complement=>($urlbase=~/&amp;$/?$urlbase."&amp;":$urlbase)."filter_$linefield=$row&amp;filter_$colfield=$col"
 296                                                         }
 297                 }
 298                 push @looprow, {
 299                         'rowtitle_display' => display_value($linefield,$row),
 300                         'rowtitle' => $row,
 301                         'loopcell' => \@loopcell,
 302                         'totalrow' => $$data{$row}{totalrow}
 303                 };
 304         }
 305         for my $col ( sort keys %cols_hash ) {
 306                 my $total = 0;
 307                 foreach my $row (@loopline) {
 308                         $total += $data->{$row}{$col}{calculation} if $data->{$row}{$col}{calculation};
 309                         $debug and warn "value added ".$$data{$row}{$col}{calculation}. "for line ".$row;
 310                 }
 311                 push @loopfooter, {'totalcol' => $total};
 312                 push @loopcol, {'coltitle' => $col,
 313                                                 coltitle_display=>display_value($colfield,$col)};
 314         }
 315         # the header of the table
 316         $globalline{loopfilter}=\@loopfilter;
 317         # the core of the table
 318         $globalline{looprow} = \@looprow;
 319         $globalline{loopcol} = \@loopcol;
 320         #       # the foot (totals by borrower type)
 321         $globalline{loopfooter} = \@loopfooter;
 322         $globalline{total}  = $grantotal;
 323         $globalline{line}   = $linefield;
 324         $globalline{column} = $colfield;
 325         return [(\%globalline)];
 326 }
 327
 328 sub null_to_zzempty ($) {
 329         my $string = shift;
 330         defined($string)    or  return 'zzEMPTY';
 331         ($string eq "NULL") and return 'zzEMPTY';
 332         return $string;         # else return the valid value
 333 }
 334 sub display_value {
 335     my ( $crit, $value ) = @_;
 336     my $display_value =
 337         ( $crit =~ /ccode/ )         ? $ccodes->{$value}
 338       : ( $crit =~ /location/ )      ? $locations->{$value}
 339       : ( $crit =~ /itemtype/ )      ? $itemtypes->{$value}->{description}
 340       : ( $crit =~ /branch/ )        ? GetBranchName($value)
 341       : ( $crit =~ /reservestatus/ ) ? reservestatushuman($value)
 342       :                                $value;    # default fallback
 343     if ($crit =~ /sort1/) {
 344         foreach (@$Bsort1) {
 345             ($value eq $_->{authorised_value}) or next;
 346             $display_value = $_->{lib} and last;
 347         }
 348     }
 349     elsif ($crit =~ /sort2/) {
 350         foreach (@$Bsort2) {
 351             ($value eq $_->{authorised_value}) or next;
 352             $display_value = $_->{lib} and last;
 353         }
 354     }
 355     elsif ( $crit =~ /category/ ) {
 356         foreach (@$categoryloop) {
 357             ( $value eq $_->{categorycode} ) or next;
 358             $display_value = $_->{description} and last;
 359         }
 360     }
 361     return $display_value;
 362 }
 363 sub reservestatushuman{
 364         my ($val)=@_;
 365         my %hashhuman=(
 366         1=>"1- placed",
 367         2=>"2- processed",
 368         3=>"3- pending",
 369         4=>"4- satisfied",
 370         5=>"5- cancelled",
 371         6=>"6- not a status"
 372         );
 373         $hashhuman{$val};
 374 }
 375 sub changeifreservestatus{
 376         my ($val)=@_;
 377         ($val=~/reservestatus/
 378                 ?$val=qq{ case
 379                                         when priority>0 then 1
 380                                         when priority=0 then
 381                                                 (case
 382                                                    when found='f' then 4
 383                                                    when found='w' then
 384                                                    (case
 385                                                     when cancellationdate is null then 3
 386                                                         else 5
 387                                                         end )
 388                                                    else 2
 389                                                  end )
 390                                     else 6
 391                                         end }
 392                 :$val);
 393 }
 394 1;