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);
46 use Koha::Borrower::Debarments qw(GetDebarments IsDebarred);
56 use List::MoreUtils qw/uniq/;
63 my $sessionID = $query->cookie("CGISESSID") ;
64 my $session = get_session($sessionID);
66 # branch and printer are now defined by the userenv
67 # but first we have to check if someone has tried to change them
69 my $branch = $query->param('branch');
71 # update our session so the userenv is updated
72 $session->param('branch', $branch);
73 $session->param('branchname', GetBranchName($branch));
76 my $printer = $query->param('printer');
78 # update our session so the userenv is updated
79 $session->param('branchprinter', $printer);
82 if (!C4::Context->userenv && !$branch){
83 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
84 # no branch set we can't issue
85 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
91 my $barcode = $query->param('barcode');
92 # Barcode given by user could be '0'
93 if ( $barcode || $barcode eq '0' ) {
94 $barcodes = [ $barcode ];
96 my $filefh = $query->upload('uploadfile');
98 while ( my $content = <$filefh> ) {
99 $content =~ s/[\r\n]*$//g;
100 push @$barcodes, $content if $content;
102 } elsif ( my $list = $query->param('barcodelist') ) {
103 push @$barcodes, split( /\s\n/, $list );
104 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
106 @$barcodes = $query->param('barcodes');
110 $barcodes = [ uniq @$barcodes ];
112 my $template_name = q|circ/circulation.tt|;
113 my $borrowernumber = $query->param('borrowernumber');
114 my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
115 my $batch = $query->param('batch');
116 my $batch_allowed = 0;
117 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
118 $template_name = q|circ/circulation_batch_checkouts.tt|;
119 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
120 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
127 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
129 template_name => $template_name,
132 authnotrequired => 0,
133 flagsrequired => { circulate => 'circulate_remaining_permissions' },
137 my $branches = GetBranches();
139 my $force_allow_issue = $query->param('forceallow') || 0;
140 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
141 $force_allow_issue = 0;
144 my $onsite_checkout = $query->param('onsite_checkout');
146 my @failedrenews = $query->param('failedrenew'); # expected to be itemnumbers
147 our %renew_failed = ();
148 for (@failedrenews) { $renew_failed{$_} = 1; }
150 my @failedreturns = $query->param('failedreturn');
151 our %return_failed = ();
152 for (@failedreturns) { $return_failed{$_} = 1; }
154 my $findborrower = $query->param('findborrower') || q{};
155 $findborrower =~ s|,| |g;
157 $branch = C4::Context->userenv->{'branch'};
158 $printer = C4::Context->userenv->{'branchprinter'};
160 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
161 if (C4::Context->preference("AutoLocation") != 1) {
162 $template->param(ManualLocation => 1);
165 if (C4::Context->preference("DisplayClearScreenButton")) {
166 $template->param(DisplayClearScreenButton => 1);
169 for my $barcode ( @$barcodes ) {
170 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
171 $barcode = barcodedecode($barcode)
172 if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
175 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
176 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
177 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso' }); }
179 my $restoreduedatespec = $query->param('restoreduedatespec') || $session->param('stickyduedate') || $duedatespec;
180 if ($restoreduedatespec eq "highholds_empty") {
181 undef $restoreduedatespec;
183 my $issueconfirmed = $query->param('issueconfirmed');
184 my $cancelreserve = $query->param('cancelreserve');
185 my $print = $query->param('print') || q{};
186 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
187 my $charges = $query->param('charges') || q{};
189 # Check if stickyduedate is turned off
191 # was stickyduedate loaded from session?
192 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
193 $session->clear( 'stickyduedate' );
194 $stickyduedate = $query->param('stickyduedate');
195 $duedatespec = $query->param('duedatespec');
197 $session->param('auto_renew', $query->param('auto_renew'));
200 $session->clear('auto_renew');
203 my ($datedue,$invalidduedate);
205 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
206 if( $onsite_checkout && !$duedatespec_allow ) {
207 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
208 $datedue .= ' 23:59:00';
209 } elsif( $duedatespec_allow ) {
210 if ( $duedatespec ) {
211 $datedue = eval { dt_from_string( $duedatespec ) };
214 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
219 # check and see if we should print
220 if ( @$barcodes == 0 && $print eq 'maybe' ) {
224 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
225 if ( @$barcodes == 0 && $charges eq 'yes' ) {
228 borrowernumber => $borrowernumber
232 if ( $print eq 'yes' && $borrowernumber ne '' ) {
233 if ( C4::Context->boolean_preference('printcirculationslips') ) {
234 my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
235 NetworkPrint($letter->{content});
237 $query->param( 'borrowernumber', '' );
238 $borrowernumber = '';
242 # STEP 2 : FIND BORROWER
243 # if there is a list of find borrowers....
247 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
249 $borrowernumber = $borrower->{borrowernumber};
251 my $dt_params = { iDisplayLength => -1 };
252 my $results = C4::Utils::DataTables::Members::search(
254 searchmember => $findborrower,
255 searchtype => 'contain',
256 dt_params => $dt_params,
259 my $borrowers = $results->{patrons};
260 if ( scalar @$borrowers == 1 ) {
261 $borrowernumber = $borrowers->[0]->{borrowernumber};
262 $query->param( 'borrowernumber', $borrowernumber );
263 $query->param( 'barcode', '' );
264 } elsif ( @$borrowers ) {
265 $template->param( borrowers => $borrowers );
267 $query->param( 'findborrower', '' );
268 $message = "'$findborrower'";
273 # get the borrower information.....
274 if ($borrowernumber) {
275 $borrower = GetMemberDetails( $borrowernumber, 0 );
276 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
278 # Warningdate is the date that the warning starts appearing
279 my ( $today_year, $today_month, $today_day) = Today();
280 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
281 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
282 # if the expiry date is before today ie they have expired
283 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
284 || Date_to_Days($today_year, $today_month, $today_day )
285 > Date_to_Days($warning_year, $warning_month, $warning_day) )
287 #borrowercard expired, no issues
290 noissues => ($force_allow_issue) ? 0 : "1",
291 forceallow => $force_allow_issue,
295 # check for NotifyBorrowerDeparture
296 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
297 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
298 Date_to_Days( $today_year, $today_month, $today_day ) )
300 # borrower card soon to expire warn librarian
301 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
304 if (C4::Context->preference('ReturnBeforeExpiry')){
305 $template->param("returnbeforeexpiry" => 1);
310 issuecount => $issue,
314 if ( IsDebarred($borrowernumber) ) {
316 'userdebarred' => $borrower->{debarred},
317 'debarredcomment' => $borrower->{debarredcomment},
320 if ( $borrower->{debarred} ne "9999-12-31" ) {
321 $template->param( 'userdebarreddate' => $borrower->{debarred} );
333 for my $barcode ( @$barcodes ) {
334 my $template_params = { barcode => $barcode };
335 # always check for blockers on issuing
336 my ( $error, $question, $alerts ) =
337 CanBookBeIssued( $borrower, $barcode, $datedue , $inprocess, undef, { onsite_checkout => $onsite_checkout } );
338 my $blocker = $invalidduedate ? 1 : 0;
340 $template_params->{alert} = $alerts;
342 # Get the item title for more information
343 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
344 $template_params->{authvalcode_notforloan} =
345 C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
347 # Fix for bug 7494: optional checkout-time fallback search for a book
349 if ( $error->{'UNKNOWN_BARCODE'}
350 && C4::Context->preference("itemBarcodeFallbackSearch")
354 $template_params->{FALLBACK} = 1;
356 my $query = "kw=" . $barcode;
357 my ( $searcherror, $results, $total_hits ) = SimpleSearch($query);
359 # if multiple hits, offer options to librarian
360 if ( $total_hits > 0 ) {
362 foreach my $hit ( @{$results} ) {
364 TransformMarcToKoha( C4::Context->dbh,
365 C4::Search::new_record_from_zebra('biblioserver',$hit) );
367 # offer all barcodes individually
368 if ( $chosen->{barcode} ) {
369 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
370 my %chosen_single = %{$chosen};
371 $chosen_single{barcode} = $barcode;
372 push( @options, \%chosen_single );
376 $template_params->{options} = \@options;
380 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
381 delete $question->{'DEBT'} if ($debt_confirmed);
382 foreach my $impossible ( keys %$error ) {
383 $template_params->{$impossible} = $$error{$impossible};
384 $template_params->{IMPOSSIBLE} = 1;
388 my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
389 if( !$blocker || $force_allow_issue ){
390 my $confirm_required = 0;
391 unless($issueconfirmed){
392 # Get the item title for more information
393 $template_params->{additional_materials} = $iteminfo->{'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->param( 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 $template->param( flagged=> 1);
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 '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 'CREDITS' ) {
514 creditsmsg => $flags->{'CREDITS'}->{'message'},
515 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
518 elsif ( $flag eq 'ODUES' ) {
521 oduesmsg => $flags->{'ODUES'}->{'message'}
524 my $items = $flags->{$flag}->{'itemlist'};
525 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
526 $template->param( nonreturns => 'true' );
529 elsif ( $flag eq 'NOTES' ) {
532 notesmsg => $flags->{'NOTES'}->{'message'}
538 my $amountold = $borrower->{flags}->{'CHARGES'}->{'message'} || 0;
539 $amountold =~ s/^.*\$//; # remove upto the $, if any
541 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
543 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
544 my ( $catcodes, $labels ) = GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
545 my $cnt = scalar(@$catcodes);
546 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
547 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
550 my $lib_messages_loop = GetMessages( $borrowernumber, 'L', $branch );
551 if($lib_messages_loop){ $template->param(flagged => 1 ); }
553 my $bor_messages_loop = GetMessages( $borrowernumber, 'B', $branch );
554 if($bor_messages_loop){ $template->param(flagged => 1 ); }
556 my $fast_cataloging = 0;
557 if (defined getframeworkinfo('FA')) {
561 if (C4::Context->preference('ExtendedPatronAttributes')) {
562 my $attributes = GetBorrowerAttributes($borrowernumber);
564 ExtendedPatronAttributes => 1,
565 extendedattributes => $attributes
569 ?'batch_checkout_view'
572 my @relatives = GetMemberRelatives( $borrower->{'borrowernumber'} );
573 my $relatives_issues_count =
574 Koha::Database->new()->schema()->resultset('Issue')
575 ->count( { borrowernumber => \@relatives } );
577 my $roadtype = C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{streettype} );
579 $template->param(%$borrower);
581 # Restore date if changed by holds and/or save stickyduedate to session
582 if ($restoreduedatespec || $stickyduedate) {
583 $duedatespec = $restoreduedatespec || $duedatespec;
585 if ($stickyduedate) {
586 $session->param( 'stickyduedate', $duedatespec );
588 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
593 lib_messages_loop => $lib_messages_loop,
594 bor_messages_loop => $bor_messages_loop,
595 all_messages_del => C4::Context->preference('AllowAllMessageDeletion'),
596 findborrower => $findborrower,
597 borrower => $borrower,
598 borrowernumber => $borrowernumber,
599 categoryname => $borrower->{'description'},
601 branchname => GetBranchName($borrower->{'branchcode'}),
603 printername => $printer,
604 was_renewed => $query->param('was_renewed') ? 1 : 0,
605 expiry => $borrower->{'dateexpiry'},
606 roadtype => $roadtype,
607 amountold => $amountold,
608 barcodes => $barcodes,
609 stickyduedate => $stickyduedate,
610 duedatespec => $duedatespec,
611 restoreduedatespec => $restoreduedatespec,
613 totaldue => sprintf('%.2f', $total),
614 inprocess => $inprocess,
615 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
617 batch_allowed => $batch_allowed,
618 AudioAlerts => C4::Context->preference("AudioAlerts"),
619 fast_cataloging => $fast_cataloging,
620 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
621 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
622 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
623 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
624 RoutingSerials => C4::Context->preference('RoutingSerials'),
625 relatives_issues_count => $relatives_issues_count,
626 relatives_borrowernumbers => \@relatives,
629 my ($picture, $dberror) = GetPatronImage($borrower->{'borrowernumber'});
630 $template->param( picture => 1 ) if $picture;
632 # get authorised values with type of BOR_NOTES
634 my $canned_notes = GetAuthorisedValues("BOR_NOTES");
637 debt_confirmed => $debt_confirmed,
638 SpecifyDueDate => $duedatespec_allow,
639 CircAutocompl => C4::Context->preference("CircAutocompl"),
640 AllowRenewalLimitOverride => C4::Context->preference("AllowRenewalLimitOverride"),
641 canned_bor_notes_loop => $canned_notes,
642 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
643 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
646 output_html_with_http_headers $query, $cookie, $template->output;