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::Patron::Messages;
55 use Koha::SearchEngine;
56 use Koha::SearchEngine::Search;
57 use Koha::Patron::Modifications;
59 use List::MoreUtils qw( uniq );
66 my $override_high_holds = $query->param('override_high_holds');
67 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
69 my $sessionID = $query->cookie("CGISESSID") ;
70 my $session = get_session($sessionID);
73 my $barcode = $query->param('barcode');
76 my $borrowernumber = $query->param('borrowernumber');
78 if (C4::Context->preference("AutoSwitchPatron") && $barcode) {
79 my $new_barcode = $findborrower;
80 Koha::Plugins->call( 'patron_barcode_transform', \$new_barcode );
81 if (Koha::Patrons->search( { cardnumber => $new_barcode} )->count() > 0) {
82 $findborrower = $barcode;
84 undef $borrowernumber;
88 $findborrower ||= $query->param('findborrower') || q{};
89 $findborrower =~ s|,| |g;
91 # Barcode given by user could be '0'
92 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
93 $barcodes = [ $barcode ];
95 my $filefh = $query->upload('uploadfile');
97 while ( my $content = <$filefh> ) {
98 $content =~ s/[\r\n]*$//g;
99 push @$barcodes, $content if $content;
101 } elsif ( my $list = $query->param('barcodelist') ) {
102 push @$barcodes, split( /\s\n/, $list );
103 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
105 @$barcodes = $query->multi_param('barcodes');
109 $barcodes = [ uniq @$barcodes ];
111 my $template_name = q|circ/circulation.tt|;
112 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
113 my $batch = $query->param('batch');
114 my $batch_allowed = 0;
115 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
116 $template_name = q|circ/circulation_batch_checkouts.tt|;
117 my @batch_category_codes = split ',', C4::Context->preference('BatchCheckoutsValidCategories');
118 my $categorycode = $patron->categorycode;
119 if ( $categorycode && grep { $_ eq $categorycode } @batch_category_codes ) {
126 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
128 template_name => $template_name,
131 flagsrequired => { circulate => 'circulate_remaining_permissions' },
134 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
136 my $force_allow_issue = $query->param('forceallow') || 0;
137 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
138 $force_allow_issue = 0;
140 my $onsite_checkout = $query->param('onsite_checkout');
142 if (C4::Context->preference("OnSiteCheckoutAutoCheck") && $onsite_checkout eq "on") {
143 $template->param(onsite_checkout => $onsite_checkout);
146 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
147 our %renew_failed = ();
148 for (@failedrenews) { $renew_failed{$_} = 1; }
150 my @failedreturns = $query->multi_param('failedreturn');
151 our %return_failed = ();
152 for (@failedreturns) { $return_failed{$_} = 1; }
154 my $searchtype = $query->param('searchtype') || q{contain};
156 my $branch = C4::Context->userenv->{'branch'};
158 if (C4::Context->preference("DisplayClearScreenButton")) {
159 $template->param(DisplayClearScreenButton => 1);
162 for my $barcode ( @$barcodes ) {
163 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
164 $barcode = barcodedecode( $barcode ) if $barcode;
167 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
168 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
169 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso' }); }
171 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
172 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
173 undef $restoreduedatespec;
175 my $issueconfirmed = $query->param('issueconfirmed');
176 my $cancelreserve = $query->param('cancelreserve');
177 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
178 my $charges = $query->param('charges') || q{};
180 # Check if stickyduedate is turned off
182 # was stickyduedate loaded from session?
183 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
184 $session->clear( 'stickyduedate' );
185 $stickyduedate = $query->param('stickyduedate');
186 $duedatespec = $query->param('duedatespec');
188 $session->param('auto_renew', scalar $query->param('auto_renew'));
191 $session->clear('auto_renew');
194 $template->param( auto_renew => $session->param('auto_renew') );
196 my ($datedue,$invalidduedate);
198 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
199 if( $onsite_checkout && !$duedatespec_allow ) {
200 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
201 $datedue .= ' 23:59:00';
202 } elsif( $duedatespec_allow ) {
203 if ( $duedatespec ) {
204 $datedue = eval { dt_from_string( $duedatespec ) };
207 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
212 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
213 if ( @$barcodes == 0 && $charges eq 'yes' ) {
216 borrowernumber => $borrowernumber
221 # STEP 2 : FIND BORROWER
222 # if there is a list of find borrowers....
226 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
227 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
229 $borrowernumber = $patron->borrowernumber;
231 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
236 # get the borrower information.....
238 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
241 $template->param( borrowernumber => $patron->borrowernumber );
242 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
244 my $overdues = $patron->get_overdues;
245 my $issues = $patron->checkouts;
246 $balance = $patron->account->balance;
249 # if the expiry date is before today ie they have expired
250 if ( $patron->is_expired ) {
251 #borrowercard expired, no issues
253 noissues => ($force_allow_issue) ? 0 : "1",
254 forceallow => $force_allow_issue,
258 # check for NotifyBorrowerDeparture
259 elsif ( $patron->is_going_to_expire ) {
260 # borrower card soon to expire warn librarian
261 $template->param( "warndeparture" => $patron->dateexpiry ,
263 if (C4::Context->preference('ReturnBeforeExpiry')){
264 $template->param("returnbeforeexpiry" => 1);
268 overduecount => $overdues->count,
269 issuecount => $issues->count,
270 finetotal => $balance,
273 if ( $patron and $patron->is_debarred ) {
275 'userdebarred' => $patron->debarred,
276 'debarredcomment' => $patron->debarredcomment,
279 if ( $patron->debarred ne "9999-12-31" ) {
280 $template->param( 'userdebarreddate' => $patron->debarred );
284 # Calculate and display patron's age
285 if ( !$patron->is_valid_age ) {
286 $template->param( age_limitations => 1 );
287 $template->param( age_low => $patron->category->dateofbirthrequired );
288 $template->param( age_high => $patron->category->upperagelimit );
299 for my $barcode ( @$barcodes ) {
301 my $template_params = {
303 onsite_checkout => $onsite_checkout,
306 # always check for blockers on issuing
307 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
313 onsite_checkout => $onsite_checkout,
314 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
318 my $blocker = $invalidduedate ? 1 : 0;
320 $template_params->{alert} = $alerts;
321 $template_params->{messages} = $messages;
323 my $item = Koha::Items->find({ barcode => $barcode });
327 $biblio = $item->biblio;
330 # Fix for bug 7494: optional checkout-time fallback search for a book
332 if ( $error->{'UNKNOWN_BARCODE'}
333 && C4::Context->preference("itemBarcodeFallbackSearch")
337 $template_params->{FALLBACK} = 1;
339 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
340 my $query = "kw=" . $barcode;
341 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
343 # if multiple hits, offer options to librarian
344 if ( $total_hits > 0 ) {
346 foreach my $hit ( @{$results} ) {
347 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
348 TransformMarcToKoha( C4::Search::new_record_from_zebra('biblioserver',$hit) );
350 # offer all barcodes individually
351 if ( $chosen->{barcode} ) {
352 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
355 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
356 $template_params->{options} = $items;
360 if ( $error->{DEBT_GUARANTORS} ) {
361 $template_params->{DEBT_GUARANTORS} = $error->{DEBT_GUARANTORS};
362 $template_params->{IMPOSSIBLE} = 1;
366 if ( $error->{UNKNOWN_BARCODE} or not $onsite_checkout or not C4::Context->preference("OnSiteCheckoutsForce") ) {
367 delete $question->{'DEBT'} if ($debt_confirmed);
368 foreach my $impossible ( keys %$error ) {
369 $template_params->{$impossible} = $$error{$impossible};
370 $template_params->{IMPOSSIBLE} = 1;
375 if( $item and ( !$blocker or $force_allow_issue ) ){
376 my $confirm_required = 0;
377 unless($issueconfirmed){
378 # Get the item title for more information
379 my $materials = $item->materials;
380 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
381 $materials = $descriptions->{lib} // $materials;
382 $template_params->{ADDITIONAL_MATERIALS} = $materials;
383 $template_params->{itemhomebranch} = $item->homebranch;
385 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
386 foreach my $needsconfirmation ( keys %$question ) {
387 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
388 $template_params->{getTitleMessageIteminfo} = $biblio->title;
389 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
390 $template_params->{NEEDSCONFIRMATION} = 1;
391 $confirm_required = 1;
394 unless($confirm_required) {
395 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
396 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, } );
397 $template_params->{issue} = $issue;
398 $session->clear('auto_renew');
403 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
405 reserveborrowernumber => $question->{'resborrowernumber'},
406 reserve_id => $question->{reserve_id},
411 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
412 $patron = Koha::Patrons->find( $borrowernumber );
413 $template_params->{issuecount} = $patron->checkouts->count;
416 $template_params->{item} = $item;
417 $template_params->{biblio} = $biblio;
418 $template_params->{itembiblionumber} = $biblio->biblionumber;
420 push @$checkout_infos, $template_params;
423 $template->param( %{$checkout_infos->[0]} );
424 $template->param( barcode => $barcodes->[0] );
426 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
428 checkout_infos => $checkout_infos,
429 confirmation_needed => $confirmation_needed,
434 ##################################################################################
436 # show all reserves of this borrower, and the position of the reservation ....
438 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
439 my $waiting_holds = $holds->waiting;
441 holds_count => $holds->count(),
442 WaitingHolds => $waiting_holds,
448 if ( $patron->gonenoaddress ) {
449 $template->param( gonenoaddress => 1 );
452 if ( $patron->lost ) {
453 $template->param( lost=> 1 );
456 if ( $patron->is_debarred ) {
457 $template->param( is_debarred=> 1 );
460 my $account = $patron->account;
461 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
462 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
463 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
466 chargesamount => $owing,
468 } elsif ( $balance < 0 ) {
471 creditsamount => -$balance,
475 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
476 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
477 if ( $no_issues_charge_guarantors ) {
478 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
480 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
482 charges_guarantors_guarantees => $guarantors_non_issues_charges
484 $noissues = 1 unless C4::Context->preference("allowfineoverride");
488 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
489 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
490 if ( defined $no_issues_charge_guarantees ) {
491 my $guarantees_non_issues_charges = 0;
492 my $guarantees = $patron->guarantee_relationships->guarantees;
493 while ( my $g = $guarantees->next ) {
494 $guarantees_non_issues_charges += $g->account->non_issues_charges;
496 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
498 charges_guarantees => 1,
499 chargesamount_guarantees => $guarantees_non_issues_charges,
501 $noissues = 1 unless C4::Context->preference("allowfineoverride");
505 if ( $patron->has_overdues ) {
506 $template->param( odues => 1 );
509 if ( $patron->borrowernotes ) {
510 my $borrowernotes = $patron->borrowernotes;
511 $borrowernotes =~ s#\n#<br />#g;
514 notesmsg => $borrowernotes,
520 noissues => ($force_allow_issue) ? 0 : 'true',
521 forceallow => $force_allow_issue,
526 my $patron_messages = Koha::Patron::Messages->search(
528 'me.borrowernumber' => $borrowernumber,
532 '+select' => ['manager.surname', 'manager.firstname' ],
533 '+as' => ['manager_surname', 'manager_firstname'],
537 my $fast_cataloging = 0;
538 if ( Koha::BiblioFrameworks->find('FA') ) {
543 ?'batch_checkout_view'
548 if ( my @guarantors = $patron->guarantor_relationships()->guarantors() ) {
549 push( @relatives, $_->id ) for @guarantors;
550 push( @relatives, $_->id ) for $patron->siblings();
552 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees();
555 my $relatives_issues_count =
556 Koha::Database->new()->schema()->resultset('Issue')
557 ->count( { borrowernumber => \@relatives } );
560 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
561 my $roadtype = $av->count ? $av->next->lib : '';
563 roadtype => $roadtype,
565 categoryname => $patron->category->description,
566 expiry => $patron->dateexpiry,
570 # Restore date if changed by holds and/or save stickyduedate to session
571 if ($restoreduedatespec || $stickyduedate) {
572 $duedatespec = $restoreduedatespec || $duedatespec;
574 if ($stickyduedate) {
575 $session->param( 'stickyduedate', $duedatespec );
577 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
582 patron_messages => $patron_messages,
583 borrowernumber => $borrowernumber,
585 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
586 barcodes => $barcodes,
587 stickyduedate => $stickyduedate,
588 duedatespec => $duedatespec,
589 restoreduedatespec => $restoreduedatespec,
591 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
592 inprocess => $inprocess,
594 batch_allowed => $batch_allowed,
596 AudioAlerts => C4::Context->preference("AudioAlerts"),
597 fast_cataloging => $fast_cataloging,
598 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
599 RoutingSerials => C4::Context->preference('RoutingSerials'),
600 relatives_issues_count => $relatives_issues_count,
601 relatives_borrowernumbers => \@relatives,
605 if ( C4::Context->preference("ExportCircHistory") ) {
606 $template->param(csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc' }) ]);
609 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
611 debt_confirmed => $debt_confirmed,
612 SpecifyDueDate => $duedatespec_allow,
613 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
614 debarments => scalar GetDebarments({ borrowernumber => $borrowernumber }),
615 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
616 has_modifications => $has_modifications,
617 override_high_holds => $override_high_holds,
618 nopermission => scalar $query->param('nopermission'),
619 autoswitched => $autoswitched,
620 logged_in_user => $logged_in_user,
623 output_html_with_http_headers $query, $cookie, $template->output;