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>.
29 use DateTime
::Duration
;
32 use C4
::Auth qw
/:DEFAULT get_session haspermission/;
33 use C4
::Branch
; # GetBranches
34 use C4
::Koha
; # GetPrinter
36 use C4
::Utils
::DataTables
::Members
;
45 use C4
::Members
::Attributes
qw(GetBorrowerAttributes);
47 use Koha
::Patron
::Debarments
qw(GetDebarments IsDebarred);
50 use Koha
::Patron
::Messages
;
51 use Koha
::Patron
::Images
;
52 use Koha
::SearchEngine
;
53 use Koha
::SearchEngine
::Search
;
60 use List
::MoreUtils qw
/uniq/;
67 my $sessionID = $query->cookie("CGISESSID") ;
68 my $session = get_session
($sessionID);
70 # branch and printer are now defined by the userenv
71 # but first we have to check if someone has tried to change them
73 my $branch = $query->param('branch');
75 # update our session so the userenv is updated
76 $session->param('branch', $branch);
77 $session->param('branchname', GetBranchName
($branch));
80 my $printer = $query->param('printer');
82 # update our session so the userenv is updated
83 $session->param('branchprinter', $printer);
86 if (!C4
::Context
->userenv && !$branch){
87 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
88 # no branch set we can't issue
89 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
95 my $barcode = $query->param('barcode');
96 # Barcode given by user could be '0'
97 if ( $barcode || $barcode eq '0' ) {
98 $barcodes = [ $barcode ];
100 my $filefh = $query->upload('uploadfile');
102 while ( my $content = <$filefh> ) {
103 $content =~ s/[\r\n]*$//g;
104 push @
$barcodes, $content if $content;
106 } elsif ( my $list = $query->param('barcodelist') ) {
107 push @
$barcodes, split( /\s\n/, $list );
108 $barcodes = [ map { $_ =~ /^\s*$/ ?
() : $_ } @
$barcodes ];
110 @
$barcodes = $query->multi_param('barcodes');
114 $barcodes = [ uniq @
$barcodes ];
116 my $template_name = q
|circ
/circulation
.tt
|;
117 my $borrowernumber = $query->param('borrowernumber');
118 my $borrower = $borrowernumber ? GetMember
( borrowernumber
=> $borrowernumber ) : undef;
119 my $batch = $query->param('batch');
120 my $batch_allowed = 0;
121 if ( $batch && C4
::Context
->preference('BatchCheckouts') ) {
122 $template_name = q
|circ
/circulation_batch_checkouts
.tt
|;
123 my @batch_category_codes = split '\|', C4
::Context
->preference('BatchCheckoutsValidCategories');
124 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
131 my ( $template, $loggedinuser, $cookie ) = get_template_and_user
(
133 template_name
=> $template_name,
136 authnotrequired
=> 0,
137 flagsrequired
=> { circulate
=> 'circulate_remaining_permissions' },
141 my $branches = GetBranches
();
143 my $force_allow_issue = $query->param('forceallow') || 0;
144 if (!C4
::Auth
::haspermission
( C4
::Context
->userenv->{id
} , { circulate
=> 'force_checkout' } )) {
145 $force_allow_issue = 0;
148 my $onsite_checkout = $query->param('onsite_checkout');
150 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
151 our %renew_failed = ();
152 for (@failedrenews) { $renew_failed{$_} = 1; }
154 my @failedreturns = $query->multi_param('failedreturn');
155 our %return_failed = ();
156 for (@failedreturns) { $return_failed{$_} = 1; }
158 my $findborrower = $query->param('findborrower') || q{};
159 $findborrower =~ s
|,| |g
;
161 $branch = C4
::Context
->userenv->{'branch'};
162 $printer = C4
::Context
->userenv->{'branchprinter'};
164 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
165 if (C4
::Context
->preference("AutoLocation") != 1) {
166 $template->param(ManualLocation
=> 1);
169 if (C4
::Context
->preference("DisplayClearScreenButton")) {
170 $template->param(DisplayClearScreenButton
=> 1);
173 for my $barcode ( @
$barcodes ) {
174 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
175 $barcode = barcodedecode
($barcode)
176 if( $barcode && C4
::Context
->preference('itemBarcodeInputFilter'));
179 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
180 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
181 $duedatespec = eval { output_pref
( { dt
=> dt_from_string
( $duedatespec ), dateformat
=> 'iso' }); }
183 my $restoreduedatespec = $query->param('restoreduedatespec') || $session->param('stickyduedate') || $duedatespec;
184 if ($restoreduedatespec eq "highholds_empty") {
185 undef $restoreduedatespec;
187 my $issueconfirmed = $query->param('issueconfirmed');
188 my $cancelreserve = $query->param('cancelreserve');
189 my $print = $query->param('print') || q{};
190 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
191 my $charges = $query->param('charges') || q{};
193 # Check if stickyduedate is turned off
195 # was stickyduedate loaded from session?
196 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
197 $session->clear( 'stickyduedate' );
198 $stickyduedate = $query->param('stickyduedate');
199 $duedatespec = $query->param('duedatespec');
201 $session->param('auto_renew', $query->param('auto_renew'));
204 $session->clear('auto_renew');
207 my ($datedue,$invalidduedate);
209 my $duedatespec_allow = C4
::Context
->preference('SpecifyDueDate');
210 if( $onsite_checkout && !$duedatespec_allow ) {
211 $datedue = output_pref
({ dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' });
212 $datedue .= ' 23:59:00';
213 } elsif( $duedatespec_allow ) {
214 if ( $duedatespec ) {
215 $datedue = eval { dt_from_string
( $duedatespec ) };
218 $template->param( IMPOSSIBLE
=>1, INVALID_DATE
=>$duedatespec );
223 # check and see if we should print
224 if ( @
$barcodes == 0 && $print eq 'maybe' ) {
228 my $inprocess = (@
$barcodes == 0) ?
'' : $query->param('inprocess');
229 if ( @
$barcodes == 0 && $charges eq 'yes' ) {
232 borrowernumber
=> $borrowernumber
236 if ( $print eq 'yes' && $borrowernumber ne '' ) {
237 if ( C4
::Context
->boolean_preference('printcirculationslips') ) {
238 my $letter = IssueSlip
($branch, $borrowernumber, "QUICK");
239 NetworkPrint
($letter->{content
});
241 $query->param( 'borrowernumber', '' );
242 $borrowernumber = '';
246 # STEP 2 : FIND BORROWER
247 # if there is a list of find borrowers....
251 my $borrower = C4
::Members
::GetMember
( cardnumber
=> $findborrower );
253 $borrowernumber = $borrower->{borrowernumber
};
255 my $dt_params = { iDisplayLength
=> -1 };
256 my $results = C4
::Utils
::DataTables
::Members
::search
(
258 searchmember
=> $findborrower,
259 searchtype
=> 'contain',
260 dt_params
=> $dt_params,
263 my $borrowers = $results->{patrons
};
264 if ( scalar @
$borrowers == 1 ) {
265 $borrowernumber = $borrowers->[0]->{borrowernumber
};
266 $query->param( 'borrowernumber', $borrowernumber );
267 $query->param( 'barcode', '' );
268 } elsif ( @
$borrowers ) {
269 $template->param( borrowers
=> $borrowers );
271 $query->param( 'findborrower', '' );
272 $message = "'$findborrower'";
277 # get the borrower information.....
278 if ($borrowernumber) {
279 $borrower = GetMemberDetails
( $borrowernumber, 0 );
280 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
( $borrowernumber );
282 # Warningdate is the date that the warning starts appearing
283 my ( $today_year, $today_month, $today_day) = Today
();
284 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
285 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
286 # if the expiry date is before today ie they have expired
287 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
288 || Date_to_Days
($today_year, $today_month, $today_day )
289 > Date_to_Days
($warning_year, $warning_month, $warning_day) )
291 #borrowercard expired, no issues
293 noissues
=> ($force_allow_issue) ?
0 : "1",
294 forceallow
=> $force_allow_issue,
298 # check for NotifyBorrowerDeparture
299 elsif ( C4
::Context
->preference('NotifyBorrowerDeparture') &&
300 Date_to_Days
(Add_Delta_Days
($warning_year,$warning_month,$warning_day,- C4
::Context
->preference('NotifyBorrowerDeparture'))) <
301 Date_to_Days
( $today_year, $today_month, $today_day ) )
303 # borrower card soon to expire warn librarian
304 $template->param( "warndeparture" => $borrower->{dateexpiry
} ,
306 if (C4
::Context
->preference('ReturnBeforeExpiry')){
307 $template->param("returnbeforeexpiry" => 1);
312 issuecount
=> $issue,
316 if ( IsDebarred
($borrowernumber) ) {
318 'userdebarred' => $borrower->{debarred
},
319 'debarredcomment' => $borrower->{debarredcomment
},
322 if ( $borrower->{debarred
} ne "9999-12-31" ) {
323 $template->param( 'userdebarreddate' => $borrower->{debarred
} );
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")
356 $template_params->{FALLBACK
} = 1;
358 my $searcher = Koha
::SearchEngine
::Search
->new({index => $Koha::SearchEngine
::BIBLIOS_INDEX
});
359 my $query = "kw=" . $barcode;
360 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
362 # if multiple hits, offer options to librarian
363 if ( $total_hits > 0 ) {
365 foreach my $hit ( @
{$results} ) {
367 TransformMarcToKoha
( 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;
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 my $materials = $iteminfo->{'materials'};
396 my $avcode = GetAuthValCode
('items.materials');
398 $materials = GetKohaAuthorisedValueLib
($avcode, $materials);
400 $template_params->{additional_materials
} = $materials;
401 $template_params->{itemhomebranch
} = $iteminfo->{'homebranch'};
403 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
404 foreach my $needsconfirmation ( keys %$question ) {
405 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
406 $template_params->{getTitleMessageIteminfo
} = $iteminfo->{'title'};
407 $template_params->{getBarcodeMessageIteminfo
} = $iteminfo->{'barcode'};
408 $template_params->{NEEDSCONFIRMATION
} = 1;
409 $template_params->{onsite_checkout
} = $onsite_checkout;
410 $confirm_required = 1;
413 unless($confirm_required) {
414 my $issue = AddIssue
( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout
=> $onsite_checkout, auto_renew
=> $session->param('auto_renew') } );
415 $template->param( issue
=> $issue );
416 $session->clear('auto_renew');
421 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
422 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
($borrowernumber);
424 if ($question->{RESERVE_WAITING
} or $question->{RESERVED
}){
426 reserveborrowernumber
=> $question->{'resborrowernumber'}
431 itembiblionumber
=> $getmessageiteminfo->{'biblionumber'}
436 $template_params->{issuecount
} = $issue;
439 $iteminfo->{subtitle
} = GetRecordValue
('subtitle', GetMarcBiblio
($iteminfo->{biblionumber
}), GetFrameworkCode
($iteminfo->{biblionumber
}));
440 $template_params->{item
} = $iteminfo;
442 push @
$checkout_infos, $template_params;
445 $template->param( %{$checkout_infos->[0]} );
446 $template->param( barcode
=> $barcodes->[0] );
448 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION
} } @
$checkout_infos;
450 checkout_infos
=> $checkout_infos,
451 confirmation_needed
=> $confirmation_needed,
456 # reload the borrower info for the sake of reseting the flags.....
457 if ($borrowernumber) {
458 $borrower = GetMemberDetails
( $borrowernumber, 0 );
461 ##################################################################################
463 # show all reserves of this borrower, and the position of the reservation ....
464 if ($borrowernumber) {
465 my $holds = Koha
::Holds
->search( { borrowernumber
=> $borrowernumber } );
466 my $waiting_holds = $holds->waiting;
468 holds_count
=> $holds->count(),
469 WaitingHolds
=> $waiting_holds,
472 $template->param( adultborrower
=> 1 ) if ( $borrower->{category_type
} eq 'A' || $borrower->{category_type
} eq 'I' );
476 my $flags = $borrower->{'flags'};
477 foreach my $flag ( sort keys %$flags ) {
478 $flags->{$flag}->{'message'} =~ s
#\n#<br />#g;
479 if ( $flags->{$flag}->{'noissues'} ) {
481 noissues
=> ($force_allow_issue) ?
0 : 'true',
482 forceallow
=> $force_allow_issue,
484 if ( $flag eq 'GNA' ) {
485 $template->param( gna
=> 'true' );
487 elsif ( $flag eq 'LOST' ) {
488 $template->param( lost
=> 'true' );
490 elsif ( $flag eq 'DBARRED' ) {
491 $template->param( dbarred
=> 'true' );
493 elsif ( $flag eq 'CHARGES' ) {
496 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
497 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
498 charges_is_blocker
=> 1
501 elsif ( $flag eq 'CREDITS' ) {
504 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
505 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
510 if ( $flag eq 'CHARGES' ) {
513 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
514 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
517 elsif ( $flag eq 'CREDITS' ) {
520 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
521 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
524 elsif ( $flag eq 'ODUES' ) {
527 oduesmsg
=> $flags->{'ODUES'}->{'message'}
530 my $items = $flags->{$flag}->{'itemlist'};
531 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
532 $template->param( nonreturns
=> 'true' );
535 elsif ( $flag eq 'NOTES' ) {
538 notesmsg
=> $flags->{'NOTES'}->{'message'}
544 my $amountold = $borrower->{flags
} ?
$borrower->{flags
}->{'CHARGES'}->{'message'} || 0 : 0;
545 $amountold =~ s/^.*\$//; # remove upto the $, if any
547 my ( $total, $accts, $numaccts) = GetMemberAccountRecords
( $borrowernumber );
549 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
550 my ( $catcodes, $labels ) = GetborCatFromCatType
( 'A', 'WHERE category_type = ?' );
551 my $cnt = scalar(@
$catcodes);
552 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
553 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
556 my $librarian_messages = Koha
::Patron
::Messages
->search(
558 borrowernumber
=> $borrowernumber,
563 my $patron_messages = Koha
::Patron
::Messages
->search(
565 borrowernumber
=> $borrowernumber,
570 my $fast_cataloging = 0;
571 if (defined getframeworkinfo
('FA')) {
575 if (C4
::Context
->preference('ExtendedPatronAttributes')) {
576 my $attributes = GetBorrowerAttributes
($borrowernumber);
578 ExtendedPatronAttributes
=> 1,
579 extendedattributes
=> $attributes
583 ?
'batch_checkout_view'
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;
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)) {
617 librarian_messages
=> $librarian_messages,
618 patron_messages
=> $patron_messages,
619 findborrower
=> $findborrower,
620 borrower
=> $borrower,
621 borrowernumber
=> $borrowernumber,
622 categoryname
=> $borrower->{'description'},
624 branchname
=> GetBranchName
($borrower->{'branchcode'}),
626 printername
=> $printer,
627 was_renewed
=> scalar $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,
636 totaldue
=> sprintf('%.2f', $total),
637 inprocess
=> $inprocess,
638 is_child
=> ($borrowernumber && $borrower->{'category_type'} eq 'C'),
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");
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;