3 # script to execute issuing of books
5 # Copyright 2000-2002 Katipo Communications
6 # copyright 2010 BibLibre
7 # Copyright 2011 PTFS-Europe Ltd.
8 # Copyright 2012 software.coop and MJ Ray
10 # This file is part of Koha.
12 # Koha is free software; you can redistribute it and/or modify it
13 # under the terms of the GNU General Public License as published by
14 # the Free Software Foundation; either version 3 of the License, or
15 # (at your option) any later version.
17 # Koha is distributed in the hope that it will be useful, but
18 # WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 # GNU General Public License for more details.
22 # You should have received a copy of the GNU General Public License
23 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 # FIXME There are too many calls to Koha::Patrons->find in this script
29 use URI::Escape qw( uri_escape_utf8 );
31 use DateTime::Duration;
32 use Scalar::Util qw( looks_like_number );
33 use C4::Output qw( output_and_exit_if_error output_and_exit output_html_with_http_headers );
34 use C4::Auth qw( get_session get_template_and_user );
36 use C4::Circulation qw( barcodedecode CanBookBeIssued AddIssue );
38 use C4::Biblio qw( TransformMarcToKoha );
39 use C4::Search qw( new_record_from_zebra );
44 use Koha::AuthorisedValues;
45 use Koha::CsvProfiles;
47 use Koha::Patron::Debarments qw( GetDebarments );
48 use Koha::DateUtils qw( dt_from_string output_pref );
51 use Koha::BiblioFrameworks;
53 use Koha::SearchEngine;
54 use Koha::SearchEngine::Search;
55 use Koha::Patron::Modifications;
57 use List::MoreUtils qw( uniq );
64 my $override_high_holds = $query->param('override_high_holds');
65 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
67 my $sessionID = $query->cookie("CGISESSID") ;
68 my $session = get_session($sessionID);
71 my $barcode = $query->param('barcode');
74 my $borrowernumber = $query->param('borrowernumber');
76 if (C4::Context->preference("AutoSwitchPatron") && $barcode) {
77 my $new_barcode = $barcode;
78 Koha::Plugins->call( 'patron_barcode_transform', \$new_barcode );
79 if (Koha::Patrons->search( { cardnumber => $new_barcode} )->count() > 0) {
80 $findborrower = $barcode;
82 undef $borrowernumber;
86 $findborrower ||= $query->param('findborrower') || q{};
87 $findborrower =~ s|,| |g;
89 # Barcode given by user could be '0'
90 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
91 $barcodes = [ $barcode ];
93 my $filefh = $query->upload('uploadfile');
95 while ( my $content = <$filefh> ) {
96 $content =~ s/[\r\n]*$//g;
97 push @$barcodes, $content if $content;
99 } elsif ( my $list = $query->param('barcodelist') ) {
100 push @$barcodes, split( /\s\n/, $list );
101 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
103 @$barcodes = $query->multi_param('barcodes');
107 $barcodes = [ uniq @$barcodes ];
109 my $template_name = q|circ/circulation.tt|;
110 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
111 my $batch = $query->param('batch');
112 my $batch_allowed = 0;
113 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
114 $template_name = q|circ/circulation_batch_checkouts.tt|;
115 my @batch_category_codes = split ',', C4::Context->preference('BatchCheckoutsValidCategories');
116 my $categorycode = $patron->categorycode;
117 if ( $categorycode && grep { $_ eq $categorycode } @batch_category_codes ) {
124 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
126 template_name => $template_name,
129 flagsrequired => { circulate => 'circulate_remaining_permissions' },
132 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
134 my $force_allow_issue = $query->param('forceallow') || 0;
135 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
136 $force_allow_issue = 0;
138 my $onsite_checkout = $query->param('onsite_checkout');
140 if (C4::Context->preference("OnSiteCheckoutAutoCheck") && $onsite_checkout eq "on") {
141 $template->param(onsite_checkout => $onsite_checkout);
144 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
145 our %renew_failed = ();
146 for (@failedrenews) { $renew_failed{$_} = 1; }
148 my @failedreturns = $query->multi_param('failedreturn');
149 our %return_failed = ();
150 for (@failedreturns) { $return_failed{$_} = 1; }
152 my $searchtype = $query->param('searchtype') || q{contain};
154 my $branch = C4::Context->userenv->{'branch'};
156 if (C4::Context->preference("DisplayClearScreenButton")) {
157 $template->param(DisplayClearScreenButton => 1);
160 for my $barcode ( @$barcodes ) {
161 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
162 $barcode = barcodedecode( $barcode ) if $barcode;
165 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
166 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
167 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso' }); }
169 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
170 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
171 undef $restoreduedatespec;
173 my $issueconfirmed = $query->param('issueconfirmed');
174 my $cancelreserve = $query->param('cancelreserve');
175 my $cancel_recall = $query->param('cancel_recall');
176 my $recall_id = $query->param('recall_id');
177 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
178 my $charges = $query->param('charges') || q{};
180 # Check if stickyduedate is turned off
182 # was stickyduedate loaded from session?
183 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
184 $session->clear( 'stickyduedate' );
185 $stickyduedate = $query->param('stickyduedate');
186 $duedatespec = $query->param('duedatespec');
188 $session->param('auto_renew', scalar $query->param('auto_renew'));
191 $session->clear('auto_renew');
194 $template->param( auto_renew => $session->param('auto_renew') );
196 my ($datedue,$invalidduedate);
198 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
199 if( $onsite_checkout && !$duedatespec_allow ) {
200 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
201 $datedue .= ' 23:59:00';
202 } elsif( $duedatespec_allow ) {
203 if ( $duedatespec ) {
204 $datedue = eval { dt_from_string( $duedatespec ) };
207 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
212 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
213 if ( @$barcodes == 0 && $charges eq 'yes' ) {
216 borrowernumber => $borrowernumber
221 # STEP 2 : FIND BORROWER
222 # if there is a list of find borrowers....
226 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
227 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
229 $borrowernumber = $patron->borrowernumber;
231 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
236 # get the borrower information.....
238 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
241 $template->param( borrowernumber => $patron->borrowernumber );
242 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
244 my $overdues = $patron->get_overdues;
245 my $issues = $patron->checkouts;
246 $balance = $patron->account->balance;
249 # if the expiry date is before today ie they have expired
250 if ( $patron->is_expired ) {
251 #borrowercard expired, no issues
253 noissues => ($force_allow_issue) ? 0 : "1",
254 forceallow => $force_allow_issue,
258 # check for NotifyBorrowerDeparture
259 elsif ( $patron->is_going_to_expire ) {
260 # borrower card soon to expire warn librarian
261 $template->param( "warndeparture" => $patron->dateexpiry ,
263 if (C4::Context->preference('ReturnBeforeExpiry')){
264 $template->param("returnbeforeexpiry" => 1);
268 overduecount => $overdues->count,
269 issuecount => $issues->count,
270 finetotal => $balance,
273 if ( $patron and $patron->is_debarred ) {
275 'userdebarred' => $patron->debarred,
276 'debarredcomment' => $patron->debarredcomment,
279 if ( $patron->debarred ne "9999-12-31" ) {
280 $template->param( 'userdebarreddate' => $patron->debarred );
284 # Calculate and display patron's age
285 if ( !$patron->is_valid_age ) {
286 $template->param( age_limitations => 1 );
287 $template->param( age_low => $patron->category->dateofbirthrequired );
288 $template->param( age_high => $patron->category->upperagelimit );
299 for my $barcode ( @$barcodes ) {
301 my $template_params = {
303 onsite_checkout => $onsite_checkout,
306 # always check for blockers on issuing
307 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
313 onsite_checkout => $onsite_checkout,
314 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
318 my $blocker = $invalidduedate ? 1 : 0;
320 $template_params->{alert} = $alerts;
321 $template_params->{messages} = $messages;
323 my $item = Koha::Items->find({ barcode => $barcode });
327 $biblio = $item->biblio;
330 # Fix for bug 7494: optional checkout-time fallback search for a book
332 if ( $error->{'UNKNOWN_BARCODE'}
333 && C4::Context->preference("itemBarcodeFallbackSearch")
337 $template_params->{FALLBACK} = 1;
339 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
340 my $query = "kw=" . $barcode;
341 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
343 # if multiple hits, offer options to librarian
344 if ( $total_hits > 0 ) {
346 foreach my $hit ( @{$results} ) {
347 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
348 TransformMarcToKoha({ record => C4::Search::new_record_from_zebra('biblioserver',$hit) });
350 # offer all barcodes individually
351 if ( $chosen->{barcode} ) {
352 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
355 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
356 $template_params->{options} = $items;
360 # Only some errors will block when performing forced onsite checkout,
361 # for other cases all errors will block
362 my @blocking_error_codes = ($onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce")) ?
363 qw( UNKNOWN_BARCODE ) : (keys %$error);
365 foreach my $code ( @blocking_error_codes ) {
366 if ($error->{$code}) {
367 $template_params->{$code} = $error->{$code};
368 $template_params->{IMPOSSIBLE} = 1;
373 delete $question->{'DEBT'} if ($debt_confirmed);
375 if( $item and ( !$blocker or $force_allow_issue ) ){
376 my $confirm_required = 0;
377 unless($issueconfirmed){
378 # Get the item title for more information
379 my $materials = $item->materials;
380 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
381 $materials = $descriptions->{lib} // $materials;
382 $template_params->{ADDITIONAL_MATERIALS} = $materials;
383 $template_params->{itemhomebranch} = $item->homebranch;
385 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
386 foreach my $needsconfirmation ( keys %$question ) {
387 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
388 $template_params->{getTitleMessageIteminfo} = $biblio->title;
389 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
390 $template_params->{NEEDSCONFIRMATION} = 1;
391 $confirm_required = 1;
394 unless($confirm_required) {
395 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
396 if ( C4::Context->preference('UseRecalls') && !$recall_id ) {
397 my $recall = Koha::Recalls->find(
399 biblio_id => $item->biblionumber,
400 item_id => [ undef, $item->itemnumber ],
401 status => [ 'requested', 'waiting' ],
403 patron_id => $patron->borrowernumber,
406 $recall_id = ( $recall and $recall->id ) ? $recall->id : undef;
408 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, cancel_recall => $cancel_recall, recall_id => $recall_id, } );
409 $template_params->{issue} = $issue;
410 $session->clear('auto_renew');
415 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
417 reserveborrowernumber => $question->{'resborrowernumber'},
418 reserve_id => $question->{reserve_id},
423 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
424 $patron = Koha::Patrons->find( $borrowernumber );
425 $template_params->{issuecount} = $patron->checkouts->count;
428 $template_params->{item} = $item;
429 $template_params->{biblio} = $biblio;
430 $template_params->{itembiblionumber} = $biblio->biblionumber;
432 push @$checkout_infos, $template_params;
435 $template->param( %{$checkout_infos->[0]} );
436 $template->param( barcode => $barcodes->[0] );
438 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
440 checkout_infos => $checkout_infos,
441 confirmation_needed => $confirmation_needed,
446 ##################################################################################
448 # show all reserves of this borrower, and the position of the reservation ....
450 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
451 my $waiting_holds = $holds->waiting;
453 holds_count => $holds->count(),
454 WaitingHolds => $waiting_holds,
456 if ( C4::Context->preference('UseRecalls') ) {
458 recalls => $patron->recalls->filter_by_current->search({},{ order_by => { -asc => 'created_date' } }),
459 specific_patron => 1,
466 if ( $patron->gonenoaddress ) {
467 $template->param( gonenoaddress => 1 );
470 if ( $patron->lost ) {
471 $template->param( lost=> 1 );
474 if ( $patron->is_debarred ) {
475 $template->param( is_debarred=> 1 );
478 my $account = $patron->account;
479 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
480 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
481 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
484 chargesamount => $owing,
486 } elsif ( $balance < 0 ) {
489 creditsamount => -$balance,
493 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
494 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
495 if ( $no_issues_charge_guarantors ) {
496 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
498 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
500 charges_guarantors_guarantees => $guarantors_non_issues_charges
502 $noissues = 1 unless C4::Context->preference("allowfineoverride");
506 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
507 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
508 if ( defined $no_issues_charge_guarantees ) {
509 my $guarantees_non_issues_charges = 0;
510 my $guarantees = $patron->guarantee_relationships->guarantees;
511 while ( my $g = $guarantees->next ) {
512 $guarantees_non_issues_charges += $g->account->non_issues_charges;
514 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
516 charges_guarantees => 1,
517 chargesamount_guarantees => $guarantees_non_issues_charges,
519 $noissues = 1 unless C4::Context->preference("allowfineoverride");
523 if ( $patron->has_overdues ) {
524 $template->param( odues => 1 );
527 if ( $patron->borrowernotes ) {
528 my $borrowernotes = $patron->borrowernotes;
529 $borrowernotes =~ s#\n#<br />#g;
532 notesmsg => $borrowernotes,
538 noissues => ($force_allow_issue) ? 0 : 'true',
539 forceallow => $force_allow_issue,
543 my $patron_messages = $patron->messages->search(
547 '+select' => ['manager.surname', 'manager.firstname' ],
548 '+as' => ['manager_surname', 'manager_firstname'],
551 $template->param( patron_messages => $patron_messages );
555 my $fast_cataloging = 0;
556 if ( Koha::BiblioFrameworks->find('FA') ) {
561 ?'batch_checkout_view'
566 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
567 push( @relatives, $_->id ) for @guarantors;
568 push( @relatives, $_->id ) for $patron->siblings->as_list;
570 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
573 my $relatives_issues_count =
574 Koha::Database->new()->schema()->resultset('Issue')
575 ->count( { borrowernumber => \@relatives } );
578 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
579 my $roadtype = $av->count ? $av->next->lib : '';
581 roadtype => $roadtype,
583 categoryname => $patron->category->description,
584 expiry => $patron->dateexpiry,
588 # Restore date if changed by holds and/or save stickyduedate to session
589 if ($restoreduedatespec || $stickyduedate) {
590 $duedatespec = $restoreduedatespec || $duedatespec;
592 if ($stickyduedate) {
593 $session->param( 'stickyduedate', $duedatespec );
595 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
600 borrowernumber => $borrowernumber,
602 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
603 barcodes => $barcodes,
604 stickyduedate => $stickyduedate,
605 duedatespec => $duedatespec,
606 restoreduedatespec => $restoreduedatespec,
608 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
609 inprocess => $inprocess,
611 batch_allowed => $batch_allowed,
613 AudioAlerts => C4::Context->preference("AudioAlerts"),
614 fast_cataloging => $fast_cataloging,
615 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
616 RoutingSerials => C4::Context->preference('RoutingSerials'),
617 relatives_issues_count => $relatives_issues_count,
618 relatives_borrowernumbers => \@relatives,
622 if ( C4::Context->preference("ExportCircHistory") ) {
623 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
626 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
628 debt_confirmed => $debt_confirmed,
629 SpecifyDueDate => $duedatespec_allow,
630 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
631 debarments => scalar GetDebarments({ borrowernumber => $borrowernumber }),
632 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
633 has_modifications => $has_modifications,
634 override_high_holds => $override_high_holds,
635 nopermission => scalar $query->param('nopermission'),
636 autoswitched => $autoswitched,
637 logged_in_user => $logged_in_user,
640 output_html_with_http_headers $query, $cookie, $template->output;