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 = barcodedecode( $barcode ) if $barcode;
164 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
165 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
166 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso' }); }
168 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
169 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
170 undef $restoreduedatespec;
172 my $issueconfirmed = $query->param('issueconfirmed');
173 my $cancelreserve = $query->param('cancelreserve');
174 my $cancel_recall = $query->param('cancel_recall');
175 my $recall_id = $query->param('recall_id');
176 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
177 my $charges = $query->param('charges') || q{};
179 # Check if stickyduedate is turned off
181 # was stickyduedate loaded from session?
182 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
183 $session->clear( 'stickyduedate' );
184 $stickyduedate = $query->param('stickyduedate');
185 $duedatespec = $query->param('duedatespec');
187 $session->param('auto_renew', scalar $query->param('auto_renew'));
190 $session->clear('auto_renew');
193 $template->param( auto_renew => $session->param('auto_renew') );
195 my ($datedue,$invalidduedate);
197 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
198 if( $onsite_checkout && !$duedatespec_allow ) {
199 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
200 $datedue .= ' 23:59:00';
201 } elsif( $duedatespec_allow ) {
202 if ( $duedatespec ) {
203 $datedue = eval { dt_from_string( $duedatespec ) };
206 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
211 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
212 if ( @$barcodes == 0 && $charges eq 'yes' ) {
215 borrowernumber => $borrowernumber
220 # STEP 2 : FIND BORROWER
221 # if there is a list of find borrowers....
225 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
226 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
228 $borrowernumber = $patron->borrowernumber;
230 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
235 # get the borrower information.....
237 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
240 $template->param( borrowernumber => $patron->borrowernumber );
241 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
243 my $overdues = $patron->get_overdues;
244 my $issues = $patron->checkouts;
245 $balance = $patron->account->balance;
248 # if the expiry date is before today ie they have expired
249 if ( $patron->is_expired ) {
250 #borrowercard expired, no issues
252 noissues => ($force_allow_issue) ? 0 : "1",
253 forceallow => $force_allow_issue,
257 # check for NotifyBorrowerDeparture
258 elsif ( $patron->is_going_to_expire ) {
259 # borrower card soon to expire warn librarian
260 $template->param( "warndeparture" => $patron->dateexpiry ,
262 if (C4::Context->preference('ReturnBeforeExpiry')){
263 $template->param("returnbeforeexpiry" => 1);
267 overduecount => $overdues->count,
268 issuecount => $issues->count,
269 finetotal => $balance,
272 if ( $patron and $patron->is_debarred ) {
274 'userdebarred' => $patron->debarred,
275 'debarredcomment' => $patron->debarredcomment,
278 if ( $patron->debarred ne "9999-12-31" ) {
279 $template->param( 'userdebarreddate' => $patron->debarred );
283 # Calculate and display patron's age
284 if ( !$patron->is_valid_age ) {
285 $template->param( age_limitations => 1 );
286 $template->param( age_low => $patron->category->dateofbirthrequired );
287 $template->param( age_high => $patron->category->upperagelimit );
298 for my $barcode ( @$barcodes ) {
300 my $template_params = {
302 onsite_checkout => $onsite_checkout,
305 # always check for blockers on issuing
306 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
312 onsite_checkout => $onsite_checkout,
313 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
317 my $blocker = $invalidduedate ? 1 : 0;
319 $template_params->{alert} = $alerts;
320 $template_params->{messages} = $messages;
322 my $item = Koha::Items->find({ barcode => $barcode });
326 $biblio = $item->biblio;
329 # Fix for bug 7494: optional checkout-time fallback search for a book
331 if ( $error->{'UNKNOWN_BARCODE'}
332 && C4::Context->preference("itemBarcodeFallbackSearch")
336 $template_params->{FALLBACK} = 1;
338 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
339 my $query = "kw=" . $barcode;
340 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
342 # if multiple hits, offer options to librarian
343 if ( $total_hits > 0 ) {
345 foreach my $hit ( @{$results} ) {
346 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
347 TransformMarcToKoha({ record => C4::Search::new_record_from_zebra('biblioserver',$hit) });
349 # offer all barcodes individually
350 if ( $chosen->{barcode} ) {
351 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
354 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
355 $template_params->{options} = $items;
359 # Only some errors will block when performing forced onsite checkout,
360 # for other cases all errors will block
361 my @blocking_error_codes = ($onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce")) ?
362 qw( UNKNOWN_BARCODE ) : (keys %$error);
364 foreach my $code ( @blocking_error_codes ) {
365 if ($error->{$code}) {
366 $template_params->{$code} = $error->{$code};
367 $template_params->{IMPOSSIBLE} = 1;
372 delete $question->{'DEBT'} if ($debt_confirmed);
374 if( $item and ( !$blocker or $force_allow_issue ) ){
375 my $confirm_required = 0;
376 unless($issueconfirmed){
377 # Get the item title for more information
378 my $materials = $item->materials;
379 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
380 $materials = $descriptions->{lib} // $materials;
381 $template_params->{ADDITIONAL_MATERIALS} = $materials;
382 $template_params->{itemhomebranch} = $item->homebranch;
384 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
385 foreach my $needsconfirmation ( keys %$question ) {
386 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
387 $template_params->{getTitleMessageIteminfo} = $biblio->title;
388 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
389 $template_params->{NEEDSCONFIRMATION} = 1;
390 $confirm_required = 1;
393 unless($confirm_required) {
394 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
395 if ( C4::Context->preference('UseRecalls') && !$recall_id ) {
396 my $recall = Koha::Recalls->find(
398 biblio_id => $item->biblionumber,
399 item_id => [ undef, $item->itemnumber ],
400 status => [ 'requested', 'waiting' ],
402 patron_id => $patron->borrowernumber,
405 $recall_id = ( $recall and $recall->id ) ? $recall->id : undef;
407 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, } );
408 $template_params->{issue} = $issue;
409 $session->clear('auto_renew');
414 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
416 reserveborrowernumber => $question->{'resborrowernumber'},
417 reserve_id => $question->{reserve_id},
422 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
423 $patron = Koha::Patrons->find( $borrowernumber );
424 $template_params->{issuecount} = $patron->checkouts->count;
427 $template_params->{item} = $item;
428 $template_params->{biblio} = $biblio;
429 $template_params->{itembiblionumber} = $biblio->biblionumber;
431 push @$checkout_infos, $template_params;
434 $template->param( %{$checkout_infos->[0]} );
435 $template->param( barcode => $barcodes->[0] );
437 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
439 checkout_infos => $checkout_infos,
440 confirmation_needed => $confirmation_needed,
445 ##################################################################################
447 # show all reserves of this borrower, and the position of the reservation ....
449 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
450 my $waiting_holds = $holds->waiting;
452 holds_count => $holds->count(),
453 WaitingHolds => $waiting_holds,
455 if ( C4::Context->preference('UseRecalls') ) {
457 recalls => $patron->recalls->filter_by_current->search({},{ order_by => { -asc => 'created_date' } }),
458 specific_patron => 1,
465 if ( $patron->gonenoaddress ) {
466 $template->param( gonenoaddress => 1 );
469 if ( $patron->lost ) {
470 $template->param( lost=> 1 );
473 if ( $patron->is_debarred ) {
474 $template->param( is_debarred=> 1 );
477 my $account = $patron->account;
478 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
479 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
480 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
483 chargesamount => $owing,
485 } elsif ( $balance < 0 ) {
488 creditsamount => -$balance,
492 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
493 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
494 if ( $no_issues_charge_guarantors ) {
495 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
497 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
499 charges_guarantors_guarantees => $guarantors_non_issues_charges
501 $noissues = 1 unless C4::Context->preference("allowfineoverride");
505 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
506 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
507 if ( defined $no_issues_charge_guarantees ) {
508 my $guarantees_non_issues_charges = 0;
509 my $guarantees = $patron->guarantee_relationships->guarantees;
510 while ( my $g = $guarantees->next ) {
511 $guarantees_non_issues_charges += $g->account->non_issues_charges;
513 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
515 charges_guarantees => 1,
516 chargesamount_guarantees => $guarantees_non_issues_charges,
518 $noissues = 1 unless C4::Context->preference("allowfineoverride");
522 if ( $patron->has_overdues ) {
523 $template->param( odues => 1 );
526 if ( $patron->borrowernotes ) {
527 my $borrowernotes = $patron->borrowernotes;
528 $borrowernotes =~ s#\n#<br />#g;
531 notesmsg => $borrowernotes,
537 noissues => ($force_allow_issue) ? 0 : 'true',
538 forceallow => $force_allow_issue,
542 my $patron_messages = $patron->messages->search(
546 '+select' => ['manager.surname', 'manager.firstname' ],
547 '+as' => ['manager_surname', 'manager_firstname'],
550 $template->param( patron_messages => $patron_messages );
554 my $fast_cataloging = 0;
555 if ( Koha::BiblioFrameworks->find('FA') ) {
560 ?'batch_checkout_view'
565 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
566 push( @relatives, $_->id ) for @guarantors;
567 push( @relatives, $_->id ) for $patron->siblings->as_list;
569 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
572 my $relatives_issues_count =
573 Koha::Database->new()->schema()->resultset('Issue')
574 ->count( { borrowernumber => \@relatives } );
577 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
578 my $roadtype = $av->count ? $av->next->lib : '';
580 roadtype => $roadtype,
582 categoryname => $patron->category->description,
583 expiry => $patron->dateexpiry,
587 # Restore date if changed by holds and/or save stickyduedate to session
588 if ($restoreduedatespec || $stickyduedate) {
589 $duedatespec = $restoreduedatespec || $duedatespec;
591 if ($stickyduedate) {
592 $session->param( 'stickyduedate', $duedatespec );
594 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
599 borrowernumber => $borrowernumber,
601 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
602 barcodes => $barcodes,
603 stickyduedate => $stickyduedate,
604 duedatespec => $duedatespec,
605 restoreduedatespec => $restoreduedatespec,
607 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
608 inprocess => $inprocess,
610 batch_allowed => $batch_allowed,
612 AudioAlerts => C4::Context->preference("AudioAlerts"),
613 fast_cataloging => $fast_cataloging,
614 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
615 RoutingSerials => C4::Context->preference('RoutingSerials'),
616 relatives_issues_count => $relatives_issues_count,
617 relatives_borrowernumbers => \@relatives,
621 if ( C4::Context->preference("ExportCircHistory") ) {
622 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
625 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
627 debt_confirmed => $debt_confirmed,
628 SpecifyDueDate => $duedatespec_allow,
629 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
630 debarments => scalar GetDebarments({ borrowernumber => $borrowernumber }),
631 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
632 has_modifications => $has_modifications,
633 override_high_holds => $override_high_holds,
634 nopermission => scalar $query->param('nopermission'),
635 autoswitched => $autoswitched,
636 logged_in_user => $logged_in_user,
639 output_html_with_http_headers $query, $cookie, $template->output;