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::Branch; # GetBranches
34 use C4::Koha; # GetPrinter
36 use C4::Utils::DataTables::Members;
45 use C4::Members::Attributes qw(GetBorrowerAttributes);
47 use Koha::Patron::Debarments qw(GetDebarments IsDebarred);
50 use Koha::Patron::Messages;
51 use Koha::Patron::Images;
52 use Koha::SearchEngine;
53 use Koha::SearchEngine::Search;
54 use Koha::Patron::Modifications;
61 use List::MoreUtils qw/uniq/;
68 my $sessionID = $query->cookie("CGISESSID") ;
69 my $session = get_session($sessionID);
71 # branch and printer are now defined by the userenv
72 # but first we have to check if someone has tried to change them
74 my $branch = $query->param('branch');
76 # update our session so the userenv is updated
77 $session->param('branch', $branch);
78 $session->param('branchname', GetBranchName($branch));
81 my $printer = $query->param('printer');
83 # update our session so the userenv is updated
84 $session->param('branchprinter', $printer);
87 if (!C4::Context->userenv && !$branch){
88 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
89 # no branch set we can't issue
90 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
96 my $barcode = $query->param('barcode');
97 # Barcode given by user could be '0'
98 if ( $barcode || $barcode eq '0' ) {
99 $barcodes = [ $barcode ];
101 my $filefh = $query->upload('uploadfile');
103 while ( my $content = <$filefh> ) {
104 $content =~ s/[\r\n]*$//g;
105 push @$barcodes, $content if $content;
107 } elsif ( my $list = $query->param('barcodelist') ) {
108 push @$barcodes, split( /\s\n/, $list );
109 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
111 @$barcodes = $query->multi_param('barcodes');
115 $barcodes = [ uniq @$barcodes ];
117 my $template_name = q|circ/circulation.tt|;
118 my $borrowernumber = $query->param('borrowernumber');
119 my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
120 my $batch = $query->param('batch');
121 my $batch_allowed = 0;
122 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
123 $template_name = q|circ/circulation_batch_checkouts.tt|;
124 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
125 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
132 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
134 template_name => $template_name,
137 authnotrequired => 0,
138 flagsrequired => { circulate => 'circulate_remaining_permissions' },
142 my $branches = GetBranches();
144 my $force_allow_issue = $query->param('forceallow') || 0;
145 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
146 $force_allow_issue = 0;
149 my $onsite_checkout = $query->param('onsite_checkout');
151 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
152 our %renew_failed = ();
153 for (@failedrenews) { $renew_failed{$_} = 1; }
155 my @failedreturns = $query->multi_param('failedreturn');
156 our %return_failed = ();
157 for (@failedreturns) { $return_failed{$_} = 1; }
159 my $findborrower = $query->param('findborrower') || q{};
160 $findborrower =~ s|,| |g;
162 $branch = C4::Context->userenv->{'branch'};
163 $printer = C4::Context->userenv->{'branchprinter'};
165 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
166 if (C4::Context->preference("AutoLocation") != 1) {
167 $template->param(ManualLocation => 1);
170 if (C4::Context->preference("DisplayClearScreenButton")) {
171 $template->param(DisplayClearScreenButton => 1);
174 for my $barcode ( @$barcodes ) {
175 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
176 $barcode = barcodedecode($barcode)
177 if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
180 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
181 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
182 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso' }); }
184 my $restoreduedatespec = $query->param('restoreduedatespec') || $session->param('stickyduedate') || $duedatespec;
185 if ($restoreduedatespec eq "highholds_empty") {
186 undef $restoreduedatespec;
188 my $issueconfirmed = $query->param('issueconfirmed');
189 my $cancelreserve = $query->param('cancelreserve');
190 my $print = $query->param('print') || q{};
191 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
192 my $charges = $query->param('charges') || q{};
194 # Check if stickyduedate is turned off
196 # was stickyduedate loaded from session?
197 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
198 $session->clear( 'stickyduedate' );
199 $stickyduedate = $query->param('stickyduedate');
200 $duedatespec = $query->param('duedatespec');
202 $session->param('auto_renew', $query->param('auto_renew'));
205 $session->clear('auto_renew');
208 my ($datedue,$invalidduedate);
210 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
211 if( $onsite_checkout && !$duedatespec_allow ) {
212 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
213 $datedue .= ' 23:59:00';
214 } elsif( $duedatespec_allow ) {
215 if ( $duedatespec ) {
216 $datedue = eval { dt_from_string( $duedatespec ) };
219 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
224 # check and see if we should print
225 if ( @$barcodes == 0 && $print eq 'maybe' ) {
229 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
230 if ( @$barcodes == 0 && $charges eq 'yes' ) {
233 borrowernumber => $borrowernumber
237 if ( $print eq 'yes' && $borrowernumber ne '' ) {
238 if ( C4::Context->boolean_preference('printcirculationslips') ) {
239 my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
240 NetworkPrint($letter->{content});
242 $query->param( 'borrowernumber', '' );
243 $borrowernumber = '';
247 # STEP 2 : FIND BORROWER
248 # if there is a list of find borrowers....
252 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
254 $borrowernumber = $borrower->{borrowernumber};
256 my $dt_params = { iDisplayLength => -1 };
257 my $results = C4::Utils::DataTables::Members::search(
259 searchmember => $findborrower,
260 searchtype => 'contain',
261 dt_params => $dt_params,
264 my $borrowers = $results->{patrons};
265 if ( scalar @$borrowers == 1 ) {
266 $borrowernumber = $borrowers->[0]->{borrowernumber};
267 $query->param( 'borrowernumber', $borrowernumber );
268 $query->param( 'barcode', '' );
269 } elsif ( @$borrowers ) {
270 $template->param( borrowers => $borrowers );
272 $query->param( 'findborrower', '' );
273 $message = "'$findborrower'";
278 # get the borrower information.....
279 if ($borrowernumber) {
280 $borrower = GetMemberDetails( $borrowernumber, 0 );
281 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
283 # Warningdate is the date that the warning starts appearing
284 my ( $today_year, $today_month, $today_day) = Today();
285 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
286 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
287 # if the expiry date is before today ie they have expired
288 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
289 || Date_to_Days($today_year, $today_month, $today_day )
290 > Date_to_Days($warning_year, $warning_month, $warning_day) )
292 #borrowercard expired, no issues
294 noissues => ($force_allow_issue) ? 0 : "1",
295 forceallow => $force_allow_issue,
299 # check for NotifyBorrowerDeparture
300 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
301 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
302 Date_to_Days( $today_year, $today_month, $today_day ) )
304 # borrower card soon to expire warn librarian
305 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
307 if (C4::Context->preference('ReturnBeforeExpiry')){
308 $template->param("returnbeforeexpiry" => 1);
313 issuecount => $issue,
317 if ( IsDebarred($borrowernumber) ) {
319 'userdebarred' => $borrower->{debarred},
320 'debarredcomment' => $borrower->{debarredcomment},
323 if ( $borrower->{debarred} ne "9999-12-31" ) {
324 $template->param( 'userdebarreddate' => $borrower->{debarred} );
336 for my $barcode ( @$barcodes ) {
337 my $template_params = { barcode => $barcode };
338 # always check for blockers on issuing
339 my ( $error, $question, $alerts ) =
340 CanBookBeIssued( $borrower, $barcode, $datedue , $inprocess, undef, { onsite_checkout => $onsite_checkout } );
341 my $blocker = $invalidduedate ? 1 : 0;
343 $template_params->{alert} = $alerts;
345 # Get the item title for more information
346 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
347 $template_params->{authvalcode_notforloan} =
348 C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
350 # Fix for bug 7494: optional checkout-time fallback search for a book
352 if ( $error->{'UNKNOWN_BARCODE'}
353 && C4::Context->preference("itemBarcodeFallbackSearch")
357 $template_params->{FALLBACK} = 1;
359 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
360 my $query = "kw=" . $barcode;
361 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
363 # if multiple hits, offer options to librarian
364 if ( $total_hits > 0 ) {
366 foreach my $hit ( @{$results} ) {
368 TransformMarcToKoha( C4::Search::new_record_from_zebra('biblioserver',$hit) );
370 # offer all barcodes individually
371 if ( $chosen->{barcode} ) {
372 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
373 my %chosen_single = %{$chosen};
374 $chosen_single{barcode} = $barcode;
375 push( @options, \%chosen_single );
379 $template_params->{options} = \@options;
383 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
384 delete $question->{'DEBT'} if ($debt_confirmed);
385 foreach my $impossible ( keys %$error ) {
386 $template_params->{$impossible} = $$error{$impossible};
387 $template_params->{IMPOSSIBLE} = 1;
391 my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
392 if( !$blocker || $force_allow_issue ){
393 my $confirm_required = 0;
394 unless($issueconfirmed){
395 # Get the item title for more information
396 my $materials = $iteminfo->{'materials'};
397 my $avcode = GetAuthValCode('items.materials');
399 $materials = GetKohaAuthorisedValueLib($avcode, $materials);
401 $template_params->{additional_materials} = $materials;
402 $template_params->{itemhomebranch} = $iteminfo->{'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} = $iteminfo->{'title'};
408 $template_params->{getBarcodeMessageIteminfo} = $iteminfo->{'barcode'};
409 $template_params->{NEEDSCONFIRMATION} = 1;
410 $template_params->{onsite_checkout} = $onsite_checkout;
411 $confirm_required = 1;
414 unless($confirm_required) {
415 my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew') } );
416 $template->param( issue => $issue );
417 $session->clear('auto_renew');
422 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
423 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines($borrowernumber);
425 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
427 reserveborrowernumber => $question->{'resborrowernumber'}
432 itembiblionumber => $getmessageiteminfo->{'biblionumber'}
437 $template_params->{issuecount} = $issue;
440 $iteminfo->{subtitle} = GetRecordValue('subtitle', GetMarcBiblio($iteminfo->{biblionumber}), GetFrameworkCode($iteminfo->{biblionumber}));
441 $template_params->{item} = $iteminfo;
443 push @$checkout_infos, $template_params;
446 $template->param( %{$checkout_infos->[0]} );
447 $template->param( barcode => $barcodes->[0] );
449 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
451 checkout_infos => $checkout_infos,
452 confirmation_needed => $confirmation_needed,
457 # reload the borrower info for the sake of reseting the flags.....
458 if ($borrowernumber) {
459 $borrower = GetMemberDetails( $borrowernumber, 0 );
462 ##################################################################################
464 # show all reserves of this borrower, and the position of the reservation ....
465 if ($borrowernumber) {
466 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
467 my $waiting_holds = $holds->waiting;
469 holds_count => $holds->count(),
470 WaitingHolds => $waiting_holds,
473 $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
477 my $flags = $borrower->{'flags'};
478 foreach my $flag ( sort keys %$flags ) {
479 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
480 if ( $flags->{$flag}->{'noissues'} ) {
482 noissues => ($force_allow_issue) ? 0 : 'true',
483 forceallow => $force_allow_issue,
485 if ( $flag eq 'GNA' ) {
486 $template->param( gna => 'true' );
488 elsif ( $flag eq 'LOST' ) {
489 $template->param( lost => 'true' );
491 elsif ( $flag eq 'DBARRED' ) {
492 $template->param( dbarred => 'true' );
494 elsif ( $flag eq 'CHARGES' ) {
497 chargesmsg => $flags->{'CHARGES'}->{'message'},
498 chargesamount => $flags->{'CHARGES'}->{'amount'},
499 charges_is_blocker => 1
502 elsif ( $flag eq 'CREDITS' ) {
505 creditsmsg => $flags->{'CREDITS'}->{'message'},
506 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
511 if ( $flag eq 'CHARGES' ) {
514 chargesmsg => $flags->{'CHARGES'}->{'message'},
515 chargesamount => $flags->{'CHARGES'}->{'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 = $borrower->{flags} ? $borrower->{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 ( $catcodes, $labels ) = GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
552 my $cnt = scalar(@$catcodes);
553 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
554 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
557 my $librarian_messages = Koha::Patron::Messages->search(
559 borrowernumber => $borrowernumber,
564 my $patron_messages = Koha::Patron::Messages->search(
566 borrowernumber => $borrowernumber,
571 my $fast_cataloging = 0;
572 if (defined getframeworkinfo('FA')) {
576 if (C4::Context->preference('ExtendedPatronAttributes')) {
577 my $attributes = GetBorrowerAttributes($borrowernumber);
579 ExtendedPatronAttributes => 1,
580 extendedattributes => $attributes
584 ?'batch_checkout_view'
588 if ( $borrowernumber ) {
589 if ( my $patron = Koha::Patrons->find( $borrower->{borrowernumber} ) ) {
590 if ( my $guarantor = $patron->guarantor ) {
591 push @relatives, $guarantor->borrowernumber;
592 push @relatives, $_->borrowernumber for $patron->siblings;
594 push @relatives, $_->borrowernumber for $patron->guarantees;
598 my $relatives_issues_count =
599 Koha::Database->new()->schema()->resultset('Issue')
600 ->count( { borrowernumber => \@relatives } );
602 my $roadtype = C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{streettype} );
604 $template->param(%$borrower);
606 # Restore date if changed by holds and/or save stickyduedate to session
607 if ($restoreduedatespec || $stickyduedate) {
608 $duedatespec = $restoreduedatespec || $duedatespec;
610 if ($stickyduedate) {
611 $session->param( 'stickyduedate', $duedatespec );
613 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
618 librarian_messages => $librarian_messages,
619 patron_messages => $patron_messages,
620 findborrower => $findborrower,
621 borrower => $borrower,
622 borrowernumber => $borrowernumber,
623 categoryname => $borrower->{'description'},
625 branchname => GetBranchName($borrower->{'branchcode'}),
627 printername => $printer,
628 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
629 expiry => $borrower->{'dateexpiry'},
630 roadtype => $roadtype,
631 amountold => $amountold,
632 barcodes => $barcodes,
633 stickyduedate => $stickyduedate,
634 duedatespec => $duedatespec,
635 restoreduedatespec => $restoreduedatespec,
637 totaldue => sprintf('%.2f', $total),
638 inprocess => $inprocess,
639 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
641 batch_allowed => $batch_allowed,
642 AudioAlerts => C4::Context->preference("AudioAlerts"),
643 fast_cataloging => $fast_cataloging,
644 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
645 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
646 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
647 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
648 RoutingSerials => C4::Context->preference('RoutingSerials'),
649 relatives_issues_count => $relatives_issues_count,
650 relatives_borrowernumbers => \@relatives,
653 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
654 $template->param( picture => 1 ) if $patron_image;
656 # get authorised values with type of BOR_NOTES
658 my $canned_notes = GetAuthorisedValues("BOR_NOTES");
661 debt_confirmed => $debt_confirmed,
662 SpecifyDueDate => $duedatespec_allow,
663 CircAutocompl => C4::Context->preference("CircAutocompl"),
664 canned_bor_notes_loop => $canned_notes,
665 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
666 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
667 modifications => Koha::Patron::Modifications->GetModifications({ borrowernumber => $borrowernumber }),
670 output_html_with_http_headers $query, $cookie, $template->output;