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::DateUtils qw( dt_from_string );
48 use Koha::Patron::Restriction::Types;
51 use Koha::BiblioFrameworks;
53 use Koha::SearchEngine;
54 use Koha::SearchEngine::Search;
55 use Koha::Patron::Modifications;
58 use List::MoreUtils qw( uniq );
65 my $override_high_holds = $query->param('override_high_holds');
66 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
68 my $sessionID = $query->cookie("CGISESSID") ;
69 my $session = get_session($sessionID);
72 my $barcode = $query->param('barcode');
75 my $borrowernumber = $query->param('borrowernumber');
77 if (C4::Context->preference("AutoSwitchPatron") && $barcode) {
78 my $new_barcode = $barcode;
79 Koha::Plugins->call( 'patron_barcode_transform', \$new_barcode );
80 if (Koha::Patrons->search( { cardnumber => $new_barcode} )->count() > 0) {
81 $findborrower = $barcode;
83 undef $borrowernumber;
87 $findborrower ||= $query->param('findborrower') || q{};
88 $findborrower =~ s|,| |g;
90 # Barcode given by user could be '0'
91 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
92 $barcodes = [ $barcode ];
94 my $filefh = $query->upload('uploadfile');
96 while ( my $content = <$filefh> ) {
97 $content =~ s/[\r\n]*$//g;
98 push @$barcodes, $content if $content;
100 } elsif ( my $list = $query->param('barcodelist') ) {
101 push @$barcodes, split( /\s\n/, $list );
102 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
104 @$barcodes = $query->multi_param('barcodes');
108 $barcodes = [ uniq @$barcodes ];
110 my $template_name = q|circ/circulation.tt|;
111 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
112 my $batch = $query->param('batch');
113 my $batch_allowed = 0;
114 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
115 $template_name = q|circ/circulation_batch_checkouts.tt|;
116 my @batch_category_codes = split ',', C4::Context->preference('BatchCheckoutsValidCategories');
117 my $categorycode = $patron->categorycode;
118 if ( $categorycode && grep { $_ eq $categorycode } @batch_category_codes ) {
125 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
127 template_name => $template_name,
130 flagsrequired => { circulate => 'circulate_remaining_permissions' },
133 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
135 my $force_allow_issue = $query->param('forceallow') || 0;
136 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
137 $force_allow_issue = 0;
139 my $onsite_checkout = $query->param('onsite_checkout');
141 if (C4::Context->preference("OnSiteCheckoutAutoCheck") && $onsite_checkout eq "on") {
142 $template->param(onsite_checkout => $onsite_checkout);
145 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
146 our %renew_failed = ();
147 for (@failedrenews) { $renew_failed{$_} = 1; }
149 my @failedreturns = $query->multi_param('failedreturn');
150 our %return_failed = ();
151 for (@failedreturns) { $return_failed{$_} = 1; }
153 my $searchtype = $query->param('searchtype') || q{contain};
155 my $branch = C4::Context->userenv->{'branch'};
157 for my $barcode ( @$barcodes ) {
158 $barcode = barcodedecode( $barcode ) if $barcode;
161 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
162 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
163 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
164 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
165 undef $restoreduedatespec;
167 my $issueconfirmed = $query->param('issueconfirmed');
168 my $cancelreserve = $query->param('cancelreserve');
169 my $cancel_recall = $query->param('cancel_recall');
170 my $recall_id = $query->param('recall_id');
171 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
172 my $charges = $query->param('charges') || q{};
174 # Check if stickyduedate is turned off
176 # was stickyduedate loaded from session?
177 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
178 $session->clear( 'stickyduedate' );
179 $stickyduedate = $query->param('stickyduedate');
180 $duedatespec = $query->param('duedatespec');
182 $session->param('auto_renew', scalar $query->param('auto_renew'));
185 $session->clear('auto_renew');
188 $template->param( auto_renew => $session->param('auto_renew') );
190 my ($datedue,$invalidduedate);
192 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
193 if( $onsite_checkout && !$duedatespec_allow ) {
194 $datedue = dt_from_string()->truncate(to => 'day');
195 $datedue->set_hour(23);
196 $datedue->set_minute(59);
197 } elsif( $duedatespec_allow ) {
198 if ( $duedatespec ) {
199 $datedue = eval { dt_from_string( $duedatespec ) };
202 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
207 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
208 if ( @$barcodes == 0 && $charges eq 'yes' ) {
211 borrowernumber => $borrowernumber
216 # STEP 2 : FIND BORROWER
217 # if there is a list of find borrowers....
221 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
222 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
224 $borrowernumber = $patron->borrowernumber;
226 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
231 # get the borrower information.....
233 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
236 $template->param( borrowernumber => $patron->borrowernumber );
237 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
239 my $overdues = $patron->overdues;
240 my $issues = $patron->checkouts;
241 $balance = $patron->account->balance;
244 # if the expiry date is before today ie they have expired
245 if ( $patron->is_expired ) {
246 #borrowercard expired, no issues
248 noissues => ($force_allow_issue) ? 0 : "1",
249 forceallow => $force_allow_issue,
253 # check for NotifyBorrowerDeparture
254 elsif ( $patron->is_going_to_expire ) {
255 # borrower card soon to expire warn librarian
256 $template->param( "warndeparture" => $patron->dateexpiry ,
258 if (C4::Context->preference('ReturnBeforeExpiry')){
259 $template->param("returnbeforeexpiry" => 1);
263 overduecount => $overdues->count,
264 issuecount => $issues->count,
265 finetotal => $balance,
268 if ( $patron and $patron->is_debarred ) {
270 'userdebarred' => $patron->debarred,
271 'debarredcomment' => $patron->debarredcomment,
274 if ( $patron->debarred ne "9999-12-31" ) {
275 $template->param( 'userdebarreddate' => $patron->debarred );
279 # Calculate and display patron's age
280 if ( !$patron->is_valid_age ) {
281 $template->param( age_limitations => 1 );
282 $template->param( age_low => $patron->category->dateofbirthrequired );
283 $template->param( age_high => $patron->category->upperagelimit );
294 for my $barcode ( @$barcodes ) {
296 my $template_params = {
298 onsite_checkout => $onsite_checkout,
301 # always check for blockers on issuing
302 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
308 onsite_checkout => $onsite_checkout,
309 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
313 my $blocker = $invalidduedate ? 1 : 0;
315 $template_params->{alert} = $alerts;
316 $template_params->{messages} = $messages;
318 my $item = Koha::Items->find({ barcode => $barcode });
322 $biblio = $item->biblio;
325 # Fix for bug 7494: optional checkout-time fallback search for a book
327 if ( $error->{'UNKNOWN_BARCODE'}
328 && C4::Context->preference("itemBarcodeFallbackSearch")
332 $template_params->{FALLBACK} = 1;
334 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
335 my $query = "kw=" . $barcode;
336 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
338 # if multiple hits, offer options to librarian
339 if ( $total_hits > 0 ) {
341 foreach my $hit ( @{$results} ) {
342 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
343 TransformMarcToKoha({ record => C4::Search::new_record_from_zebra('biblioserver',$hit) });
345 # offer all barcodes individually
346 if ( $chosen->{barcode} ) {
347 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
350 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
351 $template_params->{options} = $items;
355 # Only some errors will block when performing forced onsite checkout,
356 # for other cases all errors will block
357 my @blocking_error_codes = ($onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce")) ?
358 qw( UNKNOWN_BARCODE ) : (keys %$error);
360 foreach my $code ( @blocking_error_codes ) {
361 if ($error->{$code}) {
362 $template_params->{$code} = $error->{$code};
363 $template_params->{IMPOSSIBLE} = 1;
368 delete $question->{'DEBT'} if ($debt_confirmed);
370 if( $item and ( !$blocker or $force_allow_issue ) ){
371 my $confirm_required = 0;
372 unless($issueconfirmed){
373 # Get the item title for more information
374 my $materials = $item->materials;
375 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
376 $materials = $descriptions->{lib} // $materials;
377 $template_params->{ADDITIONAL_MATERIALS} = $materials;
378 $template_params->{itemhomebranch} = $item->homebranch;
380 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
381 foreach my $needsconfirmation ( keys %$question ) {
382 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
383 $template_params->{getTitleMessageIteminfo} = $biblio->title;
384 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
385 $template_params->{NEEDSCONFIRMATION} = 1;
386 $confirm_required = 1;
389 unless($confirm_required) {
390 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
391 if ( C4::Context->preference('UseRecalls') && !$recall_id ) {
392 my $recall = Koha::Recalls->find(
394 biblio_id => $item->biblionumber,
395 item_id => [ undef, $item->itemnumber ],
396 status => [ 'requested', 'waiting' ],
398 patron_id => $patron->borrowernumber,
401 $recall_id = ( $recall and $recall->id ) ? $recall->id : undef;
403 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, } );
404 $template_params->{issue} = $issue;
405 $session->clear('auto_renew');
410 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
412 reserveborrowernumber => $question->{'resborrowernumber'},
413 reserve_id => $question->{reserve_id},
418 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
419 $patron = Koha::Patrons->find( $borrowernumber );
420 $template_params->{issuecount} = $patron->checkouts->count;
423 $template_params->{item} = $item;
424 $template_params->{biblio} = $biblio;
425 $template_params->{itembiblionumber} = $biblio->biblionumber;
427 push @$checkout_infos, $template_params;
430 $template->param( %{$checkout_infos->[0]} );
431 $template->param( barcode => $barcodes->[0] );
433 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
435 checkout_infos => $checkout_infos,
436 confirmation_needed => $confirmation_needed,
441 ##################################################################################
443 # show all reserves of this borrower, and the position of the reservation ....
445 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
446 my $waiting_holds = $holds->waiting;
448 holds_count => $holds->count(),
449 WaitingHolds => $waiting_holds,
452 if ( C4::Context->preference('UseRecalls') ) {
453 my $waiting_recalls = $patron->recalls->search({ status => 'waiting' });
455 recalls => $patron->recalls->filter_by_current->search({},{ order_by => { -asc => 'created_date' } }),
456 specific_patron => 1,
457 waiting_recalls => $waiting_recalls,
464 if ( $patron->gonenoaddress ) {
465 $template->param( gonenoaddress => 1 );
468 if ( $patron->lost ) {
469 $template->param( lost=> 1 );
472 if ( $patron->is_debarred ) {
473 $template->param( is_debarred=> 1 );
476 my $account = $patron->account;
477 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
478 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
479 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
482 chargesamount => $owing,
484 } elsif ( $balance < 0 ) {
487 creditsamount => -$balance,
491 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
492 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
493 if ( $no_issues_charge_guarantors ) {
494 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
496 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
498 charges_guarantors_guarantees => $guarantors_non_issues_charges
500 $noissues = 1 unless C4::Context->preference("allowfineoverride");
504 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
505 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
506 if ( defined $no_issues_charge_guarantees ) {
507 my $guarantees_non_issues_charges = 0;
508 my $guarantees = $patron->guarantee_relationships->guarantees;
509 while ( my $g = $guarantees->next ) {
510 $guarantees_non_issues_charges += $g->account->non_issues_charges;
512 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
514 charges_guarantees => 1,
515 chargesamount_guarantees => $guarantees_non_issues_charges,
517 $noissues = 1 unless C4::Context->preference("allowfineoverride");
521 if ( $patron->has_overdues ) {
522 $template->param( odues => 1 );
525 if ( $patron->borrowernotes ) {
526 my $borrowernotes = $patron->borrowernotes;
527 $borrowernotes =~ s#\n#<br />#g;
530 notesmsg => $borrowernotes,
536 noissues => ($force_allow_issue) ? 0 : 'true',
537 forceallow => $force_allow_issue,
541 my $patron_messages = $patron->messages->search(
545 '+select' => ['manager.surname', 'manager.firstname' ],
546 '+as' => ['manager_surname', 'manager_firstname'],
549 $template->param( patron_messages => $patron_messages );
553 my $fast_cataloging = 0;
554 if ( Koha::BiblioFrameworks->find('FA') ) {
559 ?'batch_checkout_view'
564 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
565 push( @relatives, $_->id ) for @guarantors;
566 push( @relatives, $_->id ) for $patron->siblings->as_list;
568 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
571 my $relatives_issues_count =
572 Koha::Database->new()->schema()->resultset('Issue')
573 ->count( { borrowernumber => \@relatives } );
576 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
577 my $roadtype = $av->count ? $av->next->lib : '';
579 roadtype => $roadtype,
581 categoryname => $patron->category->description,
582 expiry => $patron->dateexpiry,
586 # Restore date if changed by holds and/or save stickyduedate to session
587 if ($restoreduedatespec || $stickyduedate) {
588 $duedatespec = $restoreduedatespec || $duedatespec;
590 if ($stickyduedate) {
591 $session->param( 'stickyduedate', $duedatespec );
593 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
598 borrowernumber => $borrowernumber,
600 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
601 barcodes => $barcodes,
602 stickyduedate => $stickyduedate,
603 duedatespec => $duedatespec,
604 restoreduedatespec => $restoreduedatespec,
606 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
607 inprocess => $inprocess,
609 batch_allowed => $batch_allowed,
611 AudioAlerts => C4::Context->preference("AudioAlerts"),
612 fast_cataloging => $fast_cataloging,
613 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
614 RoutingSerials => C4::Context->preference('RoutingSerials'),
615 relatives_issues_count => $relatives_issues_count,
616 relatives_borrowernumbers => \@relatives,
620 if ( C4::Context->preference("ExportCircHistory") ) {
621 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
624 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
626 debt_confirmed => $debt_confirmed,
627 SpecifyDueDate => $duedatespec_allow,
628 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
629 todaysdate => dt_from_string()->set(hour => 23)->set(minute => 59),
630 restriction_types => scalar Koha::Patron::Restriction::Types->search(),
631 has_modifications => $has_modifications,
632 override_high_holds => $override_high_holds,
633 nopermission => scalar $query->param('nopermission'),
634 autoswitched => $autoswitched,
635 logged_in_user => $logged_in_user,
638 # Generate CSRF token for upload and delete image buttons
640 csrf_token => Koha::Token->new->generate_csrf({ session_id => $query->cookie('CGISESSID'),}),
643 output_html_with_http_headers $query, $cookie, $template->output;