1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX qw( floor );
28 use C4::Stats qw( UpdateStats );
29 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest ItemsAnyAvailableAndNotRestricted );
30 use C4::Biblio qw( UpdateTotalIssues );
31 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
33 use C4::ItemCirculationAlertPreference;
35 use C4::Log qw( logaction ); # logaction
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits qw( CheckDigits );
40 use Data::Dumper qw( Dumper );
42 use Koha::AuthorisedValues;
43 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
44 use Koha::Biblioitems;
45 use Koha::DateUtils qw( dt_from_string );
48 use Koha::Illrequests;
51 use Koha::Patron::Debarments qw( DelUniqueDebarment GetDebarments AddUniqueDebarment );
54 use Koha::Account::Lines;
56 use Koha::Account::Lines;
57 use Koha::Account::Offsets;
58 use Koha::Config::SysPrefs;
59 use Koha::Charges::Fees;
60 use Koha::Config::SysPref;
61 use Koha::Checkouts::ReturnClaims;
62 use Koha::SearchEngine::Indexer;
63 use Koha::Exceptions::Checkout;
67 use List::MoreUtils qw( any );
68 use Scalar::Util qw( looks_like_number );
69 use Date::Calc qw( Date_to_Days );
70 our (@ISA, @EXPORT_OK);
76 # FIXME subs that should probably be elsewhere
81 GetPendingOnSiteCheckouts
92 GetLatestAutoRenewDate
95 GetBranchBorrowerCircRule
113 IsBranchTransferAllowed
114 CreateBranchTransferLimit
115 DeleteBranchTransferLimits
121 DeleteOfflineOperation
122 ProcessOfflineOperation
123 ProcessOfflinePayment
126 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
131 C4::Circulation - Koha circulation module
139 The functions in this module deal with circulation, issues, and
140 returns, as well as general information about the library.
141 Also deals with inventory.
147 $str = &barcodedecode($barcode, [$filter]);
149 Generic filter function for barcode string.
150 Called on every circ if the System Pref itemBarcodeInputFilter is set.
151 Will do some manipulation of the barcode for systems that deliver a barcode
152 to circulation.pl that differs from the barcode stored for the item.
153 For proper functioning of this filter, calling the function on the
154 correct barcode string (items.barcode) should return an unaltered barcode.
155 Barcode is going to be automatically trimmed of leading/trailing whitespaces.
157 The optional $filter argument is to allow for testing or explicit
158 behavior that ignores the System Pref. Valid values are the same as the
163 # FIXME -- the &decode fcn below should be wrapped into this one.
164 # FIXME -- these plugins should be moved out of Circulation.pm
167 my ($barcode, $filter) = @_;
169 return unless defined $barcode;
171 my $branch = C4::Context::mybranch();
172 $barcode =~ s/^\s+|\s+$//g;
173 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
174 Koha::Plugins->call('item_barcode_transform', \$barcode );
175 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
176 if ($filter eq 'whitespace') {
178 } elsif ($filter eq 'cuecat') {
180 my @fields = split( /\./, $barcode );
181 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
182 ($#results == 2) and return $results[2];
183 } elsif ($filter eq 'T-prefix') {
184 if ($barcode =~ /^[Tt](\d)/) {
185 (defined($1) and $1 eq '0') and return $barcode;
186 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
188 return sprintf("T%07d", $barcode);
189 # FIXME: $barcode could be "T1", causing warning: substr outside of string
190 # Why drop the nonzero digit after the T?
191 # Why pass non-digits (or empty string) to "T%07d"?
192 } elsif ($filter eq 'libsuite8') {
193 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
194 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
195 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
197 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
200 } elsif ($filter eq 'EAN13') {
201 my $ean = CheckDigits('ean');
202 if ( $ean->is_valid($barcode) ) {
203 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
204 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
206 warn "# [$barcode] not valid EAN-13/UPC-A\n";
209 return $barcode; # return barcode, modified or not
214 $str = &_decode($chunk);
216 Decodes a segment of a string emitted by a CueCat barcode scanner and
219 FIXME: Should be replaced with Barcode::Cuecat from CPAN
220 or Javascript based decoding on the client side.
227 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
228 my @s = map { index( $seq, $_ ); } split( //, $encoded );
229 my $l = ( $#s + 1 ) % 4;
232 # warn "Error: Cuecat decode parsing failed!";
240 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
242 chr( ( $n >> 16 ) ^ 67 )
243 .chr( ( $n >> 8 & 255 ) ^ 67 )
244 .chr( ( $n & 255 ) ^ 67 );
247 $r = substr( $r, 0, length($r) - $l );
253 ($dotransfer, $messages, $iteminformation) = &transferbook({
254 from_branch => $frombranch
255 to_branch => $tobranch,
257 ignore_reserves => $ignore_reserves,
261 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
263 C<$fbr> is the code for the branch initiating the transfer.
264 C<$tbr> is the code for the branch to which the item should be transferred.
266 C<$barcode> is the barcode of the item to be transferred.
268 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
269 Otherwise, if an item is reserved, the transfer fails.
271 C<$trigger> is the enum value for what triggered the transfer.
273 Returns three values:
279 is true if the transfer was successful.
283 is a reference-to-hash which may have any of the following keys:
289 There is no item in the catalog with the given barcode. The value is C<$barcode>.
291 =item C<DestinationEqualsHolding>
293 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
297 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
301 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
303 =item C<WasTransferred>
305 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
307 =item C<RecallPlacedAtHoldingBranch>
309 A recall for this item was found, and the transfer has already been completed as the item's branch matches the recall's pickup branch.
313 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
323 my $tbr = $params->{to_branch};
324 my $fbr = $params->{from_branch};
325 my $ignoreRs = $params->{ignore_reserves};
326 my $barcode = $params->{barcode};
327 my $trigger = $params->{trigger};
330 my $item = Koha::Items->find( { barcode => $barcode } );
332 Koha::Exceptions::MissingParameter->throw(
333 "Missing mandatory parameter: from_branch")
336 Koha::Exceptions::MissingParameter->throw(
337 "Missing mandatory parameter: to_branch")
342 $messages->{'BadBarcode'} = $barcode;
344 return ( $dotransfer, $messages );
347 my $itemnumber = $item->itemnumber;
348 # get branches of book...
349 my $hbr = $item->homebranch;
351 # if using Branch Transfer Limits
352 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
353 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
354 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
355 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
356 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
359 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
360 $messages->{'NotAllowed'} = $tbr . "::" . $code;
365 # can't transfer book if is already there....
366 if ( $fbr eq $tbr ) {
367 $messages->{'DestinationEqualsHolding'} = 1;
371 # check if it is still issued to someone, return it...
372 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
374 AddReturn( $barcode, $fbr );
375 $messages->{'WasReturned'} = $issue->borrowernumber;
379 # That'll save a database query.
380 my ( $resfound, $resrec, undef ) =
381 CheckReserves( $itemnumber );
383 $resrec->{'ResFound'} = $resfound;
384 $messages->{'ResFound'} = $resrec;
385 $dotransfer = 0 unless $ignoreRs;
389 if ( C4::Context->preference('UseRecalls') ) {
390 my $recall = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
391 if ( defined $recall ) {
392 # do a transfer if the recall branch is different to the item holding branch
393 if ( $recall->pickup_library_id eq $fbr ) {
395 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
398 $messages->{'RecallFound'} = $recall;
403 #actually do the transfer....
405 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
407 # don't need to update MARC anymore, we do it in batch now
408 $messages->{'WasTransfered'} = $tbr;
411 ModDateLastSeen( $itemnumber );
412 return ( $dotransfer, $messages );
417 my $borrower = shift;
418 my $item_object = shift;
420 my $onsite_checkout = $params->{onsite_checkout} || 0;
421 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
422 my $cat_borrower = $borrower->{'categorycode'};
423 my $dbh = C4::Context->dbh;
424 # Get which branchcode we need
425 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
426 my $type = $item_object->effective_itemtype;
428 my ($type_object, $parent_type, $parent_maxissueqty_rule);
429 $type_object = Koha::ItemTypes->find( $type );
430 $parent_type = $type_object->parent_type if $type_object;
431 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
432 # Find any children if we are a parent_type;
434 # given branch, patron category, and item type, determine
435 # applicable issuing rule
437 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
439 categorycode => $cat_borrower,
440 itemtype => $parent_type,
441 branchcode => $branch,
442 rule_name => 'maxissueqty',
445 # If the parent rule is for default type we discount it
446 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
448 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
450 categorycode => $cat_borrower,
452 branchcode => $branch,
453 rule_name => 'maxissueqty',
457 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
459 categorycode => $cat_borrower,
461 branchcode => $branch,
462 rule_name => 'maxonsiteissueqty',
467 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
468 # if a rule is found and has a loan limit set, count
469 # how many loans the patron already has that meet that
471 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
474 if ( $maxissueqty_rule->branchcode ) {
475 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
476 $checkouts = $patron->checkouts->search(
477 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
478 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
479 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
481 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
482 $checkouts = $patron->checkouts->search(
483 { "item.$branch_type" => $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 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
579 $checkouts = $patron->checkouts->search(
580 { "item.$branch_type" => $branch},
581 { prefetch => 'item' } );
584 my $checkout_count = $checkouts->count;
585 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
586 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
587 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
589 my $qty_over = _check_max_qty(
591 checkout_count => $checkout_count,
592 onsite_checkout_count => $onsite_checkout_count,
593 onsite_checkout => $onsite_checkout,
594 max_checkouts_allowed => $max_checkouts_allowed,
595 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
596 switch_onsite_checkout => $switch_onsite_checkout
599 return $qty_over if defined $qty_over;
602 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
603 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
606 # OK, the patron can issue !!!
612 my $checkout_count = $params->{checkout_count};
613 my $onsite_checkout_count = $params->{onsite_checkout_count};
614 my $onsite_checkout = $params->{onsite_checkout};
615 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
616 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
617 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
619 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
620 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
621 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
623 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
624 count => $onsite_checkout_count,
625 max_allowed => $max_onsite_checkouts_allowed,
629 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
630 if ( $max_checkouts_allowed eq '' ) { return; }
631 my $delta = $switch_onsite_checkout ? 1 : 0;
632 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
634 reason => 'TOO_MANY_CHECKOUTS',
635 count => $checkout_count,
636 max_allowed => $max_checkouts_allowed,
640 elsif ( not $onsite_checkout ) {
641 if ( $max_checkouts_allowed eq '' ) { return; }
643 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
646 reason => 'TOO_MANY_CHECKOUTS',
647 count => $checkout_count - $onsite_checkout_count,
648 max_allowed => $max_checkouts_allowed,
656 =head2 CanBookBeIssued
658 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
659 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
661 Check if a book can be issued.
663 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
665 IMPORTANT: The assumption by users of this routine is that causes blocking
666 the issue are keyed by uppercase labels and other returned
667 data is keyed in lower case!
671 =item C<$patron> is a Koha::Patron
673 =item C<$barcode> is the bar code of the book being issued.
675 =item C<$duedates> is a DateTime object.
677 =item C<$inprocess> boolean switch
679 =item C<$ignore_reserves> boolean switch
681 =item C<$params> Hashref of additional parameters
684 override_high_holds - Ignore high holds
685 onsite_checkout - Checkout is an onsite checkout that will not leave the library
693 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
694 Possible values are :
700 sticky due date is invalid
704 borrower gone with no address
708 borrower declared it's card lost
714 =head3 UNKNOWN_BARCODE
728 item is restricted (set by ??)
730 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
731 could be prevented, but ones that can be overriden by the operator.
733 Possible values are :
741 renewing, not issuing
743 =head3 ISSUED_TO_ANOTHER
745 issued to someone else.
749 reserved for someone else.
753 reserved and being transferred for someone else.
757 sticky due date is invalid or due date in the past
761 if the borrower borrows to much things
765 recalled by someone else
769 sub CanBookBeIssued {
770 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
771 my %needsconfirmation; # filled with problems that needs confirmations
772 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
773 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
774 my %messages; # filled with information messages that should be displayed.
776 my $onsite_checkout = $params->{onsite_checkout} || 0;
777 my $override_high_holds = $params->{override_high_holds} || 0;
779 my $item_object = Koha::Items->find({barcode => $barcode });
781 # MANDATORY CHECKS - unless item exists, nothing else matters
782 unless ( $item_object ) {
783 $issuingimpossible{UNKNOWN_BARCODE} = 1;
785 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
787 my $item_unblessed = $item_object->unblessed; # Transition...
788 my $issue = $item_object->checkout;
789 my $biblio = $item_object->biblio;
791 my $biblioitem = $biblio->biblioitem;
792 my $effective_itemtype = $item_object->effective_itemtype;
793 my $dbh = C4::Context->dbh;
794 my $patron_unblessed = $patron->unblessed;
796 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
798 my $now = dt_from_string();
799 $duedate ||= CalcDateDue( $now, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
800 if (DateTime->compare($duedate,$now) == -1 ) { # duedate cannot be before now
801 $needsconfirmation{INVALID_DATE} = $duedate;
804 my $fees = Koha::Charges::Fees->new(
807 library => $circ_library,
808 item => $item_object,
816 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
817 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
818 C4::Stats::UpdateStats(
820 branch => C4::Context->userenv->{'branch'},
822 itemnumber => $item_object->itemnumber,
823 itemtype => $effective_itemtype,
824 borrowernumber => $patron->borrowernumber,
825 ccode => $item_object->ccode,
826 categorycode => $patron->categorycode,
829 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
830 return( { STATS => 1 }, {});
833 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
834 $issuingimpossible{GNA} = 1;
837 if ( $patron->lost && $patron->lost == 1 ) {
838 $issuingimpossible{CARD_LOST} = 1;
840 if ( $patron->is_debarred ) {
841 $issuingimpossible{DEBARRED} = 1;
844 if ( $patron->is_expired ) {
845 $issuingimpossible{EXPIRED} = 1;
853 my $account = $patron->account;
854 my $balance = $account->balance;
855 my $non_issues_charges = $account->non_issues_charges;
856 my $other_charges = $balance - $non_issues_charges;
858 my $amountlimit = C4::Context->preference("noissuescharge");
859 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
860 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
862 # Check the debt of this patrons guarantees
863 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
864 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
865 if ( defined $no_issues_charge_guarantees ) {
866 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
867 my $guarantees_non_issues_charges = 0;
868 foreach my $g ( @guarantees ) {
869 $guarantees_non_issues_charges += $g->account->non_issues_charges;
872 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
873 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
874 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
875 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
876 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
877 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
881 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
882 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
883 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
884 if ( defined $no_issues_charge_guarantors ) {
885 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
887 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
888 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
889 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
890 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
891 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
892 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
896 if ( C4::Context->preference("IssuingInProcess") ) {
897 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
898 $issuingimpossible{DEBT} = $non_issues_charges;
899 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
900 $needsconfirmation{DEBT} = $non_issues_charges;
901 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
902 $needsconfirmation{DEBT} = $non_issues_charges;
906 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
907 $needsconfirmation{DEBT} = $non_issues_charges;
908 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
909 $issuingimpossible{DEBT} = $non_issues_charges;
910 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
911 $needsconfirmation{DEBT} = $non_issues_charges;
915 if ($balance > 0 && $other_charges > 0) {
916 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
919 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
920 $patron_unblessed = $patron->unblessed;
922 if ( my $debarred_date = $patron->is_debarred ) {
923 # patron has accrued fine days or has a restriction. $count is a date
924 if ($debarred_date eq '9999-12-31') {
925 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
928 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
930 } elsif ( my $num_overdues = $patron->has_overdues ) {
931 ## patron has outstanding overdue loans
932 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
933 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
935 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
936 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
940 # Additional Materials Check
941 if ( C4::Context->preference("CircConfirmItemParts")
942 && $item_object->materials )
944 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
948 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
950 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
952 # Already issued to current borrower.
953 # If it is an on-site checkout if it can be switched to a normal checkout
954 # or ask whether the loan should be renewed
956 if ( $issue->onsite_checkout
957 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
958 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
960 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
961 $patron->borrowernumber,
962 $item_object->itemnumber,
964 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
965 if ( $renewerror eq 'onsite_checkout' ) {
966 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
969 $issuingimpossible{NO_MORE_RENEWALS} = 1;
973 $needsconfirmation{RENEW_ISSUE} = 1;
979 # issued to someone else
981 my $patron = Koha::Patrons->find( $issue->borrowernumber );
983 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
985 unless ( $can_be_returned ) {
986 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
987 $issuingimpossible{branch_to_return} = $message;
989 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
990 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
992 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
993 $needsconfirmation{issued_firstname} = $patron->firstname;
994 $needsconfirmation{issued_surname} = $patron->surname;
995 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
996 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
1001 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1003 my $switch_onsite_checkout = (
1004 C4::Context->preference('SwitchOnSiteCheckouts')
1006 and $issue->onsite_checkout
1007 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1008 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1009 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1010 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1011 if ( $toomany->{max_allowed} == 0 ) {
1012 $needsconfirmation{PATRON_CANT} = 1;
1014 if ( C4::Context->preference("AllowTooManyOverride") ) {
1015 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1016 $needsconfirmation{current_loan_count} = $toomany->{count};
1017 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1019 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1020 $issuingimpossible{current_loan_count} = $toomany->{count};
1021 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1026 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1028 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1029 my $wants_check = $patron->wants_check_for_previous_checkout;
1030 $needsconfirmation{PREVISSUE} = 1
1031 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1036 if ( $item_object->notforloan )
1038 if(!C4::Context->preference("AllowNotForLoanOverride")){
1039 $issuingimpossible{NOT_FOR_LOAN} = 1;
1040 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1042 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1043 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1047 # we have to check itemtypes.notforloan also
1048 if (C4::Context->preference('item-level_itypes')){
1049 # this should probably be a subroutine
1050 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1051 $sth->execute($effective_itemtype);
1052 my $notforloan=$sth->fetchrow_hashref();
1053 if ($notforloan->{'notforloan'}) {
1054 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1055 $issuingimpossible{NOT_FOR_LOAN} = 1;
1056 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1058 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1059 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1064 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1065 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1066 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1067 $issuingimpossible{NOT_FOR_LOAN} = 1;
1068 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1070 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1071 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1076 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1078 $issuingimpossible{WTHDRAWN} = 1;
1080 if ( $item_object->restricted
1081 && $item_object->restricted == 1 )
1083 $issuingimpossible{RESTRICTED} = 1;
1085 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1086 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1087 my $code = $av->count ? $av->next->lib : '';
1088 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1089 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1091 if ( C4::Context->preference("IndependentBranches") ) {
1092 my $userenv = C4::Context->userenv;
1093 unless ( C4::Context->IsSuperLibrarian() ) {
1094 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1095 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1096 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1097 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1099 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1100 if ( $patron->branchcode ne $userenv->{branch} );
1105 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1107 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1108 if ($rentalConfirmation) {
1109 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1111 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1112 if ($itemtype_object) {
1113 my $accumulate_charge = $fees->accumulate_rentalcharge();
1114 if ( $accumulate_charge > 0 ) {
1115 $rentalCharge += $accumulate_charge;
1119 if ( $rentalCharge > 0 ) {
1120 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1125 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1126 # Only bother doing this if UseRecalls is enabled and the item is recallable
1127 # Don't look at recalls that are in transit
1128 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1129 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1131 foreach my $r ( @recalls ) {
1132 if ( $r->item_id and
1133 $r->item_id == $item_object->itemnumber and
1134 $r->patron_id == $patron->borrowernumber and
1135 ( $r->waiting or $r->requested ) ) {
1136 $messages{RECALLED} = $r->id;
1138 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1141 elsif ( $r->item_id and
1142 $r->item_id == $item_object->itemnumber and
1144 # recalled item is in transit
1145 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1147 elsif ( $r->item_level and
1148 $r->item_id == $item_object->itemnumber and
1149 $r->patron_id != $patron->borrowernumber and
1151 # this specific item has been recalled by a different patron
1152 $needsconfirmation{RECALLED} = $r;
1156 elsif ( !$r->item_level and
1157 $r->patron_id != $patron->borrowernumber and
1159 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1160 $needsconfirmation{RECALLED} = $r;
1167 unless ( $ignore_reserves and defined $recall ) {
1168 # See if the item is on reserve.
1169 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1171 my $resbor = $res->{'borrowernumber'};
1172 if ( $resbor ne $patron->borrowernumber ) {
1173 my $patron = Koha::Patrons->find( $resbor );
1174 if ( $restype eq "Waiting" )
1176 # The item is on reserve and waiting, but has been
1177 # reserved by some other patron.
1178 $needsconfirmation{RESERVE_WAITING} = 1;
1179 $needsconfirmation{'resfirstname'} = $patron->firstname;
1180 $needsconfirmation{'ressurname'} = $patron->surname;
1181 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1182 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1183 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1184 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1185 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1187 elsif ( $restype eq "Reserved" ) {
1188 # The item is on reserve for someone else.
1189 $needsconfirmation{RESERVED} = 1;
1190 $needsconfirmation{'resfirstname'} = $patron->firstname;
1191 $needsconfirmation{'ressurname'} = $patron->surname;
1192 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1193 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1194 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1195 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1196 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1198 elsif ( $restype eq "Transferred" ) {
1199 # The item is determined hold being transferred for someone else.
1200 $needsconfirmation{TRANSFERRED} = 1;
1201 $needsconfirmation{'resfirstname'} = $patron->firstname;
1202 $needsconfirmation{'ressurname'} = $patron->surname;
1203 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1204 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1205 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1206 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1207 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1209 elsif ( $restype eq "Processing" ) {
1210 # The item is determined hold being processed for someone else.
1211 $needsconfirmation{PROCESSING} = 1;
1212 $needsconfirmation{'resfirstname'} = $patron->firstname;
1213 $needsconfirmation{'ressurname'} = $patron->surname;
1214 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1215 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1216 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1217 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1218 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1224 ## CHECK AGE RESTRICTION
1225 my $agerestriction = $biblioitem->agerestriction;
1226 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1227 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1228 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1229 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1232 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1236 ## check for high holds decreasing loan period
1237 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1238 my $check = checkHighHolds( $item_object, $patron );
1240 if ( $check->{exceeded} ) {
1242 num_holds => $check->{outstanding},
1243 duration => $check->{duration},
1244 returndate => $check->{due_date},
1246 if ($override_high_holds) {
1247 $alerts{HIGHHOLDS} = $highholds;
1250 $needsconfirmation{HIGHHOLDS} = $highholds;
1256 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1257 # don't do the multiple loans per bib check if we've
1258 # already determined that we've got a loan on the same item
1259 !$issuingimpossible{NO_MORE_RENEWALS} &&
1260 !$needsconfirmation{RENEW_ISSUE}
1262 # Check if borrower has already issued an item from the same biblio
1263 # Only if it's not a subscription
1264 my $biblionumber = $item_object->biblionumber;
1265 require C4::Serials;
1266 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1267 unless ($is_a_subscription) {
1268 # FIXME Should be $patron->checkouts($args);
1269 my $checkouts = Koha::Checkouts->search(
1271 borrowernumber => $patron->borrowernumber,
1272 biblionumber => $biblionumber,
1278 # if we get here, we don't already have a loan on this item,
1279 # so if there are any loans on this bib, ask for confirmation
1280 if ( $checkouts->count ) {
1281 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1286 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1289 =head2 CanBookBeReturned
1291 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1293 Check whether the item can be returned to the provided branch
1297 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1299 =item C<$branch> is the branchcode where the return is taking place
1307 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1309 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1315 sub CanBookBeReturned {
1316 my ($item, $branch) = @_;
1317 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1319 # assume return is allowed to start
1323 # identify all cases where return is forbidden
1324 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1326 $message = $item->{'homebranch'};
1327 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1329 $message = $item->{'holdingbranch'};
1330 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1332 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1335 return ($allowed, $message);
1338 =head2 CheckHighHolds
1340 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1341 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1342 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1346 sub checkHighHolds {
1347 my ( $item, $patron ) = @_;
1348 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1358 # Count holds on this record, ignoring the borrowers own holds as they would be filled by the checkout
1359 my $holds = Koha::Holds->search({
1360 biblionumber => $item->biblionumber,
1361 borrowernumber => { '!=' => $patron->borrowernumber }
1364 if ( $holds->count() ) {
1365 $return_data->{outstanding} = $holds->count();
1367 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1368 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1369 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1371 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1373 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1375 # static means just more than a given number of holds on the record
1377 # If the number of holds is not above the threshold, we can stop here
1378 if ( $holds->count() <= $decreaseLoanHighHoldsValue ) {
1379 return $return_data;
1382 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1384 # dynamic means X more than the number of holdable items on the record
1386 # let's get the items
1387 my @items = $holds->next()->biblio()->items()->as_list;
1389 # Remove any items with status defined to be ignored even if the would not make item unholdable
1390 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1391 @items = grep { !$_->$status } @items;
1394 # Remove any items that are not holdable for this patron
1395 # We need to ignore hold counts as the borrower's own hold that will be filled by the checkout
1396 # could prevent them from placing further holds
1397 @items = grep { CanItemBeReserved( $patron, $_, undef, { ignore_hold_counts => 1 } )->{status} eq 'OK' } @items;
1399 my $items_count = scalar @items;
1401 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1403 # If the number of holds is less than the count of items we have
1404 # plus the number of holds allowed above that count, we can stop here
1405 if ( $holds->count() <= $threshold ) {
1406 return $return_data;
1410 my $issuedate = dt_from_string();
1412 my $itype = $item->effective_itemtype;
1413 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1415 categorycode => $patron->categorycode,
1417 branchcode => $branchcode,
1420 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1422 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1424 my $rule = Koha::CirculationRules->get_effective_rule_value(
1426 categorycode => $patron->categorycode,
1427 itemtype => $item->effective_itemtype,
1428 branchcode => $branchcode,
1429 rule_name => 'decreaseloanholds',
1434 if ( defined($rule) && $rule ne '' ){
1435 # overrides decreaseLoanHighHoldsDuration syspref
1438 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1440 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1441 $reduced_datedue->set_hour($orig_due->hour);
1442 $reduced_datedue->set_minute($orig_due->minute);
1443 $reduced_datedue->truncate( to => 'minute' );
1445 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1446 $return_data->{exceeded} = 1;
1447 $return_data->{duration} = $duration;
1448 $return_data->{due_date} = $reduced_datedue;
1452 return $return_data;
1457 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1459 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1463 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1465 =item C<$barcode> is the barcode of the item being issued.
1467 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1468 Calculated if empty.
1470 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1472 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1475 AddIssue does the following things :
1477 - step 01: check that there is a borrowernumber & a barcode provided
1478 - check for RENEWAL (book issued & being issued to the same patron)
1479 - renewal YES = Calculate Charge & renew
1481 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1483 - fill reserve if reserve to this patron
1484 - cancel reserve or not, otherwise
1486 - fill recall if recall to this patron
1487 - cancel recall or not
1488 - revert recall's waiting status or not
1489 * TRANSFERT PENDING ?
1490 - complete the transfert
1498 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1500 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1501 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1502 my $auto_renew = $params && $params->{auto_renew};
1503 my $cancel_recall = $params && $params->{cancel_recall};
1504 my $recall_id = $params && $params->{recall_id};
1505 my $dbh = C4::Context->dbh;
1506 my $barcodecheck = CheckValidBarcode($barcode);
1510 if ( $datedue && ref $datedue ne 'DateTime' ) {
1511 $datedue = dt_from_string($datedue);
1514 # $issuedate defaults to today.
1515 if ( !defined $issuedate ) {
1516 $issuedate = dt_from_string();
1519 if ( ref $issuedate ne 'DateTime' ) {
1520 $issuedate = dt_from_string($issuedate);
1525 # Stop here if the patron or barcode doesn't exist
1526 if ( $borrower && $barcode && $barcodecheck ) {
1527 # find which item we issue
1528 my $item_object = Koha::Items->find({ barcode => $barcode })
1529 or return; # if we don't get an Item, abort.
1530 my $item_unblessed = $item_object->unblessed;
1532 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1534 # get actual issuing if there is one
1535 my $actualissue = $item_object->checkout;
1537 # check if we just renew the issue.
1538 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1539 and not $switch_onsite_checkout ) {
1540 $datedue = AddRenewal(
1541 $borrower->{'borrowernumber'},
1542 $item_object->itemnumber,
1545 $issuedate, # here interpreted as the renewal date
1551 my $itype = $item_object->effective_itemtype;
1552 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1556 # Check if we need to use an exact due date set by the ILL module
1557 if ( C4::Context->preference('ILLModule') ) {
1558 # Check if there is an ILL connected with the biblio of the item we are issuing
1559 my $ill_request = Koha::Illrequests->search({
1560 biblio_id => $item_object->biblionumber,
1561 borrowernumber => $borrower->{'borrowernumber'},
1563 due_date => { '!=', undef },
1566 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1567 my $ill_dt = dt_from_string( $ill_request->due_date );
1568 $ill_dt->set_hour(23);
1569 $ill_dt->set_minute(59);
1574 $datedue->truncate( to => 'minute' );
1576 my $patron = Koha::Patrons->find( $borrower );
1577 my $library = Koha::Libraries->find( $branchcode );
1578 my $fees = Koha::Charges::Fees->new(
1581 library => $library,
1582 item => $item_object,
1583 to_date => $datedue,
1587 # it's NOT a renewal
1588 if ( $actualissue and not $switch_onsite_checkout ) {
1589 # This book is currently on loan, but not to the person
1590 # who wants to borrow it now. mark it returned before issuing to the new borrower
1591 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1592 return unless $allowed;
1593 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1594 # AddReturn certainly has side-effects, like onloan => undef
1595 $item_object->discard_changes;
1598 if ( C4::Context->preference('UseRecalls') ) {
1599 Koha::Recalls->move_recall(
1601 action => $cancel_recall,
1602 recall_id => $recall_id,
1603 item => $item_object,
1604 borrowernumber => $borrower->{borrowernumber},
1609 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1611 # Starting process for transfer job (checking transfert and validate it if we have one)
1612 if ( my $transfer = $item_object->get_transfer ) {
1613 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1616 datearrived => dt_from_string,
1617 tobranch => C4::Context->userenv->{branch},
1618 comments => 'Forced branchtransfer'
1621 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1622 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1623 if ( $hold ) { # Is this really needed?
1624 $hold->set( { found => undef } )->store;
1625 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1630 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1631 unless ($auto_renew) {
1632 my $rule = Koha::CirculationRules->get_effective_rule_value(
1634 categorycode => $borrower->{categorycode},
1635 itemtype => $item_object->effective_itemtype,
1636 branchcode => $branchcode,
1637 rule_name => 'auto_renew'
1641 $auto_renew = $rule if defined $rule && $rule ne '';
1644 my $issue_attributes = {
1645 borrowernumber => $borrower->{'borrowernumber'},
1646 issuedate => $issuedate,
1647 date_due => $datedue,
1648 branchcode => C4::Context->userenv->{'branch'},
1649 onsite_checkout => $onsite_checkout,
1650 auto_renew => $auto_renew ? 1 : 0,
1653 # Get ID of logged in user. if called from a batch job,
1654 # no user session exists and C4::Context->userenv() returns
1655 # the scalar '0'. Only do this if the syspref says so
1656 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1657 my $userenv = C4::Context->userenv();
1658 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1660 $issue_attributes->{issuer_id} = $usernumber;
1664 # In the case that the borrower has an on-site checkout
1665 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1666 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1668 $issue->set($issue_attributes)->store;
1671 $issue = Koha::Checkout->new(
1673 itemnumber => $item_object->itemnumber,
1678 $issue->discard_changes;
1679 C4::Auth::track_login_daily( $borrower->{userid} );
1680 if ( $item_object->location && $item_object->location eq 'CART'
1681 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1682 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1683 CartToShelf( $item_object->itemnumber );
1686 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1687 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1690 # Record if item was lost
1691 my $was_lost = $item_object->itemlost;
1693 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1694 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1695 $item_object->itemlost(0);
1696 $item_object->onloan($datedue->ymd());
1697 $item_object->datelastborrowed( dt_from_string()->ymd() );
1698 $item_object->datelastseen( dt_from_string()->ymd() );
1699 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1701 # If the item was lost, it has now been found, charge the overdue if necessary
1703 if ( $item_object->{_charge} ) {
1704 $actualissue //= Koha::Old::Checkouts->search(
1705 { itemnumber => $item_unblessed->{itemnumber} },
1707 order_by => { '-desc' => 'returndate' },
1711 unless ( exists( $borrower->{branchcode} ) ) {
1712 my $patron = $actualissue->patron;
1713 $borrower = $patron->unblessed;
1715 _CalculateAndUpdateFine(
1717 issue => $actualissue,
1718 item => $item_unblessed,
1719 borrower => $borrower,
1720 return_date => $issuedate
1723 _FixOverduesOnReturn( $borrower->{borrowernumber},
1724 $item_object->itemnumber, undef, 'RENEWED' );
1728 # If it costs to borrow this book, charge it to the patron's account.
1729 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1730 if ( $charge && $charge > 0 ) {
1731 AddIssuingCharge( $issue, $charge, 'RENT' );
1734 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1735 if ( $itemtype_object ) {
1736 my $accumulate_charge = $fees->accumulate_rentalcharge();
1737 if ( $accumulate_charge > 0 ) {
1738 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1739 $charge += $accumulate_charge;
1740 $item_unblessed->{charge} = $charge;
1744 # Record the fact that this book was issued.
1745 C4::Stats::UpdateStats(
1747 branch => C4::Context->userenv->{'branch'},
1748 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1750 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1751 itemnumber => $item_object->itemnumber,
1752 itemtype => $item_object->effective_itemtype,
1753 location => $item_object->location,
1754 borrowernumber => $borrower->{'borrowernumber'},
1755 ccode => $item_object->ccode,
1756 categorycode => $borrower->{'categorycode'}
1760 # Send a checkout slip.
1761 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1763 branchcode => $branchcode,
1764 categorycode => $borrower->{categorycode},
1765 item_type => $item_object->effective_itemtype,
1766 notification => 'CHECKOUT',
1768 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1769 SendCirculationAlert(
1772 item => $item_object->unblessed,
1773 borrower => $borrower,
1774 branch => $branchcode,
1779 "CIRCULATION", "ISSUE",
1780 $borrower->{'borrowernumber'},
1781 $item_object->itemnumber,
1782 ) if C4::Context->preference("IssueLog");
1784 Koha::Plugins->call('after_circ_action', {
1785 action => 'checkout',
1787 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1788 checkout => $issue->get_from_storage
1792 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1794 biblio_ids => [ $item_object->biblionumber ]
1796 ) if C4::Context->preference('RealTimeHoldsQueue');
1802 =head2 GetLoanLength
1804 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1806 Get loan length for an itemtype, a borrower type and a branch
1811 my ( $categorycode, $itemtype, $branchcode ) = @_;
1813 # Initialize default values
1817 lengthunit => 'days',
1820 my $found = Koha::CirculationRules->get_effective_rules( {
1821 branchcode => $branchcode,
1822 categorycode => $categorycode,
1823 itemtype => $itemtype,
1832 foreach my $rule_name (keys %$found) {
1833 $rules->{$rule_name} = $found->{$rule_name};
1840 =head2 GetHardDueDate
1842 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1844 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1848 sub GetHardDueDate {
1849 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1851 my $rules = Koha::CirculationRules->get_effective_rules(
1853 categorycode => $borrowertype,
1854 itemtype => $itemtype,
1855 branchcode => $branchcode,
1856 rules => [ 'hardduedate', 'hardduedatecompare' ],
1860 if ( defined( $rules->{hardduedate} ) ) {
1861 if ( $rules->{hardduedate} ) {
1862 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1865 return ( undef, undef );
1870 =head2 GetBranchBorrowerCircRule
1872 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1874 Retrieves circulation rule attributes that apply to the given
1875 branch and patron category, regardless of item type.
1876 The return value is a hashref containing the following key:
1878 patron_maxissueqty - maximum number of loans that a
1879 patron of the given category can have at the given
1880 branch. If the value is undef, no limit.
1882 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1883 patron of the given category can have at the given
1884 branch. If the value is undef, no limit.
1886 This will check for different branch/category combinations in the following order:
1890 default branch and category
1892 If no rule has been found in the database, it will default to
1895 patron_maxissueqty - undef
1896 patron_maxonsiteissueqty - undef
1898 C<$branchcode> and C<$categorycode> should contain the
1899 literal branch code and patron category code, respectively - no
1904 sub GetBranchBorrowerCircRule {
1905 my ( $branchcode, $categorycode ) = @_;
1907 # Initialize default values
1909 patron_maxissueqty => undef,
1910 patron_maxonsiteissueqty => undef,
1914 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1915 my $rule = Koha::CirculationRules->get_effective_rule(
1917 categorycode => $categorycode,
1919 branchcode => $branchcode,
1920 rule_name => $rule_name,
1924 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1930 =head2 GetBranchItemRule
1932 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1934 Retrieves circulation rule attributes that apply to the given
1935 branch and item type, regardless of patron category.
1937 The return value is a hashref containing the following keys:
1939 holdallowed => Hold policy for this branch and itemtype. Possible values:
1940 not_allowed: No holds allowed.
1941 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1942 from_any_library: Holds allowed from any patron.
1943 from_local_hold_group: Holds allowed from libraries in hold group
1945 This searches branchitemrules in the following order:
1947 * Same branchcode and itemtype
1948 * Same branchcode, itemtype '*'
1949 * branchcode '*', same itemtype
1950 * branchcode and itemtype '*'
1952 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1956 sub GetBranchItemRule {
1957 my ( $branchcode, $itemtype ) = @_;
1960 my $rules = Koha::CirculationRules->get_effective_rules({
1961 branchcode => $branchcode,
1962 itemtype => $itemtype,
1963 rules => ['holdallowed', 'hold_fulfillment_policy']
1966 # built-in default circulation rule
1967 $rules->{holdallowed} //= 'from_any_library';
1968 $rules->{hold_fulfillment_policy} //= 'any';
1975 ($doreturn, $messages, $iteminformation, $borrower) =
1976 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1982 =item C<$barcode> is the bar code of the book being returned.
1984 =item C<$branch> is the code of the branch where the book is being returned.
1986 =item C<$exemptfine> indicates that overdue charges for the item will be
1989 =item C<$return_date> allows the default return date to be overridden
1990 by the given return date. Optional.
1994 C<&AddReturn> returns a list of four items:
1996 C<$doreturn> is true iff the return succeeded.
1998 C<$messages> is a reference-to-hash giving feedback on the operation.
1999 The keys of the hash are:
2005 No item with this barcode exists. The value is C<$barcode>.
2009 The book is not currently on loan. The value is C<$barcode>.
2013 This book has been withdrawn/cancelled. The value should be ignored.
2015 =item C<Wrongbranch>
2017 This book has was returned to the wrong branch. The value is a hashref
2018 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2019 contain the branchcode of the incorrect and correct return library, respectively.
2023 The item was reserved. The value is a reference-to-hash whose keys are
2024 fields from the reserves table of the Koha database, and
2025 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2026 either C<Waiting>, C<Reserved>, or 0.
2028 =item C<WasReturned>
2030 Value 1 if return is successful.
2032 =item C<NeedsTransfer>
2034 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2036 =item C<RecallFound>
2038 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2039 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2042 =item C<TransferredRecall>
2044 This item has been transferred to this branch to fill a recall. The recall object is returned.
2048 C<$iteminformation> is a reference-to-hash, giving information about the
2049 returned item from the issues table.
2051 C<$borrower> is a reference-to-hash, giving information about the
2052 patron who last borrowed the book.
2057 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2059 if ($branch and not Koha::Libraries->find($branch)) {
2060 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2063 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2064 my $return_date_specified = !!$return_date;
2065 $return_date //= dt_from_string();
2069 my $validTransfer = 1;
2070 my $stat_type = 'return';
2072 # get information on item
2073 my $item = Koha::Items->find({ barcode => $barcode });
2075 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2078 my $itemnumber = $item->itemnumber;
2079 my $itemtype = $item->effective_itemtype;
2081 my $issue = $item->checkout;
2083 $patron = $issue->patron
2084 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2085 . Dumper($issue->unblessed) . "\n";
2087 $messages->{'NotIssued'} = $barcode;
2088 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2090 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2092 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2093 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2094 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2095 $messages->{'LocalUse'} = 1;
2096 $stat_type = 'localuse';
2100 # full item data, but no borrowernumber or checkout info (no issue)
2101 my $hbr = Koha::CirculationRules->get_return_branch_policy($item);
2102 # get the proper branch to which to return the item
2103 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2104 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2105 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2107 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2108 my $patron_unblessed = $patron ? $patron->unblessed : {};
2110 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2111 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2112 if ($update_loc_rules) {
2113 if (defined $update_loc_rules->{_ALL_}) {
2114 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2115 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2117 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2118 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2120 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2121 $item->location($update_loc_rules->{_ALL_})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2125 foreach my $key ( keys %$update_loc_rules ) {
2126 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2127 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2128 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2129 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2130 $item->location($update_loc_rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2137 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2139 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2141 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2143 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2146 foreach my $key ( keys %$rules ) {
2147 if ( $item->notforloan eq $key ) {
2148 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2149 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 }) unless $rules->{$key} eq 'ONLYMESSAGE';
2156 # check if the return is allowed at this branch
2157 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2158 unless ($returnallowed){
2159 $messages->{'Wrongbranch'} = {
2160 Wrongbranch => $branch,
2161 Rightbranch => $message
2164 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2165 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2166 return ( $doreturn, $messages, $issue, $patron_unblessed);
2169 if ( $item->withdrawn ) { # book has been cancelled
2170 $messages->{'withdrawn'} = 1;
2171 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2174 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2178 # case of a return of document (deal with issues and holdingbranch)
2180 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2181 $patron or warn "AddReturn without current borrower";
2185 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2190 C4::Context->preference('CalculateFinesOnReturn')
2191 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2196 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2199 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 );
2201 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2202 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2204 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2207 # FIXME is the "= 1" right? This could be the borrower hash.
2208 $messages->{'WasReturned'} = 1;
2211 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2215 # the holdingbranch is updated if the document is returned to another location.
2216 # this is always done regardless of whether the item was on loan or not
2217 if ($item->holdingbranch ne $branch) {
2218 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2221 my $item_was_lost = $item->itemlost;
2222 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2223 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2225 # fix up the accounts.....
2226 if ($item_was_lost) {
2227 $messages->{'WasLost'} = 1;
2228 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2229 my @object_messages = @{ $updated_item->object_messages };
2230 for my $message (@object_messages) {
2231 $messages->{'LostItemFeeRefunded'} = 1
2232 if $message->message eq 'lost_refunded';
2233 $messages->{'ProcessingFeeRefunded'} = 1
2234 if $message->message eq 'processing_refunded';
2235 $messages->{'LostItemFeeRestored'} = 1
2236 if $message->message eq 'lost_restored';
2238 if ( $message->message eq 'lost_charge' ) {
2239 $issue //= Koha::Old::Checkouts->search(
2240 { itemnumber => $item->itemnumber },
2241 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2243 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2244 my $patron = $issue->patron;
2245 $patron_unblessed = $patron->unblessed;
2247 _CalculateAndUpdateFine(
2250 item => $item->unblessed,
2251 borrower => $patron_unblessed,
2252 return_date => $return_date
2255 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2256 $item->itemnumber, undef, 'RETURNED' );
2257 $messages->{'LostItemFeeCharged'} = 1;
2263 # check if we have a transfer for this document
2264 my $transfer = $item->get_transfer;
2266 # if we have a transfer to complete, we update the line of transfers with the datearrived
2269 if ( $transfer->in_transit ) {
2270 if ( $transfer->tobranch eq $branch ) {
2272 $messages->{'TransferArrived'} = $transfer->frombranch;
2273 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2274 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2277 $messages->{'WrongTransfer'} = $transfer->tobranch;
2278 $messages->{'WrongTransferItem'} = $item->itemnumber;
2279 $messages->{'TransferTrigger'} = $transfer->reason;
2283 if ( $transfer->tobranch eq $branch ) {
2285 $messages->{'TransferArrived'} = $transfer->frombranch;
2286 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2287 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2290 $messages->{'WasTransfered'} = $transfer->tobranch;
2291 $messages->{'TransferTrigger'} = $transfer->reason;
2296 # fix up the overdues in accounts...
2297 if ($borrowernumber) {
2298 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2299 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2301 if ( $issue and $issue->is_overdue($return_date) ) {
2303 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2304 if ($debardate and $debardate ne "9999-12-31") {
2306 $messages->{'PrevDebarred'} = $debardate;
2308 $messages->{'Debarred'} = $debardate;
2310 } elsif ($patron->debarred) {
2311 if ( $patron->debarred eq "9999-12-31") {
2312 $messages->{'ForeverDebarred'} = $patron->debarred;
2314 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2315 $borrower_debar_dt->truncate(to => 'day');
2316 my $today_dt = $return_date->clone()->truncate(to => 'day');
2317 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2318 $messages->{'PrevDebarred'} = $patron->debarred;
2322 # there's no overdue on the item but borrower had been previously debarred
2323 } elsif ( $issue->date_due and $patron->debarred ) {
2324 if ( $patron->debarred eq "9999-12-31") {
2325 $messages->{'ForeverDebarred'} = $patron->debarred;
2327 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2328 $borrower_debar_dt->truncate(to => 'day');
2329 my $today_dt = $return_date->clone()->truncate(to => 'day');
2330 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2331 $messages->{'PrevDebarred'} = $patron->debarred;
2338 if ( C4::Context->preference('UseRecalls') ) {
2339 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2341 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2342 if ( defined $recall ) {
2343 $messages->{RecallFound} = $recall;
2344 if ( $recall->pickup_library_id ne $branch ) {
2345 $messages->{RecallNeedsTransfer} = $branch;
2350 # find reserves.....
2351 # launch the Checkreserves routine to find any holds
2352 my ($resfound, $resrec);
2353 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2354 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2355 # 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)
2356 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2357 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2358 $resfound = 'Reserved';
2359 $resrec = $hold->unblessed;
2362 $resrec->{'ResFound'} = $resfound;
2363 $messages->{'ResFound'} = $resrec;
2366 # Record the fact that this book was returned.
2367 my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2368 C4::Stats::UpdateStats({
2371 itemnumber => $itemnumber,
2372 itemtype => $itemtype,
2373 location => $item->location,
2374 borrowernumber => $borrowernumber,
2375 ccode => $item->ccode,
2376 categorycode => $categorycode,
2379 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2381 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2383 branchcode => $branch,
2384 categorycode => $patron->categorycode,
2385 item_type => $itemtype,
2386 notification => 'CHECKIN',
2388 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2389 SendCirculationAlert({
2391 item => $item->unblessed,
2392 borrower => $patron->unblessed,
2398 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2399 if C4::Context->preference("ReturnLog");
2402 # Check if this item belongs to a biblio record that is attached to an
2403 # ILL request, if it is we need to update the ILL request's status
2404 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2405 my $request = Koha::Illrequests->find(
2406 { biblio_id => $item->biblio->biblionumber }
2408 $request->status('RET') if $request;
2411 if ( C4::Context->preference('UseRecalls') ) {
2412 # all recalls that have triggered a transfer will have an allocated itemnumber
2413 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2414 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2415 $messages->{TransferredRecall} = $transfer_recall;
2419 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2420 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2421 && ( $doreturn or $messages->{'NotIssued'} )
2423 and ( $branch ne $returnbranch )
2424 and not $messages->{'WrongTransfer'}
2425 and not $messages->{'WasTransfered'}
2426 and not $messages->{TransferredRecall}
2427 and not $messages->{RecallNeedsTransfer} )
2429 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2430 if (C4::Context->preference("AutomaticItemReturn" ) or
2431 (C4::Context->preference("UseBranchTransferLimits") and
2432 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2434 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2435 $messages->{'WasTransfered'} = $returnbranch;
2436 $messages->{'TransferTrigger'} = $transfer_trigger;
2438 $messages->{'NeedsTransfer'} = $returnbranch;
2439 $messages->{'TransferTrigger'} = $transfer_trigger;
2443 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2444 my $claims = Koha::Checkouts::ReturnClaims->search(
2446 itemnumber => $item->id,
2447 resolution => undef,
2451 if ( $claims->count ) {
2452 $messages->{ReturnClaims} = $claims;
2456 # Check for bundle status
2457 if ( $item->in_bundle ) {
2458 my $host = $item->bundle_host;
2459 $messages->{InBundle} = $host;
2462 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2463 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2465 if ( $doreturn and $issue ) {
2466 my $checkin = Koha::Old::Checkouts->find($issue->id);
2468 Koha::Plugins->call('after_circ_action', {
2469 action => 'checkin',
2475 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2477 biblio_ids => [ $item->biblionumber ]
2479 ) if C4::Context->preference('RealTimeHoldsQueue');
2482 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2485 =head2 MarkIssueReturned
2487 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2489 Unconditionally marks an issue as being returned by
2490 moving the C<issues> row to C<old_issues> and
2491 setting C<returndate> to the current date.
2493 if C<$returndate> is specified (in iso format), it is used as the date
2496 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2497 the old_issue is immediately anonymised
2499 Ideally, this function would be internal to C<C4::Circulation>,
2500 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2501 and offline_circ/process_koc.pl.
2503 The last optional parameter allos passing skip_record_index to the item store call.
2507 sub MarkIssueReturned {
2508 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2510 # Retrieve the issue
2511 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2513 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2515 my $issue_id = $issue->issue_id;
2517 my $schema = Koha::Database->schema;
2519 # FIXME Improve the return value and handle it from callers
2520 $schema->txn_do(sub {
2522 my $patron = Koha::Patrons->find( $borrowernumber );
2524 # Update the returndate value
2525 if ( $returndate ) {
2526 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2529 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2532 # Create the old_issues entry
2533 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2535 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2536 if ( $privacy && $privacy == 2) {
2537 $old_checkout->anonymize;
2540 # And finally delete the issue
2543 $issue->item->onloan(undef)->store(
2545 skip_record_index => $params->{skip_record_index},
2546 skip_holds_queue => $params->{skip_holds_queue}
2550 if ( C4::Context->preference('StoreLastBorrower') ) {
2551 my $item = Koha::Items->find( $itemnumber );
2552 $item->last_returned_by( $patron );
2555 # Remove any OVERDUES related debarment if the borrower has no overdues
2556 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2557 && $patron->debarred
2558 && !$patron->has_overdues
2559 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2561 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2569 =head2 _debar_user_on_return
2571 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2573 C<$borrower> borrower hashref
2575 C<$item> item hashref
2577 C<$datedue> date due DateTime object
2579 C<$returndate> DateTime object representing the return time
2581 Internal function, called only by AddReturn that calculates and updates
2582 the user fine days, and debars them if necessary.
2584 Should only be called for overdue returns
2586 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2591 sub _calculate_new_debar_dt {
2592 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2594 my $branchcode = _GetCircControlBranch( $item, $borrower );
2595 my $circcontrol = C4::Context->preference('CircControl');
2596 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2597 { categorycode => $borrower->{categorycode},
2598 itemtype => $item->{itype},
2599 branchcode => $branchcode,
2604 'maxsuspensiondays',
2605 'suspension_chargeperiod',
2609 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2610 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2611 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2613 return unless $finedays;
2615 # finedays is in days, so hourly loans must multiply by 24
2616 # thus 1 hour late equals 1 day suspension * finedays rate
2617 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2619 # grace period is measured in the same units as the loan
2621 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2623 my $deltadays = DateTime::Duration->new(
2624 days => $chargeable_units
2627 if ( $deltadays->subtract($grace)->is_positive() ) {
2628 my $suspension_days = $deltadays * $finedays;
2630 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2631 # No need to / 1 and do not consider / 0
2632 $suspension_days = DateTime::Duration->new(
2633 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2637 # If the max suspension days is < than the suspension days
2638 # the suspension days is limited to this maximum period.
2639 my $max_sd = $issuing_rule->{maxsuspensiondays};
2640 if ( defined $max_sd && $max_sd ne '' ) {
2641 $max_sd = DateTime::Duration->new( days => $max_sd );
2642 $suspension_days = $max_sd
2643 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2646 my ( $has_been_extended );
2647 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2648 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2650 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2651 $has_been_extended = 1;
2656 # Use the calendar or not to calculate the debarment date
2657 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2658 my $calendar = Koha::Calendar->new(
2659 branchcode => $branchcode,
2660 days_mode => 'Calendar'
2662 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2665 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2667 return $new_debar_dt;
2672 sub _debar_user_on_return {
2673 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2675 $return_date //= dt_from_string();
2677 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2679 return unless $new_debar_dt;
2681 Koha::Patron::Debarments::AddUniqueDebarment({
2682 borrowernumber => $borrower->{borrowernumber},
2683 expiration => $new_debar_dt->ymd(),
2684 type => 'SUSPENSION',
2686 # if borrower was already debarred but does not get an extra debarment
2687 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2688 my ($new_debarment_str, $is_a_reminder);
2689 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2691 $new_debarment_str = $borrower->{debarred};
2693 $new_debarment_str = $new_debar_dt->ymd();
2695 # FIXME Should return a DateTime object
2696 return $new_debarment_str, $is_a_reminder;
2699 =head2 _FixOverduesOnReturn
2701 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2703 C<$borrowernumber> borrowernumber
2705 C<$itemnumber> itemnumber
2707 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2709 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2715 sub _FixOverduesOnReturn {
2716 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2717 unless( $borrowernumber ) {
2718 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2722 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2726 warn "_FixOverduesOnReturn() not supplied valid status";
2730 my $schema = Koha::Database->schema;
2732 my $result = $schema->txn_do(
2734 # check for overdue fine
2735 my $accountlines = Koha::Account::Lines->search(
2737 borrowernumber => $borrowernumber,
2738 itemnumber => $item,
2739 debit_type_code => 'OVERDUE',
2740 status => 'UNRETURNED'
2743 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2745 my $accountline = $accountlines->next;
2746 my $payments = $accountline->credits;
2748 my $amountoutstanding = $accountline->amountoutstanding;
2749 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2750 $accountline->delete;
2751 return 0; # no warning, we've just removed a zero value fine (backdated return)
2752 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2753 my $account = Koha::Account->new({patron_id => $borrowernumber});
2754 my $credit = $account->add_credit(
2756 amount => $amountoutstanding,
2757 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2758 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2759 interface => C4::Context->interface,
2765 $credit->apply({ debits => [ $accountline ] });
2767 if (C4::Context->preference("FinesLog")) {
2768 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2772 $accountline->status($status);
2773 return $accountline->store();
2780 =head2 _GetCircControlBranch
2782 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2786 Return the library code to be used to determine which circulation
2787 policy applies to a transaction. Looks up the CircControl and
2788 HomeOrHoldingBranch system preferences.
2790 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2792 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2796 sub _GetCircControlBranch {
2797 my ($item, $borrower) = @_;
2798 my $circcontrol = C4::Context->preference('CircControl');
2801 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2802 $branch= C4::Context->userenv->{'branch'};
2803 } elsif ($circcontrol eq 'PatronLibrary') {
2804 $branch=$borrower->{branchcode};
2806 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2807 $branch = $item->{$branchfield};
2808 # default to item home branch if holdingbranch is used
2809 # and is not defined
2810 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2811 $branch = $item->{homebranch};
2817 =head2 GetUpcomingDueIssues
2819 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2823 sub GetUpcomingDueIssues {
2826 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2827 my $dbh = C4::Context->dbh;
2830 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2832 LEFT JOIN items USING (itemnumber)
2833 LEFT JOIN branches ON branches.branchcode =
2835 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2836 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2837 my @bind_parameters = ( $params->{'days_in_advance'} );
2839 my $sth = $dbh->prepare( $statement );
2840 $sth->execute( @bind_parameters );
2841 my $upcoming_dues = $sth->fetchall_arrayref({});
2843 return $upcoming_dues;
2846 =head2 CanBookBeRenewed
2848 ($ok,$error,$info) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2850 Find out whether a borrowed item may be renewed.
2852 C<$borrowernumber> is the borrower number of the patron who currently
2853 has the item on loan.
2855 C<$itemnumber> is the number of the item to renew.
2857 C<$override_limit>, if supplied with a true value, causes
2858 the limit on the number of times that the loan can be renewed
2859 (as controlled by the item type) to be ignored. Overriding also allows
2860 to renew sooner than "No renewal before" and to manually renew loans
2861 that are automatically renewed.
2863 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2864 item must currently be on loan to the specified borrower; renewals
2865 must be allowed for the item's type; and the borrower must not have
2866 already renewed the loan.
2867 $error will contain the reason the renewal can not proceed
2868 $info will contain a hash of additional info
2869 currently 'soonest_renew_date' if error is 'too soon'
2873 sub CanBookBeRenewed {
2874 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2876 my $auto_renew = "no";
2879 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2880 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2881 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2882 return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2884 my $patron = $issue->patron or return;
2886 # override_limit will override anything else except on_reserve
2887 unless ( $override_limit ){
2888 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2889 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2891 categorycode => $patron->categorycode,
2892 itemtype => $item->effective_itemtype,
2893 branchcode => $branchcode,
2897 'unseen_renewals_allowed'
2902 return ( 0, "too_many" )
2903 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2905 return ( 0, "too_unseen" )
2906 if C4::Context->preference('UnseenRenewals') &&
2907 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2908 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2910 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2911 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2912 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2913 my $restricted = $patron->is_debarred;
2914 my $hasoverdues = $patron->has_overdues;
2916 if ( $restricted and $restrictionblockrenewing ) {
2917 return ( 0, 'restriction');
2918 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2919 return ( 0, 'overdue');
2922 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2925 branchcode => $branchcode,
2928 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2929 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2930 # extra notices being sent. Cron also implies no override
2931 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2932 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2933 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2936 if ( C4::Context->preference('UseRecalls') ) {
2938 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2939 if ( defined $recall ) {
2940 if ( $recall->item_level ) {
2941 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2942 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
2944 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2945 return ( 0, 'recalled' ) unless ( $recall->waiting );
2950 my $fillable_holds = Koha::Holds->search(
2952 biblionumber => $item->biblionumber,
2955 reservedate => { '<=' => \'NOW()' },
2958 { prefetch => 'patron' }
2960 if ( $fillable_holds->count ) {
2961 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
2962 my @possible_holds = $fillable_holds->as_list;
2964 # Get all other items that could possibly fill reserves
2965 # FIXME We could join reserves (or more tables) here to eliminate some checks later
2966 my @other_items = Koha::Items->search({
2967 biblionumber => $item->biblionumber,
2970 -not => { itemnumber => $itemnumber } })->as_list;
2972 return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
2975 foreach my $possible_hold (@possible_holds) {
2977 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
2978 my $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron_with_reserve });
2980 # FIXME: We are not checking whether the item we are renewing can fill the hold
2982 foreach my $other_item (@other_items) {
2983 next if defined $matched_items{$other_item->itemnumber};
2984 next if IsItemOnHoldAndFound( $other_item->itemnumber );
2985 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef, $items_any_available);
2986 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2987 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
2988 # CanItemBeReserved checks 'rules' and 'policies' which means
2989 # items will fill holds at checkin that are rejected here
2991 $matched_items{$other_item->itemnumber} = 1;
2994 return ( 0, "on_reserve" ) unless $fillable;
2998 my ($status, $matched_reserve, $possible_reserves) = CheckReserves($itemnumber);
2999 return ( 0, "on_reserve" ) if $status;
3003 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3004 $soonest = GetSoonestRenewDate($issue);
3005 if ( $soonest > dt_from_string() ){
3006 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3009 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3011 return ( 1, undef );
3016 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
3020 C<$borrowernumber> is the borrower number of the patron who currently
3023 C<$itemnumber> is the number of the item to renew.
3025 C<$branch> is the library where the renewal took place (if any).
3026 The library that controls the circ policies for the renewal is retrieved from the issues record.
3028 C<$datedue> can be a DateTime object used to set the due date.
3030 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3031 this parameter is not supplied, lastreneweddate is set to the current date.
3033 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3034 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3035 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3038 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3039 from the book's item type.
3041 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3042 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3043 fallback to a true value
3048 my $borrowernumber = shift;
3049 my $itemnumber = shift or return;
3051 my $datedue = shift;
3052 my $lastreneweddate = shift || dt_from_string();
3053 my $skipfinecalc = shift;
3056 # Fallback on a 'seen' renewal
3057 $seen = defined $seen && $seen == 0 ? 0 : 1;
3059 my $item_object = Koha::Items->find($itemnumber) or return;
3060 my $biblio = $item_object->biblio;
3061 my $issue = $item_object->checkout;
3062 my $item_unblessed = $item_object->unblessed;
3064 my $dbh = C4::Context->dbh;
3066 return unless $issue;
3068 $borrowernumber ||= $issue->borrowernumber;
3070 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3071 $datedue = dt_from_string($datedue, 'sql');
3074 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3075 my $patron_unblessed = $patron->unblessed;
3077 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3079 my $schema = Koha::Database->schema;
3080 $schema->txn_do(sub{
3082 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3083 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3085 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3087 # If the due date wasn't specified, calculate it by adding the
3088 # book's loan length to today's date or the current due date
3089 # based on the value of the RenewalPeriodBase syspref.
3090 my $itemtype = $item_object->effective_itemtype;
3093 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3094 dt_from_string( $issue->date_due, 'sql' ) :
3096 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3099 my $fees = Koha::Charges::Fees->new(
3102 library => $circ_library,
3103 item => $item_object,
3104 from_date => dt_from_string( $issue->date_due, 'sql' ),
3105 to_date => dt_from_string($datedue),
3109 # Increment the unseen renewals, if appropriate
3110 # We only do so if the syspref is enabled and
3111 # a maximum value has been set in the circ rules
3112 my $unseen_renewals = $issue->unseen_renewals;
3113 if (C4::Context->preference('UnseenRenewals')) {
3114 my $rule = Koha::CirculationRules->get_effective_rule(
3115 { categorycode => $patron->categorycode,
3116 itemtype => $item_object->effective_itemtype,
3117 branchcode => $circ_library->branchcode,
3118 rule_name => 'unseen_renewals_allowed'
3121 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3124 # If the renewal is seen, unseen should revert to 0
3125 $unseen_renewals = 0;
3129 # Update the issues record to have the new due date, and a new count
3130 # of how many times it has been renewed.
3131 my $renews = ( $issue->renewals_count || 0 ) + 1;
3132 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3135 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3138 Koha::Exceptions::Checkout::FailedRenewal->throw(
3139 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3143 # Update the renewal count on the item, and tell zebra to reindex
3144 $renews = ( $item_object->renewals || 0 ) + 1;
3145 $item_object->renewals($renews);
3146 $item_object->onloan($datedue);
3147 $item_object->store({ log_action => 0 });
3149 # Charge a new rental fee, if applicable
3150 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3151 if ( $charge > 0 ) {
3152 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3155 # Charge a new accumulate rental fee, if applicable
3156 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3157 if ( $itemtype_object ) {
3158 my $accumulate_charge = $fees->accumulate_rentalcharge();
3159 if ( $accumulate_charge > 0 ) {
3160 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3162 $charge += $accumulate_charge;
3165 # Send a renewal slip according to checkout alert preferencei
3166 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3167 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3169 branchcode => $branch,
3170 categorycode => $patron->categorycode,
3171 item_type => $itemtype,
3172 notification => 'CHECKOUT',
3174 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3175 SendCirculationAlert(
3178 item => $item_unblessed,
3179 borrower => $patron->unblessed,
3186 # Remove any OVERDUES related debarment if the borrower has no overdues
3188 && $patron->is_debarred
3189 && ! $patron->has_overdues
3190 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3192 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3195 # Add renewal record
3196 my $renewal = Koha::Checkouts::Renewal->new(
3198 checkout_id => $issue->issue_id,
3199 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3201 interface => C4::Context->interface
3205 # Add the renewal to stats
3206 C4::Stats::UpdateStats(
3208 branch => $item_object->renewal_branchcode({branch => $branch}),
3211 itemnumber => $itemnumber,
3212 itemtype => $itemtype,
3213 location => $item_object->location,
3214 borrowernumber => $borrowernumber,
3215 ccode => $item_object->ccode,
3216 categorycode => $patron->categorycode,
3221 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3223 Koha::Plugins->call('after_circ_action', {
3224 action => 'renewal',
3226 checkout => $issue->get_from_storage
3235 # check renewal status
3236 my ( $bornum, $itemno ) = @_;
3237 my $dbh = C4::Context->dbh;
3239 my $unseencount = 0;
3240 my $renewsallowed = 0;
3241 my $unseenallowed = 0;
3245 my $patron = Koha::Patrons->find( $bornum );
3246 my $item = Koha::Items->find($itemno);
3248 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3250 # Look in the issues table for this item, lent to this borrower,
3251 # and not yet returned.
3253 # FIXME - I think this function could be redone to use only one SQL call.
3254 my $sth = $dbh->prepare(
3255 "select * from issues
3256 where (borrowernumber = ?)
3257 and (itemnumber = ?)"
3259 $sth->execute( $bornum, $itemno );
3260 my $data = $sth->fetchrow_hashref;
3261 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3262 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3263 # $item and $borrower should be calculated
3264 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3266 my $rules = Koha::CirculationRules->get_effective_rules(
3268 categorycode => $patron->categorycode,
3269 itemtype => $item->effective_itemtype,
3270 branchcode => $branchcode,
3271 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3274 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3275 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3276 $rules->{unseen_renewals_allowed} :
3278 $renewsleft = $renewsallowed - $renewcount;
3279 $unseenleft = $unseenallowed - $unseencount;
3280 if($renewsleft < 0){ $renewsleft = 0; }
3281 if($unseenleft < 0){ $unseenleft = 0; }
3292 =head2 GetSoonestRenewDate
3294 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($checkout);
3296 Find out the soonest possible renew date of a borrowed item.
3298 C<$checkout> is the checkout object to renew.
3300 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3301 renew date, based on the value "No renewal before" of the applicable
3302 issuing rule. Returns the current date if the item can already be
3303 renewed, and returns undefined if the patron, item, or checkout
3308 sub GetSoonestRenewDate {
3309 my ( $checkout ) = @_;
3311 my $item = $checkout->item or return;
3312 my $patron = $checkout->patron or return;
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( $checkout->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 ( $checkout->auto_renew && $patron->autorenew_checkouts ) {
3342 # Checkouts with auto-renewing fall back to due date
3343 my $soonestrenewal = dt_from_string( $checkout->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 = $item->checkout;
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 = $item->checkout;
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 $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4342 my $control_branchcode =
4343 ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4344 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4345 : $issue->branchcode;
4347 my $date_returned = $return_date ? $return_date : dt_from_string();
4349 my ( $amount, $unitcounttotal, $unitcount ) =
4350 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4352 if ( C4::Context->preference('finesMode') eq 'production' ) {
4353 if ( $amount > 0 ) {
4354 C4::Overdues::UpdateFine({
4355 issue_id => $issue->issue_id,
4356 itemnumber => $issue->itemnumber,
4357 borrowernumber => $issue->borrowernumber,
4362 elsif ($return_date) {
4364 # Backdated returns may have fines that shouldn't exist,
4365 # so in this case, we need to drop those fines to 0
4367 C4::Overdues::UpdateFine({
4368 issue_id => $issue->issue_id,
4369 itemnumber => $issue->itemnumber,
4370 borrowernumber => $issue->borrowernumber,
4378 sub _CanBookBeAutoRenewed {
4379 my ( $params ) = @_;
4380 my $patron = $params->{patron};
4381 my $item = $params->{item};
4382 my $branchcode = $params->{branchcode};
4383 my $issue = $params->{issue};
4385 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4387 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4389 categorycode => $patron->categorycode,
4390 itemtype => $item->effective_itemtype,
4391 branchcode => $branchcode,
4393 'no_auto_renewal_after',
4394 'no_auto_renewal_after_hard_limit',
4401 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4402 return 'auto_account_expired';
4405 if ( defined $issuing_rule->{no_auto_renewal_after}
4406 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4407 # Get issue_date and add no_auto_renewal_after
4408 # If this is greater than today, it's too late for renewal.
4409 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4410 $maximum_renewal_date->add(
4411 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4413 my $now = dt_from_string;
4414 if ( $now >= $maximum_renewal_date ) {
4415 return "auto_too_late";
4418 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4419 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4420 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4421 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4422 return "auto_too_late";
4426 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4427 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4428 my $amountoutstanding =
4429 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4430 ? $patron->account->balance
4431 : $patron->account->outstanding_debits->total_outstanding;
4432 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4433 return "auto_too_much_oweing";
4437 my $soonest = GetSoonestRenewDate($issue);
4438 if ( $soonest > dt_from_string() )
4440 return ( "auto_too_soon", $soonest );
4453 Koha Development Team <http://koha-community.org/>