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 );
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 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 blessed );
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 = $item->checkout;
374 AddReturn( $barcode, $fbr );
375 $messages->{'WasReturned'} = $issue->borrowernumber;
379 # That'll save a database query.
380 my ( $resfound, $resrec, undef ) =
381 CheckReserves( $item );
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 ($patron, $item, $params) = @_;
418 my $onsite_checkout = $params->{onsite_checkout} || 0;
419 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
420 my $cat_borrower = $patron->categorycode;
421 my $dbh = C4::Context->dbh;
422 # Get which branchcode we need
423 my $branch = _GetCircControlBranch($item, $patron);
424 my $type = $item->effective_itemtype;
426 my ($type_object, $parent_type, $parent_maxissueqty_rule);
427 $type_object = Koha::ItemTypes->find( $type );
428 $parent_type = $type_object->parent_type if $type_object;
429 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
430 # Find any children if we are a parent_type;
432 # given branch, patron category, and item type, determine
433 # applicable issuing rule
435 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
437 categorycode => $cat_borrower,
438 itemtype => $parent_type,
439 branchcode => $branch,
440 rule_name => 'maxissueqty',
443 # If the parent rule is for default type we discount it
444 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
446 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
448 categorycode => $cat_borrower,
450 branchcode => $branch,
451 rule_name => 'maxissueqty',
455 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
457 categorycode => $cat_borrower,
459 branchcode => $branch,
460 rule_name => 'maxonsiteissueqty',
464 # if a rule is found and has a loan limit set, count
465 # how many loans the patron already has that meet that
467 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
470 if ( $maxissueqty_rule->branchcode ) {
471 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
472 $checkouts = $patron->checkouts->search(
473 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
474 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
475 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
477 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
478 $checkouts = $patron->checkouts->search(
479 { "item.$branch_type" => $maxissueqty_rule->branchcode } );
482 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
484 $checkouts = $checkouts->search(undef, { prefetch => 'item' });
487 my $rule_itemtype = $maxissueqty_rule->itemtype;
490 unless ( $rule_itemtype ) {
491 # matching rule has the default item type, so count only
492 # those existing loans that don't fall under a more
494 @types = Koha::CirculationRules->search(
496 branchcode => $maxissueqty_rule->branchcode,
497 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
498 itemtype => { '!=' => undef },
499 rule_name => 'maxissueqty'
501 )->get_column('itemtype');
503 if ( $parent_maxissueqty_rule ) {
504 # if we have a parent item type then we count loans of the
505 # specific item type or its siblings or parent
506 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
507 @types = $children->get_column('itemtype');
508 push @types, $parent_type;
509 } elsif ( $child_types ) {
510 # If we are a parent type, we need to count all child types and our own type
511 @types = $child_types->get_column('itemtype');
512 push @types, $type; # And don't forget to count our own types
514 # Otherwise only count the specific itemtype
519 while ( my $c = $checkouts->next ) {
520 my $itemtype = $c->item->effective_itemtype;
522 unless ( $rule_itemtype ) {
523 next if grep {$_ eq $itemtype} @types;
525 next unless grep {$_ eq $itemtype} @types;
528 $sum_checkouts->{total}++;
529 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
530 $sum_checkouts->{itemtype}->{$itemtype}++;
533 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
534 my $checkout_count = $sum_checkouts->{total} || 0;
535 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
537 my $checkout_rules = {
538 checkout_count => $checkout_count,
539 onsite_checkout_count => $onsite_checkout_count,
540 onsite_checkout => $onsite_checkout,
541 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
542 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
543 switch_onsite_checkout => $switch_onsite_checkout,
544 circulation_rule => $maxissueqty_rule,
545 onsite_circulation_rule => $maxonsiteissueqty_rule,
547 # If parent rules exists
548 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
549 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
550 my $qty_over = _check_max_qty($checkout_rules);
551 return $qty_over if defined $qty_over;
553 # If the parent rule is less than or equal to the child, we only need check the parent
554 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
555 $checkout_rules->{checkout_count} = $checkout_count_type;
556 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
557 my $qty_over = _check_max_qty($checkout_rules);
558 return $qty_over if defined $qty_over;
561 my $qty_over = _check_max_qty($checkout_rules);
562 return $qty_over if defined $qty_over;
566 # Now count total loans against the limit for the branch
567 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
568 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
570 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
571 $checkouts = $patron->checkouts->search(
572 { 'me.branchcode' => $branch} );
573 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
574 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
576 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
577 $checkouts = $patron->checkouts->search(
578 { "item.$branch_type" => $branch},
579 { prefetch => 'item' } );
582 my $checkout_count = $checkouts->count;
583 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
584 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
585 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
587 my $qty_over = _check_max_qty(
589 checkout_count => $checkout_count,
590 onsite_checkout_count => $onsite_checkout_count,
591 onsite_checkout => $onsite_checkout,
592 max_checkouts_allowed => $max_checkouts_allowed,
593 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
594 switch_onsite_checkout => $switch_onsite_checkout,
595 circulation_rule => $branch_borrower_circ_rule,
598 return $qty_over if defined $qty_over;
601 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
602 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
605 # OK, the patron can issue !!!
611 my $checkout_count = $params->{checkout_count};
612 my $onsite_checkout_count = $params->{onsite_checkout_count};
613 my $onsite_checkout = $params->{onsite_checkout};
614 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
615 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
616 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
617 my $circulation_rule = $params->{circulation_rule};
618 my $onsite_circulation_rule = $params->{onsite_circulation_rule};
620 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
621 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
622 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
624 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
625 count => $onsite_checkout_count,
626 max_allowed => $max_onsite_checkouts_allowed,
627 circulation_rule => $onsite_circulation_rule,
631 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
632 if ( $max_checkouts_allowed eq '' ) { return; }
633 my $delta = $switch_onsite_checkout ? 1 : 0;
634 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
636 reason => 'TOO_MANY_CHECKOUTS',
637 count => $checkout_count,
638 max_allowed => $max_checkouts_allowed,
639 circulation_rule => $circulation_rule,
643 elsif ( not $onsite_checkout ) {
644 if ( $max_checkouts_allowed eq '' ) { return; }
646 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
649 reason => 'TOO_MANY_CHECKOUTS',
650 count => $checkout_count - $onsite_checkout_count,
651 max_allowed => $max_checkouts_allowed,
652 circulation_rule => $circulation_rule,
660 =head2 CanBookBeIssued
662 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
663 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
665 Check if a book can be issued.
667 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
669 IMPORTANT: The assumption by users of this routine is that causes blocking
670 the issue are keyed by uppercase labels and other returned
671 data is keyed in lower case!
675 =item C<$patron> is a Koha::Patron
677 =item C<$barcode> is the bar code of the book being issued.
679 =item C<$duedates> is a DateTime object.
681 =item C<$inprocess> boolean switch
683 =item C<$ignore_reserves> boolean switch
685 =item C<$params> Hashref of additional parameters
688 override_high_holds - Ignore high holds
689 onsite_checkout - Checkout is an onsite checkout that will not leave the library
690 item - Optionally pass the object for the item we are checking out to save a lookup
698 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
699 Possible values are :
705 sticky due date is invalid
709 borrower gone with no address
713 borrower declared it's card lost
719 =head3 UNKNOWN_BARCODE
733 item is restricted (set by ??)
735 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
736 could be prevented, but ones that can be overriden by the operator.
738 Possible values are :
746 renewing, not issuing
748 =head3 ISSUED_TO_ANOTHER
750 issued to someone else.
754 reserved for someone else.
758 reserved and being transferred for someone else.
762 sticky due date is invalid or due date in the past
766 if the borrower borrows to much things
770 recalled by someone else
774 sub CanBookBeIssued {
775 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
776 my %needsconfirmation; # filled with problems that needs confirmations
777 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
778 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
779 my %messages; # filled with information messages that should be displayed.
781 my $onsite_checkout = $params->{onsite_checkout} || 0;
782 my $override_high_holds = $params->{override_high_holds} || 0;
784 my $item_object = $params->{item}
785 // Koha::Items->find( { barcode => $barcode } );
787 # MANDATORY CHECKS - unless item exists, nothing else matters
788 unless ( $item_object ) {
789 $issuingimpossible{UNKNOWN_BARCODE} = 1;
791 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
793 my $item_unblessed = $item_object->unblessed; # Transition...
794 my $issue = $item_object->checkout;
795 my $biblio = $item_object->biblio;
797 my $biblioitem = $biblio->biblioitem;
798 my $effective_itemtype = $item_object->effective_itemtype;
799 my $dbh = C4::Context->dbh;
800 my $patron_unblessed = $patron->unblessed;
802 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
804 my $now = dt_from_string();
805 $duedate ||= CalcDateDue( $now, $effective_itemtype, $circ_library->branchcode, $patron );
806 if (DateTime->compare($duedate,$now) == -1 ) { # duedate cannot be before now
807 $needsconfirmation{INVALID_DATE} = $duedate;
810 my $fees = Koha::Charges::Fees->new(
813 library => $circ_library,
814 item => $item_object,
822 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
823 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
824 C4::Stats::UpdateStats(
826 branch => C4::Context->userenv->{'branch'},
828 itemnumber => $item_object->itemnumber,
829 itemtype => $effective_itemtype,
830 borrowernumber => $patron->borrowernumber,
831 ccode => $item_object->ccode,
832 categorycode => $patron->categorycode,
833 location => $item_object->location,
834 interface => C4::Context->interface,
837 my $block_lost_return = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
838 my ( $stats_return, $stats_messages, $stats_iteminformation, $stats_borrower ) =
839 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
840 ModDateLastSeen( $item_object->itemnumber, $block_lost_return ); # FIXME Move to Koha::Item
844 CHECKEDIN => $stats_return,
845 MESSAGES => $stats_messages,
846 ITEM => $stats_iteminformation,
847 BORROWER => $stats_borrower,
853 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
854 $issuingimpossible{GNA} = 1;
857 if ( $patron->lost && $patron->lost == 1 ) {
858 $issuingimpossible{CARD_LOST} = 1;
860 if ( $patron->is_debarred ) {
861 $issuingimpossible{DEBARRED} = 1;
864 if ( $patron->is_expired ) {
865 $issuingimpossible{EXPIRED} = 1;
873 my $account = $patron->account;
874 my $balance = $account->balance;
875 my $non_issues_charges = $account->non_issues_charges;
876 my $other_charges = $balance - $non_issues_charges;
878 my $amountlimit = C4::Context->preference("noissuescharge");
879 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
880 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
882 # Check the debt of this patrons guarantees
883 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
884 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
885 if ( defined $no_issues_charge_guarantees ) {
886 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
887 my $guarantees_non_issues_charges = 0;
888 foreach my $g ( @guarantees ) {
889 $guarantees_non_issues_charges += $g->account->non_issues_charges;
892 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
893 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
894 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
895 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
896 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
897 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
901 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
902 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
903 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
904 if ( defined $no_issues_charge_guarantors ) {
905 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
907 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
908 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
909 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
910 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
911 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
912 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
916 if ( C4::Context->preference("IssuingInProcess") ) {
917 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
918 $issuingimpossible{DEBT} = $non_issues_charges;
919 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
920 $needsconfirmation{DEBT} = $non_issues_charges;
921 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
922 $needsconfirmation{DEBT} = $non_issues_charges;
926 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
927 $needsconfirmation{DEBT} = $non_issues_charges;
928 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
929 $issuingimpossible{DEBT} = $non_issues_charges;
930 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
931 $needsconfirmation{DEBT} = $non_issues_charges;
935 if ($balance > 0 && $other_charges > 0) {
936 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
939 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
940 $patron_unblessed = $patron->unblessed;
942 if ( my $debarred_date = $patron->is_debarred ) {
943 # patron has accrued fine days or has a restriction. $count is a date
944 if ($debarred_date eq '9999-12-31') {
945 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
948 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
950 } elsif ( my $num_overdues = $patron->has_overdues ) {
951 ## patron has outstanding overdue loans
952 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
953 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
955 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
956 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
960 # Additional Materials Check
961 if ( C4::Context->preference("CircConfirmItemParts")
962 && $item_object->materials )
964 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
968 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
970 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
972 # Already issued to current borrower.
973 # If it is an on-site checkout if it can be switched to a normal checkout
974 # or ask whether the loan should be renewed
976 if ( $issue->onsite_checkout
977 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
978 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
980 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed($patron, $issue);
981 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
982 if ( $renewerror eq 'onsite_checkout' ) {
983 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
986 $issuingimpossible{NO_MORE_RENEWALS} = 1;
990 $needsconfirmation{RENEW_ISSUE} = 1;
996 # issued to someone else
998 my $patron = Koha::Patrons->find( $issue->borrowernumber );
1000 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1002 if ( !$can_be_returned ) {
1003 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
1004 $issuingimpossible{branch_to_return} = $message;
1006 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
1007 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
1010 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
1011 $needsconfirmation{issued_firstname} = $patron->firstname;
1012 $needsconfirmation{issued_surname} = $patron->surname;
1013 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
1014 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
1019 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1021 my $switch_onsite_checkout = (
1022 C4::Context->preference('SwitchOnSiteCheckouts')
1024 and $issue->onsite_checkout
1025 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1026 my $toomany = TooMany( $patron, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1027 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1028 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1029 if ( $toomany->{max_allowed} == 0 ) {
1030 $needsconfirmation{PATRON_CANT} = 1;
1031 $needsconfirmation{circulation_rule_PATRON_CANT} = $toomany->{circulation_rule};
1033 if ( C4::Context->preference("AllowTooManyOverride") ) {
1034 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1035 $needsconfirmation{current_loan_count} = $toomany->{count};
1036 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1037 $needsconfirmation{circulation_rule_TOO_MANY} = $toomany->{circulation_rule};
1039 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1040 $issuingimpossible{current_loan_count} = $toomany->{count};
1041 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1042 $needsconfirmation{circulation_rule_TOO_MANY} = $toomany->{circulation_rule};
1047 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1049 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1050 if ( $patron->wants_check_for_previous_checkout && $patron->do_check_for_previous_checkout($item_unblessed) ) {
1051 $needsconfirmation{PREVISSUE} = 1;
1057 if ( $item_object->notforloan )
1059 if(!C4::Context->preference("AllowNotForLoanOverride")){
1060 $issuingimpossible{NOT_FOR_LOAN} = 1;
1061 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1063 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1064 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1068 # we have to check itemtypes.notforloan also
1069 if (C4::Context->preference('item-level_itypes')){
1070 # this should probably be a subroutine
1071 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1072 $sth->execute($effective_itemtype);
1073 my $notforloan=$sth->fetchrow_hashref();
1074 if ($notforloan->{'notforloan'}) {
1075 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1076 $issuingimpossible{NOT_FOR_LOAN} = 1;
1077 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1079 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1080 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1085 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1086 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1087 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1088 $issuingimpossible{NOT_FOR_LOAN} = 1;
1089 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1091 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1092 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1097 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1099 $issuingimpossible{WTHDRAWN} = 1;
1101 if ( $item_object->restricted
1102 && $item_object->restricted == 1 )
1104 $issuingimpossible{RESTRICTED} = 1;
1106 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1107 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1108 my $code = $av->count ? $av->next->lib : '';
1109 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1110 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1112 if ( C4::Context->preference("IndependentBranches") ) {
1113 my $userenv = C4::Context->userenv;
1114 unless ( C4::Context->IsSuperLibrarian() ) {
1115 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1116 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1117 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1118 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1120 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1121 if ( $patron->branchcode ne $userenv->{branch} );
1126 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1128 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1129 if ($rentalConfirmation) {
1130 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1132 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1133 if ($itemtype_object) {
1134 my $accumulate_charge = $fees->accumulate_rentalcharge();
1135 if ( $accumulate_charge > 0 ) {
1136 $rentalCharge += $accumulate_charge;
1140 if ( $rentalCharge > 0 ) {
1141 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1146 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1147 # Only bother doing this if UseRecalls is enabled and the item is recallable
1148 # Don't look at recalls that are in transit
1149 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1150 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1152 foreach my $r ( @recalls ) {
1153 if ( $r->item_id and
1154 $r->item_id == $item_object->itemnumber and
1155 $r->patron_id == $patron->borrowernumber and
1156 ( $r->waiting or $r->requested ) ) {
1157 $messages{RECALLED} = $r->id;
1159 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1162 elsif ( $r->item_id and
1163 $r->item_id == $item_object->itemnumber and
1165 # recalled item is in transit
1166 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1168 elsif ( $r->item_level and
1169 $r->item_id == $item_object->itemnumber and
1170 $r->patron_id != $patron->borrowernumber and
1172 # this specific item has been recalled by a different patron
1173 $needsconfirmation{RECALLED} = $r;
1177 elsif ( !$r->item_level and
1178 $r->patron_id != $patron->borrowernumber and
1180 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1181 $needsconfirmation{RECALLED} = $r;
1188 unless ( $ignore_reserves and defined $recall ) {
1189 # See if the item is on reserve.
1190 my ( $restype, $res ) = CheckReserves( $item_object );
1192 my $resbor = $res->{'borrowernumber'};
1193 if ( $resbor ne $patron->borrowernumber ) {
1194 my $patron = Koha::Patrons->find( $resbor );
1195 if ( $restype eq "Waiting" )
1197 # The item is on reserve and waiting, but has been
1198 # reserved by some other patron.
1199 $needsconfirmation{RESERVE_WAITING} = 1;
1200 $needsconfirmation{'resfirstname'} = $patron->firstname;
1201 $needsconfirmation{'ressurname'} = $patron->surname;
1202 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1203 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1204 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1205 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1206 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1208 elsif ( $restype eq "Reserved" ) {
1209 # The item is on reserve for someone else.
1210 $needsconfirmation{RESERVED} = 1;
1211 $needsconfirmation{'resfirstname'} = $patron->firstname;
1212 $needsconfirmation{'ressurname'} = $patron->surname;
1213 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1214 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1215 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1216 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1217 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1219 elsif ( $restype eq "Transferred" ) {
1220 # The item is determined hold being transferred for someone else.
1221 $needsconfirmation{TRANSFERRED} = 1;
1222 $needsconfirmation{'resfirstname'} = $patron->firstname;
1223 $needsconfirmation{'ressurname'} = $patron->surname;
1224 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1225 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1226 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1227 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1228 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1230 elsif ( $restype eq "Processing" ) {
1231 # The item is determined hold being processed for someone else.
1232 $needsconfirmation{PROCESSING} = 1;
1233 $needsconfirmation{'resfirstname'} = $patron->firstname;
1234 $needsconfirmation{'ressurname'} = $patron->surname;
1235 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1236 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1237 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1238 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1239 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1245 ## CHECK FOR BOOKINGS
1247 my $booking = $item_object->find_booking(
1249 checkout_date => $now,
1250 due_date => $duedate,
1251 patron_id => $patron->borrowernumber
1256 # Booked to this patron :)
1257 if ( $booking->patron_id == $patron->borrowernumber ) {
1258 if ( $now < dt_from_string( $booking->start_date ) ) {
1259 $needsconfirmation{'BOOKED_EARLY'} = $booking;
1261 $alerts{'BOOKED'} = $booking;
1265 # Booking starts before due date, reduce loan?
1266 elsif ( $duedate > dt_from_string( $booking->start_date ) ) {
1267 $needsconfirmation{'BOOKED_TO_ANOTHER'} = $booking;
1270 # Loan falls inside booking
1272 $issuingimpossible{'BOOKED_TO_ANOTHER'} = $booking;
1276 ## CHECK AGE RESTRICTION
1277 my $agerestriction = $biblioitem->agerestriction;
1278 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1279 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1280 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1281 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1284 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1288 ## check for high holds decreasing loan period
1289 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1290 my $check = checkHighHolds( $item_object, $patron );
1292 if ( $check->{exceeded} ) {
1294 num_holds => $check->{outstanding},
1295 duration => $check->{duration},
1296 returndate => $check->{due_date},
1298 if ($override_high_holds) {
1299 $alerts{HIGHHOLDS} = $highholds;
1302 $needsconfirmation{HIGHHOLDS} = $highholds;
1308 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1309 # don't do the multiple loans per bib check if we've
1310 # already determined that we've got a loan on the same item
1311 !$issuingimpossible{NO_MORE_RENEWALS} &&
1312 !$needsconfirmation{RENEW_ISSUE}
1314 # Check if borrower has already issued an item from the same biblio
1315 # Only if it's not a subscription
1316 my $biblionumber = $item_object->biblionumber;
1317 require C4::Serials;
1318 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1319 unless ($is_a_subscription) {
1320 # FIXME Should be $patron->checkouts($args);
1321 my $checkouts = Koha::Checkouts->search(
1323 borrowernumber => $patron->borrowernumber,
1324 biblionumber => $biblionumber,
1330 # if we get here, we don't already have a loan on this item,
1331 # so if there are any loans on this bib, ask for confirmation
1332 if ( $checkouts->count ) {
1333 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1338 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1341 =head2 CanBookBeReturned
1343 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1345 Check whether the item can be returned to the provided branch
1349 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1351 =item C<$branch> is the branchcode where the return is taking place
1359 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1361 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1367 sub CanBookBeReturned {
1368 my ($item, $branch) = @_;
1369 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1371 # assume return is allowed to start
1375 # identify all cases where return is forbidden
1376 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1378 $message = $item->{'homebranch'};
1379 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1381 $message = $item->{'holdingbranch'};
1382 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1384 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1387 return ($allowed, $message);
1390 =head2 CheckHighHolds
1392 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1393 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1394 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1398 sub checkHighHolds {
1399 my ( $item, $patron ) = @_;
1400 my $branchcode = _GetCircControlBranch( $item, $patron );
1410 # Count holds on this record, ignoring the borrowers own holds as they would be filled by the checkout
1411 my $holds = Koha::Holds->search({
1412 biblionumber => $item->biblionumber,
1413 borrowernumber => { '!=' => $patron->borrowernumber }
1416 if ( $holds->count() ) {
1417 $return_data->{outstanding} = $holds->count();
1419 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1420 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1421 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1423 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1425 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1427 # static means just more than a given number of holds on the record
1429 # If the number of holds is not above the threshold, we can stop here
1430 if ( $holds->count() <= $decreaseLoanHighHoldsValue ) {
1431 return $return_data;
1434 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1436 # dynamic means X more than the number of holdable items on the record
1438 # let's get the items
1439 my @items = $holds->next()->biblio()->items()->as_list;
1441 # Remove any items with status defined to be ignored even if the would not make item unholdable
1442 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1443 @items = grep { !$_->$status } @items;
1446 # Remove any items that are not holdable for this patron
1447 # We need to ignore hold counts as the borrower's own hold that will be filled by the checkout
1448 # could prevent them from placing further holds
1449 @items = grep { CanItemBeReserved( $patron, $_, undef, { ignore_hold_counts => 1 } )->{status} eq 'OK' } @items;
1451 my $items_count = scalar @items;
1453 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1455 # If the number of holds is less than the count of items we have
1456 # plus the number of holds allowed above that count, we can stop here
1457 if ( $holds->count() <= $threshold ) {
1458 return $return_data;
1462 my $issuedate = dt_from_string();
1464 my $itype = $item->effective_itemtype;
1465 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1467 categorycode => $patron->categorycode,
1469 branchcode => $branchcode,
1472 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1474 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1476 my $rule = Koha::CirculationRules->get_effective_rule_value(
1478 categorycode => $patron->categorycode,
1479 itemtype => $item->effective_itemtype,
1480 branchcode => $branchcode,
1481 rule_name => 'decreaseloanholds',
1486 if ( defined($rule) && $rule ne '' ){
1487 # overrides decreaseLoanHighHoldsDuration syspref
1490 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1492 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1493 $reduced_datedue->set_hour($orig_due->hour);
1494 $reduced_datedue->set_minute($orig_due->minute);
1495 $reduced_datedue->truncate( to => 'minute' );
1497 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1498 $return_data->{exceeded} = 1;
1499 $return_data->{duration} = $duration;
1500 $return_data->{due_date} = $reduced_datedue;
1504 return $return_data;
1509 &AddIssue($patron, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1511 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1515 =item C<$patron> is a patron object.
1517 =item C<$barcode> is the barcode of the item being issued.
1519 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1520 Calculated if empty.
1522 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1524 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1527 AddIssue does the following things :
1529 - step 01: check that there is a borrowernumber & a barcode provided
1530 - check for RENEWAL (book issued & being issued to the same patron)
1531 - renewal YES = Calculate Charge & renew
1533 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1535 - fill reserve if reserve to this patron
1536 - cancel reserve or not, otherwise
1538 - fill recall if recall to this patron
1539 - cancel recall or not
1540 - revert recall's waiting status or not
1541 * TRANSFERT PENDING ?
1542 - complete the transfert
1550 my ( $patron, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1552 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1553 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1554 my $auto_renew = $params && $params->{auto_renew};
1555 my $cancel_recall = $params && $params->{cancel_recall};
1556 my $recall_id = $params && $params->{recall_id};
1557 my $dbh = C4::Context->dbh;
1558 my $barcodecheck = CheckValidBarcode($barcode);
1562 if ( $datedue && ref $datedue ne 'DateTime' ) {
1563 $datedue = dt_from_string($datedue);
1566 # $issuedate defaults to today.
1567 if ( !defined $issuedate ) {
1568 $issuedate = dt_from_string();
1571 if ( ref $issuedate ne 'DateTime' ) {
1572 $issuedate = dt_from_string($issuedate);
1577 # Stop here if the patron or barcode doesn't exist
1578 if ( $patron && $barcode && $barcodecheck ) {
1579 # find which item we issue
1580 my $item_object = Koha::Items->find({ barcode => $barcode })
1581 or return; # if we don't get an Item, abort.
1582 my $item_unblessed = $item_object->unblessed;
1584 my $branchcode = _GetCircControlBranch( $item_object, $patron );
1586 # get actual issuing if there is one
1587 my $actualissue = $item_object->checkout;
1589 # check if we just renew the issue.
1590 if ( $actualissue and $actualissue->borrowernumber eq $patron->borrowernumber
1591 and not $switch_onsite_checkout ) {
1592 $datedue = AddRenewal(
1594 borrowernumber => $patron->borrowernumber,
1595 itemnumber => $item_object->itemnumber,
1596 branch => $branchcode,
1597 datedue => $datedue,
1599 $issuedate, # here interpreted as the renewal date
1602 $issue = $item_object->checkout;
1607 my $itype = $item_object->effective_itemtype;
1608 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1612 # Check if we need to use an exact due date set by the ILL module
1613 if ( C4::Context->preference('ILLModule') ) {
1614 # Check if there is an ILL connected with the biblio of the item we are issuing
1615 my $ill_request = Koha::Illrequests->search({
1616 biblio_id => $item_object->biblionumber,
1617 borrowernumber => $patron->borrowernumber,
1619 due_date => { '!=', undef },
1622 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1623 my $ill_dt = dt_from_string( $ill_request->due_date );
1624 $ill_dt->set_hour(23);
1625 $ill_dt->set_minute(59);
1630 $datedue->truncate( to => 'minute' );
1632 my $library = Koha::Libraries->find( $branchcode );
1633 my $fees = Koha::Charges::Fees->new(
1636 library => $library,
1637 item => $item_object,
1638 to_date => $datedue,
1642 # it's NOT a renewal
1643 if ( $actualissue and not $switch_onsite_checkout ) {
1644 # This book is currently on loan, but not to the person
1645 # who wants to borrow it now. mark it returned before issuing to the new borrower
1646 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1647 return unless $allowed;
1648 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1649 # AddReturn certainly has side-effects, like onloan => undef
1650 $item_object->discard_changes;
1653 if ( C4::Context->preference('UseRecalls') ) {
1654 Koha::Recalls->move_recall(
1656 action => $cancel_recall,
1657 recall_id => $recall_id,
1658 item => $item_object,
1659 borrowernumber => $patron->borrowernumber,
1664 C4::Reserves::MoveReserve( $item_object->itemnumber, $patron->borrowernumber, $cancelreserve );
1666 # Starting process for transfer job (checking transfert and validate it if we have one)
1667 if ( my $transfer = $item_object->get_transfer ) {
1668 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1671 datearrived => dt_from_string,
1672 tobranch => C4::Context->userenv->{branch},
1673 comments => 'Forced branchtransfer'
1676 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1677 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1678 if ( $hold ) { # Is this really needed?
1679 $hold->set( { found => undef } )->store;
1680 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1685 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1686 unless ($auto_renew) {
1687 my $rule = Koha::CirculationRules->get_effective_rule_value(
1689 categorycode => $patron->categorycode,
1690 itemtype => $item_object->effective_itemtype,
1691 branchcode => $branchcode,
1692 rule_name => 'auto_renew'
1696 $auto_renew = $rule if defined $rule && $rule ne '';
1699 my $issue_attributes = {
1700 borrowernumber => $patron->borrowernumber,
1701 issuedate => $issuedate,
1702 date_due => $datedue,
1703 branchcode => C4::Context->userenv->{'branch'},
1704 onsite_checkout => $onsite_checkout,
1705 auto_renew => $auto_renew ? 1 : 0,
1708 # Get ID of logged in user. if called from a batch job,
1709 # no user session exists and C4::Context->userenv() returns
1710 # the scalar '0'. Only do this if the syspref says so
1711 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1712 my $userenv = C4::Context->userenv();
1713 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1715 $issue_attributes->{issuer_id} = $usernumber;
1719 # In the case that the borrower has an on-site checkout
1720 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1721 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1723 $issue->set($issue_attributes)->store;
1726 $issue = Koha::Checkout->new(
1728 itemnumber => $item_object->itemnumber,
1733 $issue->discard_changes;
1734 $patron->update_lastseen('check_out');
1735 if ( $item_object->location && $item_object->location eq 'CART'
1736 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1737 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1738 CartToShelf( $item_object->itemnumber );
1741 # Update item location
1742 $item_object->location_update_trigger( 'checkout' );
1744 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1745 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1748 # Record if item was lost
1749 my $was_lost = $item_object->itemlost;
1751 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1752 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1753 $item_object->itemlost(0);
1754 $item_object->onloan($datedue->ymd());
1755 $item_object->datelastborrowed( dt_from_string()->ymd() );
1756 $item_object->datelastseen( dt_from_string() );
1757 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1759 # If the item was lost, it has now been found, charge the overdue if necessary
1761 if ( $item_object->{_charge} ) {
1762 $actualissue //= Koha::Old::Checkouts->search(
1763 { itemnumber => $item_object->itemnumber },
1765 order_by => { '-desc' => 'returndate' },
1769 unless ( $patron->branchcode ) {
1770 $patron = $actualissue->patron;
1772 _CalculateAndUpdateFine(
1774 issue => $actualissue,
1775 item => $item_unblessed,
1776 borrower => $patron->unblessed,
1777 return_date => $issuedate
1780 _FixOverduesOnReturn( $patron->borrowernumber,
1781 $item_object->itemnumber, undef, 'RENEWED' );
1785 # If it costs to borrow this book, charge it to the patron's account.
1786 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1787 if ( $charge && $charge > 0 ) {
1788 AddIssuingCharge( $issue, $charge, 'RENT' );
1791 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1792 if ( $itemtype_object ) {
1793 my $accumulate_charge = $fees->accumulate_rentalcharge();
1794 if ( $accumulate_charge > 0 ) {
1795 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1796 $charge += $accumulate_charge;
1797 $item_unblessed->{charge} = $charge;
1801 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckout');
1803 $yaml = "$yaml\n\n";
1806 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
1808 warn "Unable to parse UpdateNotForLoanStatusOnCheckout syspref : $@";
1811 foreach my $key ( keys %$rules ) {
1812 if ( $item_object->notforloan eq $key ) {
1813 $item_object->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
1820 # Record the fact that this book was issued.
1821 C4::Stats::UpdateStats(
1823 branch => C4::Context->userenv->{'branch'},
1824 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1826 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1827 itemnumber => $item_object->itemnumber,
1828 itemtype => $item_object->effective_itemtype,
1829 location => $item_object->location,
1830 borrowernumber => $patron->borrowernumber,
1831 ccode => $item_object->ccode,
1832 categorycode => $patron->categorycode
1836 # Send a checkout slip.
1837 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1839 branchcode => $branchcode,
1840 categorycode => $patron->categorycode,
1841 item_type => $item_object->effective_itemtype,
1842 notification => 'CHECKOUT',
1844 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1845 SendCirculationAlert(
1848 item => $item_object->unblessed,
1849 borrower => $patron->unblessed,
1850 branch => $branchcode,
1855 "CIRCULATION", "ISSUE",
1856 $patron->borrowernumber,
1857 $item_object->itemnumber,
1858 ) if C4::Context->preference("IssueLog");
1860 Koha::Plugins->call('after_circ_action', {
1861 action => 'checkout',
1863 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1864 checkout => $issue->get_from_storage
1868 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1870 biblio_ids => [ $item_object->biblionumber ]
1872 ) if C4::Context->preference('RealTimeHoldsQueue');
1878 =head2 GetLoanLength
1880 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1882 Get loan length for an itemtype, a borrower type and a branch
1887 my ( $categorycode, $itemtype, $branchcode ) = @_;
1889 # Initialize default values
1893 lengthunit => 'days',
1896 my $found = Koha::CirculationRules->get_effective_rules( {
1897 branchcode => $branchcode,
1898 categorycode => $categorycode,
1899 itemtype => $itemtype,
1908 foreach my $rule_name (keys %$found) {
1909 $rules->{$rule_name} = $found->{$rule_name};
1916 =head2 GetHardDueDate
1918 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1920 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1924 sub GetHardDueDate {
1925 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1927 my $rules = Koha::CirculationRules->get_effective_rules(
1929 categorycode => $borrowertype,
1930 itemtype => $itemtype,
1931 branchcode => $branchcode,
1932 rules => [ 'hardduedate', 'hardduedatecompare' ],
1936 if ( defined( $rules->{hardduedate} ) ) {
1937 if ( $rules->{hardduedate} ) {
1938 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1941 return ( undef, undef );
1946 =head2 GetBranchBorrowerCircRule
1948 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1950 Retrieves circulation rule attributes that apply to the given
1951 branch and patron category, regardless of item type.
1952 The return value is a hashref containing the following key:
1954 patron_maxissueqty - maximum number of loans that a
1955 patron of the given category can have at the given
1956 branch. If the value is undef, no limit.
1958 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1959 patron of the given category can have at the given
1960 branch. If the value is undef, no limit.
1962 This will check for different branch/category combinations in the following order:
1966 default branch and category
1968 If no rule has been found in the database, it will default to
1971 patron_maxissueqty - undef
1972 patron_maxonsiteissueqty - undef
1974 C<$branchcode> and C<$categorycode> should contain the
1975 literal branch code and patron category code, respectively - no
1980 sub GetBranchBorrowerCircRule {
1981 my ( $branchcode, $categorycode ) = @_;
1983 # Initialize default values
1985 patron_maxissueqty => undef,
1986 patron_maxonsiteissueqty => undef,
1990 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1991 my $rule = Koha::CirculationRules->get_effective_rule(
1993 categorycode => $categorycode,
1995 branchcode => $branchcode,
1996 rule_name => $rule_name,
2000 $rules->{$rule_name} = $rule->rule_value if defined $rule;
2006 =head2 GetBranchItemRule
2008 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
2010 Retrieves circulation rule attributes that apply to the given
2011 branch and item type, regardless of patron category.
2013 The return value is a hashref containing the following keys:
2015 holdallowed => Hold policy for this branch and itemtype. Possible values:
2016 not_allowed: No holds allowed.
2017 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
2018 from_any_library: Holds allowed from any patron.
2019 from_local_hold_group: Holds allowed from libraries in hold group
2021 This searches branchitemrules in the following order:
2023 * Same branchcode and itemtype
2024 * Same branchcode, itemtype '*'
2025 * branchcode '*', same itemtype
2026 * branchcode and itemtype '*'
2028 Neither C<$branchcode> nor C<$itemtype> should be '*'.
2032 sub GetBranchItemRule {
2033 my ( $branchcode, $itemtype ) = @_;
2036 my $rules = Koha::CirculationRules->get_effective_rules({
2037 branchcode => $branchcode,
2038 itemtype => $itemtype,
2039 rules => ['holdallowed', 'hold_fulfillment_policy']
2042 # built-in default circulation rule
2043 $rules->{holdallowed} //= 'from_any_library';
2044 $rules->{hold_fulfillment_policy} //= 'any';
2051 ($doreturn, $messages, $iteminformation, $borrower) =
2052 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
2058 =item C<$barcode> is the bar code of the book being returned.
2060 =item C<$branch> is the code of the branch where the book is being returned.
2062 =item C<$exemptfine> indicates that overdue charges for the item will be
2065 =item C<$return_date> allows the default return date to be overridden
2066 by the given return date. Optional.
2070 C<&AddReturn> returns a list of four items:
2072 C<$doreturn> is true iff the return succeeded.
2074 C<$messages> is a reference-to-hash giving feedback on the operation.
2075 The keys of the hash are:
2081 No item with this barcode exists. The value is C<$barcode>.
2085 The book is not currently on loan. The value is C<$barcode>.
2089 This book has been withdrawn/cancelled. The value should be ignored.
2091 =item C<Wrongbranch>
2093 This book has was returned to the wrong branch. The value is a hashref
2094 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2095 contain the branchcode of the incorrect and correct return library, respectively.
2099 The item was reserved. The value is a reference-to-hash whose keys are
2100 fields from the reserves table of the Koha database, and
2101 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2102 either C<Waiting>, C<Reserved>, or 0.
2104 =item C<WasReturned>
2106 Value 1 if return is successful.
2108 =item C<NeedsTransfer>
2110 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2112 =item C<RecallFound>
2114 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2115 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2118 =item C<TransferredRecall>
2120 This item has been transferred to this branch to fill a recall. The recall object is returned.
2124 C<$iteminformation> is a reference-to-hash, giving information about the
2125 returned item from the issues table.
2127 C<$borrower> is a reference-to-hash, giving information about the
2128 patron who last borrowed the book.
2133 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2135 if ($branch and not Koha::Libraries->find($branch)) {
2136 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2139 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2140 my $return_date_specified = !!$return_date;
2141 $return_date //= dt_from_string();
2145 my $validTransfer = 1;
2146 my $stat_type = 'return';
2148 # get information on item
2149 my $item = Koha::Items->find({ barcode => $barcode });
2151 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2154 my $itemnumber = $item->itemnumber;
2155 my $itemtype = $item->effective_itemtype;
2157 my $issue = $item->checkout;
2159 $patron = $issue->patron
2160 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2161 . Dumper($issue->unblessed) . "\n";
2163 $messages->{'NotIssued'} = $barcode;
2164 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2166 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2168 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2169 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2170 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2171 $messages->{'LocalUse'} = 1;
2172 $stat_type = 'localuse';
2176 if ( $item->withdrawn ) { # book has been cancelled
2177 $messages->{'withdrawn'} = 1;
2179 # In the case where we block return of withdrawn, we should completely block the return
2180 # without updating item statuses, so we exit early
2181 return ( 0, $messages, $issue, ( $patron ? $patron->unblessed : {} ))
2182 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2186 # full item data, but no borrowernumber or checkout info (no issue)
2187 my $hbr = Koha::CirculationRules->get_return_branch_policy($item);
2189 # check if returnbranch and homebranch belong to the same float group
2190 my $validate_float =
2191 Koha::Libraries->find( $item->homebranch )->validate_float_sibling( { branchcode => $branch } );
2193 # get the proper branch to which to return the item
2195 if ( $hbr eq 'noreturn' ) {
2196 $returnbranch = $branch;
2197 } elsif ( $hbr eq 'returnbylibrarygroup' ) {
2199 # if library isn't in same the float group, transfer item to homebranch
2200 $hbr = 'homebranch';
2201 $returnbranch = $validate_float ? $branch : $item->$hbr;
2203 $returnbranch = $item->$hbr;
2206 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2207 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2209 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2210 my $patron_unblessed = $patron ? $patron->unblessed : {};
2212 # Update item location
2213 my $loc_messages = $item->location_update_trigger( 'checkin' );
2214 foreach my $loc_msg_key ( keys %$loc_messages ) {
2215 $messages->{ $loc_msg_key } = $loc_messages->{ $loc_msg_key };
2218 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2220 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2222 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2224 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2227 if ( defined $rules->{$item->itype} ) {
2228 foreach my $notloan_rule_key (keys %{ $rules->{$item->itype}} ) {
2229 if ( $item->notforloan eq $notloan_rule_key ) {
2230 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$item->itype}->{$notloan_rule_key} };
2231 $item->notforloan($rules->{$item->itype}->{$notloan_rule_key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2235 } elsif ( defined $rules->{'_ALL_'} ) {
2236 foreach my $notloan_rule_key (keys %{ $rules->{'_ALL_'}} ) {
2237 if ( $item->notforloan eq $notloan_rule_key ) {
2238 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{'_ALL_'}->{$notloan_rule_key} };
2239 $item->notforloan($rules->{'_ALL_'}->{$notloan_rule_key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2247 # check if the return is allowed at this branch
2248 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2249 unless ($returnallowed){
2250 $messages->{'Wrongbranch'} = {
2251 Wrongbranch => $branch,
2252 Rightbranch => $message
2255 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2256 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2257 return ( $doreturn, $messages, $issue, $patron_unblessed);
2260 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2264 # case of a return of document (deal with issues and holdingbranch)
2266 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2267 $patron or warn "AddReturn without current borrower";
2271 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2276 C4::Context->preference('CalculateFinesOnReturn')
2277 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2282 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2285 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 );
2287 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2288 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2290 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2293 # FIXME is the "= 1" right? This could be the borrower hash.
2294 $messages->{'WasReturned'} = 1;
2297 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2301 # the holdingbranch is updated if the document is returned to another location.
2302 # this is always done regardless of whether the item was on loan or not
2303 if ($item->holdingbranch ne $branch) {
2304 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2307 my $item_was_lost = $item->itemlost;
2308 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2309 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2311 # fix up the accounts.....
2312 if ($item_was_lost) {
2313 $messages->{'WasLost'} = 1;
2314 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2315 my @object_messages = @{ $updated_item->object_messages };
2316 for my $message (@object_messages) {
2317 $messages->{'LostItemFeeRefunded'} = 1
2318 if $message->message eq 'lost_refunded';
2319 $messages->{'ProcessingFeeRefunded'} = 1
2320 if $message->message eq 'processing_refunded';
2321 $messages->{'LostItemFeeRestored'} = 1
2322 if $message->message eq 'lost_restored';
2324 if ( $message->message eq 'lost_charge' ) {
2325 $issue //= Koha::Old::Checkouts->search(
2326 { itemnumber => $item->itemnumber },
2327 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2329 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2330 my $patron = $issue->patron;
2331 $patron_unblessed = $patron->unblessed;
2333 _CalculateAndUpdateFine(
2336 item => $item->unblessed,
2337 borrower => $patron_unblessed,
2338 return_date => $return_date
2341 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2342 $item->itemnumber, undef, 'RETURNED' );
2343 $messages->{'LostItemFeeCharged'} = 1;
2349 # check if we have a transfer for this document
2350 my $transfer = $item->get_transfer;
2352 # if we have a transfer to complete, we update the line of transfers with the datearrived
2355 if ( $transfer->in_transit ) {
2356 if ( $transfer->tobranch eq $branch ) {
2358 $messages->{'TransferArrived'} = $transfer->frombranch;
2359 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2361 if defined $transfer->reason && $transfer->reason eq 'Reserve';
2364 $messages->{'WrongTransfer'} = $transfer->tobranch;
2365 $messages->{'WrongTransferItem'} = $item->itemnumber;
2366 $messages->{'TransferTrigger'} = $transfer->reason;
2370 if ( $transfer->tobranch eq $branch ) {
2372 $messages->{'TransferArrived'} = $transfer->frombranch;
2373 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2374 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2377 $messages->{'TransferTrigger'} = $transfer->reason;
2378 if ( $transfer->frombranch eq $branch ) {
2380 $messages->{'WasTransfered'} = $transfer->tobranch;
2383 $messages->{'WrongTransfer'} = $transfer->tobranch;
2384 $messages->{'WrongTransferItem'} = $item->itemnumber;
2390 # fix up the overdues in accounts...
2391 if ($borrowernumber) {
2392 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2393 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2395 if ( $issue and $issue->is_overdue($return_date) ) {
2397 my ($debardate,$reminder) = _debar_user_on_return( $patron, $item, dt_from_string($issue->date_due), $return_date );
2398 if ($debardate and $debardate ne "9999-12-31") {
2400 $messages->{'PrevDebarred'} = $debardate;
2402 $messages->{'Debarred'} = $debardate;
2404 } elsif ($patron->debarred) {
2405 if ( $patron->debarred eq "9999-12-31") {
2406 $messages->{'ForeverDebarred'} = $patron->debarred;
2408 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2409 $borrower_debar_dt->truncate(to => 'day');
2410 my $today_dt = $return_date->clone()->truncate(to => 'day');
2411 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2412 $messages->{'PrevDebarred'} = $patron->debarred;
2416 # there's no overdue on the item but borrower had been previously debarred
2417 } elsif ( $issue->date_due and $patron->debarred ) {
2418 if ( $patron->debarred eq "9999-12-31") {
2419 $messages->{'ForeverDebarred'} = $patron->debarred;
2421 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2422 $borrower_debar_dt->truncate(to => 'day');
2423 my $today_dt = $return_date->clone()->truncate(to => 'day');
2424 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2425 $messages->{'PrevDebarred'} = $patron->debarred;
2432 if ( C4::Context->preference('UseRecalls') ) {
2433 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2435 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2436 if ( defined $recall ) {
2437 $messages->{RecallFound} = $recall;
2438 if ( $recall->pickup_library_id ne $branch ) {
2439 $messages->{RecallNeedsTransfer} = $branch;
2444 # find reserves.....
2445 # launch the Checkreserves routine to find any holds
2446 my ($resfound, $resrec);
2447 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2448 ($resfound, $resrec, undef) = CheckReserves( $item, $lookahead ) unless ( $item->withdrawn );
2449 # 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)
2450 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2451 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2452 $resfound = 'Reserved';
2453 $resrec = $hold->unblessed;
2456 $resrec->{'ResFound'} = $resfound;
2457 $messages->{'ResFound'} = $resrec;
2460 # Record the fact that this book was returned.
2461 my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2462 C4::Stats::UpdateStats({
2465 itemnumber => $itemnumber,
2466 itemtype => $itemtype,
2467 location => $item->location,
2468 borrowernumber => $borrowernumber,
2469 ccode => $item->ccode,
2470 categorycode => $categorycode,
2471 interface => C4::Context->interface,
2474 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2476 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2478 branchcode => $branch,
2479 categorycode => $patron->categorycode,
2480 item_type => $itemtype,
2481 notification => 'CHECKIN',
2483 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2484 SendCirculationAlert({
2486 item => $item->unblessed,
2487 borrower => $patron->unblessed,
2493 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2494 if C4::Context->preference("ReturnLog");
2496 #Update borrowers.lastseen
2497 $patron->update_lastseen('check_in');
2500 # Check if this item belongs to a biblio record that is attached to an
2501 # ILL request, if it is we need to update the ILL request's status
2502 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2503 my $request = Koha::Illrequests->find(
2504 { biblio_id => $item->biblio->biblionumber }
2506 $request->status('RET') if $request;
2509 if ( C4::Context->preference('UseRecalls') ) {
2510 # all recalls that have triggered a transfer will have an allocated itemnumber
2511 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2512 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2513 $messages->{TransferredRecall} = $transfer_recall;
2517 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2518 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2519 && ( $doreturn or $messages->{'NotIssued'} )
2521 and ( $branch ne $returnbranch )
2522 and not $messages->{'WrongTransfer'}
2523 and not $messages->{'WasTransfered'}
2524 and not $messages->{TransferredRecall}
2525 and not $messages->{RecallNeedsTransfer} )
2527 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2528 if (C4::Context->preference("AutomaticItemReturn" ) or
2529 (C4::Context->preference("UseBranchTransferLimits") and
2530 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2532 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2533 $messages->{'WasTransfered'} = $returnbranch;
2534 $messages->{'TransferTrigger'} = $transfer_trigger;
2536 $messages->{'NeedsTransfer'} = $returnbranch;
2537 $messages->{'TransferTrigger'} = $transfer_trigger;
2541 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2542 my $claims = Koha::Checkouts::ReturnClaims->search(
2544 itemnumber => $item->id,
2545 resolution => undef,
2549 if ( $claims->count ) {
2550 $messages->{ReturnClaims} = $claims;
2554 # Check for bundle status
2555 if ( $item->in_bundle ) {
2556 my $host = $item->bundle_host;
2557 $messages->{InBundle} = $host;
2560 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2561 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2563 if ( $doreturn and $issue ) {
2564 my $checkin = Koha::Old::Checkouts->find($issue->id);
2566 Koha::Plugins->call('after_circ_action', {
2567 action => 'checkin',
2573 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2575 biblio_ids => [ $item->biblionumber ]
2577 ) if C4::Context->preference('RealTimeHoldsQueue');
2580 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2583 =head2 MarkIssueReturned
2585 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2587 Unconditionally marks an issue as being returned by
2588 moving the C<issues> row to C<old_issues> and
2589 setting C<returndate> to the current date.
2591 if C<$returndate> is specified (in iso format), it is used as the date
2594 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2595 the old_issue is immediately anonymised
2597 Ideally, this function would be internal to C<C4::Circulation>,
2598 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2599 and offline_circ/process_koc.pl.
2601 The last optional parameter allos passing skip_record_index to the item store call.
2605 sub MarkIssueReturned {
2606 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2608 # Retrieve the issue
2609 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2610 my $issue_branchcode = $issue->branchcode;
2612 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2614 my $issue_id = $issue->issue_id;
2616 my $schema = Koha::Database->schema;
2618 # FIXME Improve the return value and handle it from callers
2619 $schema->txn_do(sub {
2621 my $patron = Koha::Patrons->find( $borrowernumber );
2623 # Update the returndate value
2624 if ( $returndate ) {
2625 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2628 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2631 # Create the old_issues entry
2632 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2634 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2635 if ( $privacy && $privacy == 2) {
2636 $old_checkout->anonymize;
2639 # And finally delete the issue
2642 $issue->item->onloan(undef)->store(
2644 skip_record_index => $params->{skip_record_index},
2645 skip_holds_queue => $params->{skip_holds_queue}
2649 if ( C4::Context->preference('StoreLastBorrower') ) {
2650 my $item = Koha::Items->find( $itemnumber );
2651 $item->last_returned_by( $patron->borrowernumber )->store;
2654 # Possibly remove any OVERDUES related debarment
2655 my $overdue_restrictions = $patron->restrictions->search( { type => 'OVERDUES' } );
2656 if ( C4::Context->preference('AutoRemoveOverduesRestrictions') ne 'no' && $patron->is_debarred ) {
2657 my $remove_restrictions =
2658 C4::Context->preference('AutoRemoveOverduesRestrictions') eq 'when_no_overdue_causing_debarment'
2659 ? !$patron->has_restricting_overdues( { issue_branchcode => $issue_branchcode } )
2660 : !$patron->has_overdues;
2661 if ( $remove_restrictions && $overdue_restrictions->count ) {
2662 DelUniqueDebarment( { borrowernumber => $borrowernumber, type => 'OVERDUES' } );
2671 =head2 _debar_user_on_return
2673 _debar_user_on_return($patron, $item, $datedue, $returndate);
2675 C<$patron> patron object
2677 C<$item> item object
2679 C<$datedue> date due DateTime object
2681 C<$returndate> DateTime object representing the return time
2683 Internal function, called only by AddReturn that calculates and updates
2684 the user fine days, and debars them if necessary.
2686 Should only be called for overdue returns
2688 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2693 sub _calculate_new_debar_dt {
2694 my ( $patron, $item, $dt_due, $return_date ) = @_;
2696 my $branchcode = _GetCircControlBranch( $item, $patron );
2697 my $circcontrol = C4::Context->preference('CircControl');
2698 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2699 { categorycode => $patron->categorycode,
2700 itemtype => $item->effective_itemtype,
2701 branchcode => $branchcode,
2706 'maxsuspensiondays',
2707 'suspension_chargeperiod',
2711 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2712 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2713 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2715 return unless $finedays;
2717 # finedays is in days, so hourly loans must multiply by 24
2718 # thus 1 hour late equals 1 day suspension * finedays rate
2719 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2721 # grace period is measured in the same units as the loan
2723 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2725 my $deltadays = DateTime::Duration->new(
2726 days => $chargeable_units
2729 if ( $deltadays->subtract($grace)->is_positive() ) {
2730 my $suspension_days = $deltadays * $finedays;
2732 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2733 # No need to / 1 and do not consider / 0
2734 $suspension_days = DateTime::Duration->new(
2735 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2739 # If the max suspension days is < than the suspension days
2740 # the suspension days is limited to this maximum period.
2741 my $max_sd = $issuing_rule->{maxsuspensiondays};
2742 if ( defined $max_sd && $max_sd ne '' ) {
2743 $max_sd = DateTime::Duration->new( days => $max_sd );
2744 $suspension_days = $max_sd
2745 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2748 my ( $has_been_extended );
2749 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $patron->is_debarred ) {
2750 my $debarment = $patron->restrictions->search({type => 'SUSPENSION' },{rows => 1})->single;
2752 $return_date = dt_from_string( $debarment->expiration, 'sql' );
2753 $has_been_extended = 1;
2758 # Use the calendar or not to calculate the debarment date
2759 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2760 my $calendar = Koha::Calendar->new(
2761 branchcode => $branchcode,
2762 days_mode => 'Calendar'
2764 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2767 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2769 return $new_debar_dt;
2774 sub _debar_user_on_return {
2775 my ( $patron, $item, $dt_due, $return_date ) = @_;
2777 $return_date //= dt_from_string();
2779 my $new_debar_dt = _calculate_new_debar_dt($patron, $item, $dt_due, $return_date);
2781 return unless $new_debar_dt;
2783 Koha::Patron::Debarments::AddUniqueDebarment({
2784 borrowernumber => $patron->borrowernumber,
2785 expiration => $new_debar_dt->ymd(),
2786 type => 'SUSPENSION',
2788 # if borrower was already debarred but does not get an extra debarment
2789 my ($new_debarment_str, $is_a_reminder);
2790 if ( $patron->is_debarred ) {
2792 $new_debarment_str = $patron->debarred;
2794 $new_debarment_str = $new_debar_dt->ymd();
2796 # FIXME Should return a DateTime object
2797 return $new_debarment_str, $is_a_reminder;
2800 =head2 _FixOverduesOnReturn
2802 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2804 C<$borrowernumber> borrowernumber
2806 C<$itemnumber> itemnumber
2808 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2810 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2816 sub _FixOverduesOnReturn {
2817 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2818 unless( $borrowernumber ) {
2819 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2823 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2827 warn "_FixOverduesOnReturn() not supplied valid status";
2831 my $schema = Koha::Database->schema;
2833 my $result = $schema->txn_do(
2835 # check for overdue fine
2836 my $accountlines = Koha::Account::Lines->search(
2838 borrowernumber => $borrowernumber,
2839 itemnumber => $item,
2840 debit_type_code => 'OVERDUE',
2841 status => 'UNRETURNED'
2844 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2846 my $accountline = $accountlines->next;
2847 my $payments = $accountline->credits;
2849 my $amountoutstanding = $accountline->amountoutstanding;
2850 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2851 $accountline->delete;
2852 return 0; # no warning, we've just removed a zero value fine (backdated return)
2853 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2854 my $account = Koha::Account->new({patron_id => $borrowernumber});
2855 my $credit = $account->add_credit(
2857 amount => $amountoutstanding,
2858 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2859 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2860 interface => C4::Context->interface,
2866 $credit->apply({ debits => [ $accountline ] });
2868 if (C4::Context->preference("FinesLog")) {
2869 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2873 $accountline->status($status);
2874 return $accountline->store();
2881 =head2 _GetCircControlBranch
2883 my $circ_control_branch = _GetCircControlBranch($item, $patron);
2887 Return the library code to be used to determine which circulation
2888 policy applies to a transaction. Looks up the CircControl and
2889 HomeOrHoldingBranch system preferences.
2891 C<$item> is an item object.
2893 C<$patron> is a patron object.
2897 sub _GetCircControlBranch {
2898 my ($item, $patron) = @_;
2899 my $circcontrol = C4::Context->preference('CircControl');
2902 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2903 $branch = C4::Context->userenv->{'branch'};
2904 } elsif ($circcontrol eq 'PatronLibrary') {
2905 $branch = $patron->branchcode;
2907 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2908 $branch = $item->get_column($branchfield);
2909 # default to item home branch if holdingbranch is used
2910 # and is not defined
2911 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2912 $branch = $item->homebranch;
2918 =head2 GetUpcomingDueIssues
2920 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2924 sub GetUpcomingDueIssues {
2927 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2928 my $dbh = C4::Context->dbh;
2931 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2933 LEFT JOIN items USING (itemnumber)
2934 LEFT JOIN branches ON branches.branchcode =
2936 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2937 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2938 my @bind_parameters = ( $params->{'days_in_advance'} );
2940 my $sth = $dbh->prepare( $statement );
2941 $sth->execute( @bind_parameters );
2942 my $upcoming_dues = $sth->fetchall_arrayref({});
2944 return $upcoming_dues;
2947 =head2 CanBookBeRenewed
2949 ($ok,$error,$info) = &CanBookBeRenewed($patron, $issue, $override_limit, $cron);
2951 Find out whether a borrowed item may be renewed.
2953 C<$patron> is the patron who currently has the issue.
2955 C<$issue> is the checkout to renew.
2957 C<$cron> true or false, specifies if this check is being made
2958 by the automatic_renewals.pl cronscript
2960 C<$override_limit>, if supplied with a true value, causes
2961 the limit on the number of times that the loan can be renewed
2962 (as controlled by the item type) to be ignored. Overriding also allows
2963 to renew sooner than "No renewal before" and to manually renew loans
2964 that are automatically renewed.
2966 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2967 item must currently be on loan to the specified borrower; renewals
2968 must be allowed for the item's type; and the borrower must not have
2969 already renewed the loan.
2970 $error will contain the reason the renewal can not proceed
2971 $info will contain a hash of additional info
2972 currently 'soonest_renew_date' if error is 'too soon'
2976 sub CanBookBeRenewed {
2977 my ( $patron, $issue, $override_limit, $cron ) = @_;
2979 my $auto_renew = "no";
2981 my $item = $issue->item;
2983 return ( 0, 'no_item' ) unless $item;
2984 return ( 0, 'no_checkout' ) unless $issue;
2985 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2986 return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2987 return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2989 my $final_renewal = 0;
2990 my $final_unseen_renewal = 0;
2992 # override_limit will override anything else except on_reserve
2993 unless ( $override_limit ){
2994 my $branchcode = _GetCircControlBranch( $item, $patron );
2995 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2997 categorycode => $patron->categorycode,
2998 itemtype => $item->effective_itemtype,
2999 branchcode => $branchcode,
3003 'unseen_renewals_allowed'
3008 return ( 0, "too_many" )
3009 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
3011 return ( 0, "too_unseen" )
3012 if C4::Context->preference('UnseenRenewals') &&
3013 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
3014 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
3016 $final_renewal = $issuing_rule->{renewalsallowed} == ( $issue->renewals_count + 1 ) ? 1 : 0;
3017 $final_unseen_renewal = ( C4::Context->preference('UnseenRenewals')
3018 && $issuing_rule->{unseen_renewals_allowed} == ( $issue->unseen_renewals + 1 ) ) ? 1 : 0;
3020 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
3021 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
3022 my $restricted = $patron->is_debarred;
3023 my $hasoverdues = $patron->has_overdues;
3025 if ( $restricted and $restrictionblockrenewing ) {
3026 return ( 0, 'restriction');
3027 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
3028 return ( 0, 'overdue');
3031 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
3034 branchcode => $branchcode,
3037 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
3038 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
3039 # extra notices being sent. Cron also implies no override
3040 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
3041 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
3042 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
3045 if ( C4::Context->preference('UseRecalls') ) {
3047 $recall = $item->check_recalls if $item->can_be_waiting_recall;
3048 if ( defined $recall ) {
3049 if ( $recall->item_level ) {
3050 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
3051 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
3053 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
3054 return ( 0, 'recalled' ) unless ( $recall->waiting );
3059 # There is an item level hold on this item, no other item can fill the hold
3060 return ( 0, "on_reserve" )
3061 if ( $item->current_holds->search( { non_priority => 0 } )->count );
3063 my $fillable_holds = Koha::Holds->search(
3065 biblionumber => $item->biblionumber,
3068 reservedate => { '<=' => \'NOW()' },
3072 if ( $fillable_holds->count ) {
3073 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
3074 my @possible_holds = $fillable_holds->as_list;
3076 # Get all other items that could possibly fill reserves
3077 # FIXME We could join reserves (or more tables) here to eliminate some checks later
3078 my @other_items = Koha::Items->search({
3079 biblionumber => $item->biblionumber,
3082 -not => { itemnumber => $item->itemnumber } })->as_list;
3084 return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
3087 foreach my $possible_hold (@possible_holds) {
3089 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
3091 # FIXME: We are not checking whether the item we are renewing can fill the hold
3093 foreach my $other_item (@other_items) {
3094 next if defined $matched_items{$other_item->itemnumber};
3095 next if IsItemOnHoldAndFound( $other_item->itemnumber );
3096 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef);
3097 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3098 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3099 # CanItemBeReserved checks 'rules' and 'policies' which means
3100 # items will fill holds at checkin that are rejected here
3102 $matched_items{$other_item->itemnumber} = 1;
3105 return ( 0, "on_reserve" ) unless $fillable;
3109 my ($status, $matched_reserve, $possible_reserves) = CheckReserves($item);
3110 return ( 0, "on_reserve" ) if $status;
3114 if ( $auto_renew eq 'auto_too_soon' ) {
3116 # If its cron, tell it it's too soon for a an auto renewal
3117 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $cron;
3119 # Check if it's too soon for a manual renewal
3120 my $soonestManual = GetSoonestRenewDate( $patron, $issue );
3121 if ( $soonestManual > dt_from_string() ) {
3122 return ( 0, "too_soon", { soonest_renew_date => $soonestManual } ) unless $override_limit;
3126 $soonest = GetSoonestRenewDate($patron, $issue);
3127 if ( $soonest > dt_from_string() ){
3128 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3131 my $auto_renew_code = $final_renewal ? 'auto_renew_final' : $final_unseen_renewal ? 'auto_unseen_final' : 'auto_renew';
3132 return ( 1, $auto_renew_code ) if $auto_renew eq "ok" || $auto_renew eq "auto_too_soon" && !$override_limit;
3134 return ( 1, undef );
3139 $new_date_due = AddRenewal({
3140 borrowernumber => $borrowernumber,
3141 itemnumber => $itemnumber,
3143 [datedue => $datedue],
3144 [lastreneweddate => $lastreneweddate],
3145 [skipfinecalc => $skipfinecalc],
3147 [automatic => $automatic],
3148 [skip_record_index => $skip_record_index]
3151 Renews a loan, returns the updated due date upon success.
3153 C<$borrowernumber> is the borrower number of the patron who currently
3156 C<$itemnumber> is the number of the item to renew.
3158 C<$branch> is the library where the renewal took place (if any).
3159 The library that controls the circ policies for the renewal is retrieved from the issues record.
3161 C<$datedue> can be a DateTime object used to set the due date.
3163 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3164 this parameter is not supplied, lastreneweddate is set to the current date.
3166 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3167 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3168 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3171 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3172 from the book's item type.
3174 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3175 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3176 fallback to a true value
3178 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3180 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3181 should be skipped for this renewal.
3188 my $borrowernumber = $params->{borrowernumber};
3189 my $itemnumber = $params->{itemnumber};
3190 return unless $itemnumber;
3192 my $branch = $params->{branch};
3193 my $datedue = $params->{datedue};
3194 my $lastreneweddate = $params->{lastreneweddate} // dt_from_string();
3195 my $skipfinecalc = $params->{skipfinecalc};
3196 my $seen = $params->{seen};
3197 my $automatic = $params->{automatic};
3198 my $skip_record_index = $params->{skip_record_index};
3200 # Fallback on a 'seen' renewal
3201 $seen = defined $seen && $seen == 0 ? 0 : 1;
3203 my $item_object = Koha::Items->find($itemnumber) or return;
3204 my $biblio = $item_object->biblio;
3205 my $issue = $item_object->checkout;
3206 my $item_unblessed = $item_object->unblessed;
3208 my $renewal_type = $automatic ? "Automatic" : "Manual";
3210 my $dbh = C4::Context->dbh;
3212 return unless $issue;
3214 $borrowernumber ||= $issue->borrowernumber;
3216 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3217 $datedue = dt_from_string($datedue, 'sql');
3220 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3221 my $patron_unblessed = $patron->unblessed;
3223 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
3225 my $schema = Koha::Database->schema;
3226 $schema->txn_do(sub{
3228 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3229 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3231 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3233 # If the due date wasn't specified, calculate it by adding the
3234 # book's loan length to today's date or the current due date
3235 # based on the value of the RenewalPeriodBase syspref.
3236 my $itemtype = $item_object->effective_itemtype;
3239 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3240 dt_from_string( $issue->date_due, 'sql' ) :
3242 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron, 'is a renewal');
3245 my $fees = Koha::Charges::Fees->new(
3248 library => $circ_library,
3249 item => $item_object,
3250 from_date => dt_from_string( $issue->date_due, 'sql' ),
3251 to_date => dt_from_string($datedue),
3255 # Increment the unseen renewals, if appropriate
3256 # We only do so if the syspref is enabled and
3257 # a maximum value has been set in the circ rules
3258 my $unseen_renewals = $issue->unseen_renewals;
3259 if (C4::Context->preference('UnseenRenewals')) {
3260 my $rule = Koha::CirculationRules->get_effective_rule(
3261 { categorycode => $patron->categorycode,
3262 itemtype => $item_object->effective_itemtype,
3263 branchcode => $circ_library->branchcode,
3264 rule_name => 'unseen_renewals_allowed'
3267 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3270 # If the renewal is seen, unseen should revert to 0
3271 $unseen_renewals = 0;
3275 # Update the issues record to have the new due date, and a new count
3276 # of how many times it has been renewed.
3277 my $renews = ( $issue->renewals_count || 0 ) + 1;
3278 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3281 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3284 Koha::Exceptions::Checkout::FailedRenewal->throw(
3285 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3289 # Update the renewal count on the item, and tell zebra to reindex
3290 $renews = ( $item_object->renewals || 0 ) + 1;
3291 $item_object->renewals($renews);
3292 $item_object->onloan($datedue);
3293 # Don't index as we are in a transaction, skip hardcoded here
3294 $item_object->store({ log_action => 0, skip_record_index => 1 });
3296 # Charge a new rental fee, if applicable
3297 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3298 if ( $charge > 0 ) {
3299 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3302 # Charge a new accumulate rental fee, if applicable
3303 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3304 if ( $itemtype_object ) {
3305 my $accumulate_charge = $fees->accumulate_rentalcharge();
3306 if ( $accumulate_charge > 0 ) {
3307 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3309 $charge += $accumulate_charge;
3312 # Send a renewal slip according to checkout alert preferencei
3313 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3314 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3316 branchcode => $branch,
3317 categorycode => $patron->categorycode,
3318 item_type => $itemtype,
3319 notification => 'CHECKOUT',
3321 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3322 SendCirculationAlert(
3325 item => $item_unblessed,
3326 borrower => $patron->unblessed,
3333 # Remove any OVERDUES related debarment if the borrower has no overdues
3334 my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3336 && $patron->is_debarred
3337 && ! $patron->has_overdues
3338 && $overdue_restrictions->count
3340 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3343 # Add renewal record
3344 my $renewal = Koha::Checkouts::Renewal->new(
3346 checkout_id => $issue->issue_id,
3347 interface => C4::Context->interface,
3348 renewal_type => $renewal_type,
3349 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3354 # Add the renewal to stats
3355 C4::Stats::UpdateStats(
3357 branch => $item_object->renewal_branchcode({branch => $branch}),
3360 itemnumber => $itemnumber,
3361 itemtype => $itemtype,
3362 location => $item_object->location,
3363 borrowernumber => $borrowernumber,
3364 ccode => $item_object->ccode,
3365 categorycode => $patron->categorycode,
3366 interface => C4::Context->interface,
3369 #Update borrowers.lastseen
3370 $patron->update_lastseen('renewal');
3373 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3375 Koha::Plugins->call('after_circ_action', {
3376 action => 'renewal',
3378 checkout => $issue->get_from_storage
3383 unless( $skip_record_index ){
3384 # We index now, after the transaction is committed
3385 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3386 $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3393 # check renewal status
3394 my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3396 my $dbh = C4::Context->dbh;
3398 my $unseencount = 0;
3399 my $renewsallowed = 0;
3400 my $unseenallowed = 0;
3403 my $patron = blessed $borrowernumber_or_patron ?
3404 $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3405 my $item = blessed $itemnumber_or_item ?
3406 $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3408 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3410 # Look in the issues table for this item, lent to this borrower,
3411 # and not yet returned.
3413 # FIXME - I think this function could be redone to use only one SQL call.
3414 my $sth = $dbh->prepare(q{
3415 SELECT * FROM issues
3416 WHERE (borrowernumber = ?) AND (itemnumber = ?)
3418 $sth->execute( $patron->borrowernumber, $item->itemnumber );
3419 my $data = $sth->fetchrow_hashref;
3420 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3421 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3422 # $item and $borrower should be calculated
3423 my $branchcode = _GetCircControlBranch($item, $patron);
3425 my $rules = Koha::CirculationRules->get_effective_rules(
3427 categorycode => $patron->categorycode,
3428 itemtype => $item->effective_itemtype,
3429 branchcode => $branchcode,
3430 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3433 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3434 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3435 $rules->{unseen_renewals_allowed} :
3437 $renewsleft = $renewsallowed - $renewcount;
3438 $unseenleft = $unseenallowed - $unseencount;
3439 if($renewsleft < 0){ $renewsleft = 0; }
3440 if($unseenleft < 0){ $unseenleft = 0; }
3451 =head2 GetSoonestRenewDate
3453 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3455 Find out the soonest possible renew date of a borrowed item.
3457 C<$patron> is the patron who currently has the item on loan.
3459 C<$issue> is the the item issue.
3461 C<$is_auto> is this soonest renew date for an auto renewal?
3463 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3464 renew date, based on the value "No renewal before" of the applicable
3465 issuing rule. Returns the current date if the item can already be
3466 renewed, and returns undefined if the patron, item, or checkout
3471 sub GetSoonestRenewDate {
3472 my ( $patron, $issue, $is_auto ) = @_;
3473 return unless $issue;
3474 return unless $patron;
3476 my $item = $issue->item;
3477 return unless $item;
3479 my $circ_rule = $is_auto ? 'noautorenewalbefore' : 'norenewalbefore';
3481 my $dbh = C4::Context->dbh;
3483 my $branchcode = _GetCircControlBranch( $item, $patron );
3484 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3485 { categorycode => $patron->categorycode,
3486 itemtype => $item->effective_itemtype,
3487 branchcode => $branchcode,
3495 my $now = dt_from_string;
3497 if ( defined $issuing_rule->{$circ_rule}
3498 and $issuing_rule->{$circ_rule} ne "" )
3500 my $soonestrenewal =
3501 dt_from_string( $issue->date_due )->subtract(
3502 $issuing_rule->{lengthunit} => $issuing_rule->{$circ_rule} );
3504 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3505 and $issuing_rule->{lengthunit} eq 'days' )
3507 $soonestrenewal->truncate( to => 'day' );
3509 return $soonestrenewal;
3510 } elsif ( $is_auto && $issue->auto_renew && $patron->autorenew_checkouts ) {
3511 # Checkouts with auto-renewing fall back to due date if noautorenewalbefore is undef
3512 my $soonestrenewal = dt_from_string( $issue->date_due );
3513 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3514 and $issuing_rule->{lengthunit} eq 'days' )
3516 $soonestrenewal->truncate( to => 'day' );
3518 return $soonestrenewal;
3523 =head2 GetLatestAutoRenewDate
3525 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3527 Find out the latest possible auto renew date of a borrowed item.
3529 C<$patron> is the patron who currently has the item on loan.
3531 C<$issue> is the item issue.
3533 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3534 auto renew date, based on the value "No auto renewal after" and the "No auto
3535 renewal after (hard limit) of the applicable issuing rule.
3536 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3537 or item cannot be found.
3541 sub GetLatestAutoRenewDate {
3542 my ( $patron, $issue ) = @_;
3543 return unless $issue;
3544 return unless $patron;
3546 my $item = $issue->item;
3547 return unless $item;
3549 my $dbh = C4::Context->dbh;
3550 my $branchcode = _GetCircControlBranch( $item, $patron );
3552 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3554 categorycode => $patron->categorycode,
3555 itemtype => $item->effective_itemtype,
3556 branchcode => $branchcode,
3558 'no_auto_renewal_after',
3559 'no_auto_renewal_after_hard_limit',
3565 return unless $circulation_rules;
3567 if ( not $circulation_rules->{no_auto_renewal_after}
3568 or $circulation_rules->{no_auto_renewal_after} eq '' )
3569 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3570 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3572 my $maximum_renewal_date;
3573 if ( $circulation_rules->{no_auto_renewal_after} ) {
3574 $maximum_renewal_date = dt_from_string($issue->issuedate);
3575 $maximum_renewal_date->add(
3576 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3580 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3581 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3582 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3584 return $maximum_renewal_date;
3588 =head2 GetIssuingCharges
3590 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3592 Calculate how much it would cost for a given patron to borrow a given
3593 item, including any applicable discounts.
3595 C<$itemnumber> is the item number of item the patron wishes to borrow.
3597 C<$borrowernumber> is the patron's borrower number.
3599 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3600 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3605 sub GetIssuingCharges {
3607 # calculate charges due
3608 my ( $itemnumber, $borrowernumber ) = @_;
3610 my $dbh = C4::Context->dbh;
3613 # Get the book's item type and rental charge (via its biblioitem).
3614 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3615 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3616 $charge_query .= (C4::Context->preference('item-level_itypes'))
3617 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3618 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3620 $charge_query .= ' WHERE items.itemnumber =?';
3622 my $sth = $dbh->prepare($charge_query);
3623 $sth->execute($itemnumber);
3625 if ( my $item_data = $sth->fetchrow_hashref ) {
3626 $item_type = $item_data->{itemtype};
3627 $charge = $item_data->{rentalcharge};
3629 # FIXME This should follow CircControl
3630 my $branch = C4::Context::mybranch();
3631 $patron //= Koha::Patrons->find( $borrowernumber );
3632 my $discount = Koha::CirculationRules->get_effective_rule({
3633 categorycode => $patron->categorycode,
3634 branchcode => $branch,
3635 itemtype => $item_type,
3636 rule_name => 'rentaldiscount'
3639 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3641 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3645 return ( $charge, $item_type );
3648 =head2 AddIssuingCharge
3650 &AddIssuingCharge( $checkout, $charge, $type )
3654 sub AddIssuingCharge {
3655 my ( $checkout, $charge, $type ) = @_;
3657 # FIXME What if checkout does not exist?
3659 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3660 my $accountline = $account->add_debit(
3664 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3665 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3666 interface => C4::Context->interface,
3668 item_id => $checkout->itemnumber,
3669 issue_id => $checkout->issue_id,
3674 =head2 GetTransfersFromTo
3676 @results = GetTransfersFromTo($frombranch,$tobranch);
3678 Returns the list of pending transfers between $from and $to branch
3682 sub GetTransfersFromTo {
3683 my ( $frombranch, $tobranch ) = @_;
3684 return unless ( $frombranch && $tobranch );
3685 my $dbh = C4::Context->dbh;
3687 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3688 FROM branchtransfers
3691 AND datecancelled IS NULL
3692 AND datesent IS NOT NULL
3693 AND datearrived IS NULL
3695 my $sth = $dbh->prepare($query);
3696 $sth->execute( $frombranch, $tobranch );
3699 while ( my $data = $sth->fetchrow_hashref ) {
3700 push @gettransfers, $data;
3702 return (@gettransfers);
3705 =head2 SendCirculationAlert
3707 Send out a C<check-in> or C<checkout> alert using the messaging system.
3715 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3719 Hashref of information about the item being checked in or out.
3723 Hashref of information about the borrower of the item.
3727 The branchcode from where the checkout or check-in took place.
3733 SendCirculationAlert({
3736 borrower => $borrower,
3742 sub SendCirculationAlert {
3744 my ($type, $item, $borrower, $branch, $issue) =
3745 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3746 my %message_name = (
3747 CHECKIN => 'Item_Check_in',
3748 CHECKOUT => 'Item_Checkout',
3749 RENEWAL => 'Item_Checkout',
3751 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3752 borrowernumber => $borrower->{borrowernumber},
3753 message_name => $message_name{$type},
3758 items => $item->{itemnumber},
3759 biblio => $item->{biblionumber},
3760 biblioitems => $item->{biblionumber},
3761 borrowers => $borrower,
3762 branches => $branch,
3765 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3766 # See C4::Letters:: _parseletter_sth
3767 if( $type eq 'CHECKIN' ){
3768 $tables->{old_issues} = $issue->issue_id;
3770 $tables->{issues} = $item->{itemnumber};
3773 my $schema = Koha::Database->new->schema;
3774 my @transports = keys %{ $borrower_preferences->{transports} };
3776 # From the MySQL doc:
3777 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3778 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3779 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3780 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3782 for my $mtt (@transports) {
3783 my $letter = C4::Letters::GetPreparedLetter (
3784 module => 'circulation',
3785 letter_code => $type,
3786 branchcode => $branch,
3787 message_transport_type => $mtt,
3788 lang => $borrower->{lang},
3792 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3793 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3794 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3795 unless ( $message ) {
3796 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3797 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3798 C4::Message->enqueue($letter, $patron, $mtt);
3800 $message->append($letter);
3803 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3809 =head2 updateWrongTransfer
3811 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3813 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
3817 sub updateWrongTransfer {
3818 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3820 # first step: cancel the original transfer
3821 my $item = Koha::Items->find($itemNumber);
3822 my $transfer = $item->get_transfer;
3823 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3825 # second step: create a new transfer to the right location
3826 my $new_transfer = $item->request_transfer(
3828 to => $transfer->to_library,
3829 reason => $transfer->reason,
3830 comment => $transfer->comments,
3836 return $new_transfer;
3841 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3843 this function calculates the due date given the start date and configured circulation rules,
3844 checking against the holidays calendar as per the daysmode circulation rule.
3845 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3846 C<$itemtype> = itemtype code of item in question
3847 C<$branch> = location whose calendar to use
3848 C<$patron> = Patron object
3849 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3854 my ( $startdate, $itemtype, $branch, $patron, $isrenewal ) = @_;
3858 # loanlength now a href
3860 GetLoanLength( $patron->categorycode, $itemtype, $branch );
3862 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3868 if (ref $startdate ne 'DateTime' ) {
3869 $datedue = dt_from_string($datedue);
3871 $datedue = $startdate->clone;
3874 $datedue = dt_from_string()->truncate( to => 'minute' );
3878 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3880 categorycode => $patron->categorycode,
3881 itemtype => $itemtype,
3882 branchcode => $branch,
3886 # calculate the datedue as normal
3887 if ( $daysmode eq 'Days' )
3888 { # ignoring calendar
3889 if ( $loanlength->{lengthunit} eq 'hours' ) {
3890 $datedue->add( hours => $loanlength->{$length_key} );
3892 $datedue->add( days => $loanlength->{$length_key} );
3893 $datedue->set_hour(23);
3894 $datedue->set_minute(59);
3898 if ($loanlength->{lengthunit} eq 'hours') {
3899 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3902 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3904 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3905 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3906 if ($loanlength->{lengthunit} eq 'days') {
3907 $datedue->set_hour(23);
3908 $datedue->set_minute(59);
3912 # if Hard Due Dates are used, retrieve them and apply as necessary
3913 my ( $hardduedate, $hardduedatecompare ) =
3914 GetHardDueDate( $patron->categorycode, $itemtype, $branch );
3915 if ($hardduedate) { # hardduedates are currently dates
3916 $hardduedate->truncate( to => 'minute' );
3917 $hardduedate->set_hour(23);
3918 $hardduedate->set_minute(59);
3919 my $cmp = DateTime->compare( $hardduedate, $datedue );
3921 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3922 # if the calculated date is before the 'after' Hard Due Date (floor), override
3923 # if the hard due date is set to 'exactly', overrride
3924 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3925 $datedue = $hardduedate->clone;
3928 # in all other cases, keep the date due as it is
3932 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3933 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3934 my $expiry_dt = dt_from_string( $patron->dateexpiry, 'iso', 'floating');
3935 if( $expiry_dt ) { #skip empty expiry date..
3936 $expiry_dt->set( hour => 23, minute => 59);
3937 my $d1= $datedue->clone->set_time_zone('floating');
3938 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3939 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3942 if ( $daysmode ne 'Days' ) {
3943 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3944 if ( $calendar->is_holiday($datedue) ) {
3945 # Don't return on a closed day
3946 $datedue = $calendar->prev_open_days( $datedue, 1 );
3955 sub CheckValidBarcode{
3957 my $dbh = C4::Context->dbh;
3958 my $query=qq|SELECT count(*)
3962 my $sth = $dbh->prepare($query);
3963 $sth->execute($barcode);
3964 my $exist=$sth->fetchrow ;
3968 =head2 IsBranchTransferAllowed
3970 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3972 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3974 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3975 Koha::Item->can_be_transferred.
3979 sub IsBranchTransferAllowed {
3980 my ( $toBranch, $fromBranch, $code ) = @_;
3982 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3984 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3985 my $dbh = C4::Context->dbh;
3987 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3988 $sth->execute( $toBranch, $fromBranch, $code );
3989 my $limit = $sth->fetchrow_hashref();
3991 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3992 if ( $limit->{'limitId'} ) {
3999 =head2 CreateBranchTransferLimit
4001 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
4003 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
4005 Deprecated in favor of Koha::Item::Transfer::Limit->new.
4009 sub CreateBranchTransferLimit {
4010 my ( $toBranch, $fromBranch, $code ) = @_;
4011 return unless defined($toBranch) && defined($fromBranch);
4012 my $limitType = C4::Context->preference("BranchTransferLimitsType");
4014 my $dbh = C4::Context->dbh;
4016 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
4017 return $sth->execute( $code, $toBranch, $fromBranch );
4020 =head2 DeleteBranchTransferLimits
4022 my $result = DeleteBranchTransferLimits($frombranch);
4024 Deletes all the library transfer limits for one library. Returns the
4025 number of limits deleted, 0e0 if no limits were deleted, or undef if
4026 no arguments are supplied.
4028 Deprecated in favor of Koha::Item::Transfer::Limits->search({
4029 fromBranch => $fromBranch
4034 sub DeleteBranchTransferLimits {
4036 return unless defined $branch;
4037 my $dbh = C4::Context->dbh;
4038 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
4039 return $sth->execute($branch);
4043 my ( $borrowernumber, $itemnum ) = @_;
4044 MarkIssueReturned( $borrowernumber, $itemnum );
4049 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
4051 The final optional parameter, C<$params>, expected to contain
4052 'skip_record_index' key, which relayed down to Koha::Item/store,
4053 there it prevents calling of ModZebra index_records,
4054 which takes most of the time in batch adds/deletes: index_records better
4055 to be called later in C<additem.pl> after the whole loop.
4058 skip_record_index => 1|0
4063 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
4065 unless ( $mark_lost_from ) {
4066 # Temporary check to avoid regressions
4067 die q|LostItem called without $mark_lost_from, check the API.|;
4071 if ( $force_mark_returned ) {
4074 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
4075 $mark_returned = ( $pref =~ m|$mark_lost_from| );
4078 my $dbh = C4::Context->dbh();
4079 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
4081 JOIN items USING (itemnumber)
4082 JOIN biblio USING (biblionumber)
4083 WHERE issues.itemnumber=?");
4084 $sth->execute($itemnumber);
4085 my $issues=$sth->fetchrow_hashref();
4087 # If a borrower lost the item, add a replacement cost to the their record
4088 if ( my $borrowernumber = $issues->{borrowernumber} ){
4089 my $patron = Koha::Patrons->find( $borrowernumber );
4091 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
4092 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
4094 if (C4::Context->preference('WhenLostChargeReplacementFee')){
4095 C4::Accounts::chargelostitem(
4098 $issues->{'replacementprice'},
4099 sprintf( "%s %s %s",
4100 $issues->{'title'} || q{},
4101 $issues->{'barcode'} || q{},
4102 $issues->{'itemcallnumber'} || q{},
4105 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4106 #warn " $issues->{'borrowernumber'} / $itemnumber ";
4109 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4112 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4113 my $item = Koha::Items->find($itemnumber);
4114 my $transfers = $item->get_transfers;
4115 while (my $transfer = $transfers->next) {
4116 $transfer->cancel({ reason => 'ItemLost', force => 1 });
4120 sub GetOfflineOperations {
4121 my $dbh = C4::Context->dbh;
4122 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4123 $sth->execute(C4::Context->userenv->{'branch'});
4124 my $results = $sth->fetchall_arrayref({});
4128 sub GetOfflineOperation {
4129 my $operationid = shift;
4130 return unless $operationid;
4131 my $dbh = C4::Context->dbh;
4132 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4133 $sth->execute( $operationid );
4134 return $sth->fetchrow_hashref;
4137 sub AddOfflineOperation {
4138 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4139 my $dbh = C4::Context->dbh;
4140 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4141 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4145 sub DeleteOfflineOperation {
4146 my $dbh = C4::Context->dbh;
4147 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4148 $sth->execute( shift );
4152 sub ProcessOfflineOperation {
4153 my $operation = shift;
4156 if ( $operation->{action} eq 'return' ) {
4157 $report = ProcessOfflineReturn( $operation );
4158 } elsif ( $operation->{action} eq 'issue' ) {
4159 $report = ProcessOfflineIssue( $operation );
4160 } elsif ( $operation->{action} eq 'payment' ) {
4161 $report = ProcessOfflinePayment( $operation );
4164 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4169 sub ProcessOfflineReturn {
4170 my $operation = shift;
4172 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4175 my $itemnumber = $item->itemnumber;
4176 my $issue = $item->checkout;
4178 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4179 ModDateLastSeen( $itemnumber, $leave_item_lost );
4181 $issue->borrowernumber,
4183 $operation->{timestamp},
4185 $item->onloan(undef);
4186 $item->store({ log_action => 0 });
4189 return "Item not issued.";
4192 return "Item not found.";
4196 sub ProcessOfflineIssue {
4197 my $operation = shift;
4199 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4200 $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4203 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4205 return "Barcode not found.";
4207 my $itemnumber = $item->itemnumber;
4208 my $issue = $item->checkout;
4210 if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4212 $issue->borrowernumber,
4214 $operation->{timestamp},
4219 $operation->{'barcode'},
4222 $operation->{timestamp},
4227 return "Borrower not found.";
4231 sub ProcessOfflinePayment {
4232 my $operation = shift;
4234 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4235 $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4237 $patron->account->pay(
4239 amount => $operation->{amount},
4240 library_id => $operation->{branchcode},
4250 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4252 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4257 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4261 ? Koha::Items->find($itemnumber)
4262 : Koha::Items->find( { barcode => $barcode } );
4266 return C4::Letters::GetPreparedLetter (
4267 module => 'circulation',
4268 letter_code => 'TRANSFERSLIP',
4269 branchcode => $branch,
4271 'branches' => $to_branch,
4272 'biblio' => $item->biblionumber,
4273 'items' => $item->unblessed,
4278 =head2 CheckIfIssuedToPatron
4280 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4282 Return 1 if any record item is issued to patron, otherwise return 0
4286 sub CheckIfIssuedToPatron {
4287 my ($borrowernumber, $biblionumber) = @_;
4289 my $dbh = C4::Context->dbh;
4291 SELECT COUNT(*) FROM issues
4292 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4293 WHERE items.biblionumber = ?
4294 AND issues.borrowernumber = ?
4296 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4297 return 1 if $is_issued;
4303 IsItemIssued( $itemnumber )
4305 Return 1 if the item is on loan, otherwise return 0
4310 my $itemnumber = shift;
4311 my $dbh = C4::Context->dbh;
4312 my $sth = $dbh->prepare(q{
4315 WHERE itemnumber = ?
4317 $sth->execute($itemnumber);
4318 return $sth->fetchrow;
4321 =head2 GetAgeRestriction
4323 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4324 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4326 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4327 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4329 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4330 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4331 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4332 Negative days mean the borrower has gone past the age restriction age.
4336 sub GetAgeRestriction {
4337 my ($record_restrictions, $borrower) = @_;
4338 my $markers = C4::Context->preference('AgeRestrictionMarker');
4340 return unless $record_restrictions;
4341 # Split $record_restrictions to something like FSK 16 or PEGI 6
4342 my @values = split ' ', uc($record_restrictions);
4343 return unless @values;
4345 # Search first occurrence of one of the markers
4346 my @markers = split /\|/, uc($markers);
4347 return unless @markers;
4350 my $restriction_year = 0;
4351 for my $value (@values) {
4353 for my $marker (@markers) {
4354 $marker =~ s/^\s+//; #remove leading spaces
4355 $marker =~ s/\s+$//; #remove trailing spaces
4356 if ( $marker eq $value ) {
4357 if ( $index <= $#values ) {
4358 $restriction_year += $values[$index];
4362 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4364 # Perhaps it is something like "K16" (as in Finland)
4365 $restriction_year += $1;
4369 last if ( $restriction_year > 0 );
4372 #Check if the borrower is age restricted for this material and for how long.
4373 if ($restriction_year && $borrower) {
4374 if ( $borrower->{'dateofbirth'} ) {
4375 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4376 $alloweddate[0] += $restriction_year;
4378 #Prevent runime eror on leap year (invalid date)
4379 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4380 $alloweddate[2] = 28;
4383 #Get how many days the borrower has to reach the age restriction
4384 my @Today = split /-/, dt_from_string()->ymd();
4385 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4386 #Negative days means the borrower went past the age restriction age
4387 return ($restriction_year, $daysToAgeRestriction);
4391 return ($restriction_year);
4395 =head2 GetPendingOnSiteCheckouts
4399 sub GetPendingOnSiteCheckouts {
4400 my $dbh = C4::Context->dbh;
4401 return $dbh->selectall_arrayref(q|
4407 items.itemcallnumber,
4411 issues.date_due < NOW() AS is_overdue,
4414 borrowers.firstname,
4416 borrowers.cardnumber,
4417 borrowers.borrowernumber
4419 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4420 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4421 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4422 WHERE issues.onsite_checkout = 1
4423 |, { Slice => {} } );
4429 my ($count, $branch, $itemtype, $ccode, $newness)
4430 = @$params{qw(count branch itemtype ccode newness)};
4432 my $dbh = C4::Context->dbh;
4435 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4436 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4437 i.ccode, SUM(i.issues) AS count
4439 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4440 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4443 my (@where_strs, @where_args);
4446 push @where_strs, 'i.homebranch = ?';
4447 push @where_args, $branch;
4450 if (C4::Context->preference('item-level_itypes')){
4451 push @where_strs, 'i.itype = ?';
4452 push @where_args, $itemtype;
4454 push @where_strs, 'bi.itemtype = ?';
4455 push @where_args, $itemtype;
4459 push @where_strs, 'i.ccode = ?';
4460 push @where_args, $ccode;
4463 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4464 push @where_args, $newness;
4468 $query .= 'WHERE ' . join(' AND ', @where_strs);
4472 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4473 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4478 $query .= q{ ) xxx WHERE count > 0 };
4479 $count = int($count);
4481 $query .= "LIMIT $count";
4484 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4489 =head2 Internal methods
4493 sub _CalculateAndUpdateFine {
4496 my $borrower = $params->{borrower};
4497 my $item = $params->{item};
4498 my $issue = $params->{issue};
4499 my $return_date = $params->{return_date};
4501 unless ($borrower) { carp "No borrower passed in!" && return; }
4502 unless ($item) { carp "No item passed in!" && return; }
4503 unless ($issue) { carp "No issue passed in!" && return; }
4505 my $datedue = dt_from_string( $issue->date_due );
4507 # we only need to calculate and change the fines if we want to do that on return
4508 # Should be on for hourly loans
4509 my $control = C4::Context->preference('CircControl');
4510 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4511 my $control_branchcode =
4512 ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4513 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4514 : $issue->branchcode;
4516 my $date_returned = $return_date ? $return_date : dt_from_string();
4518 my ( $amount, $unitcounttotal, $unitcount ) =
4519 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4521 if ( C4::Context->preference('finesMode') eq 'production' ) {
4522 if ( $amount > 0 ) {
4523 C4::Overdues::UpdateFine({
4524 issue_id => $issue->issue_id,
4525 itemnumber => $issue->itemnumber,
4526 borrowernumber => $issue->borrowernumber,
4531 elsif ($return_date) {
4533 # Backdated returns may have fines that shouldn't exist,
4534 # so in this case, we need to drop those fines to 0
4536 C4::Overdues::UpdateFine({
4537 issue_id => $issue->issue_id,
4538 itemnumber => $issue->itemnumber,
4539 borrowernumber => $issue->borrowernumber,
4547 sub _CanBookBeAutoRenewed {
4548 my ( $params ) = @_;
4549 my $patron = $params->{patron};
4550 my $item = $params->{item};
4551 my $branchcode = $params->{branchcode};
4552 my $issue = $params->{issue};
4554 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4556 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4558 categorycode => $patron->categorycode,
4559 itemtype => $item->effective_itemtype,
4560 branchcode => $branchcode,
4562 'no_auto_renewal_after',
4563 'no_auto_renewal_after_hard_limit',
4565 'noautorenewalbefore',
4570 if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4571 return 'auto_account_expired';
4574 if ( defined $issuing_rule->{no_auto_renewal_after}
4575 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4576 # Get issue_date and add no_auto_renewal_after
4577 # If this is greater than today, it's too late for renewal.
4578 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4579 $maximum_renewal_date->add(
4580 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4582 my $now = dt_from_string;
4583 if ( $now >= $maximum_renewal_date ) {
4584 return "auto_too_late";
4587 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4588 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4589 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4590 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4591 return "auto_too_late";
4595 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4596 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4597 my $amountoutstanding =
4598 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4599 ? $patron->account->balance
4600 : $patron->account->outstanding_debits->total_outstanding;
4601 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4602 return "auto_too_much_oweing";
4606 my $soonest = GetSoonestRenewDate( $patron, $issue, 1 );
4607 if ( $soonest > dt_from_string() )
4609 return ( "auto_too_soon", $soonest );
4622 Koha Development Team <http://koha-community.org/>