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);
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 $override_high_holds = $query->param('override_high_holds');
69 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
71 my $sessionID = $query->cookie("CGISESSID") ;
72 my $session = get_session($sessionID);
73 if (!C4::Context->userenv){
74 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
75 # no branch set we can't issue
76 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
82 my $barcode = $query->param('barcode');
83 # Barcode given by user could be '0'
84 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
85 $barcodes = [ $barcode ];
87 my $filefh = $query->upload('uploadfile');
89 while ( my $content = <$filefh> ) {
90 $content =~ s/[\r\n]*$//g;
91 push @$barcodes, $content if $content;
93 } elsif ( my $list = $query->param('barcodelist') ) {
94 push @$barcodes, split( /\s\n/, $list );
95 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
97 @$barcodes = $query->multi_param('barcodes');
101 $barcodes = [ uniq @$barcodes ];
103 my $template_name = q|circ/circulation.tt|;
104 my $borrowernumber = $query->param('borrowernumber');
105 my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
106 my $batch = $query->param('batch');
107 my $batch_allowed = 0;
108 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
109 $template_name = q|circ/circulation_batch_checkouts.tt|;
110 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
111 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
118 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
120 template_name => $template_name,
123 authnotrequired => 0,
124 flagsrequired => { circulate => 'circulate_remaining_permissions' },
128 my $force_allow_issue = $query->param('forceallow') || 0;
129 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
130 $force_allow_issue = 0;
133 my $onsite_checkout = $query->param('onsite_checkout');
135 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
136 our %renew_failed = ();
137 for (@failedrenews) { $renew_failed{$_} = 1; }
139 my @failedreturns = $query->multi_param('failedreturn');
140 our %return_failed = ();
141 for (@failedreturns) { $return_failed{$_} = 1; }
143 my $findborrower = $query->param('findborrower') || q{};
144 $findborrower =~ s|,| |g;
146 my $branch = C4::Context->userenv->{'branch'};
148 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
149 if (C4::Context->preference("AutoLocation") != 1) {
150 $template->param(ManualLocation => 1);
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 => 'contain',
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.....
262 if ($borrowernumber) {
263 $borrower = GetMemberDetails( $borrowernumber, 0 );
264 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
266 # Warningdate is the date that the warning starts appearing
267 my ( $today_year, $today_month, $today_day) = Today();
268 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
269 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
270 # if the expiry date is before today ie they have expired
271 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
272 || Date_to_Days($today_year, $today_month, $today_day )
273 > Date_to_Days($warning_year, $warning_month, $warning_day) )
275 #borrowercard expired, no issues
277 noissues => ($force_allow_issue) ? 0 : "1",
278 forceallow => $force_allow_issue,
282 # check for NotifyBorrowerDeparture
283 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
284 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
285 Date_to_Days( $today_year, $today_month, $today_day ) )
287 # borrower card soon to expire warn librarian
288 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
290 if (C4::Context->preference('ReturnBeforeExpiry')){
291 $template->param("returnbeforeexpiry" => 1);
296 issuecount => $issue,
300 my $patron = Koha::Patrons->find( $borrowernumber );
301 if ( $patron and $patron->is_debarred ) {
303 'userdebarred' => $borrower->{debarred},
304 'debarredcomment' => $borrower->{debarredcomment},
307 if ( $borrower->{debarred} ne "9999-12-31" ) {
308 $template->param( 'userdebarreddate' => $borrower->{debarred} );
320 for my $barcode ( @$barcodes ) {
321 my $template_params = { barcode => $barcode };
322 # always check for blockers on issuing
323 my ( $error, $question, $alerts ) = CanBookBeIssued(
329 onsite_checkout => $onsite_checkout,
330 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
334 my $blocker = $invalidduedate ? 1 : 0;
336 $template_params->{alert} = $alerts;
338 # Get the item title for more information
339 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
340 $template_params->{authvalcode_notforloan} =
341 C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
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} ) {
361 TransformMarcToKoha( C4::Search::new_record_from_zebra('biblioserver',$hit) );
363 # offer all barcodes individually
364 if ( $chosen->{barcode} ) {
365 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
366 my %chosen_single = %{$chosen};
367 $chosen_single{barcode} = $barcode;
368 push( @options, \%chosen_single );
372 $template_params->{options} = \@options;
376 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
377 delete $question->{'DEBT'} if ($debt_confirmed);
378 foreach my $impossible ( keys %$error ) {
379 $template_params->{$impossible} = $$error{$impossible};
380 $template_params->{IMPOSSIBLE} = 1;
384 my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
385 if( !$blocker || $force_allow_issue ){
386 my $confirm_required = 0;
387 unless($issueconfirmed){
388 # Get the item title for more information
389 my $materials = $iteminfo->{'materials'};
390 my $avcode = GetAuthValCode('items.materials');
392 $materials = GetKohaAuthorisedValueLib($avcode, $materials);
394 $template_params->{additional_materials} = $materials;
395 $template_params->{itemhomebranch} = $iteminfo->{'homebranch'};
397 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
398 foreach my $needsconfirmation ( keys %$question ) {
399 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
400 $template_params->{getTitleMessageIteminfo} = $iteminfo->{'title'};
401 $template_params->{getBarcodeMessageIteminfo} = $iteminfo->{'barcode'};
402 $template_params->{NEEDSCONFIRMATION} = 1;
403 $template_params->{onsite_checkout} = $onsite_checkout;
404 $confirm_required = 1;
407 unless($confirm_required) {
408 my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew') } );
409 $template_params->{issue} = $issue;
410 $session->clear('auto_renew');
415 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
416 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines($borrowernumber);
418 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
420 reserveborrowernumber => $question->{'resborrowernumber'}
425 itembiblionumber => $getmessageiteminfo->{'biblionumber'}
430 $template_params->{issuecount} = $issue;
433 $iteminfo->{subtitle} = GetRecordValue('subtitle', GetMarcBiblio($iteminfo->{biblionumber}), GetFrameworkCode($iteminfo->{biblionumber}));
434 $template_params->{item} = $iteminfo;
436 push @$checkout_infos, $template_params;
439 $template->param( %{$checkout_infos->[0]} );
440 $template->param( barcode => $barcodes->[0] );
442 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
444 checkout_infos => $checkout_infos,
445 confirmation_needed => $confirmation_needed,
450 # reload the borrower info for the sake of reseting the flags.....
451 if ($borrowernumber) {
452 $borrower = GetMemberDetails( $borrowernumber, 0 );
455 ##################################################################################
457 # show all reserves of this borrower, and the position of the reservation ....
458 if ($borrowernumber) {
459 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
460 my $waiting_holds = $holds->waiting;
462 holds_count => $holds->count(),
463 WaitingHolds => $waiting_holds,
466 $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
470 my $flags = $borrower->{'flags'};
471 foreach my $flag ( sort keys %$flags ) {
472 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
473 if ( $flags->{$flag}->{'noissues'} ) {
475 noissues => ($force_allow_issue) ? 0 : 'true',
476 forceallow => $force_allow_issue,
478 if ( $flag eq 'GNA' ) {
479 $template->param( gna => 'true' );
481 elsif ( $flag eq 'LOST' ) {
482 $template->param( lost => 'true' );
484 elsif ( $flag eq 'DBARRED' ) {
485 $template->param( dbarred => 'true' );
487 elsif ( $flag eq 'CHARGES' ) {
490 chargesmsg => $flags->{'CHARGES'}->{'message'},
491 chargesamount => $flags->{'CHARGES'}->{'amount'},
492 charges_is_blocker => 1
495 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
497 charges_guarantees => 'true',
498 chargesmsg_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'message'},
499 chargesamount_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'amount'},
500 charges_guarantees_is_blocker => 1
503 elsif ( $flag eq 'CREDITS' ) {
506 creditsmsg => $flags->{'CREDITS'}->{'message'},
507 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
512 if ( $flag eq 'CHARGES' ) {
515 chargesmsg => $flags->{'CHARGES'}->{'message'},
516 chargesamount => $flags->{'CHARGES'}->{'amount'},
519 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
521 charges_guarantees => 'true',
522 chargesmsg_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'message'},
523 chargesamount_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'amount'},
526 elsif ( $flag eq 'CREDITS' ) {
529 creditsmsg => $flags->{'CREDITS'}->{'message'},
530 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
533 elsif ( $flag eq 'ODUES' ) {
536 oduesmsg => $flags->{'ODUES'}->{'message'}
539 my $items = $flags->{$flag}->{'itemlist'};
540 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
541 $template->param( nonreturns => 'true' );
544 elsif ( $flag eq 'NOTES' ) {
547 notesmsg => $flags->{'NOTES'}->{'message'}
553 my $amountold = $borrower->{flags} ? $borrower->{flags}->{'CHARGES'}->{'message'} || 0 : 0;
554 $amountold =~ s/^.*\$//; # remove upto the $, if any
556 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
558 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
559 my ( $catcodes, $labels ) = GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
560 my $cnt = scalar(@$catcodes);
561 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
562 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
565 my $librarian_messages = Koha::Patron::Messages->search(
567 borrowernumber => $borrowernumber,
572 my $patron_messages = Koha::Patron::Messages->search(
574 borrowernumber => $borrowernumber,
579 my $fast_cataloging = 0;
580 if (defined getframeworkinfo('FA')) {
584 if (C4::Context->preference('ExtendedPatronAttributes')) {
585 my $attributes = GetBorrowerAttributes($borrowernumber);
587 ExtendedPatronAttributes => 1,
588 extendedattributes => $attributes
592 ?'batch_checkout_view'
596 if ( $borrowernumber ) {
597 if ( my $patron = Koha::Patrons->find( $borrower->{borrowernumber} ) ) {
598 if ( my $guarantor = $patron->guarantor ) {
599 push @relatives, $guarantor->borrowernumber;
600 push @relatives, $_->borrowernumber for $patron->siblings;
602 push @relatives, $_->borrowernumber for $patron->guarantees;
606 my $relatives_issues_count =
607 Koha::Database->new()->schema()->resultset('Issue')
608 ->count( { borrowernumber => \@relatives } );
610 my $roadtype = C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{streettype} );
612 $template->param(%$borrower);
614 # Restore date if changed by holds and/or save stickyduedate to session
615 if ($restoreduedatespec || $stickyduedate) {
616 $duedatespec = $restoreduedatespec || $duedatespec;
618 if ($stickyduedate) {
619 $session->param( 'stickyduedate', $duedatespec );
621 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
626 librarian_messages => $librarian_messages,
627 patron_messages => $patron_messages,
628 borrower => $borrower,
629 borrowernumber => $borrowernumber,
630 categoryname => $borrower->{'description'},
632 branchname => GetBranchName($borrower->{'branchcode'}),
633 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
634 expiry => $borrower->{'dateexpiry'},
635 roadtype => $roadtype,
636 amountold => $amountold,
637 barcodes => $barcodes,
638 stickyduedate => $stickyduedate,
639 duedatespec => $duedatespec,
640 restoreduedatespec => $restoreduedatespec,
642 totaldue => sprintf('%.2f', $total),
643 inprocess => $inprocess,
644 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
646 batch_allowed => $batch_allowed,
648 AudioAlerts => C4::Context->preference("AudioAlerts"),
649 fast_cataloging => $fast_cataloging,
650 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
651 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
652 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
653 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
654 RoutingSerials => C4::Context->preference('RoutingSerials'),
655 relatives_issues_count => $relatives_issues_count,
656 relatives_borrowernumbers => \@relatives,
659 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
660 $template->param( picture => 1 ) if $patron_image;
662 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
664 debt_confirmed => $debt_confirmed,
665 SpecifyDueDate => $duedatespec_allow,
666 CircAutocompl => C4::Context->preference("CircAutocompl"),
667 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
668 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
669 has_modifications => $has_modifications,
670 override_high_holds => $override_high_holds,
671 nopermission => scalar $query->param('nopermission'),
674 output_html_with_http_headers $query, $cookie, $template->output;