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
30 use DateTime::Duration;
31 use Scalar::Util qw( looks_like_number );
32 use C4::Output qw( output_and_exit_if_error output_and_exit output_html_with_http_headers );
33 use C4::Auth qw( get_session get_template_and_user );
35 use C4::Circulation qw( barcodedecode CanBookBeIssued AddIssue );
36 use C4::Utils::DataTables::Members;
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::Patron::Messages;
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 if (Koha::Patrons->search( { cardnumber => $barcode} )->count() > 0) {
79 $findborrower = $barcode;
81 undef $borrowernumber;
85 $findborrower ||= $query->param('findborrower') || q{};
86 $findborrower =~ s|,| |g;
88 # Barcode given by user could be '0'
89 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
90 $barcodes = [ $barcode ];
92 my $filefh = $query->upload('uploadfile');
94 while ( my $content = <$filefh> ) {
95 $content =~ s/[\r\n]*$//g;
96 push @$barcodes, $content if $content;
98 } elsif ( my $list = $query->param('barcodelist') ) {
99 push @$barcodes, split( /\s\n/, $list );
100 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
102 @$barcodes = $query->multi_param('barcodes');
106 $barcodes = [ uniq @$barcodes ];
108 my $template_name = q|circ/circulation.tt|;
109 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
110 my $batch = $query->param('batch');
111 my $batch_allowed = 0;
112 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
113 $template_name = q|circ/circulation_batch_checkouts.tt|;
114 my @batch_category_codes = split ',', C4::Context->preference('BatchCheckoutsValidCategories');
115 my $categorycode = $patron->categorycode;
116 if ( $categorycode && grep { $_ eq $categorycode } @batch_category_codes ) {
123 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
125 template_name => $template_name,
128 flagsrequired => { circulate => 'circulate_remaining_permissions' },
131 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
133 my $force_allow_issue = $query->param('forceallow') || 0;
134 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
135 $force_allow_issue = 0;
137 my $onsite_checkout = $query->param('onsite_checkout');
139 if (C4::Context->preference("OnSiteCheckoutAutoCheck") && $onsite_checkout eq "on") {
140 $template->param(onsite_checkout => $onsite_checkout);
143 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
144 our %renew_failed = ();
145 for (@failedrenews) { $renew_failed{$_} = 1; }
147 my @failedreturns = $query->multi_param('failedreturn');
148 our %return_failed = ();
149 for (@failedreturns) { $return_failed{$_} = 1; }
151 my $searchtype = $query->param('searchtype') || q{contain};
153 my $branch = C4::Context->userenv->{'branch'};
155 if (C4::Context->preference("DisplayClearScreenButton")) {
156 $template->param(DisplayClearScreenButton => 1);
159 for my $barcode ( @$barcodes ) {
160 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
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 $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
175 my $charges = $query->param('charges') || q{};
177 # Check if stickyduedate is turned off
179 # was stickyduedate loaded from session?
180 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
181 $session->clear( 'stickyduedate' );
182 $stickyduedate = $query->param('stickyduedate');
183 $duedatespec = $query->param('duedatespec');
185 $session->param('auto_renew', scalar $query->param('auto_renew'));
188 $session->clear('auto_renew');
191 $template->param( auto_renew => $session->param('auto_renew') );
193 my ($datedue,$invalidduedate);
195 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
196 if( $onsite_checkout && !$duedatespec_allow ) {
197 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
198 $datedue .= ' 23:59:00';
199 } elsif( $duedatespec_allow ) {
200 if ( $duedatespec ) {
201 $datedue = eval { dt_from_string( $duedatespec ) };
204 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
209 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
210 if ( @$barcodes == 0 && $charges eq 'yes' ) {
213 borrowernumber => $borrowernumber
218 # STEP 2 : FIND BORROWER
219 # if there is a list of find borrowers....
223 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
225 $borrowernumber = $patron->borrowernumber;
227 my $dt_params = { iDisplayLength => -1 };
228 my $results = C4::Utils::DataTables::Members::search(
230 searchmember => $findborrower,
231 searchtype => $searchtype,
232 dt_params => $dt_params,
235 my $borrowers = $results->{patrons};
236 if ( scalar @$borrowers == 1 ) {
237 $borrowernumber = $borrowers->[0]->{borrowernumber};
238 $query->param( 'borrowernumber', $borrowernumber );
239 $query->param( 'barcode', '' );
240 } elsif ( @$borrowers ) {
241 $template->param( borrowers => $borrowers );
243 $query->param( 'findborrower', '' );
244 $message = "'$findborrower'";
249 # get the borrower information.....
251 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
254 $template->param( borrowernumber => $patron->borrowernumber );
255 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
257 my $overdues = $patron->get_overdues;
258 my $issues = $patron->checkouts;
259 $balance = $patron->account->balance;
262 # if the expiry date is before today ie they have expired
263 if ( $patron->is_expired ) {
264 #borrowercard expired, no issues
266 noissues => ($force_allow_issue) ? 0 : "1",
267 forceallow => $force_allow_issue,
271 # check for NotifyBorrowerDeparture
272 elsif ( $patron->is_going_to_expire ) {
273 # borrower card soon to expire warn librarian
274 $template->param( "warndeparture" => $patron->dateexpiry ,
276 if (C4::Context->preference('ReturnBeforeExpiry')){
277 $template->param("returnbeforeexpiry" => 1);
281 overduecount => $overdues->count,
282 issuecount => $issues->count,
283 finetotal => $balance,
286 if ( $patron and $patron->is_debarred ) {
288 'userdebarred' => $patron->debarred,
289 'debarredcomment' => $patron->debarredcomment,
292 if ( $patron->debarred ne "9999-12-31" ) {
293 $template->param( 'userdebarreddate' => $patron->debarred );
297 # Calculate and display patron's age
298 if ( !$patron->is_valid_age ) {
299 $template->param( age_limitations => 1 );
300 $template->param( age_low => $patron->category->dateofbirthrequired );
301 $template->param( age_high => $patron->category->upperagelimit );
312 for my $barcode ( @$barcodes ) {
314 my $template_params = {
316 onsite_checkout => $onsite_checkout,
319 # always check for blockers on issuing
320 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
326 onsite_checkout => $onsite_checkout,
327 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
331 my $blocker = $invalidduedate ? 1 : 0;
333 $template_params->{alert} = $alerts;
334 $template_params->{messages} = $messages;
336 my $item = Koha::Items->find({ barcode => $barcode });
340 $biblio = $item->biblio;
343 # Fix for bug 7494: optional checkout-time fallback search for a book
345 if ( $error->{'UNKNOWN_BARCODE'}
346 && C4::Context->preference("itemBarcodeFallbackSearch")
350 $template_params->{FALLBACK} = 1;
352 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
353 my $query = "kw=" . $barcode;
354 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
356 # if multiple hits, offer options to librarian
357 if ( $total_hits > 0 ) {
359 foreach my $hit ( @{$results} ) {
360 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
361 TransformMarcToKoha( C4::Search::new_record_from_zebra('biblioserver',$hit) );
363 # offer all barcodes individually
364 if ( $chosen->{barcode} ) {
365 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
368 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
369 $template_params->{options} = $items;
373 if ( $error->{DEBT_GUARANTORS} ) {
374 $template_params->{DEBT_GUARANTORS} = $error->{DEBT_GUARANTORS};
375 $template_params->{IMPOSSIBLE} = 1;
379 if ( $error->{UNKNOWN_BARCODE} or not $onsite_checkout or not C4::Context->preference("OnSiteCheckoutsForce") ) {
380 delete $question->{'DEBT'} if ($debt_confirmed);
381 foreach my $impossible ( keys %$error ) {
382 $template_params->{$impossible} = $$error{$impossible};
383 $template_params->{IMPOSSIBLE} = 1;
388 if( $item and ( !$blocker or $force_allow_issue ) ){
389 my $confirm_required = 0;
390 unless($issueconfirmed){
391 # Get the item title for more information
392 my $materials = $item->materials;
393 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
394 $materials = $descriptions->{lib} // $materials;
395 $template_params->{ADDITIONAL_MATERIALS} = $materials;
396 $template_params->{itemhomebranch} = $item->homebranch;
398 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
399 foreach my $needsconfirmation ( keys %$question ) {
400 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
401 $template_params->{getTitleMessageIteminfo} = $biblio->title;
402 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
403 $template_params->{NEEDSCONFIRMATION} = 1;
404 $confirm_required = 1;
407 unless($confirm_required) {
408 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
409 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, } );
410 $template_params->{issue} = $issue;
411 $session->clear('auto_renew');
416 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
418 reserveborrowernumber => $question->{'resborrowernumber'},
419 reserve_id => $question->{reserve_id},
424 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
425 $patron = Koha::Patrons->find( $borrowernumber );
426 $template_params->{issuecount} = $patron->checkouts->count;
429 $template_params->{item} = $item;
430 $template_params->{biblio} = $biblio;
431 $template_params->{itembiblionumber} = $biblio->biblionumber;
433 push @$checkout_infos, $template_params;
436 $template->param( %{$checkout_infos->[0]} );
437 $template->param( barcode => $barcodes->[0] );
439 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
441 checkout_infos => $checkout_infos,
442 confirmation_needed => $confirmation_needed,
447 ##################################################################################
449 # show all reserves of this borrower, and the position of the reservation ....
451 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
452 my $waiting_holds = $holds->waiting;
454 holds_count => $holds->count(),
455 WaitingHolds => $waiting_holds,
461 if ( $patron->gonenoaddress ) {
462 $template->param( gonenoaddress => 1 );
465 if ( $patron->lost ) {
466 $template->param( lost=> 1 );
469 if ( $patron->is_debarred ) {
470 $template->param( is_debarred=> 1 );
473 my $account = $patron->account;
474 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
475 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
476 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
479 chargesamount => $owing,
481 } elsif ( $balance < 0 ) {
484 creditsamount => -$balance,
488 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
489 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
490 if ( $no_issues_charge_guarantors ) {
491 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
493 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
495 charges_guarantors_guarantees => $guarantors_non_issues_charges
497 $noissues = 1 unless C4::Context->preference("allowfineoverride");
501 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
502 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
503 if ( defined $no_issues_charge_guarantees ) {
504 my $guarantees_non_issues_charges = 0;
505 my $guarantees = $patron->guarantee_relationships->guarantees;
506 while ( my $g = $guarantees->next ) {
507 $guarantees_non_issues_charges += $g->account->non_issues_charges;
509 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
511 charges_guarantees => 1,
512 chargesamount_guarantees => $guarantees_non_issues_charges,
514 $noissues = 1 unless C4::Context->preference("allowfineoverride");
518 if ( $patron->has_overdues ) {
519 $template->param( odues => 1 );
522 if ( $patron->borrowernotes ) {
523 my $borrowernotes = $patron->borrowernotes;
524 $borrowernotes =~ s#\n#<br />#g;
527 notesmsg => $borrowernotes,
533 noissues => ($force_allow_issue) ? 0 : 'true',
534 forceallow => $force_allow_issue,
539 my $patron_messages = Koha::Patron::Messages->search(
541 'me.borrowernumber' => $borrowernumber,
545 '+select' => ['manager.surname', 'manager.firstname' ],
546 '+as' => ['manager_surname', 'manager_firstname'],
550 my $fast_cataloging = 0;
551 if ( Koha::BiblioFrameworks->find('FA') ) {
556 ?'batch_checkout_view'
561 if ( my @guarantors = $patron->guarantor_relationships()->guarantors() ) {
562 push( @relatives, $_->id ) for @guarantors;
563 push( @relatives, $_->id ) for $patron->siblings();
565 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees();
568 my $relatives_issues_count =
569 Koha::Database->new()->schema()->resultset('Issue')
570 ->count( { borrowernumber => \@relatives } );
573 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
574 my $roadtype = $av->count ? $av->next->lib : '';
576 roadtype => $roadtype,
578 categoryname => $patron->category->description,
579 expiry => $patron->dateexpiry,
583 # Restore date if changed by holds and/or save stickyduedate to session
584 if ($restoreduedatespec || $stickyduedate) {
585 $duedatespec = $restoreduedatespec || $duedatespec;
587 if ($stickyduedate) {
588 $session->param( 'stickyduedate', $duedatespec );
590 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
595 patron_messages => $patron_messages,
596 borrowernumber => $borrowernumber,
598 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
599 barcodes => $barcodes,
600 stickyduedate => $stickyduedate,
601 duedatespec => $duedatespec,
602 restoreduedatespec => $restoreduedatespec,
604 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
605 inprocess => $inprocess,
607 batch_allowed => $batch_allowed,
609 AudioAlerts => C4::Context->preference("AudioAlerts"),
610 fast_cataloging => $fast_cataloging,
611 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
612 RoutingSerials => C4::Context->preference('RoutingSerials'),
613 relatives_issues_count => $relatives_issues_count,
614 relatives_borrowernumbers => \@relatives,
618 if ( C4::Context->preference("ExportCircHistory") ) {
619 $template->param(csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc' }) ]);
622 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
624 debt_confirmed => $debt_confirmed,
625 SpecifyDueDate => $duedatespec_allow,
626 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
627 debarments => scalar GetDebarments({ borrowernumber => $borrowernumber }),
628 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
629 has_modifications => $has_modifications,
630 override_high_holds => $override_high_holds,
631 nopermission => scalar $query->param('nopermission'),
632 autoswitched => $autoswitched,
633 logged_in_user => $logged_in_user,
636 output_html_with_http_headers $query, $cookie, $template->output;