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>.
29 use DateTime::Duration;
32 use C4::Auth qw/:DEFAULT get_session haspermission/;
33 use C4::Koha; # GetPrinter
35 use C4::Utils::DataTables::Members;
44 use C4::Members::Attributes qw(GetBorrowerAttributes);
45 use Koha::AuthorisedValues;
46 use Koha::CsvProfiles;
48 use Koha::Patron::Debarments qw(GetDebarments);
51 use Koha::BiblioFrameworks;
53 use Koha::Patron::Messages;
54 use Koha::Patron::Images;
55 use Koha::SearchEngine;
56 use Koha::SearchEngine::Search;
57 use Koha::Patron::Modifications;
64 use List::MoreUtils qw/uniq/;
71 my $override_high_holds = $query->param('override_high_holds');
72 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
74 my $sessionID = $query->cookie("CGISESSID") ;
75 my $session = get_session($sessionID);
76 if (!C4::Context->userenv){
77 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
78 # no branch set we can't issue
79 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
85 my $barcode = $query->param('barcode');
86 # Barcode given by user could be '0'
87 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
88 $barcodes = [ $barcode ];
90 my $filefh = $query->upload('uploadfile');
92 while ( my $content = <$filefh> ) {
93 $content =~ s/[\r\n]*$//g;
94 push @$barcodes, $content if $content;
96 } elsif ( my $list = $query->param('barcodelist') ) {
97 push @$barcodes, split( /\s\n/, $list );
98 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
100 @$barcodes = $query->multi_param('barcodes');
104 $barcodes = [ uniq @$barcodes ];
106 my $template_name = q|circ/circulation.tt|;
107 my $borrowernumber = $query->param('borrowernumber');
108 my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
109 my $batch = $query->param('batch');
110 my $batch_allowed = 0;
111 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
112 $template_name = q|circ/circulation_batch_checkouts.tt|;
113 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
114 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
121 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
123 template_name => $template_name,
126 authnotrequired => 0,
127 flagsrequired => { circulate => 'circulate_remaining_permissions' },
131 my $force_allow_issue = $query->param('forceallow') || 0;
132 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
133 $force_allow_issue = 0;
136 my $onsite_checkout = $query->param('onsite_checkout');
138 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
139 our %renew_failed = ();
140 for (@failedrenews) { $renew_failed{$_} = 1; }
142 my @failedreturns = $query->multi_param('failedreturn');
143 our %return_failed = ();
144 for (@failedreturns) { $return_failed{$_} = 1; }
146 my $searchtype = $query->param('searchtype') || q{contain};
148 my $findborrower = $query->param('findborrower') || q{};
149 $findborrower =~ s|,| |g;
151 my $branch = C4::Context->userenv->{'branch'};
153 if (C4::Context->preference("DisplayClearScreenButton")) {
154 $template->param(DisplayClearScreenButton => 1);
157 for my $barcode ( @$barcodes ) {
158 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
159 $barcode = barcodedecode($barcode)
160 if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
163 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
164 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
165 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso', timeformat => '24hr' }); }
167 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
168 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
169 undef $restoreduedatespec;
171 my $issueconfirmed = $query->param('issueconfirmed');
172 my $cancelreserve = $query->param('cancelreserve');
173 my $print = $query->param('print') || q{};
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 my ($datedue,$invalidduedate);
193 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
194 if( $onsite_checkout && !$duedatespec_allow ) {
195 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
196 $datedue .= ' 23:59:00';
197 } elsif( $duedatespec_allow ) {
198 if ( $duedatespec ) {
199 $datedue = eval { dt_from_string( $duedatespec ) };
202 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
207 # check and see if we should print
208 if ( @$barcodes == 0 && $print eq 'maybe' ) {
212 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
213 if ( @$barcodes == 0 && $charges eq 'yes' ) {
216 borrowernumber => $borrowernumber
220 if ( $print eq 'yes' && $borrowernumber ne '' ) {
221 if ( C4::Context->boolean_preference('printcirculationslips') ) {
222 my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
223 NetworkPrint($letter->{content});
225 $query->param( 'borrowernumber', '' );
226 $borrowernumber = '';
230 # STEP 2 : FIND BORROWER
231 # if there is a list of find borrowers....
235 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
237 $borrowernumber = $borrower->{borrowernumber};
239 my $dt_params = { iDisplayLength => -1 };
240 my $results = C4::Utils::DataTables::Members::search(
242 searchmember => $findborrower,
243 searchtype => $searchtype,
244 dt_params => $dt_params,
247 my $borrowers = $results->{patrons};
248 if ( scalar @$borrowers == 1 ) {
249 $borrowernumber = $borrowers->[0]->{borrowernumber};
250 $query->param( 'borrowernumber', $borrowernumber );
251 $query->param( 'barcode', '' );
252 } elsif ( @$borrowers ) {
253 $template->param( borrowers => $borrowers );
255 $query->param( 'findborrower', '' );
256 $message = "'$findborrower'";
261 # get the borrower information.....
263 if ($borrowernumber) {
264 $patron = Koha::Patrons->find( $borrowernumber );
265 $borrower = GetMember( borrowernumber => $borrowernumber );
266 my $overdues = $patron->get_overdues;
267 my $issues = $patron->checkouts;
268 my $balance = $patron->account->balance;
271 # if the expiry date is before today ie they have expired
272 if ( $patron->is_expired ) {
273 #borrowercard expired, no issues
275 noissues => ($force_allow_issue) ? 0 : "1",
276 forceallow => $force_allow_issue,
280 # check for NotifyBorrowerDeparture
281 elsif ( $patron->is_going_to_expire ) {
282 # borrower card soon to expire warn librarian
283 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
285 if (C4::Context->preference('ReturnBeforeExpiry')){
286 $template->param("returnbeforeexpiry" => 1);
290 overduecount => $overdues->count,
291 issuecount => $issues->count,
292 finetotal => $balance,
295 if ( $patron and $patron->is_debarred ) {
297 'userdebarred' => $borrower->{debarred},
298 'debarredcomment' => $borrower->{debarredcomment},
301 if ( $borrower->{debarred} ne "9999-12-31" ) {
302 $template->param( 'userdebarreddate' => $borrower->{debarred} );
314 for my $barcode ( @$barcodes ) {
315 my $template_params = { barcode => $barcode };
316 # always check for blockers on issuing
317 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
323 onsite_checkout => $onsite_checkout,
324 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
328 my $blocker = $invalidduedate ? 1 : 0;
330 $template_params->{alert} = $alerts;
331 $template_params->{messages} = $messages;
333 my $item = Koha::Items->find({ barcode => $barcode });
334 my $biblio = $item->biblio;
336 my $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.notforloan', authorised_value => { not => undef } });
337 $template_params->{authvalcode_notforloan} = $mss->count ? $mss->next->authorised_value : undef;
339 # Fix for bug 7494: optional checkout-time fallback search for a book
341 if ( $error->{'UNKNOWN_BARCODE'}
342 && C4::Context->preference("itemBarcodeFallbackSearch")
346 $template_params->{FALLBACK} = 1;
348 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
349 my $query = "kw=" . $barcode;
350 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
352 # if multiple hits, offer options to librarian
353 if ( $total_hits > 0 ) {
355 foreach my $hit ( @{$results} ) {
357 TransformMarcToKoha( C4::Search::new_record_from_zebra('biblioserver',$hit) );
359 # offer all barcodes individually
360 if ( $chosen->{barcode} ) {
361 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
362 my %chosen_single = %{$chosen};
363 $chosen_single{barcode} = $barcode;
364 push( @options, \%chosen_single );
368 $template_params->{options} = \@options;
372 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
373 delete $question->{'DEBT'} if ($debt_confirmed);
374 foreach my $impossible ( keys %$error ) {
375 $template_params->{$impossible} = $$error{$impossible};
376 $template_params->{IMPOSSIBLE} = 1;
380 if( !$blocker || $force_allow_issue ){
381 my $confirm_required = 0;
382 unless($issueconfirmed){
383 # Get the item title for more information
384 my $materials = $item->materials;
385 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
386 $materials = $descriptions->{lib} // $materials;
387 $template_params->{additional_materials} = $materials;
388 $template_params->{itemhomebranch} = $item->homebranch;
390 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
391 foreach my $needsconfirmation ( keys %$question ) {
392 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
393 $template_params->{getTitleMessageIteminfo} = $biblio->title;
394 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
395 $template_params->{NEEDSCONFIRMATION} = 1;
396 $template_params->{onsite_checkout} = $onsite_checkout;
397 $confirm_required = 1;
400 unless($confirm_required) {
401 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
402 my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew'), switch_onsite_checkout => $switch_onsite_checkout, } );
403 $template_params->{issue} = $issue;
404 $session->clear('auto_renew');
409 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
411 reserveborrowernumber => $question->{'resborrowernumber'}
416 itembiblionumber => $biblio->biblionumber
420 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
421 $patron = Koha::Patrons->find( $borrowernumber );
422 $template_params->{issuecount} = $patron->checkouts->count;
425 $template_params->{item} = $item;
426 $template_params->{biblio} = $biblio;
428 push @$checkout_infos, $template_params;
431 $template->param( %{$checkout_infos->[0]} );
432 $template->param( barcode => $barcodes->[0] );
434 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
436 checkout_infos => $checkout_infos,
437 confirmation_needed => $confirmation_needed,
442 # reload the borrower info for the sake of reseting the flags.....
443 if ($borrowernumber) {
444 $borrower = GetMember( borrowernumber => $borrowernumber );
447 ##################################################################################
449 # show all reserves of this borrower, and the position of the reservation ....
450 if ($borrowernumber) {
451 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
452 my $waiting_holds = $holds->waiting;
454 holds_count => $holds->count(),
455 WaitingHolds => $waiting_holds,
458 $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
462 my $flags = $borrower ? C4::Members::patronflags( $borrower ) : {};
463 foreach my $flag ( sort keys %$flags ) {
464 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
465 if ( $flags->{$flag}->{'noissues'} ) {
467 noissues => ($force_allow_issue) ? 0 : 'true',
468 forceallow => $force_allow_issue,
470 if ( $flag eq 'GNA' ) {
471 $template->param( gna => 'true' );
473 elsif ( $flag eq 'LOST' ) {
474 $template->param( lost => 'true' );
476 elsif ( $flag eq 'DBARRED' ) {
477 $template->param( dbarred => 'true' );
479 elsif ( $flag eq 'CHARGES' ) {
482 chargesmsg => $flags->{'CHARGES'}->{'message'},
483 chargesamount => $flags->{'CHARGES'}->{'amount'},
484 charges_is_blocker => 1
487 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
489 charges_guarantees => 'true',
490 chargesmsg_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'message'},
491 chargesamount_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'amount'},
492 charges_guarantees_is_blocker => 1
495 elsif ( $flag eq 'CREDITS' ) {
498 creditsmsg => $flags->{'CREDITS'}->{'message'},
499 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
504 if ( $flag eq 'CHARGES' ) {
507 chargesmsg => $flags->{'CHARGES'}->{'message'},
508 chargesamount => $flags->{'CHARGES'}->{'amount'},
511 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
513 charges_guarantees => 'true',
514 chargesmsg_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'message'},
515 chargesamount_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'amount'},
518 elsif ( $flag eq 'CREDITS' ) {
521 creditsmsg => $flags->{'CREDITS'}->{'message'},
522 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
525 elsif ( $flag eq 'ODUES' ) {
528 oduesmsg => $flags->{'ODUES'}->{'message'}
531 my $items = $flags->{$flag}->{'itemlist'};
532 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
533 $template->param( nonreturns => 'true' );
536 elsif ( $flag eq 'NOTES' ) {
539 notesmsg => $flags->{'NOTES'}->{'message'}
545 my $amountold = $flags ? $flags->{'CHARGES'}->{'message'} || 0 : 0;
546 $amountold =~ s/^.*\$//; # remove upto the $, if any
548 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
550 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
551 my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
552 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
553 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
556 my $messages = Koha::Patron::Messages->search(
558 'me.borrowernumber' => $borrowernumber,
562 '+select' => ['manager.surname', 'manager.firstname' ],
563 '+as' => ['manager_surname', 'manager_firstname'],
567 my $fast_cataloging = 0;
568 if ( Koha::BiblioFrameworks->find('FA') ) {
572 if (C4::Context->preference('ExtendedPatronAttributes')) {
573 my $attributes = GetBorrowerAttributes($borrowernumber);
575 ExtendedPatronAttributes => 1,
576 extendedattributes => $attributes
580 ?'batch_checkout_view'
584 if ( $borrowernumber ) {
586 if ( my $guarantor = $patron->guarantor ) {
587 push @relatives, $guarantor->borrowernumber;
588 push @relatives, $_->borrowernumber for $patron->siblings;
590 push @relatives, $_->borrowernumber for $patron->guarantees;
594 my $relatives_issues_count =
595 Koha::Database->new()->schema()->resultset('Issue')
596 ->count( { borrowernumber => \@relatives } );
598 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $borrower->{streettype} });
599 my $roadtype = $av->count ? $av->next->lib : '';
601 $template->param(%$borrower);
603 # Restore date if changed by holds and/or save stickyduedate to session
604 if ($restoreduedatespec || $stickyduedate) {
605 $duedatespec = $restoreduedatespec || $duedatespec;
607 if ($stickyduedate) {
608 $session->param( 'stickyduedate', $duedatespec );
610 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
616 messages => $messages,
617 borrower => $borrower,
618 borrowernumber => $borrowernumber,
619 categoryname => $borrower->{'description'},
621 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
622 expiry => $borrower->{'dateexpiry'},
623 roadtype => $roadtype,
624 amountold => $amountold,
625 barcodes => $barcodes,
626 stickyduedate => $stickyduedate,
627 duedatespec => $duedatespec,
628 restoreduedatespec => $restoreduedatespec,
630 totaldue => sprintf('%.2f', $total),
631 inprocess => $inprocess,
632 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
634 batch_allowed => $batch_allowed,
636 AudioAlerts => C4::Context->preference("AudioAlerts"),
637 fast_cataloging => $fast_cataloging,
638 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
639 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
640 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
641 RoutingSerials => C4::Context->preference('RoutingSerials'),
642 relatives_issues_count => $relatives_issues_count,
643 relatives_borrowernumbers => \@relatives,
646 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
647 $template->param( picture => 1 ) if $patron_image;
649 if ( C4::Context->preference("ExportCircHistory") ) {
650 $template->param(csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc' }) ]);
653 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
655 debt_confirmed => $debt_confirmed,
656 SpecifyDueDate => $duedatespec_allow,
657 CircAutocompl => C4::Context->preference("CircAutocompl"),
658 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
659 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
660 has_modifications => $has_modifications,
661 override_high_holds => $override_high_holds,
662 nopermission => scalar $query->param('nopermission'),
665 output_html_with_http_headers $query, $cookie, $template->output;