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
::Patron
::Messages
;
51 use Koha
::Patron
::Images
;
52 use Koha
::SearchEngine
;
53 use Koha
::SearchEngine
::Search
;
54 use Koha
::Patron
::Modifications
;
61 use List
::MoreUtils qw
/uniq/;
68 my $override_high_holds = $query->param('override_high_holds');
69 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
71 my $sessionID = $query->cookie("CGISESSID") ;
72 my $session = get_session
($sessionID);
73 if (!C4
::Context
->userenv){
74 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
75 # no branch set we can't issue
76 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
82 my $barcode = $query->param('barcode');
83 # Barcode given by user could be '0'
84 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
85 $barcodes = [ $barcode ];
87 my $filefh = $query->upload('uploadfile');
89 while ( my $content = <$filefh> ) {
90 $content =~ s/[\r\n]*$//g;
91 push @
$barcodes, $content if $content;
93 } elsif ( my $list = $query->param('barcodelist') ) {
94 push @
$barcodes, split( /\s\n/, $list );
95 $barcodes = [ map { $_ =~ /^\s*$/ ?
() : $_ } @
$barcodes ];
97 @
$barcodes = $query->multi_param('barcodes');
101 $barcodes = [ uniq @
$barcodes ];
103 my $template_name = q
|circ
/circulation
.tt
|;
104 my $borrowernumber = $query->param('borrowernumber');
105 my $borrower = $borrowernumber ? GetMember
( borrowernumber
=> $borrowernumber ) : undef;
106 my $batch = $query->param('batch');
107 my $batch_allowed = 0;
108 if ( $batch && C4
::Context
->preference('BatchCheckouts') ) {
109 $template_name = q
|circ
/circulation_batch_checkouts
.tt
|;
110 my @batch_category_codes = split '\|', C4
::Context
->preference('BatchCheckoutsValidCategories');
111 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
118 my ( $template, $loggedinuser, $cookie ) = get_template_and_user
(
120 template_name
=> $template_name,
123 authnotrequired
=> 0,
124 flagsrequired
=> { circulate
=> 'circulate_remaining_permissions' },
128 my $force_allow_issue = $query->param('forceallow') || 0;
129 if (!C4
::Auth
::haspermission
( C4
::Context
->userenv->{id
} , { circulate
=> 'force_checkout' } )) {
130 $force_allow_issue = 0;
133 my $onsite_checkout = $query->param('onsite_checkout');
135 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
136 our %renew_failed = ();
137 for (@failedrenews) { $renew_failed{$_} = 1; }
139 my @failedreturns = $query->multi_param('failedreturn');
140 our %return_failed = ();
141 for (@failedreturns) { $return_failed{$_} = 1; }
143 my $searchtype = $query->param('searchtype') || q{contain};
145 my $findborrower = $query->param('findborrower') || q{};
146 $findborrower =~ s
|,| |g
;
148 my $branch = C4
::Context
->userenv->{'branch'};
150 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
151 if (C4
::Context
->preference("AutoLocation") != 1) {
152 $template->param(ManualLocation
=> 1);
155 if (C4
::Context
->preference("DisplayClearScreenButton")) {
156 $template->param(DisplayClearScreenButton
=> 1);
159 for my $barcode ( @
$barcodes ) {
160 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
161 $barcode = barcodedecode
($barcode)
162 if( $barcode && C4
::Context
->preference('itemBarcodeInputFilter'));
165 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
166 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
167 $duedatespec = eval { output_pref
( { dt
=> dt_from_string
( $duedatespec ), dateformat
=> 'iso', timeformat
=> '24hr' }); }
169 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
170 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
171 undef $restoreduedatespec;
173 my $issueconfirmed = $query->param('issueconfirmed');
174 my $cancelreserve = $query->param('cancelreserve');
175 my $print = $query->param('print') || q{};
176 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
177 my $charges = $query->param('charges') || q{};
179 # Check if stickyduedate is turned off
181 # was stickyduedate loaded from session?
182 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
183 $session->clear( 'stickyduedate' );
184 $stickyduedate = $query->param('stickyduedate');
185 $duedatespec = $query->param('duedatespec');
187 $session->param('auto_renew', scalar $query->param('auto_renew'));
190 $session->clear('auto_renew');
193 my ($datedue,$invalidduedate);
195 my $duedatespec_allow = C4
::Context
->preference('SpecifyDueDate');
196 if( $onsite_checkout && !$duedatespec_allow ) {
197 $datedue = output_pref
({ dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' });
198 $datedue .= ' 23:59:00';
199 } elsif( $duedatespec_allow ) {
200 if ( $duedatespec ) {
201 $datedue = eval { dt_from_string
( $duedatespec ) };
204 $template->param( IMPOSSIBLE
=>1, INVALID_DATE
=>$duedatespec );
209 # check and see if we should print
210 if ( @
$barcodes == 0 && $print eq 'maybe' ) {
214 my $inprocess = (@
$barcodes == 0) ?
'' : $query->param('inprocess');
215 if ( @
$barcodes == 0 && $charges eq 'yes' ) {
218 borrowernumber
=> $borrowernumber
222 if ( $print eq 'yes' && $borrowernumber ne '' ) {
223 if ( C4
::Context
->boolean_preference('printcirculationslips') ) {
224 my $letter = IssueSlip
($branch, $borrowernumber, "QUICK");
225 NetworkPrint
($letter->{content
});
227 $query->param( 'borrowernumber', '' );
228 $borrowernumber = '';
232 # STEP 2 : FIND BORROWER
233 # if there is a list of find borrowers....
237 my $borrower = C4
::Members
::GetMember
( cardnumber
=> $findborrower );
239 $borrowernumber = $borrower->{borrowernumber
};
241 my $dt_params = { iDisplayLength
=> -1 };
242 my $results = C4
::Utils
::DataTables
::Members
::search
(
244 searchmember
=> $findborrower,
245 searchtype
=> $searchtype,
246 dt_params
=> $dt_params,
249 my $borrowers = $results->{patrons
};
250 if ( scalar @
$borrowers == 1 ) {
251 $borrowernumber = $borrowers->[0]->{borrowernumber
};
252 $query->param( 'borrowernumber', $borrowernumber );
253 $query->param( 'barcode', '' );
254 } elsif ( @
$borrowers ) {
255 $template->param( borrowers
=> $borrowers );
257 $query->param( 'findborrower', '' );
258 $message = "'$findborrower'";
263 # get the borrower information.....
264 if ($borrowernumber) {
265 $borrower = GetMemberDetails
( $borrowernumber, 0 );
266 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
( $borrowernumber );
268 # Warningdate is the date that the warning starts appearing
269 my ( $today_year, $today_month, $today_day) = Today
();
270 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
271 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
272 # if the expiry date is before today ie they have expired
273 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
274 || Date_to_Days
($today_year, $today_month, $today_day )
275 > Date_to_Days
($warning_year, $warning_month, $warning_day) )
277 #borrowercard expired, no issues
279 noissues
=> ($force_allow_issue) ?
0 : "1",
280 forceallow
=> $force_allow_issue,
284 # check for NotifyBorrowerDeparture
285 elsif ( C4
::Context
->preference('NotifyBorrowerDeparture') &&
286 Date_to_Days
(Add_Delta_Days
($warning_year,$warning_month,$warning_day,- C4
::Context
->preference('NotifyBorrowerDeparture'))) <
287 Date_to_Days
( $today_year, $today_month, $today_day ) )
289 # borrower card soon to expire warn librarian
290 $template->param( "warndeparture" => $borrower->{dateexpiry
} ,
292 if (C4
::Context
->preference('ReturnBeforeExpiry')){
293 $template->param("returnbeforeexpiry" => 1);
298 issuecount
=> $issue,
302 my $patron = Koha
::Patrons
->find( $borrowernumber );
303 if ( $patron and $patron->is_debarred ) {
305 'userdebarred' => $borrower->{debarred
},
306 'debarredcomment' => $borrower->{debarredcomment
},
309 if ( $borrower->{debarred
} ne "9999-12-31" ) {
310 $template->param( 'userdebarreddate' => $borrower->{debarred
} );
322 for my $barcode ( @
$barcodes ) {
323 my $template_params = { barcode
=> $barcode };
324 # always check for blockers on issuing
325 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued
(
331 onsite_checkout
=> $onsite_checkout,
332 override_high_holds
=> $override_high_holds || $override_high_holds_tmp || 0,
336 my $blocker = $invalidduedate ?
1 : 0;
338 $template_params->{alert
} = $alerts;
339 $template_params->{messages
} = $messages;
341 # Get the item title for more information
342 my $getmessageiteminfo = GetBiblioFromItemNumber
(undef,$barcode);
344 my $mss = Koha
::MarcSubfieldStructures
->search({ frameworkcode
=> $getmessageiteminfo->{frameworkcode
}, kohafield
=> 'items.notforloan', authorised_value
=> { not => undef } });
345 $template_params->{authvalcode_notforloan
} = $mss->count ?
$mss->next->authorised_value : undef;
347 # Fix for bug 7494: optional checkout-time fallback search for a book
349 if ( $error->{'UNKNOWN_BARCODE'}
350 && C4
::Context
->preference("itemBarcodeFallbackSearch")
354 $template_params->{FALLBACK
} = 1;
356 my $searcher = Koha
::SearchEngine
::Search
->new({index => $Koha::SearchEngine
::BIBLIOS_INDEX
});
357 my $query = "kw=" . $barcode;
358 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
360 # if multiple hits, offer options to librarian
361 if ( $total_hits > 0 ) {
363 foreach my $hit ( @
{$results} ) {
365 TransformMarcToKoha
( 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;
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 $av = Koha
::AuthorisedValues
->search_by_koha_field({ frameworkcode
=> $getmessageiteminfo->{frameworkcode
}, kohafield
=> 'items.materials', authorised_value
=> $materials });
395 $materials = $av->count ?
$av->next->lib : '';
396 $template_params->{additional_materials
} = $materials;
397 $template_params->{itemhomebranch
} = $iteminfo->{'homebranch'};
399 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
400 foreach my $needsconfirmation ( keys %$question ) {
401 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
402 $template_params->{getTitleMessageIteminfo
} = $iteminfo->{'title'};
403 $template_params->{getBarcodeMessageIteminfo
} = $iteminfo->{'barcode'};
404 $template_params->{NEEDSCONFIRMATION
} = 1;
405 $template_params->{onsite_checkout
} = $onsite_checkout;
406 $confirm_required = 1;
409 unless($confirm_required) {
410 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED
};
411 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, } );
412 $template_params->{issue
} = $issue;
413 $session->clear('auto_renew');
418 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
419 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
($borrowernumber);
421 if ($question->{RESERVE_WAITING
} or $question->{RESERVED
}){
423 reserveborrowernumber
=> $question->{'resborrowernumber'}
428 itembiblionumber
=> $getmessageiteminfo->{'biblionumber'}
433 $template_params->{issuecount
} = $issue;
436 $iteminfo->{subtitle
} = GetRecordValue
('subtitle', GetMarcBiblio
($iteminfo->{biblionumber
}), GetFrameworkCode
($iteminfo->{biblionumber
}));
437 $template_params->{item
} = $iteminfo;
439 push @
$checkout_infos, $template_params;
442 $template->param( %{$checkout_infos->[0]} );
443 $template->param( barcode
=> $barcodes->[0] );
445 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION
} } @
$checkout_infos;
447 checkout_infos
=> $checkout_infos,
448 confirmation_needed
=> $confirmation_needed,
453 # reload the borrower info for the sake of reseting the flags.....
454 if ($borrowernumber) {
455 $borrower = GetMemberDetails
( $borrowernumber, 0 );
458 ##################################################################################
460 # show all reserves of this borrower, and the position of the reservation ....
461 if ($borrowernumber) {
462 my $holds = Koha
::Holds
->search( { borrowernumber
=> $borrowernumber } );
463 my $waiting_holds = $holds->waiting;
465 holds_count
=> $holds->count(),
466 WaitingHolds
=> $waiting_holds,
469 $template->param( adultborrower
=> 1 ) if ( $borrower->{category_type
} eq 'A' || $borrower->{category_type
} eq 'I' );
473 my $flags = $borrower->{'flags'};
474 foreach my $flag ( sort keys %$flags ) {
475 $flags->{$flag}->{'message'} =~ s
#\n#<br />#g;
476 if ( $flags->{$flag}->{'noissues'} ) {
478 noissues
=> ($force_allow_issue) ?
0 : 'true',
479 forceallow
=> $force_allow_issue,
481 if ( $flag eq 'GNA' ) {
482 $template->param( gna
=> 'true' );
484 elsif ( $flag eq 'LOST' ) {
485 $template->param( lost
=> 'true' );
487 elsif ( $flag eq 'DBARRED' ) {
488 $template->param( dbarred
=> 'true' );
490 elsif ( $flag eq 'CHARGES' ) {
493 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
494 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
495 charges_is_blocker
=> 1
498 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
500 charges_guarantees
=> 'true',
501 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
502 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
503 charges_guarantees_is_blocker
=> 1
506 elsif ( $flag eq 'CREDITS' ) {
509 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
510 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
515 if ( $flag eq 'CHARGES' ) {
518 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
519 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
522 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
524 charges_guarantees
=> 'true',
525 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
526 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
529 elsif ( $flag eq 'CREDITS' ) {
532 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
533 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
536 elsif ( $flag eq 'ODUES' ) {
539 oduesmsg
=> $flags->{'ODUES'}->{'message'}
542 my $items = $flags->{$flag}->{'itemlist'};
543 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
544 $template->param( nonreturns
=> 'true' );
547 elsif ( $flag eq 'NOTES' ) {
550 notesmsg
=> $flags->{'NOTES'}->{'message'}
556 my $amountold = $borrower->{flags
} ?
$borrower->{flags
}->{'CHARGES'}->{'message'} || 0 : 0;
557 $amountold =~ s/^.*\$//; # remove upto the $, if any
559 my ( $total, $accts, $numaccts) = GetMemberAccountRecords
( $borrowernumber );
561 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
562 my $patron_categories = Koha
::Patron
::Categories
->search_limited({ category_type
=> 'A' }, {order_by
=> ['categorycode']});
563 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
564 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
567 my $librarian_messages = Koha
::Patron
::Messages
->search(
569 borrowernumber
=> $borrowernumber,
574 my $patron_messages = Koha
::Patron
::Messages
->search(
576 borrowernumber
=> $borrowernumber,
581 my $fast_cataloging = 0;
582 if (defined getframeworkinfo
('FA')) {
586 if (C4
::Context
->preference('ExtendedPatronAttributes')) {
587 my $attributes = GetBorrowerAttributes
($borrowernumber);
589 ExtendedPatronAttributes
=> 1,
590 extendedattributes
=> $attributes
594 ?
'batch_checkout_view'
598 if ( $borrowernumber ) {
599 if ( my $patron = Koha
::Patrons
->find( $borrower->{borrowernumber
} ) ) {
600 if ( my $guarantor = $patron->guarantor ) {
601 push @relatives, $guarantor->borrowernumber;
602 push @relatives, $_->borrowernumber for $patron->siblings;
604 push @relatives, $_->borrowernumber for $patron->guarantees;
608 my $relatives_issues_count =
609 Koha
::Database
->new()->schema()->resultset('Issue')
610 ->count( { borrowernumber
=> \
@relatives } );
612 my $av = Koha
::AuthorisedValues
->search({ category
=> 'ROADTYPE', authorised_value
=> $borrower->{streettype
} });
613 my $roadtype = $av->count ?
$av->next->lib : '';
615 $template->param(%$borrower);
617 # Restore date if changed by holds and/or save stickyduedate to session
618 if ($restoreduedatespec || $stickyduedate) {
619 $duedatespec = $restoreduedatespec || $duedatespec;
621 if ($stickyduedate) {
622 $session->param( 'stickyduedate', $duedatespec );
624 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
629 librarian_messages
=> $librarian_messages,
630 patron_messages
=> $patron_messages,
631 borrower
=> $borrower,
632 borrowernumber
=> $borrowernumber,
633 categoryname
=> $borrower->{'description'},
635 was_renewed
=> scalar $query->param('was_renewed') ?
1 : 0,
636 expiry
=> $borrower->{'dateexpiry'},
637 roadtype
=> $roadtype,
638 amountold
=> $amountold,
639 barcodes
=> $barcodes,
640 stickyduedate
=> $stickyduedate,
641 duedatespec
=> $duedatespec,
642 restoreduedatespec
=> $restoreduedatespec,
644 totaldue
=> sprintf('%.2f', $total),
645 inprocess
=> $inprocess,
646 is_child
=> ($borrowernumber && $borrower->{'category_type'} eq 'C'),
648 batch_allowed
=> $batch_allowed,
650 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
651 fast_cataloging
=> $fast_cataloging,
652 CircAutoPrintQuickSlip
=> C4
::Context
->preference("CircAutoPrintQuickSlip"),
653 activeBorrowerRelationship
=> (C4
::Context
->preference('borrowerRelationship') ne ''),
654 SuspendHoldsIntranet
=> C4
::Context
->preference('SuspendHoldsIntranet'),
655 AutoResumeSuspendedHolds
=> C4
::Context
->preference('AutoResumeSuspendedHolds'),
656 RoutingSerials
=> C4
::Context
->preference('RoutingSerials'),
657 relatives_issues_count
=> $relatives_issues_count,
658 relatives_borrowernumbers
=> \
@relatives,
661 my $patron_image = Koha
::Patron
::Images
->find($borrower->{borrowernumber
});
662 $template->param( picture
=> 1 ) if $patron_image;
664 my $has_modifications = Koha
::Patron
::Modifications
->search( { borrowernumber
=> $borrowernumber } )->count;
666 debt_confirmed
=> $debt_confirmed,
667 SpecifyDueDate
=> $duedatespec_allow,
668 CircAutocompl
=> C4
::Context
->preference("CircAutocompl"),
669 debarments
=> GetDebarments
({ borrowernumber
=> $borrowernumber }),
670 todaysdate
=> output_pref
( { dt
=> dt_from_string
()->set(hour
=> 23)->set(minute
=> 59), dateformat
=> 'sql' } ),
671 has_modifications
=> $has_modifications,
672 override_high_holds
=> $override_high_holds,
673 nopermission
=> scalar $query->param('nopermission'),
676 output_html_with_http_headers
$query, $cookie, $template->output;