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 $override_high_holds = $query->param('override_high_holds');
115 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
117 my $sessionID = $query->cookie("CGISESSID");
118 my $session = get_session($sessionID);
120 my $userenv = C4::Context->userenv;
121 my $branch = $userenv->{'branch'} // '';
122 my $desk_id = $userenv->{"desk_id"} || '';
127 if ( C4::Context->preference("AutoSwitchPatron") && $barcode ) {
128 my $new_barcode = $barcode;
129 Koha::Plugins->call( 'patron_barcode_transform', \$new_barcode );
130 if ( Koha::Patrons->search( { cardnumber => $new_barcode } )->count() > 0 ) {
131 $findborrower = $barcode;
133 undef $borrowernumber;
139 $findborrower ||= $query->param('findborrower') || q{};
140 $findborrower =~ s|,| |g;
142 if ( $query->param('confirm_hold') ) {
143 my $reserve_id = $query->param('confirm_hold');
144 my $hold_branch = $query->param('hold_branch');
145 my $hold_itemnumber = $query->param('hold_itemnumber');
146 my $hold_borrowernumber = $query->param('hold_borrowernumber');
147 my $diffBranchSend = ( $branch ne $hold_branch );
149 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
150 # i.e., whether to apply waiting status
151 ModReserveAffect( $hold_itemnumber, $hold_borrowernumber, $diffBranchSend, $reserve_id, $desk_id );
155 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
157 my $force_allow_issue = $query->param('forceallow') || 0;
158 if (!C4::Auth::haspermission( $userenv->{id} , { circulate => 'force_checkout' } )) {
159 $force_allow_issue = 0;
161 my $onsite_checkout = $query->param('onsite_checkout');
163 if (C4::Context->preference("OnSiteCheckoutAutoCheck") && $onsite_checkout eq "on") {
164 $template->param(onsite_checkout => $onsite_checkout);
167 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
168 our %renew_failed = ();
169 for (@failedrenews) { $renew_failed{$_} = 1; }
171 my @failedreturns = $query->multi_param('failedreturn');
172 our %return_failed = ();
173 for (@failedreturns) { $return_failed{$_} = 1; }
175 for my $barcode ( @$barcodes ) {
176 $barcode = barcodedecode( $barcode ) if $barcode;
179 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
180 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
181 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
182 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
183 undef $restoreduedatespec;
185 my $issueconfirmed = $query->param('issueconfirmed');
186 my $cancelreserve = $query->param('cancelreserve');
187 my $cancel_recall = $query->param('cancel_recall');
188 my $recall_id = $query->param('recall_id');
189 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
190 my $charges = $query->param('charges') || q{};
192 # Check if stickyduedate is turned off
194 # was stickyduedate loaded from session?
195 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
196 $session->clear( 'stickyduedate' );
197 $stickyduedate = $query->param('stickyduedate');
198 $duedatespec = $query->param('duedatespec');
200 $session->param('auto_renew', scalar $query->param('auto_renew'));
203 $session->clear('auto_renew');
206 $template->param( auto_renew => $session->param('auto_renew') );
208 my ($datedue,$invalidduedate);
210 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
211 if( $onsite_checkout && !$duedatespec_allow ) {
212 $datedue = dt_from_string()->truncate(to => 'day');
213 $datedue->set_hour(23);
214 $datedue->set_minute(59);
215 } elsif( $duedatespec_allow ) {
216 if ( $duedatespec ) {
217 $datedue = eval { dt_from_string( $duedatespec ) };
220 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
224 my $reduced_datedue = $query->param('reduceddue');
225 if ( $reduced_datedue ) {
226 $datedue = dt_from_string( $reduced_datedue );
229 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
230 if ( @$barcodes == 0 && $charges eq 'yes' ) {
233 borrowernumber => $borrowernumber
238 # STEP 2 : FIND BORROWER
239 # if there is a list of find borrowers....
243 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
244 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
246 $borrowernumber = $patron->borrowernumber;
248 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
253 # get the borrower information.....
255 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
258 $template->param( borrowernumber => $patron->borrowernumber );
259 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
261 my $overdues = $patron->overdues;
262 my $issues = $patron->checkouts;
263 $balance = $patron->account->balance;
266 # if the expiry date is before today ie they have expired
267 if ( $patron->is_expired ) {
268 #borrowercard expired, no issues
270 noissues => ($force_allow_issue) ? 0 : "1",
271 forceallow => $force_allow_issue,
275 # check for NotifyBorrowerDeparture
276 elsif ( $patron->is_going_to_expire ) {
277 # borrower card soon to expire warn librarian
278 $template->param( "warndeparture" => $patron->dateexpiry ,
280 if (C4::Context->preference('ReturnBeforeExpiry')){
281 $template->param("returnbeforeexpiry" => 1);
285 overduecount => $overdues->count,
286 issuecount => $issues->count,
287 finetotal => $balance,
290 if ( $patron and $patron->is_debarred ) {
292 'userdebarred' => $patron->debarred,
293 'debarredcomment' => $patron->debarredcomment,
294 'debarredsince' => $patron->restrictions->search()->single->created,
297 if ( $patron->debarred ne "9999-12-31" ) {
298 $template->param( 'userdebarreddate' => $patron->debarred );
302 # Calculate and display patron's age
303 if ( !$patron->is_valid_age ) {
304 $template->param( age_limitations => 1 );
305 $template->param( age_low => $patron->category->dateofbirthrequired );
306 $template->param( age_high => $patron->category->upperagelimit );
310 Koha::Patron::Categories->search_with_library_limits( { 'me.categorycode' => $patron->categorycode } )->count )
312 $template->param( limited_category => 1 );
322 for my $barcode ( @$barcodes ) {
324 my $template_params = {
326 onsite_checkout => $onsite_checkout,
329 # always check for blockers on issuing
330 my ( $issuingimpossible, $needsconfirmation, $alerts, $messages );
332 ( $issuingimpossible, $needsconfirmation, $alerts, $messages ) = CanBookBeIssued(
338 onsite_checkout => $onsite_checkout,
339 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
343 die $_ unless blessed $_ && $_->can('rethrow');
345 if ( $_->isa('Koha::Exceptions::Calendar::NoOpenDays') ) {
346 $issuingimpossible = { NO_OPEN_DAYS => 1 };
352 my $blocker = $invalidduedate ? 1 : 0;
354 $template_params->{alert} = $alerts;
355 $template_params->{messages} = $messages;
357 my $item = Koha::Items->find({ barcode => $barcode });
361 $biblio = $item->biblio;
364 if ( $issuingimpossible->{'STATS'} ) {
365 $template->param( STATS => 1 );
367 if ( $item->onloan ) {
368 my ( $stats_return, $stats_messages, $stats_iteminformation, $stats_borrower ) =
369 AddReturn( $item->barcode, C4::Context->userenv->{'branch'}, undef, undef, 1 );
372 CHECKEDIN => $stats_return,
373 MESSAGES => $stats_messages,
374 ITEM => $stats_iteminformation,
375 BORROWER => $stats_borrower,
379 # Fix for bug 7494: optional checkout-time fallback search for a book
381 if ( $issuingimpossible->{'UNKNOWN_BARCODE'}
382 && C4::Context->preference("itemBarcodeFallbackSearch")
386 $template_params->{FALLBACK} = 1;
388 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
389 my $query = "kw=" . $barcode;
390 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
392 # if multiple hits, offer options to librarian
393 if ( $total_hits > 0 ) {
395 foreach my $hit ( @{$results} ) {
396 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
397 TransformMarcToKoha({ record => C4::Search::new_record_from_zebra('biblioserver',$hit) });
399 # offer all barcodes individually
400 if ( $chosen->{barcode} ) {
401 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
404 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
405 $template_params->{options} = $items;
409 # Only some errors will block when performing forced onsite checkout,
410 # for other cases all errors will block
411 my @blocking_error_codes =
412 ( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") )
413 ? qw( UNKNOWN_BARCODE NO_OPEN_DAYS )
414 : ( keys %$issuingimpossible );
416 if ( $issuingimpossible->{BOOKED_TO_ANOTHER} ) {
417 $template_params->{BOOKED_TO_ANOTHER} = $issuingimpossible->{BOOKED_TO_ANOTHER};
418 $template_params->{IMPOSSIBLE} = 1;
422 foreach my $code ( @blocking_error_codes ) {
423 if ($issuingimpossible->{$code}) {
424 $template_params->{$code} = $issuingimpossible->{$code};
426 $template_params->{IMPOSSIBLE} = 1;
431 delete $needsconfirmation->{'DEBT'} if ($debt_confirmed);
433 if( $item and ( !$blocker or $force_allow_issue ) ){
434 my $confirm_required = 0;
435 unless($issueconfirmed){
436 # Get the item title for more information
437 my $materials = $item->materials;
438 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
439 $materials = $descriptions->{lib} // $materials;
440 $template_params->{ADDITIONAL_MATERIALS} = $materials;
441 $template_params->{itemhomebranch} = $item->homebranch;
443 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
444 foreach my $needsconfirmation_key ( keys %$needsconfirmation ) {
445 $template_params->{$needsconfirmation_key} = $needsconfirmation->{$needsconfirmation_key};
446 $template_params->{getTitleMessageIteminfo} = $biblio->title;
447 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
448 $template_params->{NEEDSCONFIRMATION} = 1;
449 $confirm_required = 1;
450 if ( $needsconfirmation_key eq 'BOOKED_TO_ANOTHER' ) {
452 dt_from_string( $$needsconfirmation{$needsconfirmation_key}->start_date )->subtract( days => 1 );
453 $template_params->{reduceddue} = $reduceddue;
457 unless ($confirm_required) {
458 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
459 if ( C4::Context->preference('UseRecalls') && !$recall_id ) {
460 my $recall = Koha::Recalls->find(
462 biblio_id => $item->biblionumber,
463 item_id => [ undef, $item->itemnumber ],
464 status => [ 'requested', 'waiting' ],
466 patron_id => $patron->borrowernumber,
469 $recall_id = ( $recall and $recall->id ) ? $recall->id : undef;
472 # If booked (alerts or confirmation) update datedue to end of booking
473 if ( my $booked = $needsconfirmation->{BOOKED_EARLY} // $alerts->{BOOKED} ) {
474 $datedue = $booked->end_date;
476 my $issue = AddIssue(
477 $patron, $barcode, $datedue,
481 onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew'),
482 switch_onsite_checkout => $switch_onsite_checkout, cancel_recall => $cancel_recall,
483 recall_id => $recall_id,
486 $template_params->{issue} = $issue;
487 $session->clear('auto_renew');
492 if ($needsconfirmation->{RESERVE_WAITING} or $needsconfirmation->{RESERVED} or $needsconfirmation->{TRANSFERRED} or $needsconfirmation->{PROCESSING}){
494 reserveborrowernumber => $needsconfirmation->{'resborrowernumber'},
495 reserve_id => $needsconfirmation->{reserve_id},
500 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
501 $patron = Koha::Patrons->find( $borrowernumber );
502 $template_params->{issuecount} = $patron->checkouts->count;
505 $template_params->{item} = $item;
506 $template_params->{biblio} = $biblio;
507 $template_params->{itembiblionumber} = $biblio->biblionumber;
509 push @$checkout_infos, $template_params;
512 $template->param( %{$checkout_infos->[0]} );
513 $template->param( barcode => $barcodes->[0] );
515 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
517 checkout_infos => $checkout_infos,
518 onsite_checkout => $onsite_checkout,
519 confirmation_needed => $confirmation_needed,
524 ##################################################################################
526 # show all reserves of this borrower, and the position of the reservation ....
528 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
529 my $waiting_holds = $holds->waiting;
531 holds_count => $holds->count(),
532 WaitingHolds => $waiting_holds,
535 if ( C4::Context->preference('UseRecalls') ) {
536 my $waiting_recalls = $patron->recalls->search({ status => 'waiting' });
538 recalls => $patron->recalls->filter_by_current->search({},{ order_by => { -asc => 'created_date' } }),
539 specific_patron => 1,
540 waiting_recalls => $waiting_recalls,
547 if ( $patron->gonenoaddress ) {
548 $template->param( gonenoaddress => 1 );
551 if ( $patron->lost ) {
552 $template->param( lost=> 1 );
555 if ( $patron->is_debarred ) {
556 $template->param( is_debarred=> 1 );
559 if ( $patron->borrowernumber eq C4::Context->preference("AnonymousPatron") ) {
560 $template->param( is_anonymous => 1 );
563 my $account = $patron->account;
564 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
565 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
566 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
569 chargesamount => $owing,
571 } elsif ( $balance < 0 ) {
574 creditsamount => -$balance,
578 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
579 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
580 if ( $no_issues_charge_guarantors ) {
581 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
583 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
585 charges_guarantors_guarantees => $guarantors_non_issues_charges
587 $noissues = 1 unless C4::Context->preference("allowfineoverride");
591 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
592 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
593 if ( defined $no_issues_charge_guarantees ) {
594 my $guarantees_non_issues_charges = 0;
595 my $guarantees = $patron->guarantee_relationships->guarantees;
596 while ( my $g = $guarantees->next ) {
597 $guarantees_non_issues_charges += $g->account->non_issues_charges;
599 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
601 charges_guarantees => 1,
602 chargesamount_guarantees => $guarantees_non_issues_charges,
604 $noissues = 1 unless C4::Context->preference("allowfineoverride");
608 if ( $patron->has_overdues ) {
609 $template->param( odues => 1 );
612 if ( $patron->borrowernotes ) {
613 my $borrowernotes = $patron->borrowernotes;
614 $borrowernotes =~ s#\n#<br />#g;
617 notesmsg => $borrowernotes,
623 noissues => ($force_allow_issue) ? 0 : 'true',
624 forceallow => $force_allow_issue,
628 my $patron_messages = $patron->messages->search(
632 '+select' => ['manager.surname', 'manager.firstname' ],
633 '+as' => ['manager_surname', 'manager_firstname'],
636 $template->param( patron_messages => $patron_messages );
640 my $fast_cataloging = 0;
641 if ( Koha::BiblioFrameworks->find('FA') ) {
646 ?'batch_checkout_view'
651 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
652 push( @relatives, $_->id ) for @guarantors;
653 push( @relatives, $_->id ) for $patron->siblings->as_list;
655 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
658 my $relatives_issues_count =
659 Koha::Database->new()->schema()->resultset('Issue')
660 ->count( { borrowernumber => \@relatives } );
663 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
664 my $roadtype = $av->count ? $av->next->lib : '';
666 roadtype => $roadtype,
668 categoryname => $patron->category->description,
669 expiry => $patron->dateexpiry,
673 # Restore date if changed by holds and/or save stickyduedate to session
674 if ($restoreduedatespec || $stickyduedate) {
675 $duedatespec = $restoreduedatespec || $duedatespec;
677 if ($stickyduedate) {
678 $session->param( 'stickyduedate', $duedatespec );
680 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
685 borrowernumber => $borrowernumber,
687 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
688 barcodes => $barcodes,
689 stickyduedate => $stickyduedate,
690 duedatespec => $duedatespec,
691 restoreduedatespec => $restoreduedatespec,
693 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
694 inprocess => $inprocess,
696 batch_allowed => $batch_allowed,
698 AudioAlerts => C4::Context->preference("AudioAlerts"),
699 fast_cataloging => $fast_cataloging,
700 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
701 RoutingSerials => C4::Context->preference('RoutingSerials'),
702 relatives_issues_count => $relatives_issues_count,
703 relatives_borrowernumbers => \@relatives,
707 if ( C4::Context->preference("ExportCircHistory") ) {
708 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
711 my ( $has_modifications, $patron_lists_count);
713 $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
714 $patron_lists_count = $patron->get_lists_with_patron->count();
717 debt_confirmed => $debt_confirmed,
718 SpecifyDueDate => $duedatespec_allow,
719 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
720 today_due_date_and_time => dt_from_string()->set(hour => 23)->set(minute => 59),
721 restriction_types => scalar Koha::Patron::Restriction::Types->search(),
722 has_modifications => $has_modifications,
723 patron_lists_count => $patron_lists_count,
724 override_high_holds => $override_high_holds,
725 nopermission => scalar $query->param('nopermission'),
726 autoswitched => $autoswitched,
727 logged_in_user => $logged_in_user,
730 # Generate CSRF token for upload and delete image buttons
732 csrf_token => Koha::Token->new->generate_csrf({ session_id => $query->cookie('CGISESSID'),}),
735 output_html_with_http_headers $query, $cookie, $template->output;