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 );
28 use C4::Stats qw( UpdateStats );
29 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest ItemsAnyAvailableAndNotRestricted );
30 use C4::Biblio qw( UpdateTotalIssues );
31 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
33 use C4::ItemCirculationAlertPreference;
35 use C4::Log qw( logaction ); # logaction
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits qw( CheckDigits );
40 use Data::Dumper qw( Dumper );
42 use Koha::AuthorisedValues;
43 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
44 use Koha::Biblioitems;
45 use Koha::DateUtils qw( dt_from_string );
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
113 IsBranchTransferAllowed
114 CreateBranchTransferLimit
115 DeleteBranchTransferLimits
121 DeleteOfflineOperation
122 ProcessOfflineOperation
123 ProcessOfflinePayment
126 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
131 C4::Circulation - Koha circulation module
139 The functions in this module deal with circulation, issues, and
140 returns, as well as general information about the library.
141 Also deals with inventory.
147 $str = &barcodedecode($barcode, [$filter]);
149 Generic filter function for barcode string.
150 Called on every circ if the System Pref itemBarcodeInputFilter is set.
151 Will do some manipulation of the barcode for systems that deliver a barcode
152 to circulation.pl that differs from the barcode stored for the item.
153 For proper functioning of this filter, calling the function on the
154 correct barcode string (items.barcode) should return an unaltered barcode.
155 Barcode is going to be automatically trimmed of leading/trailing whitespaces.
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) = @_;
169 return unless defined $barcode;
171 my $branch = C4::Context::mybranch();
172 $barcode =~ s/^\s+|\s+$//g;
173 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
174 Koha::Plugins->call('item_barcode_transform', \$barcode );
175 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
176 if ($filter eq 'whitespace') {
178 } elsif ($filter eq 'cuecat') {
180 my @fields = split( /\./, $barcode );
181 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
182 ($#results == 2) and return $results[2];
183 } elsif ($filter eq 'T-prefix') {
184 if ($barcode =~ /^[Tt](\d)/) {
185 (defined($1) and $1 eq '0') and return $barcode;
186 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
188 return sprintf("T%07d", $barcode);
189 # FIXME: $barcode could be "T1", causing warning: substr outside of string
190 # Why drop the nonzero digit after the T?
191 # Why pass non-digits (or empty string) to "T%07d"?
192 } elsif ($filter eq 'libsuite8') {
193 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
194 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
195 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
197 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
200 } elsif ($filter eq 'EAN13') {
201 my $ean = CheckDigits('ean');
202 if ( $ean->is_valid($barcode) ) {
203 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
204 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
206 warn "# [$barcode] not valid EAN-13/UPC-A\n";
209 return $barcode; # return barcode, modified or not
214 $str = &_decode($chunk);
216 Decodes a segment of a string emitted by a CueCat barcode scanner and
219 FIXME: Should be replaced with Barcode::Cuecat from CPAN
220 or Javascript based decoding on the client side.
227 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
228 my @s = map { index( $seq, $_ ); } split( //, $encoded );
229 my $l = ( $#s + 1 ) % 4;
232 # warn "Error: Cuecat decode parsing failed!";
240 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
242 chr( ( $n >> 16 ) ^ 67 )
243 .chr( ( $n >> 8 & 255 ) ^ 67 )
244 .chr( ( $n & 255 ) ^ 67 );
247 $r = substr( $r, 0, length($r) - $l );
253 ($dotransfer, $messages, $iteminformation) = &transferbook({
254 from_branch => $frombranch
255 to_branch => $tobranch,
257 ignore_reserves => $ignore_reserves,
261 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
263 C<$fbr> is the code for the branch initiating the transfer.
264 C<$tbr> is the code for the branch to which the item should be transferred.
266 C<$barcode> is the barcode of the item to be transferred.
268 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
269 Otherwise, if an item is reserved, the transfer fails.
271 C<$trigger> is the enum value for what triggered the transfer.
273 Returns three values:
279 is true if the transfer was successful.
283 is a reference-to-hash which may have any of the following keys:
289 There is no item in the catalog with the given barcode. The value is C<$barcode>.
291 =item C<DestinationEqualsHolding>
293 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.
297 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.
301 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>.
303 =item C<WasTransferred>
305 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
307 =item C<RecallPlacedAtHoldingBranch>
309 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.
313 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
323 my $tbr = $params->{to_branch};
324 my $fbr = $params->{from_branch};
325 my $ignoreRs = $params->{ignore_reserves};
326 my $barcode = $params->{barcode};
327 my $trigger = $params->{trigger};
330 my $item = Koha::Items->find( { barcode => $barcode } );
332 Koha::Exceptions::MissingParameter->throw(
333 "Missing mandatory parameter: from_branch")
336 Koha::Exceptions::MissingParameter->throw(
337 "Missing mandatory parameter: to_branch")
342 $messages->{'BadBarcode'} = $barcode;
344 return ( $dotransfer, $messages );
347 my $itemnumber = $item->itemnumber;
348 # get branches of book...
349 my $hbr = $item->homebranch;
351 # if using Branch Transfer Limits
352 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
353 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
354 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
355 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
356 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
359 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
360 $messages->{'NotAllowed'} = $tbr . "::" . $code;
365 # can't transfer book if is already there....
366 if ( $fbr eq $tbr ) {
367 $messages->{'DestinationEqualsHolding'} = 1;
371 # check if it is still issued to someone, return it...
372 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
374 AddReturn( $barcode, $fbr );
375 $messages->{'WasReturned'} = $issue->borrowernumber;
379 # That'll save a database query.
380 my ( $resfound, $resrec, undef ) =
381 CheckReserves( $itemnumber );
383 $resrec->{'ResFound'} = $resfound;
384 $messages->{'ResFound'} = $resrec;
385 $dotransfer = 0 unless $ignoreRs;
389 if ( C4::Context->preference('UseRecalls') ) {
390 my $recall = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
391 if ( defined $recall ) {
392 # do a transfer if the recall branch is different to the item holding branch
393 if ( $recall->pickup_library_id eq $fbr ) {
395 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
398 $messages->{'RecallFound'} = $recall;
403 #actually do the transfer....
405 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
407 # don't need to update MARC anymore, we do it in batch now
408 $messages->{'WasTransfered'} = $tbr;
411 ModDateLastSeen( $itemnumber );
412 return ( $dotransfer, $messages );
417 my $borrower = shift;
418 my $item_object = shift;
420 my $onsite_checkout = $params->{onsite_checkout} || 0;
421 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
422 my $cat_borrower = $borrower->{'categorycode'};
423 my $dbh = C4::Context->dbh;
424 # Get which branchcode we need
425 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
426 my $type = $item_object->effective_itemtype;
428 my ($type_object, $parent_type, $parent_maxissueqty_rule);
429 $type_object = Koha::ItemTypes->find( $type );
430 $parent_type = $type_object->parent_type if $type_object;
431 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
432 # Find any children if we are a parent_type;
434 # given branch, patron category, and item type, determine
435 # applicable issuing rule
437 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
439 categorycode => $cat_borrower,
440 itemtype => $parent_type,
441 branchcode => $branch,
442 rule_name => 'maxissueqty',
445 # If the parent rule is for default type we discount it
446 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
448 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
450 categorycode => $cat_borrower,
452 branchcode => $branch,
453 rule_name => 'maxissueqty',
457 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
459 categorycode => $cat_borrower,
461 branchcode => $branch,
462 rule_name => 'maxonsiteissueqty',
467 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
468 # if a rule is found and has a loan limit set, count
469 # how many loans the patron already has that meet that
471 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
474 if ( $maxissueqty_rule->branchcode ) {
475 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
476 $checkouts = $patron->checkouts->search(
477 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
478 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
479 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
481 $checkouts = $patron->checkouts->search(
482 { 'item.homebranch' => $maxissueqty_rule->branchcode } );
485 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
487 $checkouts = $checkouts->search(undef, { prefetch => 'item' });
490 my $rule_itemtype = $maxissueqty_rule->itemtype;
493 unless ( $rule_itemtype ) {
494 # matching rule has the default item type, so count only
495 # those existing loans that don't fall under a more
497 @types = Koha::CirculationRules->search(
499 branchcode => $maxissueqty_rule->branchcode,
500 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
501 itemtype => { '!=' => undef },
502 rule_name => 'maxissueqty'
504 )->get_column('itemtype');
506 if ( $parent_maxissueqty_rule ) {
507 # if we have a parent item type then we count loans of the
508 # specific item type or its siblings or parent
509 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
510 @types = $children->get_column('itemtype');
511 push @types, $parent_type;
512 } elsif ( $child_types ) {
513 # If we are a parent type, we need to count all child types and our own type
514 @types = $child_types->get_column('itemtype');
515 push @types, $type; # And don't forget to count our own types
517 # Otherwise only count the specific itemtype
522 while ( my $c = $checkouts->next ) {
523 my $itemtype = $c->item->effective_itemtype;
525 unless ( $rule_itemtype ) {
526 next if grep {$_ eq $itemtype} @types;
528 next unless grep {$_ eq $itemtype} @types;
531 $sum_checkouts->{total}++;
532 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
533 $sum_checkouts->{itemtype}->{$itemtype}++;
536 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
537 my $checkout_count = $sum_checkouts->{total} || 0;
538 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
540 my $checkout_rules = {
541 checkout_count => $checkout_count,
542 onsite_checkout_count => $onsite_checkout_count,
543 onsite_checkout => $onsite_checkout,
544 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
545 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
546 switch_onsite_checkout => $switch_onsite_checkout,
548 # If parent rules exists
549 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
550 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
551 my $qty_over = _check_max_qty($checkout_rules);
552 return $qty_over if defined $qty_over;
554 # If the parent rule is less than or equal to the child, we only need check the parent
555 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
556 $checkout_rules->{checkout_count} = $checkout_count_type;
557 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
558 my $qty_over = _check_max_qty($checkout_rules);
559 return $qty_over if defined $qty_over;
562 my $qty_over = _check_max_qty($checkout_rules);
563 return $qty_over if defined $qty_over;
567 # Now count total loans against the limit for the branch
568 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
569 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
571 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
572 $checkouts = $patron->checkouts->search(
573 { 'me.branchcode' => $branch} );
574 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
575 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
577 $checkouts = $patron->checkouts->search(
578 { 'item.homebranch' => $branch},
579 { prefetch => 'item' } );
582 my $checkout_count = $checkouts->count;
583 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
584 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
585 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
587 my $qty_over = _check_max_qty(
589 checkout_count => $checkout_count,
590 onsite_checkout_count => $onsite_checkout_count,
591 onsite_checkout => $onsite_checkout,
592 max_checkouts_allowed => $max_checkouts_allowed,
593 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
594 switch_onsite_checkout => $switch_onsite_checkout
597 return $qty_over if defined $qty_over;
600 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
601 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
604 # OK, the patron can issue !!!
610 my $checkout_count = $params->{checkout_count};
611 my $onsite_checkout_count = $params->{onsite_checkout_count};
612 my $onsite_checkout = $params->{onsite_checkout};
613 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
614 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
615 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
617 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
618 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
619 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
621 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
622 count => $onsite_checkout_count,
623 max_allowed => $max_onsite_checkouts_allowed,
627 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
628 if ( $max_checkouts_allowed eq '' ) { return; }
629 my $delta = $switch_onsite_checkout ? 1 : 0;
630 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
632 reason => 'TOO_MANY_CHECKOUTS',
633 count => $checkout_count,
634 max_allowed => $max_checkouts_allowed,
638 elsif ( not $onsite_checkout ) {
639 if ( $max_checkouts_allowed eq '' ) { return; }
641 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
644 reason => 'TOO_MANY_CHECKOUTS',
645 count => $checkout_count - $onsite_checkout_count,
646 max_allowed => $max_checkouts_allowed,
654 =head2 CanBookBeIssued
656 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
657 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
659 Check if a book can be issued.
661 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
663 IMPORTANT: The assumption by users of this routine is that causes blocking
664 the issue are keyed by uppercase labels and other returned
665 data is keyed in lower case!
669 =item C<$patron> is a Koha::Patron
671 =item C<$barcode> is the bar code of the book being issued.
673 =item C<$duedates> is a DateTime object.
675 =item C<$inprocess> boolean switch
677 =item C<$ignore_reserves> boolean switch
679 =item C<$params> Hashref of additional parameters
682 override_high_holds - Ignore high holds
683 onsite_checkout - Checkout is an onsite checkout that will not leave the library
691 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
692 Possible values are :
698 sticky due date is invalid
702 borrower gone with no address
706 borrower declared it's card lost
712 =head3 UNKNOWN_BARCODE
726 item is restricted (set by ??)
728 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
729 could be prevented, but ones that can be overriden by the operator.
731 Possible values are :
739 renewing, not issuing
741 =head3 ISSUED_TO_ANOTHER
743 issued to someone else.
747 reserved for someone else.
751 reserved and being transferred for someone else.
755 sticky due date is invalid or due date in the past
759 if the borrower borrows to much things
763 recalled by someone else
767 sub CanBookBeIssued {
768 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
769 my %needsconfirmation; # filled with problems that needs confirmations
770 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
771 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
772 my %messages; # filled with information messages that should be displayed.
774 my $onsite_checkout = $params->{onsite_checkout} || 0;
775 my $override_high_holds = $params->{override_high_holds} || 0;
777 my $item_object = Koha::Items->find({barcode => $barcode });
779 # MANDATORY CHECKS - unless item exists, nothing else matters
780 unless ( $item_object ) {
781 $issuingimpossible{UNKNOWN_BARCODE} = 1;
783 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
785 my $item_unblessed = $item_object->unblessed; # Transition...
786 my $issue = $item_object->checkout;
787 my $biblio = $item_object->biblio;
789 my $biblioitem = $biblio->biblioitem;
790 my $effective_itemtype = $item_object->effective_itemtype;
791 my $dbh = C4::Context->dbh;
792 my $patron_unblessed = $patron->unblessed;
794 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
796 my $now = dt_from_string();
797 $duedate ||= CalcDateDue( $now, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
798 if (DateTime->compare($duedate,$now) == -1 ) { # duedate cannot be before now
799 $needsconfirmation{INVALID_DATE} = $duedate;
802 my $fees = Koha::Charges::Fees->new(
805 library => $circ_library,
806 item => $item_object,
814 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
815 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
816 C4::Stats::UpdateStats(
818 branch => C4::Context->userenv->{'branch'},
820 itemnumber => $item_object->itemnumber,
821 itemtype => $effective_itemtype,
822 borrowernumber => $patron->borrowernumber,
823 ccode => $item_object->ccode,
824 categorycode => $patron->categorycode,
827 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
828 return( { STATS => 1 }, {});
831 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
832 $issuingimpossible{GNA} = 1;
835 if ( $patron->lost && $patron->lost == 1 ) {
836 $issuingimpossible{CARD_LOST} = 1;
838 if ( $patron->is_debarred ) {
839 $issuingimpossible{DEBARRED} = 1;
842 if ( $patron->is_expired ) {
843 $issuingimpossible{EXPIRED} = 1;
851 my $account = $patron->account;
852 my $balance = $account->balance;
853 my $non_issues_charges = $account->non_issues_charges;
854 my $other_charges = $balance - $non_issues_charges;
856 my $amountlimit = C4::Context->preference("noissuescharge");
857 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
858 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
860 # Check the debt of this patrons guarantees
861 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
862 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
863 if ( defined $no_issues_charge_guarantees ) {
864 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
865 my $guarantees_non_issues_charges = 0;
866 foreach my $g ( @guarantees ) {
867 $guarantees_non_issues_charges += $g->account->non_issues_charges;
870 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
871 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
872 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
873 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
874 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
875 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
879 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
880 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
881 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
882 if ( defined $no_issues_charge_guarantors ) {
883 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
885 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
886 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
887 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
888 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
889 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
890 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
894 if ( C4::Context->preference("IssuingInProcess") ) {
895 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
896 $issuingimpossible{DEBT} = $non_issues_charges;
897 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
898 $needsconfirmation{DEBT} = $non_issues_charges;
899 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
900 $needsconfirmation{DEBT} = $non_issues_charges;
904 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
905 $needsconfirmation{DEBT} = $non_issues_charges;
906 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
907 $issuingimpossible{DEBT} = $non_issues_charges;
908 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
909 $needsconfirmation{DEBT} = $non_issues_charges;
913 if ($balance > 0 && $other_charges > 0) {
914 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
917 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
918 $patron_unblessed = $patron->unblessed;
920 if ( my $debarred_date = $patron->is_debarred ) {
921 # patron has accrued fine days or has a restriction. $count is a date
922 if ($debarred_date eq '9999-12-31') {
923 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
926 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
928 } elsif ( my $num_overdues = $patron->has_overdues ) {
929 ## patron has outstanding overdue loans
930 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
931 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
933 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
934 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
938 # Additional Materials Check
939 if ( C4::Context->preference("CircConfirmItemParts")
940 && $item_object->materials )
942 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
946 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
948 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
950 # Already issued to current borrower.
951 # If it is an on-site checkout if it can be switched to a normal checkout
952 # or ask whether the loan should be renewed
954 if ( $issue->onsite_checkout
955 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
956 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
958 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
959 $patron->borrowernumber,
960 $item_object->itemnumber,
962 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
963 if ( $renewerror eq 'onsite_checkout' ) {
964 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
967 $issuingimpossible{NO_MORE_RENEWALS} = 1;
971 $needsconfirmation{RENEW_ISSUE} = 1;
977 # issued to someone else
979 my $patron = Koha::Patrons->find( $issue->borrowernumber );
981 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
983 unless ( $can_be_returned ) {
984 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
985 $issuingimpossible{branch_to_return} = $message;
987 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
988 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
990 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
991 $needsconfirmation{issued_firstname} = $patron->firstname;
992 $needsconfirmation{issued_surname} = $patron->surname;
993 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
994 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
999 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1001 my $switch_onsite_checkout = (
1002 C4::Context->preference('SwitchOnSiteCheckouts')
1004 and $issue->onsite_checkout
1005 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1006 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1007 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1008 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1009 if ( $toomany->{max_allowed} == 0 ) {
1010 $needsconfirmation{PATRON_CANT} = 1;
1012 if ( C4::Context->preference("AllowTooManyOverride") ) {
1013 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1014 $needsconfirmation{current_loan_count} = $toomany->{count};
1015 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1017 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1018 $issuingimpossible{current_loan_count} = $toomany->{count};
1019 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1024 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1026 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1027 my $wants_check = $patron->wants_check_for_previous_checkout;
1028 $needsconfirmation{PREVISSUE} = 1
1029 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1034 if ( $item_object->notforloan )
1036 if(!C4::Context->preference("AllowNotForLoanOverride")){
1037 $issuingimpossible{NOT_FOR_LOAN} = 1;
1038 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1040 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1041 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1045 # we have to check itemtypes.notforloan also
1046 if (C4::Context->preference('item-level_itypes')){
1047 # this should probably be a subroutine
1048 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1049 $sth->execute($effective_itemtype);
1050 my $notforloan=$sth->fetchrow_hashref();
1051 if ($notforloan->{'notforloan'}) {
1052 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1053 $issuingimpossible{NOT_FOR_LOAN} = 1;
1054 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1056 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1057 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1062 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1063 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
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 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1076 $issuingimpossible{WTHDRAWN} = 1;
1078 if ( $item_object->restricted
1079 && $item_object->restricted == 1 )
1081 $issuingimpossible{RESTRICTED} = 1;
1083 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1084 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1085 my $code = $av->count ? $av->next->lib : '';
1086 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1087 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1089 if ( C4::Context->preference("IndependentBranches") ) {
1090 my $userenv = C4::Context->userenv;
1091 unless ( C4::Context->IsSuperLibrarian() ) {
1092 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1093 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1094 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1095 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1097 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1098 if ( $patron->branchcode ne $userenv->{branch} );
1103 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1105 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1106 if ($rentalConfirmation) {
1107 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1109 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1110 if ($itemtype_object) {
1111 my $accumulate_charge = $fees->accumulate_rentalcharge();
1112 if ( $accumulate_charge > 0 ) {
1113 $rentalCharge += $accumulate_charge;
1117 if ( $rentalCharge > 0 ) {
1118 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1123 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1124 # Only bother doing this if UseRecalls is enabled and the item is recallable
1125 # Don't look at recalls that are in transit
1126 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1127 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1129 foreach my $r ( @recalls ) {
1130 if ( $r->item_id and
1131 $r->item_id == $item_object->itemnumber and
1132 $r->patron_id == $patron->borrowernumber and
1133 ( $r->waiting or $r->requested ) ) {
1134 $messages{RECALLED} = $r->id;
1136 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1139 elsif ( $r->item_id and
1140 $r->item_id == $item_object->itemnumber and
1142 # recalled item is in transit
1143 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1145 elsif ( $r->item_level and
1146 $r->item_id == $item_object->itemnumber and
1147 $r->patron_id != $patron->borrowernumber and
1149 # this specific item has been recalled by a different patron
1150 $needsconfirmation{RECALLED} = $r;
1154 elsif ( !$r->item_level and
1155 $r->patron_id != $patron->borrowernumber and
1157 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1158 $needsconfirmation{RECALLED} = $r;
1165 unless ( $ignore_reserves and defined $recall ) {
1166 # See if the item is on reserve.
1167 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1169 my $resbor = $res->{'borrowernumber'};
1170 if ( $resbor ne $patron->borrowernumber ) {
1171 my $patron = Koha::Patrons->find( $resbor );
1172 if ( $restype eq "Waiting" )
1174 # The item is on reserve and waiting, but has been
1175 # reserved by some other patron.
1176 $needsconfirmation{RESERVE_WAITING} = 1;
1177 $needsconfirmation{'resfirstname'} = $patron->firstname;
1178 $needsconfirmation{'ressurname'} = $patron->surname;
1179 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1180 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1181 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1182 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1183 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1185 elsif ( $restype eq "Reserved" ) {
1186 # The item is on reserve for someone else.
1187 $needsconfirmation{RESERVED} = 1;
1188 $needsconfirmation{'resfirstname'} = $patron->firstname;
1189 $needsconfirmation{'ressurname'} = $patron->surname;
1190 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1191 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1192 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1193 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1194 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1196 elsif ( $restype eq "Transferred" ) {
1197 # The item is determined hold being transferred for someone else.
1198 $needsconfirmation{TRANSFERRED} = 1;
1199 $needsconfirmation{'resfirstname'} = $patron->firstname;
1200 $needsconfirmation{'ressurname'} = $patron->surname;
1201 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1202 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1203 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1204 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1205 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1207 elsif ( $restype eq "Processing" ) {
1208 # The item is determined hold being processed for someone else.
1209 $needsconfirmation{PROCESSING} = 1;
1210 $needsconfirmation{'resfirstname'} = $patron->firstname;
1211 $needsconfirmation{'ressurname'} = $patron->surname;
1212 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1213 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1214 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1215 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1216 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1222 ## CHECK AGE RESTRICTION
1223 my $agerestriction = $biblioitem->agerestriction;
1224 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1225 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1226 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1227 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1230 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1234 ## check for high holds decreasing loan period
1235 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1236 my $check = checkHighHolds( $item_object, $patron );
1238 if ( $check->{exceeded} ) {
1240 num_holds => $check->{outstanding},
1241 duration => $check->{duration},
1242 returndate => $check->{due_date},
1244 if ($override_high_holds) {
1245 $alerts{HIGHHOLDS} = $highholds;
1248 $needsconfirmation{HIGHHOLDS} = $highholds;
1254 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1255 # don't do the multiple loans per bib check if we've
1256 # already determined that we've got a loan on the same item
1257 !$issuingimpossible{NO_MORE_RENEWALS} &&
1258 !$needsconfirmation{RENEW_ISSUE}
1260 # Check if borrower has already issued an item from the same biblio
1261 # Only if it's not a subscription
1262 my $biblionumber = $item_object->biblionumber;
1263 require C4::Serials;
1264 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1265 unless ($is_a_subscription) {
1266 # FIXME Should be $patron->checkouts($args);
1267 my $checkouts = Koha::Checkouts->search(
1269 borrowernumber => $patron->borrowernumber,
1270 biblionumber => $biblionumber,
1276 # if we get here, we don't already have a loan on this item,
1277 # so if there are any loans on this bib, ask for confirmation
1278 if ( $checkouts->count ) {
1279 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1284 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1287 =head2 CanBookBeReturned
1289 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1291 Check whether the item can be returned to the provided branch
1295 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1297 =item C<$branch> is the branchcode where the return is taking place
1305 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1307 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1313 sub CanBookBeReturned {
1314 my ($item, $branch) = @_;
1315 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1317 # assume return is allowed to start
1321 # identify all cases where return is forbidden
1322 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1324 $message = $item->{'homebranch'};
1325 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1327 $message = $item->{'holdingbranch'};
1328 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1330 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1333 return ($allowed, $message);
1336 =head2 CheckHighHolds
1338 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1339 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1340 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1344 sub checkHighHolds {
1345 my ( $item, $patron ) = @_;
1346 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1355 my $holds = Koha::Holds->search( { biblionumber => $item->biblionumber } );
1357 if ( $holds->count() ) {
1358 $return_data->{outstanding} = $holds->count();
1360 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1361 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1362 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1364 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1366 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1368 # static means just more than a given number of holds on the record
1370 # If the number of holds is less than the threshold, we can stop here
1371 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1372 return $return_data;
1375 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1377 # dynamic means X more than the number of holdable items on the record
1379 # let's get the items
1380 my @items = $holds->next()->biblio()->items()->as_list;
1382 # Remove any items with status defined to be ignored even if the would not make item unholdable
1383 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1384 @items = grep { !$_->$status } @items;
1387 # Remove any items that are not holdable for this patron
1388 @items = grep { CanItemBeReserved( $patron , $_, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1390 my $items_count = scalar @items;
1392 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1394 # If the number of holds is less than the count of items we have
1395 # plus the number of holds allowed above that count, we can stop here
1396 if ( $holds->count() <= $threshold ) {
1397 return $return_data;
1401 my $issuedate = dt_from_string();
1403 my $itype = $item->effective_itemtype;
1404 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1406 categorycode => $patron->categorycode,
1408 branchcode => $branchcode,
1411 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1413 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1415 my $rule = Koha::CirculationRules->get_effective_rule_value(
1417 categorycode => $patron->categorycode,
1418 itemtype => $item->effective_itemtype,
1419 branchcode => $branchcode,
1420 rule_name => 'decreaseloanholds',
1425 if ( defined($rule) && $rule ne '' ){
1426 # overrides decreaseLoanHighHoldsDuration syspref
1429 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1431 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1432 $reduced_datedue->set_hour($orig_due->hour);
1433 $reduced_datedue->set_minute($orig_due->minute);
1434 $reduced_datedue->truncate( to => 'minute' );
1436 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1437 $return_data->{exceeded} = 1;
1438 $return_data->{duration} = $duration;
1439 $return_data->{due_date} = $reduced_datedue;
1443 return $return_data;
1448 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1450 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1454 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1456 =item C<$barcode> is the barcode of the item being issued.
1458 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1459 Calculated if empty.
1461 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1463 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1466 AddIssue does the following things :
1468 - step 01: check that there is a borrowernumber & a barcode provided
1469 - check for RENEWAL (book issued & being issued to the same patron)
1470 - renewal YES = Calculate Charge & renew
1472 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1474 - fill reserve if reserve to this patron
1475 - cancel reserve or not, otherwise
1477 - fill recall if recall to this patron
1478 - cancel recall or not
1479 - revert recall's waiting status or not
1480 * TRANSFERT PENDING ?
1481 - complete the transfert
1489 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1491 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1492 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1493 my $auto_renew = $params && $params->{auto_renew};
1494 my $cancel_recall = $params && $params->{cancel_recall};
1495 my $recall_id = $params && $params->{recall_id};
1496 my $dbh = C4::Context->dbh;
1497 my $barcodecheck = CheckValidBarcode($barcode);
1501 if ( $datedue && ref $datedue ne 'DateTime' ) {
1502 $datedue = dt_from_string($datedue);
1505 # $issuedate defaults to today.
1506 if ( !defined $issuedate ) {
1507 $issuedate = dt_from_string();
1510 if ( ref $issuedate ne 'DateTime' ) {
1511 $issuedate = dt_from_string($issuedate);
1516 # Stop here if the patron or barcode doesn't exist
1517 if ( $borrower && $barcode && $barcodecheck ) {
1518 # find which item we issue
1519 my $item_object = Koha::Items->find({ barcode => $barcode })
1520 or return; # if we don't get an Item, abort.
1521 my $item_unblessed = $item_object->unblessed;
1523 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1525 # get actual issuing if there is one
1526 my $actualissue = $item_object->checkout;
1528 # check if we just renew the issue.
1529 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1530 and not $switch_onsite_checkout ) {
1531 $datedue = AddRenewal(
1532 $borrower->{'borrowernumber'},
1533 $item_object->itemnumber,
1536 $issuedate, # here interpreted as the renewal date
1541 my $itype = $item_object->effective_itemtype;
1542 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1546 # Check if we need to use an exact due date set by the ILL module
1547 if ( C4::Context->preference('ILLModule') ) {
1548 # Check if there is an ILL connected with the biblio of the item we are issuing
1549 my $ill_request = Koha::Illrequests->search({
1550 biblio_id => $item_object->biblionumber,
1551 borrowernumber => $borrower->{'borrowernumber'},
1553 due_date => { '!=', undef },
1556 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1557 my $ill_dt = dt_from_string( $ill_request->due_date );
1558 $ill_dt->set_hour(23);
1559 $ill_dt->set_minute(59);
1564 $datedue->truncate( to => 'minute' );
1566 my $patron = Koha::Patrons->find( $borrower );
1567 my $library = Koha::Libraries->find( $branchcode );
1568 my $fees = Koha::Charges::Fees->new(
1571 library => $library,
1572 item => $item_object,
1573 to_date => $datedue,
1577 # it's NOT a renewal
1578 if ( $actualissue and not $switch_onsite_checkout ) {
1579 # This book is currently on loan, but not to the person
1580 # who wants to borrow it now. mark it returned before issuing to the new borrower
1581 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1582 return unless $allowed;
1583 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1584 # AddReturn certainly has side-effects, like onloan => undef
1585 $item_object->discard_changes;
1588 if ( C4::Context->preference('UseRecalls') ) {
1589 Koha::Recalls->move_recall(
1591 action => $cancel_recall,
1592 recall_id => $recall_id,
1593 item => $item_object,
1594 borrowernumber => $borrower->{borrowernumber},
1599 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1601 # Starting process for transfer job (checking transfert and validate it if we have one)
1602 if ( my $transfer = $item_object->get_transfer ) {
1603 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1606 datearrived => dt_from_string,
1607 tobranch => C4::Context->userenv->{branch},
1608 comments => 'Forced branchtransfer'
1611 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1612 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1613 if ( $hold ) { # Is this really needed?
1614 $hold->set( { found => undef } )->store;
1615 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1620 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1621 unless ($auto_renew) {
1622 my $rule = Koha::CirculationRules->get_effective_rule_value(
1624 categorycode => $borrower->{categorycode},
1625 itemtype => $item_object->effective_itemtype,
1626 branchcode => $branchcode,
1627 rule_name => 'auto_renew'
1631 $auto_renew = $rule if defined $rule && $rule ne '';
1634 my $issue_attributes = {
1635 borrowernumber => $borrower->{'borrowernumber'},
1636 issuedate => $issuedate,
1637 date_due => $datedue,
1638 branchcode => C4::Context->userenv->{'branch'},
1639 onsite_checkout => $onsite_checkout,
1640 auto_renew => $auto_renew ? 1 : 0,
1643 # Get ID of logged in user. if called from a batch job,
1644 # no user session exists and C4::Context->userenv() returns
1645 # the scalar '0'. Only do this if the syspref says so
1646 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1647 my $userenv = C4::Context->userenv();
1648 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1650 $issue_attributes->{issuer_id} = $usernumber;
1654 # In the case that the borrower has an on-site checkout
1655 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1656 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1658 $issue->set($issue_attributes)->store;
1661 $issue = Koha::Checkout->new(
1663 itemnumber => $item_object->itemnumber,
1668 $issue->discard_changes;
1669 C4::Auth::track_login_daily( $borrower->{userid} );
1670 if ( $item_object->location && $item_object->location eq 'CART'
1671 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1672 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1673 CartToShelf( $item_object->itemnumber );
1676 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1677 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1680 # Record if item was lost
1681 my $was_lost = $item_object->itemlost;
1683 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1684 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1685 $item_object->itemlost(0);
1686 $item_object->onloan($datedue->ymd());
1687 $item_object->datelastborrowed( dt_from_string()->ymd() );
1688 $item_object->datelastseen( dt_from_string()->ymd() );
1689 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1691 # If the item was lost, it has now been found, charge the overdue if necessary
1693 if ( $item_object->{_charge} ) {
1694 $actualissue //= Koha::Old::Checkouts->search(
1695 { itemnumber => $item_unblessed->{itemnumber} },
1697 order_by => { '-desc' => 'returndate' },
1701 unless ( exists( $borrower->{branchcode} ) ) {
1702 my $patron = $actualissue->patron;
1703 $borrower = $patron->unblessed;
1705 _CalculateAndUpdateFine(
1707 issue => $actualissue,
1708 item => $item_unblessed,
1709 borrower => $borrower,
1710 return_date => $issuedate
1713 _FixOverduesOnReturn( $borrower->{borrowernumber},
1714 $item_object->itemnumber, undef, 'RENEWED' );
1718 # If it costs to borrow this book, charge it to the patron's account.
1719 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1720 if ( $charge && $charge > 0 ) {
1721 AddIssuingCharge( $issue, $charge, 'RENT' );
1724 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1725 if ( $itemtype_object ) {
1726 my $accumulate_charge = $fees->accumulate_rentalcharge();
1727 if ( $accumulate_charge > 0 ) {
1728 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1729 $charge += $accumulate_charge;
1730 $item_unblessed->{charge} = $charge;
1734 # Record the fact that this book was issued.
1735 C4::Stats::UpdateStats(
1737 branch => C4::Context->userenv->{'branch'},
1738 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1740 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1741 itemnumber => $item_object->itemnumber,
1742 itemtype => $item_object->effective_itemtype,
1743 location => $item_object->location,
1744 borrowernumber => $borrower->{'borrowernumber'},
1745 ccode => $item_object->ccode,
1746 categorycode => $borrower->{'categorycode'}
1750 # Send a checkout slip.
1751 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1753 branchcode => $branchcode,
1754 categorycode => $borrower->{categorycode},
1755 item_type => $item_object->effective_itemtype,
1756 notification => 'CHECKOUT',
1758 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1759 SendCirculationAlert(
1762 item => $item_object->unblessed,
1763 borrower => $borrower,
1764 branch => $branchcode,
1769 "CIRCULATION", "ISSUE",
1770 $borrower->{'borrowernumber'},
1771 $item_object->itemnumber,
1772 ) if C4::Context->preference("IssueLog");
1774 Koha::Plugins->call('after_circ_action', {
1775 action => 'checkout',
1777 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1778 checkout => $issue->get_from_storage
1782 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1784 biblio_ids => [ $item_object->biblionumber ]
1786 ) if C4::Context->preference('RealTimeHoldsQueue');
1792 =head2 GetLoanLength
1794 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1796 Get loan length for an itemtype, a borrower type and a branch
1801 my ( $categorycode, $itemtype, $branchcode ) = @_;
1803 # Initialize default values
1807 lengthunit => 'days',
1810 my $found = Koha::CirculationRules->get_effective_rules( {
1811 branchcode => $branchcode,
1812 categorycode => $categorycode,
1813 itemtype => $itemtype,
1822 foreach my $rule_name (keys %$found) {
1823 $rules->{$rule_name} = $found->{$rule_name};
1830 =head2 GetHardDueDate
1832 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1834 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1838 sub GetHardDueDate {
1839 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1841 my $rules = Koha::CirculationRules->get_effective_rules(
1843 categorycode => $borrowertype,
1844 itemtype => $itemtype,
1845 branchcode => $branchcode,
1846 rules => [ 'hardduedate', 'hardduedatecompare' ],
1850 if ( defined( $rules->{hardduedate} ) ) {
1851 if ( $rules->{hardduedate} ) {
1852 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1855 return ( undef, undef );
1860 =head2 GetBranchBorrowerCircRule
1862 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1864 Retrieves circulation rule attributes that apply to the given
1865 branch and patron category, regardless of item type.
1866 The return value is a hashref containing the following key:
1868 patron_maxissueqty - maximum number of loans that a
1869 patron of the given category can have at the given
1870 branch. If the value is undef, no limit.
1872 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1873 patron of the given category can have at the given
1874 branch. If the value is undef, no limit.
1876 This will check for different branch/category combinations in the following order:
1880 default branch and category
1882 If no rule has been found in the database, it will default to
1885 patron_maxissueqty - undef
1886 patron_maxonsiteissueqty - undef
1888 C<$branchcode> and C<$categorycode> should contain the
1889 literal branch code and patron category code, respectively - no
1894 sub GetBranchBorrowerCircRule {
1895 my ( $branchcode, $categorycode ) = @_;
1897 # Initialize default values
1899 patron_maxissueqty => undef,
1900 patron_maxonsiteissueqty => undef,
1904 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1905 my $rule = Koha::CirculationRules->get_effective_rule(
1907 categorycode => $categorycode,
1909 branchcode => $branchcode,
1910 rule_name => $rule_name,
1914 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1920 =head2 GetBranchItemRule
1922 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1924 Retrieves circulation rule attributes that apply to the given
1925 branch and item type, regardless of patron category.
1927 The return value is a hashref containing the following keys:
1929 holdallowed => Hold policy for this branch and itemtype. Possible values:
1930 not_allowed: No holds allowed.
1931 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1932 from_any_library: Holds allowed from any patron.
1933 from_local_hold_group: Holds allowed from libraries in hold group
1935 returnbranch => branch to which to return item. Possible values:
1936 noreturn: do not return, let item remain where checked in (floating collections)
1937 homebranch: return to item's home branch
1938 holdingbranch: return to issuer branch
1940 This searches branchitemrules in the following order:
1942 * Same branchcode and itemtype
1943 * Same branchcode, itemtype '*'
1944 * branchcode '*', same itemtype
1945 * branchcode and itemtype '*'
1947 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1951 sub GetBranchItemRule {
1952 my ( $branchcode, $itemtype ) = @_;
1955 my $rules = Koha::CirculationRules->get_effective_rules({
1956 branchcode => $branchcode,
1957 itemtype => $itemtype,
1958 rules => ['holdallowed', 'hold_fulfillment_policy', 'returnbranch']
1961 # built-in default circulation rule
1962 $rules->{holdallowed} //= 'from_any_library';
1963 $rules->{hold_fulfillment_policy} //= 'any';
1964 $rules->{returnbranch} //= 'homebranch';
1971 ($doreturn, $messages, $iteminformation, $borrower) =
1972 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1978 =item C<$barcode> is the bar code of the book being returned.
1980 =item C<$branch> is the code of the branch where the book is being returned.
1982 =item C<$exemptfine> indicates that overdue charges for the item will be
1985 =item C<$return_date> allows the default return date to be overridden
1986 by the given return date. Optional.
1990 C<&AddReturn> returns a list of four items:
1992 C<$doreturn> is true iff the return succeeded.
1994 C<$messages> is a reference-to-hash giving feedback on the operation.
1995 The keys of the hash are:
2001 No item with this barcode exists. The value is C<$barcode>.
2005 The book is not currently on loan. The value is C<$barcode>.
2009 This book has been withdrawn/cancelled. The value should be ignored.
2011 =item C<Wrongbranch>
2013 This book has was returned to the wrong branch. The value is a hashref
2014 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2015 contain the branchcode of the incorrect and correct return library, respectively.
2019 The item was reserved. The value is a reference-to-hash whose keys are
2020 fields from the reserves table of the Koha database, and
2021 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2022 either C<Waiting>, C<Reserved>, or 0.
2024 =item C<WasReturned>
2026 Value 1 if return is successful.
2028 =item C<NeedsTransfer>
2030 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2032 =item C<RecallFound>
2034 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2035 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2038 =item C<TransferredRecall>
2040 This item has been transferred to this branch to fill a recall. The recall object is returned.
2044 C<$iteminformation> is a reference-to-hash, giving information about the
2045 returned item from the issues table.
2047 C<$borrower> is a reference-to-hash, giving information about the
2048 patron who last borrowed the book.
2053 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2055 if ($branch and not Koha::Libraries->find($branch)) {
2056 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2059 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2060 my $return_date_specified = !!$return_date;
2061 $return_date //= dt_from_string();
2065 my $validTransfer = 1;
2066 my $stat_type = 'return';
2068 # get information on item
2069 my $item = Koha::Items->find({ barcode => $barcode });
2071 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2074 my $itemnumber = $item->itemnumber;
2075 my $itemtype = $item->effective_itemtype;
2077 my $issue = $item->checkout;
2079 $patron = $issue->patron
2080 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2081 . Dumper($issue->unblessed) . "\n";
2083 $messages->{'NotIssued'} = $barcode;
2084 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2086 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2088 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2089 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2090 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2091 $messages->{'LocalUse'} = 1;
2092 $stat_type = 'localuse';
2096 # full item data, but no borrowernumber or checkout info (no issue)
2097 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2098 # get the proper branch to which to return the item
2099 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2100 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2101 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2103 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2104 my $patron_unblessed = $patron ? $patron->unblessed : {};
2106 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2107 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2108 if ($update_loc_rules) {
2109 if (defined $update_loc_rules->{_ALL_}) {
2110 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2111 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2113 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2114 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2116 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2117 $item->location($update_loc_rules->{_ALL_})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2121 foreach my $key ( keys %$update_loc_rules ) {
2122 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2123 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2124 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2125 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2126 $item->location($update_loc_rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2133 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2135 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2137 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2139 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2142 foreach my $key ( keys %$rules ) {
2143 if ( $item->notforloan eq $key ) {
2144 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2145 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2152 # check if the return is allowed at this branch
2153 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2154 unless ($returnallowed){
2155 $messages->{'Wrongbranch'} = {
2156 Wrongbranch => $branch,
2157 Rightbranch => $message
2160 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2161 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2162 return ( $doreturn, $messages, $issue, $patron_unblessed);
2165 if ( $item->withdrawn ) { # book has been cancelled
2166 $messages->{'withdrawn'} = 1;
2167 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2170 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2174 # case of a return of document (deal with issues and holdingbranch)
2176 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2177 $patron or warn "AddReturn without current borrower";
2181 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2186 C4::Context->preference('CalculateFinesOnReturn')
2187 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2192 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2195 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 );
2197 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2198 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2200 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2203 # FIXME is the "= 1" right? This could be the borrower hash.
2204 $messages->{'WasReturned'} = 1;
2207 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2211 # the holdingbranch is updated if the document is returned to another location.
2212 # this is always done regardless of whether the item was on loan or not
2213 if ($item->holdingbranch ne $branch) {
2214 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2217 my $item_was_lost = $item->itemlost;
2218 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2219 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2221 # fix up the accounts.....
2222 if ($item_was_lost) {
2223 $messages->{'WasLost'} = 1;
2224 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2225 my @object_messages = @{ $updated_item->object_messages };
2226 for my $message (@object_messages) {
2227 $messages->{'LostItemFeeRefunded'} = 1
2228 if $message->message eq 'lost_refunded';
2229 $messages->{'LostItemFeeRestored'} = 1
2230 if $message->message eq 'lost_restored';
2232 if ( $message->message eq 'lost_charge' ) {
2233 $issue //= Koha::Old::Checkouts->search(
2234 { itemnumber => $item->itemnumber },
2235 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2237 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2238 my $patron = $issue->patron;
2239 $patron_unblessed = $patron->unblessed;
2241 _CalculateAndUpdateFine(
2244 item => $item->unblessed,
2245 borrower => $patron_unblessed,
2246 return_date => $return_date
2249 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2250 $item->itemnumber, undef, 'RETURNED' );
2251 $messages->{'LostItemFeeCharged'} = 1;
2257 # check if we have a transfer for this document
2258 my $transfer = $item->get_transfer;
2260 # if we have a transfer to complete, we update the line of transfers with the datearrived
2263 if ( $transfer->in_transit ) {
2264 if ( $transfer->tobranch eq $branch ) {
2266 $messages->{'TransferArrived'} = $transfer->frombranch;
2267 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2268 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2271 $messages->{'WrongTransfer'} = $transfer->tobranch;
2272 $messages->{'WrongTransferItem'} = $item->itemnumber;
2273 $messages->{'TransferTrigger'} = $transfer->reason;
2277 if ( $transfer->tobranch eq $branch ) {
2279 $messages->{'TransferArrived'} = $transfer->frombranch;
2280 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2281 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2284 $messages->{'WasTransfered'} = $transfer->tobranch;
2285 $messages->{'TransferTrigger'} = $transfer->reason;
2290 # fix up the overdues in accounts...
2291 if ($borrowernumber) {
2292 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2293 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2295 if ( $issue and $issue->is_overdue($return_date) ) {
2297 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2299 $messages->{'PrevDebarred'} = $debardate;
2301 $messages->{'Debarred'} = $debardate if $debardate;
2303 # there's no overdue on the item but borrower had been previously debarred
2304 } elsif ( $issue->date_due and $patron->debarred ) {
2305 if ( $patron->debarred eq "9999-12-31") {
2306 $messages->{'ForeverDebarred'} = $patron->debarred;
2308 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2309 $borrower_debar_dt->truncate(to => 'day');
2310 my $today_dt = $return_date->clone()->truncate(to => 'day');
2311 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2312 $messages->{'PrevDebarred'} = $patron->debarred;
2319 if ( C4::Context->preference('UseRecalls') ) {
2320 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2322 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2323 if ( defined $recall ) {
2324 $messages->{RecallFound} = $recall;
2325 if ( $recall->pickup_library_id ne $branch ) {
2326 $messages->{RecallNeedsTransfer} = $branch;
2331 # find reserves.....
2332 # launch the Checkreserves routine to find any holds
2333 my ($resfound, $resrec);
2334 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2335 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2336 # 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)
2337 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2338 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2339 $resfound = 'Reserved';
2340 $resrec = $hold->unblessed;
2343 $resrec->{'ResFound'} = $resfound;
2344 $messages->{'ResFound'} = $resrec;
2347 # Record the fact that this book was returned.
2348 my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2349 C4::Stats::UpdateStats({
2352 itemnumber => $itemnumber,
2353 itemtype => $itemtype,
2354 location => $item->location,
2355 borrowernumber => $borrowernumber,
2356 ccode => $item->ccode,
2357 categorycode => $categorycode,
2360 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2362 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2364 branchcode => $branch,
2365 categorycode => $patron->categorycode,
2366 item_type => $itemtype,
2367 notification => 'CHECKIN',
2369 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2370 SendCirculationAlert({
2372 item => $item->unblessed,
2373 borrower => $patron->unblessed,
2379 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2380 if C4::Context->preference("ReturnLog");
2383 # Check if this item belongs to a biblio record that is attached to an
2384 # ILL request, if it is we need to update the ILL request's status
2385 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2386 my $request = Koha::Illrequests->find(
2387 { biblio_id => $item->biblio->biblionumber }
2389 $request->status('RET') if $request;
2392 if ( C4::Context->preference('UseRecalls') ) {
2393 # all recalls that have triggered a transfer will have an allocated itemnumber
2394 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2395 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2396 $messages->{TransferredRecall} = $transfer_recall;
2400 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2401 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2402 && ( $doreturn or $messages->{'NotIssued'} )
2404 and ( $branch ne $returnbranch )
2405 and not $messages->{'WrongTransfer'}
2406 and not $messages->{'WasTransfered'}
2407 and not $messages->{TransferredRecall}
2408 and not $messages->{RecallNeedsTransfer} )
2410 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2411 if (C4::Context->preference("AutomaticItemReturn" ) or
2412 (C4::Context->preference("UseBranchTransferLimits") and
2413 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2415 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2416 $messages->{'WasTransfered'} = $returnbranch;
2417 $messages->{'TransferTrigger'} = $transfer_trigger;
2419 $messages->{'NeedsTransfer'} = $returnbranch;
2420 $messages->{'TransferTrigger'} = $transfer_trigger;
2424 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2425 my $claims = Koha::Checkouts::ReturnClaims->search(
2427 itemnumber => $item->id,
2428 resolution => undef,
2432 if ( $claims->count ) {
2433 $messages->{ReturnClaims} = $claims;
2437 # Check for bundle status
2438 if ( $item->in_bundle ) {
2439 my $host = $item->bundle_host;
2440 $messages->{InBundle} = $host;
2443 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2444 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2446 if ( $doreturn and $issue ) {
2447 my $checkin = Koha::Old::Checkouts->find($issue->id);
2449 Koha::Plugins->call('after_circ_action', {
2450 action => 'checkin',
2456 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2458 biblio_ids => [ $item->biblionumber ]
2460 ) if C4::Context->preference('RealTimeHoldsQueue');
2463 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2466 =head2 MarkIssueReturned
2468 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2470 Unconditionally marks an issue as being returned by
2471 moving the C<issues> row to C<old_issues> and
2472 setting C<returndate> to the current date.
2474 if C<$returndate> is specified (in iso format), it is used as the date
2477 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2478 the old_issue is immediately anonymised
2480 Ideally, this function would be internal to C<C4::Circulation>,
2481 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2482 and offline_circ/process_koc.pl.
2484 The last optional parameter allos passing skip_record_index to the item store call.
2488 sub MarkIssueReturned {
2489 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2491 # Retrieve the issue
2492 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2494 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2496 my $issue_id = $issue->issue_id;
2498 my $schema = Koha::Database->schema;
2500 # FIXME Improve the return value and handle it from callers
2501 $schema->txn_do(sub {
2503 my $patron = Koha::Patrons->find( $borrowernumber );
2505 # Update the returndate value
2506 if ( $returndate ) {
2507 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2510 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2513 # Create the old_issues entry
2514 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2516 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2517 if ( $privacy && $privacy == 2) {
2518 $old_checkout->anonymize;
2521 # And finally delete the issue
2524 $issue->item->onloan(undef)->store(
2526 skip_record_index => $params->{skip_record_index},
2527 skip_holds_queue => $params->{skip_holds_queue}
2531 if ( C4::Context->preference('StoreLastBorrower') ) {
2532 my $item = Koha::Items->find( $itemnumber );
2533 $item->last_returned_by( $patron );
2536 # Remove any OVERDUES related debarment if the borrower has no overdues
2537 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2538 && $patron->debarred
2539 && !$patron->has_overdues
2540 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2542 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2550 =head2 _debar_user_on_return
2552 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2554 C<$borrower> borrower hashref
2556 C<$item> item hashref
2558 C<$datedue> date due DateTime object
2560 C<$returndate> DateTime object representing the return time
2562 Internal function, called only by AddReturn that calculates and updates
2563 the user fine days, and debars them if necessary.
2565 Should only be called for overdue returns
2567 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2572 sub _calculate_new_debar_dt {
2573 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2575 my $branchcode = _GetCircControlBranch( $item, $borrower );
2576 my $circcontrol = C4::Context->preference('CircControl');
2577 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2578 { categorycode => $borrower->{categorycode},
2579 itemtype => $item->{itype},
2580 branchcode => $branchcode,
2585 'maxsuspensiondays',
2586 'suspension_chargeperiod',
2590 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2591 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2592 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2594 return unless $finedays;
2596 # finedays is in days, so hourly loans must multiply by 24
2597 # thus 1 hour late equals 1 day suspension * finedays rate
2598 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2600 # grace period is measured in the same units as the loan
2602 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2604 my $deltadays = DateTime::Duration->new(
2605 days => $chargeable_units
2608 if ( $deltadays->subtract($grace)->is_positive() ) {
2609 my $suspension_days = $deltadays * $finedays;
2611 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2612 # No need to / 1 and do not consider / 0
2613 $suspension_days = DateTime::Duration->new(
2614 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2618 # If the max suspension days is < than the suspension days
2619 # the suspension days is limited to this maximum period.
2620 my $max_sd = $issuing_rule->{maxsuspensiondays};
2621 if ( defined $max_sd && $max_sd ne '' ) {
2622 $max_sd = DateTime::Duration->new( days => $max_sd );
2623 $suspension_days = $max_sd
2624 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2627 my ( $has_been_extended );
2628 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2629 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2631 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2632 $has_been_extended = 1;
2637 # Use the calendar or not to calculate the debarment date
2638 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2639 my $calendar = Koha::Calendar->new(
2640 branchcode => $branchcode,
2641 days_mode => 'Calendar'
2643 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2646 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2648 return $new_debar_dt;
2653 sub _debar_user_on_return {
2654 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2656 $return_date //= dt_from_string();
2658 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2660 return unless $new_debar_dt;
2662 Koha::Patron::Debarments::AddUniqueDebarment({
2663 borrowernumber => $borrower->{borrowernumber},
2664 expiration => $new_debar_dt->ymd(),
2665 type => 'SUSPENSION',
2667 # if borrower was already debarred but does not get an extra debarment
2668 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2669 my ($new_debarment_str, $is_a_reminder);
2670 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2672 $new_debarment_str = $borrower->{debarred};
2674 $new_debarment_str = $new_debar_dt->ymd();
2676 # FIXME Should return a DateTime object
2677 return $new_debarment_str, $is_a_reminder;
2680 =head2 _FixOverduesOnReturn
2682 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2684 C<$borrowernumber> borrowernumber
2686 C<$itemnumber> itemnumber
2688 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2690 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2696 sub _FixOverduesOnReturn {
2697 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2698 unless( $borrowernumber ) {
2699 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2703 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2707 warn "_FixOverduesOnReturn() not supplied valid status";
2711 my $schema = Koha::Database->schema;
2713 my $result = $schema->txn_do(
2715 # check for overdue fine
2716 my $accountlines = Koha::Account::Lines->search(
2718 borrowernumber => $borrowernumber,
2719 itemnumber => $item,
2720 debit_type_code => 'OVERDUE',
2721 status => 'UNRETURNED'
2724 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2726 my $accountline = $accountlines->next;
2727 my $payments = $accountline->credits;
2729 my $amountoutstanding = $accountline->amountoutstanding;
2730 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2731 $accountline->delete;
2732 return 0; # no warning, we've just removed a zero value fine (backdated return)
2733 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2734 my $account = Koha::Account->new({patron_id => $borrowernumber});
2735 my $credit = $account->add_credit(
2737 amount => $amountoutstanding,
2738 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2739 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2740 interface => C4::Context->interface,
2746 $credit->apply({ debits => [ $accountline ] });
2748 if (C4::Context->preference("FinesLog")) {
2749 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2753 $accountline->status($status);
2754 return $accountline->store();
2761 =head2 _GetCircControlBranch
2763 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2767 Return the library code to be used to determine which circulation
2768 policy applies to a transaction. Looks up the CircControl and
2769 HomeOrHoldingBranch system preferences.
2771 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2773 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2777 sub _GetCircControlBranch {
2778 my ($item, $borrower) = @_;
2779 my $circcontrol = C4::Context->preference('CircControl');
2782 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2783 $branch= C4::Context->userenv->{'branch'};
2784 } elsif ($circcontrol eq 'PatronLibrary') {
2785 $branch=$borrower->{branchcode};
2787 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2788 $branch = $item->{$branchfield};
2789 # default to item home branch if holdingbranch is used
2790 # and is not defined
2791 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2792 $branch = $item->{homebranch};
2798 =head2 GetUpcomingDueIssues
2800 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2804 sub GetUpcomingDueIssues {
2807 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2808 my $dbh = C4::Context->dbh;
2811 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2813 LEFT JOIN items USING (itemnumber)
2814 LEFT JOIN branches ON branches.branchcode =
2816 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2817 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2818 my @bind_parameters = ( $params->{'days_in_advance'} );
2820 my $sth = $dbh->prepare( $statement );
2821 $sth->execute( @bind_parameters );
2822 my $upcoming_dues = $sth->fetchall_arrayref({});
2824 return $upcoming_dues;
2827 =head2 CanBookBeRenewed
2829 ($ok,$error,$info) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2831 Find out whether a borrowed item may be renewed.
2833 C<$borrowernumber> is the borrower number of the patron who currently
2834 has the item on loan.
2836 C<$itemnumber> is the number of the item to renew.
2838 C<$override_limit>, if supplied with a true value, causes
2839 the limit on the number of times that the loan can be renewed
2840 (as controlled by the item type) to be ignored. Overriding also allows
2841 to renew sooner than "No renewal before" and to manually renew loans
2842 that are automatically renewed.
2844 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2845 item must currently be on loan to the specified borrower; renewals
2846 must be allowed for the item's type; and the borrower must not have
2847 already renewed the loan.
2848 $error will contain the reason the renewal can not proceed
2849 $info will contain a hash of additional info
2850 currently 'soonest_renew_date' if error is 'too soon'
2854 sub CanBookBeRenewed {
2855 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2857 my $auto_renew = "no";
2860 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2861 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2862 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2863 return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2865 my $patron = $issue->patron or return;
2867 # override_limit will override anything else except on_reserve
2868 unless ( $override_limit ){
2869 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2870 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2872 categorycode => $patron->categorycode,
2873 itemtype => $item->effective_itemtype,
2874 branchcode => $branchcode,
2878 'unseen_renewals_allowed'
2883 return ( 0, "too_many" )
2884 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2886 return ( 0, "too_unseen" )
2887 if C4::Context->preference('UnseenRenewals') &&
2888 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2889 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2891 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2892 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2893 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2894 my $restricted = $patron->is_debarred;
2895 my $hasoverdues = $patron->has_overdues;
2897 if ( $restricted and $restrictionblockrenewing ) {
2898 return ( 0, 'restriction');
2899 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2900 return ( 0, 'overdue');
2903 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2906 branchcode => $branchcode,
2909 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2910 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2911 # extra notices being sent. Cron also implies no override
2912 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2913 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2914 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2917 if ( C4::Context->preference('UseRecalls') ) {
2919 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2920 if ( defined $recall ) {
2921 if ( $recall->item_level ) {
2922 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2923 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
2925 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2926 return ( 0, 'recalled' ) unless ( $recall->waiting );
2931 my $fillable_holds = Koha::Holds->search(
2933 biblionumber => $item->biblionumber,
2936 reservedate => { '<=' => \'NOW()' },
2939 { prefetch => 'patron' }
2941 if ( $fillable_holds->count ) {
2942 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
2943 my @possible_holds = $fillable_holds->as_list;
2945 # Get all other items that could possibly fill reserves
2946 # FIXME We could join reserves (or more tables) here to eliminate some checks later
2947 my @other_items = Koha::Items->search({
2948 biblionumber => $item->biblionumber,
2951 -not => { itemnumber => $itemnumber } })->as_list;
2953 return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
2956 foreach my $possible_hold (@possible_holds) {
2958 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
2959 my $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron_with_reserve });
2961 # FIXME: We are not checking whether the item we are renewing can fill the hold
2963 foreach my $other_item (@other_items) {
2964 next if defined $matched_items{$other_item->itemnumber};
2965 next if IsItemOnHoldAndFound( $other_item->itemnumber );
2966 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef, $items_any_available);
2967 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2968 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
2969 # CanItemBeReserved checks 'rules' and 'policies' which means
2970 # items will fill holds at checkin that are rejected here
2972 $matched_items{$other_item->itemnumber} = 1;
2975 return ( 0, "on_reserve" ) unless $fillable;
2979 my ($status, $matched_reserve, $possible_reserves) = CheckReserves($itemnumber);
2980 return ( 0, "on_reserve" ) if $status;
2984 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2985 $soonest = GetSoonestRenewDate($issue);
2986 if ( $soonest > dt_from_string() ){
2987 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
2990 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2992 return ( 1, undef );
2997 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
3001 C<$borrowernumber> is the borrower number of the patron who currently
3004 C<$itemnumber> is the number of the item to renew.
3006 C<$branch> is the library where the renewal took place (if any).
3007 The library that controls the circ policies for the renewal is retrieved from the issues record.
3009 C<$datedue> can be a DateTime object used to set the due date.
3011 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3012 this parameter is not supplied, lastreneweddate is set to the current date.
3014 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3015 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3016 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3019 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3020 from the book's item type.
3022 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3023 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3024 fallback to a true value
3029 my $borrowernumber = shift;
3030 my $itemnumber = shift or return;
3032 my $datedue = shift;
3033 my $lastreneweddate = shift || dt_from_string();
3034 my $skipfinecalc = shift;
3037 # Fallback on a 'seen' renewal
3038 $seen = defined $seen && $seen == 0 ? 0 : 1;
3040 my $item_object = Koha::Items->find($itemnumber) or return;
3041 my $biblio = $item_object->biblio;
3042 my $issue = $item_object->checkout;
3043 my $item_unblessed = $item_object->unblessed;
3045 my $dbh = C4::Context->dbh;
3047 return unless $issue;
3049 $borrowernumber ||= $issue->borrowernumber;
3051 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3052 $datedue = dt_from_string($datedue, 'sql');
3055 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3056 my $patron_unblessed = $patron->unblessed;
3058 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3060 my $schema = Koha::Database->schema;
3061 $schema->txn_do(sub{
3063 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3064 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3066 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3068 # If the due date wasn't specified, calculate it by adding the
3069 # book's loan length to today's date or the current due date
3070 # based on the value of the RenewalPeriodBase syspref.
3071 my $itemtype = $item_object->effective_itemtype;
3074 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3075 dt_from_string( $issue->date_due, 'sql' ) :
3077 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3080 my $fees = Koha::Charges::Fees->new(
3083 library => $circ_library,
3084 item => $item_object,
3085 from_date => dt_from_string( $issue->date_due, 'sql' ),
3086 to_date => dt_from_string($datedue),
3090 # Increment the unseen renewals, if appropriate
3091 # We only do so if the syspref is enabled and
3092 # a maximum value has been set in the circ rules
3093 my $unseen_renewals = $issue->unseen_renewals;
3094 if (C4::Context->preference('UnseenRenewals')) {
3095 my $rule = Koha::CirculationRules->get_effective_rule(
3096 { categorycode => $patron->categorycode,
3097 itemtype => $item_object->effective_itemtype,
3098 branchcode => $circ_library->branchcode,
3099 rule_name => 'unseen_renewals_allowed'
3102 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3105 # If the renewal is seen, unseen should revert to 0
3106 $unseen_renewals = 0;
3110 # Update the issues record to have the new due date, and a new count
3111 # of how many times it has been renewed.
3112 my $renews = ( $issue->renewals_count || 0 ) + 1;
3113 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3116 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3119 Koha::Exceptions::Checkout::FailedRenewal->throw(
3120 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3124 # Update the renewal count on the item, and tell zebra to reindex
3125 $renews = ( $item_object->renewals || 0 ) + 1;
3126 $item_object->renewals($renews);
3127 $item_object->onloan($datedue);
3128 $item_object->store({ log_action => 0 });
3130 # Charge a new rental fee, if applicable
3131 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3132 if ( $charge > 0 ) {
3133 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3136 # Charge a new accumulate rental fee, if applicable
3137 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3138 if ( $itemtype_object ) {
3139 my $accumulate_charge = $fees->accumulate_rentalcharge();
3140 if ( $accumulate_charge > 0 ) {
3141 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3143 $charge += $accumulate_charge;
3146 # Send a renewal slip according to checkout alert preferencei
3147 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3148 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3150 branchcode => $branch,
3151 categorycode => $patron->categorycode,
3152 item_type => $itemtype,
3153 notification => 'CHECKOUT',
3155 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3156 SendCirculationAlert(
3159 item => $item_unblessed,
3160 borrower => $patron->unblessed,
3167 # Remove any OVERDUES related debarment if the borrower has no overdues
3169 && $patron->is_debarred
3170 && ! $patron->has_overdues
3171 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3173 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3176 # Add renewal record
3177 my $renewal = Koha::Checkouts::Renewal->new(
3179 checkout_id => $issue->issue_id,
3180 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3182 interface => C4::Context->interface
3186 # Add the renewal to stats
3187 C4::Stats::UpdateStats(
3189 branch => $item_object->renewal_branchcode({branch => $branch}),
3192 itemnumber => $itemnumber,
3193 itemtype => $itemtype,
3194 location => $item_object->location,
3195 borrowernumber => $borrowernumber,
3196 ccode => $item_object->ccode,
3197 categorycode => $patron->categorycode,
3202 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3204 Koha::Plugins->call('after_circ_action', {
3205 action => 'renewal',
3207 checkout => $issue->get_from_storage
3216 # check renewal status
3217 my ( $bornum, $itemno ) = @_;
3218 my $dbh = C4::Context->dbh;
3220 my $unseencount = 0;
3221 my $renewsallowed = 0;
3222 my $unseenallowed = 0;
3226 my $patron = Koha::Patrons->find( $bornum );
3227 my $item = Koha::Items->find($itemno);
3229 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3231 # Look in the issues table for this item, lent to this borrower,
3232 # and not yet returned.
3234 # FIXME - I think this function could be redone to use only one SQL call.
3235 my $sth = $dbh->prepare(
3236 "select * from issues
3237 where (borrowernumber = ?)
3238 and (itemnumber = ?)"
3240 $sth->execute( $bornum, $itemno );
3241 my $data = $sth->fetchrow_hashref;
3242 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3243 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3244 # $item and $borrower should be calculated
3245 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3247 my $rules = Koha::CirculationRules->get_effective_rules(
3249 categorycode => $patron->categorycode,
3250 itemtype => $item->effective_itemtype,
3251 branchcode => $branchcode,
3252 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3255 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3256 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3257 $rules->{unseen_renewals_allowed} :
3259 $renewsleft = $renewsallowed - $renewcount;
3260 $unseenleft = $unseenallowed - $unseencount;
3261 if($renewsleft < 0){ $renewsleft = 0; }
3262 if($unseenleft < 0){ $unseenleft = 0; }
3273 =head2 GetSoonestRenewDate
3275 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($issue);
3277 Find out the soonest possible renew date of a borrowed item.
3279 C<$checkout> is the checkout object to renew.
3281 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3282 renew date, based on the value "No renewal before" of the applicable
3283 issuing rule. Returns the current date if the item can already be
3284 renewed, and returns undefined if the borrower, loan, or item
3289 sub GetSoonestRenewDate {
3290 my ( $checkout ) = @_;
3292 my $item = $checkout->item or return;
3293 my $patron = $checkout->patron or return;
3295 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3296 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3297 { categorycode => $patron->categorycode,
3298 itemtype => $item->effective_itemtype,
3299 branchcode => $branchcode,
3307 my $now = dt_from_string;
3309 if ( defined $issuing_rule->{norenewalbefore}
3310 and $issuing_rule->{norenewalbefore} ne "" )
3312 my $soonestrenewal =
3313 dt_from_string( $checkout->date_due )->subtract(
3314 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3316 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3317 and $issuing_rule->{lengthunit} eq 'days' )
3319 $soonestrenewal->truncate( to => 'day' );
3321 return $soonestrenewal if $now < $soonestrenewal;
3322 } elsif ( $checkout->auto_renew && $patron->autorenew_checkouts ) {
3323 # Checkouts with auto-renewing fall back to due date
3324 my $soonestrenewal = dt_from_string( $checkout->date_due );
3325 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3326 and $issuing_rule->{lengthunit} eq 'days' )
3328 $soonestrenewal->truncate( to => 'day' );
3330 return $soonestrenewal;
3335 =head2 GetLatestAutoRenewDate
3337 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3339 Find out the latest possible auto renew date of a borrowed item.
3341 C<$borrowernumber> is the borrower number of the patron who currently
3342 has the item on loan.
3344 C<$itemnumber> is the number of the item to renew.
3346 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3347 auto renew date, based on the value "No auto renewal after" and the "No auto
3348 renewal after (hard limit) of the applicable issuing rule.
3349 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3350 or item cannot be found.
3354 sub GetLatestAutoRenewDate {
3355 my ( $borrowernumber, $itemnumber ) = @_;
3357 my $dbh = C4::Context->dbh;
3359 my $item = Koha::Items->find($itemnumber) or return;
3360 my $itemissue = $item->checkout or return;
3362 $borrowernumber ||= $itemissue->borrowernumber;
3363 my $patron = Koha::Patrons->find( $borrowernumber )
3366 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3367 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3369 categorycode => $patron->categorycode,
3370 itemtype => $item->effective_itemtype,
3371 branchcode => $branchcode,
3373 'no_auto_renewal_after',
3374 'no_auto_renewal_after_hard_limit',
3380 return unless $circulation_rules;
3382 if ( not $circulation_rules->{no_auto_renewal_after}
3383 or $circulation_rules->{no_auto_renewal_after} eq '' )
3384 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3385 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3387 my $maximum_renewal_date;
3388 if ( $circulation_rules->{no_auto_renewal_after} ) {
3389 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3390 $maximum_renewal_date->add(
3391 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3395 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3396 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3397 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3399 return $maximum_renewal_date;
3403 =head2 GetIssuingCharges
3405 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3407 Calculate how much it would cost for a given patron to borrow a given
3408 item, including any applicable discounts.
3410 C<$itemnumber> is the item number of item the patron wishes to borrow.
3412 C<$borrowernumber> is the patron's borrower number.
3414 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3415 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3420 sub GetIssuingCharges {
3422 # calculate charges due
3423 my ( $itemnumber, $borrowernumber ) = @_;
3425 my $dbh = C4::Context->dbh;
3428 # Get the book's item type and rental charge (via its biblioitem).
3429 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3430 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3431 $charge_query .= (C4::Context->preference('item-level_itypes'))
3432 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3433 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3435 $charge_query .= ' WHERE items.itemnumber =?';
3437 my $sth = $dbh->prepare($charge_query);
3438 $sth->execute($itemnumber);
3439 if ( my $item_data = $sth->fetchrow_hashref ) {
3440 $item_type = $item_data->{itemtype};
3441 $charge = $item_data->{rentalcharge};
3443 # FIXME This should follow CircControl
3444 my $branch = C4::Context::mybranch();
3445 my $patron = Koha::Patrons->find( $borrowernumber );
3446 my $discount = Koha::CirculationRules->get_effective_rule({
3447 categorycode => $patron->categorycode,
3448 branchcode => $branch,
3449 itemtype => $item_type,
3450 rule_name => 'rentaldiscount'
3453 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3455 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3459 return ( $charge, $item_type );
3462 =head2 AddIssuingCharge
3464 &AddIssuingCharge( $checkout, $charge, $type )
3468 sub AddIssuingCharge {
3469 my ( $checkout, $charge, $type ) = @_;
3471 # FIXME What if checkout does not exist?
3473 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3474 my $accountline = $account->add_debit(
3478 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3479 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3480 interface => C4::Context->interface,
3482 item_id => $checkout->itemnumber,
3483 issue_id => $checkout->issue_id,
3488 =head2 GetTransfersFromTo
3490 @results = GetTransfersFromTo($frombranch,$tobranch);
3492 Returns the list of pending transfers between $from and $to branch
3496 sub GetTransfersFromTo {
3497 my ( $frombranch, $tobranch ) = @_;
3498 return unless ( $frombranch && $tobranch );
3499 my $dbh = C4::Context->dbh;
3501 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3502 FROM branchtransfers
3505 AND datecancelled IS NULL
3506 AND datesent IS NOT NULL
3507 AND datearrived IS NULL
3509 my $sth = $dbh->prepare($query);
3510 $sth->execute( $frombranch, $tobranch );
3513 while ( my $data = $sth->fetchrow_hashref ) {
3514 push @gettransfers, $data;
3516 return (@gettransfers);
3519 =head2 SendCirculationAlert
3521 Send out a C<check-in> or C<checkout> alert using the messaging system.
3529 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3533 Hashref of information about the item being checked in or out.
3537 Hashref of information about the borrower of the item.
3541 The branchcode from where the checkout or check-in took place.
3547 SendCirculationAlert({
3550 borrower => $borrower,
3556 sub SendCirculationAlert {
3558 my ($type, $item, $borrower, $branch, $issue) =
3559 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3560 my %message_name = (
3561 CHECKIN => 'Item_Check_in',
3562 CHECKOUT => 'Item_Checkout',
3563 RENEWAL => 'Item_Checkout',
3565 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3566 borrowernumber => $borrower->{borrowernumber},
3567 message_name => $message_name{$type},
3572 items => $item->{itemnumber},
3573 biblio => $item->{biblionumber},
3574 biblioitems => $item->{biblionumber},
3575 borrowers => $borrower,
3576 branches => $branch,
3579 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3580 # See C4::Letters:: _parseletter_sth
3581 if( $type eq 'CHECKIN' ){
3582 $tables->{old_issues} = $issue->issue_id;
3584 $tables->{issues} = $item->{itemnumber};
3587 my $schema = Koha::Database->new->schema;
3588 my @transports = keys %{ $borrower_preferences->{transports} };
3590 # From the MySQL doc:
3591 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3592 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3593 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3594 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3596 for my $mtt (@transports) {
3597 my $letter = C4::Letters::GetPreparedLetter (
3598 module => 'circulation',
3599 letter_code => $type,
3600 branchcode => $branch,
3601 message_transport_type => $mtt,
3602 lang => $borrower->{lang},
3606 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3607 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3608 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3609 unless ( $message ) {
3610 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3611 C4::Message->enqueue($letter, $borrower, $mtt);
3613 $message->append($letter);
3616 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3622 =head2 updateWrongTransfer
3624 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3626 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
3630 sub updateWrongTransfer {
3631 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3633 # first step: cancel the original transfer
3634 my $item = Koha::Items->find($itemNumber);
3635 my $transfer = $item->get_transfer;
3636 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3638 # second step: create a new transfer to the right location
3639 my $new_transfer = $item->request_transfer(
3641 to => $transfer->to_library,
3642 reason => $transfer->reason,
3643 comment => $transfer->comments,
3649 return $new_transfer;
3654 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3656 this function calculates the due date given the start date and configured circulation rules,
3657 checking against the holidays calendar as per the daysmode circulation rule.
3658 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3659 C<$itemtype> = itemtype code of item in question
3660 C<$branch> = location whose calendar to use
3661 C<$borrower> = Borrower object
3662 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3667 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3671 # loanlength now a href
3673 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3675 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3681 if (ref $startdate ne 'DateTime' ) {
3682 $datedue = dt_from_string($datedue);
3684 $datedue = $startdate->clone;
3687 $datedue = dt_from_string()->truncate( to => 'minute' );
3691 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3693 categorycode => $borrower->{categorycode},
3694 itemtype => $itemtype,
3695 branchcode => $branch,
3699 # calculate the datedue as normal
3700 if ( $daysmode eq 'Days' )
3701 { # ignoring calendar
3702 if ( $loanlength->{lengthunit} eq 'hours' ) {
3703 $datedue->add( hours => $loanlength->{$length_key} );
3705 $datedue->add( days => $loanlength->{$length_key} );
3706 $datedue->set_hour(23);
3707 $datedue->set_minute(59);
3711 if ($loanlength->{lengthunit} eq 'hours') {
3712 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3715 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3717 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3718 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3719 if ($loanlength->{lengthunit} eq 'days') {
3720 $datedue->set_hour(23);
3721 $datedue->set_minute(59);
3725 # if Hard Due Dates are used, retrieve them and apply as necessary
3726 my ( $hardduedate, $hardduedatecompare ) =
3727 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3728 if ($hardduedate) { # hardduedates are currently dates
3729 $hardduedate->truncate( to => 'minute' );
3730 $hardduedate->set_hour(23);
3731 $hardduedate->set_minute(59);
3732 my $cmp = DateTime->compare( $hardduedate, $datedue );
3734 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3735 # if the calculated date is before the 'after' Hard Due Date (floor), override
3736 # if the hard due date is set to 'exactly', overrride
3737 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3738 $datedue = $hardduedate->clone;
3741 # in all other cases, keep the date due as it is
3745 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3746 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3747 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3748 if( $expiry_dt ) { #skip empty expiry date..
3749 $expiry_dt->set( hour => 23, minute => 59);
3750 my $d1= $datedue->clone->set_time_zone('floating');
3751 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3752 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3755 if ( $daysmode ne 'Days' ) {
3756 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3757 if ( $calendar->is_holiday($datedue) ) {
3758 # Don't return on a closed day
3759 $datedue = $calendar->prev_open_days( $datedue, 1 );
3768 sub CheckValidBarcode{
3770 my $dbh = C4::Context->dbh;
3771 my $query=qq|SELECT count(*)
3775 my $sth = $dbh->prepare($query);
3776 $sth->execute($barcode);
3777 my $exist=$sth->fetchrow ;
3781 =head2 IsBranchTransferAllowed
3783 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3785 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3787 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3788 Koha::Item->can_be_transferred.
3792 sub IsBranchTransferAllowed {
3793 my ( $toBranch, $fromBranch, $code ) = @_;
3795 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3797 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3798 my $dbh = C4::Context->dbh;
3800 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3801 $sth->execute( $toBranch, $fromBranch, $code );
3802 my $limit = $sth->fetchrow_hashref();
3804 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3805 if ( $limit->{'limitId'} ) {
3812 =head2 CreateBranchTransferLimit
3814 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3816 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3818 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3822 sub CreateBranchTransferLimit {
3823 my ( $toBranch, $fromBranch, $code ) = @_;
3824 return unless defined($toBranch) && defined($fromBranch);
3825 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3827 my $dbh = C4::Context->dbh;
3829 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3830 return $sth->execute( $code, $toBranch, $fromBranch );
3833 =head2 DeleteBranchTransferLimits
3835 my $result = DeleteBranchTransferLimits($frombranch);
3837 Deletes all the library transfer limits for one library. Returns the
3838 number of limits deleted, 0e0 if no limits were deleted, or undef if
3839 no arguments are supplied.
3841 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3842 fromBranch => $fromBranch
3847 sub DeleteBranchTransferLimits {
3849 return unless defined $branch;
3850 my $dbh = C4::Context->dbh;
3851 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3852 return $sth->execute($branch);
3856 my ( $borrowernumber, $itemnum ) = @_;
3857 MarkIssueReturned( $borrowernumber, $itemnum );
3862 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3864 The final optional parameter, C<$params>, expected to contain
3865 'skip_record_index' key, which relayed down to Koha::Item/store,
3866 there it prevents calling of ModZebra index_records,
3867 which takes most of the time in batch adds/deletes: index_records better
3868 to be called later in C<additem.pl> after the whole loop.
3871 skip_record_index => 1|0
3876 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3878 unless ( $mark_lost_from ) {
3879 # Temporary check to avoid regressions
3880 die q|LostItem called without $mark_lost_from, check the API.|;
3884 if ( $force_mark_returned ) {
3887 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3888 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3891 my $dbh = C4::Context->dbh();
3892 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3894 JOIN items USING (itemnumber)
3895 JOIN biblio USING (biblionumber)
3896 WHERE issues.itemnumber=?");
3897 $sth->execute($itemnumber);
3898 my $issues=$sth->fetchrow_hashref();
3900 # If a borrower lost the item, add a replacement cost to the their record
3901 if ( my $borrowernumber = $issues->{borrowernumber} ){
3902 my $patron = Koha::Patrons->find( $borrowernumber );
3904 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3905 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3907 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3908 C4::Accounts::chargelostitem(
3911 $issues->{'replacementprice'},
3912 sprintf( "%s %s %s",
3913 $issues->{'title'} || q{},
3914 $issues->{'barcode'} || q{},
3915 $issues->{'itemcallnumber'} || q{},
3918 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3919 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3922 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3925 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3926 my $item = Koha::Items->find($itemnumber);
3927 my $transfers = $item->get_transfers;
3928 while (my $transfer = $transfers->next) {
3929 $transfer->cancel({ reason => 'ItemLost', force => 1 });
3933 sub GetOfflineOperations {
3934 my $dbh = C4::Context->dbh;
3935 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3936 $sth->execute(C4::Context->userenv->{'branch'});
3937 my $results = $sth->fetchall_arrayref({});
3941 sub GetOfflineOperation {
3942 my $operationid = shift;
3943 return unless $operationid;
3944 my $dbh = C4::Context->dbh;
3945 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3946 $sth->execute( $operationid );
3947 return $sth->fetchrow_hashref;
3950 sub AddOfflineOperation {
3951 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3952 my $dbh = C4::Context->dbh;
3953 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3954 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3958 sub DeleteOfflineOperation {
3959 my $dbh = C4::Context->dbh;
3960 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3961 $sth->execute( shift );
3965 sub ProcessOfflineOperation {
3966 my $operation = shift;
3969 if ( $operation->{action} eq 'return' ) {
3970 $report = ProcessOfflineReturn( $operation );
3971 } elsif ( $operation->{action} eq 'issue' ) {
3972 $report = ProcessOfflineIssue( $operation );
3973 } elsif ( $operation->{action} eq 'payment' ) {
3974 $report = ProcessOfflinePayment( $operation );
3977 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3982 sub ProcessOfflineReturn {
3983 my $operation = shift;
3985 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3988 my $itemnumber = $item->itemnumber;
3989 my $issue = $item->checkout;
3991 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3992 ModDateLastSeen( $itemnumber, $leave_item_lost );
3994 $issue->borrowernumber,
3996 $operation->{timestamp},
3998 $item->renewals_count(0);
3999 $item->onloan(undef);
4000 $item->store({ log_action => 0 });
4003 return "Item not issued.";
4006 return "Item not found.";
4010 sub ProcessOfflineIssue {
4011 my $operation = shift;
4013 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4016 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4018 return "Barcode not found.";
4020 my $itemnumber = $item->itemnumber;
4021 my $issue = $item->checkout;
4023 if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4025 $issue->borrowernumber,
4027 $operation->{timestamp},
4032 $operation->{'barcode'},
4035 $operation->{timestamp},
4040 return "Borrower not found.";
4044 sub ProcessOfflinePayment {
4045 my $operation = shift;
4047 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4049 $patron->account->pay(
4051 amount => $operation->{amount},
4052 library_id => $operation->{branchcode},
4062 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4064 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4069 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4073 ? Koha::Items->find($itemnumber)
4074 : Koha::Items->find( { barcode => $barcode } );
4078 return C4::Letters::GetPreparedLetter (
4079 module => 'circulation',
4080 letter_code => 'TRANSFERSLIP',
4081 branchcode => $branch,
4083 'branches' => $to_branch,
4084 'biblio' => $item->biblionumber,
4085 'items' => $item->unblessed,
4090 =head2 CheckIfIssuedToPatron
4092 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4094 Return 1 if any record item is issued to patron, otherwise return 0
4098 sub CheckIfIssuedToPatron {
4099 my ($borrowernumber, $biblionumber) = @_;
4101 my $dbh = C4::Context->dbh;
4103 SELECT COUNT(*) FROM issues
4104 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4105 WHERE items.biblionumber = ?
4106 AND issues.borrowernumber = ?
4108 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4109 return 1 if $is_issued;
4115 IsItemIssued( $itemnumber )
4117 Return 1 if the item is on loan, otherwise return 0
4122 my $itemnumber = shift;
4123 my $dbh = C4::Context->dbh;
4124 my $sth = $dbh->prepare(q{
4127 WHERE itemnumber = ?
4129 $sth->execute($itemnumber);
4130 return $sth->fetchrow;
4133 =head2 GetAgeRestriction
4135 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4136 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4138 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4139 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4141 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4142 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4143 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4144 Negative days mean the borrower has gone past the age restriction age.
4148 sub GetAgeRestriction {
4149 my ($record_restrictions, $borrower) = @_;
4150 my $markers = C4::Context->preference('AgeRestrictionMarker');
4152 return unless $record_restrictions;
4153 # Split $record_restrictions to something like FSK 16 or PEGI 6
4154 my @values = split ' ', uc($record_restrictions);
4155 return unless @values;
4157 # Search first occurrence of one of the markers
4158 my @markers = split /\|/, uc($markers);
4159 return unless @markers;
4162 my $restriction_year = 0;
4163 for my $value (@values) {
4165 for my $marker (@markers) {
4166 $marker =~ s/^\s+//; #remove leading spaces
4167 $marker =~ s/\s+$//; #remove trailing spaces
4168 if ( $marker eq $value ) {
4169 if ( $index <= $#values ) {
4170 $restriction_year += $values[$index];
4174 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4176 # Perhaps it is something like "K16" (as in Finland)
4177 $restriction_year += $1;
4181 last if ( $restriction_year > 0 );
4184 #Check if the borrower is age restricted for this material and for how long.
4185 if ($restriction_year && $borrower) {
4186 if ( $borrower->{'dateofbirth'} ) {
4187 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4188 $alloweddate[0] += $restriction_year;
4190 #Prevent runime eror on leap year (invalid date)
4191 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4192 $alloweddate[2] = 28;
4195 #Get how many days the borrower has to reach the age restriction
4196 my @Today = split /-/, dt_from_string()->ymd();
4197 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4198 #Negative days means the borrower went past the age restriction age
4199 return ($restriction_year, $daysToAgeRestriction);
4203 return ($restriction_year);
4207 =head2 GetPendingOnSiteCheckouts
4211 sub GetPendingOnSiteCheckouts {
4212 my $dbh = C4::Context->dbh;
4213 return $dbh->selectall_arrayref(q|
4219 items.itemcallnumber,
4223 issues.date_due < NOW() AS is_overdue,
4226 borrowers.firstname,
4228 borrowers.cardnumber,
4229 borrowers.borrowernumber
4231 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4232 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4233 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4234 WHERE issues.onsite_checkout = 1
4235 |, { Slice => {} } );
4241 my ($count, $branch, $itemtype, $ccode, $newness)
4242 = @$params{qw(count branch itemtype ccode newness)};
4244 my $dbh = C4::Context->dbh;
4247 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4248 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4249 i.ccode, SUM(i.issues) AS count
4251 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4252 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4255 my (@where_strs, @where_args);
4258 push @where_strs, 'i.homebranch = ?';
4259 push @where_args, $branch;
4262 if (C4::Context->preference('item-level_itypes')){
4263 push @where_strs, 'i.itype = ?';
4264 push @where_args, $itemtype;
4266 push @where_strs, 'bi.itemtype = ?';
4267 push @where_args, $itemtype;
4271 push @where_strs, 'i.ccode = ?';
4272 push @where_args, $ccode;
4275 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4276 push @where_args, $newness;
4280 $query .= 'WHERE ' . join(' AND ', @where_strs);
4284 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4285 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4290 $query .= q{ ) xxx WHERE count > 0 };
4291 $count = int($count);
4293 $query .= "LIMIT $count";
4296 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4301 =head2 Internal methods
4305 sub _CalculateAndUpdateFine {
4308 my $borrower = $params->{borrower};
4309 my $item = $params->{item};
4310 my $issue = $params->{issue};
4311 my $return_date = $params->{return_date};
4313 unless ($borrower) { carp "No borrower passed in!" && return; }
4314 unless ($item) { carp "No item passed in!" && return; }
4315 unless ($issue) { carp "No issue passed in!" && return; }
4317 my $datedue = dt_from_string( $issue->date_due );
4319 # we only need to calculate and change the fines if we want to do that on return
4320 # Should be on for hourly loans
4321 my $control = C4::Context->preference('CircControl');
4322 my $control_branchcode =
4323 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4324 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4325 : $issue->branchcode;
4327 my $date_returned = $return_date ? $return_date : dt_from_string();
4329 my ( $amount, $unitcounttotal, $unitcount ) =
4330 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4332 if ( C4::Context->preference('finesMode') eq 'production' ) {
4333 if ( $amount > 0 ) {
4334 C4::Overdues::UpdateFine({
4335 issue_id => $issue->issue_id,
4336 itemnumber => $issue->itemnumber,
4337 borrowernumber => $issue->borrowernumber,
4342 elsif ($return_date) {
4344 # Backdated returns may have fines that shouldn't exist,
4345 # so in this case, we need to drop those fines to 0
4347 C4::Overdues::UpdateFine({
4348 issue_id => $issue->issue_id,
4349 itemnumber => $issue->itemnumber,
4350 borrowernumber => $issue->borrowernumber,
4358 sub _CanBookBeAutoRenewed {
4359 my ( $params ) = @_;
4360 my $patron = $params->{patron};
4361 my $item = $params->{item};
4362 my $branchcode = $params->{branchcode};
4363 my $issue = $params->{issue};
4365 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4367 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4369 categorycode => $patron->categorycode,
4370 itemtype => $item->effective_itemtype,
4371 branchcode => $branchcode,
4373 'no_auto_renewal_after',
4374 'no_auto_renewal_after_hard_limit',
4381 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4382 return 'auto_account_expired';
4385 if ( defined $issuing_rule->{no_auto_renewal_after}
4386 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4387 # Get issue_date and add no_auto_renewal_after
4388 # If this is greater than today, it's too late for renewal.
4389 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4390 $maximum_renewal_date->add(
4391 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4393 my $now = dt_from_string;
4394 if ( $now >= $maximum_renewal_date ) {
4395 return "auto_too_late";
4398 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4399 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4400 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4401 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4402 return "auto_too_late";
4406 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4407 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4408 my $amountoutstanding =
4409 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4410 ? $patron->account->balance
4411 : $patron->account->outstanding_debits->total_outstanding;
4412 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4413 return "auto_too_much_oweing";
4417 my $soonest = GetSoonestRenewDate($issue);
4418 if ( $soonest > dt_from_string() )
4420 return ( "auto_too_soon", $soonest );
4433 Koha Development Team <http://koha-community.org/>