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
;
46 use Koha
::CsvProfiles
;
48 use Koha
::Patron
::Debarments
qw(GetDebarments);
51 use Koha
::BiblioFrameworks
;
52 use Koha
::Patron
::Messages
;
53 use Koha
::Patron
::Images
;
54 use Koha
::SearchEngine
;
55 use Koha
::SearchEngine
::Search
;
56 use Koha
::Patron
::Modifications
;
63 use List
::MoreUtils qw
/uniq/;
70 my $override_high_holds = $query->param('override_high_holds');
71 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
73 my $sessionID = $query->cookie("CGISESSID") ;
74 my $session = get_session
($sessionID);
75 if (!C4
::Context
->userenv){
76 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
77 # no branch set we can't issue
78 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
84 my $barcode = $query->param('barcode');
85 # Barcode given by user could be '0'
86 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
87 $barcodes = [ $barcode ];
89 my $filefh = $query->upload('uploadfile');
91 while ( my $content = <$filefh> ) {
92 $content =~ s/[\r\n]*$//g;
93 push @
$barcodes, $content if $content;
95 } elsif ( my $list = $query->param('barcodelist') ) {
96 push @
$barcodes, split( /\s\n/, $list );
97 $barcodes = [ map { $_ =~ /^\s*$/ ?
() : $_ } @
$barcodes ];
99 @
$barcodes = $query->multi_param('barcodes');
103 $barcodes = [ uniq @
$barcodes ];
105 my $template_name = q
|circ
/circulation
.tt
|;
106 my $borrowernumber = $query->param('borrowernumber');
107 my $borrower = $borrowernumber ? GetMember
( borrowernumber
=> $borrowernumber ) : undef;
108 my $batch = $query->param('batch');
109 my $batch_allowed = 0;
110 if ( $batch && C4
::Context
->preference('BatchCheckouts') ) {
111 $template_name = q
|circ
/circulation_batch_checkouts
.tt
|;
112 my @batch_category_codes = split '\|', C4
::Context
->preference('BatchCheckoutsValidCategories');
113 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
120 my ( $template, $loggedinuser, $cookie ) = get_template_and_user
(
122 template_name
=> $template_name,
125 authnotrequired
=> 0,
126 flagsrequired
=> { circulate
=> 'circulate_remaining_permissions' },
130 my $force_allow_issue = $query->param('forceallow') || 0;
131 if (!C4
::Auth
::haspermission
( C4
::Context
->userenv->{id
} , { circulate
=> 'force_checkout' } )) {
132 $force_allow_issue = 0;
135 my $onsite_checkout = $query->param('onsite_checkout');
137 my @failedrenews = $query->multi_param('failedrenew'); # expected to be itemnumbers
138 our %renew_failed = ();
139 for (@failedrenews) { $renew_failed{$_} = 1; }
141 my @failedreturns = $query->multi_param('failedreturn');
142 our %return_failed = ();
143 for (@failedreturns) { $return_failed{$_} = 1; }
145 my $searchtype = $query->param('searchtype') || q{contain};
147 my $findborrower = $query->param('findborrower') || q{};
148 $findborrower =~ s
|,| |g
;
150 my $branch = C4
::Context
->userenv->{'branch'};
152 if (C4
::Context
->preference("DisplayClearScreenButton")) {
153 $template->param(DisplayClearScreenButton
=> 1);
156 for my $barcode ( @
$barcodes ) {
157 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
158 $barcode = barcodedecode
($barcode)
159 if( $barcode && C4
::Context
->preference('itemBarcodeInputFilter'));
162 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
163 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
164 $duedatespec = eval { output_pref
( { dt
=> dt_from_string
( $duedatespec ), dateformat
=> 'iso', timeformat
=> '24hr' }); }
166 my $restoreduedatespec = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
167 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
168 undef $restoreduedatespec;
170 my $issueconfirmed = $query->param('issueconfirmed');
171 my $cancelreserve = $query->param('cancelreserve');
172 my $print = $query->param('print') || q{};
173 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
174 my $charges = $query->param('charges') || q{};
176 # Check if stickyduedate is turned off
178 # was stickyduedate loaded from session?
179 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
180 $session->clear( 'stickyduedate' );
181 $stickyduedate = $query->param('stickyduedate');
182 $duedatespec = $query->param('duedatespec');
184 $session->param('auto_renew', scalar $query->param('auto_renew'));
187 $session->clear('auto_renew');
190 my ($datedue,$invalidduedate);
192 my $duedatespec_allow = C4
::Context
->preference('SpecifyDueDate');
193 if( $onsite_checkout && !$duedatespec_allow ) {
194 $datedue = output_pref
({ dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' });
195 $datedue .= ' 23:59:00';
196 } elsif( $duedatespec_allow ) {
197 if ( $duedatespec ) {
198 $datedue = eval { dt_from_string
( $duedatespec ) };
201 $template->param( IMPOSSIBLE
=>1, INVALID_DATE
=>$duedatespec );
206 # check and see if we should print
207 if ( @
$barcodes == 0 && $print eq 'maybe' ) {
211 my $inprocess = (@
$barcodes == 0) ?
'' : $query->param('inprocess');
212 if ( @
$barcodes == 0 && $charges eq 'yes' ) {
215 borrowernumber
=> $borrowernumber
219 if ( $print eq 'yes' && $borrowernumber ne '' ) {
220 if ( C4
::Context
->boolean_preference('printcirculationslips') ) {
221 my $letter = IssueSlip
($branch, $borrowernumber, "QUICK");
222 NetworkPrint
($letter->{content
});
224 $query->param( 'borrowernumber', '' );
225 $borrowernumber = '';
229 # STEP 2 : FIND BORROWER
230 # if there is a list of find borrowers....
234 my $borrower = C4
::Members
::GetMember
( cardnumber
=> $findborrower );
236 $borrowernumber = $borrower->{borrowernumber
};
238 my $dt_params = { iDisplayLength
=> -1 };
239 my $results = C4
::Utils
::DataTables
::Members
::search
(
241 searchmember
=> $findborrower,
242 searchtype
=> $searchtype,
243 dt_params
=> $dt_params,
246 my $borrowers = $results->{patrons
};
247 if ( scalar @
$borrowers == 1 ) {
248 $borrowernumber = $borrowers->[0]->{borrowernumber
};
249 $query->param( 'borrowernumber', $borrowernumber );
250 $query->param( 'barcode', '' );
251 } elsif ( @
$borrowers ) {
252 $template->param( borrowers
=> $borrowers );
254 $query->param( 'findborrower', '' );
255 $message = "'$findborrower'";
260 # get the borrower information.....
262 if ($borrowernumber) {
263 $patron = Koha
::Patrons
->find( $borrowernumber );
264 $borrower = GetMember
( borrowernumber
=> $borrowernumber );
265 my $overdues = $patron->get_overdues;
266 my $issues = $patron->checkouts;
267 my $balance = $patron->account->balance;
270 # if the expiry date is before today ie they have expired
271 if ( $patron->is_expired ) {
272 #borrowercard expired, no issues
274 noissues
=> ($force_allow_issue) ?
0 : "1",
275 forceallow
=> $force_allow_issue,
279 # check for NotifyBorrowerDeparture
280 elsif ( $patron->is_going_to_expire ) {
281 # borrower card soon to expire warn librarian
282 $template->param( "warndeparture" => $borrower->{dateexpiry
} ,
284 if (C4
::Context
->preference('ReturnBeforeExpiry')){
285 $template->param("returnbeforeexpiry" => 1);
289 overduecount
=> $overdues->count,
290 issuecount
=> $issues->count,
291 finetotal
=> $balance,
294 if ( $patron and $patron->is_debarred ) {
296 'userdebarred' => $borrower->{debarred
},
297 'debarredcomment' => $borrower->{debarredcomment
},
300 if ( $borrower->{debarred
} ne "9999-12-31" ) {
301 $template->param( 'userdebarreddate' => $borrower->{debarred
} );
313 for my $barcode ( @
$barcodes ) {
314 my $template_params = { barcode
=> $barcode };
315 # always check for blockers on issuing
316 my ( $error, $question, $alerts, $messages ) = CanBookBeIssued
(
322 onsite_checkout
=> $onsite_checkout,
323 override_high_holds
=> $override_high_holds || $override_high_holds_tmp || 0,
327 my $blocker = $invalidduedate ?
1 : 0;
329 $template_params->{alert
} = $alerts;
330 $template_params->{messages
} = $messages;
332 # Get the item title for more information
333 my $getmessageiteminfo = GetBiblioFromItemNumber
(undef,$barcode);
335 my $mss = Koha
::MarcSubfieldStructures
->search({ frameworkcode
=> $getmessageiteminfo->{frameworkcode
}, kohafield
=> 'items.notforloan', authorised_value
=> { not => undef } });
336 $template_params->{authvalcode_notforloan
} = $mss->count ?
$mss->next->authorised_value : undef;
338 # Fix for bug 7494: optional checkout-time fallback search for a book
340 if ( $error->{'UNKNOWN_BARCODE'}
341 && C4
::Context
->preference("itemBarcodeFallbackSearch")
345 $template_params->{FALLBACK
} = 1;
347 my $searcher = Koha
::SearchEngine
::Search
->new({index => $Koha::SearchEngine
::BIBLIOS_INDEX
});
348 my $query = "kw=" . $barcode;
349 my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
351 # if multiple hits, offer options to librarian
352 if ( $total_hits > 0 ) {
354 foreach my $hit ( @
{$results} ) {
356 TransformMarcToKoha
( C4
::Search
::new_record_from_zebra
('biblioserver',$hit) );
358 # offer all barcodes individually
359 if ( $chosen->{barcode
} ) {
360 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode
}) ) {
361 my %chosen_single = %{$chosen};
362 $chosen_single{barcode
} = $barcode;
363 push( @options, \
%chosen_single );
367 $template_params->{options
} = \
@options;
371 unless( $onsite_checkout and C4
::Context
->preference("OnSiteCheckoutsForce") ) {
372 delete $question->{'DEBT'} if ($debt_confirmed);
373 foreach my $impossible ( keys %$error ) {
374 $template_params->{$impossible} = $$error{$impossible};
375 $template_params->{IMPOSSIBLE
} = 1;
379 my $iteminfo = GetBiblioFromItemNumber
(undef, $barcode);
380 if( !$blocker || $force_allow_issue ){
381 my $confirm_required = 0;
382 unless($issueconfirmed){
383 # Get the item title for more information
384 my $materials = $iteminfo->{'materials'};
385 my $descriptions = Koha
::AuthorisedValues
->get_description_by_koha_field({ frameworkcode
=> $getmessageiteminfo->{frameworkcode
}, kohafield
=> 'items.materials', authorised_value
=> $materials });
386 $materials = $descriptions->{lib
} // '';
387 $template_params->{additional_materials
} = $materials;
388 $template_params->{itemhomebranch
} = $iteminfo->{'homebranch'};
390 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
391 foreach my $needsconfirmation ( keys %$question ) {
392 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
393 $template_params->{getTitleMessageIteminfo
} = $iteminfo->{'title'};
394 $template_params->{getBarcodeMessageIteminfo
} = $iteminfo->{'barcode'};
395 $template_params->{NEEDSCONFIRMATION
} = 1;
396 $template_params->{onsite_checkout
} = $onsite_checkout;
397 $confirm_required = 1;
400 unless($confirm_required) {
401 my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED
};
402 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, } );
403 $template_params->{issue
} = $issue;
404 $session->clear('auto_renew');
409 if ($question->{RESERVE_WAITING
} or $question->{RESERVED
}){
411 reserveborrowernumber
=> $question->{'resborrowernumber'}
416 itembiblionumber
=> $getmessageiteminfo->{'biblionumber'}
420 # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
421 $patron = Koha
::Patrons
->find( $borrowernumber );
422 $template_params->{issuecount
} = $patron->checkouts->count;
425 $iteminfo->{subtitle
} = GetRecordValue
('subtitle', GetMarcBiblio
($iteminfo->{biblionumber
}), GetFrameworkCode
($iteminfo->{biblionumber
}));
426 $template_params->{item
} = $iteminfo;
428 push @
$checkout_infos, $template_params;
431 $template->param( %{$checkout_infos->[0]} );
432 $template->param( barcode
=> $barcodes->[0] );
434 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION
} } @
$checkout_infos;
436 checkout_infos
=> $checkout_infos,
437 confirmation_needed
=> $confirmation_needed,
442 # reload the borrower info for the sake of reseting the flags.....
443 if ($borrowernumber) {
444 $borrower = GetMember
( borrowernumber
=> $borrowernumber );
447 ##################################################################################
449 # show all reserves of this borrower, and the position of the reservation ....
450 if ($borrowernumber) {
451 my $holds = Koha
::Holds
->search( { borrowernumber
=> $borrowernumber } );
452 my $waiting_holds = $holds->waiting;
454 holds_count
=> $holds->count(),
455 WaitingHolds
=> $waiting_holds,
458 $template->param( adultborrower
=> 1 ) if ( $borrower->{category_type
} eq 'A' || $borrower->{category_type
} eq 'I' );
462 my $flags = $borrower ? C4
::Members
::patronflags
( $borrower ) : {};
463 foreach my $flag ( sort keys %$flags ) {
464 $flags->{$flag}->{'message'} =~ s
#\n#<br />#g;
465 if ( $flags->{$flag}->{'noissues'} ) {
467 noissues
=> ($force_allow_issue) ?
0 : 'true',
468 forceallow
=> $force_allow_issue,
470 if ( $flag eq 'GNA' ) {
471 $template->param( gna
=> 'true' );
473 elsif ( $flag eq 'LOST' ) {
474 $template->param( lost
=> 'true' );
476 elsif ( $flag eq 'DBARRED' ) {
477 $template->param( dbarred
=> 'true' );
479 elsif ( $flag eq 'CHARGES' ) {
482 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
483 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
484 charges_is_blocker
=> 1
487 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
489 charges_guarantees
=> 'true',
490 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
491 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
492 charges_guarantees_is_blocker
=> 1
495 elsif ( $flag eq 'CREDITS' ) {
498 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
499 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
504 if ( $flag eq 'CHARGES' ) {
507 chargesmsg
=> $flags->{'CHARGES'}->{'message'},
508 chargesamount
=> $flags->{'CHARGES'}->{'amount'},
511 elsif ( $flag eq 'CHARGES_GUARANTEES' ) {
513 charges_guarantees
=> 'true',
514 chargesmsg_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'message'},
515 chargesamount_guarantees
=> $flags->{'CHARGES_GUARANTEES'}->{'amount'},
518 elsif ( $flag eq 'CREDITS' ) {
521 creditsmsg
=> $flags->{'CREDITS'}->{'message'},
522 creditsamount
=> sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
525 elsif ( $flag eq 'ODUES' ) {
528 oduesmsg
=> $flags->{'ODUES'}->{'message'}
531 my $items = $flags->{$flag}->{'itemlist'};
532 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
533 $template->param( nonreturns
=> 'true' );
536 elsif ( $flag eq 'NOTES' ) {
539 notesmsg
=> $flags->{'NOTES'}->{'message'}
545 my $amountold = $flags ?
$flags->{'CHARGES'}->{'message'} || 0 : 0;
546 $amountold =~ s/^.*\$//; # remove upto the $, if any
548 my ( $total, $accts, $numaccts) = GetMemberAccountRecords
( $borrowernumber );
550 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
551 my $patron_categories = Koha
::Patron
::Categories
->search_limited({ category_type
=> 'A' }, {order_by
=> ['categorycode']});
552 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
553 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
556 my $messages = Koha
::Patron
::Messages
->search(
558 'me.borrowernumber' => $borrowernumber,
562 '+select' => ['manager.surname', 'manager.firstname' ],
563 '+as' => ['manager_surname', 'manager_firstname'],
567 my $fast_cataloging = 0;
568 if ( Koha
::BiblioFrameworks
->find('FA') ) {
572 if (C4
::Context
->preference('ExtendedPatronAttributes')) {
573 my $attributes = GetBorrowerAttributes
($borrowernumber);
575 ExtendedPatronAttributes
=> 1,
576 extendedattributes
=> $attributes
580 ?
'batch_checkout_view'
584 if ( $borrowernumber ) {
586 if ( my $guarantor = $patron->guarantor ) {
587 push @relatives, $guarantor->borrowernumber;
588 push @relatives, $_->borrowernumber for $patron->siblings;
590 push @relatives, $_->borrowernumber for $patron->guarantees;
594 my $relatives_issues_count =
595 Koha
::Database
->new()->schema()->resultset('Issue')
596 ->count( { borrowernumber
=> \
@relatives } );
598 my $av = Koha
::AuthorisedValues
->search({ category
=> 'ROADTYPE', authorised_value
=> $borrower->{streettype
} });
599 my $roadtype = $av->count ?
$av->next->lib : '';
601 $template->param(%$borrower);
603 # Restore date if changed by holds and/or save stickyduedate to session
604 if ($restoreduedatespec || $stickyduedate) {
605 $duedatespec = $restoreduedatespec || $duedatespec;
607 if ($stickyduedate) {
608 $session->param( 'stickyduedate', $duedatespec );
610 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
616 messages
=> $messages,
617 borrower
=> $borrower,
618 borrowernumber
=> $borrowernumber,
619 categoryname
=> $borrower->{'description'},
621 was_renewed
=> scalar $query->param('was_renewed') ?
1 : 0,
622 expiry
=> $borrower->{'dateexpiry'},
623 roadtype
=> $roadtype,
624 amountold
=> $amountold,
625 barcodes
=> $barcodes,
626 stickyduedate
=> $stickyduedate,
627 duedatespec
=> $duedatespec,
628 restoreduedatespec
=> $restoreduedatespec,
630 totaldue
=> sprintf('%.2f', $total),
631 inprocess
=> $inprocess,
632 is_child
=> ($borrowernumber && $borrower->{'category_type'} eq 'C'),
634 batch_allowed
=> $batch_allowed,
636 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
637 fast_cataloging
=> $fast_cataloging,
638 CircAutoPrintQuickSlip
=> C4
::Context
->preference("CircAutoPrintQuickSlip"),
639 activeBorrowerRelationship
=> (C4
::Context
->preference('borrowerRelationship') ne ''),
640 SuspendHoldsIntranet
=> C4
::Context
->preference('SuspendHoldsIntranet'),
641 AutoResumeSuspendedHolds
=> C4
::Context
->preference('AutoResumeSuspendedHolds'),
642 RoutingSerials
=> C4
::Context
->preference('RoutingSerials'),
643 relatives_issues_count
=> $relatives_issues_count,
644 relatives_borrowernumbers
=> \
@relatives,
647 my $patron_image = Koha
::Patron
::Images
->find($borrower->{borrowernumber
});
648 $template->param( picture
=> 1 ) if $patron_image;
650 if ( C4
::Context
->preference("ExportCircHistory") ) {
651 $template->param(csv_profiles
=> [ Koha
::CsvProfiles
->search({ type
=> 'marc' }) ]);
654 my $has_modifications = Koha
::Patron
::Modifications
->search( { borrowernumber
=> $borrowernumber } )->count;
656 debt_confirmed
=> $debt_confirmed,
657 SpecifyDueDate
=> $duedatespec_allow,
658 CircAutocompl
=> C4
::Context
->preference("CircAutocompl"),
659 debarments
=> GetDebarments
({ borrowernumber
=> $borrowernumber }),
660 todaysdate
=> output_pref
( { dt
=> dt_from_string
()->set(hour
=> 23)->set(minute
=> 59), dateformat
=> 'sql' } ),
661 has_modifications
=> $has_modifications,
662 override_high_holds
=> $override_high_holds,
663 nopermission
=> scalar $query->param('nopermission'),
666 output_html_with_http_headers
$query, $cookie, $template->output;