Revert "Bug 28409: Comprehensively validate category in opac-shelves.pl"
[koha.git] / reports / bor_issues_top.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
22 use CGI qw ( -utf8 );
23 use C4::Auth;
24 use C4::Output;
25 use C4::Context;
26 use C4::Koha;
27 use C4::Circulation;
28 use C4::Members;
29 use C4::Reports;
30 use C4::Debug;
31
32 use Koha::DateUtils;
33 use Koha::ItemTypes;
34 use Koha::Patron::Categories;
35
36 =head1 NAME
37
38 plugin that shows a stats on borrowers
39
40 =head1 DESCRIPTION
41
42 =cut
43
44 $debug and open DEBUG, ">/tmp/bor_issues_top.debug.log";
45
46 my $input = new CGI;
47 my $fullreportname = "reports/bor_issues_top.tt";
48 my $do_it   = $input->param('do_it');
49 my $limit   = $input->param("Limit");
50 my $column  = $input->param("Criteria");
51 my @filters = $input->multi_param("Filter");
52 foreach ( @filters[0..3] ) {
53     $_ and $_ = eval { output_pref( { dt => dt_from_string ( $_ ), dateonly => 1, dateformat => 'iso' }); };
54 }
55 my $output   = $input->param("output");
56 my $basename = $input->param("basename");
57 my ($template, $borrowernumber, $cookie)
58     = get_template_and_user({template_name => $fullreportname,
59                 query => $input,
60                 type => "intranet",
61                 flagsrequired => {reports => '*'},
62                 debug => 1,
63                 });
64 our $sep     = $input->param("sep") || C4::Context->preference('delimiter') || ',';
65 $sep = "\t" if ($sep eq 'tabulation');
66 $template->param(do_it => $do_it,
67         );
68 if ($do_it) {
69 # Displaying results
70     my $results = calculate($limit, $column, \@filters);
71     if ($output eq "screen"){
72 # Printing results to screen
73         $template->param(mainloop => $results, limit=>$limit);
74         output_html_with_http_headers $input, $cookie, $template->output;
75     } else {
76 # Printing to a csv file
77         print $input->header(-type => 'application/vnd.sun.xml.calc',
78                             -encoding    => 'utf-8',
79                             -attachment=>"$basename.csv",
80                             -filename=>"$basename.csv" );
81         my $cols  = @$results[0]->{loopcol};
82         my $lines = @$results[0]->{looprow};
83 # header top-right
84         print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
85 # Other header
86                 print join($sep, map {$_->{coltitle}} @$cols);
87         print $sep . "Total\n";
88 # Table
89         foreach my $line ( @$lines ) {
90             my $x = $line->{loopcell};
91             print $line->{rowtitle}.$sep;
92                         print join($sep, map {$_->{value}} @$x);
93             print $sep,$line->{totalrow};
94             print "\n";
95         }
96 # footer
97         print "TOTAL";
98         $cols = @$results[0]->{loopfooter};
99                 print join($sep, map {$_->{totalcol}} @$cols);
100         print $sep.@$results[0]->{total};
101     }
102     exit;
103 }
104
105 my $dbh = C4::Context->dbh;
106 my @values;
107
108 # here each element returned by map is a hashref, get it?
109 my @mime  = ( map { {type =>$_} } (split /[;:]/, 'CSV') ); # FIXME translation
110 my $delims = GetDelimiterChoices;
111
112 my $patron_categories = Koha::Patron::Categories->search_limited({}, {order_by => ['categorycode']});
113 my $itemtypes = Koha::ItemTypes->search_with_localization;
114 $template->param(
115             mimeloop => \@mime,
116           CGIseplist => $delims,
117       itemtypes => $itemtypes,
118 patron_categories => $patron_categories,
119 );
120 output_html_with_http_headers $input, $cookie, $template->output;
121
122
123 sub calculate {
124     my ($limit, $column, $filters) = @_;
125
126     my @loopcol;
127     my @loopline;
128     my @looprow;
129     my %globalline;
130         my %columns;
131     my $grantotal =0;
132     my $dbh = C4::Context->dbh;
133
134
135 # Checking filters
136     my @loopfilter;
137         my @cellmap = (
138                 "Issue From",
139                 "Issue To",
140                 "Return From",
141                 "Return To",
142                 "Branch",
143                 "Doc Type",
144                 "Bor Cat",
145                 "Day",
146                 "Month",
147                 "Year"
148         );
149     for (my $i=0;$i<=6;$i++) {
150         my %cell;
151         if ( @$filters[$i] ) {
152             if (($i==1) and (@$filters[$i-1])) {
153                 $cell{err} = 1 if (@$filters[$i]<@$filters[$i-1]) ;
154             }
155             # format the dates filters, otherwise just fill as is
156             $cell{filter} .= @$filters[$i];
157                         defined ($cellmap[$i]) and
158                                 $cell{crit} .= $cellmap[$i];
159             push @loopfilter, \%cell;
160         }
161     }
162     my $colfield;
163     my $colorder;
164     if ($column){
165         $column = "old_issues." .$column if (($column=~/branchcode/) or ($column=~/timestamp/));
166         $column = "biblioitems.".$column if $column=~/itemtype/;
167         $column = "borrowers."  .$column if $column=~/categorycode/;
168         my @colfilter ;
169                 if ($column =~ /timestamp/) {
170                 $colfilter[0] = @$filters[0];
171                 $colfilter[1] = @$filters[1];
172                 } elsif ($column =~ /returndate/) {
173                 $colfilter[0] = @$filters[2];
174                 $colfilter[1] = @$filters[3];
175                 } elsif ($column =~ /branchcode/) {
176                         $colfilter[0] = @$filters[4];
177                 } elsif ($column =~ /itemtype/) {
178                         $colfilter[0] = @$filters[5];
179                 } elsif ($column =~ /category/) {
180                         $colfilter[0] = @$filters[6];
181                 } elsif ($column =~ /sort2/   ) {
182                         # $colfilter[0] = @$filters[11];
183                 }
184                                                 
185     # loop cols.
186         if ($column eq "Day") {
187             #Display by day
188             $column = "old_issues.timestamp";
189             $colfield .="dayname($column)";  
190             $colorder .="weekday($column)";
191         } elsif ($column eq "Month") {
192             #Display by Month
193             $column = "old_issues.timestamp";
194             $colfield .="monthname($column)";  
195             $colorder .="month($column)";  
196         } elsif ($column eq "Year") {
197             #Display by Year
198             $column = "old_issues.timestamp";
199             $colfield .="Year($column)";
200             $colorder .= $column;
201         } else {
202             $colfield .= $column;
203             $colorder .= $column;
204         }  
205
206         my $strsth2;
207         $strsth2 .= "SELECT DISTINCTROW $colfield 
208                      FROM `old_issues` 
209                      LEFT JOIN borrowers   ON old_issues.borrowernumber=borrowers.borrowernumber 
210                      LEFT JOIN items       ON old_issues.itemnumber=items.itemnumber 
211                      LEFT JOIN biblioitems ON (biblioitems.biblioitemnumber=items.biblioitemnumber)
212                      WHERE 1";
213         if (($column=~/timestamp/) or ($column=~/returndate/)){
214             if ($colfilter[1] and $colfilter[0]){
215                 $strsth2 .= " AND $column between '$colfilter[0]' AND '$colfilter[1]' " ;
216             } elsif ($colfilter[1]) {
217                 $strsth2 .= " AND $column < '$colfilter[1]' " ;
218             } elsif ($colfilter[0]) {
219                 $strsth2 .= " AND $column > '$colfilter[0]' " ;
220             }
221         } elsif ($colfilter[0]) {
222             $colfilter[0] =~ s/\*/%/g;
223             $strsth2 .= " AND $column LIKE '$colfilter[0]' " ;
224         }
225         $strsth2 .=" GROUP BY $colfield";
226         $strsth2 .=" ORDER BY $colorder";
227
228         $debug and print DEBUG "bor_issues_top (old_issues) SQL: $strsth2\n";
229         my $sth2 = $dbh->prepare($strsth2);
230         $sth2->execute;
231         print DEBUG "rows: ", $sth2->rows, "\n";
232         while (my @row = $sth2->fetchrow) {
233                         $columns{($row[0] ||'NULL')}++;
234             push @loopcol, { coltitle => $row[0] || 'NULL' };
235         }
236
237                 $strsth2 =~ s/old_issues/issues/g;
238         $debug and print DEBUG "bor_issues_top (issues) SQL: $strsth2\n";
239                 $sth2 = $dbh->prepare($strsth2);
240         $sth2->execute;
241         $debug and print DEBUG "rows: ", $sth2->rows, "\n";
242         while (my @row = $sth2->fetchrow) {
243                         $columns{($row[0] ||'NULL')}++;
244             push @loopcol, { coltitle => $row[0] || 'NULL' };
245         }
246                 $debug and print DEBUG "full array: ", Dumper(\%columns), "\n";
247     }else{
248         $columns{''} = 1;
249     }
250
251     my $strcalc ;
252
253 # Processing average loanperiods
254     $strcalc .= "SELECT  CONCAT_WS('', borrowers.surname , \",\\t\", borrowers.firstname),  COUNT(*) AS RANK, borrowers.borrowernumber AS ID";
255     $strcalc .= " , $colfield " if ($colfield);
256     $strcalc .= " FROM `old_issues`
257                   LEFT JOIN  borrowers  USING(borrowernumber)
258                   LEFT JOIN    items    USING(itemnumber)
259                   LEFT JOIN biblioitems USING(biblioitemnumber)
260                   WHERE old_issues.borrowernumber IS NOT NULL
261                   ";
262         my @filterterms = (
263                 'old_issues.issuedate >',
264                 'old_issues.issuedate <',
265                 'old_issues.returndate >',
266                 'old_issues.returndate <',
267                 'old_issues.branchcode  like',
268                 'biblioitems.itemtype   like',
269                 'borrowers.categorycode like',
270         );
271     foreach ((@$filters)[0..9]) {
272                 my $term = shift @filterterms;  # go through both arrays in step
273                 ($_) or next;
274                 s/\*/%/g;
275                 $strcalc .= " AND $term '$_' ";
276         }
277     $strcalc .= " GROUP BY borrowers.borrowernumber";
278     $strcalc .= ", $colfield" if ($column);
279     $strcalc .= " ORDER BY RANK DESC";
280     $strcalc .= ",$colfield " if ($colfield);
281     $strcalc .= " LIMIT $limit" if ($limit);
282
283     $debug and print DEBUG "(old_issues) SQL : $strcalc\n";
284     my $dbcalc = $dbh->prepare($strcalc);
285     $dbcalc->execute;
286     $debug and print DEBUG "rows: ", $dbcalc->rows, "\n";
287         my %patrons = ();
288         # DATA STRUCTURE is going to look like this:
289         #       (2253=> {name=>"John Doe",
290         #                               allcols=>{MAIN=>12, MEDIA_LIB=>3}
291         #                       },
292         #       )
293     while (my @data = $dbcalc->fetchrow) {
294         my ($row, $rank, $id, $col) = @data;
295         $col = "zzEMPTY" if (!defined($col));
296                 unless ($patrons{$id}) {
297                         $patrons{$id} = {name=>$row, allcols=>{}, newcols=>{}, oldcols=>{}};
298                 }
299                 $patrons{$id}->{oldcols}->{$col} = $rank;
300     }
301
302         use Data::Dumper;
303
304         $strcalc =~ s/old_issues/issues/g;
305     $debug and print DEBUG "(issues) SQL : $strcalc\n";
306     $dbcalc = $dbh->prepare($strcalc);
307     $dbcalc->execute;
308     $debug and print DEBUG "rows: ", $dbcalc->rows, "\n";
309     while (my @data = $dbcalc->fetchrow) {
310         my ($row, $rank, $id, $col) = @data;
311         $col = "zzEMPTY" if (!defined($col));
312                 unless ($patrons{$id}) {
313                         $patrons{$id} = {name=>$row, allcols=>{}, newcols=>{}, oldcols=>{}};
314                 }
315                 $patrons{$id}->{newcols}->{$col} = $rank;
316     }
317
318         foreach my $id (keys %patrons) {
319                 my @uniq = keys %{{ %{$patrons{$id}->{newcols}}, %{$patrons{$id}->{oldcols}} }};                # get uniq keys, see perlfaq4
320                 foreach (@uniq) {
321                         my $count = ($patrons{$id}->{newcols}->{$_} || 0) +
322                                                 ($patrons{$id}->{oldcols}->{$_} || 0);
323                         $patrons{$id}->{allcols}->{$_} = $count;
324                         $patrons{$id}->{total} += $count;
325                 }
326         }
327     $debug and print DEBUG "\n\npatrons: ", Dumper(\%patrons);
328     
329         my $i = 1;
330         my @cols_in_order = sort keys %columns;         # if you want to order the columns, do something here
331         my @ranked_ids = sort {
332                                                    $patrons{$b}->{total} <=> $patrons{$a}->{total}
333                                                 || $patrons{$a}->{name}  cmp $patrons{$b}->{name}
334                                                 } keys %patrons;
335     foreach my $id (@ranked_ids) {
336         my @loopcell;
337
338         foreach my $key (@cols_in_order) {
339                         if($column){
340                       push @loopcell, {
341                                 value => $patrons{$id}->{name},
342                                 reference => $id,
343                                 count => $patrons{$id}->{allcols}->{$key},
344                           };
345                         }else{
346                           push @loopcell, {
347                                 value => $patrons{$id}->{name},
348                                 reference => $id,
349                                 count => $patrons{$id}->{total},
350                           };  
351                         }
352         }
353         push @looprow,{ 'rowtitle' => $i++ ,
354                         'loopcell' => \@loopcell,
355                         'hilighted' => ($i%2),
356                     };
357         # use a limit, if a limit is defined
358         last if $i > $limit and $limit
359     }
360
361     # the header of the table
362     $globalline{loopfilter}=\@loopfilter;
363     # the core of the table
364     $globalline{looprow} = \@looprow;
365     $globalline{loopcol} = [ map {{coltitle=>$_}} @cols_in_order ];
366         # the foot (totals by borrower type)
367     $globalline{loopfooter} = [];
368     $globalline{total}= $grantotal;             # FIXME: useless
369     $globalline{column} = $column;
370     return [\%globalline];      # reference to a 1 element array: that element is a hashref
371 }
372
373 $debug and close DEBUG;
374 1;
375 __END__