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 );
27 use C4::Stats qw( UpdateStats );
28 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest );
29 use C4::Biblio qw( UpdateTotalIssues );
30 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
32 use C4::ItemCirculationAlertPreference;
34 use C4::Log qw( logaction ); # logaction
36 use C4::RotatingCollections qw(GetCollectionItemBranches);
37 use Algorithm::CheckDigits qw( CheckDigits );
39 use Data::Dumper qw( Dumper );
41 use Koha::AuthorisedValues;
42 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
43 use Koha::Biblioitems;
44 use Koha::DateUtils qw( dt_from_string );
47 use Koha::Illrequests;
50 use Koha::Patron::Debarments qw( DelUniqueDebarment AddUniqueDebarment );
53 use Koha::Account::Lines;
55 use Koha::Account::Lines;
56 use Koha::Account::Offsets;
57 use Koha::Config::SysPrefs;
58 use Koha::Charges::Fees;
59 use Koha::Config::SysPref;
60 use Koha::Checkouts::ReturnClaims;
61 use Koha::SearchEngine::Indexer;
62 use Koha::Exceptions::Checkout;
65 use Koha::Library::Hours;
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 = $barcode ? Koha::Items->find( { barcode => $barcode } ) : undef;
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 ) ) {
824 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
825 C4::Stats::UpdateStats(
827 branch => C4::Context->userenv->{'branch'},
829 itemnumber => $item_object->itemnumber,
830 itemtype => $effective_itemtype,
831 borrowernumber => $patron->borrowernumber,
832 ccode => $item_object->ccode,
833 categorycode => $patron->categorycode,
834 location => $item_object->location,
835 interface => C4::Context->interface,
838 my $block_lost_return = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
839 ModDateLastSeen( $item_object->itemnumber, $block_lost_return ); # FIXME Move to Koha::Item
840 return ( { STATS => 1, }, {} );
843 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
844 $issuingimpossible{GNA} = 1;
847 if ( $patron->lost && $patron->lost == 1 ) {
848 $issuingimpossible{CARD_LOST} = 1;
850 if ( $patron->is_debarred ) {
851 $issuingimpossible{DEBARRED} = 1;
854 if ( $patron->is_expired ) {
855 $issuingimpossible{EXPIRED} = 1;
863 my $account = $patron->account;
864 my $balance = $account->balance;
865 my $non_issues_charges = $account->non_issues_charges;
866 my $other_charges = $balance - $non_issues_charges;
868 my $amountlimit = C4::Context->preference("noissuescharge");
869 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
870 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
872 # Check the debt of this patrons guarantees
873 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
874 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
875 if ( defined $no_issues_charge_guarantees ) {
876 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
877 my $guarantees_non_issues_charges = 0;
878 foreach my $g ( @guarantees ) {
879 $guarantees_non_issues_charges += $g->account->non_issues_charges;
882 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
883 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
884 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
885 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
886 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
887 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
891 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
892 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
893 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
894 if ( defined $no_issues_charge_guarantors ) {
895 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
897 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
898 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
899 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
900 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
901 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
902 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
906 if ( C4::Context->preference("IssuingInProcess") ) {
907 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
908 $issuingimpossible{DEBT} = $non_issues_charges;
909 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
910 $needsconfirmation{DEBT} = $non_issues_charges;
911 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
912 $needsconfirmation{DEBT} = $non_issues_charges;
916 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
917 $needsconfirmation{DEBT} = $non_issues_charges;
918 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
919 $issuingimpossible{DEBT} = $non_issues_charges;
920 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
921 $needsconfirmation{DEBT} = $non_issues_charges;
925 if ($balance > 0 && $other_charges > 0) {
926 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
929 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
930 $patron_unblessed = $patron->unblessed;
932 if ( my $debarred_date = $patron->is_debarred ) {
933 # patron has accrued fine days or has a restriction. $count is a date
934 if ($debarred_date eq '9999-12-31') {
935 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
938 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
940 } elsif ( my $num_overdues = $patron->has_overdues ) {
941 ## patron has outstanding overdue loans
942 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
943 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
945 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
946 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
950 # Additional Materials Check
951 if ( C4::Context->preference("CircConfirmItemParts")
952 && $item_object->materials )
954 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
958 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
960 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
962 # Already issued to current borrower.
963 # If it is an on-site checkout if it can be switched to a normal checkout
964 # or ask whether the loan should be renewed
966 if ( $issue->onsite_checkout
967 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
968 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
970 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed($patron, $issue);
971 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
972 if ( $renewerror eq 'onsite_checkout' ) {
973 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
976 $issuingimpossible{NO_MORE_RENEWALS} = 1;
980 $needsconfirmation{RENEW_ISSUE} = 1;
986 # issued to someone else
988 my $patron = Koha::Patrons->find( $issue->borrowernumber );
990 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
992 if ( !$can_be_returned ) {
993 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
994 $issuingimpossible{branch_to_return} = $message;
996 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
997 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
1000 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
1001 $needsconfirmation{issued_firstname} = $patron->firstname;
1002 $needsconfirmation{issued_surname} = $patron->surname;
1003 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
1004 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
1009 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1011 my $switch_onsite_checkout = (
1012 C4::Context->preference('SwitchOnSiteCheckouts')
1014 and $issue->onsite_checkout
1015 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1016 my $toomany = TooMany( $patron, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1017 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1018 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1019 if ( $toomany->{max_allowed} == 0 ) {
1020 $needsconfirmation{PATRON_CANT} = 1;
1021 $needsconfirmation{circulation_rule_PATRON_CANT} = $toomany->{circulation_rule};
1023 if ( C4::Context->preference("AllowTooManyOverride") ) {
1024 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1025 $needsconfirmation{current_loan_count} = $toomany->{count};
1026 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1027 $needsconfirmation{circulation_rule_TOO_MANY} = $toomany->{circulation_rule};
1029 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1030 $issuingimpossible{current_loan_count} = $toomany->{count};
1031 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1032 $needsconfirmation{circulation_rule_TOO_MANY} = $toomany->{circulation_rule};
1037 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1039 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1040 if ( $patron->wants_check_for_previous_checkout && $patron->do_check_for_previous_checkout($item_unblessed) ) {
1041 $needsconfirmation{PREVISSUE} = 1;
1047 if ( $item_object->notforloan )
1049 if(!C4::Context->preference("AllowNotForLoanOverride")){
1050 $issuingimpossible{NOT_FOR_LOAN} = 1;
1051 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1053 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1054 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1058 # we have to check itemtypes.notforloan also
1059 if (C4::Context->preference('item-level_itypes')){
1060 # this should probably be a subroutine
1061 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1062 $sth->execute($effective_itemtype);
1063 my $notforloan=$sth->fetchrow_hashref();
1064 if ($notforloan->{'notforloan'}) {
1065 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1066 $issuingimpossible{NOT_FOR_LOAN} = 1;
1067 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1069 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1070 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1075 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1076 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1077 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1078 $issuingimpossible{NOT_FOR_LOAN} = 1;
1079 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1081 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1082 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1087 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1089 $issuingimpossible{WTHDRAWN} = 1;
1091 if ( $item_object->restricted
1092 && $item_object->restricted == 1 )
1094 $issuingimpossible{RESTRICTED} = 1;
1096 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1097 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1098 my $code = $av->count ? $av->next->lib : '';
1099 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1100 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1102 if ( C4::Context->preference("IndependentBranches") ) {
1103 my $userenv = C4::Context->userenv;
1104 unless ( C4::Context->IsSuperLibrarian() ) {
1105 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1106 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1107 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1108 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1110 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1111 if ( $patron->branchcode ne $userenv->{branch} );
1116 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1118 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1119 if ($rentalConfirmation) {
1120 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1122 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1123 if ($itemtype_object) {
1124 my $accumulate_charge = $fees->accumulate_rentalcharge();
1125 if ( $accumulate_charge > 0 ) {
1126 $rentalCharge += $accumulate_charge;
1130 if ( $rentalCharge > 0 ) {
1131 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1136 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1137 # Only bother doing this if UseRecalls is enabled and the item is recallable
1138 # Don't look at recalls that are in transit
1139 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1140 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1142 foreach my $r ( @recalls ) {
1143 if ( $r->item_id and
1144 $r->item_id == $item_object->itemnumber and
1145 $r->patron_id == $patron->borrowernumber and
1146 ( $r->waiting or $r->requested ) ) {
1147 $messages{RECALLED} = $r->id;
1149 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1152 elsif ( $r->item_id and
1153 $r->item_id == $item_object->itemnumber and
1155 # recalled item is in transit
1156 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1158 elsif ( $r->item_level and
1159 $r->item_id == $item_object->itemnumber and
1160 $r->patron_id != $patron->borrowernumber and
1162 # this specific item has been recalled by a different patron
1163 $needsconfirmation{RECALLED} = $r;
1167 elsif ( !$r->item_level and
1168 $r->patron_id != $patron->borrowernumber and
1170 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1171 $needsconfirmation{RECALLED} = $r;
1178 unless ( $ignore_reserves || $recall ) {
1179 # See if the item is on reserve.
1180 my ( $restype, $res ) = CheckReserves( $item_object );
1182 my $resbor = $res->{'borrowernumber'};
1183 if ( $resbor ne $patron->borrowernumber ) {
1184 my $patron = Koha::Patrons->find( $resbor );
1185 if ( $restype eq "Waiting" )
1187 # The item is on reserve and waiting, but has been
1188 # reserved by some other patron.
1189 $needsconfirmation{RESERVE_WAITING} = 1;
1190 $needsconfirmation{'resfirstname'} = $patron->firstname;
1191 $needsconfirmation{'ressurname'} = $patron->surname;
1192 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1193 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1194 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1195 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1196 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1198 elsif ( $restype eq "Reserved" ) {
1199 # The item is on reserve for someone else.
1200 $needsconfirmation{RESERVED} = 1;
1201 $needsconfirmation{'resfirstname'} = $patron->firstname;
1202 $needsconfirmation{'ressurname'} = $patron->surname;
1203 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1204 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1205 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1206 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1207 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1209 elsif ( $restype eq "Transferred" ) {
1210 # The item is determined hold being transferred for someone else.
1211 $needsconfirmation{TRANSFERRED} = 1;
1212 $needsconfirmation{'resfirstname'} = $patron->firstname;
1213 $needsconfirmation{'ressurname'} = $patron->surname;
1214 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1215 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1216 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1217 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1218 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1220 elsif ( $restype eq "Processing" ) {
1221 # The item is determined hold being processed for someone else.
1222 $needsconfirmation{PROCESSING} = 1;
1223 $needsconfirmation{'resfirstname'} = $patron->firstname;
1224 $needsconfirmation{'ressurname'} = $patron->surname;
1225 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1226 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1227 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1228 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1229 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1235 ## CHECK FOR BOOKINGS
1237 my $booking = $item_object->find_booking(
1238 { checkout_date => $now, due_date => $duedate, patron_id => $patron->borrowernumber }
1242 my $booking_start = dt_from_string( $booking->start_date );
1244 # Booked to this patron :)
1245 if ( $booking->patron_id == $patron->borrowernumber ) {
1246 if ( $now < $booking_start ) {
1247 $needsconfirmation{'BOOKED_EARLY'} = $booking;
1249 $alerts{'BOOKED'} = $booking;
1254 # Loan falls inside booking
1255 if ( $now > $booking_start ) {
1256 $issuingimpossible{'BOOKED_TO_ANOTHER'} = $booking;
1259 # Booking starts before due date, reduce loan?
1261 $needsconfirmation{'BOOKED_TO_ANOTHER'} = $booking;
1266 ## CHECK AGE RESTRICTION
1267 my $agerestriction = $biblioitem->agerestriction;
1268 my ( $restriction_age, $daysToAgeRestriction ) =
1269 GetAgeRestriction( $agerestriction, $patron->unblessed );
1270 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1271 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1272 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1275 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1279 ## check for high holds decreasing loan period
1280 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1281 my $check = checkHighHolds( $item_object, $patron );
1283 if ( $check->{exceeded} ) {
1285 num_holds => $check->{outstanding},
1286 duration => $check->{duration},
1287 returndate => $check->{due_date},
1289 if ($override_high_holds) {
1290 $alerts{HIGHHOLDS} = $highholds;
1293 $needsconfirmation{HIGHHOLDS} = $highholds;
1299 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1300 # don't do the multiple loans per bib check if we've
1301 # already determined that we've got a loan on the same item
1302 !$issuingimpossible{NO_MORE_RENEWALS} &&
1303 !$needsconfirmation{RENEW_ISSUE}
1305 # Check if borrower has already issued an item from the same biblio
1306 # Only if it's not a subscription
1307 my $biblionumber = $item_object->biblionumber;
1308 require C4::Serials;
1309 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1310 unless ($is_a_subscription) {
1311 # FIXME Should be $patron->checkouts($args);
1312 my $checkouts = Koha::Checkouts->search(
1314 borrowernumber => $patron->borrowernumber,
1315 biblionumber => $biblionumber,
1321 # if we get here, we don't already have a loan on this item,
1322 # so if there are any loans on this bib, ask for confirmation
1323 if ( $checkouts->count ) {
1324 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1329 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1332 =head2 CanBookBeReturned
1334 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1336 Check whether the item can be returned to the provided branch
1340 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1342 =item C<$branch> is the branchcode where the return is taking place
1350 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1352 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1358 sub CanBookBeReturned {
1359 my ($item, $branch) = @_;
1360 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1362 # assume return is allowed to start
1366 # identify all cases where return is forbidden
1367 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1369 $message = $item->{'homebranch'};
1370 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1372 $message = $item->{'holdingbranch'};
1373 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1375 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1378 return ($allowed, $message);
1381 =head2 CheckHighHolds
1383 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1384 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1385 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1389 sub checkHighHolds {
1390 my ( $item, $patron ) = @_;
1391 my $branchcode = _GetCircControlBranch( $item, $patron );
1401 # Count holds on this record, ignoring the borrowers own holds as they would be filled by the checkout
1402 my $holds = Koha::Holds->search({
1403 biblionumber => $item->biblionumber,
1404 borrowernumber => { '!=' => $patron->borrowernumber }
1407 if ( $holds->count() ) {
1408 $return_data->{outstanding} = $holds->count();
1410 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1411 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1412 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1414 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1416 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1418 # static means just more than a given number of holds on the record
1420 # If the number of holds is not above the threshold, we can stop here
1421 if ( $holds->count() <= $decreaseLoanHighHoldsValue ) {
1422 return $return_data;
1425 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1427 # dynamic means X more than the number of holdable items on the record
1429 # let's get the items
1430 my @items = $holds->next()->biblio()->items()->as_list;
1432 # Remove any items with status defined to be ignored even if the would not make item unholdable
1433 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1434 @items = grep { !$_->$status } @items;
1437 # Remove any items that are not holdable for this patron
1438 # We need to ignore hold counts as the borrower's own hold that will be filled by the checkout
1439 # could prevent them from placing further holds
1440 @items = grep { CanItemBeReserved( $patron, $_, undef, { ignore_hold_counts => 1 } )->{status} eq 'OK' } @items;
1442 my $items_count = scalar @items;
1444 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1446 # If the number of holds is less than the count of items we have
1447 # plus the number of holds allowed above that count, we can stop here
1448 if ( $holds->count() <= $threshold ) {
1449 return $return_data;
1453 my $issuedate = dt_from_string();
1455 my $itype = $item->effective_itemtype;
1456 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1458 categorycode => $patron->categorycode,
1460 branchcode => $branchcode,
1463 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1465 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1467 my $rule = Koha::CirculationRules->get_effective_rule_value(
1469 categorycode => $patron->categorycode,
1470 itemtype => $item->effective_itemtype,
1471 branchcode => $branchcode,
1472 rule_name => 'decreaseloanholds',
1477 if ( defined($rule) && $rule ne '' ){
1478 # overrides decreaseLoanHighHoldsDuration syspref
1481 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1483 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1484 $reduced_datedue->set_hour($orig_due->hour);
1485 $reduced_datedue->set_minute($orig_due->minute);
1486 $reduced_datedue->truncate( to => 'minute' );
1488 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1489 $return_data->{exceeded} = 1;
1490 $return_data->{duration} = $duration;
1491 $return_data->{due_date} = $reduced_datedue;
1495 return $return_data;
1500 &AddIssue($patron, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1502 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1506 =item C<$patron> is a patron object.
1508 =item C<$barcode> is the barcode of the item being issued.
1510 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1511 Calculated if empty.
1513 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1515 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1518 AddIssue does the following things :
1520 - step 01: check that there is a borrowernumber & a barcode provided
1521 - check for RENEWAL (book issued & being issued to the same patron)
1522 - renewal YES = Calculate Charge & renew
1524 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1526 - fill reserve if reserve to this patron
1527 - cancel reserve or not, otherwise
1529 - fill recall if recall to this patron
1530 - cancel recall or not
1531 - revert recall's waiting status or not
1532 * TRANSFERT PENDING ?
1533 - complete the transfert
1541 my ( $patron, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1543 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1544 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1545 my $auto_renew = $params && $params->{auto_renew};
1546 my $cancel_recall = $params && $params->{cancel_recall};
1547 my $recall_id = $params && $params->{recall_id};
1548 my $dbh = C4::Context->dbh;
1549 my $barcodecheck = CheckValidBarcode($barcode);
1553 if ( $datedue && ref $datedue ne 'DateTime' ) {
1554 $datedue = dt_from_string($datedue);
1557 # $issuedate defaults to today.
1558 if ( !defined $issuedate ) {
1559 $issuedate = dt_from_string();
1562 if ( ref $issuedate ne 'DateTime' ) {
1563 $issuedate = dt_from_string($issuedate);
1568 # Stop here if the patron or barcode doesn't exist
1569 if ( $patron && $barcode && $barcodecheck ) {
1570 # find which item we issue
1571 my $item_object = Koha::Items->find({ barcode => $barcode })
1572 or return; # if we don't get an Item, abort.
1573 my $item_unblessed = $item_object->unblessed;
1575 my $branchcode = _GetCircControlBranch( $item_object, $patron );
1577 # get actual issuing if there is one
1578 my $actualissue = $item_object->checkout;
1580 # check if we just renew the issue.
1581 if ( $actualissue and $actualissue->borrowernumber eq $patron->borrowernumber
1582 and not $switch_onsite_checkout ) {
1583 $datedue = AddRenewal(
1585 borrowernumber => $patron->borrowernumber,
1586 itemnumber => $item_object->itemnumber,
1587 branch => $branchcode,
1588 datedue => $datedue,
1590 $issuedate, # here interpreted as the renewal date
1593 $issue = $item_object->checkout;
1598 my $itype = $item_object->effective_itemtype;
1599 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1603 # Check if we need to use an exact due date set by the ILL module
1604 if ( C4::Context->preference('ILLModule') ) {
1605 # Check if there is an ILL connected with the biblio of the item we are issuing
1606 my $ill_request = Koha::Illrequests->search({
1607 biblio_id => $item_object->biblionumber,
1608 borrowernumber => $patron->borrowernumber,
1610 due_date => { '!=', undef },
1613 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1614 my $ill_dt = dt_from_string( $ill_request->due_date );
1615 $ill_dt->set_hour(23);
1616 $ill_dt->set_minute(59);
1621 $datedue->truncate( to => 'minute' );
1623 my $library = Koha::Libraries->find( $branchcode );
1624 my $fees = Koha::Charges::Fees->new(
1627 library => $library,
1628 item => $item_object,
1629 to_date => $datedue,
1633 # it's NOT a renewal
1634 if ( $actualissue and not $switch_onsite_checkout ) {
1635 # This book is currently on loan, but not to the person
1636 # who wants to borrow it now. mark it returned before issuing to the new borrower
1637 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1638 return unless $allowed;
1639 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1640 # AddReturn certainly has side-effects, like onloan => undef
1641 $item_object->discard_changes;
1644 if ( C4::Context->preference('UseRecalls') ) {
1645 Koha::Recalls->move_recall(
1647 action => $cancel_recall,
1648 recall_id => $recall_id,
1649 item => $item_object,
1650 borrowernumber => $patron->borrowernumber,
1655 C4::Reserves::MoveReserve( $item_object->itemnumber, $patron->borrowernumber, $cancelreserve );
1657 # Starting process for transfer job (checking transfert and validate it if we have one)
1658 if ( my $transfer = $item_object->get_transfer ) {
1659 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1662 datearrived => dt_from_string,
1663 tobranch => C4::Context->userenv->{branch},
1664 comments => 'Forced branchtransfer'
1667 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1668 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1669 if ( $hold ) { # Is this really needed?
1670 $hold->set( { found => undef } )->store;
1671 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1676 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1677 unless ($auto_renew) {
1678 my $rule = Koha::CirculationRules->get_effective_rule_value(
1680 categorycode => $patron->categorycode,
1681 itemtype => $item_object->effective_itemtype,
1682 branchcode => $branchcode,
1683 rule_name => 'auto_renew'
1687 $auto_renew = $rule if defined $rule && $rule ne '';
1690 my $issue_attributes = {
1691 borrowernumber => $patron->borrowernumber,
1692 issuedate => $issuedate,
1693 date_due => $datedue,
1694 branchcode => C4::Context->userenv->{'branch'},
1695 onsite_checkout => $onsite_checkout,
1696 auto_renew => $auto_renew ? 1 : 0,
1699 # Get ID of logged in user. if called from a batch job,
1700 # no user session exists and C4::Context->userenv() returns
1701 # the scalar '0'. Only do this if the syspref says so
1702 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1703 my $userenv = C4::Context->userenv();
1704 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1706 $issue_attributes->{issuer_id} = $usernumber;
1710 # In the case that the borrower has an on-site checkout
1711 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1712 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1714 $issue->set($issue_attributes)->store;
1717 $issue = Koha::Checkout->new(
1719 itemnumber => $item_object->itemnumber,
1724 # Ensure item is no longer listed in the holds queue
1726 q{DELETE tmp_holdsqueue, hold_fill_targets FROM tmp_holdsqueue LEFT JOIN hold_fill_targets USING ( itemnumber ) WHERE itemnumber = ?},
1727 undef, $item_object->id
1730 $issue->discard_changes;
1731 $patron->update_lastseen('check_out');
1732 if ( $item_object->location && $item_object->location eq 'CART'
1733 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1734 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1735 CartToShelf( $item_object->itemnumber );
1738 # Update item location
1739 $item_object->location_update_trigger( 'checkout' );
1741 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1742 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1745 # Record if item was lost
1746 my $was_lost = $item_object->itemlost;
1748 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1749 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1750 $item_object->itemlost(0);
1751 $item_object->onloan($datedue->ymd());
1752 $item_object->datelastborrowed( dt_from_string()->ymd() );
1753 $item_object->datelastseen( dt_from_string() );
1754 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1756 # If the item was lost, it has now been found, charge the overdue if necessary
1758 if ( $item_object->{_charge} ) {
1759 $actualissue //= Koha::Old::Checkouts->search(
1760 { itemnumber => $item_object->itemnumber },
1762 order_by => { '-desc' => 'returndate' },
1766 unless ( $patron->branchcode ) {
1767 $patron = $actualissue->patron;
1769 _CalculateAndUpdateFine(
1771 issue => $actualissue,
1772 item => $item_unblessed,
1773 borrower => $patron->unblessed,
1774 return_date => $issuedate
1777 _FixOverduesOnReturn( $patron->borrowernumber,
1778 $item_object->itemnumber, undef, 'RENEWED' );
1782 # If it costs to borrow this book, charge it to the patron's account.
1783 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1784 if ( $charge && $charge > 0 ) {
1785 AddIssuingCharge( $issue, $charge, 'RENT' );
1788 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1789 if ( $itemtype_object ) {
1790 my $accumulate_charge = $fees->accumulate_rentalcharge();
1791 if ( $accumulate_charge > 0 ) {
1792 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1793 $charge += $accumulate_charge;
1794 $item_unblessed->{charge} = $charge;
1798 my $rules = C4::Context->yaml_preference('UpdateNotForLoanStatusOnCheckout');
1800 foreach my $key ( keys %$rules ) {
1801 if ( $item_object->notforloan eq $key ) {
1802 $item_object->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
1808 # Record the fact that this book was issued.
1809 C4::Stats::UpdateStats(
1811 branch => C4::Context->userenv->{'branch'},
1812 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1814 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1815 itemnumber => $item_object->itemnumber,
1816 itemtype => $item_object->effective_itemtype,
1817 location => $item_object->location,
1818 borrowernumber => $patron->borrowernumber,
1819 ccode => $item_object->ccode,
1820 categorycode => $patron->categorycode
1824 # Send a checkout slip.
1825 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1827 branchcode => $branchcode,
1828 categorycode => $patron->categorycode,
1829 item_type => $item_object->effective_itemtype,
1830 notification => 'CHECKOUT',
1832 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1833 SendCirculationAlert(
1836 item => $item_object->unblessed,
1837 borrower => $patron->unblessed,
1838 branch => $branchcode,
1843 "CIRCULATION", "ISSUE",
1844 $patron->borrowernumber,
1845 $item_object->itemnumber,
1846 ) if C4::Context->preference("IssueLog");
1848 Koha::Plugins->call('after_circ_action', {
1849 action => 'checkout',
1851 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1852 checkout => $issue->get_from_storage
1856 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1858 biblio_ids => [ $item_object->biblionumber ]
1860 ) if C4::Context->preference('RealTimeHoldsQueue');
1866 =head2 GetLoanLength
1868 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1870 Get loan length for an itemtype, a borrower type and a branch
1875 my ( $categorycode, $itemtype, $branchcode ) = @_;
1877 # Initialize default values
1881 lengthunit => 'days',
1884 my $found = Koha::CirculationRules->get_effective_rules( {
1885 branchcode => $branchcode,
1886 categorycode => $categorycode,
1887 itemtype => $itemtype,
1896 foreach my $rule_name (keys %$found) {
1897 $rules->{$rule_name} = $found->{$rule_name};
1904 =head2 GetHardDueDate
1906 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1908 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1912 sub GetHardDueDate {
1913 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1915 my $rules = Koha::CirculationRules->get_effective_rules(
1917 categorycode => $borrowertype,
1918 itemtype => $itemtype,
1919 branchcode => $branchcode,
1920 rules => [ 'hardduedate', 'hardduedatecompare' ],
1924 if ( defined( $rules->{hardduedate} ) ) {
1925 if ( $rules->{hardduedate} ) {
1926 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1929 return ( undef, undef );
1934 =head2 GetBranchBorrowerCircRule
1936 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1938 Retrieves circulation rule attributes that apply to the given
1939 branch and patron category, regardless of item type.
1940 The return value is a hashref containing the following key:
1942 patron_maxissueqty - maximum number of loans that a
1943 patron of the given category can have at the given
1944 branch. If the value is undef, no limit.
1946 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1947 patron of the given category can have at the given
1948 branch. If the value is undef, no limit.
1950 This will check for different branch/category combinations in the following order:
1954 default branch and category
1956 If no rule has been found in the database, it will default to
1959 patron_maxissueqty - undef
1960 patron_maxonsiteissueqty - undef
1962 C<$branchcode> and C<$categorycode> should contain the
1963 literal branch code and patron category code, respectively - no
1968 sub GetBranchBorrowerCircRule {
1969 my ( $branchcode, $categorycode ) = @_;
1971 # Initialize default values
1973 patron_maxissueqty => undef,
1974 patron_maxonsiteissueqty => undef,
1978 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1979 my $rule = Koha::CirculationRules->get_effective_rule(
1981 categorycode => $categorycode,
1983 branchcode => $branchcode,
1984 rule_name => $rule_name,
1988 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1994 =head2 GetBranchItemRule
1996 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1998 Retrieves circulation rule attributes that apply to the given
1999 branch and item type, regardless of patron category.
2001 The return value is a hashref containing the following keys:
2003 holdallowed => Hold policy for this branch and itemtype. Possible values:
2004 not_allowed: No holds allowed.
2005 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
2006 from_any_library: Holds allowed from any patron.
2007 from_local_hold_group: Holds allowed from libraries in hold group
2009 This searches branchitemrules in the following order:
2011 * Same branchcode and itemtype
2012 * Same branchcode, itemtype '*'
2013 * branchcode '*', same itemtype
2014 * branchcode and itemtype '*'
2016 Neither C<$branchcode> nor C<$itemtype> should be '*'.
2020 sub GetBranchItemRule {
2021 my ( $branchcode, $itemtype ) = @_;
2024 my $rules = Koha::CirculationRules->get_effective_rules({
2025 branchcode => $branchcode,
2026 itemtype => $itemtype,
2027 rules => ['holdallowed', 'hold_fulfillment_policy']
2030 # built-in default circulation rule
2031 $rules->{holdallowed} //= 'from_any_library';
2032 $rules->{hold_fulfillment_policy} //= 'any';
2039 ($doreturn, $messages, $iteminformation, $borrower) =
2040 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] [,$skip_localuse ] );
2046 =item C<$barcode> is the bar code of the book being returned.
2048 =item C<$branch> is the code of the branch where the book is being returned.
2050 =item C<$exemptfine> indicates that overdue charges for the item will be
2053 =item C<$return_date> allows the default return date to be overridden
2054 by the given return date. Optional.
2056 =item C<$skip_localuse> indicated that localuse should not be recorded. Optional.
2060 C<&AddReturn> returns a list of four items:
2062 C<$doreturn> is true iff the return succeeded.
2064 C<$messages> is a reference-to-hash giving feedback on the operation.
2065 The keys of the hash are:
2071 No item with this barcode exists. The value is C<$barcode>.
2075 The book is not currently on loan. The value is C<$barcode>.
2079 This book has been withdrawn/cancelled. The value should be ignored.
2081 =item C<Wrongbranch>
2083 This book has was returned to the wrong branch. The value is a hashref
2084 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2085 contain the branchcode of the incorrect and correct return library, respectively.
2089 The item was reserved. The value is a reference-to-hash whose keys are
2090 fields from the reserves table of the Koha database, and
2091 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2092 either C<Waiting>, C<Reserved>, or 0.
2094 =item C<WasReturned>
2096 Value 1 if return is successful.
2098 =item C<NeedsTransfer>
2100 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2102 =item C<RecallFound>
2104 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2105 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2108 =item C<TransferredRecall>
2110 This item has been transferred to this branch to fill a recall. The recall object is returned.
2114 C<$iteminformation> is a reference-to-hash, giving information about the
2115 returned item from the issues table.
2117 C<$borrower> is a reference-to-hash, giving information about the
2118 patron who last borrowed the book.
2123 my ( $barcode, $branch, $exemptfine, $return_date, $skip_localuse ) = @_;
2125 if ($branch and not Koha::Libraries->find($branch)) {
2126 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2129 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2130 my $return_date_specified = !!$return_date;
2131 $return_date //= dt_from_string();
2135 my $validTransfer = 1;
2136 my $stat_type = 'return';
2138 # get information on item
2139 my $item = Koha::Items->find({ barcode => $barcode });
2141 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2144 my $itemnumber = $item->itemnumber;
2145 my $itemtype = $item->effective_itemtype;
2147 my $issue = $item->checkout;
2149 $patron = $issue->patron
2150 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2151 . Dumper($issue->unblessed) . "\n";
2153 $messages->{'NotIssued'} = $barcode;
2154 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2156 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2158 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2159 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2160 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2161 $messages->{'LocalUse'} = 1;
2162 $stat_type = 'localuse';
2166 if ( $item->withdrawn ) { # book has been cancelled
2167 $messages->{'withdrawn'} = 1;
2169 # In the case where we block return of withdrawn, we should completely block the return
2170 # without updating item statuses, so we exit early
2171 return ( 0, $messages, $issue, ( $patron ? $patron->unblessed : {} ))
2172 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2176 # full item data, but no borrowernumber or checkout info (no issue)
2177 my $hbr = Koha::CirculationRules->get_return_branch_policy($item);
2179 # check if returnbranch and homebranch belong to the same float group
2180 my $validate_float =
2181 Koha::Libraries->find( $item->homebranch )->validate_float_sibling( { branchcode => $branch } );
2183 # get the proper branch to which to return the item
2185 if ( $hbr eq 'noreturn' ) {
2186 $returnbranch = $branch;
2187 } elsif ( $hbr eq 'returnbylibrarygroup' ) {
2189 # if library isn't in same the float group, transfer item to homebranch
2190 $hbr = 'homebranch';
2191 $returnbranch = $validate_float ? $branch : $item->$hbr;
2193 $returnbranch = $item->$hbr;
2196 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2197 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2199 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2200 my $patron_unblessed = $patron ? $patron->unblessed : {};
2202 # Update item location
2203 my $loc_messages = $item->location_update_trigger( 'checkin' );
2204 foreach my $loc_msg_key ( keys %$loc_messages ) {
2205 $messages->{ $loc_msg_key } = $loc_messages->{ $loc_msg_key };
2208 my $rules = C4::Context->yaml_preference('UpdateNotForLoanStatusOnCheckin');
2210 if ( defined $rules->{ $item->itype } ) {
2211 foreach my $notloan_rule_key ( keys %{ $rules->{ $item->itype } } ) {
2212 if ( $item->notforloan eq $notloan_rule_key ) {
2213 $messages->{'NotForLoanStatusUpdated'} =
2214 { from => $item->notforloan, to => $rules->{ $item->itype }->{$notloan_rule_key} };
2215 $item->notforloan( $rules->{ $item->itype }->{$notloan_rule_key} )
2216 ->store( { log_action => 0, skip_record_index => 1, skip_holds_queue => 1 } )
2217 unless $rules->{ $item->itype }->{$notloan_rule_key} eq 'ONLYMESSAGE';
2221 } elsif ( defined $rules->{'_ALL_'} ) {
2222 foreach my $notloan_rule_key ( keys %{ $rules->{'_ALL_'} } ) {
2223 if ( $item->notforloan eq $notloan_rule_key ) {
2224 $messages->{'NotForLoanStatusUpdated'} =
2225 { from => $item->notforloan, to => $rules->{'_ALL_'}->{$notloan_rule_key} };
2226 $item->notforloan( $rules->{'_ALL_'}->{$notloan_rule_key} )
2227 ->store( { log_action => 0, skip_record_index => 1, skip_holds_queue => 1 } )
2228 unless $rules->{'_ALL_'}->{$notloan_rule_key} eq 'ONLYMESSAGE';
2235 # check if the return is allowed at this branch
2236 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2237 unless ($returnallowed){
2238 $messages->{'Wrongbranch'} = {
2239 Wrongbranch => $branch,
2240 Rightbranch => $message
2243 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2244 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2245 return ( $doreturn, $messages, $issue, $patron_unblessed);
2248 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2252 # case of a return of document (deal with issues and holdingbranch)
2254 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2255 $patron or warn "AddReturn without current borrower";
2259 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2264 C4::Context->preference('CalculateFinesOnReturn')
2265 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2270 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2273 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 );
2275 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2276 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2278 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2281 # FIXME is the "= 1" right? This could be the borrower hash.
2282 $messages->{'WasReturned'} = 1;
2285 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2289 # the holdingbranch is updated if the document is returned to another location.
2290 # this is always done regardless of whether the item was on loan or not
2291 if ($item->holdingbranch ne $branch) {
2292 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2295 my $item_was_lost = $item->itemlost;
2296 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2297 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2299 # fix up the accounts.....
2300 if ($item_was_lost) {
2301 $messages->{'WasLost'} = 1;
2302 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2303 my @object_messages = @{ $updated_item->object_messages };
2304 for my $message (@object_messages) {
2305 $messages->{'LostItemFeeRefunded'} = 1
2306 if $message->message eq 'lost_refunded';
2307 $messages->{'ProcessingFeeRefunded'} = 1
2308 if $message->message eq 'processing_refunded';
2309 $messages->{'LostItemFeeRestored'} = 1
2310 if $message->message eq 'lost_restored';
2312 if ( $message->message eq 'lost_charge' ) {
2313 $issue //= Koha::Old::Checkouts->search(
2314 { itemnumber => $item->itemnumber },
2315 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2317 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2318 my $patron = $issue->patron;
2319 $patron_unblessed = $patron->unblessed;
2321 _CalculateAndUpdateFine(
2324 item => $item->unblessed,
2325 borrower => $patron_unblessed,
2326 return_date => $return_date
2329 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2330 $item->itemnumber, undef, 'RETURNED' );
2331 $messages->{'LostItemFeeCharged'} = 1;
2337 # check if we have a transfer for this document
2338 my $transfer = $item->get_transfer;
2340 # if we have a transfer to complete, we update the line of transfers with the datearrived
2343 if ( $transfer->in_transit ) {
2344 if ( $transfer->tobranch eq $branch ) {
2346 $messages->{'TransferArrived'} = $transfer->frombranch;
2347 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2349 if defined $transfer->reason && $transfer->reason eq 'Reserve';
2352 $messages->{'WrongTransfer'} = $transfer->tobranch;
2353 $messages->{'WrongTransferItem'} = $item->itemnumber;
2354 $messages->{'TransferTrigger'} = $transfer->reason;
2358 if ( $transfer->tobranch eq $branch ) {
2360 $messages->{'TransferArrived'} = $transfer->frombranch;
2361 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2362 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2365 $messages->{'TransferTrigger'} = $transfer->reason;
2366 if ( $transfer->frombranch eq $branch ) {
2368 $messages->{'WasTransfered'} = $transfer->tobranch;
2371 $messages->{'WrongTransfer'} = $transfer->tobranch;
2372 $messages->{'WrongTransferItem'} = $item->itemnumber;
2378 # fix up the overdues in accounts...
2379 if ($borrowernumber) {
2380 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2381 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2383 if ( $issue and $issue->is_overdue($return_date) ) {
2385 my ($debardate,$reminder) = _debar_user_on_return( $patron, $item, dt_from_string($issue->date_due), $return_date );
2386 if ($debardate and $debardate ne "9999-12-31") {
2388 $messages->{'PrevDebarred'} = $debardate;
2390 $messages->{'Debarred'} = $debardate;
2392 } elsif ($patron->debarred) {
2393 if ( $patron->debarred eq "9999-12-31") {
2394 $messages->{'ForeverDebarred'} = $patron->debarred;
2396 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2397 $borrower_debar_dt->truncate(to => 'day');
2398 my $today_dt = $return_date->clone()->truncate(to => 'day');
2399 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2400 $messages->{'PrevDebarred'} = $patron->debarred;
2404 # there's no overdue on the item but borrower had been previously debarred
2405 } elsif ( $issue->date_due and $patron->debarred ) {
2406 if ( $patron->debarred eq "9999-12-31") {
2407 $messages->{'ForeverDebarred'} = $patron->debarred;
2409 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2410 $borrower_debar_dt->truncate(to => 'day');
2411 my $today_dt = $return_date->clone()->truncate(to => 'day');
2412 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2413 $messages->{'PrevDebarred'} = $patron->debarred;
2420 if ( C4::Context->preference('UseRecalls') ) {
2421 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2423 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2424 if ( defined $recall ) {
2425 $messages->{RecallFound} = $recall;
2426 if ( $recall->pickup_library_id ne $branch ) {
2427 $messages->{RecallNeedsTransfer} = $branch;
2432 # find reserves.....
2433 # launch the Checkreserves routine to find any holds
2434 my ($resfound, $resrec);
2435 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2436 ($resfound, $resrec, undef) = CheckReserves( $item, $lookahead ) unless ( $item->withdrawn );
2437 # 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)
2438 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2439 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2440 $resfound = 'Reserved';
2441 $resrec = $hold->unblessed;
2444 $resrec->{'ResFound'} = $resfound;
2445 $messages->{'ResFound'} = $resrec;
2448 # Record the fact that this book was returned.
2449 my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2450 C4::Stats::UpdateStats({
2453 itemnumber => $itemnumber,
2454 itemtype => $itemtype,
2455 location => $item->location,
2456 borrowernumber => $borrowernumber,
2457 ccode => $item->ccode,
2458 categorycode => $categorycode,
2459 interface => C4::Context->interface,
2460 }) unless ( $skip_localuse && $stat_type eq 'localuse' );
2462 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2464 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2466 branchcode => $branch,
2467 categorycode => $patron->categorycode,
2468 item_type => $itemtype,
2469 notification => 'CHECKIN',
2471 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2472 SendCirculationAlert({
2474 item => $item->unblessed,
2475 borrower => $patron->unblessed,
2481 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2482 if C4::Context->preference("ReturnLog");
2484 #Update borrowers.lastseen
2485 $patron->update_lastseen('check_in');
2488 # Check if this item belongs to a biblio record that is attached to an
2489 # ILL request, if it is we need to update the ILL request's status
2490 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2491 my $request = Koha::Illrequests->find(
2492 { biblio_id => $item->biblio->biblionumber }
2494 $request->status('RET') if $request;
2497 if ( C4::Context->preference('UseRecalls') ) {
2498 # all recalls that have triggered a transfer will have an allocated itemnumber
2499 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2500 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2501 $messages->{TransferredRecall} = $transfer_recall;
2505 if ( $messages->{WasLost} and C4::Context->preference('BlockReturnOfLostItems') ) {
2509 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2510 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2511 && ( $doreturn or $messages->{'NotIssued'} )
2513 and ( $branch ne $returnbranch )
2514 and not $messages->{'WrongTransfer'}
2515 and not $messages->{'WasTransfered'}
2516 and not $messages->{TransferredRecall}
2517 and not $messages->{RecallNeedsTransfer} )
2519 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2520 if (C4::Context->preference("AutomaticItemReturn" ) or
2521 (C4::Context->preference("UseBranchTransferLimits") and
2522 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2524 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2525 $messages->{'WasTransfered'} = $returnbranch;
2526 $messages->{'TransferTrigger'} = $transfer_trigger;
2528 $messages->{'NeedsTransfer'} = $returnbranch;
2529 $messages->{'TransferTrigger'} = $transfer_trigger;
2533 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2534 my $claims = Koha::Checkouts::ReturnClaims->search(
2536 itemnumber => $item->id,
2537 resolution => undef,
2541 if ( $claims->count ) {
2542 $messages->{ReturnClaims} = $claims;
2546 # Check for bundle status
2547 if ( $item->in_bundle ) {
2548 my $host = $item->bundle_host;
2549 $messages->{InBundle} = $host;
2552 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2553 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2555 if ( $doreturn and $issue ) {
2556 my $checkin = Koha::Old::Checkouts->find($issue->id);
2558 Koha::Plugins->call('after_circ_action', {
2559 action => 'checkin',
2565 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2567 biblio_ids => [ $item->biblionumber ]
2569 ) if C4::Context->preference('RealTimeHoldsQueue');
2572 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2575 =head2 MarkIssueReturned
2577 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2579 Unconditionally marks an issue as being returned by
2580 moving the C<issues> row to C<old_issues> and
2581 setting C<returndate> to the current date.
2583 if C<$returndate> is specified (in iso format), it is used as the date
2586 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2587 the old_issue is immediately anonymised
2589 Ideally, this function would be internal to C<C4::Circulation>,
2590 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2591 and offline_circ/process_koc.pl.
2593 The last optional parameter allos passing skip_record_index to the item store call.
2597 sub MarkIssueReturned {
2598 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2600 # Retrieve the issue
2601 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2602 my $issue_branchcode = $issue->branchcode;
2604 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2606 my $issue_id = $issue->issue_id;
2608 my $schema = Koha::Database->schema;
2610 # FIXME Improve the return value and handle it from callers
2611 $schema->txn_do(sub {
2613 my $patron = Koha::Patrons->find( $borrowernumber );
2615 # Update the returndate value
2616 if ( $returndate ) {
2617 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2620 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2623 # Create the old_issues entry
2624 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2626 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2627 if ( $privacy && $privacy == 2) {
2628 $old_checkout->anonymize;
2631 # And finally delete the issue
2634 $issue->item->onloan(undef)->store(
2636 skip_record_index => $params->{skip_record_index},
2637 skip_holds_queue => $params->{skip_holds_queue}
2641 if ( C4::Context->preference('StoreLastBorrower') ) {
2642 my $item = Koha::Items->find( $itemnumber );
2643 $item->last_returned_by( $patron->borrowernumber )->store;
2646 # Possibly remove any OVERDUES related debarment
2647 my $overdue_restrictions = $patron->restrictions->search( { type => 'OVERDUES' } );
2648 if ( C4::Context->preference('AutoRemoveOverduesRestrictions') ne 'no' && $patron->is_debarred ) {
2649 my $remove_restrictions =
2650 C4::Context->preference('AutoRemoveOverduesRestrictions') eq 'when_no_overdue_causing_debarment'
2651 ? !$patron->has_restricting_overdues( { issue_branchcode => $issue_branchcode } )
2652 : !$patron->has_overdues;
2653 if ( $remove_restrictions && $overdue_restrictions->count ) {
2654 DelUniqueDebarment( { borrowernumber => $borrowernumber, type => 'OVERDUES' } );
2663 =head2 _debar_user_on_return
2665 _debar_user_on_return($patron, $item, $datedue, $returndate);
2667 C<$patron> patron object
2669 C<$item> item object
2671 C<$datedue> date due DateTime object
2673 C<$returndate> DateTime object representing the return time
2675 Internal function, called only by AddReturn that calculates and updates
2676 the user fine days, and debars them if necessary.
2678 Should only be called for overdue returns
2680 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2685 sub _calculate_new_debar_dt {
2686 my ( $patron, $item, $dt_due, $return_date ) = @_;
2688 my $branchcode = _GetCircControlBranch( $item, $patron );
2689 my $circcontrol = C4::Context->preference('CircControl');
2690 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2691 { categorycode => $patron->categorycode,
2692 itemtype => $item->effective_itemtype,
2693 branchcode => $branchcode,
2698 'maxsuspensiondays',
2699 'suspension_chargeperiod',
2703 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2704 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2705 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2707 return unless $finedays;
2709 # finedays is in days, so hourly loans must multiply by 24
2710 # thus 1 hour late equals 1 day suspension * finedays rate
2711 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2713 # grace period is measured in the same units as the loan
2715 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2717 my $deltadays = DateTime::Duration->new(
2718 days => $chargeable_units
2721 if ( $deltadays->subtract($grace)->is_positive() ) {
2722 my $suspension_days = $deltadays * $finedays;
2724 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2725 # No need to / 1 and do not consider / 0
2726 $suspension_days = DateTime::Duration->new(
2727 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2731 # If the max suspension days is < than the suspension days
2732 # the suspension days is limited to this maximum period.
2733 my $max_sd = $issuing_rule->{maxsuspensiondays};
2734 if ( defined $max_sd && $max_sd ne '' ) {
2735 $max_sd = DateTime::Duration->new( days => $max_sd );
2736 $suspension_days = $max_sd
2737 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2740 my ( $has_been_extended );
2741 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $patron->is_debarred ) {
2742 my $debarment = $patron->restrictions->search({type => 'SUSPENSION' },{rows => 1})->single;
2744 $return_date = dt_from_string( $debarment->expiration, 'sql' );
2745 $has_been_extended = 1;
2750 # Use the calendar or not to calculate the debarment date
2751 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2752 my $calendar = Koha::Calendar->new(
2753 branchcode => $branchcode,
2754 days_mode => 'Calendar'
2756 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2759 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2761 return $new_debar_dt;
2766 sub _debar_user_on_return {
2767 my ( $patron, $item, $dt_due, $return_date ) = @_;
2769 $return_date //= dt_from_string();
2771 my $new_debar_dt = _calculate_new_debar_dt($patron, $item, $dt_due, $return_date);
2773 return unless $new_debar_dt;
2775 Koha::Patron::Debarments::AddUniqueDebarment({
2776 borrowernumber => $patron->borrowernumber,
2777 expiration => $new_debar_dt->ymd(),
2778 type => 'SUSPENSION',
2780 # if borrower was already debarred but does not get an extra debarment
2781 my ($new_debarment_str, $is_a_reminder);
2782 if ( $patron->is_debarred ) {
2784 $new_debarment_str = $patron->debarred;
2786 $new_debarment_str = $new_debar_dt->ymd();
2788 # FIXME Should return a DateTime object
2789 return $new_debarment_str, $is_a_reminder;
2792 =head2 _FixOverduesOnReturn
2794 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2796 C<$borrowernumber> borrowernumber
2798 C<$itemnumber> itemnumber
2800 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2802 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2808 sub _FixOverduesOnReturn {
2809 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2810 unless( $borrowernumber ) {
2811 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2815 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2819 warn "_FixOverduesOnReturn() not supplied valid status";
2823 my $schema = Koha::Database->schema;
2825 my $result = $schema->txn_do(
2827 # check for overdue fine
2828 my $accountlines = Koha::Account::Lines->search(
2830 borrowernumber => $borrowernumber,
2831 itemnumber => $item,
2832 debit_type_code => 'OVERDUE',
2833 status => 'UNRETURNED'
2836 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2838 my $accountline = $accountlines->next;
2839 my $payments = $accountline->credits;
2841 my $amountoutstanding = $accountline->amountoutstanding;
2842 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2843 $accountline->delete;
2844 return 0; # no warning, we've just removed a zero value fine (backdated return)
2845 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2846 my $account = Koha::Account->new({patron_id => $borrowernumber});
2847 my $credit = $account->add_credit(
2849 amount => $amountoutstanding,
2850 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2851 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2852 interface => C4::Context->interface,
2858 $credit->apply({ debits => [ $accountline ] });
2860 if (C4::Context->preference("FinesLog")) {
2861 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2865 $accountline->status($status);
2866 return $accountline->store();
2873 =head2 _GetCircControlBranch
2875 my $circ_control_branch = _GetCircControlBranch($item, $patron);
2879 Return the library code to be used to determine which circulation
2880 policy applies to a transaction. Looks up the CircControl and
2881 HomeOrHoldingBranch system preferences.
2883 C<$item> is an item object.
2885 C<$patron> is a patron object.
2889 sub _GetCircControlBranch {
2890 my ($item, $patron) = @_;
2891 my $circcontrol = C4::Context->preference('CircControl');
2894 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2895 $branch = C4::Context->userenv->{'branch'};
2896 } elsif ($circcontrol eq 'PatronLibrary') {
2897 $branch = $patron->branchcode;
2899 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2900 $branch = $item->get_column($branchfield);
2901 # default to item home branch if holdingbranch is used
2902 # and is not defined
2903 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2904 $branch = $item->homebranch;
2910 =head2 GetUpcomingDueIssues
2912 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2916 sub GetUpcomingDueIssues {
2919 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2920 my $dbh = C4::Context->dbh;
2923 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2925 LEFT JOIN items USING (itemnumber)
2926 LEFT JOIN branches ON branches.branchcode =
2928 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2929 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2930 my @bind_parameters = ( $params->{'days_in_advance'} );
2932 my $sth = $dbh->prepare( $statement );
2933 $sth->execute( @bind_parameters );
2934 my $upcoming_dues = $sth->fetchall_arrayref({});
2936 return $upcoming_dues;
2939 =head2 CanBookBeRenewed
2941 ($ok,$error,$info) = &CanBookBeRenewed($patron, $issue, $override_limit, $cron);
2943 Find out whether a borrowed item may be renewed.
2945 C<$patron> is the patron who currently has the issue.
2947 C<$issue> is the checkout to renew.
2949 C<$cron> true or false, specifies if this check is being made
2950 by the automatic_renewals.pl cronscript
2952 C<$override_limit>, if supplied with a true value, causes
2953 the limit on the number of times that the loan can be renewed
2954 (as controlled by the item type) to be ignored. Overriding also allows
2955 to renew sooner than "No renewal before" and to manually renew loans
2956 that are automatically renewed.
2958 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2959 item must currently be on loan to the specified borrower; renewals
2960 must be allowed for the item's type; and the borrower must not have
2961 already renewed the loan.
2962 $error will contain the reason the renewal can not proceed
2963 $info will contain a hash of additional info
2964 currently 'soonest_renew_date' if error is 'too soon'
2968 sub CanBookBeRenewed {
2969 my ( $patron, $issue, $override_limit, $cron ) = @_;
2971 my $auto_renew = "no";
2973 my $item = $issue->item;
2975 return ( 0, 'no_item' ) unless $item;
2976 return ( 0, 'no_checkout' ) unless $issue;
2977 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2978 return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2979 return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2981 my $final_renewal = 0;
2982 my $final_unseen_renewal = 0;
2984 # override_limit will override anything else except on_reserve
2985 my $branchcode = _GetCircControlBranch( $item, $patron );
2986 unless ( $override_limit ){
2988 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2991 branchcode => $branchcode,
2994 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2995 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2996 # extra notices being sent. Cron also implies no override
2997 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2998 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2999 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
3001 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3003 categorycode => $patron->categorycode,
3004 itemtype => $item->effective_itemtype,
3005 branchcode => $branchcode,
3009 'unseen_renewals_allowed'
3014 return ( 0, "too_many" )
3015 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
3017 return ( 0, "too_unseen" )
3018 if C4::Context->preference('UnseenRenewals') &&
3019 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
3020 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
3022 $final_renewal = $issuing_rule->{renewalsallowed} == ( $issue->renewals_count + 1 ) ? 1 : 0;
3023 $final_unseen_renewal = ( C4::Context->preference('UnseenRenewals')
3024 && $issuing_rule->{unseen_renewals_allowed} == ( $issue->unseen_renewals + 1 ) ) ? 1 : 0;
3026 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
3027 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
3028 my $restricted = $patron->is_debarred;
3029 my $hasoverdues = $patron->has_overdues;
3031 if ( $restricted and $restrictionblockrenewing ) {
3032 return ( 0, 'restriction');
3033 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
3034 return ( 0, 'overdue');
3039 if ( C4::Context->preference('UseRecalls') ) {
3041 $recall = $item->check_recalls if $item->can_be_waiting_recall;
3042 if ( defined $recall ) {
3043 if ( $recall->item_level ) {
3044 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
3045 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
3047 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
3048 return ( 0, 'recalled' ) unless ( $recall->waiting );
3053 # There is an item level hold on this item, no other item can fill the hold
3054 return ( 0, "on_reserve" )
3055 if ( $item->current_holds->search( { non_priority => 0 } )->count );
3058 my ( $status, $matched_reserve, $possible_holds ) = CheckReserves($item);
3059 my @fillable_holds = ();
3060 foreach my $possible_hold ( @{$possible_holds} ) {
3061 push @fillable_holds, $possible_hold unless $possible_hold->{non_priority};
3063 if ( @fillable_holds ) {
3064 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
3066 # Get all other items that could possibly fill reserves
3067 # FIXME We could join reserves (or more tables) here to eliminate some checks later
3068 my @other_items = Koha::Items->search({
3069 biblionumber => $item->biblionumber,
3072 -not => { itemnumber => $item->itemnumber } })->as_list;
3074 return ( 0, "on_reserve" ) if @fillable_holds && (scalar @other_items < scalar @fillable_holds );
3077 foreach my $possible_hold ( @fillable_holds ) {
3079 my $patron_with_reserve = Koha::Patrons->find($possible_hold->{borrowernumber});
3081 foreach my $other_item (@other_items) {
3082 next if defined $matched_items{$other_item->itemnumber};
3083 next if IsItemOnHoldAndFound( $other_item->itemnumber );
3084 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef);
3085 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3086 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3087 # CanItemBeReserved checks 'rules' and 'policies' which means
3088 # items will fill holds at checkin that are rejected here
3090 $matched_items{$other_item->itemnumber} = 1;
3093 return ( 0, "on_reserve" ) unless $fillable;
3097 return ( 0, "on_reserve" ) if $status;
3101 # CHECK FOR BOOKINGS
3102 if ( $item->bookings->count ) {
3104 ( C4::Context->preference('RenewalPeriodBase') eq 'date_due' )
3105 ? dt_from_string( $issue->date_due, 'sql' )
3107 my $datedue = CalcDateDue( $startdate, $item->effective_itemtype, $branchcode, $patron, 'is a renewal' );
3109 my $booking = $item->find_booking(
3110 { checkout_date => $startdate, due_date => $datedue, patron_id => $patron->borrowernumber }
3114 return ( 0, 'booked' ) unless ( $booking->patron_id == $patron->borrowernumber );
3119 if ( $auto_renew eq 'auto_too_soon' ) {
3121 # If its cron, tell it it's too soon for a an auto renewal
3122 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $cron;
3124 # Check if it's too soon for a manual renewal
3125 my $soonestManual = GetSoonestRenewDate( $patron, $issue );
3126 if ( $soonestManual > dt_from_string() ) {
3127 return ( 0, "too_soon", { soonest_renew_date => $soonestManual } ) unless $override_limit;
3131 $soonest = GetSoonestRenewDate($patron, $issue);
3132 if ( $soonest > dt_from_string() ){
3133 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3136 my $auto_renew_code = $final_renewal ? 'auto_renew_final' : $final_unseen_renewal ? 'auto_unseen_final' : 'auto_renew';
3137 return ( 1, $auto_renew_code ) if $auto_renew eq "ok" || $auto_renew eq "auto_too_soon" && !$override_limit;
3139 return ( 1, undef );
3144 $new_date_due = AddRenewal({
3145 borrowernumber => $borrowernumber,
3146 itemnumber => $itemnumber,
3148 [datedue => $datedue],
3149 [lastreneweddate => $lastreneweddate],
3150 [skipfinecalc => $skipfinecalc],
3152 [automatic => $automatic],
3153 [skip_record_index => $skip_record_index]
3156 Renews a loan, returns the updated due date upon success.
3158 C<$borrowernumber> is the borrower number of the patron who currently
3161 C<$itemnumber> is the number of the item to renew.
3163 C<$branch> is the library where the renewal took place (if any).
3164 The library that controls the circ policies for the renewal is retrieved from the issues record.
3166 C<$datedue> can be a DateTime object used to set the due date.
3168 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3169 this parameter is not supplied, lastreneweddate is set to the current date.
3171 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3172 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3173 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3176 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3177 from the book's item type.
3179 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3180 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3181 fallback to a true value
3183 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3185 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3186 should be skipped for this renewal.
3193 my $borrowernumber = $params->{borrowernumber};
3194 my $itemnumber = $params->{itemnumber};
3195 return unless $itemnumber;
3197 my $branch = $params->{branch};
3198 my $datedue = $params->{datedue};
3199 my $lastreneweddate = $params->{lastreneweddate} // dt_from_string();
3200 my $skipfinecalc = $params->{skipfinecalc};
3201 my $seen = $params->{seen};
3202 my $automatic = $params->{automatic};
3203 my $skip_record_index = $params->{skip_record_index};
3205 # Fallback on a 'seen' renewal
3206 $seen = defined $seen && $seen == 0 ? 0 : 1;
3208 my $item_object = Koha::Items->find($itemnumber) or return;
3209 my $biblio = $item_object->biblio;
3210 my $issue = $item_object->checkout;
3211 my $item_unblessed = $item_object->unblessed;
3213 my $renewal_type = $automatic ? "Automatic" : "Manual";
3215 my $dbh = C4::Context->dbh;
3217 return unless $issue;
3219 $borrowernumber ||= $issue->borrowernumber;
3221 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3222 $datedue = dt_from_string($datedue, 'sql');
3225 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3226 my $patron_unblessed = $patron->unblessed;
3228 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
3230 my $schema = Koha::Database->schema;
3231 $schema->txn_do(sub{
3233 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3234 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3236 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3238 # If the due date wasn't specified, calculate it by adding the
3239 # book's loan length to today's date or the current due date
3240 # based on the value of the RenewalPeriodBase syspref.
3241 my $itemtype = $item_object->effective_itemtype;
3244 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3245 dt_from_string( $issue->date_due, 'sql' ) :
3247 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron, 'is a renewal');
3250 my $fees = Koha::Charges::Fees->new(
3253 library => $circ_library,
3254 item => $item_object,
3255 from_date => dt_from_string( $issue->date_due, 'sql' ),
3256 to_date => dt_from_string($datedue),
3260 # Increment the unseen renewals, if appropriate
3261 # We only do so if the syspref is enabled and
3262 # a maximum value has been set in the circ rules
3263 my $unseen_renewals = $issue->unseen_renewals;
3264 if (C4::Context->preference('UnseenRenewals')) {
3265 my $rule = Koha::CirculationRules->get_effective_rule(
3266 { categorycode => $patron->categorycode,
3267 itemtype => $item_object->effective_itemtype,
3268 branchcode => $circ_library->branchcode,
3269 rule_name => 'unseen_renewals_allowed'
3272 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3275 # If the renewal is seen, unseen should revert to 0
3276 $unseen_renewals = 0;
3280 # Update the issues record to have the new due date, and a new count
3281 # of how many times it has been renewed.
3282 my $renews = ( $issue->renewals_count || 0 ) + 1;
3283 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3286 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3289 Koha::Exceptions::Checkout::FailedRenewal->throw(
3290 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3294 # Update the renewal count on the item, and tell zebra to reindex
3295 $renews = ( $item_object->renewals || 0 ) + 1;
3296 $item_object->renewals($renews);
3297 $item_object->onloan($datedue);
3298 # Don't index as we are in a transaction, skip hardcoded here
3299 $item_object->store({ log_action => 0, skip_record_index => 1 });
3301 # Charge a new rental fee, if applicable
3302 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3303 if ( $charge > 0 ) {
3304 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3307 # Charge a new accumulate rental fee, if applicable
3308 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3309 if ( $itemtype_object ) {
3310 my $accumulate_charge = $fees->accumulate_rentalcharge();
3311 if ( $accumulate_charge > 0 ) {
3312 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3314 $charge += $accumulate_charge;
3317 # Send a renewal slip according to checkout alert preferencei
3318 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3319 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3321 branchcode => $branch,
3322 categorycode => $patron->categorycode,
3323 item_type => $itemtype,
3324 notification => 'CHECKOUT',
3326 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3327 SendCirculationAlert(
3330 item => $item_unblessed,
3331 borrower => $patron->unblessed,
3338 # Remove any OVERDUES related debarment if the borrower has no overdues
3339 my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3341 && $patron->is_debarred
3342 && ! $patron->has_overdues
3343 && $overdue_restrictions->count
3345 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3348 # Add renewal record
3349 my $renewal = Koha::Checkouts::Renewal->new(
3351 checkout_id => $issue->issue_id,
3352 interface => C4::Context->interface,
3353 renewal_type => $renewal_type,
3354 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3359 # Add the renewal to stats
3360 C4::Stats::UpdateStats(
3362 branch => $item_object->renewal_branchcode({branch => $branch}),
3365 itemnumber => $itemnumber,
3366 itemtype => $itemtype,
3367 location => $item_object->location,
3368 borrowernumber => $borrowernumber,
3369 ccode => $item_object->ccode,
3370 categorycode => $patron->categorycode,
3371 interface => C4::Context->interface,
3374 #Update borrowers.lastseen
3375 $patron->update_lastseen('renewal');
3378 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3380 Koha::Plugins->call('after_circ_action', {
3381 action => 'renewal',
3383 checkout => $issue->get_from_storage
3388 unless( $skip_record_index ){
3389 # We index now, after the transaction is committed
3390 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3391 $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3398 # check renewal status
3399 my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3401 my $dbh = C4::Context->dbh;
3403 my $unseencount = 0;
3404 my $renewsallowed = 0;
3405 my $unseenallowed = 0;
3408 my $patron = blessed $borrowernumber_or_patron ?
3409 $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3410 my $item = blessed $itemnumber_or_item ?
3411 $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3413 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3415 # Look in the issues table for this item, lent to this borrower,
3416 # and not yet returned.
3418 # FIXME - I think this function could be redone to use only one SQL call.
3419 my $sth = $dbh->prepare(q{
3420 SELECT * FROM issues
3421 WHERE (borrowernumber = ?) AND (itemnumber = ?)
3423 $sth->execute( $patron->borrowernumber, $item->itemnumber );
3424 my $data = $sth->fetchrow_hashref;
3425 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3426 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3427 # $item and $borrower should be calculated
3428 my $branchcode = _GetCircControlBranch($item, $patron);
3430 my $rules = Koha::CirculationRules->get_effective_rules(
3432 categorycode => $patron->categorycode,
3433 itemtype => $item->effective_itemtype,
3434 branchcode => $branchcode,
3435 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3438 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3439 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3440 $rules->{unseen_renewals_allowed} :
3442 $renewsleft = $renewsallowed - $renewcount;
3443 $unseenleft = $unseenallowed - $unseencount;
3444 if($renewsleft < 0){ $renewsleft = 0; }
3445 if($unseenleft < 0){ $unseenleft = 0; }
3456 =head2 GetSoonestRenewDate
3458 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3460 Find out the soonest possible renew date of a borrowed item.
3462 C<$patron> is the patron who currently has the item on loan.
3464 C<$issue> is the the item issue.
3466 C<$is_auto> is this soonest renew date for an auto renewal?
3468 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3469 renew date, based on the value "No renewal before" of the applicable
3470 issuing rule. Returns the current date if the item can already be
3471 renewed, and returns undefined if the patron, item, or checkout
3476 sub GetSoonestRenewDate {
3477 my ( $patron, $issue, $is_auto ) = @_;
3478 return unless $issue;
3479 return unless $patron;
3481 my $item = $issue->item;
3482 return unless $item;
3484 my $circ_rule = $is_auto ? 'noautorenewalbefore' : 'norenewalbefore';
3486 my $dbh = C4::Context->dbh;
3488 my $branchcode = _GetCircControlBranch( $item, $patron );
3489 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3490 { categorycode => $patron->categorycode,
3491 itemtype => $item->effective_itemtype,
3492 branchcode => $branchcode,
3500 my $now = dt_from_string;
3502 if ( defined $issuing_rule->{$circ_rule}
3503 and $issuing_rule->{$circ_rule} ne "" )
3505 my $soonestrenewal =
3506 dt_from_string( $issue->date_due )->subtract(
3507 $issuing_rule->{lengthunit} => $issuing_rule->{$circ_rule} );
3509 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3510 and $issuing_rule->{lengthunit} eq 'days' )
3512 $soonestrenewal->truncate( to => 'day' );
3514 return $soonestrenewal;
3515 } elsif ( $is_auto && $issue->auto_renew && $patron->autorenew_checkouts ) {
3516 # Checkouts with auto-renewing fall back to due date if noautorenewalbefore is undef
3517 my $soonestrenewal = dt_from_string( $issue->date_due );
3518 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3519 and $issuing_rule->{lengthunit} eq 'days' )
3521 $soonestrenewal->truncate( to => 'day' );
3523 return $soonestrenewal;
3528 =head2 GetLatestAutoRenewDate
3530 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3532 Find out the latest possible auto renew date of a borrowed item.
3534 C<$patron> is the patron who currently has the item on loan.
3536 C<$issue> is the item issue.
3538 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3539 auto renew date, based on the value "No auto renewal after" and the "No auto
3540 renewal after (hard limit) of the applicable issuing rule.
3541 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3542 or item cannot be found.
3546 sub GetLatestAutoRenewDate {
3547 my ( $patron, $issue ) = @_;
3548 return unless $issue;
3549 return unless $patron;
3551 my $item = $issue->item;
3552 return unless $item;
3554 my $dbh = C4::Context->dbh;
3555 my $branchcode = _GetCircControlBranch( $item, $patron );
3557 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3559 categorycode => $patron->categorycode,
3560 itemtype => $item->effective_itemtype,
3561 branchcode => $branchcode,
3563 'no_auto_renewal_after',
3564 'no_auto_renewal_after_hard_limit',
3570 return unless $circulation_rules;
3572 if ( not $circulation_rules->{no_auto_renewal_after}
3573 or $circulation_rules->{no_auto_renewal_after} eq '' )
3574 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3575 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3577 my $maximum_renewal_date;
3578 if ( $circulation_rules->{no_auto_renewal_after} ) {
3579 $maximum_renewal_date = dt_from_string($issue->issuedate);
3580 $maximum_renewal_date->add(
3581 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3585 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3586 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3587 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3589 return $maximum_renewal_date;
3593 =head2 GetIssuingCharges
3595 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3597 Calculate how much it would cost for a given patron to borrow a given
3598 item, including any applicable discounts.
3600 C<$itemnumber> is the item number of item the patron wishes to borrow.
3602 C<$borrowernumber> is the patron's borrower number.
3604 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3605 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3610 sub GetIssuingCharges {
3612 # calculate charges due
3613 my ( $itemnumber, $borrowernumber ) = @_;
3615 my $dbh = C4::Context->dbh;
3618 # Get the book's item type and rental charge (via its biblioitem).
3619 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3620 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3621 $charge_query .= (C4::Context->preference('item-level_itypes'))
3622 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3623 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3625 $charge_query .= ' WHERE items.itemnumber =?';
3627 my $sth = $dbh->prepare($charge_query);
3628 $sth->execute($itemnumber);
3630 if ( my $item_data = $sth->fetchrow_hashref ) {
3631 $item_type = $item_data->{itemtype};
3632 $charge = $item_data->{rentalcharge};
3634 # FIXME This should follow CircControl
3635 my $branch = C4::Context::mybranch();
3636 $patron //= Koha::Patrons->find( $borrowernumber );
3637 my $discount = Koha::CirculationRules->get_effective_rule({
3638 categorycode => $patron->categorycode,
3639 branchcode => $branch,
3640 itemtype => $item_type,
3641 rule_name => 'rentaldiscount'
3644 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3646 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3650 return ( $charge, $item_type );
3653 =head2 AddIssuingCharge
3655 &AddIssuingCharge( $checkout, $charge, $type )
3659 sub AddIssuingCharge {
3660 my ( $checkout, $charge, $type ) = @_;
3662 # FIXME What if checkout does not exist?
3664 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3665 my $accountline = $account->add_debit(
3669 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3670 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3671 interface => C4::Context->interface,
3673 item_id => $checkout->itemnumber,
3674 issue_id => $checkout->issue_id,
3679 =head2 GetTransfersFromTo
3681 @results = GetTransfersFromTo($frombranch,$tobranch);
3683 Returns the list of pending transfers between $from and $to branch
3687 sub GetTransfersFromTo {
3688 my ( $frombranch, $tobranch ) = @_;
3689 return unless ( $frombranch && $tobranch );
3690 my $dbh = C4::Context->dbh;
3692 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3693 FROM branchtransfers
3696 AND datecancelled IS NULL
3697 AND datesent IS NOT NULL
3698 AND datearrived IS NULL
3700 my $sth = $dbh->prepare($query);
3701 $sth->execute( $frombranch, $tobranch );
3704 while ( my $data = $sth->fetchrow_hashref ) {
3705 push @gettransfers, $data;
3707 return (@gettransfers);
3710 =head2 SendCirculationAlert
3712 Send out a C<check-in> or C<checkout> alert using the messaging system.
3720 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3724 Hashref of information about the item being checked in or out.
3728 Hashref of information about the borrower of the item.
3732 The branchcode from where the checkout or check-in took place.
3738 SendCirculationAlert({
3741 borrower => $borrower,
3747 sub SendCirculationAlert {
3749 my ($type, $item, $borrower, $branch, $issue) =
3750 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3751 my %message_name = (
3752 CHECKIN => 'Item_Check_in',
3753 CHECKOUT => 'Item_Checkout',
3754 RENEWAL => 'Item_Checkout',
3756 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3757 borrowernumber => $borrower->{borrowernumber},
3758 message_name => $message_name{$type},
3763 items => $item->{itemnumber},
3764 biblio => $item->{biblionumber},
3765 biblioitems => $item->{biblionumber},
3766 borrowers => $borrower,
3767 branches => $branch,
3770 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3771 # See C4::Letters:: _parseletter_sth
3772 if( $type eq 'CHECKIN' ){
3773 $tables->{old_issues} = $issue->issue_id;
3775 $tables->{issues} = $item->{itemnumber};
3778 my $schema = Koha::Database->new->schema;
3779 my @transports = keys %{ $borrower_preferences->{transports} };
3781 # From the MySQL doc:
3782 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3783 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3784 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3785 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3787 for my $mtt (@transports) {
3788 my $letter = C4::Letters::GetPreparedLetter (
3789 module => 'circulation',
3790 letter_code => $type,
3791 branchcode => $branch,
3792 message_transport_type => $mtt,
3793 lang => $borrower->{lang},
3797 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3798 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3799 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3800 unless ( $message ) {
3801 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3802 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3803 C4::Message->enqueue($letter, $patron, $mtt);
3805 $message->append($letter);
3808 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3814 =head2 updateWrongTransfer
3816 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3818 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
3822 sub updateWrongTransfer {
3823 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3825 # first step: cancel the original transfer
3826 my $item = Koha::Items->find($itemNumber);
3827 my $transfer = $item->get_transfer;
3828 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3830 # second step: create a new transfer to the right location
3831 my $new_transfer = $item->request_transfer(
3833 to => $transfer->to_library,
3834 reason => $transfer->reason,
3835 comment => $transfer->comments,
3841 return $new_transfer;
3846 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3848 this function calculates the due date given the start date and configured circulation rules,
3849 checking against the holidays calendar as per the daysmode circulation rule.
3850 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3851 C<$itemtype> = itemtype code of item in question
3852 C<$branch> = location whose calendar to use
3853 C<$patron> = Patron object
3854 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3859 my ( $startdate, $itemtype, $branch, $patron, $isrenewal ) = @_;
3863 # loanlength now a href
3865 GetLoanLength( $patron->categorycode, $itemtype, $branch );
3867 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3873 if (ref $startdate ne 'DateTime' ) {
3874 $datedue = dt_from_string($datedue);
3876 $datedue = $startdate->clone;
3879 $datedue = dt_from_string()->truncate( to => 'minute' );
3883 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3885 categorycode => $patron->categorycode,
3886 itemtype => $itemtype,
3887 branchcode => $branch,
3891 my $considerlibraryhours = C4::Context->preference('ConsiderLibraryHoursInCirculation');
3893 # starter vars so don't do calculations directly to $datedue
3894 my $potential_datedue = $datedue->clone;
3895 my $library_close = $datedue->clone;
3896 my $dayofweek = $datedue->day_of_week - 1;
3897 my $tomorrow_dayofweek = $dayofweek + 1;
3899 # If it's Sunday and tomorrow would be == 7, make tomorrow 0 (Days are stored as 0-6)
3900 if ( $tomorrow_dayofweek > 6 ) { $tomorrow_dayofweek = 0; }
3901 my $todayhours = Koha::Library::Hours->find( { library_id => $branch, day => $dayofweek } );
3903 my $tomorrowhours = Koha::Library::Hours->find( { library_id => $branch, day => $tomorrow_dayofweek } )
3904 ; # get open hours of next day
3906 if ( $considerlibraryhours ne 'ignore' and $todayhours->close_time and $tomorrowhours->open_time ) {
3907 @close = split( ":", $todayhours->close_time );
3908 $library_close = $library_close->set( hour => $close[0], minute => $close[1] );
3909 $potential_datedue = $potential_datedue->add( hours => $loanlength->{$length_key} )
3910 ; # datedue without consideration for open hours
3911 @open = split( ":", $tomorrowhours->open_time );
3914 # calculate the datedue as normal
3915 if ( $daysmode eq 'Days' )
3916 { # ignoring calendar
3917 if ( $loanlength->{lengthunit} eq 'hours' ) {
3918 if ( $considerlibraryhours ne 'ignore' and $potential_datedue > $library_close and $todayhours->close_time and $tomorrowhours->open_time ) {
3919 if ( $considerlibraryhours eq 'close' ) {
3921 # datedue will be after the library closes on that day
3922 # shorten loan period to end when library closes
3923 $datedue->set( hour => $close[0], minute => $close[1] );
3924 } elsif ( $considerlibraryhours eq 'open' ) {
3926 # datedue will be after the library closes on that day
3927 # extend loan period to when library opens following day
3928 $datedue->add( days => 1 )->set( hour => $open[0], minute => $open[1] );
3931 # ignore library open hours
3932 $datedue->add( hours => $loanlength->{$length_key} );
3936 # due time doesn't conflict with library open hours, don't need to check
3937 $datedue->add( hours => $loanlength->{$length_key} );
3940 $datedue->add( days => $loanlength->{$length_key} );
3941 $datedue->set_hour(23);
3942 $datedue->set_minute(59);
3946 if ($loanlength->{lengthunit} eq 'hours') {
3947 if ( $considerlibraryhours ne 'ignore' and $potential_datedue > $library_close and $todayhours->close_time and $tomorrowhours->open_time ) {
3948 if ( $considerlibraryhours eq 'close' ) {
3950 # datedue will be after the library closes on that day
3951 # shorten loan period to end when library closes by hardcoding due time
3952 $datedue->set( hour => $close[0], minute => $close[1] );
3953 } elsif ( $considerlibraryhours eq 'open' ) {
3955 # datedue will be after the library closes on that day
3956 # extend loan period to when library opens following day by hardcoding due time for next open day
3957 $dur = DateTime::Duration->new( days => 1 );
3958 $datedue->set( hour => $open[0], minute => $open[1] );
3961 # ignore library open hours
3962 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key} );
3966 # due time doesn't conflict with library open hours, don't need to check
3967 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key} );
3971 $dur = DateTime::Duration->new( days => $loanlength->{$length_key} );
3973 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3974 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} ) if $dur;
3975 if ($loanlength->{lengthunit} eq 'days') {
3976 $datedue->set_hour(23);
3977 $datedue->set_minute(59);
3981 # if Hard Due Dates are used, retrieve them and apply as necessary
3982 my ( $hardduedate, $hardduedatecompare ) =
3983 GetHardDueDate( $patron->categorycode, $itemtype, $branch );
3984 if ($hardduedate) { # hardduedates are currently dates
3985 $hardduedate->truncate( to => 'minute' );
3986 $hardduedate->set_hour(23);
3987 $hardduedate->set_minute(59);
3988 my $cmp = DateTime->compare( $hardduedate, $datedue );
3990 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3991 # if the calculated date is before the 'after' Hard Due Date (floor), override
3992 # if the hard due date is set to 'exactly', overrride
3993 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3994 $datedue = $hardduedate->clone;
3997 # in all other cases, keep the date due as it is
4001 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
4002 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
4003 my $expiry_dt = dt_from_string( $patron->dateexpiry, 'iso', 'floating');
4004 if( $expiry_dt ) { #skip empty expiry date..
4005 $expiry_dt->set( hour => 23, minute => 59);
4006 my $d1= $datedue->clone->set_time_zone('floating');
4007 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
4008 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
4011 if ( $daysmode ne 'Days' ) {
4012 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
4013 if ( $calendar->is_holiday($datedue) ) {
4014 # Don't return on a closed day
4015 $datedue = $calendar->prev_open_days( $datedue, 1 );
4024 sub CheckValidBarcode{
4026 my $dbh = C4::Context->dbh;
4027 my $query=qq|SELECT count(*)
4031 my $sth = $dbh->prepare($query);
4032 $sth->execute($barcode);
4033 my $exist=$sth->fetchrow ;
4037 =head2 IsBranchTransferAllowed
4039 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
4041 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
4043 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
4044 Koha::Item->can_be_transferred.
4048 sub IsBranchTransferAllowed {
4049 my ( $toBranch, $fromBranch, $code ) = @_;
4051 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
4053 my $limitType = C4::Context->preference("BranchTransferLimitsType");
4054 my $dbh = C4::Context->dbh;
4056 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
4057 $sth->execute( $toBranch, $fromBranch, $code );
4058 my $limit = $sth->fetchrow_hashref();
4060 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
4061 if ( $limit->{'limitId'} ) {
4068 =head2 CreateBranchTransferLimit
4070 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
4072 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
4074 Deprecated in favor of Koha::Item::Transfer::Limit->new.
4078 sub CreateBranchTransferLimit {
4079 my ( $toBranch, $fromBranch, $code ) = @_;
4080 return unless defined($toBranch) && defined($fromBranch);
4081 my $limitType = C4::Context->preference("BranchTransferLimitsType");
4083 my $dbh = C4::Context->dbh;
4085 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
4086 return $sth->execute( $code, $toBranch, $fromBranch );
4089 =head2 DeleteBranchTransferLimits
4091 my $result = DeleteBranchTransferLimits($frombranch);
4093 Deletes all the library transfer limits for one library. Returns the
4094 number of limits deleted, 0e0 if no limits were deleted, or undef if
4095 no arguments are supplied.
4097 Deprecated in favor of Koha::Item::Transfer::Limits->search({
4098 fromBranch => $fromBranch
4103 sub DeleteBranchTransferLimits {
4105 return unless defined $branch;
4106 my $dbh = C4::Context->dbh;
4107 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
4108 return $sth->execute($branch);
4112 my ( $borrowernumber, $itemnum ) = @_;
4113 MarkIssueReturned( $borrowernumber, $itemnum );
4118 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
4120 The final optional parameter, C<$params>, expected to contain
4121 'skip_record_index' key, which relayed down to Koha::Item/store,
4122 there it prevents calling of ModZebra index_records,
4123 which takes most of the time in batch adds/deletes: index_records better
4124 to be called later in C<additem.pl> after the whole loop.
4127 skip_record_index => 1|0
4132 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
4134 unless ( $mark_lost_from ) {
4135 # Temporary check to avoid regressions
4136 die q|LostItem called without $mark_lost_from, check the API.|;
4140 if ( $force_mark_returned ) {
4143 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
4144 $mark_returned = ( $pref =~ m|$mark_lost_from| );
4147 my $dbh = C4::Context->dbh();
4148 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
4150 JOIN items USING (itemnumber)
4151 JOIN biblio USING (biblionumber)
4152 WHERE issues.itemnumber=?");
4153 $sth->execute($itemnumber);
4154 my $issues=$sth->fetchrow_hashref();
4156 # If a borrower lost the item, add a replacement cost to the their record
4157 if ( my $borrowernumber = $issues->{borrowernumber} ){
4158 my $patron = Koha::Patrons->find( $borrowernumber );
4160 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
4161 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
4163 if (C4::Context->preference('WhenLostChargeReplacementFee')){
4164 C4::Accounts::chargelostitem(
4167 $issues->{'replacementprice'},
4168 sprintf( "%s %s %s",
4169 $issues->{'title'} || q{},
4170 $issues->{'barcode'} || q{},
4171 $issues->{'itemcallnumber'} || q{},
4174 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4175 #warn " $issues->{'borrowernumber'} / $itemnumber ";
4178 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4181 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4182 my $item = Koha::Items->find($itemnumber);
4183 my $transfers = $item->get_transfers;
4184 while (my $transfer = $transfers->next) {
4185 $transfer->cancel({ reason => 'ItemLost', force => 1 });
4189 sub GetOfflineOperations {
4190 my $dbh = C4::Context->dbh;
4191 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4192 $sth->execute(C4::Context->userenv->{'branch'});
4193 my $results = $sth->fetchall_arrayref({});
4197 sub GetOfflineOperation {
4198 my $operationid = shift;
4199 return unless $operationid;
4200 my $dbh = C4::Context->dbh;
4201 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4202 $sth->execute( $operationid );
4203 return $sth->fetchrow_hashref;
4206 sub AddOfflineOperation {
4207 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4208 my $dbh = C4::Context->dbh;
4209 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4210 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4214 sub DeleteOfflineOperation {
4215 my $dbh = C4::Context->dbh;
4216 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4217 $sth->execute( shift );
4221 sub ProcessOfflineOperation {
4222 my $operation = shift;
4225 if ( $operation->{action} eq 'return' ) {
4226 $report = ProcessOfflineReturn( $operation );
4227 } elsif ( $operation->{action} eq 'issue' ) {
4228 $report = ProcessOfflineIssue( $operation );
4229 } elsif ( $operation->{action} eq 'payment' ) {
4230 $report = ProcessOfflinePayment( $operation );
4233 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4238 sub ProcessOfflineReturn {
4239 my $operation = shift;
4241 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4244 my $itemnumber = $item->itemnumber;
4245 my $issue = $item->checkout;
4247 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4248 ModDateLastSeen( $itemnumber, $leave_item_lost );
4250 $issue->borrowernumber,
4252 $operation->{timestamp},
4254 $item->onloan(undef);
4255 $item->store({ log_action => 0 });
4258 return "Item not issued.";
4261 return "Item not found.";
4265 sub ProcessOfflineIssue {
4266 my $operation = shift;
4268 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4269 $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4272 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4274 return "Barcode not found.";
4276 my $itemnumber = $item->itemnumber;
4277 my $issue = $item->checkout;
4279 if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4281 $issue->borrowernumber,
4283 $operation->{timestamp},
4288 $operation->{'barcode'},
4291 $operation->{timestamp},
4296 return "Borrower not found.";
4300 sub ProcessOfflinePayment {
4301 my $operation = shift;
4303 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4304 $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4306 $patron->account->pay(
4308 amount => $operation->{amount},
4309 library_id => $operation->{branchcode},
4319 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4321 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4326 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4330 ? Koha::Items->find($itemnumber)
4331 : Koha::Items->find( { barcode => $barcode } );
4335 return C4::Letters::GetPreparedLetter (
4336 module => 'circulation',
4337 letter_code => 'TRANSFERSLIP',
4338 branchcode => $branch,
4340 'branches' => $to_branch,
4341 'biblio' => $item->biblionumber,
4342 'items' => $item->unblessed,
4347 =head2 CheckIfIssuedToPatron
4349 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4351 Return 1 if any record item is issued to patron, otherwise return 0
4355 sub CheckIfIssuedToPatron {
4356 my ($borrowernumber, $biblionumber) = @_;
4358 my $dbh = C4::Context->dbh;
4360 SELECT COUNT(*) FROM issues
4361 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4362 WHERE items.biblionumber = ?
4363 AND issues.borrowernumber = ?
4365 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4366 return 1 if $is_issued;
4372 IsItemIssued( $itemnumber )
4374 Return 1 if the item is on loan, otherwise return 0
4379 my $itemnumber = shift;
4380 my $dbh = C4::Context->dbh;
4381 my $sth = $dbh->prepare(q{
4384 WHERE itemnumber = ?
4386 $sth->execute($itemnumber);
4387 return $sth->fetchrow;
4390 =head2 GetAgeRestriction
4392 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4393 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4395 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4396 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4398 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4399 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4400 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4401 Negative days mean the borrower has gone past the age restriction age.
4405 sub GetAgeRestriction {
4406 my ($record_restrictions, $borrower) = @_;
4407 my $markers = C4::Context->preference('AgeRestrictionMarker');
4409 return unless $record_restrictions;
4410 # Split $record_restrictions to something like FSK 16 or PEGI 6
4411 my @values = split ' ', uc($record_restrictions);
4412 return unless @values;
4414 # Search first occurrence of one of the markers
4415 my @markers = split /\|/, uc($markers);
4416 return unless @markers;
4419 my $restriction_year = 0;
4420 for my $value (@values) {
4422 for my $marker (@markers) {
4423 $marker =~ s/^\s+//; #remove leading spaces
4424 $marker =~ s/\s+$//; #remove trailing spaces
4425 if ( $marker eq $value ) {
4426 if ( $index <= $#values ) {
4427 $restriction_year += $values[$index];
4431 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4433 # Perhaps it is something like "K16" (as in Finland)
4434 $restriction_year += $1;
4438 last if ( $restriction_year > 0 );
4441 #Check if the borrower is age restricted for this material and for how long.
4442 if ($restriction_year && $borrower) {
4443 if ( $borrower->{'dateofbirth'} ) {
4444 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4445 $alloweddate[0] += $restriction_year;
4447 #Prevent runime eror on leap year (invalid date)
4448 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4449 $alloweddate[2] = 28;
4452 #Get how many days the borrower has to reach the age restriction
4453 my @Today = split /-/, dt_from_string()->ymd();
4454 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4455 #Negative days means the borrower went past the age restriction age
4456 return ($restriction_year, $daysToAgeRestriction);
4460 return ($restriction_year);
4464 =head2 GetPendingOnSiteCheckouts
4468 sub GetPendingOnSiteCheckouts {
4469 my $dbh = C4::Context->dbh;
4470 return $dbh->selectall_arrayref(q|
4476 items.itemcallnumber,
4480 issues.date_due < NOW() AS is_overdue,
4483 borrowers.firstname,
4485 borrowers.cardnumber,
4486 borrowers.borrowernumber
4488 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4489 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4490 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4491 WHERE issues.onsite_checkout = 1
4492 |, { Slice => {} } );
4498 my ($count, $branch, $itemtype, $ccode, $newness)
4499 = @$params{qw(count branch itemtype ccode newness)};
4501 my $dbh = C4::Context->dbh;
4504 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4505 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4506 i.ccode, SUM(i.issues) AS count
4508 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4509 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4512 my (@where_strs, @where_args);
4515 push @where_strs, 'i.homebranch = ?';
4516 push @where_args, $branch;
4519 if (C4::Context->preference('item-level_itypes')){
4520 push @where_strs, 'i.itype = ?';
4521 push @where_args, $itemtype;
4523 push @where_strs, 'bi.itemtype = ?';
4524 push @where_args, $itemtype;
4528 push @where_strs, 'i.ccode = ?';
4529 push @where_args, $ccode;
4532 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4533 push @where_args, $newness;
4537 $query .= 'WHERE ' . join(' AND ', @where_strs);
4541 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4542 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4547 $query .= q{ ) xxx WHERE count > 0 };
4548 $count = int($count);
4550 $query .= "LIMIT $count";
4553 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4558 =head2 Internal methods
4562 sub _CalculateAndUpdateFine {
4565 my $borrower = $params->{borrower};
4566 my $item = $params->{item};
4567 my $issue = $params->{issue};
4568 my $return_date = $params->{return_date};
4570 unless ($borrower) { carp "No borrower passed in!" && return; }
4571 unless ($item) { carp "No item passed in!" && return; }
4572 unless ($issue) { carp "No issue passed in!" && return; }
4574 my $datedue = dt_from_string( $issue->date_due );
4576 # we only need to calculate and change the fines if we want to do that on return
4577 # Should be on for hourly loans
4578 my $control = C4::Context->preference('CircControl');
4579 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4580 my $control_branchcode =
4581 ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4582 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4583 : $issue->branchcode;
4585 my $date_returned = $return_date ? $return_date : dt_from_string();
4587 my ( $amount, $unitcounttotal, $unitcount ) =
4588 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4590 if ( C4::Context->preference('finesMode') eq 'production' ) {
4591 if ( $amount > 0 ) {
4592 C4::Overdues::UpdateFine({
4593 issue_id => $issue->issue_id,
4594 itemnumber => $issue->itemnumber,
4595 borrowernumber => $issue->borrowernumber,
4600 elsif ($return_date) {
4602 # Backdated returns may have fines that shouldn't exist,
4603 # so in this case, we need to drop those fines to 0
4605 C4::Overdues::UpdateFine({
4606 issue_id => $issue->issue_id,
4607 itemnumber => $issue->itemnumber,
4608 borrowernumber => $issue->borrowernumber,
4616 sub _CanBookBeAutoRenewed {
4617 my ( $params ) = @_;
4618 my $patron = $params->{patron};
4619 my $item = $params->{item};
4620 my $branchcode = $params->{branchcode};
4621 my $issue = $params->{issue};
4623 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4625 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4627 categorycode => $patron->categorycode,
4628 itemtype => $item->effective_itemtype,
4629 branchcode => $branchcode,
4631 'no_auto_renewal_after',
4632 'no_auto_renewal_after_hard_limit',
4634 'noautorenewalbefore',
4639 if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4640 return 'auto_account_expired';
4643 if ( defined $issuing_rule->{no_auto_renewal_after}
4644 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4645 # Get issue_date and add no_auto_renewal_after
4646 # If this is greater than today, it's too late for renewal.
4647 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4648 $maximum_renewal_date->add(
4649 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4651 my $now = dt_from_string;
4652 if ( $now >= $maximum_renewal_date ) {
4653 return "auto_too_late";
4656 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4657 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4658 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4659 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4660 return "auto_too_late";
4664 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4665 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4666 my $amountoutstanding =
4667 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4668 ? $patron->account->balance
4669 : $patron->account->outstanding_debits->total_outstanding;
4670 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4671 return "auto_too_much_oweing";
4675 my $soonest = GetSoonestRenewDate( $patron, $issue, 1 );
4676 if ( $soonest > dt_from_string() )
4678 return ( "auto_too_soon", $soonest );
4691 Koha Development Team <http://koha-community.org/>