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
100 CheckIfIssuedToPatron
114 IsBranchTransferAllowed
115 CreateBranchTransferLimit
116 DeleteBranchTransferLimits
122 DeleteOfflineOperation
123 ProcessOfflineOperation
124 ProcessOfflinePayment
127 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
132 C4::Circulation - Koha circulation module
140 The functions in this module deal with circulation, issues, and
141 returns, as well as general information about the library.
142 Also deals with inventory.
148 $str = &barcodedecode($barcode, [$filter]);
150 Generic filter function for barcode string.
151 Called on every circ if the System Pref itemBarcodeInputFilter is set.
152 Will do some manipulation of the barcode for systems that deliver a barcode
153 to circulation.pl that differs from the barcode stored for the item.
154 For proper functioning of this filter, calling the function on the
155 correct barcode string (items.barcode) should return an unaltered barcode.
156 Barcode is going to be automatically trimmed of leading/trailing whitespaces.
158 The optional $filter argument is to allow for testing or explicit
159 behavior that ignores the System Pref. Valid values are the same as the
164 # FIXME -- the &decode fcn below should be wrapped into this one.
165 # FIXME -- these plugins should be moved out of Circulation.pm
168 my ($barcode, $filter) = @_;
170 return unless defined $barcode;
172 my $branch = C4::Context::mybranch();
173 $barcode =~ s/^\s+|\s+$//g;
174 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
175 Koha::Plugins->call('item_barcode_transform', \$barcode );
176 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
177 if ($filter eq 'whitespace') {
179 } elsif ($filter eq 'cuecat') {
181 my @fields = split( /\./, $barcode );
182 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
183 ($#results == 2) and return $results[2];
184 } elsif ($filter eq 'T-prefix') {
185 if ($barcode =~ /^[Tt](\d)/) {
186 (defined($1) and $1 eq '0') and return $barcode;
187 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
189 return sprintf("T%07d", $barcode);
190 # FIXME: $barcode could be "T1", causing warning: substr outside of string
191 # Why drop the nonzero digit after the T?
192 # Why pass non-digits (or empty string) to "T%07d"?
193 } elsif ($filter eq 'libsuite8') {
194 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
195 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
196 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
198 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
201 } elsif ($filter eq 'EAN13') {
202 my $ean = CheckDigits('ean');
203 if ( $ean->is_valid($barcode) ) {
204 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
205 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
207 warn "# [$barcode] not valid EAN-13/UPC-A\n";
210 return $barcode; # return barcode, modified or not
215 $str = &_decode($chunk);
217 Decodes a segment of a string emitted by a CueCat barcode scanner and
220 FIXME: Should be replaced with Barcode::Cuecat from CPAN
221 or Javascript based decoding on the client side.
228 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
229 my @s = map { index( $seq, $_ ); } split( //, $encoded );
230 my $l = ( $#s + 1 ) % 4;
233 # warn "Error: Cuecat decode parsing failed!";
241 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
243 chr( ( $n >> 16 ) ^ 67 )
244 .chr( ( $n >> 8 & 255 ) ^ 67 )
245 .chr( ( $n & 255 ) ^ 67 );
248 $r = substr( $r, 0, length($r) - $l );
254 ($dotransfer, $messages, $iteminformation) = &transferbook({
255 from_branch => $frombranch
256 to_branch => $tobranch,
258 ignore_reserves => $ignore_reserves,
262 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
264 C<$fbr> is the code for the branch initiating the transfer.
265 C<$tbr> is the code for the branch to which the item should be transferred.
267 C<$barcode> is the barcode of the item to be transferred.
269 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
270 Otherwise, if an item is reserved, the transfer fails.
272 C<$trigger> is the enum value for what triggered the transfer.
274 Returns three values:
280 is true if the transfer was successful.
284 is a reference-to-hash which may have any of the following keys:
290 There is no item in the catalog with the given barcode. The value is C<$barcode>.
292 =item C<DestinationEqualsHolding>
294 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.
298 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.
302 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>.
304 =item C<WasTransferred>
306 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
308 =item C<RecallPlacedAtHoldingBranch>
310 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.
314 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
324 my $tbr = $params->{to_branch};
325 my $fbr = $params->{from_branch};
326 my $ignoreRs = $params->{ignore_reserves};
327 my $barcode = $params->{barcode};
328 my $trigger = $params->{trigger};
331 my $item = Koha::Items->find( { barcode => $barcode } );
333 Koha::Exceptions::MissingParameter->throw(
334 "Missing mandatory parameter: from_branch")
337 Koha::Exceptions::MissingParameter->throw(
338 "Missing mandatory parameter: to_branch")
343 $messages->{'BadBarcode'} = $barcode;
345 return ( $dotransfer, $messages );
348 my $itemnumber = $item->itemnumber;
349 # get branches of book...
350 my $hbr = $item->homebranch;
352 # if using Branch Transfer Limits
353 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
354 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
355 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
356 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
357 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
360 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
361 $messages->{'NotAllowed'} = $tbr . "::" . $code;
366 # can't transfer book if is already there....
367 if ( $fbr eq $tbr ) {
368 $messages->{'DestinationEqualsHolding'} = 1;
372 # check if it is still issued to someone, return it...
373 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
375 AddReturn( $barcode, $fbr );
376 $messages->{'WasReturned'} = $issue->borrowernumber;
380 # That'll save a database query.
381 my ( $resfound, $resrec, undef ) =
382 CheckReserves( $itemnumber );
384 $resrec->{'ResFound'} = $resfound;
385 $messages->{'ResFound'} = $resrec;
386 $dotransfer = 0 unless $ignoreRs;
390 if ( C4::Context->preference('UseRecalls') ) {
391 my $recall = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
392 if ( defined $recall ) {
393 # do a transfer if the recall branch is different to the item holding branch
394 if ( $recall->pickup_library_id eq $fbr ) {
396 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
399 $messages->{'RecallFound'} = $recall;
404 #actually do the transfer....
406 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
408 # don't need to update MARC anymore, we do it in batch now
409 $messages->{'WasTransfered'} = $tbr;
412 ModDateLastSeen( $itemnumber );
413 return ( $dotransfer, $messages );
418 my $borrower = shift;
419 my $item_object = shift;
421 my $onsite_checkout = $params->{onsite_checkout} || 0;
422 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
423 my $cat_borrower = $borrower->{'categorycode'};
424 my $dbh = C4::Context->dbh;
425 # Get which branchcode we need
426 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
427 my $type = $item_object->effective_itemtype;
429 my ($type_object, $parent_type, $parent_maxissueqty_rule);
430 $type_object = Koha::ItemTypes->find( $type );
431 $parent_type = $type_object->parent_type if $type_object;
432 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
433 # Find any children if we are a parent_type;
435 # given branch, patron category, and item type, determine
436 # applicable issuing rule
438 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
440 categorycode => $cat_borrower,
441 itemtype => $parent_type,
442 branchcode => $branch,
443 rule_name => 'maxissueqty',
446 # If the parent rule is for default type we discount it
447 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
449 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
451 categorycode => $cat_borrower,
453 branchcode => $branch,
454 rule_name => 'maxissueqty',
458 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
460 categorycode => $cat_borrower,
462 branchcode => $branch,
463 rule_name => 'maxonsiteissueqty',
468 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
469 # if a rule is found and has a loan limit set, count
470 # how many loans the patron already has that meet that
472 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
475 if ( $maxissueqty_rule->branchcode ) {
476 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
477 $checkouts = $patron->checkouts->search(
478 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
479 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
480 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
482 $checkouts = $patron->checkouts->search(
483 { 'item.homebranch' => $maxissueqty_rule->branchcode } );
486 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
488 $checkouts = $checkouts->search(undef, { prefetch => 'item' });
491 my $rule_itemtype = $maxissueqty_rule->itemtype;
494 unless ( $rule_itemtype ) {
495 # matching rule has the default item type, so count only
496 # those existing loans that don't fall under a more
498 @types = Koha::CirculationRules->search(
500 branchcode => $maxissueqty_rule->branchcode,
501 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
502 itemtype => { '!=' => undef },
503 rule_name => 'maxissueqty'
505 )->get_column('itemtype');
507 if ( $parent_maxissueqty_rule ) {
508 # if we have a parent item type then we count loans of the
509 # specific item type or its siblings or parent
510 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
511 @types = $children->get_column('itemtype');
512 push @types, $parent_type;
513 } elsif ( $child_types ) {
514 # If we are a parent type, we need to count all child types and our own type
515 @types = $child_types->get_column('itemtype');
516 push @types, $type; # And don't forget to count our own types
518 # Otherwise only count the specific itemtype
523 while ( my $c = $checkouts->next ) {
524 my $itemtype = $c->item->effective_itemtype;
526 unless ( $rule_itemtype ) {
527 next if grep {$_ eq $itemtype} @types;
529 next unless grep {$_ eq $itemtype} @types;
532 $sum_checkouts->{total}++;
533 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
534 $sum_checkouts->{itemtype}->{$itemtype}++;
537 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
538 my $checkout_count = $sum_checkouts->{total} || 0;
539 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
541 my $checkout_rules = {
542 checkout_count => $checkout_count,
543 onsite_checkout_count => $onsite_checkout_count,
544 onsite_checkout => $onsite_checkout,
545 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
546 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
547 switch_onsite_checkout => $switch_onsite_checkout,
549 # If parent rules exists
550 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
551 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
552 my $qty_over = _check_max_qty($checkout_rules);
553 return $qty_over if defined $qty_over;
555 # If the parent rule is less than or equal to the child, we only need check the parent
556 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
557 $checkout_rules->{checkout_count} = $checkout_count_type;
558 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
559 my $qty_over = _check_max_qty($checkout_rules);
560 return $qty_over if defined $qty_over;
563 my $qty_over = _check_max_qty($checkout_rules);
564 return $qty_over if defined $qty_over;
568 # Now count total loans against the limit for the branch
569 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
570 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
572 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
573 $checkouts = $patron->checkouts->search(
574 { 'me.branchcode' => $branch} );
575 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
576 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
578 $checkouts = $patron->checkouts->search(
579 { 'item.homebranch' => $branch},
580 { prefetch => 'item' } );
583 my $checkout_count = $checkouts->count;
584 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
585 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
586 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
588 my $qty_over = _check_max_qty(
590 checkout_count => $checkout_count,
591 onsite_checkout_count => $onsite_checkout_count,
592 onsite_checkout => $onsite_checkout,
593 max_checkouts_allowed => $max_checkouts_allowed,
594 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
595 switch_onsite_checkout => $switch_onsite_checkout
598 return $qty_over if defined $qty_over;
601 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
602 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
605 # OK, the patron can issue !!!
611 my $checkout_count = $params->{checkout_count};
612 my $onsite_checkout_count = $params->{onsite_checkout_count};
613 my $onsite_checkout = $params->{onsite_checkout};
614 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
615 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
616 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
618 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
619 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
620 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
622 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
623 count => $onsite_checkout_count,
624 max_allowed => $max_onsite_checkouts_allowed,
628 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
629 if ( $max_checkouts_allowed eq '' ) { return; }
630 my $delta = $switch_onsite_checkout ? 1 : 0;
631 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
633 reason => 'TOO_MANY_CHECKOUTS',
634 count => $checkout_count,
635 max_allowed => $max_checkouts_allowed,
639 elsif ( not $onsite_checkout ) {
640 if ( $max_checkouts_allowed eq '' ) { return; }
642 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
645 reason => 'TOO_MANY_CHECKOUTS',
646 count => $checkout_count - $onsite_checkout_count,
647 max_allowed => $max_checkouts_allowed,
655 =head2 CanBookBeIssued
657 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
658 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
660 Check if a book can be issued.
662 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
664 IMPORTANT: The assumption by users of this routine is that causes blocking
665 the issue are keyed by uppercase labels and other returned
666 data is keyed in lower case!
670 =item C<$patron> is a Koha::Patron
672 =item C<$barcode> is the bar code of the book being issued.
674 =item C<$duedates> is a DateTime object.
676 =item C<$inprocess> boolean switch
678 =item C<$ignore_reserves> boolean switch
680 =item C<$params> Hashref of additional parameters
683 override_high_holds - Ignore high holds
684 onsite_checkout - Checkout is an onsite checkout that will not leave the library
692 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
693 Possible values are :
699 sticky due date is invalid
703 borrower gone with no address
707 borrower declared it's card lost
713 =head3 UNKNOWN_BARCODE
727 item is restricted (set by ??)
729 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
730 could be prevented, but ones that can be overriden by the operator.
732 Possible values are :
740 renewing, not issuing
742 =head3 ISSUED_TO_ANOTHER
744 issued to someone else.
748 reserved for someone else.
752 reserved and being transferred for someone else.
756 sticky due date is invalid or due date in the past
760 if the borrower borrows to much things
764 recalled by someone else
768 sub CanBookBeIssued {
769 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
770 my %needsconfirmation; # filled with problems that needs confirmations
771 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
772 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
773 my %messages; # filled with information messages that should be displayed.
775 my $onsite_checkout = $params->{onsite_checkout} || 0;
776 my $override_high_holds = $params->{override_high_holds} || 0;
778 my $item_object = Koha::Items->find({barcode => $barcode });
780 # MANDATORY CHECKS - unless item exists, nothing else matters
781 unless ( $item_object ) {
782 $issuingimpossible{UNKNOWN_BARCODE} = 1;
784 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
786 my $item_unblessed = $item_object->unblessed; # Transition...
787 my $issue = $item_object->checkout;
788 my $biblio = $item_object->biblio;
790 my $biblioitem = $biblio->biblioitem;
791 my $effective_itemtype = $item_object->effective_itemtype;
792 my $dbh = C4::Context->dbh;
793 my $patron_unblessed = $patron->unblessed;
795 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
797 my $now = dt_from_string();
798 $duedate ||= CalcDateDue( $now, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
799 if (DateTime->compare($duedate,$now) == -1 ) { # duedate cannot be before now
800 $needsconfirmation{INVALID_DATE} = $duedate;
803 my $fees = Koha::Charges::Fees->new(
806 library => $circ_library,
807 item => $item_object,
815 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
816 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
817 C4::Stats::UpdateStats({
818 branch => C4::Context->userenv->{'branch'},
820 itemnumber => $item_object->itemnumber,
821 itemtype => $effective_itemtype,
822 borrowernumber => $patron->borrowernumber,
823 ccode => $item_object->ccode}
825 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
826 return( { STATS => 1 }, {});
829 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
830 $issuingimpossible{GNA} = 1;
833 if ( $patron->lost && $patron->lost == 1 ) {
834 $issuingimpossible{CARD_LOST} = 1;
836 if ( $patron->is_debarred ) {
837 $issuingimpossible{DEBARRED} = 1;
840 if ( $patron->is_expired ) {
841 $issuingimpossible{EXPIRED} = 1;
849 my $account = $patron->account;
850 my $balance = $account->balance;
851 my $non_issues_charges = $account->non_issues_charges;
852 my $other_charges = $balance - $non_issues_charges;
854 my $amountlimit = C4::Context->preference("noissuescharge");
855 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
856 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
858 # Check the debt of this patrons guarantees
859 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
860 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
861 if ( defined $no_issues_charge_guarantees ) {
862 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
863 my $guarantees_non_issues_charges = 0;
864 foreach my $g ( @guarantees ) {
865 $guarantees_non_issues_charges += $g->account->non_issues_charges;
868 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
869 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
870 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
871 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
872 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
873 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
877 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
878 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
879 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
880 if ( defined $no_issues_charge_guarantors ) {
881 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
883 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
884 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
885 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
886 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
887 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
888 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
892 if ( C4::Context->preference("IssuingInProcess") ) {
893 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
894 $issuingimpossible{DEBT} = $non_issues_charges;
895 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
896 $needsconfirmation{DEBT} = $non_issues_charges;
897 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
898 $needsconfirmation{DEBT} = $non_issues_charges;
902 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
903 $needsconfirmation{DEBT} = $non_issues_charges;
904 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
905 $issuingimpossible{DEBT} = $non_issues_charges;
906 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
907 $needsconfirmation{DEBT} = $non_issues_charges;
911 if ($balance > 0 && $other_charges > 0) {
912 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
915 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
916 $patron_unblessed = $patron->unblessed;
918 if ( my $debarred_date = $patron->is_debarred ) {
919 # patron has accrued fine days or has a restriction. $count is a date
920 if ($debarred_date eq '9999-12-31') {
921 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
924 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
926 } elsif ( my $num_overdues = $patron->has_overdues ) {
927 ## patron has outstanding overdue loans
928 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
929 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
931 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
932 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
936 # Additional Materials Check
937 if ( C4::Context->preference("CircConfirmItemParts")
938 && $item_object->materials )
940 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
944 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
946 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
948 # Already issued to current borrower.
949 # If it is an on-site checkout if it can be switched to a normal checkout
950 # or ask whether the loan should be renewed
952 if ( $issue->onsite_checkout
953 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
954 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
956 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
957 $patron->borrowernumber,
958 $item_object->itemnumber,
960 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
961 if ( $renewerror eq 'onsite_checkout' ) {
962 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
965 $issuingimpossible{NO_MORE_RENEWALS} = 1;
969 $needsconfirmation{RENEW_ISSUE} = 1;
975 # issued to someone else
977 my $patron = Koha::Patrons->find( $issue->borrowernumber );
979 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
981 unless ( $can_be_returned ) {
982 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
983 $issuingimpossible{branch_to_return} = $message;
985 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
986 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
988 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
989 $needsconfirmation{issued_firstname} = $patron->firstname;
990 $needsconfirmation{issued_surname} = $patron->surname;
991 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
992 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
997 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
999 my $switch_onsite_checkout = (
1000 C4::Context->preference('SwitchOnSiteCheckouts')
1002 and $issue->onsite_checkout
1003 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1004 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1005 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1006 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1007 if ( $toomany->{max_allowed} == 0 ) {
1008 $needsconfirmation{PATRON_CANT} = 1;
1010 if ( C4::Context->preference("AllowTooManyOverride") ) {
1011 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1012 $needsconfirmation{current_loan_count} = $toomany->{count};
1013 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1015 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1016 $issuingimpossible{current_loan_count} = $toomany->{count};
1017 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1022 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1024 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1025 my $wants_check = $patron->wants_check_for_previous_checkout;
1026 $needsconfirmation{PREVISSUE} = 1
1027 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1032 if ( $item_object->notforloan )
1034 if(!C4::Context->preference("AllowNotForLoanOverride")){
1035 $issuingimpossible{NOT_FOR_LOAN} = 1;
1036 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1038 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1039 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1043 # we have to check itemtypes.notforloan also
1044 if (C4::Context->preference('item-level_itypes')){
1045 # this should probably be a subroutine
1046 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1047 $sth->execute($effective_itemtype);
1048 my $notforloan=$sth->fetchrow_hashref();
1049 if ($notforloan->{'notforloan'}) {
1050 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1051 $issuingimpossible{NOT_FOR_LOAN} = 1;
1052 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1054 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1055 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1060 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1061 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1062 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1063 $issuingimpossible{NOT_FOR_LOAN} = 1;
1064 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1066 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1067 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1072 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1074 $issuingimpossible{WTHDRAWN} = 1;
1076 if ( $item_object->restricted
1077 && $item_object->restricted == 1 )
1079 $issuingimpossible{RESTRICTED} = 1;
1081 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1082 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1083 my $code = $av->count ? $av->next->lib : '';
1084 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1085 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1087 if ( C4::Context->preference("IndependentBranches") ) {
1088 my $userenv = C4::Context->userenv;
1089 unless ( C4::Context->IsSuperLibrarian() ) {
1090 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1091 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1092 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1093 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1095 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1096 if ( $patron->branchcode ne $userenv->{branch} );
1101 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1103 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1104 if ($rentalConfirmation) {
1105 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1107 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1108 if ($itemtype_object) {
1109 my $accumulate_charge = $fees->accumulate_rentalcharge();
1110 if ( $accumulate_charge > 0 ) {
1111 $rentalCharge += $accumulate_charge;
1115 if ( $rentalCharge > 0 ) {
1116 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1121 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1122 # Only bother doing this if UseRecalls is enabled and the item is recallable
1123 # Don't look at recalls that are in transit
1124 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1125 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1127 foreach my $r ( @recalls ) {
1128 if ( $r->item_id and
1129 $r->item_id == $item_object->itemnumber and
1130 $r->patron_id == $patron->borrowernumber and
1131 ( $r->waiting or $r->requested ) ) {
1132 $messages{RECALLED} = $r->id;
1134 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1137 elsif ( $r->item_id and
1138 $r->item_id == $item_object->itemnumber and
1140 # recalled item is in transit
1141 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1143 elsif ( $r->item_level and
1144 $r->item_id == $item_object->itemnumber and
1145 $r->patron_id != $patron->borrowernumber and
1147 # this specific item has been recalled by a different patron
1148 $needsconfirmation{RECALLED} = $r;
1152 elsif ( !$r->item_level and
1153 $r->patron_id != $patron->borrowernumber and
1155 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1156 $needsconfirmation{RECALLED} = $r;
1163 unless ( $ignore_reserves and defined $recall ) {
1164 # See if the item is on reserve.
1165 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1167 my $resbor = $res->{'borrowernumber'};
1168 if ( $resbor ne $patron->borrowernumber ) {
1169 my $patron = Koha::Patrons->find( $resbor );
1170 if ( $restype eq "Waiting" )
1172 # The item is on reserve and waiting, but has been
1173 # reserved by some other patron.
1174 $needsconfirmation{RESERVE_WAITING} = 1;
1175 $needsconfirmation{'resfirstname'} = $patron->firstname;
1176 $needsconfirmation{'ressurname'} = $patron->surname;
1177 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1178 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1179 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1180 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1181 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1183 elsif ( $restype eq "Reserved" ) {
1184 # The item is on reserve for someone else.
1185 $needsconfirmation{RESERVED} = 1;
1186 $needsconfirmation{'resfirstname'} = $patron->firstname;
1187 $needsconfirmation{'ressurname'} = $patron->surname;
1188 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1189 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1190 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1191 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1192 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1194 elsif ( $restype eq "Transferred" ) {
1195 # The item is determined hold being transferred for someone else.
1196 $needsconfirmation{TRANSFERRED} = 1;
1197 $needsconfirmation{'resfirstname'} = $patron->firstname;
1198 $needsconfirmation{'ressurname'} = $patron->surname;
1199 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1200 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1201 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1202 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1203 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1205 elsif ( $restype eq "Processing" ) {
1206 # The item is determined hold being processed for someone else.
1207 $needsconfirmation{PROCESSING} = 1;
1208 $needsconfirmation{'resfirstname'} = $patron->firstname;
1209 $needsconfirmation{'ressurname'} = $patron->surname;
1210 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1211 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1212 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1213 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1214 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1220 ## CHECK AGE RESTRICTION
1221 my $agerestriction = $biblioitem->agerestriction;
1222 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1223 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1224 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1225 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1228 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1232 ## check for high holds decreasing loan period
1233 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1234 my $check = checkHighHolds( $item_object, $patron );
1236 if ( $check->{exceeded} ) {
1238 num_holds => $check->{outstanding},
1239 duration => $check->{duration},
1240 returndate => $check->{due_date},
1242 if ($override_high_holds) {
1243 $alerts{HIGHHOLDS} = $highholds;
1246 $needsconfirmation{HIGHHOLDS} = $highholds;
1252 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1253 # don't do the multiple loans per bib check if we've
1254 # already determined that we've got a loan on the same item
1255 !$issuingimpossible{NO_MORE_RENEWALS} &&
1256 !$needsconfirmation{RENEW_ISSUE}
1258 # Check if borrower has already issued an item from the same biblio
1259 # Only if it's not a subscription
1260 my $biblionumber = $item_object->biblionumber;
1261 require C4::Serials;
1262 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1263 unless ($is_a_subscription) {
1264 # FIXME Should be $patron->checkouts($args);
1265 my $checkouts = Koha::Checkouts->search(
1267 borrowernumber => $patron->borrowernumber,
1268 biblionumber => $biblionumber,
1274 # if we get here, we don't already have a loan on this item,
1275 # so if there are any loans on this bib, ask for confirmation
1276 if ( $checkouts->count ) {
1277 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1282 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1285 =head2 CanBookBeReturned
1287 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1289 Check whether the item can be returned to the provided branch
1293 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1295 =item C<$branch> is the branchcode where the return is taking place
1303 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1305 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1311 sub CanBookBeReturned {
1312 my ($item, $branch) = @_;
1313 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1315 # assume return is allowed to start
1319 # identify all cases where return is forbidden
1320 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1322 $message = $item->{'homebranch'};
1323 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1325 $message = $item->{'holdingbranch'};
1326 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1328 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1331 return ($allowed, $message);
1334 =head2 CheckHighHolds
1336 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1337 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1338 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1342 sub checkHighHolds {
1343 my ( $item, $patron ) = @_;
1344 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1353 my $holds = Koha::Holds->search( { biblionumber => $item->biblionumber } );
1355 if ( $holds->count() ) {
1356 $return_data->{outstanding} = $holds->count();
1358 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1359 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1360 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1362 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1364 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1366 # static means just more than a given number of holds on the record
1368 # If the number of holds is less than the threshold, we can stop here
1369 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1370 return $return_data;
1373 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1375 # dynamic means X more than the number of holdable items on the record
1377 # let's get the items
1378 my @items = $holds->next()->biblio()->items()->as_list;
1380 # Remove any items with status defined to be ignored even if the would not make item unholdable
1381 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1382 @items = grep { !$_->$status } @items;
1385 # Remove any items that are not holdable for this patron
1386 @items = grep { CanItemBeReserved( $patron , $_, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1388 my $items_count = scalar @items;
1390 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1392 # If the number of holds is less than the count of items we have
1393 # plus the number of holds allowed above that count, we can stop here
1394 if ( $holds->count() <= $threshold ) {
1395 return $return_data;
1399 my $issuedate = dt_from_string();
1401 my $itype = $item->effective_itemtype;
1402 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1404 categorycode => $patron->categorycode,
1406 branchcode => $branchcode,
1409 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1411 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1413 my $rule = Koha::CirculationRules->get_effective_rule_value(
1415 categorycode => $patron->categorycode,
1416 itemtype => $item->effective_itemtype,
1417 branchcode => $branchcode,
1418 rule_name => 'decreaseloanholds',
1423 if ( defined($rule) && $rule ne '' ){
1424 # overrides decreaseLoanHighHoldsDuration syspref
1427 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1429 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1430 $reduced_datedue->set_hour($orig_due->hour);
1431 $reduced_datedue->set_minute($orig_due->minute);
1432 $reduced_datedue->truncate( to => 'minute' );
1434 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1435 $return_data->{exceeded} = 1;
1436 $return_data->{duration} = $duration;
1437 $return_data->{due_date} = $reduced_datedue;
1441 return $return_data;
1446 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1448 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1452 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1454 =item C<$barcode> is the barcode of the item being issued.
1456 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1457 Calculated if empty.
1459 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1461 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1464 AddIssue does the following things :
1466 - step 01: check that there is a borrowernumber & a barcode provided
1467 - check for RENEWAL (book issued & being issued to the same patron)
1468 - renewal YES = Calculate Charge & renew
1470 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1472 - fill reserve if reserve to this patron
1473 - cancel reserve or not, otherwise
1475 - fill recall if recall to this patron
1476 - cancel recall or not
1477 - revert recall's waiting status or not
1478 * TRANSFERT PENDING ?
1479 - complete the transfert
1487 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1489 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1490 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1491 my $auto_renew = $params && $params->{auto_renew};
1492 my $cancel_recall = $params && $params->{cancel_recall};
1493 my $recall_id = $params && $params->{recall_id};
1494 my $dbh = C4::Context->dbh;
1495 my $barcodecheck = CheckValidBarcode($barcode);
1499 if ( $datedue && ref $datedue ne 'DateTime' ) {
1500 $datedue = dt_from_string($datedue);
1503 # $issuedate defaults to today.
1504 if ( !defined $issuedate ) {
1505 $issuedate = dt_from_string();
1508 if ( ref $issuedate ne 'DateTime' ) {
1509 $issuedate = dt_from_string($issuedate);
1514 # Stop here if the patron or barcode doesn't exist
1515 if ( $borrower && $barcode && $barcodecheck ) {
1516 # find which item we issue
1517 my $item_object = Koha::Items->find({ barcode => $barcode })
1518 or return; # if we don't get an Item, abort.
1519 my $item_unblessed = $item_object->unblessed;
1521 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1523 # get actual issuing if there is one
1524 my $actualissue = $item_object->checkout;
1526 # check if we just renew the issue.
1527 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1528 and not $switch_onsite_checkout ) {
1529 $datedue = AddRenewal(
1530 $borrower->{'borrowernumber'},
1531 $item_object->itemnumber,
1534 $issuedate, # here interpreted as the renewal date
1539 my $itype = $item_object->effective_itemtype;
1540 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1544 # Check if we need to use an exact due date set by the ILL module
1545 if ( C4::Context->preference('ILLModule') ) {
1546 # Check if there is an ILL connected with the biblio of the item we are issuing
1547 my $ill_request = Koha::Illrequests->search({
1548 biblio_id => $item_object->biblionumber,
1549 borrowernumber => $borrower->{'borrowernumber'},
1551 due_date => { '!=', undef },
1554 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1555 my $ill_dt = dt_from_string( $ill_request->due_date );
1556 $ill_dt->set_hour(23);
1557 $ill_dt->set_minute(59);
1562 $datedue->truncate( to => 'minute' );
1564 my $patron = Koha::Patrons->find( $borrower );
1565 my $library = Koha::Libraries->find( $branchcode );
1566 my $fees = Koha::Charges::Fees->new(
1569 library => $library,
1570 item => $item_object,
1571 to_date => $datedue,
1575 # it's NOT a renewal
1576 if ( $actualissue and not $switch_onsite_checkout ) {
1577 # This book is currently on loan, but not to the person
1578 # who wants to borrow it now. mark it returned before issuing to the new borrower
1579 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1580 return unless $allowed;
1581 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1582 # AddReturn certainly has side-effects, like onloan => undef
1583 $item_object->discard_changes;
1586 if ( C4::Context->preference('UseRecalls') ) {
1587 Koha::Recalls->move_recall(
1589 action => $cancel_recall,
1590 recall_id => $recall_id,
1591 item => $item_object,
1592 borrowernumber => $borrower->{borrowernumber},
1597 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1599 # Starting process for transfer job (checking transfert and validate it if we have one)
1600 if ( my $transfer = $item_object->get_transfer ) {
1601 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1604 datearrived => dt_from_string,
1605 tobranch => C4::Context->userenv->{branch},
1606 comments => 'Forced branchtransfer'
1609 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1610 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1611 if ( $hold ) { # Is this really needed?
1612 $hold->set( { found => undef } )->store;
1613 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1618 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1619 unless ($auto_renew) {
1620 my $rule = Koha::CirculationRules->get_effective_rule_value(
1622 categorycode => $borrower->{categorycode},
1623 itemtype => $item_object->effective_itemtype,
1624 branchcode => $branchcode,
1625 rule_name => 'auto_renew'
1629 $auto_renew = $rule if defined $rule && $rule ne '';
1632 my $issue_attributes = {
1633 borrowernumber => $borrower->{'borrowernumber'},
1634 issuedate => $issuedate,
1635 date_due => $datedue,
1636 branchcode => C4::Context->userenv->{'branch'},
1637 onsite_checkout => $onsite_checkout,
1638 auto_renew => $auto_renew ? 1 : 0,
1641 # Get ID of logged in user. if called from a batch job,
1642 # no user session exists and C4::Context->userenv() returns
1643 # the scalar '0'. Only do this if the syspref says so
1644 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1645 my $userenv = C4::Context->userenv();
1646 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1648 $issue_attributes->{issuer_id} = $usernumber;
1652 # In the case that the borrower has an on-site checkout
1653 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1654 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1656 $issue->set($issue_attributes)->store;
1659 $issue = Koha::Checkout->new(
1661 itemnumber => $item_object->itemnumber,
1666 $issue->discard_changes;
1667 C4::Auth::track_login_daily( $borrower->{userid} );
1668 if ( $item_object->location && $item_object->location eq 'CART'
1669 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1670 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1671 CartToShelf( $item_object->itemnumber );
1674 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1675 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1678 # Record if item was lost
1679 my $was_lost = $item_object->itemlost;
1681 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1682 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1683 $item_object->itemlost(0);
1684 $item_object->onloan($datedue->ymd());
1685 $item_object->datelastborrowed( dt_from_string()->ymd() );
1686 $item_object->datelastseen( dt_from_string()->ymd() );
1687 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1689 # If the item was lost, it has now been found, charge the overdue if necessary
1691 if ( $item_object->{_charge} ) {
1692 $actualissue //= Koha::Old::Checkouts->search(
1693 { itemnumber => $item_unblessed->{itemnumber} },
1695 order_by => { '-desc' => 'returndate' },
1699 unless ( exists( $borrower->{branchcode} ) ) {
1700 my $patron = $actualissue->patron;
1701 $borrower = $patron->unblessed;
1703 _CalculateAndUpdateFine(
1705 issue => $actualissue,
1706 item => $item_unblessed,
1707 borrower => $borrower,
1708 return_date => $issuedate
1711 _FixOverduesOnReturn( $borrower->{borrowernumber},
1712 $item_object->itemnumber, undef, 'RENEWED' );
1716 # If it costs to borrow this book, charge it to the patron's account.
1717 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1718 if ( $charge && $charge > 0 ) {
1719 AddIssuingCharge( $issue, $charge, 'RENT' );
1722 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1723 if ( $itemtype_object ) {
1724 my $accumulate_charge = $fees->accumulate_rentalcharge();
1725 if ( $accumulate_charge > 0 ) {
1726 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1727 $charge += $accumulate_charge;
1728 $item_unblessed->{charge} = $charge;
1732 # Record the fact that this book was issued.
1733 C4::Stats::UpdateStats(
1735 branch => C4::Context->userenv->{'branch'},
1736 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1738 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1739 itemnumber => $item_object->itemnumber,
1740 itemtype => $item_object->effective_itemtype,
1741 location => $item_object->location,
1742 borrowernumber => $borrower->{'borrowernumber'},
1743 ccode => $item_object->ccode,
1747 # Send a checkout slip.
1748 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1750 branchcode => $branchcode,
1751 categorycode => $borrower->{categorycode},
1752 item_type => $item_object->effective_itemtype,
1753 notification => 'CHECKOUT',
1755 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1756 SendCirculationAlert(
1759 item => $item_object->unblessed,
1760 borrower => $borrower,
1761 branch => $branchcode,
1766 "CIRCULATION", "ISSUE",
1767 $borrower->{'borrowernumber'},
1768 $item_object->itemnumber,
1769 ) if C4::Context->preference("IssueLog");
1771 Koha::Plugins->call('after_circ_action', {
1772 action => 'checkout',
1774 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1775 checkout => $issue->get_from_storage
1779 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1781 biblio_ids => [ $item_object->biblionumber ]
1783 ) if C4::Context->preference('RealTimeHoldsQueue');
1789 =head2 GetLoanLength
1791 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1793 Get loan length for an itemtype, a borrower type and a branch
1798 my ( $categorycode, $itemtype, $branchcode ) = @_;
1800 # Initialize default values
1804 lengthunit => 'days',
1807 my $found = Koha::CirculationRules->get_effective_rules( {
1808 branchcode => $branchcode,
1809 categorycode => $categorycode,
1810 itemtype => $itemtype,
1819 foreach my $rule_name (keys %$found) {
1820 $rules->{$rule_name} = $found->{$rule_name};
1827 =head2 GetHardDueDate
1829 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1831 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1835 sub GetHardDueDate {
1836 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1838 my $rules = Koha::CirculationRules->get_effective_rules(
1840 categorycode => $borrowertype,
1841 itemtype => $itemtype,
1842 branchcode => $branchcode,
1843 rules => [ 'hardduedate', 'hardduedatecompare' ],
1847 if ( defined( $rules->{hardduedate} ) ) {
1848 if ( $rules->{hardduedate} ) {
1849 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1852 return ( undef, undef );
1857 =head2 GetBranchBorrowerCircRule
1859 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1861 Retrieves circulation rule attributes that apply to the given
1862 branch and patron category, regardless of item type.
1863 The return value is a hashref containing the following key:
1865 patron_maxissueqty - maximum number of loans that a
1866 patron of the given category can have at the given
1867 branch. If the value is undef, no limit.
1869 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1870 patron of the given category can have at the given
1871 branch. If the value is undef, no limit.
1873 This will check for different branch/category combinations in the following order:
1877 default branch and category
1879 If no rule has been found in the database, it will default to
1882 patron_maxissueqty - undef
1883 patron_maxonsiteissueqty - undef
1885 C<$branchcode> and C<$categorycode> should contain the
1886 literal branch code and patron category code, respectively - no
1891 sub GetBranchBorrowerCircRule {
1892 my ( $branchcode, $categorycode ) = @_;
1894 # Initialize default values
1896 patron_maxissueqty => undef,
1897 patron_maxonsiteissueqty => undef,
1901 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1902 my $rule = Koha::CirculationRules->get_effective_rule(
1904 categorycode => $categorycode,
1906 branchcode => $branchcode,
1907 rule_name => $rule_name,
1911 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1917 =head2 GetBranchItemRule
1919 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1921 Retrieves circulation rule attributes that apply to the given
1922 branch and item type, regardless of patron category.
1924 The return value is a hashref containing the following keys:
1926 holdallowed => Hold policy for this branch and itemtype. Possible values:
1927 not_allowed: No holds allowed.
1928 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1929 from_any_library: Holds allowed from any patron.
1930 from_local_hold_group: Holds allowed from libraries in hold group
1932 returnbranch => branch to which to return item. Possible values:
1933 noreturn: do not return, let item remain where checked in (floating collections)
1934 homebranch: return to item's home branch
1935 holdingbranch: return to issuer branch
1937 This searches branchitemrules in the following order:
1939 * Same branchcode and itemtype
1940 * Same branchcode, itemtype '*'
1941 * branchcode '*', same itemtype
1942 * branchcode and itemtype '*'
1944 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1948 sub GetBranchItemRule {
1949 my ( $branchcode, $itemtype ) = @_;
1952 my $rules = Koha::CirculationRules->get_effective_rules({
1953 branchcode => $branchcode,
1954 itemtype => $itemtype,
1955 rules => ['holdallowed', 'hold_fulfillment_policy', 'returnbranch']
1958 # built-in default circulation rule
1959 $rules->{holdallowed} //= 'from_any_library';
1960 $rules->{hold_fulfillment_policy} //= 'any';
1961 $rules->{returnbranch} //= 'homebranch';
1968 ($doreturn, $messages, $iteminformation, $borrower) =
1969 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1975 =item C<$barcode> is the bar code of the book being returned.
1977 =item C<$branch> is the code of the branch where the book is being returned.
1979 =item C<$exemptfine> indicates that overdue charges for the item will be
1982 =item C<$return_date> allows the default return date to be overridden
1983 by the given return date. Optional.
1987 C<&AddReturn> returns a list of four items:
1989 C<$doreturn> is true iff the return succeeded.
1991 C<$messages> is a reference-to-hash giving feedback on the operation.
1992 The keys of the hash are:
1998 No item with this barcode exists. The value is C<$barcode>.
2002 The book is not currently on loan. The value is C<$barcode>.
2006 This book has been withdrawn/cancelled. The value should be ignored.
2008 =item C<Wrongbranch>
2010 This book has was returned to the wrong branch. The value is a hashref
2011 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2012 contain the branchcode of the incorrect and correct return library, respectively.
2016 The item was reserved. The value is a reference-to-hash whose keys are
2017 fields from the reserves table of the Koha database, and
2018 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2019 either C<Waiting>, C<Reserved>, or 0.
2021 =item C<WasReturned>
2023 Value 1 if return is successful.
2025 =item C<NeedsTransfer>
2027 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2029 =item C<RecallFound>
2031 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2032 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2035 =item C<TransferredRecall>
2037 This item has been transferred to this branch to fill a recall. The recall object is returned.
2041 C<$iteminformation> is a reference-to-hash, giving information about the
2042 returned item from the issues table.
2044 C<$borrower> is a reference-to-hash, giving information about the
2045 patron who last borrowed the book.
2050 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2052 if ($branch and not Koha::Libraries->find($branch)) {
2053 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2056 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2057 my $return_date_specified = !!$return_date;
2058 $return_date //= dt_from_string();
2062 my $validTransfer = 1;
2063 my $stat_type = 'return';
2065 # get information on item
2066 my $item = Koha::Items->find({ barcode => $barcode });
2068 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2071 my $itemnumber = $item->itemnumber;
2072 my $itemtype = $item->effective_itemtype;
2074 my $issue = $item->checkout;
2076 $patron = $issue->patron
2077 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2078 . Dumper($issue->unblessed) . "\n";
2080 $messages->{'NotIssued'} = $barcode;
2081 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2083 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2085 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2086 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2087 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2088 $messages->{'LocalUse'} = 1;
2089 $stat_type = 'localuse';
2093 # full item data, but no borrowernumber or checkout info (no issue)
2094 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2095 # get the proper branch to which to return the item
2096 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2097 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2098 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2100 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2101 my $patron_unblessed = $patron ? $patron->unblessed : {};
2103 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2104 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2105 if ($update_loc_rules) {
2106 if (defined $update_loc_rules->{_ALL_}) {
2107 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2108 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2110 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2111 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2113 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2114 $item->location($update_loc_rules->{_ALL_})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2118 foreach my $key ( keys %$update_loc_rules ) {
2119 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2120 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2121 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2122 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2123 $item->location($update_loc_rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2130 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2132 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2134 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2136 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2139 foreach my $key ( keys %$rules ) {
2140 if ( $item->notforloan eq $key ) {
2141 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2142 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2149 # check if the return is allowed at this branch
2150 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2151 unless ($returnallowed){
2152 $messages->{'Wrongbranch'} = {
2153 Wrongbranch => $branch,
2154 Rightbranch => $message
2157 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2158 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2159 return ( $doreturn, $messages, $issue, $patron_unblessed);
2162 if ( $item->withdrawn ) { # book has been cancelled
2163 $messages->{'withdrawn'} = 1;
2164 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2167 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2171 # case of a return of document (deal with issues and holdingbranch)
2173 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2174 $patron or warn "AddReturn without current borrower";
2178 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2183 C4::Context->preference('CalculateFinesOnReturn')
2184 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2189 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2192 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 );
2194 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2195 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2197 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2200 # FIXME is the "= 1" right? This could be the borrower hash.
2201 $messages->{'WasReturned'} = 1;
2204 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2208 # the holdingbranch is updated if the document is returned to another location.
2209 # this is always done regardless of whether the item was on loan or not
2210 if ($item->holdingbranch ne $branch) {
2211 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2214 my $item_was_lost = $item->itemlost;
2215 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2216 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2218 # fix up the accounts.....
2219 if ($item_was_lost) {
2220 $messages->{'WasLost'} = 1;
2221 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2222 my @object_messages = @{ $updated_item->object_messages };
2223 for my $message (@object_messages) {
2224 $messages->{'LostItemFeeRefunded'} = 1
2225 if $message->message eq 'lost_refunded';
2226 $messages->{'LostItemFeeRestored'} = 1
2227 if $message->message eq 'lost_restored';
2229 if ( $message->message eq 'lost_charge' ) {
2230 $issue //= Koha::Old::Checkouts->search(
2231 { itemnumber => $item->itemnumber },
2232 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2234 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2235 my $patron = $issue->patron;
2236 $patron_unblessed = $patron->unblessed;
2238 _CalculateAndUpdateFine(
2241 item => $item->unblessed,
2242 borrower => $patron_unblessed,
2243 return_date => $return_date
2246 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2247 $item->itemnumber, undef, 'RETURNED' );
2248 $messages->{'LostItemFeeCharged'} = 1;
2254 # check if we have a transfer for this document
2255 my $transfer = $item->get_transfer;
2257 # if we have a transfer to complete, we update the line of transfers with the datearrived
2260 if ( $transfer->in_transit ) {
2261 if ( $transfer->tobranch eq $branch ) {
2263 $messages->{'TransferArrived'} = $transfer->frombranch;
2264 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2265 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2268 $messages->{'WrongTransfer'} = $transfer->tobranch;
2269 $messages->{'WrongTransferItem'} = $item->itemnumber;
2270 $messages->{'TransferTrigger'} = $transfer->reason;
2274 if ( $transfer->tobranch eq $branch ) {
2276 $messages->{'TransferArrived'} = $transfer->frombranch;
2277 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2278 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2281 $messages->{'WasTransfered'} = $transfer->tobranch;
2282 $messages->{'TransferTrigger'} = $transfer->reason;
2287 # fix up the overdues in accounts...
2288 if ($borrowernumber) {
2289 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2290 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2292 if ( $issue and $issue->is_overdue($return_date) ) {
2294 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2296 $messages->{'PrevDebarred'} = $debardate;
2298 $messages->{'Debarred'} = $debardate if $debardate;
2300 # there's no overdue on the item but borrower had been previously debarred
2301 } elsif ( $issue->date_due and $patron->debarred ) {
2302 if ( $patron->debarred eq "9999-12-31") {
2303 $messages->{'ForeverDebarred'} = $patron->debarred;
2305 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2306 $borrower_debar_dt->truncate(to => 'day');
2307 my $today_dt = $return_date->clone()->truncate(to => 'day');
2308 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2309 $messages->{'PrevDebarred'} = $patron->debarred;
2316 if ( C4::Context->preference('UseRecalls') ) {
2317 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2319 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2320 if ( defined $recall ) {
2321 $messages->{RecallFound} = $recall;
2322 if ( $recall->pickup_library_id ne $branch ) {
2323 $messages->{RecallNeedsTransfer} = $branch;
2328 # find reserves.....
2329 # launch the Checkreserves routine to find any holds
2330 my ($resfound, $resrec);
2331 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2332 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2333 # 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)
2334 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2335 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2336 $resfound = 'Reserved';
2337 $resrec = $hold->unblessed;
2340 $resrec->{'ResFound'} = $resfound;
2341 $messages->{'ResFound'} = $resrec;
2344 # Record the fact that this book was returned.
2345 C4::Stats::UpdateStats({
2348 itemnumber => $itemnumber,
2349 itemtype => $itemtype,
2350 location => $item->location,
2351 borrowernumber => $borrowernumber,
2352 ccode => $item->ccode,
2355 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2357 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2359 branchcode => $branch,
2360 categorycode => $patron->categorycode,
2361 item_type => $itemtype,
2362 notification => 'CHECKIN',
2364 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2365 SendCirculationAlert({
2367 item => $item->unblessed,
2368 borrower => $patron->unblessed,
2374 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2375 if C4::Context->preference("ReturnLog");
2378 # Check if this item belongs to a biblio record that is attached to an
2379 # ILL request, if it is we need to update the ILL request's status
2380 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2381 my $request = Koha::Illrequests->find(
2382 { biblio_id => $item->biblio->biblionumber }
2384 $request->status('RET') if $request;
2387 if ( C4::Context->preference('UseRecalls') ) {
2388 # all recalls that have triggered a transfer will have an allocated itemnumber
2389 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2390 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2391 $messages->{TransferredRecall} = $transfer_recall;
2395 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2396 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2397 && ( $doreturn or $messages->{'NotIssued'} )
2399 and ( $branch ne $returnbranch )
2400 and not $messages->{'WrongTransfer'}
2401 and not $messages->{'WasTransfered'}
2402 and not $messages->{TransferredRecall}
2403 and not $messages->{RecallNeedsTransfer} )
2405 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2406 if (C4::Context->preference("AutomaticItemReturn" ) or
2407 (C4::Context->preference("UseBranchTransferLimits") and
2408 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2410 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2411 $messages->{'WasTransfered'} = $returnbranch;
2412 $messages->{'TransferTrigger'} = $transfer_trigger;
2414 $messages->{'NeedsTransfer'} = $returnbranch;
2415 $messages->{'TransferTrigger'} = $transfer_trigger;
2419 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2420 my $claims = Koha::Checkouts::ReturnClaims->search(
2422 itemnumber => $item->id,
2423 resolution => undef,
2427 if ( $claims->count ) {
2428 $messages->{ReturnClaims} = $claims;
2432 # Check for bundle status
2433 if ( $item->in_bundle ) {
2434 my $host = $item->bundle_host;
2435 $messages->{InBundle} = $host;
2438 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2439 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2441 if ( $doreturn and $issue ) {
2442 my $checkin = Koha::Old::Checkouts->find($issue->id);
2444 Koha::Plugins->call('after_circ_action', {
2445 action => 'checkin',
2451 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2453 biblio_ids => [ $item->biblionumber ]
2455 ) if C4::Context->preference('RealTimeHoldsQueue');
2458 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2461 =head2 MarkIssueReturned
2463 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2465 Unconditionally marks an issue as being returned by
2466 moving the C<issues> row to C<old_issues> and
2467 setting C<returndate> to the current date.
2469 if C<$returndate> is specified (in iso format), it is used as the date
2472 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2473 the old_issue is immediately anonymised
2475 Ideally, this function would be internal to C<C4::Circulation>,
2476 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2477 and offline_circ/process_koc.pl.
2479 The last optional parameter allos passing skip_record_index to the item store call.
2483 sub MarkIssueReturned {
2484 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2486 # Retrieve the issue
2487 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2489 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2491 my $issue_id = $issue->issue_id;
2493 my $schema = Koha::Database->schema;
2495 # FIXME Improve the return value and handle it from callers
2496 $schema->txn_do(sub {
2498 my $patron = Koha::Patrons->find( $borrowernumber );
2500 # Update the returndate value
2501 if ( $returndate ) {
2502 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2505 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2508 # Create the old_issues entry
2509 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2511 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2512 if ( $privacy && $privacy == 2) {
2513 $old_checkout->anonymize;
2516 # And finally delete the issue
2519 $issue->item->onloan(undef)->store(
2521 skip_record_index => $params->{skip_record_index},
2522 skip_holds_queue => $params->{skip_holds_queue}
2526 if ( C4::Context->preference('StoreLastBorrower') ) {
2527 my $item = Koha::Items->find( $itemnumber );
2528 $item->last_returned_by( $patron );
2531 # Remove any OVERDUES related debarment if the borrower has no overdues
2532 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2533 && $patron->debarred
2534 && !$patron->has_overdues
2535 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2537 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2545 =head2 _debar_user_on_return
2547 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2549 C<$borrower> borrower hashref
2551 C<$item> item hashref
2553 C<$datedue> date due DateTime object
2555 C<$returndate> DateTime object representing the return time
2557 Internal function, called only by AddReturn that calculates and updates
2558 the user fine days, and debars them if necessary.
2560 Should only be called for overdue returns
2562 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2567 sub _calculate_new_debar_dt {
2568 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2570 my $branchcode = _GetCircControlBranch( $item, $borrower );
2571 my $circcontrol = C4::Context->preference('CircControl');
2572 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2573 { categorycode => $borrower->{categorycode},
2574 itemtype => $item->{itype},
2575 branchcode => $branchcode,
2580 'maxsuspensiondays',
2581 'suspension_chargeperiod',
2585 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2586 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2587 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2589 return unless $finedays;
2591 # finedays is in days, so hourly loans must multiply by 24
2592 # thus 1 hour late equals 1 day suspension * finedays rate
2593 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2595 # grace period is measured in the same units as the loan
2597 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2599 my $deltadays = DateTime::Duration->new(
2600 days => $chargeable_units
2603 if ( $deltadays->subtract($grace)->is_positive() ) {
2604 my $suspension_days = $deltadays * $finedays;
2606 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2607 # No need to / 1 and do not consider / 0
2608 $suspension_days = DateTime::Duration->new(
2609 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2613 # If the max suspension days is < than the suspension days
2614 # the suspension days is limited to this maximum period.
2615 my $max_sd = $issuing_rule->{maxsuspensiondays};
2616 if ( defined $max_sd && $max_sd ne '' ) {
2617 $max_sd = DateTime::Duration->new( days => $max_sd );
2618 $suspension_days = $max_sd
2619 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2622 my ( $has_been_extended );
2623 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2624 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2626 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2627 $has_been_extended = 1;
2632 # Use the calendar or not to calculate the debarment date
2633 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2634 my $calendar = Koha::Calendar->new(
2635 branchcode => $branchcode,
2636 days_mode => 'Calendar'
2638 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2641 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2643 return $new_debar_dt;
2648 sub _debar_user_on_return {
2649 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2651 $return_date //= dt_from_string();
2653 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2655 return unless $new_debar_dt;
2657 Koha::Patron::Debarments::AddUniqueDebarment({
2658 borrowernumber => $borrower->{borrowernumber},
2659 expiration => $new_debar_dt->ymd(),
2660 type => 'SUSPENSION',
2662 # if borrower was already debarred but does not get an extra debarment
2663 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2664 my ($new_debarment_str, $is_a_reminder);
2665 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2667 $new_debarment_str = $borrower->{debarred};
2669 $new_debarment_str = $new_debar_dt->ymd();
2671 # FIXME Should return a DateTime object
2672 return $new_debarment_str, $is_a_reminder;
2675 =head2 _FixOverduesOnReturn
2677 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2679 C<$borrowernumber> borrowernumber
2681 C<$itemnumber> itemnumber
2683 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2685 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2691 sub _FixOverduesOnReturn {
2692 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2693 unless( $borrowernumber ) {
2694 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2698 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2702 warn "_FixOverduesOnReturn() not supplied valid status";
2706 my $schema = Koha::Database->schema;
2708 my $result = $schema->txn_do(
2710 # check for overdue fine
2711 my $accountlines = Koha::Account::Lines->search(
2713 borrowernumber => $borrowernumber,
2714 itemnumber => $item,
2715 debit_type_code => 'OVERDUE',
2716 status => 'UNRETURNED'
2719 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2721 my $accountline = $accountlines->next;
2722 my $payments = $accountline->credits;
2724 my $amountoutstanding = $accountline->amountoutstanding;
2725 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2726 $accountline->delete;
2727 return 0; # no warning, we've just removed a zero value fine (backdated return)
2728 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2729 my $account = Koha::Account->new({patron_id => $borrowernumber});
2730 my $credit = $account->add_credit(
2732 amount => $amountoutstanding,
2733 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2734 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2735 interface => C4::Context->interface,
2741 $credit->apply({ debits => [ $accountline ] });
2743 if (C4::Context->preference("FinesLog")) {
2744 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2748 $accountline->status($status);
2749 return $accountline->store();
2756 =head2 _GetCircControlBranch
2758 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2762 Return the library code to be used to determine which circulation
2763 policy applies to a transaction. Looks up the CircControl and
2764 HomeOrHoldingBranch system preferences.
2766 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2768 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2772 sub _GetCircControlBranch {
2773 my ($item, $borrower) = @_;
2774 my $circcontrol = C4::Context->preference('CircControl');
2777 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2778 $branch= C4::Context->userenv->{'branch'};
2779 } elsif ($circcontrol eq 'PatronLibrary') {
2780 $branch=$borrower->{branchcode};
2782 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2783 $branch = $item->{$branchfield};
2784 # default to item home branch if holdingbranch is used
2785 # and is not defined
2786 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2787 $branch = $item->{homebranch};
2795 $issue = GetOpenIssue( $itemnumber );
2797 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2799 C<$itemnumber> is the item's itemnumber
2806 my ( $itemnumber ) = @_;
2807 return unless $itemnumber;
2808 my $dbh = C4::Context->dbh;
2809 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2810 $sth->execute( $itemnumber );
2811 return $sth->fetchrow_hashref();
2815 =head2 GetUpcomingDueIssues
2817 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2821 sub GetUpcomingDueIssues {
2824 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2825 my $dbh = C4::Context->dbh;
2828 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2830 LEFT JOIN items USING (itemnumber)
2831 LEFT JOIN branches ON branches.branchcode =
2833 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2834 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2835 my @bind_parameters = ( $params->{'days_in_advance'} );
2837 my $sth = $dbh->prepare( $statement );
2838 $sth->execute( @bind_parameters );
2839 my $upcoming_dues = $sth->fetchall_arrayref({});
2841 return $upcoming_dues;
2844 =head2 CanBookBeRenewed
2846 ($ok,$error,$info) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2848 Find out whether a borrowed item may be renewed.
2850 C<$borrowernumber> is the borrower number of the patron who currently
2851 has the item on loan.
2853 C<$itemnumber> is the number of the item to renew.
2855 C<$override_limit>, if supplied with a true value, causes
2856 the limit on the number of times that the loan can be renewed
2857 (as controlled by the item type) to be ignored. Overriding also allows
2858 to renew sooner than "No renewal before" and to manually renew loans
2859 that are automatically renewed.
2861 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2862 item must currently be on loan to the specified borrower; renewals
2863 must be allowed for the item's type; and the borrower must not have
2864 already renewed the loan.
2865 $error will contain the reason the renewal can not proceed
2866 $info will contain a hash of additional info
2867 currently 'soonest_renew_date' if error is 'too soon'
2871 sub CanBookBeRenewed {
2872 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2874 my $auto_renew = "no";
2877 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2878 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2879 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2880 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2882 my $patron = $issue->patron or return;
2884 # override_limit will override anything else except on_reserve
2885 unless ( $override_limit ){
2886 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2887 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2889 categorycode => $patron->categorycode,
2890 itemtype => $item->effective_itemtype,
2891 branchcode => $branchcode,
2895 'unseen_renewals_allowed'
2900 return ( 0, "too_many" )
2901 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2903 return ( 0, "too_unseen" )
2904 if C4::Context->preference('UnseenRenewals') &&
2905 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2906 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2908 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2909 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2910 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2911 my $restricted = $patron->is_debarred;
2912 my $hasoverdues = $patron->has_overdues;
2914 if ( $restricted and $restrictionblockrenewing ) {
2915 return ( 0, 'restriction');
2916 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2917 return ( 0, 'overdue');
2920 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2923 branchcode => $branchcode,
2926 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2927 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2928 # extra notices being sent. Cron also implies no override
2929 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2930 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2931 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2934 if ( C4::Context->preference('UseRecalls') ) {
2936 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2937 if ( defined $recall ) {
2938 if ( $recall->item_level ) {
2939 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2940 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
2942 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2943 return ( 0, 'recalled' ) unless ( $recall->waiting );
2948 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') && !Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count()
2951 my $biblio = Koha::Biblios->find($item->biblionumber);
2952 my @possible_holds = $biblio->current_holds->unfilled->search(
2953 {non_priority => 0},
2954 { prefetch => 'patron' }
2957 # Get all other items that could possibly fill reserves
2958 # FIXME We could join reserves (or more tables) here to eliminate some checks later
2959 my @other_items = Koha::Items->search({
2960 biblionumber => $biblio->biblionumber,
2963 -not => { itemnumber => $itemnumber } })->as_list;
2965 return ( 0, "on_reserve" ) if scalar @other_items < scalar @possible_holds;
2968 foreach my $possible_hold (@possible_holds) {
2970 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
2971 my $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron_with_reserve });
2973 # FIXME: We are not checking whether the item we are renewing can fill the hold
2975 foreach my $other_item (@other_items) {
2976 next if defined $matched_items{$other_item->itemnumber};
2977 next if IsItemOnHoldAndFound( $other_item->itemnumber );
2978 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef, $items_any_available);
2979 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2980 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
2981 # CanItemBeReserved checks 'rules' and 'policies' which means
2982 # items will fill holds at checkin that are rejected here
2984 $matched_items{$other_item->itemnumber} = 1;
2987 return ( 0, "on_reserve" ) unless $fillable;
2991 my ($status, $matched_reserve, $possible_reserves) = CheckReserves($itemnumber);
2992 return ( 0, "on_reserve" ) if $matched_reserve;
2995 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2996 $soonest = GetSoonestRenewDate($borrowernumber, $itemnumber);
2997 if ( $soonest > dt_from_string() ){
2998 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3001 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3003 return ( 1, undef );
3008 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
3012 C<$borrowernumber> is the borrower number of the patron who currently
3015 C<$itemnumber> is the number of the item to renew.
3017 C<$branch> is the library where the renewal took place (if any).
3018 The library that controls the circ policies for the renewal is retrieved from the issues record.
3020 C<$datedue> can be a DateTime object used to set the due date.
3022 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3023 this parameter is not supplied, lastreneweddate is set to the current date.
3025 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3026 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3027 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3030 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3031 from the book's item type.
3033 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3034 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3035 fallback to a true value
3040 my $borrowernumber = shift;
3041 my $itemnumber = shift or return;
3043 my $datedue = shift;
3044 my $lastreneweddate = shift || dt_from_string();
3045 my $skipfinecalc = shift;
3048 # Fallback on a 'seen' renewal
3049 $seen = defined $seen && $seen == 0 ? 0 : 1;
3051 my $item_object = Koha::Items->find($itemnumber) or return;
3052 my $biblio = $item_object->biblio;
3053 my $issue = $item_object->checkout;
3054 my $item_unblessed = $item_object->unblessed;
3056 my $dbh = C4::Context->dbh;
3058 return unless $issue;
3060 $borrowernumber ||= $issue->borrowernumber;
3062 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3063 $datedue = dt_from_string($datedue, 'sql');
3066 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3067 my $patron_unblessed = $patron->unblessed;
3069 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3071 my $schema = Koha::Database->schema;
3072 $schema->txn_do(sub{
3074 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3075 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3077 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3079 # If the due date wasn't specified, calculate it by adding the
3080 # book's loan length to today's date or the current due date
3081 # based on the value of the RenewalPeriodBase syspref.
3082 my $itemtype = $item_object->effective_itemtype;
3085 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3086 dt_from_string( $issue->date_due, 'sql' ) :
3088 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3091 my $fees = Koha::Charges::Fees->new(
3094 library => $circ_library,
3095 item => $item_object,
3096 from_date => dt_from_string( $issue->date_due, 'sql' ),
3097 to_date => dt_from_string($datedue),
3101 # Increment the unseen renewals, if appropriate
3102 # We only do so if the syspref is enabled and
3103 # a maximum value has been set in the circ rules
3104 my $unseen_renewals = $issue->unseen_renewals;
3105 if (C4::Context->preference('UnseenRenewals')) {
3106 my $rule = Koha::CirculationRules->get_effective_rule(
3107 { categorycode => $patron->categorycode,
3108 itemtype => $item_object->effective_itemtype,
3109 branchcode => $circ_library->branchcode,
3110 rule_name => 'unseen_renewals_allowed'
3113 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3116 # If the renewal is seen, unseen should revert to 0
3117 $unseen_renewals = 0;
3121 # Update the issues record to have the new due date, and a new count
3122 # of how many times it has been renewed.
3123 my $renews = ( $issue->renewals_count || 0 ) + 1;
3124 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3127 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3130 Koha::Exceptions::Checkout::FailedRenewal->throw(
3131 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3135 # Update the renewal count on the item, and tell zebra to reindex
3136 $renews = ( $item_object->renewals || 0 ) + 1;
3137 $item_object->renewals($renews);
3138 $item_object->onloan($datedue);
3139 $item_object->store({ log_action => 0 });
3141 # Charge a new rental fee, if applicable
3142 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3143 if ( $charge > 0 ) {
3144 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3147 # Charge a new accumulate rental fee, if applicable
3148 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3149 if ( $itemtype_object ) {
3150 my $accumulate_charge = $fees->accumulate_rentalcharge();
3151 if ( $accumulate_charge > 0 ) {
3152 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3154 $charge += $accumulate_charge;
3157 # Send a renewal slip according to checkout alert preferencei
3158 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3159 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3161 branchcode => $branch,
3162 categorycode => $patron->categorycode,
3163 item_type => $itemtype,
3164 notification => 'CHECKOUT',
3166 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3167 SendCirculationAlert(
3170 item => $item_unblessed,
3171 borrower => $patron->unblessed,
3178 # Remove any OVERDUES related debarment if the borrower has no overdues
3180 && $patron->is_debarred
3181 && ! $patron->has_overdues
3182 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3184 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3187 # Add renewal record
3188 my $renewal = Koha::Checkouts::Renewal->new(
3190 checkout_id => $issue->issue_id,
3191 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3193 interface => C4::Context->interface
3197 # Add the renewal to stats
3198 C4::Stats::UpdateStats(
3200 branch => $item_object->renewal_branchcode({branch => $branch}),
3203 itemnumber => $itemnumber,
3204 itemtype => $itemtype,
3205 location => $item_object->location,
3206 borrowernumber => $borrowernumber,
3207 ccode => $item_object->ccode,
3212 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3214 Koha::Plugins->call('after_circ_action', {
3215 action => 'renewal',
3217 checkout => $issue->get_from_storage
3226 # check renewal status
3227 my ( $bornum, $itemno ) = @_;
3228 my $dbh = C4::Context->dbh;
3230 my $unseencount = 0;
3231 my $renewsallowed = 0;
3232 my $unseenallowed = 0;
3236 my $patron = Koha::Patrons->find( $bornum );
3237 my $item = Koha::Items->find($itemno);
3239 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3241 # Look in the issues table for this item, lent to this borrower,
3242 # and not yet returned.
3244 # FIXME - I think this function could be redone to use only one SQL call.
3245 my $sth = $dbh->prepare(
3246 "select * from issues
3247 where (borrowernumber = ?)
3248 and (itemnumber = ?)"
3250 $sth->execute( $bornum, $itemno );
3251 my $data = $sth->fetchrow_hashref;
3252 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3253 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3254 # $item and $borrower should be calculated
3255 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3257 my $rules = Koha::CirculationRules->get_effective_rules(
3259 categorycode => $patron->categorycode,
3260 itemtype => $item->effective_itemtype,
3261 branchcode => $branchcode,
3262 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3265 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3266 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3267 $rules->{unseen_renewals_allowed} :
3269 $renewsleft = $renewsallowed - $renewcount;
3270 $unseenleft = $unseenallowed - $unseencount;
3271 if($renewsleft < 0){ $renewsleft = 0; }
3272 if($unseenleft < 0){ $unseenleft = 0; }
3283 =head2 GetSoonestRenewDate
3285 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3287 Find out the soonest possible renew date of a borrowed item.
3289 C<$borrowernumber> is the borrower number of the patron who currently
3290 has the item on loan.
3292 C<$itemnumber> is the number of the item to renew.
3294 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3295 renew date, based on the value "No renewal before" of the applicable
3296 issuing rule. Returns the current date if the item can already be
3297 renewed, and returns undefined if the borrower, loan, or item
3302 sub GetSoonestRenewDate {
3303 my ( $borrowernumber, $itemnumber ) = @_;
3305 my $dbh = C4::Context->dbh;
3307 my $item = Koha::Items->find($itemnumber) or return;
3308 my $itemissue = $item->checkout or return;
3310 $borrowernumber ||= $itemissue->borrowernumber;
3311 my $patron = Koha::Patrons->find( $borrowernumber )
3314 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3315 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3316 { categorycode => $patron->categorycode,
3317 itemtype => $item->effective_itemtype,
3318 branchcode => $branchcode,
3326 my $now = dt_from_string;
3328 if ( defined $issuing_rule->{norenewalbefore}
3329 and $issuing_rule->{norenewalbefore} ne "" )
3331 my $soonestrenewal =
3332 dt_from_string( $itemissue->date_due )->subtract(
3333 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3335 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3336 and $issuing_rule->{lengthunit} eq 'days' )
3338 $soonestrenewal->truncate( to => 'day' );
3340 return $soonestrenewal if $now < $soonestrenewal;
3341 } elsif ( $itemissue->auto_renew && $patron->autorenew_checkouts ) {
3342 # Checkouts with auto-renewing fall back to due date
3343 my $soonestrenewal = dt_from_string( $itemissue->date_due );
3344 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3345 and $issuing_rule->{lengthunit} eq 'days' )
3347 $soonestrenewal->truncate( to => 'day' );
3349 return $soonestrenewal;
3354 =head2 GetLatestAutoRenewDate
3356 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3358 Find out the latest possible auto renew date of a borrowed item.
3360 C<$borrowernumber> is the borrower number of the patron who currently
3361 has the item on loan.
3363 C<$itemnumber> is the number of the item to renew.
3365 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3366 auto renew date, based on the value "No auto renewal after" and the "No auto
3367 renewal after (hard limit) of the applicable issuing rule.
3368 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3369 or item cannot be found.
3373 sub GetLatestAutoRenewDate {
3374 my ( $borrowernumber, $itemnumber ) = @_;
3376 my $dbh = C4::Context->dbh;
3378 my $item = Koha::Items->find($itemnumber) or return;
3379 my $itemissue = $item->checkout or return;
3381 $borrowernumber ||= $itemissue->borrowernumber;
3382 my $patron = Koha::Patrons->find( $borrowernumber )
3385 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3386 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3388 categorycode => $patron->categorycode,
3389 itemtype => $item->effective_itemtype,
3390 branchcode => $branchcode,
3392 'no_auto_renewal_after',
3393 'no_auto_renewal_after_hard_limit',
3399 return unless $circulation_rules;
3401 if ( not $circulation_rules->{no_auto_renewal_after}
3402 or $circulation_rules->{no_auto_renewal_after} eq '' )
3403 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3404 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3406 my $maximum_renewal_date;
3407 if ( $circulation_rules->{no_auto_renewal_after} ) {
3408 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3409 $maximum_renewal_date->add(
3410 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3414 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3415 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3416 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3418 return $maximum_renewal_date;
3422 =head2 GetIssuingCharges
3424 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3426 Calculate how much it would cost for a given patron to borrow a given
3427 item, including any applicable discounts.
3429 C<$itemnumber> is the item number of item the patron wishes to borrow.
3431 C<$borrowernumber> is the patron's borrower number.
3433 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3434 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3439 sub GetIssuingCharges {
3441 # calculate charges due
3442 my ( $itemnumber, $borrowernumber ) = @_;
3444 my $dbh = C4::Context->dbh;
3447 # Get the book's item type and rental charge (via its biblioitem).
3448 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3449 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3450 $charge_query .= (C4::Context->preference('item-level_itypes'))
3451 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3452 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3454 $charge_query .= ' WHERE items.itemnumber =?';
3456 my $sth = $dbh->prepare($charge_query);
3457 $sth->execute($itemnumber);
3458 if ( my $item_data = $sth->fetchrow_hashref ) {
3459 $item_type = $item_data->{itemtype};
3460 $charge = $item_data->{rentalcharge};
3462 # FIXME This should follow CircControl
3463 my $branch = C4::Context::mybranch();
3464 my $patron = Koha::Patrons->find( $borrowernumber );
3465 my $discount = Koha::CirculationRules->get_effective_rule({
3466 categorycode => $patron->categorycode,
3467 branchcode => $branch,
3468 itemtype => $item_type,
3469 rule_name => 'rentaldiscount'
3472 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3474 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3478 return ( $charge, $item_type );
3481 =head2 AddIssuingCharge
3483 &AddIssuingCharge( $checkout, $charge, $type )
3487 sub AddIssuingCharge {
3488 my ( $checkout, $charge, $type ) = @_;
3490 # FIXME What if checkout does not exist?
3492 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3493 my $accountline = $account->add_debit(
3497 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3498 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3499 interface => C4::Context->interface,
3501 item_id => $checkout->itemnumber,
3502 issue_id => $checkout->issue_id,
3507 =head2 GetTransfersFromTo
3509 @results = GetTransfersFromTo($frombranch,$tobranch);
3511 Returns the list of pending transfers between $from and $to branch
3515 sub GetTransfersFromTo {
3516 my ( $frombranch, $tobranch ) = @_;
3517 return unless ( $frombranch && $tobranch );
3518 my $dbh = C4::Context->dbh;
3520 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3521 FROM branchtransfers
3524 AND datecancelled IS NULL
3525 AND datesent IS NOT NULL
3526 AND datearrived IS NULL
3528 my $sth = $dbh->prepare($query);
3529 $sth->execute( $frombranch, $tobranch );
3532 while ( my $data = $sth->fetchrow_hashref ) {
3533 push @gettransfers, $data;
3535 return (@gettransfers);
3538 =head2 SendCirculationAlert
3540 Send out a C<check-in> or C<checkout> alert using the messaging system.
3548 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3552 Hashref of information about the item being checked in or out.
3556 Hashref of information about the borrower of the item.
3560 The branchcode from where the checkout or check-in took place.
3566 SendCirculationAlert({
3569 borrower => $borrower,
3575 sub SendCirculationAlert {
3577 my ($type, $item, $borrower, $branch, $issue) =
3578 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3579 my %message_name = (
3580 CHECKIN => 'Item_Check_in',
3581 CHECKOUT => 'Item_Checkout',
3582 RENEWAL => 'Item_Checkout',
3584 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3585 borrowernumber => $borrower->{borrowernumber},
3586 message_name => $message_name{$type},
3591 items => $item->{itemnumber},
3592 biblio => $item->{biblionumber},
3593 biblioitems => $item->{biblionumber},
3594 borrowers => $borrower,
3595 branches => $branch,
3598 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3599 # See C4::Letters:: _parseletter_sth
3600 if( $type eq 'CHECKIN' ){
3601 $tables->{old_issues} = $issue->issue_id;
3603 $tables->{issues} = $item->{itemnumber};
3606 my $schema = Koha::Database->new->schema;
3607 my @transports = keys %{ $borrower_preferences->{transports} };
3609 # From the MySQL doc:
3610 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3611 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3612 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3613 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3615 for my $mtt (@transports) {
3616 my $letter = C4::Letters::GetPreparedLetter (
3617 module => 'circulation',
3618 letter_code => $type,
3619 branchcode => $branch,
3620 message_transport_type => $mtt,
3621 lang => $borrower->{lang},
3625 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3626 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3627 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3628 unless ( $message ) {
3629 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3630 C4::Message->enqueue($letter, $borrower, $mtt);
3632 $message->append($letter);
3635 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3641 =head2 updateWrongTransfer
3643 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3645 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
3649 sub updateWrongTransfer {
3650 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3652 # first step: cancel the original transfer
3653 my $item = Koha::Items->find($itemNumber);
3654 my $transfer = $item->get_transfer;
3655 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3657 # second step: create a new transfer to the right location
3658 my $new_transfer = $item->request_transfer(
3660 to => $transfer->to_library,
3661 reason => $transfer->reason,
3662 comment => $transfer->comments,
3668 return $new_transfer;
3673 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3675 this function calculates the due date given the start date and configured circulation rules,
3676 checking against the holidays calendar as per the daysmode circulation rule.
3677 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3678 C<$itemtype> = itemtype code of item in question
3679 C<$branch> = location whose calendar to use
3680 C<$borrower> = Borrower object
3681 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3686 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3690 # loanlength now a href
3692 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3694 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3700 if (ref $startdate ne 'DateTime' ) {
3701 $datedue = dt_from_string($datedue);
3703 $datedue = $startdate->clone;
3706 $datedue = dt_from_string()->truncate( to => 'minute' );
3710 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3712 categorycode => $borrower->{categorycode},
3713 itemtype => $itemtype,
3714 branchcode => $branch,
3718 # calculate the datedue as normal
3719 if ( $daysmode eq 'Days' )
3720 { # ignoring calendar
3721 if ( $loanlength->{lengthunit} eq 'hours' ) {
3722 $datedue->add( hours => $loanlength->{$length_key} );
3724 $datedue->add( days => $loanlength->{$length_key} );
3725 $datedue->set_hour(23);
3726 $datedue->set_minute(59);
3730 if ($loanlength->{lengthunit} eq 'hours') {
3731 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3734 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3736 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3737 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3738 if ($loanlength->{lengthunit} eq 'days') {
3739 $datedue->set_hour(23);
3740 $datedue->set_minute(59);
3744 # if Hard Due Dates are used, retrieve them and apply as necessary
3745 my ( $hardduedate, $hardduedatecompare ) =
3746 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3747 if ($hardduedate) { # hardduedates are currently dates
3748 $hardduedate->truncate( to => 'minute' );
3749 $hardduedate->set_hour(23);
3750 $hardduedate->set_minute(59);
3751 my $cmp = DateTime->compare( $hardduedate, $datedue );
3753 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3754 # if the calculated date is before the 'after' Hard Due Date (floor), override
3755 # if the hard due date is set to 'exactly', overrride
3756 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3757 $datedue = $hardduedate->clone;
3760 # in all other cases, keep the date due as it is
3764 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3765 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3766 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3767 if( $expiry_dt ) { #skip empty expiry date..
3768 $expiry_dt->set( hour => 23, minute => 59);
3769 my $d1= $datedue->clone->set_time_zone('floating');
3770 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3771 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3774 if ( $daysmode ne 'Days' ) {
3775 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3776 if ( $calendar->is_holiday($datedue) ) {
3777 # Don't return on a closed day
3778 $datedue = $calendar->prev_open_days( $datedue, 1 );
3787 sub CheckValidBarcode{
3789 my $dbh = C4::Context->dbh;
3790 my $query=qq|SELECT count(*)
3794 my $sth = $dbh->prepare($query);
3795 $sth->execute($barcode);
3796 my $exist=$sth->fetchrow ;
3800 =head2 IsBranchTransferAllowed
3802 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3804 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3806 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3807 Koha::Item->can_be_transferred.
3811 sub IsBranchTransferAllowed {
3812 my ( $toBranch, $fromBranch, $code ) = @_;
3814 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3816 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3817 my $dbh = C4::Context->dbh;
3819 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3820 $sth->execute( $toBranch, $fromBranch, $code );
3821 my $limit = $sth->fetchrow_hashref();
3823 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3824 if ( $limit->{'limitId'} ) {
3831 =head2 CreateBranchTransferLimit
3833 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3835 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3837 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3841 sub CreateBranchTransferLimit {
3842 my ( $toBranch, $fromBranch, $code ) = @_;
3843 return unless defined($toBranch) && defined($fromBranch);
3844 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3846 my $dbh = C4::Context->dbh;
3848 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3849 return $sth->execute( $code, $toBranch, $fromBranch );
3852 =head2 DeleteBranchTransferLimits
3854 my $result = DeleteBranchTransferLimits($frombranch);
3856 Deletes all the library transfer limits for one library. Returns the
3857 number of limits deleted, 0e0 if no limits were deleted, or undef if
3858 no arguments are supplied.
3860 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3861 fromBranch => $fromBranch
3866 sub DeleteBranchTransferLimits {
3868 return unless defined $branch;
3869 my $dbh = C4::Context->dbh;
3870 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3871 return $sth->execute($branch);
3875 my ( $borrowernumber, $itemnum ) = @_;
3876 MarkIssueReturned( $borrowernumber, $itemnum );
3881 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3883 The final optional parameter, C<$params>, expected to contain
3884 'skip_record_index' key, which relayed down to Koha::Item/store,
3885 there it prevents calling of ModZebra index_records,
3886 which takes most of the time in batch adds/deletes: index_records better
3887 to be called later in C<additem.pl> after the whole loop.
3890 skip_record_index => 1|0
3895 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3897 unless ( $mark_lost_from ) {
3898 # Temporary check to avoid regressions
3899 die q|LostItem called without $mark_lost_from, check the API.|;
3903 if ( $force_mark_returned ) {
3906 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3907 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3910 my $dbh = C4::Context->dbh();
3911 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3913 JOIN items USING (itemnumber)
3914 JOIN biblio USING (biblionumber)
3915 WHERE issues.itemnumber=?");
3916 $sth->execute($itemnumber);
3917 my $issues=$sth->fetchrow_hashref();
3919 # If a borrower lost the item, add a replacement cost to the their record
3920 if ( my $borrowernumber = $issues->{borrowernumber} ){
3921 my $patron = Koha::Patrons->find( $borrowernumber );
3923 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3924 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3926 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3927 C4::Accounts::chargelostitem(
3930 $issues->{'replacementprice'},
3931 sprintf( "%s %s %s",
3932 $issues->{'title'} || q{},
3933 $issues->{'barcode'} || q{},
3934 $issues->{'itemcallnumber'} || q{},
3937 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3938 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3941 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3944 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3945 my $item = Koha::Items->find($itemnumber);
3946 my $transfers = $item->get_transfers;
3947 while (my $transfer = $transfers->next) {
3948 $transfer->cancel({ reason => 'ItemLost', force => 1 });
3952 sub GetOfflineOperations {
3953 my $dbh = C4::Context->dbh;
3954 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3955 $sth->execute(C4::Context->userenv->{'branch'});
3956 my $results = $sth->fetchall_arrayref({});
3960 sub GetOfflineOperation {
3961 my $operationid = shift;
3962 return unless $operationid;
3963 my $dbh = C4::Context->dbh;
3964 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3965 $sth->execute( $operationid );
3966 return $sth->fetchrow_hashref;
3969 sub AddOfflineOperation {
3970 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3971 my $dbh = C4::Context->dbh;
3972 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3973 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3977 sub DeleteOfflineOperation {
3978 my $dbh = C4::Context->dbh;
3979 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3980 $sth->execute( shift );
3984 sub ProcessOfflineOperation {
3985 my $operation = shift;
3988 if ( $operation->{action} eq 'return' ) {
3989 $report = ProcessOfflineReturn( $operation );
3990 } elsif ( $operation->{action} eq 'issue' ) {
3991 $report = ProcessOfflineIssue( $operation );
3992 } elsif ( $operation->{action} eq 'payment' ) {
3993 $report = ProcessOfflinePayment( $operation );
3996 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4001 sub ProcessOfflineReturn {
4002 my $operation = shift;
4004 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4007 my $itemnumber = $item->itemnumber;
4008 my $issue = GetOpenIssue( $itemnumber );
4010 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4011 ModDateLastSeen( $itemnumber, $leave_item_lost );
4013 $issue->{borrowernumber},
4015 $operation->{timestamp},
4017 $item->renewals_count(0);
4018 $item->onloan(undef);
4019 $item->store({ log_action => 0 });
4022 return "Item not issued.";
4025 return "Item not found.";
4029 sub ProcessOfflineIssue {
4030 my $operation = shift;
4032 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4035 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4037 return "Barcode not found.";
4039 my $itemnumber = $item->itemnumber;
4040 my $issue = GetOpenIssue( $itemnumber );
4042 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4044 $issue->{borrowernumber},
4046 $operation->{timestamp},
4051 $operation->{'barcode'},
4054 $operation->{timestamp},
4059 return "Borrower not found.";
4063 sub ProcessOfflinePayment {
4064 my $operation = shift;
4066 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4068 $patron->account->pay(
4070 amount => $operation->{amount},
4071 library_id => $operation->{branchcode},
4081 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4083 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4088 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4092 ? Koha::Items->find($itemnumber)
4093 : Koha::Items->find( { barcode => $barcode } );
4097 return C4::Letters::GetPreparedLetter (
4098 module => 'circulation',
4099 letter_code => 'TRANSFERSLIP',
4100 branchcode => $branch,
4102 'branches' => $to_branch,
4103 'biblio' => $item->biblionumber,
4104 'items' => $item->unblessed,
4109 =head2 CheckIfIssuedToPatron
4111 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4113 Return 1 if any record item is issued to patron, otherwise return 0
4117 sub CheckIfIssuedToPatron {
4118 my ($borrowernumber, $biblionumber) = @_;
4120 my $dbh = C4::Context->dbh;
4122 SELECT COUNT(*) FROM issues
4123 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4124 WHERE items.biblionumber = ?
4125 AND issues.borrowernumber = ?
4127 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4128 return 1 if $is_issued;
4134 IsItemIssued( $itemnumber )
4136 Return 1 if the item is on loan, otherwise return 0
4141 my $itemnumber = shift;
4142 my $dbh = C4::Context->dbh;
4143 my $sth = $dbh->prepare(q{
4146 WHERE itemnumber = ?
4148 $sth->execute($itemnumber);
4149 return $sth->fetchrow;
4152 =head2 GetAgeRestriction
4154 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4155 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4157 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4158 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4160 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4161 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4162 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4163 Negative days mean the borrower has gone past the age restriction age.
4167 sub GetAgeRestriction {
4168 my ($record_restrictions, $borrower) = @_;
4169 my $markers = C4::Context->preference('AgeRestrictionMarker');
4171 return unless $record_restrictions;
4172 # Split $record_restrictions to something like FSK 16 or PEGI 6
4173 my @values = split ' ', uc($record_restrictions);
4174 return unless @values;
4176 # Search first occurrence of one of the markers
4177 my @markers = split /\|/, uc($markers);
4178 return unless @markers;
4181 my $restriction_year = 0;
4182 for my $value (@values) {
4184 for my $marker (@markers) {
4185 $marker =~ s/^\s+//; #remove leading spaces
4186 $marker =~ s/\s+$//; #remove trailing spaces
4187 if ( $marker eq $value ) {
4188 if ( $index <= $#values ) {
4189 $restriction_year += $values[$index];
4193 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4195 # Perhaps it is something like "K16" (as in Finland)
4196 $restriction_year += $1;
4200 last if ( $restriction_year > 0 );
4203 #Check if the borrower is age restricted for this material and for how long.
4204 if ($restriction_year && $borrower) {
4205 if ( $borrower->{'dateofbirth'} ) {
4206 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4207 $alloweddate[0] += $restriction_year;
4209 #Prevent runime eror on leap year (invalid date)
4210 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4211 $alloweddate[2] = 28;
4214 #Get how many days the borrower has to reach the age restriction
4215 my @Today = split /-/, dt_from_string()->ymd();
4216 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4217 #Negative days means the borrower went past the age restriction age
4218 return ($restriction_year, $daysToAgeRestriction);
4222 return ($restriction_year);
4226 =head2 GetPendingOnSiteCheckouts
4230 sub GetPendingOnSiteCheckouts {
4231 my $dbh = C4::Context->dbh;
4232 return $dbh->selectall_arrayref(q|
4238 items.itemcallnumber,
4242 issues.date_due < NOW() AS is_overdue,
4245 borrowers.firstname,
4247 borrowers.cardnumber,
4248 borrowers.borrowernumber
4250 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4251 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4252 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4253 WHERE issues.onsite_checkout = 1
4254 |, { Slice => {} } );
4260 my ($count, $branch, $itemtype, $ccode, $newness)
4261 = @$params{qw(count branch itemtype ccode newness)};
4263 my $dbh = C4::Context->dbh;
4266 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4267 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4268 i.ccode, SUM(i.issues) AS count
4270 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4271 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4274 my (@where_strs, @where_args);
4277 push @where_strs, 'i.homebranch = ?';
4278 push @where_args, $branch;
4281 if (C4::Context->preference('item-level_itypes')){
4282 push @where_strs, 'i.itype = ?';
4283 push @where_args, $itemtype;
4285 push @where_strs, 'bi.itemtype = ?';
4286 push @where_args, $itemtype;
4290 push @where_strs, 'i.ccode = ?';
4291 push @where_args, $ccode;
4294 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4295 push @where_args, $newness;
4299 $query .= 'WHERE ' . join(' AND ', @where_strs);
4303 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4304 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4309 $query .= q{ ) xxx WHERE count > 0 };
4310 $count = int($count);
4312 $query .= "LIMIT $count";
4315 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4320 =head2 Internal methods
4324 sub _CalculateAndUpdateFine {
4327 my $borrower = $params->{borrower};
4328 my $item = $params->{item};
4329 my $issue = $params->{issue};
4330 my $return_date = $params->{return_date};
4332 unless ($borrower) { carp "No borrower passed in!" && return; }
4333 unless ($item) { carp "No item passed in!" && return; }
4334 unless ($issue) { carp "No issue passed in!" && return; }
4336 my $datedue = dt_from_string( $issue->date_due );
4338 # we only need to calculate and change the fines if we want to do that on return
4339 # Should be on for hourly loans
4340 my $control = C4::Context->preference('CircControl');
4341 my $control_branchcode =
4342 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4343 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4344 : $issue->branchcode;
4346 my $date_returned = $return_date ? $return_date : dt_from_string();
4348 my ( $amount, $unitcounttotal, $unitcount ) =
4349 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4351 if ( C4::Context->preference('finesMode') eq 'production' ) {
4352 if ( $amount > 0 ) {
4353 C4::Overdues::UpdateFine({
4354 issue_id => $issue->issue_id,
4355 itemnumber => $issue->itemnumber,
4356 borrowernumber => $issue->borrowernumber,
4361 elsif ($return_date) {
4363 # Backdated returns may have fines that shouldn't exist,
4364 # so in this case, we need to drop those fines to 0
4366 C4::Overdues::UpdateFine({
4367 issue_id => $issue->issue_id,
4368 itemnumber => $issue->itemnumber,
4369 borrowernumber => $issue->borrowernumber,
4377 sub _CanBookBeAutoRenewed {
4378 my ( $params ) = @_;
4379 my $patron = $params->{patron};
4380 my $item = $params->{item};
4381 my $branchcode = $params->{branchcode};
4382 my $issue = $params->{issue};
4384 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4386 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4388 categorycode => $patron->categorycode,
4389 itemtype => $item->effective_itemtype,
4390 branchcode => $branchcode,
4392 'no_auto_renewal_after',
4393 'no_auto_renewal_after_hard_limit',
4400 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4401 return 'auto_account_expired';
4404 if ( defined $issuing_rule->{no_auto_renewal_after}
4405 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4406 # Get issue_date and add no_auto_renewal_after
4407 # If this is greater than today, it's too late for renewal.
4408 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4409 $maximum_renewal_date->add(
4410 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4412 my $now = dt_from_string;
4413 if ( $now >= $maximum_renewal_date ) {
4414 return "auto_too_late";
4417 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4418 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4419 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4420 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4421 return "auto_too_late";
4425 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4426 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4427 my $amountoutstanding =
4428 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4429 ? $patron->account->balance
4430 : $patron->account->outstanding_debits->total_outstanding;
4431 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4432 return "auto_too_much_oweing";
4436 my $soonest = GetSoonestRenewDate($patron->id, $item->id);
4437 if ( $soonest > dt_from_string() )
4439 return ( "auto_too_soon", $soonest );
4445 sub _item_denied_renewal {
4448 my $item = $params->{item};
4449 return unless $item;
4451 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4452 return unless $denyingrules;
4453 foreach my $field (keys %$denyingrules) {
4454 my $val = $item->$field;
4455 if( !defined $val) {
4456 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4459 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4460 # If the results matches the values in the syspref
4461 # We return true if match found
4474 Koha Development Team <http://koha-community.org/>