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 );
37 use C4::Utils::DataTables::Members;
39 use C4::Biblio qw( TransformMarcToKoha );
40 use C4::Search qw( new_record_from_zebra );
45 use Koha::AuthorisedValues;
46 use Koha::CsvProfiles;
48 use Koha::Patron::Debarments qw( GetDebarments );
49 use Koha::DateUtils qw( dt_from_string output_pref );
52 use Koha::BiblioFrameworks;
54 use Koha::SearchEngine;
55 use Koha::SearchEngine::Search;
56 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 if (C4::Context->preference("DisplayClearScreenButton")) {
158 $template->param(DisplayClearScreenButton => 1);
161 for my $barcode ( @$barcodes ) {
162 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
163 $barcode = barcodedecode( $barcode ) if $barcode;
166 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
167 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
168 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso' }); }
170 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
171 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
172 undef $restoreduedatespec;
174 my $issueconfirmed = $query->param('issueconfirmed');
175 my $cancelreserve = $query->param('cancelreserve');
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( 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 if ( $error->{DEBT_GUARANTORS} ) {
360 $template_params->{DEBT_GUARANTORS} = $error->{DEBT_GUARANTORS};
361 $template_params->{IMPOSSIBLE} = 1;
365 if ( $error->{UNKNOWN_BARCODE} or not $onsite_checkout or not C4::Context->preference("OnSiteCheckoutsForce") ) {
366 delete $question->{'DEBT'} if ($debt_confirmed);
367 foreach my $impossible ( keys %$error ) {
368 $template_params->{$impossible} = $$error{$impossible};
369 $template_params->{IMPOSSIBLE} = 1;
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 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, } );
396 $template_params->{issue} = $issue;
397 $session->clear('auto_renew');
402 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
404 reserveborrowernumber => $question->{'resborrowernumber'},
405 reserve_id => $question->{reserve_id},
410 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
411 $patron = Koha::Patrons->find( $borrowernumber );
412 $template_params->{issuecount} = $patron->checkouts->count;
415 $template_params->{item} = $item;
416 $template_params->{biblio} = $biblio;
417 $template_params->{itembiblionumber} = $biblio->biblionumber;
419 push @$checkout_infos, $template_params;
422 $template->param( %{$checkout_infos->[0]} );
423 $template->param( barcode => $barcodes->[0] );
425 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
427 checkout_infos => $checkout_infos,
428 confirmation_needed => $confirmation_needed,
433 ##################################################################################
435 # show all reserves of this borrower, and the position of the reservation ....
437 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
438 my $waiting_holds = $holds->waiting;
440 holds_count => $holds->count(),
441 WaitingHolds => $waiting_holds,
447 if ( $patron->gonenoaddress ) {
448 $template->param( gonenoaddress => 1 );
451 if ( $patron->lost ) {
452 $template->param( lost=> 1 );
455 if ( $patron->is_debarred ) {
456 $template->param( is_debarred=> 1 );
459 my $account = $patron->account;
460 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
461 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
462 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
465 chargesamount => $owing,
467 } elsif ( $balance < 0 ) {
470 creditsamount => -$balance,
474 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
475 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
476 if ( $no_issues_charge_guarantors ) {
477 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
479 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
481 charges_guarantors_guarantees => $guarantors_non_issues_charges
483 $noissues = 1 unless C4::Context->preference("allowfineoverride");
487 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
488 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
489 if ( defined $no_issues_charge_guarantees ) {
490 my $guarantees_non_issues_charges = 0;
491 my $guarantees = $patron->guarantee_relationships->guarantees;
492 while ( my $g = $guarantees->next ) {
493 $guarantees_non_issues_charges += $g->account->non_issues_charges;
495 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
497 charges_guarantees => 1,
498 chargesamount_guarantees => $guarantees_non_issues_charges,
500 $noissues = 1 unless C4::Context->preference("allowfineoverride");
504 if ( $patron->has_overdues ) {
505 $template->param( odues => 1 );
508 if ( $patron->borrowernotes ) {
509 my $borrowernotes = $patron->borrowernotes;
510 $borrowernotes =~ s#\n#<br />#g;
513 notesmsg => $borrowernotes,
519 noissues => ($force_allow_issue) ? 0 : 'true',
520 forceallow => $force_allow_issue,
525 my $patron_messages = $patron->messages->search(
529 '+select' => ['manager.surname', 'manager.firstname' ],
530 '+as' => ['manager_surname', 'manager_firstname'],
534 my $fast_cataloging = 0;
535 if ( Koha::BiblioFrameworks->find('FA') ) {
540 ?'batch_checkout_view'
545 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
546 push( @relatives, $_->id ) for @guarantors;
547 push( @relatives, $_->id ) for $patron->siblings->as_list;
549 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
552 my $relatives_issues_count =
553 Koha::Database->new()->schema()->resultset('Issue')
554 ->count( { borrowernumber => \@relatives } );
557 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
558 my $roadtype = $av->count ? $av->next->lib : '';
560 roadtype => $roadtype,
562 categoryname => $patron->category->description,
563 expiry => $patron->dateexpiry,
567 # Restore date if changed by holds and/or save stickyduedate to session
568 if ($restoreduedatespec || $stickyduedate) {
569 $duedatespec = $restoreduedatespec || $duedatespec;
571 if ($stickyduedate) {
572 $session->param( 'stickyduedate', $duedatespec );
574 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
579 patron_messages => $patron_messages,
580 borrowernumber => $borrowernumber,
582 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
583 barcodes => $barcodes,
584 stickyduedate => $stickyduedate,
585 duedatespec => $duedatespec,
586 restoreduedatespec => $restoreduedatespec,
588 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
589 inprocess => $inprocess,
591 batch_allowed => $batch_allowed,
593 AudioAlerts => C4::Context->preference("AudioAlerts"),
594 fast_cataloging => $fast_cataloging,
595 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
596 RoutingSerials => C4::Context->preference('RoutingSerials'),
597 relatives_issues_count => $relatives_issues_count,
598 relatives_borrowernumbers => \@relatives,
602 if ( C4::Context->preference("ExportCircHistory") ) {
603 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
606 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
608 debt_confirmed => $debt_confirmed,
609 SpecifyDueDate => $duedatespec_allow,
610 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
611 debarments => scalar GetDebarments({ borrowernumber => $borrowernumber }),
612 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
613 has_modifications => $has_modifications,
614 override_high_holds => $override_high_holds,
615 nopermission => scalar $query->param('nopermission'),
616 autoswitched => $autoswitched,
617 logged_in_user => $logged_in_user,
620 output_html_with_http_headers $query, $cookie, $template->output;