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
::Koha
; # GetPrinter
35 use C4
::Utils
::DataTables
::Members
;
44 use C4
::Members
::Attributes
qw(GetBorrowerAttributes);
45 use Koha
::AuthorisedValues
;
47 use Koha
::Patron
::Debarments
qw(GetDebarments);
50 use Koha
::BiblioFrameworks
;
51 use Koha
::Patron
::Messages
;
52 use Koha
::Patron
::Images
;
53 use Koha
::SearchEngine
;
54 use Koha
::SearchEngine
::Search
;
55 use Koha
::Patron
::Modifications
;
62 use List
::MoreUtils qw
/uniq/;
69 my $override_high_holds = $query->param('override_high_holds');
70 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
72 my $sessionID = $query->cookie("CGISESSID") ;
73 my $session = get_session
($sessionID);
74 if (!C4
::Context
->userenv){
75 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
76 # no branch set we can't issue
77 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
83 my $barcode = $query->param('barcode');
84 # Barcode given by user could be '0'
85 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
86 $barcodes = [ $barcode ];
88 my $filefh = $query->upload('uploadfile');
90 while ( my $content = <$filefh> ) {
91 $content =~ s/[\r\n]*$//g;
92 push @
$barcodes, $content if $content;
94 } elsif ( my $list = $query->param('barcodelist') ) {
95 push @
$barcodes, split( /\s\n/, $list );
96 $barcodes = [ map { $_ =~ /^\s*$/ ?
() : $_ } @
$barcodes ];
98 @
$barcodes = $query->multi_param('barcodes');
102 $barcodes = [ uniq @
$barcodes ];
104 my $template_name = q
|circ
/circulation
.tt
|;
105 my $borrowernumber = $query->param('borrowernumber');
106 my $borrower = $borrowernumber ? GetMember
( borrowernumber
=> $borrowernumber ) : undef;
107 my $batch = $query->param('batch');
108 my $batch_allowed = 0;
109 if ( $batch && C4
::Context
->preference('BatchCheckouts') ) {
110 $template_name = q
|circ
/circulation_batch_checkouts
.tt
|;
111 my @batch_category_codes = split '\|', C4
::Context
->preference('BatchCheckoutsValidCategories');
112 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
119 my ( $template, $loggedinuser, $cookie ) = get_template_and_user
(
121 template_name
=> $template_name,
124 authnotrequired
=> 0,
125 flagsrequired
=> { circulate
=> 'circulate_remaining_permissions' },
129 my $force_allow_issue = $query->param('forceallow') || 0;
130 if (!C4
::Auth
::haspermission
( C4
::Context
->userenv->{id
} , { circulate
=> 'force_checkout' } )) {
131 $force_allow_issue = 0;
134 my $onsite_checkout = $query->param('onsite_checkout');
136 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
137 our %renew_failed = ();
138 for (@failedrenews) { $renew_failed{$_} = 1; }
140 my @failedreturns = $query->multi_param('failedreturn');
141 our %return_failed = ();
142 for (@failedreturns) { $return_failed{$_} = 1; }
144 my $searchtype = $query->param('searchtype') || q{contain};
146 my $findborrower = $query->param('findborrower') || q{};
147 $findborrower =~ s
|,| |g
;
149 my $branch = C4
::Context
->userenv->{'branch'};
151 if (C4
::Context
->preference("DisplayClearScreenButton")) {
152 $template->param(DisplayClearScreenButton
=> 1);
155 for my $barcode ( @
$barcodes ) {
156 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
157 $barcode = barcodedecode
($barcode)
158 if( $barcode && C4
::Context
->preference('itemBarcodeInputFilter'));
161 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
162 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
163 $duedatespec = eval { output_pref
( { dt
=> dt_from_string
( $duedatespec ), dateformat
=> 'iso', timeformat
=> '24hr' }); }
165 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
166 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
167 undef $restoreduedatespec;
169 my $issueconfirmed = $query->param('issueconfirmed');
170 my $cancelreserve = $query->param('cancelreserve');
171 my $print = $query->param('print') || q{};
172 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
173 my $charges = $query->param('charges') || q{};
175 # Check if stickyduedate is turned off
177 # was stickyduedate loaded from session?
178 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
179 $session->clear( 'stickyduedate' );
180 $stickyduedate = $query->param('stickyduedate');
181 $duedatespec = $query->param('duedatespec');
183 $session->param('auto_renew', scalar $query->param('auto_renew'));
186 $session->clear('auto_renew');
189 my ($datedue,$invalidduedate);
191 my $duedatespec_allow = C4
::Context
->preference('SpecifyDueDate');
192 if( $onsite_checkout && !$duedatespec_allow ) {
193 $datedue = output_pref
({ dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' });
194 $datedue .= ' 23:59:00';
195 } elsif( $duedatespec_allow ) {
196 if ( $duedatespec ) {
197 $datedue = eval { dt_from_string
( $duedatespec ) };
200 $template->param( IMPOSSIBLE
=>1, INVALID_DATE
=>$duedatespec );
205 # check and see if we should print
206 if ( @
$barcodes == 0 && $print eq 'maybe' ) {
210 my $inprocess = (@
$barcodes == 0) ?
'' : $query->param('inprocess');
211 if ( @
$barcodes == 0 && $charges eq 'yes' ) {
214 borrowernumber
=> $borrowernumber
218 if ( $print eq 'yes' && $borrowernumber ne '' ) {
219 if ( C4
::Context
->boolean_preference('printcirculationslips') ) {
220 my $letter = IssueSlip
($branch, $borrowernumber, "QUICK");
221 NetworkPrint
($letter->{content
});
223 $query->param( 'borrowernumber', '' );
224 $borrowernumber = '';
228 # STEP 2 : FIND BORROWER
229 # if there is a list of find borrowers....
233 my $borrower = C4
::Members
::GetMember
( cardnumber
=> $findborrower );
235 $borrowernumber = $borrower->{borrowernumber
};
237 my $dt_params = { iDisplayLength
=> -1 };
238 my $results = C4
::Utils
::DataTables
::Members
::search
(
240 searchmember
=> $findborrower,
241 searchtype
=> $searchtype,
242 dt_params
=> $dt_params,
245 my $borrowers = $results->{patrons
};
246 if ( scalar @
$borrowers == 1 ) {
247 $borrowernumber = $borrowers->[0]->{borrowernumber
};
248 $query->param( 'borrowernumber', $borrowernumber );
249 $query->param( 'barcode', '' );
250 } elsif ( @
$borrowers ) {
251 $template->param( borrowers
=> $borrowers );
253 $query->param( 'findborrower', '' );
254 $message = "'$findborrower'";
259 # get the borrower information.....
261 if ($borrowernumber) {
262 $patron = Koha
::Patrons
->find( $borrowernumber );
263 $borrower = GetMember
( borrowernumber
=> $borrowernumber );
264 my $overdues = $patron->get_overdues;
265 my $issues = $patron->checkouts;
266 my $balance = $patron->account->balance;
269 # if the expiry date is before today ie they have expired
270 if ( $patron->is_expired ) {
271 #borrowercard expired, no issues
273 noissues
=> ($force_allow_issue) ?
0 : "1",
274 forceallow
=> $force_allow_issue,
278 # check for NotifyBorrowerDeparture
279 elsif ( $patron->is_going_to_expire ) {
280 # borrower card soon to expire warn librarian
281 $template->param( "warndeparture" => $borrower->{dateexpiry
} ,
283 if (C4
::Context
->preference('ReturnBeforeExpiry')){
284 $template->param("returnbeforeexpiry" => 1);
288 overduecount
=> $overdues->count,
289 issuecount
=> $issues->count,
290 finetotal
=> $balance,
293 if ( $patron and $patron->is_debarred ) {
295 'userdebarred' => $borrower->{debarred
},
296 'debarredcomment' => $borrower->{debarredcomment
},
299 if ( $borrower->{debarred
} ne "9999-12-31" ) {
300 $template->param( 'userdebarreddate' => $borrower->{debarred
} );
312 for my $barcode ( @
$barcodes ) {
313 my $template_params = { barcode
=> $barcode };
314 # always check for blockers on issuing
315 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued
(
321 onsite_checkout
=> $onsite_checkout,
322 override_high_holds
=> $override_high_holds || $override_high_holds_tmp || 0,
326 my $blocker = $invalidduedate ?
1 : 0;
328 $template_params->{alert
} = $alerts;
329 $template_params->{messages
} = $messages;
331 # Get the item title for more information
332 my $getmessageiteminfo = GetBiblioFromItemNumber
(undef,$barcode);
334 my $mss = Koha
::MarcSubfieldStructures
->search({ frameworkcode
=> $getmessageiteminfo->{frameworkcode
}, kohafield
=> 'items.notforloan', authorised_value
=> { not => undef } });
335 $template_params->{authvalcode_notforloan
} = $mss->count ?
$mss->next->authorised_value : undef;
337 # Fix for bug 7494: optional checkout-time fallback search for a book
339 if ( $error->{'UNKNOWN_BARCODE'}
340 && C4
::Context
->preference("itemBarcodeFallbackSearch")
344 $template_params->{FALLBACK
} = 1;
346 my $searcher = Koha
::SearchEngine
::Search
->new({index => $Koha::SearchEngine
::BIBLIOS_INDEX
});
347 my $query = "kw=" . $barcode;
348 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
350 # if multiple hits, offer options to librarian
351 if ( $total_hits > 0 ) {
353 foreach my $hit ( @
{$results} ) {
355 TransformMarcToKoha
( C4
::Search
::new_record_from_zebra
('biblioserver',$hit) );
357 # offer all barcodes individually
358 if ( $chosen->{barcode
} ) {
359 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode
}) ) {
360 my %chosen_single = %{$chosen};
361 $chosen_single{barcode
} = $barcode;
362 push( @options, \
%chosen_single );
366 $template_params->{options
} = \
@options;
370 unless( $onsite_checkout and C4
::Context
->preference("OnSiteCheckoutsForce") ) {
371 delete $question->{'DEBT'} if ($debt_confirmed);
372 foreach my $impossible ( keys %$error ) {
373 $template_params->{$impossible} = $$error{$impossible};
374 $template_params->{IMPOSSIBLE
} = 1;
378 my $iteminfo = GetBiblioFromItemNumber
(undef, $barcode);
379 if( !$blocker || $force_allow_issue ){
380 my $confirm_required = 0;
381 unless($issueconfirmed){
382 # Get the item title for more information
383 my $materials = $iteminfo->{'materials'};
384 my $descriptions = Koha
::AuthorisedValues
->get_description_by_koha_field({ frameworkcode
=> $getmessageiteminfo->{frameworkcode
}, kohafield
=> 'items.materials', authorised_value
=> $materials });
385 $materials = $descriptions->{lib
} // '';
386 $template_params->{additional_materials
} = $materials;
387 $template_params->{itemhomebranch
} = $iteminfo->{'homebranch'};
389 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
390 foreach my $needsconfirmation ( keys %$question ) {
391 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
392 $template_params->{getTitleMessageIteminfo
} = $iteminfo->{'title'};
393 $template_params->{getBarcodeMessageIteminfo
} = $iteminfo->{'barcode'};
394 $template_params->{NEEDSCONFIRMATION
} = 1;
395 $template_params->{onsite_checkout
} = $onsite_checkout;
396 $confirm_required = 1;
399 unless($confirm_required) {
400 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED
};
401 my $issue = AddIssue
( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout
=> $onsite_checkout, auto_renew
=> $session->param('auto_renew'), switch_onsite_checkout
=> $switch_onsite_checkout, } );
402 $template_params->{issue
} = $issue;
403 $session->clear('auto_renew');
408 if ($question->{RESERVE_WAITING
} or $question->{RESERVED
}){
410 reserveborrowernumber
=> $question->{'resborrowernumber'}
415 itembiblionumber
=> $getmessageiteminfo->{'biblionumber'}
419 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
420 $patron = Koha
::Patrons
->find( $borrowernumber );
421 $template_params->{issuecount
} = $patron->checkouts->count;
424 $iteminfo->{subtitle
} = GetRecordValue
('subtitle', GetMarcBiblio
($iteminfo->{biblionumber
}), GetFrameworkCode
($iteminfo->{biblionumber
}));
425 $template_params->{item
} = $iteminfo;
427 push @
$checkout_infos, $template_params;
430 $template->param( %{$checkout_infos->[0]} );
431 $template->param( barcode
=> $barcodes->[0] );
433 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION
} } @
$checkout_infos;
435 checkout_infos
=> $checkout_infos,
436 confirmation_needed
=> $confirmation_needed,
441 # reload the borrower info for the sake of reseting the flags.....
442 if ($borrowernumber) {
443 $borrower = GetMember
( borrowernumber
=> $borrowernumber );
446 ##################################################################################
448 # show all reserves of this borrower, and the position of the reservation ....
449 if ($borrowernumber) {
450 my $holds = Koha
::Holds
->search( { borrowernumber
=> $borrowernumber } );
451 my $waiting_holds = $holds->waiting;
453 holds_count
=> $holds->count(),
454 WaitingHolds
=> $waiting_holds,
457 $template->param( adultborrower
=> 1 ) if ( $borrower->{category_type
} eq 'A' || $borrower->{category_type
} eq 'I' );
461 my $flags = $borrower ? C4
::Members
::patronflags
( $borrower ) : {};
462 foreach my $flag ( sort keys %$flags ) {
463 $flags->{$flag}->{'message'} =~ s
#\n#<br />#g;
464 if ( $flags->{$flag}->{'noissues'} ) {
466 noissues
=> ($force_allow_issue) ?
0 : 'true',
467 forceallow
=> $force_allow_issue,
469 if ( $flag eq 'GNA' ) {
470 $template->param( gna
=> 'true' );
472 elsif ( $flag eq 'LOST' ) {
473 $template->param( lost
=> 'true' );
475 elsif ( $flag eq 'DBARRED' ) {
476 $template->param( dbarred
=> 'true' );
478 elsif ( $flag eq 'CHARGES' ) {
481 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
482 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
483 charges_is_blocker
=> 1
486 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
488 charges_guarantees
=> 'true',
489 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
490 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
491 charges_guarantees_is_blocker
=> 1
494 elsif ( $flag eq 'CREDITS' ) {
497 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
498 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
503 if ( $flag eq 'CHARGES' ) {
506 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
507 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
510 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
512 charges_guarantees
=> 'true',
513 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
514 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'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 = $flags ?
$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 $patron_categories = Koha
::Patron
::Categories
->search_limited({ category_type
=> 'A' }, {order_by
=> ['categorycode']});
551 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
552 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
555 my $messages = Koha
::Patron
::Messages
->search(
557 'me.borrowernumber' => $borrowernumber,
561 '+select' => ['manager.surname', 'manager.firstname' ],
562 '+as' => ['manager_surname', 'manager_firstname'],
566 my $fast_cataloging = 0;
567 if ( Koha
::BiblioFrameworks
->find('FA') ) {
571 if (C4
::Context
->preference('ExtendedPatronAttributes')) {
572 my $attributes = GetBorrowerAttributes
($borrowernumber);
574 ExtendedPatronAttributes
=> 1,
575 extendedattributes
=> $attributes
579 ?
'batch_checkout_view'
583 if ( $borrowernumber ) {
585 if ( my $guarantor = $patron->guarantor ) {
586 push @relatives, $guarantor->borrowernumber;
587 push @relatives, $_->borrowernumber for $patron->siblings;
589 push @relatives, $_->borrowernumber for $patron->guarantees;
593 my $relatives_issues_count =
594 Koha
::Database
->new()->schema()->resultset('Issue')
595 ->count( { borrowernumber
=> \
@relatives } );
597 my $av = Koha
::AuthorisedValues
->search({ category
=> 'ROADTYPE', authorised_value
=> $borrower->{streettype
} });
598 my $roadtype = $av->count ?
$av->next->lib : '';
600 $template->param(%$borrower);
602 # Restore date if changed by holds and/or save stickyduedate to session
603 if ($restoreduedatespec || $stickyduedate) {
604 $duedatespec = $restoreduedatespec || $duedatespec;
606 if ($stickyduedate) {
607 $session->param( 'stickyduedate', $duedatespec );
609 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
615 messages
=> $messages,
616 borrower
=> $borrower,
617 borrowernumber
=> $borrowernumber,
618 categoryname
=> $borrower->{'description'},
620 was_renewed
=> scalar $query->param('was_renewed') ?
1 : 0,
621 expiry
=> $borrower->{'dateexpiry'},
622 roadtype
=> $roadtype,
623 amountold
=> $amountold,
624 barcodes
=> $barcodes,
625 stickyduedate
=> $stickyduedate,
626 duedatespec
=> $duedatespec,
627 restoreduedatespec
=> $restoreduedatespec,
629 totaldue
=> sprintf('%.2f', $total),
630 inprocess
=> $inprocess,
631 is_child
=> ($borrowernumber && $borrower->{'category_type'} eq 'C'),
633 batch_allowed
=> $batch_allowed,
635 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
636 fast_cataloging
=> $fast_cataloging,
637 CircAutoPrintQuickSlip
=> C4
::Context
->preference("CircAutoPrintQuickSlip"),
638 activeBorrowerRelationship
=> (C4
::Context
->preference('borrowerRelationship') ne ''),
639 SuspendHoldsIntranet
=> C4
::Context
->preference('SuspendHoldsIntranet'),
640 AutoResumeSuspendedHolds
=> C4
::Context
->preference('AutoResumeSuspendedHolds'),
641 RoutingSerials
=> C4
::Context
->preference('RoutingSerials'),
642 relatives_issues_count
=> $relatives_issues_count,
643 relatives_borrowernumbers
=> \
@relatives,
646 my $patron_image = Koha
::Patron
::Images
->find($borrower->{borrowernumber
});
647 $template->param( picture
=> 1 ) if $patron_image;
649 my $has_modifications = Koha
::Patron
::Modifications
->search( { borrowernumber
=> $borrowernumber } )->count;
651 debt_confirmed
=> $debt_confirmed,
652 SpecifyDueDate
=> $duedatespec_allow,
653 CircAutocompl
=> C4
::Context
->preference("CircAutocompl"),
654 debarments
=> GetDebarments
({ borrowernumber
=> $borrowernumber }),
655 todaysdate
=> output_pref
( { dt
=> dt_from_string
()->set(hour
=> 23)->set(minute
=> 59), dateformat
=> 'sql' } ),
656 has_modifications
=> $has_modifications,
657 override_high_holds
=> $override_high_holds,
658 nopermission
=> scalar $query->param('nopermission'),
661 output_html_with_http_headers
$query, $cookie, $template->output;