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 );
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;
137 $findborrower ||= $query->param('findborrower') || q{};
138 $findborrower =~ s|,| |g;
140 if ( $query->param('confirm_hold') ) {
141 my $reserve_id = $query->param('confirm_hold');
142 my $hold_branch = $query->param('hold_branch');
143 my $hold_itemnumber = $query->param('hold_itemnumber');
144 my $hold_borrowernumber = $query->param('hold_borrowernumber');
145 my $diffBranchSend = ( $branch ne $hold_branch );
147 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
148 # i.e., whether to apply waiting status
149 ModReserveAffect( $hold_itemnumber, $hold_borrowernumber, $diffBranchSend, $reserve_id, $desk_id );
153 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
155 my $force_allow_issue = $query->param('forceallow') || 0;
156 if (!C4::Auth::haspermission( $userenv->{id} , { circulate => 'force_checkout' } )) {
157 $force_allow_issue = 0;
159 my $onsite_checkout = $query->param('onsite_checkout');
161 if (C4::Context->preference("OnSiteCheckoutAutoCheck") && $onsite_checkout eq "on") {
162 $template->param(onsite_checkout => $onsite_checkout);
165 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
166 our %renew_failed = ();
167 for (@failedrenews) { $renew_failed{$_} = 1; }
169 my @failedreturns = $query->multi_param('failedreturn');
170 our %return_failed = ();
171 for (@failedreturns) { $return_failed{$_} = 1; }
173 for my $barcode ( @$barcodes ) {
174 $barcode = barcodedecode( $barcode ) if $barcode;
177 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
178 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
179 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
180 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
181 undef $restoreduedatespec;
183 my $issueconfirmed = $query->param('issueconfirmed');
184 my $cancelreserve = $query->param('cancelreserve');
185 my $cancel_recall = $query->param('cancel_recall');
186 my $recall_id = $query->param('recall_id');
187 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
188 my $charges = $query->param('charges') || q{};
190 # Check if stickyduedate is turned off
192 # was stickyduedate loaded from session?
193 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
194 $session->clear( 'stickyduedate' );
195 $stickyduedate = $query->param('stickyduedate');
196 $duedatespec = $query->param('duedatespec');
198 $session->param('auto_renew', scalar $query->param('auto_renew'));
201 $session->clear('auto_renew');
204 $template->param( auto_renew => $session->param('auto_renew') );
206 my ($datedue,$invalidduedate);
208 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
209 if( $onsite_checkout && !$duedatespec_allow ) {
210 $datedue = dt_from_string()->truncate(to => 'day');
211 $datedue->set_hour(23);
212 $datedue->set_minute(59);
213 } elsif( $duedatespec_allow ) {
214 if ( $duedatespec ) {
215 $datedue = eval { dt_from_string( $duedatespec ) };
218 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
223 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
224 if ( @$barcodes == 0 && $charges eq 'yes' ) {
227 borrowernumber => $borrowernumber
232 # STEP 2 : FIND BORROWER
233 # if there is a list of find borrowers....
237 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
238 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
240 $borrowernumber = $patron->borrowernumber;
242 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
247 # get the borrower information.....
249 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
252 $template->param( borrowernumber => $patron->borrowernumber );
253 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
255 my $overdues = $patron->overdues;
256 my $issues = $patron->checkouts;
257 $balance = $patron->account->balance;
260 # if the expiry date is before today ie they have expired
261 if ( $patron->is_expired ) {
262 #borrowercard expired, no issues
264 noissues => ($force_allow_issue) ? 0 : "1",
265 forceallow => $force_allow_issue,
269 # check for NotifyBorrowerDeparture
270 elsif ( $patron->is_going_to_expire ) {
271 # borrower card soon to expire warn librarian
272 $template->param( "warndeparture" => $patron->dateexpiry ,
274 if (C4::Context->preference('ReturnBeforeExpiry')){
275 $template->param("returnbeforeexpiry" => 1);
279 overduecount => $overdues->count,
280 issuecount => $issues->count,
281 finetotal => $balance,
284 if ( $patron and $patron->is_debarred ) {
286 'userdebarred' => $patron->debarred,
287 'debarredcomment' => $patron->debarredcomment,
288 'debarredsince' => $patron->restrictions->search()->single->created,
291 if ( $patron->debarred ne "9999-12-31" ) {
292 $template->param( 'userdebarreddate' => $patron->debarred );
296 # Calculate and display patron's age
297 if ( !$patron->is_valid_age ) {
298 $template->param( age_limitations => 1 );
299 $template->param( age_low => $patron->category->dateofbirthrequired );
300 $template->param( age_high => $patron->category->upperagelimit );
311 for my $barcode ( @$barcodes ) {
313 my $template_params = {
315 onsite_checkout => $onsite_checkout,
318 # always check for blockers on issuing
319 my ( $error, $question, $alerts, $messages );
321 ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
327 onsite_checkout => $onsite_checkout,
328 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
332 die $_ unless blessed $_ && $_->can('rethrow');
334 if ( $_->isa('Koha::Exceptions::Calendar::NoOpenDays') ) {
335 $error = { NO_OPEN_DAYS => 1 };
341 my $blocker = $invalidduedate ? 1 : 0;
343 $template_params->{alert} = $alerts;
344 $template_params->{messages} = $messages;
346 my $item = Koha::Items->find({ barcode => $barcode });
350 $biblio = $item->biblio;
353 # Fix for bug 7494: optional checkout-time fallback search for a book
355 if ( $error->{'UNKNOWN_BARCODE'}
356 && C4::Context->preference("itemBarcodeFallbackSearch")
360 $template_params->{FALLBACK} = 1;
362 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
363 my $query = "kw=" . $barcode;
364 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
366 # if multiple hits, offer options to librarian
367 if ( $total_hits > 0 ) {
369 foreach my $hit ( @{$results} ) {
370 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
371 TransformMarcToKoha({ record => C4::Search::new_record_from_zebra('biblioserver',$hit) });
373 # offer all barcodes individually
374 if ( $chosen->{barcode} ) {
375 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
378 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
379 $template_params->{options} = $items;
383 # Only some errors will block when performing forced onsite checkout,
384 # for other cases all errors will block
385 my @blocking_error_codes =
386 ( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") )
387 ? qw( UNKNOWN_BARCODE NO_OPEN_DAYS )
390 foreach my $code ( @blocking_error_codes ) {
391 if ($error->{$code}) {
392 $template_params->{$code} = $error->{$code};
393 $template_params->{IMPOSSIBLE} = 1;
398 delete $question->{'DEBT'} if ($debt_confirmed);
400 if( $item and ( !$blocker or $force_allow_issue ) ){
401 my $confirm_required = 0;
402 unless($issueconfirmed){
403 # Get the item title for more information
404 my $materials = $item->materials;
405 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
406 $materials = $descriptions->{lib} // $materials;
407 $template_params->{ADDITIONAL_MATERIALS} = $materials;
408 $template_params->{itemhomebranch} = $item->homebranch;
410 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
411 foreach my $needsconfirmation ( keys %$question ) {
412 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
413 $template_params->{getTitleMessageIteminfo} = $biblio->title;
414 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
415 $template_params->{NEEDSCONFIRMATION} = 1;
416 $confirm_required = 1;
419 unless($confirm_required) {
420 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
421 if ( C4::Context->preference('UseRecalls') && !$recall_id ) {
422 my $recall = Koha::Recalls->find(
424 biblio_id => $item->biblionumber,
425 item_id => [ undef, $item->itemnumber ],
426 status => [ 'requested', 'waiting' ],
428 patron_id => $patron->borrowernumber,
431 $recall_id = ( $recall and $recall->id ) ? $recall->id : undef;
433 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, } );
434 $template_params->{issue} = $issue;
435 $session->clear('auto_renew');
440 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
442 reserveborrowernumber => $question->{'resborrowernumber'},
443 reserve_id => $question->{reserve_id},
448 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
449 $patron = Koha::Patrons->find( $borrowernumber );
450 $template_params->{issuecount} = $patron->checkouts->count;
453 $template_params->{item} = $item;
454 $template_params->{biblio} = $biblio;
455 $template_params->{itembiblionumber} = $biblio->biblionumber;
457 push @$checkout_infos, $template_params;
460 $template->param( %{$checkout_infos->[0]} );
461 $template->param( barcode => $barcodes->[0] );
463 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
465 checkout_infos => $checkout_infos,
466 confirmation_needed => $confirmation_needed,
471 ##################################################################################
473 # show all reserves of this borrower, and the position of the reservation ....
475 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
476 my $waiting_holds = $holds->waiting;
478 holds_count => $holds->count(),
479 WaitingHolds => $waiting_holds,
482 if ( C4::Context->preference('UseRecalls') ) {
483 my $waiting_recalls = $patron->recalls->search({ status => 'waiting' });
485 recalls => $patron->recalls->filter_by_current->search({},{ order_by => { -asc => 'created_date' } }),
486 specific_patron => 1,
487 waiting_recalls => $waiting_recalls,
494 if ( $patron->gonenoaddress ) {
495 $template->param( gonenoaddress => 1 );
498 if ( $patron->lost ) {
499 $template->param( lost=> 1 );
502 if ( $patron->is_debarred ) {
503 $template->param( is_debarred=> 1 );
506 if ( $patron->borrowernumber eq C4::Context->preference("AnonymousPatron") ) {
507 $template->param( is_anonymous => 1 );
510 my $account = $patron->account;
511 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
512 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
513 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
516 chargesamount => $owing,
518 } elsif ( $balance < 0 ) {
521 creditsamount => -$balance,
525 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
526 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
527 if ( $no_issues_charge_guarantors ) {
528 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
530 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
532 charges_guarantors_guarantees => $guarantors_non_issues_charges
534 $noissues = 1 unless C4::Context->preference("allowfineoverride");
538 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
539 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
540 if ( defined $no_issues_charge_guarantees ) {
541 my $guarantees_non_issues_charges = 0;
542 my $guarantees = $patron->guarantee_relationships->guarantees;
543 while ( my $g = $guarantees->next ) {
544 $guarantees_non_issues_charges += $g->account->non_issues_charges;
546 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
548 charges_guarantees => 1,
549 chargesamount_guarantees => $guarantees_non_issues_charges,
551 $noissues = 1 unless C4::Context->preference("allowfineoverride");
555 if ( $patron->has_overdues ) {
556 $template->param( odues => 1 );
559 if ( $patron->borrowernotes ) {
560 my $borrowernotes = $patron->borrowernotes;
561 $borrowernotes =~ s#\n#<br />#g;
564 notesmsg => $borrowernotes,
570 noissues => ($force_allow_issue) ? 0 : 'true',
571 forceallow => $force_allow_issue,
575 my $patron_messages = $patron->messages->search(
579 '+select' => ['manager.surname', 'manager.firstname' ],
580 '+as' => ['manager_surname', 'manager_firstname'],
583 $template->param( patron_messages => $patron_messages );
587 my $fast_cataloging = 0;
588 if ( Koha::BiblioFrameworks->find('FA') ) {
593 ?'batch_checkout_view'
598 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
599 push( @relatives, $_->id ) for @guarantors;
600 push( @relatives, $_->id ) for $patron->siblings->as_list;
602 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
605 my $relatives_issues_count =
606 Koha::Database->new()->schema()->resultset('Issue')
607 ->count( { borrowernumber => \@relatives } );
610 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
611 my $roadtype = $av->count ? $av->next->lib : '';
613 roadtype => $roadtype,
615 categoryname => $patron->category->description,
616 expiry => $patron->dateexpiry,
620 # Restore date if changed by holds and/or save stickyduedate to session
621 if ($restoreduedatespec || $stickyduedate) {
622 $duedatespec = $restoreduedatespec || $duedatespec;
624 if ($stickyduedate) {
625 $session->param( 'stickyduedate', $duedatespec );
627 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
632 borrowernumber => $borrowernumber,
634 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
635 barcodes => $barcodes,
636 stickyduedate => $stickyduedate,
637 duedatespec => $duedatespec,
638 restoreduedatespec => $restoreduedatespec,
640 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
641 inprocess => $inprocess,
643 batch_allowed => $batch_allowed,
645 AudioAlerts => C4::Context->preference("AudioAlerts"),
646 fast_cataloging => $fast_cataloging,
647 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
648 RoutingSerials => C4::Context->preference('RoutingSerials'),
649 relatives_issues_count => $relatives_issues_count,
650 relatives_borrowernumbers => \@relatives,
654 if ( C4::Context->preference("ExportCircHistory") ) {
655 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
658 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
660 debt_confirmed => $debt_confirmed,
661 SpecifyDueDate => $duedatespec_allow,
662 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
663 today_due_date_and_time => dt_from_string()->set(hour => 23)->set(minute => 59),
664 restriction_types => scalar Koha::Patron::Restriction::Types->search(),
665 has_modifications => $has_modifications,
666 override_high_holds => $override_high_holds,
667 nopermission => scalar $query->param('nopermission'),
668 autoswitched => $autoswitched,
669 logged_in_user => $logged_in_user,
672 # Generate CSRF token for upload and delete image buttons
674 csrf_token => Koha::Token->new->generate_csrf({ session_id => $query->cookie('CGISESSID'),}),
677 output_html_with_http_headers $query, $cookie, $template->output;