Bug 15758: Koha::Libraries - Remove GetBranchesLoop
[koha.git] / reports / borrowers_stats.pl
1 #!/usr/bin/perl
2
3 # Copyright 2000-2002 Katipo Communications
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 Modern::Perl;
21 use CGI qw ( -utf8 );
22 use List::MoreUtils qw/uniq/;
23
24 use C4::Auth;
25 use C4::Context;
26 use C4::Branch; # GetBranches
27 use C4::Koha;
28 use Koha::DateUtils;
29 use C4::Acquisition;
30 use C4::Output;
31 use C4::Reports;
32 use C4::Circulation;
33 use C4::Members::AttributeTypes;
34
35 use Koha::Patron::Categories;
36
37 use Date::Calc qw(
38   Today
39   Add_Delta_YM
40   );
41
42 =head1 NAME
43
44 plugin that shows a stats on borrowers
45
46 =head1 DESCRIPTION
47
48 =cut
49
50 my $input = new CGI;
51 my $do_it=$input->param('do_it');
52 my $fullreportname = "reports/borrowers_stats.tt";
53 my $line = $input->param("Line");
54 my $column = $input->param("Column");
55 my @filters = $input->multi_param("Filter");
56 $filters[3] = eval { output_pref( { dt => dt_from_string( $filters[3]), dateonly => 1, dateformat => 'iso' } ); }
57     if ( $filters[3] );
58 $filters[4] = eval { output_pref ({ dt => dt_from_string( $filters[4]), dateonly => 1, dateformat => 'iso' } ); }
59     if ( $filters[4] );
60 my $digits = $input->param("digits");
61 our $period = $input->param("period");
62 my $borstat = $input->param("status");
63 my $borstat1 = $input->param("activity");
64 my $output = $input->param("output");
65 my $basename = $input->param("basename");
66 our $sep     = $input->param("sep");
67 $sep = "\t" if ($sep and $sep eq 'tabulation');
68
69 my ($template, $borrowernumber, $cookie)
70         = get_template_and_user({template_name => $fullreportname,
71                                 query => $input,
72                                 type => "intranet",
73                                 authnotrequired => 0,
74                                 flagsrequired => {reports => '*'},
75                                 debug => 1,
76                                 });
77 $template->param(do_it => $do_it);
78 if ($do_it) {
79         my $attributes;
80         if (C4::Context->preference('ExtendedPatronAttributes')) {
81             $attributes = parse_extended_patron_attributes($input);
82         }
83         my $results = calculate($line, $column, $digits, $borstat,$borstat1 ,\@filters, $attributes);
84         if ($output eq "screen"){
85                 $template->param(mainloop => $results);
86                 output_html_with_http_headers $input, $cookie, $template->output;
87         } else {
88                 print $input->header(-type => 'application/vnd.sun.xml.calc',
89                          -encoding => 'utf-8',
90                              -name => "$basename.csv",
91                        -attachment => "$basename.csv");
92                 my $cols = @$results[0]->{loopcol};
93                 my $lines = @$results[0]->{looprow};
94                 print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
95                 foreach my $col ( @$cols ) {
96                         print $col->{coltitle}.$sep;
97                 }
98                 print "Total\n";
99                 foreach my $line ( @$lines ) {
100                         my $x = $line->{loopcell};
101                         print $line->{rowtitle}.$sep;
102                         foreach my $cell (@$x) {
103                                 print $cell->{value}.$sep;
104                         }
105                         print $line->{totalrow};
106                         print "\n";
107                 }
108                 print "TOTAL";
109                 $cols = @$results[0]->{loopfooter};
110                 foreach my $col ( @$cols ) {
111                         print $sep.$col->{totalcol};
112                 }
113                 print $sep.@$results[0]->{total};
114         }
115         exit;   # exit after do_it, regardless
116 } else {
117         my $dbh = C4::Context->dbh;
118         my $req;
119     my $patron_categories = Koha::Patron::Categories->search({}, {order_by => ['description']});
120     $template->param( patron_categories => $patron_categories );
121         $req = $dbh->prepare("SELECT DISTINCTROW zipcode FROM borrowers WHERE zipcode IS NOT NULL AND zipcode <> '' ORDER BY zipcode");
122         $req->execute;
123         $template->param(   ZIP_LOOP => $req->fetchall_arrayref({}));
124         $req = $dbh->prepare("SELECT authorised_value,lib FROM authorised_values WHERE category='Bsort1' ORDER BY lib");
125         $req->execute;
126         $template->param( SORT1_LOOP => $req->fetchall_arrayref({}));
127         $req = $dbh->prepare("SELECT DISTINCTROW sort2 AS value FROM borrowers WHERE sort2 IS NOT NULL AND sort2 <> '' ORDER BY sort2 LIMIT 200");
128                 # More than 200 items in a dropdown is not going to be useful anyway, and w/ 50,000 patrons we can destory DB performance.
129         $req->execute;
130         $template->param( SORT2_LOOP => $req->fetchall_arrayref({}));
131         
132     my $CGIextChoice = ( 'CSV' ); # FIXME translation
133         my $CGIsepChoice=GetDelimiterChoices;
134         $template->param(
135                 CGIextChoice => $CGIextChoice,
136                 CGIsepChoice => $CGIsepChoice,
137     );
138     if (C4::Context->preference('ExtendedPatronAttributes')) {
139         $template->param(ExtendedPatronAttributes => 1);
140         patron_attributes_form($template);
141     }
142 }
143 output_html_with_http_headers $input, $cookie, $template->output;
144
145 sub calculate {
146         my ($line, $column, $digits, $status, $activity, $filters, $attr_filters) = @_;
147
148         my @mainloop;
149         my @loopfooter;
150         my @loopcol;
151         my @loopline;
152         my @looprow;
153         my %globalline;
154         my $grantotal =0;
155 # extract parameters
156         my $dbh = C4::Context->dbh;
157
158     # check parameters
159     my @valid_names = qw(categorycode zipcode branchcode sex sort1 sort2);
160     my @attribute_types = C4::Members::AttributeTypes::GetAttributeTypes;
161     if ($line =~ /^patron_attr\.(.*)/) {
162         my $attribute_type = $1;
163         return unless (grep {$attribute_type eq $_->{code}} @attribute_types);
164     } else {
165         return unless (grep /^$line$/, @valid_names);
166     }
167     if ($column =~ /^patron_attr\.(.*)/) {
168         my $attribute_type = $1;
169         return unless (grep {$attribute_type eq $_->{code}} @attribute_types);
170     } else {
171         return unless (grep /^$column$/, @valid_names);
172     }
173     return if ($digits and $digits !~ /^\d+$/);
174     return if ($status and (grep /^$status$/, qw(debarred gonenoaddress lost)) == 0);
175     return if ($activity and (grep /^$activity$/, qw(active nonactive)) == 0);
176
177     # Filters
178     my $linefilter;
179     if    ( $line =~ /categorycode/ ) { $linefilter = @$filters[0]; }
180     elsif ( $line =~ /zipcode/ )      { $linefilter = @$filters[1]; }
181     elsif ( $line =~ /branchcode/ )   { $linefilter = @$filters[2]; }
182     elsif ( $line =~ /sex/ )          { $linefilter = @$filters[5]; }
183     elsif ( $line =~ /sort1/ )        { $linefilter = @$filters[6]; }
184     elsif ( $line =~ /sort2/ )        { $linefilter = @$filters[7]; }
185     elsif ( $line =~ /^patron_attr\.(.*)$/ ) { $linefilter = $attr_filters->{$1}; }
186     else  { $linefilter = ''; }
187
188     my $colfilter;
189     if    ( $column =~ /categorycode/ ) { $colfilter = @$filters[0]; }
190     elsif ( $column =~ /zipcode/ )      { $colfilter = @$filters[1]; }
191     elsif ( $column =~ /branchcode/)    { $colfilter = @$filters[2]; }
192     elsif ( $column =~ /sex/)           { $colfilter = @$filters[5]; }
193     elsif ( $column =~ /sort1/)         { $colfilter = @$filters[6]; }
194     elsif ( $column =~ /sort2/)         { $colfilter = @$filters[7]; }
195     elsif ( $column =~ /^patron_attr\.(.*)$/) { $colfilter = $attr_filters->{$1}; }
196     else  { $colfilter = ''; }
197
198     my @loopfilter;
199     foreach my $i (0 .. scalar @$filters) {
200         my %cell;
201         if ( @$filters[$i] ) {
202             if ($i == 3 or $i == 4) {
203                 $cell{filter} = eval { output_pref( { dt => dt_from_string( @$filters[$i] ), dateonly => 1 }); }
204                     if ( @$filters[$i] );
205             } else {
206                 $cell{filter} = @$filters[$i];
207             }
208
209             if    ( $i == 0)  { $cell{crit} = "Cat code"; }
210             elsif ( $i == 1 ) { $cell{crit} = "ZIP/Postal code"; }
211             elsif ( $i == 2 ) { $cell{crit} = "Branch code"; }
212             elsif ( $i == 3 ||
213                     $i == 4 ) { $cell{crit} = "Date of birth"; }
214             elsif ( $i == 5 ) { $cell{crit} = "Sex"; }
215             elsif ( $i == 6 ) { $cell{crit} = "Sort1"; }
216             elsif ( $i == 7 ) { $cell{crit} = "Sort2"; }
217             else { $cell{crit} = "Unknown"; }
218
219             push @loopfilter, \%cell;
220         }
221     }
222     foreach my $type (keys %$attr_filters) {
223         if($attr_filters->{$type}) {
224             push @loopfilter, {
225                 crit => "Attribute $type",
226                 filter => $attr_filters->{$type}
227             }
228         }
229     }
230
231         ($status  ) and push @loopfilter,{crit=>"Status",  filter=>$status  };
232         ($activity) and push @loopfilter,{crit=>"Activity",filter=>$activity};
233         push @loopfilter,{debug=>1, crit=>"Branches",filter=>join(" ", sort keys %$branches)};
234         push @loopfilter,{debug=>1, crit=>"(line, column)", filter=>"($line,$column)"};
235 # year of activity
236         my ( $period_year, $period_month, $period_day )=Add_Delta_YM( Today(),-$period, 0);
237         my $newperioddate=$period_year."-".$period_month."-".$period_day;
238 # 1st, loop rows.
239         my $linefield;
240
241     my $line_attribute_type;
242     if ($line  =~/^patron_attr\.(.*)$/) {
243         $line_attribute_type = $1;
244         $line = 'borrower_attributes.attribute';
245     }
246
247     if (($line =~/zipcode/) and ($digits)) {
248         $linefield = "left($line,$digits)";
249     } else {
250         $linefield = $line;
251     }
252     my $patron_categories = Koha::Patron::Categories->search({}, {order_by => ['categorycode']});
253     push @loopfilter,
254         {
255             debug  => 1,
256             crit   => "Patron category",
257             filter => join( ", ", map { $_->categorycode . ' (' . ( $_->description || 'NO_DESCRIPTION' ) . ')' } $patron_categories->as_list ),
258         };
259
260     my $strsth;
261     my @strparams; # bind parameters for the query
262     if ($line_attribute_type) {
263         $strsth = "SELECT distinct attribute FROM borrower_attributes
264             WHERE attribute IS NOT NULL AND code=?";
265         push @strparams, $line_attribute_type;
266     } else {
267         $strsth = "SELECT distinctrow $linefield FROM borrowers
268             WHERE $line IS NOT NULL ";
269     }
270
271         $linefilter =~ s/\*/%/g;
272         if ( $linefilter ) {
273                 $strsth .= " AND $linefield LIKE ? " ;
274                 push @strparams, $linefilter;
275         }
276         $strsth .= " AND $status='1' " if ($status);
277     $strsth .=" order by $linefield";
278         
279         push @loopfilter, {sql=>1, crit=>"Query", filter=>$strsth};
280         my $sth = $dbh->prepare($strsth);
281     $sth->execute(@strparams);
282         while (my ($celvalue) = $sth->fetchrow) {
283                 my %cell;
284                 if ($celvalue) {
285                         $cell{rowtitle} = $celvalue;
286             $cell{rowtitle_display} = ($patron_categories->find($celvalue)->description || "$celvalue\*") if ($line eq 'categorycode');
287                 }
288                 $cell{totalrow} = 0;
289                 push @loopline, \%cell;
290         }
291
292 # 2nd, loop cols.
293         my $colfield;
294
295     my $column_attribute_type;
296     if ($column  =~/^patron_attr.(.*)$/) {
297         $column_attribute_type = $1;
298         $column = 'borrower_attributes.attribute';
299     }
300
301     if (($column =~/zipcode/) and ($digits)) {
302         $colfield = "left($column,$digits)";
303     } else {
304         $colfield = $column;
305     }
306
307     my $strsth2;
308     my @strparams2; # bind parameters for the query
309     if ($column_attribute_type) {
310         $strsth2 = "SELECT DISTINCT attribute FROM borrower_attributes
311             WHERE attribute IS NOT NULL AND code=?";
312         push @strparams2, $column_attribute_type;
313     } else {
314         $strsth2 = "SELECT DISTINCTROW $colfield FROM borrowers
315             WHERE $column IS NOT NULL";
316     }
317
318         if ($colfilter) {
319                 $colfilter =~ s/\*/%/g;
320                 $strsth2 .= " AND $colfield LIKE ? ";
321         push @strparams2, $colfield;
322         }
323         $strsth2 .= " AND $status='1' " if ($status);
324
325     $strsth2 .= " order by $colfield";
326         push @loopfilter, {sql=>1, crit=>"Query", filter=>$strsth2};
327         my $sth2 = $dbh->prepare($strsth2);
328     $sth2->execute(@strparams2);
329         while (my ($celvalue) = $sth2->fetchrow) {
330                 my %cell;
331              if (defined $celvalue) {
332                         $cell{coltitle} = $celvalue;
333                         # $cell{coltitle_display} = ($colfield eq 'branchcode') ? $branches->{$celvalue}->{branchname} : $celvalue;
334             $cell{coltitle_display} = $patron_categories->find($celvalue)->description if ($column eq 'categorycode');
335                 }
336                 push @loopcol, \%cell;
337         }
338
339         my $i=0;
340         #Initialization of cell values.....
341         my %table;
342 #       warn "init table";
343         foreach my $row (@loopline) {
344                 foreach my $col ( @loopcol ) {
345             my $rowtitle = $row->{rowtitle} // '';
346             my $coltitle = $row->{coltitle} // '';
347             $table{$rowtitle}->{$coltitle} = 0;
348                 }
349         $row->{rowtitle} ||= '';
350                 $table{$row->{rowtitle}}->{totalrow}=0;
351                 $table{$row->{rowtitle}}->{rowtitle_display} = $row->{rowtitle_display};
352         }
353
354     # preparing calculation
355     my $strcalc;
356     my @calcparams;
357     $strcalc = "SELECT ";
358     if ($line_attribute_type) {
359         $strcalc .= " attribute_$line_attribute_type.attribute AS line_attribute, ";
360     } else {
361         $strcalc .= " $linefield, ";
362     }
363     if ($column_attribute_type) {
364         $strcalc .= " attribute_$column_attribute_type.attribute AS column_attribute, ";
365     } else {
366         $strcalc .= " $colfield, ";
367     }
368
369     $strcalc .= " COUNT(*) FROM borrowers ";
370     foreach my $type (keys %$attr_filters) {
371         if (
372             ($line_attribute_type and $line_attribute_type eq $type)
373          or ($column_attribute_type and $column_attribute_type eq $type)
374          or ($attr_filters->{$type})
375         ) {
376             $strcalc .= " LEFT JOIN borrower_attributes AS attribute_$type
377                 ON (borrowers.borrowernumber = attribute_$type.borrowernumber
378                     AND attribute_$type.code = " . $dbh->quote($type) . ") ";
379         }
380     }
381     $strcalc .= " WHERE 1 ";
382
383         @$filters[0]=~ s/\*/%/g if (@$filters[0]);
384         $strcalc .= " AND categorycode like '" . @$filters[0] ."'" if ( @$filters[0] );
385         @$filters[1]=~ s/\*/%/g if (@$filters[1]);
386         $strcalc .= " AND zipcode like '" . @$filters[1] ."'" if ( @$filters[1] );
387         @$filters[2]=~ s/\*/%/g if (@$filters[2]);
388         $strcalc .= " AND branchcode like '" . @$filters[2] ."'" if ( @$filters[2] );
389         @$filters[3]=~ s/\*/%/g if (@$filters[3]);
390         $strcalc .= " AND dateofbirth > '" . @$filters[3] ."'" if ( @$filters[3] );
391         @$filters[4]=~ s/\*/%/g if (@$filters[4]);
392         $strcalc .= " AND dateofbirth < '" . @$filters[4] ."'" if ( @$filters[4] );
393     @$filters[5]=~ s/\*/%/g if (@$filters[5]);
394     $strcalc .= " AND sex like '" . @$filters[5] ."'" if ( @$filters[5] );
395     @$filters[6]=~ s/\*/%/g if (@$filters[6]);
396         $strcalc .= " AND sort1 like '" . @$filters[6] ."'" if ( @$filters[6] );
397         @$filters[7]=~ s/\*/%/g if (@$filters[7]);
398         $strcalc .= " AND sort2 like '" . @$filters[7] ."'" if ( @$filters[7] );
399
400     foreach my $type (keys %$attr_filters) {
401         if($attr_filters->{$type}) {
402             my $filter = $attr_filters->{$type};
403             $filter =~ s/\*/%/g;
404             $strcalc .= " AND attribute_$type.attribute LIKE '" . $filter . "' ";
405         }
406     }
407         $strcalc .= " AND borrowernumber in (select distinct(borrowernumber) from old_issues where issuedate > '" . $newperioddate . "')" if ($activity eq 'active');
408         $strcalc .= " AND borrowernumber not in (select distinct(borrowernumber) from old_issues where issuedate > '" . $newperioddate . "')" if ($activity eq 'nonactive');
409         $strcalc .= " AND $status='1' " if ($status);
410
411     $strcalc .= " GROUP BY ";
412     if ($line_attribute_type) {
413         $strcalc .= " line_attribute, ";
414     } else {
415         $strcalc .= " $linefield, ";
416     }
417     if ($column_attribute_type) {
418         $strcalc .= " column_attribute ";
419     } else {
420         $strcalc .= " $colfield ";
421     }
422
423         push @loopfilter, {sql=>1, crit=>"Query", filter=>$strcalc};
424         my $dbcalc = $dbh->prepare($strcalc);
425         (scalar(@calcparams)) ? $dbcalc->execute(@calcparams) : $dbcalc->execute();
426         
427         my $emptycol; 
428         while (my ($row, $col, $value) = $dbcalc->fetchrow) {
429 #               warn "filling table $row / $col / $value ";
430                 $emptycol = 1 if (!defined($col));
431                 $col = "zzEMPTY" if (!defined($col));
432                 $row = "zzEMPTY" if (!defined($row));
433                 
434                 $table{$row}->{$col}+=$value;
435                 $table{$row}->{totalrow}+=$value;
436                 $grantotal += $value;
437         }
438         
439         push @loopcol,{coltitle => "NULL"} if ($emptycol);
440         
441         foreach my $row (sort keys %table) {
442                 my @loopcell;
443                 #@loopcol ensures the order for columns is common with column titles
444                 # and the number matches the number of columns
445                 foreach my $col ( @loopcol ) {
446             my $coltitle = $col->{coltitle} // '';
447             $coltitle = $coltitle eq "NULL" ? "zzEMPTY" : $coltitle;
448                         my $value =$table{$row}->{$coltitle};
449                         push @loopcell, {value => $value};
450                 }
451                 push @looprow,{
452                         'rowtitle' => ($row eq "zzEMPTY")?"NULL":$row,
453                         'rowtitle_display' => $table{$row}->{rowtitle_display} || ($row eq "zzEMPTY" ? "NULL" : $row),
454                         'loopcell' => \@loopcell,
455                         'totalrow' => $table{$row}->{totalrow}
456                 };
457         }
458         
459         foreach my $col ( @loopcol ) {
460                 my $total=0;
461                 foreach my $row ( @looprow ) {
462             my $rowtitle = $row->{rowtitle} // '';
463             $rowtitle = ($rowtitle eq "NULL") ? "zzEMPTY" : $rowtitle;
464             my $coltitle = $col->{coltitle} // '';
465             $coltitle = ($coltitle eq "NULL") ? "zzEMPTY" : $coltitle;
466
467             $total += $table{$rowtitle}->{$coltitle} || 0;
468 #                       warn "value added ".$table{$row->{rowtitle}}->{$col->{coltitle}}. "for line ".$row->{rowtitle};
469                 }
470 #               warn "summ for column ".$col->{coltitle}."  = ".$total;
471                 push @loopfooter, {'totalcol' => $total};
472         }
473                         
474
475         # the header of the table
476         $globalline{loopfilter}=\@loopfilter;
477         # the core of the table
478         $globalline{looprow} = \@looprow;
479         $globalline{loopcol} = \@loopcol;
480 #       # the foot (totals by borrower type)
481         $globalline{loopfooter} = \@loopfooter;
482         $globalline{total}= $grantotal;
483         $globalline{line} = ($line_attribute_type) ? $line_attribute_type : $line;
484         $globalline{column} = ($column_attribute_type) ? $column_attribute_type : $column;
485         push @mainloop,\%globalline;
486         return \@mainloop;
487 }
488
489 sub parse_extended_patron_attributes {
490     my ($input) = @_;
491
492     my @params_names = $input->param;
493     my %attr;
494     foreach my $name (@params_names) {
495         if ($name =~ /^Filter_patron_attr\.(.*)$/) {
496             my $code = $1;
497             my $value = $input->param($name);
498             $attr{$code} = $value;
499         }
500     }
501
502     return \%attr;
503 }
504
505
506 sub patron_attributes_form {
507     my $template = shift;
508
509     my @types = C4::Members::AttributeTypes::GetAttributeTypes();
510
511     my %items_by_class;
512     foreach my $type (@types) {
513         my $attr_type = C4::Members::AttributeTypes->fetch($type->{code});
514         my $entry = {
515             class             => $attr_type->class(),
516             code              => $attr_type->code(),
517             description       => $attr_type->description(),
518             repeatable        => $attr_type->repeatable(),
519             category          => $attr_type->authorised_value_category(),
520             category_code     => $attr_type->category_code(),
521         };
522
523         my $newentry = { %$entry };
524         if ($attr_type->authorised_value_category()) {
525             $newentry->{use_dropdown} = 1;
526             $newentry->{auth_val_loop} = GetAuthorisedValues(
527                 $attr_type->authorised_value_category()
528             );
529         }
530         push @{ $items_by_class{ $attr_type->class() } }, $newentry;
531     }
532
533     my @attribute_loop;
534     foreach my $class ( sort keys %items_by_class ) {
535         my $lib = GetAuthorisedValueByCode( 'PA_CLASS', $class ) || $class;
536         push @attribute_loop, {
537             class => $class,
538             items => $items_by_class{$class},
539             lib   => $lib,
540         };
541     }
542
543     $template->param(patron_attributes => \@attribute_loop);
544
545 }