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;
37 use C4::Log; # logaction
38 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
39 use C4::RotatingCollections qw(GetCollectionItemBranches);
40 use Algorithm::CheckDigits;
44 use Koha::AuthorisedValues;
45 use Koha::Biblioitems;
49 use Koha::Illrequests;
52 use Koha::Patron::Debarments;
55 use Koha::Account::Lines;
57 use Koha::Account::Lines;
58 use Koha::Account::Offsets;
59 use Koha::Config::SysPrefs;
60 use Koha::Charges::Fees;
61 use Koha::Config::SysPref;
62 use Koha::Checkouts::ReturnClaims;
63 use Koha::SearchEngine::Indexer;
64 use Koha::Exceptions::Checkout;
66 use List::MoreUtils qw( uniq any );
67 use Scalar::Util qw( looks_like_number );
78 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
84 # FIXME subs that should probably be elsewhere
89 &GetPendingOnSiteCheckouts
92 # subs to deal with issuing a book
100 &GetLatestAutoRenewDate
102 &GetBranchBorrowerCircRule
105 &CheckIfIssuedToPatron
110 # subs to deal with returns
116 # subs to deal with transfers
122 &IsBranchTransferAllowed
123 &CreateBranchTransferLimit
124 &DeleteBranchTransferLimits
128 # subs to deal with offline circulation
130 &GetOfflineOperations
133 &DeleteOfflineOperation
134 &ProcessOfflineOperation
140 C4::Circulation - Koha circulation module
148 The functions in this module deal with circulation, issues, and
149 returns, as well as general information about the library.
150 Also deals with inventory.
156 $str = &barcodedecode($barcode, [$filter]);
158 Generic filter function for barcode string.
159 Called on every circ if the System Pref itemBarcodeInputFilter is set.
160 Will do some manipulation of the barcode for systems that deliver a barcode
161 to circulation.pl that differs from the barcode stored for the item.
162 For proper functioning of this filter, calling the function on the
163 correct barcode string (items.barcode) should return an unaltered barcode.
165 The optional $filter argument is to allow for testing or explicit
166 behavior that ignores the System Pref. Valid values are the same as the
171 # FIXME -- the &decode fcn below should be wrapped into this one.
172 # FIXME -- these plugins should be moved out of Circulation.pm
175 my ($barcode, $filter) = @_;
176 my $branch = C4::Context::mybranch();
177 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
178 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
179 if ($filter eq 'whitespace') {
181 } elsif ($filter eq 'cuecat') {
183 my @fields = split( /\./, $barcode );
184 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
185 ($#results == 2) and return $results[2];
186 } elsif ($filter eq 'T-prefix') {
187 if ($barcode =~ /^[Tt](\d)/) {
188 (defined($1) and $1 eq '0') and return $barcode;
189 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
191 return sprintf("T%07d", $barcode);
192 # FIXME: $barcode could be "T1", causing warning: substr outside of string
193 # Why drop the nonzero digit after the T?
194 # Why pass non-digits (or empty string) to "T%07d"?
195 } elsif ($filter eq 'libsuite8') {
196 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
197 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
198 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
200 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
203 } elsif ($filter eq 'EAN13') {
204 my $ean = CheckDigits('ean');
205 if ( $ean->is_valid($barcode) ) {
206 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
207 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
209 warn "# [$barcode] not valid EAN-13/UPC-A\n";
212 return $barcode; # return barcode, modified or not
217 $str = &_decode($chunk);
219 Decodes a segment of a string emitted by a CueCat barcode scanner and
222 FIXME: Should be replaced with Barcode::Cuecat from CPAN
223 or Javascript based decoding on the client side.
230 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
231 my @s = map { index( $seq, $_ ); } split( //, $encoded );
232 my $l = ( $#s + 1 ) % 4;
235 # warn "Error: Cuecat decode parsing failed!";
243 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
245 chr( ( $n >> 16 ) ^ 67 )
246 .chr( ( $n >> 8 & 255 ) ^ 67 )
247 .chr( ( $n & 255 ) ^ 67 );
250 $r = substr( $r, 0, length($r) - $l );
256 ($dotransfer, $messages, $iteminformation) = &transferbook({
257 from_branch => $frombranch
258 to_branch => $tobranch,
260 ignore_reserves => $ignore_reserves,
264 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
266 C<$fbr> is the code for the branch initiating the transfer.
267 C<$tbr> is the code for the branch to which the item should be transferred.
269 C<$barcode> is the barcode of the item to be transferred.
271 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
272 Otherwise, if an item is reserved, the transfer fails.
274 C<$trigger> is the enum value for what triggered the transfer.
276 Returns three values:
282 is true if the transfer was successful.
286 is a reference-to-hash which may have any of the following keys:
292 There is no item in the catalog with the given barcode. The value is C<$barcode>.
294 =item C<DestinationEqualsHolding>
296 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.
300 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.
304 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>.
306 =item C<WasTransferred>
308 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
318 my $tbr = $params->{to_branch};
319 my $fbr = $params->{from_branch};
320 my $ignoreRs = $params->{ignore_reserves};
321 my $barcode = $params->{barcode};
322 my $trigger = $params->{trigger};
325 my $item = Koha::Items->find( { barcode => $barcode } );
327 Koha::Exceptions::MissingParameter->throw(
328 "Missing mandatory parameter: from_branch")
331 Koha::Exceptions::MissingParameter->throw(
332 "Missing mandatory parameter: to_branch")
337 $messages->{'BadBarcode'} = $barcode;
339 return ( $dotransfer, $messages );
342 my $itemnumber = $item->itemnumber;
343 # get branches of book...
344 my $hbr = $item->homebranch;
346 # if using Branch Transfer Limits
347 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
348 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
349 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
350 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
351 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
354 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
355 $messages->{'NotAllowed'} = $tbr . "::" . $code;
360 # can't transfer book if is already there....
361 if ( $fbr eq $tbr ) {
362 $messages->{'DestinationEqualsHolding'} = 1;
366 # check if it is still issued to someone, return it...
367 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
369 AddReturn( $barcode, $fbr );
370 $messages->{'WasReturned'} = $issue->borrowernumber;
374 # That'll save a database query.
375 my ( $resfound, $resrec, undef ) =
376 CheckReserves( $itemnumber );
378 $resrec->{'ResFound'} = $resfound;
379 $messages->{'ResFound'} = $resrec;
380 $dotransfer = 0 unless $ignoreRs;
383 #actually do the transfer....
385 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
387 # don't need to update MARC anymore, we do it in batch now
388 $messages->{'WasTransfered'} = $tbr;
391 ModDateLastSeen( $itemnumber );
392 return ( $dotransfer, $messages );
397 my $borrower = shift;
398 my $item_object = shift;
400 my $onsite_checkout = $params->{onsite_checkout} || 0;
401 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
402 my $cat_borrower = $borrower->{'categorycode'};
403 my $dbh = C4::Context->dbh;
404 # Get which branchcode we need
405 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
406 my $type = $item_object->effective_itemtype;
408 my ($type_object, $parent_type, $parent_maxissueqty_rule);
409 $type_object = Koha::ItemTypes->find( $type );
410 $parent_type = $type_object->parent_type if $type_object;
411 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
412 # Find any children if we are a parent_type;
414 # given branch, patron category, and item type, determine
415 # applicable issuing rule
417 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
419 categorycode => $cat_borrower,
420 itemtype => $parent_type,
421 branchcode => $branch,
422 rule_name => 'maxissueqty',
425 # If the parent rule is for default type we discount it
426 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
428 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
430 categorycode => $cat_borrower,
432 branchcode => $branch,
433 rule_name => 'maxissueqty',
437 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
439 categorycode => $cat_borrower,
441 branchcode => $branch,
442 rule_name => 'maxonsiteissueqty',
447 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
448 # if a rule is found and has a loan limit set, count
449 # how many loans the patron already has that meet that
451 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
454 if ( $maxissueqty_rule->branchcode ) {
455 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
456 $checkouts = $patron->checkouts->search(
457 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
458 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
459 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
461 $checkouts = $patron->checkouts->search(
462 { 'item.homebranch' => $maxissueqty_rule->branchcode },
463 { prefetch => 'item' } );
466 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
469 my $rule_itemtype = $maxissueqty_rule->itemtype;
470 while ( my $c = $checkouts->next ) {
471 my $itemtype = $c->item->effective_itemtype;
473 unless ( $rule_itemtype ) {
474 # matching rule has the default item type, so count only
475 # those existing loans that don't fall under a more
477 @types = Koha::CirculationRules->search(
479 branchcode => $maxissueqty_rule->branchcode,
480 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
481 itemtype => { '!=' => undef },
482 rule_name => 'maxissueqty'
484 )->get_column('itemtype');
486 next if grep {$_ eq $itemtype} @types;
489 if ( $parent_maxissueqty_rule ) {
490 # if we have a parent item type then we count loans of the
491 # specific item type or its siblings or parent
492 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
493 @types = $children->get_column('itemtype');
494 push @types, $parent_type;
495 } elsif ( $child_types ) {
496 # If we are a parent type, we need to count all child types and our own type
497 @types = $child_types->get_column('itemtype');
498 push @types, $type; # And don't forget to count our own types
499 } else { push @types, $type; } # Otherwise only count the specific itemtype
501 next unless grep {$_ eq $itemtype} @types;
503 $sum_checkouts->{total}++;
504 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
505 $sum_checkouts->{itemtype}->{$itemtype}++;
508 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
509 my $checkout_count = $sum_checkouts->{total} || 0;
510 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
512 my $checkout_rules = {
513 checkout_count => $checkout_count,
514 onsite_checkout_count => $onsite_checkout_count,
515 onsite_checkout => $onsite_checkout,
516 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
517 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
518 switch_onsite_checkout => $switch_onsite_checkout,
520 # If parent rules exists
521 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
522 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
523 my $qty_over = _check_max_qty($checkout_rules);
524 return $qty_over if defined $qty_over;
526 # If the parent rule is less than or equal to the child, we only need check the parent
527 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
528 $checkout_rules->{checkout_count} = $checkout_count_type;
529 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
530 my $qty_over = _check_max_qty($checkout_rules);
531 return $qty_over if defined $qty_over;
534 my $qty_over = _check_max_qty($checkout_rules);
535 return $qty_over if defined $qty_over;
539 # Now count total loans against the limit for the branch
540 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
541 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
543 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
544 $checkouts = $patron->checkouts->search(
545 { 'me.branchcode' => $branch} );
546 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
547 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
549 $checkouts = $patron->checkouts->search(
550 { 'item.homebranch' => $branch},
551 { prefetch => 'item' } );
554 my $checkout_count = $checkouts->count;
555 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
556 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
557 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
559 my $qty_over = _check_max_qty(
561 checkout_count => $checkout_count,
562 onsite_checkout_count => $onsite_checkout_count,
563 onsite_checkout => $onsite_checkout,
564 max_checkouts_allowed => $max_checkouts_allowed,
565 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
566 switch_onsite_checkout => $switch_onsite_checkout
569 return $qty_over if defined $qty_over;
572 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
573 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
576 # OK, the patron can issue !!!
582 my $checkout_count = $params->{checkout_count};
583 my $onsite_checkout_count = $params->{onsite_checkout_count};
584 my $onsite_checkout = $params->{onsite_checkout};
585 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
586 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
587 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
589 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
590 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
591 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
593 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
594 count => $onsite_checkout_count,
595 max_allowed => $max_onsite_checkouts_allowed,
599 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
600 if ( $max_checkouts_allowed eq '' ) { return; }
601 my $delta = $switch_onsite_checkout ? 1 : 0;
602 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
604 reason => 'TOO_MANY_CHECKOUTS',
605 count => $checkout_count,
606 max_allowed => $max_checkouts_allowed,
610 elsif ( not $onsite_checkout ) {
611 if ( $max_checkouts_allowed eq '' ) { return; }
613 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
616 reason => 'TOO_MANY_CHECKOUTS',
617 count => $checkout_count - $onsite_checkout_count,
618 max_allowed => $max_checkouts_allowed,
626 =head2 CanBookBeIssued
628 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
629 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
631 Check if a book can be issued.
633 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
635 IMPORTANT: The assumption by users of this routine is that causes blocking
636 the issue are keyed by uppercase labels and other returned
637 data is keyed in lower case!
641 =item C<$patron> is a Koha::Patron
643 =item C<$barcode> is the bar code of the book being issued.
645 =item C<$duedates> is a DateTime object.
647 =item C<$inprocess> boolean switch
649 =item C<$ignore_reserves> boolean switch
651 =item C<$params> Hashref of additional parameters
654 override_high_holds - Ignore high holds
655 onsite_checkout - Checkout is an onsite checkout that will not leave the library
663 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
664 Possible values are :
670 sticky due date is invalid
674 borrower gone with no address
678 borrower declared it's card lost
684 =head3 UNKNOWN_BARCODE
698 item is restricted (set by ??)
700 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
701 could be prevented, but ones that can be overriden by the operator.
703 Possible values are :
711 renewing, not issuing
713 =head3 ISSUED_TO_ANOTHER
715 issued to someone else.
719 reserved for someone else.
723 reserved and being transferred for someone else.
727 sticky due date is invalid or due date in the past
731 if the borrower borrows to much things
735 sub CanBookBeIssued {
736 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
737 my %needsconfirmation; # filled with problems that needs confirmations
738 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
739 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
740 my %messages; # filled with information messages that should be displayed.
742 my $onsite_checkout = $params->{onsite_checkout} || 0;
743 my $override_high_holds = $params->{override_high_holds} || 0;
745 my $item_object = Koha::Items->find({barcode => $barcode });
747 # MANDATORY CHECKS - unless item exists, nothing else matters
748 unless ( $item_object ) {
749 $issuingimpossible{UNKNOWN_BARCODE} = 1;
751 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
753 my $item_unblessed = $item_object->unblessed; # Transition...
754 my $issue = $item_object->checkout;
755 my $biblio = $item_object->biblio;
757 my $biblioitem = $biblio->biblioitem;
758 my $effective_itemtype = $item_object->effective_itemtype;
759 my $dbh = C4::Context->dbh;
760 my $patron_unblessed = $patron->unblessed;
762 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
764 # DUE DATE is OK ? -- should already have checked.
766 if ($duedate && ref $duedate ne 'DateTime') {
767 $duedate = dt_from_string($duedate);
769 my $now = dt_from_string();
770 unless ( $duedate ) {
771 my $issuedate = $now->clone();
773 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
775 # Offline circ calls AddIssue directly, doesn't run through here
776 # So issuingimpossible should be ok.
779 my $fees = Koha::Charges::Fees->new(
782 library => $circ_library,
783 item => $item_object,
789 my $today = $now->clone();
790 $today->truncate( to => 'minute');
791 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
792 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
795 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
801 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
802 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
804 branch => C4::Context->userenv->{'branch'},
806 itemnumber => $item_object->itemnumber,
807 itemtype => $effective_itemtype,
808 borrowernumber => $patron->borrowernumber,
809 ccode => $item_object->ccode}
811 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
812 return( { STATS => 1 }, {});
815 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
816 $issuingimpossible{GNA} = 1;
819 if ( $patron->lost && $patron->lost == 1 ) {
820 $issuingimpossible{CARD_LOST} = 1;
822 if ( $patron->is_debarred ) {
823 $issuingimpossible{DEBARRED} = 1;
826 if ( $patron->is_expired ) {
827 $issuingimpossible{EXPIRED} = 1;
835 my $account = $patron->account;
836 my $balance = $account->balance;
837 my $non_issues_charges = $account->non_issues_charges;
838 my $other_charges = $balance - $non_issues_charges;
840 my $amountlimit = C4::Context->preference("noissuescharge");
841 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
842 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
844 # Check the debt of this patrons guarantees
845 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
846 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
847 if ( defined $no_issues_charge_guarantees ) {
848 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
849 my $guarantees_non_issues_charges = 0;
850 foreach my $g ( @guarantees ) {
851 $guarantees_non_issues_charges += $g->account->non_issues_charges;
854 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
855 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
856 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
857 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
858 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
859 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
863 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
864 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
865 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
866 if ( defined $no_issues_charge_guarantors ) {
867 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
869 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
870 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
871 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
872 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
873 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
874 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
878 if ( C4::Context->preference("IssuingInProcess") ) {
879 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
880 $issuingimpossible{DEBT} = $non_issues_charges;
881 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
882 $needsconfirmation{DEBT} = $non_issues_charges;
883 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
884 $needsconfirmation{DEBT} = $non_issues_charges;
888 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
889 $needsconfirmation{DEBT} = $non_issues_charges;
890 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
891 $issuingimpossible{DEBT} = $non_issues_charges;
892 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
893 $needsconfirmation{DEBT} = $non_issues_charges;
897 if ($balance > 0 && $other_charges > 0) {
898 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
901 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
902 $patron_unblessed = $patron->unblessed;
904 if ( my $debarred_date = $patron->is_debarred ) {
905 # patron has accrued fine days or has a restriction. $count is a date
906 if ($debarred_date eq '9999-12-31') {
907 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
910 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
912 } elsif ( my $num_overdues = $patron->has_overdues ) {
913 ## patron has outstanding overdue loans
914 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
915 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
917 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
918 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
922 # Additional Materials Check
923 if ( C4::Context->preference("CircConfirmItemParts")
924 && $item_object->materials )
926 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
930 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
932 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
934 # Already issued to current borrower.
935 # If it is an on-site checkout if it can be switched to a normal checkout
936 # or ask whether the loan should be renewed
938 if ( $issue->onsite_checkout
939 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
940 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
942 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
943 $patron->borrowernumber,
944 $item_object->itemnumber,
946 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
947 if ( $renewerror eq 'onsite_checkout' ) {
948 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
951 $issuingimpossible{NO_MORE_RENEWALS} = 1;
955 $needsconfirmation{RENEW_ISSUE} = 1;
961 # issued to someone else
963 my $patron = Koha::Patrons->find( $issue->borrowernumber );
965 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
967 unless ( $can_be_returned ) {
968 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
969 $issuingimpossible{branch_to_return} = $message;
971 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
972 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
974 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
975 $needsconfirmation{issued_firstname} = $patron->firstname;
976 $needsconfirmation{issued_surname} = $patron->surname;
977 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
978 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
983 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
985 my $switch_onsite_checkout = (
986 C4::Context->preference('SwitchOnSiteCheckouts')
988 and $issue->onsite_checkout
989 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
990 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
991 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
992 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
993 if ( $toomany->{max_allowed} == 0 ) {
994 $needsconfirmation{PATRON_CANT} = 1;
996 if ( C4::Context->preference("AllowTooManyOverride") ) {
997 $needsconfirmation{TOO_MANY} = $toomany->{reason};
998 $needsconfirmation{current_loan_count} = $toomany->{count};
999 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1001 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1002 $issuingimpossible{current_loan_count} = $toomany->{count};
1003 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1008 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1010 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1011 my $wants_check = $patron->wants_check_for_previous_checkout;
1012 $needsconfirmation{PREVISSUE} = 1
1013 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1018 if ( $item_object->notforloan )
1020 if(!C4::Context->preference("AllowNotForLoanOverride")){
1021 $issuingimpossible{NOT_FOR_LOAN} = 1;
1022 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1024 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1025 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1029 # we have to check itemtypes.notforloan also
1030 if (C4::Context->preference('item-level_itypes')){
1031 # this should probably be a subroutine
1032 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1033 $sth->execute($effective_itemtype);
1034 my $notforloan=$sth->fetchrow_hashref();
1035 if ($notforloan->{'notforloan'}) {
1036 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1037 $issuingimpossible{NOT_FOR_LOAN} = 1;
1038 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1040 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1041 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1046 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1047 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1048 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1049 $issuingimpossible{NOT_FOR_LOAN} = 1;
1050 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1052 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1053 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1058 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1060 $issuingimpossible{WTHDRAWN} = 1;
1062 if ( $item_object->restricted
1063 && $item_object->restricted == 1 )
1065 $issuingimpossible{RESTRICTED} = 1;
1067 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1068 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1069 my $code = $av->count ? $av->next->lib : '';
1070 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1071 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1073 if ( C4::Context->preference("IndependentBranches") ) {
1074 my $userenv = C4::Context->userenv;
1075 unless ( C4::Context->IsSuperLibrarian() ) {
1076 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1077 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1078 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1079 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1081 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1082 if ( $patron->branchcode ne $userenv->{branch} );
1087 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1089 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1090 if ($rentalConfirmation) {
1091 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1093 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1094 if ($itemtype_object) {
1095 my $accumulate_charge = $fees->accumulate_rentalcharge();
1096 if ( $accumulate_charge > 0 ) {
1097 $rentalCharge += $accumulate_charge;
1101 if ( $rentalCharge > 0 ) {
1102 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1106 unless ( $ignore_reserves ) {
1107 # See if the item is on reserve.
1108 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1110 my $resbor = $res->{'borrowernumber'};
1111 if ( $resbor ne $patron->borrowernumber ) {
1112 my $patron = Koha::Patrons->find( $resbor );
1113 if ( $restype eq "Waiting" )
1115 # The item is on reserve and waiting, but has been
1116 # reserved by some other patron.
1117 $needsconfirmation{RESERVE_WAITING} = 1;
1118 $needsconfirmation{'resfirstname'} = $patron->firstname;
1119 $needsconfirmation{'ressurname'} = $patron->surname;
1120 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1121 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1122 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1123 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1124 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1126 elsif ( $restype eq "Reserved" ) {
1127 # The item is on reserve for someone else.
1128 $needsconfirmation{RESERVED} = 1;
1129 $needsconfirmation{'resfirstname'} = $patron->firstname;
1130 $needsconfirmation{'ressurname'} = $patron->surname;
1131 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1132 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1133 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1134 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1135 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1137 elsif ( $restype eq "Transferred" ) {
1138 # The item is determined hold being transferred for someone else.
1139 $needsconfirmation{TRANSFERRED} = 1;
1140 $needsconfirmation{'resfirstname'} = $patron->firstname;
1141 $needsconfirmation{'ressurname'} = $patron->surname;
1142 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1143 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1144 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1145 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1146 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1148 elsif ( $restype eq "Processing" ) {
1149 # The item is determined hold being processed for someone else.
1150 $needsconfirmation{PROCESSING} = 1;
1151 $needsconfirmation{'resfirstname'} = $patron->firstname;
1152 $needsconfirmation{'ressurname'} = $patron->surname;
1153 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1154 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1155 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1156 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1157 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1163 ## CHECK AGE RESTRICTION
1164 my $agerestriction = $biblioitem->agerestriction;
1165 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1166 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1167 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1168 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1171 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1175 ## check for high holds decreasing loan period
1176 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1177 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1179 if ( $check->{exceeded} ) {
1180 if ($override_high_holds) {
1181 $alerts{HIGHHOLDS} = {
1182 num_holds => $check->{outstanding},
1183 duration => $check->{duration},
1184 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1188 $needsconfirmation{HIGHHOLDS} = {
1189 num_holds => $check->{outstanding},
1190 duration => $check->{duration},
1191 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1198 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1199 # don't do the multiple loans per bib check if we've
1200 # already determined that we've got a loan on the same item
1201 !$issuingimpossible{NO_MORE_RENEWALS} &&
1202 !$needsconfirmation{RENEW_ISSUE}
1204 # Check if borrower has already issued an item from the same biblio
1205 # Only if it's not a subscription
1206 my $biblionumber = $item_object->biblionumber;
1207 require C4::Serials;
1208 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1209 unless ($is_a_subscription) {
1210 # FIXME Should be $patron->checkouts($args);
1211 my $checkouts = Koha::Checkouts->search(
1213 borrowernumber => $patron->borrowernumber,
1214 biblionumber => $biblionumber,
1220 # if we get here, we don't already have a loan on this item,
1221 # so if there are any loans on this bib, ask for confirmation
1222 if ( $checkouts->count ) {
1223 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1228 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1231 =head2 CanBookBeReturned
1233 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1235 Check whether the item can be returned to the provided branch
1239 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1241 =item C<$branch> is the branchcode where the return is taking place
1249 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1251 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1257 sub CanBookBeReturned {
1258 my ($item, $branch) = @_;
1259 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1261 # assume return is allowed to start
1265 # identify all cases where return is forbidden
1266 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1268 $message = $item->{'homebranch'};
1269 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1271 $message = $item->{'holdingbranch'};
1272 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1274 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1277 return ($allowed, $message);
1280 =head2 CheckHighHolds
1282 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1283 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1284 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1288 sub checkHighHolds {
1289 my ( $item, $borrower ) = @_;
1290 my $branchcode = _GetCircControlBranch( $item, $borrower );
1291 my $item_object = Koha::Items->find( $item->{itemnumber} );
1300 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1302 if ( $holds->count() ) {
1303 $return_data->{outstanding} = $holds->count();
1305 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1306 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1307 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1309 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1311 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1313 # static means just more than a given number of holds on the record
1315 # If the number of holds is less than the threshold, we can stop here
1316 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1317 return $return_data;
1320 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1322 # dynamic means X more than the number of holdable items on the record
1324 # let's get the items
1325 my @items = $holds->next()->biblio()->items()->as_list;
1327 # Remove any items with status defined to be ignored even if the would not make item unholdable
1328 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1329 @items = grep { !$_->$status } @items;
1332 # Remove any items that are not holdable for this patron
1333 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1335 my $items_count = scalar @items;
1337 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1339 # If the number of holds is less than the count of items we have
1340 # plus the number of holds allowed above that count, we can stop here
1341 if ( $holds->count() <= $threshold ) {
1342 return $return_data;
1346 my $issuedate = dt_from_string();
1348 my $itype = $item_object->effective_itemtype;
1349 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1351 categorycode => $borrower->{categorycode},
1353 branchcode => $branchcode,
1356 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1358 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1360 my $rule = Koha::CirculationRules->get_effective_rule(
1362 categorycode => $borrower->{categorycode},
1363 itemtype => $item_object->effective_itemtype,
1364 branchcode => $branchcode,
1365 rule_name => 'decreaseloanholds',
1370 if ( defined($rule) && $rule->rule_value ne '' ){
1371 # overrides decreaseLoanHighHoldsDuration syspref
1372 $duration = $rule->rule_value;
1374 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1376 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1377 $reduced_datedue->set_hour($orig_due->hour);
1378 $reduced_datedue->set_minute($orig_due->minute);
1379 $reduced_datedue->truncate( to => 'minute' );
1381 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1382 $return_data->{exceeded} = 1;
1383 $return_data->{duration} = $duration;
1384 $return_data->{due_date} = $reduced_datedue;
1388 return $return_data;
1393 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1395 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1399 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1401 =item C<$barcode> is the barcode of the item being issued.
1403 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1404 Calculated if empty.
1406 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1408 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1409 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1411 AddIssue does the following things :
1413 - step 01: check that there is a borrowernumber & a barcode provided
1414 - check for RENEWAL (book issued & being issued to the same patron)
1415 - renewal YES = Calculate Charge & renew
1417 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1419 - fill reserve if reserve to this patron
1420 - cancel reserve or not, otherwise
1421 * TRANSFERT PENDING ?
1422 - complete the transfert
1430 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1432 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1433 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1434 my $auto_renew = $params && $params->{auto_renew};
1435 my $dbh = C4::Context->dbh;
1436 my $barcodecheck = CheckValidBarcode($barcode);
1440 if ( $datedue && ref $datedue ne 'DateTime' ) {
1441 $datedue = dt_from_string($datedue);
1444 # $issuedate defaults to today.
1445 if ( !defined $issuedate ) {
1446 $issuedate = dt_from_string();
1449 if ( ref $issuedate ne 'DateTime' ) {
1450 $issuedate = dt_from_string($issuedate);
1455 # Stop here if the patron or barcode doesn't exist
1456 if ( $borrower && $barcode && $barcodecheck ) {
1457 # find which item we issue
1458 my $item_object = Koha::Items->find({ barcode => $barcode })
1459 or return; # if we don't get an Item, abort.
1460 my $item_unblessed = $item_object->unblessed;
1462 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1464 # get actual issuing if there is one
1465 my $actualissue = $item_object->checkout;
1467 # check if we just renew the issue.
1468 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1469 and not $switch_onsite_checkout ) {
1470 $datedue = AddRenewal(
1471 $borrower->{'borrowernumber'},
1472 $item_object->itemnumber,
1475 $issuedate, # here interpreted as the renewal date
1480 my $itype = $item_object->effective_itemtype;
1481 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1484 $datedue->truncate( to => 'minute' );
1486 my $patron = Koha::Patrons->find( $borrower );
1487 my $library = Koha::Libraries->find( $branchcode );
1488 my $fees = Koha::Charges::Fees->new(
1491 library => $library,
1492 item => $item_object,
1493 to_date => $datedue,
1497 # it's NOT a renewal
1498 if ( $actualissue and not $switch_onsite_checkout ) {
1499 # This book is currently on loan, but not to the person
1500 # who wants to borrow it now. mark it returned before issuing to the new borrower
1501 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1502 return unless $allowed;
1503 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1504 # AddReturn certainly has side-effects, like onloan => undef
1505 $item_object->discard_changes;
1508 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1510 # Starting process for transfer job (checking transfert and validate it if we have one)
1511 if ( my $transfer = $item_object->get_transfer ) {
1512 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1515 datearrived => dt_from_string,
1516 tobranch => C4::Context->userenv->{branch},
1517 comments => 'Forced branchtransfer'
1520 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1521 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1522 if ( $hold ) { # Is this really needed?
1523 $hold->set( { found => undef } )->store;
1524 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1529 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1530 unless ($auto_renew) {
1531 my $rule = Koha::CirculationRules->get_effective_rule(
1533 categorycode => $borrower->{categorycode},
1534 itemtype => $item_object->effective_itemtype,
1535 branchcode => $branchcode,
1536 rule_name => 'auto_renew'
1540 $auto_renew = $rule->rule_value if $rule;
1543 my $issue_attributes = {
1544 borrowernumber => $borrower->{'borrowernumber'},
1545 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1546 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1547 branchcode => C4::Context->userenv->{'branch'},
1548 onsite_checkout => $onsite_checkout,
1549 auto_renew => $auto_renew ? 1 : 0,
1552 # Get ID of logged in user. if called from a batch job,
1553 # no user session exists and C4::Context->userenv() returns
1554 # the scalar '0'. Only do this if the syspref says so
1555 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1556 my $userenv = C4::Context->userenv();
1557 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1559 $issue_attributes->{issuer_id} = $usernumber;
1563 # In the case that the borrower has an on-site checkout
1564 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1565 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1567 $issue->set($issue_attributes)->store;
1570 $issue = Koha::Checkout->new(
1572 itemnumber => $item_object->itemnumber,
1577 $issue->discard_changes;
1578 if ( $item_object->location && $item_object->location eq 'CART'
1579 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1580 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1581 CartToShelf( $item_object->itemnumber );
1584 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1585 UpdateTotalIssues( $item_object->biblionumber, 1 );
1588 # Record if item was lost
1589 my $was_lost = $item_object->itemlost;
1591 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1592 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1593 $item_object->itemlost(0);
1594 $item_object->onloan($datedue->ymd());
1595 $item_object->datelastborrowed( dt_from_string()->ymd() );
1596 $item_object->datelastseen( dt_from_string()->ymd() );
1597 $item_object->store({log_action => 0});
1599 # If the item was lost, it has now been found, charge the overdue if necessary
1601 if ( $item_object->{_charge} ) {
1602 $actualissue //= Koha::Old::Checkouts->search(
1603 { itemnumber => $item_unblessed->{itemnumber} },
1605 order_by => { '-desc' => 'returndate' },
1609 unless ( exists( $borrower->{branchcode} ) ) {
1610 my $patron = $actualissue->patron;
1611 $borrower = $patron->unblessed;
1613 _CalculateAndUpdateFine(
1615 issue => $actualissue,
1616 item => $item_unblessed,
1617 borrower => $borrower,
1618 return_date => $issuedate
1621 _FixOverduesOnReturn( $borrower->{borrowernumber},
1622 $item_object->itemnumber, undef, 'RENEWED' );
1626 # If it costs to borrow this book, charge it to the patron's account.
1627 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1628 if ( $charge && $charge > 0 ) {
1629 AddIssuingCharge( $issue, $charge, 'RENT' );
1632 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1633 if ( $itemtype_object ) {
1634 my $accumulate_charge = $fees->accumulate_rentalcharge();
1635 if ( $accumulate_charge > 0 ) {
1636 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1637 $charge += $accumulate_charge;
1638 $item_unblessed->{charge} = $charge;
1642 # Record the fact that this book was issued.
1645 branch => C4::Context->userenv->{'branch'},
1646 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1648 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1649 itemnumber => $item_object->itemnumber,
1650 itemtype => $item_object->effective_itemtype,
1651 location => $item_object->location,
1652 borrowernumber => $borrower->{'borrowernumber'},
1653 ccode => $item_object->ccode,
1657 # Send a checkout slip.
1658 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1660 branchcode => $branchcode,
1661 categorycode => $borrower->{categorycode},
1662 item_type => $item_object->effective_itemtype,
1663 notification => 'CHECKOUT',
1665 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1666 SendCirculationAlert(
1669 item => $item_object->unblessed,
1670 borrower => $borrower,
1671 branch => $branchcode,
1676 "CIRCULATION", "ISSUE",
1677 $borrower->{'borrowernumber'},
1678 $item_object->itemnumber,
1679 ) if C4::Context->preference("IssueLog");
1681 Koha::Plugins->call('after_circ_action', {
1682 action => 'checkout',
1684 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1685 checkout => $issue->get_from_storage
1693 =head2 GetLoanLength
1695 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1697 Get loan length for an itemtype, a borrower type and a branch
1702 my ( $categorycode, $itemtype, $branchcode ) = @_;
1704 # Initialize default values
1708 lengthunit => 'days',
1711 my $found = Koha::CirculationRules->get_effective_rules( {
1712 branchcode => $branchcode,
1713 categorycode => $categorycode,
1714 itemtype => $itemtype,
1723 foreach my $rule_name (keys %$found) {
1724 $rules->{$rule_name} = $found->{$rule_name};
1731 =head2 GetHardDueDate
1733 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1735 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1739 sub GetHardDueDate {
1740 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1742 my $rules = Koha::CirculationRules->get_effective_rules(
1744 categorycode => $borrowertype,
1745 itemtype => $itemtype,
1746 branchcode => $branchcode,
1747 rules => [ 'hardduedate', 'hardduedatecompare' ],
1751 if ( defined( $rules->{hardduedate} ) ) {
1752 if ( $rules->{hardduedate} ) {
1753 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1756 return ( undef, undef );
1761 =head2 GetBranchBorrowerCircRule
1763 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1765 Retrieves circulation rule attributes that apply to the given
1766 branch and patron category, regardless of item type.
1767 The return value is a hashref containing the following key:
1769 patron_maxissueqty - maximum number of loans that a
1770 patron of the given category can have at the given
1771 branch. If the value is undef, no limit.
1773 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1774 patron of the given category can have at the given
1775 branch. If the value is undef, no limit.
1777 This will check for different branch/category combinations in the following order:
1781 default branch and category
1783 If no rule has been found in the database, it will default to
1786 patron_maxissueqty - undef
1787 patron_maxonsiteissueqty - undef
1789 C<$branchcode> and C<$categorycode> should contain the
1790 literal branch code and patron category code, respectively - no
1795 sub GetBranchBorrowerCircRule {
1796 my ( $branchcode, $categorycode ) = @_;
1798 # Initialize default values
1800 patron_maxissueqty => undef,
1801 patron_maxonsiteissueqty => undef,
1805 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1806 my $rule = Koha::CirculationRules->get_effective_rule(
1808 categorycode => $categorycode,
1810 branchcode => $branchcode,
1811 rule_name => $rule_name,
1815 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1821 =head2 GetBranchItemRule
1823 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1825 Retrieves circulation rule attributes that apply to the given
1826 branch and item type, regardless of patron category.
1828 The return value is a hashref containing the following keys:
1830 holdallowed => Hold policy for this branch and itemtype. Possible values:
1831 not_allowed: No holds allowed.
1832 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1833 from_any_library: Holds allowed from any patron.
1834 from_local_hold_group: Holds allowed from libraries in hold group
1836 returnbranch => branch to which to return item. Possible values:
1837 noreturn: do not return, let item remain where checked in (floating collections)
1838 homebranch: return to item's home branch
1839 holdingbranch: return to issuer branch
1841 This searches branchitemrules in the following order:
1843 * Same branchcode and itemtype
1844 * Same branchcode, itemtype '*'
1845 * branchcode '*', same itemtype
1846 * branchcode and itemtype '*'
1848 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1852 sub GetBranchItemRule {
1853 my ( $branchcode, $itemtype ) = @_;
1856 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1858 branchcode => $branchcode,
1859 itemtype => $itemtype,
1860 rule_name => 'holdallowed',
1863 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1865 branchcode => $branchcode,
1866 itemtype => $itemtype,
1867 rule_name => 'hold_fulfillment_policy',
1870 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1872 branchcode => $branchcode,
1873 itemtype => $itemtype,
1874 rule_name => 'returnbranch',
1878 # built-in default circulation rule
1880 $rules->{holdallowed} = defined $holdallowed_rule
1881 ? $holdallowed_rule->rule_value
1882 : 'from_any_library';
1883 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1884 ? $hold_fulfillment_policy_rule->rule_value
1886 $rules->{returnbranch} = defined $returnbranch_rule
1887 ? $returnbranch_rule->rule_value
1895 ($doreturn, $messages, $iteminformation, $borrower) =
1896 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1902 =item C<$barcode> is the bar code of the book being returned.
1904 =item C<$branch> is the code of the branch where the book is being returned.
1906 =item C<$exemptfine> indicates that overdue charges for the item will be
1909 =item C<$return_date> allows the default return date to be overridden
1910 by the given return date. Optional.
1914 C<&AddReturn> returns a list of four items:
1916 C<$doreturn> is true iff the return succeeded.
1918 C<$messages> is a reference-to-hash giving feedback on the operation.
1919 The keys of the hash are:
1925 No item with this barcode exists. The value is C<$barcode>.
1929 The book is not currently on loan. The value is C<$barcode>.
1933 This book has been withdrawn/cancelled. The value should be ignored.
1935 =item C<Wrongbranch>
1937 This book has was returned to the wrong branch. The value is a hashref
1938 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1939 contain the branchcode of the incorrect and correct return library, respectively.
1943 The item was reserved. The value is a reference-to-hash whose keys are
1944 fields from the reserves table of the Koha database, and
1945 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1946 either C<Waiting>, C<Reserved>, or 0.
1948 =item C<WasReturned>
1950 Value 1 if return is successful.
1952 =item C<NeedsTransfer>
1954 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1958 C<$iteminformation> is a reference-to-hash, giving information about the
1959 returned item from the issues table.
1961 C<$borrower> is a reference-to-hash, giving information about the
1962 patron who last borrowed the book.
1967 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1969 if ($branch and not Koha::Libraries->find($branch)) {
1970 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1973 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1974 my $return_date_specified = !!$return_date;
1975 $return_date //= dt_from_string();
1979 my $validTransfer = 1;
1980 my $stat_type = 'return';
1982 # get information on item
1983 my $item = Koha::Items->find({ barcode => $barcode });
1985 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1988 my $itemnumber = $item->itemnumber;
1989 my $itemtype = $item->effective_itemtype;
1991 my $issue = $item->checkout;
1993 $patron = $issue->patron
1994 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1995 . Dumper($issue->unblessed) . "\n";
1997 $messages->{'NotIssued'} = $barcode;
1998 $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
2000 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2002 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2003 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2004 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2005 $messages->{'LocalUse'} = 1;
2006 $stat_type = 'localuse';
2010 # full item data, but no borrowernumber or checkout info (no issue)
2011 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2012 # get the proper branch to which to return the item
2013 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2014 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2015 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2017 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2018 my $patron_unblessed = $patron ? $patron->unblessed : {};
2020 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2021 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2022 if ($update_loc_rules) {
2023 if (defined $update_loc_rules->{_ALL_}) {
2024 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2025 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2026 if ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) {
2027 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2028 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2032 foreach my $key ( keys %$update_loc_rules ) {
2033 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2034 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2035 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2036 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2037 $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2044 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2046 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2048 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2050 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2053 foreach my $key ( keys %$rules ) {
2054 if ( $item->notforloan eq $key ) {
2055 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2056 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2063 # check if the return is allowed at this branch
2064 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2065 unless ($returnallowed){
2066 $messages->{'Wrongbranch'} = {
2067 Wrongbranch => $branch,
2068 Rightbranch => $message
2071 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2072 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2073 return ( $doreturn, $messages, $issue, $patron_unblessed);
2076 if ( $item->withdrawn ) { # book has been cancelled
2077 $messages->{'withdrawn'} = 1;
2078 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2081 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2085 # case of a return of document (deal with issues and holdingbranch)
2087 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2088 $patron or warn "AddReturn without current borrower";
2092 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2097 C4::Context->preference('CalculateFinesOnReturn')
2098 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2103 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2106 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 );
2108 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2109 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2111 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2114 # FIXME is the "= 1" right? This could be the borrower hash.
2115 $messages->{'WasReturned'} = 1;
2118 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2122 # the holdingbranch is updated if the document is returned to another location.
2123 # this is always done regardless of whether the item was on loan or not
2124 if ($item->holdingbranch ne $branch) {
2125 $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2128 my $item_was_lost = $item->itemlost;
2129 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2130 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2132 # fix up the accounts.....
2133 if ($item_was_lost) {
2134 $messages->{'WasLost'} = 1;
2135 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2136 $messages->{'LostItemFeeRefunded'} = $updated_item->{_refunded};
2137 $messages->{'LostItemFeeRestored'} = $updated_item->{_restored};
2139 if ( $updated_item->{_charge} ) {
2140 $issue //= Koha::Old::Checkouts->search(
2141 { itemnumber => $item->itemnumber },
2142 { order_by => { '-desc' => 'returndate' }, rows => 1 } )
2144 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2145 my $patron = $issue->patron;
2146 $patron_unblessed = $patron->unblessed;
2148 _CalculateAndUpdateFine(
2151 item => $item->unblessed,
2152 borrower => $patron_unblessed,
2153 return_date => $return_date
2156 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2157 $item->itemnumber, undef, 'RETURNED' );
2158 $messages->{'LostItemFeeCharged'} = 1;
2163 # check if we have a transfer for this document
2164 my $transfer = $item->get_transfer;
2166 # if we have a transfer to complete, we update the line of transfers with the datearrived
2169 if ( $transfer->in_transit ) {
2170 if ( $transfer->tobranch eq $branch ) {
2172 $messages->{'TransferArrived'} = $transfer->frombranch;
2173 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2174 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2177 $messages->{'WrongTransfer'} = $transfer->tobranch;
2178 $messages->{'WrongTransferItem'} = $item->itemnumber;
2179 $messages->{'TransferTrigger'} = $transfer->reason;
2183 if ( $transfer->tobranch eq $branch ) {
2185 $messages->{'TransferArrived'} = $transfer->frombranch;
2186 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2187 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2190 $messages->{'WasTransfered'} = $transfer->tobranch;
2191 $messages->{'TransferTrigger'} = $transfer->reason;
2196 # fix up the overdues in accounts...
2197 if ($borrowernumber) {
2198 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2199 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2201 if ( $issue and $issue->is_overdue($return_date) ) {
2203 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2205 $messages->{'PrevDebarred'} = $debardate;
2207 $messages->{'Debarred'} = $debardate if $debardate;
2209 # there's no overdue on the item but borrower had been previously debarred
2210 } elsif ( $issue->date_due and $patron->debarred ) {
2211 if ( $patron->debarred eq "9999-12-31") {
2212 $messages->{'ForeverDebarred'} = $patron->debarred;
2214 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2215 $borrower_debar_dt->truncate(to => 'day');
2216 my $today_dt = $return_date->clone()->truncate(to => 'day');
2217 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2218 $messages->{'PrevDebarred'} = $patron->debarred;
2224 # find reserves.....
2225 # launch the Checkreserves routine to find any holds
2226 my ($resfound, $resrec);
2227 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2228 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2229 # 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)
2230 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2231 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2232 $resfound = 'Reserved';
2233 $resrec = $hold->unblessed;
2236 $resrec->{'ResFound'} = $resfound;
2237 $messages->{'ResFound'} = $resrec;
2240 # Record the fact that this book was returned.
2244 itemnumber => $itemnumber,
2245 itemtype => $itemtype,
2246 location => $item->location,
2247 borrowernumber => $borrowernumber,
2248 ccode => $item->ccode,
2251 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2253 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2255 branchcode => $branch,
2256 categorycode => $patron->categorycode,
2257 item_type => $itemtype,
2258 notification => 'CHECKIN',
2260 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2261 SendCirculationAlert({
2263 item => $item->unblessed,
2264 borrower => $patron->unblessed,
2269 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2270 if C4::Context->preference("ReturnLog");
2273 # Check if this item belongs to a biblio record that is attached to an
2274 # ILL request, if it is we need to update the ILL request's status
2275 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2276 my $request = Koha::Illrequests->find(
2277 { biblio_id => $item->biblio->biblionumber }
2279 $request->status('RET') if $request;
2282 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2283 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2284 && ( $doreturn or $messages->{'NotIssued'} )
2286 and ( $branch ne $returnbranch )
2287 and not $messages->{'WrongTransfer'}
2288 and not $messages->{'WasTransfered'} )
2290 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2291 if (C4::Context->preference("AutomaticItemReturn" ) or
2292 (C4::Context->preference("UseBranchTransferLimits") and
2293 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2295 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2296 $messages->{'WasTransfered'} = $returnbranch;
2297 $messages->{'TransferTrigger'} = $transfer_trigger;
2299 $messages->{'NeedsTransfer'} = $returnbranch;
2300 $messages->{'TransferTrigger'} = $transfer_trigger;
2304 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2305 my $claims = Koha::Checkouts::ReturnClaims->search(
2307 itemnumber => $item->id,
2308 resolution => undef,
2312 if ( $claims->count ) {
2313 $messages->{ReturnClaims} = $claims;
2317 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2318 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2320 if ( $doreturn and $issue ) {
2321 my $checkin = Koha::Old::Checkouts->find($issue->id);
2323 Koha::Plugins->call('after_circ_action', {
2324 action => 'checkin',
2331 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2334 =head2 MarkIssueReturned
2336 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2338 Unconditionally marks an issue as being returned by
2339 moving the C<issues> row to C<old_issues> and
2340 setting C<returndate> to the current date.
2342 if C<$returndate> is specified (in iso format), it is used as the date
2345 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2346 the old_issue is immediately anonymised
2348 Ideally, this function would be internal to C<C4::Circulation>,
2349 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2350 and offline_circ/process_koc.pl.
2352 The last optional parameter allos passing skip_record_index to the item store call.
2356 sub MarkIssueReturned {
2357 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2359 # Retrieve the issue
2360 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2362 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2364 my $issue_id = $issue->issue_id;
2366 my $anonymouspatron;
2367 if ( $privacy && $privacy == 2 ) {
2368 # The default of 0 will not work due to foreign key constraints
2369 # The anonymisation will fail if AnonymousPatron is not a valid entry
2370 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2371 # Note that a warning should appear on the about page (System information tab).
2372 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2373 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."
2374 unless Koha::Patrons->find( $anonymouspatron );
2377 my $schema = Koha::Database->schema;
2379 # FIXME Improve the return value and handle it from callers
2380 $schema->txn_do(sub {
2382 my $patron = Koha::Patrons->find( $borrowernumber );
2384 # Update the returndate value
2385 if ( $returndate ) {
2386 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2389 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2392 # Create the old_issues entry
2393 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2395 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2396 if ( $privacy && $privacy == 2) {
2397 $old_checkout->borrowernumber($anonymouspatron)->store;
2400 # And finally delete the issue
2403 $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2405 if ( C4::Context->preference('StoreLastBorrower') ) {
2406 my $item = Koha::Items->find( $itemnumber );
2407 $item->last_returned_by( $patron );
2410 # Remove any OVERDUES related debarment if the borrower has no overdues
2411 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2412 && $patron->debarred
2413 && !$patron->has_overdues
2414 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2416 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2424 =head2 _debar_user_on_return
2426 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2428 C<$borrower> borrower hashref
2430 C<$item> item hashref
2432 C<$datedue> date due DateTime object
2434 C<$returndate> DateTime object representing the return time
2436 Internal function, called only by AddReturn that calculates and updates
2437 the user fine days, and debars them if necessary.
2439 Should only be called for overdue returns
2441 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2446 sub _calculate_new_debar_dt {
2447 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2449 my $branchcode = _GetCircControlBranch( $item, $borrower );
2450 my $circcontrol = C4::Context->preference('CircControl');
2451 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2452 { categorycode => $borrower->{categorycode},
2453 itemtype => $item->{itype},
2454 branchcode => $branchcode,
2459 'maxsuspensiondays',
2460 'suspension_chargeperiod',
2464 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2465 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2466 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2468 return unless $finedays;
2470 # finedays is in days, so hourly loans must multiply by 24
2471 # thus 1 hour late equals 1 day suspension * finedays rate
2472 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2474 # grace period is measured in the same units as the loan
2476 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2478 my $deltadays = DateTime::Duration->new(
2479 days => $chargeable_units
2482 if ( $deltadays->subtract($grace)->is_positive() ) {
2483 my $suspension_days = $deltadays * $finedays;
2485 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2486 # No need to / 1 and do not consider / 0
2487 $suspension_days = DateTime::Duration->new(
2488 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2492 # If the max suspension days is < than the suspension days
2493 # the suspension days is limited to this maximum period.
2494 my $max_sd = $issuing_rule->{maxsuspensiondays};
2495 if ( defined $max_sd && $max_sd ne '' ) {
2496 $max_sd = DateTime::Duration->new( days => $max_sd );
2497 $suspension_days = $max_sd
2498 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2501 my ( $has_been_extended );
2502 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2503 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2505 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2506 $has_been_extended = 1;
2511 # Use the calendar or not to calculate the debarment date
2512 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2513 my $calendar = Koha::Calendar->new(
2514 branchcode => $branchcode,
2515 days_mode => 'Calendar'
2517 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2520 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2522 return $new_debar_dt;
2527 sub _debar_user_on_return {
2528 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2530 $return_date //= dt_from_string();
2532 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2534 return unless $new_debar_dt;
2536 Koha::Patron::Debarments::AddUniqueDebarment({
2537 borrowernumber => $borrower->{borrowernumber},
2538 expiration => $new_debar_dt->ymd(),
2539 type => 'SUSPENSION',
2541 # if borrower was already debarred but does not get an extra debarment
2542 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2543 my ($new_debarment_str, $is_a_reminder);
2544 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2546 $new_debarment_str = $borrower->{debarred};
2548 $new_debarment_str = $new_debar_dt->ymd();
2550 # FIXME Should return a DateTime object
2551 return $new_debarment_str, $is_a_reminder;
2554 =head2 _FixOverduesOnReturn
2556 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2558 C<$borrowernumber> borrowernumber
2560 C<$itemnumber> itemnumber
2562 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2564 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2570 sub _FixOverduesOnReturn {
2571 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2572 unless( $borrowernumber ) {
2573 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2577 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2581 warn "_FixOverduesOnReturn() not supplied valid status";
2585 my $schema = Koha::Database->schema;
2587 my $result = $schema->txn_do(
2589 # check for overdue fine
2590 my $accountlines = Koha::Account::Lines->search(
2592 borrowernumber => $borrowernumber,
2593 itemnumber => $item,
2594 debit_type_code => 'OVERDUE',
2595 status => 'UNRETURNED'
2598 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2600 my $accountline = $accountlines->next;
2601 my $payments = $accountline->credits;
2603 my $amountoutstanding = $accountline->amountoutstanding;
2604 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2605 $accountline->delete;
2606 return 0; # no warning, we've just removed a zero value fine (backdated return)
2607 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2608 my $account = Koha::Account->new({patron_id => $borrowernumber});
2609 my $credit = $account->add_credit(
2611 amount => $amountoutstanding,
2612 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2613 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2614 interface => C4::Context->interface,
2620 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2622 if (C4::Context->preference("FinesLog")) {
2623 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2627 $accountline->status($status);
2628 return $accountline->store();
2635 =head2 _GetCircControlBranch
2637 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2641 Return the library code to be used to determine which circulation
2642 policy applies to a transaction. Looks up the CircControl and
2643 HomeOrHoldingBranch system preferences.
2645 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2647 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2651 sub _GetCircControlBranch {
2652 my ($item, $borrower) = @_;
2653 my $circcontrol = C4::Context->preference('CircControl');
2656 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2657 $branch= C4::Context->userenv->{'branch'};
2658 } elsif ($circcontrol eq 'PatronLibrary') {
2659 $branch=$borrower->{branchcode};
2661 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2662 $branch = $item->{$branchfield};
2663 # default to item home branch if holdingbranch is used
2664 # and is not defined
2665 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2666 $branch = $item->{homebranch};
2674 $issue = GetOpenIssue( $itemnumber );
2676 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2678 C<$itemnumber> is the item's itemnumber
2685 my ( $itemnumber ) = @_;
2686 return unless $itemnumber;
2687 my $dbh = C4::Context->dbh;
2688 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2689 $sth->execute( $itemnumber );
2690 return $sth->fetchrow_hashref();
2694 =head2 GetUpcomingDueIssues
2696 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2700 sub GetUpcomingDueIssues {
2703 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2704 my $dbh = C4::Context->dbh;
2707 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2709 LEFT JOIN items USING (itemnumber)
2710 LEFT JOIN branches ON branches.branchcode =
2712 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2713 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2714 my @bind_parameters = ( $params->{'days_in_advance'} );
2716 my $sth = $dbh->prepare( $statement );
2717 $sth->execute( @bind_parameters );
2718 my $upcoming_dues = $sth->fetchall_arrayref({});
2720 return $upcoming_dues;
2723 =head2 CanBookBeRenewed
2725 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2727 Find out whether a borrowed item may be renewed.
2729 C<$borrowernumber> is the borrower number of the patron who currently
2730 has the item on loan.
2732 C<$itemnumber> is the number of the item to renew.
2734 C<$override_limit>, if supplied with a true value, causes
2735 the limit on the number of times that the loan can be renewed
2736 (as controlled by the item type) to be ignored. Overriding also allows
2737 to renew sooner than "No renewal before" and to manually renew loans
2738 that are automatically renewed.
2740 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2741 item must currently be on loan to the specified borrower; renewals
2742 must be allowed for the item's type; and the borrower must not have
2743 already renewed the loan. $error will contain the reason the renewal can not proceed
2747 sub CanBookBeRenewed {
2748 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2750 my $dbh = C4::Context->dbh;
2752 my $auto_renew = "no";
2754 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2755 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2756 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2757 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2759 my $patron = $issue->patron or return;
2761 # override_limit will override anything else except on_reserve
2762 unless ( $override_limit ){
2763 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2764 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2766 categorycode => $patron->categorycode,
2767 itemtype => $item->effective_itemtype,
2768 branchcode => $branchcode,
2771 'no_auto_renewal_after',
2772 'no_auto_renewal_after_hard_limit',
2775 'unseen_renewals_allowed'
2780 return ( 0, "too_many" )
2781 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2783 return ( 0, "too_unseen" )
2784 if C4::Context->preference('UnseenRenewals') &&
2785 $issuing_rule->{unseen_renewals_allowed} &&
2786 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2788 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2789 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2790 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2791 my $restricted = $patron->is_debarred;
2792 my $hasoverdues = $patron->has_overdues;
2794 if ( $restricted and $restrictionblockrenewing ) {
2795 return ( 0, 'restriction');
2796 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2797 return ( 0, 'overdue');
2800 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2802 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2803 return ( 0, 'auto_account_expired' );
2806 if ( defined $issuing_rule->{no_auto_renewal_after}
2807 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2808 # Get issue_date and add no_auto_renewal_after
2809 # If this is greater than today, it's too late for renewal.
2810 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2811 $maximum_renewal_date->add(
2812 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2814 my $now = dt_from_string;
2815 if ( $now >= $maximum_renewal_date ) {
2816 return ( 0, "auto_too_late" );
2819 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2820 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2821 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2822 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2823 return ( 0, "auto_too_late" );
2827 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2828 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2829 my $amountoutstanding =
2830 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2831 ? $patron->account->balance
2832 : $patron->account->outstanding_debits->total_outstanding;
2833 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2834 return ( 0, "auto_too_much_oweing" );
2839 if ( defined $issuing_rule->{norenewalbefore}
2840 and $issuing_rule->{norenewalbefore} ne "" )
2843 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2844 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2845 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2847 # Depending on syspref reset the exact time, only check the date
2848 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2849 and $issuing_rule->{lengthunit} eq 'days' )
2851 $soonestrenewal->truncate( to => 'day' );
2854 if ( $soonestrenewal > dt_from_string() )
2856 $auto_renew = ($issue->auto_renew && $patron->autorenew_checkouts) ? "auto_too_soon" : "too_soon";
2858 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2863 # Fallback for automatic renewals:
2864 # If norenewalbefore is undef, don't renew before due date.
2865 if ( $issue->auto_renew && $auto_renew eq "no" && $patron->autorenew_checkouts ) {
2866 my $now = dt_from_string;
2867 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2870 $auto_renew = "auto_too_soon";
2875 my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2877 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2878 if ( $resfound && $resrec->{non_priority} ) {
2879 $resfound = Koha::Holds->search(
2880 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2886 # This item can fill one or more unfilled reserve, can those unfilled reserves
2887 # all be filled by other available items?
2889 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2891 my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2893 # There is an item level hold on this item, no other item can fill the hold
2898 # Get all other items that could possibly fill reserves
2899 my $items = Koha::Items->search({
2900 biblionumber => $resrec->{biblionumber},
2903 -not => { itemnumber => $itemnumber }
2906 # Get all other reserves that could have been filled by this item
2907 my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2908 my $patrons = Koha::Patrons->search({
2909 borrowernumber => { -in => \@borrowernumbers }
2912 # If the count of the union of the lists of reservable items for each borrower
2913 # is equal or greater than the number of borrowers, we know that all reserves
2914 # can be filled with available items. We can get the union of the sets simply
2915 # by pushing all the elements onto an array and removing the duplicates.
2917 ITEM: while ( my $item = $items->next ) {
2918 next if IsItemOnHoldAndFound( $item->itemnumber );
2919 while ( my $patron = $patrons->next ) {
2920 next unless IsAvailableForItemLevelRequest($item, $patron);
2921 next unless CanItemBeReserved($patron->borrowernumber,$item->itemnumber,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2922 push @reservable, $item->itemnumber;
2923 if (@reservable >= @borrowernumbers) {
2933 if( $cron ) { #The cron wants to return 'too_soon' over 'on_reserve'
2934 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2935 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2936 } else { # For other purposes we want 'on_reserve' before 'too_soon'
2937 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2938 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2941 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2943 return ( 1, undef );
2948 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2952 C<$borrowernumber> is the borrower number of the patron who currently
2955 C<$itemnumber> is the number of the item to renew.
2957 C<$branch> is the library where the renewal took place (if any).
2958 The library that controls the circ policies for the renewal is retrieved from the issues record.
2960 C<$datedue> can be a DateTime object used to set the due date.
2962 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2963 this parameter is not supplied, lastreneweddate is set to the current date.
2965 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2966 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2967 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2970 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2971 from the book's item type.
2973 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
2974 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
2975 fallback to a true value
2980 my $borrowernumber = shift;
2981 my $itemnumber = shift or return;
2983 my $datedue = shift;
2984 my $lastreneweddate = shift || dt_from_string();
2985 my $skipfinecalc = shift;
2988 # Fallback on a 'seen' renewal
2989 $seen = defined $seen && $seen == 0 ? 0 : 1;
2991 my $item_object = Koha::Items->find($itemnumber) or return;
2992 my $biblio = $item_object->biblio;
2993 my $issue = $item_object->checkout;
2994 my $item_unblessed = $item_object->unblessed;
2996 my $dbh = C4::Context->dbh;
2998 return unless $issue;
3000 $borrowernumber ||= $issue->borrowernumber;
3002 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3003 carp 'Invalid date passed to AddRenewal.';
3007 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3008 my $patron_unblessed = $patron->unblessed;
3010 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3012 my $schema = Koha::Database->schema;
3013 $schema->txn_do(sub{
3015 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3016 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3018 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3020 # If the due date wasn't specified, calculate it by adding the
3021 # book's loan length to today's date or the current due date
3022 # based on the value of the RenewalPeriodBase syspref.
3023 my $itemtype = $item_object->effective_itemtype;
3026 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3027 dt_from_string( $issue->date_due, 'sql' ) :
3029 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3032 my $fees = Koha::Charges::Fees->new(
3035 library => $circ_library,
3036 item => $item_object,
3037 from_date => dt_from_string( $issue->date_due, 'sql' ),
3038 to_date => dt_from_string($datedue),
3042 # Increment the unseen renewals, if appropriate
3043 # We only do so if the syspref is enabled and
3044 # a maximum value has been set in the circ rules
3045 my $unseen_renewals = $issue->unseen_renewals;
3046 if (C4::Context->preference('UnseenRenewals')) {
3047 my $rule = Koha::CirculationRules->get_effective_rule(
3048 { categorycode => $patron->categorycode,
3049 itemtype => $item_object->effective_itemtype,
3050 branchcode => $circ_library->branchcode,
3051 rule_name => 'unseen_renewals_allowed'
3054 if (!$seen && $rule && $rule->rule_value) {
3057 # If the renewal is seen, unseen should revert to 0
3058 $unseen_renewals = 0;
3062 # Update the issues record to have the new due date, and a new count
3063 # of how many times it has been renewed.
3064 my $renews = ( $issue->renewals || 0 ) + 1;
3065 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3068 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3071 Koha::Exceptions::Checkout::FailedRenewal->throw(
3072 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3076 # Update the renewal count on the item, and tell zebra to reindex
3077 $renews = ( $item_object->renewals || 0 ) + 1;
3078 $item_object->renewals($renews);
3079 $item_object->onloan($datedue);
3080 $item_object->store({ log_action => 0 });
3082 # Charge a new rental fee, if applicable
3083 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3084 if ( $charge > 0 ) {
3085 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3088 # Charge a new accumulate rental fee, if applicable
3089 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3090 if ( $itemtype_object ) {
3091 my $accumulate_charge = $fees->accumulate_rentalcharge();
3092 if ( $accumulate_charge > 0 ) {
3093 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3095 $charge += $accumulate_charge;
3098 # Send a renewal slip according to checkout alert preferencei
3099 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3100 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3102 branchcode => $branch,
3103 categorycode => $patron->categorycode,
3104 item_type => $itemtype,
3105 notification => 'CHECKOUT',
3107 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3108 SendCirculationAlert(
3111 item => $item_unblessed,
3112 borrower => $patron->unblessed,
3119 # Remove any OVERDUES related debarment if the borrower has no overdues
3121 && $patron->is_debarred
3122 && ! $patron->has_overdues
3123 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3125 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3128 # Add the renewal to stats
3131 branch => $item_object->renewal_branchcode({branch => $branch}),
3134 itemnumber => $itemnumber,
3135 itemtype => $itemtype,
3136 location => $item_object->location,
3137 borrowernumber => $borrowernumber,
3138 ccode => $item_object->ccode,
3143 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3145 Koha::Plugins->call('after_circ_action', {
3146 action => 'renewal',
3148 checkout => $issue->get_from_storage
3157 # check renewal status
3158 my ( $bornum, $itemno ) = @_;
3159 my $dbh = C4::Context->dbh;
3161 my $unseencount = 0;
3162 my $renewsallowed = 0;
3163 my $unseenallowed = 0;
3167 my $patron = Koha::Patrons->find( $bornum );
3168 my $item = Koha::Items->find($itemno);
3170 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3172 # Look in the issues table for this item, lent to this borrower,
3173 # and not yet returned.
3175 # FIXME - I think this function could be redone to use only one SQL call.
3176 my $sth = $dbh->prepare(
3177 "select * from issues
3178 where (borrowernumber = ?)
3179 and (itemnumber = ?)"
3181 $sth->execute( $bornum, $itemno );
3182 my $data = $sth->fetchrow_hashref;
3183 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3184 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3185 # $item and $borrower should be calculated
3186 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3188 my $rules = Koha::CirculationRules->get_effective_rules(
3190 categorycode => $patron->categorycode,
3191 itemtype => $item->effective_itemtype,
3192 branchcode => $branchcode,
3193 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3196 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3197 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3198 $rules->{unseen_renewals_allowed} :
3200 $renewsleft = $renewsallowed - $renewcount;
3201 $unseenleft = $unseenallowed - $unseencount;
3202 if($renewsleft < 0){ $renewsleft = 0; }
3203 if($unseenleft < 0){ $unseenleft = 0; }
3214 =head2 GetSoonestRenewDate
3216 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3218 Find out the soonest possible renew date of a borrowed item.
3220 C<$borrowernumber> is the borrower number of the patron who currently
3221 has the item on loan.
3223 C<$itemnumber> is the number of the item to renew.
3225 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3226 renew date, based on the value "No renewal before" of the applicable
3227 issuing rule. Returns the current date if the item can already be
3228 renewed, and returns undefined if the borrower, loan, or item
3233 sub GetSoonestRenewDate {
3234 my ( $borrowernumber, $itemnumber ) = @_;
3236 my $dbh = C4::Context->dbh;
3238 my $item = Koha::Items->find($itemnumber) or return;
3239 my $itemissue = $item->checkout or return;
3241 $borrowernumber ||= $itemissue->borrowernumber;
3242 my $patron = Koha::Patrons->find( $borrowernumber )
3245 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3246 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3247 { categorycode => $patron->categorycode,
3248 itemtype => $item->effective_itemtype,
3249 branchcode => $branchcode,
3257 my $now = dt_from_string;
3258 return $now unless $issuing_rule;
3260 if ( defined $issuing_rule->{norenewalbefore}
3261 and $issuing_rule->{norenewalbefore} ne "" )
3263 my $soonestrenewal =
3264 dt_from_string( $itemissue->date_due )->subtract(
3265 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3267 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3268 and $issuing_rule->{lengthunit} eq 'days' )
3270 $soonestrenewal->truncate( to => 'day' );
3272 return $soonestrenewal if $now < $soonestrenewal;
3277 =head2 GetLatestAutoRenewDate
3279 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3281 Find out the latest possible auto renew date of a borrowed item.
3283 C<$borrowernumber> is the borrower number of the patron who currently
3284 has the item on loan.
3286 C<$itemnumber> is the number of the item to renew.
3288 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3289 auto renew date, based on the value "No auto renewal after" and the "No auto
3290 renewal after (hard limit) of the applicable issuing rule.
3291 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3292 or item cannot be found.
3296 sub GetLatestAutoRenewDate {
3297 my ( $borrowernumber, $itemnumber ) = @_;
3299 my $dbh = C4::Context->dbh;
3301 my $item = Koha::Items->find($itemnumber) or return;
3302 my $itemissue = $item->checkout or return;
3304 $borrowernumber ||= $itemissue->borrowernumber;
3305 my $patron = Koha::Patrons->find( $borrowernumber )
3308 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3309 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3311 categorycode => $patron->categorycode,
3312 itemtype => $item->effective_itemtype,
3313 branchcode => $branchcode,
3315 'no_auto_renewal_after',
3316 'no_auto_renewal_after_hard_limit',
3322 return unless $circulation_rules;
3324 if ( not $circulation_rules->{no_auto_renewal_after}
3325 or $circulation_rules->{no_auto_renewal_after} eq '' )
3326 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3327 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3329 my $maximum_renewal_date;
3330 if ( $circulation_rules->{no_auto_renewal_after} ) {
3331 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3332 $maximum_renewal_date->add(
3333 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3337 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3338 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3339 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3341 return $maximum_renewal_date;
3345 =head2 GetIssuingCharges
3347 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3349 Calculate how much it would cost for a given patron to borrow a given
3350 item, including any applicable discounts.
3352 C<$itemnumber> is the item number of item the patron wishes to borrow.
3354 C<$borrowernumber> is the patron's borrower number.
3356 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3357 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3362 sub GetIssuingCharges {
3364 # calculate charges due
3365 my ( $itemnumber, $borrowernumber ) = @_;
3367 my $dbh = C4::Context->dbh;
3370 # Get the book's item type and rental charge (via its biblioitem).
3371 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3372 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3373 $charge_query .= (C4::Context->preference('item-level_itypes'))
3374 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3375 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3377 $charge_query .= ' WHERE items.itemnumber =?';
3379 my $sth = $dbh->prepare($charge_query);
3380 $sth->execute($itemnumber);
3381 if ( my $item_data = $sth->fetchrow_hashref ) {
3382 $item_type = $item_data->{itemtype};
3383 $charge = $item_data->{rentalcharge};
3384 # FIXME This should follow CircControl
3385 my $branch = C4::Context::mybranch();
3386 my $patron = Koha::Patrons->find( $borrowernumber );
3387 my $discount = Koha::CirculationRules->get_effective_rule({
3388 categorycode => $patron->categorycode,
3389 branchcode => $branch,
3390 itemtype => $item_type,
3391 rule_name => 'rentaldiscount'
3394 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3397 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3401 return ( $charge, $item_type );
3404 =head2 AddIssuingCharge
3406 &AddIssuingCharge( $checkout, $charge, $type )
3410 sub AddIssuingCharge {
3411 my ( $checkout, $charge, $type ) = @_;
3413 # FIXME What if checkout does not exist?
3415 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3416 my $accountline = $account->add_debit(
3420 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3421 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3422 interface => C4::Context->interface,
3424 item_id => $checkout->itemnumber,
3425 issue_id => $checkout->issue_id,
3432 GetTransfers($itemnumber);
3437 my ($itemnumber) = @_;
3439 my $dbh = C4::Context->dbh;
3448 FROM branchtransfers
3449 WHERE itemnumber = ?
3450 AND datearrived IS NULL
3451 AND datecancelled IS NULL
3453 my $sth = $dbh->prepare($query);
3454 $sth->execute($itemnumber);
3455 my @row = $sth->fetchrow_array();
3459 =head2 GetTransfersFromTo
3461 @results = GetTransfersFromTo($frombranch,$tobranch);
3463 Returns the list of pending transfers between $from and $to branch
3467 sub GetTransfersFromTo {
3468 my ( $frombranch, $tobranch ) = @_;
3469 return unless ( $frombranch && $tobranch );
3470 my $dbh = C4::Context->dbh;
3472 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3473 FROM branchtransfers
3476 AND datecancelled IS NULL
3477 AND datesent IS NOT NULL
3478 AND datearrived IS NULL
3480 my $sth = $dbh->prepare($query);
3481 $sth->execute( $frombranch, $tobranch );
3484 while ( my $data = $sth->fetchrow_hashref ) {
3485 push @gettransfers, $data;
3487 return (@gettransfers);
3490 =head2 SendCirculationAlert
3492 Send out a C<check-in> or C<checkout> alert using the messaging system.
3500 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3504 Hashref of information about the item being checked in or out.
3508 Hashref of information about the borrower of the item.
3512 The branchcode from where the checkout or check-in took place.
3518 SendCirculationAlert({
3521 borrower => $borrower,
3527 sub SendCirculationAlert {
3529 my ($type, $item, $borrower, $branch) =
3530 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3531 my %message_name = (
3532 CHECKIN => 'Item_Check_in',
3533 CHECKOUT => 'Item_Checkout',
3534 RENEWAL => 'Item_Checkout',
3536 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3537 borrowernumber => $borrower->{borrowernumber},
3538 message_name => $message_name{$type},
3540 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3542 my $schema = Koha::Database->new->schema;
3543 my @transports = keys %{ $borrower_preferences->{transports} };
3545 # From the MySQL doc:
3546 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3547 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3548 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3549 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3551 for my $mtt (@transports) {
3552 my $letter = C4::Letters::GetPreparedLetter (
3553 module => 'circulation',
3554 letter_code => $type,
3555 branchcode => $branch,
3556 message_transport_type => $mtt,
3557 lang => $borrower->{lang},
3559 $issues_table => $item->{itemnumber},
3560 'items' => $item->{itemnumber},
3561 'biblio' => $item->{biblionumber},
3562 'biblioitems' => $item->{biblionumber},
3563 'borrowers' => $borrower,
3564 'branches' => $branch,
3568 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3569 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3570 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3571 unless ( $message ) {
3572 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3573 C4::Message->enqueue($letter, $borrower, $mtt);
3575 $message->append($letter);
3578 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3584 =head2 updateWrongTransfer
3586 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3588 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
3592 sub updateWrongTransfer {
3593 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3595 # first step: cancel the original transfer
3596 my $item = Koha::Items->find($itemNumber);
3597 my $transfer = $item->get_transfer;
3598 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3600 # second step: create a new transfer to the right location
3601 my $new_transfer = $item->request_transfer(
3603 to => $transfer->to_library,
3604 reason => $transfer->reason,
3605 comment => $transfer->comments,
3611 return $new_transfer;
3616 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3618 this function calculates the due date given the start date and configured circulation rules,
3619 checking against the holidays calendar as per the daysmode circulation rule.
3620 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3621 C<$itemtype> = itemtype code of item in question
3622 C<$branch> = location whose calendar to use
3623 C<$borrower> = Borrower object
3624 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3629 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3633 # loanlength now a href
3635 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3637 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3643 if (ref $startdate ne 'DateTime' ) {
3644 $datedue = dt_from_string($datedue);
3646 $datedue = $startdate->clone;
3649 $datedue = dt_from_string()->truncate( to => 'minute' );
3653 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3655 categorycode => $borrower->{categorycode},
3656 itemtype => $itemtype,
3657 branchcode => $branch,
3661 # calculate the datedue as normal
3662 if ( $daysmode eq 'Days' )
3663 { # ignoring calendar
3664 if ( $loanlength->{lengthunit} eq 'hours' ) {
3665 $datedue->add( hours => $loanlength->{$length_key} );
3667 $datedue->add( days => $loanlength->{$length_key} );
3668 $datedue->set_hour(23);
3669 $datedue->set_minute(59);
3673 if ($loanlength->{lengthunit} eq 'hours') {
3674 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3677 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3679 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3680 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3681 if ($loanlength->{lengthunit} eq 'days') {
3682 $datedue->set_hour(23);
3683 $datedue->set_minute(59);
3687 # if Hard Due Dates are used, retrieve them and apply as necessary
3688 my ( $hardduedate, $hardduedatecompare ) =
3689 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3690 if ($hardduedate) { # hardduedates are currently dates
3691 $hardduedate->truncate( to => 'minute' );
3692 $hardduedate->set_hour(23);
3693 $hardduedate->set_minute(59);
3694 my $cmp = DateTime->compare( $hardduedate, $datedue );
3696 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3697 # if the calculated date is before the 'after' Hard Due Date (floor), override
3698 # if the hard due date is set to 'exactly', overrride
3699 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3700 $datedue = $hardduedate->clone;
3703 # in all other cases, keep the date due as it is
3707 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3708 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3709 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3710 if( $expiry_dt ) { #skip empty expiry date..
3711 $expiry_dt->set( hour => 23, minute => 59);
3712 my $d1= $datedue->clone->set_time_zone('floating');
3713 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3714 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3717 if ( $daysmode ne 'Days' ) {
3718 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3719 if ( $calendar->is_holiday($datedue) ) {
3720 # Don't return on a closed day
3721 $datedue = $calendar->prev_open_days( $datedue, 1 );
3730 sub CheckValidBarcode{
3732 my $dbh = C4::Context->dbh;
3733 my $query=qq|SELECT count(*)
3737 my $sth = $dbh->prepare($query);
3738 $sth->execute($barcode);
3739 my $exist=$sth->fetchrow ;
3743 =head2 IsBranchTransferAllowed
3745 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3747 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3749 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3750 Koha::Item->can_be_transferred.
3754 sub IsBranchTransferAllowed {
3755 my ( $toBranch, $fromBranch, $code ) = @_;
3757 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3759 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3760 my $dbh = C4::Context->dbh;
3762 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3763 $sth->execute( $toBranch, $fromBranch, $code );
3764 my $limit = $sth->fetchrow_hashref();
3766 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3767 if ( $limit->{'limitId'} ) {
3774 =head2 CreateBranchTransferLimit
3776 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3778 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3780 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3784 sub CreateBranchTransferLimit {
3785 my ( $toBranch, $fromBranch, $code ) = @_;
3786 return unless defined($toBranch) && defined($fromBranch);
3787 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3789 my $dbh = C4::Context->dbh;
3791 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3792 return $sth->execute( $code, $toBranch, $fromBranch );
3795 =head2 DeleteBranchTransferLimits
3797 my $result = DeleteBranchTransferLimits($frombranch);
3799 Deletes all the library transfer limits for one library. Returns the
3800 number of limits deleted, 0e0 if no limits were deleted, or undef if
3801 no arguments are supplied.
3803 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3804 fromBranch => $fromBranch
3809 sub DeleteBranchTransferLimits {
3811 return unless defined $branch;
3812 my $dbh = C4::Context->dbh;
3813 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3814 return $sth->execute($branch);
3818 my ( $borrowernumber, $itemnum ) = @_;
3819 MarkIssueReturned( $borrowernumber, $itemnum );
3824 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3826 The final optional parameter, C<$params>, expected to contain
3827 'skip_record_index' key, which relayed down to Koha::Item/store,
3828 there it prevents calling of ModZebra index_records,
3829 which takes most of the time in batch adds/deletes: index_records better
3830 to be called later in C<additem.pl> after the whole loop.
3833 skip_record_index => 1|0
3838 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3840 unless ( $mark_lost_from ) {
3841 # Temporary check to avoid regressions
3842 die q|LostItem called without $mark_lost_from, check the API.|;
3846 if ( $force_mark_returned ) {
3849 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3850 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3853 my $dbh = C4::Context->dbh();
3854 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3856 JOIN items USING (itemnumber)
3857 JOIN biblio USING (biblionumber)
3858 WHERE issues.itemnumber=?");
3859 $sth->execute($itemnumber);
3860 my $issues=$sth->fetchrow_hashref();
3862 # If a borrower lost the item, add a replacement cost to the their record
3863 if ( my $borrowernumber = $issues->{borrowernumber} ){
3864 my $patron = Koha::Patrons->find( $borrowernumber );
3866 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3867 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3869 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3870 C4::Accounts::chargelostitem(
3873 $issues->{'replacementprice'},
3874 sprintf( "%s %s %s",
3875 $issues->{'title'} || q{},
3876 $issues->{'barcode'} || q{},
3877 $issues->{'itemcallnumber'} || q{},
3880 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3881 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3884 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3887 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3888 my $item = Koha::Items->find($itemnumber);
3889 my $transfers = $item->get_transfers;
3890 while (my $transfer = $transfers->next) {
3891 $transfer->cancel({ reason => 'ItemLost', force => 1 });
3895 sub GetOfflineOperations {
3896 my $dbh = C4::Context->dbh;
3897 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3898 $sth->execute(C4::Context->userenv->{'branch'});
3899 my $results = $sth->fetchall_arrayref({});
3903 sub GetOfflineOperation {
3904 my $operationid = shift;
3905 return unless $operationid;
3906 my $dbh = C4::Context->dbh;
3907 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3908 $sth->execute( $operationid );
3909 return $sth->fetchrow_hashref;
3912 sub AddOfflineOperation {
3913 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3914 my $dbh = C4::Context->dbh;
3915 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3916 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3920 sub DeleteOfflineOperation {
3921 my $dbh = C4::Context->dbh;
3922 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3923 $sth->execute( shift );
3927 sub ProcessOfflineOperation {
3928 my $operation = shift;
3931 if ( $operation->{action} eq 'return' ) {
3932 $report = ProcessOfflineReturn( $operation );
3933 } elsif ( $operation->{action} eq 'issue' ) {
3934 $report = ProcessOfflineIssue( $operation );
3935 } elsif ( $operation->{action} eq 'payment' ) {
3936 $report = ProcessOfflinePayment( $operation );
3939 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3944 sub ProcessOfflineReturn {
3945 my $operation = shift;
3947 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3950 my $itemnumber = $item->itemnumber;
3951 my $issue = GetOpenIssue( $itemnumber );
3953 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3954 ModDateLastSeen( $itemnumber, $leave_item_lost );
3956 $issue->{borrowernumber},
3958 $operation->{timestamp},
3961 $item->onloan(undef);
3962 $item->store({ log_action => 0 });
3965 return "Item not issued.";
3968 return "Item not found.";
3972 sub ProcessOfflineIssue {
3973 my $operation = shift;
3975 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3978 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3980 return "Barcode not found.";
3982 my $itemnumber = $item->itemnumber;
3983 my $issue = GetOpenIssue( $itemnumber );
3985 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3987 $issue->{borrowernumber},
3989 $operation->{timestamp},
3994 $operation->{'barcode'},
3997 $operation->{timestamp},
4002 return "Borrower not found.";
4006 sub ProcessOfflinePayment {
4007 my $operation = shift;
4009 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4011 $patron->account->pay(
4013 amount => $operation->{amount},
4014 library_id => $operation->{branchcode},
4024 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4026 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4031 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4035 ? Koha::Items->find($itemnumber)
4036 : Koha::Items->find( { barcode => $barcode } );
4040 return C4::Letters::GetPreparedLetter (
4041 module => 'circulation',
4042 letter_code => 'TRANSFERSLIP',
4043 branchcode => $branch,
4045 'branches' => $to_branch,
4046 'biblio' => $item->biblionumber,
4047 'items' => $item->unblessed,
4052 =head2 CheckIfIssuedToPatron
4054 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4056 Return 1 if any record item is issued to patron, otherwise return 0
4060 sub CheckIfIssuedToPatron {
4061 my ($borrowernumber, $biblionumber) = @_;
4063 my $dbh = C4::Context->dbh;
4065 SELECT COUNT(*) FROM issues
4066 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4067 WHERE items.biblionumber = ?
4068 AND issues.borrowernumber = ?
4070 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4071 return 1 if $is_issued;
4077 IsItemIssued( $itemnumber )
4079 Return 1 if the item is on loan, otherwise return 0
4084 my $itemnumber = shift;
4085 my $dbh = C4::Context->dbh;
4086 my $sth = $dbh->prepare(q{
4089 WHERE itemnumber = ?
4091 $sth->execute($itemnumber);
4092 return $sth->fetchrow;
4095 =head2 GetAgeRestriction
4097 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4098 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4100 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4101 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4103 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4104 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4105 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4106 Negative days mean the borrower has gone past the age restriction age.
4110 sub GetAgeRestriction {
4111 my ($record_restrictions, $borrower) = @_;
4112 my $markers = C4::Context->preference('AgeRestrictionMarker');
4114 return unless $record_restrictions;
4115 # Split $record_restrictions to something like FSK 16 or PEGI 6
4116 my @values = split ' ', uc($record_restrictions);
4117 return unless @values;
4119 # Search first occurrence of one of the markers
4120 my @markers = split /\|/, uc($markers);
4121 return unless @markers;
4124 my $restriction_year = 0;
4125 for my $value (@values) {
4127 for my $marker (@markers) {
4128 $marker =~ s/^\s+//; #remove leading spaces
4129 $marker =~ s/\s+$//; #remove trailing spaces
4130 if ( $marker eq $value ) {
4131 if ( $index <= $#values ) {
4132 $restriction_year += $values[$index];
4136 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4138 # Perhaps it is something like "K16" (as in Finland)
4139 $restriction_year += $1;
4143 last if ( $restriction_year > 0 );
4146 #Check if the borrower is age restricted for this material and for how long.
4147 if ($restriction_year && $borrower) {
4148 if ( $borrower->{'dateofbirth'} ) {
4149 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4150 $alloweddate[0] += $restriction_year;
4152 #Prevent runime eror on leap year (invalid date)
4153 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4154 $alloweddate[2] = 28;
4157 #Get how many days the borrower has to reach the age restriction
4158 my @Today = split /-/, dt_from_string()->ymd();
4159 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4160 #Negative days means the borrower went past the age restriction age
4161 return ($restriction_year, $daysToAgeRestriction);
4165 return ($restriction_year);
4169 =head2 GetPendingOnSiteCheckouts
4173 sub GetPendingOnSiteCheckouts {
4174 my $dbh = C4::Context->dbh;
4175 return $dbh->selectall_arrayref(q|
4181 items.itemcallnumber,
4185 issues.date_due < NOW() AS is_overdue,
4188 borrowers.firstname,
4190 borrowers.cardnumber,
4191 borrowers.borrowernumber
4193 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4194 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4195 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4196 WHERE issues.onsite_checkout = 1
4197 |, { Slice => {} } );
4203 my ($count, $branch, $itemtype, $ccode, $newness)
4204 = @$params{qw(count branch itemtype ccode newness)};
4206 my $dbh = C4::Context->dbh;
4209 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4210 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4211 i.ccode, SUM(i.issues) AS count
4213 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4214 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4217 my (@where_strs, @where_args);
4220 push @where_strs, 'i.homebranch = ?';
4221 push @where_args, $branch;
4224 if (C4::Context->preference('item-level_itypes')){
4225 push @where_strs, 'i.itype = ?';
4226 push @where_args, $itemtype;
4228 push @where_strs, 'bi.itemtype = ?';
4229 push @where_args, $itemtype;
4233 push @where_strs, 'i.ccode = ?';
4234 push @where_args, $ccode;
4237 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4238 push @where_args, $newness;
4242 $query .= 'WHERE ' . join(' AND ', @where_strs);
4246 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4247 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4252 $query .= q{ ) xxx WHERE count > 0 };
4253 $count = int($count);
4255 $query .= "LIMIT $count";
4258 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4263 =head2 Internal methods
4267 sub _CalculateAndUpdateFine {
4270 my $borrower = $params->{borrower};
4271 my $item = $params->{item};
4272 my $issue = $params->{issue};
4273 my $return_date = $params->{return_date};
4275 unless ($borrower) { carp "No borrower passed in!" && return; }
4276 unless ($item) { carp "No item passed in!" && return; }
4277 unless ($issue) { carp "No issue passed in!" && return; }
4279 my $datedue = dt_from_string( $issue->date_due );
4281 # we only need to calculate and change the fines if we want to do that on return
4282 # Should be on for hourly loans
4283 my $control = C4::Context->preference('CircControl');
4284 my $control_branchcode =
4285 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4286 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4287 : $issue->branchcode;
4289 my $date_returned = $return_date ? $return_date : dt_from_string();
4291 my ( $amount, $unitcounttotal, $unitcount ) =
4292 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4294 if ( C4::Context->preference('finesMode') eq 'production' ) {
4295 if ( $amount > 0 ) {
4296 C4::Overdues::UpdateFine({
4297 issue_id => $issue->issue_id,
4298 itemnumber => $issue->itemnumber,
4299 borrowernumber => $issue->borrowernumber,
4301 due => output_pref($datedue),
4304 elsif ($return_date) {
4306 # Backdated returns may have fines that shouldn't exist,
4307 # so in this case, we need to drop those fines to 0
4309 C4::Overdues::UpdateFine({
4310 issue_id => $issue->issue_id,
4311 itemnumber => $issue->itemnumber,
4312 borrowernumber => $issue->borrowernumber,
4314 due => output_pref($datedue),
4320 sub _item_denied_renewal {
4323 my $item = $params->{item};
4324 return unless $item;
4326 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4327 return unless $denyingrules;
4328 foreach my $field (keys %$denyingrules) {
4329 my $val = $item->$field;
4330 if( !defined $val) {
4331 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4334 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4335 # If the results matches the values in the syspref
4336 # We return true if match found
4349 Koha Development Team <http://koha-community.org/>