Bug 23399: (follow-up) Markup comments and corrections
[koha.git] / circ / circulation.pl
blobe7b4459184e06ce90d121c30e42b46afb5e9df4c
1 #!/usr/bin/perl
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
27 use Modern::Perl;
28 use CGI qw ( -utf8 );
29 use DateTime;
30 use DateTime::Duration;
31 use Scalar::Util qw( looks_like_number );
32 use C4::Output;
33 use C4::Print;
34 use C4::Auth qw/:DEFAULT get_session haspermission/;
35 use C4::Koha; # GetPrinter
36 use C4::Circulation;
37 use C4::Utils::DataTables::Members;
38 use C4::Members;
39 use C4::Biblio;
40 use C4::Search;
41 use MARC::Record;
42 use C4::Reserves;
43 use Koha::Holds;
44 use C4::Context;
45 use CGI::Session;
46 use Koha::AuthorisedValues;
47 use Koha::CsvProfiles;
48 use Koha::Patrons;
49 use Koha::Patron::Debarments qw(GetDebarments);
50 use Koha::DateUtils;
51 use Koha::Database;
52 use Koha::BiblioFrameworks;
53 use Koha::Items;
54 use Koha::Patron::Messages;
55 use Koha::SearchEngine;
56 use Koha::SearchEngine::Search;
57 use Koha::Patron::Modifications;
59 use Date::Calc qw(
60 Today
61 Add_Delta_Days
62 Date_to_Days
64 use List::MoreUtils qw/uniq/;
67 # PARAMETERS READING
69 my $query = new CGI;
71 my $override_high_holds = $query->param('override_high_holds');
72 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
74 my $sessionID = $query->cookie("CGISESSID") ;
75 my $session = get_session($sessionID);
76 if (!C4::Context->userenv){
77 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
78 # no branch set we can't issue
79 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
80 exit;
84 my $barcodes = [];
85 my $barcode = $query->param('barcode');
86 my $findborrower;
87 my $autoswitched;
88 my $borrowernumber = $query->param('borrowernumber');
90 if (C4::Context->preference("AutoSwitchPatron") && $barcode) {
91 if (Koha::Patrons->search( { cardnumber => $barcode} )->count() > 0) {
92 $findborrower = $barcode;
93 undef $barcode;
94 undef $borrowernumber;
95 $autoswitched = 1;
98 $findborrower ||= $query->param('findborrower') || q{};
99 $findborrower =~ s|,| |g;
101 # Barcode given by user could be '0'
102 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
103 $barcodes = [ $barcode ];
104 } else {
105 my $filefh = $query->upload('uploadfile');
106 if ( $filefh ) {
107 while ( my $content = <$filefh> ) {
108 $content =~ s/[\r\n]*$//g;
109 push @$barcodes, $content if $content;
111 } elsif ( my $list = $query->param('barcodelist') ) {
112 push @$barcodes, split( /\s\n/, $list );
113 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
114 } else {
115 @$barcodes = $query->multi_param('barcodes');
119 $barcodes = [ uniq @$barcodes ];
121 my $template_name = q|circ/circulation.tt|;
122 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
123 my $batch = $query->param('batch');
124 my $batch_allowed = 0;
125 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
126 $template_name = q|circ/circulation_batch_checkouts.tt|;
127 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
128 my $categorycode = $patron->categorycode;
129 if ( $categorycode && grep {/^$categorycode$/} @batch_category_codes ) {
130 $batch_allowed = 1;
131 } else {
132 $barcodes = [];
136 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
138 template_name => $template_name,
139 query => $query,
140 type => "intranet",
141 authnotrequired => 0,
142 flagsrequired => { circulate => 'circulate_remaining_permissions' },
145 my $logged_in_user = Koha::Patrons->find( $loggedinuser ) or die "Not logged in";
147 my $force_allow_issue = $query->param('forceallow') || 0;
148 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
149 $force_allow_issue = 0;
152 my $onsite_checkout = $query->param('onsite_checkout');
154 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
155 our %renew_failed = ();
156 for (@failedrenews) { $renew_failed{$_} = 1; }
158 my @failedreturns = $query->multi_param('failedreturn');
159 our %return_failed = ();
160 for (@failedreturns) { $return_failed{$_} = 1; }
162 my $searchtype = $query->param('searchtype') || q{contain};
164 my $branch = C4::Context->userenv->{'branch'};
166 if (C4::Context->preference("DisplayClearScreenButton")) {
167 $template->param(DisplayClearScreenButton => 1);
170 for my $barcode ( @$barcodes ) {
171 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
172 $barcode = barcodedecode($barcode)
173 if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
176 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
177 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
178 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso', timeformat => '24hr' }); }
179 if ( $duedatespec );
180 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
181 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
182 undef $restoreduedatespec;
184 my $issueconfirmed = $query->param('issueconfirmed');
185 my $cancelreserve = $query->param('cancelreserve');
186 my $print = $query->param('print') || q{};
187 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
188 my $charges = $query->param('charges') || q{};
190 # Check if stickyduedate is turned off
191 if ( @$barcodes ) {
192 # was stickyduedate loaded from session?
193 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
194 $session->clear( 'stickyduedate' );
195 $stickyduedate = $query->param('stickyduedate');
196 $duedatespec = $query->param('duedatespec');
198 $session->param('auto_renew', scalar $query->param('auto_renew'));
200 else {
201 $session->clear('auto_renew');
204 my ($datedue,$invalidduedate);
206 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
207 if( $onsite_checkout && !$duedatespec_allow ) {
208 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
209 $datedue .= ' 23:59:00';
210 } elsif( $duedatespec_allow ) {
211 if ( $duedatespec ) {
212 $datedue = eval { dt_from_string( $duedatespec ) };
213 if (! $datedue ) {
214 $invalidduedate = 1;
215 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
220 # check and see if we should print
221 if ( @$barcodes == 0 && $print eq 'maybe' ) {
222 $print = 'yes';
225 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
226 if ( @$barcodes == 0 && $charges eq 'yes' ) {
227 $template->param(
228 PAYCHARGES => 'yes',
229 borrowernumber => $borrowernumber
233 if ( $print eq 'yes' && $borrowernumber ne '' ) {
234 if ( C4::Context->boolean_preference('printcirculationslips') ) {
235 my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
236 NetworkPrint($letter->{content});
238 $query->param( 'borrowernumber', '' );
239 $borrowernumber = '';
240 undef $patron;
244 # STEP 2 : FIND BORROWER
245 # if there is a list of find borrowers....
247 my $message;
248 if ($findborrower) {
249 my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
250 if ( $patron ) {
251 $borrowernumber = $patron->borrowernumber;
252 } else {
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 );
268 } else {
269 $query->param( 'findborrower', '' );
270 $message = "'$findborrower'";
275 # get the borrower information.....
276 my $balance = 0;
277 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
278 if ($patron) {
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
291 $template->param(
292 noissues => ($force_allow_issue) ? 0 : "1",
293 forceallow => $force_allow_issue,
294 expired => "1",
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);
306 $template->param(
307 overduecount => $overdues->count,
308 issuecount => $issues->count,
309 finetotal => $balance,
312 if ( $patron and $patron->is_debarred ) {
313 $template->param(
314 'userdebarred' => $patron->debarred,
315 'debarredcomment' => $patron->debarredcomment,
318 if ( $patron->debarred ne "9999-12-31" ) {
319 $template->param( 'userdebarreddate' => $patron->debarred );
323 # Calculate and display patron's age
324 if ( !$patron->is_valid_age ) {
325 $template->param( age_limitations => 1 );
326 $template->param( age_low => $patron->category->dateofbirthrequired );
327 $template->param( age_high => $patron->category->upperagelimit );
333 # STEP 3 : ISSUING
336 if (@$barcodes) {
337 my $checkout_infos;
338 for my $barcode ( @$barcodes ) {
340 my $template_params = {
341 barcode => $barcode,
342 onsite_checkout => $onsite_checkout,
345 # always check for blockers on issuing
346 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
347 $patron,
348 $barcode, $datedue,
349 $inprocess,
350 undef,
352 onsite_checkout => $onsite_checkout,
353 override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
357 my $blocker = $invalidduedate ? 1 : 0;
359 $template_params->{alert} = $alerts;
360 $template_params->{messages} = $messages;
362 my $item = Koha::Items->find({ barcode => $barcode });
364 my $biblio;
365 if ( $item ) {
366 $biblio = $item->biblio;
369 # Fix for bug 7494: optional checkout-time fallback search for a book
371 if ( $error->{'UNKNOWN_BARCODE'}
372 && C4::Context->preference("itemBarcodeFallbackSearch")
373 && not $batch
376 $template_params->{FALLBACK} = 1;
378 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
379 my $query = "kw=" . $barcode;
380 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
382 # if multiple hits, offer options to librarian
383 if ( $total_hits > 0 ) {
384 my @options = ();
385 foreach my $hit ( @{$results} ) {
386 my $chosen =
387 TransformMarcToKoha( C4::Search::new_record_from_zebra('biblioserver',$hit) );
389 # offer all barcodes individually
390 if ( $chosen->{barcode} ) {
391 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
392 my %chosen_single = %{$chosen};
393 $chosen_single{barcode} = $barcode;
394 push( @options, \%chosen_single );
398 $template_params->{options} = \@options;
402 if ( $error->{UNKNOWN_BARCODE} or not $onsite_checkout or not C4::Context->preference("OnSiteCheckoutsForce") ) {
403 delete $question->{'DEBT'} if ($debt_confirmed);
404 foreach my $impossible ( keys %$error ) {
405 $template_params->{$impossible} = $$error{$impossible};
406 $template_params->{IMPOSSIBLE} = 1;
407 $blocker = 1;
411 if( $item and ( !$blocker or $force_allow_issue ) ){
412 my $confirm_required = 0;
413 unless($issueconfirmed){
414 # Get the item title for more information
415 my $materials = $item->materials;
416 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
417 $materials = $descriptions->{lib} // $materials;
418 $template_params->{additional_materials} = $materials;
419 $template_params->{itemhomebranch} = $item->homebranch;
421 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
422 foreach my $needsconfirmation ( keys %$question ) {
423 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
424 $template_params->{getTitleMessageIteminfo} = $biblio->title;
425 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
426 $template_params->{NEEDSCONFIRMATION} = 1;
427 $template_params->{auto_renew} = $session->param('auto_renew');
428 $confirm_required = 1;
431 unless($confirm_required) {
432 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
433 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, } );
434 $template_params->{issue} = $issue;
435 $session->clear('auto_renew');
436 $inprocess = 1;
440 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
441 $template->param(
442 reserveborrowernumber => $question->{'resborrowernumber'}
447 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
448 $patron = Koha::Patrons->find( $borrowernumber );
449 $template_params->{issuecount} = $patron->checkouts->count;
451 if ( $item ) {
452 $template_params->{item} = $item;
453 $template_params->{biblio} = $biblio;
454 $template_params->{itembiblionumber} = $biblio->biblionumber;
456 push @$checkout_infos, $template_params;
458 unless ( $batch ) {
459 $template->param( %{$checkout_infos->[0]} );
460 $template->param( barcode => $barcodes->[0] );
461 } else {
462 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
463 $template->param(
464 checkout_infos => $checkout_infos,
465 confirmation_needed => $confirmation_needed,
470 ##################################################################################
471 # BUILD HTML
472 # show all reserves of this borrower, and the position of the reservation ....
473 if ($patron) {
474 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
475 my $waiting_holds = $holds->waiting;
476 $template->param(
477 holds_count => $holds->count(),
478 WaitingHolds => $waiting_holds,
482 if ( $patron ) {
483 my $noissues;
484 if ( $patron->gonenoaddress ) {
485 $template->param( gna => 1 );
486 $noissues = 1;
488 if ( $patron->lost ) {
489 $template->param( lost=> 1 );
490 $noissues = 1;
492 if ( $patron->is_debarred ) {
493 $template->param( dbarred=> 1 );
494 $noissues = 1;
496 my $account = $patron->account;
497 if( ( my $owing = $account->non_issues_charges ) > 0 ) {
498 my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
499 $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
500 $template->param(
501 charges => 1,
502 chargesamount => $owing,
504 } elsif ( $balance < 0 ) {
505 $template->param(
506 credits => 1,
507 creditsamount => -$balance,
511 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
512 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
513 if ( defined $no_issues_charge_guarantees ) {
514 my $guarantees_non_issues_charges = 0;
515 my $guarantees = $patron->guarantees;
516 while ( my $g = $guarantees->next ) {
517 $guarantees_non_issues_charges += $g->account->non_issues_charges;
519 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
520 $template->param(
521 charges_guarantees => 1,
522 chargesamount_guarantees => $guarantees_non_issues_charges,
524 $noissues = 1 unless C4::Context->preference("allowfineoverride");
528 if ( $patron->has_overdues ) {
529 $template->param( odues => 1 );
532 if ( $patron->borrowernotes ) {
533 my $borrowernotes = $patron->borrowernotes;
534 $borrowernotes =~ s#\n#<br />#g;
535 $template->param(
536 notes =>1,
537 notesmsg => $borrowernotes,
541 if ( $noissues ) {
542 $template->param(
543 noissues => ($force_allow_issue) ? 0 : 'true',
544 forceallow => $force_allow_issue,
549 my $messages = Koha::Patron::Messages->search(
551 'me.borrowernumber' => $borrowernumber,
554 join => 'manager',
555 '+select' => ['manager.surname', 'manager.firstname' ],
556 '+as' => ['manager_surname', 'manager_firstname'],
560 my $fast_cataloging = 0;
561 if ( Koha::BiblioFrameworks->find('FA') ) {
562 $fast_cataloging = 1
565 my $view = $batch
566 ?'batch_checkout_view'
567 : 'circview';
569 my @relatives;
570 if ( $borrowernumber ) {
571 if ( $patron ) {
572 if ( my $guarantor = $patron->guarantor ) {
573 push @relatives, $guarantor->borrowernumber;
574 push @relatives, $_->borrowernumber for $patron->siblings;
575 } else {
576 push @relatives, $_->borrowernumber for $patron->guarantees;
580 my $relatives_issues_count =
581 Koha::Database->new()->schema()->resultset('Issue')
582 ->count( { borrowernumber => \@relatives } );
584 if ( $patron ) {
585 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
586 my $roadtype = $av->count ? $av->next->lib : '';
587 $template->param(
588 roadtype => $roadtype,
589 patron => $patron,
590 categoryname => $patron->category->description,
591 expiry => $patron->dateexpiry,
595 # Restore date if changed by holds and/or save stickyduedate to session
596 if ($restoreduedatespec || $stickyduedate) {
597 $duedatespec = $restoreduedatespec || $duedatespec;
599 if ($stickyduedate) {
600 $session->param( 'stickyduedate', $duedatespec );
602 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
603 undef $duedatespec;
606 $template->param(
607 messages => $messages,
608 borrowernumber => $borrowernumber,
609 branch => $branch,
610 was_renewed => scalar $query->param('was_renewed') ? 1 : 0,
611 barcodes => $barcodes,
612 stickyduedate => $stickyduedate,
613 duedatespec => $duedatespec,
614 restoreduedatespec => $restoreduedatespec,
615 message => $message,
616 totaldue => sprintf('%.2f', $balance), # FIXME not used in template?
617 inprocess => $inprocess,
618 $view => 1,
619 batch_allowed => $batch_allowed,
620 batch => $batch,
621 AudioAlerts => C4::Context->preference("AudioAlerts"),
622 fast_cataloging => $fast_cataloging,
623 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
624 RoutingSerials => C4::Context->preference('RoutingSerials'),
625 relatives_issues_count => $relatives_issues_count,
626 relatives_borrowernumbers => \@relatives,
630 if ( C4::Context->preference("ExportCircHistory") ) {
631 $template->param(csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc' }) ]);
634 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
635 $template->param(
636 debt_confirmed => $debt_confirmed,
637 SpecifyDueDate => $duedatespec_allow,
638 CircAutocompl => C4::Context->preference("CircAutocompl"),
639 debarments => scalar GetDebarments({ borrowernumber => $borrowernumber }),
640 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
641 has_modifications => $has_modifications,
642 override_high_holds => $override_high_holds,
643 nopermission => scalar $query->param('nopermission'),
644 autoswitched => $autoswitched,
647 output_html_with_http_headers $query, $cookie, $template->output;