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 $searchtype = $query->param('searchtype') || q{contain};
144 my $findborrower = $query->param('findborrower') || q{};
145 $findborrower =~ s
|,| |g
;
147 my $branch = C4
::Context
->userenv->{'branch'};
149 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
150 if (C4
::Context
->preference("AutoLocation") != 1) {
151 $template->param(ManualLocation
=> 1);
154 if (C4
::Context
->preference("DisplayClearScreenButton")) {
155 $template->param(DisplayClearScreenButton
=> 1);
158 for my $barcode ( @
$barcodes ) {
159 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
160 $barcode = barcodedecode
($barcode)
161 if( $barcode && C4
::Context
->preference('itemBarcodeInputFilter'));
164 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
165 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
166 $duedatespec = eval { output_pref
( { dt
=> dt_from_string
( $duedatespec ), dateformat
=> 'iso', timeformat
=> '24hr' }); }
168 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
169 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
170 undef $restoreduedatespec;
172 my $issueconfirmed = $query->param('issueconfirmed');
173 my $cancelreserve = $query->param('cancelreserve');
174 my $print = $query->param('print') || q{};
175 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
176 my $charges = $query->param('charges') || q{};
178 # Check if stickyduedate is turned off
180 # was stickyduedate loaded from session?
181 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
182 $session->clear( 'stickyduedate' );
183 $stickyduedate = $query->param('stickyduedate');
184 $duedatespec = $query->param('duedatespec');
186 $session->param('auto_renew', scalar $query->param('auto_renew'));
189 $session->clear('auto_renew');
192 my ($datedue,$invalidduedate);
194 my $duedatespec_allow = C4
::Context
->preference('SpecifyDueDate');
195 if( $onsite_checkout && !$duedatespec_allow ) {
196 $datedue = output_pref
({ dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' });
197 $datedue .= ' 23:59:00';
198 } elsif( $duedatespec_allow ) {
199 if ( $duedatespec ) {
200 $datedue = eval { dt_from_string
( $duedatespec ) };
203 $template->param( IMPOSSIBLE
=>1, INVALID_DATE
=>$duedatespec );
208 # check and see if we should print
209 if ( @
$barcodes == 0 && $print eq 'maybe' ) {
213 my $inprocess = (@
$barcodes == 0) ?
'' : $query->param('inprocess');
214 if ( @
$barcodes == 0 && $charges eq 'yes' ) {
217 borrowernumber
=> $borrowernumber
221 if ( $print eq 'yes' && $borrowernumber ne '' ) {
222 if ( C4
::Context
->boolean_preference('printcirculationslips') ) {
223 my $letter = IssueSlip
($branch, $borrowernumber, "QUICK");
224 NetworkPrint
($letter->{content
});
226 $query->param( 'borrowernumber', '' );
227 $borrowernumber = '';
231 # STEP 2 : FIND BORROWER
232 # if there is a list of find borrowers....
236 my $borrower = C4
::Members
::GetMember
( cardnumber
=> $findborrower );
238 $borrowernumber = $borrower->{borrowernumber
};
240 my $dt_params = { iDisplayLength
=> -1 };
241 my $results = C4
::Utils
::DataTables
::Members
::search
(
243 searchmember
=> $findborrower,
244 searchtype
=> $searchtype,
245 dt_params
=> $dt_params,
248 my $borrowers = $results->{patrons
};
249 if ( scalar @
$borrowers == 1 ) {
250 $borrowernumber = $borrowers->[0]->{borrowernumber
};
251 $query->param( 'borrowernumber', $borrowernumber );
252 $query->param( 'barcode', '' );
253 } elsif ( @
$borrowers ) {
254 $template->param( borrowers
=> $borrowers );
256 $query->param( 'findborrower', '' );
257 $message = "'$findborrower'";
262 # get the borrower information.....
263 if ($borrowernumber) {
264 $borrower = GetMemberDetails
( $borrowernumber, 0 );
265 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
( $borrowernumber );
267 # Warningdate is the date that the warning starts appearing
268 my ( $today_year, $today_month, $today_day) = Today
();
269 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
270 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
271 # if the expiry date is before today ie they have expired
272 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
273 || Date_to_Days
($today_year, $today_month, $today_day )
274 > Date_to_Days
($warning_year, $warning_month, $warning_day) )
276 #borrowercard expired, no issues
278 noissues
=> ($force_allow_issue) ?
0 : "1",
279 forceallow
=> $force_allow_issue,
283 # check for NotifyBorrowerDeparture
284 elsif ( C4
::Context
->preference('NotifyBorrowerDeparture') &&
285 Date_to_Days
(Add_Delta_Days
($warning_year,$warning_month,$warning_day,- C4
::Context
->preference('NotifyBorrowerDeparture'))) <
286 Date_to_Days
( $today_year, $today_month, $today_day ) )
288 # borrower card soon to expire warn librarian
289 $template->param( "warndeparture" => $borrower->{dateexpiry
} ,
291 if (C4
::Context
->preference('ReturnBeforeExpiry')){
292 $template->param("returnbeforeexpiry" => 1);
297 issuecount
=> $issue,
301 my $patron = Koha
::Patrons
->find( $borrowernumber );
302 if ( $patron and $patron->is_debarred ) {
304 'userdebarred' => $borrower->{debarred
},
305 'debarredcomment' => $borrower->{debarredcomment
},
308 if ( $borrower->{debarred
} ne "9999-12-31" ) {
309 $template->param( 'userdebarreddate' => $borrower->{debarred
} );
321 for my $barcode ( @
$barcodes ) {
322 my $template_params = { barcode
=> $barcode };
323 # always check for blockers on issuing
324 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued
(
330 onsite_checkout
=> $onsite_checkout,
331 override_high_holds
=> $override_high_holds || $override_high_holds_tmp || 0,
335 my $blocker = $invalidduedate ?
1 : 0;
337 $template_params->{alert
} = $alerts;
338 $template_params->{messages
} = $messages;
340 # Get the item title for more information
341 my $getmessageiteminfo = GetBiblioFromItemNumber
(undef,$barcode);
342 $template_params->{authvalcode_notforloan
} =
343 C4
::Koha
::GetAuthValCode
('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
345 # Fix for bug 7494: optional checkout-time fallback search for a book
347 if ( $error->{'UNKNOWN_BARCODE'}
348 && C4
::Context
->preference("itemBarcodeFallbackSearch")
352 $template_params->{FALLBACK
} = 1;
354 my $searcher = Koha
::SearchEngine
::Search
->new({index => $Koha::SearchEngine
::BIBLIOS_INDEX
});
355 my $query = "kw=" . $barcode;
356 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
358 # if multiple hits, offer options to librarian
359 if ( $total_hits > 0 ) {
361 foreach my $hit ( @
{$results} ) {
363 TransformMarcToKoha
( C4
::Search
::new_record_from_zebra
('biblioserver',$hit) );
365 # offer all barcodes individually
366 if ( $chosen->{barcode
} ) {
367 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode
}) ) {
368 my %chosen_single = %{$chosen};
369 $chosen_single{barcode
} = $barcode;
370 push( @options, \
%chosen_single );
374 $template_params->{options
} = \
@options;
378 unless( $onsite_checkout and C4
::Context
->preference("OnSiteCheckoutsForce") ) {
379 delete $question->{'DEBT'} if ($debt_confirmed);
380 foreach my $impossible ( keys %$error ) {
381 $template_params->{$impossible} = $$error{$impossible};
382 $template_params->{IMPOSSIBLE
} = 1;
386 my $iteminfo = GetBiblioFromItemNumber
(undef, $barcode);
387 if( !$blocker || $force_allow_issue ){
388 my $confirm_required = 0;
389 unless($issueconfirmed){
390 # Get the item title for more information
391 my $materials = $iteminfo->{'materials'};
392 my $avcode = GetAuthValCode
('items.materials');
394 $materials = GetKohaAuthorisedValueLib
($avcode, $materials);
396 $template_params->{additional_materials
} = $materials;
397 $template_params->{itemhomebranch
} = $iteminfo->{'homebranch'};
399 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
400 foreach my $needsconfirmation ( keys %$question ) {
401 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
402 $template_params->{getTitleMessageIteminfo
} = $iteminfo->{'title'};
403 $template_params->{getBarcodeMessageIteminfo
} = $iteminfo->{'barcode'};
404 $template_params->{NEEDSCONFIRMATION
} = 1;
405 $template_params->{onsite_checkout
} = $onsite_checkout;
406 $confirm_required = 1;
409 unless($confirm_required) {
410 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED
};
411 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, } );
412 $template_params->{issue
} = $issue;
413 $session->clear('auto_renew');
418 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
419 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
($borrowernumber);
421 if ($question->{RESERVE_WAITING
} or $question->{RESERVED
}){
423 reserveborrowernumber
=> $question->{'resborrowernumber'}
428 itembiblionumber
=> $getmessageiteminfo->{'biblionumber'}
433 $template_params->{issuecount
} = $issue;
436 $iteminfo->{subtitle
} = GetRecordValue
('subtitle', GetMarcBiblio
($iteminfo->{biblionumber
}), GetFrameworkCode
($iteminfo->{biblionumber
}));
437 $template_params->{item
} = $iteminfo;
439 push @
$checkout_infos, $template_params;
442 $template->param( %{$checkout_infos->[0]} );
443 $template->param( barcode
=> $barcodes->[0] );
445 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION
} } @
$checkout_infos;
447 checkout_infos
=> $checkout_infos,
448 confirmation_needed
=> $confirmation_needed,
453 # reload the borrower info for the sake of reseting the flags.....
454 if ($borrowernumber) {
455 $borrower = GetMemberDetails
( $borrowernumber, 0 );
458 ##################################################################################
460 # show all reserves of this borrower, and the position of the reservation ....
461 if ($borrowernumber) {
462 my $holds = Koha
::Holds
->search( { borrowernumber
=> $borrowernumber } );
463 my $waiting_holds = $holds->waiting;
465 holds_count
=> $holds->count(),
466 WaitingHolds
=> $waiting_holds,
469 $template->param( adultborrower
=> 1 ) if ( $borrower->{category_type
} eq 'A' || $borrower->{category_type
} eq 'I' );
473 my $flags = $borrower->{'flags'};
474 foreach my $flag ( sort keys %$flags ) {
475 $flags->{$flag}->{'message'} =~ s
#\n#<br />#g;
476 if ( $flags->{$flag}->{'noissues'} ) {
478 noissues
=> ($force_allow_issue) ?
0 : 'true',
479 forceallow
=> $force_allow_issue,
481 if ( $flag eq 'GNA' ) {
482 $template->param( gna
=> 'true' );
484 elsif ( $flag eq 'LOST' ) {
485 $template->param( lost
=> 'true' );
487 elsif ( $flag eq 'DBARRED' ) {
488 $template->param( dbarred
=> 'true' );
490 elsif ( $flag eq 'CHARGES' ) {
493 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
494 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
495 charges_is_blocker
=> 1
498 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
500 charges_guarantees
=> 'true',
501 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
502 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
503 charges_guarantees_is_blocker
=> 1
506 elsif ( $flag eq 'CREDITS' ) {
509 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
510 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
515 if ( $flag eq 'CHARGES' ) {
518 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
519 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
522 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
524 charges_guarantees
=> 'true',
525 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
526 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
529 elsif ( $flag eq 'CREDITS' ) {
532 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
533 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
536 elsif ( $flag eq 'ODUES' ) {
539 oduesmsg
=> $flags->{'ODUES'}->{'message'}
542 my $items = $flags->{$flag}->{'itemlist'};
543 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
544 $template->param( nonreturns
=> 'true' );
547 elsif ( $flag eq 'NOTES' ) {
550 notesmsg
=> $flags->{'NOTES'}->{'message'}
556 my $amountold = $borrower->{flags
} ?
$borrower->{flags
}->{'CHARGES'}->{'message'} || 0 : 0;
557 $amountold =~ s/^.*\$//; # remove upto the $, if any
559 my ( $total, $accts, $numaccts) = GetMemberAccountRecords
( $borrowernumber );
561 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
562 my $patron_categories = Koha
::Patron
::Categories
->search_limited({ category_type
=> 'A' }, {order_by
=> ['categorycode']});
563 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
564 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
567 my $librarian_messages = Koha
::Patron
::Messages
->search(
569 borrowernumber
=> $borrowernumber,
574 my $patron_messages = Koha
::Patron
::Messages
->search(
576 borrowernumber
=> $borrowernumber,
581 my $fast_cataloging = 0;
582 if (defined getframeworkinfo
('FA')) {
586 if (C4
::Context
->preference('ExtendedPatronAttributes')) {
587 my $attributes = GetBorrowerAttributes
($borrowernumber);
589 ExtendedPatronAttributes
=> 1,
590 extendedattributes
=> $attributes
594 ?
'batch_checkout_view'
598 if ( $borrowernumber ) {
599 if ( my $patron = Koha
::Patrons
->find( $borrower->{borrowernumber
} ) ) {
600 if ( my $guarantor = $patron->guarantor ) {
601 push @relatives, $guarantor->borrowernumber;
602 push @relatives, $_->borrowernumber for $patron->siblings;
604 push @relatives, $_->borrowernumber for $patron->guarantees;
608 my $relatives_issues_count =
609 Koha
::Database
->new()->schema()->resultset('Issue')
610 ->count( { borrowernumber
=> \
@relatives } );
612 my $roadtype = C4
::Koha
::GetAuthorisedValueByCode
( 'ROADTYPE', $borrower->{streettype
} );
614 $template->param(%$borrower);
616 # Restore date if changed by holds and/or save stickyduedate to session
617 if ($restoreduedatespec || $stickyduedate) {
618 $duedatespec = $restoreduedatespec || $duedatespec;
620 if ($stickyduedate) {
621 $session->param( 'stickyduedate', $duedatespec );
623 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
628 librarian_messages
=> $librarian_messages,
629 patron_messages
=> $patron_messages,
630 borrower
=> $borrower,
631 borrowernumber
=> $borrowernumber,
632 categoryname
=> $borrower->{'description'},
634 was_renewed
=> scalar $query->param('was_renewed') ?
1 : 0,
635 expiry
=> $borrower->{'dateexpiry'},
636 roadtype
=> $roadtype,
637 amountold
=> $amountold,
638 barcodes
=> $barcodes,
639 stickyduedate
=> $stickyduedate,
640 duedatespec
=> $duedatespec,
641 restoreduedatespec
=> $restoreduedatespec,
643 totaldue
=> sprintf('%.2f', $total),
644 inprocess
=> $inprocess,
645 is_child
=> ($borrowernumber && $borrower->{'category_type'} eq 'C'),
647 batch_allowed
=> $batch_allowed,
649 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
650 fast_cataloging
=> $fast_cataloging,
651 CircAutoPrintQuickSlip
=> C4
::Context
->preference("CircAutoPrintQuickSlip"),
652 activeBorrowerRelationship
=> (C4
::Context
->preference('borrowerRelationship') ne ''),
653 SuspendHoldsIntranet
=> C4
::Context
->preference('SuspendHoldsIntranet'),
654 AutoResumeSuspendedHolds
=> C4
::Context
->preference('AutoResumeSuspendedHolds'),
655 RoutingSerials
=> C4
::Context
->preference('RoutingSerials'),
656 relatives_issues_count
=> $relatives_issues_count,
657 relatives_borrowernumbers
=> \
@relatives,
660 my $patron_image = Koha
::Patron
::Images
->find($borrower->{borrowernumber
});
661 $template->param( picture
=> 1 ) if $patron_image;
663 my $has_modifications = Koha
::Patron
::Modifications
->search( { borrowernumber
=> $borrowernumber } )->count;
665 debt_confirmed
=> $debt_confirmed,
666 SpecifyDueDate
=> $duedatespec_allow,
667 CircAutocompl
=> C4
::Context
->preference("CircAutocompl"),
668 debarments
=> GetDebarments
({ borrowernumber
=> $borrowernumber }),
669 todaysdate
=> output_pref
( { dt
=> dt_from_string
()->set(hour
=> 23)->set(minute
=> 59), dateformat
=> 'sql' } ),
670 has_modifications
=> $has_modifications,
671 override_high_holds
=> $override_high_holds,
672 nopermission
=> scalar $query->param('nopermission'),
675 output_html_with_http_headers
$query, $cookie, $template->output;