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>.
25 # FIXME There are too many calls to Koha::Patrons->find in this script
31 use DateTime
::Duration
;
34 use C4
::Auth qw
/:DEFAULT get_session haspermission/;
35 use C4
::Koha
; # GetPrinter
37 use C4
::Utils
::DataTables
::Members
;
46 use C4
::Members
::Attributes
qw(GetBorrowerAttributes);
47 use Koha
::AuthorisedValues
;
48 use Koha
::CsvProfiles
;
50 use Koha
::Patron
::Debarments
qw(GetDebarments);
53 use Koha
::BiblioFrameworks
;
55 use Koha
::Patron
::Messages
;
56 use Koha
::SearchEngine
;
57 use Koha
::SearchEngine
::Search
;
58 use Koha
::Patron
::Modifications
;
65 use List
::MoreUtils qw
/uniq/;
72 my $override_high_holds = $query->param('override_high_holds');
73 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
75 my $sessionID = $query->cookie("CGISESSID") ;
76 my $session = get_session
($sessionID);
77 if (!C4
::Context
->userenv){
78 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
79 # no branch set we can't issue
80 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
86 my $barcode = $query->param('barcode');
87 # Barcode given by user could be '0'
88 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
89 $barcodes = [ $barcode ];
91 my $filefh = $query->upload('uploadfile');
93 while ( my $content = <$filefh> ) {
94 $content =~ s/[\r\n]*$//g;
95 push @
$barcodes, $content if $content;
97 } elsif ( my $list = $query->param('barcodelist') ) {
98 push @
$barcodes, split( /\s\n/, $list );
99 $barcodes = [ map { $_ =~ /^\s*$/ ?
() : $_ } @
$barcodes ];
101 @
$barcodes = $query->multi_param('barcodes');
105 $barcodes = [ uniq @
$barcodes ];
107 my $template_name = q
|circ
/circulation
.tt
|;
108 my $borrowernumber = $query->param('borrowernumber');
109 my $patron = $borrowernumber ? Koha
::Patrons
->find( $borrowernumber ) : undef;
110 my $batch = $query->param('batch');
111 my $batch_allowed = 0;
112 if ( $batch && C4
::Context
->preference('BatchCheckouts') ) {
113 $template_name = q
|circ
/circulation_batch_checkouts
.tt
|;
114 my @batch_category_codes = split '\|', C4
::Context
->preference('BatchCheckoutsValidCategories');
115 my $categorycode = $patron->categorycode;
116 if ( $categorycode && grep {/^$categorycode$/} @batch_category_codes ) {
123 my ( $template, $loggedinuser, $cookie ) = get_template_and_user
(
125 template_name
=> $template_name,
128 authnotrequired
=> 0,
129 flagsrequired
=> { circulate
=> 'circulate_remaining_permissions' },
133 my $force_allow_issue = $query->param('forceallow') || 0;
134 if (!C4
::Auth
::haspermission
( C4
::Context
->userenv->{id
} , { circulate
=> 'force_checkout' } )) {
135 $force_allow_issue = 0;
138 my $onsite_checkout = $query->param('onsite_checkout');
140 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
141 our %renew_failed = ();
142 for (@failedrenews) { $renew_failed{$_} = 1; }
144 my @failedreturns = $query->multi_param('failedreturn');
145 our %return_failed = ();
146 for (@failedreturns) { $return_failed{$_} = 1; }
148 my $searchtype = $query->param('searchtype') || q{contain};
150 my $findborrower = $query->param('findborrower') || q{};
151 $findborrower =~ s
|,| |g
;
153 my $branch = C4
::Context
->userenv->{'branch'};
155 if (C4
::Context
->preference("DisplayClearScreenButton")) {
156 $template->param(DisplayClearScreenButton
=> 1);
159 for my $barcode ( @
$barcodes ) {
160 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
161 $barcode = barcodedecode
($barcode)
162 if( $barcode && C4
::Context
->preference('itemBarcodeInputFilter'));
165 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
166 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
167 $duedatespec = eval { output_pref
( { dt
=> dt_from_string
( $duedatespec ), dateformat
=> 'iso', timeformat
=> '24hr' }); }
169 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
170 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
171 undef $restoreduedatespec;
173 my $issueconfirmed = $query->param('issueconfirmed');
174 my $cancelreserve = $query->param('cancelreserve');
175 my $print = $query->param('print') || q{};
176 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
177 my $charges = $query->param('charges') || q{};
179 # Check if stickyduedate is turned off
181 # was stickyduedate loaded from session?
182 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
183 $session->clear( 'stickyduedate' );
184 $stickyduedate = $query->param('stickyduedate');
185 $duedatespec = $query->param('duedatespec');
187 $session->param('auto_renew', scalar $query->param('auto_renew'));
190 $session->clear('auto_renew');
193 my ($datedue,$invalidduedate);
195 my $duedatespec_allow = C4
::Context
->preference('SpecifyDueDate');
196 if( $onsite_checkout && !$duedatespec_allow ) {
197 $datedue = output_pref
({ dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' });
198 $datedue .= ' 23:59:00';
199 } elsif( $duedatespec_allow ) {
200 if ( $duedatespec ) {
201 $datedue = eval { dt_from_string
( $duedatespec ) };
204 $template->param( IMPOSSIBLE
=>1, INVALID_DATE
=>$duedatespec );
209 # check and see if we should print
210 if ( @
$barcodes == 0 && $print eq 'maybe' ) {
214 my $inprocess = (@
$barcodes == 0) ?
'' : $query->param('inprocess');
215 if ( @
$barcodes == 0 && $charges eq 'yes' ) {
218 borrowernumber
=> $borrowernumber
222 if ( $print eq 'yes' && $borrowernumber ne '' ) {
223 if ( C4
::Context
->boolean_preference('printcirculationslips') ) {
224 my $letter = IssueSlip
($branch, $borrowernumber, "QUICK");
225 NetworkPrint
($letter->{content
});
227 $query->param( 'borrowernumber', '' );
228 $borrowernumber = '';
232 # STEP 2 : FIND BORROWER
233 # if there is a list of find borrowers....
237 my $patron = Koha
::Patrons
->find( { cardnumber
=> $findborrower } );
239 $borrowernumber = $patron->borrowernumber;
241 my $dt_params = { iDisplayLength
=> -1 };
242 my $results = C4
::Utils
::DataTables
::Members
::search
(
244 searchmember
=> $findborrower,
245 searchtype
=> $searchtype,
246 dt_params
=> $dt_params,
249 my $borrowers = $results->{patrons
};
250 if ( scalar @
$borrowers == 1 ) {
251 $borrowernumber = $borrowers->[0]->{borrowernumber
};
252 $query->param( 'borrowernumber', $borrowernumber );
253 $query->param( 'barcode', '' );
254 } elsif ( @
$borrowers ) {
255 $template->param( borrowers
=> $borrowers );
257 $query->param( 'findborrower', '' );
258 $message = "'$findborrower'";
263 # get the borrower information.....
264 if ($borrowernumber) {
265 $patron = Koha
::Patrons
->find( $borrowernumber );
266 my $overdues = $patron->get_overdues;
267 my $issues = $patron->checkouts;
268 my $balance = $patron->account->balance;
271 # if the expiry date is before today ie they have expired
272 if ( $patron->is_expired ) {
273 #borrowercard expired, no issues
275 noissues
=> ($force_allow_issue) ?
0 : "1",
276 forceallow
=> $force_allow_issue,
280 # check for NotifyBorrowerDeparture
281 elsif ( $patron->is_going_to_expire ) {
282 # borrower card soon to expire warn librarian
283 $template->param( "warndeparture" => $patron->dateexpiry ,
285 if (C4
::Context
->preference('ReturnBeforeExpiry')){
286 $template->param("returnbeforeexpiry" => 1);
290 overduecount
=> $overdues->count,
291 issuecount
=> $issues->count,
292 finetotal
=> $balance,
295 if ( $patron and $patron->is_debarred ) {
297 'userdebarred' => $patron->debarred,
298 'debarredcomment' => $patron->debarredcomment,
301 if ( $patron->debarred ne "9999-12-31" ) {
302 $template->param( 'userdebarreddate' => $patron->debarred );
314 for my $barcode ( @
$barcodes ) {
315 my $template_params = { barcode
=> $barcode };
316 # always check for blockers on issuing
317 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued
(
323 onsite_checkout
=> $onsite_checkout,
324 override_high_holds
=> $override_high_holds || $override_high_holds_tmp || 0,
328 my $blocker = $invalidduedate ?
1 : 0;
330 $template_params->{alert
} = $alerts;
331 $template_params->{messages
} = $messages;
333 my $item = Koha
::Items
->find({ barcode
=> $barcode });
334 my ( $biblio, $mss );
337 $biblio = $item->biblio;
338 my $mss = Koha
::MarcSubfieldStructures
->search({ frameworkcode
=> $biblio->frameworkcode, kohafield
=> 'items.notforloan', authorised_value
=> { not => undef } });
339 $template_params->{authvalcode_notforloan
} = $mss->count ?
$mss->next->authorised_value : undef;
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 if( !$blocker || $force_allow_issue ){
384 my $confirm_required = 0;
385 unless($issueconfirmed){
386 # Get the item title for more information
387 my $materials = $item->materials;
388 my $descriptions = Koha
::AuthorisedValues
->get_description_by_koha_field({ frameworkcode
=> $biblio->frameworkcode, kohafield
=> 'items.materials', authorised_value
=> $materials });
389 $materials = $descriptions->{lib
} // $materials;
390 $template_params->{additional_materials
} = $materials;
391 $template_params->{itemhomebranch
} = $item->homebranch;
393 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
394 foreach my $needsconfirmation ( keys %$question ) {
395 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
396 $template_params->{getTitleMessageIteminfo
} = $biblio->title;
397 $template_params->{getBarcodeMessageIteminfo
} = $item->barcode;
398 $template_params->{NEEDSCONFIRMATION
} = 1;
399 $template_params->{onsite_checkout
} = $onsite_checkout;
400 $confirm_required = 1;
403 unless($confirm_required) {
404 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED
};
405 my $issue = AddIssue
( $patron->unblessed, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout
=> $onsite_checkout, auto_renew
=> $session->param('auto_renew'), switch_onsite_checkout
=> $switch_onsite_checkout, } );
406 $template_params->{issue
} = $issue;
407 $session->clear('auto_renew');
412 if ($question->{RESERVE_WAITING
} or $question->{RESERVED
}){
414 reserveborrowernumber
=> $question->{'resborrowernumber'}
419 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
420 $patron = Koha
::Patrons
->find( $borrowernumber );
421 $template_params->{issuecount
} = $patron->checkouts->count;
424 $template_params->{item
} = $item;
425 $template_params->{biblio
} = $biblio;
426 $template_params->{itembiblionumber
} = $biblio->biblionumber;
428 push @
$checkout_infos, $template_params;
431 $template->param( %{$checkout_infos->[0]} );
432 $template->param( barcode
=> $barcodes->[0] );
434 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION
} } @
$checkout_infos;
436 checkout_infos
=> $checkout_infos,
437 confirmation_needed
=> $confirmation_needed,
442 ##################################################################################
444 # show all reserves of this borrower, and the position of the reservation ....
445 if ($borrowernumber) {
446 my $holds = Koha
::Holds
->search( { borrowernumber
=> $borrowernumber } );
447 my $waiting_holds = $holds->waiting;
449 holds_count
=> $holds->count(),
450 WaitingHolds
=> $waiting_holds,
453 my $category_type = $patron->category->category_type;
454 $template->param( adultborrower
=> 1 ) if ( $category_type eq 'A' || $category_type eq 'I' );
458 my $flags = $patron ? C4
::Members
::patronflags
( $patron->unblessed ) : {};
459 foreach my $flag ( sort keys %$flags ) {
460 $flags->{$flag}->{'message'} =~ s
#\n#<br />#g;
461 if ( $flags->{$flag}->{'noissues'} ) {
463 noissues
=> ($force_allow_issue) ?
0 : 'true',
464 forceallow
=> $force_allow_issue,
466 if ( $flag eq 'GNA' ) {
467 $template->param( gna
=> 'true' );
469 elsif ( $flag eq 'LOST' ) {
470 $template->param( lost
=> 'true' );
472 elsif ( $flag eq 'DBARRED' ) {
473 $template->param( dbarred
=> 'true' );
475 elsif ( $flag eq 'CHARGES' ) {
478 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
479 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
480 charges_is_blocker
=> 1
483 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
485 charges_guarantees
=> 'true',
486 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
487 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
488 charges_guarantees_is_blocker
=> 1
491 elsif ( $flag eq 'CREDITS' ) {
494 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
495 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
500 if ( $flag eq 'CHARGES' ) {
503 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
504 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
507 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
509 charges_guarantees
=> 'true',
510 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
511 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
514 elsif ( $flag eq 'CREDITS' ) {
517 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
518 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
521 elsif ( $flag eq 'ODUES' ) {
524 oduesmsg
=> $flags->{'ODUES'}->{'message'}
527 my $items = $flags->{$flag}->{'itemlist'};
528 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
529 $template->param( nonreturns
=> 'true' );
532 elsif ( $flag eq 'NOTES' ) {
535 notesmsg
=> $flags->{'NOTES'}->{'message'}
541 my $amountold = $flags ?
$flags->{'CHARGES'}->{'message'} || 0 : 0;
542 $amountold =~ s/^.*\$//; # remove upto the $, if any
544 my ( $total, $accts, $numaccts) = GetMemberAccountRecords
( $borrowernumber );
546 if ( $patron && $patron->category->category_type eq 'C') {
547 my $patron_categories = Koha
::Patron
::Categories
->search_limited({ category_type
=> 'A' }, {order_by
=> ['categorycode']});
548 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
549 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
552 my $messages = Koha
::Patron
::Messages
->search(
554 'me.borrowernumber' => $borrowernumber,
558 '+select' => ['manager.surname', 'manager.firstname' ],
559 '+as' => ['manager_surname', 'manager_firstname'],
563 my $fast_cataloging = 0;
564 if ( Koha
::BiblioFrameworks
->find('FA') ) {
568 if (C4
::Context
->preference('ExtendedPatronAttributes')) {
569 my $attributes = GetBorrowerAttributes
($borrowernumber);
571 ExtendedPatronAttributes
=> 1,
572 extendedattributes
=> $attributes
576 ?
'batch_checkout_view'
580 if ( $borrowernumber ) {
582 if ( my $guarantor = $patron->guarantor ) {
583 push @relatives, $guarantor->borrowernumber;
584 push @relatives, $_->borrowernumber for $patron->siblings;
586 push @relatives, $_->borrowernumber for $patron->guarantees;
590 my $relatives_issues_count =
591 Koha
::Database
->new()->schema()->resultset('Issue')
592 ->count( { borrowernumber
=> \
@relatives } );
595 my $av = Koha
::AuthorisedValues
->search({ category
=> 'ROADTYPE', authorised_value
=> $patron->streettype });
596 my $roadtype = $av->count ?
$av->next->lib : '';
598 %{ $patron->unblessed },
599 borrower
=> $patron->unblessed,
600 roadtype
=> $roadtype,
602 categoryname
=> $patron->category->description,
603 expiry
=> $patron->dateexpiry,
604 is_child
=> ( $patron->category->category_type eq 'C' ),
605 picture
=> ( $patron->image ?
1 : 0 ),
609 # Restore date if changed by holds and/or save stickyduedate to session
610 if ($restoreduedatespec || $stickyduedate) {
611 $duedatespec = $restoreduedatespec || $duedatespec;
613 if ($stickyduedate) {
614 $session->param( 'stickyduedate', $duedatespec );
616 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
621 messages
=> $messages,
622 borrowernumber
=> $borrowernumber,
624 was_renewed
=> scalar $query->param('was_renewed') ?
1 : 0,
625 amountold
=> $amountold,
626 barcodes
=> $barcodes,
627 stickyduedate
=> $stickyduedate,
628 duedatespec
=> $duedatespec,
629 restoreduedatespec
=> $restoreduedatespec,
631 totaldue
=> sprintf('%.2f', $total),
632 inprocess
=> $inprocess,
634 batch_allowed
=> $batch_allowed,
636 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
637 fast_cataloging
=> $fast_cataloging,
638 CircAutoPrintQuickSlip
=> C4
::Context
->preference("CircAutoPrintQuickSlip"),
639 SuspendHoldsIntranet
=> C4
::Context
->preference('SuspendHoldsIntranet'),
640 AutoResumeSuspendedHolds
=> C4
::Context
->preference('AutoResumeSuspendedHolds'),
641 RoutingSerials
=> C4
::Context
->preference('RoutingSerials'),
642 relatives_issues_count
=> $relatives_issues_count,
643 relatives_borrowernumbers
=> \
@relatives,
647 if ( C4
::Context
->preference("ExportCircHistory") ) {
648 $template->param(csv_profiles
=> [ Koha
::CsvProfiles
->search({ type
=> 'marc' }) ]);
651 my $has_modifications = Koha
::Patron
::Modifications
->search( { borrowernumber
=> $borrowernumber } )->count;
653 debt_confirmed
=> $debt_confirmed,
654 SpecifyDueDate
=> $duedatespec_allow,
655 CircAutocompl
=> C4
::Context
->preference("CircAutocompl"),
656 debarments
=> GetDebarments
({ borrowernumber
=> $borrowernumber }),
657 todaysdate
=> output_pref
( { dt
=> dt_from_string
()->set(hour
=> 23)->set(minute
=> 59), dateformat
=> 'sql' } ),
658 has_modifications
=> $has_modifications,
659 override_high_holds
=> $override_high_holds,
660 nopermission
=> scalar $query->param('nopermission'),
663 output_html_with_http_headers
$query, $cookie, $template->output;