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