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