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({
817 branch => C4::Context->userenv->{'branch'},
819 itemnumber => $item_object->itemnumber,
820 itemtype => $effective_itemtype,
821 borrowernumber => $patron->borrowernumber,
822 ccode => $item_object->ccode}
824 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
825 return( { STATS => 1 }, {});
828 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
829 $issuingimpossible{GNA} = 1;
832 if ( $patron->lost && $patron->lost == 1 ) {
833 $issuingimpossible{CARD_LOST} = 1;
835 if ( $patron->is_debarred ) {
836 $issuingimpossible{DEBARRED} = 1;
839 if ( $patron->is_expired ) {
840 $issuingimpossible{EXPIRED} = 1;
848 my $account = $patron->account;
849 my $balance = $account->balance;
850 my $non_issues_charges = $account->non_issues_charges;
851 my $other_charges = $balance - $non_issues_charges;
853 my $amountlimit = C4::Context->preference("noissuescharge");
854 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
855 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
857 # Check the debt of this patrons guarantees
858 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
859 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
860 if ( defined $no_issues_charge_guarantees ) {
861 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
862 my $guarantees_non_issues_charges = 0;
863 foreach my $g ( @guarantees ) {
864 $guarantees_non_issues_charges += $g->account->non_issues_charges;
867 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
868 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
869 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
870 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
871 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
872 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
876 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
877 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
878 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
879 if ( defined $no_issues_charge_guarantors ) {
880 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
882 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
883 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
884 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
885 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
886 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
887 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
891 if ( C4::Context->preference("IssuingInProcess") ) {
892 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
893 $issuingimpossible{DEBT} = $non_issues_charges;
894 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
895 $needsconfirmation{DEBT} = $non_issues_charges;
896 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
897 $needsconfirmation{DEBT} = $non_issues_charges;
901 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
902 $needsconfirmation{DEBT} = $non_issues_charges;
903 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
904 $issuingimpossible{DEBT} = $non_issues_charges;
905 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
906 $needsconfirmation{DEBT} = $non_issues_charges;
910 if ($balance > 0 && $other_charges > 0) {
911 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
914 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
915 $patron_unblessed = $patron->unblessed;
917 if ( my $debarred_date = $patron->is_debarred ) {
918 # patron has accrued fine days or has a restriction. $count is a date
919 if ($debarred_date eq '9999-12-31') {
920 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
923 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
925 } elsif ( my $num_overdues = $patron->has_overdues ) {
926 ## patron has outstanding overdue loans
927 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
928 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
930 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
931 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
935 # Additional Materials Check
936 if ( C4::Context->preference("CircConfirmItemParts")
937 && $item_object->materials )
939 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
943 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
945 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
947 # Already issued to current borrower.
948 # If it is an on-site checkout if it can be switched to a normal checkout
949 # or ask whether the loan should be renewed
951 if ( $issue->onsite_checkout
952 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
953 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
955 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
956 $patron->borrowernumber,
957 $item_object->itemnumber,
959 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
960 if ( $renewerror eq 'onsite_checkout' ) {
961 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
964 $issuingimpossible{NO_MORE_RENEWALS} = 1;
968 $needsconfirmation{RENEW_ISSUE} = 1;
974 # issued to someone else
976 my $patron = Koha::Patrons->find( $issue->borrowernumber );
978 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
980 unless ( $can_be_returned ) {
981 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
982 $issuingimpossible{branch_to_return} = $message;
984 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
985 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
987 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
988 $needsconfirmation{issued_firstname} = $patron->firstname;
989 $needsconfirmation{issued_surname} = $patron->surname;
990 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
991 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
996 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
998 my $switch_onsite_checkout = (
999 C4::Context->preference('SwitchOnSiteCheckouts')
1001 and $issue->onsite_checkout
1002 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1003 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1004 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1005 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1006 if ( $toomany->{max_allowed} == 0 ) {
1007 $needsconfirmation{PATRON_CANT} = 1;
1009 if ( C4::Context->preference("AllowTooManyOverride") ) {
1010 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1011 $needsconfirmation{current_loan_count} = $toomany->{count};
1012 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1014 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1015 $issuingimpossible{current_loan_count} = $toomany->{count};
1016 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1021 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1023 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1024 my $wants_check = $patron->wants_check_for_previous_checkout;
1025 $needsconfirmation{PREVISSUE} = 1
1026 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1031 if ( $item_object->notforloan )
1033 if(!C4::Context->preference("AllowNotForLoanOverride")){
1034 $issuingimpossible{NOT_FOR_LOAN} = 1;
1035 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1037 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1038 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1042 # we have to check itemtypes.notforloan also
1043 if (C4::Context->preference('item-level_itypes')){
1044 # this should probably be a subroutine
1045 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1046 $sth->execute($effective_itemtype);
1047 my $notforloan=$sth->fetchrow_hashref();
1048 if ($notforloan->{'notforloan'}) {
1049 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1050 $issuingimpossible{NOT_FOR_LOAN} = 1;
1051 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1053 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1054 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1059 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1060 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1061 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1062 $issuingimpossible{NOT_FOR_LOAN} = 1;
1063 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1065 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1066 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1071 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1073 $issuingimpossible{WTHDRAWN} = 1;
1075 if ( $item_object->restricted
1076 && $item_object->restricted == 1 )
1078 $issuingimpossible{RESTRICTED} = 1;
1080 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1081 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1082 my $code = $av->count ? $av->next->lib : '';
1083 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1084 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1086 if ( C4::Context->preference("IndependentBranches") ) {
1087 my $userenv = C4::Context->userenv;
1088 unless ( C4::Context->IsSuperLibrarian() ) {
1089 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1090 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1091 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1092 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1094 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1095 if ( $patron->branchcode ne $userenv->{branch} );
1100 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1102 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1103 if ($rentalConfirmation) {
1104 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1106 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1107 if ($itemtype_object) {
1108 my $accumulate_charge = $fees->accumulate_rentalcharge();
1109 if ( $accumulate_charge > 0 ) {
1110 $rentalCharge += $accumulate_charge;
1114 if ( $rentalCharge > 0 ) {
1115 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1120 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1121 # Only bother doing this if UseRecalls is enabled and the item is recallable
1122 # Don't look at recalls that are in transit
1123 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1124 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1126 foreach my $r ( @recalls ) {
1127 if ( $r->item_id and
1128 $r->item_id == $item_object->itemnumber and
1129 $r->patron_id == $patron->borrowernumber and
1130 ( $r->waiting or $r->requested ) ) {
1131 $messages{RECALLED} = $r->id;
1133 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1136 elsif ( $r->item_id and
1137 $r->item_id == $item_object->itemnumber and
1139 # recalled item is in transit
1140 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1142 elsif ( $r->item_level and
1143 $r->item_id == $item_object->itemnumber and
1144 $r->patron_id != $patron->borrowernumber and
1146 # this specific item has been recalled by a different patron
1147 $needsconfirmation{RECALLED} = $r;
1151 elsif ( !$r->item_level and
1152 $r->patron_id != $patron->borrowernumber and
1154 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1155 $needsconfirmation{RECALLED} = $r;
1162 unless ( $ignore_reserves and defined $recall ) {
1163 # See if the item is on reserve.
1164 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1166 my $resbor = $res->{'borrowernumber'};
1167 if ( $resbor ne $patron->borrowernumber ) {
1168 my $patron = Koha::Patrons->find( $resbor );
1169 if ( $restype eq "Waiting" )
1171 # The item is on reserve and waiting, but has been
1172 # reserved by some other patron.
1173 $needsconfirmation{RESERVE_WAITING} = 1;
1174 $needsconfirmation{'resfirstname'} = $patron->firstname;
1175 $needsconfirmation{'ressurname'} = $patron->surname;
1176 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1177 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1178 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1179 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1180 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1182 elsif ( $restype eq "Reserved" ) {
1183 # The item is on reserve for someone else.
1184 $needsconfirmation{RESERVED} = 1;
1185 $needsconfirmation{'resfirstname'} = $patron->firstname;
1186 $needsconfirmation{'ressurname'} = $patron->surname;
1187 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1188 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1189 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1190 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1191 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1193 elsif ( $restype eq "Transferred" ) {
1194 # The item is determined hold being transferred for someone else.
1195 $needsconfirmation{TRANSFERRED} = 1;
1196 $needsconfirmation{'resfirstname'} = $patron->firstname;
1197 $needsconfirmation{'ressurname'} = $patron->surname;
1198 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1199 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1200 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1201 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1202 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1204 elsif ( $restype eq "Processing" ) {
1205 # The item is determined hold being processed for someone else.
1206 $needsconfirmation{PROCESSING} = 1;
1207 $needsconfirmation{'resfirstname'} = $patron->firstname;
1208 $needsconfirmation{'ressurname'} = $patron->surname;
1209 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1210 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1211 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1212 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1213 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1219 ## CHECK AGE RESTRICTION
1220 my $agerestriction = $biblioitem->agerestriction;
1221 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1222 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1223 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1224 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1227 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1231 ## check for high holds decreasing loan period
1232 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1233 my $check = checkHighHolds( $item_object, $patron );
1235 if ( $check->{exceeded} ) {
1237 num_holds => $check->{outstanding},
1238 duration => $check->{duration},
1239 returndate => $check->{due_date},
1241 if ($override_high_holds) {
1242 $alerts{HIGHHOLDS} = $highholds;
1245 $needsconfirmation{HIGHHOLDS} = $highholds;
1251 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1252 # don't do the multiple loans per bib check if we've
1253 # already determined that we've got a loan on the same item
1254 !$issuingimpossible{NO_MORE_RENEWALS} &&
1255 !$needsconfirmation{RENEW_ISSUE}
1257 # Check if borrower has already issued an item from the same biblio
1258 # Only if it's not a subscription
1259 my $biblionumber = $item_object->biblionumber;
1260 require C4::Serials;
1261 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1262 unless ($is_a_subscription) {
1263 # FIXME Should be $patron->checkouts($args);
1264 my $checkouts = Koha::Checkouts->search(
1266 borrowernumber => $patron->borrowernumber,
1267 biblionumber => $biblionumber,
1273 # if we get here, we don't already have a loan on this item,
1274 # so if there are any loans on this bib, ask for confirmation
1275 if ( $checkouts->count ) {
1276 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1281 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1284 =head2 CanBookBeReturned
1286 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1288 Check whether the item can be returned to the provided branch
1292 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1294 =item C<$branch> is the branchcode where the return is taking place
1302 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1304 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1310 sub CanBookBeReturned {
1311 my ($item, $branch) = @_;
1312 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1314 # assume return is allowed to start
1318 # identify all cases where return is forbidden
1319 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1321 $message = $item->{'homebranch'};
1322 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1324 $message = $item->{'holdingbranch'};
1325 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1327 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1330 return ($allowed, $message);
1333 =head2 CheckHighHolds
1335 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1336 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1337 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1341 sub checkHighHolds {
1342 my ( $item, $patron ) = @_;
1343 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1352 my $holds = Koha::Holds->search( { biblionumber => $item->biblionumber } );
1354 if ( $holds->count() ) {
1355 $return_data->{outstanding} = $holds->count();
1357 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1358 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1359 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1361 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1363 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1365 # static means just more than a given number of holds on the record
1367 # If the number of holds is less than the threshold, we can stop here
1368 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1369 return $return_data;
1372 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1374 # dynamic means X more than the number of holdable items on the record
1376 # let's get the items
1377 my @items = $holds->next()->biblio()->items()->as_list;
1379 # Remove any items with status defined to be ignored even if the would not make item unholdable
1380 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1381 @items = grep { !$_->$status } @items;
1384 # Remove any items that are not holdable for this patron
1385 @items = grep { CanItemBeReserved( $patron , $_, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1387 my $items_count = scalar @items;
1389 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1391 # If the number of holds is less than the count of items we have
1392 # plus the number of holds allowed above that count, we can stop here
1393 if ( $holds->count() <= $threshold ) {
1394 return $return_data;
1398 my $issuedate = dt_from_string();
1400 my $itype = $item->effective_itemtype;
1401 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1403 categorycode => $patron->categorycode,
1405 branchcode => $branchcode,
1408 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1410 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1412 my $rule = Koha::CirculationRules->get_effective_rule_value(
1414 categorycode => $patron->categorycode,
1415 itemtype => $item->effective_itemtype,
1416 branchcode => $branchcode,
1417 rule_name => 'decreaseloanholds',
1422 if ( defined($rule) && $rule ne '' ){
1423 # overrides decreaseLoanHighHoldsDuration syspref
1426 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1428 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1429 $reduced_datedue->set_hour($orig_due->hour);
1430 $reduced_datedue->set_minute($orig_due->minute);
1431 $reduced_datedue->truncate( to => 'minute' );
1433 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1434 $return_data->{exceeded} = 1;
1435 $return_data->{duration} = $duration;
1436 $return_data->{due_date} = $reduced_datedue;
1440 return $return_data;
1445 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1447 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1451 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1453 =item C<$barcode> is the barcode of the item being issued.
1455 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1456 Calculated if empty.
1458 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1460 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1463 AddIssue does the following things :
1465 - step 01: check that there is a borrowernumber & a barcode provided
1466 - check for RENEWAL (book issued & being issued to the same patron)
1467 - renewal YES = Calculate Charge & renew
1469 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1471 - fill reserve if reserve to this patron
1472 - cancel reserve or not, otherwise
1474 - fill recall if recall to this patron
1475 - cancel recall or not
1476 - revert recall's waiting status or not
1477 * TRANSFERT PENDING ?
1478 - complete the transfert
1486 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1488 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1489 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1490 my $auto_renew = $params && $params->{auto_renew};
1491 my $cancel_recall = $params && $params->{cancel_recall};
1492 my $recall_id = $params && $params->{recall_id};
1493 my $dbh = C4::Context->dbh;
1494 my $barcodecheck = CheckValidBarcode($barcode);
1498 if ( $datedue && ref $datedue ne 'DateTime' ) {
1499 $datedue = dt_from_string($datedue);
1502 # $issuedate defaults to today.
1503 if ( !defined $issuedate ) {
1504 $issuedate = dt_from_string();
1507 if ( ref $issuedate ne 'DateTime' ) {
1508 $issuedate = dt_from_string($issuedate);
1513 # Stop here if the patron or barcode doesn't exist
1514 if ( $borrower && $barcode && $barcodecheck ) {
1515 # find which item we issue
1516 my $item_object = Koha::Items->find({ barcode => $barcode })
1517 or return; # if we don't get an Item, abort.
1518 my $item_unblessed = $item_object->unblessed;
1520 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1522 # get actual issuing if there is one
1523 my $actualissue = $item_object->checkout;
1525 # check if we just renew the issue.
1526 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1527 and not $switch_onsite_checkout ) {
1528 $datedue = AddRenewal(
1529 $borrower->{'borrowernumber'},
1530 $item_object->itemnumber,
1533 $issuedate, # here interpreted as the renewal date
1538 my $itype = $item_object->effective_itemtype;
1539 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1543 # Check if we need to use an exact due date set by the ILL module
1544 if ( C4::Context->preference('ILLModule') ) {
1545 # Check if there is an ILL connected with the biblio of the item we are issuing
1546 my $ill_request = Koha::Illrequests->search({
1547 biblio_id => $item_object->biblionumber,
1548 borrowernumber => $borrower->{'borrowernumber'},
1550 due_date => { '!=', undef },
1553 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1554 my $ill_dt = dt_from_string( $ill_request->due_date );
1555 $ill_dt->set_hour(23);
1556 $ill_dt->set_minute(59);
1561 $datedue->truncate( to => 'minute' );
1563 my $patron = Koha::Patrons->find( $borrower );
1564 my $library = Koha::Libraries->find( $branchcode );
1565 my $fees = Koha::Charges::Fees->new(
1568 library => $library,
1569 item => $item_object,
1570 to_date => $datedue,
1574 # it's NOT a renewal
1575 if ( $actualissue and not $switch_onsite_checkout ) {
1576 # This book is currently on loan, but not to the person
1577 # who wants to borrow it now. mark it returned before issuing to the new borrower
1578 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1579 return unless $allowed;
1580 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1581 # AddReturn certainly has side-effects, like onloan => undef
1582 $item_object->discard_changes;
1585 if ( C4::Context->preference('UseRecalls') ) {
1586 Koha::Recalls->move_recall(
1588 action => $cancel_recall,
1589 recall_id => $recall_id,
1590 item => $item_object,
1591 borrowernumber => $borrower->{borrowernumber},
1596 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1598 # Starting process for transfer job (checking transfert and validate it if we have one)
1599 if ( my $transfer = $item_object->get_transfer ) {
1600 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1603 datearrived => dt_from_string,
1604 tobranch => C4::Context->userenv->{branch},
1605 comments => 'Forced branchtransfer'
1608 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1609 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1610 if ( $hold ) { # Is this really needed?
1611 $hold->set( { found => undef } )->store;
1612 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1617 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1618 unless ($auto_renew) {
1619 my $rule = Koha::CirculationRules->get_effective_rule_value(
1621 categorycode => $borrower->{categorycode},
1622 itemtype => $item_object->effective_itemtype,
1623 branchcode => $branchcode,
1624 rule_name => 'auto_renew'
1628 $auto_renew = $rule if defined $rule && $rule ne '';
1631 my $issue_attributes = {
1632 borrowernumber => $borrower->{'borrowernumber'},
1633 issuedate => $issuedate,
1634 date_due => $datedue,
1635 branchcode => C4::Context->userenv->{'branch'},
1636 onsite_checkout => $onsite_checkout,
1637 auto_renew => $auto_renew ? 1 : 0,
1640 # Get ID of logged in user. if called from a batch job,
1641 # no user session exists and C4::Context->userenv() returns
1642 # the scalar '0'. Only do this if the syspref says so
1643 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1644 my $userenv = C4::Context->userenv();
1645 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1647 $issue_attributes->{issuer_id} = $usernumber;
1651 # In the case that the borrower has an on-site checkout
1652 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1653 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1655 $issue->set($issue_attributes)->store;
1658 $issue = Koha::Checkout->new(
1660 itemnumber => $item_object->itemnumber,
1665 $issue->discard_changes;
1666 C4::Auth::track_login_daily( $borrower->{userid} );
1667 if ( $item_object->location && $item_object->location eq 'CART'
1668 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1669 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1670 CartToShelf( $item_object->itemnumber );
1673 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1674 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1677 # Record if item was lost
1678 my $was_lost = $item_object->itemlost;
1680 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1681 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1682 $item_object->itemlost(0);
1683 $item_object->onloan($datedue->ymd());
1684 $item_object->datelastborrowed( dt_from_string()->ymd() );
1685 $item_object->datelastseen( dt_from_string()->ymd() );
1686 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1688 # If the item was lost, it has now been found, charge the overdue if necessary
1690 if ( $item_object->{_charge} ) {
1691 $actualissue //= Koha::Old::Checkouts->search(
1692 { itemnumber => $item_unblessed->{itemnumber} },
1694 order_by => { '-desc' => 'returndate' },
1698 unless ( exists( $borrower->{branchcode} ) ) {
1699 my $patron = $actualissue->patron;
1700 $borrower = $patron->unblessed;
1702 _CalculateAndUpdateFine(
1704 issue => $actualissue,
1705 item => $item_unblessed,
1706 borrower => $borrower,
1707 return_date => $issuedate
1710 _FixOverduesOnReturn( $borrower->{borrowernumber},
1711 $item_object->itemnumber, undef, 'RENEWED' );
1715 # If it costs to borrow this book, charge it to the patron's account.
1716 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1717 if ( $charge && $charge > 0 ) {
1718 AddIssuingCharge( $issue, $charge, 'RENT' );
1721 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1722 if ( $itemtype_object ) {
1723 my $accumulate_charge = $fees->accumulate_rentalcharge();
1724 if ( $accumulate_charge > 0 ) {
1725 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1726 $charge += $accumulate_charge;
1727 $item_unblessed->{charge} = $charge;
1731 # Record the fact that this book was issued.
1732 C4::Stats::UpdateStats(
1734 branch => C4::Context->userenv->{'branch'},
1735 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1737 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1738 itemnumber => $item_object->itemnumber,
1739 itemtype => $item_object->effective_itemtype,
1740 location => $item_object->location,
1741 borrowernumber => $borrower->{'borrowernumber'},
1742 ccode => $item_object->ccode,
1746 # Send a checkout slip.
1747 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1749 branchcode => $branchcode,
1750 categorycode => $borrower->{categorycode},
1751 item_type => $item_object->effective_itemtype,
1752 notification => 'CHECKOUT',
1754 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1755 SendCirculationAlert(
1758 item => $item_object->unblessed,
1759 borrower => $borrower,
1760 branch => $branchcode,
1765 "CIRCULATION", "ISSUE",
1766 $borrower->{'borrowernumber'},
1767 $item_object->itemnumber,
1768 ) if C4::Context->preference("IssueLog");
1770 Koha::Plugins->call('after_circ_action', {
1771 action => 'checkout',
1773 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1774 checkout => $issue->get_from_storage
1778 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1780 biblio_ids => [ $item_object->biblionumber ]
1782 ) if C4::Context->preference('RealTimeHoldsQueue');
1788 =head2 GetLoanLength
1790 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1792 Get loan length for an itemtype, a borrower type and a branch
1797 my ( $categorycode, $itemtype, $branchcode ) = @_;
1799 # Initialize default values
1803 lengthunit => 'days',
1806 my $found = Koha::CirculationRules->get_effective_rules( {
1807 branchcode => $branchcode,
1808 categorycode => $categorycode,
1809 itemtype => $itemtype,
1818 foreach my $rule_name (keys %$found) {
1819 $rules->{$rule_name} = $found->{$rule_name};
1826 =head2 GetHardDueDate
1828 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1830 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1834 sub GetHardDueDate {
1835 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1837 my $rules = Koha::CirculationRules->get_effective_rules(
1839 categorycode => $borrowertype,
1840 itemtype => $itemtype,
1841 branchcode => $branchcode,
1842 rules => [ 'hardduedate', 'hardduedatecompare' ],
1846 if ( defined( $rules->{hardduedate} ) ) {
1847 if ( $rules->{hardduedate} ) {
1848 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1851 return ( undef, undef );
1856 =head2 GetBranchBorrowerCircRule
1858 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1860 Retrieves circulation rule attributes that apply to the given
1861 branch and patron category, regardless of item type.
1862 The return value is a hashref containing the following key:
1864 patron_maxissueqty - maximum number of loans that a
1865 patron of the given category can have at the given
1866 branch. If the value is undef, no limit.
1868 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1869 patron of the given category can have at the given
1870 branch. If the value is undef, no limit.
1872 This will check for different branch/category combinations in the following order:
1876 default branch and category
1878 If no rule has been found in the database, it will default to
1881 patron_maxissueqty - undef
1882 patron_maxonsiteissueqty - undef
1884 C<$branchcode> and C<$categorycode> should contain the
1885 literal branch code and patron category code, respectively - no
1890 sub GetBranchBorrowerCircRule {
1891 my ( $branchcode, $categorycode ) = @_;
1893 # Initialize default values
1895 patron_maxissueqty => undef,
1896 patron_maxonsiteissueqty => undef,
1900 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1901 my $rule = Koha::CirculationRules->get_effective_rule(
1903 categorycode => $categorycode,
1905 branchcode => $branchcode,
1906 rule_name => $rule_name,
1910 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1916 =head2 GetBranchItemRule
1918 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1920 Retrieves circulation rule attributes that apply to the given
1921 branch and item type, regardless of patron category.
1923 The return value is a hashref containing the following keys:
1925 holdallowed => Hold policy for this branch and itemtype. Possible values:
1926 not_allowed: No holds allowed.
1927 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1928 from_any_library: Holds allowed from any patron.
1929 from_local_hold_group: Holds allowed from libraries in hold group
1931 returnbranch => branch to which to return item. Possible values:
1932 noreturn: do not return, let item remain where checked in (floating collections)
1933 homebranch: return to item's home branch
1934 holdingbranch: return to issuer branch
1936 This searches branchitemrules in the following order:
1938 * Same branchcode and itemtype
1939 * Same branchcode, itemtype '*'
1940 * branchcode '*', same itemtype
1941 * branchcode and itemtype '*'
1943 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1947 sub GetBranchItemRule {
1948 my ( $branchcode, $itemtype ) = @_;
1951 my $rules = Koha::CirculationRules->get_effective_rules({
1952 branchcode => $branchcode,
1953 itemtype => $itemtype,
1954 rules => ['holdallowed', 'hold_fulfillment_policy', 'returnbranch']
1957 # built-in default circulation rule
1958 $rules->{holdallowed} //= 'from_any_library';
1959 $rules->{hold_fulfillment_policy} //= 'any';
1960 $rules->{returnbranch} //= 'homebranch';
1967 ($doreturn, $messages, $iteminformation, $borrower) =
1968 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1974 =item C<$barcode> is the bar code of the book being returned.
1976 =item C<$branch> is the code of the branch where the book is being returned.
1978 =item C<$exemptfine> indicates that overdue charges for the item will be
1981 =item C<$return_date> allows the default return date to be overridden
1982 by the given return date. Optional.
1986 C<&AddReturn> returns a list of four items:
1988 C<$doreturn> is true iff the return succeeded.
1990 C<$messages> is a reference-to-hash giving feedback on the operation.
1991 The keys of the hash are:
1997 No item with this barcode exists. The value is C<$barcode>.
2001 The book is not currently on loan. The value is C<$barcode>.
2005 This book has been withdrawn/cancelled. The value should be ignored.
2007 =item C<Wrongbranch>
2009 This book has was returned to the wrong branch. The value is a hashref
2010 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2011 contain the branchcode of the incorrect and correct return library, respectively.
2015 The item was reserved. The value is a reference-to-hash whose keys are
2016 fields from the reserves table of the Koha database, and
2017 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2018 either C<Waiting>, C<Reserved>, or 0.
2020 =item C<WasReturned>
2022 Value 1 if return is successful.
2024 =item C<NeedsTransfer>
2026 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2028 =item C<RecallFound>
2030 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2031 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2034 =item C<TransferredRecall>
2036 This item has been transferred to this branch to fill a recall. The recall object is returned.
2040 C<$iteminformation> is a reference-to-hash, giving information about the
2041 returned item from the issues table.
2043 C<$borrower> is a reference-to-hash, giving information about the
2044 patron who last borrowed the book.
2049 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2051 if ($branch and not Koha::Libraries->find($branch)) {
2052 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2055 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2056 my $return_date_specified = !!$return_date;
2057 $return_date //= dt_from_string();
2061 my $validTransfer = 1;
2062 my $stat_type = 'return';
2064 # get information on item
2065 my $item = Koha::Items->find({ barcode => $barcode });
2067 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2070 my $itemnumber = $item->itemnumber;
2071 my $itemtype = $item->effective_itemtype;
2073 my $issue = $item->checkout;
2075 $patron = $issue->patron
2076 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2077 . Dumper($issue->unblessed) . "\n";
2079 $messages->{'NotIssued'} = $barcode;
2080 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2082 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2084 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2085 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2086 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2087 $messages->{'LocalUse'} = 1;
2088 $stat_type = 'localuse';
2092 # full item data, but no borrowernumber or checkout info (no issue)
2093 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2094 # get the proper branch to which to return the item
2095 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2096 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2097 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2099 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2100 my $patron_unblessed = $patron ? $patron->unblessed : {};
2102 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2103 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2104 if ($update_loc_rules) {
2105 if (defined $update_loc_rules->{_ALL_}) {
2106 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2107 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2109 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2110 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2112 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2113 $item->location($update_loc_rules->{_ALL_})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2117 foreach my $key ( keys %$update_loc_rules ) {
2118 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2119 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2120 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2121 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2122 $item->location($update_loc_rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2129 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2131 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2133 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2135 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2138 foreach my $key ( keys %$rules ) {
2139 if ( $item->notforloan eq $key ) {
2140 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2141 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2148 # check if the return is allowed at this branch
2149 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2150 unless ($returnallowed){
2151 $messages->{'Wrongbranch'} = {
2152 Wrongbranch => $branch,
2153 Rightbranch => $message
2156 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2157 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2158 return ( $doreturn, $messages, $issue, $patron_unblessed);
2161 if ( $item->withdrawn ) { # book has been cancelled
2162 $messages->{'withdrawn'} = 1;
2163 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2166 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2170 # case of a return of document (deal with issues and holdingbranch)
2172 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2173 $patron or warn "AddReturn without current borrower";
2177 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2182 C4::Context->preference('CalculateFinesOnReturn')
2183 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2188 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2191 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 );
2193 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2194 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2196 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2199 # FIXME is the "= 1" right? This could be the borrower hash.
2200 $messages->{'WasReturned'} = 1;
2203 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2207 # the holdingbranch is updated if the document is returned to another location.
2208 # this is always done regardless of whether the item was on loan or not
2209 if ($item->holdingbranch ne $branch) {
2210 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2213 my $item_was_lost = $item->itemlost;
2214 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2215 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2217 # fix up the accounts.....
2218 if ($item_was_lost) {
2219 $messages->{'WasLost'} = 1;
2220 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2221 my @object_messages = @{ $updated_item->object_messages };
2222 for my $message (@object_messages) {
2223 $messages->{'LostItemFeeRefunded'} = 1
2224 if $message->message eq 'lost_refunded';
2225 $messages->{'LostItemFeeRestored'} = 1
2226 if $message->message eq 'lost_restored';
2228 if ( $message->message eq 'lost_charge' ) {
2229 $issue //= Koha::Old::Checkouts->search(
2230 { itemnumber => $item->itemnumber },
2231 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2233 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2234 my $patron = $issue->patron;
2235 $patron_unblessed = $patron->unblessed;
2237 _CalculateAndUpdateFine(
2240 item => $item->unblessed,
2241 borrower => $patron_unblessed,
2242 return_date => $return_date
2245 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2246 $item->itemnumber, undef, 'RETURNED' );
2247 $messages->{'LostItemFeeCharged'} = 1;
2253 # check if we have a transfer for this document
2254 my $transfer = $item->get_transfer;
2256 # if we have a transfer to complete, we update the line of transfers with the datearrived
2259 if ( $transfer->in_transit ) {
2260 if ( $transfer->tobranch eq $branch ) {
2262 $messages->{'TransferArrived'} = $transfer->frombranch;
2263 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2264 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2267 $messages->{'WrongTransfer'} = $transfer->tobranch;
2268 $messages->{'WrongTransferItem'} = $item->itemnumber;
2269 $messages->{'TransferTrigger'} = $transfer->reason;
2273 if ( $transfer->tobranch eq $branch ) {
2275 $messages->{'TransferArrived'} = $transfer->frombranch;
2276 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2277 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2280 $messages->{'WasTransfered'} = $transfer->tobranch;
2281 $messages->{'TransferTrigger'} = $transfer->reason;
2286 # fix up the overdues in accounts...
2287 if ($borrowernumber) {
2288 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2289 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2291 if ( $issue and $issue->is_overdue($return_date) ) {
2293 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2295 $messages->{'PrevDebarred'} = $debardate;
2297 $messages->{'Debarred'} = $debardate if $debardate;
2299 # there's no overdue on the item but borrower had been previously debarred
2300 } elsif ( $issue->date_due and $patron->debarred ) {
2301 if ( $patron->debarred eq "9999-12-31") {
2302 $messages->{'ForeverDebarred'} = $patron->debarred;
2304 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2305 $borrower_debar_dt->truncate(to => 'day');
2306 my $today_dt = $return_date->clone()->truncate(to => 'day');
2307 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2308 $messages->{'PrevDebarred'} = $patron->debarred;
2315 if ( C4::Context->preference('UseRecalls') ) {
2316 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2318 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2319 if ( defined $recall ) {
2320 $messages->{RecallFound} = $recall;
2321 if ( $recall->pickup_library_id ne $branch ) {
2322 $messages->{RecallNeedsTransfer} = $branch;
2327 # find reserves.....
2328 # launch the Checkreserves routine to find any holds
2329 my ($resfound, $resrec);
2330 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2331 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2332 # 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)
2333 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2334 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2335 $resfound = 'Reserved';
2336 $resrec = $hold->unblessed;
2339 $resrec->{'ResFound'} = $resfound;
2340 $messages->{'ResFound'} = $resrec;
2343 # Record the fact that this book was returned.
2344 C4::Stats::UpdateStats({
2347 itemnumber => $itemnumber,
2348 itemtype => $itemtype,
2349 location => $item->location,
2350 borrowernumber => $borrowernumber,
2351 ccode => $item->ccode,
2354 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2356 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2358 branchcode => $branch,
2359 categorycode => $patron->categorycode,
2360 item_type => $itemtype,
2361 notification => 'CHECKIN',
2363 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2364 SendCirculationAlert({
2366 item => $item->unblessed,
2367 borrower => $patron->unblessed,
2373 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2374 if C4::Context->preference("ReturnLog");
2377 # Check if this item belongs to a biblio record that is attached to an
2378 # ILL request, if it is we need to update the ILL request's status
2379 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2380 my $request = Koha::Illrequests->find(
2381 { biblio_id => $item->biblio->biblionumber }
2383 $request->status('RET') if $request;
2386 if ( C4::Context->preference('UseRecalls') ) {
2387 # all recalls that have triggered a transfer will have an allocated itemnumber
2388 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2389 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2390 $messages->{TransferredRecall} = $transfer_recall;
2394 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2395 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2396 && ( $doreturn or $messages->{'NotIssued'} )
2398 and ( $branch ne $returnbranch )
2399 and not $messages->{'WrongTransfer'}
2400 and not $messages->{'WasTransfered'}
2401 and not $messages->{TransferredRecall}
2402 and not $messages->{RecallNeedsTransfer} )
2404 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2405 if (C4::Context->preference("AutomaticItemReturn" ) or
2406 (C4::Context->preference("UseBranchTransferLimits") and
2407 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2409 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2410 $messages->{'WasTransfered'} = $returnbranch;
2411 $messages->{'TransferTrigger'} = $transfer_trigger;
2413 $messages->{'NeedsTransfer'} = $returnbranch;
2414 $messages->{'TransferTrigger'} = $transfer_trigger;
2418 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2419 my $claims = Koha::Checkouts::ReturnClaims->search(
2421 itemnumber => $item->id,
2422 resolution => undef,
2426 if ( $claims->count ) {
2427 $messages->{ReturnClaims} = $claims;
2431 # Check for bundle status
2432 if ( $item->in_bundle ) {
2433 my $host = $item->bundle_host;
2434 $messages->{InBundle} = $host;
2437 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2438 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2440 if ( $doreturn and $issue ) {
2441 my $checkin = Koha::Old::Checkouts->find($issue->id);
2443 Koha::Plugins->call('after_circ_action', {
2444 action => 'checkin',
2450 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2452 biblio_ids => [ $item->biblionumber ]
2454 ) if C4::Context->preference('RealTimeHoldsQueue');
2457 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2460 =head2 MarkIssueReturned
2462 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2464 Unconditionally marks an issue as being returned by
2465 moving the C<issues> row to C<old_issues> and
2466 setting C<returndate> to the current date.
2468 if C<$returndate> is specified (in iso format), it is used as the date
2471 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2472 the old_issue is immediately anonymised
2474 Ideally, this function would be internal to C<C4::Circulation>,
2475 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2476 and offline_circ/process_koc.pl.
2478 The last optional parameter allos passing skip_record_index to the item store call.
2482 sub MarkIssueReturned {
2483 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2485 # Retrieve the issue
2486 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2488 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2490 my $issue_id = $issue->issue_id;
2492 my $schema = Koha::Database->schema;
2494 # FIXME Improve the return value and handle it from callers
2495 $schema->txn_do(sub {
2497 my $patron = Koha::Patrons->find( $borrowernumber );
2499 # Update the returndate value
2500 if ( $returndate ) {
2501 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2504 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2507 # Create the old_issues entry
2508 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2510 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2511 if ( $privacy && $privacy == 2) {
2512 $old_checkout->anonymize;
2515 # And finally delete the issue
2518 $issue->item->onloan(undef)->store(
2520 skip_record_index => $params->{skip_record_index},
2521 skip_holds_queue => $params->{skip_holds_queue}
2525 if ( C4::Context->preference('StoreLastBorrower') ) {
2526 my $item = Koha::Items->find( $itemnumber );
2527 $item->last_returned_by( $patron );
2530 # Remove any OVERDUES related debarment if the borrower has no overdues
2531 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2532 && $patron->debarred
2533 && !$patron->has_overdues
2534 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2536 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2544 =head2 _debar_user_on_return
2546 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2548 C<$borrower> borrower hashref
2550 C<$item> item hashref
2552 C<$datedue> date due DateTime object
2554 C<$returndate> DateTime object representing the return time
2556 Internal function, called only by AddReturn that calculates and updates
2557 the user fine days, and debars them if necessary.
2559 Should only be called for overdue returns
2561 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2566 sub _calculate_new_debar_dt {
2567 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2569 my $branchcode = _GetCircControlBranch( $item, $borrower );
2570 my $circcontrol = C4::Context->preference('CircControl');
2571 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2572 { categorycode => $borrower->{categorycode},
2573 itemtype => $item->{itype},
2574 branchcode => $branchcode,
2579 'maxsuspensiondays',
2580 'suspension_chargeperiod',
2584 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2585 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2586 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2588 return unless $finedays;
2590 # finedays is in days, so hourly loans must multiply by 24
2591 # thus 1 hour late equals 1 day suspension * finedays rate
2592 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2594 # grace period is measured in the same units as the loan
2596 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2598 my $deltadays = DateTime::Duration->new(
2599 days => $chargeable_units
2602 if ( $deltadays->subtract($grace)->is_positive() ) {
2603 my $suspension_days = $deltadays * $finedays;
2605 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2606 # No need to / 1 and do not consider / 0
2607 $suspension_days = DateTime::Duration->new(
2608 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2612 # If the max suspension days is < than the suspension days
2613 # the suspension days is limited to this maximum period.
2614 my $max_sd = $issuing_rule->{maxsuspensiondays};
2615 if ( defined $max_sd && $max_sd ne '' ) {
2616 $max_sd = DateTime::Duration->new( days => $max_sd );
2617 $suspension_days = $max_sd
2618 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2621 my ( $has_been_extended );
2622 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2623 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2625 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2626 $has_been_extended = 1;
2631 # Use the calendar or not to calculate the debarment date
2632 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2633 my $calendar = Koha::Calendar->new(
2634 branchcode => $branchcode,
2635 days_mode => 'Calendar'
2637 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2640 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2642 return $new_debar_dt;
2647 sub _debar_user_on_return {
2648 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2650 $return_date //= dt_from_string();
2652 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2654 return unless $new_debar_dt;
2656 Koha::Patron::Debarments::AddUniqueDebarment({
2657 borrowernumber => $borrower->{borrowernumber},
2658 expiration => $new_debar_dt->ymd(),
2659 type => 'SUSPENSION',
2661 # if borrower was already debarred but does not get an extra debarment
2662 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2663 my ($new_debarment_str, $is_a_reminder);
2664 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2666 $new_debarment_str = $borrower->{debarred};
2668 $new_debarment_str = $new_debar_dt->ymd();
2670 # FIXME Should return a DateTime object
2671 return $new_debarment_str, $is_a_reminder;
2674 =head2 _FixOverduesOnReturn
2676 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2678 C<$borrowernumber> borrowernumber
2680 C<$itemnumber> itemnumber
2682 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2684 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2690 sub _FixOverduesOnReturn {
2691 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2692 unless( $borrowernumber ) {
2693 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2697 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2701 warn "_FixOverduesOnReturn() not supplied valid status";
2705 my $schema = Koha::Database->schema;
2707 my $result = $schema->txn_do(
2709 # check for overdue fine
2710 my $accountlines = Koha::Account::Lines->search(
2712 borrowernumber => $borrowernumber,
2713 itemnumber => $item,
2714 debit_type_code => 'OVERDUE',
2715 status => 'UNRETURNED'
2718 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2720 my $accountline = $accountlines->next;
2721 my $payments = $accountline->credits;
2723 my $amountoutstanding = $accountline->amountoutstanding;
2724 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2725 $accountline->delete;
2726 return 0; # no warning, we've just removed a zero value fine (backdated return)
2727 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2728 my $account = Koha::Account->new({patron_id => $borrowernumber});
2729 my $credit = $account->add_credit(
2731 amount => $amountoutstanding,
2732 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2733 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2734 interface => C4::Context->interface,
2740 $credit->apply({ debits => [ $accountline ] });
2742 if (C4::Context->preference("FinesLog")) {
2743 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2747 $accountline->status($status);
2748 return $accountline->store();
2755 =head2 _GetCircControlBranch
2757 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2761 Return the library code to be used to determine which circulation
2762 policy applies to a transaction. Looks up the CircControl and
2763 HomeOrHoldingBranch system preferences.
2765 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2767 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2771 sub _GetCircControlBranch {
2772 my ($item, $borrower) = @_;
2773 my $circcontrol = C4::Context->preference('CircControl');
2776 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2777 $branch= C4::Context->userenv->{'branch'};
2778 } elsif ($circcontrol eq 'PatronLibrary') {
2779 $branch=$borrower->{branchcode};
2781 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2782 $branch = $item->{$branchfield};
2783 # default to item home branch if holdingbranch is used
2784 # and is not defined
2785 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2786 $branch = $item->{homebranch};
2792 =head2 GetUpcomingDueIssues
2794 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2798 sub GetUpcomingDueIssues {
2801 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2802 my $dbh = C4::Context->dbh;
2805 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2807 LEFT JOIN items USING (itemnumber)
2808 LEFT JOIN branches ON branches.branchcode =
2810 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2811 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2812 my @bind_parameters = ( $params->{'days_in_advance'} );
2814 my $sth = $dbh->prepare( $statement );
2815 $sth->execute( @bind_parameters );
2816 my $upcoming_dues = $sth->fetchall_arrayref({});
2818 return $upcoming_dues;
2821 =head2 CanBookBeRenewed
2823 ($ok,$error,$info) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2825 Find out whether a borrowed item may be renewed.
2827 C<$borrowernumber> is the borrower number of the patron who currently
2828 has the item on loan.
2830 C<$itemnumber> is the number of the item to renew.
2832 C<$override_limit>, if supplied with a true value, causes
2833 the limit on the number of times that the loan can be renewed
2834 (as controlled by the item type) to be ignored. Overriding also allows
2835 to renew sooner than "No renewal before" and to manually renew loans
2836 that are automatically renewed.
2838 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2839 item must currently be on loan to the specified borrower; renewals
2840 must be allowed for the item's type; and the borrower must not have
2841 already renewed the loan.
2842 $error will contain the reason the renewal can not proceed
2843 $info will contain a hash of additional info
2844 currently 'soonest_renew_date' if error is 'too soon'
2848 sub CanBookBeRenewed {
2849 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2851 my $auto_renew = "no";
2854 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2855 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2856 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2857 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2859 my $patron = $issue->patron or return;
2861 # override_limit will override anything else except on_reserve
2862 unless ( $override_limit ){
2863 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2864 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2866 categorycode => $patron->categorycode,
2867 itemtype => $item->effective_itemtype,
2868 branchcode => $branchcode,
2872 'unseen_renewals_allowed'
2877 return ( 0, "too_many" )
2878 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2880 return ( 0, "too_unseen" )
2881 if C4::Context->preference('UnseenRenewals') &&
2882 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2883 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2885 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2886 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2887 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2888 my $restricted = $patron->is_debarred;
2889 my $hasoverdues = $patron->has_overdues;
2891 if ( $restricted and $restrictionblockrenewing ) {
2892 return ( 0, 'restriction');
2893 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2894 return ( 0, 'overdue');
2897 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2900 branchcode => $branchcode,
2903 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2904 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2905 # extra notices being sent. Cron also implies no override
2906 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2907 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2908 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2911 if ( C4::Context->preference('UseRecalls') ) {
2913 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2914 if ( defined $recall ) {
2915 if ( $recall->item_level ) {
2916 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2917 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
2919 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2920 return ( 0, 'recalled' ) unless ( $recall->waiting );
2925 my $fillable_holds = Koha::Holds->search(
2927 biblionumber => $item->biblionumber,
2930 reservedate => { '<=' => \'NOW()' },
2933 { prefetch => 'patron' }
2935 if ( $fillable_holds->count ) {
2936 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
2937 my @possible_holds = $fillable_holds->as_list;
2939 # Get all other items that could possibly fill reserves
2940 # FIXME We could join reserves (or more tables) here to eliminate some checks later
2941 my @other_items = Koha::Items->search({
2942 biblionumber => $item->biblionumber,
2945 -not => { itemnumber => $itemnumber } })->as_list;
2947 return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
2950 foreach my $possible_hold (@possible_holds) {
2952 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
2953 my $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron_with_reserve });
2955 # FIXME: We are not checking whether the item we are renewing can fill the hold
2957 foreach my $other_item (@other_items) {
2958 next if defined $matched_items{$other_item->itemnumber};
2959 next if IsItemOnHoldAndFound( $other_item->itemnumber );
2960 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef, $items_any_available);
2961 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2962 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
2963 # CanItemBeReserved checks 'rules' and 'policies' which means
2964 # items will fill holds at checkin that are rejected here
2966 $matched_items{$other_item->itemnumber} = 1;
2969 return ( 0, "on_reserve" ) unless $fillable;
2973 my ($status, $matched_reserve, $possible_reserves) = CheckReserves($itemnumber);
2974 return ( 0, "on_reserve" ) if $status;
2978 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2979 $soonest = GetSoonestRenewDate($borrowernumber, $itemnumber);
2980 if ( $soonest > dt_from_string() ){
2981 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
2984 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2986 return ( 1, undef );
2991 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2995 C<$borrowernumber> is the borrower number of the patron who currently
2998 C<$itemnumber> is the number of the item to renew.
3000 C<$branch> is the library where the renewal took place (if any).
3001 The library that controls the circ policies for the renewal is retrieved from the issues record.
3003 C<$datedue> can be a DateTime object used to set the due date.
3005 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3006 this parameter is not supplied, lastreneweddate is set to the current date.
3008 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3009 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3010 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3013 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3014 from the book's item type.
3016 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3017 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3018 fallback to a true value
3023 my $borrowernumber = shift;
3024 my $itemnumber = shift or return;
3026 my $datedue = shift;
3027 my $lastreneweddate = shift || dt_from_string();
3028 my $skipfinecalc = shift;
3031 # Fallback on a 'seen' renewal
3032 $seen = defined $seen && $seen == 0 ? 0 : 1;
3034 my $item_object = Koha::Items->find($itemnumber) or return;
3035 my $biblio = $item_object->biblio;
3036 my $issue = $item_object->checkout;
3037 my $item_unblessed = $item_object->unblessed;
3039 my $dbh = C4::Context->dbh;
3041 return unless $issue;
3043 $borrowernumber ||= $issue->borrowernumber;
3045 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3046 $datedue = dt_from_string($datedue, 'sql');
3049 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3050 my $patron_unblessed = $patron->unblessed;
3052 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3054 my $schema = Koha::Database->schema;
3055 $schema->txn_do(sub{
3057 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3058 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3060 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3062 # If the due date wasn't specified, calculate it by adding the
3063 # book's loan length to today's date or the current due date
3064 # based on the value of the RenewalPeriodBase syspref.
3065 my $itemtype = $item_object->effective_itemtype;
3068 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3069 dt_from_string( $issue->date_due, 'sql' ) :
3071 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3074 my $fees = Koha::Charges::Fees->new(
3077 library => $circ_library,
3078 item => $item_object,
3079 from_date => dt_from_string( $issue->date_due, 'sql' ),
3080 to_date => dt_from_string($datedue),
3084 # Increment the unseen renewals, if appropriate
3085 # We only do so if the syspref is enabled and
3086 # a maximum value has been set in the circ rules
3087 my $unseen_renewals = $issue->unseen_renewals;
3088 if (C4::Context->preference('UnseenRenewals')) {
3089 my $rule = Koha::CirculationRules->get_effective_rule(
3090 { categorycode => $patron->categorycode,
3091 itemtype => $item_object->effective_itemtype,
3092 branchcode => $circ_library->branchcode,
3093 rule_name => 'unseen_renewals_allowed'
3096 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3099 # If the renewal is seen, unseen should revert to 0
3100 $unseen_renewals = 0;
3104 # Update the issues record to have the new due date, and a new count
3105 # of how many times it has been renewed.
3106 my $renews = ( $issue->renewals_count || 0 ) + 1;
3107 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3110 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3113 Koha::Exceptions::Checkout::FailedRenewal->throw(
3114 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3118 # Update the renewal count on the item, and tell zebra to reindex
3119 $renews = ( $item_object->renewals || 0 ) + 1;
3120 $item_object->renewals($renews);
3121 $item_object->onloan($datedue);
3122 $item_object->store({ log_action => 0 });
3124 # Charge a new rental fee, if applicable
3125 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3126 if ( $charge > 0 ) {
3127 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3130 # Charge a new accumulate rental fee, if applicable
3131 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3132 if ( $itemtype_object ) {
3133 my $accumulate_charge = $fees->accumulate_rentalcharge();
3134 if ( $accumulate_charge > 0 ) {
3135 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3137 $charge += $accumulate_charge;
3140 # Send a renewal slip according to checkout alert preferencei
3141 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3142 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3144 branchcode => $branch,
3145 categorycode => $patron->categorycode,
3146 item_type => $itemtype,
3147 notification => 'CHECKOUT',
3149 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3150 SendCirculationAlert(
3153 item => $item_unblessed,
3154 borrower => $patron->unblessed,
3161 # Remove any OVERDUES related debarment if the borrower has no overdues
3163 && $patron->is_debarred
3164 && ! $patron->has_overdues
3165 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3167 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3170 # Add renewal record
3171 my $renewal = Koha::Checkouts::Renewal->new(
3173 checkout_id => $issue->issue_id,
3174 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3176 interface => C4::Context->interface
3180 # Add the renewal to stats
3181 C4::Stats::UpdateStats(
3183 branch => $item_object->renewal_branchcode({branch => $branch}),
3186 itemnumber => $itemnumber,
3187 itemtype => $itemtype,
3188 location => $item_object->location,
3189 borrowernumber => $borrowernumber,
3190 ccode => $item_object->ccode,
3195 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3197 Koha::Plugins->call('after_circ_action', {
3198 action => 'renewal',
3200 checkout => $issue->get_from_storage
3209 # check renewal status
3210 my ( $bornum, $itemno ) = @_;
3211 my $dbh = C4::Context->dbh;
3213 my $unseencount = 0;
3214 my $renewsallowed = 0;
3215 my $unseenallowed = 0;
3219 my $patron = Koha::Patrons->find( $bornum );
3220 my $item = Koha::Items->find($itemno);
3222 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3224 # Look in the issues table for this item, lent to this borrower,
3225 # and not yet returned.
3227 # FIXME - I think this function could be redone to use only one SQL call.
3228 my $sth = $dbh->prepare(
3229 "select * from issues
3230 where (borrowernumber = ?)
3231 and (itemnumber = ?)"
3233 $sth->execute( $bornum, $itemno );
3234 my $data = $sth->fetchrow_hashref;
3235 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3236 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3237 # $item and $borrower should be calculated
3238 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3240 my $rules = Koha::CirculationRules->get_effective_rules(
3242 categorycode => $patron->categorycode,
3243 itemtype => $item->effective_itemtype,
3244 branchcode => $branchcode,
3245 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3248 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3249 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3250 $rules->{unseen_renewals_allowed} :
3252 $renewsleft = $renewsallowed - $renewcount;
3253 $unseenleft = $unseenallowed - $unseencount;
3254 if($renewsleft < 0){ $renewsleft = 0; }
3255 if($unseenleft < 0){ $unseenleft = 0; }
3266 =head2 GetSoonestRenewDate
3268 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3270 Find out the soonest possible renew date of a borrowed item.
3272 C<$borrowernumber> is the borrower number of the patron who currently
3273 has the item on loan.
3275 C<$itemnumber> is the number of the item to renew.
3277 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3278 renew date, based on the value "No renewal before" of the applicable
3279 issuing rule. Returns the current date if the item can already be
3280 renewed, and returns undefined if the borrower, loan, or item
3285 sub GetSoonestRenewDate {
3286 my ( $borrowernumber, $itemnumber ) = @_;
3288 my $dbh = C4::Context->dbh;
3290 my $item = Koha::Items->find($itemnumber) or return;
3291 my $itemissue = $item->checkout or return;
3293 $borrowernumber ||= $itemissue->borrowernumber;
3294 my $patron = Koha::Patrons->find( $borrowernumber )
3297 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3298 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3299 { categorycode => $patron->categorycode,
3300 itemtype => $item->effective_itemtype,
3301 branchcode => $branchcode,
3309 my $now = dt_from_string;
3311 if ( defined $issuing_rule->{norenewalbefore}
3312 and $issuing_rule->{norenewalbefore} ne "" )
3314 my $soonestrenewal =
3315 dt_from_string( $itemissue->date_due )->subtract(
3316 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3318 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3319 and $issuing_rule->{lengthunit} eq 'days' )
3321 $soonestrenewal->truncate( to => 'day' );
3323 return $soonestrenewal if $now < $soonestrenewal;
3324 } elsif ( $itemissue->auto_renew && $patron->autorenew_checkouts ) {
3325 # Checkouts with auto-renewing fall back to due date
3326 my $soonestrenewal = dt_from_string( $itemissue->date_due );
3327 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3328 and $issuing_rule->{lengthunit} eq 'days' )
3330 $soonestrenewal->truncate( to => 'day' );
3332 return $soonestrenewal;
3337 =head2 GetLatestAutoRenewDate
3339 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3341 Find out the latest possible auto renew date of a borrowed item.
3343 C<$borrowernumber> is the borrower number of the patron who currently
3344 has the item on loan.
3346 C<$itemnumber> is the number of the item to renew.
3348 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3349 auto renew date, based on the value "No auto renewal after" and the "No auto
3350 renewal after (hard limit) of the applicable issuing rule.
3351 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3352 or item cannot be found.
3356 sub GetLatestAutoRenewDate {
3357 my ( $borrowernumber, $itemnumber ) = @_;
3359 my $dbh = C4::Context->dbh;
3361 my $item = Koha::Items->find($itemnumber) or return;
3362 my $itemissue = $item->checkout or return;
3364 $borrowernumber ||= $itemissue->borrowernumber;
3365 my $patron = Koha::Patrons->find( $borrowernumber )
3368 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3369 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3371 categorycode => $patron->categorycode,
3372 itemtype => $item->effective_itemtype,
3373 branchcode => $branchcode,
3375 'no_auto_renewal_after',
3376 'no_auto_renewal_after_hard_limit',
3382 return unless $circulation_rules;
3384 if ( not $circulation_rules->{no_auto_renewal_after}
3385 or $circulation_rules->{no_auto_renewal_after} eq '' )
3386 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3387 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3389 my $maximum_renewal_date;
3390 if ( $circulation_rules->{no_auto_renewal_after} ) {
3391 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3392 $maximum_renewal_date->add(
3393 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3397 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3398 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3399 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3401 return $maximum_renewal_date;
3405 =head2 GetIssuingCharges
3407 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3409 Calculate how much it would cost for a given patron to borrow a given
3410 item, including any applicable discounts.
3412 C<$itemnumber> is the item number of item the patron wishes to borrow.
3414 C<$borrowernumber> is the patron's borrower number.
3416 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3417 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3422 sub GetIssuingCharges {
3424 # calculate charges due
3425 my ( $itemnumber, $borrowernumber ) = @_;
3427 my $dbh = C4::Context->dbh;
3430 # Get the book's item type and rental charge (via its biblioitem).
3431 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3432 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3433 $charge_query .= (C4::Context->preference('item-level_itypes'))
3434 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3435 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3437 $charge_query .= ' WHERE items.itemnumber =?';
3439 my $sth = $dbh->prepare($charge_query);
3440 $sth->execute($itemnumber);
3441 if ( my $item_data = $sth->fetchrow_hashref ) {
3442 $item_type = $item_data->{itemtype};
3443 $charge = $item_data->{rentalcharge};
3445 # FIXME This should follow CircControl
3446 my $branch = C4::Context::mybranch();
3447 my $patron = Koha::Patrons->find( $borrowernumber );
3448 my $discount = Koha::CirculationRules->get_effective_rule({
3449 categorycode => $patron->categorycode,
3450 branchcode => $branch,
3451 itemtype => $item_type,
3452 rule_name => 'rentaldiscount'
3455 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3457 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3461 return ( $charge, $item_type );
3464 =head2 AddIssuingCharge
3466 &AddIssuingCharge( $checkout, $charge, $type )
3470 sub AddIssuingCharge {
3471 my ( $checkout, $charge, $type ) = @_;
3473 # FIXME What if checkout does not exist?
3475 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3476 my $accountline = $account->add_debit(
3480 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3481 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3482 interface => C4::Context->interface,
3484 item_id => $checkout->itemnumber,
3485 issue_id => $checkout->issue_id,
3490 =head2 GetTransfersFromTo
3492 @results = GetTransfersFromTo($frombranch,$tobranch);
3494 Returns the list of pending transfers between $from and $to branch
3498 sub GetTransfersFromTo {
3499 my ( $frombranch, $tobranch ) = @_;
3500 return unless ( $frombranch && $tobranch );
3501 my $dbh = C4::Context->dbh;
3503 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3504 FROM branchtransfers
3507 AND datecancelled IS NULL
3508 AND datesent IS NOT NULL
3509 AND datearrived IS NULL
3511 my $sth = $dbh->prepare($query);
3512 $sth->execute( $frombranch, $tobranch );
3515 while ( my $data = $sth->fetchrow_hashref ) {
3516 push @gettransfers, $data;
3518 return (@gettransfers);
3521 =head2 SendCirculationAlert
3523 Send out a C<check-in> or C<checkout> alert using the messaging system.
3531 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3535 Hashref of information about the item being checked in or out.
3539 Hashref of information about the borrower of the item.
3543 The branchcode from where the checkout or check-in took place.
3549 SendCirculationAlert({
3552 borrower => $borrower,
3558 sub SendCirculationAlert {
3560 my ($type, $item, $borrower, $branch, $issue) =
3561 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3562 my %message_name = (
3563 CHECKIN => 'Item_Check_in',
3564 CHECKOUT => 'Item_Checkout',
3565 RENEWAL => 'Item_Checkout',
3567 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3568 borrowernumber => $borrower->{borrowernumber},
3569 message_name => $message_name{$type},
3574 items => $item->{itemnumber},
3575 biblio => $item->{biblionumber},
3576 biblioitems => $item->{biblionumber},
3577 borrowers => $borrower,
3578 branches => $branch,
3581 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3582 # See C4::Letters:: _parseletter_sth
3583 if( $type eq 'CHECKIN' ){
3584 $tables->{old_issues} = $issue->issue_id;
3586 $tables->{issues} = $item->{itemnumber};
3589 my $schema = Koha::Database->new->schema;
3590 my @transports = keys %{ $borrower_preferences->{transports} };
3592 # From the MySQL doc:
3593 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3594 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3595 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3596 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3598 for my $mtt (@transports) {
3599 my $letter = C4::Letters::GetPreparedLetter (
3600 module => 'circulation',
3601 letter_code => $type,
3602 branchcode => $branch,
3603 message_transport_type => $mtt,
3604 lang => $borrower->{lang},
3608 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3609 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3610 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3611 unless ( $message ) {
3612 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3613 C4::Message->enqueue($letter, $borrower, $mtt);
3615 $message->append($letter);
3618 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3624 =head2 updateWrongTransfer
3626 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3628 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
3632 sub updateWrongTransfer {
3633 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3635 # first step: cancel the original transfer
3636 my $item = Koha::Items->find($itemNumber);
3637 my $transfer = $item->get_transfer;
3638 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3640 # second step: create a new transfer to the right location
3641 my $new_transfer = $item->request_transfer(
3643 to => $transfer->to_library,
3644 reason => $transfer->reason,
3645 comment => $transfer->comments,
3651 return $new_transfer;
3656 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3658 this function calculates the due date given the start date and configured circulation rules,
3659 checking against the holidays calendar as per the daysmode circulation rule.
3660 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3661 C<$itemtype> = itemtype code of item in question
3662 C<$branch> = location whose calendar to use
3663 C<$borrower> = Borrower object
3664 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3669 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3673 # loanlength now a href
3675 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3677 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3683 if (ref $startdate ne 'DateTime' ) {
3684 $datedue = dt_from_string($datedue);
3686 $datedue = $startdate->clone;
3689 $datedue = dt_from_string()->truncate( to => 'minute' );
3693 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3695 categorycode => $borrower->{categorycode},
3696 itemtype => $itemtype,
3697 branchcode => $branch,
3701 # calculate the datedue as normal
3702 if ( $daysmode eq 'Days' )
3703 { # ignoring calendar
3704 if ( $loanlength->{lengthunit} eq 'hours' ) {
3705 $datedue->add( hours => $loanlength->{$length_key} );
3707 $datedue->add( days => $loanlength->{$length_key} );
3708 $datedue->set_hour(23);
3709 $datedue->set_minute(59);
3713 if ($loanlength->{lengthunit} eq 'hours') {
3714 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3717 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3719 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3720 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3721 if ($loanlength->{lengthunit} eq 'days') {
3722 $datedue->set_hour(23);
3723 $datedue->set_minute(59);
3727 # if Hard Due Dates are used, retrieve them and apply as necessary
3728 my ( $hardduedate, $hardduedatecompare ) =
3729 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3730 if ($hardduedate) { # hardduedates are currently dates
3731 $hardduedate->truncate( to => 'minute' );
3732 $hardduedate->set_hour(23);
3733 $hardduedate->set_minute(59);
3734 my $cmp = DateTime->compare( $hardduedate, $datedue );
3736 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3737 # if the calculated date is before the 'after' Hard Due Date (floor), override
3738 # if the hard due date is set to 'exactly', overrride
3739 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3740 $datedue = $hardduedate->clone;
3743 # in all other cases, keep the date due as it is
3747 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3748 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3749 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3750 if( $expiry_dt ) { #skip empty expiry date..
3751 $expiry_dt->set( hour => 23, minute => 59);
3752 my $d1= $datedue->clone->set_time_zone('floating');
3753 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3754 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3757 if ( $daysmode ne 'Days' ) {
3758 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3759 if ( $calendar->is_holiday($datedue) ) {
3760 # Don't return on a closed day
3761 $datedue = $calendar->prev_open_days( $datedue, 1 );
3770 sub CheckValidBarcode{
3772 my $dbh = C4::Context->dbh;
3773 my $query=qq|SELECT count(*)
3777 my $sth = $dbh->prepare($query);
3778 $sth->execute($barcode);
3779 my $exist=$sth->fetchrow ;
3783 =head2 IsBranchTransferAllowed
3785 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3787 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3789 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3790 Koha::Item->can_be_transferred.
3794 sub IsBranchTransferAllowed {
3795 my ( $toBranch, $fromBranch, $code ) = @_;
3797 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3799 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3800 my $dbh = C4::Context->dbh;
3802 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3803 $sth->execute( $toBranch, $fromBranch, $code );
3804 my $limit = $sth->fetchrow_hashref();
3806 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3807 if ( $limit->{'limitId'} ) {
3814 =head2 CreateBranchTransferLimit
3816 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3818 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3820 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3824 sub CreateBranchTransferLimit {
3825 my ( $toBranch, $fromBranch, $code ) = @_;
3826 return unless defined($toBranch) && defined($fromBranch);
3827 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3829 my $dbh = C4::Context->dbh;
3831 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3832 return $sth->execute( $code, $toBranch, $fromBranch );
3835 =head2 DeleteBranchTransferLimits
3837 my $result = DeleteBranchTransferLimits($frombranch);
3839 Deletes all the library transfer limits for one library. Returns the
3840 number of limits deleted, 0e0 if no limits were deleted, or undef if
3841 no arguments are supplied.
3843 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3844 fromBranch => $fromBranch
3849 sub DeleteBranchTransferLimits {
3851 return unless defined $branch;
3852 my $dbh = C4::Context->dbh;
3853 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3854 return $sth->execute($branch);
3858 my ( $borrowernumber, $itemnum ) = @_;
3859 MarkIssueReturned( $borrowernumber, $itemnum );
3864 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3866 The final optional parameter, C<$params>, expected to contain
3867 'skip_record_index' key, which relayed down to Koha::Item/store,
3868 there it prevents calling of ModZebra index_records,
3869 which takes most of the time in batch adds/deletes: index_records better
3870 to be called later in C<additem.pl> after the whole loop.
3873 skip_record_index => 1|0
3878 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3880 unless ( $mark_lost_from ) {
3881 # Temporary check to avoid regressions
3882 die q|LostItem called without $mark_lost_from, check the API.|;
3886 if ( $force_mark_returned ) {
3889 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3890 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3893 my $dbh = C4::Context->dbh();
3894 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3896 JOIN items USING (itemnumber)
3897 JOIN biblio USING (biblionumber)
3898 WHERE issues.itemnumber=?");
3899 $sth->execute($itemnumber);
3900 my $issues=$sth->fetchrow_hashref();
3902 # If a borrower lost the item, add a replacement cost to the their record
3903 if ( my $borrowernumber = $issues->{borrowernumber} ){
3904 my $patron = Koha::Patrons->find( $borrowernumber );
3906 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3907 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3909 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3910 C4::Accounts::chargelostitem(
3913 $issues->{'replacementprice'},
3914 sprintf( "%s %s %s",
3915 $issues->{'title'} || q{},
3916 $issues->{'barcode'} || q{},
3917 $issues->{'itemcallnumber'} || q{},
3920 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3921 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3924 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3927 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3928 my $item = Koha::Items->find($itemnumber);
3929 my $transfers = $item->get_transfers;
3930 while (my $transfer = $transfers->next) {
3931 $transfer->cancel({ reason => 'ItemLost', force => 1 });
3935 sub GetOfflineOperations {
3936 my $dbh = C4::Context->dbh;
3937 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3938 $sth->execute(C4::Context->userenv->{'branch'});
3939 my $results = $sth->fetchall_arrayref({});
3943 sub GetOfflineOperation {
3944 my $operationid = shift;
3945 return unless $operationid;
3946 my $dbh = C4::Context->dbh;
3947 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3948 $sth->execute( $operationid );
3949 return $sth->fetchrow_hashref;
3952 sub AddOfflineOperation {
3953 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3954 my $dbh = C4::Context->dbh;
3955 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3956 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3960 sub DeleteOfflineOperation {
3961 my $dbh = C4::Context->dbh;
3962 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3963 $sth->execute( shift );
3967 sub ProcessOfflineOperation {
3968 my $operation = shift;
3971 if ( $operation->{action} eq 'return' ) {
3972 $report = ProcessOfflineReturn( $operation );
3973 } elsif ( $operation->{action} eq 'issue' ) {
3974 $report = ProcessOfflineIssue( $operation );
3975 } elsif ( $operation->{action} eq 'payment' ) {
3976 $report = ProcessOfflinePayment( $operation );
3979 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3984 sub ProcessOfflineReturn {
3985 my $operation = shift;
3987 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3990 my $itemnumber = $item->itemnumber;
3991 my $issue = $item->checkout;
3993 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3994 ModDateLastSeen( $itemnumber, $leave_item_lost );
3996 $issue->borrowernumber,
3998 $operation->{timestamp},
4000 $item->renewals_count(0);
4001 $item->onloan(undef);
4002 $item->store({ log_action => 0 });
4005 return "Item not issued.";
4008 return "Item not found.";
4012 sub ProcessOfflineIssue {
4013 my $operation = shift;
4015 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4018 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4020 return "Barcode not found.";
4022 my $itemnumber = $item->itemnumber;
4023 my $issue = $item->checkout;
4025 if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4027 $issue->borrowernumber,
4029 $operation->{timestamp},
4034 $operation->{'barcode'},
4037 $operation->{timestamp},
4042 return "Borrower not found.";
4046 sub ProcessOfflinePayment {
4047 my $operation = shift;
4049 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4051 $patron->account->pay(
4053 amount => $operation->{amount},
4054 library_id => $operation->{branchcode},
4064 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4066 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4071 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4075 ? Koha::Items->find($itemnumber)
4076 : Koha::Items->find( { barcode => $barcode } );
4080 return C4::Letters::GetPreparedLetter (
4081 module => 'circulation',
4082 letter_code => 'TRANSFERSLIP',
4083 branchcode => $branch,
4085 'branches' => $to_branch,
4086 'biblio' => $item->biblionumber,
4087 'items' => $item->unblessed,
4092 =head2 CheckIfIssuedToPatron
4094 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4096 Return 1 if any record item is issued to patron, otherwise return 0
4100 sub CheckIfIssuedToPatron {
4101 my ($borrowernumber, $biblionumber) = @_;
4103 my $dbh = C4::Context->dbh;
4105 SELECT COUNT(*) FROM issues
4106 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4107 WHERE items.biblionumber = ?
4108 AND issues.borrowernumber = ?
4110 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4111 return 1 if $is_issued;
4117 IsItemIssued( $itemnumber )
4119 Return 1 if the item is on loan, otherwise return 0
4124 my $itemnumber = shift;
4125 my $dbh = C4::Context->dbh;
4126 my $sth = $dbh->prepare(q{
4129 WHERE itemnumber = ?
4131 $sth->execute($itemnumber);
4132 return $sth->fetchrow;
4135 =head2 GetAgeRestriction
4137 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4138 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4140 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4141 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4143 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4144 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4145 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4146 Negative days mean the borrower has gone past the age restriction age.
4150 sub GetAgeRestriction {
4151 my ($record_restrictions, $borrower) = @_;
4152 my $markers = C4::Context->preference('AgeRestrictionMarker');
4154 return unless $record_restrictions;
4155 # Split $record_restrictions to something like FSK 16 or PEGI 6
4156 my @values = split ' ', uc($record_restrictions);
4157 return unless @values;
4159 # Search first occurrence of one of the markers
4160 my @markers = split /\|/, uc($markers);
4161 return unless @markers;
4164 my $restriction_year = 0;
4165 for my $value (@values) {
4167 for my $marker (@markers) {
4168 $marker =~ s/^\s+//; #remove leading spaces
4169 $marker =~ s/\s+$//; #remove trailing spaces
4170 if ( $marker eq $value ) {
4171 if ( $index <= $#values ) {
4172 $restriction_year += $values[$index];
4176 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4178 # Perhaps it is something like "K16" (as in Finland)
4179 $restriction_year += $1;
4183 last if ( $restriction_year > 0 );
4186 #Check if the borrower is age restricted for this material and for how long.
4187 if ($restriction_year && $borrower) {
4188 if ( $borrower->{'dateofbirth'} ) {
4189 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4190 $alloweddate[0] += $restriction_year;
4192 #Prevent runime eror on leap year (invalid date)
4193 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4194 $alloweddate[2] = 28;
4197 #Get how many days the borrower has to reach the age restriction
4198 my @Today = split /-/, dt_from_string()->ymd();
4199 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4200 #Negative days means the borrower went past the age restriction age
4201 return ($restriction_year, $daysToAgeRestriction);
4205 return ($restriction_year);
4209 =head2 GetPendingOnSiteCheckouts
4213 sub GetPendingOnSiteCheckouts {
4214 my $dbh = C4::Context->dbh;
4215 return $dbh->selectall_arrayref(q|
4221 items.itemcallnumber,
4225 issues.date_due < NOW() AS is_overdue,
4228 borrowers.firstname,
4230 borrowers.cardnumber,
4231 borrowers.borrowernumber
4233 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4234 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4235 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4236 WHERE issues.onsite_checkout = 1
4237 |, { Slice => {} } );
4243 my ($count, $branch, $itemtype, $ccode, $newness)
4244 = @$params{qw(count branch itemtype ccode newness)};
4246 my $dbh = C4::Context->dbh;
4249 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4250 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4251 i.ccode, SUM(i.issues) AS count
4253 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4254 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4257 my (@where_strs, @where_args);
4260 push @where_strs, 'i.homebranch = ?';
4261 push @where_args, $branch;
4264 if (C4::Context->preference('item-level_itypes')){
4265 push @where_strs, 'i.itype = ?';
4266 push @where_args, $itemtype;
4268 push @where_strs, 'bi.itemtype = ?';
4269 push @where_args, $itemtype;
4273 push @where_strs, 'i.ccode = ?';
4274 push @where_args, $ccode;
4277 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4278 push @where_args, $newness;
4282 $query .= 'WHERE ' . join(' AND ', @where_strs);
4286 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4287 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4292 $query .= q{ ) xxx WHERE count > 0 };
4293 $count = int($count);
4295 $query .= "LIMIT $count";
4298 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4303 =head2 Internal methods
4307 sub _CalculateAndUpdateFine {
4310 my $borrower = $params->{borrower};
4311 my $item = $params->{item};
4312 my $issue = $params->{issue};
4313 my $return_date = $params->{return_date};
4315 unless ($borrower) { carp "No borrower passed in!" && return; }
4316 unless ($item) { carp "No item passed in!" && return; }
4317 unless ($issue) { carp "No issue passed in!" && return; }
4319 my $datedue = dt_from_string( $issue->date_due );
4321 # we only need to calculate and change the fines if we want to do that on return
4322 # Should be on for hourly loans
4323 my $control = C4::Context->preference('CircControl');
4324 my $control_branchcode =
4325 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4326 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4327 : $issue->branchcode;
4329 my $date_returned = $return_date ? $return_date : dt_from_string();
4331 my ( $amount, $unitcounttotal, $unitcount ) =
4332 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4334 if ( C4::Context->preference('finesMode') eq 'production' ) {
4335 if ( $amount > 0 ) {
4336 C4::Overdues::UpdateFine({
4337 issue_id => $issue->issue_id,
4338 itemnumber => $issue->itemnumber,
4339 borrowernumber => $issue->borrowernumber,
4344 elsif ($return_date) {
4346 # Backdated returns may have fines that shouldn't exist,
4347 # so in this case, we need to drop those fines to 0
4349 C4::Overdues::UpdateFine({
4350 issue_id => $issue->issue_id,
4351 itemnumber => $issue->itemnumber,
4352 borrowernumber => $issue->borrowernumber,
4360 sub _CanBookBeAutoRenewed {
4361 my ( $params ) = @_;
4362 my $patron = $params->{patron};
4363 my $item = $params->{item};
4364 my $branchcode = $params->{branchcode};
4365 my $issue = $params->{issue};
4367 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4369 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4371 categorycode => $patron->categorycode,
4372 itemtype => $item->effective_itemtype,
4373 branchcode => $branchcode,
4375 'no_auto_renewal_after',
4376 'no_auto_renewal_after_hard_limit',
4383 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4384 return 'auto_account_expired';
4387 if ( defined $issuing_rule->{no_auto_renewal_after}
4388 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4389 # Get issue_date and add no_auto_renewal_after
4390 # If this is greater than today, it's too late for renewal.
4391 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4392 $maximum_renewal_date->add(
4393 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4395 my $now = dt_from_string;
4396 if ( $now >= $maximum_renewal_date ) {
4397 return "auto_too_late";
4400 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4401 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4402 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4403 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4404 return "auto_too_late";
4408 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4409 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4410 my $amountoutstanding =
4411 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4412 ? $patron->account->balance
4413 : $patron->account->outstanding_debits->total_outstanding;
4414 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4415 return "auto_too_much_oweing";
4419 my $soonest = GetSoonestRenewDate($patron->id, $item->id);
4420 if ( $soonest > dt_from_string() )
4422 return ( "auto_too_soon", $soonest );
4428 sub _item_denied_renewal {
4431 my $item = $params->{item};
4432 return unless $item;
4434 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4435 return unless $denyingrules;
4436 foreach my $field (keys %$denyingrules) {
4437 my $val = $item->$field;
4438 if( !defined $val) {
4439 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4442 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4443 # If the results matches the values in the syspref
4444 # We return true if match found
4457 Koha Development Team <http://koha-community.org/>