Bug 16040: Update fnReloadAjax DT plugin to fix quotes deletion
[koha.git] / circ / circulation.pl
blob75799bd524d193135e66d75e5ed35b269ff78a45
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 use strict;
26 use warnings;
27 use CGI qw ( -utf8 );
28 use DateTime;
29 use DateTime::Duration;
30 use C4::Output;
31 use C4::Print;
32 use C4::Auth qw/:DEFAULT get_session haspermission/;
33 use C4::Branch; # GetBranches
34 use C4::Koha; # GetPrinter
35 use C4::Circulation;
36 use C4::Utils::DataTables::Members;
37 use C4::Members;
38 use C4::Biblio;
39 use C4::Search;
40 use MARC::Record;
41 use C4::Reserves;
42 use Koha::Holds;
43 use C4::Context;
44 use CGI::Session;
45 use C4::Members::Attributes qw(GetBorrowerAttributes);
46 use Koha::Patron;
47 use Koha::Patron::Debarments qw(GetDebarments IsDebarred);
48 use Koha::DateUtils;
49 use Koha::Database;
50 use Koha::Patron::Messages;
51 use Koha::Patron::Images;
53 use Date::Calc qw(
54 Today
55 Add_Delta_Days
56 Date_to_Days
58 use List::MoreUtils qw/uniq/;
61 # PARAMETERS READING
63 my $query = new CGI;
65 my $sessionID = $query->cookie("CGISESSID") ;
66 my $session = get_session($sessionID);
68 # branch and printer are now defined by the userenv
69 # but first we have to check if someone has tried to change them
71 my $branch = $query->param('branch');
72 if ($branch){
73 # update our session so the userenv is updated
74 $session->param('branch', $branch);
75 $session->param('branchname', GetBranchName($branch));
78 my $printer = $query->param('printer');
79 if ($printer){
80 # update our session so the userenv is updated
81 $session->param('branchprinter', $printer);
84 if (!C4::Context->userenv && !$branch){
85 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
86 # no branch set we can't issue
87 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
88 exit;
92 my $barcodes = [];
93 my $barcode = $query->param('barcode');
94 # Barcode given by user could be '0'
95 if ( $barcode || $barcode eq '0' ) {
96 $barcodes = [ $barcode ];
97 } else {
98 my $filefh = $query->upload('uploadfile');
99 if ( $filefh ) {
100 while ( my $content = <$filefh> ) {
101 $content =~ s/[\r\n]*$//g;
102 push @$barcodes, $content if $content;
104 } elsif ( my $list = $query->param('barcodelist') ) {
105 push @$barcodes, split( /\s\n/, $list );
106 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
107 } else {
108 @$barcodes = $query->param('barcodes');
112 $barcodes = [ uniq @$barcodes ];
114 my $template_name = q|circ/circulation.tt|;
115 my $borrowernumber = $query->param('borrowernumber');
116 my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
117 my $batch = $query->param('batch');
118 my $batch_allowed = 0;
119 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
120 $template_name = q|circ/circulation_batch_checkouts.tt|;
121 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
122 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
123 $batch_allowed = 1;
124 } else {
125 $barcodes = [];
129 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
131 template_name => $template_name,
132 query => $query,
133 type => "intranet",
134 authnotrequired => 0,
135 flagsrequired => { circulate => 'circulate_remaining_permissions' },
139 my $branches = GetBranches();
141 my $force_allow_issue = $query->param('forceallow') || 0;
142 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
143 $force_allow_issue = 0;
146 my $onsite_checkout = $query->param('onsite_checkout');
148 my @failedrenews = $query->param('failedrenew'); # expected to be itemnumbers
149 our %renew_failed = ();
150 for (@failedrenews) { $renew_failed{$_} = 1; }
152 my @failedreturns = $query->param('failedreturn');
153 our %return_failed = ();
154 for (@failedreturns) { $return_failed{$_} = 1; }
156 my $findborrower = $query->param('findborrower') || q{};
157 $findborrower =~ s|,| |g;
159 $branch = C4::Context->userenv->{'branch'};
160 $printer = C4::Context->userenv->{'branchprinter'};
162 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
163 if (C4::Context->preference("AutoLocation") != 1) {
164 $template->param(ManualLocation => 1);
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' }); }
180 if ( $duedatespec );
181 my $restoreduedatespec = $query->param('restoreduedatespec') || $session->param('stickyduedate') || $duedatespec;
182 if ($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
192 if ( @$barcodes ) {
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', $query->param('auto_renew'));
201 else {
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 ) };
214 if (! $datedue ) {
215 $invalidduedate = 1;
216 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
221 # check and see if we should print
222 if ( @$barcodes == 0 && $print eq 'maybe' ) {
223 $print = 'yes';
226 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
227 if ( @$barcodes == 0 && $charges eq 'yes' ) {
228 $template->param(
229 PAYCHARGES => '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....
247 my $message;
248 if ($findborrower) {
249 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
250 if ( $borrower ) {
251 $borrowernumber = $borrower->{borrowernumber};
252 } else {
253 my $dt_params = { iDisplayLength => -1 };
254 my $results = C4::Utils::DataTables::Members::search(
256 searchmember => $findborrower,
257 searchtype => 'contain',
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 if ($borrowernumber) {
277 $borrower = GetMemberDetails( $borrowernumber, 0 );
278 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
280 # Warningdate is the date that the warning starts appearing
281 my ( $today_year, $today_month, $today_day) = Today();
282 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
283 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
284 # if the expiry date is before today ie they have expired
285 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
286 || Date_to_Days($today_year, $today_month, $today_day )
287 > Date_to_Days($warning_year, $warning_month, $warning_day) )
289 #borrowercard expired, no issues
290 $template->param(
291 flagged => "1",
292 noissues => ($force_allow_issue) ? 0 : "1",
293 forceallow => $force_allow_issue,
294 expired => "1",
297 # check for NotifyBorrowerDeparture
298 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
299 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
300 Date_to_Days( $today_year, $today_month, $today_day ) )
302 # borrower card soon to expire warn librarian
303 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
304 flagged => "1"
306 if (C4::Context->preference('ReturnBeforeExpiry')){
307 $template->param("returnbeforeexpiry" => 1);
310 $template->param(
311 overduecount => $od,
312 issuecount => $issue,
313 finetotal => $fines
316 if ( IsDebarred($borrowernumber) ) {
317 $template->param(
318 'userdebarred' => $borrower->{debarred},
319 'debarredcomment' => $borrower->{debarredcomment},
322 if ( $borrower->{debarred} ne "9999-12-31" ) {
323 $template->param( 'userdebarreddate' => $borrower->{debarred} );
330 # STEP 3 : ISSUING
333 if (@$barcodes) {
334 my $checkout_infos;
335 for my $barcode ( @$barcodes ) {
336 my $template_params = { barcode => $barcode };
337 # always check for blockers on issuing
338 my ( $error, $question, $alerts ) =
339 CanBookBeIssued( $borrower, $barcode, $datedue , $inprocess, undef, { onsite_checkout => $onsite_checkout } );
340 my $blocker = $invalidduedate ? 1 : 0;
342 $template_params->{alert} = $alerts;
344 # Get the item title for more information
345 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
346 $template_params->{authvalcode_notforloan} =
347 C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
349 # Fix for bug 7494: optional checkout-time fallback search for a book
351 if ( $error->{'UNKNOWN_BARCODE'}
352 && C4::Context->preference("itemBarcodeFallbackSearch")
353 && not $batch
356 $template_params->{FALLBACK} = 1;
358 my $query = "kw=" . $barcode;
359 my ( $searcherror, $results, $total_hits ) = SimpleSearch($query);
361 # if multiple hits, offer options to librarian
362 if ( $total_hits > 0 ) {
363 my @options = ();
364 foreach my $hit ( @{$results} ) {
365 my $chosen =
366 TransformMarcToKoha( C4::Context->dbh,
367 C4::Search::new_record_from_zebra('biblioserver',$hit) );
369 # offer all barcodes individually
370 if ( $chosen->{barcode} ) {
371 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
372 my %chosen_single = %{$chosen};
373 $chosen_single{barcode} = $barcode;
374 push( @options, \%chosen_single );
378 $template_params->{options} = \@options;
382 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
383 delete $question->{'DEBT'} if ($debt_confirmed);
384 foreach my $impossible ( keys %$error ) {
385 $template_params->{$impossible} = $$error{$impossible};
386 $template_params->{IMPOSSIBLE} = 1;
387 $blocker = 1;
390 my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
391 if( !$blocker || $force_allow_issue ){
392 my $confirm_required = 0;
393 unless($issueconfirmed){
394 # Get the item title for more information
395 $template_params->{additional_materials} = $iteminfo->{'materials'};
396 $template_params->{itemhomebranch} = $iteminfo->{'homebranch'};
398 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
399 foreach my $needsconfirmation ( keys %$question ) {
400 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
401 $template_params->{getTitleMessageIteminfo} = $iteminfo->{'title'};
402 $template_params->{getBarcodeMessageIteminfo} = $iteminfo->{'barcode'};
403 $template_params->{NEEDSCONFIRMATION} = 1;
404 $template_params->{onsite_checkout} = $onsite_checkout;
405 $confirm_required = 1;
408 unless($confirm_required) {
409 my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew') } );
410 $template->param( issue => $issue );
411 $session->clear('auto_renew');
412 $inprocess = 1;
416 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
417 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines($borrowernumber);
419 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
420 $template->param(
421 reserveborrowernumber => $question->{'resborrowernumber'}
425 $template->param(
426 itembiblionumber => $getmessageiteminfo->{'biblionumber'}
431 $template_params->{issuecount} = $issue;
433 if ( $iteminfo ) {
434 $iteminfo->{subtitle} = GetRecordValue('subtitle', GetMarcBiblio($iteminfo->{biblionumber}), GetFrameworkCode($iteminfo->{biblionumber}));
435 $template_params->{item} = $iteminfo;
437 push @$checkout_infos, $template_params;
439 unless ( $batch ) {
440 $template->param( %{$checkout_infos->[0]} );
441 $template->param( barcode => $barcodes->[0] );
442 } else {
443 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
444 $template->param(
445 checkout_infos => $checkout_infos,
446 confirmation_needed => $confirmation_needed,
451 # reload the borrower info for the sake of reseting the flags.....
452 if ($borrowernumber) {
453 $borrower = GetMemberDetails( $borrowernumber, 0 );
456 ##################################################################################
457 # BUILD HTML
458 # show all reserves of this borrower, and the position of the reservation ....
459 if ($borrowernumber) {
460 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
461 my $waiting_holds = $holds->waiting;
462 $template->param(
463 holds_count => $holds->count(),
464 WaitingHolds => $waiting_holds,
467 $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
470 #title
471 my $flags = $borrower->{'flags'};
472 foreach my $flag ( sort keys %$flags ) {
473 $template->param( flagged=> 1);
474 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
475 if ( $flags->{$flag}->{'noissues'} ) {
476 $template->param(
477 noissues => ($force_allow_issue) ? 0 : 'true',
478 forceallow => $force_allow_issue,
480 if ( $flag eq 'GNA' ) {
481 $template->param( gna => 'true' );
483 elsif ( $flag eq 'LOST' ) {
484 $template->param( lost => 'true' );
486 elsif ( $flag eq 'DBARRED' ) {
487 $template->param( dbarred => 'true' );
489 elsif ( $flag eq 'CHARGES' ) {
490 $template->param(
491 charges => 'true',
492 chargesmsg => $flags->{'CHARGES'}->{'message'},
493 chargesamount => $flags->{'CHARGES'}->{'amount'},
494 charges_is_blocker => 1
497 elsif ( $flag eq 'CREDITS' ) {
498 $template->param(
499 credits => 'true',
500 creditsmsg => $flags->{'CREDITS'}->{'message'},
501 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
505 else {
506 if ( $flag eq 'CHARGES' ) {
507 $template->param(
508 charges => 'true',
509 chargesmsg => $flags->{'CHARGES'}->{'message'},
510 chargesamount => $flags->{'CHARGES'}->{'amount'},
513 elsif ( $flag eq 'CREDITS' ) {
514 $template->param(
515 credits => 'true',
516 creditsmsg => $flags->{'CREDITS'}->{'message'},
517 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
520 elsif ( $flag eq 'ODUES' ) {
521 $template->param(
522 odues => 'true',
523 oduesmsg => $flags->{'ODUES'}->{'message'}
526 my $items = $flags->{$flag}->{'itemlist'};
527 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
528 $template->param( nonreturns => 'true' );
531 elsif ( $flag eq 'NOTES' ) {
532 $template->param(
533 notes => 'true',
534 notesmsg => $flags->{'NOTES'}->{'message'}
540 my $amountold = $borrower->{flags} ? $borrower->{flags}->{'CHARGES'}->{'message'} || 0 : 0;
541 $amountold =~ s/^.*\$//; # remove upto the $, if any
543 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
545 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
546 my ( $catcodes, $labels ) = GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
547 my $cnt = scalar(@$catcodes);
548 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
549 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
552 my $librarian_messages = Koha::Patron::Messages->search(
554 borrowernumber => $borrowernumber,
555 message_type => 'L',
559 my $patron_messages = Koha::Patron::Messages->search(
561 borrowernumber => $borrowernumber,
562 message_type => 'B',
566 if( $librarian_messages->count or $patron_messages->count ) {
567 $template->param(flagged => 1)
570 my $fast_cataloging = 0;
571 if (defined getframeworkinfo('FA')) {
572 $fast_cataloging = 1
575 if (C4::Context->preference('ExtendedPatronAttributes')) {
576 my $attributes = GetBorrowerAttributes($borrowernumber);
577 $template->param(
578 ExtendedPatronAttributes => 1,
579 extendedattributes => $attributes
582 my $view = $batch
583 ?'batch_checkout_view'
584 : 'circview';
586 my @relatives;
587 if ( $borrowernumber ) {
588 if ( my $patron = Koha::Patrons->find( $borrower->{borrowernumber} ) ) {
589 if ( my $guarantor = $patron->guarantor ) {
590 push @relatives, $guarantor->borrowernumber;
591 push @relatives, $_->borrowernumber for $patron->siblings;
592 } else {
593 push @relatives, $_->borrowernumber for $patron->guarantees;
597 my $relatives_issues_count =
598 Koha::Database->new()->schema()->resultset('Issue')
599 ->count( { borrowernumber => \@relatives } );
601 my $roadtype = C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{streettype} );
603 $template->param(%$borrower);
605 # Restore date if changed by holds and/or save stickyduedate to session
606 if ($restoreduedatespec || $stickyduedate) {
607 $duedatespec = $restoreduedatespec || $duedatespec;
609 if ($stickyduedate) {
610 $session->param( 'stickyduedate', $duedatespec );
612 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
613 undef $duedatespec;
616 $template->param(
617 librarian_messages => $librarian_messages,
618 patron_messages => $patron_messages,
619 findborrower => $findborrower,
620 borrower => $borrower,
621 borrowernumber => $borrowernumber,
622 categoryname => $borrower->{'description'},
623 branch => $branch,
624 branchname => GetBranchName($borrower->{'branchcode'}),
625 printer => $printer,
626 printername => $printer,
627 was_renewed => $query->param('was_renewed') ? 1 : 0,
628 expiry => $borrower->{'dateexpiry'},
629 roadtype => $roadtype,
630 amountold => $amountold,
631 barcodes => $barcodes,
632 stickyduedate => $stickyduedate,
633 duedatespec => $duedatespec,
634 restoreduedatespec => $restoreduedatespec,
635 message => $message,
636 totaldue => sprintf('%.2f', $total),
637 inprocess => $inprocess,
638 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
639 $view => 1,
640 batch_allowed => $batch_allowed,
641 AudioAlerts => C4::Context->preference("AudioAlerts"),
642 fast_cataloging => $fast_cataloging,
643 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
644 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
645 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
646 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
647 RoutingSerials => C4::Context->preference('RoutingSerials'),
648 relatives_issues_count => $relatives_issues_count,
649 relatives_borrowernumbers => \@relatives,
652 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
653 $template->param( picture => 1 ) if $patron_image;
655 # get authorised values with type of BOR_NOTES
657 my $canned_notes = GetAuthorisedValues("BOR_NOTES");
659 $template->param(
660 debt_confirmed => $debt_confirmed,
661 SpecifyDueDate => $duedatespec_allow,
662 CircAutocompl => C4::Context->preference("CircAutocompl"),
663 canned_bor_notes_loop => $canned_notes,
664 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
665 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
668 output_html_with_http_headers $query, $cookie, $template->output;