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);
46 use Koha::Patron::Debarments qw(GetDebarments);
49 use Koha::Patron::Messages;
50 use Koha::Patron::Images;
51 use Koha::SearchEngine;
52 use Koha::SearchEngine::Search;
53 use Koha::Patron::Modifications;
60 use List::MoreUtils qw/uniq/;
67 my $override_high_holds = $query->param('override_high_holds');
68 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
70 my $sessionID = $query->cookie("CGISESSID") ;
71 my $session = get_session($sessionID);
72 if (!C4::Context->userenv){
73 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
74 # no branch set we can't issue
75 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
81 my $barcode = $query->param('barcode');
82 # Barcode given by user could be '0'
83 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
84 $barcodes = [ $barcode ];
86 my $filefh = $query->upload('uploadfile');
88 while ( my $content = <$filefh> ) {
89 $content =~ s/[\r\n]*$//g;
90 push @$barcodes, $content if $content;
92 } elsif ( my $list = $query->param('barcodelist') ) {
93 push @$barcodes, split( /\s\n/, $list );
94 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
96 @$barcodes = $query->multi_param('barcodes');
100 $barcodes = [ uniq @$barcodes ];
102 my $template_name = q|circ/circulation.tt|;
103 my $borrowernumber = $query->param('borrowernumber');
104 my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
105 my $batch = $query->param('batch');
106 my $batch_allowed = 0;
107 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
108 $template_name = q|circ/circulation_batch_checkouts.tt|;
109 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
110 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
117 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
119 template_name => $template_name,
122 authnotrequired => 0,
123 flagsrequired => { circulate => 'circulate_remaining_permissions' },
127 my $force_allow_issue = $query->param('forceallow') || 0;
128 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
129 $force_allow_issue = 0;
132 my $onsite_checkout = $query->param('onsite_checkout');
134 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
135 our %renew_failed = ();
136 for (@failedrenews) { $renew_failed{$_} = 1; }
138 my @failedreturns = $query->multi_param('failedreturn');
139 our %return_failed = ();
140 for (@failedreturns) { $return_failed{$_} = 1; }
142 my $findborrower = $query->param('findborrower') || q{};
143 $findborrower =~ s|,| |g;
145 my $branch = C4::Context->userenv->{'branch'};
147 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
148 if (C4::Context->preference("AutoLocation") != 1) {
149 $template->param(ManualLocation => 1);
152 if (C4::Context->preference("DisplayClearScreenButton")) {
153 $template->param(DisplayClearScreenButton => 1);
156 for my $barcode ( @$barcodes ) {
157 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
158 $barcode = barcodedecode($barcode)
159 if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
162 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
163 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
164 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso', timeformat => '24hr' }); }
166 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
167 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
168 undef $restoreduedatespec;
170 my $issueconfirmed = $query->param('issueconfirmed');
171 my $cancelreserve = $query->param('cancelreserve');
172 my $print = $query->param('print') || q{};
173 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
174 my $charges = $query->param('charges') || q{};
176 # Check if stickyduedate is turned off
178 # was stickyduedate loaded from session?
179 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
180 $session->clear( 'stickyduedate' );
181 $stickyduedate = $query->param('stickyduedate');
182 $duedatespec = $query->param('duedatespec');
184 $session->param('auto_renew', scalar $query->param('auto_renew'));
187 $session->clear('auto_renew');
190 my ($datedue,$invalidduedate);
192 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
193 if( $onsite_checkout && !$duedatespec_allow ) {
194 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
195 $datedue .= ' 23:59:00';
196 } elsif( $duedatespec_allow ) {
197 if ( $duedatespec ) {
198 $datedue = eval { dt_from_string( $duedatespec ) };
201 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
206 # check and see if we should print
207 if ( @$barcodes == 0 && $print eq 'maybe' ) {
211 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
212 if ( @$barcodes == 0 && $charges eq 'yes' ) {
215 borrowernumber => $borrowernumber
219 if ( $print eq 'yes' && $borrowernumber ne '' ) {
220 if ( C4::Context->boolean_preference('printcirculationslips') ) {
221 my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
222 NetworkPrint($letter->{content});
224 $query->param( 'borrowernumber', '' );
225 $borrowernumber = '';
229 # STEP 2 : FIND BORROWER
230 # if there is a list of find borrowers....
234 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
236 $borrowernumber = $borrower->{borrowernumber};
238 my $dt_params = { iDisplayLength => -1 };
239 my $results = C4::Utils::DataTables::Members::search(
241 searchmember => $findborrower,
242 searchtype => 'contain',
243 dt_params => $dt_params,
246 my $borrowers = $results->{patrons};
247 if ( scalar @$borrowers == 1 ) {
248 $borrowernumber = $borrowers->[0]->{borrowernumber};
249 $query->param( 'borrowernumber', $borrowernumber );
250 $query->param( 'barcode', '' );
251 } elsif ( @$borrowers ) {
252 $template->param( borrowers => $borrowers );
254 $query->param( 'findborrower', '' );
255 $message = "'$findborrower'";
260 # get the borrower information.....
261 if ($borrowernumber) {
262 $borrower = GetMemberDetails( $borrowernumber, 0 );
263 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
265 # Warningdate is the date that the warning starts appearing
266 my ( $today_year, $today_month, $today_day) = Today();
267 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
268 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
269 # if the expiry date is before today ie they have expired
270 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
271 || Date_to_Days($today_year, $today_month, $today_day )
272 > Date_to_Days($warning_year, $warning_month, $warning_day) )
274 #borrowercard expired, no issues
276 noissues => ($force_allow_issue) ? 0 : "1",
277 forceallow => $force_allow_issue,
281 # check for NotifyBorrowerDeparture
282 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
283 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
284 Date_to_Days( $today_year, $today_month, $today_day ) )
286 # borrower card soon to expire warn librarian
287 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
289 if (C4::Context->preference('ReturnBeforeExpiry')){
290 $template->param("returnbeforeexpiry" => 1);
295 issuecount => $issue,
299 my $patron = Koha::Patrons->find( $borrowernumber );
300 if ( $patron and $patron->is_debarred ) {
302 'userdebarred' => $borrower->{debarred},
303 'debarredcomment' => $borrower->{debarredcomment},
306 if ( $borrower->{debarred} ne "9999-12-31" ) {
307 $template->param( 'userdebarreddate' => $borrower->{debarred} );
319 for my $barcode ( @$barcodes ) {
320 my $template_params = { barcode => $barcode };
321 # always check for blockers on issuing
322 my ( $error, $question, $alerts ) = CanBookBeIssued(
328 onsite_checkout => $onsite_checkout,
329 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
333 my $blocker = $invalidduedate ? 1 : 0;
335 $template_params->{alert} = $alerts;
337 # Get the item title for more information
338 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
339 $template_params->{authvalcode_notforloan} =
340 C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
342 # Fix for bug 7494: optional checkout-time fallback search for a book
344 if ( $error->{'UNKNOWN_BARCODE'}
345 && C4::Context->preference("itemBarcodeFallbackSearch")
349 $template_params->{FALLBACK} = 1;
351 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
352 my $query = "kw=" . $barcode;
353 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
355 # if multiple hits, offer options to librarian
356 if ( $total_hits > 0 ) {
358 foreach my $hit ( @{$results} ) {
360 TransformMarcToKoha( C4::Search::new_record_from_zebra('biblioserver',$hit) );
362 # offer all barcodes individually
363 if ( $chosen->{barcode} ) {
364 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
365 my %chosen_single = %{$chosen};
366 $chosen_single{barcode} = $barcode;
367 push( @options, \%chosen_single );
371 $template_params->{options} = \@options;
375 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
376 delete $question->{'DEBT'} if ($debt_confirmed);
377 foreach my $impossible ( keys %$error ) {
378 $template_params->{$impossible} = $$error{$impossible};
379 $template_params->{IMPOSSIBLE} = 1;
383 my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
384 if( !$blocker || $force_allow_issue ){
385 my $confirm_required = 0;
386 unless($issueconfirmed){
387 # Get the item title for more information
388 my $materials = $iteminfo->{'materials'};
389 my $avcode = GetAuthValCode('items.materials');
391 $materials = GetKohaAuthorisedValueLib($avcode, $materials);
393 $template_params->{additional_materials} = $materials;
394 $template_params->{itemhomebranch} = $iteminfo->{'homebranch'};
396 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
397 foreach my $needsconfirmation ( keys %$question ) {
398 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
399 $template_params->{getTitleMessageIteminfo} = $iteminfo->{'title'};
400 $template_params->{getBarcodeMessageIteminfo} = $iteminfo->{'barcode'};
401 $template_params->{NEEDSCONFIRMATION} = 1;
402 $template_params->{onsite_checkout} = $onsite_checkout;
403 $confirm_required = 1;
406 unless($confirm_required) {
407 my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew') } );
408 $template_params->{issue} = $issue;
409 $session->clear('auto_renew');
414 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
415 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines($borrowernumber);
417 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
419 reserveborrowernumber => $question->{'resborrowernumber'}
424 itembiblionumber => $getmessageiteminfo->{'biblionumber'}
429 $template_params->{issuecount} = $issue;
432 $iteminfo->{subtitle} = GetRecordValue('subtitle', GetMarcBiblio($iteminfo->{biblionumber}), GetFrameworkCode($iteminfo->{biblionumber}));
433 $template_params->{item} = $iteminfo;
435 push @$checkout_infos, $template_params;
438 $template->param( %{$checkout_infos->[0]} );
439 $template->param( barcode => $barcodes->[0] );
441 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
443 checkout_infos => $checkout_infos,
444 confirmation_needed => $confirmation_needed,
449 # reload the borrower info for the sake of reseting the flags.....
450 if ($borrowernumber) {
451 $borrower = GetMemberDetails( $borrowernumber, 0 );
454 ##################################################################################
456 # show all reserves of this borrower, and the position of the reservation ....
457 if ($borrowernumber) {
458 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
459 my $waiting_holds = $holds->waiting;
461 holds_count => $holds->count(),
462 WaitingHolds => $waiting_holds,
465 $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
469 my $flags = $borrower->{'flags'};
470 foreach my $flag ( sort keys %$flags ) {
471 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
472 if ( $flags->{$flag}->{'noissues'} ) {
474 noissues => ($force_allow_issue) ? 0 : 'true',
475 forceallow => $force_allow_issue,
477 if ( $flag eq 'GNA' ) {
478 $template->param( gna => 'true' );
480 elsif ( $flag eq 'LOST' ) {
481 $template->param( lost => 'true' );
483 elsif ( $flag eq 'DBARRED' ) {
484 $template->param( dbarred => 'true' );
486 elsif ( $flag eq 'CHARGES' ) {
489 chargesmsg => $flags->{'CHARGES'}->{'message'},
490 chargesamount => $flags->{'CHARGES'}->{'amount'},
491 charges_is_blocker => 1
494 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
496 charges_guarantees => 'true',
497 chargesmsg_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'message'},
498 chargesamount_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'amount'},
499 charges_guarantees_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 'CHARGES_GUARANTEES' ) {
520 charges_guarantees => 'true',
521 chargesmsg_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'message'},
522 chargesamount_guarantees => $flags->{'CHARGES_GUARANTEES'}->{'amount'},
525 elsif ( $flag eq 'CREDITS' ) {
528 creditsmsg => $flags->{'CREDITS'}->{'message'},
529 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
532 elsif ( $flag eq 'ODUES' ) {
535 oduesmsg => $flags->{'ODUES'}->{'message'}
538 my $items = $flags->{$flag}->{'itemlist'};
539 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
540 $template->param( nonreturns => 'true' );
543 elsif ( $flag eq 'NOTES' ) {
546 notesmsg => $flags->{'NOTES'}->{'message'}
552 my $amountold = $borrower->{flags} ? $borrower->{flags}->{'CHARGES'}->{'message'} || 0 : 0;
553 $amountold =~ s/^.*\$//; # remove upto the $, if any
555 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
557 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
558 my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
559 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
560 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
563 my $librarian_messages = Koha::Patron::Messages->search(
565 borrowernumber => $borrowernumber,
570 my $patron_messages = Koha::Patron::Messages->search(
572 borrowernumber => $borrowernumber,
577 my $fast_cataloging = 0;
578 if (defined getframeworkinfo('FA')) {
582 if (C4::Context->preference('ExtendedPatronAttributes')) {
583 my $attributes = GetBorrowerAttributes($borrowernumber);
585 ExtendedPatronAttributes => 1,
586 extendedattributes => $attributes
590 ?'batch_checkout_view'
594 if ( $borrowernumber ) {
595 if ( my $patron = Koha::Patrons->find( $borrower->{borrowernumber} ) ) {
596 if ( my $guarantor = $patron->guarantor ) {
597 push @relatives, $guarantor->borrowernumber;
598 push @relatives, $_->borrowernumber for $patron->siblings;
600 push @relatives, $_->borrowernumber for $patron->guarantees;
604 my $relatives_issues_count =
605 Koha::Database->new()->schema()->resultset('Issue')
606 ->count( { borrowernumber => \@relatives } );
608 my $roadtype = C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{streettype} );
610 $template->param(%$borrower);
612 # Restore date if changed by holds and/or save stickyduedate to session
613 if ($restoreduedatespec || $stickyduedate) {
614 $duedatespec = $restoreduedatespec || $duedatespec;
616 if ($stickyduedate) {
617 $session->param( 'stickyduedate', $duedatespec );
619 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
624 librarian_messages => $librarian_messages,
625 patron_messages => $patron_messages,
626 borrower => $borrower,
627 borrowernumber => $borrowernumber,
628 categoryname => $borrower->{'description'},
630 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
631 expiry => $borrower->{'dateexpiry'},
632 roadtype => $roadtype,
633 amountold => $amountold,
634 barcodes => $barcodes,
635 stickyduedate => $stickyduedate,
636 duedatespec => $duedatespec,
637 restoreduedatespec => $restoreduedatespec,
639 totaldue => sprintf('%.2f', $total),
640 inprocess => $inprocess,
641 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
643 batch_allowed => $batch_allowed,
645 AudioAlerts => C4::Context->preference("AudioAlerts"),
646 fast_cataloging => $fast_cataloging,
647 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
648 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
649 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
650 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
651 RoutingSerials => C4::Context->preference('RoutingSerials'),
652 relatives_issues_count => $relatives_issues_count,
653 relatives_borrowernumbers => \@relatives,
656 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
657 $template->param( picture => 1 ) if $patron_image;
659 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
661 debt_confirmed => $debt_confirmed,
662 SpecifyDueDate => $duedatespec_allow,
663 CircAutocompl => C4::Context->preference("CircAutocompl"),
664 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
665 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
666 has_modifications => $has_modifications,
667 override_high_holds => $override_high_holds,
668 nopermission => scalar $query->param('nopermission'),
671 output_html_with_http_headers $query, $cookie, $template->output;