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( blessed looks_like_number );
34 use C4::Output qw( output_and_exit_if_error output_and_exit output_html_with_http_headers );
35 use C4::Auth qw( get_session get_template_and_user );
37 use C4::Circulation qw( barcodedecode CanBookBeIssued AddIssue AddReturn );
39 use C4::Biblio qw( TransformMarcToKoha );
40 use C4::Search qw( new_record_from_zebra );
41 use C4::Reserves qw( ModReserveAffect );
45 use Koha::AuthorisedValues;
46 use Koha::CsvProfiles;
48 use Koha::DateUtils qw( dt_from_string );
49 use Koha::Patron::Restriction::Types;
52 use Koha::BiblioFrameworks;
54 use Koha::SearchEngine;
55 use Koha::SearchEngine::Search;
56 use Koha::Patron::Modifications;
59 use List::MoreUtils qw( uniq );
66 my $borrowernumber = $query->param('borrowernumber');
68 my $barcode = $query->param('barcode');
71 # Barcode given by user could be '0'
72 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
73 $barcodes = [ $barcode ];
75 my $filefh = $query->upload('uploadfile');
77 while ( my $content = <$filefh> ) {
78 $content =~ s/[\r\n]*$//g;
79 push @$barcodes, $content if $content;
81 } elsif ( my $list = $query->param('barcodelist') ) {
82 push @$barcodes, split( /\s\n/, $list );
83 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
85 @$barcodes = $query->multi_param('barcodes');
88 $barcodes = [ uniq @$barcodes ];
90 my $template_name = q|circ/circulation.tt|;
91 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
92 my $batch = $query->param('batch');
93 my $batch_allowed = 0;
94 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
95 $template_name = q|circ/circulation_batch_checkouts.tt|;
96 my @batch_category_codes = split ',', C4::Context->preference('BatchCheckoutsValidCategories');
97 my $categorycode = $patron->categorycode;
98 if ( $categorycode && grep { $_ eq $categorycode } @batch_category_codes ) {
105 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
107 template_name => $template_name,
110 flagsrequired => { circulate => 'circulate_remaining_permissions' },
114 my $op = $query->param('op');
115 my $override_high_holds = $query->param('override_high_holds');
116 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
118 my $sessionID = $query->cookie("CGISESSID");
119 my $session = get_session($sessionID);
121 my $userenv = C4::Context->userenv;
122 my $branch = $userenv->{'branch'} // '';
123 my $desk_id = $userenv->{"desk_id"} || '';
128 if ( C4::Context->preference("AutoSwitchPatron") && $barcode ) {
129 my $new_barcode = $barcode;
130 Koha::Plugins->call( 'patron_barcode_transform', \$new_barcode );
131 if ( Koha::Patrons->search( { cardnumber => $new_barcode } )->count() > 0 ) {
132 $findborrower = $barcode;
134 undef $borrowernumber;
140 $findborrower ||= $query->param('findborrower') || q{};
141 $findborrower =~ s|,| |g;
143 if ( $op eq 'cud-confirm_hold' && $query->param('confirm_hold') ) {
144 my $reserve_id = $query->param('confirm_hold');
145 my $hold_branch = $query->param('hold_branch');
146 my $hold_itemnumber = $query->param('hold_itemnumber');
147 my $hold_borrowernumber = $query->param('hold_borrowernumber');
148 my $diffBranchSend = ( $branch ne $hold_branch );
150 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
151 # i.e., whether to apply waiting status
152 ModReserveAffect( $hold_itemnumber, $hold_borrowernumber, $diffBranchSend, $reserve_id, $desk_id );
156 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
158 my $force_allow_issue = $query->param('forceallow') || 0;
159 if (!C4::Auth::haspermission( $userenv->{id} , { circulate => 'force_checkout' } )) {
160 $force_allow_issue = 0;
162 my $onsite_checkout = $query->param('onsite_checkout');
164 if (C4::Context->preference("OnSiteCheckoutAutoCheck") && $onsite_checkout eq "on") {
165 $template->param(onsite_checkout => $onsite_checkout);
168 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
169 our %renew_failed = ();
170 for (@failedrenews) { $renew_failed{$_} = 1; }
172 my @failedreturns = $query->multi_param('failedreturn');
173 our %return_failed = ();
174 for (@failedreturns) { $return_failed{$_} = 1; }
176 for my $barcode ( @$barcodes ) {
177 $barcode = barcodedecode( $barcode ) if $barcode;
180 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
181 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
182 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
183 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
184 undef $restoreduedatespec;
186 my $issueconfirmed = $query->param('issueconfirmed');
187 my $cancelreserve = $query->param('cancelreserve');
188 my $cancel_recall = $query->param('cancel_recall');
189 my $recall_id = $query->param('recall_id');
190 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
191 my $charges = $query->param('charges') || q{};
193 # Check if stickyduedate is turned off
195 # was stickyduedate loaded from session?
196 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
197 $session->clear( 'stickyduedate' );
198 $stickyduedate = $query->param('stickyduedate');
199 $duedatespec = $query->param('duedatespec');
201 $session->param('auto_renew', scalar $query->param('auto_renew'));
204 $session->clear('auto_renew');
207 $template->param( auto_renew => $session->param('auto_renew') );
209 my ($datedue,$invalidduedate);
211 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
212 if( $onsite_checkout && !$duedatespec_allow ) {
213 $datedue = dt_from_string()->truncate(to => 'day');
214 $datedue->set_hour(23);
215 $datedue->set_minute(59);
216 } elsif( $duedatespec_allow ) {
217 if ( $duedatespec ) {
218 $datedue = eval { dt_from_string( $duedatespec ) };
221 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
225 my $reduced_datedue = $query->param('reduceddue');
226 if ( $reduced_datedue ) {
227 $datedue = dt_from_string( $reduced_datedue );
230 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
231 if ( @$barcodes == 0 && $charges eq 'yes' ) {
234 borrowernumber => $borrowernumber
239 # STEP 2 : FIND BORROWER
240 # if there is a list of find borrowers....
244 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
245 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
247 $borrowernumber = $patron->borrowernumber;
249 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
254 # get the borrower information.....
256 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
259 $template->param( borrowernumber => $patron->borrowernumber );
260 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
262 my $overdues = $patron->overdues;
263 my $issues = $patron->checkouts;
264 $balance = $patron->account->balance;
267 # if the expiry date is before today ie they have expired
268 if ( $patron->is_expired ) {
269 #borrowercard expired, no issues
271 noissues => ($force_allow_issue) ? 0 : "1",
272 forceallow => $force_allow_issue,
276 # check for NotifyBorrowerDeparture
277 elsif ( $patron->is_going_to_expire ) {
278 # borrower card soon to expire warn librarian
279 $template->param( "warndeparture" => $patron->dateexpiry ,
281 if (C4::Context->preference('ReturnBeforeExpiry')){
282 $template->param("returnbeforeexpiry" => 1);
286 overduecount => $overdues->count,
287 issuecount => $issues->count,
288 finetotal => $balance,
291 if ( $patron and $patron->is_debarred ) {
293 'userdebarred' => $patron->debarred,
294 'debarredcomment' => $patron->debarredcomment,
295 'debarredsince' => $patron->restrictions->search()->single->created,
298 if ( $patron->debarred ne "9999-12-31" ) {
299 $template->param( 'userdebarreddate' => $patron->debarred );
303 # Calculate and display patron's age
304 if ( !$patron->is_valid_age ) {
305 $template->param( age_limitations => 1 );
306 $template->param( age_low => $patron->category->dateofbirthrequired );
307 $template->param( age_high => $patron->category->upperagelimit );
311 Koha::Patron::Categories->search_with_library_limits( { 'me.categorycode' => $patron->categorycode } )->count )
313 $template->param( limited_category => 1 );
321 if (@$barcodes && $op eq 'cud-checkout') {
323 for my $barcode ( @$barcodes ) {
325 my $template_params = {
327 onsite_checkout => $onsite_checkout,
330 # always check for blockers on issuing
331 my ( $issuingimpossible, $needsconfirmation, $alerts, $messages );
333 ( $issuingimpossible, $needsconfirmation, $alerts, $messages ) = CanBookBeIssued(
339 onsite_checkout => $onsite_checkout,
340 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
344 die $_ unless blessed $_ && $_->can('rethrow');
346 if ( $_->isa('Koha::Exceptions::Calendar::NoOpenDays') ) {
347 $issuingimpossible = { NO_OPEN_DAYS => 1 };
353 my $blocker = $invalidduedate ? 1 : 0;
355 $template_params->{alert} = $alerts;
356 $template_params->{messages} = $messages;
358 my $item = Koha::Items->find({ barcode => $barcode });
362 $biblio = $item->biblio;
365 if ( $issuingimpossible->{'STATS'} ) {
366 $template->param( STATS => 1 );
368 if ( $item->onloan ) {
369 my ( $stats_return, $stats_messages, $stats_iteminformation, $stats_borrower ) =
370 AddReturn( $item->barcode, C4::Context->userenv->{'branch'}, undef, undef, 1 );
373 CHECKEDIN => $stats_return,
374 MESSAGES => $stats_messages,
375 ITEM => $stats_iteminformation,
376 BORROWER => $stats_borrower,
380 # Fix for bug 7494: optional checkout-time fallback search for a book
382 if ( $issuingimpossible->{'UNKNOWN_BARCODE'}
383 && C4::Context->preference("itemBarcodeFallbackSearch")
387 $template_params->{FALLBACK} = 1;
389 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
390 my $query = "kw=" . $barcode;
391 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
393 # if multiple hits, offer options to librarian
394 if ( $total_hits > 0 ) {
396 foreach my $hit ( @{$results} ) {
397 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
398 TransformMarcToKoha({ record => C4::Search::new_record_from_zebra('biblioserver',$hit) });
400 # offer all barcodes individually
401 if ( $chosen->{barcode} ) {
402 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
405 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
406 $template_params->{options} = $items;
410 # Only some errors will block when performing forced onsite checkout,
411 # for other cases all errors will block
412 my @blocking_error_codes =
413 ( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") )
414 ? qw( UNKNOWN_BARCODE NO_OPEN_DAYS )
415 : ( keys %$issuingimpossible );
417 if ( $issuingimpossible->{BOOKED_TO_ANOTHER} ) {
418 $template_params->{BOOKED_TO_ANOTHER} = $issuingimpossible->{BOOKED_TO_ANOTHER};
419 $template_params->{IMPOSSIBLE} = 1;
423 foreach my $code ( @blocking_error_codes ) {
424 if ($issuingimpossible->{$code}) {
425 $template_params->{$code} = $issuingimpossible->{$code};
427 $template_params->{IMPOSSIBLE} = 1;
432 delete $needsconfirmation->{'DEBT'} if ($debt_confirmed);
434 if( $item and ( !$blocker or $force_allow_issue ) ){
435 my $confirm_required = 0;
436 unless($issueconfirmed){
437 # Get the item title for more information
438 my $materials = $item->materials;
439 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
440 $materials = $descriptions->{lib} // $materials;
441 $template_params->{ADDITIONAL_MATERIALS} = $materials;
442 $template_params->{itemhomebranch} = $item->homebranch;
444 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
445 foreach my $needsconfirmation_key ( keys %$needsconfirmation ) {
446 $template_params->{$needsconfirmation_key} = $needsconfirmation->{$needsconfirmation_key};
447 $template_params->{getTitleMessageIteminfo} = $biblio->title;
448 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
449 $template_params->{NEEDSCONFIRMATION} = 1;
450 $confirm_required = 1;
451 if ( $needsconfirmation_key eq 'BOOKED_TO_ANOTHER' ) {
453 dt_from_string( $$needsconfirmation{$needsconfirmation_key}->start_date )->subtract( days => 1 );
454 $template_params->{reduceddue} = $reduceddue;
458 unless ($confirm_required) {
459 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
460 if ( C4::Context->preference('UseRecalls') && !$recall_id ) {
461 my $recall = Koha::Recalls->find(
463 biblio_id => $item->biblionumber,
464 item_id => [ undef, $item->itemnumber ],
465 status => [ 'requested', 'waiting' ],
467 patron_id => $patron->borrowernumber,
470 $recall_id = ( $recall and $recall->id ) ? $recall->id : undef;
473 # If booked (alerts or confirmation) update datedue to end of booking
474 if ( my $booked = $needsconfirmation->{BOOKED_EARLY} // $alerts->{BOOKED} ) {
475 $datedue = $booked->end_date;
477 my $issue = AddIssue(
478 $patron, $barcode, $datedue,
482 onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew'),
483 switch_onsite_checkout => $switch_onsite_checkout, cancel_recall => $cancel_recall,
484 recall_id => $recall_id,
487 $template_params->{issue} = $issue;
488 $session->clear('auto_renew');
493 if ($needsconfirmation->{RESERVE_WAITING} or $needsconfirmation->{RESERVED} or $needsconfirmation->{TRANSFERRED} or $needsconfirmation->{PROCESSING}){
495 reserveborrowernumber => $needsconfirmation->{'resborrowernumber'},
496 reserve_id => $needsconfirmation->{reserve_id},
501 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
502 $patron = Koha::Patrons->find( $borrowernumber );
503 $template_params->{issuecount} = $patron->checkouts->count;
506 $template_params->{item} = $item;
507 $template_params->{biblio} = $biblio;
508 $template_params->{itembiblionumber} = $biblio->biblionumber;
510 push @$checkout_infos, $template_params;
513 $template->param( %{$checkout_infos->[0]} );
514 $template->param( barcode => $barcodes->[0] );
516 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
518 checkout_infos => $checkout_infos,
519 onsite_checkout => $onsite_checkout,
520 confirmation_needed => $confirmation_needed,
525 ##################################################################################
527 # show all reserves of this borrower, and the position of the reservation ....
529 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
530 my $waiting_holds = $holds->waiting;
532 holds_count => $holds->count(),
533 WaitingHolds => $waiting_holds,
536 if ( C4::Context->preference('UseRecalls') ) {
537 my $waiting_recalls = $patron->recalls->search({ status => 'waiting' });
539 recalls => $patron->recalls->filter_by_current->search({},{ order_by => { -asc => 'created_date' } }),
540 specific_patron => 1,
541 waiting_recalls => $waiting_recalls,
548 if ( $patron->gonenoaddress ) {
549 $template->param( gonenoaddress => 1 );
552 if ( $patron->lost ) {
553 $template->param( lost=> 1 );
556 if ( $patron->is_debarred ) {
557 $template->param( is_debarred=> 1 );
560 if ( $patron->borrowernumber eq C4::Context->preference("AnonymousPatron") ) {
561 $template->param( is_anonymous => 1 );
564 my $account = $patron->account;
565 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
566 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
567 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
570 chargesamount => $owing,
572 } elsif ( $balance < 0 ) {
575 creditsamount => -$balance,
579 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
580 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
581 if ( $no_issues_charge_guarantors ) {
582 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
584 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
586 charges_guarantors_guarantees => $guarantors_non_issues_charges
588 $noissues = 1 unless C4::Context->preference("allowfineoverride");
592 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
593 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
594 if ( defined $no_issues_charge_guarantees ) {
595 my $guarantees_non_issues_charges = 0;
596 my $guarantees = $patron->guarantee_relationships->guarantees;
597 while ( my $g = $guarantees->next ) {
598 $guarantees_non_issues_charges += $g->account->non_issues_charges;
600 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
602 charges_guarantees => 1,
603 chargesamount_guarantees => $guarantees_non_issues_charges,
605 $noissues = 1 unless C4::Context->preference("allowfineoverride");
609 if ( $patron->has_overdues ) {
610 $template->param( odues => 1 );
613 if ( $patron->borrowernotes ) {
614 my $borrowernotes = $patron->borrowernotes;
615 $borrowernotes =~ s#\n#<br />#g;
618 notesmsg => $borrowernotes,
624 noissues => ($force_allow_issue) ? 0 : 'true',
625 forceallow => $force_allow_issue,
629 my $patron_messages = $patron->messages->search(
633 '+select' => ['manager.surname', 'manager.firstname' ],
634 '+as' => ['manager_surname', 'manager_firstname'],
637 $template->param( patron_messages => $patron_messages );
639 if ( C4::Context->preference("WaitingNotifyAtCheckout") ) {
640 my $waiting_holds = $patron->holds->search( { found => 'W', branchcode => $branch } );
641 $template->param( waiting_holds => $waiting_holds );
645 my $fast_cataloging = 0;
646 if ( Koha::BiblioFrameworks->find('FA') ) {
651 ?'batch_checkout_view'
656 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
657 push( @relatives, $_->id ) for @guarantors;
658 push( @relatives, $_->id ) for $patron->siblings->as_list;
660 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
663 my $relatives_issues_count =
664 Koha::Database->new()->schema()->resultset('Issue')
665 ->count( { borrowernumber => \@relatives } );
668 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
669 my $roadtype = $av->count ? $av->next->lib : '';
671 roadtype => $roadtype,
673 categoryname => $patron->category->description,
674 expiry => $patron->dateexpiry,
678 # Restore date if changed by holds and/or save stickyduedate to session
679 if ($restoreduedatespec || $stickyduedate) {
680 $duedatespec = $restoreduedatespec || $duedatespec;
682 if ($stickyduedate) {
683 $session->param( 'stickyduedate', $duedatespec );
685 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
690 borrowernumber => $borrowernumber,
692 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
693 barcodes => $barcodes,
694 stickyduedate => $stickyduedate,
695 duedatespec => $duedatespec,
696 restoreduedatespec => $restoreduedatespec,
698 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
699 inprocess => $inprocess,
701 batch_allowed => $batch_allowed,
703 AudioAlerts => C4::Context->preference("AudioAlerts"),
704 fast_cataloging => $fast_cataloging,
705 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
706 RoutingSerials => C4::Context->preference('RoutingSerials'),
707 relatives_issues_count => $relatives_issues_count,
708 relatives_borrowernumbers => \@relatives,
712 if ( C4::Context->preference("ExportCircHistory") ) {
713 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
716 my ( $has_modifications, $patron_lists_count);
718 $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
719 $patron_lists_count = $patron->get_lists_with_patron->count();
722 debt_confirmed => $debt_confirmed,
723 SpecifyDueDate => $duedatespec_allow,
724 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
725 today_due_date_and_time => dt_from_string()->set(hour => 23)->set(minute => 59),
726 restriction_types => scalar Koha::Patron::Restriction::Types->search(),
727 has_modifications => $has_modifications,
728 patron_lists_count => $patron_lists_count,
729 override_high_holds => $override_high_holds,
730 nopermission => scalar $query->param('nopermission'),
731 autoswitched => $autoswitched,
732 logged_in_user => $logged_in_user,
735 output_html_with_http_headers $query, $cookie, $template->output;