From ce1ca4e3e7af62d58b9382211d29043794d240e7 Mon Sep 17 00:00:00 2001 From: Kyle M Hall Date: Fri, 19 Jul 2024 11:15:18 +0000 Subject: [PATCH] Bug 36547: (QA follow-up) Tidy overdue.pl Signed-off-by: Kyle M Hall --- circ/overdue.pl | 341 +++++++++++++++++++++++++----------------------- 1 file changed, 180 insertions(+), 161 deletions(-) diff --git a/circ/overdue.pl b/circ/overdue.pl index 8c4c6f12238..7c9e02eae40 100755 --- a/circ/overdue.pl +++ b/circ/overdue.pl @@ -1,6 +1,5 @@ #!/usr/bin/perl - # Copyright 2000-2002 Katipo Communications # Parts copyright 2010 BibLibre # @@ -22,32 +21,32 @@ use Modern::Perl; use C4::Context; use C4::Output qw( output_html_with_http_headers ); -use CGI qw(-oldstyle_urls -utf8); -use C4::Auth qw( get_template_and_user ); +use CGI qw(-oldstyle_urls -utf8); +use C4::Auth qw( get_template_and_user ); use Text::CSV_XS; use Koha::DateUtils qw( dt_from_string ); use Koha::Patron::Attribute::Types; use DateTime; use DateTime::Format::MySQL; -my $input = CGI->new; -my $showall = $input->param('showall'); -my $bornamefilter = $input->param('borname') || ''; -my $borcatfilter = $input->param('borcat') || ''; -my $itemtypefilter = $input->param('itemtype') || ''; -my $borflagsfilter = $input->param('borflag') || ''; -my $branchfilter = $input->param('branch') || ''; -my $homebranchfilter = $input->param('homebranch') || ''; +my $input = CGI->new; +my $showall = $input->param('showall'); +my $bornamefilter = $input->param('borname') || ''; +my $borcatfilter = $input->param('borcat') || ''; +my $itemtypefilter = $input->param('itemtype') || ''; +my $borflagsfilter = $input->param('borflag') || ''; +my $branchfilter = $input->param('branch') || ''; +my $homebranchfilter = $input->param('homebranch') || ''; my $holdingbranchfilter = $input->param('holdingbranch') || ''; -my $dateduefrom = $input->param('dateduefrom'); -my $datedueto = $input->param('datedueto'); -my $op = $input->param('op') || ''; +my $dateduefrom = $input->param('dateduefrom'); +my $datedueto = $input->param('datedueto'); +my $op = $input->param('op') || ''; -if ( $dateduefrom ) { - $dateduefrom = dt_from_string( $dateduefrom ); +if ($dateduefrom) { + $dateduefrom = dt_from_string($dateduefrom); } -if ( $datedueto ) { - $datedueto = dt_from_string( $datedueto )->set_hour(23)->set_minute(59); +if ($datedueto) { + $datedueto = dt_from_string($datedueto)->set_hour(23)->set_minute(59); } my $filters = { @@ -64,27 +63,27 @@ my $filters = { showall => $showall, }; -my $isfiltered = $op =~ /apply/i && $op =~ /filter/i; -my $noreport = C4::Context->preference('FilterBeforeOverdueReport') && ! $isfiltered && $op ne "csv"; +my $isfiltered = $op =~ /apply/i && $op =~ /filter/i; +my $noreport = C4::Context->preference('FilterBeforeOverdueReport') && !$isfiltered && $op ne "csv"; my ( $template, $loggedinuser, $cookie ) = get_template_and_user( { - template_name => "circ/overdue.tt", - query => $input, - type => "intranet", - flagsrequired => { circulate => "overdues_report" }, + template_name => "circ/overdue.tt", + query => $input, + type => "intranet", + flagsrequired => { circulate => "overdues_report" }, } ); -our $logged_in_user = Koha::Patrons->find( $loggedinuser ); +our $logged_in_user = Koha::Patrons->find($loggedinuser); my $dbh = C4::Context->dbh; my $req; -$req = $dbh->prepare( "select categorycode, description from categories order by description"); +$req = $dbh->prepare("select categorycode, description from categories order by description"); $req->execute; my @borcatloop; -while (my ($catcode, $description) =$req->fetchrow) { +while ( my ( $catcode, $description ) = $req->fetchrow ) { push @borcatloop, { value => $catcode, selected => $catcode eq $borcatfilter ? 1 : 0, @@ -92,10 +91,10 @@ while (my ($catcode, $description) =$req->fetchrow) { }; } -$req = $dbh->prepare( "select itemtype, description from itemtypes order by description"); +$req = $dbh->prepare("select itemtype, description from itemtypes order by description"); $req->execute; my @itemtypeloop; -while (my ($itemtype, $description) =$req->fetchrow) { +while ( my ( $itemtype, $description ) = $req->fetchrow ) { push @itemtypeloop, { value => $itemtype, selected => $itemtype eq $itemtypefilter ? 1 : 0, @@ -108,16 +107,17 @@ while (my ($itemtype, $description) =$req->fetchrow) { # %cgi_attrcode_to_attrvalues contains the patron attribute filter values, as returned by the CGI # %borrowernumber_to_attributes is populated by those borrowernumbers matching the patron attribute filters -my %cgi_attrcode_to_attrvalues; # ( patron_attribute_code => [ zero or more attribute filter values from the CGI ] ) -for my $attrcode (grep { /^patron_attr_filter_/ } $input->multi_param) { - if (my @attrvalues = grep { length($_) > 0 } $input->multi_param($attrcode)) { +my %cgi_attrcode_to_attrvalues; # ( patron_attribute_code => [ zero or more attribute filter values from the CGI ] ) +for my $attrcode ( grep { /^patron_attr_filter_/ } $input->multi_param ) { + if ( my @attrvalues = grep { length($_) > 0 } $input->multi_param($attrcode) ) { $attrcode =~ s/^patron_attr_filter_//; $cgi_attrcode_to_attrvalues{$attrcode} = \@attrvalues; } } my $have_pattr_filter_data = keys(%cgi_attrcode_to_attrvalues) > 0; -my @patron_attr_filter_loop; # array of [ domid cgivalue ismany isclone ordinal code description repeatable is_date authorised_value_category ] +my @patron_attr_filter_loop + ; # array of [ domid cgivalue ismany isclone ordinal code description repeatable is_date authorised_value_category ] my $patron_attrs = Koha::Patron::Attribute::Types->search_with_library_limits( { @@ -128,31 +128,36 @@ my $patron_attrs = Koha::Patron::Attribute::Types->search_with_library_limits( ); my $ordinal = 0; -while (my $attr = $patron_attrs->next ) { +while ( my $attr = $patron_attrs->next ) { my $row = { - code => $attr->code, - description => $attr->description, - repeatable => $attr->repeatable, - is_date => $attr->is_date, + code => $attr->code, + description => $attr->description, + repeatable => $attr->repeatable, + is_date => $attr->is_date, authorised_value_category => $attr->authorised_value_category, }; $row->{ordinal} = $ordinal; - my $code = $row->{code}; - my $cgivalues = $cgi_attrcode_to_attrvalues{$code} || [ '' ]; - my $isclone = 0; + my $code = $row->{code}; + my $cgivalues = $cgi_attrcode_to_attrvalues{$code} || ['']; + my $isclone = 0; $row->{ismany} = @$cgivalues > 1; my $serial = 0; for (@$cgivalues) { - $row->{domid} = $ordinal * 1000 + $serial; + $row->{domid} = $ordinal * 1000 + $serial; $row->{cgivalue} = $_; - $row->{isclone} = $isclone; - push @patron_attr_filter_loop, { %$row }; # careful: must store a *deep copy* of the modified row - } continue { $isclone = 1, ++$serial } -} continue { ++$ordinal } + $row->{isclone} = $isclone; + push @patron_attr_filter_loop, {%$row}; # careful: must store a *deep copy* of the modified row + } continue { + $isclone = 1, ++$serial; + } +} continue { + ++$ordinal; +} -my %borrowernumber_to_attributes; # hash of { borrowernumber => { attrcode => [ [val,display], [val,display], ... ] } } - # i.e. val differs from display when attr is an authorised value +my %borrowernumber_to_attributes; # hash of { borrowernumber => { attrcode => [ [val,display], [val,display], ... ] } } + # i.e. val differs from display when attr is an authorised value if (@patron_attr_filter_loop) { + # MAYBE FIXME: currently, *all* borrower_attributes are loaded into %borrowernumber_to_attributes # then filtered and honed down to match the patron attribute filters. If this is # too resource intensive, MySQL can be used to do the filtering, i.e. rewire the @@ -166,22 +171,23 @@ if (@patron_attr_filter_loop) { }; my $sth = $dbh->prepare($sql); $sth->execute(); - while (my $row = $sth->fetchrow_hashref) { - my $pattrs = $borrowernumber_to_attributes{$row->{bn}} ||= { }; - push @{ $pattrs->{$row->{attrcode}} }, [ + while ( my $row = $sth->fetchrow_hashref ) { + my $pattrs = $borrowernumber_to_attributes{ $row->{bn} } ||= {}; + push @{ $pattrs->{ $row->{attrcode} } }, [ $row->{attrval}, defined $row->{avdescription} ? $row->{avdescription} : $row->{attrval}, ]; } - for my $bn (keys %borrowernumber_to_attributes) { + for my $bn ( keys %borrowernumber_to_attributes ) { my $pattrs = $borrowernumber_to_attributes{$bn}; - my $keep = 1; - for my $code (keys %cgi_attrcode_to_attrvalues) { + my $keep = 1; + for my $code ( keys %cgi_attrcode_to_attrvalues ) { + # discard patrons that do not match (case insensitive) at least one of each attribute filter value my $discard = 1; - for my $attrval (map { lc $_ } @{ $cgi_attrcode_to_attrvalues{$code} }) { - if (grep { $attrval eq lc($_->[0]) } @{ $pattrs->{$code} }) { + for my $attrval ( map { lc $_ } @{ $cgi_attrcode_to_attrvalues{$code} } ) { + if ( grep { $attrval eq lc( $_->[0] ) } @{ $pattrs->{$code} } ) { $discard = 0; last; } @@ -195,20 +201,22 @@ if (@patron_attr_filter_loop) { } } - $template->param( - patron_attr_header_loop => [ map { { header => $_->{description} } } grep { ! $_->{isclone} } @patron_attr_filter_loop ], - filters => $filters, - borcatloop=> \@borcatloop, - itemtypeloop => \@itemtypeloop, + patron_attr_header_loop => + [ map { { header => $_->{description} } } grep { !$_->{isclone} } @patron_attr_filter_loop ], + filters => $filters, + borcatloop => \@borcatloop, + itemtypeloop => \@itemtypeloop, patron_attr_filter_loop => \@patron_attr_filter_loop, - showall => $showall, + showall => $showall, ); if ($noreport) { + # la de dah ... page comes up presto-quicko - $template->param( noreport => $noreport ); + $template->param( noreport => $noreport ); } else { + # FIXME : the left joins + where clauses make the following SQL query really slow with large datasets :( # # FIX 1: use the table with the least rows as first in the join, second least second, etc @@ -216,15 +224,14 @@ if ($noreport) { # # FIX 2: ensure there are indexes for columns participating in the WHERE clauses, where feasible/reasonable - my $today_dt = dt_from_string(); - $today_dt->truncate(to => 'minute'); + $today_dt->truncate( to => 'minute' ); my $todaysdate = $today_dt->strftime('%Y-%m-%d %H:%M'); - $bornamefilter =~s/\*/\%/g; - $bornamefilter =~s/\?/\_/g; + $bornamefilter =~ s/\*/\%/g; + $bornamefilter =~ s/\?/\_/g; - my $strsth="SELECT date_due, + my $strsth = "SELECT date_due, borrowers.title as borrowertitle, borrowers.surname, borrowers.firstname, @@ -266,108 +273,119 @@ if ($noreport) { LEFT JOIN biblioitems ON (biblioitems.biblioitemnumber=items.biblioitemnumber) LEFT JOIN biblio ON (biblio.biblionumber=items.biblionumber ) LEFT JOIN return_claims ON (return_claims.borrowernumber=borrowers.borrowernumber AND return_claims.itemnumber=items.itemnumber) - WHERE 1=1 "; # placeholder, since it is possible that none of the additional - # conditions will be selected by user - $strsth.=" AND date_due < '" . $todaysdate . "' " unless ($showall or $datedueto); - $strsth.=" AND (borrowers.firstname like '".$bornamefilter."%' or borrowers.surname like '".$bornamefilter."%' or borrowers.cardnumber like '".$bornamefilter."%')" if($bornamefilter) ; - $strsth.=" AND borrowers.categorycode = '" . $borcatfilter . "' " if $borcatfilter; - if( $itemtypefilter ){ - if( C4::Context->preference('item-level_itypes') ){ - $strsth.=" AND items.itype = '" . $itemtypefilter . "' "; + WHERE 1=1 "; # placeholder, since it is possible that none of the additional + # conditions will be selected by user + $strsth .= " AND date_due < '" . $todaysdate . "' " unless ( $showall or $datedueto ); + $strsth .= + " AND (borrowers.firstname like '" + . $bornamefilter + . "%' or borrowers.surname like '" + . $bornamefilter + . "%' or borrowers.cardnumber like '" + . $bornamefilter . "%')" + if ($bornamefilter); + $strsth .= " AND borrowers.categorycode = '" . $borcatfilter . "' " if $borcatfilter; + + if ($itemtypefilter) { + if ( C4::Context->preference('item-level_itypes') ) { + $strsth .= " AND items.itype = '" . $itemtypefilter . "' "; } else { - $strsth.=" AND biblioitems.itemtype = '" . $itemtypefilter . "' "; + $strsth .= " AND biblioitems.itemtype = '" . $itemtypefilter . "' "; } } if ( $borflagsfilter eq 'gonenoaddress' ) { $strsth .= " AND borrowers.gonenoaddress <> 0"; - } - elsif ( $borflagsfilter eq 'debarred' ) { - $strsth .= " AND borrowers.debarred >= CURDATE()" ; - } - elsif ( $borflagsfilter eq 'lost') { + } elsif ( $borflagsfilter eq 'debarred' ) { + $strsth .= " AND borrowers.debarred >= CURDATE()"; + } elsif ( $borflagsfilter eq 'lost' ) { $strsth .= " AND borrowers.lost <> 0"; } - $strsth.=" AND borrowers.branchcode = '" . $branchfilter . "' " if $branchfilter; - $strsth.=" AND items.homebranch = '" . $homebranchfilter . "' " if $homebranchfilter; - $strsth.=" AND items.holdingbranch = '" . $holdingbranchfilter . "' " if $holdingbranchfilter; - $strsth.=" AND date_due >= ?" if $dateduefrom; - $strsth.=" AND date_due <= ?" if $datedueto; + $strsth .= " AND borrowers.branchcode = '" . $branchfilter . "' " if $branchfilter; + $strsth .= " AND items.homebranch = '" . $homebranchfilter . "' " if $homebranchfilter; + $strsth .= " AND items.holdingbranch = '" . $holdingbranchfilter . "' " if $holdingbranchfilter; + $strsth .= " AND date_due >= ?" if $dateduefrom; + $strsth .= " AND date_due <= ?" if $datedueto; + # restrict patrons (borrowers) to those matching the patron attribute filter(s), if any - my $bnlist = $have_pattr_filter_data ? join(',',keys %borrowernumber_to_attributes) : ''; + my $bnlist = $have_pattr_filter_data ? join( ',', keys %borrowernumber_to_attributes ) : ''; $strsth =~ s/WHERE 1=1/WHERE 1=1 AND borrowers.borrowernumber IN ($bnlist)/ if $bnlist; - $strsth =~ s/WHERE 1=1/WHERE 0=1/ if $have_pattr_filter_data && !$bnlist; # no match if no borrowers matched patron attrs - $strsth.=" ORDER BY date_due, surname, firstname"; - $template->param(sql=>$strsth); - my $sth=$dbh->prepare($strsth); + $strsth =~ s/WHERE 1=1/WHERE 0=1/ + if $have_pattr_filter_data && !$bnlist; # no match if no borrowers matched patron attrs + $strsth .= " ORDER BY date_due, surname, firstname"; + $template->param( sql => $strsth ); + my $sth = $dbh->prepare($strsth); $sth->execute( - ($dateduefrom ? DateTime::Format::MySQL->format_datetime($dateduefrom) : ()), - ($datedueto ? DateTime::Format::MySQL->format_datetime($datedueto) : ()), + ( $dateduefrom ? DateTime::Format::MySQL->format_datetime($dateduefrom) : () ), + ( $datedueto ? DateTime::Format::MySQL->format_datetime($datedueto) : () ), ); my @overduedata; - while (my $data = $sth->fetchrow_hashref) { + while ( my $data = $sth->fetchrow_hashref ) { # most of the overdue report data is linked to the database schema, i.e. things like borrowernumber and phone # but the patron attributes (patron_attr_value_loop) are unnormalised and varies dynamically from one db to the next - my $pattrs = $borrowernumber_to_attributes{$data->{borrowernumber}} || {}; # patron attrs for this borrower - # $pattrs is a hash { attrcode => [ [value,displayvalue], [value,displayvalue]... ] } + my $pattrs = $borrowernumber_to_attributes{ $data->{borrowernumber} } || {}; # patron attrs for this borrower + # $pattrs is a hash { attrcode => [ [value,displayvalue], [value,displayvalue]... ] } - my @patron_attr_value_loop; # template array [ {value=>v1}, {value=>v2} ... } ] - for my $pattr_filter (grep { ! $_->{isclone} } @patron_attr_filter_loop) { - my @displayvalues = map { $_->[1] } @{ $pattrs->{$pattr_filter->{code}} }; # grab second value from each subarray - push @patron_attr_value_loop, { value => join(', ', sort { lc $a cmp lc $b } @displayvalues) }; + my @patron_attr_value_loop; # template array [ {value=>v1}, {value=>v2} ... } ] + for my $pattr_filter ( grep { !$_->{isclone} } @patron_attr_filter_loop ) { + my @displayvalues = + map { $_->[1] } @{ $pattrs->{ $pattr_filter->{code} } }; # grab second value from each subarray + push @patron_attr_value_loop, { value => join( ', ', sort { lc $a cmp lc $b } @displayvalues ) }; } push @overduedata, { - patron => Koha::Patrons->find( $data->{borrowernumber} ), - duedate => $data->{date_due}, - borrowernumber => $data->{borrowernumber}, - cardnumber => $data->{cardnumber}, - borrowertitle => $data->{borrowertitle}, - surname => $data->{surname}, - firstname => $data->{firstname}, - streetnumber => $data->{streetnumber}, - streettype => $data->{streettype}, - address => $data->{address}, - address2 => $data->{address2}, - city => $data->{city}, - zipcode => $data->{zipcode}, - country => $data->{country}, - phone => $data->{phone}, - email => $data->{email}, - branchcode => $data->{branchcode}, - barcode => $data->{barcode}, - datelastborrowed => $data->{datelastborrowed}, - itemnum => $data->{itemnumber}, - issuedate => $data->{issuedate}, - biblionumber => $data->{biblionumber}, - title => $data->{title}, - subtitle => $data->{subtitle}, - part_number => $data->{part_number}, - part_name => $data->{part_name}, - author => $data->{author}, - homebranchcode => $data->{homebranch}, - holdingbranchcode => $data->{holdingbranch}, - location => $data->{location}, - itemcallnumber => $data->{itemcallnumber}, - replacementprice => $data->{replacementprice}, - itemnotes_nonpublic => $data->{itemnotes_nonpublic}, + patron => Koha::Patrons->find( $data->{borrowernumber} ), + duedate => $data->{date_due}, + borrowernumber => $data->{borrowernumber}, + cardnumber => $data->{cardnumber}, + borrowertitle => $data->{borrowertitle}, + surname => $data->{surname}, + firstname => $data->{firstname}, + streetnumber => $data->{streetnumber}, + streettype => $data->{streettype}, + address => $data->{address}, + address2 => $data->{address2}, + city => $data->{city}, + zipcode => $data->{zipcode}, + country => $data->{country}, + phone => $data->{phone}, + email => $data->{email}, + branchcode => $data->{branchcode}, + barcode => $data->{barcode}, + datelastborrowed => $data->{datelastborrowed}, + itemnum => $data->{itemnumber}, + issuedate => $data->{issuedate}, + biblionumber => $data->{biblionumber}, + title => $data->{title}, + subtitle => $data->{subtitle}, + part_number => $data->{part_number}, + part_name => $data->{part_name}, + author => $data->{author}, + homebranchcode => $data->{homebranch}, + holdingbranchcode => $data->{holdingbranch}, + location => $data->{location}, + itemcallnumber => $data->{itemcallnumber}, + replacementprice => $data->{replacementprice}, + itemnotes_nonpublic => $data->{itemnotes_nonpublic}, return_claim_created_on => $data->{return_claim_created_on}, - return_claim_id => $data->{return_claim_id}, - enumchron => $data->{enumchron}, - itemtype => $data->{itype}, - patron_attr_value_loop => \@patron_attr_value_loop, + return_claim_id => $data->{return_claim_id}, + enumchron => $data->{enumchron}, + itemtype => $data->{itype}, + patron_attr_value_loop => \@patron_attr_value_loop, }; } - if ($op eq 'csv') { - binmode(STDOUT, ":encoding(UTF-8)"); - my $csv = build_csv(\@overduedata); - print $input->header(-type => 'application/vnd.sun.xml.calc', - -encoding => 'utf-8', - -attachment=>"overdues.csv", - -filename=>"overdues.csv" ); + if ( $op eq 'csv' ) { + binmode( STDOUT, ":encoding(UTF-8)" ); + my $csv = build_csv( \@overduedata ); + print $input->header( + -type => 'application/vnd.sun.xml.calc', + -encoding => 'utf-8', + -attachment => "overdues.csv", + -filename => "overdues.csv" + ); print $csv; exit; } @@ -377,22 +395,21 @@ if ($noreport) { $new_cgi->delete('op'); $template->param( - todaysdate => $today_dt, - overdueloop => \@overduedata, - nnoverdue => scalar(@overduedata), - noverdue_is_plural => scalar(@overduedata) != 1, - noreport => $noreport, - isfiltered => $isfiltered, - borflag_gonenoaddress => $borflagsfilter eq 'gonenoaddress', - borflag_debarred => $borflagsfilter eq 'debarred', - borflag_lost => $borflagsfilter eq 'lost', + todaysdate => $today_dt, + overdueloop => \@overduedata, + nnoverdue => scalar(@overduedata), + noverdue_is_plural => scalar(@overduedata) != 1, + noreport => $noreport, + isfiltered => $isfiltered, + borflag_gonenoaddress => $borflagsfilter eq 'gonenoaddress', + borflag_debarred => $borflagsfilter eq 'debarred', + borflag_lost => $borflagsfilter eq 'lost', ); } output_html_with_http_headers $input, $cookie, $template->output; - sub build_csv { my $overdues = shift; @@ -402,20 +419,22 @@ sub build_csv { # build header ... my @keys = - qw ( duedate title author borrowertitle firstname surname phone barcode email address address2 zipcode city country - branchcode datelastissued itemcallnumber biblionumber borrowernumber itemnum issuedate replacementprice itemnotes_nonpublic streetnumber streettype); + qw ( duedate title author borrowertitle firstname surname phone barcode email address address2 zipcode city country + branchcode datelastissued itemcallnumber biblionumber borrowernumber itemnum issuedate replacementprice itemnotes_nonpublic streetnumber streettype); my $csv = Text::CSV_XS->new(); $csv->combine(@keys); push @lines, $csv->string(); - my @private_keys = qw( borrowertitle firstname surname phone email address address2 zipcode city country streetnumber streettype ); + my @private_keys = + qw( borrowertitle firstname surname phone email address address2 zipcode city country streetnumber streettype ); + # ... and rest of report - foreach my $overdue ( @{ $overdues } ) { + foreach my $overdue ( @{$overdues} ) { unless ( $logged_in_user->can_see_patron_infos( $overdue->{patron} ) ) { $overdue->{$_} = undef for @private_keys; } - push @lines, $csv->string() if $csv->combine(map { $overdue->{$_} } @keys); + push @lines, $csv->string() if $csv->combine( map { $overdue->{$_} } @keys ); } - return join("\n", @lines) . "\n"; + return join( "\n", @lines ) . "\n"; } -- 2.30.2