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
30 use DateTime
::Duration
;
31 use Scalar
::Util
qw( looks_like_number );
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');
89 my $borrowernumber = $query->param('borrowernumber');
91 if (C4
::Context
->preference("AutoSwitchPatron") && $barcode) {
92 if (Koha
::Patrons
->search( { cardnumber
=> $barcode} )->count() > 0) {
93 $findborrower = $barcode;
95 undef $borrowernumber;
99 $findborrower ||= $query->param('findborrower') || q{};
100 $findborrower =~ s
|,| |g
;
102 # Barcode given by user could be '0'
103 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
104 $barcodes = [ $barcode ];
106 my $filefh = $query->upload('uploadfile');
108 while ( my $content = <$filefh> ) {
109 $content =~ s/[\r\n]*$//g;
110 push @
$barcodes, $content if $content;
112 } elsif ( my $list = $query->param('barcodelist') ) {
113 push @
$barcodes, split( /\s\n/, $list );
114 $barcodes = [ map { $_ =~ /^\s*$/ ?
() : $_ } @
$barcodes ];
116 @
$barcodes = $query->multi_param('barcodes');
120 $barcodes = [ uniq @
$barcodes ];
122 my $template_name = q
|circ
/circulation
.tt
|;
123 my $patron = $borrowernumber ? Koha
::Patrons
->find( $borrowernumber ) : undef;
124 my $batch = $query->param('batch');
125 my $batch_allowed = 0;
126 if ( $batch && C4
::Context
->preference('BatchCheckouts') ) {
127 $template_name = q
|circ
/circulation_batch_checkouts
.tt
|;
128 my @batch_category_codes = split '\|', C4
::Context
->preference('BatchCheckoutsValidCategories');
129 my $categorycode = $patron->categorycode;
130 if ( $categorycode && grep {/^$categorycode$/} @batch_category_codes ) {
137 my ( $template, $loggedinuser, $cookie ) = get_template_and_user
(
139 template_name
=> $template_name,
142 authnotrequired
=> 0,
143 flagsrequired
=> { circulate
=> 'circulate_remaining_permissions' },
146 my $logged_in_user = Koha
::Patrons
->find( $loggedinuser ) or die "Not logged in";
148 my $force_allow_issue = $query->param('forceallow') || 0;
149 if (!C4
::Auth
::haspermission
( C4
::Context
->userenv->{id
} , { circulate
=> 'force_checkout' } )) {
150 $force_allow_issue = 0;
153 my $onsite_checkout = $query->param('onsite_checkout');
155 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
156 our %renew_failed = ();
157 for (@failedrenews) { $renew_failed{$_} = 1; }
159 my @failedreturns = $query->multi_param('failedreturn');
160 our %return_failed = ();
161 for (@failedreturns) { $return_failed{$_} = 1; }
163 my $searchtype = $query->param('searchtype') || q{contain};
165 my $branch = C4
::Context
->userenv->{'branch'};
167 if (C4
::Context
->preference("DisplayClearScreenButton")) {
168 $template->param(DisplayClearScreenButton
=> 1);
171 for my $barcode ( @
$barcodes ) {
172 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
173 $barcode = barcodedecode
($barcode)
174 if( $barcode && C4
::Context
->preference('itemBarcodeInputFilter'));
177 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
178 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
179 $duedatespec = eval { output_pref
( { dt
=> dt_from_string
( $duedatespec ), dateformat
=> 'iso', timeformat
=> '24hr' }); }
181 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
182 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
183 undef $restoreduedatespec;
185 my $issueconfirmed = $query->param('issueconfirmed');
186 my $cancelreserve = $query->param('cancelreserve');
187 my $print = $query->param('print') || q{};
188 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
189 my $charges = $query->param('charges') || q{};
191 # Check if stickyduedate is turned off
193 # was stickyduedate loaded from session?
194 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
195 $session->clear( 'stickyduedate' );
196 $stickyduedate = $query->param('stickyduedate');
197 $duedatespec = $query->param('duedatespec');
199 $session->param('auto_renew', scalar $query->param('auto_renew'));
202 $session->clear('auto_renew');
205 my ($datedue,$invalidduedate);
207 my $duedatespec_allow = C4
::Context
->preference('SpecifyDueDate');
208 if( $onsite_checkout && !$duedatespec_allow ) {
209 $datedue = output_pref
({ dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' });
210 $datedue .= ' 23:59:00';
211 } elsif( $duedatespec_allow ) {
212 if ( $duedatespec ) {
213 $datedue = eval { dt_from_string
( $duedatespec ) };
216 $template->param( IMPOSSIBLE
=>1, INVALID_DATE
=>$duedatespec );
221 # check and see if we should print
222 if ( @
$barcodes == 0 && $print eq 'maybe' ) {
226 my $inprocess = (@
$barcodes == 0) ?
'' : $query->param('inprocess');
227 if ( @
$barcodes == 0 && $charges eq 'yes' ) {
230 borrowernumber
=> $borrowernumber
234 if ( $print eq 'yes' && $borrowernumber ne '' ) {
235 if ( C4
::Context
->boolean_preference('printcirculationslips') ) {
236 my $letter = IssueSlip
($branch, $borrowernumber, "QUICK");
237 NetworkPrint
($letter->{content
});
239 $query->param( 'borrowernumber', '' );
240 $borrowernumber = '';
244 # STEP 2 : FIND BORROWER
245 # if there is a list of find borrowers....
249 my $patron = Koha
::Patrons
->find( { cardnumber
=> $findborrower } );
251 $borrowernumber = $patron->borrowernumber;
253 my $dt_params = { iDisplayLength
=> -1 };
254 my $results = C4
::Utils
::DataTables
::Members
::search
(
256 searchmember
=> $findborrower,
257 searchtype
=> $searchtype,
258 dt_params
=> $dt_params,
261 my $borrowers = $results->{patrons
};
262 if ( scalar @
$borrowers == 1 ) {
263 $borrowernumber = $borrowers->[0]->{borrowernumber
};
264 $query->param( 'borrowernumber', $borrowernumber );
265 $query->param( 'barcode', '' );
266 } elsif ( @
$borrowers ) {
267 $template->param( borrowers
=> $borrowers );
269 $query->param( 'findborrower', '' );
270 $message = "'$findborrower'";
275 # get the borrower information.....
277 $patron ||= Koha
::Patrons
->find( $borrowernumber ) if $borrowernumber;
280 $template->param( borrowernumber
=> $patron->borrowernumber );
281 output_and_exit_if_error
( $query, $cookie, $template, { module
=> 'members', logged_in_user
=> $logged_in_user, current_patron
=> $patron } );
283 my $overdues = $patron->get_overdues;
284 my $issues = $patron->checkouts;
285 $balance = $patron->account->balance;
288 # if the expiry date is before today ie they have expired
289 if ( $patron->is_expired ) {
290 #borrowercard expired, no issues
292 noissues
=> ($force_allow_issue) ?
0 : "1",
293 forceallow
=> $force_allow_issue,
297 # check for NotifyBorrowerDeparture
298 elsif ( $patron->is_going_to_expire ) {
299 # borrower card soon to expire warn librarian
300 $template->param( "warndeparture" => $patron->dateexpiry ,
302 if (C4
::Context
->preference('ReturnBeforeExpiry')){
303 $template->param("returnbeforeexpiry" => 1);
307 overduecount
=> $overdues->count,
308 issuecount
=> $issues->count,
309 finetotal
=> $balance,
312 if ( $patron and $patron->is_debarred ) {
314 'userdebarred' => $patron->debarred,
315 'debarredcomment' => $patron->debarredcomment,
318 if ( $patron->debarred ne "9999-12-31" ) {
319 $template->param( 'userdebarreddate' => $patron->debarred );
331 for my $barcode ( @
$barcodes ) {
332 my $template_params = { barcode
=> $barcode };
333 # always check for blockers on issuing
334 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued
(
340 onsite_checkout
=> $onsite_checkout,
341 override_high_holds
=> $override_high_holds || $override_high_holds_tmp || 0,
345 my $blocker = $invalidduedate ?
1 : 0;
347 $template_params->{alert
} = $alerts;
348 $template_params->{messages
} = $messages;
350 my $item = Koha
::Items
->find({ barcode
=> $barcode });
351 my ( $biblio, $mss );
354 $biblio = $item->biblio;
355 my $mss = Koha
::MarcSubfieldStructures
->search({ frameworkcode
=> $biblio->frameworkcode, kohafield
=> 'items.notforloan', authorised_value
=> [ -and => {'!=' => undef }, {'!=' => ''}] });
356 $template_params->{authvalcode_notforloan
} = $mss->count ?
$mss->next->authorised_value : undef;
359 # Fix for bug 7494: optional checkout-time fallback search for a book
361 if ( $error->{'UNKNOWN_BARCODE'}
362 && C4
::Context
->preference("itemBarcodeFallbackSearch")
366 $template_params->{FALLBACK
} = 1;
368 my $searcher = Koha
::SearchEngine
::Search
->new({index => $Koha::SearchEngine
::BIBLIOS_INDEX
});
369 my $query = "kw=" . $barcode;
370 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
372 # if multiple hits, offer options to librarian
373 if ( $total_hits > 0 ) {
375 foreach my $hit ( @
{$results} ) {
377 TransformMarcToKoha
( C4
::Search
::new_record_from_zebra
('biblioserver',$hit) );
379 # offer all barcodes individually
380 if ( $chosen->{barcode
} ) {
381 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode
}) ) {
382 my %chosen_single = %{$chosen};
383 $chosen_single{barcode
} = $barcode;
384 push( @options, \
%chosen_single );
388 $template_params->{options
} = \
@options;
392 if ( $error->{UNKNOWN_BARCODE
} or not $onsite_checkout or not C4
::Context
->preference("OnSiteCheckoutsForce") ) {
393 delete $question->{'DEBT'} if ($debt_confirmed);
394 foreach my $impossible ( keys %$error ) {
395 $template_params->{$impossible} = $$error{$impossible};
396 $template_params->{IMPOSSIBLE
} = 1;
401 if( $item and ( !$blocker or $force_allow_issue ) ){
402 my $confirm_required = 0;
403 unless($issueconfirmed){
404 # Get the item title for more information
405 my $materials = $item->materials;
406 my $descriptions = Koha
::AuthorisedValues
->get_description_by_koha_field({ frameworkcode
=> $biblio->frameworkcode, kohafield
=> 'items.materials', authorised_value
=> $materials });
407 $materials = $descriptions->{lib
} // $materials;
408 $template_params->{additional_materials
} = $materials;
409 $template_params->{itemhomebranch
} = $item->homebranch;
411 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
412 foreach my $needsconfirmation ( keys %$question ) {
413 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
414 $template_params->{getTitleMessageIteminfo
} = $biblio->title;
415 $template_params->{getBarcodeMessageIteminfo
} = $item->barcode;
416 $template_params->{NEEDSCONFIRMATION
} = 1;
417 $template_params->{onsite_checkout
} = $onsite_checkout;
418 $template_params->{auto_renew
} = $session->param('auto_renew');
419 $confirm_required = 1;
422 unless($confirm_required) {
423 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED
};
424 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, } );
425 $template_params->{issue
} = $issue;
426 $session->clear('auto_renew');
431 if ($question->{RESERVE_WAITING
} or $question->{RESERVED
}){
433 reserveborrowernumber
=> $question->{'resborrowernumber'}
438 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
439 $patron = Koha
::Patrons
->find( $borrowernumber );
440 $template_params->{issuecount
} = $patron->checkouts->count;
443 $template_params->{item
} = $item;
444 $template_params->{biblio
} = $biblio;
445 $template_params->{itembiblionumber
} = $biblio->biblionumber;
447 push @
$checkout_infos, $template_params;
450 $template->param( %{$checkout_infos->[0]} );
451 $template->param( barcode
=> $barcodes->[0] );
453 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION
} } @
$checkout_infos;
455 checkout_infos
=> $checkout_infos,
456 confirmation_needed
=> $confirmation_needed,
461 ##################################################################################
463 # show all reserves of this borrower, and the position of the reservation ....
465 my $holds = Koha
::Holds
->search( { borrowernumber
=> $borrowernumber } ); # FIXME must be Koha::Patron->holds
466 my $waiting_holds = $holds->waiting;
468 holds_count
=> $holds->count(),
469 WaitingHolds
=> $waiting_holds,
475 if ( $patron->gonenoaddress ) {
476 $template->param( gna
=> 1 );
479 if ( $patron->lost ) {
480 $template->param( lost
=> 1 );
483 if ( $patron->is_debarred ) {
484 $template->param( dbarred
=> 1 );
487 my $account = $patron->account;
488 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
489 my $noissuescharge = C4
::Context
->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
490 $noissues ||= ( not C4
::Context
->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
493 chargesamount
=> $owing,
495 } elsif ( $balance < 0 ) {
498 creditsamount
=> -$balance,
502 my $no_issues_charge_guarantees = C4
::Context
->preference("NoIssuesChargeGuarantees");
503 $no_issues_charge_guarantees = undef unless looks_like_number
( $no_issues_charge_guarantees );
504 if ( defined $no_issues_charge_guarantees ) {
505 my $guarantees_non_issues_charges = 0;
506 my $guarantees = $patron->guarantees;
507 while ( my $g = $guarantees->next ) {
508 $guarantees_non_issues_charges += $g->account->non_issues_charges;
510 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
512 charges_guarantees
=> 1,
513 chargesamount_guarantees
=> $guarantees_non_issues_charges,
515 $noissues = 1 unless C4
::Context
->preference("allowfineoverride");
519 if ( $patron->has_overdues ) {
520 $template->param( odues
=> 1 );
523 if ( $patron->borrowernotes ) {
524 my $borrowernotes = $patron->borrowernotes;
525 $borrowernotes =~ s
#\n#<br />#g;
528 notesmsg
=> $borrowernotes,
534 noissues
=> ($force_allow_issue) ?
0 : 'true',
535 forceallow
=> $force_allow_issue,
540 my $messages = Koha
::Patron
::Messages
->search(
542 'me.borrowernumber' => $borrowernumber,
546 '+select' => ['manager.surname', 'manager.firstname' ],
547 '+as' => ['manager_surname', 'manager_firstname'],
551 my $fast_cataloging = 0;
552 if ( Koha
::BiblioFrameworks
->find('FA') ) {
556 if (C4
::Context
->preference('ExtendedPatronAttributes')) {
557 my $attributes = GetBorrowerAttributes
($borrowernumber);
559 ExtendedPatronAttributes
=> 1,
560 extendedattributes
=> $attributes
564 ?
'batch_checkout_view'
568 if ( $borrowernumber ) {
570 if ( my $guarantor = $patron->guarantor ) {
571 push @relatives, $guarantor->borrowernumber;
572 push @relatives, $_->borrowernumber for $patron->siblings;
574 push @relatives, $_->borrowernumber for $patron->guarantees;
578 my $relatives_issues_count =
579 Koha
::Database
->new()->schema()->resultset('Issue')
580 ->count( { borrowernumber
=> \
@relatives } );
583 my $av = Koha
::AuthorisedValues
->search({ category
=> 'ROADTYPE', authorised_value
=> $patron->streettype });
584 my $roadtype = $av->count ?
$av->next->lib : '';
586 roadtype
=> $roadtype,
588 categoryname
=> $patron->category->description,
589 expiry
=> $patron->dateexpiry,
593 # Restore date if changed by holds and/or save stickyduedate to session
594 if ($restoreduedatespec || $stickyduedate) {
595 $duedatespec = $restoreduedatespec || $duedatespec;
597 if ($stickyduedate) {
598 $session->param( 'stickyduedate', $duedatespec );
600 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
605 messages
=> $messages,
606 borrowernumber
=> $borrowernumber,
608 was_renewed
=> scalar $query->param('was_renewed') ?
1 : 0,
609 barcodes
=> $barcodes,
610 stickyduedate
=> $stickyduedate,
611 duedatespec
=> $duedatespec,
612 restoreduedatespec
=> $restoreduedatespec,
614 totaldue
=> sprintf('%.2f', $balance), # FIXME not used in template?
615 inprocess
=> $inprocess,
617 batch_allowed
=> $batch_allowed,
619 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
620 fast_cataloging
=> $fast_cataloging,
621 CircAutoPrintQuickSlip
=> C4
::Context
->preference("CircAutoPrintQuickSlip"),
622 RoutingSerials
=> C4
::Context
->preference('RoutingSerials'),
623 relatives_issues_count
=> $relatives_issues_count,
624 relatives_borrowernumbers
=> \
@relatives,
628 if ( C4
::Context
->preference("ExportCircHistory") ) {
629 $template->param(csv_profiles
=> [ Koha
::CsvProfiles
->search({ type
=> 'marc' }) ]);
632 my $has_modifications = Koha
::Patron
::Modifications
->search( { borrowernumber
=> $borrowernumber } )->count;
634 debt_confirmed
=> $debt_confirmed,
635 SpecifyDueDate
=> $duedatespec_allow,
636 CircAutocompl
=> C4
::Context
->preference("CircAutocompl"),
637 debarments
=> scalar GetDebarments
({ borrowernumber
=> $borrowernumber }),
638 todaysdate
=> output_pref
( { dt
=> dt_from_string
()->set(hour
=> 23)->set(minute
=> 59), dateformat
=> 'sql' } ),
639 has_modifications
=> $has_modifications,
640 override_high_holds
=> $override_high_holds,
641 nopermission
=> scalar $query->param('nopermission'),
642 autoswitched
=> $autoswitched,
645 output_html_with_http_headers
$query, $cookie, $template->output;