Bug 16224: Fix t/db_dependent/Reports_Guided.t
[koha.git] / circ / circulation.pl
blobe4c54245642e6ea4adf76ad9829523ae13762066
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::Borrower::Debarments qw(GetDebarments IsDebarred);
47 use Koha::DateUtils;
48 use Koha::Database;
50 use Date::Calc qw(
51 Today
52 Add_Delta_Days
53 Date_to_Days
55 use List::MoreUtils qw/uniq/;
58 # PARAMETERS READING
60 my $query = new CGI;
62 my $sessionID = $query->cookie("CGISESSID") ;
63 my $session = get_session($sessionID);
65 # branch and printer are now defined by the userenv
66 # but first we have to check if someone has tried to change them
68 my $branch = $query->param('branch');
69 if ($branch){
70 # update our session so the userenv is updated
71 $session->param('branch', $branch);
72 $session->param('branchname', GetBranchName($branch));
75 my $printer = $query->param('printer');
76 if ($printer){
77 # update our session so the userenv is updated
78 $session->param('branchprinter', $printer);
81 if (!C4::Context->userenv && !$branch){
82 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
83 # no branch set we can't issue
84 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
85 exit;
89 my $barcodes = [];
90 my $barcode = $query->param('barcode');
91 # Barcode given by user could be '0'
92 if ( $barcode || $barcode eq '0' ) {
93 $barcodes = [ $barcode ];
94 } else {
95 my $filefh = $query->upload('uploadfile');
96 if ( $filefh ) {
97 while ( my $content = <$filefh> ) {
98 $content =~ s/[\r\n]*$//g;
99 push @$barcodes, $content if $content;
101 } elsif ( my $list = $query->param('barcodelist') ) {
102 push @$barcodes, split( /\s\n/, $list );
103 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
104 } else {
105 @$barcodes = $query->param('barcodes');
109 $barcodes = [ uniq @$barcodes ];
111 my $template_name = q|circ/circulation.tt|;
112 my $borrowernumber = $query->param('borrowernumber');
113 my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
114 my $batch = $query->param('batch');
115 my $batch_allowed = 0;
116 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
117 $template_name = q|circ/circulation_batch_checkouts.tt|;
118 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
119 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
120 $batch_allowed = 1;
121 } else {
122 $barcodes = [];
126 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
128 template_name => $template_name,
129 query => $query,
130 type => "intranet",
131 authnotrequired => 0,
132 flagsrequired => { circulate => 'circulate_remaining_permissions' },
136 my $branches = GetBranches();
138 my $force_allow_issue = $query->param('forceallow') || 0;
139 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
140 $force_allow_issue = 0;
143 my $onsite_checkout = $query->param('onsite_checkout');
145 my @failedrenews = $query->param('failedrenew'); # expected to be itemnumbers
146 our %renew_failed = ();
147 for (@failedrenews) { $renew_failed{$_} = 1; }
149 my @failedreturns = $query->param('failedreturn');
150 our %return_failed = ();
151 for (@failedreturns) { $return_failed{$_} = 1; }
153 my $findborrower = $query->param('findborrower') || q{};
154 $findborrower =~ s|,| |g;
156 $branch = C4::Context->userenv->{'branch'};
157 $printer = C4::Context->userenv->{'branchprinter'};
159 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
160 if (C4::Context->preference("AutoLocation") != 1) {
161 $template->param(ManualLocation => 1);
164 if (C4::Context->preference("DisplayClearScreenButton")) {
165 $template->param(DisplayClearScreenButton => 1);
168 for my $barcode ( @$barcodes ) {
169 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
170 $barcode = barcodedecode($barcode)
171 if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
174 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
175 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
176 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso' }); }
177 if ( $duedatespec );
178 my $restoreduedatespec = $query->param('restoreduedatespec') || $session->param('stickyduedate') || $duedatespec;
179 if ($restoreduedatespec eq "highholds_empty") {
180 undef $restoreduedatespec;
182 my $issueconfirmed = $query->param('issueconfirmed');
183 my $cancelreserve = $query->param('cancelreserve');
184 my $print = $query->param('print') || q{};
185 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
186 my $charges = $query->param('charges') || q{};
188 # Check if stickyduedate is turned off
189 if ( @$barcodes ) {
190 # was stickyduedate loaded from session?
191 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
192 $session->clear( 'stickyduedate' );
193 $stickyduedate = $query->param('stickyduedate');
194 $duedatespec = $query->param('duedatespec');
196 $session->param('auto_renew', $query->param('auto_renew'));
198 else {
199 $session->clear('auto_renew');
202 my ($datedue,$invalidduedate);
204 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
205 if( $onsite_checkout && !$duedatespec_allow ) {
206 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
207 $datedue .= ' 23:59:00';
208 } elsif( $duedatespec_allow ) {
209 if ( $duedatespec ) {
210 $datedue = eval { dt_from_string( $duedatespec ) };
211 if (! $datedue ) {
212 $invalidduedate = 1;
213 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
218 # check and see if we should print
219 if ( @$barcodes == 0 && $print eq 'maybe' ) {
220 $print = 'yes';
223 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
224 if ( @$barcodes == 0 && $charges eq 'yes' ) {
225 $template->param(
226 PAYCHARGES => 'yes',
227 borrowernumber => $borrowernumber
231 if ( $print eq 'yes' && $borrowernumber ne '' ) {
232 if ( C4::Context->boolean_preference('printcirculationslips') ) {
233 my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
234 NetworkPrint($letter->{content});
236 $query->param( 'borrowernumber', '' );
237 $borrowernumber = '';
241 # STEP 2 : FIND BORROWER
242 # if there is a list of find borrowers....
244 my $message;
245 if ($findborrower) {
246 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
247 if ( $borrower ) {
248 $borrowernumber = $borrower->{borrowernumber};
249 } else {
250 my $dt_params = { iDisplayLength => -1 };
251 my $results = C4::Utils::DataTables::Members::search(
253 searchmember => $findborrower,
254 searchtype => 'contain',
255 dt_params => $dt_params,
258 my $borrowers = $results->{patrons};
259 if ( scalar @$borrowers == 1 ) {
260 $borrowernumber = $borrowers->[0]->{borrowernumber};
261 $query->param( 'borrowernumber', $borrowernumber );
262 $query->param( 'barcode', '' );
263 } elsif ( @$borrowers ) {
264 $template->param( borrowers => $borrowers );
265 } else {
266 $query->param( 'findborrower', '' );
267 $message = "'$findborrower'";
272 # get the borrower information.....
273 if ($borrowernumber) {
274 $borrower = GetMemberDetails( $borrowernumber, 0 );
275 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
277 # Warningdate is the date that the warning starts appearing
278 my ( $today_year, $today_month, $today_day) = Today();
279 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
280 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
281 # if the expiry date is before today ie they have expired
282 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
283 || Date_to_Days($today_year, $today_month, $today_day )
284 > Date_to_Days($warning_year, $warning_month, $warning_day) )
286 #borrowercard expired, no issues
287 $template->param(
288 flagged => "1",
289 noissues => ($force_allow_issue) ? 0 : "1",
290 forceallow => $force_allow_issue,
291 expired => "1",
294 # check for NotifyBorrowerDeparture
295 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
296 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
297 Date_to_Days( $today_year, $today_month, $today_day ) )
299 # borrower card soon to expire warn librarian
300 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
301 flagged => "1"
303 if (C4::Context->preference('ReturnBeforeExpiry')){
304 $template->param("returnbeforeexpiry" => 1);
307 $template->param(
308 overduecount => $od,
309 issuecount => $issue,
310 finetotal => $fines
313 if ( IsDebarred($borrowernumber) ) {
314 $template->param(
315 'userdebarred' => $borrower->{debarred},
316 'debarredcomment' => $borrower->{debarredcomment},
319 if ( $borrower->{debarred} ne "9999-12-31" ) {
320 $template->param( 'userdebarreddate' => $borrower->{debarred} );
327 # STEP 3 : ISSUING
330 if (@$barcodes) {
331 my $checkout_infos;
332 for my $barcode ( @$barcodes ) {
333 my $template_params = { barcode => $barcode };
334 # always check for blockers on issuing
335 my ( $error, $question, $alerts ) =
336 CanBookBeIssued( $borrower, $barcode, $datedue , $inprocess, undef, { onsite_checkout => $onsite_checkout } );
337 my $blocker = $invalidduedate ? 1 : 0;
339 $template_params->{alert} = $alerts;
341 # Get the item title for more information
342 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
343 $template_params->{authvalcode_notforloan} =
344 C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
346 # Fix for bug 7494: optional checkout-time fallback search for a book
348 if ( $error->{'UNKNOWN_BARCODE'}
349 && C4::Context->preference("itemBarcodeFallbackSearch")
350 && not $batch
353 $template_params->{FALLBACK} = 1;
355 my $query = "kw=" . $barcode;
356 my ( $searcherror, $results, $total_hits ) = SimpleSearch($query);
358 # if multiple hits, offer options to librarian
359 if ( $total_hits > 0 ) {
360 my @options = ();
361 foreach my $hit ( @{$results} ) {
362 my $chosen =
363 TransformMarcToKoha( C4::Context->dbh,
364 C4::Search::new_record_from_zebra('biblioserver',$hit) );
366 # offer all barcodes individually
367 if ( $chosen->{barcode} ) {
368 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
369 my %chosen_single = %{$chosen};
370 $chosen_single{barcode} = $barcode;
371 push( @options, \%chosen_single );
375 $template_params->{options} = \@options;
379 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
380 delete $question->{'DEBT'} if ($debt_confirmed);
381 foreach my $impossible ( keys %$error ) {
382 $template_params->{$impossible} = $$error{$impossible};
383 $template_params->{IMPOSSIBLE} = 1;
384 $blocker = 1;
387 my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
388 if( !$blocker || $force_allow_issue ){
389 my $confirm_required = 0;
390 unless($issueconfirmed){
391 # Get the item title for more information
392 $template_params->{additional_materials} = $iteminfo->{'materials'};
393 $template_params->{itemhomebranch} = $iteminfo->{'homebranch'};
395 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
396 foreach my $needsconfirmation ( keys %$question ) {
397 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
398 $template_params->{getTitleMessageIteminfo} = $iteminfo->{'title'};
399 $template_params->{getBarcodeMessageIteminfo} = $iteminfo->{'barcode'};
400 $template_params->{NEEDSCONFIRMATION} = 1;
401 $template_params->{onsite_checkout} = $onsite_checkout;
402 $confirm_required = 1;
405 unless($confirm_required) {
406 my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew') } );
407 $template->param( issue => $issue );
408 $session->clear('auto_renew');
409 $inprocess = 1;
413 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
414 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines($borrowernumber);
416 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
417 $template->param(
418 reserveborrowernumber => $question->{'resborrowernumber'},
419 itembiblionumber => $getmessageiteminfo->{'biblionumber'}
423 $template_params->{issuecount} = $issue;
425 if ( $iteminfo ) {
426 $iteminfo->{subtitle} = GetRecordValue('subtitle', GetMarcBiblio($iteminfo->{biblionumber}), GetFrameworkCode($iteminfo->{biblionumber}));
427 $template_params->{item} = $iteminfo;
429 push @$checkout_infos, $template_params;
431 unless ( $batch ) {
432 $template->param( %{$checkout_infos->[0]} );
433 $template->param( barcode => $barcodes->[0] );
434 } else {
435 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
436 $template->param(
437 checkout_infos => $checkout_infos,
438 confirmation_needed => $confirmation_needed,
443 # reload the borrower info for the sake of reseting the flags.....
444 if ($borrowernumber) {
445 $borrower = GetMemberDetails( $borrowernumber, 0 );
448 ##################################################################################
449 # BUILD HTML
450 # show all reserves of this borrower, and the position of the reservation ....
451 if ($borrowernumber) {
452 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
453 my $waiting_holds = $holds->waiting;
454 $template->param(
455 holds_count => $holds->count(),
456 WaitingHolds => $waiting_holds,
459 $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
462 #title
463 my $flags = $borrower->{'flags'};
464 foreach my $flag ( sort keys %$flags ) {
465 $template->param( flagged=> 1);
466 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
467 if ( $flags->{$flag}->{'noissues'} ) {
468 $template->param(
469 noissues => ($force_allow_issue) ? 0 : 'true',
470 forceallow => $force_allow_issue,
472 if ( $flag eq 'GNA' ) {
473 $template->param( gna => 'true' );
475 elsif ( $flag eq 'LOST' ) {
476 $template->param( lost => 'true' );
478 elsif ( $flag eq 'DBARRED' ) {
479 $template->param( dbarred => 'true' );
481 elsif ( $flag eq 'CHARGES' ) {
482 $template->param(
483 charges => 'true',
484 chargesmsg => $flags->{'CHARGES'}->{'message'},
485 chargesamount => $flags->{'CHARGES'}->{'amount'},
486 charges_is_blocker => 1
489 elsif ( $flag eq 'CREDITS' ) {
490 $template->param(
491 credits => 'true',
492 creditsmsg => $flags->{'CREDITS'}->{'message'},
493 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
497 else {
498 if ( $flag eq 'CHARGES' ) {
499 $template->param(
500 charges => 'true',
501 chargesmsg => $flags->{'CHARGES'}->{'message'},
502 chargesamount => $flags->{'CHARGES'}->{'amount'},
505 elsif ( $flag eq 'CREDITS' ) {
506 $template->param(
507 credits => 'true',
508 creditsmsg => $flags->{'CREDITS'}->{'message'},
509 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
512 elsif ( $flag eq 'ODUES' ) {
513 $template->param(
514 odues => 'true',
515 oduesmsg => $flags->{'ODUES'}->{'message'}
518 my $items = $flags->{$flag}->{'itemlist'};
519 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
520 $template->param( nonreturns => 'true' );
523 elsif ( $flag eq 'NOTES' ) {
524 $template->param(
525 notes => 'true',
526 notesmsg => $flags->{'NOTES'}->{'message'}
532 my $amountold = $borrower->{flags} ? $borrower->{flags}->{'CHARGES'}->{'message'} || 0 : 0;
533 $amountold =~ s/^.*\$//; # remove upto the $, if any
535 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
537 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
538 my ( $catcodes, $labels ) = GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
539 my $cnt = scalar(@$catcodes);
540 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
541 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
544 my $lib_messages_loop = GetMessages( $borrowernumber, 'L', $branch );
545 if($lib_messages_loop){ $template->param(flagged => 1 ); }
547 my $bor_messages_loop = GetMessages( $borrowernumber, 'B', $branch );
548 if($bor_messages_loop){ $template->param(flagged => 1 ); }
550 my $fast_cataloging = 0;
551 if (defined getframeworkinfo('FA')) {
552 $fast_cataloging = 1
555 if (C4::Context->preference('ExtendedPatronAttributes')) {
556 my $attributes = GetBorrowerAttributes($borrowernumber);
557 $template->param(
558 ExtendedPatronAttributes => 1,
559 extendedattributes => $attributes
562 my $view = $batch
563 ?'batch_checkout_view'
564 : 'circview';
566 my @relatives = GetMemberRelatives( $borrower->{'borrowernumber'} );
567 my $relatives_issues_count =
568 Koha::Database->new()->schema()->resultset('Issue')
569 ->count( { borrowernumber => \@relatives } );
571 my $roadtype = C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{streettype} );
573 $template->param(%$borrower);
575 # Restore date if changed by holds and/or save stickyduedate to session
576 if ($restoreduedatespec || $stickyduedate) {
577 $duedatespec = $restoreduedatespec || $duedatespec;
579 if ($stickyduedate) {
580 $session->param( 'stickyduedate', $duedatespec );
582 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
583 undef $duedatespec;
586 $template->param(
587 lib_messages_loop => $lib_messages_loop,
588 bor_messages_loop => $bor_messages_loop,
589 all_messages_del => C4::Context->preference('AllowAllMessageDeletion'),
590 findborrower => $findborrower,
591 borrower => $borrower,
592 borrowernumber => $borrowernumber,
593 categoryname => $borrower->{'description'},
594 branch => $branch,
595 branchname => GetBranchName($borrower->{'branchcode'}),
596 printer => $printer,
597 printername => $printer,
598 was_renewed => $query->param('was_renewed') ? 1 : 0,
599 expiry => $borrower->{'dateexpiry'},
600 roadtype => $roadtype,
601 amountold => $amountold,
602 barcodes => $barcodes,
603 stickyduedate => $stickyduedate,
604 duedatespec => $duedatespec,
605 restoreduedatespec => $restoreduedatespec,
606 message => $message,
607 totaldue => sprintf('%.2f', $total),
608 inprocess => $inprocess,
609 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
610 $view => 1,
611 batch_allowed => $batch_allowed,
612 AudioAlerts => C4::Context->preference("AudioAlerts"),
613 fast_cataloging => $fast_cataloging,
614 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
615 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
616 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
617 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
618 RoutingSerials => C4::Context->preference('RoutingSerials'),
619 relatives_issues_count => $relatives_issues_count,
620 relatives_borrowernumbers => \@relatives,
623 my ($picture, $dberror) = GetPatronImage($borrower->{'borrowernumber'});
624 $template->param( picture => 1 ) if $picture;
626 # get authorised values with type of BOR_NOTES
628 my $canned_notes = GetAuthorisedValues("BOR_NOTES");
630 $template->param(
631 debt_confirmed => $debt_confirmed,
632 SpecifyDueDate => $duedatespec_allow,
633 CircAutocompl => C4::Context->preference("CircAutocompl"),
634 canned_bor_notes_loop => $canned_notes,
635 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
636 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
639 output_html_with_http_headers $query, $cookie, $template->output;