1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 #use warnings; FIXME - Bug 2505
33 use C4::ItemCirculationAlertPreference;
36 use C4::Log; # logaction
37 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
38 use C4::RotatingCollections qw(GetCollectionItemBranches);
39 use Algorithm::CheckDigits;
43 use Koha::AuthorisedValues;
44 use Koha::Biblioitems;
48 use Koha::IssuingRules;
51 use Koha::Patron::Debarments;
55 use Koha::RefundLostItemFeeRule;
56 use Koha::RefundLostItemFeeRules;
57 use Koha::Account::Lines;
58 use Koha::Account::Offsets;
60 use List::MoreUtils qw( uniq );
61 use Scalar::Util qw( looks_like_number );
71 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
77 # FIXME subs that should probably be elsewhere
82 &GetPendingOnSiteCheckouts
85 # subs to deal with issuing a book
93 &GetLatestAutoRenewDate
95 &GetBranchBorrowerCircRule
99 &CheckIfIssuedToPatron
104 # subs to deal with returns
110 # subs to deal with transfers
117 &IsBranchTransferAllowed
118 &CreateBranchTransferLimit
119 &DeleteBranchTransferLimits
123 # subs to deal with offline circulation
125 &GetOfflineOperations
128 &DeleteOfflineOperation
129 &ProcessOfflineOperation
135 C4::Circulation - Koha circulation module
143 The functions in this module deal with circulation, issues, and
144 returns, as well as general information about the library.
145 Also deals with inventory.
151 $str = &barcodedecode($barcode, [$filter]);
153 Generic filter function for barcode string.
154 Called on every circ if the System Pref itemBarcodeInputFilter is set.
155 Will do some manipulation of the barcode for systems that deliver a barcode
156 to circulation.pl that differs from the barcode stored for the item.
157 For proper functioning of this filter, calling the function on the
158 correct barcode string (items.barcode) should return an unaltered barcode.
160 The optional $filter argument is to allow for testing or explicit
161 behavior that ignores the System Pref. Valid values are the same as the
166 # FIXME -- the &decode fcn below should be wrapped into this one.
167 # FIXME -- these plugins should be moved out of Circulation.pm
170 my ($barcode, $filter) = @_;
171 my $branch = C4::Context::mybranch();
172 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
173 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
174 if ($filter eq 'whitespace') {
176 } elsif ($filter eq 'cuecat') {
178 my @fields = split( /\./, $barcode );
179 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
180 ($#results == 2) and return $results[2];
181 } elsif ($filter eq 'T-prefix') {
182 if ($barcode =~ /^[Tt](\d)/) {
183 (defined($1) and $1 eq '0') and return $barcode;
184 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
186 return sprintf("T%07d", $barcode);
187 # FIXME: $barcode could be "T1", causing warning: substr outside of string
188 # Why drop the nonzero digit after the T?
189 # Why pass non-digits (or empty string) to "T%07d"?
190 } elsif ($filter eq 'libsuite8') {
191 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
192 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
193 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
195 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
198 } elsif ($filter eq 'EAN13') {
199 my $ean = CheckDigits('ean');
200 if ( $ean->is_valid($barcode) ) {
201 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
202 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
204 warn "# [$barcode] not valid EAN-13/UPC-A\n";
207 return $barcode; # return barcode, modified or not
212 $str = &decode($chunk);
214 Decodes a segment of a string emitted by a CueCat barcode scanner and
217 FIXME: Should be replaced with Barcode::Cuecat from CPAN
218 or Javascript based decoding on the client side.
225 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
226 my @s = map { index( $seq, $_ ); } split( //, $encoded );
227 my $l = ( $#s + 1 ) % 4;
230 # warn "Error: Cuecat decode parsing failed!";
238 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
240 chr( ( $n >> 16 ) ^ 67 )
241 .chr( ( $n >> 8 & 255 ) ^ 67 )
242 .chr( ( $n & 255 ) ^ 67 );
245 $r = substr( $r, 0, length($r) - $l );
251 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
252 $barcode, $ignore_reserves);
254 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
256 C<$newbranch> is the code for the branch to which the item should be transferred.
258 C<$barcode> is the barcode of the item to be transferred.
260 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
261 Otherwise, if an item is reserved, the transfer fails.
263 Returns three values:
269 is true if the transfer was successful.
273 is a reference-to-hash which may have any of the following keys:
279 There is no item in the catalog with the given barcode. The value is C<$barcode>.
281 =item C<DestinationEqualsHolding>
283 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
287 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
291 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
293 =item C<WasTransferred>
295 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
304 my ( $tbr, $barcode, $ignoreRs ) = @_;
307 my $item = Koha::Items->find( { barcode => $barcode } );
311 $messages->{'BadBarcode'} = $barcode;
315 my $itemnumber = $item->itemnumber;
316 my $issue = GetOpenIssue($itemnumber);
317 # get branches of book...
318 my $hbr = $item->homebranch;
319 my $fbr = $item->holdingbranch;
321 # if using Branch Transfer Limits
322 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
323 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
324 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
325 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
326 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
329 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
330 $messages->{'NotAllowed'} = $tbr . "::" . $code;
335 # can't transfer book if is already there....
336 if ( $fbr eq $tbr ) {
337 $messages->{'DestinationEqualsHolding'} = 1;
341 # check if it is still issued to someone, return it...
343 AddReturn( $barcode, $fbr );
344 $messages->{'WasReturned'} = $issue->borrowernumber;
348 # That'll save a database query.
349 my ( $resfound, $resrec, undef ) =
350 CheckReserves( $itemnumber );
351 if ( $resfound and not $ignoreRs ) {
352 $resrec->{'ResFound'} = $resfound;
354 # $messages->{'ResFound'} = $resrec;
358 #actually do the transfer....
360 ModItemTransfer( $itemnumber, $fbr, $tbr );
362 # don't need to update MARC anymore, we do it in batch now
363 $messages->{'WasTransfered'} = 1;
366 ModDateLastSeen( $itemnumber );
367 return ( $dotransfer, $messages );
372 my $borrower = shift;
373 my $biblionumber = shift;
376 my $onsite_checkout = $params->{onsite_checkout} || 0;
377 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
378 my $cat_borrower = $borrower->{'categorycode'};
379 my $dbh = C4::Context->dbh;
381 # Get which branchcode we need
382 $branch = _GetCircControlBranch($item,$borrower);
383 my $type = (C4::Context->preference('item-level_itypes'))
384 ? $item->{'itype'} # item-level
385 : $item->{'itemtype'}; # biblio-level
387 # given branch, patron category, and item type, determine
388 # applicable issuing rule
389 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
390 { categorycode => $cat_borrower,
392 branchcode => $branch
397 # if a rule is found and has a loan limit set, count
398 # how many loans the patron already has that meet that
400 if (defined($issuing_rule) and defined($issuing_rule->maxissueqty)) {
403 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
405 JOIN items USING (itemnumber)
408 my $rule_itemtype = $issuing_rule->itemtype;
409 if ($rule_itemtype eq "*") {
410 # matching rule has the default item type, so count only
411 # those existing loans that don't fall under a more
413 if (C4::Context->preference('item-level_itypes')) {
414 $count_query .= " WHERE items.itype NOT IN (
415 SELECT itemtype FROM issuingrules
417 AND (categorycode = ? OR categorycode = ?)
421 $count_query .= " JOIN biblioitems USING (biblionumber)
422 WHERE biblioitems.itemtype NOT IN (
423 SELECT itemtype FROM issuingrules
425 AND (categorycode = ? OR categorycode = ?)
429 push @bind_params, $issuing_rule->branchcode;
430 push @bind_params, $issuing_rule->categorycode;
431 push @bind_params, $cat_borrower;
433 # rule has specific item type, so count loans of that
435 if (C4::Context->preference('item-level_itypes')) {
436 $count_query .= " WHERE items.itype = ? ";
438 $count_query .= " JOIN biblioitems USING (biblionumber)
439 WHERE biblioitems.itemtype= ? ";
441 push @bind_params, $type;
444 $count_query .= " AND borrowernumber = ? ";
445 push @bind_params, $borrower->{'borrowernumber'};
446 my $rule_branch = $issuing_rule->branchcode;
447 if ($rule_branch ne "*") {
448 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
449 $count_query .= " AND issues.branchcode = ? ";
450 push @bind_params, $branch;
451 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
452 ; # if branch is the patron's home branch, then count all loans by patron
454 $count_query .= " AND items.homebranch = ? ";
455 push @bind_params, $branch;
459 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
461 my $max_checkouts_allowed = $issuing_rule->maxissueqty;
462 my $max_onsite_checkouts_allowed = $issuing_rule->maxonsiteissueqty;
464 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
465 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
467 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
468 count => $onsite_checkout_count,
469 max_allowed => $max_onsite_checkouts_allowed,
473 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
474 my $delta = $switch_onsite_checkout ? 1 : 0;
475 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
477 reason => 'TOO_MANY_CHECKOUTS',
478 count => $checkout_count,
479 max_allowed => $max_checkouts_allowed,
482 } elsif ( not $onsite_checkout ) {
483 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
485 reason => 'TOO_MANY_CHECKOUTS',
486 count => $checkout_count - $onsite_checkout_count,
487 max_allowed => $max_checkouts_allowed,
493 # Now count total loans against the limit for the branch
494 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
495 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
496 my @bind_params = ();
497 my $branch_count_query = q|
498 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
500 JOIN items USING (itemnumber)
501 WHERE borrowernumber = ?
503 push @bind_params, $borrower->{borrowernumber};
505 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
506 $branch_count_query .= " AND issues.branchcode = ? ";
507 push @bind_params, $branch;
508 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
509 ; # if branch is the patron's home branch, then count all loans by patron
511 $branch_count_query .= " AND items.homebranch = ? ";
512 push @bind_params, $branch;
514 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
515 my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty};
516 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty};
518 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
519 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
521 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
522 count => $onsite_checkout_count,
523 max_allowed => $max_onsite_checkouts_allowed,
527 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
528 my $delta = $switch_onsite_checkout ? 1 : 0;
529 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
531 reason => 'TOO_MANY_CHECKOUTS',
532 count => $checkout_count,
533 max_allowed => $max_checkouts_allowed,
536 } elsif ( not $onsite_checkout ) {
537 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
539 reason => 'TOO_MANY_CHECKOUTS',
540 count => $checkout_count - $onsite_checkout_count,
541 max_allowed => $max_checkouts_allowed,
547 if ( not defined( $issuing_rule ) and not defined($branch_borrower_circ_rule->{maxissueqty}) ) {
548 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
551 # OK, the patron can issue !!!
555 =head2 CanBookBeIssued
557 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
558 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
560 Check if a book can be issued.
562 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
564 IMPORTANT: The assumption by users of this routine is that causes blocking
565 the issue are keyed by uppercase labels and other returned
566 data is keyed in lower case!
570 =item C<$patron> is a Koha::Patron
572 =item C<$barcode> is the bar code of the book being issued.
574 =item C<$duedates> is a DateTime object.
576 =item C<$inprocess> boolean switch
578 =item C<$ignore_reserves> boolean switch
580 =item C<$params> Hashref of additional parameters
583 override_high_holds - Ignore high holds
584 onsite_checkout - Checkout is an onsite checkout that will not leave the library
592 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
593 Possible values are :
599 sticky due date is invalid
603 borrower gone with no address
607 borrower declared it's card lost
613 =head3 UNKNOWN_BARCODE
627 item is restricted (set by ??)
629 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
630 could be prevented, but ones that can be overriden by the operator.
632 Possible values are :
640 renewing, not issuing
642 =head3 ISSUED_TO_ANOTHER
644 issued to someone else.
648 reserved for someone else.
652 sticky due date is invalid or due date in the past
656 if the borrower borrows to much things
660 sub CanBookBeIssued {
661 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
662 my %needsconfirmation; # filled with problems that needs confirmations
663 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
664 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
665 my %messages; # filled with information messages that should be displayed.
667 my $onsite_checkout = $params->{onsite_checkout} || 0;
668 my $override_high_holds = $params->{override_high_holds} || 0;
670 my $item = GetItem(undef, $barcode );
671 my $issue = Koha::Checkouts->find( { itemnumber => $item->{itemnumber} } );
672 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
673 $item->{'itemtype'}=$item->{'itype'};
674 my $dbh = C4::Context->dbh;
675 my $patron_unblessed = $patron->unblessed;
677 # MANDATORY CHECKS - unless item exists, nothing else matters
678 unless ( $item->{barcode} ) {
679 $issuingimpossible{UNKNOWN_BARCODE} = 1;
681 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
684 # DUE DATE is OK ? -- should already have checked.
686 if ($duedate && ref $duedate ne 'DateTime') {
687 $duedate = dt_from_string($duedate);
689 my $now = DateTime->now( time_zone => C4::Context->tz() );
690 unless ( $duedate ) {
691 my $issuedate = $now->clone();
693 my $branch = _GetCircControlBranch($item, $patron_unblessed);
694 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
695 $duedate = CalcDateDue( $issuedate, $itype, $branch, $patron_unblessed );
697 # Offline circ calls AddIssue directly, doesn't run through here
698 # So issuingimpossible should be ok.
701 my $today = $now->clone();
702 $today->truncate( to => 'minute');
703 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
704 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
707 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
713 if ( $patron->category->category_type eq 'X' && ( $item->{barcode} )) {
714 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
716 branch => C4::Context->userenv->{'branch'},
718 itemnumber => $item->{'itemnumber'},
719 itemtype => $item->{'itype'},
720 borrowernumber => $patron->borrowernumber,
721 ccode => $item->{'ccode'}}
723 ModDateLastSeen( $item->{'itemnumber'} );
724 return( { STATS => 1 }, {});
727 my $flags = C4::Members::patronflags( $patron_unblessed );
729 if ( $flags->{GNA} ) {
730 $issuingimpossible{GNA} = 1;
732 if ( $flags->{'LOST'} ) {
733 $issuingimpossible{CARD_LOST} = 1;
735 if ( $flags->{'DBARRED'} ) {
736 $issuingimpossible{DEBARRED} = 1;
740 if ( $patron->is_expired ) {
741 $issuingimpossible{EXPIRED} = 1;
749 my ($balance, $non_issue_charges, $other_charges) =
750 C4::Members::GetMemberAccountBalance( $patron->borrowernumber );
752 my $amountlimit = C4::Context->preference("noissuescharge");
753 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
754 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
756 # Check the debt of this patrons guarantees
757 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
758 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
759 if ( defined $no_issues_charge_guarantees ) {
760 my @guarantees = $patron->guarantees();
761 my $guarantees_non_issues_charges;
762 foreach my $g ( @guarantees ) {
763 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
764 $guarantees_non_issues_charges += $n;
767 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
768 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
769 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
770 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
771 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
772 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
776 if ( C4::Context->preference("IssuingInProcess") ) {
777 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
778 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
779 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
780 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
781 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
782 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
786 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
787 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
788 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
789 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
790 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
791 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
795 if ($balance > 0 && $other_charges > 0) {
796 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
799 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
800 $patron_unblessed = $patron->unblessed;
802 if ( my $debarred_date = $patron->is_debarred ) {
803 # patron has accrued fine days or has a restriction. $count is a date
804 if ($debarred_date eq '9999-12-31') {
805 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
808 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
810 } elsif ( my $num_overdues = $patron->has_overdues ) {
811 ## patron has outstanding overdue loans
812 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
813 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
815 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
816 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
821 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
823 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
825 # Already issued to current borrower.
826 # If it is an on-site checkout if it can be switched to a normal checkout
827 # or ask whether the loan should be renewed
829 if ( $issue->onsite_checkout
830 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
831 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
833 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
834 $patron->borrowernumber,
835 $item->{'itemnumber'},
837 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
838 if ( $renewerror eq 'onsite_checkout' ) {
839 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
842 $issuingimpossible{NO_MORE_RENEWALS} = 1;
846 $needsconfirmation{RENEW_ISSUE} = 1;
852 # issued to someone else
854 my $patron = Koha::Patrons->find( $issue->borrowernumber );
856 my ( $can_be_returned, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
858 unless ( $can_be_returned ) {
859 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
860 $issuingimpossible{branch_to_return} = $message;
862 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
863 $needsconfirmation{issued_firstname} = $patron->firstname;
864 $needsconfirmation{issued_surname} = $patron->surname;
865 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
866 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
870 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
872 my $switch_onsite_checkout = (
873 C4::Context->preference('SwitchOnSiteCheckouts')
875 and $issue->onsite_checkout
876 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
877 my $toomany = TooMany( $patron_unblessed, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
878 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
879 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
880 if ( $toomany->{max_allowed} == 0 ) {
881 $needsconfirmation{PATRON_CANT} = 1;
883 if ( C4::Context->preference("AllowTooManyOverride") ) {
884 $needsconfirmation{TOO_MANY} = $toomany->{reason};
885 $needsconfirmation{current_loan_count} = $toomany->{count};
886 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
888 $issuingimpossible{TOO_MANY} = $toomany->{reason};
889 $issuingimpossible{current_loan_count} = $toomany->{count};
890 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
895 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
897 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
898 my $wants_check = $patron->wants_check_for_previous_checkout;
899 $needsconfirmation{PREVISSUE} = 1
900 if ($wants_check and $patron->do_check_for_previous_checkout($item));
905 if ( $item->{'notforloan'} )
907 if(!C4::Context->preference("AllowNotForLoanOverride")){
908 $issuingimpossible{NOT_FOR_LOAN} = 1;
909 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
911 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
912 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
916 # we have to check itemtypes.notforloan also
917 if (C4::Context->preference('item-level_itypes')){
918 # this should probably be a subroutine
919 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
920 $sth->execute($item->{'itemtype'});
921 my $notforloan=$sth->fetchrow_hashref();
922 if ($notforloan->{'notforloan'}) {
923 if (!C4::Context->preference("AllowNotForLoanOverride")) {
924 $issuingimpossible{NOT_FOR_LOAN} = 1;
925 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
927 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
928 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
932 elsif ($biblioitem->{'notforloan'} == 1){
933 if (!C4::Context->preference("AllowNotForLoanOverride")) {
934 $issuingimpossible{NOT_FOR_LOAN} = 1;
935 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
937 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
938 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
942 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
944 $issuingimpossible{WTHDRAWN} = 1;
946 if ( $item->{'restricted'}
947 && $item->{'restricted'} == 1 )
949 $issuingimpossible{RESTRICTED} = 1;
951 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
952 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->{itemlost} });
953 my $code = $av->count ? $av->next->lib : '';
954 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
955 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
957 if ( C4::Context->preference("IndependentBranches") ) {
958 my $userenv = C4::Context->userenv;
959 unless ( C4::Context->IsSuperLibrarian() ) {
960 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
961 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
962 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
964 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
965 if ( $patron->branchcode ne $userenv->{branch} );
969 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
971 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
973 if ( $rentalConfirmation ){
974 my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $patron->borrowernumber );
975 if ( $rentalCharge > 0 ){
976 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
980 unless ( $ignore_reserves ) {
981 # See if the item is on reserve.
982 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
984 my $resbor = $res->{'borrowernumber'};
985 if ( $resbor ne $patron->borrowernumber ) {
986 my $patron = Koha::Patrons->find( $resbor );
987 if ( $restype eq "Waiting" )
989 # The item is on reserve and waiting, but has been
990 # reserved by some other patron.
991 $needsconfirmation{RESERVE_WAITING} = 1;
992 $needsconfirmation{'resfirstname'} = $patron->firstname;
993 $needsconfirmation{'ressurname'} = $patron->surname;
994 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
995 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
996 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
997 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
999 elsif ( $restype eq "Reserved" ) {
1000 # The item is on reserve for someone else.
1001 $needsconfirmation{RESERVED} = 1;
1002 $needsconfirmation{'resfirstname'} = $patron->firstname;
1003 $needsconfirmation{'ressurname'} = $patron->surname;
1004 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1005 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1006 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1007 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1013 ## CHECK AGE RESTRICTION
1014 my $agerestriction = $biblioitem->{'agerestriction'};
1015 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1016 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1017 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1018 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1021 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1025 ## check for high holds decreasing loan period
1026 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1027 my $check = checkHighHolds( $item, $patron_unblessed );
1029 if ( $check->{exceeded} ) {
1030 if ($override_high_holds) {
1031 $alerts{HIGHHOLDS} = {
1032 num_holds => $check->{outstanding},
1033 duration => $check->{duration},
1034 returndate => output_pref( $check->{due_date} ),
1038 $needsconfirmation{HIGHHOLDS} = {
1039 num_holds => $check->{outstanding},
1040 duration => $check->{duration},
1041 returndate => output_pref( $check->{due_date} ),
1048 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1049 # don't do the multiple loans per bib check if we've
1050 # already determined that we've got a loan on the same item
1051 !$issuingimpossible{NO_MORE_RENEWALS} &&
1052 !$needsconfirmation{RENEW_ISSUE}
1054 # Check if borrower has already issued an item from the same biblio
1055 # Only if it's not a subscription
1056 my $biblionumber = $item->{biblionumber};
1057 require C4::Serials;
1058 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1059 unless ($is_a_subscription) {
1060 # FIXME Should be $patron->checkouts($args);
1061 my $checkouts = Koha::Checkouts->search(
1063 borrowernumber => $patron->borrowernumber,
1064 biblionumber => $biblionumber,
1070 # if we get here, we don't already have a loan on this item,
1071 # so if there are any loans on this bib, ask for confirmation
1072 if ( $checkouts->count ) {
1073 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1078 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1081 =head2 CanBookBeReturned
1083 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1085 Check whether the item can be returned to the provided branch
1089 =item C<$item> is a hash of item information as returned from GetItem
1091 =item C<$branch> is the branchcode where the return is taking place
1099 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1101 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1107 sub CanBookBeReturned {
1108 my ($item, $branch) = @_;
1109 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1111 # assume return is allowed to start
1115 # identify all cases where return is forbidden
1116 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1118 $message = $item->{'homebranch'};
1119 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1121 $message = $item->{'holdingbranch'};
1122 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1124 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1127 return ($allowed, $message);
1130 =head2 CheckHighHolds
1132 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1133 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1134 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1138 sub checkHighHolds {
1139 my ( $item, $borrower ) = @_;
1140 my $branch = _GetCircControlBranch( $item, $borrower );
1141 my $item_object = Koha::Items->find( $item->{itemnumber} );
1150 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1152 if ( $holds->count() ) {
1153 $return_data->{outstanding} = $holds->count();
1155 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1156 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1157 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1159 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1161 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1163 # static means just more than a given number of holds on the record
1165 # If the number of holds is less than the threshold, we can stop here
1166 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1167 return $return_data;
1170 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1172 # dynamic means X more than the number of holdable items on the record
1174 # let's get the items
1175 my @items = $holds->next()->biblio()->items();
1177 # Remove any items with status defined to be ignored even if the would not make item unholdable
1178 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1179 @items = grep { !$_->$status } @items;
1182 # Remove any items that are not holdable for this patron
1183 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber ) eq 'OK' } @items;
1185 my $items_count = scalar @items;
1187 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1189 # If the number of holds is less than the count of items we have
1190 # plus the number of holds allowed above that count, we can stop here
1191 if ( $holds->count() <= $threshold ) {
1192 return $return_data;
1196 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1198 my $calendar = Koha::Calendar->new( branchcode => $branch );
1200 my $itype = $item_object->effective_itemtype;
1201 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1203 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1205 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1206 $reduced_datedue->set_hour($orig_due->hour);
1207 $reduced_datedue->set_minute($orig_due->minute);
1208 $reduced_datedue->truncate( to => 'minute' );
1210 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1211 $return_data->{exceeded} = 1;
1212 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1213 $return_data->{due_date} = $reduced_datedue;
1217 return $return_data;
1222 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1224 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1228 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1230 =item C<$barcode> is the barcode of the item being issued.
1232 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1233 Calculated if empty.
1235 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1237 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1238 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1240 AddIssue does the following things :
1242 - step 01: check that there is a borrowernumber & a barcode provided
1243 - check for RENEWAL (book issued & being issued to the same patron)
1244 - renewal YES = Calculate Charge & renew
1246 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1248 - fill reserve if reserve to this patron
1249 - cancel reserve or not, otherwise
1250 * TRANSFERT PENDING ?
1251 - complete the transfert
1259 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1261 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1262 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1263 my $auto_renew = $params && $params->{auto_renew};
1264 my $dbh = C4::Context->dbh;
1265 my $barcodecheck = CheckValidBarcode($barcode);
1269 if ( $datedue && ref $datedue ne 'DateTime' ) {
1270 $datedue = dt_from_string($datedue);
1273 # $issuedate defaults to today.
1274 if ( !defined $issuedate ) {
1275 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1278 if ( ref $issuedate ne 'DateTime' ) {
1279 $issuedate = dt_from_string($issuedate);
1284 # Stop here if the patron or barcode doesn't exist
1285 if ( $borrower && $barcode && $barcodecheck ) {
1286 # find which item we issue
1287 my $item = GetItem( '', $barcode )
1288 or return; # if we don't get an Item, abort.
1289 my $item_object = Koha::Items->find( { barcode => $barcode } );
1291 my $branch = _GetCircControlBranch( $item, $borrower );
1293 # get actual issuing if there is one
1294 my $actualissue = Koha::Checkouts->find( { itemnumber => $item->{itemnumber} } );
1296 # check if we just renew the issue.
1297 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1298 and not $switch_onsite_checkout ) {
1299 $datedue = AddRenewal(
1300 $borrower->{'borrowernumber'},
1301 $item->{'itemnumber'},
1304 $issuedate, # here interpreted as the renewal date
1308 # it's NOT a renewal
1309 if ( $actualissue and not $switch_onsite_checkout ) {
1310 # This book is currently on loan, but not to the person
1311 # who wants to borrow it now. mark it returned before issuing to the new borrower
1312 my ( $allowed, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
1313 return unless $allowed;
1314 AddReturn( $item->{'barcode'}, C4::Context->userenv->{'branch'} );
1317 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1319 # Starting process for transfer job (checking transfert and validate it if we have one)
1320 my ($datesent) = GetTransfers( $item->{'itemnumber'} );
1322 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1323 my $sth = $dbh->prepare(
1324 "UPDATE branchtransfers
1325 SET datearrived = now(),
1327 comments = 'Forced branchtransfer'
1328 WHERE itemnumber= ? AND datearrived IS NULL"
1330 $sth->execute( C4::Context->userenv->{'branch'},
1331 $item->{'itemnumber'} );
1334 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1335 unless ($auto_renew) {
1336 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1337 { categorycode => $borrower->{categorycode},
1338 itemtype => $item->{itype},
1339 branchcode => $branch
1343 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1346 # Record in the database the fact that the book was issued.
1348 my $itype = $item_object->effective_itemtype;
1349 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1352 $datedue->truncate( to => 'minute' );
1354 $issue = Koha::Database->new()->schema()->resultset('Issue')->update_or_create(
1356 borrowernumber => $borrower->{'borrowernumber'},
1357 itemnumber => $item->{'itemnumber'},
1358 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1359 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1360 branchcode => C4::Context->userenv->{'branch'},
1361 onsite_checkout => $onsite_checkout,
1362 auto_renew => $auto_renew ? 1 : 0
1366 if ( C4::Context->preference('ReturnToShelvingCart') ) {
1367 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1368 CartToShelf( $item->{'itemnumber'} );
1370 $item->{'issues'}++;
1371 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1372 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1375 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1376 if ( $item->{'itemlost'} ) {
1378 Koha::RefundLostItemFeeRules->should_refund(
1380 current_branch => C4::Context->userenv->{branch},
1381 item_home_branch => $item->{homebranch},
1382 item_holding_branch => $item->{holdingbranch}
1387 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1388 $item->{'barcode'} );
1394 issues => $item->{'issues'},
1395 holdingbranch => C4::Context->userenv->{'branch'},
1397 onloan => $datedue->ymd(),
1398 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1400 $item->{'biblionumber'},
1401 $item->{'itemnumber'}
1403 ModDateLastSeen( $item->{'itemnumber'} );
1405 # If it costs to borrow this book, charge it to the patron's account.
1406 my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1407 if ( $charge > 0 ) {
1408 AddIssuingCharge( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $charge );
1409 $item->{'charge'} = $charge;
1412 # Record the fact that this book was issued.
1415 branch => C4::Context->userenv->{'branch'},
1416 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1418 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1419 itemnumber => $item->{'itemnumber'},
1420 itemtype => $item->{'itype'},
1421 location => $item->{location},
1422 borrowernumber => $borrower->{'borrowernumber'},
1423 ccode => $item->{'ccode'}
1427 # Send a checkout slip.
1428 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1430 branchcode => $branch,
1431 categorycode => $borrower->{categorycode},
1432 item_type => $item->{itype},
1433 notification => 'CHECKOUT',
1435 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1436 SendCirculationAlert(
1440 borrower => $borrower,
1446 "CIRCULATION", "ISSUE",
1447 $borrower->{'borrowernumber'},
1448 $item->{'itemnumber'}
1449 ) if C4::Context->preference("IssueLog");
1455 =head2 GetLoanLength
1457 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1459 Get loan length for an itemtype, a borrower type and a branch
1464 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1465 my $dbh = C4::Context->dbh;
1466 my $sth = $dbh->prepare(qq{
1467 SELECT issuelength, lengthunit, renewalperiod
1469 WHERE categorycode=?
1472 AND issuelength IS NOT NULL
1475 # try to find issuelength & return the 1st available.
1476 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1477 $sth->execute( $borrowertype, $itemtype, $branchcode );
1478 my $loanlength = $sth->fetchrow_hashref;
1481 if defined($loanlength) && defined $loanlength->{issuelength};
1483 $sth->execute( $borrowertype, '*', $branchcode );
1484 $loanlength = $sth->fetchrow_hashref;
1486 if defined($loanlength) && defined $loanlength->{issuelength};
1488 $sth->execute( '*', $itemtype, $branchcode );
1489 $loanlength = $sth->fetchrow_hashref;
1491 if defined($loanlength) && defined $loanlength->{issuelength};
1493 $sth->execute( '*', '*', $branchcode );
1494 $loanlength = $sth->fetchrow_hashref;
1496 if defined($loanlength) && defined $loanlength->{issuelength};
1498 $sth->execute( $borrowertype, $itemtype, '*' );
1499 $loanlength = $sth->fetchrow_hashref;
1501 if defined($loanlength) && defined $loanlength->{issuelength};
1503 $sth->execute( $borrowertype, '*', '*' );
1504 $loanlength = $sth->fetchrow_hashref;
1506 if defined($loanlength) && defined $loanlength->{issuelength};
1508 $sth->execute( '*', $itemtype, '*' );
1509 $loanlength = $sth->fetchrow_hashref;
1511 if defined($loanlength) && defined $loanlength->{issuelength};
1513 $sth->execute( '*', '*', '*' );
1514 $loanlength = $sth->fetchrow_hashref;
1516 if defined($loanlength) && defined $loanlength->{issuelength};
1518 # if no rule is set => 0 day (hardcoded)
1522 lengthunit => 'days',
1528 =head2 GetHardDueDate
1530 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1532 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1536 sub GetHardDueDate {
1537 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1539 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1540 { categorycode => $borrowertype,
1541 itemtype => $itemtype,
1542 branchcode => $branchcode
1547 if ( defined( $issuing_rule ) ) {
1548 if ( $issuing_rule->hardduedate ) {
1549 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1551 return (undef, undef);
1556 =head2 GetBranchBorrowerCircRule
1558 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1560 Retrieves circulation rule attributes that apply to the given
1561 branch and patron category, regardless of item type.
1562 The return value is a hashref containing the following key:
1564 maxissueqty - maximum number of loans that a
1565 patron of the given category can have at the given
1566 branch. If the value is undef, no limit.
1568 maxonsiteissueqty - maximum of on-site checkouts that a
1569 patron of the given category can have at the given
1570 branch. If the value is undef, no limit.
1572 This will first check for a specific branch and
1573 category match from branch_borrower_circ_rules.
1575 If no rule is found, it will then check default_branch_circ_rules
1576 (same branch, default category). If no rule is found,
1577 it will then check default_borrower_circ_rules (default
1578 branch, same category), then failing that, default_circ_rules
1579 (default branch, default category).
1581 If no rule has been found in the database, it will default to
1585 maxonsiteissueqty - undef
1587 C<$branchcode> and C<$categorycode> should contain the
1588 literal branch code and patron category code, respectively - no
1593 sub GetBranchBorrowerCircRule {
1594 my ( $branchcode, $categorycode ) = @_;
1597 my $dbh = C4::Context->dbh();
1598 $rules = $dbh->selectrow_hashref( q|
1599 SELECT maxissueqty, maxonsiteissueqty
1600 FROM branch_borrower_circ_rules
1601 WHERE branchcode = ?
1602 AND categorycode = ?
1603 |, {}, $branchcode, $categorycode ) ;
1604 return $rules if $rules;
1606 # try same branch, default borrower category
1607 $rules = $dbh->selectrow_hashref( q|
1608 SELECT maxissueqty, maxonsiteissueqty
1609 FROM default_branch_circ_rules
1610 WHERE branchcode = ?
1611 |, {}, $branchcode ) ;
1612 return $rules if $rules;
1614 # try default branch, same borrower category
1615 $rules = $dbh->selectrow_hashref( q|
1616 SELECT maxissueqty, maxonsiteissueqty
1617 FROM default_borrower_circ_rules
1618 WHERE categorycode = ?
1619 |, {}, $categorycode ) ;
1620 return $rules if $rules;
1622 # try default branch, default borrower category
1623 $rules = $dbh->selectrow_hashref( q|
1624 SELECT maxissueqty, maxonsiteissueqty
1625 FROM default_circ_rules
1627 return $rules if $rules;
1629 # built-in default circulation rule
1631 maxissueqty => undef,
1632 maxonsiteissueqty => undef,
1636 =head2 GetBranchItemRule
1638 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1640 Retrieves circulation rule attributes that apply to the given
1641 branch and item type, regardless of patron category.
1643 The return value is a hashref containing the following keys:
1645 holdallowed => Hold policy for this branch and itemtype. Possible values:
1646 0: No holds allowed.
1647 1: Holds allowed only by patrons that have the same homebranch as the item.
1648 2: Holds allowed from any patron.
1650 returnbranch => branch to which to return item. Possible values:
1651 noreturn: do not return, let item remain where checked in (floating collections)
1652 homebranch: return to item's home branch
1653 holdingbranch: return to issuer branch
1655 This searches branchitemrules in the following order:
1657 * Same branchcode and itemtype
1658 * Same branchcode, itemtype '*'
1659 * branchcode '*', same itemtype
1660 * branchcode and itemtype '*'
1662 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1666 sub GetBranchItemRule {
1667 my ( $branchcode, $itemtype ) = @_;
1668 my $dbh = C4::Context->dbh();
1672 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1673 FROM branch_item_rules
1674 WHERE branchcode = ?
1675 AND itemtype = ?', $branchcode, $itemtype],
1676 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1677 FROM default_branch_circ_rules
1678 WHERE branchcode = ?', $branchcode],
1679 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1680 FROM default_branch_item_rules
1681 WHERE itemtype = ?', $itemtype],
1682 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1683 FROM default_circ_rules'],
1686 foreach my $attempt (@attempts) {
1687 my ($query, @bind_params) = @{$attempt};
1688 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1691 # Since branch/category and branch/itemtype use the same per-branch
1692 # defaults tables, we have to check that the key we want is set, not
1693 # just that a row was returned
1694 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1695 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1696 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1699 # built-in default circulation rule
1700 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1701 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1702 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1709 ($doreturn, $messages, $iteminformation, $borrower) =
1710 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1716 =item C<$barcode> is the bar code of the book being returned.
1718 =item C<$branch> is the code of the branch where the book is being returned.
1720 =item C<$exemptfine> indicates that overdue charges for the item will be
1723 =item C<$dropbox> indicates that the check-in date is assumed to be
1724 yesterday, or the last non-holiday as defined in C4::Calendar . If
1725 overdue charges are applied and C<$dropbox> is true, the last charge
1726 will be removed. This assumes that the fines accrual script has run
1727 for _today_. Optional.
1729 =item C<$return_date> allows the default return date to be overridden
1730 by the given return date. Optional.
1734 C<&AddReturn> returns a list of four items:
1736 C<$doreturn> is true iff the return succeeded.
1738 C<$messages> is a reference-to-hash giving feedback on the operation.
1739 The keys of the hash are:
1745 No item with this barcode exists. The value is C<$barcode>.
1749 The book is not currently on loan. The value is C<$barcode>.
1753 This book has been withdrawn/cancelled. The value should be ignored.
1755 =item C<Wrongbranch>
1757 This book has was returned to the wrong branch. The value is a hashref
1758 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1759 contain the branchcode of the incorrect and correct return library, respectively.
1763 The item was reserved. The value is a reference-to-hash whose keys are
1764 fields from the reserves table of the Koha database, and
1765 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1766 either C<Waiting>, C<Reserved>, or 0.
1768 =item C<WasReturned>
1770 Value 1 if return is successful.
1772 =item C<NeedsTransfer>
1774 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1778 C<$iteminformation> is a reference-to-hash, giving information about the
1779 returned item from the issues table.
1781 C<$borrower> is a reference-to-hash, giving information about the
1782 patron who last borrowed the book.
1787 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1789 if ($branch and not Koha::Libraries->find($branch)) {
1790 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1793 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1797 my $validTransfert = 0;
1798 my $stat_type = 'return';
1800 # get information on item
1801 my $item = GetItem( undef, $barcode );
1803 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1806 my $itemnumber = $item->{ itemnumber };
1807 my $itemtype = $item->{itype}; # GetItem called effective_itemtype
1809 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
1811 $patron = Koha::Patrons->find( $issue->borrowernumber )
1812 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1813 . Dumper($issue->unblessed) . "\n";
1815 $messages->{'NotIssued'} = $barcode;
1816 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1818 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1819 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1820 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1821 $messages->{'LocalUse'} = 1;
1822 $stat_type = 'localuse';
1826 if ( $item->{'location'} eq 'PROC' ) {
1827 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1828 $item->{'location'} = 'CART';
1831 $item->{location} = $item->{permanent_location};
1834 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1837 # full item data, but no borrowernumber or checkout info (no issue)
1838 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1839 # get the proper branch to which to return the item
1840 my $returnbranch = $item->{$hbr} || $branch ;
1841 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1843 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1844 my $patron_unblessed = $patron ? $patron->unblessed : {};
1846 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1848 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1850 eval { $rules = YAML::Load($yaml); };
1852 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1855 foreach my $key ( keys %$rules ) {
1856 if ( $item->{notforloan} eq $key ) {
1857 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1858 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1865 # check if the return is allowed at this branch
1866 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1867 unless ($returnallowed){
1868 $messages->{'Wrongbranch'} = {
1869 Wrongbranch => $branch,
1870 Rightbranch => $message
1873 return ( $doreturn, $messages, $issue, $patron_unblessed);
1876 if ( $item->{'withdrawn'} ) { # book has been cancelled
1877 $messages->{'withdrawn'} = 1;
1878 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1881 if ( $item->{itemlost} and C4::Context->preference("BlockReturnOfLostItems") ) {
1885 # case of a return of document (deal with issues and holdingbranch)
1886 my $today = DateTime->now( time_zone => C4::Context->tz() );
1890 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1891 $patron or warn "AddReturn without current borrower";
1892 my $circControlBranch;
1894 # define circControlBranch only if dropbox mode is set
1895 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1896 # FIXME: check issuedate > returndate, factoring in holidays
1898 $circControlBranch = _GetCircControlBranch($item,$patron_unblessed);
1899 $is_overdue = $issue->is_overdue( $dropboxdate );
1901 $is_overdue = $issue->is_overdue;
1906 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1907 $circControlBranch, $return_date, $patron->privacy );
1910 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1911 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed, return_date => $return_date } );
1914 carp "The checkin for the following issue failed, Please go to the about page, section 'data corrupted' to know how to fix this problem ($@)" . Dumper( $issue->unblessed );
1916 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1919 # FIXME is the "= 1" right? This could be the borrower hash.
1920 $messages->{'WasReturned'} = 1;
1924 ModItem({ onloan => undef }, $item->{biblionumber}, $item->{'itemnumber'});
1927 # the holdingbranch is updated if the document is returned to another location.
1928 # this is always done regardless of whether the item was on loan or not
1929 my $item_holding_branch = $item->{ holdingbranch };
1930 if ($item->{'holdingbranch'} ne $branch) {
1931 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1932 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1934 ModDateLastSeen( $item->{'itemnumber'} );
1936 # check if we have a transfer for this document
1937 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1939 # if we have a transfer to do, we update the line of transfers with the datearrived
1940 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1942 if ( $tobranch eq $branch ) {
1943 my $sth = C4::Context->dbh->prepare(
1944 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1946 $sth->execute( $item->{'itemnumber'} );
1947 # if we have a reservation with valid transfer, we can set it's status to 'W'
1948 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1949 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1951 $messages->{'WrongTransfer'} = $tobranch;
1952 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1954 $validTransfert = 1;
1956 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1959 # fix up the accounts.....
1960 if ( $item->{'itemlost'} ) {
1961 $messages->{'WasLost'} = 1;
1962 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
1964 Koha::RefundLostItemFeeRules->should_refund(
1966 current_branch => C4::Context->userenv->{branch},
1967 item_home_branch => $item->{homebranch},
1968 item_holding_branch => $item_holding_branch
1973 _FixAccountForLostAndReturned( $item->{'itemnumber'},
1974 $borrowernumber, $barcode );
1975 $messages->{'LostItemFeeRefunded'} = 1;
1980 # fix up the overdues in accounts...
1981 if ($borrowernumber) {
1982 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1983 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1985 if ( $issue and $issue->is_overdue ) {
1987 $today = $dropboxdate if $dropbox;
1988 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item, dt_from_string($issue->date_due), $today );
1990 $messages->{'PrevDebarred'} = $debardate;
1992 $messages->{'Debarred'} = $debardate if $debardate;
1994 # there's no overdue on the item but borrower had been previously debarred
1995 } elsif ( $issue->date_due and $patron->debarred ) {
1996 if ( $patron->debarred eq "9999-12-31") {
1997 $messages->{'ForeverDebarred'} = $patron->debarred;
1999 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2000 $borrower_debar_dt->truncate(to => 'day');
2001 my $today_dt = $today->clone()->truncate(to => 'day');
2002 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2003 $messages->{'PrevDebarred'} = $patron->debarred;
2009 # find reserves.....
2010 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2011 my ($resfound, $resrec);
2012 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2013 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2015 $resrec->{'ResFound'} = $resfound;
2016 $messages->{'ResFound'} = $resrec;
2019 # Record the fact that this book was returned.
2023 itemnumber => $itemnumber,
2024 itemtype => $itemtype,
2025 borrowernumber => $borrowernumber,
2026 ccode => $item->{ ccode }
2029 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2031 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2033 branchcode => $branch,
2034 categorycode => $patron->categorycode,
2035 item_type => $item->{itype},
2036 notification => 'CHECKIN',
2038 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2039 SendCirculationAlert({
2042 borrower => $patron->unblessed,
2047 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2048 if C4::Context->preference("ReturnLog");
2051 # Remove any OVERDUES related debarment if the borrower has no overdues
2052 if ( $borrowernumber
2053 && $patron->debarred
2054 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2055 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2056 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2058 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2061 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2062 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2063 if (C4::Context->preference("AutomaticItemReturn" ) or
2064 (C4::Context->preference("UseBranchTransferLimits") and
2065 ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2067 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2068 $debug and warn "item: " . Dumper($item);
2069 ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2070 $messages->{'WasTransfered'} = 1;
2072 $messages->{'NeedsTransfer'} = $returnbranch;
2076 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2079 =head2 MarkIssueReturned
2081 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2083 Unconditionally marks an issue as being returned by
2084 moving the C<issues> row to C<old_issues> and
2085 setting C<returndate> to the current date, or
2086 the last non-holiday date of the branccode specified in
2087 C<dropbox_branch> . Assumes you've already checked that
2088 it's safe to do this, i.e. last non-holiday > issuedate.
2090 if C<$returndate> is specified (in iso format), it is used as the date
2091 of the return. It is ignored when a dropbox_branch is passed in.
2093 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2094 the old_issue is immediately anonymised
2096 Ideally, this function would be internal to C<C4::Circulation>,
2097 not exported, but it is currently needed by one
2098 routine in C<C4::Accounts>.
2102 sub MarkIssueReturned {
2103 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2106 # Retrieve the issue
2107 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2108 my $issue_id = $issue->issue_id;
2110 my $anonymouspatron;
2111 if ( $privacy == 2 ) {
2112 # The default of 0 will not work due to foreign key constraints
2113 # The anonymisation will fail if AnonymousPatron is not a valid entry
2114 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2115 # Note that a warning should appear on the about page (System information tab).
2116 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2117 die "Fatal error: the patron ($borrowernumber) has requested their circulation history be anonymized on check-in, but the AnonymousPatron system preference is empty or not set correctly."
2118 unless Koha::Patrons->find( $anonymouspatron );
2120 my $database = Koha::Database->new();
2121 my $schema = $database->schema;
2122 my $dbh = C4::Context->dbh;
2124 my $query = 'UPDATE issues SET returndate=';
2126 if ($dropbox_branch) {
2127 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2128 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2130 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2131 } elsif ($returndate) {
2133 push @bind, $returndate;
2135 $query .= ' now() ';
2137 $query .= ' WHERE issue_id = ?';
2138 push @bind, $issue_id;
2140 # FIXME Improve the return value and handle it from callers
2141 $schema->txn_do(sub {
2143 # Update the returndate
2144 $dbh->do( $query, undef, @bind );
2146 # We just updated the returndate, so we need to refetch $issue
2147 $issue->discard_changes;
2149 # Create the old_issues entry
2150 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2152 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2153 if ( $privacy == 2) {
2154 $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $old_checkout->issue_id);
2157 # And finally delete the issue
2160 ModItem( { 'onloan' => undef }, undef, $itemnumber );
2162 if ( C4::Context->preference('StoreLastBorrower') ) {
2163 my $item = Koha::Items->find( $itemnumber );
2164 my $patron = Koha::Patrons->find( $borrowernumber );
2165 $item->last_returned_by( $patron );
2172 =head2 _debar_user_on_return
2174 _debar_user_on_return($borrower, $item, $datedue, today);
2176 C<$borrower> borrower hashref
2178 C<$item> item hashref
2180 C<$datedue> date due DateTime object
2182 C<$return_date> DateTime object representing the return time
2184 Internal function, called only by AddReturn that calculates and updates
2185 the user fine days, and debars them if necessary.
2187 Should only be called for overdue returns
2191 sub _debar_user_on_return {
2192 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2194 my $branchcode = _GetCircControlBranch( $item, $borrower );
2196 my $circcontrol = C4::Context->preference('CircControl');
2197 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2198 { categorycode => $borrower->{categorycode},
2199 itemtype => $item->{itype},
2200 branchcode => $branchcode
2203 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2204 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2205 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2209 # finedays is in days, so hourly loans must multiply by 24
2210 # thus 1 hour late equals 1 day suspension * finedays rate
2211 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2213 # grace period is measured in the same units as the loan
2215 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2217 my $deltadays = DateTime::Duration->new(
2218 days => $chargeable_units
2220 if ( $deltadays->subtract($grace)->is_positive() ) {
2221 my $suspension_days = $deltadays * $finedays;
2223 # If the max suspension days is < than the suspension days
2224 # the suspension days is limited to this maximum period.
2225 my $max_sd = $issuing_rule->maxsuspensiondays;
2226 if ( defined $max_sd ) {
2227 $max_sd = DateTime::Duration->new( days => $max_sd );
2228 $suspension_days = $max_sd
2229 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2232 my ( $has_been_extended, $is_a_reminder );
2233 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2234 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2236 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2237 $has_been_extended = 1;
2242 $return_date->clone()->add_duration( $suspension_days );
2244 Koha::Patron::Debarments::AddUniqueDebarment({
2245 borrowernumber => $borrower->{borrowernumber},
2246 expiration => $new_debar_dt->ymd(),
2247 type => 'SUSPENSION',
2249 # if borrower was already debarred but does not get an extra debarment
2250 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2251 my $new_debarment_str;
2252 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2254 $new_debarment_str = $borrower->{debarred};
2256 $new_debarment_str = $new_debar_dt->ymd();
2258 # FIXME Should return a DateTime object
2259 return $new_debarment_str, $is_a_reminder;
2265 =head2 _FixOverduesOnReturn
2267 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2269 C<$brn> borrowernumber
2273 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2274 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2276 Internal function, called only by AddReturn
2280 sub _FixOverduesOnReturn {
2281 my ($borrowernumber, $item);
2282 unless ($borrowernumber = shift) {
2283 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2286 unless ($item = shift) {
2287 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2290 my ($exemptfine, $dropbox) = @_;
2291 my $dbh = C4::Context->dbh;
2293 # check for overdue fine
2294 my $accountline = Koha::Account::Lines->search(
2296 borrowernumber => $borrowernumber,
2297 itemnumber => $item,
2299 accounttype => 'FU',
2304 return 0 unless $accountline; # no warning, there's just nothing to fix
2308 my $amountoutstanding = $accountline->amountoutstanding;
2310 $accountline->accounttype('FFOR');
2311 $accountline->amountoutstanding(0);
2313 Koha::Account::Offset->new(
2315 debit_id => $accountline->id,
2317 amount => $amountoutstanding * -1,
2321 if (C4::Context->preference("FinesLog")) {
2322 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2324 } elsif ($dropbox && $accountline->lastincrement) {
2325 my $outstanding = $accountline->amountoutstanding - $accountline->lastincrement;
2326 my $amt = $accountline->amount - $accountline->lastincrement;
2328 Koha::Account::Offset->new(
2330 debit_id => $accountline->id,
2332 amount => $accountline->lastincrement * -1,
2336 if ( C4::Context->preference("FinesLog") ) {
2337 &logaction( "FINES", 'MODIFY', $borrowernumber,
2338 "Dropbox adjustment $amt, item $item" );
2341 $accountline->accounttype('F');
2343 if ( $outstanding >= 0 && $amt >= 0 ) {
2344 $accountline->amount($amt);
2345 $accountline->amountoutstanding($outstanding);
2349 $accountline->accounttype('F');
2352 return $accountline->store();
2355 =head2 _FixAccountForLostAndReturned
2357 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2359 Calculates the charge for a book lost and returned.
2361 Internal function, not exported, called only by AddReturn.
2365 sub _FixAccountForLostAndReturned {
2366 my $itemnumber = shift or return;
2367 my $borrowernumber = @_ ? shift : undef;
2368 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2370 # check for charge made for lost book
2371 my $accountline = Koha::Account::Lines->search(
2373 itemnumber => $itemnumber,
2374 accounttype => { -in => [ 'L', 'Rep', 'W' ] },
2377 order_by => { -desc => [ 'date', 'accountno' ] }
2381 return unless $accountline;
2382 return if $accountline->accounttype eq 'W'; # Written off
2384 $accountline->accounttype('LR');
2385 $accountline->store();
2387 my $account = Koha::Account->new( { patron_id => $accountline->borrowernumber } );
2388 my $credit_id = $account->pay(
2390 amount => $accountline->amount,
2391 description => "Item Returned " . $item_id,
2392 account_type => 'CR',
2393 offset_type => 'Lost Item Return',
2394 accounlines => [$accountline],
2399 ModItem( { paidfor => '' }, undef, $itemnumber );
2404 =head2 _GetCircControlBranch
2406 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2410 Return the library code to be used to determine which circulation
2411 policy applies to a transaction. Looks up the CircControl and
2412 HomeOrHoldingBranch system preferences.
2414 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2416 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2420 sub _GetCircControlBranch {
2421 my ($item, $borrower) = @_;
2422 my $circcontrol = C4::Context->preference('CircControl');
2425 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2426 $branch= C4::Context->userenv->{'branch'};
2427 } elsif ($circcontrol eq 'PatronLibrary') {
2428 $branch=$borrower->{branchcode};
2430 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2431 $branch = $item->{$branchfield};
2432 # default to item home branch if holdingbranch is used
2433 # and is not defined
2434 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2435 $branch = $item->{homebranch};
2443 $issue = GetOpenIssue( $itemnumber );
2445 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2447 C<$itemnumber> is the item's itemnumber
2454 my ( $itemnumber ) = @_;
2455 return unless $itemnumber;
2456 my $dbh = C4::Context->dbh;
2457 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2458 $sth->execute( $itemnumber );
2459 return $sth->fetchrow_hashref();
2463 =head2 GetBiblioIssues
2465 $issues = GetBiblioIssues($biblionumber);
2467 this function get all issues from a biblionumber.
2470 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2471 tables issues and the firstname,surname & cardnumber from borrowers.
2475 sub GetBiblioIssues {
2476 my $biblionumber = shift;
2477 return unless $biblionumber;
2478 my $dbh = C4::Context->dbh;
2480 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2482 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2483 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2484 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2485 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2486 WHERE biblio.biblionumber = ?
2488 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2490 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2491 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2492 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2493 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2494 WHERE biblio.biblionumber = ?
2497 my $sth = $dbh->prepare($query);
2498 $sth->execute($biblionumber, $biblionumber);
2501 while ( my $data = $sth->fetchrow_hashref ) {
2502 push @issues, $data;
2507 =head2 GetUpcomingDueIssues
2509 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2513 sub GetUpcomingDueIssues {
2516 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2517 my $dbh = C4::Context->dbh;
2519 my $statement = <<END_SQL;
2522 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2524 LEFT JOIN items USING (itemnumber)
2525 LEFT OUTER JOIN branches USING (branchcode)
2526 WHERE returndate is NULL
2528 WHERE days_until_due >= 0 AND days_until_due <= ?
2531 my @bind_parameters = ( $params->{'days_in_advance'} );
2533 my $sth = $dbh->prepare( $statement );
2534 $sth->execute( @bind_parameters );
2535 my $upcoming_dues = $sth->fetchall_arrayref({});
2537 return $upcoming_dues;
2540 =head2 CanBookBeRenewed
2542 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2544 Find out whether a borrowed item may be renewed.
2546 C<$borrowernumber> is the borrower number of the patron who currently
2547 has the item on loan.
2549 C<$itemnumber> is the number of the item to renew.
2551 C<$override_limit>, if supplied with a true value, causes
2552 the limit on the number of times that the loan can be renewed
2553 (as controlled by the item type) to be ignored. Overriding also allows
2554 to renew sooner than "No renewal before" and to manually renew loans
2555 that are automatically renewed.
2557 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2558 item must currently be on loan to the specified borrower; renewals
2559 must be allowed for the item's type; and the borrower must not have
2560 already renewed the loan. $error will contain the reason the renewal can not proceed
2564 sub CanBookBeRenewed {
2565 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2567 my $dbh = C4::Context->dbh;
2570 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2571 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return ( 0, 'no_checkout' );
2572 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2574 $borrowernumber ||= $issue->borrowernumber;
2575 my $patron = Koha::Patrons->find( $borrowernumber )
2578 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2580 # This item can fill one or more unfilled reserve, can those unfilled reserves
2581 # all be filled by other available items?
2583 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2585 my $schema = Koha::Database->new()->schema();
2587 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2589 # There is an item level hold on this item, no other item can fill the hold
2594 # Get all other items that could possibly fill reserves
2595 my @itemnumbers = $schema->resultset('Item')->search(
2597 biblionumber => $resrec->{biblionumber},
2600 -not => { itemnumber => $itemnumber }
2602 { columns => 'itemnumber' }
2603 )->get_column('itemnumber')->all();
2605 # Get all other reserves that could have been filled by this item
2606 my @borrowernumbers;
2608 my ( $reserve_found, $reserve, undef ) =
2609 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2611 if ($reserve_found) {
2612 push( @borrowernumbers, $reserve->{borrowernumber} );
2619 # If the count of the union of the lists of reservable items for each borrower
2620 # is equal or greater than the number of borrowers, we know that all reserves
2621 # can be filled with available items. We can get the union of the sets simply
2622 # by pushing all the elements onto an array and removing the duplicates.
2625 ITEM: foreach my $i (@itemnumbers) {
2626 my $item = GetItem($i);
2627 next if IsItemOnHoldAndFound($i);
2628 for my $b (@borrowernumbers) {
2629 my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2630 next unless IsAvailableForItemLevelRequest($item, $borr);
2631 next unless CanItemBeReserved($b,$i);
2633 push @reservable, $i;
2634 if (@reservable >= @borrowernumbers) {
2643 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2645 return ( 1, undef ) if $override_limit;
2647 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2648 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2649 { categorycode => $patron->categorycode,
2650 itemtype => $item->{itype},
2651 branchcode => $branchcode
2655 return ( 0, "too_many" )
2656 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2658 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2659 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2660 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2661 my $restricted = $patron->is_debarred;
2662 my $hasoverdues = $patron->has_overdues;
2664 if ( $restricted and $restrictionblockrenewing ) {
2665 return ( 0, 'restriction');
2666 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2667 return ( 0, 'overdue');
2670 if ( $issue->auto_renew ) {
2672 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2673 return ( 0, 'auto_account_expired' );
2676 if ( defined $issuing_rule->no_auto_renewal_after
2677 and $issuing_rule->no_auto_renewal_after ne "" ) {
2678 # Get issue_date and add no_auto_renewal_after
2679 # If this is greater than today, it's too late for renewal.
2680 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2681 $maximum_renewal_date->add(
2682 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2684 my $now = dt_from_string;
2685 if ( $now >= $maximum_renewal_date ) {
2686 return ( 0, "auto_too_late" );
2689 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2690 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2691 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2692 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2693 return ( 0, "auto_too_late" );
2697 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2698 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2699 my $amountoutstanding = $patron->account->balance;
2700 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2701 return ( 0, "auto_too_much_oweing" );
2706 if ( defined $issuing_rule->norenewalbefore
2707 and $issuing_rule->norenewalbefore ne "" )
2710 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2711 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2712 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2714 # Depending on syspref reset the exact time, only check the date
2715 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2716 and $issuing_rule->lengthunit eq 'days' )
2718 $soonestrenewal->truncate( to => 'day' );
2721 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2723 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2724 return ( 0, "too_soon" );
2726 elsif ( $issue->auto_renew ) {
2727 return ( 0, "auto_renew" );
2731 # Fallback for automatic renewals:
2732 # If norenewalbefore is undef, don't renew before due date.
2733 if ( $issue->auto_renew ) {
2734 my $now = dt_from_string;
2735 return ( 0, "auto_renew" )
2736 if $now >= dt_from_string( $issue->date_due, 'sql' );
2737 return ( 0, "auto_too_soon" );
2740 return ( 1, undef );
2745 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2749 C<$borrowernumber> is the borrower number of the patron who currently
2752 C<$itemnumber> is the number of the item to renew.
2754 C<$branch> is the library where the renewal took place (if any).
2755 The library that controls the circ policies for the renewal is retrieved from the issues record.
2757 C<$datedue> can be a DateTime object used to set the due date.
2759 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2760 this parameter is not supplied, lastreneweddate is set to the current date.
2762 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2763 from the book's item type.
2768 my $borrowernumber = shift;
2769 my $itemnumber = shift or return;
2771 my $datedue = shift;
2772 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2774 my $item = GetItem($itemnumber) or return;
2775 my $item_object = Koha::Items->find( $itemnumber ); # Should replace $item
2776 my $biblio = $item_object->biblio;
2778 my $dbh = C4::Context->dbh;
2780 # Find the issues record for this book
2781 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
2783 return unless $issue;
2785 $borrowernumber ||= $issue->borrowernumber;
2787 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2788 carp 'Invalid date passed to AddRenewal.';
2792 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2793 my $patron_unblessed = $patron->unblessed;
2795 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2796 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed } );
2798 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2800 # If the due date wasn't specified, calculate it by adding the
2801 # book's loan length to today's date or the current due date
2802 # based on the value of the RenewalPeriodBase syspref.
2805 my $itemtype = $item_object->effective_itemtype;
2806 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2807 dt_from_string( $issue->date_due, 'sql' ) :
2808 DateTime->now( time_zone => C4::Context->tz());
2809 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $patron_unblessed), $patron_unblessed, 'is a renewal');
2812 # Update the issues record to have the new due date, and a new count
2813 # of how many times it has been renewed.
2814 my $renews = $issue->renewals + 1;
2815 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2816 WHERE borrowernumber=?
2820 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2822 # Update the renewal count on the item, and tell zebra to reindex
2823 $renews = $item->{renewals} + 1;
2824 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->{biblionumber}, $itemnumber);
2826 # Charge a new rental fee, if applicable?
2827 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2828 if ( $charge > 0 ) {
2829 my $accountno = getnextacctno( $borrowernumber );
2831 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2832 $sth = $dbh->prepare(
2833 "INSERT INTO accountlines
2834 (date, borrowernumber, accountno, amount, manager_id,
2835 description,accounttype, amountoutstanding, itemnumber)
2836 VALUES (now(),?,?,?,?,?,?,?,?)"
2838 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2839 "Renewal of Rental Item " . $biblio->title . " $item->{'barcode'}",
2840 'Rent', $charge, $itemnumber );
2843 # Send a renewal slip according to checkout alert preferencei
2844 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2845 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2847 branchcode => $branch,
2848 categorycode => $patron->categorycode,
2849 item_type => $item->{itype},
2850 notification => 'CHECKOUT',
2852 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2853 SendCirculationAlert(
2857 borrower => $patron->unblessed,
2864 # Remove any OVERDUES related debarment if the borrower has no overdues
2866 && $patron->is_debarred
2867 && ! $patron->has_overdues
2868 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2870 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2873 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2874 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2877 # Add the renewal to stats
2883 itemnumber => $itemnumber,
2884 itemtype => $item->{itype},
2885 location => $item->{location},
2886 borrowernumber => $borrowernumber,
2887 ccode => $item->{'ccode'}
2892 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2897 # check renewal status
2898 my ( $bornum, $itemno ) = @_;
2899 my $dbh = C4::Context->dbh;
2901 my $renewsallowed = 0;
2904 my $patron = Koha::Patrons->find( $bornum );
2905 my $item = GetItem($itemno);
2907 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2909 # Look in the issues table for this item, lent to this borrower,
2910 # and not yet returned.
2912 # FIXME - I think this function could be redone to use only one SQL call.
2913 my $sth = $dbh->prepare(
2914 "select * from issues
2915 where (borrowernumber = ?)
2916 and (itemnumber = ?)"
2918 $sth->execute( $bornum, $itemno );
2919 my $data = $sth->fetchrow_hashref;
2920 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2921 # $item and $borrower should be calculated
2922 my $branchcode = _GetCircControlBranch($item, $patron->unblessed);
2924 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2925 { categorycode => $patron->categorycode,
2926 itemtype => $item->{itype},
2927 branchcode => $branchcode
2931 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
2932 $renewsleft = $renewsallowed - $renewcount;
2933 if($renewsleft < 0){ $renewsleft = 0; }
2934 return ( $renewcount, $renewsallowed, $renewsleft );
2937 =head2 GetSoonestRenewDate
2939 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2941 Find out the soonest possible renew date of a borrowed item.
2943 C<$borrowernumber> is the borrower number of the patron who currently
2944 has the item on loan.
2946 C<$itemnumber> is the number of the item to renew.
2948 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2949 renew date, based on the value "No renewal before" of the applicable
2950 issuing rule. Returns the current date if the item can already be
2951 renewed, and returns undefined if the borrower, loan, or item
2956 sub GetSoonestRenewDate {
2957 my ( $borrowernumber, $itemnumber ) = @_;
2959 my $dbh = C4::Context->dbh;
2961 my $item = GetItem($itemnumber) or return;
2962 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2964 $borrowernumber ||= $itemissue->borrowernumber;
2965 my $patron = Koha::Patrons->find( $borrowernumber )
2968 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2969 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2970 { categorycode => $patron->categorycode,
2971 itemtype => $item->{itype},
2972 branchcode => $branchcode
2976 my $now = dt_from_string;
2977 return $now unless $issuing_rule;
2979 if ( defined $issuing_rule->norenewalbefore
2980 and $issuing_rule->norenewalbefore ne "" )
2982 my $soonestrenewal =
2983 dt_from_string( $itemissue->date_due )->subtract(
2984 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2986 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2987 and $issuing_rule->lengthunit eq 'days' )
2989 $soonestrenewal->truncate( to => 'day' );
2991 return $soonestrenewal if $now < $soonestrenewal;
2996 =head2 GetLatestAutoRenewDate
2998 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3000 Find out the latest possible auto renew date of a borrowed item.
3002 C<$borrowernumber> is the borrower number of the patron who currently
3003 has the item on loan.
3005 C<$itemnumber> is the number of the item to renew.
3007 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3008 auto renew date, based on the value "No auto renewal after" and the "No auto
3009 renewal after (hard limit) of the applicable issuing rule.
3010 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3011 or item cannot be found.
3015 sub GetLatestAutoRenewDate {
3016 my ( $borrowernumber, $itemnumber ) = @_;
3018 my $dbh = C4::Context->dbh;
3020 my $item = GetItem($itemnumber) or return;
3021 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3023 $borrowernumber ||= $itemissue->borrowernumber;
3024 my $patron = Koha::Patrons->find( $borrowernumber )
3027 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3028 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3029 { categorycode => $patron->categorycode,
3030 itemtype => $item->{itype},
3031 branchcode => $branchcode
3035 return unless $issuing_rule;
3037 if ( not $issuing_rule->no_auto_renewal_after
3038 or $issuing_rule->no_auto_renewal_after eq '' )
3039 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3040 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3042 my $maximum_renewal_date;
3043 if ( $issuing_rule->no_auto_renewal_after ) {
3044 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3045 $maximum_renewal_date->add(
3046 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3050 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3051 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3052 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3054 return $maximum_renewal_date;
3058 =head2 GetIssuingCharges
3060 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3062 Calculate how much it would cost for a given patron to borrow a given
3063 item, including any applicable discounts.
3065 C<$itemnumber> is the item number of item the patron wishes to borrow.
3067 C<$borrowernumber> is the patron's borrower number.
3069 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3070 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3075 sub GetIssuingCharges {
3077 # calculate charges due
3078 my ( $itemnumber, $borrowernumber ) = @_;
3080 my $dbh = C4::Context->dbh;
3083 # Get the book's item type and rental charge (via its biblioitem).
3084 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3085 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3086 $charge_query .= (C4::Context->preference('item-level_itypes'))
3087 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3088 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3090 $charge_query .= ' WHERE items.itemnumber =?';
3092 my $sth = $dbh->prepare($charge_query);
3093 $sth->execute($itemnumber);
3094 if ( my $item_data = $sth->fetchrow_hashref ) {
3095 $item_type = $item_data->{itemtype};
3096 $charge = $item_data->{rentalcharge};
3097 my $branch = C4::Context::mybranch();
3098 my $discount_query = q|SELECT rentaldiscount,
3099 issuingrules.itemtype, issuingrules.branchcode
3101 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3102 WHERE borrowers.borrowernumber = ?
3103 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3104 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3105 my $discount_sth = $dbh->prepare($discount_query);
3106 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3107 my $discount_rules = $discount_sth->fetchall_arrayref({});
3108 if (@{$discount_rules}) {
3109 # We may have multiple rules so get the most specific
3110 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3111 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3114 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3118 return ( $charge, $item_type );
3121 # Select most appropriate discount rule from those returned
3122 sub _get_discount_from_rule {
3123 my ($rules_ref, $branch, $itemtype) = @_;
3126 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3127 $discount = $rules_ref->[0]->{rentaldiscount};
3128 return (defined $discount) ? $discount : 0;
3130 # could have up to 4 does one match $branch and $itemtype
3131 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3133 $discount = $d[0]->{rentaldiscount};
3134 return (defined $discount) ? $discount : 0;
3136 # do we have item type + all branches
3137 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3139 $discount = $d[0]->{rentaldiscount};
3140 return (defined $discount) ? $discount : 0;
3142 # do we all item types + this branch
3143 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3145 $discount = $d[0]->{rentaldiscount};
3146 return (defined $discount) ? $discount : 0;
3148 # so all and all (surely we wont get here)
3149 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3151 $discount = $d[0]->{rentaldiscount};
3152 return (defined $discount) ? $discount : 0;
3158 =head2 AddIssuingCharge
3160 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3164 sub AddIssuingCharge {
3165 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3167 my $nextaccntno = getnextacctno($borrowernumber);
3170 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3172 my $accountline = Koha::Account::Line->new(
3174 borrowernumber => $borrowernumber,
3175 itemnumber => $itemnumber,
3176 accountno => $nextaccntno,
3178 amountoutstanding => $charge,
3179 manager_id => $manager_id,
3180 description => 'Rental',
3181 accounttype => 'Rent',
3186 Koha::Account::Offset->new(
3188 debit_id => $accountline->id,
3189 type => 'Rental Fee',
3197 GetTransfers($itemnumber);
3202 my ($itemnumber) = @_;
3204 my $dbh = C4::Context->dbh;
3211 FROM branchtransfers
3212 WHERE itemnumber = ?
3213 AND datearrived IS NULL
3215 my $sth = $dbh->prepare($query);
3216 $sth->execute($itemnumber);
3217 my @row = $sth->fetchrow_array();
3221 =head2 GetTransfersFromTo
3223 @results = GetTransfersFromTo($frombranch,$tobranch);
3225 Returns the list of pending transfers between $from and $to branch
3229 sub GetTransfersFromTo {
3230 my ( $frombranch, $tobranch ) = @_;
3231 return unless ( $frombranch && $tobranch );
3232 my $dbh = C4::Context->dbh;
3234 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3235 FROM branchtransfers
3238 AND datearrived IS NULL
3240 my $sth = $dbh->prepare($query);
3241 $sth->execute( $frombranch, $tobranch );
3244 while ( my $data = $sth->fetchrow_hashref ) {
3245 push @gettransfers, $data;
3247 return (@gettransfers);
3250 =head2 DeleteTransfer
3252 &DeleteTransfer($itemnumber);
3256 sub DeleteTransfer {
3257 my ($itemnumber) = @_;
3258 return unless $itemnumber;
3259 my $dbh = C4::Context->dbh;
3260 my $sth = $dbh->prepare(
3261 "DELETE FROM branchtransfers
3263 AND datearrived IS NULL "
3265 return $sth->execute($itemnumber);
3268 =head2 SendCirculationAlert
3270 Send out a C<check-in> or C<checkout> alert using the messaging system.
3278 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3282 Hashref of information about the item being checked in or out.
3286 Hashref of information about the borrower of the item.
3290 The branchcode from where the checkout or check-in took place.
3296 SendCirculationAlert({
3299 borrower => $borrower,
3305 sub SendCirculationAlert {
3307 my ($type, $item, $borrower, $branch) =
3308 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3309 my %message_name = (
3310 CHECKIN => 'Item_Check_in',
3311 CHECKOUT => 'Item_Checkout',
3312 RENEWAL => 'Item_Checkout',
3314 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3315 borrowernumber => $borrower->{borrowernumber},
3316 message_name => $message_name{$type},
3318 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3320 my $schema = Koha::Database->new->schema;
3321 my @transports = keys %{ $borrower_preferences->{transports} };
3323 # From the MySQL doc:
3324 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3325 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3326 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3327 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3329 for my $mtt (@transports) {
3330 my $letter = C4::Letters::GetPreparedLetter (
3331 module => 'circulation',
3332 letter_code => $type,
3333 branchcode => $branch,
3334 message_transport_type => $mtt,
3335 lang => $borrower->{lang},
3337 $issues_table => $item->{itemnumber},
3338 'items' => $item->{itemnumber},
3339 'biblio' => $item->{biblionumber},
3340 'biblioitems' => $item->{biblionumber},
3341 'borrowers' => $borrower,
3342 'branches' => $branch,
3346 $schema->storage->txn_begin;
3347 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3348 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3349 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3350 unless ( $message ) {
3351 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3352 C4::Message->enqueue($letter, $borrower, $mtt);
3354 $message->append($letter);
3357 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3358 $schema->storage->txn_commit;
3364 =head2 updateWrongTransfer
3366 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3368 This function validate the line of brachtransfer but with the wrong destination (mistake from a librarian ...), and create a new line in branchtransfer from the actual library to the original library of reservation
3372 sub updateWrongTransfer {
3373 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3374 my $dbh = C4::Context->dbh;
3375 # first step validate the actual line of transfert .
3378 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3380 $sth->execute($FromLibrary,$itemNumber);
3382 # second step create a new line of branchtransfer to the right location .
3383 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3385 #third step changing holdingbranch of item
3386 UpdateHoldingbranch($FromLibrary,$itemNumber);
3389 =head2 UpdateHoldingbranch
3391 $items = UpdateHoldingbranch($branch,$itmenumber);
3393 Simple methode for updating hodlingbranch in items BDD line
3397 sub UpdateHoldingbranch {
3398 my ( $branch,$itemnumber ) = @_;
3399 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3404 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3406 this function calculates the due date given the start date and configured circulation rules,
3407 checking against the holidays calendar as per the 'useDaysMode' syspref.
3408 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3409 C<$itemtype> = itemtype code of item in question
3410 C<$branch> = location whose calendar to use
3411 C<$borrower> = Borrower object
3412 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3417 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3421 # loanlength now a href
3423 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3425 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3431 if (ref $startdate ne 'DateTime' ) {
3432 $datedue = dt_from_string($datedue);
3434 $datedue = $startdate->clone;
3438 DateTime->now( time_zone => C4::Context->tz() )
3439 ->truncate( to => 'minute' );
3443 # calculate the datedue as normal
3444 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3445 { # ignoring calendar
3446 if ( $loanlength->{lengthunit} eq 'hours' ) {
3447 $datedue->add( hours => $loanlength->{$length_key} );
3449 $datedue->add( days => $loanlength->{$length_key} );
3450 $datedue->set_hour(23);
3451 $datedue->set_minute(59);
3455 if ($loanlength->{lengthunit} eq 'hours') {
3456 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3459 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3461 my $calendar = Koha::Calendar->new( branchcode => $branch );
3462 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3463 if ($loanlength->{lengthunit} eq 'days') {
3464 $datedue->set_hour(23);
3465 $datedue->set_minute(59);
3469 # if Hard Due Dates are used, retrieve them and apply as necessary
3470 my ( $hardduedate, $hardduedatecompare ) =
3471 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3472 if ($hardduedate) { # hardduedates are currently dates
3473 $hardduedate->truncate( to => 'minute' );
3474 $hardduedate->set_hour(23);
3475 $hardduedate->set_minute(59);
3476 my $cmp = DateTime->compare( $hardduedate, $datedue );
3478 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3479 # if the calculated date is before the 'after' Hard Due Date (floor), override
3480 # if the hard due date is set to 'exactly', overrride
3481 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3482 $datedue = $hardduedate->clone;
3485 # in all other cases, keep the date due as it is
3489 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3490 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3491 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3492 if( $expiry_dt ) { #skip empty expiry date..
3493 $expiry_dt->set( hour => 23, minute => 59);
3494 my $d1= $datedue->clone->set_time_zone('floating');
3495 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3496 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3499 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3500 my $calendar = Koha::Calendar->new( branchcode => $branch );
3501 if ( $calendar->is_holiday($datedue) ) {
3502 # Don't return on a closed day
3503 $datedue = $calendar->prev_open_day( $datedue );
3512 sub CheckValidBarcode{
3514 my $dbh = C4::Context->dbh;
3515 my $query=qq|SELECT count(*)
3519 my $sth = $dbh->prepare($query);
3520 $sth->execute($barcode);
3521 my $exist=$sth->fetchrow ;
3525 =head2 IsBranchTransferAllowed
3527 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3529 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3533 sub IsBranchTransferAllowed {
3534 my ( $toBranch, $fromBranch, $code ) = @_;
3536 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3538 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3539 my $dbh = C4::Context->dbh;
3541 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3542 $sth->execute( $toBranch, $fromBranch, $code );
3543 my $limit = $sth->fetchrow_hashref();
3545 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3546 if ( $limit->{'limitId'} ) {
3553 =head2 CreateBranchTransferLimit
3555 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3557 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3561 sub CreateBranchTransferLimit {
3562 my ( $toBranch, $fromBranch, $code ) = @_;
3563 return unless defined($toBranch) && defined($fromBranch);
3564 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3566 my $dbh = C4::Context->dbh;
3568 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3569 return $sth->execute( $code, $toBranch, $fromBranch );
3572 =head2 DeleteBranchTransferLimits
3574 my $result = DeleteBranchTransferLimits($frombranch);
3576 Deletes all the library transfer limits for one library. Returns the
3577 number of limits deleted, 0e0 if no limits were deleted, or undef if
3578 no arguments are supplied.
3582 sub DeleteBranchTransferLimits {
3584 return unless defined $branch;
3585 my $dbh = C4::Context->dbh;
3586 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3587 return $sth->execute($branch);
3591 my ( $borrowernumber, $itemnum ) = @_;
3593 MarkIssueReturned( $borrowernumber, $itemnum );
3594 my $patron = Koha::Patrons->find( $borrowernumber );
3595 my $item = C4::Items::GetItem( $itemnum );
3596 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3597 my @datearr = localtime(time);
3598 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3599 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3600 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3605 my ($itemnumber, $mark_returned) = @_;
3607 $mark_returned //= C4::Context->preference('MarkLostItemsAsReturned');
3609 my $dbh = C4::Context->dbh();
3610 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3612 JOIN items USING (itemnumber)
3613 JOIN biblio USING (biblionumber)
3614 WHERE issues.itemnumber=?");
3615 $sth->execute($itemnumber);
3616 my $issues=$sth->fetchrow_hashref();
3618 # If a borrower lost the item, add a replacement cost to the their record
3619 if ( my $borrowernumber = $issues->{borrowernumber} ){
3620 my $patron = Koha::Patrons->find( $borrowernumber );
3622 if (C4::Context->preference('WhenLostForgiveFine')){
3623 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3624 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3626 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3627 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3628 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3629 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3632 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$patron->privacy) if $mark_returned;
3636 sub GetOfflineOperations {
3637 my $dbh = C4::Context->dbh;
3638 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3639 $sth->execute(C4::Context->userenv->{'branch'});
3640 my $results = $sth->fetchall_arrayref({});
3644 sub GetOfflineOperation {
3645 my $operationid = shift;
3646 return unless $operationid;
3647 my $dbh = C4::Context->dbh;
3648 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3649 $sth->execute( $operationid );
3650 return $sth->fetchrow_hashref;
3653 sub AddOfflineOperation {
3654 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3655 my $dbh = C4::Context->dbh;
3656 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3657 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3661 sub DeleteOfflineOperation {
3662 my $dbh = C4::Context->dbh;
3663 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3664 $sth->execute( shift );
3668 sub ProcessOfflineOperation {
3669 my $operation = shift;
3672 if ( $operation->{action} eq 'return' ) {
3673 $report = ProcessOfflineReturn( $operation );
3674 } elsif ( $operation->{action} eq 'issue' ) {
3675 $report = ProcessOfflineIssue( $operation );
3676 } elsif ( $operation->{action} eq 'payment' ) {
3677 $report = ProcessOfflinePayment( $operation );
3680 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3685 sub ProcessOfflineReturn {
3686 my $operation = shift;
3688 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3691 my $itemnumber = $item->itemnumber;
3692 my $issue = GetOpenIssue( $itemnumber );
3695 $issue->{borrowernumber},
3698 $operation->{timestamp},
3701 { renewals => 0, onloan => undef },
3702 $issue->{'biblionumber'},
3707 return "Item not issued.";
3710 return "Item not found.";
3714 sub ProcessOfflineIssue {
3715 my $operation = shift;
3717 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3720 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3722 return "Barcode not found.";
3724 my $itemnumber = $item->itemnumber;
3725 my $issue = GetOpenIssue( $itemnumber );
3727 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3729 $issue->{borrowernumber},
3732 $operation->{timestamp},
3737 $operation->{'barcode'},
3740 $operation->{timestamp},
3745 return "Borrower not found.";
3749 sub ProcessOfflinePayment {
3750 my $operation = shift;
3752 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} });
3753 my $amount = $operation->{amount};
3755 Koha::Account->new( { patron_id => $patron->id } )->pay( { amount => $amount } );
3763 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3765 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3770 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3772 my $item = GetItem( $itemnumber, $barcode )
3775 return C4::Letters::GetPreparedLetter (
3776 module => 'circulation',
3777 letter_code => 'TRANSFERSLIP',
3778 branchcode => $branch,
3780 'branches' => $to_branch,
3781 'biblio' => $item->{biblionumber},
3787 =head2 CheckIfIssuedToPatron
3789 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3791 Return 1 if any record item is issued to patron, otherwise return 0
3795 sub CheckIfIssuedToPatron {
3796 my ($borrowernumber, $biblionumber) = @_;
3798 my $dbh = C4::Context->dbh;
3800 SELECT COUNT(*) FROM issues
3801 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3802 WHERE items.biblionumber = ?
3803 AND issues.borrowernumber = ?
3805 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3806 return 1 if $is_issued;
3812 IsItemIssued( $itemnumber )
3814 Return 1 if the item is on loan, otherwise return 0
3819 my $itemnumber = shift;
3820 my $dbh = C4::Context->dbh;
3821 my $sth = $dbh->prepare(q{
3824 WHERE itemnumber = ?
3826 $sth->execute($itemnumber);
3827 return $sth->fetchrow;
3830 =head2 GetAgeRestriction
3832 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3833 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3835 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3836 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3838 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3839 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3840 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3841 Negative days mean the borrower has gone past the age restriction age.
3845 sub GetAgeRestriction {
3846 my ($record_restrictions, $borrower) = @_;
3847 my $markers = C4::Context->preference('AgeRestrictionMarker');
3849 # Split $record_restrictions to something like FSK 16 or PEGI 6
3850 my @values = split ' ', uc($record_restrictions);
3851 return unless @values;
3853 # Search first occurrence of one of the markers
3854 my @markers = split /\|/, uc($markers);
3855 return unless @markers;
3858 my $restriction_year = 0;
3859 for my $value (@values) {
3861 for my $marker (@markers) {
3862 $marker =~ s/^\s+//; #remove leading spaces
3863 $marker =~ s/\s+$//; #remove trailing spaces
3864 if ( $marker eq $value ) {
3865 if ( $index <= $#values ) {
3866 $restriction_year += $values[$index];
3870 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3872 # Perhaps it is something like "K16" (as in Finland)
3873 $restriction_year += $1;
3877 last if ( $restriction_year > 0 );
3880 #Check if the borrower is age restricted for this material and for how long.
3881 if ($restriction_year && $borrower) {
3882 if ( $borrower->{'dateofbirth'} ) {
3883 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3884 $alloweddate[0] += $restriction_year;
3886 #Prevent runime eror on leap year (invalid date)
3887 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3888 $alloweddate[2] = 28;
3891 #Get how many days the borrower has to reach the age restriction
3892 my @Today = split /-/, DateTime->today->ymd();
3893 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3894 #Negative days means the borrower went past the age restriction age
3895 return ($restriction_year, $daysToAgeRestriction);
3899 return ($restriction_year);
3903 =head2 GetPendingOnSiteCheckouts
3907 sub GetPendingOnSiteCheckouts {
3908 my $dbh = C4::Context->dbh;
3909 return $dbh->selectall_arrayref(q|
3915 items.itemcallnumber,
3919 issues.date_due < NOW() AS is_overdue,
3922 borrowers.firstname,
3924 borrowers.cardnumber,
3925 borrowers.borrowernumber
3927 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
3928 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
3929 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
3930 WHERE issues.onsite_checkout = 1
3931 |, { Slice => {} } );
3937 my ($count, $branch, $itemtype, $ccode, $newness)
3938 = @$params{qw(count branch itemtype ccode newness)};
3940 my $dbh = C4::Context->dbh;
3943 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
3944 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
3945 i.ccode, SUM(i.issues) AS count
3947 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
3948 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
3951 my (@where_strs, @where_args);
3954 push @where_strs, 'i.homebranch = ?';
3955 push @where_args, $branch;
3958 if (C4::Context->preference('item-level_itypes')){
3959 push @where_strs, 'i.itype = ?';
3960 push @where_args, $itemtype;
3962 push @where_strs, 'bi.itemtype = ?';
3963 push @where_args, $itemtype;
3967 push @where_strs, 'i.ccode = ?';
3968 push @where_args, $ccode;
3971 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
3972 push @where_args, $newness;
3976 $query .= 'WHERE ' . join(' AND ', @where_strs);
3980 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
3981 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
3986 $query .= q{ ) xxx WHERE count > 0 };
3987 $count = int($count);
3989 $query .= "LIMIT $count";
3992 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
3997 sub _CalculateAndUpdateFine {
4000 my $borrower = $params->{borrower};
4001 my $item = $params->{item};
4002 my $issue = $params->{issue};
4003 my $return_date = $params->{return_date};
4005 unless ($borrower) { carp "No borrower passed in!" && return; }
4006 unless ($item) { carp "No item passed in!" && return; }
4007 unless ($issue) { carp "No issue passed in!" && return; }
4009 my $datedue = dt_from_string( $issue->date_due );
4011 # we only need to calculate and change the fines if we want to do that on return
4012 # Should be on for hourly loans
4013 my $control = C4::Context->preference('CircControl');
4014 my $control_branchcode =
4015 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4016 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4017 : $issue->branchcode;
4019 my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4021 my ( $amount, $type, $unitcounttotal ) =
4022 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4026 if ( C4::Context->preference('finesMode') eq 'production' ) {
4027 if ( $amount > 0 ) {
4028 C4::Overdues::UpdateFine({
4029 issue_id => $issue->issue_id,
4030 itemnumber => $issue->itemnumber,
4031 borrowernumber => $issue->borrowernumber,
4034 due => output_pref($datedue),
4037 elsif ($return_date) {
4039 # Backdated returns may have fines that shouldn't exist,
4040 # so in this case, we need to drop those fines to 0
4042 C4::Overdues::UpdateFine({
4043 issue_id => $issue->issue_id,
4044 itemnumber => $issue->itemnumber,
4045 borrowernumber => $issue->borrowernumber,
4048 due => output_pref($datedue),
4060 Koha Development Team <http://koha-community.org/>