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 );
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);
73 my $barcode = $query->param('barcode');
76 my $borrowernumber = $query->param('borrowernumber');
78 if (C4::Context->preference("AutoSwitchPatron") && $barcode) {
79 my $new_barcode = $barcode;
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 $branch = C4::Context->userenv->{'branch'};
156 for my $barcode ( @$barcodes ) {
157 $barcode = barcodedecode( $barcode ) if $barcode;
160 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
161 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
162 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
163 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
164 undef $restoreduedatespec;
166 my $issueconfirmed = $query->param('issueconfirmed');
167 my $cancelreserve = $query->param('cancelreserve');
168 my $cancel_recall = $query->param('cancel_recall');
169 my $recall_id = $query->param('recall_id');
170 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
171 my $charges = $query->param('charges') || q{};
173 # Check if stickyduedate is turned off
175 # was stickyduedate loaded from session?
176 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
177 $session->clear( 'stickyduedate' );
178 $stickyduedate = $query->param('stickyduedate');
179 $duedatespec = $query->param('duedatespec');
181 $session->param('auto_renew', scalar $query->param('auto_renew'));
184 $session->clear('auto_renew');
187 $template->param( auto_renew => $session->param('auto_renew') );
189 my ($datedue,$invalidduedate);
191 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
192 if( $onsite_checkout && !$duedatespec_allow ) {
193 $datedue = dt_from_string()->truncate(to => 'day');
194 $datedue->set_hour(23);
195 $datedue->set_minute(59);
196 } elsif( $duedatespec_allow ) {
197 if ( $duedatespec ) {
198 $datedue = eval { dt_from_string( $duedatespec ) };
201 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
205 my $reduced_datedue = $query->param('reduceddue');
206 if ( $reduced_datedue ) {
207 $datedue = dt_from_string( $reduced_datedue );
210 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
211 if ( @$barcodes == 0 && $charges eq 'yes' ) {
214 borrowernumber => $borrowernumber
219 # STEP 2 : FIND BORROWER
220 # if there is a list of find borrowers....
224 Koha::Plugins->call( 'patron_barcode_transform', \$findborrower );
225 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
227 $borrowernumber = $patron->borrowernumber;
229 print $query->redirect( "/cgi-bin/koha/members/member.pl?quicksearch=1&circsearch=1&searchmember=" . uri_escape_utf8($findborrower) );
234 # get the borrower information.....
236 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
239 $template->param( borrowernumber => $patron->borrowernumber );
240 output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
242 my $overdues = $patron->overdues;
243 my $issues = $patron->checkouts;
244 $balance = $patron->account->balance;
247 # if the expiry date is before today ie they have expired
248 if ( $patron->is_expired ) {
249 #borrowercard expired, no issues
251 noissues => ($force_allow_issue) ? 0 : "1",
252 forceallow => $force_allow_issue,
256 # check for NotifyBorrowerDeparture
257 elsif ( $patron->is_going_to_expire ) {
258 # borrower card soon to expire warn librarian
259 $template->param( "warndeparture" => $patron->dateexpiry ,
261 if (C4::Context->preference('ReturnBeforeExpiry')){
262 $template->param("returnbeforeexpiry" => 1);
266 overduecount => $overdues->count,
267 issuecount => $issues->count,
268 finetotal => $balance,
271 if ( $patron and $patron->is_debarred ) {
273 'userdebarred' => $patron->debarred,
274 'debarredcomment' => $patron->debarredcomment,
275 'debarredsince' => $patron->restrictions->search()->single->created,
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 );
308 ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
314 onsite_checkout => $onsite_checkout,
315 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
319 die $_ unless blessed $_ && $_->can('rethrow');
321 if ( $_->isa('Koha::Exceptions::Calendar::NoOpenDays') ) {
322 $error = { NO_OPEN_DAYS => 1 };
328 my $blocker = $invalidduedate ? 1 : 0;
330 $template_params->{alert} = $alerts;
331 $template_params->{messages} = $messages;
333 my $item = Koha::Items->find({ barcode => $barcode });
337 $biblio = $item->biblio;
340 # Fix for bug 7494: optional checkout-time fallback search for a book
342 if ( $error->{'UNKNOWN_BARCODE'}
343 && C4::Context->preference("itemBarcodeFallbackSearch")
347 $template_params->{FALLBACK} = 1;
349 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
350 my $query = "kw=" . $barcode;
351 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
353 # if multiple hits, offer options to librarian
354 if ( $total_hits > 0 ) {
356 foreach my $hit ( @{$results} ) {
357 my $chosen = # Maybe easier to retrieve the itemnumber from $hit?
358 TransformMarcToKoha({ record => C4::Search::new_record_from_zebra('biblioserver',$hit) });
360 # offer all barcodes individually
361 if ( $chosen->{barcode} ) {
362 push @barcodes, sort split(/\s*\|\s*/, $chosen->{barcode});
365 my $items = Koha::Items->search({ barcode => {-in => \@barcodes}});
366 $template_params->{options} = $items;
370 # Only some errors will block when performing forced onsite checkout,
371 # for other cases all errors will block
372 my @blocking_error_codes =
373 ( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") )
374 ? qw( UNKNOWN_BARCODE NO_OPEN_DAYS )
377 if ( $error->{BOOKED_TO_ANOTHER} ) {
378 $template_params->{BOOKED_TO_ANOTHER} = $error->{BOOKED_TO_ANOTHER};
379 $template_params->{IMPOSSIBLE} = 1;
383 foreach my $code ( @blocking_error_codes ) {
384 if ($error->{$code}) {
385 $template_params->{$code} = $error->{$code};
387 $template_params->{IMPOSSIBLE} = 1;
392 delete $question->{'DEBT'} if ($debt_confirmed);
394 if( $item and ( !$blocker or $force_allow_issue ) ){
395 my $confirm_required = 0;
396 unless($issueconfirmed){
397 # Get the item title for more information
398 my $materials = $item->materials;
399 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
400 $materials = $descriptions->{lib} // $materials;
401 $template_params->{ADDITIONAL_MATERIALS} = $materials;
402 $template_params->{itemhomebranch} = $item->homebranch;
404 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
405 foreach my $needsconfirmation ( keys %$question ) {
406 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
407 $template_params->{getTitleMessageIteminfo} = $biblio->title;
408 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
409 $template_params->{NEEDSCONFIRMATION} = 1;
410 $confirm_required = 1;
411 if ( $needsconfirmation eq 'BOOKED_TO_ANOTHER' ) {
413 dt_from_string( $$question{$needsconfirmation}->start_date )->subtract( days => 1 );
414 $template_params->{reduceddue} = $reduceddue;
418 unless ($confirm_required) {
419 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
420 if ( C4::Context->preference('UseRecalls') && !$recall_id ) {
421 my $recall = Koha::Recalls->find(
423 biblio_id => $item->biblionumber,
424 item_id => [ undef, $item->itemnumber ],
425 status => [ 'requested', 'waiting' ],
427 patron_id => $patron->borrowernumber,
430 $recall_id = ( $recall and $recall->id ) ? $recall->id : undef;
433 # If booked (alerts or confirmation) update datedue to end of booking
434 if ( my $booked = $question->{BOOKED_EARLY} // $alerts->{BOOKED} ) {
435 $datedue = $booked->end_date;
437 my $issue = AddIssue(
438 $patron, $barcode, $datedue,
442 onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew'),
443 switch_onsite_checkout => $switch_onsite_checkout, cancel_recall => $cancel_recall,
444 recall_id => $recall_id,
447 $template_params->{issue} = $issue;
448 $session->clear('auto_renew');
453 if ($question->{RESERVE_WAITING} or $question->{RESERVED} or $question->{TRANSFERRED} or $question->{PROCESSING}){
455 reserveborrowernumber => $question->{'resborrowernumber'},
456 reserve_id => $question->{reserve_id},
461 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
462 $patron = Koha::Patrons->find( $borrowernumber );
463 $template_params->{issuecount} = $patron->checkouts->count;
466 $template_params->{item} = $item;
467 $template_params->{biblio} = $biblio;
468 $template_params->{itembiblionumber} = $biblio->biblionumber;
470 push @$checkout_infos, $template_params;
473 $template->param( %{$checkout_infos->[0]} );
474 $template->param( barcode => $barcodes->[0] );
476 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
478 checkout_infos => $checkout_infos,
479 confirmation_needed => $confirmation_needed,
484 ##################################################################################
486 # show all reserves of this borrower, and the position of the reservation ....
488 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
489 my $waiting_holds = $holds->waiting;
491 holds_count => $holds->count(),
492 WaitingHolds => $waiting_holds,
495 if ( C4::Context->preference('UseRecalls') ) {
496 my $waiting_recalls = $patron->recalls->search({ status => 'waiting' });
498 recalls => $patron->recalls->filter_by_current->search({},{ order_by => { -asc => 'created_date' } }),
499 specific_patron => 1,
500 waiting_recalls => $waiting_recalls,
507 if ( $patron->gonenoaddress ) {
508 $template->param( gonenoaddress => 1 );
511 if ( $patron->lost ) {
512 $template->param( lost=> 1 );
515 if ( $patron->is_debarred ) {
516 $template->param( is_debarred=> 1 );
519 if ( $patron->borrowernumber eq C4::Context->preference("AnonymousPatron") ) {
520 $template->param( is_anonymous => 1 );
523 my $account = $patron->account;
524 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
525 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
526 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
529 chargesamount => $owing,
531 } elsif ( $balance < 0 ) {
534 creditsamount => -$balance,
538 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
539 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
540 if ( $no_issues_charge_guarantors ) {
541 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
543 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors ) {
545 charges_guarantors_guarantees => $guarantors_non_issues_charges
547 $noissues = 1 unless C4::Context->preference("allowfineoverride");
551 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
552 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
553 if ( defined $no_issues_charge_guarantees ) {
554 my $guarantees_non_issues_charges = 0;
555 my $guarantees = $patron->guarantee_relationships->guarantees;
556 while ( my $g = $guarantees->next ) {
557 $guarantees_non_issues_charges += $g->account->non_issues_charges;
559 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
561 charges_guarantees => 1,
562 chargesamount_guarantees => $guarantees_non_issues_charges,
564 $noissues = 1 unless C4::Context->preference("allowfineoverride");
568 if ( $patron->has_overdues ) {
569 $template->param( odues => 1 );
572 if ( $patron->borrowernotes ) {
573 my $borrowernotes = $patron->borrowernotes;
574 $borrowernotes =~ s#\n#<br />#g;
577 notesmsg => $borrowernotes,
583 noissues => ($force_allow_issue) ? 0 : 'true',
584 forceallow => $force_allow_issue,
588 my $patron_messages = $patron->messages->search(
592 '+select' => ['manager.surname', 'manager.firstname' ],
593 '+as' => ['manager_surname', 'manager_firstname'],
596 $template->param( patron_messages => $patron_messages );
600 my $fast_cataloging = 0;
601 if ( Koha::BiblioFrameworks->find('FA') ) {
606 ?'batch_checkout_view'
611 if ( my @guarantors = $patron->guarantor_relationships()->guarantors->as_list ) {
612 push( @relatives, $_->id ) for @guarantors;
613 push( @relatives, $_->id ) for $patron->siblings->as_list;
615 push( @relatives, $_->id ) for $patron->guarantee_relationships()->guarantees->as_list;
618 my $relatives_issues_count =
619 Koha::Database->new()->schema()->resultset('Issue')
620 ->count( { borrowernumber => \@relatives } );
623 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
624 my $roadtype = $av->count ? $av->next->lib : '';
626 roadtype => $roadtype,
628 categoryname => $patron->category->description,
629 expiry => $patron->dateexpiry,
633 # Restore date if changed by holds and/or save stickyduedate to session
634 if ($restoreduedatespec || $stickyduedate) {
635 $duedatespec = $restoreduedatespec || $duedatespec;
637 if ($stickyduedate) {
638 $session->param( 'stickyduedate', $duedatespec );
640 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
645 borrowernumber => $borrowernumber,
647 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
648 barcodes => $barcodes,
649 stickyduedate => $stickyduedate,
650 duedatespec => $duedatespec,
651 restoreduedatespec => $restoreduedatespec,
653 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
654 inprocess => $inprocess,
656 batch_allowed => $batch_allowed,
658 AudioAlerts => C4::Context->preference("AudioAlerts"),
659 fast_cataloging => $fast_cataloging,
660 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
661 RoutingSerials => C4::Context->preference('RoutingSerials'),
662 relatives_issues_count => $relatives_issues_count,
663 relatives_borrowernumbers => \@relatives,
667 if ( C4::Context->preference("ExportCircHistory") ) {
668 $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' }));
671 my ( $has_modifications, $patron_lists_count);
673 $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
674 $patron_lists_count = $patron->get_lists_with_patron->count();
677 debt_confirmed => $debt_confirmed,
678 SpecifyDueDate => $duedatespec_allow,
679 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
680 today_due_date_and_time => dt_from_string()->set(hour => 23)->set(minute => 59),
681 restriction_types => scalar Koha::Patron::Restriction::Types->search(),
682 has_modifications => $has_modifications,
683 patron_lists_count => $patron_lists_count,
684 override_high_holds => $override_high_holds,
685 nopermission => scalar $query->param('nopermission'),
686 autoswitched => $autoswitched,
687 logged_in_user => $logged_in_user,
690 # Generate CSRF token for upload and delete image buttons
692 csrf_token => Koha::Token->new->generate_csrf({ session_id => $query->cookie('CGISESSID'),}),
695 output_html_with_http_headers $query, $cookie, $template->output;