Bug 13264: Refactor search utf8 tests and add some more
[koha.git] / circ / circulation.pl
blob50936d7f3dbc73299ec13165cb3e8dcac6639695
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 under the
13 # terms of the GNU General Public License as published by the Free Software
14 # Foundation; either version 2 of the License, or (at your option) any later
15 # version.
17 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
18 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License along
22 # with Koha; if not, write to the Free Software Foundation, Inc.,
23 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 use strict;
26 use warnings;
27 use CGI;
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::Dates qw/format_date/;
34 use C4::Branch; # GetBranches
35 use C4::Koha; # GetPrinter
36 use C4::Circulation;
37 use C4::Members;
38 use C4::Biblio;
39 use C4::Search;
40 use MARC::Record;
41 use C4::Reserves;
42 use C4::Context;
43 use CGI::Session;
44 use C4::Members::Attributes qw(GetBorrowerAttributes);
45 use Koha::Borrower::Debarments qw(GetDebarments IsDebarred);
46 use Koha::DateUtils;
47 use Koha::Database;
49 use Date::Calc qw(
50 Today
51 Add_Delta_YM
52 Add_Delta_Days
53 Date_to_Days
55 use List::MoreUtils qw/uniq/;
59 # PARAMETERS READING
61 my $query = new CGI;
63 my $sessionID = $query->cookie("CGISESSID") ;
64 my $session = get_session($sessionID);
66 # branch and printer are now defined by the userenv
67 # but first we have to check if someone has tried to change them
69 my $branch = $query->param('branch');
70 if ($branch){
71 # update our session so the userenv is updated
72 $session->param('branch', $branch);
73 $session->param('branchname', GetBranchName($branch));
76 my $printer = $query->param('printer');
77 if ($printer){
78 # update our session so the userenv is updated
79 $session->param('branchprinter', $printer);
82 if (!C4::Context->userenv && !$branch){
83 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
84 # no branch set we can't issue
85 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
86 exit;
90 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
92 template_name => 'circ/circulation.tt',
93 query => $query,
94 type => "intranet",
95 authnotrequired => 0,
96 flagsrequired => { circulate => 'circulate_remaining_permissions' },
100 my $branches = GetBranches();
102 my $force_allow_issue = $query->param('forceallow') || 0;
103 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
104 $force_allow_issue = 0;
107 my $onsite_checkout = $query->param('onsite_checkout');
109 my @failedrenews = $query->param('failedrenew'); # expected to be itemnumbers
110 our %renew_failed = ();
111 for (@failedrenews) { $renew_failed{$_} = 1; }
113 my @failedreturns = $query->param('failedreturn');
114 our %return_failed = ();
115 for (@failedreturns) { $return_failed{$_} = 1; }
117 my $findborrower = $query->param('findborrower') || q{};
118 $findborrower =~ s|,| |g;
119 my $borrowernumber = $query->param('borrowernumber');
121 $branch = C4::Context->userenv->{'branch'};
122 $printer = C4::Context->userenv->{'branchprinter'};
125 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
126 if (C4::Context->preference("AutoLocation") != 1) {
127 $template->param(ManualLocation => 1);
130 if (C4::Context->preference("DisplayClearScreenButton")) {
131 $template->param(DisplayClearScreenButton => 1);
134 my $barcode = $query->param('barcode') || q{};
135 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
137 $barcode = barcodedecode($barcode) if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
138 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
139 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
140 my $issueconfirmed = $query->param('issueconfirmed');
141 my $cancelreserve = $query->param('cancelreserve');
142 my $print = $query->param('print') || q{};
143 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
144 my $charges = $query->param('charges') || q{};
146 # Check if stickyduedate is turned off
147 if ( $barcode ) {
148 # was stickyduedate loaded from session?
149 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
150 $session->clear( 'stickyduedate' );
151 $stickyduedate = $query->param('stickyduedate');
152 $duedatespec = $query->param('duedatespec');
154 $session->param('auto_renew', $query->param('auto_renew'));
156 else {
157 $session->clear('auto_renew');
160 my ($datedue,$invalidduedate);
162 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
163 if( $onsite_checkout ) {
164 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
165 $datedue .= ' 23:59:00';
166 } elsif( $duedatespec_allow ) {
167 if ($duedatespec) {
168 if ($duedatespec =~ C4::Dates->regexp('syspref')) {
169 $datedue = dt_from_string($duedatespec);
170 } else {
171 $invalidduedate = 1;
172 $template->param(IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec);
177 our $todaysdate = C4::Dates->new->output('iso');
179 # check and see if we should print
180 if ( $barcode eq '' && $print eq 'maybe' ) {
181 $print = 'yes';
184 my $inprocess = ($barcode eq '') ? '' : $query->param('inprocess');
185 if ( $barcode eq '' && $charges eq 'yes' ) {
186 $template->param(
187 PAYCHARGES => 'yes',
188 borrowernumber => $borrowernumber
192 if ( $print eq 'yes' && $borrowernumber ne '' ) {
193 if ( C4::Context->boolean_preference('printcirculationslips') ) {
194 my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
195 NetworkPrint($letter->{content});
197 $query->param( 'borrowernumber', '' );
198 $borrowernumber = '';
202 # STEP 2 : FIND BORROWER
203 # if there is a list of find borrowers....
205 my $borrowerslist;
206 my $message;
207 if ($findborrower) {
208 my $borrowers = Search($findborrower, 'cardnumber') || [];
209 if (C4::Context->preference("AddPatronLists")) {
210 if (C4::Context->preference("AddPatronLists")=~/code/){
211 my $categories = GetBorrowercategoryList;
212 $categories->[0]->{'first'} = 1;
213 $template->param(categories=>$categories);
216 if ( @$borrowers == 0 ) {
217 $query->param( 'findborrower', '' );
218 $message = "'$findborrower'";
220 elsif ( @$borrowers == 1 ) {
221 $borrowernumber = $borrowers->[0]->{'borrowernumber'};
222 $query->param( 'borrowernumber', $borrowernumber );
223 $query->param( 'barcode', '' );
225 else {
226 $borrowerslist = $borrowers;
230 # get the borrower information.....
231 my $borrower;
232 if ($borrowernumber) {
233 $borrower = GetMemberDetails( $borrowernumber, 0 );
234 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
236 # Warningdate is the date that the warning starts appearing
237 my ( $today_year, $today_month, $today_day) = Today();
238 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
239 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
240 # Renew day is calculated by adding the enrolment period to today
241 my ( $renew_year, $renew_month, $renew_day);
242 if ($enrol_year*$enrol_month*$enrol_day>0) {
243 ( $renew_year, $renew_month, $renew_day) =
244 Add_Delta_YM( $enrol_year, $enrol_month, $enrol_day,
245 0 , $borrower->{'enrolmentperiod'});
247 # if the expiry date is before today ie they have expired
248 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
249 || Date_to_Days($today_year, $today_month, $today_day )
250 > Date_to_Days($warning_year, $warning_month, $warning_day) )
252 #borrowercard expired, no issues
253 $template->param(
254 flagged => "1",
255 noissues => ($force_allow_issue) ? 0 : "1",
256 forceallow => $force_allow_issue,
257 expired => "1",
258 renewaldate => format_date("$renew_year-$renew_month-$renew_day")
261 # check for NotifyBorrowerDeparture
262 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
263 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
264 Date_to_Days( $today_year, $today_month, $today_day ) )
266 # borrower card soon to expire warn librarian
267 $template->param("warndeparture" => format_date($borrower->{dateexpiry}),
268 flagged => "1",);
269 if (C4::Context->preference('ReturnBeforeExpiry')){
270 $template->param("returnbeforeexpiry" => 1);
273 $template->param(
274 overduecount => $od,
275 issuecount => $issue,
276 finetotal => $fines
279 if ( IsDebarred($borrowernumber) ) {
280 $template->param(
281 'userdebarred' => $borrower->{debarred},
282 'debarredcomment' => $borrower->{debarredcomment},
285 if ( $borrower->{debarred} ne "9999-12-31" ) {
286 $template->param( 'userdebarreddate' =>
287 C4::Dates::format_date( $borrower->{debarred} ) );
294 # STEP 3 : ISSUING
297 if ($barcode) {
298 # always check for blockers on issuing
299 my ( $error, $question, $alerts ) =
300 CanBookBeIssued( $borrower, $barcode, $datedue , $inprocess );
301 my $blocker = $invalidduedate ? 1 : 0;
303 $template->param( alert => $alerts );
305 # Get the item title for more information
306 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
307 $template->param(
308 authvalcode_notforloan => C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'}),
310 # Fix for bug 7494: optional checkout-time fallback search for a book
312 if ( $error->{'UNKNOWN_BARCODE'}
313 && C4::Context->preference("itemBarcodeFallbackSearch") )
315 $template->param( FALLBACK => 1 );
317 my $query = "kw=" . $barcode;
318 my ( $searcherror, $results, $total_hits ) = SimpleSearch($query);
320 # if multiple hits, offer options to librarian
321 if ( $total_hits > 0 ) {
322 my @options = ();
323 foreach my $hit ( @{$results} ) {
324 my $chosen =
325 TransformMarcToKoha( C4::Context->dbh,
326 C4::Search::new_record_from_zebra('biblioserver',$hit) );
328 # offer all barcodes individually
329 if ( $chosen->{barcode} ) {
330 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
331 my %chosen_single = %{$chosen};
332 $chosen_single{barcode} = $barcode;
333 push( @options, \%chosen_single );
337 $template->param( options => \@options );
341 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
342 delete $question->{'DEBT'} if ($debt_confirmed);
343 foreach my $impossible ( keys %$error ) {
344 $template->param(
345 $impossible => $$error{$impossible},
346 IMPOSSIBLE => 1
348 $blocker = 1;
351 if( !$blocker || $force_allow_issue ){
352 my $confirm_required = 0;
353 unless($issueconfirmed){
354 # Get the item title for more information
355 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
356 $template->{VARS}->{'additional_materials'} = $getmessageiteminfo->{'materials'};
357 $template->param( itemhomebranch => $getmessageiteminfo->{'homebranch'} );
359 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
360 foreach my $needsconfirmation ( keys %$question ) {
361 $template->param(
362 $needsconfirmation => $$question{$needsconfirmation},
363 getTitleMessageIteminfo => $getmessageiteminfo->{'title'},
364 getBarcodeMessageIteminfo => $getmessageiteminfo->{'barcode'},
365 NEEDSCONFIRMATION => 1,
366 onsite_checkout => $onsite_checkout,
368 $confirm_required = 1;
371 unless($confirm_required) {
372 AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew') } );
373 $session->clear('auto_renew');
374 $inprocess = 1;
378 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines($borrowernumber);
379 $template->param( issuecount => $issue );
382 # reload the borrower info for the sake of reseting the flags.....
383 if ($borrowernumber) {
384 $borrower = GetMemberDetails( $borrowernumber, 0 );
387 ##################################################################################
388 # BUILD HTML
389 # show all reserves of this borrower, and the position of the reservation ....
390 if ($borrowernumber) {
391 $template->param(
392 holds_count => Koha::Database->new()->schema()->resultset('Reserve')
393 ->count( { borrowernumber => $borrowernumber } ) );
394 my @borrowerreserv = GetReservesFromBorrowernumber($borrowernumber);
396 my @WaitingReserveLoop;
397 foreach my $num_res (@borrowerreserv) {
398 if ( $num_res->{'found'} && $num_res->{'found'} eq 'W' ) {
399 my $getiteminfo = GetBiblioFromItemNumber( $num_res->{'itemnumber'} );
400 my $itemtypeinfo = getitemtypeinfo( (C4::Context->preference('item-level_itypes')) ? $getiteminfo->{'itype'} : $getiteminfo->{'itemtype'} );
401 my %getWaitingReserveInfo;
402 $getWaitingReserveInfo{title} = $getiteminfo->{'title'};
403 $getWaitingReserveInfo{biblionumber} =
404 $getiteminfo->{'biblionumber'};
405 $getWaitingReserveInfo{itemtype} = $itemtypeinfo->{'description'};
406 $getWaitingReserveInfo{author} = $getiteminfo->{'author'};
407 $getWaitingReserveInfo{itemcallnumber} =
408 $getiteminfo->{'itemcallnumber'};
409 $getWaitingReserveInfo{reservedate} =
410 format_date( $num_res->{'reservedate'} );
411 $getWaitingReserveInfo{waitingat} =
412 GetBranchName( $num_res->{'branchcode'} );
413 $getWaitingReserveInfo{waitinghere} = 1
414 if $num_res->{'branchcode'} eq $branch;
415 push( @WaitingReserveLoop, \%getWaitingReserveInfo );
418 $template->param( WaitingReserveLoop => \@WaitingReserveLoop );
419 $template->param( adultborrower => 1 )
420 if ( $borrower->{'category_type'} eq 'A' );
423 my @values;
424 my %labels;
425 my $selectborrower;
426 if ($borrowerslist) {
427 foreach (
428 sort {(lc $a->{'surname'} cmp lc $b->{'surname'} || lc $a->{'firstname'} cmp lc $b->{'firstname'})
429 } @$borrowerslist
432 push @values, $_->{'borrowernumber'};
433 $labels{ $_->{'borrowernumber'} } =
434 "$_->{'surname'}, $_->{'firstname'} ... ($_->{'cardnumber'} - $_->{'categorycode'} - $_->{'branchcode'}) ... $_->{'address'} ";
436 $selectborrower = {
437 values => \@values,
438 labels => \%labels,
442 #title
443 my $flags = $borrower->{'flags'};
444 foreach my $flag ( sort keys %$flags ) {
445 $template->param( flagged=> 1);
446 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
447 if ( $flags->{$flag}->{'noissues'} ) {
448 $template->param(
449 noissues => ($force_allow_issue) ? 0 : 'true',
450 forceallow => $force_allow_issue,
452 if ( $flag eq 'GNA' ) {
453 $template->param( gna => 'true' );
455 elsif ( $flag eq 'LOST' ) {
456 $template->param( lost => 'true' );
458 elsif ( $flag eq 'DBARRED' ) {
459 $template->param( dbarred => 'true' );
461 elsif ( $flag eq 'CHARGES' ) {
462 $template->param(
463 charges => 'true',
464 chargesmsg => $flags->{'CHARGES'}->{'message'},
465 chargesamount => $flags->{'CHARGES'}->{'amount'},
466 charges_is_blocker => 1
469 elsif ( $flag eq 'CREDITS' ) {
470 $template->param(
471 credits => 'true',
472 creditsmsg => $flags->{'CREDITS'}->{'message'},
473 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
477 else {
478 if ( $flag eq 'CHARGES' ) {
479 $template->param(
480 charges => 'true',
481 chargesmsg => $flags->{'CHARGES'}->{'message'},
482 chargesamount => $flags->{'CHARGES'}->{'amount'},
485 elsif ( $flag eq 'CREDITS' ) {
486 $template->param(
487 credits => 'true',
488 creditsmsg => $flags->{'CREDITS'}->{'message'},
489 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
492 elsif ( $flag eq 'ODUES' ) {
493 $template->param(
494 odues => 'true',
495 oduesmsg => $flags->{'ODUES'}->{'message'}
498 my $items = $flags->{$flag}->{'itemlist'};
499 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
500 $template->param( nonreturns => 'true' );
503 elsif ( $flag eq 'NOTES' ) {
504 $template->param(
505 notes => 'true',
506 notesmsg => $flags->{'NOTES'}->{'message'}
512 my $amountold = $borrower->{flags}->{'CHARGES'}->{'message'} || 0;
513 $amountold =~ s/^.*\$//; # remove upto the $, if any
515 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
517 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
518 my ( $catcodes, $labels ) = GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
519 my $cnt = scalar(@$catcodes);
520 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
521 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
524 my $lib_messages_loop = GetMessages( $borrowernumber, 'L', $branch );
525 if($lib_messages_loop){ $template->param(flagged => 1 ); }
527 my $bor_messages_loop = GetMessages( $borrowernumber, 'B', $branch );
528 if($bor_messages_loop){ $template->param(flagged => 1 ); }
530 # Computes full borrower address
531 my @fulladdress;
532 push @fulladdress, $borrower->{'streetnumber'} if ( $borrower->{'streetnumber'} );
533 push @fulladdress, C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{'streettype'} ) if ( $borrower->{'streettype'} );
534 push @fulladdress, $borrower->{'address'} if ( $borrower->{'address'} );
536 my $fast_cataloging = 0;
537 if (defined getframeworkinfo('FA')) {
538 $fast_cataloging = 1
541 if (C4::Context->preference('ExtendedPatronAttributes')) {
542 my $attributes = GetBorrowerAttributes($borrowernumber);
543 $template->param(
544 ExtendedPatronAttributes => 1,
545 extendedattributes => $attributes
549 my @relatives = GetMemberRelatives( $borrower->{'borrowernumber'} );
550 my $relatives_issues_count =
551 Koha::Database->new()->schema()->resultset('Issue')
552 ->count( { borrowernumber => \@relatives } );
554 $template->param(
555 lib_messages_loop => $lib_messages_loop,
556 bor_messages_loop => $bor_messages_loop,
557 all_messages_del => C4::Context->preference('AllowAllMessageDeletion'),
558 findborrower => $findborrower,
559 borrower => $borrower,
560 borrowernumber => $borrowernumber,
561 branch => $branch,
562 branchname => GetBranchName($borrower->{'branchcode'}),
563 printer => $printer,
564 printername => $printer,
565 firstname => $borrower->{'firstname'},
566 surname => $borrower->{'surname'},
567 showname => $borrower->{'showname'},
568 category_type => $borrower->{'category_type'},
569 was_renewed => $query->param('was_renewed') ? 1 : 0,
570 expiry => format_date($borrower->{'dateexpiry'}),
571 categorycode => $borrower->{'categorycode'},
572 categoryname => $borrower->{description},
573 address => join(' ', @fulladdress),
574 address2 => $borrower->{'address2'},
575 email => $borrower->{'email'},
576 emailpro => $borrower->{'emailpro'},
577 borrowernotes => $borrower->{'borrowernotes'},
578 city => $borrower->{'city'},
579 state => $borrower->{'state'},
580 zipcode => $borrower->{'zipcode'},
581 country => $borrower->{'country'},
582 phone => $borrower->{'phone'},
583 mobile => $borrower->{'mobile'},
584 phonepro => $borrower->{'phonepro'},
585 cardnumber => $borrower->{'cardnumber'},
586 othernames => $borrower->{'othernames'},
587 amountold => $amountold,
588 barcode => $barcode,
589 stickyduedate => $stickyduedate,
590 duedatespec => $duedatespec,
591 message => $message,
592 selectborrower => $selectborrower,
593 totaldue => sprintf('%.2f', $total),
594 inprocess => $inprocess,
595 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
596 circview => 1,
597 soundon => C4::Context->preference("SoundOn"),
598 fast_cataloging => $fast_cataloging,
599 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
600 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
601 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
602 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
603 RoutingSerials => C4::Context->preference('RoutingSerials'),
604 relatives_issues_count => $relatives_issues_count,
605 relatives_borrowernumbers => \@relatives,
608 # save stickyduedate to session
609 if ($stickyduedate) {
610 $session->param( 'stickyduedate', $duedatespec );
613 my ($picture, $dberror) = GetPatronImage($borrower->{'borrowernumber'});
614 $template->param( picture => 1 ) if $picture;
616 # get authorised values with type of BOR_NOTES
618 my $canned_notes = GetAuthorisedValues("BOR_NOTES");
620 $template->param(
621 debt_confirmed => $debt_confirmed,
622 SpecifyDueDate => $duedatespec_allow,
623 CircAutocompl => C4::Context->preference("CircAutocompl"),
624 AllowRenewalLimitOverride => C4::Context->preference("AllowRenewalLimitOverride"),
625 canned_bor_notes_loop => $canned_notes,
626 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
627 todaysdate => dt_from_string()->set(hour => 23)->set(minute => 59),
630 output_html_with_http_headers $query, $cookie, $template->output;