4 # Copyright 2000-2002 Katipo Communications
5 # Parts copyright 2010 BibLibre
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 use CGI qw(-oldstyle_urls -utf8);
30 use DateTime::Format::MySQL;
33 my $showall = $input->param('showall');
34 my $bornamefilter = $input->param('borname') || '';
35 my $borcatfilter = $input->param('borcat') || '';
36 my $itemtypefilter = $input->param('itemtype') || '';
37 my $borflagsfilter = $input->param('borflag') || '';
38 my $branchfilter = $input->param('branch') || '';
39 my $homebranchfilter = $input->param('homebranch') || '';
40 my $holdingbranchfilter = $input->param('holdingbranch') || '';
41 my $dateduefrom = $input->param('dateduefrom');
42 my $datedueto = $input->param('datedueto');
43 my $op = $input->param('op') || '';
46 $dateduefrom = dt_from_string( $dateduefrom );
49 $datedueto = dt_from_string( $datedueto )->set_hour(23)->set_minute(59);
53 itemtype => $itemtypefilter,
54 borname => $bornamefilter,
55 borcat => $borcatfilter,
56 itemtype => $itemtypefilter,
57 borflag => $borflagsfilter,
58 branch => $branchfilter,
59 homebranch => $homebranchfilter,
60 holdingbranch => $holdingbranchfilter,
61 dateduefrom => $dateduefrom,
62 datedueto => $datedueto,
65 my $isfiltered = $op =~ /apply/i && $op =~ /filter/i;
66 my $noreport = C4::Context->preference('FilterBeforeOverdueReport') && ! $isfiltered && $op ne "csv";
68 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
70 template_name => "circ/overdue.tt",
73 flagsrequired => { circulate => "overdues_report" },
77 our $logged_in_user = Koha::Patrons->find( $loggedinuser );
79 my $dbh = C4::Context->dbh;
82 $req = $dbh->prepare( "select categorycode, description from categories order by description");
85 while (my ($catcode, $description) =$req->fetchrow) {
88 selected => $catcode eq $borcatfilter ? 1 : 0,
89 catname => $description,
93 $req = $dbh->prepare( "select itemtype, description from itemtypes order by description");
96 while (my ($itemtype, $description) =$req->fetchrow) {
99 selected => $itemtype eq $itemtypefilter ? 1 : 0,
100 itemtypename => $description,
104 # Filtering by Patron Attributes
105 # @patron_attr_filter_loop is non empty if there are any patron attribute filters
106 # %cgi_attrcode_to_attrvalues contains the patron attribute filter values, as returned by the CGI
107 # %borrowernumber_to_attributes is populated by those borrowernumbers matching the patron attribute filters
109 my %cgi_attrcode_to_attrvalues; # ( patron_attribute_code => [ zero or more attribute filter values from the CGI ] )
110 for my $attrcode (grep { /^patron_attr_filter_/ } $input->multi_param) {
111 if (my @attrvalues = grep { length($_) > 0 } $input->multi_param($attrcode)) {
112 $attrcode =~ s/^patron_attr_filter_//;
113 $cgi_attrcode_to_attrvalues{$attrcode} = \@attrvalues;
116 my $have_pattr_filter_data = keys(%cgi_attrcode_to_attrvalues) > 0;
118 my @patron_attr_filter_loop; # array of [ domid cgivalue ismany isclone ordinal code description repeatable authorised_value_category ]
120 my $sth = $dbh->prepare('SELECT code,description,repeatable,authorised_value_category
121 FROM borrower_attribute_types
122 WHERE staff_searchable <> 0
123 ORDER BY description');
126 while (my $row = $sth->fetchrow_hashref) {
127 $row->{ordinal} = $ordinal;
128 my $code = $row->{code};
129 my $cgivalues = $cgi_attrcode_to_attrvalues{$code} || [ '' ];
131 $row->{ismany} = @$cgivalues > 1;
134 $row->{domid} = $ordinal * 1000 + $serial;
135 $row->{cgivalue} = $_;
136 $row->{isclone} = $isclone;
137 push @patron_attr_filter_loop, { %$row }; # careful: must store a *deep copy* of the modified row
138 } continue { $isclone = 1, ++$serial }
139 } continue { ++$ordinal }
141 my %borrowernumber_to_attributes; # hash of { borrowernumber => { attrcode => [ [val,display], [val,display], ... ] } }
142 # i.e. val differs from display when attr is an authorised value
143 if (@patron_attr_filter_loop) {
144 # MAYBE FIXME: currently, *all* borrower_attributes are loaded into %borrowernumber_to_attributes
145 # then filtered and honed down to match the patron attribute filters. If this is
146 # too resource intensive, MySQL can be used to do the filtering, i.e. rewire the
147 # SQL below to select only those attribute values that match the filters.
149 my $sql = q(SELECT borrowernumber AS bn, b.code, attribute AS val, category AS avcategory, lib AS avdescription
150 FROM borrower_attributes b
151 JOIN borrower_attribute_types bt ON (b.code = bt.code)
152 LEFT JOIN authorised_values a ON (a.category = bt.authorised_value_category AND a.authorised_value = b.attribute));
153 my $sth = $dbh->prepare($sql);
155 while (my $row = $sth->fetchrow_hashref) {
156 my $pattrs = $borrowernumber_to_attributes{$row->{bn}} ||= { };
157 push @{ $pattrs->{$row->{code}} }, [
159 defined $row->{avdescription} ? $row->{avdescription} : $row->{val},
163 for my $bn (keys %borrowernumber_to_attributes) {
164 my $pattrs = $borrowernumber_to_attributes{$bn};
166 for my $code (keys %cgi_attrcode_to_attrvalues) {
167 # discard patrons that do not match (case insensitive) at least one of each attribute filter value
169 for my $attrval (map { lc $_ } @{ $cgi_attrcode_to_attrvalues{$code} }) {
170 ## if (grep { $attrval eq lc($_->[0]) } @{ $pattrs->{$code} })
171 if (grep { $attrval eq lc($_->[1]) } @{ $pattrs->{$code} }) {
181 delete $borrowernumber_to_attributes{$bn} if !$keep;
187 patron_attr_header_loop => [ map { { header => $_->{description} } } grep { ! $_->{isclone} } @patron_attr_filter_loop ],
189 borcatloop=> \@borcatloop,
190 itemtypeloop => \@itemtypeloop,
191 patron_attr_filter_loop => \@patron_attr_filter_loop,
196 # la de dah ... page comes up presto-quicko
197 $template->param( noreport => $noreport );
199 # FIXME : the left joins + where clauses make the following SQL query really slow with large datasets :(
201 # FIX 1: use the table with the least rows as first in the join, second least second, etc
202 # ref: http://www.fiftyfoureleven.com/weblog/web-development/programming-and-scripts/mysql-optimization-tip
204 # FIX 2: ensure there are indexes for columns participating in the WHERE clauses, where feasible/reasonable
207 my $today_dt = dt_from_string();
208 $today_dt->truncate(to => 'minute');
209 my $todaysdate = $today_dt->strftime('%Y-%m-%d %H:%M');
211 $bornamefilter =~s/\*/\%/g;
212 $bornamefilter =~s/\?/\_/g;
214 my $strsth="SELECT date_due,
215 borrowers.title as borrowertitle,
218 borrowers.streetnumber,
219 borrowers.streettype,
227 borrowers.cardnumber,
228 borrowers.borrowernumber,
229 borrowers.branchcode,
238 items.itemcallnumber,
239 items.replacementprice,
241 items.itemnotes_nonpublic,
244 LEFT JOIN borrowers ON (issues.borrowernumber=borrowers.borrowernumber )
245 LEFT JOIN items ON (issues.itemnumber=items.itemnumber)
246 LEFT JOIN biblioitems ON (biblioitems.biblioitemnumber=items.biblioitemnumber)
247 LEFT JOIN biblio ON (biblio.biblionumber=items.biblionumber )
248 WHERE 1=1 "; # placeholder, since it is possible that none of the additional
249 # conditions will be selected by user
250 $strsth.=" AND date_due < '" . $todaysdate . "' " unless ($showall);
251 $strsth.=" AND (borrowers.firstname like '".$bornamefilter."%' or borrowers.surname like '".$bornamefilter."%' or borrowers.cardnumber like '".$bornamefilter."%')" if($bornamefilter) ;
252 $strsth.=" AND borrowers.categorycode = '" . $borcatfilter . "' " if $borcatfilter;
253 if( $itemtypefilter ){
254 if( C4::Context->preference('item-level_itypes') ){
255 $strsth.=" AND items.itype = '" . $itemtypefilter . "' ";
257 $strsth.=" AND biblioitems.itemtype = '" . $itemtypefilter . "' ";
260 if ( $borflagsfilter eq 'gonenoaddress' ) {
261 $strsth .= " AND borrowers.gonenoaddress <> 0";
263 elsif ( $borflagsfilter eq 'debarred' ) {
264 $strsth .= " AND borrowers.debarred >= CURDATE()" ;
266 elsif ( $borflagsfilter eq 'lost') {
267 $strsth .= " AND borrowers.lost <> 0";
269 $strsth.=" AND borrowers.branchcode = '" . $branchfilter . "' " if $branchfilter;
270 $strsth.=" AND items.homebranch = '" . $homebranchfilter . "' " if $homebranchfilter;
271 $strsth.=" AND items.holdingbranch = '" . $holdingbranchfilter . "' " if $holdingbranchfilter;
272 $strsth.=" AND date_due >= ?" if $dateduefrom;
273 $strsth.=" AND date_due <= ?" if $datedueto;
274 # restrict patrons (borrowers) to those matching the patron attribute filter(s), if any
275 my $bnlist = $have_pattr_filter_data ? join(',',keys %borrowernumber_to_attributes) : '';
276 $strsth =~ s/WHERE 1=1/WHERE 1=1 AND borrowers.borrowernumber IN ($bnlist)/ if $bnlist;
277 $strsth =~ s/WHERE 1=1/WHERE 0=1/ if $have_pattr_filter_data && !$bnlist; # no match if no borrowers matched patron attrs
278 $strsth.=" ORDER BY date_due, surname, firstname";
279 $template->param(sql=>$strsth);
280 my $sth=$dbh->prepare($strsth);
282 ($dateduefrom ? DateTime::Format::MySQL->format_datetime($dateduefrom) : ()),
283 ($datedueto ? DateTime::Format::MySQL->format_datetime($datedueto) : ()),
287 while (my $data = $sth->fetchrow_hashref) {
289 # most of the overdue report data is linked to the database schema, i.e. things like borrowernumber and phone
290 # but the patron attributes (patron_attr_value_loop) are unnormalised and varies dynamically from one db to the next
292 my $pattrs = $borrowernumber_to_attributes{$data->{borrowernumber}} || {}; # patron attrs for this borrower
293 # $pattrs is a hash { attrcode => [ [value,displayvalue], [value,displayvalue]... ] }
295 my @patron_attr_value_loop; # template array [ {value=>v1}, {value=>v2} ... } ]
296 for my $pattr_filter (grep { ! $_->{isclone} } @patron_attr_filter_loop) {
297 my @displayvalues = map { $_->[1] } @{ $pattrs->{$pattr_filter->{code}} }; # grab second value from each subarray
298 push @patron_attr_value_loop, { value => join(', ', sort { lc $a cmp lc $b } @displayvalues) };
302 patron => Koha::Patrons->find( $data->{borrowernumber} ),
303 duedate => $data->{date_due},
304 borrowernumber => $data->{borrowernumber},
305 cardnumber => $data->{cardnumber},
306 borrowertitle => $data->{borrowertitle},
307 surname => $data->{surname},
308 firstname => $data->{firstname},
309 streetnumber => $data->{streetnumber},
310 streettype => $data->{streettype},
311 address => $data->{address},
312 address2 => $data->{address2},
313 city => $data->{city},
314 zipcode => $data->{zipcode},
315 country => $data->{country},
316 phone => $data->{phone},
317 email => $data->{email},
318 branchcode => $data->{branchcode},
319 barcode => $data->{barcode},
320 itemnum => $data->{itemnumber},
321 issuedate => output_pref({ dt => dt_from_string( $data->{issuedate} ), dateonly => 1 }),
322 biblionumber => $data->{biblionumber},
323 title => $data->{title},
324 author => $data->{author},
325 homebranchcode => $data->{homebranch},
326 holdingbranchcode => $data->{holdingbranch},
327 itemcallnumber => $data->{itemcallnumber},
328 replacementprice => $data->{replacementprice},
329 itemnotes_nonpublic => $data->{itemnotes_nonpublic},
330 enumchron => $data->{enumchron},
331 itemtype => $data->{itype},
332 patron_attr_value_loop => \@patron_attr_value_loop,
337 binmode(STDOUT, ":encoding(UTF-8)");
338 my $csv = build_csv(\@overduedata);
339 print $input->header(-type => 'application/vnd.sun.xml.calc',
340 -encoding => 'utf-8',
341 -attachment=>"overdues.csv",
342 -filename=>"overdues.csv" );
347 # generate parameter list for CSV download link
348 my $new_cgi = CGI->new($input);
349 $new_cgi->delete('op');
352 todaysdate => output_pref($today_dt),
353 overdueloop => \@overduedata,
354 nnoverdue => scalar(@overduedata),
355 noverdue_is_plural => scalar(@overduedata) != 1,
356 noreport => $noreport,
357 isfiltered => $isfiltered,
358 borflag_gonenoaddress => $borflagsfilter eq 'gonenoaddress',
359 borflag_debarred => $borflagsfilter eq 'debarred',
360 borflag_lost => $borflagsfilter eq 'lost',
365 output_html_with_http_headers $input, $cookie, $template->output;
369 my $overdues = shift;
371 return "" if scalar(@$overdues) == 0;
377 qw ( duedate title author borrowertitle firstname surname phone barcode email address address2 zipcode city country
378 branchcode itemcallnumber biblionumber borrowernumber itemnum issuedate replacementprice itemnotes_nonpublic streetnumber streettype);
379 my $csv = Text::CSV_XS->new();
380 $csv->combine(@keys);
381 push @lines, $csv->string();
383 my @private_keys = qw( borrowertitle firstname surname phone email address address2 zipcode city country streetnumber streettype );
384 # ... and rest of report
385 foreach my $overdue ( @{ $overdues } ) {
386 unless ( $logged_in_user->can_see_patron_infos( $overdue->{patron} ) ) {
387 $overdue->{$_} = undef for @private_keys;
389 push @lines, $csv->string() if $csv->combine(map { $overdue->{$_} } @keys);
392 return join("\n", @lines) . "\n";