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::ILL::Requests;
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 C4::Reserves::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 || $parent_maxissueqty_rule ) {
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 || $parent_maxissueqty_rule ) {
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 ) = C4::Reserves::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;
1253 # Booked to another patron
1255 # Booking starts before due date, reduce loan?
1256 if ( $now < $booking_start && $duedate > $booking_start ) {
1257 $needsconfirmation{'BOOKED_TO_ANOTHER'} = $booking;
1260 # Loan falls inside booking
1262 $issuingimpossible{'BOOKED_TO_ANOTHER'} = $booking;
1267 ## CHECK AGE RESTRICTION
1268 my $agerestriction = $biblioitem->agerestriction;
1269 my ( $restriction_age, $daysToAgeRestriction ) =
1270 GetAgeRestriction( $agerestriction, $patron->unblessed );
1271 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1272 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1273 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1276 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1280 ## check for high holds decreasing loan period
1281 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1282 my $check = checkHighHolds( $item_object, $patron );
1284 if ( $check->{exceeded} ) {
1286 num_holds => $check->{outstanding},
1287 duration => $check->{duration},
1288 returndate => $check->{due_date},
1290 if ($override_high_holds) {
1291 $alerts{HIGHHOLDS} = $highholds;
1294 $needsconfirmation{HIGHHOLDS} = $highholds;
1300 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1301 # don't do the multiple loans per bib check if we've
1302 # already determined that we've got a loan on the same item
1303 !$issuingimpossible{NO_MORE_RENEWALS} &&
1304 !$needsconfirmation{RENEW_ISSUE}
1306 # Check if borrower has already issued an item from the same biblio
1307 # Only if it's not a subscription
1308 my $biblionumber = $item_object->biblionumber;
1309 require C4::Serials;
1310 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1311 unless ($is_a_subscription) {
1312 # FIXME Should be $patron->checkouts($args);
1313 my $checkouts = Koha::Checkouts->search(
1315 borrowernumber => $patron->borrowernumber,
1316 biblionumber => $biblionumber,
1322 # if we get here, we don't already have a loan on this item,
1323 # so if there are any loans on this bib, ask for confirmation
1324 if ( $checkouts->count ) {
1325 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1330 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1333 =head2 CanBookBeReturned
1335 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1337 Check whether the item can be returned to the provided branch
1341 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1343 =item C<$branch> is the branchcode where the return is taking place
1351 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1353 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1359 sub CanBookBeReturned {
1360 my ($item, $branch) = @_;
1361 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1363 # assume return is allowed to start
1367 # identify all cases where return is forbidden
1368 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1370 $message = $item->{'homebranch'};
1371 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1373 $message = $item->{'holdingbranch'};
1374 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1376 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1379 return ($allowed, $message);
1382 =head2 CheckHighHolds
1384 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1385 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1386 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1390 sub checkHighHolds {
1391 my ( $item, $patron ) = @_;
1392 my $branchcode = _GetCircControlBranch( $item, $patron );
1402 # Count holds on this record, ignoring the borrowers own holds as they would be filled by the checkout
1403 my $holds = Koha::Holds->search({
1404 biblionumber => $item->biblionumber,
1405 borrowernumber => { '!=' => $patron->borrowernumber }
1408 if ( $holds->count() ) {
1409 $return_data->{outstanding} = $holds->count();
1411 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1412 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1413 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1415 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1417 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1419 # static means just more than a given number of holds on the record
1421 # If the number of holds is not above the threshold, we can stop here
1422 if ( $holds->count() <= $decreaseLoanHighHoldsValue ) {
1423 return $return_data;
1426 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1428 # dynamic means X more than the number of holdable items on the record
1430 # let's get the items
1431 my @items = $holds->next()->biblio()->items()->as_list;
1433 # Remove any items with status defined to be ignored even if the would not make item unholdable
1434 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1435 @items = grep { !$_->$status } @items;
1438 # Remove any items that are not holdable for this patron
1439 # We need to ignore hold counts as the borrower's own hold that will be filled by the checkout
1440 # could prevent them from placing further holds
1441 @items = grep { C4::Reserves::CanItemBeReserved( $patron, $_, undef, { ignore_hold_counts => 1 } )->{status} eq 'OK' } @items;
1443 my $items_count = scalar @items;
1445 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1447 # If the number of holds is less than the count of items we have
1448 # plus the number of holds allowed above that count, we can stop here
1449 if ( $holds->count() <= $threshold ) {
1450 return $return_data;
1454 my $issuedate = dt_from_string();
1456 my $itype = $item->effective_itemtype;
1457 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1459 categorycode => $patron->categorycode,
1461 branchcode => $branchcode,
1464 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1466 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1468 my $rule = Koha::CirculationRules->get_effective_rule_value(
1470 categorycode => $patron->categorycode,
1471 itemtype => $item->effective_itemtype,
1472 branchcode => $branchcode,
1473 rule_name => 'decreaseloanholds',
1478 if ( defined($rule) && $rule ne '' ){
1479 # overrides decreaseLoanHighHoldsDuration syspref
1482 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1484 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1485 $reduced_datedue->set_hour($orig_due->hour);
1486 $reduced_datedue->set_minute($orig_due->minute);
1487 $reduced_datedue->truncate( to => 'minute' );
1489 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1490 $return_data->{exceeded} = 1;
1491 $return_data->{duration} = $duration;
1492 $return_data->{due_date} = $reduced_datedue;
1496 return $return_data;
1501 &AddIssue($patron, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1503 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1507 =item C<$patron> is a patron object.
1509 =item C<$barcode> is the barcode of the item being issued.
1511 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1512 Calculated if empty.
1514 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1516 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1519 AddIssue does the following things :
1521 - step 01: check that there is a borrowernumber & a barcode provided
1522 - check for RENEWAL (book issued & being issued to the same patron)
1523 - renewal YES = Calculate Charge & renew
1525 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1527 - fill reserve if reserve to this patron
1528 - cancel reserve or not, otherwise
1530 - fill recall if recall to this patron
1531 - cancel recall or not
1532 - revert recall's waiting status or not
1533 * TRANSFERT PENDING ?
1534 - complete the transfert
1542 my ( $patron, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1544 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1545 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1546 my $auto_renew = $params && $params->{auto_renew};
1547 my $cancel_recall = $params && $params->{cancel_recall};
1548 my $recall_id = $params && $params->{recall_id};
1549 my $dbh = C4::Context->dbh;
1550 my $barcodecheck = CheckValidBarcode($barcode);
1554 if ( $datedue && ref $datedue ne 'DateTime' ) {
1555 $datedue = dt_from_string($datedue);
1558 # $issuedate defaults to today.
1559 if ( !defined $issuedate ) {
1560 $issuedate = dt_from_string();
1563 if ( ref $issuedate ne 'DateTime' ) {
1564 $issuedate = dt_from_string($issuedate);
1569 # Stop here if the patron or barcode doesn't exist
1570 if ( $patron && $barcode && $barcodecheck ) {
1571 # find which item we issue
1572 my $item_object = Koha::Items->find({ barcode => $barcode })
1573 or return; # if we don't get an Item, abort.
1574 my $item_unblessed = $item_object->unblessed;
1576 my $branchcode = _GetCircControlBranch( $item_object, $patron );
1578 # get actual issuing if there is one
1579 my $actualissue = $item_object->checkout;
1581 # check if we just renew the issue.
1582 if ( $actualissue and $actualissue->borrowernumber eq $patron->borrowernumber
1583 and not $switch_onsite_checkout ) {
1584 $datedue = AddRenewal(
1586 borrowernumber => $patron->borrowernumber,
1587 itemnumber => $item_object->itemnumber,
1588 branch => $branchcode,
1589 datedue => $datedue,
1591 $issuedate, # here interpreted as the renewal date
1594 $issue = $item_object->checkout;
1599 my $itype = $item_object->effective_itemtype;
1600 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1604 # Check if we need to use an exact due date set by the ILL module
1605 if ( C4::Context->preference('ILLModule') ) {
1606 # Check if there is an ILL connected with the biblio of the item we are issuing
1607 my $ill_request = Koha::ILL::Requests->search({
1608 biblio_id => $item_object->biblionumber,
1609 borrowernumber => $patron->borrowernumber,
1611 due_date => { '!=', undef },
1614 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1615 my $ill_dt = dt_from_string( $ill_request->due_date );
1616 $ill_dt->set_hour(23);
1617 $ill_dt->set_minute(59);
1622 $datedue->truncate( to => 'minute' );
1624 my $library = Koha::Libraries->find( $branchcode );
1625 my $fees = Koha::Charges::Fees->new(
1628 library => $library,
1629 item => $item_object,
1630 to_date => $datedue,
1634 # it's NOT a renewal
1635 if ( $actualissue and not $switch_onsite_checkout ) {
1636 # This book is currently on loan, but not to the person
1637 # who wants to borrow it now. mark it returned before issuing to the new borrower
1638 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1639 return unless $allowed;
1640 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1641 # AddReturn certainly has side-effects, like onloan => undef
1642 $item_object->discard_changes;
1645 if ( C4::Context->preference('UseRecalls') ) {
1646 Koha::Recalls->move_recall(
1648 action => $cancel_recall,
1649 recall_id => $recall_id,
1650 item => $item_object,
1651 borrowernumber => $patron->borrowernumber,
1656 C4::Reserves::MoveReserve( $item_object->itemnumber, $patron->borrowernumber, $cancelreserve );
1658 # Starting process for transfer job (checking transfert and validate it if we have one)
1659 if ( my $transfer = $item_object->get_transfer ) {
1660 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1663 datearrived => dt_from_string,
1664 tobranch => C4::Context->userenv->{branch},
1665 comments => 'Forced branchtransfer'
1668 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1669 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1670 if ( $hold ) { # Is this really needed?
1671 $hold->set( { found => undef } )->store;
1672 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1677 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1678 unless ($auto_renew) {
1679 my $rule = Koha::CirculationRules->get_effective_rule_value(
1681 categorycode => $patron->categorycode,
1682 itemtype => $item_object->effective_itemtype,
1683 branchcode => $branchcode,
1684 rule_name => 'auto_renew'
1688 $auto_renew = $rule if defined $rule && $rule ne '';
1691 my $issue_attributes = {
1692 borrowernumber => $patron->borrowernumber,
1693 issuedate => $issuedate,
1694 date_due => $datedue,
1695 branchcode => C4::Context->userenv->{'branch'},
1696 onsite_checkout => $onsite_checkout,
1697 auto_renew => $auto_renew ? 1 : 0,
1700 # Get ID of logged in user. if called from a batch job,
1701 # no user session exists and C4::Context->userenv() returns
1702 # the scalar '0'. Only do this if the syspref says so
1703 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1704 my $userenv = C4::Context->userenv();
1705 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1707 $issue_attributes->{issuer_id} = $usernumber;
1711 # In the case that the borrower has an on-site checkout
1712 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1713 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1715 $issue->set($issue_attributes)->store;
1718 $issue = Koha::Checkout->new(
1720 itemnumber => $item_object->itemnumber,
1725 # Ensure item is no longer listed in the holds queue
1727 q{DELETE tmp_holdsqueue, hold_fill_targets FROM tmp_holdsqueue LEFT JOIN hold_fill_targets USING ( itemnumber ) WHERE itemnumber = ?},
1728 undef, $item_object->id
1731 $issue->discard_changes;
1732 $patron->update_lastseen('check_out');
1733 if ( $item_object->location && $item_object->location eq 'CART'
1734 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1735 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1736 CartToShelf( $item_object->itemnumber );
1739 # Update item location
1740 $item_object->location_update_trigger( 'checkout' );
1742 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1743 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1746 # Record if item was lost
1747 my $was_lost = $item_object->itemlost;
1749 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1750 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1751 $item_object->itemlost(0);
1752 $item_object->onloan($datedue->ymd());
1753 $item_object->datelastborrowed( dt_from_string()->ymd() );
1754 $item_object->datelastseen( dt_from_string() );
1755 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1757 # If the item was lost, it has now been found, charge the overdue if necessary
1759 if ( $item_object->{_charge} ) {
1760 $actualissue //= Koha::Old::Checkouts->search(
1761 { itemnumber => $item_object->itemnumber },
1763 order_by => { '-desc' => 'returndate' },
1767 unless ( $patron->branchcode ) {
1768 $patron = $actualissue->patron;
1770 _CalculateAndUpdateFine(
1772 issue => $actualissue,
1773 item => $item_unblessed,
1774 borrower => $patron->unblessed,
1775 return_date => $issuedate
1778 _FixOverduesOnReturn( $patron->borrowernumber,
1779 $item_object->itemnumber, undef, 'RENEWED' );
1783 # If it costs to borrow this book, charge it to the patron's account.
1784 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1785 if ( $charge && $charge > 0 ) {
1786 AddIssuingCharge( $issue, $charge, 'RENT' );
1789 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1790 if ( $itemtype_object ) {
1791 my $accumulate_charge = $fees->accumulate_rentalcharge();
1792 if ( $accumulate_charge > 0 ) {
1793 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1794 $charge += $accumulate_charge;
1795 $item_unblessed->{charge} = $charge;
1799 my $rules = C4::Context->yaml_preference('UpdateNotForLoanStatusOnCheckout');
1801 foreach my $key ( keys %$rules ) {
1802 if ( $item_object->notforloan eq $key ) {
1803 $item_object->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
1809 # Record the fact that this book was issued.
1810 C4::Stats::UpdateStats(
1812 branch => C4::Context->userenv->{'branch'},
1813 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1815 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1816 itemnumber => $item_object->itemnumber,
1817 itemtype => $item_object->effective_itemtype,
1818 location => $item_object->location,
1819 borrowernumber => $patron->borrowernumber,
1820 ccode => $item_object->ccode,
1821 categorycode => $patron->categorycode
1825 # Send a checkout slip.
1826 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1828 branchcode => $branchcode,
1829 categorycode => $patron->categorycode,
1830 item_type => $item_object->effective_itemtype,
1831 notification => 'CHECKOUT',
1833 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1834 SendCirculationAlert(
1837 item => $item_object->unblessed,
1838 borrower => $patron->unblessed,
1839 branch => $branchcode,
1844 "CIRCULATION", "ISSUE",
1845 $patron->borrowernumber,
1846 $item_object->itemnumber,
1847 ) if C4::Context->preference("IssueLog");
1849 Koha::Plugins->call('after_circ_action', {
1850 action => 'checkout',
1852 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1853 checkout => $issue->get_from_storage
1857 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1859 biblio_ids => [ $item_object->biblionumber ]
1861 ) if C4::Context->preference('RealTimeHoldsQueue');
1867 =head2 GetLoanLength
1869 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1871 Get loan length for an itemtype, a borrower type and a branch
1876 my ( $categorycode, $itemtype, $branchcode ) = @_;
1878 # Initialize default values
1882 lengthunit => 'days',
1885 my $found = Koha::CirculationRules->get_effective_rules( {
1886 branchcode => $branchcode,
1887 categorycode => $categorycode,
1888 itemtype => $itemtype,
1897 foreach my $rule_name (keys %$found) {
1898 $rules->{$rule_name} = $found->{$rule_name};
1905 =head2 GetHardDueDate
1907 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1909 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1913 sub GetHardDueDate {
1914 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1916 my $rules = Koha::CirculationRules->get_effective_rules(
1918 categorycode => $borrowertype,
1919 itemtype => $itemtype,
1920 branchcode => $branchcode,
1921 rules => [ 'hardduedate', 'hardduedatecompare' ],
1925 if ( defined( $rules->{hardduedate} ) ) {
1926 if ( $rules->{hardduedate} ) {
1927 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1930 return ( undef, undef );
1935 =head2 GetBranchBorrowerCircRule
1937 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1939 Retrieves circulation rule attributes that apply to the given
1940 branch and patron category, regardless of item type.
1941 The return value is a hashref containing the following key:
1943 patron_maxissueqty - maximum number of loans that a
1944 patron of the given category can have at the given
1945 branch. If the value is undef, no limit.
1947 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1948 patron of the given category can have at the given
1949 branch. If the value is undef, no limit.
1951 This will check for different branch/category combinations in the following order:
1955 default branch and category
1957 If no rule has been found in the database, it will default to
1960 patron_maxissueqty - undef
1961 patron_maxonsiteissueqty - undef
1963 C<$branchcode> and C<$categorycode> should contain the
1964 literal branch code and patron category code, respectively - no
1969 sub GetBranchBorrowerCircRule {
1970 my ( $branchcode, $categorycode ) = @_;
1972 # Initialize default values
1974 patron_maxissueqty => undef,
1975 patron_maxonsiteissueqty => undef,
1979 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1980 my $rule = Koha::CirculationRules->get_effective_rule(
1982 categorycode => $categorycode,
1984 branchcode => $branchcode,
1985 rule_name => $rule_name,
1989 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1995 =head2 GetBranchItemRule
1997 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1999 Retrieves circulation rule attributes that apply to the given
2000 branch and item type, regardless of patron category.
2002 The return value is a hashref containing the following keys:
2004 holdallowed => Hold policy for this branch and itemtype. Possible values:
2005 not_allowed: No holds allowed.
2006 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
2007 from_any_library: Holds allowed from any patron.
2008 from_local_hold_group: Holds allowed from libraries in hold group
2010 This searches branchitemrules in the following order:
2012 * Same branchcode and itemtype
2013 * Same branchcode, itemtype '*'
2014 * branchcode '*', same itemtype
2015 * branchcode and itemtype '*'
2017 Neither C<$branchcode> nor C<$itemtype> should be '*'.
2021 sub GetBranchItemRule {
2022 my ( $branchcode, $itemtype ) = @_;
2025 my $rules = Koha::CirculationRules->get_effective_rules({
2026 branchcode => $branchcode,
2027 itemtype => $itemtype,
2028 rules => ['holdallowed', 'hold_fulfillment_policy']
2031 # built-in default circulation rule
2032 $rules->{holdallowed} //= 'from_any_library';
2033 $rules->{hold_fulfillment_policy} //= 'any';
2040 ($doreturn, $messages, $iteminformation, $borrower) =
2041 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] [,$skip_localuse ] );
2047 =item C<$barcode> is the bar code of the book being returned.
2049 =item C<$branch> is the code of the branch where the book is being returned.
2051 =item C<$exemptfine> indicates that overdue charges for the item will be
2054 =item C<$return_date> allows the default return date to be overridden
2055 by the given return date. Optional.
2057 =item C<$skip_localuse> indicated that localuse should not be recorded. Optional.
2061 C<&AddReturn> returns a list of four items:
2063 C<$doreturn> is true iff the return succeeded.
2065 C<$messages> is a reference-to-hash giving feedback on the operation.
2066 The keys of the hash are:
2072 No item with this barcode exists. The value is C<$barcode>.
2076 The book is not currently on loan. The value is C<$barcode>.
2080 This book has been withdrawn/cancelled. The value should be ignored.
2082 =item C<Wrongbranch>
2084 This book has was returned to the wrong branch. The value is a hashref
2085 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2086 contain the branchcode of the incorrect and correct return library, respectively.
2090 The item was reserved. The value is a reference-to-hash whose keys are
2091 fields from the reserves table of the Koha database, and
2092 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2093 either C<Waiting>, C<Reserved>, or 0.
2095 =item C<WasReturned>
2097 Value 1 if return is successful.
2099 =item C<NeedsTransfer>
2101 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2103 =item C<RecallFound>
2105 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2106 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2109 =item C<TransferredRecall>
2111 This item has been transferred to this branch to fill a recall. The recall object is returned.
2115 C<$iteminformation> is a reference-to-hash, giving information about the
2116 returned item from the issues table.
2118 C<$borrower> is a reference-to-hash, giving information about the
2119 patron who last borrowed the book.
2124 my ( $barcode, $branch, $exemptfine, $return_date, $skip_localuse ) = @_;
2126 if ($branch and not Koha::Libraries->find($branch)) {
2127 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2130 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2131 my $return_date_specified = !!$return_date;
2132 $return_date //= dt_from_string();
2136 my $validTransfer = 1;
2137 my $stat_type = 'return';
2139 # get information on item
2140 my $item = Koha::Items->find({ barcode => $barcode });
2142 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2145 my $itemnumber = $item->itemnumber;
2146 my $itemtype = $item->effective_itemtype;
2147 my $localuse_count = $item->localuse || 0;
2149 my $issue = $item->checkout;
2151 $patron = $issue->patron
2152 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2153 . Dumper($issue->unblessed) . "\n";
2155 $messages->{'NotIssued'} = $barcode;
2156 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2158 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2160 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2161 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2162 if ( C4::Context->preference("RecordLocalUseOnReturn") ) {
2164 $item->localuse($localuse_count)->store;
2165 $messages->{'LocalUse'} = 1;
2166 $stat_type = 'localuse';
2170 if ( $item->withdrawn ) { # book has been cancelled
2171 $messages->{'withdrawn'} = 1;
2173 # In the case where we block return of withdrawn, we should completely block the return
2174 # without updating item statuses, so we exit early
2175 return ( 0, $messages, $issue, ( $patron ? $patron->unblessed : {} ))
2176 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2180 # full item data, but no borrowernumber or checkout info (no issue)
2181 my $hbr = Koha::CirculationRules->get_return_branch_policy($item);
2183 # check if returnbranch and homebranch belong to the same float group
2184 my $validate_float =
2185 Koha::Libraries->find( $item->homebranch )->validate_float_sibling( { branchcode => $branch } );
2187 # get the proper branch to which to return the item
2189 if ( $hbr eq 'noreturn' ) {
2190 $returnbranch = $branch;
2191 } elsif ( $hbr eq 'returnbylibrarygroup' ) {
2193 # if library isn't in same the float group, transfer item to homebranch
2194 $hbr = 'homebranch';
2195 $returnbranch = $validate_float ? $branch : $item->$hbr;
2197 $returnbranch = $item->$hbr;
2200 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2201 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2203 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2204 my $patron_unblessed = $patron ? $patron->unblessed : {};
2206 # Update item location
2207 my $loc_messages = $item->location_update_trigger( 'checkin' );
2208 foreach my $loc_msg_key ( keys %$loc_messages ) {
2209 $messages->{ $loc_msg_key } = $loc_messages->{ $loc_msg_key };
2212 my $rules = C4::Context->yaml_preference('UpdateNotForLoanStatusOnCheckin');
2214 if ( defined $rules->{ $item->itype } ) {
2215 foreach my $notloan_rule_key ( keys %{ $rules->{ $item->itype } } ) {
2216 if ( $item->notforloan eq $notloan_rule_key ) {
2217 $messages->{'NotForLoanStatusUpdated'} =
2218 { from => $item->notforloan, to => $rules->{ $item->itype }->{$notloan_rule_key} };
2219 $item->notforloan( $rules->{ $item->itype }->{$notloan_rule_key} )
2220 ->store( { log_action => 0, skip_record_index => 1, skip_holds_queue => 1 } )
2221 unless $rules->{ $item->itype }->{$notloan_rule_key} eq 'ONLYMESSAGE';
2225 } elsif ( defined $rules->{'_ALL_'} ) {
2226 foreach my $notloan_rule_key ( keys %{ $rules->{'_ALL_'} } ) {
2227 if ( $item->notforloan eq $notloan_rule_key ) {
2228 $messages->{'NotForLoanStatusUpdated'} =
2229 { from => $item->notforloan, to => $rules->{'_ALL_'}->{$notloan_rule_key} };
2230 $item->notforloan( $rules->{'_ALL_'}->{$notloan_rule_key} )
2231 ->store( { log_action => 0, skip_record_index => 1, skip_holds_queue => 1 } )
2232 unless $rules->{'_ALL_'}->{$notloan_rule_key} eq 'ONLYMESSAGE';
2239 # check if the return is allowed at this branch
2240 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2241 unless ($returnallowed){
2242 $messages->{'Wrongbranch'} = {
2243 Wrongbranch => $branch,
2244 Rightbranch => $message
2247 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2248 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2249 return ( $doreturn, $messages, $issue, $patron_unblessed);
2252 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2256 # case of a return of document (deal with issues and holdingbranch)
2258 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2259 $patron or warn "AddReturn without current borrower";
2263 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2268 C4::Context->preference('CalculateFinesOnReturn')
2269 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2274 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2277 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 );
2279 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2280 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2282 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2285 # FIXME is the "= 1" right? This could be the borrower hash.
2286 $messages->{'WasReturned'} = 1;
2289 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2293 # the holdingbranch is updated if the document is returned to another location.
2294 # this is always done regardless of whether the item was on loan or not
2295 if ($item->holdingbranch ne $branch) {
2296 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2299 my $item_was_lost = $item->itemlost;
2300 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2301 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2303 # fix up the accounts.....
2304 if ($item_was_lost) {
2305 $messages->{'WasLost'} = 1;
2306 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2307 my @object_messages = @{ $updated_item->object_messages };
2308 for my $message (@object_messages) {
2309 $messages->{'LostItemFeeRefunded'} = 1
2310 if $message->message eq 'lost_refunded';
2311 $messages->{'ProcessingFeeRefunded'} = 1
2312 if $message->message eq 'processing_refunded';
2313 $messages->{'LostItemFeeRestored'} = 1
2314 if $message->message eq 'lost_restored';
2316 if ( $message->message eq 'lost_charge' ) {
2317 $issue //= Koha::Old::Checkouts->search(
2318 { itemnumber => $item->itemnumber },
2319 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2321 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2322 my $patron = $issue->patron;
2323 $patron_unblessed = $patron->unblessed;
2325 _CalculateAndUpdateFine(
2328 item => $item->unblessed,
2329 borrower => $patron_unblessed,
2330 return_date => $return_date
2333 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2334 $item->itemnumber, undef, 'RETURNED' );
2335 $messages->{'LostItemFeeCharged'} = 1;
2341 # check if we have a transfer for this document
2342 my $transfer = $item->get_transfer;
2344 # if we have a transfer to complete, we update the line of transfers with the datearrived
2347 if ( $transfer->in_transit ) {
2348 if ( $transfer->tobranch eq $branch ) {
2350 $messages->{'TransferArrived'} = $transfer->frombranch;
2351 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2353 if defined $transfer->reason && $transfer->reason eq 'Reserve';
2356 $messages->{'WrongTransfer'} = $transfer->tobranch;
2357 $messages->{'WrongTransferItem'} = $item->itemnumber;
2358 $messages->{'TransferTrigger'} = $transfer->reason;
2362 if ( $transfer->tobranch eq $branch ) {
2364 $messages->{'TransferArrived'} = $transfer->frombranch;
2365 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2366 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2369 $messages->{'TransferTrigger'} = $transfer->reason;
2370 if ( $transfer->frombranch eq $branch ) {
2372 $messages->{'WasTransfered'} = $transfer->tobranch;
2375 $messages->{'WrongTransfer'} = $transfer->tobranch;
2376 $messages->{'WrongTransferItem'} = $item->itemnumber;
2382 # fix up the overdues in accounts...
2383 if ($borrowernumber) {
2384 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2385 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2387 if ( $issue and $issue->is_overdue($return_date) ) {
2389 my ($debardate,$reminder) = _debar_user_on_return( $patron, $item, dt_from_string($issue->date_due), $return_date );
2390 if ($debardate and $debardate ne "9999-12-31") {
2392 $messages->{'PrevDebarred'} = $debardate;
2394 $messages->{'Debarred'} = $debardate;
2396 } elsif ($patron->debarred) {
2397 if ( $patron->debarred eq "9999-12-31") {
2398 $messages->{'ForeverDebarred'} = $patron->debarred;
2400 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2401 $borrower_debar_dt->truncate(to => 'day');
2402 my $today_dt = $return_date->clone()->truncate(to => 'day');
2403 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2404 $messages->{'PrevDebarred'} = $patron->debarred;
2408 # there's no overdue on the item but borrower had been previously debarred
2409 } elsif ( $issue->date_due and $patron->debarred ) {
2410 if ( $patron->debarred eq "9999-12-31") {
2411 $messages->{'ForeverDebarred'} = $patron->debarred;
2413 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2414 $borrower_debar_dt->truncate(to => 'day');
2415 my $today_dt = $return_date->clone()->truncate(to => 'day');
2416 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2417 $messages->{'PrevDebarred'} = $patron->debarred;
2424 if ( C4::Context->preference('UseRecalls') ) {
2425 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2427 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2428 if ( defined $recall ) {
2429 $messages->{RecallFound} = $recall;
2430 if ( $recall->pickup_library_id ne $branch ) {
2431 $messages->{RecallNeedsTransfer} = $branch;
2436 # find reserves.....
2437 # launch the Checkreserves routine to find any holds
2438 my ($resfound, $resrec);
2439 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2440 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item, $lookahead ) unless ( $item->withdrawn );
2441 # 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)
2442 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2443 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2444 $resfound = 'Reserved';
2445 $resrec = $hold->unblessed;
2448 $resrec->{'ResFound'} = $resfound;
2449 $messages->{'ResFound'} = $resrec;
2452 # Record the fact that this book was returned.
2453 my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2454 C4::Stats::UpdateStats({
2457 itemnumber => $itemnumber,
2458 itemtype => $itemtype,
2459 location => $item->location,
2460 borrowernumber => $borrowernumber,
2461 ccode => $item->ccode,
2462 categorycode => $categorycode,
2463 interface => C4::Context->interface,
2464 }) unless ( $skip_localuse && $stat_type eq 'localuse' );
2466 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2468 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2470 branchcode => $branch,
2471 categorycode => $patron->categorycode,
2472 item_type => $itemtype,
2473 notification => 'CHECKIN',
2475 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2476 SendCirculationAlert({
2478 item => $item->unblessed,
2479 borrower => $patron->unblessed,
2485 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2486 if C4::Context->preference("ReturnLog");
2488 #Update borrowers.lastseen
2489 $patron->update_lastseen('check_in');
2492 # Check if this item belongs to a biblio record that is attached to an
2493 # ILL request, if it is we need to update the ILL request's status
2494 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2495 my $request = Koha::ILL::Requests->find(
2496 { biblio_id => $item->biblio->biblionumber }
2498 $request->status('RET') if $request;
2501 if ( C4::Context->preference('UseRecalls') ) {
2502 # all recalls that have triggered a transfer will have an allocated itemnumber
2503 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2504 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2505 $messages->{TransferredRecall} = $transfer_recall;
2509 if ( $messages->{WasLost} and C4::Context->preference('BlockReturnOfLostItems') ) {
2513 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2514 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2515 && ( $doreturn or $messages->{'NotIssued'} )
2517 and ( $branch ne $returnbranch )
2518 and not $messages->{'WrongTransfer'}
2519 and not $messages->{'WasTransfered'}
2520 and not $messages->{TransferredRecall}
2521 and not $messages->{RecallNeedsTransfer} )
2523 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2524 if (C4::Context->preference("AutomaticItemReturn" ) or
2525 (C4::Context->preference("UseBranchTransferLimits") and
2526 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2528 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2529 $messages->{'WasTransfered'} = $returnbranch;
2530 $messages->{'TransferTrigger'} = $transfer_trigger;
2532 $messages->{'NeedsTransfer'} = $returnbranch;
2533 $messages->{'TransferTrigger'} = $transfer_trigger;
2537 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2539 my $claim = Koha::Checkouts::ReturnClaims->find(
2541 itemnumber => $item->id,
2542 resolution => undef,
2546 my $autoClaimReturnCheckin = C4::Context->preference('AutoClaimReturnStatusOnCheckin');
2547 if ($autoClaimReturnCheckin) {
2549 my $patron_id = C4::Context->userenv ? C4::Context->userenv->{'number'} : undef;
2550 my $resolution = $autoClaimReturnCheckin;
2554 resolution => $resolution,
2555 resolved_by => $patron_id,
2558 $messages->{ClaimAutoResolved} = $claim;
2560 $messages->{ReturnClaims} = $claim;
2565 # Check for bundle status
2566 if ( $item->in_bundle ) {
2567 my $host = $item->bundle_host;
2568 $messages->{InBundle} = $host;
2571 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2572 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2574 if ( $doreturn and $issue ) {
2575 my $checkin = Koha::Old::Checkouts->find($issue->id);
2577 Koha::Plugins->call('after_circ_action', {
2578 action => 'checkin',
2584 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2586 biblio_ids => [ $item->biblionumber ]
2588 ) if C4::Context->preference('RealTimeHoldsQueue');
2591 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2594 =head2 MarkIssueReturned
2596 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2598 Unconditionally marks an issue as being returned by
2599 moving the C<issues> row to C<old_issues> and
2600 setting C<returndate> to the current date.
2602 if C<$returndate> is specified (in iso format), it is used as the date
2605 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2606 the old_issue is immediately anonymised
2608 Ideally, this function would be internal to C<C4::Circulation>,
2609 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2610 and offline_circ/process_koc.pl.
2612 The last optional parameter allos passing skip_record_index to the item store call.
2616 sub MarkIssueReturned {
2617 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2619 # Retrieve the issue
2620 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2621 my $issue_branchcode = $issue->branchcode;
2623 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2625 my $issue_id = $issue->issue_id;
2627 my $schema = Koha::Database->schema;
2629 # FIXME Improve the return value and handle it from callers
2630 $schema->txn_do(sub {
2632 my $patron = Koha::Patrons->find( $borrowernumber );
2634 # Update the returndate value
2635 if ( $returndate ) {
2636 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2639 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2642 # Create the old_issues entry
2643 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2645 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2646 if ( $privacy && $privacy == 2) {
2647 $old_checkout->anonymize;
2650 # And finally delete the issue
2653 $issue->item->onloan(undef)->store(
2655 skip_record_index => $params->{skip_record_index},
2656 skip_holds_queue => $params->{skip_holds_queue}
2660 if ( C4::Context->preference('StoreLastBorrower') ) {
2661 my $item = Koha::Items->find( $itemnumber );
2662 $item->last_returned_by( $patron->borrowernumber )->store;
2665 # Possibly remove any OVERDUES related debarment
2666 my $overdue_restrictions = $patron->restrictions->search( { type => 'OVERDUES' } );
2667 if ( C4::Context->preference('AutoRemoveOverduesRestrictions') ne 'no' && $patron->is_debarred ) {
2668 my $remove_restrictions =
2669 C4::Context->preference('AutoRemoveOverduesRestrictions') eq 'when_no_overdue_causing_debarment'
2670 ? !$patron->has_restricting_overdues( { issue_branchcode => $issue_branchcode } )
2671 : !$patron->has_overdues;
2672 if ( $remove_restrictions && $overdue_restrictions->count ) {
2673 DelUniqueDebarment( { borrowernumber => $borrowernumber, type => 'OVERDUES' } );
2682 =head2 _debar_user_on_return
2684 _debar_user_on_return($patron, $item, $datedue, $returndate);
2686 C<$patron> patron object
2688 C<$item> item object
2690 C<$datedue> date due DateTime object
2692 C<$returndate> DateTime object representing the return time
2694 Internal function, called only by AddReturn that calculates and updates
2695 the user fine days, and debars them if necessary.
2697 Should only be called for overdue returns
2699 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2704 sub _calculate_new_debar_dt {
2705 my ( $patron, $item, $dt_due, $return_date ) = @_;
2707 my $branchcode = _GetCircControlBranch( $item, $patron );
2708 my $circcontrol = C4::Context->preference('CircControl');
2709 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2710 { categorycode => $patron->categorycode,
2711 itemtype => $item->effective_itemtype,
2712 branchcode => $branchcode,
2717 'maxsuspensiondays',
2718 'suspension_chargeperiod',
2722 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2723 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2724 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2726 return unless $finedays;
2728 # finedays is in days, so hourly loans must multiply by 24
2729 # thus 1 hour late equals 1 day suspension * finedays rate
2730 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2732 # grace period is measured in the same units as the loan
2734 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2736 my $deltadays = DateTime::Duration->new(
2737 days => $chargeable_units
2740 if ( $deltadays->subtract($grace)->is_positive() ) {
2741 my $suspension_days = $deltadays * $finedays;
2743 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2744 # No need to / 1 and do not consider / 0
2745 $suspension_days = DateTime::Duration->new(
2746 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2750 # If the max suspension days is < than the suspension days
2751 # the suspension days is limited to this maximum period.
2752 my $max_sd = $issuing_rule->{maxsuspensiondays};
2753 if ( defined $max_sd && $max_sd ne '' ) {
2754 $max_sd = DateTime::Duration->new( days => $max_sd );
2755 $suspension_days = $max_sd
2756 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2759 my ( $has_been_extended );
2760 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $patron->is_debarred ) {
2761 my $debarment = $patron->restrictions->search({type => 'SUSPENSION' },{rows => 1})->single;
2763 $return_date = dt_from_string( $debarment->expiration, 'sql' );
2764 $has_been_extended = 1;
2769 # Use the calendar or not to calculate the debarment date
2770 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2771 my $calendar = Koha::Calendar->new(
2772 branchcode => $branchcode,
2773 days_mode => 'Calendar'
2775 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2778 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2780 return $new_debar_dt;
2785 sub _debar_user_on_return {
2786 my ( $patron, $item, $dt_due, $return_date ) = @_;
2788 $return_date //= dt_from_string();
2790 my $new_debar_dt = _calculate_new_debar_dt($patron, $item, $dt_due, $return_date);
2792 return unless $new_debar_dt;
2794 Koha::Patron::Debarments::AddUniqueDebarment({
2795 borrowernumber => $patron->borrowernumber,
2796 expiration => $new_debar_dt->ymd(),
2797 type => 'SUSPENSION',
2799 # if borrower was already debarred but does not get an extra debarment
2800 my ($new_debarment_str, $is_a_reminder);
2801 if ( $patron->is_debarred ) {
2803 $new_debarment_str = $patron->debarred;
2805 $new_debarment_str = $new_debar_dt->ymd();
2807 # FIXME Should return a DateTime object
2808 return $new_debarment_str, $is_a_reminder;
2811 =head2 _FixOverduesOnReturn
2813 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2815 C<$borrowernumber> borrowernumber
2817 C<$itemnumber> itemnumber
2819 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2821 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2827 sub _FixOverduesOnReturn {
2828 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2829 unless( $borrowernumber ) {
2830 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2834 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2838 warn "_FixOverduesOnReturn() not supplied valid status";
2842 my $schema = Koha::Database->schema;
2844 my $result = $schema->txn_do(
2846 # check for overdue fine
2847 my $accountlines = Koha::Account::Lines->search(
2849 borrowernumber => $borrowernumber,
2850 itemnumber => $item,
2851 debit_type_code => 'OVERDUE',
2852 status => 'UNRETURNED'
2855 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2857 my $accountline = $accountlines->next;
2858 my $payments = $accountline->credits;
2860 my $amountoutstanding = $accountline->amountoutstanding;
2861 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2862 $accountline->delete;
2863 return 0; # no warning, we've just removed a zero value fine (backdated return)
2864 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2865 my $account = Koha::Account->new({patron_id => $borrowernumber});
2866 my $credit = $account->add_credit(
2868 amount => $amountoutstanding,
2869 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2870 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2871 interface => C4::Context->interface,
2877 $credit->apply({ debits => [ $accountline ] });
2879 if (C4::Context->preference("FinesLog")) {
2880 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2884 $accountline->status($status);
2885 return $accountline->store();
2892 =head2 _GetCircControlBranch
2894 my $circ_control_branch = _GetCircControlBranch($item, $patron);
2898 Return the library code to be used to determine which circulation
2899 policy applies to a transaction. Looks up the CircControl and
2900 HomeOrHoldingBranch system preferences.
2902 C<$item> is an item object.
2904 C<$patron> is a patron object.
2908 sub _GetCircControlBranch {
2909 my ($item, $patron) = @_;
2910 my $circcontrol = C4::Context->preference('CircControl');
2913 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2914 $branch = C4::Context->userenv->{'branch'};
2915 } elsif ($circcontrol eq 'PatronLibrary') {
2916 $branch = $patron->branchcode;
2918 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2919 $branch = $item->get_column($branchfield);
2920 # default to item home branch if holdingbranch is used
2921 # and is not defined
2922 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2923 $branch = $item->homebranch;
2929 =head2 GetUpcomingDueIssues
2931 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2935 sub GetUpcomingDueIssues {
2938 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2939 my $dbh = C4::Context->dbh;
2942 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2944 LEFT JOIN items USING (itemnumber)
2945 LEFT JOIN branches ON branches.branchcode =
2947 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2948 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2949 my @bind_parameters = ( $params->{'days_in_advance'} );
2951 my $sth = $dbh->prepare( $statement );
2952 $sth->execute( @bind_parameters );
2953 my $upcoming_dues = $sth->fetchall_arrayref({});
2955 return $upcoming_dues;
2958 =head2 CanBookBeRenewed
2960 ($ok,$error,$info) = &CanBookBeRenewed($patron, $issue, $override_limit, $cron);
2962 Find out whether a borrowed item may be renewed.
2964 C<$patron> is the patron who currently has the issue.
2966 C<$issue> is the checkout to renew.
2968 C<$cron> true or false, specifies if this check is being made
2969 by the automatic_renewals.pl cronscript
2971 C<$override_limit>, if supplied with a true value, causes
2972 the limit on the number of times that the loan can be renewed
2973 (as controlled by the item type) to be ignored. Overriding also allows
2974 to renew sooner than "No renewal before" and to manually renew loans
2975 that are automatically renewed.
2977 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2978 item must currently be on loan to the specified borrower; renewals
2979 must be allowed for the item's type; and the borrower must not have
2980 already renewed the loan.
2981 $error will contain the reason the renewal can not proceed
2982 $info will contain a hash of additional info
2983 currently 'soonest_renew_date' if error is 'too soon'
2987 sub CanBookBeRenewed {
2988 my ( $patron, $issue, $override_limit, $cron ) = @_;
2990 my $auto_renew = "no";
2992 my $item = $issue->item;
2994 return ( 0, 'no_item' ) unless $item;
2995 return ( 0, 'no_checkout' ) unless $issue;
2996 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2997 return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2998 return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
3000 my $final_renewal = 0;
3001 my $final_unseen_renewal = 0;
3003 # override_limit will override anything else except on_reserve
3004 my $branchcode = _GetCircControlBranch( $item, $patron );
3005 unless ( $override_limit ){
3007 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
3010 branchcode => $branchcode,
3013 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
3014 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
3015 # extra notices being sent. Cron also implies no override
3016 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
3017 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
3018 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
3020 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3022 categorycode => $patron->categorycode,
3023 itemtype => $item->effective_itemtype,
3024 branchcode => $branchcode,
3028 'unseen_renewals_allowed'
3033 return ( 0, "too_many" )
3034 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
3036 return ( 0, "too_unseen" )
3037 if C4::Context->preference('UnseenRenewals') &&
3038 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
3039 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
3041 $final_renewal = $issuing_rule->{renewalsallowed} == ( $issue->renewals_count + 1 ) ? 1 : 0;
3042 $final_unseen_renewal = ( C4::Context->preference('UnseenRenewals')
3043 && $issuing_rule->{unseen_renewals_allowed} == ( $issue->unseen_renewals + 1 ) ) ? 1 : 0;
3045 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
3046 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
3047 my $restricted = $patron->is_debarred;
3048 my $hasoverdues = $patron->has_overdues;
3050 if ( $restricted and $restrictionblockrenewing ) {
3051 return ( 0, 'restriction');
3052 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
3053 return ( 0, 'overdue');
3058 if ( C4::Context->preference('UseRecalls') ) {
3060 $recall = $item->check_recalls if $item->can_be_waiting_recall;
3061 if ( defined $recall ) {
3062 if ( $recall->item_level ) {
3063 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
3064 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
3066 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
3067 return ( 0, 'recalled' ) unless ( $recall->waiting );
3072 # There is an item level hold on this item, no other item can fill the hold
3073 return ( 0, "on_reserve" )
3074 if ( $item->current_holds->search( { non_priority => 0 } )->count );
3077 my ( $status, $matched_reserve, $possible_holds ) = C4::Reserves::CheckReserves($item);
3078 my @fillable_holds = ();
3079 foreach my $possible_hold ( @{$possible_holds} ) {
3080 push @fillable_holds, $possible_hold unless $possible_hold->{non_priority};
3082 if ( @fillable_holds ) {
3083 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
3085 # Get all other items that could possibly fill reserves
3086 # FIXME We could join reserves (or more tables) here to eliminate some checks later
3087 my @other_items = Koha::Items->search({
3088 biblionumber => $item->biblionumber,
3091 -not => { itemnumber => $item->itemnumber } })->as_list;
3093 return ( 0, "on_reserve" ) if @fillable_holds && (scalar @other_items < scalar @fillable_holds );
3096 foreach my $possible_hold ( @fillable_holds ) {
3098 my $patron_with_reserve = Koha::Patrons->find($possible_hold->{borrowernumber});
3100 foreach my $other_item (@other_items) {
3101 next if defined $matched_items{$other_item->itemnumber};
3102 next if IsItemOnHoldAndFound( $other_item->itemnumber );
3103 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef);
3104 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3105 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3106 # CanItemBeReserved checks 'rules' and 'policies' which means
3107 # items will fill holds at checkin that are rejected here
3109 $matched_items{$other_item->itemnumber} = 1;
3112 return ( 0, "on_reserve" ) unless $fillable;
3116 return ( 0, "on_reserve" ) if $status;
3120 # CHECK FOR BOOKINGS
3121 if ( $item->bookings->count ) {
3123 ( C4::Context->preference('RenewalPeriodBase') eq 'date_due' )
3124 ? dt_from_string( $issue->date_due, 'sql' )
3126 my $datedue = CalcDateDue( $startdate, $item->effective_itemtype, $branchcode, $patron, 'is a renewal' );
3128 my $booking = $item->find_booking(
3129 { checkout_date => $startdate, due_date => $datedue, patron_id => $patron->borrowernumber }
3133 return ( 0, 'booked' ) unless ( $booking->patron_id == $patron->borrowernumber );
3138 if ( $auto_renew eq 'auto_too_soon' ) {
3140 # If its cron, tell it it's too soon for a an auto renewal
3141 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $cron;
3143 # Check if it's too soon for a manual renewal
3144 my $soonestManual = GetSoonestRenewDate( $patron, $issue );
3145 if ( $soonestManual > dt_from_string() ) {
3146 return ( 0, "too_soon", { soonest_renew_date => $soonestManual } ) unless $override_limit;
3150 $soonest = GetSoonestRenewDate($patron, $issue);
3151 if ( $soonest > dt_from_string() ){
3152 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3155 my $auto_renew_code = $final_renewal ? 'auto_renew_final' : $final_unseen_renewal ? 'auto_unseen_final' : 'auto_renew';
3156 return ( 1, $auto_renew_code ) if $auto_renew eq "ok" || $auto_renew eq "auto_too_soon" && !$override_limit;
3158 return ( 1, undef );
3163 $new_date_due = AddRenewal({
3164 borrowernumber => $borrowernumber,
3165 itemnumber => $itemnumber,
3167 [datedue => $datedue],
3168 [lastreneweddate => $lastreneweddate],
3169 [skipfinecalc => $skipfinecalc],
3171 [automatic => $automatic],
3172 [skip_record_index => $skip_record_index]
3175 Renews a loan, returns the updated due date upon success.
3177 C<$borrowernumber> is the borrower number of the patron who currently
3180 C<$itemnumber> is the number of the item to renew.
3182 C<$branch> is the library where the renewal took place (if any).
3183 The library that controls the circ policies for the renewal is retrieved from the issues record.
3185 C<$datedue> can be a DateTime object used to set the due date.
3187 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3188 this parameter is not supplied, lastreneweddate is set to the current date.
3190 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3191 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3192 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3195 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3196 from the book's item type.
3198 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3199 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3200 fallback to a true value
3202 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3204 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3205 should be skipped for this renewal.
3212 my $borrowernumber = $params->{borrowernumber};
3213 my $itemnumber = $params->{itemnumber};
3214 return unless $itemnumber;
3216 my $branch = $params->{branch};
3217 my $datedue = $params->{datedue};
3218 my $lastreneweddate = $params->{lastreneweddate} // dt_from_string();
3219 my $skipfinecalc = $params->{skipfinecalc};
3220 my $seen = $params->{seen};
3221 my $automatic = $params->{automatic};
3222 my $skip_record_index = $params->{skip_record_index};
3224 # Fallback on a 'seen' renewal
3225 $seen = defined $seen && $seen == 0 ? 0 : 1;
3227 my $item_object = Koha::Items->find($itemnumber) or return;
3228 my $biblio = $item_object->biblio;
3229 my $issue = $item_object->checkout;
3230 my $item_unblessed = $item_object->unblessed;
3232 my $renewal_type = $automatic ? "Automatic" : "Manual";
3234 my $dbh = C4::Context->dbh;
3236 return unless $issue;
3238 $borrowernumber ||= $issue->borrowernumber;
3240 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3241 $datedue = dt_from_string($datedue, 'sql');
3244 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3245 my $patron_unblessed = $patron->unblessed;
3247 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
3249 my $schema = Koha::Database->schema;
3250 $schema->txn_do(sub{
3252 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3253 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3255 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3257 # If the due date wasn't specified, calculate it by adding the
3258 # book's loan length to today's date or the current due date
3259 # based on the value of the RenewalPeriodBase syspref.
3260 my $itemtype = $item_object->effective_itemtype;
3263 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3264 dt_from_string( $issue->date_due, 'sql' ) :
3266 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron, 'is a renewal');
3269 my $fees = Koha::Charges::Fees->new(
3272 library => $circ_library,
3273 item => $item_object,
3274 from_date => dt_from_string( $issue->date_due, 'sql' ),
3275 to_date => dt_from_string($datedue),
3279 # Increment the unseen renewals, if appropriate
3280 # We only do so if the syspref is enabled and
3281 # a maximum value has been set in the circ rules
3282 my $unseen_renewals = $issue->unseen_renewals;
3283 if (C4::Context->preference('UnseenRenewals')) {
3284 my $rule = Koha::CirculationRules->get_effective_rule(
3285 { categorycode => $patron->categorycode,
3286 itemtype => $item_object->effective_itemtype,
3287 branchcode => $circ_library->branchcode,
3288 rule_name => 'unseen_renewals_allowed'
3291 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3294 # If the renewal is seen, unseen should revert to 0
3295 $unseen_renewals = 0;
3299 # Update the issues record to have the new due date, and a new count
3300 # of how many times it has been renewed.
3301 my $renews = ( $issue->renewals_count || 0 ) + 1;
3302 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3305 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3308 Koha::Exceptions::Checkout::FailedRenewal->throw(
3309 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3313 # Update the renewal count on the item, and tell zebra to reindex
3314 $renews = ( $item_object->renewals || 0 ) + 1;
3315 $item_object->renewals($renews);
3316 $item_object->onloan($datedue);
3317 # Don't index as we are in a transaction, skip hardcoded here
3318 $item_object->store({ log_action => 0, skip_record_index => 1 });
3320 # Charge a new rental fee, if applicable
3321 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3322 if ( $charge > 0 ) {
3323 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3326 # Charge a new accumulate rental fee, if applicable
3327 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3328 if ( $itemtype_object ) {
3329 my $accumulate_charge = $fees->accumulate_rentalcharge();
3330 if ( $accumulate_charge > 0 ) {
3331 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3333 $charge += $accumulate_charge;
3336 # Send a renewal slip according to checkout alert preferencei
3337 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3338 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3340 branchcode => $branch,
3341 categorycode => $patron->categorycode,
3342 item_type => $itemtype,
3343 notification => 'CHECKOUT',
3345 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3346 SendCirculationAlert(
3349 item => $item_unblessed,
3350 borrower => $patron->unblessed,
3357 # Remove any OVERDUES related debarment if the borrower has no overdues
3358 my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3360 && $patron->is_debarred
3361 && ! $patron->has_overdues
3362 && $overdue_restrictions->count
3364 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3367 # Add renewal record
3368 my $renewal = Koha::Checkouts::Renewal->new(
3370 checkout_id => $issue->issue_id,
3371 interface => C4::Context->interface,
3372 renewal_type => $renewal_type,
3373 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3378 # Add the renewal to stats
3379 C4::Stats::UpdateStats(
3381 branch => $item_object->renewal_branchcode({branch => $branch}),
3384 itemnumber => $itemnumber,
3385 itemtype => $itemtype,
3386 location => $item_object->location,
3387 borrowernumber => $borrowernumber,
3388 ccode => $item_object->ccode,
3389 categorycode => $patron->categorycode,
3390 interface => C4::Context->interface,
3393 #Update borrowers.lastseen
3394 $patron->update_lastseen('renewal');
3397 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3399 Koha::Plugins->call('after_circ_action', {
3400 action => 'renewal',
3402 checkout => $issue->get_from_storage
3407 unless( $skip_record_index ){
3408 # We index now, after the transaction is committed
3409 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3410 $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3417 # check renewal status
3418 my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3420 my $dbh = C4::Context->dbh;
3422 my $unseencount = 0;
3423 my $renewsallowed = 0;
3424 my $unseenallowed = 0;
3427 my $patron = blessed $borrowernumber_or_patron ?
3428 $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3429 my $item = blessed $itemnumber_or_item ?
3430 $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3432 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3434 # Look in the issues table for this item, lent to this borrower,
3435 # and not yet returned.
3437 # FIXME - I think this function could be redone to use only one SQL call.
3438 my $sth = $dbh->prepare(q{
3439 SELECT * FROM issues
3440 WHERE (borrowernumber = ?) AND (itemnumber = ?)
3442 $sth->execute( $patron->borrowernumber, $item->itemnumber );
3443 my $data = $sth->fetchrow_hashref;
3444 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3445 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3446 # $item and $borrower should be calculated
3447 my $branchcode = _GetCircControlBranch($item, $patron);
3449 my $rules = Koha::CirculationRules->get_effective_rules(
3451 categorycode => $patron->categorycode,
3452 itemtype => $item->effective_itemtype,
3453 branchcode => $branchcode,
3454 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3457 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3458 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3459 $rules->{unseen_renewals_allowed} :
3461 $renewsleft = $renewsallowed - $renewcount;
3462 $unseenleft = $unseenallowed - $unseencount;
3463 if($renewsleft < 0){ $renewsleft = 0; }
3464 if($unseenleft < 0){ $unseenleft = 0; }
3475 =head2 GetSoonestRenewDate
3477 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3479 Find out the soonest possible renew date of a borrowed item.
3481 C<$patron> is the patron who currently has the item on loan.
3483 C<$issue> is the the item issue.
3485 C<$is_auto> is this soonest renew date for an auto renewal?
3487 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3488 renew date, based on the value "No renewal before" of the applicable
3489 issuing rule. Returns the current date if the item can already be
3490 renewed, and returns undefined if the patron, item, or checkout
3495 sub GetSoonestRenewDate {
3496 my ( $patron, $issue, $is_auto ) = @_;
3497 return unless $issue;
3498 return unless $patron;
3500 my $item = $issue->item;
3501 return unless $item;
3503 my $circ_rule = $is_auto ? 'noautorenewalbefore' : 'norenewalbefore';
3505 my $dbh = C4::Context->dbh;
3507 my $branchcode = _GetCircControlBranch( $item, $patron );
3508 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3509 { categorycode => $patron->categorycode,
3510 itemtype => $item->effective_itemtype,
3511 branchcode => $branchcode,
3519 my $now = dt_from_string;
3521 if ( defined $issuing_rule->{$circ_rule}
3522 and $issuing_rule->{$circ_rule} ne "" )
3524 my $soonestrenewal =
3525 dt_from_string( $issue->date_due )->subtract(
3526 $issuing_rule->{lengthunit} => $issuing_rule->{$circ_rule} );
3528 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3529 and $issuing_rule->{lengthunit} eq 'days' )
3531 $soonestrenewal->truncate( to => 'day' );
3533 return $soonestrenewal;
3534 } elsif ( $is_auto && $issue->auto_renew && $patron->autorenew_checkouts ) {
3535 # Checkouts with auto-renewing fall back to due date if noautorenewalbefore is undef
3536 my $soonestrenewal = dt_from_string( $issue->date_due );
3537 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3538 and $issuing_rule->{lengthunit} eq 'days' )
3540 $soonestrenewal->truncate( to => 'day' );
3542 return $soonestrenewal;
3547 =head2 GetLatestAutoRenewDate
3549 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3551 Find out the latest possible auto renew date of a borrowed item.
3553 C<$patron> is the patron who currently has the item on loan.
3555 C<$issue> is the item issue.
3557 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3558 auto renew date, based on the value "No auto renewal after" and the "No auto
3559 renewal after (hard limit) of the applicable issuing rule.
3560 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3561 or item cannot be found.
3565 sub GetLatestAutoRenewDate {
3566 my ( $patron, $issue ) = @_;
3567 return unless $issue;
3568 return unless $patron;
3570 my $item = $issue->item;
3571 return unless $item;
3573 my $dbh = C4::Context->dbh;
3574 my $branchcode = _GetCircControlBranch( $item, $patron );
3576 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3578 categorycode => $patron->categorycode,
3579 itemtype => $item->effective_itemtype,
3580 branchcode => $branchcode,
3582 'no_auto_renewal_after',
3583 'no_auto_renewal_after_hard_limit',
3589 return unless $circulation_rules;
3591 if ( not $circulation_rules->{no_auto_renewal_after}
3592 or $circulation_rules->{no_auto_renewal_after} eq '' )
3593 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3594 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3596 my $maximum_renewal_date;
3597 if ( $circulation_rules->{no_auto_renewal_after} ) {
3598 $maximum_renewal_date = dt_from_string($issue->issuedate);
3599 $maximum_renewal_date->add(
3600 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3604 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3605 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3606 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3608 return $maximum_renewal_date;
3612 =head2 GetIssuingCharges
3614 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3616 Calculate how much it would cost for a given patron to borrow a given
3617 item, including any applicable discounts.
3619 C<$itemnumber> is the item number of item the patron wishes to borrow.
3621 C<$borrowernumber> is the patron's borrower number.
3623 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3624 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3629 sub GetIssuingCharges {
3631 # calculate charges due
3632 my ( $itemnumber, $borrowernumber ) = @_;
3634 my $dbh = C4::Context->dbh;
3637 # Get the book's item type and rental charge (via its biblioitem).
3638 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3639 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3640 $charge_query .= (C4::Context->preference('item-level_itypes'))
3641 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3642 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3644 $charge_query .= ' WHERE items.itemnumber =?';
3646 my $sth = $dbh->prepare($charge_query);
3647 $sth->execute($itemnumber);
3649 if ( my $item_data = $sth->fetchrow_hashref ) {
3650 $item_type = $item_data->{itemtype};
3651 $charge = $item_data->{rentalcharge};
3653 # FIXME This should follow CircControl
3654 my $branch = C4::Context::mybranch();
3655 $patron //= Koha::Patrons->find( $borrowernumber );
3656 my $discount = Koha::CirculationRules->get_effective_rule({
3657 categorycode => $patron->categorycode,
3658 branchcode => $branch,
3659 itemtype => $item_type,
3660 rule_name => 'rentaldiscount'
3663 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3665 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3669 return ( $charge, $item_type );
3672 =head2 AddIssuingCharge
3674 &AddIssuingCharge( $checkout, $charge, $type )
3678 sub AddIssuingCharge {
3679 my ( $checkout, $charge, $type ) = @_;
3681 # FIXME What if checkout does not exist?
3683 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3684 my $accountline = $account->add_debit(
3688 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3689 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3690 interface => C4::Context->interface,
3692 item_id => $checkout->itemnumber,
3693 issue_id => $checkout->issue_id,
3698 =head2 GetTransfersFromTo
3700 @results = GetTransfersFromTo($frombranch,$tobranch);
3702 Returns the list of pending transfers between $from and $to branch
3706 sub GetTransfersFromTo {
3707 my ( $frombranch, $tobranch ) = @_;
3708 return unless ( $frombranch && $tobranch );
3709 my $dbh = C4::Context->dbh;
3711 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3712 FROM branchtransfers
3715 AND datecancelled IS NULL
3716 AND datesent IS NOT NULL
3717 AND datearrived IS NULL
3719 my $sth = $dbh->prepare($query);
3720 $sth->execute( $frombranch, $tobranch );
3723 while ( my $data = $sth->fetchrow_hashref ) {
3724 push @gettransfers, $data;
3726 return (@gettransfers);
3729 =head2 SendCirculationAlert
3731 Send out a C<check-in> or C<checkout> alert using the messaging system.
3739 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3743 Hashref of information about the item being checked in or out.
3747 Hashref of information about the borrower of the item.
3751 The branchcode from where the checkout or check-in took place.
3757 SendCirculationAlert({
3760 borrower => $borrower,
3766 sub SendCirculationAlert {
3768 my ($type, $item, $borrower, $branch, $issue) =
3769 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3770 my %message_name = (
3771 CHECKIN => 'Item_Check_in',
3772 CHECKOUT => 'Item_Checkout',
3773 RENEWAL => 'Item_Checkout',
3775 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3776 borrowernumber => $borrower->{borrowernumber},
3777 message_name => $message_name{$type},
3782 items => $item->{itemnumber},
3783 biblio => $item->{biblionumber},
3784 biblioitems => $item->{biblionumber},
3785 borrowers => $borrower,
3786 branches => $branch,
3789 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3790 # See C4::Letters:: _parseletter_sth
3791 if( $type eq 'CHECKIN' ){
3792 $tables->{old_issues} = $issue->issue_id;
3794 $tables->{issues} = $item->{itemnumber};
3797 my $schema = Koha::Database->new->schema;
3798 my @transports = keys %{ $borrower_preferences->{transports} };
3800 # From the MySQL doc:
3801 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3802 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3803 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3804 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3806 for my $mtt (@transports) {
3807 my $letter = C4::Letters::GetPreparedLetter (
3808 module => 'circulation',
3809 letter_code => $type,
3810 branchcode => $branch,
3811 message_transport_type => $mtt,
3812 lang => $borrower->{lang},
3816 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3817 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3818 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3819 unless ( $message ) {
3820 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3821 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3822 C4::Message->enqueue($letter, $patron, $mtt);
3824 $message->append($letter);
3827 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3833 =head2 updateWrongTransfer
3835 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3837 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
3841 sub updateWrongTransfer {
3842 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3844 # first step: cancel the original transfer
3845 my $item = Koha::Items->find($itemNumber);
3846 my $transfer = $item->get_transfer;
3847 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3849 # second step: create a new transfer to the right location
3850 my $new_transfer = $item->request_transfer(
3852 to => $transfer->to_library,
3853 reason => $transfer->reason,
3854 comment => $transfer->comments,
3860 return $new_transfer;
3865 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3867 this function calculates the due date given the start date and configured circulation rules,
3868 checking against the holidays calendar as per the daysmode circulation rule.
3869 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3870 C<$itemtype> = itemtype code of item in question
3871 C<$branch> = location whose calendar to use
3872 C<$patron> = Patron object
3873 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3878 my ( $startdate, $itemtype, $branch, $patron, $isrenewal ) = @_;
3882 # loanlength now a href
3884 GetLoanLength( $patron->categorycode, $itemtype, $branch );
3886 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3892 if (ref $startdate ne 'DateTime' ) {
3893 $datedue = dt_from_string($datedue);
3895 $datedue = $startdate->clone;
3898 $datedue = dt_from_string()->truncate( to => 'minute' );
3902 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3904 categorycode => $patron->categorycode,
3905 itemtype => $itemtype,
3906 branchcode => $branch,
3910 my $considerlibraryhours = C4::Context->preference('ConsiderLibraryHoursInCirculation');
3912 # starter vars so don't do calculations directly to $datedue
3913 my $potential_datedue = $datedue->clone;
3914 my $library_close = $datedue->clone;
3915 my $dayofweek = $datedue->day_of_week;
3917 # Representation fix
3918 # DateTime object dow (1-7) where Monday is 1
3919 # Arrays are 0-based where 0 = Sunday, not 7.
3920 if ( $dayofweek == 7 ) {
3924 my $tomorrow_dayofweek = $dayofweek + 1;
3925 if ( $tomorrow_dayofweek == 7 ) {
3926 $tomorrow_dayofweek = 0;
3929 my $todayhours = Koha::Library::Hours->find( { library_id => $branch, day => $dayofweek } );
3931 my $tomorrowhours = Koha::Library::Hours->find( { library_id => $branch, day => $tomorrow_dayofweek } )
3932 ; # get open hours of next day
3934 # Defend against missing library hours definitions
3935 if ( !$todayhours || !$tomorrowhours ) { $considerlibraryhours = 'ignore' }
3938 if ( $considerlibraryhours ne 'ignore' and $todayhours->close_time and $tomorrowhours->open_time ) {
3939 @close = split( ":", $todayhours->close_time );
3940 $library_close = $library_close->set( hour => $close[0], minute => $close[1] );
3941 $potential_datedue = $potential_datedue->add( hours => $loanlength->{$length_key} )
3942 ; # datedue without consideration for open hours
3943 @open = split( ":", $tomorrowhours->open_time );
3946 # calculate the datedue as normal
3947 if ( $daysmode eq 'Days' )
3948 { # ignoring calendar
3949 if ( $loanlength->{lengthunit} eq 'hours' ) {
3950 if ( $considerlibraryhours ne 'ignore' and $potential_datedue > $library_close and $todayhours->close_time and $tomorrowhours->open_time ) {
3951 if ( $considerlibraryhours eq 'close' ) {
3953 # datedue will be after the library closes on that day
3954 # shorten loan period to end when library closes
3955 $datedue->set( hour => $close[0], minute => $close[1] );
3956 } elsif ( $considerlibraryhours eq 'open' ) {
3958 # datedue will be after the library closes on that day
3959 # extend loan period to when library opens following day
3960 $datedue->add( days => 1 )->set( hour => $open[0], minute => $open[1] );
3963 # ignore library open hours
3964 $datedue->add( hours => $loanlength->{$length_key} );
3968 # due time doesn't conflict with library open hours, don't need to check
3969 $datedue->add( hours => $loanlength->{$length_key} );
3972 $datedue->add( days => $loanlength->{$length_key} );
3973 $datedue->set_hour(23);
3974 $datedue->set_minute(59);
3978 if ($loanlength->{lengthunit} eq 'hours') {
3979 if ( $considerlibraryhours ne 'ignore' and $potential_datedue > $library_close and $todayhours->close_time and $tomorrowhours->open_time ) {
3980 if ( $considerlibraryhours eq 'close' ) {
3982 # datedue will be after the library closes on that day
3983 # shorten loan period to end when library closes by hardcoding due time
3984 $datedue->set( hour => $close[0], minute => $close[1] );
3985 } elsif ( $considerlibraryhours eq 'open' ) {
3987 # datedue will be after the library closes on that day
3988 # extend loan period to when library opens following day by hardcoding due time for next open day
3989 $dur = DateTime::Duration->new( days => 1 );
3990 $datedue->set( hour => $open[0], minute => $open[1] );
3993 # ignore library open hours
3994 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key} );
3998 # due time doesn't conflict with library open hours, don't need to check
3999 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key} );
4003 $dur = DateTime::Duration->new( days => $loanlength->{$length_key} );
4005 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
4006 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} ) if $dur;
4007 if ($loanlength->{lengthunit} eq 'days') {
4008 $datedue->set_hour(23);
4009 $datedue->set_minute(59);
4013 # if Hard Due Dates are used, retrieve them and apply as necessary
4014 my ( $hardduedate, $hardduedatecompare ) =
4015 GetHardDueDate( $patron->categorycode, $itemtype, $branch );
4016 if ($hardduedate) { # hardduedates are currently dates
4017 $hardduedate->truncate( to => 'minute' );
4018 $hardduedate->set_hour(23);
4019 $hardduedate->set_minute(59);
4020 my $cmp = DateTime->compare( $hardduedate, $datedue );
4022 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
4023 # if the calculated date is before the 'after' Hard Due Date (floor), override
4024 # if the hard due date is set to 'exactly', overrride
4025 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
4026 $datedue = $hardduedate->clone;
4029 # in all other cases, keep the date due as it is
4033 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
4034 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
4035 my $expiry_dt = dt_from_string( $patron->dateexpiry, 'iso', 'floating');
4036 if( $expiry_dt ) { #skip empty expiry date..
4037 $expiry_dt->set( hour => 23, minute => 59);
4038 my $d1= $datedue->clone->set_time_zone('floating');
4039 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
4040 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
4043 if ( $daysmode ne 'Days' ) {
4044 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
4045 if ( $calendar->is_holiday($datedue) ) {
4046 # Don't return on a closed day
4047 $datedue = $calendar->prev_open_days( $datedue, 1 );
4056 sub CheckValidBarcode{
4058 my $dbh = C4::Context->dbh;
4059 my $query=qq|SELECT count(*)
4063 my $sth = $dbh->prepare($query);
4064 $sth->execute($barcode);
4065 my $exist=$sth->fetchrow ;
4069 =head2 IsBranchTransferAllowed
4071 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
4073 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
4075 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
4076 Koha::Item->can_be_transferred.
4080 sub IsBranchTransferAllowed {
4081 my ( $toBranch, $fromBranch, $code ) = @_;
4083 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
4085 my $limitType = C4::Context->preference("BranchTransferLimitsType");
4086 my $dbh = C4::Context->dbh;
4088 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
4089 $sth->execute( $toBranch, $fromBranch, $code );
4090 my $limit = $sth->fetchrow_hashref();
4092 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
4093 if ( $limit->{'limitId'} ) {
4100 =head2 CreateBranchTransferLimit
4102 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
4104 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
4106 Deprecated in favor of Koha::Item::Transfer::Limit->new.
4110 sub CreateBranchTransferLimit {
4111 my ( $toBranch, $fromBranch, $code ) = @_;
4112 return unless defined($toBranch) && defined($fromBranch);
4113 my $limitType = C4::Context->preference("BranchTransferLimitsType");
4115 my $dbh = C4::Context->dbh;
4117 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
4118 return $sth->execute( $code, $toBranch, $fromBranch );
4121 =head2 DeleteBranchTransferLimits
4123 my $result = DeleteBranchTransferLimits($frombranch);
4125 Deletes all the library transfer limits for one library. Returns the
4126 number of limits deleted, 0e0 if no limits were deleted, or undef if
4127 no arguments are supplied.
4129 Deprecated in favor of Koha::Item::Transfer::Limits->search({
4130 fromBranch => $fromBranch
4135 sub DeleteBranchTransferLimits {
4137 return unless defined $branch;
4138 my $dbh = C4::Context->dbh;
4139 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
4140 return $sth->execute($branch);
4144 my ( $borrowernumber, $itemnum ) = @_;
4145 MarkIssueReturned( $borrowernumber, $itemnum );
4150 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
4152 The final optional parameter, C<$params>, expected to contain
4153 'skip_record_index' key, which relayed down to Koha::Item/store,
4154 there it prevents calling of ModZebra index_records,
4155 which takes most of the time in batch adds/deletes: index_records better
4156 to be called later in C<additem.pl> after the whole loop.
4159 skip_record_index => 1|0
4164 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
4166 unless ( $mark_lost_from ) {
4167 # Temporary check to avoid regressions
4168 die q|LostItem called without $mark_lost_from, check the API.|;
4172 if ( $force_mark_returned ) {
4175 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
4176 $mark_returned = ( $pref =~ m|$mark_lost_from| );
4179 my $dbh = C4::Context->dbh();
4180 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
4182 JOIN items USING (itemnumber)
4183 JOIN biblio USING (biblionumber)
4184 WHERE issues.itemnumber=?");
4185 $sth->execute($itemnumber);
4186 my $issues=$sth->fetchrow_hashref();
4188 # If a borrower lost the item, add a replacement cost to the their record
4189 if ( my $borrowernumber = $issues->{borrowernumber} ){
4190 my $patron = Koha::Patrons->find( $borrowernumber );
4192 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
4193 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
4195 if (C4::Context->preference('WhenLostChargeReplacementFee')){
4196 C4::Accounts::chargelostitem(
4199 $issues->{'replacementprice'},
4200 sprintf( "%s %s %s",
4201 $issues->{'title'} || q{},
4202 $issues->{'barcode'} || q{},
4203 $issues->{'itemcallnumber'} || q{},
4206 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4207 #warn " $issues->{'borrowernumber'} / $itemnumber ";
4210 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4213 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4214 my $item = Koha::Items->find($itemnumber);
4215 my $transfers = $item->get_transfers;
4216 while (my $transfer = $transfers->next) {
4217 $transfer->cancel({ reason => 'ItemLost', force => 1 });
4221 sub GetOfflineOperations {
4222 my $dbh = C4::Context->dbh;
4223 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4224 $sth->execute(C4::Context->userenv->{'branch'});
4225 my $results = $sth->fetchall_arrayref({});
4229 sub GetOfflineOperation {
4230 my $operationid = shift;
4231 return unless $operationid;
4232 my $dbh = C4::Context->dbh;
4233 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4234 $sth->execute( $operationid );
4235 return $sth->fetchrow_hashref;
4238 sub AddOfflineOperation {
4239 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4240 my $dbh = C4::Context->dbh;
4241 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4242 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4246 sub DeleteOfflineOperation {
4247 my $dbh = C4::Context->dbh;
4248 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4249 $sth->execute( shift );
4253 sub ProcessOfflineOperation {
4254 my $operation = shift;
4257 if ( $operation->{action} eq 'return' ) {
4258 $report = ProcessOfflineReturn( $operation );
4259 } elsif ( $operation->{action} eq 'issue' ) {
4260 $report = ProcessOfflineIssue( $operation );
4261 } elsif ( $operation->{action} eq 'payment' ) {
4262 $report = ProcessOfflinePayment( $operation );
4265 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4270 sub ProcessOfflineReturn {
4271 my $operation = shift;
4273 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4276 my $itemnumber = $item->itemnumber;
4277 my $issue = $item->checkout;
4279 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4280 ModDateLastSeen( $itemnumber, $leave_item_lost );
4282 $issue->borrowernumber,
4284 $operation->{timestamp},
4286 $item->onloan(undef);
4287 $item->store({ log_action => 0 });
4290 return "Item not issued.";
4293 return "Item not found.";
4297 sub ProcessOfflineIssue {
4298 my $operation = shift;
4300 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4301 $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4304 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4306 return "Barcode not found.";
4308 my $itemnumber = $item->itemnumber;
4309 my $issue = $item->checkout;
4311 if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4313 $issue->borrowernumber,
4315 $operation->{timestamp},
4320 $operation->{'barcode'},
4323 $operation->{timestamp},
4328 return "Borrower not found.";
4332 sub ProcessOfflinePayment {
4333 my $operation = shift;
4335 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4336 $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4338 $patron->account->pay(
4340 amount => $operation->{amount},
4341 library_id => $operation->{branchcode},
4351 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4353 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4358 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4362 ? Koha::Items->find($itemnumber)
4363 : Koha::Items->find( { barcode => $barcode } );
4367 return C4::Letters::GetPreparedLetter (
4368 module => 'circulation',
4369 letter_code => 'TRANSFERSLIP',
4370 branchcode => $branch,
4372 'branches' => $to_branch,
4373 'biblio' => $item->biblionumber,
4374 'items' => $item->unblessed,
4379 =head2 CheckIfIssuedToPatron
4381 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4383 Return 1 if any record item is issued to patron, otherwise return 0
4387 sub CheckIfIssuedToPatron {
4388 my ($borrowernumber, $biblionumber) = @_;
4390 my $dbh = C4::Context->dbh;
4392 SELECT COUNT(*) FROM issues
4393 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4394 WHERE items.biblionumber = ?
4395 AND issues.borrowernumber = ?
4397 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4398 return 1 if $is_issued;
4404 IsItemIssued( $itemnumber )
4406 Return 1 if the item is on loan, otherwise return 0
4411 my $itemnumber = shift;
4412 my $dbh = C4::Context->dbh;
4413 my $sth = $dbh->prepare(q{
4416 WHERE itemnumber = ?
4418 $sth->execute($itemnumber);
4419 return $sth->fetchrow;
4422 =head2 GetAgeRestriction
4424 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4425 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4427 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4428 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4430 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4431 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4432 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4433 Negative days mean the borrower has gone past the age restriction age.
4437 sub GetAgeRestriction {
4438 my ($record_restrictions, $borrower) = @_;
4439 my $markers = C4::Context->preference('AgeRestrictionMarker');
4441 return unless $record_restrictions;
4442 # Split $record_restrictions to something like FSK 16 or PEGI 6
4443 my @values = split ' ', uc($record_restrictions);
4444 return unless @values;
4446 # Search first occurrence of one of the markers
4447 my @markers = split /\|/, uc($markers);
4448 return unless @markers;
4451 my $restriction_year = 0;
4452 for my $value (@values) {
4454 for my $marker (@markers) {
4455 $marker =~ s/^\s+//; #remove leading spaces
4456 $marker =~ s/\s+$//; #remove trailing spaces
4457 if ( $marker eq $value ) {
4458 if ( $index <= $#values ) {
4459 $restriction_year += $values[$index];
4463 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4465 # Perhaps it is something like "K16" (as in Finland)
4466 $restriction_year += $1;
4470 last if ( $restriction_year > 0 );
4473 #Check if the borrower is age restricted for this material and for how long.
4474 if ($restriction_year && $borrower) {
4475 if ( $borrower->{'dateofbirth'} ) {
4476 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4477 $alloweddate[0] += $restriction_year;
4479 #Prevent runime eror on leap year (invalid date)
4480 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4481 $alloweddate[2] = 28;
4484 #Get how many days the borrower has to reach the age restriction
4485 my @Today = split /-/, dt_from_string()->ymd();
4486 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4487 #Negative days means the borrower went past the age restriction age
4488 return ($restriction_year, $daysToAgeRestriction);
4492 return ($restriction_year);
4496 =head2 GetPendingOnSiteCheckouts
4500 sub GetPendingOnSiteCheckouts {
4501 my $dbh = C4::Context->dbh;
4502 return $dbh->selectall_arrayref(q|
4508 items.itemcallnumber,
4512 issues.date_due < NOW() AS is_overdue,
4515 borrowers.firstname,
4517 borrowers.cardnumber,
4518 borrowers.borrowernumber
4520 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4521 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4522 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4523 WHERE issues.onsite_checkout = 1
4524 |, { Slice => {} } );
4530 my ($count, $branch, $itemtype, $ccode, $newness)
4531 = @$params{qw(count branch itemtype ccode newness)};
4533 my $dbh = C4::Context->dbh;
4536 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4537 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4538 i.ccode, SUM(i.issues) AS count
4540 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4541 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4544 my (@where_strs, @where_args);
4547 push @where_strs, 'i.homebranch = ?';
4548 push @where_args, $branch;
4551 if (C4::Context->preference('item-level_itypes')){
4552 push @where_strs, 'i.itype = ?';
4553 push @where_args, $itemtype;
4555 push @where_strs, 'bi.itemtype = ?';
4556 push @where_args, $itemtype;
4560 push @where_strs, 'i.ccode = ?';
4561 push @where_args, $ccode;
4564 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4565 push @where_args, $newness;
4569 $query .= 'WHERE ' . join(' AND ', @where_strs);
4573 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4574 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4579 $query .= q{ ) xxx WHERE count > 0 };
4580 $count = int($count);
4582 $query .= "LIMIT $count";
4585 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4590 =head2 Internal methods
4594 sub _CalculateAndUpdateFine {
4597 my $borrower = $params->{borrower};
4598 my $item = $params->{item};
4599 my $issue = $params->{issue};
4600 my $return_date = $params->{return_date};
4602 unless ($borrower) { carp "No borrower passed in!" && return; }
4603 unless ($item) { carp "No item passed in!" && return; }
4604 unless ($issue) { carp "No issue passed in!" && return; }
4606 my $datedue = dt_from_string( $issue->date_due );
4608 # we only need to calculate and change the fines if we want to do that on return
4609 # Should be on for hourly loans
4610 my $control = C4::Context->preference('CircControl');
4611 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4612 my $control_branchcode =
4613 ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4614 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4615 : $issue->branchcode;
4617 my $date_returned = $return_date ? $return_date : dt_from_string();
4619 my ( $amount, $unitcounttotal, $unitcount ) =
4620 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4622 if ( C4::Context->preference('finesMode') eq 'production' ) {
4623 if ( $amount > 0 ) {
4624 C4::Overdues::UpdateFine({
4625 issue_id => $issue->issue_id,
4626 itemnumber => $issue->itemnumber,
4627 borrowernumber => $issue->borrowernumber,
4632 elsif ($return_date) {
4634 # Backdated returns may have fines that shouldn't exist,
4635 # so in this case, we need to drop those fines to 0
4637 C4::Overdues::UpdateFine({
4638 issue_id => $issue->issue_id,
4639 itemnumber => $issue->itemnumber,
4640 borrowernumber => $issue->borrowernumber,
4648 sub _CanBookBeAutoRenewed {
4649 my ( $params ) = @_;
4650 my $patron = $params->{patron};
4651 my $item = $params->{item};
4652 my $branchcode = $params->{branchcode};
4653 my $issue = $params->{issue};
4655 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4657 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4659 categorycode => $patron->categorycode,
4660 itemtype => $item->effective_itemtype,
4661 branchcode => $branchcode,
4663 'no_auto_renewal_after',
4664 'no_auto_renewal_after_hard_limit',
4666 'noautorenewalbefore',
4671 if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4672 return 'auto_account_expired';
4675 if ( defined $issuing_rule->{no_auto_renewal_after}
4676 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4677 # Get issue_date and add no_auto_renewal_after
4678 # If this is greater than today, it's too late for renewal.
4679 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4680 $maximum_renewal_date->add(
4681 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4683 my $now = dt_from_string;
4684 if ( $now >= $maximum_renewal_date ) {
4685 return "auto_too_late";
4688 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4689 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4690 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4691 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4692 return "auto_too_late";
4696 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4697 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4698 my $amountoutstanding =
4699 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4700 ? $patron->account->balance
4701 : $patron->account->outstanding_debits->total_outstanding;
4702 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4703 return "auto_too_much_oweing";
4707 my $soonest = GetSoonestRenewDate( $patron, $issue, 1 );
4708 if ( $soonest > dt_from_string() )
4710 return ( "auto_too_soon", $soonest );
4723 Koha Development Team <http://koha-community.org/>