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( blessed looks_like_number );
34 use C4::Output qw( output_and_exit_if_error output_and_exit output_html_with_http_headers );
35 use C4::Auth qw( get_session get_template_and_user );
37 use C4::Circulation qw( barcodedecode CanBookBeIssued AddIssue );
39 use C4::Biblio qw( TransformMarcToKoha );
40 use C4::Search qw( new_record_from_zebra );
41 use C4::Reserves qw( ModReserveAffect );
45 use Koha::AuthorisedValues;
46 use Koha::CsvProfiles;
48 use Koha::DateUtils qw( dt_from_string );
49 use Koha::Patron::Restriction::Types;
52 use Koha::BiblioFrameworks;
54 use Koha::SearchEngine;
55 use Koha::SearchEngine::Search;
56 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);
72 my $userenv = C4::Context->userenv;
73 my $branch = $userenv->{'branch'} // '';
74 my $desk_id = $userenv->{"desk_id"} || '';
77 my $barcode = $query->param('barcode');
80 my $borrowernumber = $query->param('borrowernumber');
82 if (C4::Context->preference("AutoSwitchPatron") && $barcode) {
83 my $new_barcode = $barcode;
84 Koha::Plugins->call( 'patron_barcode_transform', \$new_barcode );
85 if (Koha::Patrons->search( { cardnumber => $new_barcode} )->count() > 0) {
86 $findborrower = $barcode;
88 undef $borrowernumber;
92 $findborrower ||= $query->param('findborrower') || q{};
93 $findborrower =~ s|,| |g;
95 if ( $query->param('confirm_hold') ) {
96 my $reserve_id = $query->param('confirm_hold');
97 my $hold_branch = $query->param('hold_branch');
98 my $hold_itemnumber = $query->param('hold_itemnumber');
99 my $hold_borrowernumber = $query->param('hold_borrowernumber');
100 my $diffBranchSend = ( $branch ne $hold_branch );
102 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
103 # i.e., whether to apply waiting status
104 ModReserveAffect( $hold_itemnumber, $hold_borrowernumber, $diffBranchSend, $reserve_id, $desk_id );
107 # Barcode given by user could be '0'
108 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
109 $barcodes = [ $barcode ];
111 my $filefh = $query->upload('uploadfile');
113 while ( my $content = <$filefh> ) {
114 $content =~ s/[\r\n]*$//g;
115 push @$barcodes, $content if $content;
117 } elsif ( my $list = $query->param('barcodelist') ) {
118 push @$barcodes, split( /\s\n/, $list );
119 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
121 @$barcodes = $query->multi_param('barcodes');
125 $barcodes = [ uniq @$barcodes ];
127 my $template_name = q|circ/circulation.tt|;
128 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
129 my $batch = $query->param('batch');
130 my $batch_allowed = 0;
131 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
132 $template_name = q|circ/circulation_batch_checkouts.tt|;
133 my @batch_category_codes = split ',', C4::Context->preference('BatchCheckoutsValidCategories');
134 my $categorycode = $patron->categorycode;
135 if ( $categorycode && grep { $_ eq $categorycode } @batch_category_codes ) {
142 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
144 template_name => $template_name,
147 flagsrequired => { circulate => 'circulate_remaining_permissions' },
150 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
152 my $force_allow_issue = $query->param('forceallow') || 0;
153 if (!C4::Auth::haspermission( $userenv->{id} , { circulate => 'force_checkout' } )) {
154 $force_allow_issue = 0;
156 my $onsite_checkout = $query->param('onsite_checkout');
158 if (C4::Context->preference("OnSiteCheckoutAutoCheck") && $onsite_checkout eq "on") {
159 $template->param(onsite_checkout => $onsite_checkout);
162 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
163 our %renew_failed = ();
164 for (@failedrenews) { $renew_failed{$_} = 1; }
166 my @failedreturns = $query->multi_param('failedreturn');
167 our %return_failed = ();
168 for (@failedreturns) { $return_failed{$_} = 1; }
170 for my $barcode ( @$barcodes ) {
171 $barcode = barcodedecode( $barcode ) if $barcode;
174 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
175 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
176 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
177 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
178 undef $restoreduedatespec;
180 my $issueconfirmed = $query->param('issueconfirmed');
181 my $cancelreserve = $query->param('cancelreserve');
182 my $cancel_recall = $query->param('cancel_recall');
183 my $recall_id = $query->param('recall_id');
184 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
185 my $charges = $query->param('charges') || q{};
187 # Check if stickyduedate is turned off
189 # was stickyduedate loaded from session?
190 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
191 $session->clear( 'stickyduedate' );
192 $stickyduedate = $query->param('stickyduedate');
193 $duedatespec = $query->param('duedatespec');
195 $session->param('auto_renew', scalar $query->param('auto_renew'));
198 $session->clear('auto_renew');
201 $template->param( auto_renew => $session->param('auto_renew') );
203 my ($datedue,$invalidduedate);
205 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
206 if( $onsite_checkout && !$duedatespec_allow ) {
207 $datedue = dt_from_string()->truncate(to => 'day');
208 $datedue->set_hour(23);
209 $datedue->set_minute(59);
210 } elsif( $duedatespec_allow ) {
211 if ( $duedatespec ) {
212 $datedue = eval { dt_from_string( $duedatespec ) };
215 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
220 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
221 if ( @$barcodes == 0 && $charges eq 'yes' ) {
224 borrowernumber => $borrowernumber
229 # STEP 2 : FIND BORROWER
230 # if there is a list of find borrowers....
234 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
235 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
237 $borrowernumber = $patron->borrowernumber;
239 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
244 # get the borrower information.....
246 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
249 $template->param( borrowernumber => $patron->borrowernumber );
250 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
252 my $overdues = $patron->overdues;
253 my $issues = $patron->checkouts;
254 $balance = $patron->account->balance;
257 # if the expiry date is before today ie they have expired
258 if ( $patron->is_expired ) {
259 #borrowercard expired, no issues
261 noissues => ($force_allow_issue) ? 0 : "1",
262 forceallow => $force_allow_issue,
266 # check for NotifyBorrowerDeparture
267 elsif ( $patron->is_going_to_expire ) {
268 # borrower card soon to expire warn librarian
269 $template->param( "warndeparture" => $patron->dateexpiry ,
271 if (C4::Context->preference('ReturnBeforeExpiry')){
272 $template->param("returnbeforeexpiry" => 1);
276 overduecount => $overdues->count,
277 issuecount => $issues->count,
278 finetotal => $balance,
281 if ( $patron and $patron->is_debarred ) {
283 'userdebarred' => $patron->debarred,
284 'debarredcomment' => $patron->debarredcomment,
287 if ( $patron->debarred ne "9999-12-31" ) {
288 $template->param( 'userdebarreddate' => $patron->debarred );
292 # Calculate and display patron's age
293 if ( !$patron->is_valid_age ) {
294 $template->param( age_limitations => 1 );
295 $template->param( age_low => $patron->category->dateofbirthrequired );
296 $template->param( age_high => $patron->category->upperagelimit );
307 for my $barcode ( @$barcodes ) {
309 my $template_params = {
311 onsite_checkout => $onsite_checkout,
314 # always check for blockers on issuing
315 my ( $error, $question, $alerts, $messages );
317 ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
323 onsite_checkout => $onsite_checkout,
324 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
328 die $_ unless blessed $_ && $_->can('rethrow');
330 if ( $_->isa('Koha::Exceptions::Calendar::NoOpenDays') ) {
331 $error = { NO_OPEN_DAYS => 1 };
337 my $blocker = $invalidduedate ? 1 : 0;
339 $template_params->{alert} = $alerts;
340 $template_params->{messages} = $messages;
342 my $item = Koha::Items->find({ barcode => $barcode });
346 $biblio = $item->biblio;
349 # Fix for bug 7494: optional checkout-time fallback search for a book
351 if ( $error->{'UNKNOWN_BARCODE'}
352 && C4::Context->preference("itemBarcodeFallbackSearch")
356 $template_params->{FALLBACK} = 1;
358 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
359 my $query = "kw=" . $barcode;
360 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
362 # if multiple hits, offer options to librarian
363 if ( $total_hits > 0 ) {
365 foreach my $hit ( @{$results} ) {
366 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
367 TransformMarcToKoha({ record => C4::Search::new_record_from_zebra('biblioserver',$hit) });
369 # offer all barcodes individually
370 if ( $chosen->{barcode} ) {
371 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
374 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
375 $template_params->{options} = $items;
379 # Only some errors will block when performing forced onsite checkout,
380 # for other cases all errors will block
381 my @blocking_error_codes =
382 ( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") )
383 ? qw( UNKNOWN_BARCODE NO_OPEN_DAYS )
386 foreach my $code ( @blocking_error_codes ) {
387 if ($error->{$code}) {
388 $template_params->{$code} = $error->{$code};
389 $template_params->{IMPOSSIBLE} = 1;
394 delete $question->{'DEBT'} if ($debt_confirmed);
396 if( $item and ( !$blocker or $force_allow_issue ) ){
397 my $confirm_required = 0;
398 unless($issueconfirmed){
399 # Get the item title for more information
400 my $materials = $item->materials;
401 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
402 $materials = $descriptions->{lib} // $materials;
403 $template_params->{ADDITIONAL_MATERIALS} = $materials;
404 $template_params->{itemhomebranch} = $item->homebranch;
406 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
407 foreach my $needsconfirmation ( keys %$question ) {
408 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
409 $template_params->{getTitleMessageIteminfo} = $biblio->title;
410 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
411 $template_params->{NEEDSCONFIRMATION} = 1;
412 $confirm_required = 1;
415 unless($confirm_required) {
416 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
417 if ( C4::Context->preference('UseRecalls') && !$recall_id ) {
418 my $recall = Koha::Recalls->find(
420 biblio_id => $item->biblionumber,
421 item_id => [ undef, $item->itemnumber ],
422 status => [ 'requested', 'waiting' ],
424 patron_id => $patron->borrowernumber,
427 $recall_id = ( $recall and $recall->id ) ? $recall->id : undef;
429 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, } );
430 $template_params->{issue} = $issue;
431 $session->clear('auto_renew');
436 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
438 reserveborrowernumber => $question->{'resborrowernumber'},
439 reserve_id => $question->{reserve_id},
444 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
445 $patron = Koha::Patrons->find( $borrowernumber );
446 $template_params->{issuecount} = $patron->checkouts->count;
449 $template_params->{item} = $item;
450 $template_params->{biblio} = $biblio;
451 $template_params->{itembiblionumber} = $biblio->biblionumber;
453 push @$checkout_infos, $template_params;
456 $template->param( %{$checkout_infos->[0]} );
457 $template->param( barcode => $barcodes->[0] );
459 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
461 checkout_infos => $checkout_infos,
462 confirmation_needed => $confirmation_needed,
467 ##################################################################################
469 # show all reserves of this borrower, and the position of the reservation ....
471 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
472 my $waiting_holds = $holds->waiting;
474 holds_count => $holds->count(),
475 WaitingHolds => $waiting_holds,
478 if ( C4::Context->preference('UseRecalls') ) {
479 my $waiting_recalls = $patron->recalls->search({ status => 'waiting' });
481 recalls => $patron->recalls->filter_by_current->search({},{ order_by => { -asc => 'created_date' } }),
482 specific_patron => 1,
483 waiting_recalls => $waiting_recalls,
490 if ( $patron->gonenoaddress ) {
491 $template->param( gonenoaddress => 1 );
494 if ( $patron->lost ) {
495 $template->param( lost=> 1 );
498 if ( $patron->is_debarred ) {
499 $template->param( is_debarred=> 1 );
502 if ( $patron->borrowernumber eq C4::Context->preference("AnonymousPatron") ) {
503 $template->param( is_anonymous => 1 );
506 my $account = $patron->account;
507 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
508 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
509 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
512 chargesamount => $owing,
514 } elsif ( $balance < 0 ) {
517 creditsamount => -$balance,
521 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
522 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
523 if ( $no_issues_charge_guarantors ) {
524 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
526 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
528 charges_guarantors_guarantees => $guarantors_non_issues_charges
530 $noissues = 1 unless C4::Context->preference("allowfineoverride");
534 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
535 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
536 if ( defined $no_issues_charge_guarantees ) {
537 my $guarantees_non_issues_charges = 0;
538 my $guarantees = $patron->guarantee_relationships->guarantees;
539 while ( my $g = $guarantees->next ) {
540 $guarantees_non_issues_charges += $g->account->non_issues_charges;
542 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
544 charges_guarantees => 1,
545 chargesamount_guarantees => $guarantees_non_issues_charges,
547 $noissues = 1 unless C4::Context->preference("allowfineoverride");
551 if ( $patron->has_overdues ) {
552 $template->param( odues => 1 );
555 if ( $patron->borrowernotes ) {
556 my $borrowernotes = $patron->borrowernotes;
557 $borrowernotes =~ s#\n#<br />#g;
560 notesmsg => $borrowernotes,
566 noissues => ($force_allow_issue) ? 0 : 'true',
567 forceallow => $force_allow_issue,
571 my $patron_messages = $patron->messages->search(
575 '+select' => ['manager.surname', 'manager.firstname' ],
576 '+as' => ['manager_surname', 'manager_firstname'],
579 $template->param( patron_messages => $patron_messages );
583 my $fast_cataloging = 0;
584 if ( Koha::BiblioFrameworks->find('FA') ) {
589 ?'batch_checkout_view'
594 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
595 push( @relatives, $_->id ) for @guarantors;
596 push( @relatives, $_->id ) for $patron->siblings->as_list;
598 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
601 my $relatives_issues_count =
602 Koha::Database->new()->schema()->resultset('Issue')
603 ->count( { borrowernumber => \@relatives } );
606 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
607 my $roadtype = $av->count ? $av->next->lib : '';
609 roadtype => $roadtype,
611 categoryname => $patron->category->description,
612 expiry => $patron->dateexpiry,
616 # Restore date if changed by holds and/or save stickyduedate to session
617 if ($restoreduedatespec || $stickyduedate) {
618 $duedatespec = $restoreduedatespec || $duedatespec;
620 if ($stickyduedate) {
621 $session->param( 'stickyduedate', $duedatespec );
623 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
628 borrowernumber => $borrowernumber,
630 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
631 barcodes => $barcodes,
632 stickyduedate => $stickyduedate,
633 duedatespec => $duedatespec,
634 restoreduedatespec => $restoreduedatespec,
636 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
637 inprocess => $inprocess,
639 batch_allowed => $batch_allowed,
641 AudioAlerts => C4::Context->preference("AudioAlerts"),
642 fast_cataloging => $fast_cataloging,
643 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
644 RoutingSerials => C4::Context->preference('RoutingSerials'),
645 relatives_issues_count => $relatives_issues_count,
646 relatives_borrowernumbers => \@relatives,
650 if ( C4::Context->preference("ExportCircHistory") ) {
651 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
654 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
656 debt_confirmed => $debt_confirmed,
657 SpecifyDueDate => $duedatespec_allow,
658 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
659 today_due_date_and_time => dt_from_string()->set(hour => 23)->set(minute => 59),
660 restriction_types => scalar Koha::Patron::Restriction::Types->search(),
661 has_modifications => $has_modifications,
662 override_high_holds => $override_high_holds,
663 nopermission => scalar $query->param('nopermission'),
664 autoswitched => $autoswitched,
665 logged_in_user => $logged_in_user,
668 # Generate CSRF token for upload and delete image buttons
670 csrf_token => Koha::Token->new->generate_csrf({ session_id => $query->cookie('CGISESSID'),}),
673 output_html_with_http_headers $query, $cookie, $template->output;