Bug 12670: Show materials label in checkin/checkout messages
[koha.git] / circ / circulation.pl
blob2bda49b16b3adac96c96c89c0720c5f4fc19b6bb
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 noissues => ($force_allow_issue) ? 0 : "1",
292 forceallow => $force_allow_issue,
293 expired => "1",
296 # check for NotifyBorrowerDeparture
297 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
298 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
299 Date_to_Days( $today_year, $today_month, $today_day ) )
301 # borrower card soon to expire warn librarian
302 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
304 if (C4::Context->preference('ReturnBeforeExpiry')){
305 $template->param("returnbeforeexpiry" => 1);
308 $template->param(
309 overduecount => $od,
310 issuecount => $issue,
311 finetotal => $fines
314 if ( IsDebarred($borrowernumber) ) {
315 $template->param(
316 'userdebarred' => $borrower->{debarred},
317 'debarredcomment' => $borrower->{debarredcomment},
320 if ( $borrower->{debarred} ne "9999-12-31" ) {
321 $template->param( 'userdebarreddate' => $borrower->{debarred} );
328 # STEP 3 : ISSUING
331 if (@$barcodes) {
332 my $checkout_infos;
333 for my $barcode ( @$barcodes ) {
334 my $template_params = { barcode => $barcode };
335 # always check for blockers on issuing
336 my ( $error, $question, $alerts ) =
337 CanBookBeIssued( $borrower, $barcode, $datedue , $inprocess, undef, { onsite_checkout => $onsite_checkout } );
338 my $blocker = $invalidduedate ? 1 : 0;
340 $template_params->{alert} = $alerts;
342 # Get the item title for more information
343 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
344 $template_params->{authvalcode_notforloan} =
345 C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
347 # Fix for bug 7494: optional checkout-time fallback search for a book
349 if ( $error->{'UNKNOWN_BARCODE'}
350 && C4::Context->preference("itemBarcodeFallbackSearch")
351 && not $batch
354 $template_params->{FALLBACK} = 1;
356 my $query = "kw=" . $barcode;
357 my ( $searcherror, $results, $total_hits ) = SimpleSearch($query);
359 # if multiple hits, offer options to librarian
360 if ( $total_hits > 0 ) {
361 my @options = ();
362 foreach my $hit ( @{$results} ) {
363 my $chosen =
364 TransformMarcToKoha( C4::Context->dbh,
365 C4::Search::new_record_from_zebra('biblioserver',$hit) );
367 # offer all barcodes individually
368 if ( $chosen->{barcode} ) {
369 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
370 my %chosen_single = %{$chosen};
371 $chosen_single{barcode} = $barcode;
372 push( @options, \%chosen_single );
376 $template_params->{options} = \@options;
380 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
381 delete $question->{'DEBT'} if ($debt_confirmed);
382 foreach my $impossible ( keys %$error ) {
383 $template_params->{$impossible} = $$error{$impossible};
384 $template_params->{IMPOSSIBLE} = 1;
385 $blocker = 1;
388 my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
389 if( !$blocker || $force_allow_issue ){
390 my $confirm_required = 0;
391 unless($issueconfirmed){
392 # Get the item title for more information
393 my $materials = $iteminfo->{'materials'};
394 my $avcode = GetAuthValCode('items.materials');
395 if ($avcode) {
396 $materials = GetKohaAuthorisedValueLib($avcode, $materials);
398 $template_params->{additional_materials} = $materials;
399 $template_params->{itemhomebranch} = $iteminfo->{'homebranch'};
401 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
402 foreach my $needsconfirmation ( keys %$question ) {
403 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
404 $template_params->{getTitleMessageIteminfo} = $iteminfo->{'title'};
405 $template_params->{getBarcodeMessageIteminfo} = $iteminfo->{'barcode'};
406 $template_params->{NEEDSCONFIRMATION} = 1;
407 $template_params->{onsite_checkout} = $onsite_checkout;
408 $confirm_required = 1;
411 unless($confirm_required) {
412 my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew') } );
413 $template->param( issue => $issue );
414 $session->clear('auto_renew');
415 $inprocess = 1;
419 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
420 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines($borrowernumber);
422 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
423 $template->param(
424 reserveborrowernumber => $question->{'resborrowernumber'}
428 $template->param(
429 itembiblionumber => $getmessageiteminfo->{'biblionumber'}
434 $template_params->{issuecount} = $issue;
436 if ( $iteminfo ) {
437 $iteminfo->{subtitle} = GetRecordValue('subtitle', GetMarcBiblio($iteminfo->{biblionumber}), GetFrameworkCode($iteminfo->{biblionumber}));
438 $template_params->{item} = $iteminfo;
440 push @$checkout_infos, $template_params;
442 unless ( $batch ) {
443 $template->param( %{$checkout_infos->[0]} );
444 $template->param( barcode => $barcodes->[0] );
445 } else {
446 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
447 $template->param(
448 checkout_infos => $checkout_infos,
449 confirmation_needed => $confirmation_needed,
454 # reload the borrower info for the sake of reseting the flags.....
455 if ($borrowernumber) {
456 $borrower = GetMemberDetails( $borrowernumber, 0 );
459 ##################################################################################
460 # BUILD HTML
461 # show all reserves of this borrower, and the position of the reservation ....
462 if ($borrowernumber) {
463 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
464 my $waiting_holds = $holds->waiting;
465 $template->param(
466 holds_count => $holds->count(),
467 WaitingHolds => $waiting_holds,
470 $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
473 #title
474 my $flags = $borrower->{'flags'};
475 foreach my $flag ( sort keys %$flags ) {
476 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
477 if ( $flags->{$flag}->{'noissues'} ) {
478 $template->param(
479 noissues => ($force_allow_issue) ? 0 : 'true',
480 forceallow => $force_allow_issue,
482 if ( $flag eq 'GNA' ) {
483 $template->param( gna => 'true' );
485 elsif ( $flag eq 'LOST' ) {
486 $template->param( lost => 'true' );
488 elsif ( $flag eq 'DBARRED' ) {
489 $template->param( dbarred => 'true' );
491 elsif ( $flag eq 'CHARGES' ) {
492 $template->param(
493 charges => 'true',
494 chargesmsg => $flags->{'CHARGES'}->{'message'},
495 chargesamount => $flags->{'CHARGES'}->{'amount'},
496 charges_is_blocker => 1
499 elsif ( $flag eq 'CREDITS' ) {
500 $template->param(
501 credits => 'true',
502 creditsmsg => $flags->{'CREDITS'}->{'message'},
503 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
507 else {
508 if ( $flag eq 'CHARGES' ) {
509 $template->param(
510 charges => 'true',
511 chargesmsg => $flags->{'CHARGES'}->{'message'},
512 chargesamount => $flags->{'CHARGES'}->{'amount'},
515 elsif ( $flag eq 'CREDITS' ) {
516 $template->param(
517 credits => 'true',
518 creditsmsg => $flags->{'CREDITS'}->{'message'},
519 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
522 elsif ( $flag eq 'ODUES' ) {
523 $template->param(
524 odues => 'true',
525 oduesmsg => $flags->{'ODUES'}->{'message'}
528 my $items = $flags->{$flag}->{'itemlist'};
529 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
530 $template->param( nonreturns => 'true' );
533 elsif ( $flag eq 'NOTES' ) {
534 $template->param(
535 notes => 'true',
536 notesmsg => $flags->{'NOTES'}->{'message'}
542 my $amountold = $borrower->{flags} ? $borrower->{flags}->{'CHARGES'}->{'message'} || 0 : 0;
543 $amountold =~ s/^.*\$//; # remove upto the $, if any
545 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
547 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
548 my ( $catcodes, $labels ) = GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
549 my $cnt = scalar(@$catcodes);
550 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
551 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
554 my $librarian_messages = Koha::Patron::Messages->search(
556 borrowernumber => $borrowernumber,
557 message_type => 'L',
561 my $patron_messages = Koha::Patron::Messages->search(
563 borrowernumber => $borrowernumber,
564 message_type => 'B',
568 my $fast_cataloging = 0;
569 if (defined getframeworkinfo('FA')) {
570 $fast_cataloging = 1
573 if (C4::Context->preference('ExtendedPatronAttributes')) {
574 my $attributes = GetBorrowerAttributes($borrowernumber);
575 $template->param(
576 ExtendedPatronAttributes => 1,
577 extendedattributes => $attributes
580 my $view = $batch
581 ?'batch_checkout_view'
582 : 'circview';
584 my @relatives;
585 if ( $borrowernumber ) {
586 if ( my $patron = Koha::Patrons->find( $borrower->{borrowernumber} ) ) {
587 if ( my $guarantor = $patron->guarantor ) {
588 push @relatives, $guarantor->borrowernumber;
589 push @relatives, $_->borrowernumber for $patron->siblings;
590 } else {
591 push @relatives, $_->borrowernumber for $patron->guarantees;
595 my $relatives_issues_count =
596 Koha::Database->new()->schema()->resultset('Issue')
597 ->count( { borrowernumber => \@relatives } );
599 my $roadtype = C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{streettype} );
601 $template->param(%$borrower);
603 # Restore date if changed by holds and/or save stickyduedate to session
604 if ($restoreduedatespec || $stickyduedate) {
605 $duedatespec = $restoreduedatespec || $duedatespec;
607 if ($stickyduedate) {
608 $session->param( 'stickyduedate', $duedatespec );
610 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
611 undef $duedatespec;
614 $template->param(
615 librarian_messages => $librarian_messages,
616 patron_messages => $patron_messages,
617 findborrower => $findborrower,
618 borrower => $borrower,
619 borrowernumber => $borrowernumber,
620 categoryname => $borrower->{'description'},
621 branch => $branch,
622 branchname => GetBranchName($borrower->{'branchcode'}),
623 printer => $printer,
624 printername => $printer,
625 was_renewed => $query->param('was_renewed') ? 1 : 0,
626 expiry => $borrower->{'dateexpiry'},
627 roadtype => $roadtype,
628 amountold => $amountold,
629 barcodes => $barcodes,
630 stickyduedate => $stickyduedate,
631 duedatespec => $duedatespec,
632 restoreduedatespec => $restoreduedatespec,
633 message => $message,
634 totaldue => sprintf('%.2f', $total),
635 inprocess => $inprocess,
636 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
637 $view => 1,
638 batch_allowed => $batch_allowed,
639 AudioAlerts => C4::Context->preference("AudioAlerts"),
640 fast_cataloging => $fast_cataloging,
641 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
642 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
643 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
644 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
645 RoutingSerials => C4::Context->preference('RoutingSerials'),
646 relatives_issues_count => $relatives_issues_count,
647 relatives_borrowernumbers => \@relatives,
650 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
651 $template->param( picture => 1 ) if $patron_image;
653 # get authorised values with type of BOR_NOTES
655 my $canned_notes = GetAuthorisedValues("BOR_NOTES");
657 $template->param(
658 debt_confirmed => $debt_confirmed,
659 SpecifyDueDate => $duedatespec_allow,
660 CircAutocompl => C4::Context->preference("CircAutocompl"),
661 canned_bor_notes_loop => $canned_notes,
662 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
663 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
666 output_html_with_http_headers $query, $cookie, $template->output;