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 AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
152 if (C4
::Context
->preference("AutoLocation") != 1) {
153 $template->param(ManualLocation
=> 1);
156 if (C4
::Context
->preference("DisplayClearScreenButton")) {
157 $template->param(DisplayClearScreenButton
=> 1);
160 for my $barcode ( @
$barcodes ) {
161 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
162 $barcode = barcodedecode
($barcode)
163 if( $barcode && C4
::Context
->preference('itemBarcodeInputFilter'));
166 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
167 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
168 $duedatespec = eval { output_pref
( { dt
=> dt_from_string
( $duedatespec ), dateformat
=> 'iso', timeformat
=> '24hr' }); }
170 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
171 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
172 undef $restoreduedatespec;
174 my $issueconfirmed = $query->param('issueconfirmed');
175 my $cancelreserve = $query->param('cancelreserve');
176 my $print = $query->param('print') || q{};
177 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
178 my $charges = $query->param('charges') || q{};
180 # Check if stickyduedate is turned off
182 # was stickyduedate loaded from session?
183 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
184 $session->clear( 'stickyduedate' );
185 $stickyduedate = $query->param('stickyduedate');
186 $duedatespec = $query->param('duedatespec');
188 $session->param('auto_renew', scalar $query->param('auto_renew'));
191 $session->clear('auto_renew');
194 my ($datedue,$invalidduedate);
196 my $duedatespec_allow = C4
::Context
->preference('SpecifyDueDate');
197 if( $onsite_checkout && !$duedatespec_allow ) {
198 $datedue = output_pref
({ dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' });
199 $datedue .= ' 23:59:00';
200 } elsif( $duedatespec_allow ) {
201 if ( $duedatespec ) {
202 $datedue = eval { dt_from_string
( $duedatespec ) };
205 $template->param( IMPOSSIBLE
=>1, INVALID_DATE
=>$duedatespec );
210 # check and see if we should print
211 if ( @
$barcodes == 0 && $print eq 'maybe' ) {
215 my $inprocess = (@
$barcodes == 0) ?
'' : $query->param('inprocess');
216 if ( @
$barcodes == 0 && $charges eq 'yes' ) {
219 borrowernumber
=> $borrowernumber
223 if ( $print eq 'yes' && $borrowernumber ne '' ) {
224 if ( C4
::Context
->boolean_preference('printcirculationslips') ) {
225 my $letter = IssueSlip
($branch, $borrowernumber, "QUICK");
226 NetworkPrint
($letter->{content
});
228 $query->param( 'borrowernumber', '' );
229 $borrowernumber = '';
233 # STEP 2 : FIND BORROWER
234 # if there is a list of find borrowers....
238 my $borrower = C4
::Members
::GetMember
( cardnumber
=> $findborrower );
240 $borrowernumber = $borrower->{borrowernumber
};
242 my $dt_params = { iDisplayLength
=> -1 };
243 my $results = C4
::Utils
::DataTables
::Members
::search
(
245 searchmember
=> $findborrower,
246 searchtype
=> $searchtype,
247 dt_params
=> $dt_params,
250 my $borrowers = $results->{patrons
};
251 if ( scalar @
$borrowers == 1 ) {
252 $borrowernumber = $borrowers->[0]->{borrowernumber
};
253 $query->param( 'borrowernumber', $borrowernumber );
254 $query->param( 'barcode', '' );
255 } elsif ( @
$borrowers ) {
256 $template->param( borrowers
=> $borrowers );
258 $query->param( 'findborrower', '' );
259 $message = "'$findborrower'";
264 # get the borrower information.....
266 if ($borrowernumber) {
267 $patron = Koha
::Patrons
->find( $borrowernumber );
268 $borrower = GetMember
( borrowernumber
=> $borrowernumber );
269 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
( $borrowernumber );
271 # if the expiry date is before today ie they have expired
272 if ( $patron->is_expired ) {
273 #borrowercard expired, no issues
275 noissues
=> ($force_allow_issue) ?
0 : "1",
276 forceallow
=> $force_allow_issue,
280 # check for NotifyBorrowerDeparture
281 elsif ( $patron->is_going_to_expire ) {
282 # borrower card soon to expire warn librarian
283 $template->param( "warndeparture" => $borrower->{dateexpiry
} ,
285 if (C4
::Context
->preference('ReturnBeforeExpiry')){
286 $template->param("returnbeforeexpiry" => 1);
291 issuecount
=> $issue,
295 if ( $patron and $patron->is_debarred ) {
297 'userdebarred' => $borrower->{debarred
},
298 'debarredcomment' => $borrower->{debarredcomment
},
301 if ( $borrower->{debarred
} ne "9999-12-31" ) {
302 $template->param( 'userdebarreddate' => $borrower->{debarred
} );
314 for my $barcode ( @
$barcodes ) {
315 my $template_params = { barcode
=> $barcode };
316 # always check for blockers on issuing
317 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued
(
323 onsite_checkout
=> $onsite_checkout,
324 override_high_holds
=> $override_high_holds || $override_high_holds_tmp || 0,
328 my $blocker = $invalidduedate ?
1 : 0;
330 $template_params->{alert
} = $alerts;
331 $template_params->{messages
} = $messages;
333 # Get the item title for more information
334 my $getmessageiteminfo = GetBiblioFromItemNumber
(undef,$barcode);
336 my $mss = Koha
::MarcSubfieldStructures
->search({ frameworkcode
=> $getmessageiteminfo->{frameworkcode
}, kohafield
=> 'items.notforloan', authorised_value
=> { not => undef } });
337 $template_params->{authvalcode_notforloan
} = $mss->count ?
$mss->next->authorised_value : undef;
339 # Fix for bug 7494: optional checkout-time fallback search for a book
341 if ( $error->{'UNKNOWN_BARCODE'}
342 && C4
::Context
->preference("itemBarcodeFallbackSearch")
346 $template_params->{FALLBACK
} = 1;
348 my $searcher = Koha
::SearchEngine
::Search
->new({index => $Koha::SearchEngine
::BIBLIOS_INDEX
});
349 my $query = "kw=" . $barcode;
350 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
352 # if multiple hits, offer options to librarian
353 if ( $total_hits > 0 ) {
355 foreach my $hit ( @
{$results} ) {
357 TransformMarcToKoha
( C4
::Search
::new_record_from_zebra
('biblioserver',$hit) );
359 # offer all barcodes individually
360 if ( $chosen->{barcode
} ) {
361 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode
}) ) {
362 my %chosen_single = %{$chosen};
363 $chosen_single{barcode
} = $barcode;
364 push( @options, \
%chosen_single );
368 $template_params->{options
} = \
@options;
372 unless( $onsite_checkout and C4
::Context
->preference("OnSiteCheckoutsForce") ) {
373 delete $question->{'DEBT'} if ($debt_confirmed);
374 foreach my $impossible ( keys %$error ) {
375 $template_params->{$impossible} = $$error{$impossible};
376 $template_params->{IMPOSSIBLE
} = 1;
380 my $iteminfo = GetBiblioFromItemNumber
(undef, $barcode);
381 if( !$blocker || $force_allow_issue ){
382 my $confirm_required = 0;
383 unless($issueconfirmed){
384 # Get the item title for more information
385 my $materials = $iteminfo->{'materials'};
386 my $descriptions = Koha
::AuthorisedValues
->get_description_by_koha_field({ frameworkcode
=> $getmessageiteminfo->{frameworkcode
}, kohafield
=> 'items.materials', authorised_value
=> $materials });
387 $materials = $descriptions->{lib
} // '';
388 $template_params->{additional_materials
} = $materials;
389 $template_params->{itemhomebranch
} = $iteminfo->{'homebranch'};
391 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
392 foreach my $needsconfirmation ( keys %$question ) {
393 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
394 $template_params->{getTitleMessageIteminfo
} = $iteminfo->{'title'};
395 $template_params->{getBarcodeMessageIteminfo
} = $iteminfo->{'barcode'};
396 $template_params->{NEEDSCONFIRMATION
} = 1;
397 $template_params->{onsite_checkout
} = $onsite_checkout;
398 $confirm_required = 1;
401 unless($confirm_required) {
402 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED
};
403 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, } );
404 $template_params->{issue
} = $issue;
405 $session->clear('auto_renew');
410 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
411 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
($borrowernumber);
413 if ($question->{RESERVE_WAITING
} or $question->{RESERVED
}){
415 reserveborrowernumber
=> $question->{'resborrowernumber'}
420 itembiblionumber
=> $getmessageiteminfo->{'biblionumber'}
425 $template_params->{issuecount
} = $issue;
428 $iteminfo->{subtitle
} = GetRecordValue
('subtitle', GetMarcBiblio
($iteminfo->{biblionumber
}), GetFrameworkCode
($iteminfo->{biblionumber
}));
429 $template_params->{item
} = $iteminfo;
431 push @
$checkout_infos, $template_params;
434 $template->param( %{$checkout_infos->[0]} );
435 $template->param( barcode
=> $barcodes->[0] );
437 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION
} } @
$checkout_infos;
439 checkout_infos
=> $checkout_infos,
440 confirmation_needed
=> $confirmation_needed,
445 # reload the borrower info for the sake of reseting the flags.....
446 if ($borrowernumber) {
447 $borrower = GetMember
( borrowernumber
=> $borrowernumber );
450 ##################################################################################
452 # show all reserves of this borrower, and the position of the reservation ....
453 if ($borrowernumber) {
454 my $holds = Koha
::Holds
->search( { borrowernumber
=> $borrowernumber } );
455 my $waiting_holds = $holds->waiting;
457 holds_count
=> $holds->count(),
458 WaitingHolds
=> $waiting_holds,
461 $template->param( adultborrower
=> 1 ) if ( $borrower->{category_type
} eq 'A' || $borrower->{category_type
} eq 'I' );
465 my $flags = $borrower ? C4
::Members
::patronflags
( $borrower ) : {};
466 foreach my $flag ( sort keys %$flags ) {
467 $flags->{$flag}->{'message'} =~ s
#\n#<br />#g;
468 if ( $flags->{$flag}->{'noissues'} ) {
470 noissues
=> ($force_allow_issue) ?
0 : 'true',
471 forceallow
=> $force_allow_issue,
473 if ( $flag eq 'GNA' ) {
474 $template->param( gna
=> 'true' );
476 elsif ( $flag eq 'LOST' ) {
477 $template->param( lost
=> 'true' );
479 elsif ( $flag eq 'DBARRED' ) {
480 $template->param( dbarred
=> 'true' );
482 elsif ( $flag eq 'CHARGES' ) {
485 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
486 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
487 charges_is_blocker
=> 1
490 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
492 charges_guarantees
=> 'true',
493 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
494 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
495 charges_guarantees_is_blocker
=> 1
498 elsif ( $flag eq 'CREDITS' ) {
501 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
502 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
507 if ( $flag eq 'CHARGES' ) {
510 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
511 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
514 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
516 charges_guarantees
=> 'true',
517 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
518 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
521 elsif ( $flag eq 'CREDITS' ) {
524 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
525 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
528 elsif ( $flag eq 'ODUES' ) {
531 oduesmsg
=> $flags->{'ODUES'}->{'message'}
534 my $items = $flags->{$flag}->{'itemlist'};
535 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
536 $template->param( nonreturns
=> 'true' );
539 elsif ( $flag eq 'NOTES' ) {
542 notesmsg
=> $flags->{'NOTES'}->{'message'}
548 my $amountold = $flags ?
$flags->{'CHARGES'}->{'message'} || 0 : 0;
549 $amountold =~ s/^.*\$//; # remove upto the $, if any
551 my ( $total, $accts, $numaccts) = GetMemberAccountRecords
( $borrowernumber );
553 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
554 my $patron_categories = Koha
::Patron
::Categories
->search_limited({ category_type
=> 'A' }, {order_by
=> ['categorycode']});
555 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
556 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
559 my $messages = Koha
::Patron
::Messages
->search(
561 'me.borrowernumber' => $borrowernumber,
565 '+select' => ['manager.surname', 'manager.firstname' ],
566 '+as' => ['manager_surname', 'manager_firstname'],
570 my $fast_cataloging = 0;
571 if ( Koha
::BiblioFrameworks
->find('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 ) {
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 $av = Koha
::AuthorisedValues
->search({ category
=> 'ROADTYPE', authorised_value
=> $borrower->{streettype
} });
602 my $roadtype = $av->count ?
$av->next->lib : '';
604 $template->param(%$borrower);
606 # Restore date if changed by holds and/or save stickyduedate to session
607 if ($restoreduedatespec || $stickyduedate) {
608 $duedatespec = $restoreduedatespec || $duedatespec;
610 if ($stickyduedate) {
611 $session->param( 'stickyduedate', $duedatespec );
613 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
619 messages
=> $messages,
620 borrower
=> $borrower,
621 borrowernumber
=> $borrowernumber,
622 categoryname
=> $borrower->{'description'},
624 was_renewed
=> scalar $query->param('was_renewed') ?
1 : 0,
625 expiry
=> $borrower->{'dateexpiry'},
626 roadtype
=> $roadtype,
627 amountold
=> $amountold,
628 barcodes
=> $barcodes,
629 stickyduedate
=> $stickyduedate,
630 duedatespec
=> $duedatespec,
631 restoreduedatespec
=> $restoreduedatespec,
633 totaldue
=> sprintf('%.2f', $total),
634 inprocess
=> $inprocess,
635 is_child
=> ($borrowernumber && $borrower->{'category_type'} eq 'C'),
637 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 my $has_modifications = Koha
::Patron
::Modifications
->search( { borrowernumber
=> $borrowernumber } )->count;
655 debt_confirmed
=> $debt_confirmed,
656 SpecifyDueDate
=> $duedatespec_allow,
657 CircAutocompl
=> C4
::Context
->preference("CircAutocompl"),
658 debarments
=> GetDebarments
({ borrowernumber
=> $borrowernumber }),
659 todaysdate
=> output_pref
( { dt
=> dt_from_string
()->set(hour
=> 23)->set(minute
=> 59), dateformat
=> 'sql' } ),
660 has_modifications
=> $has_modifications,
661 override_high_holds
=> $override_high_holds,
662 nopermission
=> scalar $query->param('nopermission'),
665 output_html_with_http_headers
$query, $cookie, $template->output;