Bug 21796: Don't unlock checkouts if restriction exists but fines are below limit
[koha.git] / circ / circulation.pl
index ebb8d8b..98b011b 100755 (executable)
 # You should have received a copy of the GNU General Public License
 # along with Koha; if not, see <http://www.gnu.org/licenses>.
 
-use strict;
-use warnings;
+# FIXME There are too many calls to Koha::Patrons->find in this script
+
+use Modern::Perl;
 use CGI qw ( -utf8 );
 use DateTime;
 use DateTime::Duration;
+use Scalar::Util qw( looks_like_number );
 use C4::Output;
 use C4::Print;
 use C4::Auth qw/:DEFAULT get_session haspermission/;
@@ -44,13 +46,13 @@ use CGI::Session;
 use C4::Members::Attributes qw(GetBorrowerAttributes);
 use Koha::AuthorisedValues;
 use Koha::CsvProfiles;
-use Koha::Patron;
+use Koha::Patrons;
 use Koha::Patron::Debarments qw(GetDebarments);
 use Koha::DateUtils;
 use Koha::Database;
 use Koha::BiblioFrameworks;
+use Koha::Items;
 use Koha::Patron::Messages;
-use Koha::Patron::Images;
 use Koha::SearchEngine;
 use Koha::SearchEngine::Search;
 use Koha::Patron::Modifications;
@@ -82,6 +84,21 @@ if (!C4::Context->userenv){
 
 my $barcodes = [];
 my $barcode =  $query->param('barcode');
+my $findborrower;
+my $autoswitched;
+my $borrowernumber = $query->param('borrowernumber');
+
+if (C4::Context->preference("AutoSwitchPatron") && $barcode) {
+    if (Koha::Patrons->search( { cardnumber => $barcode} )->count() > 0) {
+        $findborrower = $barcode;
+        undef $barcode;
+        undef $borrowernumber;
+        $autoswitched = 1;
+    }
+}
+$findborrower ||= $query->param('findborrower') || q{};
+$findborrower =~ s|,| |g;
+
 # Barcode given by user could be '0'
 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
     $barcodes = [ $barcode ];
@@ -103,14 +120,14 @@ if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
 $barcodes = [ uniq @$barcodes ];
 
 my $template_name = q|circ/circulation.tt|;
-my $borrowernumber = $query->param('borrowernumber');
-my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
+my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
 my $batch = $query->param('batch');
 my $batch_allowed = 0;
 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
     $template_name = q|circ/circulation_batch_checkouts.tt|;
     my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
-    if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
+    my $categorycode = $patron->categorycode;
+    if ( $categorycode && grep {/^$categorycode$/} @batch_category_codes ) {
         $batch_allowed = 1;
     } else {
         $barcodes = [];
@@ -126,6 +143,7 @@ my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
         flagsrequired   => { circulate => 'circulate_remaining_permissions' },
     }
 );
+my $logged_in_user = Koha::Patrons->find( $loggedinuser ) or die "Not logged in";
 
 my $force_allow_issue = $query->param('forceallow') || 0;
 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
@@ -144,9 +162,6 @@ for (@failedreturns) { $return_failed{$_} = 1; }
 
 my $searchtype = $query->param('searchtype') || q{contain};
 
-my $findborrower = $query->param('findborrower') || q{};
-$findborrower =~ s|,| |g;
-
 my $branch = C4::Context->userenv->{'branch'};
 
 if (C4::Context->preference("DisplayClearScreenButton")) {
@@ -231,9 +246,9 @@ if ( $print eq 'yes' && $borrowernumber ne '' ) {
 #
 my $message;
 if ($findborrower) {
-    my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
-    if ( $borrower ) {
-        $borrowernumber = $borrower->{borrowernumber};
+    my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
+    if ( $patron ) {
+        $borrowernumber = $patron->borrowernumber;
     } else {
         my $dt_params = { iDisplayLength => -1 };
         my $results = C4::Utils::DataTables::Members::search(
@@ -258,13 +273,16 @@ if ($findborrower) {
 }
 
 # get the borrower information.....
-my $patron;
-if ($borrowernumber) {
-    $patron = Koha::Patrons->find( $borrowernumber );
-    $borrower = GetMember( borrowernumber => $borrowernumber );
+my $balance = 0;
+$patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
+if ($patron) {
+
+    $template->param( borrowernumber => $patron->borrowernumber );
+    output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
+
     my $overdues = $patron->get_overdues;
     my $issues = $patron->checkouts;
-    my $balance = $patron->account->balance;
+    $balance = $patron->account->balance;
 
 
     # if the expiry date is before today ie they have expired
@@ -279,7 +297,7 @@ if ($borrowernumber) {
     # check for NotifyBorrowerDeparture
     elsif ( $patron->is_going_to_expire ) {
         # borrower card soon to expire warn librarian
-        $template->param( "warndeparture" => $borrower->{dateexpiry} ,
+        $template->param( "warndeparture" => $patron->dateexpiry ,
                         );
         if (C4::Context->preference('ReturnBeforeExpiry')){
             $template->param("returnbeforeexpiry" => 1);
@@ -293,12 +311,12 @@ if ($borrowernumber) {
 
     if ( $patron and $patron->is_debarred ) {
         $template->param(
-            'userdebarred'    => $borrower->{debarred},
-            'debarredcomment' => $borrower->{debarredcomment},
+            'userdebarred'    => $patron->debarred,
+            'debarredcomment' => $patron->debarredcomment,
         );
 
-        if ( $borrower->{debarred} ne "9999-12-31" ) {
-            $template->param( 'userdebarreddate' => $borrower->{debarred} );
+        if ( $patron->debarred ne "9999-12-31" ) {
+            $template->param( 'userdebarreddate' => $patron->debarred );
         }
     }
 
@@ -314,7 +332,7 @@ if (@$barcodes) {
     my $template_params = { barcode => $barcode };
     # always check for blockers on issuing
     my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
-        $borrower,
+        $patron,
         $barcode, $datedue,
         $inprocess,
         undef,
@@ -329,11 +347,14 @@ if (@$barcodes) {
     $template_params->{alert} = $alerts;
     $template_params->{messages} = $messages;
 
-    #  Get the item title for more information
-    my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
+    my $item = Koha::Items->find({ barcode => $barcode });
+    my ( $biblio, $mss );
 
-    my $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $getmessageiteminfo->{frameworkcode}, kohafield => 'items.notforloan', authorised_value => { not => undef } });
-    $template_params->{authvalcode_notforloan} = $mss->count ? $mss->next->authorised_value : undef;
+    if ( $item ) {
+        $biblio = $item->biblio;
+        my $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.notforloan', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
+        $template_params->{authvalcode_notforloan} = $mss->count ? $mss->next->authorised_value : undef;
+    }
 
     # Fix for bug 7494: optional checkout-time fallback search for a book
 
@@ -368,7 +389,7 @@ if (@$barcodes) {
         }
     }
 
-    unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
+    if ( $error->{UNKNOWN_BARCODE} or not $onsite_checkout or not C4::Context->preference("OnSiteCheckoutsForce") ) {
         delete $question->{'DEBT'} if ($debt_confirmed);
         foreach my $impossible ( keys %$error ) {
             $template_params->{$impossible} = $$error{$impossible};
@@ -376,30 +397,31 @@ if (@$barcodes) {
             $blocker = 1;
         }
     }
-    my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
-    if( !$blocker || $force_allow_issue ){
+
+    if( $item and ( !$blocker or $force_allow_issue ) ){
         my $confirm_required = 0;
         unless($issueconfirmed){
             #  Get the item title for more information
-            my $materials = $iteminfo->{'materials'};
-            my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $getmessageiteminfo->{frameworkcode}, kohafield => 'items.materials', authorised_value => $materials });
+            my $materials = $item->materials;
+            my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
             $materials = $descriptions->{lib} // $materials;
             $template_params->{additional_materials} = $materials;
-            $template_params->{itemhomebranch} = $iteminfo->{'homebranch'};
+            $template_params->{itemhomebranch} = $item->homebranch;
 
             # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
             foreach my $needsconfirmation ( keys %$question ) {
                 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
-                $template_params->{getTitleMessageIteminfo} = $iteminfo->{'title'};
-                $template_params->{getBarcodeMessageIteminfo} = $iteminfo->{'barcode'};
+                $template_params->{getTitleMessageIteminfo} = $biblio->title;
+                $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
                 $template_params->{NEEDSCONFIRMATION} = 1;
                 $template_params->{onsite_checkout} = $onsite_checkout;
+                $template_params->{auto_renew} = $session->param('auto_renew');
                 $confirm_required = 1;
             }
         }
         unless($confirm_required) {
             my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
-            my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew'), switch_onsite_checkout => $switch_onsite_checkout, } );
+            my $issue = AddIssue( $patron->unblessed, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew'), switch_onsite_checkout => $switch_onsite_checkout, } );
             $template_params->{issue} = $issue;
             $session->clear('auto_renew');
             $inprocess = 1;
@@ -412,18 +434,15 @@ if (@$barcodes) {
         );
     }
 
-    $template->param(
-        itembiblionumber => $getmessageiteminfo->{'biblionumber'}
-    );
-
 
     # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
     $patron = Koha::Patrons->find( $borrowernumber );
     $template_params->{issuecount} = $patron->checkouts->count;
 
-    if ( $iteminfo ) {
-        $iteminfo->{subtitle} = GetRecordValue('subtitle', GetMarcBiblio($iteminfo->{biblionumber}), GetFrameworkCode($iteminfo->{biblionumber}));
-        $template_params->{item} = $iteminfo;
+    if ( $item ) {
+        $template_params->{item} = $item;
+        $template_params->{biblio} = $biblio;
+        $template_params->{itembiblionumber} = $biblio->biblionumber;
     }
     push @$checkout_infos, $template_params;
   }
@@ -439,118 +458,83 @@ if (@$barcodes) {
   }
 }
 
-# reload the borrower info for the sake of reseting the flags.....
-if ($borrowernumber) {
-    $borrower = GetMember( borrowernumber => $borrowernumber );
-}
-
 ##################################################################################
 # BUILD HTML
 # show all reserves of this borrower, and the position of the reservation ....
-if ($borrowernumber) {
-    my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
+if ($patron) {
+    my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
     my $waiting_holds = $holds->waiting;
     $template->param(
         holds_count  => $holds->count(),
         WaitingHolds => $waiting_holds,
     );
-
-    $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
 }
 
-#title
-my $flags = $borrower ? C4::Members::patronflags( $borrower ) : {};
-foreach my $flag ( sort keys %$flags ) {
-    $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
-    if ( $flags->{$flag}->{'noissues'} ) {
+if ( $patron ) {
+    my $noissues;
+    if ( $patron->gonenoaddress ) {
+        $template->param( gna => 1 );
+        $noissues = 1;
+    }
+    if ( $patron->lost ) {
+        $template->param( lost=> 1 );
+        $noissues = 1;
+    }
+    if ( $patron->is_debarred ) {
+        $template->param( dbarred=> 1 );
+        $noissues = 1;
+    }
+    my $account = $patron->account;
+    if( ( my $owing = $account->non_issues_charges ) > 0 ) {
+        my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
+        $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
         $template->param(
-            noissues => ($force_allow_issue) ? 0 : 'true',
-            forceallow => $force_allow_issue,
+            charges => 1,
+            chargesamount => $owing,
+        )
+    } elsif ( $balance < 0 ) {
+        $template->param(
+            credits => 1,
+            creditsamount => -$balance,
         );
-        if ( $flag eq 'GNA' ) {
-            $template->param( gna => 'true' );
-        }
-        elsif ( $flag eq 'LOST' ) {
-            $template->param( lost => 'true' );
-        }
-        elsif ( $flag eq 'DBARRED' ) {
-            $template->param( dbarred => 'true' );
-        }
-        elsif ( $flag eq 'CHARGES' ) {
-            $template->param(
-                charges    => 'true',
-                chargesmsg => $flags->{'CHARGES'}->{'message'},
-                chargesamount => $flags->{'CHARGES'}->{'amount'},
-                charges_is_blocker => 1
-            );
-        }
-        elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
-            $template->param(
-                charges_guarantees    => 'true',
-                chargesmsg_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'message'},
-                chargesamount_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'amount'},
-                charges_guarantees_is_blocker => 1
-            );
-        }
-        elsif ( $flag eq 'CREDITS' ) {
-            $template->param(
-                credits    => 'true',
-                creditsmsg => $flags->{'CREDITS'}->{'message'},
-                creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
-            );
-        }
     }
-    else {
-        if ( $flag eq 'CHARGES' ) {
-            $template->param(
-                charges    => 'true',
-                chargesmsg => $flags->{'CHARGES'}->{'message'},
-                chargesamount => $flags->{'CHARGES'}->{'amount'},
-            );
-        }
-        elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
-            $template->param(
-                charges_guarantees    => 'true',
-                chargesmsg_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'message'},
-                chargesamount_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'amount'},
-            );
-        }
-        elsif ( $flag eq 'CREDITS' ) {
-            $template->param(
-                credits    => 'true',
-                creditsmsg => $flags->{'CREDITS'}->{'message'},
-                creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
-            );
-        }
-        elsif ( $flag eq 'ODUES' ) {
-            $template->param(
-                odues    => 'true',
-                oduesmsg => $flags->{'ODUES'}->{'message'}
-            );
 
-            my $items = $flags->{$flag}->{'itemlist'};
-            if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
-                $template->param( nonreturns => 'true' );
-            }
+    my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
+    $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
+    if ( defined $no_issues_charge_guarantees ) {
+        my $guarantees_non_issues_charges = 0;
+        my $guarantees = $patron->guarantees;
+        while ( my $g = $guarantees->next ) {
+            $guarantees_non_issues_charges += $g->account->non_issues_charges;
         }
-        elsif ( $flag eq 'NOTES' ) {
+        if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
             $template->param(
-                notes    => 'true',
-                notesmsg => $flags->{'NOTES'}->{'message'}
+                charges_guarantees    => 1,
+                chargesamount_guarantees => $guarantees_non_issues_charges,
             );
+            $noissues = 1 unless C4::Context->preference("allowfineoverride");
         }
     }
-}
 
-my $amountold = $flags ? $flags->{'CHARGES'}->{'message'} || 0 : 0;
-$amountold =~ s/^.*\$//;    # remove upto the $, if any
+    if ( $patron->has_overdues ) {
+        $template->param( odues => 1 );
+    }
 
-my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
+    if ( $patron->borrowernotes ) {
+        my $borrowernotes = $patron->borrowernotes;
+        $borrowernotes =~ s#\n#<br />#g;
+        $template->param(
+            notes =>1,
+            notesmsg => $borrowernotes,
+        )
+    }
 
-if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
-    my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
-    $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
-    $template->param( 'catcode' => $patron_categories->next )  if $patron_categories->count == 1;
+    if ( $noissues ) {
+        $template->param(
+            noissues => ($force_allow_issue) ? 0 : 'true',
+            forceallow => $force_allow_issue,
+        );
+    }
 }
 
 my $messages = Koha::Patron::Messages->search(
@@ -595,10 +579,16 @@ my $relatives_issues_count =
   Koha::Database->new()->schema()->resultset('Issue')
   ->count( { borrowernumber => \@relatives } );
 
-my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $borrower->{streettype} });
-my $roadtype = $av->count ? $av->next->lib : '';
-
-$template->param(%$borrower);
+if ( $patron ) {
+    my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
+    my $roadtype = $av->count ? $av->next->lib : '';
+    $template->param(
+        roadtype          => $roadtype,
+        patron            => $patron,
+        categoryname      => $patron->category->description,
+        expiry            => $patron->dateexpiry,
+    );
+}
 
 # Restore date if changed by holds and/or save stickyduedate to session
 if ($restoreduedatespec || $stickyduedate) {
@@ -612,39 +602,28 @@ if ($restoreduedatespec || $stickyduedate) {
 }
 
 $template->param(
-    patron            => $patron,
     messages           => $messages,
-    borrower          => $borrower,
     borrowernumber    => $borrowernumber,
-    categoryname      => $borrower->{'description'},
     branch            => $branch,
     was_renewed       => scalar $query->param('was_renewed') ? 1 : 0,
-    expiry            => $borrower->{'dateexpiry'},
-    roadtype          => $roadtype,
-    amountold         => $amountold,
     barcodes          => $barcodes,
     stickyduedate     => $stickyduedate,
     duedatespec       => $duedatespec,
     restoreduedatespec => $restoreduedatespec,
     message           => $message,
-    totaldue          => sprintf('%.2f', $total),
+    totaldue          => sprintf('%.2f', $balance), # FIXME not used in template?
     inprocess         => $inprocess,
-    is_child          => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
     $view             => 1,
     batch_allowed     => $batch_allowed,
     batch             => $batch,
     AudioAlerts           => C4::Context->preference("AudioAlerts"),
     fast_cataloging   => $fast_cataloging,
     CircAutoPrintQuickSlip   => C4::Context->preference("CircAutoPrintQuickSlip"),
-    SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
-    AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
     RoutingSerials => C4::Context->preference('RoutingSerials'),
     relatives_issues_count => $relatives_issues_count,
     relatives_borrowernumbers => \@relatives,
 );
 
-my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
-$template->param( picture => 1 ) if $patron_image;
 
 if ( C4::Context->preference("ExportCircHistory") ) {
     $template->param(csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc' }) ]);
@@ -655,11 +634,12 @@ $template->param(
     debt_confirmed            => $debt_confirmed,
     SpecifyDueDate            => $duedatespec_allow,
     CircAutocompl             => C4::Context->preference("CircAutocompl"),
-    debarments                => GetDebarments({ borrowernumber => $borrowernumber }),
+    debarments                => scalar GetDebarments({ borrowernumber => $borrowernumber }),
     todaysdate                => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
     has_modifications         => $has_modifications,
     override_high_holds       => $override_high_holds,
     nopermission              => scalar $query->param('nopermission'),
+    autoswitched              => $autoswitched,
 );
 
 output_html_with_http_headers $query, $cookie, $template->output;