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 POSIX qw( floor );
27 use Koha::DateUtils qw( dt_from_string output_pref );
29 use C4::Stats qw( UpdateStats );
30 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest ItemsAnyAvailableAndNotRestricted );
31 use C4::Biblio qw( UpdateTotalIssues );
32 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
34 use C4::ItemCirculationAlertPreference;
36 use C4::Log qw( logaction ); # logaction
38 use C4::RotatingCollections qw(GetCollectionItemBranches);
39 use Algorithm::CheckDigits qw( CheckDigits );
41 use Data::Dumper qw( Dumper );
43 use Koha::AuthorisedValues;
44 use Koha::Biblioitems;
45 use Koha::DateUtils qw( dt_from_string output_pref );
48 use Koha::Illrequests;
51 use Koha::Patron::Debarments qw( DelUniqueDebarment GetDebarments AddUniqueDebarment );
54 use Koha::Account::Lines;
56 use Koha::Account::Lines;
57 use Koha::Account::Offsets;
58 use Koha::Config::SysPrefs;
59 use Koha::Charges::Fees;
60 use Koha::Config::SysPref;
61 use Koha::Checkouts::ReturnClaims;
62 use Koha::SearchEngine::Indexer;
63 use Koha::Exceptions::Checkout;
67 use List::MoreUtils qw( any );
68 use Scalar::Util qw( looks_like_number );
69 use Date::Calc qw( Date_to_Days );
70 our (@ISA, @EXPORT_OK);
76 # FIXME subs that should probably be elsewhere
81 GetPendingOnSiteCheckouts
92 GetLatestAutoRenewDate
95 GetBranchBorrowerCircRule
100 CheckIfIssuedToPatron
115 IsBranchTransferAllowed
116 CreateBranchTransferLimit
117 DeleteBranchTransferLimits
123 DeleteOfflineOperation
124 ProcessOfflineOperation
125 ProcessOfflinePayment
127 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
132 C4::Circulation - Koha circulation module
140 The functions in this module deal with circulation, issues, and
141 returns, as well as general information about the library.
142 Also deals with inventory.
148 $str = &barcodedecode($barcode, [$filter]);
150 Generic filter function for barcode string.
151 Called on every circ if the System Pref itemBarcodeInputFilter is set.
152 Will do some manipulation of the barcode for systems that deliver a barcode
153 to circulation.pl that differs from the barcode stored for the item.
154 For proper functioning of this filter, calling the function on the
155 correct barcode string (items.barcode) should return an unaltered barcode.
157 The optional $filter argument is to allow for testing or explicit
158 behavior that ignores the System Pref. Valid values are the same as the
163 # FIXME -- the &decode fcn below should be wrapped into this one.
164 # FIXME -- these plugins should be moved out of Circulation.pm
167 my ($barcode, $filter) = @_;
168 my $branch = C4::Context::mybranch();
169 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
170 Koha::Plugins->call('item_barcode_transform', \$barcode );
171 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
172 if ($filter eq 'whitespace') {
174 } elsif ($filter eq 'cuecat') {
176 my @fields = split( /\./, $barcode );
177 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
178 ($#results == 2) and return $results[2];
179 } elsif ($filter eq 'T-prefix') {
180 if ($barcode =~ /^[Tt](\d)/) {
181 (defined($1) and $1 eq '0') and return $barcode;
182 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
184 return sprintf("T%07d", $barcode);
185 # FIXME: $barcode could be "T1", causing warning: substr outside of string
186 # Why drop the nonzero digit after the T?
187 # Why pass non-digits (or empty string) to "T%07d"?
188 } elsif ($filter eq 'libsuite8') {
189 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
190 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
191 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
193 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
196 } elsif ($filter eq 'EAN13') {
197 my $ean = CheckDigits('ean');
198 if ( $ean->is_valid($barcode) ) {
199 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
200 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
202 warn "# [$barcode] not valid EAN-13/UPC-A\n";
205 return $barcode; # return barcode, modified or not
210 $str = &_decode($chunk);
212 Decodes a segment of a string emitted by a CueCat barcode scanner and
215 FIXME: Should be replaced with Barcode::Cuecat from CPAN
216 or Javascript based decoding on the client side.
223 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
224 my @s = map { index( $seq, $_ ); } split( //, $encoded );
225 my $l = ( $#s + 1 ) % 4;
228 # warn "Error: Cuecat decode parsing failed!";
236 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
238 chr( ( $n >> 16 ) ^ 67 )
239 .chr( ( $n >> 8 & 255 ) ^ 67 )
240 .chr( ( $n & 255 ) ^ 67 );
243 $r = substr( $r, 0, length($r) - $l );
249 ($dotransfer, $messages, $iteminformation) = &transferbook({
250 from_branch => $frombranch
251 to_branch => $tobranch,
253 ignore_reserves => $ignore_reserves,
257 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
259 C<$fbr> is the code for the branch initiating the transfer.
260 C<$tbr> is the code for the branch to which the item should be transferred.
262 C<$barcode> is the barcode of the item to be transferred.
264 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
265 Otherwise, if an item is reserved, the transfer fails.
267 C<$trigger> is the enum value for what triggered the transfer.
269 Returns three values:
275 is true if the transfer was successful.
279 is a reference-to-hash which may have any of the following keys:
285 There is no item in the catalog with the given barcode. The value is C<$barcode>.
287 =item C<DestinationEqualsHolding>
289 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.
293 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.
297 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>.
299 =item C<WasTransferred>
301 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
303 =item C<RecallPlacedAtHoldingBranch>
305 A recall for this item was found, and the transfer has already been completed as the item's branch matches the recall's pickup branch.
309 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
319 my $tbr = $params->{to_branch};
320 my $fbr = $params->{from_branch};
321 my $ignoreRs = $params->{ignore_reserves};
322 my $barcode = $params->{barcode};
323 my $trigger = $params->{trigger};
326 my $item = Koha::Items->find( { barcode => $barcode } );
328 Koha::Exceptions::MissingParameter->throw(
329 "Missing mandatory parameter: from_branch")
332 Koha::Exceptions::MissingParameter->throw(
333 "Missing mandatory parameter: to_branch")
338 $messages->{'BadBarcode'} = $barcode;
340 return ( $dotransfer, $messages );
343 my $itemnumber = $item->itemnumber;
344 # get branches of book...
345 my $hbr = $item->homebranch;
347 # if using Branch Transfer Limits
348 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
349 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
350 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
351 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
352 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
355 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
356 $messages->{'NotAllowed'} = $tbr . "::" . $code;
361 # can't transfer book if is already there....
362 if ( $fbr eq $tbr ) {
363 $messages->{'DestinationEqualsHolding'} = 1;
367 # check if it is still issued to someone, return it...
368 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
370 AddReturn( $barcode, $fbr );
371 $messages->{'WasReturned'} = $issue->borrowernumber;
375 # That'll save a database query.
376 my ( $resfound, $resrec, undef ) =
377 CheckReserves( $itemnumber );
379 $resrec->{'ResFound'} = $resfound;
380 $messages->{'ResFound'} = $resrec;
381 $dotransfer = 0 unless $ignoreRs;
385 if ( C4::Context->preference('UseRecalls') ) {
386 my $recall = Koha::Recalls->find({ itemnumber => $itemnumber, status => 'in_transit' });
387 if ( defined $recall ) {
388 # do a transfer if the recall branch is different to the item holding branch
389 if ( $recall->branchcode eq $fbr ) {
391 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
394 $messages->{'RecallFound'} = $recall;
399 #actually do the transfer....
401 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
403 # don't need to update MARC anymore, we do it in batch now
404 $messages->{'WasTransfered'} = $tbr;
407 ModDateLastSeen( $itemnumber );
408 return ( $dotransfer, $messages );
413 my $borrower = shift;
414 my $item_object = shift;
416 my $onsite_checkout = $params->{onsite_checkout} || 0;
417 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
418 my $cat_borrower = $borrower->{'categorycode'};
419 my $dbh = C4::Context->dbh;
420 # Get which branchcode we need
421 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
422 my $type = $item_object->effective_itemtype;
424 my ($type_object, $parent_type, $parent_maxissueqty_rule);
425 $type_object = Koha::ItemTypes->find( $type );
426 $parent_type = $type_object->parent_type if $type_object;
427 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
428 # Find any children if we are a parent_type;
430 # given branch, patron category, and item type, determine
431 # applicable issuing rule
433 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
435 categorycode => $cat_borrower,
436 itemtype => $parent_type,
437 branchcode => $branch,
438 rule_name => 'maxissueqty',
441 # If the parent rule is for default type we discount it
442 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
444 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
446 categorycode => $cat_borrower,
448 branchcode => $branch,
449 rule_name => 'maxissueqty',
453 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
455 categorycode => $cat_borrower,
457 branchcode => $branch,
458 rule_name => 'maxonsiteissueqty',
463 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
464 # if a rule is found and has a loan limit set, count
465 # how many loans the patron already has that meet that
467 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
470 if ( $maxissueqty_rule->branchcode ) {
471 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
472 $checkouts = $patron->checkouts->search(
473 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
474 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
475 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
477 $checkouts = $patron->checkouts->search(
478 { 'item.homebranch' => $maxissueqty_rule->branchcode } );
481 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
483 $checkouts = $checkouts->search(undef, { prefetch => 'item' });
486 my $rule_itemtype = $maxissueqty_rule->itemtype;
489 unless ( $rule_itemtype ) {
490 # matching rule has the default item type, so count only
491 # those existing loans that don't fall under a more
493 @types = Koha::CirculationRules->search(
495 branchcode => $maxissueqty_rule->branchcode,
496 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
497 itemtype => { '!=' => undef },
498 rule_name => 'maxissueqty'
500 )->get_column('itemtype');
502 if ( $parent_maxissueqty_rule ) {
503 # if we have a parent item type then we count loans of the
504 # specific item type or its siblings or parent
505 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
506 @types = $children->get_column('itemtype');
507 push @types, $parent_type;
508 } elsif ( $child_types ) {
509 # If we are a parent type, we need to count all child types and our own type
510 @types = $child_types->get_column('itemtype');
511 push @types, $type; # And don't forget to count our own types
513 # Otherwise only count the specific itemtype
518 while ( my $c = $checkouts->next ) {
519 my $itemtype = $c->item->effective_itemtype;
521 unless ( $rule_itemtype ) {
522 next if grep {$_ eq $itemtype} @types;
524 next unless grep {$_ eq $itemtype} @types;
527 $sum_checkouts->{total}++;
528 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
529 $sum_checkouts->{itemtype}->{$itemtype}++;
532 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
533 my $checkout_count = $sum_checkouts->{total} || 0;
534 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
536 my $checkout_rules = {
537 checkout_count => $checkout_count,
538 onsite_checkout_count => $onsite_checkout_count,
539 onsite_checkout => $onsite_checkout,
540 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
541 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
542 switch_onsite_checkout => $switch_onsite_checkout,
544 # If parent rules exists
545 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
546 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
547 my $qty_over = _check_max_qty($checkout_rules);
548 return $qty_over if defined $qty_over;
550 # If the parent rule is less than or equal to the child, we only need check the parent
551 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
552 $checkout_rules->{checkout_count} = $checkout_count_type;
553 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
554 my $qty_over = _check_max_qty($checkout_rules);
555 return $qty_over if defined $qty_over;
558 my $qty_over = _check_max_qty($checkout_rules);
559 return $qty_over if defined $qty_over;
563 # Now count total loans against the limit for the branch
564 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
565 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
567 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
568 $checkouts = $patron->checkouts->search(
569 { 'me.branchcode' => $branch} );
570 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
571 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
573 $checkouts = $patron->checkouts->search(
574 { 'item.homebranch' => $branch},
575 { prefetch => 'item' } );
578 my $checkout_count = $checkouts->count;
579 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
580 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
581 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
583 my $qty_over = _check_max_qty(
585 checkout_count => $checkout_count,
586 onsite_checkout_count => $onsite_checkout_count,
587 onsite_checkout => $onsite_checkout,
588 max_checkouts_allowed => $max_checkouts_allowed,
589 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
590 switch_onsite_checkout => $switch_onsite_checkout
593 return $qty_over if defined $qty_over;
596 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
597 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
600 # OK, the patron can issue !!!
606 my $checkout_count = $params->{checkout_count};
607 my $onsite_checkout_count = $params->{onsite_checkout_count};
608 my $onsite_checkout = $params->{onsite_checkout};
609 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
610 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
611 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
613 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
614 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
615 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
617 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
618 count => $onsite_checkout_count,
619 max_allowed => $max_onsite_checkouts_allowed,
623 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
624 if ( $max_checkouts_allowed eq '' ) { return; }
625 my $delta = $switch_onsite_checkout ? 1 : 0;
626 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
628 reason => 'TOO_MANY_CHECKOUTS',
629 count => $checkout_count,
630 max_allowed => $max_checkouts_allowed,
634 elsif ( not $onsite_checkout ) {
635 if ( $max_checkouts_allowed eq '' ) { return; }
637 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
640 reason => 'TOO_MANY_CHECKOUTS',
641 count => $checkout_count - $onsite_checkout_count,
642 max_allowed => $max_checkouts_allowed,
650 =head2 CanBookBeIssued
652 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
653 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
655 Check if a book can be issued.
657 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
659 IMPORTANT: The assumption by users of this routine is that causes blocking
660 the issue are keyed by uppercase labels and other returned
661 data is keyed in lower case!
665 =item C<$patron> is a Koha::Patron
667 =item C<$barcode> is the bar code of the book being issued.
669 =item C<$duedates> is a DateTime object.
671 =item C<$inprocess> boolean switch
673 =item C<$ignore_reserves> boolean switch
675 =item C<$params> Hashref of additional parameters
678 override_high_holds - Ignore high holds
679 onsite_checkout - Checkout is an onsite checkout that will not leave the library
687 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
688 Possible values are :
694 sticky due date is invalid
698 borrower gone with no address
702 borrower declared it's card lost
708 =head3 UNKNOWN_BARCODE
722 item is restricted (set by ??)
724 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
725 could be prevented, but ones that can be overriden by the operator.
727 Possible values are :
735 renewing, not issuing
737 =head3 ISSUED_TO_ANOTHER
739 issued to someone else.
743 reserved for someone else.
747 reserved and being transferred for someone else.
751 sticky due date is invalid or due date in the past
755 if the borrower borrows to much things
759 recalled by someone else
763 sub CanBookBeIssued {
764 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
765 my %needsconfirmation; # filled with problems that needs confirmations
766 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
767 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
768 my %messages; # filled with information messages that should be displayed.
770 my $onsite_checkout = $params->{onsite_checkout} || 0;
771 my $override_high_holds = $params->{override_high_holds} || 0;
773 my $item_object = Koha::Items->find({barcode => $barcode });
775 # MANDATORY CHECKS - unless item exists, nothing else matters
776 unless ( $item_object ) {
777 $issuingimpossible{UNKNOWN_BARCODE} = 1;
779 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
781 my $item_unblessed = $item_object->unblessed; # Transition...
782 my $issue = $item_object->checkout;
783 my $biblio = $item_object->biblio;
785 my $biblioitem = $biblio->biblioitem;
786 my $effective_itemtype = $item_object->effective_itemtype;
787 my $dbh = C4::Context->dbh;
788 my $patron_unblessed = $patron->unblessed;
790 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
792 # DUE DATE is OK ? -- should already have checked.
794 if ($duedate && ref $duedate ne 'DateTime') {
795 $duedate = dt_from_string($duedate);
797 my $now = dt_from_string();
798 unless ( $duedate ) {
799 my $issuedate = $now->clone();
801 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
803 # Offline circ calls AddIssue directly, doesn't run through here
804 # So issuingimpossible should be ok.
807 my $fees = Koha::Charges::Fees->new(
810 library => $circ_library,
811 item => $item_object,
817 my $today = $now->clone();
818 $today->truncate( to => 'minute');
819 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
820 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
823 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
829 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
830 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
831 C4::Stats::UpdateStats({
832 branch => C4::Context->userenv->{'branch'},
834 itemnumber => $item_object->itemnumber,
835 itemtype => $effective_itemtype,
836 borrowernumber => $patron->borrowernumber,
837 ccode => $item_object->ccode}
839 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
840 return( { STATS => 1 }, {});
843 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
844 $issuingimpossible{GNA} = 1;
847 if ( $patron->lost && $patron->lost == 1 ) {
848 $issuingimpossible{CARD_LOST} = 1;
850 if ( $patron->is_debarred ) {
851 $issuingimpossible{DEBARRED} = 1;
854 if ( $patron->is_expired ) {
855 $issuingimpossible{EXPIRED} = 1;
863 my $account = $patron->account;
864 my $balance = $account->balance;
865 my $non_issues_charges = $account->non_issues_charges;
866 my $other_charges = $balance - $non_issues_charges;
868 my $amountlimit = C4::Context->preference("noissuescharge");
869 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
870 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
872 # Check the debt of this patrons guarantees
873 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
874 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
875 if ( defined $no_issues_charge_guarantees ) {
876 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
877 my $guarantees_non_issues_charges = 0;
878 foreach my $g ( @guarantees ) {
879 $guarantees_non_issues_charges += $g->account->non_issues_charges;
882 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
883 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
884 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
885 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
886 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
887 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
891 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
892 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
893 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
894 if ( defined $no_issues_charge_guarantors ) {
895 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
897 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
898 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
899 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
900 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
901 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
902 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
906 if ( C4::Context->preference("IssuingInProcess") ) {
907 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
908 $issuingimpossible{DEBT} = $non_issues_charges;
909 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
910 $needsconfirmation{DEBT} = $non_issues_charges;
911 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
912 $needsconfirmation{DEBT} = $non_issues_charges;
916 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
917 $needsconfirmation{DEBT} = $non_issues_charges;
918 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
919 $issuingimpossible{DEBT} = $non_issues_charges;
920 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
921 $needsconfirmation{DEBT} = $non_issues_charges;
925 if ($balance > 0 && $other_charges > 0) {
926 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
929 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
930 $patron_unblessed = $patron->unblessed;
932 if ( my $debarred_date = $patron->is_debarred ) {
933 # patron has accrued fine days or has a restriction. $count is a date
934 if ($debarred_date eq '9999-12-31') {
935 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
938 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
940 } elsif ( my $num_overdues = $patron->has_overdues ) {
941 ## patron has outstanding overdue loans
942 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
943 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
945 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
946 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
950 # Additional Materials Check
951 if ( C4::Context->preference("CircConfirmItemParts")
952 && $item_object->materials )
954 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
958 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
960 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
962 # Already issued to current borrower.
963 # If it is an on-site checkout if it can be switched to a normal checkout
964 # or ask whether the loan should be renewed
966 if ( $issue->onsite_checkout
967 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
968 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
970 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
971 $patron->borrowernumber,
972 $item_object->itemnumber,
974 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
975 if ( $renewerror eq 'onsite_checkout' ) {
976 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
979 $issuingimpossible{NO_MORE_RENEWALS} = 1;
983 $needsconfirmation{RENEW_ISSUE} = 1;
989 # issued to someone else
991 my $patron = Koha::Patrons->find( $issue->borrowernumber );
993 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
995 unless ( $can_be_returned ) {
996 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
997 $issuingimpossible{branch_to_return} = $message;
999 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
1000 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
1002 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
1003 $needsconfirmation{issued_firstname} = $patron->firstname;
1004 $needsconfirmation{issued_surname} = $patron->surname;
1005 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
1006 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
1011 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1013 my $switch_onsite_checkout = (
1014 C4::Context->preference('SwitchOnSiteCheckouts')
1016 and $issue->onsite_checkout
1017 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1018 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1019 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1020 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1021 if ( $toomany->{max_allowed} == 0 ) {
1022 $needsconfirmation{PATRON_CANT} = 1;
1024 if ( C4::Context->preference("AllowTooManyOverride") ) {
1025 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1026 $needsconfirmation{current_loan_count} = $toomany->{count};
1027 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1029 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1030 $issuingimpossible{current_loan_count} = $toomany->{count};
1031 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1036 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1038 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1039 my $wants_check = $patron->wants_check_for_previous_checkout;
1040 $needsconfirmation{PREVISSUE} = 1
1041 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1046 if ( $item_object->notforloan )
1048 if(!C4::Context->preference("AllowNotForLoanOverride")){
1049 $issuingimpossible{NOT_FOR_LOAN} = 1;
1050 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1052 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1053 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1057 # we have to check itemtypes.notforloan also
1058 if (C4::Context->preference('item-level_itypes')){
1059 # this should probably be a subroutine
1060 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1061 $sth->execute($effective_itemtype);
1062 my $notforloan=$sth->fetchrow_hashref();
1063 if ($notforloan->{'notforloan'}) {
1064 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1065 $issuingimpossible{NOT_FOR_LOAN} = 1;
1066 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1068 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1069 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1074 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1075 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1076 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1077 $issuingimpossible{NOT_FOR_LOAN} = 1;
1078 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1080 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1081 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1086 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1088 $issuingimpossible{WTHDRAWN} = 1;
1090 if ( $item_object->restricted
1091 && $item_object->restricted == 1 )
1093 $issuingimpossible{RESTRICTED} = 1;
1095 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1096 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1097 my $code = $av->count ? $av->next->lib : '';
1098 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1099 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1101 if ( C4::Context->preference("IndependentBranches") ) {
1102 my $userenv = C4::Context->userenv;
1103 unless ( C4::Context->IsSuperLibrarian() ) {
1104 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1105 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1106 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1107 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1109 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1110 if ( $patron->branchcode ne $userenv->{branch} );
1115 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1117 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1118 if ($rentalConfirmation) {
1119 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1121 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1122 if ($itemtype_object) {
1123 my $accumulate_charge = $fees->accumulate_rentalcharge();
1124 if ( $accumulate_charge > 0 ) {
1125 $rentalCharge += $accumulate_charge;
1129 if ( $rentalCharge > 0 ) {
1130 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1135 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1136 # Only bother doing this if UseRecalls is enabled and the item is recallable
1137 # Don't look at recalls that are in transit
1138 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1139 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'recalldate' } })->filter_by_current->as_list;
1141 foreach my $r ( @recalls ) {
1142 if ( $r->itemnumber and
1143 $r->itemnumber == $item_object->itemnumber and
1144 $r->borrowernumber == $patron->borrowernumber and
1145 ( $r->waiting or $r->requested ) ) {
1146 $messages{RECALLED} = $r->recall_id;
1148 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1151 elsif ( $r->itemnumber and
1152 $r->itemnumber == $item_object->itemnumber and
1154 # recalled item is in transit
1155 $issuingimpossible{RECALLED_INTRANSIT} = $r->branchcode;
1157 elsif ( $r->item_level_recall and
1158 $r->itemnumber == $item_object->itemnumber and
1159 $r->borrowernumber != $patron->borrowernumber and
1161 # this specific item has been recalled by a different patron
1162 $needsconfirmation{RECALLED} = $r;
1166 elsif ( !$r->item_level_recall and
1167 $r->borrowernumber != $patron->borrowernumber and
1169 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1170 $needsconfirmation{RECALLED} = $r;
1177 unless ( $ignore_reserves and defined $recall ) {
1178 # See if the item is on reserve.
1179 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1181 my $resbor = $res->{'borrowernumber'};
1182 if ( $resbor ne $patron->borrowernumber ) {
1183 my $patron = Koha::Patrons->find( $resbor );
1184 if ( $restype eq "Waiting" )
1186 # The item is on reserve and waiting, but has been
1187 # reserved by some other patron.
1188 $needsconfirmation{RESERVE_WAITING} = 1;
1189 $needsconfirmation{'resfirstname'} = $patron->firstname;
1190 $needsconfirmation{'ressurname'} = $patron->surname;
1191 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1192 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1193 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1194 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1195 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1197 elsif ( $restype eq "Reserved" ) {
1198 # The item is on reserve for someone else.
1199 $needsconfirmation{RESERVED} = 1;
1200 $needsconfirmation{'resfirstname'} = $patron->firstname;
1201 $needsconfirmation{'ressurname'} = $patron->surname;
1202 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1203 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1204 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1205 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1206 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1208 elsif ( $restype eq "Transferred" ) {
1209 # The item is determined hold being transferred for someone else.
1210 $needsconfirmation{TRANSFERRED} = 1;
1211 $needsconfirmation{'resfirstname'} = $patron->firstname;
1212 $needsconfirmation{'ressurname'} = $patron->surname;
1213 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1214 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1215 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1216 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1217 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1219 elsif ( $restype eq "Processing" ) {
1220 # The item is determined hold being processed for someone else.
1221 $needsconfirmation{PROCESSING} = 1;
1222 $needsconfirmation{'resfirstname'} = $patron->firstname;
1223 $needsconfirmation{'ressurname'} = $patron->surname;
1224 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1225 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1226 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1227 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1228 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1234 ## CHECK AGE RESTRICTION
1235 my $agerestriction = $biblioitem->agerestriction;
1236 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1237 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1238 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1239 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1242 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1246 ## check for high holds decreasing loan period
1247 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1248 my $check = checkHighHolds( $item_object, $patron );
1250 if ( $check->{exceeded} ) {
1251 if ($override_high_holds) {
1252 $alerts{HIGHHOLDS} = {
1253 num_holds => $check->{outstanding},
1254 duration => $check->{duration},
1255 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1259 $needsconfirmation{HIGHHOLDS} = {
1260 num_holds => $check->{outstanding},
1261 duration => $check->{duration},
1262 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1269 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1270 # don't do the multiple loans per bib check if we've
1271 # already determined that we've got a loan on the same item
1272 !$issuingimpossible{NO_MORE_RENEWALS} &&
1273 !$needsconfirmation{RENEW_ISSUE}
1275 # Check if borrower has already issued an item from the same biblio
1276 # Only if it's not a subscription
1277 my $biblionumber = $item_object->biblionumber;
1278 require C4::Serials;
1279 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1280 unless ($is_a_subscription) {
1281 # FIXME Should be $patron->checkouts($args);
1282 my $checkouts = Koha::Checkouts->search(
1284 borrowernumber => $patron->borrowernumber,
1285 biblionumber => $biblionumber,
1291 # if we get here, we don't already have a loan on this item,
1292 # so if there are any loans on this bib, ask for confirmation
1293 if ( $checkouts->count ) {
1294 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1299 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1302 =head2 CanBookBeReturned
1304 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1306 Check whether the item can be returned to the provided branch
1310 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1312 =item C<$branch> is the branchcode where the return is taking place
1320 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1322 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1328 sub CanBookBeReturned {
1329 my ($item, $branch) = @_;
1330 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1332 # assume return is allowed to start
1336 # identify all cases where return is forbidden
1337 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1339 $message = $item->{'homebranch'};
1340 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1342 $message = $item->{'holdingbranch'};
1343 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1345 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1348 return ($allowed, $message);
1351 =head2 CheckHighHolds
1353 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1354 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1355 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1359 sub checkHighHolds {
1360 my ( $item, $patron ) = @_;
1361 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1370 my $holds = Koha::Holds->search( { biblionumber => $item->biblionumber } );
1372 if ( $holds->count() ) {
1373 $return_data->{outstanding} = $holds->count();
1375 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1376 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1377 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1379 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1381 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1383 # static means just more than a given number of holds on the record
1385 # If the number of holds is less than the threshold, we can stop here
1386 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1387 return $return_data;
1390 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1392 # dynamic means X more than the number of holdable items on the record
1394 # let's get the items
1395 my @items = $holds->next()->biblio()->items()->as_list;
1397 # Remove any items with status defined to be ignored even if the would not make item unholdable
1398 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1399 @items = grep { !$_->$status } @items;
1402 # Remove any items that are not holdable for this patron
1403 @items = grep { CanItemBeReserved( $patron , $_, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1405 my $items_count = scalar @items;
1407 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1409 # If the number of holds is less than the count of items we have
1410 # plus the number of holds allowed above that count, we can stop here
1411 if ( $holds->count() <= $threshold ) {
1412 return $return_data;
1416 my $issuedate = dt_from_string();
1418 my $itype = $item->effective_itemtype;
1419 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1421 categorycode => $patron->categorycode,
1423 branchcode => $branchcode,
1426 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1428 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1430 my $rule = Koha::CirculationRules->get_effective_rule(
1432 categorycode => $patron->categorycode,
1433 itemtype => $item->effective_itemtype,
1434 branchcode => $branchcode,
1435 rule_name => 'decreaseloanholds',
1440 if ( defined($rule) && $rule->rule_value ne '' ){
1441 # overrides decreaseLoanHighHoldsDuration syspref
1442 $duration = $rule->rule_value;
1444 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1446 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1447 $reduced_datedue->set_hour($orig_due->hour);
1448 $reduced_datedue->set_minute($orig_due->minute);
1449 $reduced_datedue->truncate( to => 'minute' );
1451 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1452 $return_data->{exceeded} = 1;
1453 $return_data->{duration} = $duration;
1454 $return_data->{due_date} = $reduced_datedue;
1458 return $return_data;
1463 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1465 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1469 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1471 =item C<$barcode> is the barcode of the item being issued.
1473 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1474 Calculated if empty.
1476 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1478 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1479 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1481 AddIssue does the following things :
1483 - step 01: check that there is a borrowernumber & a barcode provided
1484 - check for RENEWAL (book issued & being issued to the same patron)
1485 - renewal YES = Calculate Charge & renew
1487 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1489 - fill reserve if reserve to this patron
1490 - cancel reserve or not, otherwise
1492 - fill recall if recall to this patron
1493 - cancel recall or not
1494 - revert recall's waiting status or not
1495 * TRANSFERT PENDING ?
1496 - complete the transfert
1504 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1506 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1507 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1508 my $auto_renew = $params && $params->{auto_renew};
1509 my $cancel_recall = $params && $params->{cancel_recall};
1510 my $recall_id = $params && $params->{recall_id};
1511 my $dbh = C4::Context->dbh;
1512 my $barcodecheck = CheckValidBarcode($barcode);
1516 if ( $datedue && ref $datedue ne 'DateTime' ) {
1517 $datedue = dt_from_string($datedue);
1520 # $issuedate defaults to today.
1521 if ( !defined $issuedate ) {
1522 $issuedate = dt_from_string();
1525 if ( ref $issuedate ne 'DateTime' ) {
1526 $issuedate = dt_from_string($issuedate);
1531 # Stop here if the patron or barcode doesn't exist
1532 if ( $borrower && $barcode && $barcodecheck ) {
1533 # find which item we issue
1534 my $item_object = Koha::Items->find({ barcode => $barcode })
1535 or return; # if we don't get an Item, abort.
1536 my $item_unblessed = $item_object->unblessed;
1538 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1540 # get actual issuing if there is one
1541 my $actualissue = $item_object->checkout;
1543 # check if we just renew the issue.
1544 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1545 and not $switch_onsite_checkout ) {
1546 $datedue = AddRenewal(
1547 $borrower->{'borrowernumber'},
1548 $item_object->itemnumber,
1551 $issuedate, # here interpreted as the renewal date
1556 my $itype = $item_object->effective_itemtype;
1557 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1560 $datedue->truncate( to => 'minute' );
1562 my $patron = Koha::Patrons->find( $borrower );
1563 my $library = Koha::Libraries->find( $branchcode );
1564 my $fees = Koha::Charges::Fees->new(
1567 library => $library,
1568 item => $item_object,
1569 to_date => $datedue,
1573 # it's NOT a renewal
1574 if ( $actualissue and not $switch_onsite_checkout ) {
1575 # This book is currently on loan, but not to the person
1576 # who wants to borrow it now. mark it returned before issuing to the new borrower
1577 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1578 return unless $allowed;
1579 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1580 # AddReturn certainly has side-effects, like onloan => undef
1581 $item_object->discard_changes;
1584 if ( C4::Context->preference('UseRecalls') ) {
1585 Koha::Recalls->move_recall(
1587 action => $cancel_recall,
1588 recall_id => $recall_id,
1589 item => $item_object,
1590 borrowernumber => $borrower->{borrowernumber},
1595 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1597 # Starting process for transfer job (checking transfert and validate it if we have one)
1598 if ( my $transfer = $item_object->get_transfer ) {
1599 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1602 datearrived => dt_from_string,
1603 tobranch => C4::Context->userenv->{branch},
1604 comments => 'Forced branchtransfer'
1607 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1608 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1609 if ( $hold ) { # Is this really needed?
1610 $hold->set( { found => undef } )->store;
1611 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1616 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1617 unless ($auto_renew) {
1618 my $rule = Koha::CirculationRules->get_effective_rule(
1620 categorycode => $borrower->{categorycode},
1621 itemtype => $item_object->effective_itemtype,
1622 branchcode => $branchcode,
1623 rule_name => 'auto_renew'
1627 $auto_renew = $rule->rule_value if $rule;
1630 my $issue_attributes = {
1631 borrowernumber => $borrower->{'borrowernumber'},
1632 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1633 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1634 branchcode => C4::Context->userenv->{'branch'},
1635 onsite_checkout => $onsite_checkout,
1636 auto_renew => $auto_renew ? 1 : 0,
1639 # Get ID of logged in user. if called from a batch job,
1640 # no user session exists and C4::Context->userenv() returns
1641 # the scalar '0'. Only do this if the syspref says so
1642 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1643 my $userenv = C4::Context->userenv();
1644 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1646 $issue_attributes->{issuer_id} = $usernumber;
1650 # In the case that the borrower has an on-site checkout
1651 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1652 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1654 $issue->set($issue_attributes)->store;
1657 $issue = Koha::Checkout->new(
1659 itemnumber => $item_object->itemnumber,
1664 $issue->discard_changes;
1665 C4::Auth::track_login_daily( $borrower->{userid} );
1666 if ( $item_object->location && $item_object->location eq 'CART'
1667 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1668 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1669 CartToShelf( $item_object->itemnumber );
1672 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1673 UpdateTotalIssues( $item_object->biblionumber, 1 );
1676 # Record if item was lost
1677 my $was_lost = $item_object->itemlost;
1679 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1680 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1681 $item_object->itemlost(0);
1682 $item_object->onloan($datedue->ymd());
1683 $item_object->datelastborrowed( dt_from_string()->ymd() );
1684 $item_object->datelastseen( dt_from_string()->ymd() );
1685 $item_object->store({log_action => 0});
1687 # If the item was lost, it has now been found, charge the overdue if necessary
1689 if ( $item_object->{_charge} ) {
1690 $actualissue //= Koha::Old::Checkouts->search(
1691 { itemnumber => $item_unblessed->{itemnumber} },
1693 order_by => { '-desc' => 'returndate' },
1697 unless ( exists( $borrower->{branchcode} ) ) {
1698 my $patron = $actualissue->patron;
1699 $borrower = $patron->unblessed;
1701 _CalculateAndUpdateFine(
1703 issue => $actualissue,
1704 item => $item_unblessed,
1705 borrower => $borrower,
1706 return_date => $issuedate
1709 _FixOverduesOnReturn( $borrower->{borrowernumber},
1710 $item_object->itemnumber, undef, 'RENEWED' );
1714 # If it costs to borrow this book, charge it to the patron's account.
1715 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1716 if ( $charge && $charge > 0 ) {
1717 AddIssuingCharge( $issue, $charge, 'RENT' );
1720 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1721 if ( $itemtype_object ) {
1722 my $accumulate_charge = $fees->accumulate_rentalcharge();
1723 if ( $accumulate_charge > 0 ) {
1724 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1725 $charge += $accumulate_charge;
1726 $item_unblessed->{charge} = $charge;
1730 # Record the fact that this book was issued.
1731 C4::Stats::UpdateStats(
1733 branch => C4::Context->userenv->{'branch'},
1734 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1736 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1737 itemnumber => $item_object->itemnumber,
1738 itemtype => $item_object->effective_itemtype,
1739 location => $item_object->location,
1740 borrowernumber => $borrower->{'borrowernumber'},
1741 ccode => $item_object->ccode,
1745 # Send a checkout slip.
1746 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1748 branchcode => $branchcode,
1749 categorycode => $borrower->{categorycode},
1750 item_type => $item_object->effective_itemtype,
1751 notification => 'CHECKOUT',
1753 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1754 SendCirculationAlert(
1757 item => $item_object->unblessed,
1758 borrower => $borrower,
1759 branch => $branchcode,
1764 "CIRCULATION", "ISSUE",
1765 $borrower->{'borrowernumber'},
1766 $item_object->itemnumber,
1767 ) if C4::Context->preference("IssueLog");
1769 Koha::Plugins->call('after_circ_action', {
1770 action => 'checkout',
1772 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1773 checkout => $issue->get_from_storage
1781 =head2 GetLoanLength
1783 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1785 Get loan length for an itemtype, a borrower type and a branch
1790 my ( $categorycode, $itemtype, $branchcode ) = @_;
1792 # Initialize default values
1796 lengthunit => 'days',
1799 my $found = Koha::CirculationRules->get_effective_rules( {
1800 branchcode => $branchcode,
1801 categorycode => $categorycode,
1802 itemtype => $itemtype,
1811 foreach my $rule_name (keys %$found) {
1812 $rules->{$rule_name} = $found->{$rule_name};
1819 =head2 GetHardDueDate
1821 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1823 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1827 sub GetHardDueDate {
1828 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1830 my $rules = Koha::CirculationRules->get_effective_rules(
1832 categorycode => $borrowertype,
1833 itemtype => $itemtype,
1834 branchcode => $branchcode,
1835 rules => [ 'hardduedate', 'hardduedatecompare' ],
1839 if ( defined( $rules->{hardduedate} ) ) {
1840 if ( $rules->{hardduedate} ) {
1841 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1844 return ( undef, undef );
1849 =head2 GetBranchBorrowerCircRule
1851 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1853 Retrieves circulation rule attributes that apply to the given
1854 branch and patron category, regardless of item type.
1855 The return value is a hashref containing the following key:
1857 patron_maxissueqty - maximum number of loans that a
1858 patron of the given category can have at the given
1859 branch. If the value is undef, no limit.
1861 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1862 patron of the given category can have at the given
1863 branch. If the value is undef, no limit.
1865 This will check for different branch/category combinations in the following order:
1869 default branch and category
1871 If no rule has been found in the database, it will default to
1874 patron_maxissueqty - undef
1875 patron_maxonsiteissueqty - undef
1877 C<$branchcode> and C<$categorycode> should contain the
1878 literal branch code and patron category code, respectively - no
1883 sub GetBranchBorrowerCircRule {
1884 my ( $branchcode, $categorycode ) = @_;
1886 # Initialize default values
1888 patron_maxissueqty => undef,
1889 patron_maxonsiteissueqty => undef,
1893 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1894 my $rule = Koha::CirculationRules->get_effective_rule(
1896 categorycode => $categorycode,
1898 branchcode => $branchcode,
1899 rule_name => $rule_name,
1903 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1909 =head2 GetBranchItemRule
1911 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1913 Retrieves circulation rule attributes that apply to the given
1914 branch and item type, regardless of patron category.
1916 The return value is a hashref containing the following keys:
1918 holdallowed => Hold policy for this branch and itemtype. Possible values:
1919 not_allowed: No holds allowed.
1920 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1921 from_any_library: Holds allowed from any patron.
1922 from_local_hold_group: Holds allowed from libraries in hold group
1924 returnbranch => branch to which to return item. Possible values:
1925 noreturn: do not return, let item remain where checked in (floating collections)
1926 homebranch: return to item's home branch
1927 holdingbranch: return to issuer branch
1929 This searches branchitemrules in the following order:
1931 * Same branchcode and itemtype
1932 * Same branchcode, itemtype '*'
1933 * branchcode '*', same itemtype
1934 * branchcode and itemtype '*'
1936 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1940 sub GetBranchItemRule {
1941 my ( $branchcode, $itemtype ) = @_;
1944 my $rules = Koha::CirculationRules->get_effective_rules({
1945 branchcode => $branchcode,
1946 itemtype => $itemtype,
1947 rules => ['holdallowed', 'hold_fulfillment_policy', 'returnbranch']
1950 # built-in default circulation rule
1951 $rules->{holdallowed} //= 'from_any_library';
1952 $rules->{hold_fulfillment_policy} //= 'any';
1953 $rules->{returnbranch} //= 'homebranch';
1960 ($doreturn, $messages, $iteminformation, $borrower) =
1961 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1967 =item C<$barcode> is the bar code of the book being returned.
1969 =item C<$branch> is the code of the branch where the book is being returned.
1971 =item C<$exemptfine> indicates that overdue charges for the item will be
1974 =item C<$return_date> allows the default return date to be overridden
1975 by the given return date. Optional.
1979 C<&AddReturn> returns a list of four items:
1981 C<$doreturn> is true iff the return succeeded.
1983 C<$messages> is a reference-to-hash giving feedback on the operation.
1984 The keys of the hash are:
1990 No item with this barcode exists. The value is C<$barcode>.
1994 The book is not currently on loan. The value is C<$barcode>.
1998 This book has been withdrawn/cancelled. The value should be ignored.
2000 =item C<Wrongbranch>
2002 This book has was returned to the wrong branch. The value is a hashref
2003 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2004 contain the branchcode of the incorrect and correct return library, respectively.
2008 The item was reserved. The value is a reference-to-hash whose keys are
2009 fields from the reserves table of the Koha database, and
2010 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2011 either C<Waiting>, C<Reserved>, or 0.
2013 =item C<WasReturned>
2015 Value 1 if return is successful.
2017 =item C<NeedsTransfer>
2019 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2021 =item C<RecallFound>
2023 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2024 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2027 =item C<TransferredRecall>
2029 This item has been transferred to this branch to fill a recall. The recall object is returned.
2033 C<$iteminformation> is a reference-to-hash, giving information about the
2034 returned item from the issues table.
2036 C<$borrower> is a reference-to-hash, giving information about the
2037 patron who last borrowed the book.
2042 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2044 if ($branch and not Koha::Libraries->find($branch)) {
2045 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2048 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2049 my $return_date_specified = !!$return_date;
2050 $return_date //= dt_from_string();
2054 my $validTransfer = 1;
2055 my $stat_type = 'return';
2057 # get information on item
2058 my $item = Koha::Items->find({ barcode => $barcode });
2060 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2063 my $itemnumber = $item->itemnumber;
2064 my $itemtype = $item->effective_itemtype;
2066 my $issue = $item->checkout;
2068 $patron = $issue->patron
2069 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2070 . Dumper($issue->unblessed) . "\n";
2072 $messages->{'NotIssued'} = $barcode;
2073 $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
2075 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2077 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2078 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2079 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2080 $messages->{'LocalUse'} = 1;
2081 $stat_type = 'localuse';
2085 # full item data, but no borrowernumber or checkout info (no issue)
2086 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2087 # get the proper branch to which to return the item
2088 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2089 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2090 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2092 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2093 my $patron_unblessed = $patron ? $patron->unblessed : {};
2095 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2096 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2097 if ($update_loc_rules) {
2098 if (defined $update_loc_rules->{_ALL_}) {
2099 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2100 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2102 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2103 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2105 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2106 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2110 foreach my $key ( keys %$update_loc_rules ) {
2111 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2112 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2113 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2114 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2115 $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2122 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2124 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2126 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2128 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2131 foreach my $key ( keys %$rules ) {
2132 if ( $item->notforloan eq $key ) {
2133 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2134 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2141 # check if the return is allowed at this branch
2142 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2143 unless ($returnallowed){
2144 $messages->{'Wrongbranch'} = {
2145 Wrongbranch => $branch,
2146 Rightbranch => $message
2149 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2150 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2151 return ( $doreturn, $messages, $issue, $patron_unblessed);
2154 if ( $item->withdrawn ) { # book has been cancelled
2155 $messages->{'withdrawn'} = 1;
2156 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2159 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2163 # case of a return of document (deal with issues and holdingbranch)
2165 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2166 $patron or warn "AddReturn without current borrower";
2170 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2175 C4::Context->preference('CalculateFinesOnReturn')
2176 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2181 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2184 carp "The checkin for the following issue failed, Please go to the about page and check all messages on the 'System information' to see if there are configuration / data issues ($@)" . Dumper( $issue->unblessed );
2186 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2187 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2189 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2192 # FIXME is the "= 1" right? This could be the borrower hash.
2193 $messages->{'WasReturned'} = 1;
2196 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2200 # the holdingbranch is updated if the document is returned to another location.
2201 # this is always done regardless of whether the item was on loan or not
2202 if ($item->holdingbranch ne $branch) {
2203 $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2206 my $item_was_lost = $item->itemlost;
2207 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2208 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2210 # fix up the accounts.....
2211 if ($item_was_lost) {
2212 $messages->{'WasLost'} = 1;
2213 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2214 my @object_messages = @{ $updated_item->object_messages };
2215 for my $message (@object_messages) {
2216 $messages->{'LostItemFeeRefunded'} = 1
2217 if $message->message eq 'lost_refunded';
2218 $messages->{'LostItemFeeRestored'} = 1
2219 if $message->message eq 'lost_restored';
2221 if ( $message->message eq 'lost_charge' ) {
2222 $issue //= Koha::Old::Checkouts->search(
2223 { itemnumber => $item->itemnumber },
2224 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2226 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2227 my $patron = $issue->patron;
2228 $patron_unblessed = $patron->unblessed;
2230 _CalculateAndUpdateFine(
2233 item => $item->unblessed,
2234 borrower => $patron_unblessed,
2235 return_date => $return_date
2238 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2239 $item->itemnumber, undef, 'RETURNED' );
2240 $messages->{'LostItemFeeCharged'} = 1;
2246 # check if we have a transfer for this document
2247 my $transfer = $item->get_transfer;
2249 # if we have a transfer to complete, we update the line of transfers with the datearrived
2252 if ( $transfer->in_transit ) {
2253 if ( $transfer->tobranch eq $branch ) {
2255 $messages->{'TransferArrived'} = $transfer->frombranch;
2256 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2257 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2260 $messages->{'WrongTransfer'} = $transfer->tobranch;
2261 $messages->{'WrongTransferItem'} = $item->itemnumber;
2262 $messages->{'TransferTrigger'} = $transfer->reason;
2266 if ( $transfer->tobranch eq $branch ) {
2268 $messages->{'TransferArrived'} = $transfer->frombranch;
2269 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2270 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2273 $messages->{'WasTransfered'} = $transfer->tobranch;
2274 $messages->{'TransferTrigger'} = $transfer->reason;
2279 # fix up the overdues in accounts...
2280 if ($borrowernumber) {
2281 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2282 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2284 if ( $issue and $issue->is_overdue($return_date) ) {
2286 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2288 $messages->{'PrevDebarred'} = $debardate;
2290 $messages->{'Debarred'} = $debardate if $debardate;
2292 # there's no overdue on the item but borrower had been previously debarred
2293 } elsif ( $issue->date_due and $patron->debarred ) {
2294 if ( $patron->debarred eq "9999-12-31") {
2295 $messages->{'ForeverDebarred'} = $patron->debarred;
2297 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2298 $borrower_debar_dt->truncate(to => 'day');
2299 my $today_dt = $return_date->clone()->truncate(to => 'day');
2300 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2301 $messages->{'PrevDebarred'} = $patron->debarred;
2308 if ( C4::Context->preference('UseRecalls') ) {
2309 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2311 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2312 if ( defined $recall ) {
2313 $messages->{RecallFound} = $recall;
2314 if ( $recall->branchcode ne $branch ) {
2315 $messages->{RecallNeedsTransfer} = $branch;
2320 # find reserves.....
2321 # launch the Checkreserves routine to find any holds
2322 my ($resfound, $resrec);
2323 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2324 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2325 # if a hold is found and is waiting at another branch, change the priority back to 1 and trigger the hold (this will trigger a transfer and update the hold status properly)
2326 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2327 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2328 $resfound = 'Reserved';
2329 $resrec = $hold->unblessed;
2332 $resrec->{'ResFound'} = $resfound;
2333 $messages->{'ResFound'} = $resrec;
2336 # Record the fact that this book was returned.
2337 C4::Stats::UpdateStats({
2340 itemnumber => $itemnumber,
2341 itemtype => $itemtype,
2342 location => $item->location,
2343 borrowernumber => $borrowernumber,
2344 ccode => $item->ccode,
2347 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2349 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2351 branchcode => $branch,
2352 categorycode => $patron->categorycode,
2353 item_type => $itemtype,
2354 notification => 'CHECKIN',
2356 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2357 SendCirculationAlert({
2359 item => $item->unblessed,
2360 borrower => $patron->unblessed,
2366 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2367 if C4::Context->preference("ReturnLog");
2370 # Check if this item belongs to a biblio record that is attached to an
2371 # ILL request, if it is we need to update the ILL request's status
2372 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2373 my $request = Koha::Illrequests->find(
2374 { biblio_id => $item->biblio->biblionumber }
2376 $request->status('RET') if $request;
2379 if ( C4::Context->preference('UseRecalls') ) {
2380 # all recalls that have triggered a transfer will have an allocated itemnumber
2381 my $transfer_recall = Koha::Recalls->find({ itemnumber => $item->itemnumber, status => 'in_transit' });
2382 if ( $transfer_recall and $transfer_recall->branchcode eq $branch ) {
2383 $messages->{TransferredRecall} = $transfer_recall;
2387 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2388 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2389 && ( $doreturn or $messages->{'NotIssued'} )
2391 and ( $branch ne $returnbranch )
2392 and not $messages->{'WrongTransfer'}
2393 and not $messages->{'WasTransfered'}
2394 and not $messages->{TransferredRecall}
2395 and not $messages->{RecallNeedsTransfer} )
2397 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2398 if (C4::Context->preference("AutomaticItemReturn" ) or
2399 (C4::Context->preference("UseBranchTransferLimits") and
2400 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2402 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2403 $messages->{'WasTransfered'} = $returnbranch;
2404 $messages->{'TransferTrigger'} = $transfer_trigger;
2406 $messages->{'NeedsTransfer'} = $returnbranch;
2407 $messages->{'TransferTrigger'} = $transfer_trigger;
2411 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2412 my $claims = Koha::Checkouts::ReturnClaims->search(
2414 itemnumber => $item->id,
2415 resolution => undef,
2419 if ( $claims->count ) {
2420 $messages->{ReturnClaims} = $claims;
2424 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2425 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2427 if ( $doreturn and $issue ) {
2428 my $checkin = Koha::Old::Checkouts->find($issue->id);
2430 Koha::Plugins->call('after_circ_action', {
2431 action => 'checkin',
2438 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2441 =head2 MarkIssueReturned
2443 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2445 Unconditionally marks an issue as being returned by
2446 moving the C<issues> row to C<old_issues> and
2447 setting C<returndate> to the current date.
2449 if C<$returndate> is specified (in iso format), it is used as the date
2452 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2453 the old_issue is immediately anonymised
2455 Ideally, this function would be internal to C<C4::Circulation>,
2456 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2457 and offline_circ/process_koc.pl.
2459 The last optional parameter allos passing skip_record_index to the item store call.
2463 sub MarkIssueReturned {
2464 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2466 # Retrieve the issue
2467 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2469 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2471 my $issue_id = $issue->issue_id;
2473 my $schema = Koha::Database->schema;
2475 # FIXME Improve the return value and handle it from callers
2476 $schema->txn_do(sub {
2478 my $patron = Koha::Patrons->find( $borrowernumber );
2480 # Update the returndate value
2481 if ( $returndate ) {
2482 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2485 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2488 # Create the old_issues entry
2489 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2491 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2492 if ( $privacy && $privacy == 2) {
2493 $old_checkout->anonymize;
2496 # And finally delete the issue
2499 $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2501 if ( C4::Context->preference('StoreLastBorrower') ) {
2502 my $item = Koha::Items->find( $itemnumber );
2503 $item->last_returned_by( $patron );
2506 # Remove any OVERDUES related debarment if the borrower has no overdues
2507 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2508 && $patron->debarred
2509 && !$patron->has_overdues
2510 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2512 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2520 =head2 _debar_user_on_return
2522 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2524 C<$borrower> borrower hashref
2526 C<$item> item hashref
2528 C<$datedue> date due DateTime object
2530 C<$returndate> DateTime object representing the return time
2532 Internal function, called only by AddReturn that calculates and updates
2533 the user fine days, and debars them if necessary.
2535 Should only be called for overdue returns
2537 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2542 sub _calculate_new_debar_dt {
2543 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2545 my $branchcode = _GetCircControlBranch( $item, $borrower );
2546 my $circcontrol = C4::Context->preference('CircControl');
2547 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2548 { categorycode => $borrower->{categorycode},
2549 itemtype => $item->{itype},
2550 branchcode => $branchcode,
2555 'maxsuspensiondays',
2556 'suspension_chargeperiod',
2560 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2561 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2562 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2564 return unless $finedays;
2566 # finedays is in days, so hourly loans must multiply by 24
2567 # thus 1 hour late equals 1 day suspension * finedays rate
2568 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2570 # grace period is measured in the same units as the loan
2572 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2574 my $deltadays = DateTime::Duration->new(
2575 days => $chargeable_units
2578 if ( $deltadays->subtract($grace)->is_positive() ) {
2579 my $suspension_days = $deltadays * $finedays;
2581 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2582 # No need to / 1 and do not consider / 0
2583 $suspension_days = DateTime::Duration->new(
2584 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2588 # If the max suspension days is < than the suspension days
2589 # the suspension days is limited to this maximum period.
2590 my $max_sd = $issuing_rule->{maxsuspensiondays};
2591 if ( defined $max_sd && $max_sd ne '' ) {
2592 $max_sd = DateTime::Duration->new( days => $max_sd );
2593 $suspension_days = $max_sd
2594 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2597 my ( $has_been_extended );
2598 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2599 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2601 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2602 $has_been_extended = 1;
2607 # Use the calendar or not to calculate the debarment date
2608 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2609 my $calendar = Koha::Calendar->new(
2610 branchcode => $branchcode,
2611 days_mode => 'Calendar'
2613 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2616 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2618 return $new_debar_dt;
2623 sub _debar_user_on_return {
2624 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2626 $return_date //= dt_from_string();
2628 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2630 return unless $new_debar_dt;
2632 Koha::Patron::Debarments::AddUniqueDebarment({
2633 borrowernumber => $borrower->{borrowernumber},
2634 expiration => $new_debar_dt->ymd(),
2635 type => 'SUSPENSION',
2637 # if borrower was already debarred but does not get an extra debarment
2638 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2639 my ($new_debarment_str, $is_a_reminder);
2640 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2642 $new_debarment_str = $borrower->{debarred};
2644 $new_debarment_str = $new_debar_dt->ymd();
2646 # FIXME Should return a DateTime object
2647 return $new_debarment_str, $is_a_reminder;
2650 =head2 _FixOverduesOnReturn
2652 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2654 C<$borrowernumber> borrowernumber
2656 C<$itemnumber> itemnumber
2658 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2660 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2666 sub _FixOverduesOnReturn {
2667 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2668 unless( $borrowernumber ) {
2669 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2673 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2677 warn "_FixOverduesOnReturn() not supplied valid status";
2681 my $schema = Koha::Database->schema;
2683 my $result = $schema->txn_do(
2685 # check for overdue fine
2686 my $accountlines = Koha::Account::Lines->search(
2688 borrowernumber => $borrowernumber,
2689 itemnumber => $item,
2690 debit_type_code => 'OVERDUE',
2691 status => 'UNRETURNED'
2694 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2696 my $accountline = $accountlines->next;
2697 my $payments = $accountline->credits;
2699 my $amountoutstanding = $accountline->amountoutstanding;
2700 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2701 $accountline->delete;
2702 return 0; # no warning, we've just removed a zero value fine (backdated return)
2703 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2704 my $account = Koha::Account->new({patron_id => $borrowernumber});
2705 my $credit = $account->add_credit(
2707 amount => $amountoutstanding,
2708 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2709 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2710 interface => C4::Context->interface,
2716 $credit->apply({ debits => [ $accountline ] });
2718 if (C4::Context->preference("FinesLog")) {
2719 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2723 $accountline->status($status);
2724 return $accountline->store();
2731 =head2 _GetCircControlBranch
2733 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2737 Return the library code to be used to determine which circulation
2738 policy applies to a transaction. Looks up the CircControl and
2739 HomeOrHoldingBranch system preferences.
2741 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2743 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2747 sub _GetCircControlBranch {
2748 my ($item, $borrower) = @_;
2749 my $circcontrol = C4::Context->preference('CircControl');
2752 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2753 $branch= C4::Context->userenv->{'branch'};
2754 } elsif ($circcontrol eq 'PatronLibrary') {
2755 $branch=$borrower->{branchcode};
2757 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2758 $branch = $item->{$branchfield};
2759 # default to item home branch if holdingbranch is used
2760 # and is not defined
2761 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2762 $branch = $item->{homebranch};
2770 $issue = GetOpenIssue( $itemnumber );
2772 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2774 C<$itemnumber> is the item's itemnumber
2781 my ( $itemnumber ) = @_;
2782 return unless $itemnumber;
2783 my $dbh = C4::Context->dbh;
2784 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2785 $sth->execute( $itemnumber );
2786 return $sth->fetchrow_hashref();
2790 =head2 GetUpcomingDueIssues
2792 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2796 sub GetUpcomingDueIssues {
2799 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2800 my $dbh = C4::Context->dbh;
2803 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2805 LEFT JOIN items USING (itemnumber)
2806 LEFT JOIN branches ON branches.branchcode =
2808 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2809 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2810 my @bind_parameters = ( $params->{'days_in_advance'} );
2812 my $sth = $dbh->prepare( $statement );
2813 $sth->execute( @bind_parameters );
2814 my $upcoming_dues = $sth->fetchall_arrayref({});
2816 return $upcoming_dues;
2819 =head2 CanBookBeRenewed
2821 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2823 Find out whether a borrowed item may be renewed.
2825 C<$borrowernumber> is the borrower number of the patron who currently
2826 has the item on loan.
2828 C<$itemnumber> is the number of the item to renew.
2830 C<$override_limit>, if supplied with a true value, causes
2831 the limit on the number of times that the loan can be renewed
2832 (as controlled by the item type) to be ignored. Overriding also allows
2833 to renew sooner than "No renewal before" and to manually renew loans
2834 that are automatically renewed.
2836 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2837 item must currently be on loan to the specified borrower; renewals
2838 must be allowed for the item's type; and the borrower must not have
2839 already renewed the loan. $error will contain the reason the renewal can not proceed
2843 sub CanBookBeRenewed {
2844 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2846 my $auto_renew = "no";
2848 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2849 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2850 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2851 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2853 my $patron = $issue->patron or return;
2855 # override_limit will override anything else except on_reserve
2856 unless ( $override_limit ){
2857 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2858 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2860 categorycode => $patron->categorycode,
2861 itemtype => $item->effective_itemtype,
2862 branchcode => $branchcode,
2866 'unseen_renewals_allowed'
2871 return ( 0, "too_many" )
2872 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2874 return ( 0, "too_unseen" )
2875 if C4::Context->preference('UnseenRenewals') &&
2876 $issuing_rule->{unseen_renewals_allowed} &&
2877 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2879 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2880 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2881 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2882 my $restricted = $patron->is_debarred;
2883 my $hasoverdues = $patron->has_overdues;
2885 if ( $restricted and $restrictionblockrenewing ) {
2886 return ( 0, 'restriction');
2887 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2888 return ( 0, 'overdue');
2891 $auto_renew = _CanBookBeAutoRenewed({
2894 branchcode => $branchcode,
2897 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_soon' && $cron;
2898 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2899 # extra notices being sent. Cron also implies no override
2900 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2901 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2902 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2905 if ( C4::Context->preference('UseRecalls') ) {
2907 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2908 if ( defined $recall ) {
2909 if ( $recall->item_level_recall ) {
2910 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2911 return ( 0, 'recalled' ) if ( $recall->itemnumber == $item->itemnumber );
2913 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2914 return ( 0, 'recalled' ) unless ( $recall->waiting );
2919 # Note: possible_reserves will contain all title level holds on this bib and item level
2920 # holds on the checked out item
2921 my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2923 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2924 if ( $resfound && $resrec->{non_priority} ) {
2925 $resfound = Koha::Holds->search(
2926 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2932 # This item can fill one or more unfilled reserve, can those unfilled reserves
2933 # all be filled by other available items?
2935 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2937 my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2939 # There is an item level hold on this item, no other item can fill the hold
2944 # Get all other items that could possibly fill reserves
2945 # FIXME We could join reserves (or more tables) here to eliminate some checks later
2946 my $items = Koha::Items->search({
2947 biblionumber => $resrec->{biblionumber},
2950 -not => { itemnumber => $itemnumber }
2952 my $item_count = $items->count();
2954 # Get all other reserves that could have been filled by this item
2955 my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2956 # Note: fetching the patrons in this manner means that a patron with 2 holds will
2957 # not block renewal if one reserve can be satisfied i.e. each patron is checked once
2958 my $patrons = Koha::Patrons->search({
2959 borrowernumber => { -in => \@borrowernumbers }
2961 my $patron_count = $patrons->count();
2963 return ( 0, "on_reserve" ) if ($patron_count > $item_count);
2964 # We cannot possibly fill all reserves if we don't have enough items
2966 # If we can fill each hold that has been found with the available items on the record
2967 # then the patron can renew. If we cannot, they cannot renew.
2968 # FIXME This code does not check whether the item we are renewing can fill
2969 # any of the existing reserves.
2973 PATRON: while ( my $patron = $patrons->next ) {
2974 # If there is a reserve that cannot be filled we are done
2975 return ( 0, "on_reserve" ) if ( $seen > $reservable );
2976 my $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron });
2977 while ( my $other_item = $items->next ) {
2978 next if defined $matched_items{$other_item->itemnumber};
2979 next if IsItemOnHoldAndFound( $other_item->itemnumber );
2980 next unless IsAvailableForItemLevelRequest($other_item, $patron, undef, $items_any_available);
2981 next unless CanItemBeReserved($patron,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2982 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
2983 # CanItemBeReserved checks 'rules' and 'policies' which means
2984 # items will fill holds at checkin that are rejected here
2986 if ($reservable >= $patron_count) {
2990 $matched_items{$other_item->itemnumber} = 1;
2999 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
3000 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3001 if ( GetSoonestRenewDate($borrowernumber, $itemnumber) > dt_from_string() ){
3002 return (0, "too_soon") unless $override_limit;
3005 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3007 return ( 1, undef );
3012 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
3016 C<$borrowernumber> is the borrower number of the patron who currently
3019 C<$itemnumber> is the number of the item to renew.
3021 C<$branch> is the library where the renewal took place (if any).
3022 The library that controls the circ policies for the renewal is retrieved from the issues record.
3024 C<$datedue> can be a DateTime object used to set the due date.
3026 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3027 this parameter is not supplied, lastreneweddate is set to the current date.
3029 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3030 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3031 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3034 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3035 from the book's item type.
3037 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3038 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3039 fallback to a true value
3044 my $borrowernumber = shift;
3045 my $itemnumber = shift or return;
3047 my $datedue = shift;
3048 my $lastreneweddate = shift || dt_from_string();
3049 my $skipfinecalc = shift;
3052 # Fallback on a 'seen' renewal
3053 $seen = defined $seen && $seen == 0 ? 0 : 1;
3055 my $item_object = Koha::Items->find($itemnumber) or return;
3056 my $biblio = $item_object->biblio;
3057 my $issue = $item_object->checkout;
3058 my $item_unblessed = $item_object->unblessed;
3060 my $dbh = C4::Context->dbh;
3062 return unless $issue;
3064 $borrowernumber ||= $issue->borrowernumber;
3066 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3067 carp 'Invalid date passed to AddRenewal.';
3071 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3072 my $patron_unblessed = $patron->unblessed;
3074 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3076 my $schema = Koha::Database->schema;
3077 $schema->txn_do(sub{
3079 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3080 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3082 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3084 # If the due date wasn't specified, calculate it by adding the
3085 # book's loan length to today's date or the current due date
3086 # based on the value of the RenewalPeriodBase syspref.
3087 my $itemtype = $item_object->effective_itemtype;
3090 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3091 dt_from_string( $issue->date_due, 'sql' ) :
3093 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3096 my $fees = Koha::Charges::Fees->new(
3099 library => $circ_library,
3100 item => $item_object,
3101 from_date => dt_from_string( $issue->date_due, 'sql' ),
3102 to_date => dt_from_string($datedue),
3106 # Increment the unseen renewals, if appropriate
3107 # We only do so if the syspref is enabled and
3108 # a maximum value has been set in the circ rules
3109 my $unseen_renewals = $issue->unseen_renewals;
3110 if (C4::Context->preference('UnseenRenewals')) {
3111 my $rule = Koha::CirculationRules->get_effective_rule(
3112 { categorycode => $patron->categorycode,
3113 itemtype => $item_object->effective_itemtype,
3114 branchcode => $circ_library->branchcode,
3115 rule_name => 'unseen_renewals_allowed'
3118 if (!$seen && $rule && $rule->rule_value) {
3121 # If the renewal is seen, unseen should revert to 0
3122 $unseen_renewals = 0;
3126 # Update the issues record to have the new due date, and a new count
3127 # of how many times it has been renewed.
3128 my $renews = ( $issue->renewals || 0 ) + 1;
3129 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3132 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3135 Koha::Exceptions::Checkout::FailedRenewal->throw(
3136 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3140 # Update the renewal count on the item, and tell zebra to reindex
3141 $renews = ( $item_object->renewals || 0 ) + 1;
3142 $item_object->renewals($renews);
3143 $item_object->onloan($datedue);
3144 $item_object->store({ log_action => 0 });
3146 # Charge a new rental fee, if applicable
3147 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3148 if ( $charge > 0 ) {
3149 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3152 # Charge a new accumulate rental fee, if applicable
3153 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3154 if ( $itemtype_object ) {
3155 my $accumulate_charge = $fees->accumulate_rentalcharge();
3156 if ( $accumulate_charge > 0 ) {
3157 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3159 $charge += $accumulate_charge;
3162 # Send a renewal slip according to checkout alert preferencei
3163 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3164 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3166 branchcode => $branch,
3167 categorycode => $patron->categorycode,
3168 item_type => $itemtype,
3169 notification => 'CHECKOUT',
3171 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3172 SendCirculationAlert(
3175 item => $item_unblessed,
3176 borrower => $patron->unblessed,
3183 # Remove any OVERDUES related debarment if the borrower has no overdues
3185 && $patron->is_debarred
3186 && ! $patron->has_overdues
3187 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3189 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3192 # Add the renewal to stats
3193 C4::Stats::UpdateStats(
3195 branch => $item_object->renewal_branchcode({branch => $branch}),
3198 itemnumber => $itemnumber,
3199 itemtype => $itemtype,
3200 location => $item_object->location,
3201 borrowernumber => $borrowernumber,
3202 ccode => $item_object->ccode,
3207 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3209 Koha::Plugins->call('after_circ_action', {
3210 action => 'renewal',
3212 checkout => $issue->get_from_storage
3221 # check renewal status
3222 my ( $bornum, $itemno ) = @_;
3223 my $dbh = C4::Context->dbh;
3225 my $unseencount = 0;
3226 my $renewsallowed = 0;
3227 my $unseenallowed = 0;
3231 my $patron = Koha::Patrons->find( $bornum );
3232 my $item = Koha::Items->find($itemno);
3234 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3236 # Look in the issues table for this item, lent to this borrower,
3237 # and not yet returned.
3239 # FIXME - I think this function could be redone to use only one SQL call.
3240 my $sth = $dbh->prepare(
3241 "select * from issues
3242 where (borrowernumber = ?)
3243 and (itemnumber = ?)"
3245 $sth->execute( $bornum, $itemno );
3246 my $data = $sth->fetchrow_hashref;
3247 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3248 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3249 # $item and $borrower should be calculated
3250 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3252 my $rules = Koha::CirculationRules->get_effective_rules(
3254 categorycode => $patron->categorycode,
3255 itemtype => $item->effective_itemtype,
3256 branchcode => $branchcode,
3257 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3260 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3261 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3262 $rules->{unseen_renewals_allowed} :
3264 $renewsleft = $renewsallowed - $renewcount;
3265 $unseenleft = $unseenallowed - $unseencount;
3266 if($renewsleft < 0){ $renewsleft = 0; }
3267 if($unseenleft < 0){ $unseenleft = 0; }
3278 =head2 GetSoonestRenewDate
3280 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3282 Find out the soonest possible renew date of a borrowed item.
3284 C<$borrowernumber> is the borrower number of the patron who currently
3285 has the item on loan.
3287 C<$itemnumber> is the number of the item to renew.
3289 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3290 renew date, based on the value "No renewal before" of the applicable
3291 issuing rule. Returns the current date if the item can already be
3292 renewed, and returns undefined if the borrower, loan, or item
3297 sub GetSoonestRenewDate {
3298 my ( $borrowernumber, $itemnumber ) = @_;
3300 my $dbh = C4::Context->dbh;
3302 my $item = Koha::Items->find($itemnumber) or return;
3303 my $itemissue = $item->checkout or return;
3305 $borrowernumber ||= $itemissue->borrowernumber;
3306 my $patron = Koha::Patrons->find( $borrowernumber )
3309 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3310 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3311 { categorycode => $patron->categorycode,
3312 itemtype => $item->effective_itemtype,
3313 branchcode => $branchcode,
3321 my $now = dt_from_string;
3323 if ( defined $issuing_rule->{norenewalbefore}
3324 and $issuing_rule->{norenewalbefore} ne "" )
3326 my $soonestrenewal =
3327 dt_from_string( $itemissue->date_due )->subtract(
3328 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3330 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3331 and $issuing_rule->{lengthunit} eq 'days' )
3333 $soonestrenewal->truncate( to => 'day' );
3335 return $soonestrenewal if $now < $soonestrenewal;
3336 } elsif ( $itemissue->auto_renew && $patron->autorenew_checkouts ) {
3337 # Checkouts with auto-renewing fall back to due date
3338 my $soonestrenewal = dt_from_string( $itemissue->date_due );
3339 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3340 and $issuing_rule->{lengthunit} eq 'days' )
3342 $soonestrenewal->truncate( to => 'day' );
3344 return $soonestrenewal;
3349 =head2 GetLatestAutoRenewDate
3351 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3353 Find out the latest possible auto renew date of a borrowed item.
3355 C<$borrowernumber> is the borrower number of the patron who currently
3356 has the item on loan.
3358 C<$itemnumber> is the number of the item to renew.
3360 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3361 auto renew date, based on the value "No auto renewal after" and the "No auto
3362 renewal after (hard limit) of the applicable issuing rule.
3363 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3364 or item cannot be found.
3368 sub GetLatestAutoRenewDate {
3369 my ( $borrowernumber, $itemnumber ) = @_;
3371 my $dbh = C4::Context->dbh;
3373 my $item = Koha::Items->find($itemnumber) or return;
3374 my $itemissue = $item->checkout or return;
3376 $borrowernumber ||= $itemissue->borrowernumber;
3377 my $patron = Koha::Patrons->find( $borrowernumber )
3380 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3381 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3383 categorycode => $patron->categorycode,
3384 itemtype => $item->effective_itemtype,
3385 branchcode => $branchcode,
3387 'no_auto_renewal_after',
3388 'no_auto_renewal_after_hard_limit',
3394 return unless $circulation_rules;
3396 if ( not $circulation_rules->{no_auto_renewal_after}
3397 or $circulation_rules->{no_auto_renewal_after} eq '' )
3398 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3399 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3401 my $maximum_renewal_date;
3402 if ( $circulation_rules->{no_auto_renewal_after} ) {
3403 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3404 $maximum_renewal_date->add(
3405 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3409 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3410 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3411 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3413 return $maximum_renewal_date;
3417 =head2 GetIssuingCharges
3419 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3421 Calculate how much it would cost for a given patron to borrow a given
3422 item, including any applicable discounts.
3424 C<$itemnumber> is the item number of item the patron wishes to borrow.
3426 C<$borrowernumber> is the patron's borrower number.
3428 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3429 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3434 sub GetIssuingCharges {
3436 # calculate charges due
3437 my ( $itemnumber, $borrowernumber ) = @_;
3439 my $dbh = C4::Context->dbh;
3442 # Get the book's item type and rental charge (via its biblioitem).
3443 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3444 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3445 $charge_query .= (C4::Context->preference('item-level_itypes'))
3446 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3447 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3449 $charge_query .= ' WHERE items.itemnumber =?';
3451 my $sth = $dbh->prepare($charge_query);
3452 $sth->execute($itemnumber);
3453 if ( my $item_data = $sth->fetchrow_hashref ) {
3454 $item_type = $item_data->{itemtype};
3455 $charge = $item_data->{rentalcharge};
3457 # FIXME This should follow CircControl
3458 my $branch = C4::Context::mybranch();
3459 my $patron = Koha::Patrons->find( $borrowernumber );
3460 my $discount = Koha::CirculationRules->get_effective_rule({
3461 categorycode => $patron->categorycode,
3462 branchcode => $branch,
3463 itemtype => $item_type,
3464 rule_name => 'rentaldiscount'
3467 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3469 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3473 return ( $charge, $item_type );
3476 =head2 AddIssuingCharge
3478 &AddIssuingCharge( $checkout, $charge, $type )
3482 sub AddIssuingCharge {
3483 my ( $checkout, $charge, $type ) = @_;
3485 # FIXME What if checkout does not exist?
3487 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3488 my $accountline = $account->add_debit(
3492 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3493 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3494 interface => C4::Context->interface,
3496 item_id => $checkout->itemnumber,
3497 issue_id => $checkout->issue_id,
3504 GetTransfers($itemnumber);
3509 my ($itemnumber) = @_;
3511 my $dbh = C4::Context->dbh;
3520 FROM branchtransfers
3521 WHERE itemnumber = ?
3522 AND datearrived IS NULL
3523 AND datecancelled IS NULL
3525 my $sth = $dbh->prepare($query);
3526 $sth->execute($itemnumber);
3527 my @row = $sth->fetchrow_array();
3531 =head2 GetTransfersFromTo
3533 @results = GetTransfersFromTo($frombranch,$tobranch);
3535 Returns the list of pending transfers between $from and $to branch
3539 sub GetTransfersFromTo {
3540 my ( $frombranch, $tobranch ) = @_;
3541 return unless ( $frombranch && $tobranch );
3542 my $dbh = C4::Context->dbh;
3544 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3545 FROM branchtransfers
3548 AND datecancelled IS NULL
3549 AND datesent IS NOT NULL
3550 AND datearrived IS NULL
3552 my $sth = $dbh->prepare($query);
3553 $sth->execute( $frombranch, $tobranch );
3556 while ( my $data = $sth->fetchrow_hashref ) {
3557 push @gettransfers, $data;
3559 return (@gettransfers);
3562 =head2 SendCirculationAlert
3564 Send out a C<check-in> or C<checkout> alert using the messaging system.
3572 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3576 Hashref of information about the item being checked in or out.
3580 Hashref of information about the borrower of the item.
3584 The branchcode from where the checkout or check-in took place.
3590 SendCirculationAlert({
3593 borrower => $borrower,
3599 sub SendCirculationAlert {
3601 my ($type, $item, $borrower, $branch, $issue) =
3602 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3603 my %message_name = (
3604 CHECKIN => 'Item_Check_in',
3605 CHECKOUT => 'Item_Checkout',
3606 RENEWAL => 'Item_Checkout',
3608 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3609 borrowernumber => $borrower->{borrowernumber},
3610 message_name => $message_name{$type},
3615 items => $item->{itemnumber},
3616 biblio => $item->{biblionumber},
3617 biblioitems => $item->{biblionumber},
3618 borrowers => $borrower,
3619 branches => $branch,
3622 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3623 # See C4::Letters:: _parseletter_sth
3624 if( $type eq 'CHECKIN' ){
3625 $tables->{old_issues} = $issue->issue_id;
3627 $tables->{issues} = $item->{itemnumber};
3630 my $schema = Koha::Database->new->schema;
3631 my @transports = keys %{ $borrower_preferences->{transports} };
3633 # From the MySQL doc:
3634 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3635 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3636 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3637 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3639 for my $mtt (@transports) {
3640 my $letter = C4::Letters::GetPreparedLetter (
3641 module => 'circulation',
3642 letter_code => $type,
3643 branchcode => $branch,
3644 message_transport_type => $mtt,
3645 lang => $borrower->{lang},
3649 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3650 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3651 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3652 unless ( $message ) {
3653 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3654 C4::Message->enqueue($letter, $borrower, $mtt);
3656 $message->append($letter);
3659 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3665 =head2 updateWrongTransfer
3667 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3669 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
3673 sub updateWrongTransfer {
3674 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3676 # first step: cancel the original transfer
3677 my $item = Koha::Items->find($itemNumber);
3678 my $transfer = $item->get_transfer;
3679 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3681 # second step: create a new transfer to the right location
3682 my $new_transfer = $item->request_transfer(
3684 to => $transfer->to_library,
3685 reason => $transfer->reason,
3686 comment => $transfer->comments,
3692 return $new_transfer;
3697 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3699 this function calculates the due date given the start date and configured circulation rules,
3700 checking against the holidays calendar as per the daysmode circulation rule.
3701 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3702 C<$itemtype> = itemtype code of item in question
3703 C<$branch> = location whose calendar to use
3704 C<$borrower> = Borrower object
3705 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3710 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3714 # loanlength now a href
3716 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3718 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3724 if (ref $startdate ne 'DateTime' ) {
3725 $datedue = dt_from_string($datedue);
3727 $datedue = $startdate->clone;
3730 $datedue = dt_from_string()->truncate( to => 'minute' );
3734 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3736 categorycode => $borrower->{categorycode},
3737 itemtype => $itemtype,
3738 branchcode => $branch,
3742 # calculate the datedue as normal
3743 if ( $daysmode eq 'Days' )
3744 { # ignoring calendar
3745 if ( $loanlength->{lengthunit} eq 'hours' ) {
3746 $datedue->add( hours => $loanlength->{$length_key} );
3748 $datedue->add( days => $loanlength->{$length_key} );
3749 $datedue->set_hour(23);
3750 $datedue->set_minute(59);
3754 if ($loanlength->{lengthunit} eq 'hours') {
3755 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3758 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3760 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3761 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3762 if ($loanlength->{lengthunit} eq 'days') {
3763 $datedue->set_hour(23);
3764 $datedue->set_minute(59);
3768 # if Hard Due Dates are used, retrieve them and apply as necessary
3769 my ( $hardduedate, $hardduedatecompare ) =
3770 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3771 if ($hardduedate) { # hardduedates are currently dates
3772 $hardduedate->truncate( to => 'minute' );
3773 $hardduedate->set_hour(23);
3774 $hardduedate->set_minute(59);
3775 my $cmp = DateTime->compare( $hardduedate, $datedue );
3777 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3778 # if the calculated date is before the 'after' Hard Due Date (floor), override
3779 # if the hard due date is set to 'exactly', overrride
3780 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3781 $datedue = $hardduedate->clone;
3784 # in all other cases, keep the date due as it is
3788 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3789 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3790 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3791 if( $expiry_dt ) { #skip empty expiry date..
3792 $expiry_dt->set( hour => 23, minute => 59);
3793 my $d1= $datedue->clone->set_time_zone('floating');
3794 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3795 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3798 if ( $daysmode ne 'Days' ) {
3799 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3800 if ( $calendar->is_holiday($datedue) ) {
3801 # Don't return on a closed day
3802 $datedue = $calendar->prev_open_days( $datedue, 1 );
3811 sub CheckValidBarcode{
3813 my $dbh = C4::Context->dbh;
3814 my $query=qq|SELECT count(*)
3818 my $sth = $dbh->prepare($query);
3819 $sth->execute($barcode);
3820 my $exist=$sth->fetchrow ;
3824 =head2 IsBranchTransferAllowed
3826 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3828 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3830 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3831 Koha::Item->can_be_transferred.
3835 sub IsBranchTransferAllowed {
3836 my ( $toBranch, $fromBranch, $code ) = @_;
3838 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3840 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3841 my $dbh = C4::Context->dbh;
3843 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3844 $sth->execute( $toBranch, $fromBranch, $code );
3845 my $limit = $sth->fetchrow_hashref();
3847 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3848 if ( $limit->{'limitId'} ) {
3855 =head2 CreateBranchTransferLimit
3857 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3859 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3861 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3865 sub CreateBranchTransferLimit {
3866 my ( $toBranch, $fromBranch, $code ) = @_;
3867 return unless defined($toBranch) && defined($fromBranch);
3868 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3870 my $dbh = C4::Context->dbh;
3872 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3873 return $sth->execute( $code, $toBranch, $fromBranch );
3876 =head2 DeleteBranchTransferLimits
3878 my $result = DeleteBranchTransferLimits($frombranch);
3880 Deletes all the library transfer limits for one library. Returns the
3881 number of limits deleted, 0e0 if no limits were deleted, or undef if
3882 no arguments are supplied.
3884 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3885 fromBranch => $fromBranch
3890 sub DeleteBranchTransferLimits {
3892 return unless defined $branch;
3893 my $dbh = C4::Context->dbh;
3894 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3895 return $sth->execute($branch);
3899 my ( $borrowernumber, $itemnum ) = @_;
3900 MarkIssueReturned( $borrowernumber, $itemnum );
3905 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3907 The final optional parameter, C<$params>, expected to contain
3908 'skip_record_index' key, which relayed down to Koha::Item/store,
3909 there it prevents calling of ModZebra index_records,
3910 which takes most of the time in batch adds/deletes: index_records better
3911 to be called later in C<additem.pl> after the whole loop.
3914 skip_record_index => 1|0
3919 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3921 unless ( $mark_lost_from ) {
3922 # Temporary check to avoid regressions
3923 die q|LostItem called without $mark_lost_from, check the API.|;
3927 if ( $force_mark_returned ) {
3930 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3931 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3934 my $dbh = C4::Context->dbh();
3935 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3937 JOIN items USING (itemnumber)
3938 JOIN biblio USING (biblionumber)
3939 WHERE issues.itemnumber=?");
3940 $sth->execute($itemnumber);
3941 my $issues=$sth->fetchrow_hashref();
3943 # If a borrower lost the item, add a replacement cost to the their record
3944 if ( my $borrowernumber = $issues->{borrowernumber} ){
3945 my $patron = Koha::Patrons->find( $borrowernumber );
3947 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3948 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3950 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3951 C4::Accounts::chargelostitem(
3954 $issues->{'replacementprice'},
3955 sprintf( "%s %s %s",
3956 $issues->{'title'} || q{},
3957 $issues->{'barcode'} || q{},
3958 $issues->{'itemcallnumber'} || q{},
3961 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3962 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3965 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3968 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3969 my $item = Koha::Items->find($itemnumber);
3970 my $transfers = $item->get_transfers;
3971 while (my $transfer = $transfers->next) {
3972 $transfer->cancel({ reason => 'ItemLost', force => 1 });
3976 sub GetOfflineOperations {
3977 my $dbh = C4::Context->dbh;
3978 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3979 $sth->execute(C4::Context->userenv->{'branch'});
3980 my $results = $sth->fetchall_arrayref({});
3984 sub GetOfflineOperation {
3985 my $operationid = shift;
3986 return unless $operationid;
3987 my $dbh = C4::Context->dbh;
3988 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3989 $sth->execute( $operationid );
3990 return $sth->fetchrow_hashref;
3993 sub AddOfflineOperation {
3994 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3995 my $dbh = C4::Context->dbh;
3996 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3997 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4001 sub DeleteOfflineOperation {
4002 my $dbh = C4::Context->dbh;
4003 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4004 $sth->execute( shift );
4008 sub ProcessOfflineOperation {
4009 my $operation = shift;
4012 if ( $operation->{action} eq 'return' ) {
4013 $report = ProcessOfflineReturn( $operation );
4014 } elsif ( $operation->{action} eq 'issue' ) {
4015 $report = ProcessOfflineIssue( $operation );
4016 } elsif ( $operation->{action} eq 'payment' ) {
4017 $report = ProcessOfflinePayment( $operation );
4020 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4025 sub ProcessOfflineReturn {
4026 my $operation = shift;
4028 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4031 my $itemnumber = $item->itemnumber;
4032 my $issue = GetOpenIssue( $itemnumber );
4034 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4035 ModDateLastSeen( $itemnumber, $leave_item_lost );
4037 $issue->{borrowernumber},
4039 $operation->{timestamp},
4042 $item->onloan(undef);
4043 $item->store({ log_action => 0 });
4046 return "Item not issued.";
4049 return "Item not found.";
4053 sub ProcessOfflineIssue {
4054 my $operation = shift;
4056 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4059 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4061 return "Barcode not found.";
4063 my $itemnumber = $item->itemnumber;
4064 my $issue = GetOpenIssue( $itemnumber );
4066 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4068 $issue->{borrowernumber},
4070 $operation->{timestamp},
4075 $operation->{'barcode'},
4078 $operation->{timestamp},
4083 return "Borrower not found.";
4087 sub ProcessOfflinePayment {
4088 my $operation = shift;
4090 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4092 $patron->account->pay(
4094 amount => $operation->{amount},
4095 library_id => $operation->{branchcode},
4105 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4107 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4112 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4116 ? Koha::Items->find($itemnumber)
4117 : Koha::Items->find( { barcode => $barcode } );
4121 return C4::Letters::GetPreparedLetter (
4122 module => 'circulation',
4123 letter_code => 'TRANSFERSLIP',
4124 branchcode => $branch,
4126 'branches' => $to_branch,
4127 'biblio' => $item->biblionumber,
4128 'items' => $item->unblessed,
4133 =head2 CheckIfIssuedToPatron
4135 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4137 Return 1 if any record item is issued to patron, otherwise return 0
4141 sub CheckIfIssuedToPatron {
4142 my ($borrowernumber, $biblionumber) = @_;
4144 my $dbh = C4::Context->dbh;
4146 SELECT COUNT(*) FROM issues
4147 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4148 WHERE items.biblionumber = ?
4149 AND issues.borrowernumber = ?
4151 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4152 return 1 if $is_issued;
4158 IsItemIssued( $itemnumber )
4160 Return 1 if the item is on loan, otherwise return 0
4165 my $itemnumber = shift;
4166 my $dbh = C4::Context->dbh;
4167 my $sth = $dbh->prepare(q{
4170 WHERE itemnumber = ?
4172 $sth->execute($itemnumber);
4173 return $sth->fetchrow;
4176 =head2 GetAgeRestriction
4178 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4179 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4181 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4182 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4184 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4185 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4186 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4187 Negative days mean the borrower has gone past the age restriction age.
4191 sub GetAgeRestriction {
4192 my ($record_restrictions, $borrower) = @_;
4193 my $markers = C4::Context->preference('AgeRestrictionMarker');
4195 return unless $record_restrictions;
4196 # Split $record_restrictions to something like FSK 16 or PEGI 6
4197 my @values = split ' ', uc($record_restrictions);
4198 return unless @values;
4200 # Search first occurrence of one of the markers
4201 my @markers = split /\|/, uc($markers);
4202 return unless @markers;
4205 my $restriction_year = 0;
4206 for my $value (@values) {
4208 for my $marker (@markers) {
4209 $marker =~ s/^\s+//; #remove leading spaces
4210 $marker =~ s/\s+$//; #remove trailing spaces
4211 if ( $marker eq $value ) {
4212 if ( $index <= $#values ) {
4213 $restriction_year += $values[$index];
4217 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4219 # Perhaps it is something like "K16" (as in Finland)
4220 $restriction_year += $1;
4224 last if ( $restriction_year > 0 );
4227 #Check if the borrower is age restricted for this material and for how long.
4228 if ($restriction_year && $borrower) {
4229 if ( $borrower->{'dateofbirth'} ) {
4230 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4231 $alloweddate[0] += $restriction_year;
4233 #Prevent runime eror on leap year (invalid date)
4234 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4235 $alloweddate[2] = 28;
4238 #Get how many days the borrower has to reach the age restriction
4239 my @Today = split /-/, dt_from_string()->ymd();
4240 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4241 #Negative days means the borrower went past the age restriction age
4242 return ($restriction_year, $daysToAgeRestriction);
4246 return ($restriction_year);
4250 =head2 GetPendingOnSiteCheckouts
4254 sub GetPendingOnSiteCheckouts {
4255 my $dbh = C4::Context->dbh;
4256 return $dbh->selectall_arrayref(q|
4262 items.itemcallnumber,
4266 issues.date_due < NOW() AS is_overdue,
4269 borrowers.firstname,
4271 borrowers.cardnumber,
4272 borrowers.borrowernumber
4274 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4275 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4276 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4277 WHERE issues.onsite_checkout = 1
4278 |, { Slice => {} } );
4284 my ($count, $branch, $itemtype, $ccode, $newness)
4285 = @$params{qw(count branch itemtype ccode newness)};
4287 my $dbh = C4::Context->dbh;
4290 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4291 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4292 i.ccode, SUM(i.issues) AS count
4294 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4295 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4298 my (@where_strs, @where_args);
4301 push @where_strs, 'i.homebranch = ?';
4302 push @where_args, $branch;
4305 if (C4::Context->preference('item-level_itypes')){
4306 push @where_strs, 'i.itype = ?';
4307 push @where_args, $itemtype;
4309 push @where_strs, 'bi.itemtype = ?';
4310 push @where_args, $itemtype;
4314 push @where_strs, 'i.ccode = ?';
4315 push @where_args, $ccode;
4318 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4319 push @where_args, $newness;
4323 $query .= 'WHERE ' . join(' AND ', @where_strs);
4327 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4328 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4333 $query .= q{ ) xxx WHERE count > 0 };
4334 $count = int($count);
4336 $query .= "LIMIT $count";
4339 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4344 =head2 Internal methods
4348 sub _CalculateAndUpdateFine {
4351 my $borrower = $params->{borrower};
4352 my $item = $params->{item};
4353 my $issue = $params->{issue};
4354 my $return_date = $params->{return_date};
4356 unless ($borrower) { carp "No borrower passed in!" && return; }
4357 unless ($item) { carp "No item passed in!" && return; }
4358 unless ($issue) { carp "No issue passed in!" && return; }
4360 my $datedue = dt_from_string( $issue->date_due );
4362 # we only need to calculate and change the fines if we want to do that on return
4363 # Should be on for hourly loans
4364 my $control = C4::Context->preference('CircControl');
4365 my $control_branchcode =
4366 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4367 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4368 : $issue->branchcode;
4370 my $date_returned = $return_date ? $return_date : dt_from_string();
4372 my ( $amount, $unitcounttotal, $unitcount ) =
4373 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4375 if ( C4::Context->preference('finesMode') eq 'production' ) {
4376 if ( $amount > 0 ) {
4377 C4::Overdues::UpdateFine({
4378 issue_id => $issue->issue_id,
4379 itemnumber => $issue->itemnumber,
4380 borrowernumber => $issue->borrowernumber,
4382 due => output_pref($datedue),
4385 elsif ($return_date) {
4387 # Backdated returns may have fines that shouldn't exist,
4388 # so in this case, we need to drop those fines to 0
4390 C4::Overdues::UpdateFine({
4391 issue_id => $issue->issue_id,
4392 itemnumber => $issue->itemnumber,
4393 borrowernumber => $issue->borrowernumber,
4395 due => output_pref($datedue),
4401 sub _CanBookBeAutoRenewed {
4402 my ( $params ) = @_;
4403 my $patron = $params->{patron};
4404 my $item = $params->{item};
4405 my $branchcode = $params->{branchcode};
4406 my $issue = $params->{issue};
4408 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4410 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4412 categorycode => $patron->categorycode,
4413 itemtype => $item->effective_itemtype,
4414 branchcode => $branchcode,
4416 'no_auto_renewal_after',
4417 'no_auto_renewal_after_hard_limit',
4424 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4425 return 'auto_account_expired';
4428 if ( defined $issuing_rule->{no_auto_renewal_after}
4429 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4430 # Get issue_date and add no_auto_renewal_after
4431 # If this is greater than today, it's too late for renewal.
4432 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4433 $maximum_renewal_date->add(
4434 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4436 my $now = dt_from_string;
4437 if ( $now >= $maximum_renewal_date ) {
4438 return "auto_too_late";
4441 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4442 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4443 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4444 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4445 return "auto_too_late";
4449 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4450 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4451 my $amountoutstanding =
4452 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4453 ? $patron->account->balance
4454 : $patron->account->outstanding_debits->total_outstanding;
4455 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4456 return "auto_too_much_oweing";
4460 if ( GetSoonestRenewDate( $patron->id, $item->id ) > dt_from_string() )
4462 return "auto_too_soon";
4468 sub _item_denied_renewal {
4471 my $item = $params->{item};
4472 return unless $item;
4474 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4475 return unless $denyingrules;
4476 foreach my $field (keys %$denyingrules) {
4477 my $val = $item->$field;
4478 if( !defined $val) {
4479 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4482 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4483 # If the results matches the values in the syspref
4484 # We return true if match found
4497 Koha Development Team <http://koha-community.org/>