1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX qw( floor );
28 use C4::Stats qw( UpdateStats );
29 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest );
30 use C4::Biblio qw( UpdateTotalIssues );
31 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
33 use C4::ItemCirculationAlertPreference;
35 use C4::Log qw( logaction ); # logaction
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits qw( CheckDigits );
40 use Data::Dumper qw( Dumper );
42 use Koha::AuthorisedValues;
43 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
44 use Koha::Biblioitems;
45 use Koha::DateUtils qw( dt_from_string );
48 use Koha::Illrequests;
51 use Koha::Patron::Debarments qw( DelUniqueDebarment AddUniqueDebarment );
54 use Koha::Account::Lines;
56 use Koha::Account::Lines;
57 use Koha::Account::Offsets;
58 use Koha::Config::SysPrefs;
59 use Koha::Charges::Fees;
60 use Koha::Config::SysPref;
61 use Koha::Checkouts::ReturnClaims;
62 use Koha::SearchEngine::Indexer;
63 use Koha::Exceptions::Checkout;
67 use List::MoreUtils qw( any );
68 use Scalar::Util qw( looks_like_number blessed );
69 use Date::Calc qw( Date_to_Days );
70 our (@ISA, @EXPORT_OK);
76 # FIXME subs that should probably be elsewhere
81 GetPendingOnSiteCheckouts
92 GetLatestAutoRenewDate
95 GetBranchBorrowerCircRule
113 IsBranchTransferAllowed
114 CreateBranchTransferLimit
115 DeleteBranchTransferLimits
121 DeleteOfflineOperation
122 ProcessOfflineOperation
123 ProcessOfflinePayment
126 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
131 C4::Circulation - Koha circulation module
139 The functions in this module deal with circulation, issues, and
140 returns, as well as general information about the library.
141 Also deals with inventory.
147 $str = &barcodedecode($barcode, [$filter]);
149 Generic filter function for barcode string.
150 Called on every circ if the System Pref itemBarcodeInputFilter is set.
151 Will do some manipulation of the barcode for systems that deliver a barcode
152 to circulation.pl that differs from the barcode stored for the item.
153 For proper functioning of this filter, calling the function on the
154 correct barcode string (items.barcode) should return an unaltered barcode.
155 Barcode is going to be automatically trimmed of leading/trailing whitespaces.
157 The optional $filter argument is to allow for testing or explicit
158 behavior that ignores the System Pref. Valid values are the same as the
163 # FIXME -- the &decode fcn below should be wrapped into this one.
164 # FIXME -- these plugins should be moved out of Circulation.pm
167 my ($barcode, $filter) = @_;
169 return unless defined $barcode;
171 my $branch = C4::Context::mybranch();
172 $barcode =~ s/^\s+|\s+$//g;
173 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
174 Koha::Plugins->call('item_barcode_transform', \$barcode );
175 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
176 if ($filter eq 'whitespace') {
178 } elsif ($filter eq 'cuecat') {
180 my @fields = split( /\./, $barcode );
181 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
182 ($#results == 2) and return $results[2];
183 } elsif ($filter eq 'T-prefix') {
184 if ($barcode =~ /^[Tt](\d)/) {
185 (defined($1) and $1 eq '0') and return $barcode;
186 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
188 return sprintf("T%07d", $barcode);
189 # FIXME: $barcode could be "T1", causing warning: substr outside of string
190 # Why drop the nonzero digit after the T?
191 # Why pass non-digits (or empty string) to "T%07d"?
192 } elsif ($filter eq 'libsuite8') {
193 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
194 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
195 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
197 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
200 } elsif ($filter eq 'EAN13') {
201 my $ean = CheckDigits('ean');
202 if ( $ean->is_valid($barcode) ) {
203 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
204 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
206 warn "# [$barcode] not valid EAN-13/UPC-A\n";
209 return $barcode; # return barcode, modified or not
214 $str = &_decode($chunk);
216 Decodes a segment of a string emitted by a CueCat barcode scanner and
219 FIXME: Should be replaced with Barcode::Cuecat from CPAN
220 or Javascript based decoding on the client side.
227 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
228 my @s = map { index( $seq, $_ ); } split( //, $encoded );
229 my $l = ( $#s + 1 ) % 4;
232 # warn "Error: Cuecat decode parsing failed!";
240 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
242 chr( ( $n >> 16 ) ^ 67 )
243 .chr( ( $n >> 8 & 255 ) ^ 67 )
244 .chr( ( $n & 255 ) ^ 67 );
247 $r = substr( $r, 0, length($r) - $l );
253 ($dotransfer, $messages, $iteminformation) = &transferbook({
254 from_branch => $frombranch
255 to_branch => $tobranch,
257 ignore_reserves => $ignore_reserves,
261 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
263 C<$fbr> is the code for the branch initiating the transfer.
264 C<$tbr> is the code for the branch to which the item should be transferred.
266 C<$barcode> is the barcode of the item to be transferred.
268 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
269 Otherwise, if an item is reserved, the transfer fails.
271 C<$trigger> is the enum value for what triggered the transfer.
273 Returns three values:
279 is true if the transfer was successful.
283 is a reference-to-hash which may have any of the following keys:
289 There is no item in the catalog with the given barcode. The value is C<$barcode>.
291 =item C<DestinationEqualsHolding>
293 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
297 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
301 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
303 =item C<WasTransferred>
305 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
307 =item C<RecallPlacedAtHoldingBranch>
309 A recall for this item was found, and the transfer has already been completed as the item's branch matches the recall's pickup branch.
313 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
323 my $tbr = $params->{to_branch};
324 my $fbr = $params->{from_branch};
325 my $ignoreRs = $params->{ignore_reserves};
326 my $barcode = $params->{barcode};
327 my $trigger = $params->{trigger};
330 my $item = Koha::Items->find( { barcode => $barcode } );
332 Koha::Exceptions::MissingParameter->throw(
333 "Missing mandatory parameter: from_branch")
336 Koha::Exceptions::MissingParameter->throw(
337 "Missing mandatory parameter: to_branch")
342 $messages->{'BadBarcode'} = $barcode;
344 return ( $dotransfer, $messages );
347 my $itemnumber = $item->itemnumber;
348 # get branches of book...
349 my $hbr = $item->homebranch;
351 # if using Branch Transfer Limits
352 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
353 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
354 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
355 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
356 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
359 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
360 $messages->{'NotAllowed'} = $tbr . "::" . $code;
365 # can't transfer book if is already there....
366 if ( $fbr eq $tbr ) {
367 $messages->{'DestinationEqualsHolding'} = 1;
371 # check if it is still issued to someone, return it...
372 my $issue = $item->checkout;
374 AddReturn( $barcode, $fbr );
375 $messages->{'WasReturned'} = $issue->borrowernumber;
379 # That'll save a database query.
380 my ( $resfound, $resrec, undef ) =
381 CheckReserves( $item );
383 $resrec->{'ResFound'} = $resfound;
384 $messages->{'ResFound'} = $resrec;
385 $dotransfer = 0 unless $ignoreRs;
389 if ( C4::Context->preference('UseRecalls') ) {
390 my $recall = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
391 if ( defined $recall ) {
392 # do a transfer if the recall branch is different to the item holding branch
393 if ( $recall->pickup_library_id eq $fbr ) {
395 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
398 $messages->{'RecallFound'} = $recall;
403 #actually do the transfer....
405 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
407 # don't need to update MARC anymore, we do it in batch now
408 $messages->{'WasTransfered'} = $tbr;
411 ModDateLastSeen( $itemnumber );
412 return ( $dotransfer, $messages );
417 my ($patron, $item, $params) = @_;
418 my $onsite_checkout = $params->{onsite_checkout} || 0;
419 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
420 my $cat_borrower = $patron->categorycode;
421 my $dbh = C4::Context->dbh;
422 # Get which branchcode we need
423 my $branch = _GetCircControlBranch($item, $patron);
424 my $type = $item->effective_itemtype;
426 my ($type_object, $parent_type, $parent_maxissueqty_rule);
427 $type_object = Koha::ItemTypes->find( $type );
428 $parent_type = $type_object->parent_type if $type_object;
429 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
430 # Find any children if we are a parent_type;
432 # given branch, patron category, and item type, determine
433 # applicable issuing rule
435 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
437 categorycode => $cat_borrower,
438 itemtype => $parent_type,
439 branchcode => $branch,
440 rule_name => 'maxissueqty',
443 # If the parent rule is for default type we discount it
444 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
446 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
448 categorycode => $cat_borrower,
450 branchcode => $branch,
451 rule_name => 'maxissueqty',
455 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
457 categorycode => $cat_borrower,
459 branchcode => $branch,
460 rule_name => 'maxonsiteissueqty',
464 # if a rule is found and has a loan limit set, count
465 # how many loans the patron already has that meet that
467 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
470 if ( $maxissueqty_rule->branchcode ) {
471 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
472 $checkouts = $patron->checkouts->search(
473 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
474 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
475 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
477 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
478 $checkouts = $patron->checkouts->search(
479 { "item.$branch_type" => $maxissueqty_rule->branchcode } );
482 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
484 $checkouts = $checkouts->search(undef, { prefetch => 'item' });
487 my $rule_itemtype = $maxissueqty_rule->itemtype;
490 unless ( $rule_itemtype ) {
491 # matching rule has the default item type, so count only
492 # those existing loans that don't fall under a more
494 @types = Koha::CirculationRules->search(
496 branchcode => $maxissueqty_rule->branchcode,
497 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
498 itemtype => { '!=' => undef },
499 rule_name => 'maxissueqty'
501 )->get_column('itemtype');
503 if ( $parent_maxissueqty_rule ) {
504 # if we have a parent item type then we count loans of the
505 # specific item type or its siblings or parent
506 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
507 @types = $children->get_column('itemtype');
508 push @types, $parent_type;
509 } elsif ( $child_types ) {
510 # If we are a parent type, we need to count all child types and our own type
511 @types = $child_types->get_column('itemtype');
512 push @types, $type; # And don't forget to count our own types
514 # Otherwise only count the specific itemtype
519 while ( my $c = $checkouts->next ) {
520 my $itemtype = $c->item->effective_itemtype;
522 unless ( $rule_itemtype ) {
523 next if grep {$_ eq $itemtype} @types;
525 next unless grep {$_ eq $itemtype} @types;
528 $sum_checkouts->{total}++;
529 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
530 $sum_checkouts->{itemtype}->{$itemtype}++;
533 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
534 my $checkout_count = $sum_checkouts->{total} || 0;
535 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
537 my $checkout_rules = {
538 checkout_count => $checkout_count,
539 onsite_checkout_count => $onsite_checkout_count,
540 onsite_checkout => $onsite_checkout,
541 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
542 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
543 switch_onsite_checkout => $switch_onsite_checkout,
545 # If parent rules exists
546 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
547 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
548 my $qty_over = _check_max_qty($checkout_rules);
549 return $qty_over if defined $qty_over;
551 # If the parent rule is less than or equal to the child, we only need check the parent
552 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
553 $checkout_rules->{checkout_count} = $checkout_count_type;
554 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
555 my $qty_over = _check_max_qty($checkout_rules);
556 return $qty_over if defined $qty_over;
559 my $qty_over = _check_max_qty($checkout_rules);
560 return $qty_over if defined $qty_over;
564 # Now count total loans against the limit for the branch
565 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
566 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
568 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
569 $checkouts = $patron->checkouts->search(
570 { 'me.branchcode' => $branch} );
571 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
572 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
574 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
575 $checkouts = $patron->checkouts->search(
576 { "item.$branch_type" => $branch},
577 { prefetch => 'item' } );
580 my $checkout_count = $checkouts->count;
581 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
582 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
583 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
585 my $qty_over = _check_max_qty(
587 checkout_count => $checkout_count,
588 onsite_checkout_count => $onsite_checkout_count,
589 onsite_checkout => $onsite_checkout,
590 max_checkouts_allowed => $max_checkouts_allowed,
591 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
592 switch_onsite_checkout => $switch_onsite_checkout
595 return $qty_over if defined $qty_over;
598 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
599 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
602 # OK, the patron can issue !!!
608 my $checkout_count = $params->{checkout_count};
609 my $onsite_checkout_count = $params->{onsite_checkout_count};
610 my $onsite_checkout = $params->{onsite_checkout};
611 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
612 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
613 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
615 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
616 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
617 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
619 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
620 count => $onsite_checkout_count,
621 max_allowed => $max_onsite_checkouts_allowed,
625 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
626 if ( $max_checkouts_allowed eq '' ) { return; }
627 my $delta = $switch_onsite_checkout ? 1 : 0;
628 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
630 reason => 'TOO_MANY_CHECKOUTS',
631 count => $checkout_count,
632 max_allowed => $max_checkouts_allowed,
636 elsif ( not $onsite_checkout ) {
637 if ( $max_checkouts_allowed eq '' ) { return; }
639 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
642 reason => 'TOO_MANY_CHECKOUTS',
643 count => $checkout_count - $onsite_checkout_count,
644 max_allowed => $max_checkouts_allowed,
652 =head2 CanBookBeIssued
654 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
655 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
657 Check if a book can be issued.
659 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
661 IMPORTANT: The assumption by users of this routine is that causes blocking
662 the issue are keyed by uppercase labels and other returned
663 data is keyed in lower case!
667 =item C<$patron> is a Koha::Patron
669 =item C<$barcode> is the bar code of the book being issued.
671 =item C<$duedates> is a DateTime object.
673 =item C<$inprocess> boolean switch
675 =item C<$ignore_reserves> boolean switch
677 =item C<$params> Hashref of additional parameters
680 override_high_holds - Ignore high holds
681 onsite_checkout - Checkout is an onsite checkout that will not leave the library
682 item - Optionally pass the object for the item we are checking out to save a lookup
690 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
691 Possible values are :
697 sticky due date is invalid
701 borrower gone with no address
705 borrower declared it's card lost
711 =head3 UNKNOWN_BARCODE
725 item is restricted (set by ??)
727 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
728 could be prevented, but ones that can be overriden by the operator.
730 Possible values are :
738 renewing, not issuing
740 =head3 ISSUED_TO_ANOTHER
742 issued to someone else.
746 reserved for someone else.
750 reserved and being transferred for someone else.
754 sticky due date is invalid or due date in the past
758 if the borrower borrows to much things
762 recalled by someone else
766 sub CanBookBeIssued {
767 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
768 my %needsconfirmation; # filled with problems that needs confirmations
769 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
770 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
771 my %messages; # filled with information messages that should be displayed.
773 my $onsite_checkout = $params->{onsite_checkout} || 0;
774 my $override_high_holds = $params->{override_high_holds} || 0;
776 my $item_object = $params->{item}
777 // Koha::Items->find( { barcode => $barcode } );
779 # MANDATORY CHECKS - unless item exists, nothing else matters
780 unless ( $item_object ) {
781 $issuingimpossible{UNKNOWN_BARCODE} = 1;
783 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
785 my $item_unblessed = $item_object->unblessed; # Transition...
786 my $issue = $item_object->checkout;
787 my $biblio = $item_object->biblio;
789 my $biblioitem = $biblio->biblioitem;
790 my $effective_itemtype = $item_object->effective_itemtype;
791 my $dbh = C4::Context->dbh;
792 my $patron_unblessed = $patron->unblessed;
794 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
796 my $now = dt_from_string();
797 $duedate ||= CalcDateDue( $now, $effective_itemtype, $circ_library->branchcode, $patron );
798 if (DateTime->compare($duedate,$now) == -1 ) { # duedate cannot be before now
799 $needsconfirmation{INVALID_DATE} = $duedate;
802 my $fees = Koha::Charges::Fees->new(
805 library => $circ_library,
806 item => $item_object,
814 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
815 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
816 C4::Stats::UpdateStats(
818 branch => C4::Context->userenv->{'branch'},
820 itemnumber => $item_object->itemnumber,
821 itemtype => $effective_itemtype,
822 borrowernumber => $patron->borrowernumber,
823 ccode => $item_object->ccode,
824 categorycode => $patron->categorycode,
825 location => $item_object->location,
826 interface => C4::Context->interface,
829 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
830 return( { STATS => 1 }, {});
833 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
834 $issuingimpossible{GNA} = 1;
837 if ( $patron->lost && $patron->lost == 1 ) {
838 $issuingimpossible{CARD_LOST} = 1;
840 if ( $patron->is_debarred ) {
841 $issuingimpossible{DEBARRED} = 1;
844 if ( $patron->is_expired ) {
845 $issuingimpossible{EXPIRED} = 1;
853 my $account = $patron->account;
854 my $balance = $account->balance;
855 my $non_issues_charges = $account->non_issues_charges;
856 my $other_charges = $balance - $non_issues_charges;
858 my $amountlimit = C4::Context->preference("noissuescharge");
859 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
860 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
862 # Check the debt of this patrons guarantees
863 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
864 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
865 if ( defined $no_issues_charge_guarantees ) {
866 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
867 my $guarantees_non_issues_charges = 0;
868 foreach my $g ( @guarantees ) {
869 $guarantees_non_issues_charges += $g->account->non_issues_charges;
872 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
873 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
874 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
875 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
876 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
877 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
881 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
882 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
883 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
884 if ( defined $no_issues_charge_guarantors ) {
885 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
887 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
888 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
889 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
890 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
891 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
892 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
896 if ( C4::Context->preference("IssuingInProcess") ) {
897 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
898 $issuingimpossible{DEBT} = $non_issues_charges;
899 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
900 $needsconfirmation{DEBT} = $non_issues_charges;
901 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
902 $needsconfirmation{DEBT} = $non_issues_charges;
906 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
907 $needsconfirmation{DEBT} = $non_issues_charges;
908 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
909 $issuingimpossible{DEBT} = $non_issues_charges;
910 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
911 $needsconfirmation{DEBT} = $non_issues_charges;
915 if ($balance > 0 && $other_charges > 0) {
916 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
919 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
920 $patron_unblessed = $patron->unblessed;
922 if ( my $debarred_date = $patron->is_debarred ) {
923 # patron has accrued fine days or has a restriction. $count is a date
924 if ($debarred_date eq '9999-12-31') {
925 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
928 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
930 } elsif ( my $num_overdues = $patron->has_overdues ) {
931 ## patron has outstanding overdue loans
932 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
933 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
935 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
936 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
940 # Additional Materials Check
941 if ( C4::Context->preference("CircConfirmItemParts")
942 && $item_object->materials )
944 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
948 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
950 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
952 # Already issued to current borrower.
953 # If it is an on-site checkout if it can be switched to a normal checkout
954 # or ask whether the loan should be renewed
956 if ( $issue->onsite_checkout
957 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
958 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
960 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed($patron, $issue);
961 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
962 if ( $renewerror eq 'onsite_checkout' ) {
963 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
966 $issuingimpossible{NO_MORE_RENEWALS} = 1;
970 $needsconfirmation{RENEW_ISSUE} = 1;
976 # issued to someone else
978 my $patron = Koha::Patrons->find( $issue->borrowernumber );
980 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
982 if ( !$can_be_returned ) {
983 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
984 $issuingimpossible{branch_to_return} = $message;
986 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
987 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
990 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
991 $needsconfirmation{issued_firstname} = $patron->firstname;
992 $needsconfirmation{issued_surname} = $patron->surname;
993 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
994 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
999 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1001 my $switch_onsite_checkout = (
1002 C4::Context->preference('SwitchOnSiteCheckouts')
1004 and $issue->onsite_checkout
1005 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1006 my $toomany = TooMany( $patron, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1007 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1008 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1009 if ( $toomany->{max_allowed} == 0 ) {
1010 $needsconfirmation{PATRON_CANT} = 1;
1012 if ( C4::Context->preference("AllowTooManyOverride") ) {
1013 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1014 $needsconfirmation{current_loan_count} = $toomany->{count};
1015 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1017 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1018 $issuingimpossible{current_loan_count} = $toomany->{count};
1019 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1024 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1026 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1027 if ( $patron->wants_check_for_previous_checkout && $patron->do_check_for_previous_checkout($item_unblessed) ) {
1028 $needsconfirmation{PREVISSUE} = 1;
1034 if ( $item_object->notforloan )
1036 if(!C4::Context->preference("AllowNotForLoanOverride")){
1037 $issuingimpossible{NOT_FOR_LOAN} = 1;
1038 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1040 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1041 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1045 # we have to check itemtypes.notforloan also
1046 if (C4::Context->preference('item-level_itypes')){
1047 # this should probably be a subroutine
1048 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1049 $sth->execute($effective_itemtype);
1050 my $notforloan=$sth->fetchrow_hashref();
1051 if ($notforloan->{'notforloan'}) {
1052 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1053 $issuingimpossible{NOT_FOR_LOAN} = 1;
1054 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1056 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1057 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1062 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1063 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1064 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1065 $issuingimpossible{NOT_FOR_LOAN} = 1;
1066 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1068 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1069 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1074 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1076 $issuingimpossible{WTHDRAWN} = 1;
1078 if ( $item_object->restricted
1079 && $item_object->restricted == 1 )
1081 $issuingimpossible{RESTRICTED} = 1;
1083 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1084 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1085 my $code = $av->count ? $av->next->lib : '';
1086 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1087 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1089 if ( C4::Context->preference("IndependentBranches") ) {
1090 my $userenv = C4::Context->userenv;
1091 unless ( C4::Context->IsSuperLibrarian() ) {
1092 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1093 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1094 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1095 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1097 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1098 if ( $patron->branchcode ne $userenv->{branch} );
1103 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1105 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1106 if ($rentalConfirmation) {
1107 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1109 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1110 if ($itemtype_object) {
1111 my $accumulate_charge = $fees->accumulate_rentalcharge();
1112 if ( $accumulate_charge > 0 ) {
1113 $rentalCharge += $accumulate_charge;
1117 if ( $rentalCharge > 0 ) {
1118 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1123 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1124 # Only bother doing this if UseRecalls is enabled and the item is recallable
1125 # Don't look at recalls that are in transit
1126 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1127 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1129 foreach my $r ( @recalls ) {
1130 if ( $r->item_id and
1131 $r->item_id == $item_object->itemnumber and
1132 $r->patron_id == $patron->borrowernumber and
1133 ( $r->waiting or $r->requested ) ) {
1134 $messages{RECALLED} = $r->id;
1136 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1139 elsif ( $r->item_id and
1140 $r->item_id == $item_object->itemnumber and
1142 # recalled item is in transit
1143 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1145 elsif ( $r->item_level and
1146 $r->item_id == $item_object->itemnumber and
1147 $r->patron_id != $patron->borrowernumber and
1149 # this specific item has been recalled by a different patron
1150 $needsconfirmation{RECALLED} = $r;
1154 elsif ( !$r->item_level and
1155 $r->patron_id != $patron->borrowernumber and
1157 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1158 $needsconfirmation{RECALLED} = $r;
1165 unless ( $ignore_reserves and defined $recall ) {
1166 # See if the item is on reserve.
1167 my ( $restype, $res ) = CheckReserves( $item_object );
1169 my $resbor = $res->{'borrowernumber'};
1170 if ( $resbor ne $patron->borrowernumber ) {
1171 my $patron = Koha::Patrons->find( $resbor );
1172 if ( $restype eq "Waiting" )
1174 # The item is on reserve and waiting, but has been
1175 # reserved by some other patron.
1176 $needsconfirmation{RESERVE_WAITING} = 1;
1177 $needsconfirmation{'resfirstname'} = $patron->firstname;
1178 $needsconfirmation{'ressurname'} = $patron->surname;
1179 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1180 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1181 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1182 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1183 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1185 elsif ( $restype eq "Reserved" ) {
1186 # The item is on reserve for someone else.
1187 $needsconfirmation{RESERVED} = 1;
1188 $needsconfirmation{'resfirstname'} = $patron->firstname;
1189 $needsconfirmation{'ressurname'} = $patron->surname;
1190 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1191 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1192 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1193 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1194 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1196 elsif ( $restype eq "Transferred" ) {
1197 # The item is determined hold being transferred for someone else.
1198 $needsconfirmation{TRANSFERRED} = 1;
1199 $needsconfirmation{'resfirstname'} = $patron->firstname;
1200 $needsconfirmation{'ressurname'} = $patron->surname;
1201 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1202 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1203 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1204 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1205 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1207 elsif ( $restype eq "Processing" ) {
1208 # The item is determined hold being processed for someone else.
1209 $needsconfirmation{PROCESSING} = 1;
1210 $needsconfirmation{'resfirstname'} = $patron->firstname;
1211 $needsconfirmation{'ressurname'} = $patron->surname;
1212 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1213 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1214 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1215 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1216 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1222 ## CHECK AGE RESTRICTION
1223 my $agerestriction = $biblioitem->agerestriction;
1224 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1225 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1226 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1227 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1230 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1234 ## check for high holds decreasing loan period
1235 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1236 my $check = checkHighHolds( $item_object, $patron );
1238 if ( $check->{exceeded} ) {
1240 num_holds => $check->{outstanding},
1241 duration => $check->{duration},
1242 returndate => $check->{due_date},
1244 if ($override_high_holds) {
1245 $alerts{HIGHHOLDS} = $highholds;
1248 $needsconfirmation{HIGHHOLDS} = $highholds;
1254 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1255 # don't do the multiple loans per bib check if we've
1256 # already determined that we've got a loan on the same item
1257 !$issuingimpossible{NO_MORE_RENEWALS} &&
1258 !$needsconfirmation{RENEW_ISSUE}
1260 # Check if borrower has already issued an item from the same biblio
1261 # Only if it's not a subscription
1262 my $biblionumber = $item_object->biblionumber;
1263 require C4::Serials;
1264 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1265 unless ($is_a_subscription) {
1266 # FIXME Should be $patron->checkouts($args);
1267 my $checkouts = Koha::Checkouts->search(
1269 borrowernumber => $patron->borrowernumber,
1270 biblionumber => $biblionumber,
1276 # if we get here, we don't already have a loan on this item,
1277 # so if there are any loans on this bib, ask for confirmation
1278 if ( $checkouts->count ) {
1279 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1284 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1287 =head2 CanBookBeReturned
1289 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1291 Check whether the item can be returned to the provided branch
1295 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1297 =item C<$branch> is the branchcode where the return is taking place
1305 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1307 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1313 sub CanBookBeReturned {
1314 my ($item, $branch) = @_;
1315 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1317 # assume return is allowed to start
1321 # identify all cases where return is forbidden
1322 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1324 $message = $item->{'homebranch'};
1325 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1327 $message = $item->{'holdingbranch'};
1328 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1330 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1333 return ($allowed, $message);
1336 =head2 CheckHighHolds
1338 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1339 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1340 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1344 sub checkHighHolds {
1345 my ( $item, $patron ) = @_;
1346 my $branchcode = _GetCircControlBranch( $item, $patron );
1356 # Count holds on this record, ignoring the borrowers own holds as they would be filled by the checkout
1357 my $holds = Koha::Holds->search({
1358 biblionumber => $item->biblionumber,
1359 borrowernumber => { '!=' => $patron->borrowernumber }
1362 if ( $holds->count() ) {
1363 $return_data->{outstanding} = $holds->count();
1365 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1366 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1367 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1369 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1371 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1373 # static means just more than a given number of holds on the record
1375 # If the number of holds is not above the threshold, we can stop here
1376 if ( $holds->count() <= $decreaseLoanHighHoldsValue ) {
1377 return $return_data;
1380 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1382 # dynamic means X more than the number of holdable items on the record
1384 # let's get the items
1385 my @items = $holds->next()->biblio()->items()->as_list;
1387 # Remove any items with status defined to be ignored even if the would not make item unholdable
1388 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1389 @items = grep { !$_->$status } @items;
1392 # Remove any items that are not holdable for this patron
1393 # We need to ignore hold counts as the borrower's own hold that will be filled by the checkout
1394 # could prevent them from placing further holds
1395 @items = grep { CanItemBeReserved( $patron, $_, undef, { ignore_hold_counts => 1 } )->{status} eq 'OK' } @items;
1397 my $items_count = scalar @items;
1399 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1401 # If the number of holds is less than the count of items we have
1402 # plus the number of holds allowed above that count, we can stop here
1403 if ( $holds->count() <= $threshold ) {
1404 return $return_data;
1408 my $issuedate = dt_from_string();
1410 my $itype = $item->effective_itemtype;
1411 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1413 categorycode => $patron->categorycode,
1415 branchcode => $branchcode,
1418 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1420 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1422 my $rule = Koha::CirculationRules->get_effective_rule_value(
1424 categorycode => $patron->categorycode,
1425 itemtype => $item->effective_itemtype,
1426 branchcode => $branchcode,
1427 rule_name => 'decreaseloanholds',
1432 if ( defined($rule) && $rule ne '' ){
1433 # overrides decreaseLoanHighHoldsDuration syspref
1436 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1438 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1439 $reduced_datedue->set_hour($orig_due->hour);
1440 $reduced_datedue->set_minute($orig_due->minute);
1441 $reduced_datedue->truncate( to => 'minute' );
1443 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1444 $return_data->{exceeded} = 1;
1445 $return_data->{duration} = $duration;
1446 $return_data->{due_date} = $reduced_datedue;
1450 return $return_data;
1455 &AddIssue($patron, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1457 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1461 =item C<$patron> is a patron object.
1463 =item C<$barcode> is the barcode of the item being issued.
1465 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1466 Calculated if empty.
1468 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1470 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1473 AddIssue does the following things :
1475 - step 01: check that there is a borrowernumber & a barcode provided
1476 - check for RENEWAL (book issued & being issued to the same patron)
1477 - renewal YES = Calculate Charge & renew
1479 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1481 - fill reserve if reserve to this patron
1482 - cancel reserve or not, otherwise
1484 - fill recall if recall to this patron
1485 - cancel recall or not
1486 - revert recall's waiting status or not
1487 * TRANSFERT PENDING ?
1488 - complete the transfert
1496 my ( $patron, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1498 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1499 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1500 my $auto_renew = $params && $params->{auto_renew};
1501 my $cancel_recall = $params && $params->{cancel_recall};
1502 my $recall_id = $params && $params->{recall_id};
1503 my $dbh = C4::Context->dbh;
1504 my $barcodecheck = CheckValidBarcode($barcode);
1508 if ( $datedue && ref $datedue ne 'DateTime' ) {
1509 $datedue = dt_from_string($datedue);
1512 # $issuedate defaults to today.
1513 if ( !defined $issuedate ) {
1514 $issuedate = dt_from_string();
1517 if ( ref $issuedate ne 'DateTime' ) {
1518 $issuedate = dt_from_string($issuedate);
1523 # Stop here if the patron or barcode doesn't exist
1524 if ( $patron && $barcode && $barcodecheck ) {
1525 # find which item we issue
1526 my $item_object = Koha::Items->find({ barcode => $barcode })
1527 or return; # if we don't get an Item, abort.
1528 my $item_unblessed = $item_object->unblessed;
1530 my $branchcode = _GetCircControlBranch( $item_object, $patron );
1532 # get actual issuing if there is one
1533 my $actualissue = $item_object->checkout;
1535 # check if we just renew the issue.
1536 if ( $actualissue and $actualissue->borrowernumber eq $patron->borrowernumber
1537 and not $switch_onsite_checkout ) {
1538 $datedue = AddRenewal(
1540 borrowernumber => $patron->borrowernumber,
1541 itemnumber => $item_object->itemnumber,
1542 branch => $branchcode,
1543 datedue => $datedue,
1545 $issuedate, # here interpreted as the renewal date
1548 $issue = $item_object->checkout;
1553 my $itype = $item_object->effective_itemtype;
1554 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1558 # Check if we need to use an exact due date set by the ILL module
1559 if ( C4::Context->preference('ILLModule') ) {
1560 # Check if there is an ILL connected with the biblio of the item we are issuing
1561 my $ill_request = Koha::Illrequests->search({
1562 biblio_id => $item_object->biblionumber,
1563 borrowernumber => $patron->borrowernumber,
1565 due_date => { '!=', undef },
1568 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1569 my $ill_dt = dt_from_string( $ill_request->due_date );
1570 $ill_dt->set_hour(23);
1571 $ill_dt->set_minute(59);
1576 $datedue->truncate( to => 'minute' );
1578 my $library = Koha::Libraries->find( $branchcode );
1579 my $fees = Koha::Charges::Fees->new(
1582 library => $library,
1583 item => $item_object,
1584 to_date => $datedue,
1588 # it's NOT a renewal
1589 if ( $actualissue and not $switch_onsite_checkout ) {
1590 # This book is currently on loan, but not to the person
1591 # who wants to borrow it now. mark it returned before issuing to the new borrower
1592 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1593 return unless $allowed;
1594 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1595 # AddReturn certainly has side-effects, like onloan => undef
1596 $item_object->discard_changes;
1599 if ( C4::Context->preference('UseRecalls') ) {
1600 Koha::Recalls->move_recall(
1602 action => $cancel_recall,
1603 recall_id => $recall_id,
1604 item => $item_object,
1605 borrowernumber => $patron->borrowernumber,
1610 C4::Reserves::MoveReserve( $item_object->itemnumber, $patron->borrowernumber, $cancelreserve );
1612 # Starting process for transfer job (checking transfert and validate it if we have one)
1613 if ( my $transfer = $item_object->get_transfer ) {
1614 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1617 datearrived => dt_from_string,
1618 tobranch => C4::Context->userenv->{branch},
1619 comments => 'Forced branchtransfer'
1622 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1623 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1624 if ( $hold ) { # Is this really needed?
1625 $hold->set( { found => undef } )->store;
1626 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1631 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1632 unless ($auto_renew) {
1633 my $rule = Koha::CirculationRules->get_effective_rule_value(
1635 categorycode => $patron->categorycode,
1636 itemtype => $item_object->effective_itemtype,
1637 branchcode => $branchcode,
1638 rule_name => 'auto_renew'
1642 $auto_renew = $rule if defined $rule && $rule ne '';
1645 my $issue_attributes = {
1646 borrowernumber => $patron->borrowernumber,
1647 issuedate => $issuedate,
1648 date_due => $datedue,
1649 branchcode => C4::Context->userenv->{'branch'},
1650 onsite_checkout => $onsite_checkout,
1651 auto_renew => $auto_renew ? 1 : 0,
1654 # Get ID of logged in user. if called from a batch job,
1655 # no user session exists and C4::Context->userenv() returns
1656 # the scalar '0'. Only do this if the syspref says so
1657 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1658 my $userenv = C4::Context->userenv();
1659 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1661 $issue_attributes->{issuer_id} = $usernumber;
1665 # In the case that the borrower has an on-site checkout
1666 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1667 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1669 $issue->set($issue_attributes)->store;
1672 $issue = Koha::Checkout->new(
1674 itemnumber => $item_object->itemnumber,
1679 $issue->discard_changes;
1680 C4::Auth::track_login_daily( $patron->userid );
1681 if ( $item_object->location && $item_object->location eq 'CART'
1682 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1683 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1684 CartToShelf( $item_object->itemnumber );
1687 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1688 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1691 # Record if item was lost
1692 my $was_lost = $item_object->itemlost;
1694 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1695 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1696 $item_object->itemlost(0);
1697 $item_object->onloan($datedue->ymd());
1698 $item_object->datelastborrowed( dt_from_string()->ymd() );
1699 $item_object->datelastseen( dt_from_string() );
1700 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1702 # If the item was lost, it has now been found, charge the overdue if necessary
1704 if ( $item_object->{_charge} ) {
1705 $actualissue //= Koha::Old::Checkouts->search(
1706 { itemnumber => $item_object->itemnumber },
1708 order_by => { '-desc' => 'returndate' },
1712 unless ( $patron->branchcode ) {
1713 $patron = $actualissue->patron;
1715 _CalculateAndUpdateFine(
1717 issue => $actualissue,
1718 item => $item_unblessed,
1719 borrower => $patron->unblessed,
1720 return_date => $issuedate
1723 _FixOverduesOnReturn( $patron->borrowernumber,
1724 $item_object->itemnumber, undef, 'RENEWED' );
1728 # If it costs to borrow this book, charge it to the patron's account.
1729 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1730 if ( $charge && $charge > 0 ) {
1731 AddIssuingCharge( $issue, $charge, 'RENT' );
1734 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1735 if ( $itemtype_object ) {
1736 my $accumulate_charge = $fees->accumulate_rentalcharge();
1737 if ( $accumulate_charge > 0 ) {
1738 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1739 $charge += $accumulate_charge;
1740 $item_unblessed->{charge} = $charge;
1744 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckout');
1746 $yaml = "$yaml\n\n";
1749 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
1751 warn "Unable to parse UpdateNotForLoanStatusOnCheckout syspref : $@";
1754 foreach my $key ( keys %$rules ) {
1755 if ( $item_object->notforloan eq $key ) {
1756 $item_object->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
1763 # Record the fact that this book was issued.
1764 C4::Stats::UpdateStats(
1766 branch => C4::Context->userenv->{'branch'},
1767 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1769 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1770 itemnumber => $item_object->itemnumber,
1771 itemtype => $item_object->effective_itemtype,
1772 location => $item_object->location,
1773 borrowernumber => $patron->borrowernumber,
1774 ccode => $item_object->ccode,
1775 categorycode => $patron->categorycode
1779 # Send a checkout slip.
1780 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1782 branchcode => $branchcode,
1783 categorycode => $patron->categorycode,
1784 item_type => $item_object->effective_itemtype,
1785 notification => 'CHECKOUT',
1787 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1788 SendCirculationAlert(
1791 item => $item_object->unblessed,
1792 borrower => $patron->unblessed,
1793 branch => $branchcode,
1798 "CIRCULATION", "ISSUE",
1799 $patron->borrowernumber,
1800 $item_object->itemnumber,
1801 ) if C4::Context->preference("IssueLog");
1803 Koha::Plugins->call('after_circ_action', {
1804 action => 'checkout',
1806 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1807 checkout => $issue->get_from_storage
1811 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1813 biblio_ids => [ $item_object->biblionumber ]
1815 ) if C4::Context->preference('RealTimeHoldsQueue');
1821 =head2 GetLoanLength
1823 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1825 Get loan length for an itemtype, a borrower type and a branch
1830 my ( $categorycode, $itemtype, $branchcode ) = @_;
1832 # Initialize default values
1836 lengthunit => 'days',
1839 my $found = Koha::CirculationRules->get_effective_rules( {
1840 branchcode => $branchcode,
1841 categorycode => $categorycode,
1842 itemtype => $itemtype,
1851 foreach my $rule_name (keys %$found) {
1852 $rules->{$rule_name} = $found->{$rule_name};
1859 =head2 GetHardDueDate
1861 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1863 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1867 sub GetHardDueDate {
1868 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1870 my $rules = Koha::CirculationRules->get_effective_rules(
1872 categorycode => $borrowertype,
1873 itemtype => $itemtype,
1874 branchcode => $branchcode,
1875 rules => [ 'hardduedate', 'hardduedatecompare' ],
1879 if ( defined( $rules->{hardduedate} ) ) {
1880 if ( $rules->{hardduedate} ) {
1881 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1884 return ( undef, undef );
1889 =head2 GetBranchBorrowerCircRule
1891 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1893 Retrieves circulation rule attributes that apply to the given
1894 branch and patron category, regardless of item type.
1895 The return value is a hashref containing the following key:
1897 patron_maxissueqty - maximum number of loans that a
1898 patron of the given category can have at the given
1899 branch. If the value is undef, no limit.
1901 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1902 patron of the given category can have at the given
1903 branch. If the value is undef, no limit.
1905 This will check for different branch/category combinations in the following order:
1909 default branch and category
1911 If no rule has been found in the database, it will default to
1914 patron_maxissueqty - undef
1915 patron_maxonsiteissueqty - undef
1917 C<$branchcode> and C<$categorycode> should contain the
1918 literal branch code and patron category code, respectively - no
1923 sub GetBranchBorrowerCircRule {
1924 my ( $branchcode, $categorycode ) = @_;
1926 # Initialize default values
1928 patron_maxissueqty => undef,
1929 patron_maxonsiteissueqty => undef,
1933 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1934 my $rule = Koha::CirculationRules->get_effective_rule(
1936 categorycode => $categorycode,
1938 branchcode => $branchcode,
1939 rule_name => $rule_name,
1943 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1949 =head2 GetBranchItemRule
1951 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1953 Retrieves circulation rule attributes that apply to the given
1954 branch and item type, regardless of patron category.
1956 The return value is a hashref containing the following keys:
1958 holdallowed => Hold policy for this branch and itemtype. Possible values:
1959 not_allowed: No holds allowed.
1960 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1961 from_any_library: Holds allowed from any patron.
1962 from_local_hold_group: Holds allowed from libraries in hold group
1964 This searches branchitemrules in the following order:
1966 * Same branchcode and itemtype
1967 * Same branchcode, itemtype '*'
1968 * branchcode '*', same itemtype
1969 * branchcode and itemtype '*'
1971 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1975 sub GetBranchItemRule {
1976 my ( $branchcode, $itemtype ) = @_;
1979 my $rules = Koha::CirculationRules->get_effective_rules({
1980 branchcode => $branchcode,
1981 itemtype => $itemtype,
1982 rules => ['holdallowed', 'hold_fulfillment_policy']
1985 # built-in default circulation rule
1986 $rules->{holdallowed} //= 'from_any_library';
1987 $rules->{hold_fulfillment_policy} //= 'any';
1994 ($doreturn, $messages, $iteminformation, $borrower) =
1995 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
2001 =item C<$barcode> is the bar code of the book being returned.
2003 =item C<$branch> is the code of the branch where the book is being returned.
2005 =item C<$exemptfine> indicates that overdue charges for the item will be
2008 =item C<$return_date> allows the default return date to be overridden
2009 by the given return date. Optional.
2013 C<&AddReturn> returns a list of four items:
2015 C<$doreturn> is true iff the return succeeded.
2017 C<$messages> is a reference-to-hash giving feedback on the operation.
2018 The keys of the hash are:
2024 No item with this barcode exists. The value is C<$barcode>.
2028 The book is not currently on loan. The value is C<$barcode>.
2032 This book has been withdrawn/cancelled. The value should be ignored.
2034 =item C<Wrongbranch>
2036 This book has was returned to the wrong branch. The value is a hashref
2037 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2038 contain the branchcode of the incorrect and correct return library, respectively.
2042 The item was reserved. The value is a reference-to-hash whose keys are
2043 fields from the reserves table of the Koha database, and
2044 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2045 either C<Waiting>, C<Reserved>, or 0.
2047 =item C<WasReturned>
2049 Value 1 if return is successful.
2051 =item C<NeedsTransfer>
2053 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2055 =item C<RecallFound>
2057 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2058 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2061 =item C<TransferredRecall>
2063 This item has been transferred to this branch to fill a recall. The recall object is returned.
2067 C<$iteminformation> is a reference-to-hash, giving information about the
2068 returned item from the issues table.
2070 C<$borrower> is a reference-to-hash, giving information about the
2071 patron who last borrowed the book.
2076 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2078 if ($branch and not Koha::Libraries->find($branch)) {
2079 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2082 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2083 my $return_date_specified = !!$return_date;
2084 $return_date //= dt_from_string();
2088 my $validTransfer = 1;
2089 my $stat_type = 'return';
2091 # get information on item
2092 my $item = Koha::Items->find({ barcode => $barcode });
2094 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2097 my $itemnumber = $item->itemnumber;
2098 my $itemtype = $item->effective_itemtype;
2100 my $issue = $item->checkout;
2102 $patron = $issue->patron
2103 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2104 . Dumper($issue->unblessed) . "\n";
2106 $messages->{'NotIssued'} = $barcode;
2107 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2109 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2111 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2112 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2113 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2114 $messages->{'LocalUse'} = 1;
2115 $stat_type = 'localuse';
2119 if ( $item->withdrawn ) { # book has been cancelled
2120 $messages->{'withdrawn'} = 1;
2122 # In the case where we block return of withdrawn, we should completely block the return
2123 # without updating item statuses, so we exit early
2124 return ( 0, $messages, $issue, ( $patron ? $patron->unblessed : {} ))
2125 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2129 # full item data, but no borrowernumber or checkout info (no issue)
2130 my $hbr = Koha::CirculationRules->get_return_branch_policy($item);
2132 # check if returnbranch and homebranch belong to the same float group
2133 my $validate_float =
2134 Koha::Libraries->find( $item->homebranch )->validate_float_sibling( { branchcode => $branch } );
2136 # get the proper branch to which to return the item
2138 if ( $hbr eq 'noreturn' ) {
2139 $returnbranch = $branch;
2140 } elsif ( $hbr eq 'returnbylibrarygroup' ) {
2142 # if library isn't in same the float group, transfer item to homebranch
2143 $hbr = 'homebranch';
2144 $returnbranch = $validate_float ? $branch : $item->$hbr;
2146 $returnbranch = $item->$hbr;
2149 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2150 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2152 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2153 my $patron_unblessed = $patron ? $patron->unblessed : {};
2155 my $update_loc_rules = C4::Context->yaml_preference('UpdateItemLocationOnCheckin');
2156 if ($update_loc_rules) {
2157 if ( defined $update_loc_rules->{_ALL_} ) {
2158 if ( $update_loc_rules->{_ALL_} eq '_PERM_' ) {
2159 $update_loc_rules->{_ALL_} = $item->permanent_location;
2161 if ( $update_loc_rules->{_ALL_} eq '_BLANK_' ) {
2162 $update_loc_rules->{_ALL_} = '';
2166 defined $item->location
2167 && $item->location ne $update_loc_rules->{_ALL_}
2169 || ( !defined $item->location
2170 && $update_loc_rules->{_ALL_} ne "" )
2173 $messages->{'ItemLocationUpdated'} =
2174 { from => $item->location, to => $update_loc_rules->{_ALL_} };
2175 $item->location( $update_loc_rules->{_ALL_} )->store(
2178 skip_record_index => 1,
2179 skip_holds_queue => 1
2185 foreach my $key ( keys %$update_loc_rules ) {
2186 if ( $update_loc_rules->{$key} eq '_PERM_' ) {
2187 $update_loc_rules->{$key} = $item->permanent_location;
2189 elsif ( $update_loc_rules->{$key} eq '_BLANK_' ) {
2190 $update_loc_rules->{$key} = '';
2194 defined $item->location
2195 && $item->location eq $key
2196 && $item->location ne $update_loc_rules->{$key}
2198 || ( $key eq '_BLANK_'
2199 && ( !defined $item->location || $item->location eq '' )
2200 && $update_loc_rules->{$key} ne '' )
2203 $messages->{'ItemLocationUpdated'} = {
2204 from => $item->location,
2205 to => $update_loc_rules->{$key}
2207 $item->location( $update_loc_rules->{$key} )->store(
2210 skip_record_index => 1,
2211 skip_holds_queue => 1
2220 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2222 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2224 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2226 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2229 foreach my $key ( keys %$rules ) {
2230 if ( $item->notforloan eq $key ) {
2231 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2232 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 }) unless $rules->{$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) = 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,
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");
2489 # Check if this item belongs to a biblio record that is attached to an
2490 # ILL request, if it is we need to update the ILL request's status
2491 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2492 my $request = Koha::Illrequests->find(
2493 { biblio_id => $item->biblio->biblionumber }
2495 $request->status('RET') if $request;
2498 if ( C4::Context->preference('UseRecalls') ) {
2499 # all recalls that have triggered a transfer will have an allocated itemnumber
2500 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2501 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2502 $messages->{TransferredRecall} = $transfer_recall;
2506 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2507 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2508 && ( $doreturn or $messages->{'NotIssued'} )
2510 and ( $branch ne $returnbranch )
2511 and not $messages->{'WrongTransfer'}
2512 and not $messages->{'WasTransfered'}
2513 and not $messages->{TransferredRecall}
2514 and not $messages->{RecallNeedsTransfer} )
2516 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2517 if (C4::Context->preference("AutomaticItemReturn" ) or
2518 (C4::Context->preference("UseBranchTransferLimits") and
2519 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2521 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2522 $messages->{'WasTransfered'} = $returnbranch;
2523 $messages->{'TransferTrigger'} = $transfer_trigger;
2525 $messages->{'NeedsTransfer'} = $returnbranch;
2526 $messages->{'TransferTrigger'} = $transfer_trigger;
2530 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2531 my $claims = Koha::Checkouts::ReturnClaims->search(
2533 itemnumber => $item->id,
2534 resolution => undef,
2538 if ( $claims->count ) {
2539 $messages->{ReturnClaims} = $claims;
2543 # Check for bundle status
2544 if ( $item->in_bundle ) {
2545 my $host = $item->bundle_host;
2546 $messages->{InBundle} = $host;
2549 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2550 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2552 if ( $doreturn and $issue ) {
2553 my $checkin = Koha::Old::Checkouts->find($issue->id);
2555 Koha::Plugins->call('after_circ_action', {
2556 action => 'checkin',
2562 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2564 biblio_ids => [ $item->biblionumber ]
2566 ) if C4::Context->preference('RealTimeHoldsQueue');
2569 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2572 =head2 MarkIssueReturned
2574 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2576 Unconditionally marks an issue as being returned by
2577 moving the C<issues> row to C<old_issues> and
2578 setting C<returndate> to the current date.
2580 if C<$returndate> is specified (in iso format), it is used as the date
2583 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2584 the old_issue is immediately anonymised
2586 Ideally, this function would be internal to C<C4::Circulation>,
2587 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2588 and offline_circ/process_koc.pl.
2590 The last optional parameter allos passing skip_record_index to the item store call.
2594 sub MarkIssueReturned {
2595 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2597 # Retrieve the issue
2598 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2599 my $issue_branchcode = $issue->branchcode;
2601 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2603 my $issue_id = $issue->issue_id;
2605 my $schema = Koha::Database->schema;
2607 # FIXME Improve the return value and handle it from callers
2608 $schema->txn_do(sub {
2610 my $patron = Koha::Patrons->find( $borrowernumber );
2612 # Update the returndate value
2613 if ( $returndate ) {
2614 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2617 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2620 # Create the old_issues entry
2621 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2623 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2624 if ( $privacy && $privacy == 2) {
2625 $old_checkout->anonymize;
2628 # And finally delete the issue
2631 $issue->item->onloan(undef)->store(
2633 skip_record_index => $params->{skip_record_index},
2634 skip_holds_queue => $params->{skip_holds_queue}
2638 if ( C4::Context->preference('StoreLastBorrower') ) {
2639 my $item = Koha::Items->find( $itemnumber );
2640 $item->last_returned_by( $patron->borrowernumber )->store;
2643 # Possibly remove any OVERDUES related debarment
2644 my $overdue_restrictions = $patron->restrictions->search( { type => 'OVERDUES' } );
2645 if ( C4::Context->preference('AutoRemoveOverduesRestrictions') ne 'no' && $patron->is_debarred ) {
2646 my $remove_restrictions =
2647 C4::Context->preference('AutoRemoveOverduesRestrictions') eq 'when_no_overdue_causing_debarment'
2648 ? !$patron->has_restricting_overdues( { issue_branchcode => $issue_branchcode } )
2649 : !$patron->has_overdues;
2650 if ( $remove_restrictions && $overdue_restrictions->count ) {
2651 DelUniqueDebarment( { borrowernumber => $borrowernumber, type => 'OVERDUES' } );
2660 =head2 _debar_user_on_return
2662 _debar_user_on_return($patron, $item, $datedue, $returndate);
2664 C<$patron> patron object
2666 C<$item> item object
2668 C<$datedue> date due DateTime object
2670 C<$returndate> DateTime object representing the return time
2672 Internal function, called only by AddReturn that calculates and updates
2673 the user fine days, and debars them if necessary.
2675 Should only be called for overdue returns
2677 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2682 sub _calculate_new_debar_dt {
2683 my ( $patron, $item, $dt_due, $return_date ) = @_;
2685 my $branchcode = _GetCircControlBranch( $item, $patron );
2686 my $circcontrol = C4::Context->preference('CircControl');
2687 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2688 { categorycode => $patron->categorycode,
2689 itemtype => $item->effective_itemtype,
2690 branchcode => $branchcode,
2695 'maxsuspensiondays',
2696 'suspension_chargeperiod',
2700 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2701 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2702 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2704 return unless $finedays;
2706 # finedays is in days, so hourly loans must multiply by 24
2707 # thus 1 hour late equals 1 day suspension * finedays rate
2708 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2710 # grace period is measured in the same units as the loan
2712 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2714 my $deltadays = DateTime::Duration->new(
2715 days => $chargeable_units
2718 if ( $deltadays->subtract($grace)->is_positive() ) {
2719 my $suspension_days = $deltadays * $finedays;
2721 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2722 # No need to / 1 and do not consider / 0
2723 $suspension_days = DateTime::Duration->new(
2724 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2728 # If the max suspension days is < than the suspension days
2729 # the suspension days is limited to this maximum period.
2730 my $max_sd = $issuing_rule->{maxsuspensiondays};
2731 if ( defined $max_sd && $max_sd ne '' ) {
2732 $max_sd = DateTime::Duration->new( days => $max_sd );
2733 $suspension_days = $max_sd
2734 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2737 my ( $has_been_extended );
2738 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $patron->is_debarred ) {
2739 my $debarment = $patron->restrictions->search({type => 'SUSPENSION' },{rows => 1})->single;
2741 $return_date = dt_from_string( $debarment->expiration, 'sql' );
2742 $has_been_extended = 1;
2747 # Use the calendar or not to calculate the debarment date
2748 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2749 my $calendar = Koha::Calendar->new(
2750 branchcode => $branchcode,
2751 days_mode => 'Calendar'
2753 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2756 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2758 return $new_debar_dt;
2763 sub _debar_user_on_return {
2764 my ( $patron, $item, $dt_due, $return_date ) = @_;
2766 $return_date //= dt_from_string();
2768 my $new_debar_dt = _calculate_new_debar_dt($patron, $item, $dt_due, $return_date);
2770 return unless $new_debar_dt;
2772 Koha::Patron::Debarments::AddUniqueDebarment({
2773 borrowernumber => $patron->borrowernumber,
2774 expiration => $new_debar_dt->ymd(),
2775 type => 'SUSPENSION',
2777 # if borrower was already debarred but does not get an extra debarment
2778 my ($new_debarment_str, $is_a_reminder);
2779 if ( $patron->is_debarred ) {
2781 $new_debarment_str = $patron->debarred;
2783 $new_debarment_str = $new_debar_dt->ymd();
2785 # FIXME Should return a DateTime object
2786 return $new_debarment_str, $is_a_reminder;
2789 =head2 _FixOverduesOnReturn
2791 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2793 C<$borrowernumber> borrowernumber
2795 C<$itemnumber> itemnumber
2797 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2799 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2805 sub _FixOverduesOnReturn {
2806 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2807 unless( $borrowernumber ) {
2808 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2812 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2816 warn "_FixOverduesOnReturn() not supplied valid status";
2820 my $schema = Koha::Database->schema;
2822 my $result = $schema->txn_do(
2824 # check for overdue fine
2825 my $accountlines = Koha::Account::Lines->search(
2827 borrowernumber => $borrowernumber,
2828 itemnumber => $item,
2829 debit_type_code => 'OVERDUE',
2830 status => 'UNRETURNED'
2833 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2835 my $accountline = $accountlines->next;
2836 my $payments = $accountline->credits;
2838 my $amountoutstanding = $accountline->amountoutstanding;
2839 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2840 $accountline->delete;
2841 return 0; # no warning, we've just removed a zero value fine (backdated return)
2842 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2843 my $account = Koha::Account->new({patron_id => $borrowernumber});
2844 my $credit = $account->add_credit(
2846 amount => $amountoutstanding,
2847 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2848 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2849 interface => C4::Context->interface,
2855 $credit->apply({ debits => [ $accountline ] });
2857 if (C4::Context->preference("FinesLog")) {
2858 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2862 $accountline->status($status);
2863 return $accountline->store();
2870 =head2 _GetCircControlBranch
2872 my $circ_control_branch = _GetCircControlBranch($item, $patron);
2876 Return the library code to be used to determine which circulation
2877 policy applies to a transaction. Looks up the CircControl and
2878 HomeOrHoldingBranch system preferences.
2880 C<$item> is an item object.
2882 C<$patron> is a patron object.
2886 sub _GetCircControlBranch {
2887 my ($item, $patron) = @_;
2888 my $circcontrol = C4::Context->preference('CircControl');
2891 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2892 $branch = C4::Context->userenv->{'branch'};
2893 } elsif ($circcontrol eq 'PatronLibrary') {
2894 $branch = $patron->branchcode;
2896 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2897 $branch = $item->get_column($branchfield);
2898 # default to item home branch if holdingbranch is used
2899 # and is not defined
2900 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2901 $branch = $item->homebranch;
2907 =head2 GetUpcomingDueIssues
2909 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2913 sub GetUpcomingDueIssues {
2916 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2917 my $dbh = C4::Context->dbh;
2920 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2922 LEFT JOIN items USING (itemnumber)
2923 LEFT JOIN branches ON branches.branchcode =
2925 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2926 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2927 my @bind_parameters = ( $params->{'days_in_advance'} );
2929 my $sth = $dbh->prepare( $statement );
2930 $sth->execute( @bind_parameters );
2931 my $upcoming_dues = $sth->fetchall_arrayref({});
2933 return $upcoming_dues;
2936 =head2 CanBookBeRenewed
2938 ($ok,$error,$info) = &CanBookBeRenewed($patron, $issue, $override_limit);
2940 Find out whether a borrowed item may be renewed.
2942 C<$patron> is the patron who currently has the issue.
2944 C<$issue> is the checkout to renew.
2946 C<$override_limit>, if supplied with a true value, causes
2947 the limit on the number of times that the loan can be renewed
2948 (as controlled by the item type) to be ignored. Overriding also allows
2949 to renew sooner than "No renewal before" and to manually renew loans
2950 that are automatically renewed.
2952 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2953 item must currently be on loan to the specified borrower; renewals
2954 must be allowed for the item's type; and the borrower must not have
2955 already renewed the loan.
2956 $error will contain the reason the renewal can not proceed
2957 $info will contain a hash of additional info
2958 currently 'soonest_renew_date' if error is 'too soon'
2962 sub CanBookBeRenewed {
2963 my ( $patron, $issue, $override_limit, $cron ) = @_;
2965 my $auto_renew = "no";
2967 my $item = $issue->item;
2969 return ( 0, 'no_item' ) unless $item;
2970 return ( 0, 'no_checkout' ) unless $issue;
2971 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2972 return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2973 return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2975 # override_limit will override anything else except on_reserve
2976 unless ( $override_limit ){
2977 my $branchcode = _GetCircControlBranch( $item, $patron );
2978 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2980 categorycode => $patron->categorycode,
2981 itemtype => $item->effective_itemtype,
2982 branchcode => $branchcode,
2986 'unseen_renewals_allowed'
2991 return ( 0, "too_many" )
2992 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2994 return ( 0, "too_unseen" )
2995 if C4::Context->preference('UnseenRenewals') &&
2996 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2997 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2999 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
3000 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
3001 my $restricted = $patron->is_debarred;
3002 my $hasoverdues = $patron->has_overdues;
3004 if ( $restricted and $restrictionblockrenewing ) {
3005 return ( 0, 'restriction');
3006 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
3007 return ( 0, 'overdue');
3010 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
3013 branchcode => $branchcode,
3016 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
3017 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
3018 # extra notices being sent. Cron also implies no override
3019 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
3020 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
3021 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
3024 if ( C4::Context->preference('UseRecalls') ) {
3026 $recall = $item->check_recalls if $item->can_be_waiting_recall;
3027 if ( defined $recall ) {
3028 if ( $recall->item_level ) {
3029 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
3030 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
3032 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
3033 return ( 0, 'recalled' ) unless ( $recall->waiting );
3038 # There is an item level hold on this item, no other item can fill the hold
3039 return ( 0, "on_reserve" )
3040 if ( $item->current_holds->search( { non_priority => 0 } )->count );
3042 my $fillable_holds = Koha::Holds->search(
3044 biblionumber => $item->biblionumber,
3047 reservedate => { '<=' => \'NOW()' },
3051 if ( $fillable_holds->count ) {
3052 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
3053 my @possible_holds = $fillable_holds->as_list;
3055 # Get all other items that could possibly fill reserves
3056 # FIXME We could join reserves (or more tables) here to eliminate some checks later
3057 my @other_items = Koha::Items->search({
3058 biblionumber => $item->biblionumber,
3061 -not => { itemnumber => $item->itemnumber } })->as_list;
3063 return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
3066 foreach my $possible_hold (@possible_holds) {
3068 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
3070 # FIXME: We are not checking whether the item we are renewing can fill the hold
3072 foreach my $other_item (@other_items) {
3073 next if defined $matched_items{$other_item->itemnumber};
3074 next if IsItemOnHoldAndFound( $other_item->itemnumber );
3075 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef);
3076 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3077 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3078 # CanItemBeReserved checks 'rules' and 'policies' which means
3079 # items will fill holds at checkin that are rejected here
3081 $matched_items{$other_item->itemnumber} = 1;
3084 return ( 0, "on_reserve" ) unless $fillable;
3088 my ($status, $matched_reserve, $possible_reserves) = CheckReserves($item);
3089 return ( 0, "on_reserve" ) if $status;
3093 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3094 $soonest = GetSoonestRenewDate($patron, $issue);
3095 if ( $soonest > dt_from_string() ){
3096 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3099 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3101 return ( 1, undef );
3106 $new_date_due = AddRenewal({
3107 borrowernumber => $borrowernumber,
3108 itemnumber => $itemnumber,
3110 [datedue => $datedue],
3111 [lastreneweddate => $lastreneweddate],
3112 [skipfinecalc => $skipfinecalc],
3114 [automatic => $automatic],
3115 [skip_record_index => $skip_record_index]
3118 Renews a loan, returns the updated due date upon success.
3120 C<$borrowernumber> is the borrower number of the patron who currently
3123 C<$itemnumber> is the number of the item to renew.
3125 C<$branch> is the library where the renewal took place (if any).
3126 The library that controls the circ policies for the renewal is retrieved from the issues record.
3128 C<$datedue> can be a DateTime object used to set the due date.
3130 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3131 this parameter is not supplied, lastreneweddate is set to the current date.
3133 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3134 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3135 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3138 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3139 from the book's item type.
3141 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3142 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3143 fallback to a true value
3145 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3147 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3148 should be skipped for this renewal.
3155 my $borrowernumber = $params->{borrowernumber};
3156 my $itemnumber = $params->{itemnumber};
3157 return unless $itemnumber;
3159 my $branch = $params->{branch};
3160 my $datedue = $params->{datedue};
3161 my $lastreneweddate = $params->{lastreneweddate} // dt_from_string();
3162 my $skipfinecalc = $params->{skipfinecalc};
3163 my $seen = $params->{seen};
3164 my $automatic = $params->{automatic};
3165 my $skip_record_index = $params->{skip_record_index};
3167 # Fallback on a 'seen' renewal
3168 $seen = defined $seen && $seen == 0 ? 0 : 1;
3170 my $item_object = Koha::Items->find($itemnumber) or return;
3171 my $biblio = $item_object->biblio;
3172 my $issue = $item_object->checkout;
3173 my $item_unblessed = $item_object->unblessed;
3175 my $renewal_type = $automatic ? "Automatic" : "Manual";
3177 my $dbh = C4::Context->dbh;
3179 return unless $issue;
3181 $borrowernumber ||= $issue->borrowernumber;
3183 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3184 $datedue = dt_from_string($datedue, 'sql');
3187 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3188 my $patron_unblessed = $patron->unblessed;
3190 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
3192 my $schema = Koha::Database->schema;
3193 $schema->txn_do(sub{
3195 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3196 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3198 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3200 # If the due date wasn't specified, calculate it by adding the
3201 # book's loan length to today's date or the current due date
3202 # based on the value of the RenewalPeriodBase syspref.
3203 my $itemtype = $item_object->effective_itemtype;
3206 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3207 dt_from_string( $issue->date_due, 'sql' ) :
3209 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron, 'is a renewal');
3212 my $fees = Koha::Charges::Fees->new(
3215 library => $circ_library,
3216 item => $item_object,
3217 from_date => dt_from_string( $issue->date_due, 'sql' ),
3218 to_date => dt_from_string($datedue),
3222 # Increment the unseen renewals, if appropriate
3223 # We only do so if the syspref is enabled and
3224 # a maximum value has been set in the circ rules
3225 my $unseen_renewals = $issue->unseen_renewals;
3226 if (C4::Context->preference('UnseenRenewals')) {
3227 my $rule = Koha::CirculationRules->get_effective_rule(
3228 { categorycode => $patron->categorycode,
3229 itemtype => $item_object->effective_itemtype,
3230 branchcode => $circ_library->branchcode,
3231 rule_name => 'unseen_renewals_allowed'
3234 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3237 # If the renewal is seen, unseen should revert to 0
3238 $unseen_renewals = 0;
3242 # Update the issues record to have the new due date, and a new count
3243 # of how many times it has been renewed.
3244 my $renews = ( $issue->renewals_count || 0 ) + 1;
3245 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3248 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3251 Koha::Exceptions::Checkout::FailedRenewal->throw(
3252 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3256 # Update the renewal count on the item, and tell zebra to reindex
3257 $renews = ( $item_object->renewals || 0 ) + 1;
3258 $item_object->renewals($renews);
3259 $item_object->onloan($datedue);
3260 # Don't index as we are in a transaction, skip hardcoded here
3261 $item_object->store({ log_action => 0, skip_record_index => 1 });
3263 # Charge a new rental fee, if applicable
3264 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3265 if ( $charge > 0 ) {
3266 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3269 # Charge a new accumulate rental fee, if applicable
3270 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3271 if ( $itemtype_object ) {
3272 my $accumulate_charge = $fees->accumulate_rentalcharge();
3273 if ( $accumulate_charge > 0 ) {
3274 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3276 $charge += $accumulate_charge;
3279 # Send a renewal slip according to checkout alert preferencei
3280 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3281 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3283 branchcode => $branch,
3284 categorycode => $patron->categorycode,
3285 item_type => $itemtype,
3286 notification => 'CHECKOUT',
3288 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3289 SendCirculationAlert(
3292 item => $item_unblessed,
3293 borrower => $patron->unblessed,
3300 # Remove any OVERDUES related debarment if the borrower has no overdues
3301 my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3303 && $patron->is_debarred
3304 && ! $patron->has_overdues
3305 && $overdue_restrictions->count
3307 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3310 # Add renewal record
3311 my $renewal = Koha::Checkouts::Renewal->new(
3313 checkout_id => $issue->issue_id,
3314 interface => C4::Context->interface,
3315 renewal_type => $renewal_type,
3316 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3321 # Add the renewal to stats
3322 C4::Stats::UpdateStats(
3324 branch => $item_object->renewal_branchcode({branch => $branch}),
3327 itemnumber => $itemnumber,
3328 itemtype => $itemtype,
3329 location => $item_object->location,
3330 borrowernumber => $borrowernumber,
3331 ccode => $item_object->ccode,
3332 categorycode => $patron->categorycode,
3333 interface => C4::Context->interface,
3338 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3340 Koha::Plugins->call('after_circ_action', {
3341 action => 'renewal',
3343 checkout => $issue->get_from_storage
3348 unless( $skip_record_index ){
3349 # We index now, after the transaction is committed
3350 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3351 $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3358 # check renewal status
3359 my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3361 my $dbh = C4::Context->dbh;
3363 my $unseencount = 0;
3364 my $renewsallowed = 0;
3365 my $unseenallowed = 0;
3368 my $patron = blessed $borrowernumber_or_patron ?
3369 $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3370 my $item = blessed $itemnumber_or_item ?
3371 $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3373 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3375 # Look in the issues table for this item, lent to this borrower,
3376 # and not yet returned.
3378 # FIXME - I think this function could be redone to use only one SQL call.
3379 my $sth = $dbh->prepare(q{
3380 SELECT * FROM issues
3381 WHERE (borrowernumber = ?) AND (itemnumber = ?)
3383 $sth->execute( $patron->borrowernumber, $item->itemnumber );
3384 my $data = $sth->fetchrow_hashref;
3385 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3386 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3387 # $item and $borrower should be calculated
3388 my $branchcode = _GetCircControlBranch($item, $patron);
3390 my $rules = Koha::CirculationRules->get_effective_rules(
3392 categorycode => $patron->categorycode,
3393 itemtype => $item->effective_itemtype,
3394 branchcode => $branchcode,
3395 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3398 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3399 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3400 $rules->{unseen_renewals_allowed} :
3402 $renewsleft = $renewsallowed - $renewcount;
3403 $unseenleft = $unseenallowed - $unseencount;
3404 if($renewsleft < 0){ $renewsleft = 0; }
3405 if($unseenleft < 0){ $unseenleft = 0; }
3416 =head2 GetSoonestRenewDate
3418 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3420 Find out the soonest possible renew date of a borrowed item.
3422 C<$patron> is the patron who currently has the item on loan.
3424 C<$issue> is the the item issue.
3426 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3427 renew date, based on the value "No renewal before" of the applicable
3428 issuing rule. Returns the current date if the item can already be
3429 renewed, and returns undefined if the patron, item, or checkout
3434 sub GetSoonestRenewDate {
3435 my ( $patron, $issue ) = @_;
3436 return unless $issue;
3437 return unless $patron;
3439 my $item = $issue->item;
3440 return unless $item;
3442 my $dbh = C4::Context->dbh;
3444 my $branchcode = _GetCircControlBranch( $item, $patron );
3445 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3446 { categorycode => $patron->categorycode,
3447 itemtype => $item->effective_itemtype,
3448 branchcode => $branchcode,
3456 my $now = dt_from_string;
3458 if ( defined $issuing_rule->{norenewalbefore}
3459 and $issuing_rule->{norenewalbefore} ne "" )
3461 my $soonestrenewal =
3462 dt_from_string( $issue->date_due )->subtract(
3463 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3465 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3466 and $issuing_rule->{lengthunit} eq 'days' )
3468 $soonestrenewal->truncate( to => 'day' );
3470 return $soonestrenewal;
3471 } elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
3472 # Checkouts with auto-renewing fall back to due date
3473 my $soonestrenewal = dt_from_string( $issue->date_due );
3474 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3475 and $issuing_rule->{lengthunit} eq 'days' )
3477 $soonestrenewal->truncate( to => 'day' );
3479 return $soonestrenewal;
3484 =head2 GetLatestAutoRenewDate
3486 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3488 Find out the latest possible auto renew date of a borrowed item.
3490 C<$patron> is the patron who currently has the item on loan.
3492 C<$issue> is the item issue.
3494 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3495 auto renew date, based on the value "No auto renewal after" and the "No auto
3496 renewal after (hard limit) of the applicable issuing rule.
3497 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3498 or item cannot be found.
3502 sub GetLatestAutoRenewDate {
3503 my ( $patron, $issue ) = @_;
3504 return unless $issue;
3505 return unless $patron;
3507 my $item = $issue->item;
3508 return unless $item;
3510 my $dbh = C4::Context->dbh;
3511 my $branchcode = _GetCircControlBranch( $item, $patron );
3513 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3515 categorycode => $patron->categorycode,
3516 itemtype => $item->effective_itemtype,
3517 branchcode => $branchcode,
3519 'no_auto_renewal_after',
3520 'no_auto_renewal_after_hard_limit',
3526 return unless $circulation_rules;
3528 if ( not $circulation_rules->{no_auto_renewal_after}
3529 or $circulation_rules->{no_auto_renewal_after} eq '' )
3530 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3531 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3533 my $maximum_renewal_date;
3534 if ( $circulation_rules->{no_auto_renewal_after} ) {
3535 $maximum_renewal_date = dt_from_string($issue->issuedate);
3536 $maximum_renewal_date->add(
3537 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3541 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3542 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3543 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3545 return $maximum_renewal_date;
3549 =head2 GetIssuingCharges
3551 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3553 Calculate how much it would cost for a given patron to borrow a given
3554 item, including any applicable discounts.
3556 C<$itemnumber> is the item number of item the patron wishes to borrow.
3558 C<$borrowernumber> is the patron's borrower number.
3560 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3561 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3566 sub GetIssuingCharges {
3568 # calculate charges due
3569 my ( $itemnumber, $borrowernumber ) = @_;
3571 my $dbh = C4::Context->dbh;
3574 # Get the book's item type and rental charge (via its biblioitem).
3575 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3576 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3577 $charge_query .= (C4::Context->preference('item-level_itypes'))
3578 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3579 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3581 $charge_query .= ' WHERE items.itemnumber =?';
3583 my $sth = $dbh->prepare($charge_query);
3584 $sth->execute($itemnumber);
3586 if ( my $item_data = $sth->fetchrow_hashref ) {
3587 $item_type = $item_data->{itemtype};
3588 $charge = $item_data->{rentalcharge};
3590 # FIXME This should follow CircControl
3591 my $branch = C4::Context::mybranch();
3592 $patron //= Koha::Patrons->find( $borrowernumber );
3593 my $discount = Koha::CirculationRules->get_effective_rule({
3594 categorycode => $patron->categorycode,
3595 branchcode => $branch,
3596 itemtype => $item_type,
3597 rule_name => 'rentaldiscount'
3600 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3602 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3606 return ( $charge, $item_type );
3609 =head2 AddIssuingCharge
3611 &AddIssuingCharge( $checkout, $charge, $type )
3615 sub AddIssuingCharge {
3616 my ( $checkout, $charge, $type ) = @_;
3618 # FIXME What if checkout does not exist?
3620 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3621 my $accountline = $account->add_debit(
3625 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3626 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3627 interface => C4::Context->interface,
3629 item_id => $checkout->itemnumber,
3630 issue_id => $checkout->issue_id,
3635 =head2 GetTransfersFromTo
3637 @results = GetTransfersFromTo($frombranch,$tobranch);
3639 Returns the list of pending transfers between $from and $to branch
3643 sub GetTransfersFromTo {
3644 my ( $frombranch, $tobranch ) = @_;
3645 return unless ( $frombranch && $tobranch );
3646 my $dbh = C4::Context->dbh;
3648 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3649 FROM branchtransfers
3652 AND datecancelled IS NULL
3653 AND datesent IS NOT NULL
3654 AND datearrived IS NULL
3656 my $sth = $dbh->prepare($query);
3657 $sth->execute( $frombranch, $tobranch );
3660 while ( my $data = $sth->fetchrow_hashref ) {
3661 push @gettransfers, $data;
3663 return (@gettransfers);
3666 =head2 SendCirculationAlert
3668 Send out a C<check-in> or C<checkout> alert using the messaging system.
3676 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3680 Hashref of information about the item being checked in or out.
3684 Hashref of information about the borrower of the item.
3688 The branchcode from where the checkout or check-in took place.
3694 SendCirculationAlert({
3697 borrower => $borrower,
3703 sub SendCirculationAlert {
3705 my ($type, $item, $borrower, $branch, $issue) =
3706 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3707 my %message_name = (
3708 CHECKIN => 'Item_Check_in',
3709 CHECKOUT => 'Item_Checkout',
3710 RENEWAL => 'Item_Checkout',
3712 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3713 borrowernumber => $borrower->{borrowernumber},
3714 message_name => $message_name{$type},
3719 items => $item->{itemnumber},
3720 biblio => $item->{biblionumber},
3721 biblioitems => $item->{biblionumber},
3722 borrowers => $borrower,
3723 branches => $branch,
3726 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3727 # See C4::Letters:: _parseletter_sth
3728 if( $type eq 'CHECKIN' ){
3729 $tables->{old_issues} = $issue->issue_id;
3731 $tables->{issues} = $item->{itemnumber};
3734 my $schema = Koha::Database->new->schema;
3735 my @transports = keys %{ $borrower_preferences->{transports} };
3737 # From the MySQL doc:
3738 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3739 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3740 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3741 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3743 for my $mtt (@transports) {
3744 my $letter = C4::Letters::GetPreparedLetter (
3745 module => 'circulation',
3746 letter_code => $type,
3747 branchcode => $branch,
3748 message_transport_type => $mtt,
3749 lang => $borrower->{lang},
3753 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3754 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3755 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3756 unless ( $message ) {
3757 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3758 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3759 C4::Message->enqueue($letter, $patron, $mtt);
3761 $message->append($letter);
3764 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3770 =head2 updateWrongTransfer
3772 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3774 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
3778 sub updateWrongTransfer {
3779 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3781 # first step: cancel the original transfer
3782 my $item = Koha::Items->find($itemNumber);
3783 my $transfer = $item->get_transfer;
3784 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3786 # second step: create a new transfer to the right location
3787 my $new_transfer = $item->request_transfer(
3789 to => $transfer->to_library,
3790 reason => $transfer->reason,
3791 comment => $transfer->comments,
3797 return $new_transfer;
3802 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3804 this function calculates the due date given the start date and configured circulation rules,
3805 checking against the holidays calendar as per the daysmode circulation rule.
3806 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3807 C<$itemtype> = itemtype code of item in question
3808 C<$branch> = location whose calendar to use
3809 C<$patron> = Patron object
3810 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3815 my ( $startdate, $itemtype, $branch, $patron, $isrenewal ) = @_;
3819 # loanlength now a href
3821 GetLoanLength( $patron->categorycode, $itemtype, $branch );
3823 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3829 if (ref $startdate ne 'DateTime' ) {
3830 $datedue = dt_from_string($datedue);
3832 $datedue = $startdate->clone;
3835 $datedue = dt_from_string()->truncate( to => 'minute' );
3839 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3841 categorycode => $patron->categorycode,
3842 itemtype => $itemtype,
3843 branchcode => $branch,
3847 # calculate the datedue as normal
3848 if ( $daysmode eq 'Days' )
3849 { # ignoring calendar
3850 if ( $loanlength->{lengthunit} eq 'hours' ) {
3851 $datedue->add( hours => $loanlength->{$length_key} );
3853 $datedue->add( days => $loanlength->{$length_key} );
3854 $datedue->set_hour(23);
3855 $datedue->set_minute(59);
3859 if ($loanlength->{lengthunit} eq 'hours') {
3860 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3863 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3865 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3866 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3867 if ($loanlength->{lengthunit} eq 'days') {
3868 $datedue->set_hour(23);
3869 $datedue->set_minute(59);
3873 # if Hard Due Dates are used, retrieve them and apply as necessary
3874 my ( $hardduedate, $hardduedatecompare ) =
3875 GetHardDueDate( $patron->categorycode, $itemtype, $branch );
3876 if ($hardduedate) { # hardduedates are currently dates
3877 $hardduedate->truncate( to => 'minute' );
3878 $hardduedate->set_hour(23);
3879 $hardduedate->set_minute(59);
3880 my $cmp = DateTime->compare( $hardduedate, $datedue );
3882 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3883 # if the calculated date is before the 'after' Hard Due Date (floor), override
3884 # if the hard due date is set to 'exactly', overrride
3885 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3886 $datedue = $hardduedate->clone;
3889 # in all other cases, keep the date due as it is
3893 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3894 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3895 my $expiry_dt = dt_from_string( $patron->dateexpiry, 'iso', 'floating');
3896 if( $expiry_dt ) { #skip empty expiry date..
3897 $expiry_dt->set( hour => 23, minute => 59);
3898 my $d1= $datedue->clone->set_time_zone('floating');
3899 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3900 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3903 if ( $daysmode ne 'Days' ) {
3904 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3905 if ( $calendar->is_holiday($datedue) ) {
3906 # Don't return on a closed day
3907 $datedue = $calendar->prev_open_days( $datedue, 1 );
3916 sub CheckValidBarcode{
3918 my $dbh = C4::Context->dbh;
3919 my $query=qq|SELECT count(*)
3923 my $sth = $dbh->prepare($query);
3924 $sth->execute($barcode);
3925 my $exist=$sth->fetchrow ;
3929 =head2 IsBranchTransferAllowed
3931 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3933 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3935 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3936 Koha::Item->can_be_transferred.
3940 sub IsBranchTransferAllowed {
3941 my ( $toBranch, $fromBranch, $code ) = @_;
3943 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3945 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3946 my $dbh = C4::Context->dbh;
3948 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3949 $sth->execute( $toBranch, $fromBranch, $code );
3950 my $limit = $sth->fetchrow_hashref();
3952 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3953 if ( $limit->{'limitId'} ) {
3960 =head2 CreateBranchTransferLimit
3962 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3964 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3966 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3970 sub CreateBranchTransferLimit {
3971 my ( $toBranch, $fromBranch, $code ) = @_;
3972 return unless defined($toBranch) && defined($fromBranch);
3973 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3975 my $dbh = C4::Context->dbh;
3977 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3978 return $sth->execute( $code, $toBranch, $fromBranch );
3981 =head2 DeleteBranchTransferLimits
3983 my $result = DeleteBranchTransferLimits($frombranch);
3985 Deletes all the library transfer limits for one library. Returns the
3986 number of limits deleted, 0e0 if no limits were deleted, or undef if
3987 no arguments are supplied.
3989 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3990 fromBranch => $fromBranch
3995 sub DeleteBranchTransferLimits {
3997 return unless defined $branch;
3998 my $dbh = C4::Context->dbh;
3999 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
4000 return $sth->execute($branch);
4004 my ( $borrowernumber, $itemnum ) = @_;
4005 MarkIssueReturned( $borrowernumber, $itemnum );
4010 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
4012 The final optional parameter, C<$params>, expected to contain
4013 'skip_record_index' key, which relayed down to Koha::Item/store,
4014 there it prevents calling of ModZebra index_records,
4015 which takes most of the time in batch adds/deletes: index_records better
4016 to be called later in C<additem.pl> after the whole loop.
4019 skip_record_index => 1|0
4024 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
4026 unless ( $mark_lost_from ) {
4027 # Temporary check to avoid regressions
4028 die q|LostItem called without $mark_lost_from, check the API.|;
4032 if ( $force_mark_returned ) {
4035 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
4036 $mark_returned = ( $pref =~ m|$mark_lost_from| );
4039 my $dbh = C4::Context->dbh();
4040 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
4042 JOIN items USING (itemnumber)
4043 JOIN biblio USING (biblionumber)
4044 WHERE issues.itemnumber=?");
4045 $sth->execute($itemnumber);
4046 my $issues=$sth->fetchrow_hashref();
4048 # If a borrower lost the item, add a replacement cost to the their record
4049 if ( my $borrowernumber = $issues->{borrowernumber} ){
4050 my $patron = Koha::Patrons->find( $borrowernumber );
4052 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
4053 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
4055 if (C4::Context->preference('WhenLostChargeReplacementFee')){
4056 C4::Accounts::chargelostitem(
4059 $issues->{'replacementprice'},
4060 sprintf( "%s %s %s",
4061 $issues->{'title'} || q{},
4062 $issues->{'barcode'} || q{},
4063 $issues->{'itemcallnumber'} || q{},
4066 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4067 #warn " $issues->{'borrowernumber'} / $itemnumber ";
4070 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4073 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4074 my $item = Koha::Items->find($itemnumber);
4075 my $transfers = $item->get_transfers;
4076 while (my $transfer = $transfers->next) {
4077 $transfer->cancel({ reason => 'ItemLost', force => 1 });
4081 sub GetOfflineOperations {
4082 my $dbh = C4::Context->dbh;
4083 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4084 $sth->execute(C4::Context->userenv->{'branch'});
4085 my $results = $sth->fetchall_arrayref({});
4089 sub GetOfflineOperation {
4090 my $operationid = shift;
4091 return unless $operationid;
4092 my $dbh = C4::Context->dbh;
4093 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4094 $sth->execute( $operationid );
4095 return $sth->fetchrow_hashref;
4098 sub AddOfflineOperation {
4099 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4100 my $dbh = C4::Context->dbh;
4101 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4102 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4106 sub DeleteOfflineOperation {
4107 my $dbh = C4::Context->dbh;
4108 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4109 $sth->execute( shift );
4113 sub ProcessOfflineOperation {
4114 my $operation = shift;
4117 if ( $operation->{action} eq 'return' ) {
4118 $report = ProcessOfflineReturn( $operation );
4119 } elsif ( $operation->{action} eq 'issue' ) {
4120 $report = ProcessOfflineIssue( $operation );
4121 } elsif ( $operation->{action} eq 'payment' ) {
4122 $report = ProcessOfflinePayment( $operation );
4125 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4130 sub ProcessOfflineReturn {
4131 my $operation = shift;
4133 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4136 my $itemnumber = $item->itemnumber;
4137 my $issue = $item->checkout;
4139 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4140 ModDateLastSeen( $itemnumber, $leave_item_lost );
4142 $issue->borrowernumber,
4144 $operation->{timestamp},
4146 $item->onloan(undef);
4147 $item->store({ log_action => 0 });
4150 return "Item not issued.";
4153 return "Item not found.";
4157 sub ProcessOfflineIssue {
4158 my $operation = shift;
4160 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4163 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4165 return "Barcode not found.";
4167 my $itemnumber = $item->itemnumber;
4168 my $issue = $item->checkout;
4170 if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4172 $issue->borrowernumber,
4174 $operation->{timestamp},
4179 $operation->{'barcode'},
4182 $operation->{timestamp},
4187 return "Borrower not found.";
4191 sub ProcessOfflinePayment {
4192 my $operation = shift;
4194 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4196 $patron->account->pay(
4198 amount => $operation->{amount},
4199 library_id => $operation->{branchcode},
4209 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4211 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4216 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4220 ? Koha::Items->find($itemnumber)
4221 : Koha::Items->find( { barcode => $barcode } );
4225 return C4::Letters::GetPreparedLetter (
4226 module => 'circulation',
4227 letter_code => 'TRANSFERSLIP',
4228 branchcode => $branch,
4230 'branches' => $to_branch,
4231 'biblio' => $item->biblionumber,
4232 'items' => $item->unblessed,
4237 =head2 CheckIfIssuedToPatron
4239 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4241 Return 1 if any record item is issued to patron, otherwise return 0
4245 sub CheckIfIssuedToPatron {
4246 my ($borrowernumber, $biblionumber) = @_;
4248 my $dbh = C4::Context->dbh;
4250 SELECT COUNT(*) FROM issues
4251 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4252 WHERE items.biblionumber = ?
4253 AND issues.borrowernumber = ?
4255 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4256 return 1 if $is_issued;
4262 IsItemIssued( $itemnumber )
4264 Return 1 if the item is on loan, otherwise return 0
4269 my $itemnumber = shift;
4270 my $dbh = C4::Context->dbh;
4271 my $sth = $dbh->prepare(q{
4274 WHERE itemnumber = ?
4276 $sth->execute($itemnumber);
4277 return $sth->fetchrow;
4280 =head2 GetAgeRestriction
4282 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4283 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4285 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4286 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4288 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4289 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4290 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4291 Negative days mean the borrower has gone past the age restriction age.
4295 sub GetAgeRestriction {
4296 my ($record_restrictions, $borrower) = @_;
4297 my $markers = C4::Context->preference('AgeRestrictionMarker');
4299 return unless $record_restrictions;
4300 # Split $record_restrictions to something like FSK 16 or PEGI 6
4301 my @values = split ' ', uc($record_restrictions);
4302 return unless @values;
4304 # Search first occurrence of one of the markers
4305 my @markers = split /\|/, uc($markers);
4306 return unless @markers;
4309 my $restriction_year = 0;
4310 for my $value (@values) {
4312 for my $marker (@markers) {
4313 $marker =~ s/^\s+//; #remove leading spaces
4314 $marker =~ s/\s+$//; #remove trailing spaces
4315 if ( $marker eq $value ) {
4316 if ( $index <= $#values ) {
4317 $restriction_year += $values[$index];
4321 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4323 # Perhaps it is something like "K16" (as in Finland)
4324 $restriction_year += $1;
4328 last if ( $restriction_year > 0 );
4331 #Check if the borrower is age restricted for this material and for how long.
4332 if ($restriction_year && $borrower) {
4333 if ( $borrower->{'dateofbirth'} ) {
4334 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4335 $alloweddate[0] += $restriction_year;
4337 #Prevent runime eror on leap year (invalid date)
4338 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4339 $alloweddate[2] = 28;
4342 #Get how many days the borrower has to reach the age restriction
4343 my @Today = split /-/, dt_from_string()->ymd();
4344 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4345 #Negative days means the borrower went past the age restriction age
4346 return ($restriction_year, $daysToAgeRestriction);
4350 return ($restriction_year);
4354 =head2 GetPendingOnSiteCheckouts
4358 sub GetPendingOnSiteCheckouts {
4359 my $dbh = C4::Context->dbh;
4360 return $dbh->selectall_arrayref(q|
4366 items.itemcallnumber,
4370 issues.date_due < NOW() AS is_overdue,
4373 borrowers.firstname,
4375 borrowers.cardnumber,
4376 borrowers.borrowernumber
4378 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4379 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4380 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4381 WHERE issues.onsite_checkout = 1
4382 |, { Slice => {} } );
4388 my ($count, $branch, $itemtype, $ccode, $newness)
4389 = @$params{qw(count branch itemtype ccode newness)};
4391 my $dbh = C4::Context->dbh;
4394 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4395 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4396 i.ccode, SUM(i.issues) AS count
4398 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4399 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4402 my (@where_strs, @where_args);
4405 push @where_strs, 'i.homebranch = ?';
4406 push @where_args, $branch;
4409 if (C4::Context->preference('item-level_itypes')){
4410 push @where_strs, 'i.itype = ?';
4411 push @where_args, $itemtype;
4413 push @where_strs, 'bi.itemtype = ?';
4414 push @where_args, $itemtype;
4418 push @where_strs, 'i.ccode = ?';
4419 push @where_args, $ccode;
4422 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4423 push @where_args, $newness;
4427 $query .= 'WHERE ' . join(' AND ', @where_strs);
4431 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4432 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4437 $query .= q{ ) xxx WHERE count > 0 };
4438 $count = int($count);
4440 $query .= "LIMIT $count";
4443 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4448 =head2 Internal methods
4452 sub _CalculateAndUpdateFine {
4455 my $borrower = $params->{borrower};
4456 my $item = $params->{item};
4457 my $issue = $params->{issue};
4458 my $return_date = $params->{return_date};
4460 unless ($borrower) { carp "No borrower passed in!" && return; }
4461 unless ($item) { carp "No item passed in!" && return; }
4462 unless ($issue) { carp "No issue passed in!" && return; }
4464 my $datedue = dt_from_string( $issue->date_due );
4466 # we only need to calculate and change the fines if we want to do that on return
4467 # Should be on for hourly loans
4468 my $control = C4::Context->preference('CircControl');
4469 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4470 my $control_branchcode =
4471 ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4472 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4473 : $issue->branchcode;
4475 my $date_returned = $return_date ? $return_date : dt_from_string();
4477 my ( $amount, $unitcounttotal, $unitcount ) =
4478 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4480 if ( C4::Context->preference('finesMode') eq 'production' ) {
4481 if ( $amount > 0 ) {
4482 C4::Overdues::UpdateFine({
4483 issue_id => $issue->issue_id,
4484 itemnumber => $issue->itemnumber,
4485 borrowernumber => $issue->borrowernumber,
4490 elsif ($return_date) {
4492 # Backdated returns may have fines that shouldn't exist,
4493 # so in this case, we need to drop those fines to 0
4495 C4::Overdues::UpdateFine({
4496 issue_id => $issue->issue_id,
4497 itemnumber => $issue->itemnumber,
4498 borrowernumber => $issue->borrowernumber,
4506 sub _CanBookBeAutoRenewed {
4507 my ( $params ) = @_;
4508 my $patron = $params->{patron};
4509 my $item = $params->{item};
4510 my $branchcode = $params->{branchcode};
4511 my $issue = $params->{issue};
4513 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4515 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4517 categorycode => $patron->categorycode,
4518 itemtype => $item->effective_itemtype,
4519 branchcode => $branchcode,
4521 'no_auto_renewal_after',
4522 'no_auto_renewal_after_hard_limit',
4529 if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4530 return 'auto_account_expired';
4533 if ( defined $issuing_rule->{no_auto_renewal_after}
4534 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4535 # Get issue_date and add no_auto_renewal_after
4536 # If this is greater than today, it's too late for renewal.
4537 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4538 $maximum_renewal_date->add(
4539 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4541 my $now = dt_from_string;
4542 if ( $now >= $maximum_renewal_date ) {
4543 return "auto_too_late";
4546 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4547 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4548 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4549 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4550 return "auto_too_late";
4554 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4555 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4556 my $amountoutstanding =
4557 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4558 ? $patron->account->balance
4559 : $patron->account->outstanding_debits->total_outstanding;
4560 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4561 return "auto_too_much_oweing";
4565 my $soonest = GetSoonestRenewDate($patron, $issue);
4566 if ( $soonest > dt_from_string() )
4568 return ( "auto_too_soon", $soonest );
4581 Koha Development Team <http://koha-community.org/>