fixing help feature with new template structure
[koha.git] / reports / borrowers_stats.pl
1 #!/usr/bin/perl
2
3 # $Id$
4
5 # Copyright 2000-2002 Katipo Communications
6 #
7 # This file is part of Koha.
8 #
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
12 # version.
13 #
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License along with
19 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
20 # Suite 330, Boston, MA  02111-1307 USA
21
22 use strict;
23 use CGI;
24 use C4::Auth;
25 use C4::Context;
26 use C4::Branch; # GetBranches
27 use C4::Koha;
28 use C4::Acquisition;
29 use C4::Output;
30 use C4::Circulation;
31 use Date::Calc qw(
32   Today
33   Add_Delta_YM
34   );
35
36 =head1 NAME
37
38 plugin that shows a stats on borrowers
39
40 =head1 DESCRIPTION
41
42 =over 2
43
44 =cut
45
46 my $input = new CGI;
47 my $do_it=$input->param('do_it');
48 my $fullreportname = "reports/borrowers_stats.tmpl";
49 my $line = $input->param("Line");
50 my $column = $input->param("Column");
51 my @filters = $input->param("Filter");
52 my $digits = $input->param("digits");
53 my $period = $input->param("period");
54 my $borstat = $input->param("status");
55 my $borstat1 = $input->param("activity");
56 my $output = $input->param("output");
57 my $basename = $input->param("basename");
58 my $mime = $input->param("MIME");
59 my $del = $input->param("sep");
60
61 my ($template, $borrowernumber, $cookie)
62         = get_template_and_user({template_name => $fullreportname,
63                                 query => $input,
64                                 type => "intranet",
65                                 authnotrequired => 0,
66                                 flagsrequired => {reports=> 1},
67                                 debug => 1,
68                                 });
69 $template->param(do_it => $do_it);
70 if ($do_it) {
71         my $results = calculate($line, $column, $digits, $borstat,$borstat1 ,\@filters);
72         if ($output eq "screen"){
73                 $template->param(mainloop => $results);
74                 output_html_with_http_headers $input, $cookie, $template->output;
75                 exit(1);
76         } else {
77                 print $input->header(-type => 'application/vnd.sun.xml.calc',
78                                      -encoding    => 'utf-8',
79                                      -name=>"$basename.csv",
80                                      -attachment=>"$basename.csv");
81                 my $cols = @$results[0]->{loopcol};
82                 my $lines = @$results[0]->{looprow};
83                 my $sep;
84                 $sep =C4::Context->preference("delimiter");
85                 print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
86                 foreach my $col ( @$cols ) {
87                         print $col->{coltitle}.$sep;
88                 }
89                 print "Total\n";
90                 foreach my $line ( @$lines ) {
91                         my $x = $line->{loopcell};
92                         print $line->{rowtitle}.$sep;
93                         foreach my $cell (@$x) {
94                                 print $cell->{value}.$sep;
95                         }
96                         print $line->{totalrow};
97                         print "\n";
98                 }
99                 print "TOTAL";
100                 $cols = @$results[0]->{loopfooter};
101                 foreach my $col ( @$cols ) {
102                         print $sep.$col->{totalcol};
103                 }
104                 print $sep.@$results[0]->{total};
105                 exit(1);
106         }
107 } else {
108         my $dbh = C4::Context->dbh;
109         my @values;
110         my %labels;
111         my $req;
112         $req = $dbh->prepare( "select categorycode, description from categories order by description");
113         $req->execute;
114         my %select_catcode;
115         my @select_catcode;
116         push @select_catcode,"";
117         $select_catcode{""} ="";
118         while (my ($catcode, $description) =$req->fetchrow) {
119                 push @select_catcode, $catcode;
120                 $select_catcode{$catcode} = $description;
121         }
122         my $CGICatCode=CGI::scrolling_list( -name     => 'Filter',
123                                 -id => 'Filter',
124                                 -values   => \@select_catcode,
125                                 -labels   => \%select_catcode,
126                                 -size     => 1,
127                                 -multiple => 0 );
128
129         
130 my $branches = GetBranches;
131 my @branchloop;
132 my @select_branch;
133 #my %select_branches;
134 push @select_branch,"";
135 #$select_branches{""}="";
136 foreach my $thisbranch (keys %$branches) {
137         push @select_branch,$thisbranch;
138    # my $selected = 1 if $thisbranch eq $branch;
139     my %row =(value => $thisbranch,
140 #                selected => $selected,
141                 branchname => $branches->{$thisbranch}->{'branchname'},
142             );
143     push @branchloop, \%row;
144 }
145     my $CGIBranch=CGI::scrolling_list( -name     => 'Filter',
146                              -id => 'Filter',
147                              -values   => \@select_branch,
148 #                             -labels   => \%select_branches,
149                              -size     => 1,
150                              -multiple => 0 );
151
152
153         $req = $dbh->prepare( "select distinctrow zipcode from borrowers order by zipcode");
154         $req->execute;
155         my @select_zipcode;
156         push @select_zipcode,"";
157         while (my ($value) =$req->fetchrow) {
158                 if ($value) {
159                         push @select_zipcode, $value;
160                 }
161         }
162
163         my $CGIZipCode=CGI::scrolling_list( -name     => 'Filter',
164                                 -id => 'Filter',
165                                 -values   => \@select_zipcode,
166                                 -size     => 1,
167                                 -multiple => 0 );
168
169
170         $req = $dbh->prepare( "SELECT authorised_value,lib FROM authorised_values WHERE category='Bsort1' order by lib");
171         $req->execute;
172         my @select_sort1;
173         my %select_sort1;
174         push @select_sort1,"";
175         $select_sort1{""}="";
176         my $hassort1;
177         while (my ($auth_value,$lib) =$req->fetchrow) {
178                 if ($auth_value) {
179                         $hassort1=1;
180                         push @select_sort1, $auth_value;
181                         $select_sort1{$auth_value}=$lib
182                 }
183         }
184
185         my $CGIsort1=CGI::scrolling_list( -name     => 'Filter',
186                                 -id => 'Filter',
187                                 -values   => \@select_sort1,
188                                 -labels =>\%select_sort1,
189                                 -size     => 1,
190                                 -multiple => 0 );
191         
192         $req = $dbh->prepare( "select distinctrow sort2 from borrowers order by sort2");
193         $req->execute;
194         my @select_sort2;
195         push @select_sort2,"";
196         my $hassort2;
197         while (my ($value) =$req->fetchrow) {
198                 if ($value) {
199                         $hassort2 = 1;
200                         push @select_sort2, $value;
201                 }
202         }
203         my $CGIsort2=CGI::scrolling_list( -name     => 'Filter',
204                                 -id => 'Filter',
205                                 -values   => \@select_sort2,
206                                 -size     => 1,
207                                 -multiple => 0 );
208         
209         my @mime = ( C4::Context->preference("MIME") );
210         foreach my $mime (@mime){
211                 warn "".$mime;
212         }
213         
214         my $CGIextChoice=CGI::scrolling_list(
215                                 -name => 'MIME',
216                                 -id => 'MIME',
217                                 -values   => \@mime,
218                                 -size     => 1,
219                                 -multiple => 0 );
220         
221         my @dels = ( C4::Context->preference("delimiter") );
222         my $CGIsepChoice=CGI::scrolling_list(
223                                 -name => 'sep',
224                                 -id => 'sep',
225                                 -values   => \@dels,
226                                 -size     => 1,
227                                 -multiple => 0 );
228
229         $template->param(               CGICatCode => $CGICatCode,
230                                         CGIZipCode => $CGIZipCode,
231 #                                       CGIBranch => $CGIBranch,
232                                         CGISort1 => $CGIsort1,
233                                         hassort1 => $hassort1,
234                                         CGISort2 => $CGIsort2,
235                                         hassort2 => $hassort2,
236                                         CGIextChoice => $CGIextChoice,
237                                         CGIsepChoice => $CGIsepChoice,
238                                         CGIBranch => $CGIBranch
239 #                                       CGIBranch => \@branchloop
240                                         );
241
242 }
243 output_html_with_http_headers $input, $cookie, $template->output;
244
245
246
247 sub calculate {
248         my ($line, $column, $digits, $status, $activity, $filters) = @_;
249         my @mainloop;
250         my @loopfooter;
251         my @loopcol;
252         my @loopline;
253         my @looprow;
254         my %globalline;
255         my $grantotal =0;
256 # extract parameters
257         my $dbh = C4::Context->dbh;
258
259 # Filters
260         my $linefilter = "";
261 #       warn "filtres ".@filters[0];
262 #       warn "filtres ".@filters[4];
263 #       warn "filtres ".@filters[5];
264 #       warn "filtres ".@filters[6];
265
266         
267         $linefilter = @$filters[0] if ($line =~ /categorycode/ )  ;
268         $linefilter = @$filters[1] if ($line =~ /zipcode/ )  ;
269         $linefilter = @$filters[2] if ($line =~ /branchcode/ ) ;
270         $linefilter = @$filters[5] if ($line =~ /sort1/ ) ;
271         $linefilter = @$filters[6] if ($line =~ /sort2/ ) ;
272
273         my $colfilter = "";
274         $colfilter = @$filters[0] if ($column =~ /categorycode/);
275         $colfilter = @$filters[1] if ($column =~ /zipcode/);
276         $colfilter = @$filters[2] if ($column =~ /branchcode/);
277         $colfilter = @$filters[5] if ($column =~ /sort1/);
278         $colfilter = @$filters[6] if ($column =~ /sort2/);
279
280         my @loopfilter;
281         for (my $i=0;$i<=6;$i++) {
282                 my %cell;
283                 if ( @$filters[$i] ) {
284                         $cell{filter} .= @$filters[$i];
285                         $cell{crit} .="Cat Code " if ($i==0);
286                         $cell{crit} .="Zip Code" if ($i==1);
287                         $cell{crit} .="Branchcode" if ($i==2);
288                         $cell{crit} .="Date of Birth" if ($i==3);
289                         $cell{crit} .="Date of Birth" if ($i==4);
290                         $cell{crit} .="Sort1" if ($i==5);
291                         $cell{crit} .="Sort2" if ($i==6);
292                         push @loopfilter, \%cell;
293                 }
294         }
295         if ($status) {
296                 push @loopfilter,{crit=>"Status",filter=>$status}
297         }
298                 
299         if ($activity) {
300                 push @loopfilter,{crit=>"Activity",filter=>$activity};
301         }
302 # year of activity
303         my ( $period_year, $period_month, $period_day )=Add_Delta_YM( Today(),-$period, 0);
304         my $newperioddate=$period_year."-".$period_month."-".$period_day;
305 #       warn "PERIOD".$period;
306 # 1st, loop rows.
307         my $linefield;
308         if (($line =~/zipcode/) and ($digits)) {
309                 $linefield .="left($line,$digits)";
310         } else{
311                 $linefield .= $line;
312         }
313         
314         my $strsth;
315         $strsth .= "select distinctrow $linefield from borrowers where $line is not null ";
316         $linefilter =~ s/\*/%/g;
317         if ( $linefilter ) {
318                 $strsth .= " and $linefield LIKE ? " ;
319         }
320         $strsth .= " and $status='1' " if ($status);
321         $strsth .=" order by $linefield";
322 #       warn "". $strsth;
323         
324         my $sth = $dbh->prepare( $strsth );
325         if ( $linefilter ) {
326                 $sth->execute($linefilter);
327         } else {
328                 $sth->execute;
329         }
330         while ( my ($celvalue) = $sth->fetchrow) {
331                 my %cell;
332                 if ($celvalue) {
333                         $cell{rowtitle} = $celvalue;
334 #               } else {
335 #                       $cell{rowtitle} = "";
336                 }
337                 $cell{totalrow} = 0;
338                 push @loopline, \%cell;
339         }
340
341 # 2nd, loop cols.
342         my $colfield;
343         if (($column =~/zipcode/) and ($digits)) {
344                 $colfield .= "left($column,$digits)";
345         } else{
346                 $colfield .= $column;
347         }
348         my $strsth2;
349         $colfilter =~ s/\*/%/g;
350         $strsth2 .= "select distinctrow $colfield from borrowers where $column is not null";
351         if ( $colfilter ) {
352                 $strsth2 .= " and $colfield LIKE ? ";
353         }
354         $strsth2 .= " and $status='1' " if ($status);
355         $strsth2 .= " order by $colfield";
356 #       warn "". $strsth2;
357         my $sth2 = $dbh->prepare( $strsth2 );
358         if ($colfilter) {
359                 $sth2->execute($colfilter);
360         } else {
361                 $sth2->execute;
362         }
363         while (my ($celvalue) = $sth2->fetchrow) {
364                 my %cell;
365                 my %ft;
366                 if ($celvalue) {
367                         $cell{coltitle} = $celvalue;
368                 }
369                 push @loopcol, \%cell;
370         }
371         
372
373         my $i=0;
374         my @totalcol;
375         my $hilighted=-1;
376         
377         #Initialization of cell values.....
378         my %table;
379 #       warn "init table";
380         foreach my $row ( @loopline ) {
381                 foreach my $col ( @loopcol ) {
382 #                       warn " init table : $row->{rowtitle} / $col->{coltitle} ";
383                         $table{$row->{rowtitle}}->{$col->{coltitle}}=0;
384                 }
385                 $table{$row->{rowtitle}}->{totalrow}=0;
386         }
387
388 # preparing calculation
389         my $strcalc .= "SELECT $linefield, $colfield, count( * ) FROM borrowers WHERE 1 ";
390         @$filters[0]=~ s/\*/%/g if (@$filters[0]);
391         $strcalc .= " AND categorycode like '" . @$filters[0] ."'" if ( @$filters[0] );
392         @$filters[1]=~ s/\*/%/g if (@$filters[1]);
393         $strcalc .= " AND zipcode like '" . @$filters[1] ."'" if ( @$filters[1] );
394         @$filters[2]=~ s/\*/%/g if (@$filters[2]);
395         $strcalc .= " AND branchcode like '" . @$filters[2] ."'" if ( @$filters[2] );
396         @$filters[3]=~ s/\*/%/g if (@$filters[3]);
397         $strcalc .= " AND dateofbirth > '" . @$filters[3] ."'" if ( @$filters[3] );
398         @$filters[4]=~ s/\*/%/g if (@$filters[4]);
399         $strcalc .= " AND dateofbirth < '" . @$filters[4] ."'" if ( @$filters[4] );
400         @$filters[5]=~ s/\*/%/g if (@$filters[5]);
401         $strcalc .= " AND sort1 like '" . @$filters[5] ."'" if ( @$filters[5] );
402         @$filters[6]=~ s/\*/%/g if (@$filters[6]);
403         $strcalc .= " AND sort2 like '" . @$filters[6] ."'" if ( @$filters[6] );
404         $strcalc .= " AND borrowernumber in (select distinct(borrowernumber) from issues where issuedate > '" . $newperioddate . "')" if ($activity eq 'active');
405         $strcalc .= " AND borrowernumber not in (select distinct(borrowernumber) from issues where issuedate > '" . $newperioddate . "')" if ($activity eq 'nonactive');
406         $strcalc .= " AND $status='1' " if ($status);
407         $strcalc .= " group by $linefield, $colfield";
408 #       warn "". $strcalc;
409         my $dbcalc = $dbh->prepare($strcalc);
410         $dbcalc->execute;
411 #       warn "filling table";
412         
413         my $emptycol; 
414         while (my ($row, $col, $value) = $dbcalc->fetchrow) {
415 #               warn "filling table $row / $col / $value ";
416                 $emptycol = 1 if ($col eq undef);
417                 $col = "zzEMPTY" if ($col eq undef);
418                 $row = "zzEMPTY" if ($row eq undef);
419                 
420                 $table{$row}->{$col}+=$value;
421                 $table{$row}->{totalrow}+=$value;
422                 $grantotal += $value;
423         }
424         
425         push @loopcol,{coltitle => "NULL"} if ($emptycol);
426         
427         foreach my $row ( sort keys %table ) {
428                 my @loopcell;
429                 #@loopcol ensures the order for columns is common with column titles
430                 # and the number matches the number of columns
431                 foreach my $col ( @loopcol ) {
432                         my $value =$table{$row}->{($col->{coltitle} eq "NULL")?"zzEMPTY":$col->{coltitle}};
433                         push @loopcell, {value => $value  } ;
434                 }
435                 push @looprow,{ 'rowtitle' => ($row eq "zzEMPTY")?"NULL":$row,
436                                                 'loopcell' => \@loopcell,
437                                                 'hilighted' => ($hilighted >0),
438                                                 'totalrow' => $table{$row}->{totalrow}
439                                         };
440                 $hilighted = -$hilighted;
441         }
442         
443         foreach my $col ( @loopcol ) {
444                 my $total=0;
445                 foreach my $row ( @looprow ) {
446                         $total += $table{($row->{rowtitle} eq "NULL")?"zzEMPTY":$row->{rowtitle}}->{($col->{coltitle} eq "NULL")?"zzEMPTY":$col->{coltitle}};
447 #                       warn "value added ".$table{$row->{rowtitle}}->{$col->{coltitle}}. "for line ".$row->{rowtitle};
448                 }
449 #               warn "summ for column ".$col->{coltitle}."  = ".$total;
450                 push @loopfooter, {'totalcol' => $total};
451         }
452                         
453
454         # the header of the table
455         $globalline{loopfilter}=\@loopfilter;
456         # the core of the table
457         $globalline{looprow} = \@looprow;
458         $globalline{loopcol} = \@loopcol;
459 #       # the foot (totals by borrower type)
460         $globalline{loopfooter} = \@loopfooter;
461         $globalline{total}= $grantotal;
462         $globalline{line} = $line;
463         $globalline{column} = $column;
464         push @mainloop,\%globalline;
465         return \@mainloop;
466 }
467