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 );
35 use C4::ItemCirculationAlertPreference;
38 use C4::Log; # logaction
39 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
40 use C4::RotatingCollections qw(GetCollectionItemBranches);
41 use Algorithm::CheckDigits;
45 use Koha::AuthorisedValues;
46 use Koha::Biblioitems;
50 use Koha::Illrequests;
53 use Koha::Patron::Debarments;
56 use Koha::Account::Lines;
58 use Koha::Account::Lines;
59 use Koha::Account::Offsets;
60 use Koha::Config::SysPrefs;
61 use Koha::Charges::Fees;
62 use Koha::Config::SysPref;
63 use Koha::Checkouts::ReturnClaims;
64 use Koha::SearchEngine::Indexer;
65 use Koha::Exceptions::Checkout;
67 use List::MoreUtils qw( uniq any );
68 use Scalar::Util qw( looks_like_number );
79 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
85 # FIXME subs that should probably be elsewhere
90 &GetPendingOnSiteCheckouts
93 # subs to deal with issuing a book
101 &GetLatestAutoRenewDate
103 &GetBranchBorrowerCircRule
106 &CheckIfIssuedToPatron
111 # subs to deal with returns
117 # subs to deal with transfers
124 &IsBranchTransferAllowed
125 &CreateBranchTransferLimit
126 &DeleteBranchTransferLimits
130 # subs to deal with offline circulation
132 &GetOfflineOperations
135 &DeleteOfflineOperation
136 &ProcessOfflineOperation
142 C4::Circulation - Koha circulation module
150 The functions in this module deal with circulation, issues, and
151 returns, as well as general information about the library.
152 Also deals with inventory.
158 $str = &barcodedecode($barcode, [$filter]);
160 Generic filter function for barcode string.
161 Called on every circ if the System Pref itemBarcodeInputFilter is set.
162 Will do some manipulation of the barcode for systems that deliver a barcode
163 to circulation.pl that differs from the barcode stored for the item.
164 For proper functioning of this filter, calling the function on the
165 correct barcode string (items.barcode) should return an unaltered barcode.
167 The optional $filter argument is to allow for testing or explicit
168 behavior that ignores the System Pref. Valid values are the same as the
173 # FIXME -- the &decode fcn below should be wrapped into this one.
174 # FIXME -- these plugins should be moved out of Circulation.pm
177 my ($barcode, $filter) = @_;
178 my $branch = C4::Context::mybranch();
179 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
180 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
181 if ($filter eq 'whitespace') {
183 } elsif ($filter eq 'cuecat') {
185 my @fields = split( /\./, $barcode );
186 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
187 ($#results == 2) and return $results[2];
188 } elsif ($filter eq 'T-prefix') {
189 if ($barcode =~ /^[Tt](\d)/) {
190 (defined($1) and $1 eq '0') and return $barcode;
191 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
193 return sprintf("T%07d", $barcode);
194 # FIXME: $barcode could be "T1", causing warning: substr outside of string
195 # Why drop the nonzero digit after the T?
196 # Why pass non-digits (or empty string) to "T%07d"?
197 } elsif ($filter eq 'libsuite8') {
198 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
199 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
200 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
202 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
205 } elsif ($filter eq 'EAN13') {
206 my $ean = CheckDigits('ean');
207 if ( $ean->is_valid($barcode) ) {
208 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
209 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
211 warn "# [$barcode] not valid EAN-13/UPC-A\n";
214 return $barcode; # return barcode, modified or not
219 $str = &_decode($chunk);
221 Decodes a segment of a string emitted by a CueCat barcode scanner and
224 FIXME: Should be replaced with Barcode::Cuecat from CPAN
225 or Javascript based decoding on the client side.
232 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
233 my @s = map { index( $seq, $_ ); } split( //, $encoded );
234 my $l = ( $#s + 1 ) % 4;
237 # warn "Error: Cuecat decode parsing failed!";
245 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
247 chr( ( $n >> 16 ) ^ 67 )
248 .chr( ( $n >> 8 & 255 ) ^ 67 )
249 .chr( ( $n & 255 ) ^ 67 );
252 $r = substr( $r, 0, length($r) - $l );
258 ($dotransfer, $messages, $iteminformation) = &transferbook({
259 from_branch => $frombranch
260 to_branch => $tobranch,
262 ignore_reserves => $ignore_reserves,
266 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
268 C<$fbr> is the code for the branch initiating the transfer.
269 C<$tbr> is the code for the branch to which the item should be transferred.
271 C<$barcode> is the barcode of the item to be transferred.
273 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
274 Otherwise, if an item is reserved, the transfer fails.
276 C<$trigger> is the enum value for what triggered the transfer.
278 Returns three values:
284 is true if the transfer was successful.
288 is a reference-to-hash which may have any of the following keys:
294 There is no item in the catalog with the given barcode. The value is C<$barcode>.
296 =item C<DestinationEqualsHolding>
298 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.
302 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.
306 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>.
308 =item C<WasTransferred>
310 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
320 my $tbr = $params->{to_branch};
321 my $fbr = $params->{from_branch};
322 my $ignoreRs = $params->{ignore_reserves};
323 my $barcode = $params->{barcode};
324 my $trigger = $params->{trigger};
327 my $item = Koha::Items->find( { barcode => $barcode } );
329 Koha::Exceptions::MissingParameter->throw(
330 "Missing mandatory parameter: from_branch")
333 Koha::Exceptions::MissingParameter->throw(
334 "Missing mandatory parameter: to_branch")
339 $messages->{'BadBarcode'} = $barcode;
341 return ( $dotransfer, $messages );
344 my $itemnumber = $item->itemnumber;
345 # get branches of book...
346 my $hbr = $item->homebranch;
348 # if using Branch Transfer Limits
349 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
350 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
351 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
352 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
353 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
356 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
357 $messages->{'NotAllowed'} = $tbr . "::" . $code;
362 # can't transfer book if is already there....
363 if ( $fbr eq $tbr ) {
364 $messages->{'DestinationEqualsHolding'} = 1;
368 # check if it is still issued to someone, return it...
369 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
371 AddReturn( $barcode, $fbr );
372 $messages->{'WasReturned'} = $issue->borrowernumber;
376 # That'll save a database query.
377 my ( $resfound, $resrec, undef ) =
378 CheckReserves( $itemnumber );
379 if ( $resfound and not $ignoreRs ) {
380 $resrec->{'ResFound'} = $resfound;
381 $messages->{'ResFound'} = $resrec;
385 #actually do the transfer....
387 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
389 # don't need to update MARC anymore, we do it in batch now
390 $messages->{'WasTransfered'} = $tbr;
393 ModDateLastSeen( $itemnumber );
394 return ( $dotransfer, $messages );
399 my $borrower = shift;
400 my $item_object = shift;
402 my $onsite_checkout = $params->{onsite_checkout} || 0;
403 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
404 my $cat_borrower = $borrower->{'categorycode'};
405 my $dbh = C4::Context->dbh;
406 # Get which branchcode we need
407 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
408 my $type = $item_object->effective_itemtype;
410 my ($type_object, $parent_type, $parent_maxissueqty_rule);
411 $type_object = Koha::ItemTypes->find( $type );
412 $parent_type = $type_object->parent_type if $type_object;
413 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
414 # Find any children if we are a parent_type;
416 # given branch, patron category, and item type, determine
417 # applicable issuing rule
419 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
421 categorycode => $cat_borrower,
422 itemtype => $parent_type,
423 branchcode => $branch,
424 rule_name => 'maxissueqty',
427 # If the parent rule is for default type we discount it
428 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
430 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
432 categorycode => $cat_borrower,
434 branchcode => $branch,
435 rule_name => 'maxissueqty',
439 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
441 categorycode => $cat_borrower,
443 branchcode => $branch,
444 rule_name => 'maxonsiteissueqty',
449 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
450 # if a rule is found and has a loan limit set, count
451 # how many loans the patron already has that meet that
453 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
456 if ( $maxissueqty_rule->branchcode ) {
457 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
458 $checkouts = $patron->checkouts->search(
459 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
460 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
461 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
463 $checkouts = $patron->checkouts->search(
464 { 'item.homebranch' => $maxissueqty_rule->branchcode },
465 { prefetch => 'item' } );
468 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
471 my $rule_itemtype = $maxissueqty_rule->itemtype;
472 while ( my $c = $checkouts->next ) {
473 my $itemtype = $c->item->effective_itemtype;
475 unless ( $rule_itemtype ) {
476 # matching rule has the default item type, so count only
477 # those existing loans that don't fall under a more
479 @types = Koha::CirculationRules->search(
481 branchcode => $maxissueqty_rule->branchcode,
482 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
483 itemtype => { '!=' => undef },
484 rule_name => 'maxissueqty'
486 )->get_column('itemtype');
488 next if grep {$_ eq $itemtype} @types;
491 if ( $parent_maxissueqty_rule ) {
492 # if we have a parent item type then we count loans of the
493 # specific item type or its siblings or parent
494 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
495 @types = $children->get_column('itemtype');
496 push @types, $parent_type;
497 } elsif ( $child_types ) {
498 # If we are a parent type, we need to count all child types and our own type
499 @types = $child_types->get_column('itemtype');
500 push @types, $type; # And don't forget to count our own types
501 } else { push @types, $type; } # Otherwise only count the specific itemtype
503 next unless grep {$_ eq $itemtype} @types;
505 $sum_checkouts->{total}++;
506 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
507 $sum_checkouts->{itemtype}->{$itemtype}++;
510 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
511 my $checkout_count = $sum_checkouts->{total} || 0;
512 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
514 my $checkout_rules = {
515 checkout_count => $checkout_count,
516 onsite_checkout_count => $onsite_checkout_count,
517 onsite_checkout => $onsite_checkout,
518 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
519 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
520 switch_onsite_checkout => $switch_onsite_checkout,
522 # If parent rules exists
523 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
524 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
525 my $qty_over = _check_max_qty($checkout_rules);
526 return $qty_over if defined $qty_over;
528 # If the parent rule is less than or equal to the child, we only need check the parent
529 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
530 $checkout_rules->{checkout_count} = $checkout_count_type;
531 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
532 my $qty_over = _check_max_qty($checkout_rules);
533 return $qty_over if defined $qty_over;
536 my $qty_over = _check_max_qty($checkout_rules);
537 return $qty_over if defined $qty_over;
541 # Now count total loans against the limit for the branch
542 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
543 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
545 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
546 $checkouts = $patron->checkouts->search(
547 { 'me.branchcode' => $branch} );
548 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
549 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
551 $checkouts = $patron->checkouts->search(
552 { 'item.homebranch' => $branch},
553 { prefetch => 'item' } );
556 my $checkout_count = $checkouts->count;
557 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
558 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
559 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
561 my $qty_over = _check_max_qty(
563 checkout_count => $checkout_count,
564 onsite_checkout_count => $onsite_checkout_count,
565 onsite_checkout => $onsite_checkout,
566 max_checkouts_allowed => $max_checkouts_allowed,
567 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
568 switch_onsite_checkout => $switch_onsite_checkout
571 return $qty_over if defined $qty_over;
574 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
575 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
578 # OK, the patron can issue !!!
584 my $checkout_count = $params->{checkout_count};
585 my $onsite_checkout_count = $params->{onsite_checkout_count};
586 my $onsite_checkout = $params->{onsite_checkout};
587 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
588 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
589 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
591 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
592 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
593 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
595 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
596 count => $onsite_checkout_count,
597 max_allowed => $max_onsite_checkouts_allowed,
601 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
602 if ( $max_checkouts_allowed eq '' ) { return; }
603 my $delta = $switch_onsite_checkout ? 1 : 0;
604 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
606 reason => 'TOO_MANY_CHECKOUTS',
607 count => $checkout_count,
608 max_allowed => $max_checkouts_allowed,
612 elsif ( not $onsite_checkout ) {
613 if ( $max_checkouts_allowed eq '' ) { return; }
615 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
618 reason => 'TOO_MANY_CHECKOUTS',
619 count => $checkout_count - $onsite_checkout_count,
620 max_allowed => $max_checkouts_allowed,
628 =head2 CanBookBeIssued
630 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
631 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
633 Check if a book can be issued.
635 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
637 IMPORTANT: The assumption by users of this routine is that causes blocking
638 the issue are keyed by uppercase labels and other returned
639 data is keyed in lower case!
643 =item C<$patron> is a Koha::Patron
645 =item C<$barcode> is the bar code of the book being issued.
647 =item C<$duedates> is a DateTime object.
649 =item C<$inprocess> boolean switch
651 =item C<$ignore_reserves> boolean switch
653 =item C<$params> Hashref of additional parameters
656 override_high_holds - Ignore high holds
657 onsite_checkout - Checkout is an onsite checkout that will not leave the library
665 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
666 Possible values are :
672 sticky due date is invalid
676 borrower gone with no address
680 borrower declared it's card lost
686 =head3 UNKNOWN_BARCODE
700 item is restricted (set by ??)
702 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
703 could be prevented, but ones that can be overriden by the operator.
705 Possible values are :
713 renewing, not issuing
715 =head3 ISSUED_TO_ANOTHER
717 issued to someone else.
721 reserved for someone else.
725 sticky due date is invalid or due date in the past
729 if the borrower borrows to much things
733 sub CanBookBeIssued {
734 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
735 my %needsconfirmation; # filled with problems that needs confirmations
736 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
737 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
738 my %messages; # filled with information messages that should be displayed.
740 my $onsite_checkout = $params->{onsite_checkout} || 0;
741 my $override_high_holds = $params->{override_high_holds} || 0;
743 my $item_object = Koha::Items->find({barcode => $barcode });
745 # MANDATORY CHECKS - unless item exists, nothing else matters
746 unless ( $item_object ) {
747 $issuingimpossible{UNKNOWN_BARCODE} = 1;
749 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
751 my $item_unblessed = $item_object->unblessed; # Transition...
752 my $issue = $item_object->checkout;
753 my $biblio = $item_object->biblio;
755 my $biblioitem = $biblio->biblioitem;
756 my $effective_itemtype = $item_object->effective_itemtype;
757 my $dbh = C4::Context->dbh;
758 my $patron_unblessed = $patron->unblessed;
760 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
762 # DUE DATE is OK ? -- should already have checked.
764 if ($duedate && ref $duedate ne 'DateTime') {
765 $duedate = dt_from_string($duedate);
767 my $now = dt_from_string();
768 unless ( $duedate ) {
769 my $issuedate = $now->clone();
771 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
773 # Offline circ calls AddIssue directly, doesn't run through here
774 # So issuingimpossible should be ok.
777 my $fees = Koha::Charges::Fees->new(
780 library => $circ_library,
781 item => $item_object,
787 my $today = $now->clone();
788 $today->truncate( to => 'minute');
789 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
790 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
793 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
799 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
800 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
802 branch => C4::Context->userenv->{'branch'},
804 itemnumber => $item_object->itemnumber,
805 itemtype => $effective_itemtype,
806 borrowernumber => $patron->borrowernumber,
807 ccode => $item_object->ccode}
809 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
810 return( { STATS => 1 }, {});
813 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
814 $issuingimpossible{GNA} = 1;
817 if ( $patron->lost && $patron->lost == 1 ) {
818 $issuingimpossible{CARD_LOST} = 1;
820 if ( $patron->is_debarred ) {
821 $issuingimpossible{DEBARRED} = 1;
824 if ( $patron->is_expired ) {
825 $issuingimpossible{EXPIRED} = 1;
833 my $account = $patron->account;
834 my $balance = $account->balance;
835 my $non_issues_charges = $account->non_issues_charges;
836 my $other_charges = $balance - $non_issues_charges;
838 my $amountlimit = C4::Context->preference("noissuescharge");
839 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
840 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
842 # Check the debt of this patrons guarantees
843 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
844 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
845 if ( defined $no_issues_charge_guarantees ) {
846 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
847 my $guarantees_non_issues_charges = 0;
848 foreach my $g ( @guarantees ) {
849 $guarantees_non_issues_charges += $g->account->non_issues_charges;
852 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
853 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
854 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
855 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
856 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
857 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
861 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
862 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
863 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
864 if ( defined $no_issues_charge_guarantors ) {
865 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
867 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
868 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
869 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
870 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
871 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
872 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
876 if ( C4::Context->preference("IssuingInProcess") ) {
877 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
878 $issuingimpossible{DEBT} = $non_issues_charges;
879 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
880 $needsconfirmation{DEBT} = $non_issues_charges;
881 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
882 $needsconfirmation{DEBT} = $non_issues_charges;
886 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
887 $needsconfirmation{DEBT} = $non_issues_charges;
888 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
889 $issuingimpossible{DEBT} = $non_issues_charges;
890 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
891 $needsconfirmation{DEBT} = $non_issues_charges;
895 if ($balance > 0 && $other_charges > 0) {
896 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
899 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
900 $patron_unblessed = $patron->unblessed;
902 if ( my $debarred_date = $patron->is_debarred ) {
903 # patron has accrued fine days or has a restriction. $count is a date
904 if ($debarred_date eq '9999-12-31') {
905 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
908 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
910 } elsif ( my $num_overdues = $patron->has_overdues ) {
911 ## patron has outstanding overdue loans
912 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
913 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
915 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
916 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
920 # Additional Materials Check
921 if ( C4::Context->preference("CircConfirmItemParts")
922 && $item_object->materials )
924 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
928 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
930 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
932 # Already issued to current borrower.
933 # If it is an on-site checkout if it can be switched to a normal checkout
934 # or ask whether the loan should be renewed
936 if ( $issue->onsite_checkout
937 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
938 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
940 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
941 $patron->borrowernumber,
942 $item_object->itemnumber,
944 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
945 if ( $renewerror eq 'onsite_checkout' ) {
946 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
949 $issuingimpossible{NO_MORE_RENEWALS} = 1;
953 $needsconfirmation{RENEW_ISSUE} = 1;
959 # issued to someone else
961 my $patron = Koha::Patrons->find( $issue->borrowernumber );
963 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
965 unless ( $can_be_returned ) {
966 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
967 $issuingimpossible{branch_to_return} = $message;
969 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
970 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
972 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
973 $needsconfirmation{issued_firstname} = $patron->firstname;
974 $needsconfirmation{issued_surname} = $patron->surname;
975 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
976 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
981 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
983 my $switch_onsite_checkout = (
984 C4::Context->preference('SwitchOnSiteCheckouts')
986 and $issue->onsite_checkout
987 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
988 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
989 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
990 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
991 if ( $toomany->{max_allowed} == 0 ) {
992 $needsconfirmation{PATRON_CANT} = 1;
994 if ( C4::Context->preference("AllowTooManyOverride") ) {
995 $needsconfirmation{TOO_MANY} = $toomany->{reason};
996 $needsconfirmation{current_loan_count} = $toomany->{count};
997 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
999 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1000 $issuingimpossible{current_loan_count} = $toomany->{count};
1001 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1006 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1008 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1009 my $wants_check = $patron->wants_check_for_previous_checkout;
1010 $needsconfirmation{PREVISSUE} = 1
1011 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1016 if ( $item_object->notforloan )
1018 if(!C4::Context->preference("AllowNotForLoanOverride")){
1019 $issuingimpossible{NOT_FOR_LOAN} = 1;
1020 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1022 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1023 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1027 # we have to check itemtypes.notforloan also
1028 if (C4::Context->preference('item-level_itypes')){
1029 # this should probably be a subroutine
1030 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1031 $sth->execute($effective_itemtype);
1032 my $notforloan=$sth->fetchrow_hashref();
1033 if ($notforloan->{'notforloan'}) {
1034 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1035 $issuingimpossible{NOT_FOR_LOAN} = 1;
1036 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1038 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1039 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1044 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1045 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1046 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1047 $issuingimpossible{NOT_FOR_LOAN} = 1;
1048 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1050 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1051 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1056 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1058 $issuingimpossible{WTHDRAWN} = 1;
1060 if ( $item_object->restricted
1061 && $item_object->restricted == 1 )
1063 $issuingimpossible{RESTRICTED} = 1;
1065 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1066 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1067 my $code = $av->count ? $av->next->lib : '';
1068 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1069 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1071 if ( C4::Context->preference("IndependentBranches") ) {
1072 my $userenv = C4::Context->userenv;
1073 unless ( C4::Context->IsSuperLibrarian() ) {
1074 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1075 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1076 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1077 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1079 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1080 if ( $patron->branchcode ne $userenv->{branch} );
1085 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1087 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1088 if ($rentalConfirmation) {
1089 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1091 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1092 if ($itemtype_object) {
1093 my $accumulate_charge = $fees->accumulate_rentalcharge();
1094 if ( $accumulate_charge > 0 ) {
1095 $rentalCharge += $accumulate_charge;
1099 if ( $rentalCharge > 0 ) {
1100 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1104 unless ( $ignore_reserves ) {
1105 # See if the item is on reserve.
1106 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1108 my $resbor = $res->{'borrowernumber'};
1109 if ( $resbor ne $patron->borrowernumber ) {
1110 my $patron = Koha::Patrons->find( $resbor );
1111 if ( $restype eq "Waiting" )
1113 # The item is on reserve and waiting, but has been
1114 # reserved by some other patron.
1115 $needsconfirmation{RESERVE_WAITING} = 1;
1116 $needsconfirmation{'resfirstname'} = $patron->firstname;
1117 $needsconfirmation{'ressurname'} = $patron->surname;
1118 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1119 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1120 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1121 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1122 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1124 elsif ( $restype eq "Reserved" ) {
1125 # The item is on reserve for someone else.
1126 $needsconfirmation{RESERVED} = 1;
1127 $needsconfirmation{'resfirstname'} = $patron->firstname;
1128 $needsconfirmation{'ressurname'} = $patron->surname;
1129 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1130 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1131 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1132 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1133 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1139 ## CHECK AGE RESTRICTION
1140 my $agerestriction = $biblioitem->agerestriction;
1141 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1142 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1143 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1144 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1147 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1151 ## check for high holds decreasing loan period
1152 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1153 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1155 if ( $check->{exceeded} ) {
1156 if ($override_high_holds) {
1157 $alerts{HIGHHOLDS} = {
1158 num_holds => $check->{outstanding},
1159 duration => $check->{duration},
1160 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1164 $needsconfirmation{HIGHHOLDS} = {
1165 num_holds => $check->{outstanding},
1166 duration => $check->{duration},
1167 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1174 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1175 # don't do the multiple loans per bib check if we've
1176 # already determined that we've got a loan on the same item
1177 !$issuingimpossible{NO_MORE_RENEWALS} &&
1178 !$needsconfirmation{RENEW_ISSUE}
1180 # Check if borrower has already issued an item from the same biblio
1181 # Only if it's not a subscription
1182 my $biblionumber = $item_object->biblionumber;
1183 require C4::Serials;
1184 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1185 unless ($is_a_subscription) {
1186 # FIXME Should be $patron->checkouts($args);
1187 my $checkouts = Koha::Checkouts->search(
1189 borrowernumber => $patron->borrowernumber,
1190 biblionumber => $biblionumber,
1196 # if we get here, we don't already have a loan on this item,
1197 # so if there are any loans on this bib, ask for confirmation
1198 if ( $checkouts->count ) {
1199 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1204 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1207 =head2 CanBookBeReturned
1209 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1211 Check whether the item can be returned to the provided branch
1215 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1217 =item C<$branch> is the branchcode where the return is taking place
1225 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1227 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1233 sub CanBookBeReturned {
1234 my ($item, $branch) = @_;
1235 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1237 # assume return is allowed to start
1241 # identify all cases where return is forbidden
1242 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1244 $message = $item->{'homebranch'};
1245 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1247 $message = $item->{'holdingbranch'};
1248 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1250 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1253 return ($allowed, $message);
1256 =head2 CheckHighHolds
1258 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1259 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1260 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1264 sub checkHighHolds {
1265 my ( $item, $borrower ) = @_;
1266 my $branchcode = _GetCircControlBranch( $item, $borrower );
1267 my $item_object = Koha::Items->find( $item->{itemnumber} );
1276 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1278 if ( $holds->count() ) {
1279 $return_data->{outstanding} = $holds->count();
1281 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1282 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1283 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1285 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1287 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1289 # static means just more than a given number of holds on the record
1291 # If the number of holds is less than the threshold, we can stop here
1292 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1293 return $return_data;
1296 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1298 # dynamic means X more than the number of holdable items on the record
1300 # let's get the items
1301 my @items = $holds->next()->biblio()->items()->as_list;
1303 # Remove any items with status defined to be ignored even if the would not make item unholdable
1304 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1305 @items = grep { !$_->$status } @items;
1308 # Remove any items that are not holdable for this patron
1309 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1311 my $items_count = scalar @items;
1313 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1315 # If the number of holds is less than the count of items we have
1316 # plus the number of holds allowed above that count, we can stop here
1317 if ( $holds->count() <= $threshold ) {
1318 return $return_data;
1322 my $issuedate = dt_from_string();
1324 my $itype = $item_object->effective_itemtype;
1325 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1327 categorycode => $borrower->{categorycode},
1329 branchcode => $branchcode,
1332 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1334 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1336 my $rule = Koha::CirculationRules->get_effective_rule(
1338 categorycode => $borrower->{categorycode},
1339 itemtype => $item_object->effective_itemtype,
1340 branchcode => $branchcode,
1341 rule_name => 'decreaseloanholds',
1346 if ( defined($rule) && $rule->rule_value ne '' ){
1347 # overrides decreaseLoanHighHoldsDuration syspref
1348 $duration = $rule->rule_value;
1350 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1352 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1353 $reduced_datedue->set_hour($orig_due->hour);
1354 $reduced_datedue->set_minute($orig_due->minute);
1355 $reduced_datedue->truncate( to => 'minute' );
1357 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1358 $return_data->{exceeded} = 1;
1359 $return_data->{duration} = $duration;
1360 $return_data->{due_date} = $reduced_datedue;
1364 return $return_data;
1369 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1371 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1375 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1377 =item C<$barcode> is the barcode of the item being issued.
1379 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1380 Calculated if empty.
1382 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1384 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1385 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1387 AddIssue does the following things :
1389 - step 01: check that there is a borrowernumber & a barcode provided
1390 - check for RENEWAL (book issued & being issued to the same patron)
1391 - renewal YES = Calculate Charge & renew
1393 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1395 - fill reserve if reserve to this patron
1396 - cancel reserve or not, otherwise
1397 * TRANSFERT PENDING ?
1398 - complete the transfert
1406 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1408 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1409 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1410 my $auto_renew = $params && $params->{auto_renew};
1411 my $dbh = C4::Context->dbh;
1412 my $barcodecheck = CheckValidBarcode($barcode);
1416 if ( $datedue && ref $datedue ne 'DateTime' ) {
1417 $datedue = dt_from_string($datedue);
1420 # $issuedate defaults to today.
1421 if ( !defined $issuedate ) {
1422 $issuedate = dt_from_string();
1425 if ( ref $issuedate ne 'DateTime' ) {
1426 $issuedate = dt_from_string($issuedate);
1431 # Stop here if the patron or barcode doesn't exist
1432 if ( $borrower && $barcode && $barcodecheck ) {
1433 # find which item we issue
1434 my $item_object = Koha::Items->find({ barcode => $barcode })
1435 or return; # if we don't get an Item, abort.
1436 my $item_unblessed = $item_object->unblessed;
1438 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1440 # get actual issuing if there is one
1441 my $actualissue = $item_object->checkout;
1443 # check if we just renew the issue.
1444 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1445 and not $switch_onsite_checkout ) {
1446 $datedue = AddRenewal(
1447 $borrower->{'borrowernumber'},
1448 $item_object->itemnumber,
1451 $issuedate, # here interpreted as the renewal date
1456 my $itype = $item_object->effective_itemtype;
1457 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1460 $datedue->truncate( to => 'minute' );
1462 my $patron = Koha::Patrons->find( $borrower );
1463 my $library = Koha::Libraries->find( $branchcode );
1464 my $fees = Koha::Charges::Fees->new(
1467 library => $library,
1468 item => $item_object,
1469 to_date => $datedue,
1473 # it's NOT a renewal
1474 if ( $actualissue and not $switch_onsite_checkout ) {
1475 # This book is currently on loan, but not to the person
1476 # who wants to borrow it now. mark it returned before issuing to the new borrower
1477 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1478 return unless $allowed;
1479 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1480 # AddReturn certainly has side-effects, like onloan => undef
1481 $item_object->discard_changes;
1484 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1486 # Starting process for transfer job (checking transfert and validate it if we have one)
1487 if ( my $transfer = $item_object->get_transfer ) {
1488 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1491 datearrived => dt_from_string,
1492 tobranch => C4::Context->userenv->{branch},
1493 comments => 'Forced branchtransfer'
1496 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1497 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1498 if ( $hold ) { # Is this really needed?
1499 $hold->set( { found => undef } )->store;
1500 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1505 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1506 unless ($auto_renew) {
1507 my $rule = Koha::CirculationRules->get_effective_rule(
1509 categorycode => $borrower->{categorycode},
1510 itemtype => $item_object->effective_itemtype,
1511 branchcode => $branchcode,
1512 rule_name => 'auto_renew'
1516 $auto_renew = $rule->rule_value if $rule;
1519 my $issue_attributes = {
1520 borrowernumber => $borrower->{'borrowernumber'},
1521 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1522 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1523 branchcode => C4::Context->userenv->{'branch'},
1524 onsite_checkout => $onsite_checkout,
1525 auto_renew => $auto_renew ? 1 : 0,
1528 # Get ID of logged in user. if called from a batch job,
1529 # no user session exists and C4::Context->userenv() returns
1530 # the scalar '0'. Only do this if the syspref says so
1531 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1532 my $userenv = C4::Context->userenv();
1533 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1535 $issue_attributes->{issuer_id} = $usernumber;
1539 # In the case that the borrower has an on-site checkout
1540 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1541 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1543 $issue->set($issue_attributes)->store;
1546 $issue = Koha::Checkout->new(
1548 itemnumber => $item_object->itemnumber,
1553 $issue->discard_changes;
1554 if ( $item_object->location && $item_object->location eq 'CART'
1555 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1556 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1557 CartToShelf( $item_object->itemnumber );
1560 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1561 UpdateTotalIssues( $item_object->biblionumber, 1 );
1564 # Record if item was lost
1565 my $was_lost = $item_object->itemlost;
1567 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1568 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1569 $item_object->itemlost(0);
1570 $item_object->onloan($datedue->ymd());
1571 $item_object->datelastborrowed( dt_from_string()->ymd() );
1572 $item_object->datelastseen( dt_from_string()->ymd() );
1573 $item_object->store({log_action => 0});
1575 # If the item was lost, it has now been found, charge the overdue if necessary
1577 if ( $item_object->{_charge} ) {
1578 $actualissue //= Koha::Old::Checkouts->search(
1579 { itemnumber => $item_unblessed->{itemnumber} },
1581 order_by => { '-desc' => 'returndate' },
1585 unless ( exists( $borrower->{branchcode} ) ) {
1586 my $patron = $actualissue->patron;
1587 $borrower = $patron->unblessed;
1589 _CalculateAndUpdateFine(
1591 issue => $actualissue,
1592 item => $item_unblessed,
1593 borrower => $borrower,
1594 return_date => $issuedate
1597 _FixOverduesOnReturn( $borrower->{borrowernumber},
1598 $item_object->itemnumber, undef, 'RENEWED' );
1602 # If it costs to borrow this book, charge it to the patron's account.
1603 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1604 if ( $charge && $charge > 0 ) {
1605 AddIssuingCharge( $issue, $charge, 'RENT' );
1608 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1609 if ( $itemtype_object ) {
1610 my $accumulate_charge = $fees->accumulate_rentalcharge();
1611 if ( $accumulate_charge > 0 ) {
1612 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1613 $charge += $accumulate_charge;
1614 $item_unblessed->{charge} = $charge;
1618 # Record the fact that this book was issued.
1621 branch => C4::Context->userenv->{'branch'},
1622 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1624 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1625 itemnumber => $item_object->itemnumber,
1626 itemtype => $item_object->effective_itemtype,
1627 location => $item_object->location,
1628 borrowernumber => $borrower->{'borrowernumber'},
1629 ccode => $item_object->ccode,
1633 # Send a checkout slip.
1634 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1636 branchcode => $branchcode,
1637 categorycode => $borrower->{categorycode},
1638 item_type => $item_object->effective_itemtype,
1639 notification => 'CHECKOUT',
1641 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1642 SendCirculationAlert(
1645 item => $item_object->unblessed,
1646 borrower => $borrower,
1647 branch => $branchcode,
1652 "CIRCULATION", "ISSUE",
1653 $borrower->{'borrowernumber'},
1654 $item_object->itemnumber,
1655 ) if C4::Context->preference("IssueLog");
1657 Koha::Plugins->call('after_circ_action', {
1658 action => 'checkout',
1660 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1661 checkout => $issue->get_from_storage
1669 =head2 GetLoanLength
1671 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1673 Get loan length for an itemtype, a borrower type and a branch
1678 my ( $categorycode, $itemtype, $branchcode ) = @_;
1680 # Initialize default values
1684 lengthunit => 'days',
1687 my $found = Koha::CirculationRules->get_effective_rules( {
1688 branchcode => $branchcode,
1689 categorycode => $categorycode,
1690 itemtype => $itemtype,
1699 foreach my $rule_name (keys %$found) {
1700 $rules->{$rule_name} = $found->{$rule_name};
1707 =head2 GetHardDueDate
1709 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1711 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1715 sub GetHardDueDate {
1716 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1718 my $rules = Koha::CirculationRules->get_effective_rules(
1720 categorycode => $borrowertype,
1721 itemtype => $itemtype,
1722 branchcode => $branchcode,
1723 rules => [ 'hardduedate', 'hardduedatecompare' ],
1727 if ( defined( $rules->{hardduedate} ) ) {
1728 if ( $rules->{hardduedate} ) {
1729 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1732 return ( undef, undef );
1737 =head2 GetBranchBorrowerCircRule
1739 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1741 Retrieves circulation rule attributes that apply to the given
1742 branch and patron category, regardless of item type.
1743 The return value is a hashref containing the following key:
1745 patron_maxissueqty - maximum number of loans that a
1746 patron of the given category can have at the given
1747 branch. If the value is undef, no limit.
1749 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1750 patron of the given category can have at the given
1751 branch. If the value is undef, no limit.
1753 This will check for different branch/category combinations in the following order:
1757 default branch and category
1759 If no rule has been found in the database, it will default to
1762 patron_maxissueqty - undef
1763 patron_maxonsiteissueqty - undef
1765 C<$branchcode> and C<$categorycode> should contain the
1766 literal branch code and patron category code, respectively - no
1771 sub GetBranchBorrowerCircRule {
1772 my ( $branchcode, $categorycode ) = @_;
1774 # Initialize default values
1776 patron_maxissueqty => undef,
1777 patron_maxonsiteissueqty => undef,
1781 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1782 my $rule = Koha::CirculationRules->get_effective_rule(
1784 categorycode => $categorycode,
1786 branchcode => $branchcode,
1787 rule_name => $rule_name,
1791 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1797 =head2 GetBranchItemRule
1799 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1801 Retrieves circulation rule attributes that apply to the given
1802 branch and item type, regardless of patron category.
1804 The return value is a hashref containing the following keys:
1806 holdallowed => Hold policy for this branch and itemtype. Possible values:
1807 0: No holds allowed.
1808 1: Holds allowed only by patrons that have the same homebranch as the item.
1809 2: Holds allowed from any patron.
1811 returnbranch => branch to which to return item. Possible values:
1812 noreturn: do not return, let item remain where checked in (floating collections)
1813 homebranch: return to item's home branch
1814 holdingbranch: return to issuer branch
1816 This searches branchitemrules in the following order:
1818 * Same branchcode and itemtype
1819 * Same branchcode, itemtype '*'
1820 * branchcode '*', same itemtype
1821 * branchcode and itemtype '*'
1823 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1827 sub GetBranchItemRule {
1828 my ( $branchcode, $itemtype ) = @_;
1831 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1833 branchcode => $branchcode,
1834 itemtype => $itemtype,
1835 rule_name => 'holdallowed',
1838 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1840 branchcode => $branchcode,
1841 itemtype => $itemtype,
1842 rule_name => 'hold_fulfillment_policy',
1845 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1847 branchcode => $branchcode,
1848 itemtype => $itemtype,
1849 rule_name => 'returnbranch',
1853 # built-in default circulation rule
1855 $rules->{holdallowed} = defined $holdallowed_rule
1856 ? $holdallowed_rule->rule_value
1858 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1859 ? $hold_fulfillment_policy_rule->rule_value
1861 $rules->{returnbranch} = defined $returnbranch_rule
1862 ? $returnbranch_rule->rule_value
1870 ($doreturn, $messages, $iteminformation, $borrower) =
1871 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1877 =item C<$barcode> is the bar code of the book being returned.
1879 =item C<$branch> is the code of the branch where the book is being returned.
1881 =item C<$exemptfine> indicates that overdue charges for the item will be
1884 =item C<$return_date> allows the default return date to be overridden
1885 by the given return date. Optional.
1889 C<&AddReturn> returns a list of four items:
1891 C<$doreturn> is true iff the return succeeded.
1893 C<$messages> is a reference-to-hash giving feedback on the operation.
1894 The keys of the hash are:
1900 No item with this barcode exists. The value is C<$barcode>.
1904 The book is not currently on loan. The value is C<$barcode>.
1908 This book has been withdrawn/cancelled. The value should be ignored.
1910 =item C<Wrongbranch>
1912 This book has was returned to the wrong branch. The value is a hashref
1913 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1914 contain the branchcode of the incorrect and correct return library, respectively.
1918 The item was reserved. The value is a reference-to-hash whose keys are
1919 fields from the reserves table of the Koha database, and
1920 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1921 either C<Waiting>, C<Reserved>, or 0.
1923 =item C<WasReturned>
1925 Value 1 if return is successful.
1927 =item C<NeedsTransfer>
1929 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1933 C<$iteminformation> is a reference-to-hash, giving information about the
1934 returned item from the issues table.
1936 C<$borrower> is a reference-to-hash, giving information about the
1937 patron who last borrowed the book.
1942 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1944 if ($branch and not Koha::Libraries->find($branch)) {
1945 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1948 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1949 my $return_date_specified = !!$return_date;
1950 $return_date //= dt_from_string();
1954 my $validTransfer = 1;
1955 my $stat_type = 'return';
1957 # get information on item
1958 my $item = Koha::Items->find({ barcode => $barcode });
1960 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1963 my $itemnumber = $item->itemnumber;
1964 my $itemtype = $item->effective_itemtype;
1966 my $issue = $item->checkout;
1968 $patron = $issue->patron
1969 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1970 . Dumper($issue->unblessed) . "\n";
1972 $messages->{'NotIssued'} = $barcode;
1973 $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
1975 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1977 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1978 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1979 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1980 $messages->{'LocalUse'} = 1;
1981 $stat_type = 'localuse';
1985 # full item data, but no borrowernumber or checkout info (no issue)
1986 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1987 # get the proper branch to which to return the item
1988 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1989 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1990 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1992 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1993 my $patron_unblessed = $patron ? $patron->unblessed : {};
1995 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
1996 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1997 if ($update_loc_rules) {
1998 if (defined $update_loc_rules->{_ALL_}) {
1999 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2000 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2001 if ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) {
2002 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2003 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2007 foreach my $key ( keys %$update_loc_rules ) {
2008 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2009 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2010 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2011 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2012 $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2019 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2021 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2023 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2025 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2028 foreach my $key ( keys %$rules ) {
2029 if ( $item->notforloan eq $key ) {
2030 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2031 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2038 # check if the return is allowed at this branch
2039 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2040 unless ($returnallowed){
2041 $messages->{'Wrongbranch'} = {
2042 Wrongbranch => $branch,
2043 Rightbranch => $message
2046 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2047 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2048 return ( $doreturn, $messages, $issue, $patron_unblessed);
2051 if ( $item->withdrawn ) { # book has been cancelled
2052 $messages->{'withdrawn'} = 1;
2053 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2056 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2060 # case of a return of document (deal with issues and holdingbranch)
2062 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2063 $patron or warn "AddReturn without current borrower";
2067 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2072 C4::Context->preference('CalculateFinesOnReturn')
2073 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2078 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2081 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 );
2083 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2084 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2086 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2089 # FIXME is the "= 1" right? This could be the borrower hash.
2090 $messages->{'WasReturned'} = 1;
2093 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2097 # the holdingbranch is updated if the document is returned to another location.
2098 # this is always done regardless of whether the item was on loan or not
2099 if ($item->holdingbranch ne $branch) {
2100 $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2103 my $item_was_lost = $item->itemlost;
2104 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2105 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2107 # fix up the accounts.....
2108 if ($item_was_lost) {
2109 $messages->{'WasLost'} = 1;
2110 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2111 $messages->{'LostItemFeeRefunded'} = $updated_item->{_refunded};
2112 $messages->{'LostItemFeeRestored'} = $updated_item->{_restored};
2114 if ( $updated_item->{_charge} ) {
2115 $issue //= Koha::Old::Checkouts->search(
2116 { itemnumber => $item->itemnumber },
2117 { order_by => { '-desc' => 'returndate' }, rows => 1 } )
2119 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2120 my $patron = $issue->patron;
2121 $patron_unblessed = $patron->unblessed;
2123 _CalculateAndUpdateFine(
2126 item => $item->unblessed,
2127 borrower => $patron_unblessed,
2128 return_date => $return_date
2131 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2132 $item->itemnumber, undef, 'RETURNED' );
2133 $messages->{'LostItemFeeCharged'} = 1;
2138 # check if we have a transfer for this document
2139 my $transfer = $item->get_transfer;
2141 # if we have a transfer to complete, we update the line of transfers with the datearrived
2142 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2145 if ( $transfer->in_transit ) {
2146 if ( $transfer->tobranch eq $branch ) {
2148 $messages->{'TransferArrived'} = $transfer->frombranch;
2151 $messages->{'WrongTransfer'} = $transfer->tobranch;
2152 $messages->{'WrongTransferItem'} = $item->itemnumber;
2156 if ( $transfer->tobranch eq $branch ) {
2158 $messages->{'TransferArrived'} = $transfer->frombranch;
2161 $messages->{'WasTransfered'} = $transfer->tobranch;
2162 $messages->{'TransferTrigger'} = $transfer->reason;
2167 # fix up the overdues in accounts...
2168 if ($borrowernumber) {
2169 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2170 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2172 if ( $issue and $issue->is_overdue($return_date) ) {
2174 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2176 $messages->{'PrevDebarred'} = $debardate;
2178 $messages->{'Debarred'} = $debardate if $debardate;
2180 # there's no overdue on the item but borrower had been previously debarred
2181 } elsif ( $issue->date_due and $patron->debarred ) {
2182 if ( $patron->debarred eq "9999-12-31") {
2183 $messages->{'ForeverDebarred'} = $patron->debarred;
2185 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2186 $borrower_debar_dt->truncate(to => 'day');
2187 my $today_dt = $return_date->clone()->truncate(to => 'day');
2188 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2189 $messages->{'PrevDebarred'} = $patron->debarred;
2195 # find reserves.....
2196 # launch the Checkreserves routine to find any holds
2197 my ($resfound, $resrec);
2198 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2199 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2200 # 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)
2201 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2202 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2203 $resfound = 'Reserved';
2204 $resrec = $hold->unblessed;
2207 $resrec->{'ResFound'} = $resfound;
2208 $messages->{'ResFound'} = $resrec;
2211 # Record the fact that this book was returned.
2215 itemnumber => $itemnumber,
2216 itemtype => $itemtype,
2217 location => $item->location,
2218 borrowernumber => $borrowernumber,
2219 ccode => $item->ccode,
2222 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2224 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2226 branchcode => $branch,
2227 categorycode => $patron->categorycode,
2228 item_type => $itemtype,
2229 notification => 'CHECKIN',
2231 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2232 SendCirculationAlert({
2234 item => $item->unblessed,
2235 borrower => $patron->unblessed,
2240 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2241 if C4::Context->preference("ReturnLog");
2244 # Check if this item belongs to a biblio record that is attached to an
2245 # ILL request, if it is we need to update the ILL request's status
2246 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2247 my $request = Koha::Illrequests->find(
2248 { biblio_id => $item->biblio->biblionumber }
2250 $request->status('RET') if $request;
2253 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2254 if ( $validTransfer && !$is_in_rotating_collection
2255 && ( $doreturn or $messages->{'NotIssued'} )
2257 and ( $branch ne $returnbranch )
2258 and not $messages->{'WrongTransfer'}
2259 and not $messages->{'WasTransfered'} )
2261 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2262 if (C4::Context->preference("AutomaticItemReturn" ) or
2263 (C4::Context->preference("UseBranchTransferLimits") and
2264 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2266 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2267 $debug and warn "item: " . Dumper($item->unblessed);
2268 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2269 $messages->{'WasTransfered'} = $returnbranch;
2270 $messages->{'TransferTrigger'} = $transfer_trigger;
2272 $messages->{'NeedsTransfer'} = $returnbranch;
2273 $messages->{'TransferTrigger'} = $transfer_trigger;
2277 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2278 my $claims = Koha::Checkouts::ReturnClaims->search(
2280 itemnumber => $item->id,
2281 resolution => undef,
2285 if ( $claims->count ) {
2286 $messages->{ReturnClaims} = $claims;
2290 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2291 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2293 if ( $doreturn and $issue ) {
2294 my $checkin = Koha::Old::Checkouts->find($issue->id);
2296 Koha::Plugins->call('after_circ_action', {
2297 action => 'checkin',
2304 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2307 =head2 MarkIssueReturned
2309 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2311 Unconditionally marks an issue as being returned by
2312 moving the C<issues> row to C<old_issues> and
2313 setting C<returndate> to the current date.
2315 if C<$returndate> is specified (in iso format), it is used as the date
2318 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2319 the old_issue is immediately anonymised
2321 Ideally, this function would be internal to C<C4::Circulation>,
2322 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2323 and offline_circ/process_koc.pl.
2325 The last optional parameter allos passing skip_record_index to the item store call.
2329 sub MarkIssueReturned {
2330 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2332 # Retrieve the issue
2333 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2335 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2337 my $issue_id = $issue->issue_id;
2339 my $anonymouspatron;
2340 if ( $privacy && $privacy == 2 ) {
2341 # The default of 0 will not work due to foreign key constraints
2342 # The anonymisation will fail if AnonymousPatron is not a valid entry
2343 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2344 # Note that a warning should appear on the about page (System information tab).
2345 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2346 die "Fatal error: the patron ($borrowernumber) has requested their circulation history be anonymized on check-in, but the AnonymousPatron system preference is empty or not set correctly."
2347 unless Koha::Patrons->find( $anonymouspatron );
2350 my $schema = Koha::Database->schema;
2352 # FIXME Improve the return value and handle it from callers
2353 $schema->txn_do(sub {
2355 my $patron = Koha::Patrons->find( $borrowernumber );
2357 # Update the returndate value
2358 if ( $returndate ) {
2359 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2362 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2365 # Create the old_issues entry
2366 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2368 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2369 if ( $privacy && $privacy == 2) {
2370 $old_checkout->borrowernumber($anonymouspatron)->store;
2373 # And finally delete the issue
2376 $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2378 if ( C4::Context->preference('StoreLastBorrower') ) {
2379 my $item = Koha::Items->find( $itemnumber );
2380 $item->last_returned_by( $patron );
2383 # Remove any OVERDUES related debarment if the borrower has no overdues
2384 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2385 && $patron->debarred
2386 && !$patron->has_overdues
2387 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2389 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2397 =head2 _debar_user_on_return
2399 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2401 C<$borrower> borrower hashref
2403 C<$item> item hashref
2405 C<$datedue> date due DateTime object
2407 C<$returndate> DateTime object representing the return time
2409 Internal function, called only by AddReturn that calculates and updates
2410 the user fine days, and debars them if necessary.
2412 Should only be called for overdue returns
2414 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2419 sub _calculate_new_debar_dt {
2420 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2422 my $branchcode = _GetCircControlBranch( $item, $borrower );
2423 my $circcontrol = C4::Context->preference('CircControl');
2424 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2425 { categorycode => $borrower->{categorycode},
2426 itemtype => $item->{itype},
2427 branchcode => $branchcode,
2432 'maxsuspensiondays',
2433 'suspension_chargeperiod',
2437 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2438 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2439 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2441 return unless $finedays;
2443 # finedays is in days, so hourly loans must multiply by 24
2444 # thus 1 hour late equals 1 day suspension * finedays rate
2445 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2447 # grace period is measured in the same units as the loan
2449 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2451 my $deltadays = DateTime::Duration->new(
2452 days => $chargeable_units
2455 if ( $deltadays->subtract($grace)->is_positive() ) {
2456 my $suspension_days = $deltadays * $finedays;
2458 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2459 # No need to / 1 and do not consider / 0
2460 $suspension_days = DateTime::Duration->new(
2461 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2465 # If the max suspension days is < than the suspension days
2466 # the suspension days is limited to this maximum period.
2467 my $max_sd = $issuing_rule->{maxsuspensiondays};
2468 if ( defined $max_sd && $max_sd ne '' ) {
2469 $max_sd = DateTime::Duration->new( days => $max_sd );
2470 $suspension_days = $max_sd
2471 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2474 my ( $has_been_extended );
2475 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2476 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2478 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2479 $has_been_extended = 1;
2484 # Use the calendar or not to calculate the debarment date
2485 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2486 my $calendar = Koha::Calendar->new(
2487 branchcode => $branchcode,
2488 days_mode => 'Calendar'
2490 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2493 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2495 return $new_debar_dt;
2500 sub _debar_user_on_return {
2501 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2503 $return_date //= dt_from_string();
2505 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2507 return unless $new_debar_dt;
2509 Koha::Patron::Debarments::AddUniqueDebarment({
2510 borrowernumber => $borrower->{borrowernumber},
2511 expiration => $new_debar_dt->ymd(),
2512 type => 'SUSPENSION',
2514 # if borrower was already debarred but does not get an extra debarment
2515 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2516 my ($new_debarment_str, $is_a_reminder);
2517 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2519 $new_debarment_str = $borrower->{debarred};
2521 $new_debarment_str = $new_debar_dt->ymd();
2523 # FIXME Should return a DateTime object
2524 return $new_debarment_str, $is_a_reminder;
2527 =head2 _FixOverduesOnReturn
2529 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2531 C<$borrowernumber> borrowernumber
2533 C<$itemnumber> itemnumber
2535 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2537 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2543 sub _FixOverduesOnReturn {
2544 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2545 unless( $borrowernumber ) {
2546 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2550 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2554 warn "_FixOverduesOnReturn() not supplied valid status";
2558 my $schema = Koha::Database->schema;
2560 my $result = $schema->txn_do(
2562 # check for overdue fine
2563 my $accountlines = Koha::Account::Lines->search(
2565 borrowernumber => $borrowernumber,
2566 itemnumber => $item,
2567 debit_type_code => 'OVERDUE',
2568 status => 'UNRETURNED'
2571 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2573 my $accountline = $accountlines->next;
2574 my $payments = $accountline->credits;
2576 my $amountoutstanding = $accountline->amountoutstanding;
2577 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2578 $accountline->delete;
2579 return 0; # no warning, we've just removed a zero value fine (backdated return)
2580 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2581 my $account = Koha::Account->new({patron_id => $borrowernumber});
2582 my $credit = $account->add_credit(
2584 amount => $amountoutstanding,
2585 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2586 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2587 interface => C4::Context->interface,
2593 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2595 if (C4::Context->preference("FinesLog")) {
2596 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2600 $accountline->status($status);
2601 return $accountline->store();
2608 =head2 _GetCircControlBranch
2610 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2614 Return the library code to be used to determine which circulation
2615 policy applies to a transaction. Looks up the CircControl and
2616 HomeOrHoldingBranch system preferences.
2618 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2620 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2624 sub _GetCircControlBranch {
2625 my ($item, $borrower) = @_;
2626 my $circcontrol = C4::Context->preference('CircControl');
2629 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2630 $branch= C4::Context->userenv->{'branch'};
2631 } elsif ($circcontrol eq 'PatronLibrary') {
2632 $branch=$borrower->{branchcode};
2634 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2635 $branch = $item->{$branchfield};
2636 # default to item home branch if holdingbranch is used
2637 # and is not defined
2638 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2639 $branch = $item->{homebranch};
2647 $issue = GetOpenIssue( $itemnumber );
2649 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2651 C<$itemnumber> is the item's itemnumber
2658 my ( $itemnumber ) = @_;
2659 return unless $itemnumber;
2660 my $dbh = C4::Context->dbh;
2661 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2662 $sth->execute( $itemnumber );
2663 return $sth->fetchrow_hashref();
2667 =head2 GetUpcomingDueIssues
2669 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2673 sub GetUpcomingDueIssues {
2676 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2677 my $dbh = C4::Context->dbh;
2680 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2682 LEFT JOIN items USING (itemnumber)
2683 LEFT JOIN branches ON branches.branchcode =
2685 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2686 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2687 my @bind_parameters = ( $params->{'days_in_advance'} );
2689 my $sth = $dbh->prepare( $statement );
2690 $sth->execute( @bind_parameters );
2691 my $upcoming_dues = $sth->fetchall_arrayref({});
2693 return $upcoming_dues;
2696 =head2 CanBookBeRenewed
2698 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2700 Find out whether a borrowed item may be renewed.
2702 C<$borrowernumber> is the borrower number of the patron who currently
2703 has the item on loan.
2705 C<$itemnumber> is the number of the item to renew.
2707 C<$override_limit>, if supplied with a true value, causes
2708 the limit on the number of times that the loan can be renewed
2709 (as controlled by the item type) to be ignored. Overriding also allows
2710 to renew sooner than "No renewal before" and to manually renew loans
2711 that are automatically renewed.
2713 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2714 item must currently be on loan to the specified borrower; renewals
2715 must be allowed for the item's type; and the borrower must not have
2716 already renewed the loan. $error will contain the reason the renewal can not proceed
2720 sub CanBookBeRenewed {
2721 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2723 my $dbh = C4::Context->dbh;
2725 my $auto_renew = "no";
2727 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2728 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2729 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2730 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2732 my $patron = $issue->patron or return;
2734 # override_limit will override anything else except on_reserve
2735 unless ( $override_limit ){
2736 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2737 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2739 categorycode => $patron->categorycode,
2740 itemtype => $item->effective_itemtype,
2741 branchcode => $branchcode,
2744 'no_auto_renewal_after',
2745 'no_auto_renewal_after_hard_limit',
2748 'unseen_renewals_allowed'
2753 return ( 0, "too_many" )
2754 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2756 return ( 0, "too_unseen" )
2757 if C4::Context->preference('UnseenRenewals') &&
2758 $issuing_rule->{unseen_renewals_allowed} &&
2759 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2761 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2762 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2763 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2764 my $restricted = $patron->is_debarred;
2765 my $hasoverdues = $patron->has_overdues;
2767 if ( $restricted and $restrictionblockrenewing ) {
2768 return ( 0, 'restriction');
2769 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2770 return ( 0, 'overdue');
2773 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2775 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2776 return ( 0, 'auto_account_expired' );
2779 if ( defined $issuing_rule->{no_auto_renewal_after}
2780 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2781 # Get issue_date and add no_auto_renewal_after
2782 # If this is greater than today, it's too late for renewal.
2783 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2784 $maximum_renewal_date->add(
2785 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2787 my $now = dt_from_string;
2788 if ( $now >= $maximum_renewal_date ) {
2789 return ( 0, "auto_too_late" );
2792 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2793 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2794 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2795 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2796 return ( 0, "auto_too_late" );
2800 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2801 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2802 my $amountoutstanding =
2803 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2804 ? $patron->account->balance
2805 : $patron->account->outstanding_debits->total_outstanding;
2806 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2807 return ( 0, "auto_too_much_oweing" );
2812 if ( defined $issuing_rule->{norenewalbefore}
2813 and $issuing_rule->{norenewalbefore} ne "" )
2816 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2817 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2818 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2820 # Depending on syspref reset the exact time, only check the date
2821 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2822 and $issuing_rule->{lengthunit} eq 'days' )
2824 $soonestrenewal->truncate( to => 'day' );
2827 if ( $soonestrenewal > dt_from_string() )
2829 $auto_renew = ($issue->auto_renew && $patron->autorenew_checkouts) ? "auto_too_soon" : "too_soon";
2831 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2836 # Fallback for automatic renewals:
2837 # If norenewalbefore is undef, don't renew before due date.
2838 if ( $issue->auto_renew && $auto_renew eq "no" && $patron->autorenew_checkouts ) {
2839 my $now = dt_from_string;
2840 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2843 $auto_renew = "auto_too_soon";
2848 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2850 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2851 if ( $resfound && $resrec->{non_priority} ) {
2852 $resfound = Koha::Holds->search(
2853 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2859 # This item can fill one or more unfilled reserve, can those unfilled reserves
2860 # all be filled by other available items?
2862 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2864 my $schema = Koha::Database->new()->schema();
2866 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2868 # There is an item level hold on this item, no other item can fill the hold
2873 # Get all other items that could possibly fill reserves
2874 my @itemnumbers = $schema->resultset('Item')->search(
2876 biblionumber => $resrec->{biblionumber},
2879 -not => { itemnumber => $itemnumber }
2881 { columns => 'itemnumber' }
2882 )->get_column('itemnumber')->all();
2884 # Get all other reserves that could have been filled by this item
2885 my @borrowernumbers;
2887 my ( $reserve_found, $reserve, undef ) =
2888 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2890 if ($reserve_found) {
2891 push( @borrowernumbers, $reserve->{borrowernumber} );
2898 # If the count of the union of the lists of reservable items for each borrower
2899 # is equal or greater than the number of borrowers, we know that all reserves
2900 # can be filled with available items. We can get the union of the sets simply
2901 # by pushing all the elements onto an array and removing the duplicates.
2904 ITEM: foreach my $itemnumber (@itemnumbers) {
2905 my $item = Koha::Items->find( $itemnumber );
2906 next if IsItemOnHoldAndFound( $itemnumber );
2907 for my $borrowernumber (@borrowernumbers) {
2908 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2909 next unless IsAvailableForItemLevelRequest($item, $patron);
2910 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2912 push @reservable, $itemnumber;
2913 if (@reservable >= @borrowernumbers) {
2922 if( $cron ) { #The cron wants to return 'too_soon' over 'on_reserve'
2923 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2924 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2925 } else { # For other purposes we want 'on_reserve' before 'too_soon'
2926 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2927 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2930 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2932 return ( 1, undef );
2937 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2941 C<$borrowernumber> is the borrower number of the patron who currently
2944 C<$itemnumber> is the number of the item to renew.
2946 C<$branch> is the library where the renewal took place (if any).
2947 The library that controls the circ policies for the renewal is retrieved from the issues record.
2949 C<$datedue> can be a DateTime object used to set the due date.
2951 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2952 this parameter is not supplied, lastreneweddate is set to the current date.
2954 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2955 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2956 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2959 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2960 from the book's item type.
2962 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
2963 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
2964 fallback to a true value
2969 my $borrowernumber = shift;
2970 my $itemnumber = shift or return;
2972 my $datedue = shift;
2973 my $lastreneweddate = shift || dt_from_string();
2974 my $skipfinecalc = shift;
2977 # Fallback on a 'seen' renewal
2978 $seen = defined $seen && $seen == 0 ? 0 : 1;
2980 my $item_object = Koha::Items->find($itemnumber) or return;
2981 my $biblio = $item_object->biblio;
2982 my $issue = $item_object->checkout;
2983 my $item_unblessed = $item_object->unblessed;
2985 my $dbh = C4::Context->dbh;
2987 return unless $issue;
2989 $borrowernumber ||= $issue->borrowernumber;
2991 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2992 carp 'Invalid date passed to AddRenewal.';
2996 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2997 my $patron_unblessed = $patron->unblessed;
2999 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3001 my $schema = Koha::Database->schema;
3002 $schema->txn_do(sub{
3004 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3005 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3007 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3009 # If the due date wasn't specified, calculate it by adding the
3010 # book's loan length to today's date or the current due date
3011 # based on the value of the RenewalPeriodBase syspref.
3012 my $itemtype = $item_object->effective_itemtype;
3015 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3016 dt_from_string( $issue->date_due, 'sql' ) :
3018 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3021 my $fees = Koha::Charges::Fees->new(
3024 library => $circ_library,
3025 item => $item_object,
3026 from_date => dt_from_string( $issue->date_due, 'sql' ),
3027 to_date => dt_from_string($datedue),
3031 # Increment the unseen renewals, if appropriate
3032 # We only do so if the syspref is enabled and
3033 # a maximum value has been set in the circ rules
3034 my $unseen_renewals = $issue->unseen_renewals;
3035 if (C4::Context->preference('UnseenRenewals')) {
3036 my $rule = Koha::CirculationRules->get_effective_rule(
3037 { categorycode => $patron->categorycode,
3038 itemtype => $item_object->effective_itemtype,
3039 branchcode => $circ_library->branchcode,
3040 rule_name => 'unseen_renewals_allowed'
3043 if (!$seen && $rule && $rule->rule_value) {
3046 # If the renewal is seen, unseen should revert to 0
3047 $unseen_renewals = 0;
3051 # Update the issues record to have the new due date, and a new count
3052 # of how many times it has been renewed.
3053 my $renews = ( $issue->renewals || 0 ) + 1;
3054 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3057 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3060 Koha::Exceptions::Checkout::FailedRenewal->throw(
3061 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3065 # Update the renewal count on the item, and tell zebra to reindex
3066 $renews = ( $item_object->renewals || 0 ) + 1;
3067 $item_object->renewals($renews);
3068 $item_object->onloan($datedue);
3069 $item_object->store({ log_action => 0 });
3071 # Charge a new rental fee, if applicable
3072 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3073 if ( $charge > 0 ) {
3074 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3077 # Charge a new accumulate rental fee, if applicable
3078 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3079 if ( $itemtype_object ) {
3080 my $accumulate_charge = $fees->accumulate_rentalcharge();
3081 if ( $accumulate_charge > 0 ) {
3082 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3084 $charge += $accumulate_charge;
3087 # Send a renewal slip according to checkout alert preferencei
3088 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3089 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3091 branchcode => $branch,
3092 categorycode => $patron->categorycode,
3093 item_type => $itemtype,
3094 notification => 'CHECKOUT',
3096 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3097 SendCirculationAlert(
3100 item => $item_unblessed,
3101 borrower => $patron->unblessed,
3108 # Remove any OVERDUES related debarment if the borrower has no overdues
3110 && $patron->is_debarred
3111 && ! $patron->has_overdues
3112 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3114 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3117 # Add the renewal to stats
3120 branch => $item_object->renewal_branchcode({branch => $branch}),
3123 itemnumber => $itemnumber,
3124 itemtype => $itemtype,
3125 location => $item_object->location,
3126 borrowernumber => $borrowernumber,
3127 ccode => $item_object->ccode,
3132 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3134 Koha::Plugins->call('after_circ_action', {
3135 action => 'renewal',
3137 checkout => $issue->get_from_storage
3146 # check renewal status
3147 my ( $bornum, $itemno ) = @_;
3148 my $dbh = C4::Context->dbh;
3150 my $unseencount = 0;
3151 my $renewsallowed = 0;
3152 my $unseenallowed = 0;
3156 my $patron = Koha::Patrons->find( $bornum );
3157 my $item = Koha::Items->find($itemno);
3159 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3161 # Look in the issues table for this item, lent to this borrower,
3162 # and not yet returned.
3164 # FIXME - I think this function could be redone to use only one SQL call.
3165 my $sth = $dbh->prepare(
3166 "select * from issues
3167 where (borrowernumber = ?)
3168 and (itemnumber = ?)"
3170 $sth->execute( $bornum, $itemno );
3171 my $data = $sth->fetchrow_hashref;
3172 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3173 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3174 # $item and $borrower should be calculated
3175 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3177 my $rules = Koha::CirculationRules->get_effective_rules(
3179 categorycode => $patron->categorycode,
3180 itemtype => $item->effective_itemtype,
3181 branchcode => $branchcode,
3182 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3185 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3186 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3187 $rules->{unseen_renewals_allowed} :
3189 $renewsleft = $renewsallowed - $renewcount;
3190 $unseenleft = $unseenallowed - $unseencount;
3191 if($renewsleft < 0){ $renewsleft = 0; }
3192 if($unseenleft < 0){ $unseenleft = 0; }
3203 =head2 GetSoonestRenewDate
3205 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3207 Find out the soonest possible renew date of a borrowed item.
3209 C<$borrowernumber> is the borrower number of the patron who currently
3210 has the item on loan.
3212 C<$itemnumber> is the number of the item to renew.
3214 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3215 renew date, based on the value "No renewal before" of the applicable
3216 issuing rule. Returns the current date if the item can already be
3217 renewed, and returns undefined if the borrower, loan, or item
3222 sub GetSoonestRenewDate {
3223 my ( $borrowernumber, $itemnumber ) = @_;
3225 my $dbh = C4::Context->dbh;
3227 my $item = Koha::Items->find($itemnumber) or return;
3228 my $itemissue = $item->checkout or return;
3230 $borrowernumber ||= $itemissue->borrowernumber;
3231 my $patron = Koha::Patrons->find( $borrowernumber )
3234 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3235 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3236 { categorycode => $patron->categorycode,
3237 itemtype => $item->effective_itemtype,
3238 branchcode => $branchcode,
3246 my $now = dt_from_string;
3247 return $now unless $issuing_rule;
3249 if ( defined $issuing_rule->{norenewalbefore}
3250 and $issuing_rule->{norenewalbefore} ne "" )
3252 my $soonestrenewal =
3253 dt_from_string( $itemissue->date_due )->subtract(
3254 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3256 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3257 and $issuing_rule->{lengthunit} eq 'days' )
3259 $soonestrenewal->truncate( to => 'day' );
3261 return $soonestrenewal if $now < $soonestrenewal;
3266 =head2 GetLatestAutoRenewDate
3268 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3270 Find out the latest possible auto renew date of a borrowed item.
3272 C<$borrowernumber> is the borrower number of the patron who currently
3273 has the item on loan.
3275 C<$itemnumber> is the number of the item to renew.
3277 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3278 auto renew date, based on the value "No auto renewal after" and the "No auto
3279 renewal after (hard limit) of the applicable issuing rule.
3280 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3281 or item cannot be found.
3285 sub GetLatestAutoRenewDate {
3286 my ( $borrowernumber, $itemnumber ) = @_;
3288 my $dbh = C4::Context->dbh;
3290 my $item = Koha::Items->find($itemnumber) or return;
3291 my $itemissue = $item->checkout or return;
3293 $borrowernumber ||= $itemissue->borrowernumber;
3294 my $patron = Koha::Patrons->find( $borrowernumber )
3297 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3298 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3300 categorycode => $patron->categorycode,
3301 itemtype => $item->effective_itemtype,
3302 branchcode => $branchcode,
3304 'no_auto_renewal_after',
3305 'no_auto_renewal_after_hard_limit',
3311 return unless $circulation_rules;
3313 if ( not $circulation_rules->{no_auto_renewal_after}
3314 or $circulation_rules->{no_auto_renewal_after} eq '' )
3315 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3316 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3318 my $maximum_renewal_date;
3319 if ( $circulation_rules->{no_auto_renewal_after} ) {
3320 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3321 $maximum_renewal_date->add(
3322 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3326 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3327 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3328 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3330 return $maximum_renewal_date;
3334 =head2 GetIssuingCharges
3336 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3338 Calculate how much it would cost for a given patron to borrow a given
3339 item, including any applicable discounts.
3341 C<$itemnumber> is the item number of item the patron wishes to borrow.
3343 C<$borrowernumber> is the patron's borrower number.
3345 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3346 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3351 sub GetIssuingCharges {
3353 # calculate charges due
3354 my ( $itemnumber, $borrowernumber ) = @_;
3356 my $dbh = C4::Context->dbh;
3359 # Get the book's item type and rental charge (via its biblioitem).
3360 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3361 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3362 $charge_query .= (C4::Context->preference('item-level_itypes'))
3363 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3364 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3366 $charge_query .= ' WHERE items.itemnumber =?';
3368 my $sth = $dbh->prepare($charge_query);
3369 $sth->execute($itemnumber);
3370 if ( my $item_data = $sth->fetchrow_hashref ) {
3371 $item_type = $item_data->{itemtype};
3372 $charge = $item_data->{rentalcharge};
3373 # FIXME This should follow CircControl
3374 my $branch = C4::Context::mybranch();
3375 my $patron = Koha::Patrons->find( $borrowernumber );
3376 my $discount = Koha::CirculationRules->get_effective_rule({
3377 categorycode => $patron->categorycode,
3378 branchcode => $branch,
3379 itemtype => $item_type,
3380 rule_name => 'rentaldiscount'
3383 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3386 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3390 return ( $charge, $item_type );
3393 =head2 AddIssuingCharge
3395 &AddIssuingCharge( $checkout, $charge, $type )
3399 sub AddIssuingCharge {
3400 my ( $checkout, $charge, $type ) = @_;
3402 # FIXME What if checkout does not exist?
3404 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3405 my $accountline = $account->add_debit(
3409 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3410 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3411 interface => C4::Context->interface,
3413 item_id => $checkout->itemnumber,
3414 issue_id => $checkout->issue_id,
3421 GetTransfers($itemnumber);
3426 my ($itemnumber) = @_;
3428 my $dbh = C4::Context->dbh;
3437 FROM branchtransfers
3438 WHERE itemnumber = ?
3439 AND datearrived IS NULL
3440 AND datecancelled IS NULL
3442 my $sth = $dbh->prepare($query);
3443 $sth->execute($itemnumber);
3444 my @row = $sth->fetchrow_array();
3448 =head2 GetTransfersFromTo
3450 @results = GetTransfersFromTo($frombranch,$tobranch);
3452 Returns the list of pending transfers between $from and $to branch
3456 sub GetTransfersFromTo {
3457 my ( $frombranch, $tobranch ) = @_;
3458 return unless ( $frombranch && $tobranch );
3459 my $dbh = C4::Context->dbh;
3461 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3462 FROM branchtransfers
3465 AND datecancelled IS NULL
3466 AND datesent IS NOT NULL
3467 AND datearrived IS NULL
3469 my $sth = $dbh->prepare($query);
3470 $sth->execute( $frombranch, $tobranch );
3473 while ( my $data = $sth->fetchrow_hashref ) {
3474 push @gettransfers, $data;
3476 return (@gettransfers);
3479 =head2 DeleteTransfer
3481 &DeleteTransfer($itemnumber);
3485 sub DeleteTransfer {
3486 my ($itemnumber) = @_;
3487 return unless $itemnumber;
3488 my $dbh = C4::Context->dbh;
3489 my $sth = $dbh->prepare(
3490 "DELETE FROM branchtransfers
3492 AND datearrived IS NULL "
3494 return $sth->execute($itemnumber);
3497 =head2 SendCirculationAlert
3499 Send out a C<check-in> or C<checkout> alert using the messaging system.
3507 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3511 Hashref of information about the item being checked in or out.
3515 Hashref of information about the borrower of the item.
3519 The branchcode from where the checkout or check-in took place.
3525 SendCirculationAlert({
3528 borrower => $borrower,
3534 sub SendCirculationAlert {
3536 my ($type, $item, $borrower, $branch) =
3537 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3538 my %message_name = (
3539 CHECKIN => 'Item_Check_in',
3540 CHECKOUT => 'Item_Checkout',
3541 RENEWAL => 'Item_Checkout',
3543 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3544 borrowernumber => $borrower->{borrowernumber},
3545 message_name => $message_name{$type},
3547 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3549 my $schema = Koha::Database->new->schema;
3550 my @transports = keys %{ $borrower_preferences->{transports} };
3552 # From the MySQL doc:
3553 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3554 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3555 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3556 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3558 for my $mtt (@transports) {
3559 my $letter = C4::Letters::GetPreparedLetter (
3560 module => 'circulation',
3561 letter_code => $type,
3562 branchcode => $branch,
3563 message_transport_type => $mtt,
3564 lang => $borrower->{lang},
3566 $issues_table => $item->{itemnumber},
3567 'items' => $item->{itemnumber},
3568 'biblio' => $item->{biblionumber},
3569 'biblioitems' => $item->{biblionumber},
3570 'borrowers' => $borrower,
3571 'branches' => $branch,
3575 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3576 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3577 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3578 unless ( $message ) {
3579 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3580 C4::Message->enqueue($letter, $borrower, $mtt);
3582 $message->append($letter);
3585 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3591 =head2 updateWrongTransfer
3593 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3595 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
3599 sub updateWrongTransfer {
3600 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3601 my $dbh = C4::Context->dbh;
3602 # first step validate the actual line of transfert .
3605 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3607 $sth->execute($FromLibrary,$itemNumber);
3609 # second step create a new line of branchtransfer to the right location .
3610 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3612 #third step changing holdingbranch of item
3613 my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3618 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3620 this function calculates the due date given the start date and configured circulation rules,
3621 checking against the holidays calendar as per the daysmode circulation rule.
3622 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3623 C<$itemtype> = itemtype code of item in question
3624 C<$branch> = location whose calendar to use
3625 C<$borrower> = Borrower object
3626 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3631 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3635 # loanlength now a href
3637 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3639 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3645 if (ref $startdate ne 'DateTime' ) {
3646 $datedue = dt_from_string($datedue);
3648 $datedue = $startdate->clone;
3651 $datedue = dt_from_string()->truncate( to => 'minute' );
3655 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3657 categorycode => $borrower->{categorycode},
3658 itemtype => $itemtype,
3659 branchcode => $branch,
3663 # calculate the datedue as normal
3664 if ( $daysmode eq 'Days' )
3665 { # ignoring calendar
3666 if ( $loanlength->{lengthunit} eq 'hours' ) {
3667 $datedue->add( hours => $loanlength->{$length_key} );
3669 $datedue->add( days => $loanlength->{$length_key} );
3670 $datedue->set_hour(23);
3671 $datedue->set_minute(59);
3675 if ($loanlength->{lengthunit} eq 'hours') {
3676 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3679 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3681 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3682 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3683 if ($loanlength->{lengthunit} eq 'days') {
3684 $datedue->set_hour(23);
3685 $datedue->set_minute(59);
3689 # if Hard Due Dates are used, retrieve them and apply as necessary
3690 my ( $hardduedate, $hardduedatecompare ) =
3691 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3692 if ($hardduedate) { # hardduedates are currently dates
3693 $hardduedate->truncate( to => 'minute' );
3694 $hardduedate->set_hour(23);
3695 $hardduedate->set_minute(59);
3696 my $cmp = DateTime->compare( $hardduedate, $datedue );
3698 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3699 # if the calculated date is before the 'after' Hard Due Date (floor), override
3700 # if the hard due date is set to 'exactly', overrride
3701 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3702 $datedue = $hardduedate->clone;
3705 # in all other cases, keep the date due as it is
3709 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3710 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3711 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3712 if( $expiry_dt ) { #skip empty expiry date..
3713 $expiry_dt->set( hour => 23, minute => 59);
3714 my $d1= $datedue->clone->set_time_zone('floating');
3715 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3716 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3719 if ( $daysmode ne 'Days' ) {
3720 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3721 if ( $calendar->is_holiday($datedue) ) {
3722 # Don't return on a closed day
3723 $datedue = $calendar->prev_open_days( $datedue, 1 );
3732 sub CheckValidBarcode{
3734 my $dbh = C4::Context->dbh;
3735 my $query=qq|SELECT count(*)
3739 my $sth = $dbh->prepare($query);
3740 $sth->execute($barcode);
3741 my $exist=$sth->fetchrow ;
3745 =head2 IsBranchTransferAllowed
3747 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3749 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3751 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3752 Koha::Item->can_be_transferred.
3756 sub IsBranchTransferAllowed {
3757 my ( $toBranch, $fromBranch, $code ) = @_;
3759 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3761 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3762 my $dbh = C4::Context->dbh;
3764 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3765 $sth->execute( $toBranch, $fromBranch, $code );
3766 my $limit = $sth->fetchrow_hashref();
3768 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3769 if ( $limit->{'limitId'} ) {
3776 =head2 CreateBranchTransferLimit
3778 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3780 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3782 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3786 sub CreateBranchTransferLimit {
3787 my ( $toBranch, $fromBranch, $code ) = @_;
3788 return unless defined($toBranch) && defined($fromBranch);
3789 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3791 my $dbh = C4::Context->dbh;
3793 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3794 return $sth->execute( $code, $toBranch, $fromBranch );
3797 =head2 DeleteBranchTransferLimits
3799 my $result = DeleteBranchTransferLimits($frombranch);
3801 Deletes all the library transfer limits for one library. Returns the
3802 number of limits deleted, 0e0 if no limits were deleted, or undef if
3803 no arguments are supplied.
3805 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3806 fromBranch => $fromBranch
3811 sub DeleteBranchTransferLimits {
3813 return unless defined $branch;
3814 my $dbh = C4::Context->dbh;
3815 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3816 return $sth->execute($branch);
3820 my ( $borrowernumber, $itemnum ) = @_;
3821 MarkIssueReturned( $borrowernumber, $itemnum );
3826 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3828 The final optional parameter, C<$params>, expected to contain
3829 'skip_record_index' key, which relayed down to Koha::Item/store,
3830 there it prevents calling of ModZebra index_records,
3831 which takes most of the time in batch adds/deletes: index_records better
3832 to be called later in C<additem.pl> after the whole loop.
3835 skip_record_index => 1|0
3840 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3842 unless ( $mark_lost_from ) {
3843 # Temporary check to avoid regressions
3844 die q|LostItem called without $mark_lost_from, check the API.|;
3848 if ( $force_mark_returned ) {
3851 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3852 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3855 my $dbh = C4::Context->dbh();
3856 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3858 JOIN items USING (itemnumber)
3859 JOIN biblio USING (biblionumber)
3860 WHERE issues.itemnumber=?");
3861 $sth->execute($itemnumber);
3862 my $issues=$sth->fetchrow_hashref();
3864 # If a borrower lost the item, add a replacement cost to the their record
3865 if ( my $borrowernumber = $issues->{borrowernumber} ){
3866 my $patron = Koha::Patrons->find( $borrowernumber );
3868 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3869 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3871 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3872 C4::Accounts::chargelostitem(
3875 $issues->{'replacementprice'},
3876 sprintf( "%s %s %s",
3877 $issues->{'title'} || q{},
3878 $issues->{'barcode'} || q{},
3879 $issues->{'itemcallnumber'} || q{},
3882 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3883 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3886 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3889 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3890 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3891 Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store({ skip_record_index => $params->{skip_record_index} });
3893 my $transferdeleted = DeleteTransfer($itemnumber);
3896 sub GetOfflineOperations {
3897 my $dbh = C4::Context->dbh;
3898 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3899 $sth->execute(C4::Context->userenv->{'branch'});
3900 my $results = $sth->fetchall_arrayref({});
3904 sub GetOfflineOperation {
3905 my $operationid = shift;
3906 return unless $operationid;
3907 my $dbh = C4::Context->dbh;
3908 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3909 $sth->execute( $operationid );
3910 return $sth->fetchrow_hashref;
3913 sub AddOfflineOperation {
3914 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3915 my $dbh = C4::Context->dbh;
3916 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3917 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3921 sub DeleteOfflineOperation {
3922 my $dbh = C4::Context->dbh;
3923 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3924 $sth->execute( shift );
3928 sub ProcessOfflineOperation {
3929 my $operation = shift;
3932 if ( $operation->{action} eq 'return' ) {
3933 $report = ProcessOfflineReturn( $operation );
3934 } elsif ( $operation->{action} eq 'issue' ) {
3935 $report = ProcessOfflineIssue( $operation );
3936 } elsif ( $operation->{action} eq 'payment' ) {
3937 $report = ProcessOfflinePayment( $operation );
3940 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3945 sub ProcessOfflineReturn {
3946 my $operation = shift;
3948 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3951 my $itemnumber = $item->itemnumber;
3952 my $issue = GetOpenIssue( $itemnumber );
3954 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3955 ModDateLastSeen( $itemnumber, $leave_item_lost );
3957 $issue->{borrowernumber},
3959 $operation->{timestamp},
3962 $item->onloan(undef);
3963 $item->store({ log_action => 0 });
3966 return "Item not issued.";
3969 return "Item not found.";
3973 sub ProcessOfflineIssue {
3974 my $operation = shift;
3976 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3979 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3981 return "Barcode not found.";
3983 my $itemnumber = $item->itemnumber;
3984 my $issue = GetOpenIssue( $itemnumber );
3986 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3988 $issue->{borrowernumber},
3990 $operation->{timestamp},
3995 $operation->{'barcode'},
3998 $operation->{timestamp},
4003 return "Borrower not found.";
4007 sub ProcessOfflinePayment {
4008 my $operation = shift;
4010 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4012 $patron->account->pay(
4014 amount => $operation->{amount},
4015 library_id => $operation->{branchcode},
4025 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4027 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4032 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4036 ? Koha::Items->find($itemnumber)
4037 : Koha::Items->find( { barcode => $barcode } );
4041 return C4::Letters::GetPreparedLetter (
4042 module => 'circulation',
4043 letter_code => 'TRANSFERSLIP',
4044 branchcode => $branch,
4046 'branches' => $to_branch,
4047 'biblio' => $item->biblionumber,
4048 'items' => $item->unblessed,
4053 =head2 CheckIfIssuedToPatron
4055 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4057 Return 1 if any record item is issued to patron, otherwise return 0
4061 sub CheckIfIssuedToPatron {
4062 my ($borrowernumber, $biblionumber) = @_;
4064 my $dbh = C4::Context->dbh;
4066 SELECT COUNT(*) FROM issues
4067 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4068 WHERE items.biblionumber = ?
4069 AND issues.borrowernumber = ?
4071 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4072 return 1 if $is_issued;
4078 IsItemIssued( $itemnumber )
4080 Return 1 if the item is on loan, otherwise return 0
4085 my $itemnumber = shift;
4086 my $dbh = C4::Context->dbh;
4087 my $sth = $dbh->prepare(q{
4090 WHERE itemnumber = ?
4092 $sth->execute($itemnumber);
4093 return $sth->fetchrow;
4096 =head2 GetAgeRestriction
4098 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4099 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4101 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4102 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4104 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4105 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4106 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4107 Negative days mean the borrower has gone past the age restriction age.
4111 sub GetAgeRestriction {
4112 my ($record_restrictions, $borrower) = @_;
4113 my $markers = C4::Context->preference('AgeRestrictionMarker');
4115 return unless $record_restrictions;
4116 # Split $record_restrictions to something like FSK 16 or PEGI 6
4117 my @values = split ' ', uc($record_restrictions);
4118 return unless @values;
4120 # Search first occurrence of one of the markers
4121 my @markers = split /\|/, uc($markers);
4122 return unless @markers;
4125 my $restriction_year = 0;
4126 for my $value (@values) {
4128 for my $marker (@markers) {
4129 $marker =~ s/^\s+//; #remove leading spaces
4130 $marker =~ s/\s+$//; #remove trailing spaces
4131 if ( $marker eq $value ) {
4132 if ( $index <= $#values ) {
4133 $restriction_year += $values[$index];
4137 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4139 # Perhaps it is something like "K16" (as in Finland)
4140 $restriction_year += $1;
4144 last if ( $restriction_year > 0 );
4147 #Check if the borrower is age restricted for this material and for how long.
4148 if ($restriction_year && $borrower) {
4149 if ( $borrower->{'dateofbirth'} ) {
4150 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4151 $alloweddate[0] += $restriction_year;
4153 #Prevent runime eror on leap year (invalid date)
4154 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4155 $alloweddate[2] = 28;
4158 #Get how many days the borrower has to reach the age restriction
4159 my @Today = split /-/, dt_from_string()->ymd();
4160 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4161 #Negative days means the borrower went past the age restriction age
4162 return ($restriction_year, $daysToAgeRestriction);
4166 return ($restriction_year);
4170 =head2 GetPendingOnSiteCheckouts
4174 sub GetPendingOnSiteCheckouts {
4175 my $dbh = C4::Context->dbh;
4176 return $dbh->selectall_arrayref(q|
4182 items.itemcallnumber,
4186 issues.date_due < NOW() AS is_overdue,
4189 borrowers.firstname,
4191 borrowers.cardnumber,
4192 borrowers.borrowernumber
4194 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4195 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4196 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4197 WHERE issues.onsite_checkout = 1
4198 |, { Slice => {} } );
4204 my ($count, $branch, $itemtype, $ccode, $newness)
4205 = @$params{qw(count branch itemtype ccode newness)};
4207 my $dbh = C4::Context->dbh;
4210 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4211 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4212 i.ccode, SUM(i.issues) AS count
4214 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4215 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4218 my (@where_strs, @where_args);
4221 push @where_strs, 'i.homebranch = ?';
4222 push @where_args, $branch;
4225 if (C4::Context->preference('item-level_itypes')){
4226 push @where_strs, 'i.itype = ?';
4227 push @where_args, $itemtype;
4229 push @where_strs, 'bi.itemtype = ?';
4230 push @where_args, $itemtype;
4234 push @where_strs, 'i.ccode = ?';
4235 push @where_args, $ccode;
4238 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4239 push @where_args, $newness;
4243 $query .= 'WHERE ' . join(' AND ', @where_strs);
4247 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4248 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4253 $query .= q{ ) xxx WHERE count > 0 };
4254 $count = int($count);
4256 $query .= "LIMIT $count";
4259 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4264 =head2 Internal methods
4268 sub _CalculateAndUpdateFine {
4271 my $borrower = $params->{borrower};
4272 my $item = $params->{item};
4273 my $issue = $params->{issue};
4274 my $return_date = $params->{return_date};
4276 unless ($borrower) { carp "No borrower passed in!" && return; }
4277 unless ($item) { carp "No item passed in!" && return; }
4278 unless ($issue) { carp "No issue passed in!" && return; }
4280 my $datedue = dt_from_string( $issue->date_due );
4282 # we only need to calculate and change the fines if we want to do that on return
4283 # Should be on for hourly loans
4284 my $control = C4::Context->preference('CircControl');
4285 my $control_branchcode =
4286 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4287 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4288 : $issue->branchcode;
4290 my $date_returned = $return_date ? $return_date : dt_from_string();
4292 my ( $amount, $unitcounttotal, $unitcount ) =
4293 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4295 if ( C4::Context->preference('finesMode') eq 'production' ) {
4296 if ( $amount > 0 ) {
4297 C4::Overdues::UpdateFine({
4298 issue_id => $issue->issue_id,
4299 itemnumber => $issue->itemnumber,
4300 borrowernumber => $issue->borrowernumber,
4302 due => output_pref($datedue),
4305 elsif ($return_date) {
4307 # Backdated returns may have fines that shouldn't exist,
4308 # so in this case, we need to drop those fines to 0
4310 C4::Overdues::UpdateFine({
4311 issue_id => $issue->issue_id,
4312 itemnumber => $issue->itemnumber,
4313 borrowernumber => $issue->borrowernumber,
4315 due => output_pref($datedue),
4321 sub _item_denied_renewal {
4324 my $item = $params->{item};
4325 return unless $item;
4327 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4328 return unless $denyingrules;
4329 foreach my $field (keys %$denyingrules) {
4330 my $val = $item->$field;
4331 if( !defined $val) {
4332 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4335 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4336 # If the results matches the values in the syspref
4337 # We return true if match found
4350 Koha Development Team <http://koha-community.org/>