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 );
32 use C4::ItemCirculationAlertPreference;
35 use C4::Log; # logaction
36 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits;
42 use Koha::AuthorisedValues;
43 use Koha::Biblioitems;
47 use Koha::Illrequests;
50 use Koha::Patron::Debarments;
53 use Koha::Account::Lines;
55 use Koha::Account::Lines;
56 use Koha::Account::Offsets;
57 use Koha::Config::SysPrefs;
58 use Koha::Charges::Fees;
59 use Koha::Util::SystemPreferences;
60 use Koha::Checkouts::ReturnClaims;
62 use List::MoreUtils qw( uniq any );
63 use Scalar::Util qw( looks_like_number );
74 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
80 # FIXME subs that should probably be elsewhere
85 &GetPendingOnSiteCheckouts
88 # subs to deal with issuing a book
96 &GetLatestAutoRenewDate
98 &GetBranchBorrowerCircRule
102 &CheckIfIssuedToPatron
107 # subs to deal with returns
113 # subs to deal with transfers
120 &IsBranchTransferAllowed
121 &CreateBranchTransferLimit
122 &DeleteBranchTransferLimits
126 # subs to deal with offline circulation
128 &GetOfflineOperations
131 &DeleteOfflineOperation
132 &ProcessOfflineOperation
138 C4::Circulation - Koha circulation module
146 The functions in this module deal with circulation, issues, and
147 returns, as well as general information about the library.
148 Also deals with inventory.
154 $str = &barcodedecode($barcode, [$filter]);
156 Generic filter function for barcode string.
157 Called on every circ if the System Pref itemBarcodeInputFilter is set.
158 Will do some manipulation of the barcode for systems that deliver a barcode
159 to circulation.pl that differs from the barcode stored for the item.
160 For proper functioning of this filter, calling the function on the
161 correct barcode string (items.barcode) should return an unaltered barcode.
163 The optional $filter argument is to allow for testing or explicit
164 behavior that ignores the System Pref. Valid values are the same as the
169 # FIXME -- the &decode fcn below should be wrapped into this one.
170 # FIXME -- these plugins should be moved out of Circulation.pm
173 my ($barcode, $filter) = @_;
174 my $branch = C4::Context::mybranch();
175 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
176 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
177 if ($filter eq 'whitespace') {
179 } elsif ($filter eq 'cuecat') {
181 my @fields = split( /\./, $barcode );
182 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
183 ($#results == 2) and return $results[2];
184 } elsif ($filter eq 'T-prefix') {
185 if ($barcode =~ /^[Tt](\d)/) {
186 (defined($1) and $1 eq '0') and return $barcode;
187 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
189 return sprintf("T%07d", $barcode);
190 # FIXME: $barcode could be "T1", causing warning: substr outside of string
191 # Why drop the nonzero digit after the T?
192 # Why pass non-digits (or empty string) to "T%07d"?
193 } elsif ($filter eq 'libsuite8') {
194 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
195 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
196 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
198 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
201 } elsif ($filter eq 'EAN13') {
202 my $ean = CheckDigits('ean');
203 if ( $ean->is_valid($barcode) ) {
204 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
205 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
207 warn "# [$barcode] not valid EAN-13/UPC-A\n";
210 return $barcode; # return barcode, modified or not
215 $str = &decode($chunk);
217 Decodes a segment of a string emitted by a CueCat barcode scanner and
220 FIXME: Should be replaced with Barcode::Cuecat from CPAN
221 or Javascript based decoding on the client side.
228 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
229 my @s = map { index( $seq, $_ ); } split( //, $encoded );
230 my $l = ( $#s + 1 ) % 4;
233 # warn "Error: Cuecat decode parsing failed!";
241 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
243 chr( ( $n >> 16 ) ^ 67 )
244 .chr( ( $n >> 8 & 255 ) ^ 67 )
245 .chr( ( $n & 255 ) ^ 67 );
248 $r = substr( $r, 0, length($r) - $l );
254 ($dotransfer, $messages, $iteminformation) = &transferbook({
255 from_branch => $frombranch
256 to_branch => $tobranch,
258 ignore_reserves => $ignore_reserves,
262 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
264 C<$fbr> is the code for the branch initiating the transfer.
265 C<$tbr> is the code for the branch to which the item should be transferred.
267 C<$barcode> is the barcode of the item to be transferred.
269 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
270 Otherwise, if an item is reserved, the transfer fails.
272 C<$trigger> is the enum value for what triggered the transfer.
274 Returns three values:
280 is true if the transfer was successful.
284 is a reference-to-hash which may have any of the following keys:
290 There is no item in the catalog with the given barcode. The value is C<$barcode>.
292 =item C<DestinationEqualsHolding>
294 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.
298 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.
302 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>.
304 =item C<WasTransferred>
306 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
316 my $tbr = $params->{to_branch};
317 my $fbr = $params->{from_branch};
318 my $ignoreRs = $params->{ignore_reserves};
319 my $barcode = $params->{barcode};
320 my $trigger = $params->{trigger};
323 my $item = Koha::Items->find( { barcode => $barcode } );
327 $messages->{'BadBarcode'} = $barcode;
329 return ( $dotransfer, $messages );
332 my $itemnumber = $item->itemnumber;
333 # get branches of book...
334 my $hbr = $item->homebranch;
336 # if using Branch Transfer Limits
337 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
338 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
339 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
340 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
341 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
344 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
345 $messages->{'NotAllowed'} = $tbr . "::" . $code;
350 # can't transfer book if is already there....
351 if ( $fbr eq $tbr ) {
352 $messages->{'DestinationEqualsHolding'} = 1;
356 # check if it is still issued to someone, return it...
357 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
359 AddReturn( $barcode, $fbr );
360 $messages->{'WasReturned'} = $issue->borrowernumber;
364 # That'll save a database query.
365 my ( $resfound, $resrec, undef ) =
366 CheckReserves( $itemnumber );
367 if ( $resfound and not $ignoreRs ) {
368 $resrec->{'ResFound'} = $resfound;
369 $messages->{'ResFound'} = $resrec;
373 #actually do the transfer....
375 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
377 # don't need to update MARC anymore, we do it in batch now
378 $messages->{'WasTransfered'} = 1;
381 ModDateLastSeen( $itemnumber );
382 return ( $dotransfer, $messages );
387 my $borrower = shift;
388 my $item_object = shift;
390 my $onsite_checkout = $params->{onsite_checkout} || 0;
391 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
392 my $cat_borrower = $borrower->{'categorycode'};
393 my $dbh = C4::Context->dbh;
394 # Get which branchcode we need
395 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
396 my $type = $item_object->effective_itemtype;
398 my ($type_object, $parent_type, $parent_maxissueqty_rule);
399 $type_object = Koha::ItemTypes->find( $type );
400 $parent_type = $type_object->parent_type if $type_object;
401 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
402 # Find any children if we are a parent_type;
404 # given branch, patron category, and item type, determine
405 # applicable issuing rule
407 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
409 categorycode => $cat_borrower,
410 itemtype => $parent_type,
411 branchcode => $branch,
412 rule_name => 'maxissueqty',
415 # If the parent rule is for default type we discount it
416 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
418 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
420 categorycode => $cat_borrower,
422 branchcode => $branch,
423 rule_name => 'maxissueqty',
427 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
429 categorycode => $cat_borrower,
431 branchcode => $branch,
432 rule_name => 'maxonsiteissueqty',
437 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
438 # if a rule is found and has a loan limit set, count
439 # how many loans the patron already has that meet that
441 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
444 if ( $maxissueqty_rule->branchcode ) {
445 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
446 $checkouts = $patron->checkouts->search(
447 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
448 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
449 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
451 $checkouts = $patron->checkouts->search(
452 { 'item.homebranch' => $maxissueqty_rule->branchcode },
453 { prefetch => 'item' } );
456 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
459 my $rule_itemtype = $maxissueqty_rule->itemtype;
460 while ( my $c = $checkouts->next ) {
461 my $itemtype = $c->item->effective_itemtype;
463 unless ( $rule_itemtype ) {
464 # matching rule has the default item type, so count only
465 # those existing loans that don't fall under a more
467 @types = Koha::CirculationRules->search(
469 branchcode => $maxissueqty_rule->branchcode,
470 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
471 itemtype => { '!=' => undef },
472 rule_name => 'maxissueqty'
474 )->get_column('itemtype');
476 next if grep {$_ eq $itemtype} @types;
479 if ( $parent_maxissueqty_rule ) {
480 # if we have a parent item type then we count loans of the
481 # specific item type or its siblings or parent
482 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
483 @types = $children->get_column('itemtype');
484 push @types, $parent_type;
485 } elsif ( $child_types ) {
486 # If we are a parent type, we need to count all child types and our own type
487 @types = $child_types->get_column('itemtype');
488 push @types, $type; # And don't forget to count our own types
489 } else { push @types, $type; } # Otherwise only count the specific itemtype
491 next unless grep {$_ eq $itemtype} @types;
493 $sum_checkouts->{total}++;
494 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
495 $sum_checkouts->{itemtype}->{$itemtype}++;
498 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
499 my $checkout_count = $sum_checkouts->{total} || 0;
500 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
502 my $checkout_rules = {
503 checkout_count => $checkout_count,
504 onsite_checkout_count => $onsite_checkout_count,
505 onsite_checkout => $onsite_checkout,
506 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
507 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
508 switch_onsite_checkout => $switch_onsite_checkout,
510 # If parent rules exists
511 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
512 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
513 my $qty_over = _check_max_qty($checkout_rules);
514 return $qty_over if defined $qty_over;
516 # If the parent rule is less than or equal to the child, we only need check the parent
517 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
518 $checkout_rules->{checkout_count} = $checkout_count_type;
519 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
520 my $qty_over = _check_max_qty($checkout_rules);
521 return $qty_over if defined $qty_over;
524 my $qty_over = _check_max_qty($checkout_rules);
525 return $qty_over if defined $qty_over;
529 # Now count total loans against the limit for the branch
530 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
531 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
533 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
534 $checkouts = $patron->checkouts->search(
535 { 'me.branchcode' => $branch} );
536 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
537 ; # if branch is the patron's home branch, then count all loans by patron
539 $checkouts = $patron->checkouts->search(
540 { 'item.homebranch' => $branch} );
543 my $checkout_count = $checkouts->count;
544 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
545 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
546 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
548 my $qty_over = _check_max_qty(
550 checkout_count => $checkout_count,
551 onsite_checkout_count => $onsite_checkout_count,
552 onsite_checkout => $onsite_checkout,
553 max_checkouts_allowed => $max_checkouts_allowed,
554 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
555 switch_onsite_checkout => $switch_onsite_checkout
558 return $qty_over if defined $qty_over;
561 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
562 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
565 # OK, the patron can issue !!!
571 my $checkout_count = $params->{checkout_count};
572 my $onsite_checkout_count = $params->{onsite_checkout_count};
573 my $onsite_checkout = $params->{onsite_checkout};
574 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
575 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
576 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
578 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
579 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
580 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
582 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
583 count => $onsite_checkout_count,
584 max_allowed => $max_onsite_checkouts_allowed,
588 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
589 if ( $max_checkouts_allowed eq '' ) { return; }
590 my $delta = $switch_onsite_checkout ? 1 : 0;
591 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
593 reason => 'TOO_MANY_CHECKOUTS',
594 count => $checkout_count,
595 max_allowed => $max_checkouts_allowed,
599 elsif ( not $onsite_checkout ) {
600 if ( $max_checkouts_allowed eq '' ) { return; }
602 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
605 reason => 'TOO_MANY_CHECKOUTS',
606 count => $checkout_count - $onsite_checkout_count,
607 max_allowed => $max_checkouts_allowed,
615 =head2 CanBookBeIssued
617 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
618 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
620 Check if a book can be issued.
622 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
624 IMPORTANT: The assumption by users of this routine is that causes blocking
625 the issue are keyed by uppercase labels and other returned
626 data is keyed in lower case!
630 =item C<$patron> is a Koha::Patron
632 =item C<$barcode> is the bar code of the book being issued.
634 =item C<$duedates> is a DateTime object.
636 =item C<$inprocess> boolean switch
638 =item C<$ignore_reserves> boolean switch
640 =item C<$params> Hashref of additional parameters
643 override_high_holds - Ignore high holds
644 onsite_checkout - Checkout is an onsite checkout that will not leave the library
652 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
653 Possible values are :
659 sticky due date is invalid
663 borrower gone with no address
667 borrower declared it's card lost
673 =head3 UNKNOWN_BARCODE
687 item is restricted (set by ??)
689 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
690 could be prevented, but ones that can be overriden by the operator.
692 Possible values are :
700 renewing, not issuing
702 =head3 ISSUED_TO_ANOTHER
704 issued to someone else.
708 reserved for someone else.
712 sticky due date is invalid or due date in the past
716 if the borrower borrows to much things
720 sub CanBookBeIssued {
721 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
722 my %needsconfirmation; # filled with problems that needs confirmations
723 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
724 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
725 my %messages; # filled with information messages that should be displayed.
727 my $onsite_checkout = $params->{onsite_checkout} || 0;
728 my $override_high_holds = $params->{override_high_holds} || 0;
730 my $item_object = Koha::Items->find({barcode => $barcode });
732 # MANDATORY CHECKS - unless item exists, nothing else matters
733 unless ( $item_object ) {
734 $issuingimpossible{UNKNOWN_BARCODE} = 1;
736 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
738 my $item_unblessed = $item_object->unblessed; # Transition...
739 my $issue = $item_object->checkout;
740 my $biblio = $item_object->biblio;
742 my $biblioitem = $biblio->biblioitem;
743 my $effective_itemtype = $item_object->effective_itemtype;
744 my $dbh = C4::Context->dbh;
745 my $patron_unblessed = $patron->unblessed;
747 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
749 # DUE DATE is OK ? -- should already have checked.
751 if ($duedate && ref $duedate ne 'DateTime') {
752 $duedate = dt_from_string($duedate);
754 my $now = dt_from_string();
755 unless ( $duedate ) {
756 my $issuedate = $now->clone();
758 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
760 # Offline circ calls AddIssue directly, doesn't run through here
761 # So issuingimpossible should be ok.
764 my $fees = Koha::Charges::Fees->new(
767 library => $circ_library,
768 item => $item_object,
774 my $today = $now->clone();
775 $today->truncate( to => 'minute');
776 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
777 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
780 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
786 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
787 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
789 branch => C4::Context->userenv->{'branch'},
791 itemnumber => $item_object->itemnumber,
792 itemtype => $effective_itemtype,
793 borrowernumber => $patron->borrowernumber,
794 ccode => $item_object->ccode}
796 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
797 return( { STATS => 1 }, {});
800 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
801 $issuingimpossible{GNA} = 1;
804 if ( $patron->lost && $patron->lost == 1 ) {
805 $issuingimpossible{CARD_LOST} = 1;
807 if ( $patron->is_debarred ) {
808 $issuingimpossible{DEBARRED} = 1;
811 if ( $patron->is_expired ) {
812 $issuingimpossible{EXPIRED} = 1;
820 my $account = $patron->account;
821 my $balance = $account->balance;
822 my $non_issues_charges = $account->non_issues_charges;
823 my $other_charges = $balance - $non_issues_charges;
825 my $amountlimit = C4::Context->preference("noissuescharge");
826 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
827 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
829 # Check the debt of this patrons guarantees
830 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
831 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
832 if ( defined $no_issues_charge_guarantees ) {
833 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
834 my $guarantees_non_issues_charges;
835 foreach my $g ( @guarantees ) {
836 $guarantees_non_issues_charges += $g->account->non_issues_charges;
839 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
840 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
841 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
842 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
843 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
844 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
848 if ( C4::Context->preference("IssuingInProcess") ) {
849 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
850 $issuingimpossible{DEBT} = $non_issues_charges;
851 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
852 $needsconfirmation{DEBT} = $non_issues_charges;
853 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
854 $needsconfirmation{DEBT} = $non_issues_charges;
858 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
859 $needsconfirmation{DEBT} = $non_issues_charges;
860 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
861 $issuingimpossible{DEBT} = $non_issues_charges;
862 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
863 $needsconfirmation{DEBT} = $non_issues_charges;
867 if ($balance > 0 && $other_charges > 0) {
868 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
871 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
872 $patron_unblessed = $patron->unblessed;
874 if ( my $debarred_date = $patron->is_debarred ) {
875 # patron has accrued fine days or has a restriction. $count is a date
876 if ($debarred_date eq '9999-12-31') {
877 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
880 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
882 } elsif ( my $num_overdues = $patron->has_overdues ) {
883 ## patron has outstanding overdue loans
884 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
885 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
887 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
888 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
893 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
895 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
897 # Already issued to current borrower.
898 # If it is an on-site checkout if it can be switched to a normal checkout
899 # or ask whether the loan should be renewed
901 if ( $issue->onsite_checkout
902 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
903 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
905 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
906 $patron->borrowernumber,
907 $item_object->itemnumber,
909 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
910 if ( $renewerror eq 'onsite_checkout' ) {
911 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
914 $issuingimpossible{NO_MORE_RENEWALS} = 1;
918 $needsconfirmation{RENEW_ISSUE} = 1;
924 # issued to someone else
926 my $patron = Koha::Patrons->find( $issue->borrowernumber );
928 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
930 unless ( $can_be_returned ) {
931 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
932 $issuingimpossible{branch_to_return} = $message;
934 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
935 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
937 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
938 $needsconfirmation{issued_firstname} = $patron->firstname;
939 $needsconfirmation{issued_surname} = $patron->surname;
940 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
941 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
946 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
948 my $switch_onsite_checkout = (
949 C4::Context->preference('SwitchOnSiteCheckouts')
951 and $issue->onsite_checkout
952 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
953 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
954 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
955 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
956 if ( $toomany->{max_allowed} == 0 ) {
957 $needsconfirmation{PATRON_CANT} = 1;
959 if ( C4::Context->preference("AllowTooManyOverride") ) {
960 $needsconfirmation{TOO_MANY} = $toomany->{reason};
961 $needsconfirmation{current_loan_count} = $toomany->{count};
962 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
964 $issuingimpossible{TOO_MANY} = $toomany->{reason};
965 $issuingimpossible{current_loan_count} = $toomany->{count};
966 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
971 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
973 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
974 my $wants_check = $patron->wants_check_for_previous_checkout;
975 $needsconfirmation{PREVISSUE} = 1
976 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
981 if ( $item_object->notforloan )
983 if(!C4::Context->preference("AllowNotForLoanOverride")){
984 $issuingimpossible{NOT_FOR_LOAN} = 1;
985 $issuingimpossible{item_notforloan} = $item_object->notforloan;
987 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
988 $needsconfirmation{item_notforloan} = $item_object->notforloan;
992 # we have to check itemtypes.notforloan also
993 if (C4::Context->preference('item-level_itypes')){
994 # this should probably be a subroutine
995 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
996 $sth->execute($effective_itemtype);
997 my $notforloan=$sth->fetchrow_hashref();
998 if ($notforloan->{'notforloan'}) {
999 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1000 $issuingimpossible{NOT_FOR_LOAN} = 1;
1001 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1003 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1004 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1009 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1010 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1011 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1012 $issuingimpossible{NOT_FOR_LOAN} = 1;
1013 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1015 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1016 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1021 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1023 $issuingimpossible{WTHDRAWN} = 1;
1025 if ( $item_object->restricted
1026 && $item_object->restricted == 1 )
1028 $issuingimpossible{RESTRICTED} = 1;
1030 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1031 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1032 my $code = $av->count ? $av->next->lib : '';
1033 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1034 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1036 if ( C4::Context->preference("IndependentBranches") ) {
1037 my $userenv = C4::Context->userenv;
1038 unless ( C4::Context->IsSuperLibrarian() ) {
1039 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1040 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1041 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1042 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1044 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1045 if ( $patron->branchcode ne $userenv->{branch} );
1050 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1052 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1053 if ($rentalConfirmation) {
1054 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1056 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1057 if ($itemtype_object) {
1058 my $accumulate_charge = $fees->accumulate_rentalcharge();
1059 if ( $accumulate_charge > 0 ) {
1060 $rentalCharge += $accumulate_charge;
1064 if ( $rentalCharge > 0 ) {
1065 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1069 unless ( $ignore_reserves ) {
1070 # See if the item is on reserve.
1071 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1073 my $resbor = $res->{'borrowernumber'};
1074 if ( $resbor ne $patron->borrowernumber ) {
1075 my $patron = Koha::Patrons->find( $resbor );
1076 if ( $restype eq "Waiting" )
1078 # The item is on reserve and waiting, but has been
1079 # reserved by some other patron.
1080 $needsconfirmation{RESERVE_WAITING} = 1;
1081 $needsconfirmation{'resfirstname'} = $patron->firstname;
1082 $needsconfirmation{'ressurname'} = $patron->surname;
1083 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1084 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1085 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1086 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1087 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1089 elsif ( $restype eq "Reserved" ) {
1090 # The item is on reserve for someone else.
1091 $needsconfirmation{RESERVED} = 1;
1092 $needsconfirmation{'resfirstname'} = $patron->firstname;
1093 $needsconfirmation{'ressurname'} = $patron->surname;
1094 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1095 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1096 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1097 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1098 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1104 ## CHECK AGE RESTRICTION
1105 my $agerestriction = $biblioitem->agerestriction;
1106 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1107 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1108 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1109 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1112 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1116 ## check for high holds decreasing loan period
1117 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1118 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1120 if ( $check->{exceeded} ) {
1121 if ($override_high_holds) {
1122 $alerts{HIGHHOLDS} = {
1123 num_holds => $check->{outstanding},
1124 duration => $check->{duration},
1125 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1129 $needsconfirmation{HIGHHOLDS} = {
1130 num_holds => $check->{outstanding},
1131 duration => $check->{duration},
1132 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1139 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1140 # don't do the multiple loans per bib check if we've
1141 # already determined that we've got a loan on the same item
1142 !$issuingimpossible{NO_MORE_RENEWALS} &&
1143 !$needsconfirmation{RENEW_ISSUE}
1145 # Check if borrower has already issued an item from the same biblio
1146 # Only if it's not a subscription
1147 my $biblionumber = $item_object->biblionumber;
1148 require C4::Serials;
1149 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1150 unless ($is_a_subscription) {
1151 # FIXME Should be $patron->checkouts($args);
1152 my $checkouts = Koha::Checkouts->search(
1154 borrowernumber => $patron->borrowernumber,
1155 biblionumber => $biblionumber,
1161 # if we get here, we don't already have a loan on this item,
1162 # so if there are any loans on this bib, ask for confirmation
1163 if ( $checkouts->count ) {
1164 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1169 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1172 =head2 CanBookBeReturned
1174 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1176 Check whether the item can be returned to the provided branch
1180 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1182 =item C<$branch> is the branchcode where the return is taking place
1190 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1192 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1198 sub CanBookBeReturned {
1199 my ($item, $branch) = @_;
1200 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1202 # assume return is allowed to start
1206 # identify all cases where return is forbidden
1207 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1209 $message = $item->{'homebranch'};
1210 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1212 $message = $item->{'holdingbranch'};
1213 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1215 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1218 return ($allowed, $message);
1221 =head2 CheckHighHolds
1223 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1224 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1225 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1229 sub checkHighHolds {
1230 my ( $item, $borrower ) = @_;
1231 my $branchcode = _GetCircControlBranch( $item, $borrower );
1232 my $item_object = Koha::Items->find( $item->{itemnumber} );
1241 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1243 if ( $holds->count() ) {
1244 $return_data->{outstanding} = $holds->count();
1246 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1247 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1248 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1250 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1252 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1254 # static means just more than a given number of holds on the record
1256 # If the number of holds is less than the threshold, we can stop here
1257 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1258 return $return_data;
1261 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1263 # dynamic means X more than the number of holdable items on the record
1265 # let's get the items
1266 my @items = $holds->next()->biblio()->items()->as_list;
1268 # Remove any items with status defined to be ignored even if the would not make item unholdable
1269 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1270 @items = grep { !$_->$status } @items;
1273 # Remove any items that are not holdable for this patron
1274 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1276 my $items_count = scalar @items;
1278 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1280 # If the number of holds is less than the count of items we have
1281 # plus the number of holds allowed above that count, we can stop here
1282 if ( $holds->count() <= $threshold ) {
1283 return $return_data;
1287 my $issuedate = dt_from_string();
1289 my $itype = $item_object->effective_itemtype;
1290 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1292 categorycode => $borrower->{categorycode},
1294 branchcode => $branchcode,
1297 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1299 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1301 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1303 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1304 $reduced_datedue->set_hour($orig_due->hour);
1305 $reduced_datedue->set_minute($orig_due->minute);
1306 $reduced_datedue->truncate( to => 'minute' );
1308 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1309 $return_data->{exceeded} = 1;
1310 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1311 $return_data->{due_date} = $reduced_datedue;
1315 return $return_data;
1320 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1322 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1326 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1328 =item C<$barcode> is the barcode of the item being issued.
1330 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1331 Calculated if empty.
1333 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1335 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1336 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1338 AddIssue does the following things :
1340 - step 01: check that there is a borrowernumber & a barcode provided
1341 - check for RENEWAL (book issued & being issued to the same patron)
1342 - renewal YES = Calculate Charge & renew
1344 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1346 - fill reserve if reserve to this patron
1347 - cancel reserve or not, otherwise
1348 * TRANSFERT PENDING ?
1349 - complete the transfert
1357 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1359 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1360 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1361 my $auto_renew = $params && $params->{auto_renew};
1362 my $dbh = C4::Context->dbh;
1363 my $barcodecheck = CheckValidBarcode($barcode);
1367 if ( $datedue && ref $datedue ne 'DateTime' ) {
1368 $datedue = dt_from_string($datedue);
1371 # $issuedate defaults to today.
1372 if ( !defined $issuedate ) {
1373 $issuedate = dt_from_string();
1376 if ( ref $issuedate ne 'DateTime' ) {
1377 $issuedate = dt_from_string($issuedate);
1382 # Stop here if the patron or barcode doesn't exist
1383 if ( $borrower && $barcode && $barcodecheck ) {
1384 # find which item we issue
1385 my $item_object = Koha::Items->find({ barcode => $barcode })
1386 or return; # if we don't get an Item, abort.
1387 my $item_unblessed = $item_object->unblessed;
1389 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1391 # get actual issuing if there is one
1392 my $actualissue = $item_object->checkout;
1394 # check if we just renew the issue.
1395 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1396 and not $switch_onsite_checkout ) {
1397 $datedue = AddRenewal(
1398 $borrower->{'borrowernumber'},
1399 $item_object->itemnumber,
1402 $issuedate, # here interpreted as the renewal date
1407 my $itype = $item_object->effective_itemtype;
1408 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1411 $datedue->truncate( to => 'minute' );
1413 my $patron = Koha::Patrons->find( $borrower );
1414 my $library = Koha::Libraries->find( $branchcode );
1415 my $fees = Koha::Charges::Fees->new(
1418 library => $library,
1419 item => $item_object,
1420 to_date => $datedue,
1424 # it's NOT a renewal
1425 if ( $actualissue and not $switch_onsite_checkout ) {
1426 # This book is currently on loan, but not to the person
1427 # who wants to borrow it now. mark it returned before issuing to the new borrower
1428 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1429 return unless $allowed;
1430 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1433 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1435 # Starting process for transfer job (checking transfert and validate it if we have one)
1436 my ($datesent) = GetTransfers( $item_object->itemnumber );
1438 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1439 my $sth = $dbh->prepare(
1440 "UPDATE branchtransfers
1441 SET datearrived = now(),
1443 comments = 'Forced branchtransfer'
1444 WHERE itemnumber= ? AND datearrived IS NULL"
1446 $sth->execute( C4::Context->userenv->{'branch'},
1447 $item_object->itemnumber );
1450 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1451 unless ($auto_renew) {
1452 my $rule = Koha::CirculationRules->get_effective_rule(
1454 categorycode => $borrower->{categorycode},
1455 itemtype => $item_object->effective_itemtype,
1456 branchcode => $branchcode,
1457 rule_name => 'auto_renew'
1461 $auto_renew = $rule->rule_value if $rule;
1464 # Record in the database the fact that the book was issued.
1466 my $itype = $item_object->effective_itemtype;
1467 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1470 $datedue->truncate( to => 'minute' );
1472 my $issue_attributes = {
1473 borrowernumber => $borrower->{'borrowernumber'},
1474 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1475 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1476 branchcode => C4::Context->userenv->{'branch'},
1477 onsite_checkout => $onsite_checkout,
1478 auto_renew => $auto_renew ? 1 : 0,
1481 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1483 $issue->set($issue_attributes)->store;
1486 $issue = Koha::Checkout->new(
1488 itemnumber => $item_object->itemnumber,
1493 if ( $item_object->location && $item_object->location eq 'CART'
1494 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1495 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1496 CartToShelf( $item_object->itemnumber );
1499 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1500 UpdateTotalIssues( $item_object->biblionumber, 1 );
1503 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1504 if ( $item_object->itemlost ) {
1506 my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
1507 if ($no_refund_after_days) {
1508 my $today = dt_from_string();
1509 my $lost_age_in_days =
1510 dt_from_string( $item_object->itemlost_on )
1511 ->delta_days($today)
1514 $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
1518 $refund && Koha::CirculationRules->get_lostreturn_policy(
1520 return_branch => C4::Context->userenv->{branch},
1521 item => $item_object
1526 _FixAccountForLostAndFound( $item_object->itemnumber, undef,
1527 $item_object->barcode );
1531 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1532 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1533 $item_object->itemlost(0);
1534 $item_object->onloan($datedue->ymd());
1535 $item_object->datelastborrowed( dt_from_string()->ymd() );
1536 $item_object->store({log_action => 0});
1537 ModDateLastSeen( $item_object->itemnumber );
1539 # If it costs to borrow this book, charge it to the patron's account.
1540 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1541 if ( $charge && $charge > 0 ) {
1542 AddIssuingCharge( $issue, $charge, 'RENT' );
1545 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1546 if ( $itemtype_object ) {
1547 my $accumulate_charge = $fees->accumulate_rentalcharge();
1548 if ( $accumulate_charge > 0 ) {
1549 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1550 $charge += $accumulate_charge;
1551 $item_unblessed->{charge} = $charge;
1555 # Record the fact that this book was issued.
1558 branch => C4::Context->userenv->{'branch'},
1559 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1561 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1562 itemnumber => $item_object->itemnumber,
1563 itemtype => $item_object->effective_itemtype,
1564 location => $item_object->location,
1565 borrowernumber => $borrower->{'borrowernumber'},
1566 ccode => $item_object->ccode,
1570 # Send a checkout slip.
1571 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1573 branchcode => $branchcode,
1574 categorycode => $borrower->{categorycode},
1575 item_type => $item_object->effective_itemtype,
1576 notification => 'CHECKOUT',
1578 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1579 SendCirculationAlert(
1582 item => $item_object->unblessed,
1583 borrower => $borrower,
1584 branch => $branchcode,
1589 "CIRCULATION", "ISSUE",
1590 $borrower->{'borrowernumber'},
1591 $item_object->itemnumber,
1592 ) if C4::Context->preference("IssueLog");
1594 Koha::Plugins->call('after_circ_action', {
1595 action => 'checkout',
1597 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1598 checkout => $issue->get_from_storage
1606 =head2 GetLoanLength
1608 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1610 Get loan length for an itemtype, a borrower type and a branch
1615 my ( $categorycode, $itemtype, $branchcode ) = @_;
1617 # Set search precedences
1620 categorycode => $categorycode,
1621 itemtype => $itemtype,
1622 branchcode => $branchcode,
1625 categorycode => $categorycode,
1627 branchcode => $branchcode,
1630 categorycode => undef,
1631 itemtype => $itemtype,
1632 branchcode => $branchcode,
1635 categorycode => undef,
1637 branchcode => $branchcode,
1640 categorycode => $categorycode,
1641 itemtype => $itemtype,
1642 branchcode => undef,
1645 categorycode => $categorycode,
1647 branchcode => undef,
1650 categorycode => undef,
1651 itemtype => $itemtype,
1652 branchcode => undef,
1655 categorycode => undef,
1657 branchcode => undef,
1661 # Initialize default values
1665 lengthunit => 'days',
1669 foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1670 foreach my $params (@params) {
1671 my $rule = Koha::CirculationRules->search(
1673 rule_name => $rule_name,
1679 $rules->{$rule_name} = $rule->rule_value;
1689 =head2 GetHardDueDate
1691 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1693 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1697 sub GetHardDueDate {
1698 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1700 my $rules = Koha::CirculationRules->get_effective_rules(
1702 categorycode => $borrowertype,
1703 itemtype => $itemtype,
1704 branchcode => $branchcode,
1705 rules => [ 'hardduedate', 'hardduedatecompare' ],
1709 if ( defined( $rules->{hardduedate} ) ) {
1710 if ( $rules->{hardduedate} ) {
1711 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1714 return ( undef, undef );
1719 =head2 GetBranchBorrowerCircRule
1721 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1723 Retrieves circulation rule attributes that apply to the given
1724 branch and patron category, regardless of item type.
1725 The return value is a hashref containing the following key:
1727 patron_maxissueqty - maximum number of loans that a
1728 patron of the given category can have at the given
1729 branch. If the value is undef, no limit.
1731 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1732 patron of the given category can have at the given
1733 branch. If the value is undef, no limit.
1735 This will check for different branch/category combinations in the following order:
1739 default branch and category
1741 If no rule has been found in the database, it will default to
1744 patron_maxissueqty - undef
1745 patron_maxonsiteissueqty - undef
1747 C<$branchcode> and C<$categorycode> should contain the
1748 literal branch code and patron category code, respectively - no
1753 sub GetBranchBorrowerCircRule {
1754 my ( $branchcode, $categorycode ) = @_;
1756 # Initialize default values
1758 patron_maxissueqty => undef,
1759 patron_maxonsiteissueqty => undef,
1763 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1764 my $rule = Koha::CirculationRules->get_effective_rule(
1766 categorycode => $categorycode,
1768 branchcode => $branchcode,
1769 rule_name => $rule_name,
1773 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1779 =head2 GetBranchItemRule
1781 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1783 Retrieves circulation rule attributes that apply to the given
1784 branch and item type, regardless of patron category.
1786 The return value is a hashref containing the following keys:
1788 holdallowed => Hold policy for this branch and itemtype. Possible values:
1789 0: No holds allowed.
1790 1: Holds allowed only by patrons that have the same homebranch as the item.
1791 2: Holds allowed from any patron.
1793 returnbranch => branch to which to return item. Possible values:
1794 noreturn: do not return, let item remain where checked in (floating collections)
1795 homebranch: return to item's home branch
1796 holdingbranch: return to issuer branch
1798 This searches branchitemrules in the following order:
1800 * Same branchcode and itemtype
1801 * Same branchcode, itemtype '*'
1802 * branchcode '*', same itemtype
1803 * branchcode and itemtype '*'
1805 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1809 sub GetBranchItemRule {
1810 my ( $branchcode, $itemtype ) = @_;
1813 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1815 branchcode => $branchcode,
1816 itemtype => $itemtype,
1817 rule_name => 'holdallowed',
1820 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1822 branchcode => $branchcode,
1823 itemtype => $itemtype,
1824 rule_name => 'hold_fulfillment_policy',
1827 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1829 branchcode => $branchcode,
1830 itemtype => $itemtype,
1831 rule_name => 'returnbranch',
1835 # built-in default circulation rule
1837 $rules->{holdallowed} = defined $holdallowed_rule
1838 ? $holdallowed_rule->rule_value
1840 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1841 ? $hold_fulfillment_policy_rule->rule_value
1843 $rules->{returnbranch} = defined $returnbranch_rule
1844 ? $returnbranch_rule->rule_value
1852 ($doreturn, $messages, $iteminformation, $borrower) =
1853 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1859 =item C<$barcode> is the bar code of the book being returned.
1861 =item C<$branch> is the code of the branch where the book is being returned.
1863 =item C<$exemptfine> indicates that overdue charges for the item will be
1866 =item C<$return_date> allows the default return date to be overridden
1867 by the given return date. Optional.
1871 C<&AddReturn> returns a list of four items:
1873 C<$doreturn> is true iff the return succeeded.
1875 C<$messages> is a reference-to-hash giving feedback on the operation.
1876 The keys of the hash are:
1882 No item with this barcode exists. The value is C<$barcode>.
1886 The book is not currently on loan. The value is C<$barcode>.
1890 This book has been withdrawn/cancelled. The value should be ignored.
1892 =item C<Wrongbranch>
1894 This book has was returned to the wrong branch. The value is a hashref
1895 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1896 contain the branchcode of the incorrect and correct return library, respectively.
1900 The item was reserved. The value is a reference-to-hash whose keys are
1901 fields from the reserves table of the Koha database, and
1902 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1903 either C<Waiting>, C<Reserved>, or 0.
1905 =item C<WasReturned>
1907 Value 1 if return is successful.
1909 =item C<NeedsTransfer>
1911 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1915 C<$iteminformation> is a reference-to-hash, giving information about the
1916 returned item from the issues table.
1918 C<$borrower> is a reference-to-hash, giving information about the
1919 patron who last borrowed the book.
1924 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1926 if ($branch and not Koha::Libraries->find($branch)) {
1927 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1930 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1931 my $return_date_specified = !!$return_date;
1932 $return_date //= dt_from_string();
1936 my $validTransfer = 1;
1937 my $stat_type = 'return';
1939 # get information on item
1940 my $item = Koha::Items->find({ barcode => $barcode });
1942 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1945 my $itemnumber = $item->itemnumber;
1946 my $itemtype = $item->effective_itemtype;
1948 my $issue = $item->checkout;
1950 $patron = $issue->patron
1951 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1952 . Dumper($issue->unblessed) . "\n";
1954 $messages->{'NotIssued'} = $barcode;
1955 $item->onloan(undef)->store if defined $item->onloan;
1957 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1959 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1960 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1961 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1962 $messages->{'LocalUse'} = 1;
1963 $stat_type = 'localuse';
1967 # full item data, but no borrowernumber or checkout info (no issue)
1968 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1969 # get the proper branch to which to return the item
1970 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1971 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1972 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1974 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1975 my $patron_unblessed = $patron ? $patron->unblessed : {};
1977 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1978 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1979 if ($update_loc_rules) {
1980 if (defined $update_loc_rules->{_ALL_}) {
1981 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1982 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1983 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1984 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1985 $item->location($update_loc_rules->{_ALL_})->store;
1989 foreach my $key ( keys %$update_loc_rules ) {
1990 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1991 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1992 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1993 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1994 $item->location($update_loc_rules->{$key})->store;
2001 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2003 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2005 eval { $rules = YAML::Load($yaml); };
2007 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2010 foreach my $key ( keys %$rules ) {
2011 if ( $item->notforloan eq $key ) {
2012 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2013 $item->notforloan($rules->{$key})->store({ log_action => 0 });
2020 # check if the return is allowed at this branch
2021 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2022 unless ($returnallowed){
2023 $messages->{'Wrongbranch'} = {
2024 Wrongbranch => $branch,
2025 Rightbranch => $message
2028 return ( $doreturn, $messages, $issue, $patron_unblessed);
2031 if ( $item->withdrawn ) { # book has been cancelled
2032 $messages->{'withdrawn'} = 1;
2033 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2036 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2040 # case of a return of document (deal with issues and holdingbranch)
2042 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2043 $patron or warn "AddReturn without current borrower";
2047 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
2052 C4::Context->preference('CalculateFinesOnReturn')
2053 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2058 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2061 carp "The checkin for the following issue failed, Please go to the about page, section 'data corrupted' to know how to fix this problem ($@)" . Dumper( $issue->unblessed );
2063 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2066 # FIXME is the "= 1" right? This could be the borrower hash.
2067 $messages->{'WasReturned'} = 1;
2071 $item->onloan(undef)->store({ log_action => 0 });
2074 # the holdingbranch is updated if the document is returned to another location.
2075 # this is always done regardless of whether the item was on loan or not
2076 my $item_holding_branch = $item->holdingbranch;
2077 if ($item->holdingbranch ne $branch) {
2078 $item->holdingbranch($branch)->store;
2081 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2082 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
2084 # check if we have a transfer for this document
2085 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2087 # if we have a transfer to do, we update the line of transfers with the datearrived
2088 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2090 # At this point we will either fill the transfer or it is a wrong transfer
2091 # either way we should not now generate a new transfer
2093 if ( $tobranch eq $branch ) {
2094 my $sth = C4::Context->dbh->prepare(
2095 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2097 $sth->execute( $item->itemnumber );
2099 $messages->{'WrongTransfer'} = $tobranch;
2100 $messages->{'WrongTransferItem'} = $item->itemnumber;
2104 # fix up the accounts.....
2105 if ( $item->itemlost ) {
2106 $messages->{'WasLost'} = 1;
2107 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2109 my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
2110 if ($no_refund_after_days) {
2111 my $today = dt_from_string();
2112 my $lost_age_in_days =
2113 dt_from_string( $item->itemlost_on )
2114 ->delta_days($today)
2117 $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
2122 Koha::CirculationRules->get_lostreturn_policy(
2124 return_branch => C4::Context->userenv->{branch},
2130 _FixAccountForLostAndFound( $item->itemnumber,
2131 $borrowernumber, $barcode );
2132 $messages->{'LostItemFeeRefunded'} = 1;
2137 # fix up the overdues in accounts...
2138 if ($borrowernumber) {
2139 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2140 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2142 if ( $issue and $issue->is_overdue($return_date) ) {
2144 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2146 $messages->{'PrevDebarred'} = $debardate;
2148 $messages->{'Debarred'} = $debardate if $debardate;
2150 # there's no overdue on the item but borrower had been previously debarred
2151 } elsif ( $issue->date_due and $patron->debarred ) {
2152 if ( $patron->debarred eq "9999-12-31") {
2153 $messages->{'ForeverDebarred'} = $patron->debarred;
2155 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2156 $borrower_debar_dt->truncate(to => 'day');
2157 my $today_dt = $return_date->clone()->truncate(to => 'day');
2158 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2159 $messages->{'PrevDebarred'} = $patron->debarred;
2165 # find reserves.....
2166 # launch the Checkreserves routine to find any holds
2167 my ($resfound, $resrec);
2168 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2169 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2170 # 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)
2171 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2172 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2173 $resfound = 'Reserved';
2174 $resrec = $hold->unblessed;
2177 $resrec->{'ResFound'} = $resfound;
2178 $messages->{'ResFound'} = $resrec;
2181 # Record the fact that this book was returned.
2185 itemnumber => $itemnumber,
2186 itemtype => $itemtype,
2187 location => $item->location,
2188 borrowernumber => $borrowernumber,
2189 ccode => $item->ccode,
2192 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2194 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2196 branchcode => $branch,
2197 categorycode => $patron->categorycode,
2198 item_type => $itemtype,
2199 notification => 'CHECKIN',
2201 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2202 SendCirculationAlert({
2204 item => $item->unblessed,
2205 borrower => $patron->unblessed,
2210 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2211 if C4::Context->preference("ReturnLog");
2214 # Check if this item belongs to a biblio record that is attached to an
2215 # ILL request, if it is we need to update the ILL request's status
2216 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2217 my $request = Koha::Illrequests->find(
2218 { biblio_id => $item->biblio->biblionumber }
2220 $request->status('RET') if $request;
2223 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2224 if ($validTransfer && !$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) ){
2225 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2226 if (C4::Context->preference("AutomaticItemReturn" ) or
2227 (C4::Context->preference("UseBranchTransferLimits") and
2228 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2230 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2231 $debug and warn "item: " . Dumper($item->unblessed);
2232 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger);
2233 $messages->{'WasTransfered'} = 1;
2235 $messages->{'NeedsTransfer'} = $returnbranch;
2236 $messages->{'TransferTrigger'} = $transfer_trigger;
2240 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2241 my $claims = Koha::Checkouts::ReturnClaims->search(
2243 itemnumber => $item->id,
2244 resolution => undef,
2248 if ( $claims->count ) {
2249 $messages->{ReturnClaims} = $claims;
2253 if ( $doreturn and $issue ) {
2254 my $checkin = Koha::Old::Checkouts->find($issue->id);
2256 Koha::Plugins->call('after_circ_action', {
2257 action => 'checkin',
2264 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2267 =head2 MarkIssueReturned
2269 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2271 Unconditionally marks an issue as being returned by
2272 moving the C<issues> row to C<old_issues> and
2273 setting C<returndate> to the current date.
2275 if C<$returndate> is specified (in iso format), it is used as the date
2278 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2279 the old_issue is immediately anonymised
2281 Ideally, this function would be internal to C<C4::Circulation>,
2282 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2283 and offline_circ/process_koc.pl.
2287 sub MarkIssueReturned {
2288 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2290 # Retrieve the issue
2291 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2293 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2295 my $issue_id = $issue->issue_id;
2297 my $anonymouspatron;
2298 if ( $privacy && $privacy == 2 ) {
2299 # The default of 0 will not work due to foreign key constraints
2300 # The anonymisation will fail if AnonymousPatron is not a valid entry
2301 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2302 # Note that a warning should appear on the about page (System information tab).
2303 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2304 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."
2305 unless Koha::Patrons->find( $anonymouspatron );
2308 my $schema = Koha::Database->schema;
2310 # FIXME Improve the return value and handle it from callers
2311 $schema->txn_do(sub {
2313 my $patron = Koha::Patrons->find( $borrowernumber );
2315 # Update the returndate value
2316 if ( $returndate ) {
2317 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2320 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2323 # Create the old_issues entry
2324 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2326 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2327 if ( $privacy && $privacy == 2) {
2328 $old_checkout->borrowernumber($anonymouspatron)->store;
2331 # And finally delete the issue
2334 $issue->item->onloan(undef)->store({ log_action => 0 });
2336 if ( C4::Context->preference('StoreLastBorrower') ) {
2337 my $item = Koha::Items->find( $itemnumber );
2338 $item->last_returned_by( $patron );
2341 # Remove any OVERDUES related debarment if the borrower has no overdues
2342 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2343 && $patron->debarred
2344 && !$patron->has_overdues
2345 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2347 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2355 =head2 _debar_user_on_return
2357 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2359 C<$borrower> borrower hashref
2361 C<$item> item hashref
2363 C<$datedue> date due DateTime object
2365 C<$returndate> DateTime object representing the return time
2367 Internal function, called only by AddReturn that calculates and updates
2368 the user fine days, and debars them if necessary.
2370 Should only be called for overdue returns
2372 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2377 sub _calculate_new_debar_dt {
2378 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2380 my $branchcode = _GetCircControlBranch( $item, $borrower );
2381 my $circcontrol = C4::Context->preference('CircControl');
2382 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2383 { categorycode => $borrower->{categorycode},
2384 itemtype => $item->{itype},
2385 branchcode => $branchcode,
2390 'maxsuspensiondays',
2391 'suspension_chargeperiod',
2395 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2396 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2397 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2399 return unless $finedays;
2401 # finedays is in days, so hourly loans must multiply by 24
2402 # thus 1 hour late equals 1 day suspension * finedays rate
2403 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2405 # grace period is measured in the same units as the loan
2407 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2409 my $deltadays = DateTime::Duration->new(
2410 days => $chargeable_units
2413 if ( $deltadays->subtract($grace)->is_positive() ) {
2414 my $suspension_days = $deltadays * $finedays;
2416 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2417 # No need to / 1 and do not consider / 0
2418 $suspension_days = DateTime::Duration->new(
2419 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2423 # If the max suspension days is < than the suspension days
2424 # the suspension days is limited to this maximum period.
2425 my $max_sd = $issuing_rule->{maxsuspensiondays};
2426 if ( defined $max_sd && $max_sd ne '' ) {
2427 $max_sd = DateTime::Duration->new( days => $max_sd );
2428 $suspension_days = $max_sd
2429 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2432 my ( $has_been_extended );
2433 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2434 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2436 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2437 $has_been_extended = 1;
2442 # Use the calendar or not to calculate the debarment date
2443 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2444 my $calendar = Koha::Calendar->new(
2445 branchcode => $branchcode,
2446 days_mode => 'Calendar'
2448 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2451 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2453 return $new_debar_dt;
2458 sub _debar_user_on_return {
2459 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2461 $return_date //= dt_from_string();
2463 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2465 return unless $new_debar_dt;
2467 Koha::Patron::Debarments::AddUniqueDebarment({
2468 borrowernumber => $borrower->{borrowernumber},
2469 expiration => $new_debar_dt->ymd(),
2470 type => 'SUSPENSION',
2472 # if borrower was already debarred but does not get an extra debarment
2473 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2474 my ($new_debarment_str, $is_a_reminder);
2475 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2477 $new_debarment_str = $borrower->{debarred};
2479 $new_debarment_str = $new_debar_dt->ymd();
2481 # FIXME Should return a DateTime object
2482 return $new_debarment_str, $is_a_reminder;
2485 =head2 _FixOverduesOnReturn
2487 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2489 C<$borrowernumber> borrowernumber
2491 C<$itemnumber> itemnumber
2493 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2495 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2501 sub _FixOverduesOnReturn {
2502 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2503 unless( $borrowernumber ) {
2504 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2508 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2512 warn "_FixOverduesOnReturn() not supplied valid status";
2516 my $schema = Koha::Database->schema;
2518 my $result = $schema->txn_do(
2520 # check for overdue fine
2521 my $accountlines = Koha::Account::Lines->search(
2523 borrowernumber => $borrowernumber,
2524 itemnumber => $item,
2525 debit_type_code => 'OVERDUE',
2526 status => 'UNRETURNED'
2529 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2531 my $accountline = $accountlines->next;
2532 my $payments = $accountline->credits;
2534 my $amountoutstanding = $accountline->amountoutstanding;
2535 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2536 $accountline->delete;
2537 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2538 my $account = Koha::Account->new({patron_id => $borrowernumber});
2539 my $credit = $account->add_credit(
2541 amount => $amountoutstanding,
2542 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2543 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2544 interface => C4::Context->interface,
2550 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2552 if (C4::Context->preference("FinesLog")) {
2553 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2556 $accountline->status('FORGIVEN');
2557 $accountline->store();
2559 $accountline->status($status);
2560 $accountline->store();
2569 =head2 _FixAccountForLostAndFound
2571 &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2573 Finds the most recent lost item charge for this item and refunds the borrower
2574 appropriatly, taking into account any payments or writeoffs already applied
2577 Internal function, not exported, called only by AddReturn.
2581 sub _FixAccountForLostAndFound {
2582 my $itemnumber = shift or return;
2583 my $borrowernumber = @_ ? shift : undef;
2584 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2588 # check for charge made for lost book
2589 my $accountlines = Koha::Account::Lines->search(
2591 itemnumber => $itemnumber,
2592 debit_type_code => 'LOST',
2593 status => [ undef, { '<>' => 'FOUND' } ]
2596 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2600 return unless $accountlines->count > 0;
2601 my $accountline = $accountlines->next;
2602 my $total_to_refund = 0;
2604 return unless $accountline->borrowernumber;
2605 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2606 return unless $patron; # Patron has been deleted, nobody to credit the return to
2608 my $account = $patron->account;
2611 if ( $accountline->amount > $accountline->amountoutstanding ) {
2612 # some amount has been cancelled. collect the offsets that are not writeoffs
2613 # this works because the only way to subtract from this kind of a debt is
2614 # using the UI buttons 'Pay' and 'Write off'
2615 my $credits_offsets = Koha::Account::Offsets->search({
2616 debit_id => $accountline->id,
2617 credit_id => { '!=' => undef }, # it is not the debit itself
2618 type => { '!=' => 'Writeoff' },
2619 amount => { '<' => 0 } # credits are negative on the DB
2622 $total_to_refund = ( $credits_offsets->count > 0 )
2623 ? $credits_offsets->total * -1 # credits are negative on the DB
2627 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2629 if ( $credit_total > 0 ) {
2630 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2631 $credit = $account->add_credit(
2633 amount => $credit_total,
2634 description => 'Item found ' . $item_id,
2635 type => 'LOST_FOUND',
2636 interface => C4::Context->interface,
2637 library_id => $branchcode,
2638 item_id => $itemnumber
2642 $credit->apply( { debits => [ $accountline ] } );
2645 # Update the account status
2646 $accountline->discard_changes->status('FOUND');
2647 $accountline->store;
2649 $accountline->item->paidfor('')->store({ log_action => 0 });
2651 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2652 $account->reconcile_balance;
2655 return ($credit) ? $credit->id : undef;
2658 =head2 _GetCircControlBranch
2660 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2664 Return the library code to be used to determine which circulation
2665 policy applies to a transaction. Looks up the CircControl and
2666 HomeOrHoldingBranch system preferences.
2668 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2670 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2674 sub _GetCircControlBranch {
2675 my ($item, $borrower) = @_;
2676 my $circcontrol = C4::Context->preference('CircControl');
2679 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2680 $branch= C4::Context->userenv->{'branch'};
2681 } elsif ($circcontrol eq 'PatronLibrary') {
2682 $branch=$borrower->{branchcode};
2684 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2685 $branch = $item->{$branchfield};
2686 # default to item home branch if holdingbranch is used
2687 # and is not defined
2688 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2689 $branch = $item->{homebranch};
2697 $issue = GetOpenIssue( $itemnumber );
2699 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2701 C<$itemnumber> is the item's itemnumber
2708 my ( $itemnumber ) = @_;
2709 return unless $itemnumber;
2710 my $dbh = C4::Context->dbh;
2711 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2712 $sth->execute( $itemnumber );
2713 return $sth->fetchrow_hashref();
2717 =head2 GetBiblioIssues
2719 $issues = GetBiblioIssues($biblionumber);
2721 this function get all issues from a biblionumber.
2724 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2725 tables issues and the firstname,surname & cardnumber from borrowers.
2729 sub GetBiblioIssues {
2730 my $biblionumber = shift;
2731 return unless $biblionumber;
2732 my $dbh = C4::Context->dbh;
2734 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2736 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2737 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2738 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2739 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2740 WHERE biblio.biblionumber = ?
2742 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2744 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2745 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2746 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2747 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2748 WHERE biblio.biblionumber = ?
2751 my $sth = $dbh->prepare($query);
2752 $sth->execute($biblionumber, $biblionumber);
2755 while ( my $data = $sth->fetchrow_hashref ) {
2756 push @issues, $data;
2761 =head2 GetUpcomingDueIssues
2763 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2767 sub GetUpcomingDueIssues {
2770 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2771 my $dbh = C4::Context->dbh;
2773 my $statement = <<END_SQL;
2776 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2778 LEFT JOIN items USING (itemnumber)
2779 LEFT OUTER JOIN branches USING (branchcode)
2780 WHERE returndate is NULL
2782 WHERE days_until_due >= 0 AND days_until_due <= ?
2785 my @bind_parameters = ( $params->{'days_in_advance'} );
2787 my $sth = $dbh->prepare( $statement );
2788 $sth->execute( @bind_parameters );
2789 my $upcoming_dues = $sth->fetchall_arrayref({});
2791 return $upcoming_dues;
2794 =head2 CanBookBeRenewed
2796 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2798 Find out whether a borrowed item may be renewed.
2800 C<$borrowernumber> is the borrower number of the patron who currently
2801 has the item on loan.
2803 C<$itemnumber> is the number of the item to renew.
2805 C<$override_limit>, if supplied with a true value, causes
2806 the limit on the number of times that the loan can be renewed
2807 (as controlled by the item type) to be ignored. Overriding also allows
2808 to renew sooner than "No renewal before" and to manually renew loans
2809 that are automatically renewed.
2811 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2812 item must currently be on loan to the specified borrower; renewals
2813 must be allowed for the item's type; and the borrower must not have
2814 already renewed the loan. $error will contain the reason the renewal can not proceed
2818 sub CanBookBeRenewed {
2819 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2821 my $dbh = C4::Context->dbh;
2825 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2826 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2827 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2828 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2830 my $patron = $issue->patron or return;
2832 # override_limit will override anything else except on_reserve
2833 unless ( $override_limit ){
2834 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2835 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2837 categorycode => $patron->categorycode,
2838 itemtype => $item->effective_itemtype,
2839 branchcode => $branchcode,
2842 'no_auto_renewal_after',
2843 'no_auto_renewal_after_hard_limit',
2850 return ( 0, "too_many" )
2851 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2853 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2854 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2855 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2856 my $restricted = $patron->is_debarred;
2857 my $hasoverdues = $patron->has_overdues;
2859 if ( $restricted and $restrictionblockrenewing ) {
2860 return ( 0, 'restriction');
2861 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2862 return ( 0, 'overdue');
2865 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2867 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2868 return ( 0, 'auto_account_expired' );
2871 if ( defined $issuing_rule->{no_auto_renewal_after}
2872 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2873 # Get issue_date and add no_auto_renewal_after
2874 # If this is greater than today, it's too late for renewal.
2875 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2876 $maximum_renewal_date->add(
2877 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2879 my $now = dt_from_string;
2880 if ( $now >= $maximum_renewal_date ) {
2881 return ( 0, "auto_too_late" );
2884 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2885 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2886 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2887 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2888 return ( 0, "auto_too_late" );
2892 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2893 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2894 my $amountoutstanding =
2895 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2896 ? $patron->account->balance
2897 : $patron->account->outstanding_debits->total_outstanding;
2898 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2899 return ( 0, "auto_too_much_oweing" );
2904 if ( defined $issuing_rule->{norenewalbefore}
2905 and $issuing_rule->{norenewalbefore} ne "" )
2908 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2909 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2910 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2912 # Depending on syspref reset the exact time, only check the date
2913 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2914 and $issuing_rule->{lengthunit} eq 'days' )
2916 $soonestrenewal->truncate( to => 'day' );
2919 if ( $soonestrenewal > dt_from_string() )
2921 return ( 0, "auto_too_soon" ) if $issue->auto_renew && $patron->autorenew_checkouts;
2922 return ( 0, "too_soon" );
2924 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2929 # Fallback for automatic renewals:
2930 # If norenewalbefore is undef, don't renew before due date.
2931 if ( $issue->auto_renew && !$auto_renew && $patron->autorenew_checkouts ) {
2932 my $now = dt_from_string;
2933 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2936 return ( 0, "auto_too_soon" );
2941 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2943 # This item can fill one or more unfilled reserve, can those unfilled reserves
2944 # all be filled by other available items?
2946 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2948 my $schema = Koha::Database->new()->schema();
2950 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2952 # There is an item level hold on this item, no other item can fill the hold
2957 # Get all other items that could possibly fill reserves
2958 my @itemnumbers = $schema->resultset('Item')->search(
2960 biblionumber => $resrec->{biblionumber},
2963 -not => { itemnumber => $itemnumber }
2965 { columns => 'itemnumber' }
2966 )->get_column('itemnumber')->all();
2968 # Get all other reserves that could have been filled by this item
2969 my @borrowernumbers;
2971 my ( $reserve_found, $reserve, undef ) =
2972 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2974 if ($reserve_found) {
2975 push( @borrowernumbers, $reserve->{borrowernumber} );
2982 # If the count of the union of the lists of reservable items for each borrower
2983 # is equal or greater than the number of borrowers, we know that all reserves
2984 # can be filled with available items. We can get the union of the sets simply
2985 # by pushing all the elements onto an array and removing the duplicates.
2988 ITEM: foreach my $itemnumber (@itemnumbers) {
2989 my $item = Koha::Items->find( $itemnumber );
2990 next if IsItemOnHoldAndFound( $itemnumber );
2991 for my $borrowernumber (@borrowernumbers) {
2992 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2993 next unless IsAvailableForItemLevelRequest($item, $patron);
2994 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2996 push @reservable, $itemnumber;
2997 if (@reservable >= @borrowernumbers) {
3006 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
3007 return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
3009 return ( 1, undef );
3014 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
3018 C<$borrowernumber> is the borrower number of the patron who currently
3021 C<$itemnumber> is the number of the item to renew.
3023 C<$branch> is the library where the renewal took place (if any).
3024 The library that controls the circ policies for the renewal is retrieved from the issues record.
3026 C<$datedue> can be a DateTime object used to set the due date.
3028 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3029 this parameter is not supplied, lastreneweddate is set to the current date.
3031 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3032 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3033 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3036 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3037 from the book's item type.
3042 my $borrowernumber = shift;
3043 my $itemnumber = shift or return;
3045 my $datedue = shift;
3046 my $lastreneweddate = shift || dt_from_string();
3047 my $skipfinecalc = shift;
3049 my $item_object = Koha::Items->find($itemnumber) or return;
3050 my $biblio = $item_object->biblio;
3051 my $issue = $item_object->checkout;
3052 my $item_unblessed = $item_object->unblessed;
3054 my $dbh = C4::Context->dbh;
3056 return unless $issue;
3058 $borrowernumber ||= $issue->borrowernumber;
3060 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3061 carp 'Invalid date passed to AddRenewal.';
3065 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3066 my $patron_unblessed = $patron->unblessed;
3068 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3070 my $schema = Koha::Database->schema;
3071 $schema->txn_do(sub{
3073 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3074 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3076 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3078 # If the due date wasn't specified, calculate it by adding the
3079 # book's loan length to today's date or the current due date
3080 # based on the value of the RenewalPeriodBase syspref.
3081 my $itemtype = $item_object->effective_itemtype;
3084 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3085 dt_from_string( $issue->date_due, 'sql' ) :
3087 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3090 my $fees = Koha::Charges::Fees->new(
3093 library => $circ_library,
3094 item => $item_object,
3095 from_date => dt_from_string( $issue->date_due, 'sql' ),
3096 to_date => dt_from_string($datedue),
3100 # Update the issues record to have the new due date, and a new count
3101 # of how many times it has been renewed.
3102 my $renews = ( $issue->renewals || 0 ) + 1;
3103 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3104 WHERE borrowernumber=?
3108 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3110 # Update the renewal count on the item, and tell zebra to reindex
3111 $renews = ( $item_object->renewals || 0 ) + 1;
3112 $item_object->renewals($renews);
3113 $item_object->onloan($datedue);
3114 $item_object->store({ log_action => 0 });
3116 # Charge a new rental fee, if applicable
3117 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3118 if ( $charge > 0 ) {
3119 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3122 # Charge a new accumulate rental fee, if applicable
3123 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3124 if ( $itemtype_object ) {
3125 my $accumulate_charge = $fees->accumulate_rentalcharge();
3126 if ( $accumulate_charge > 0 ) {
3127 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3129 $charge += $accumulate_charge;
3132 # Send a renewal slip according to checkout alert preferencei
3133 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3134 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3136 branchcode => $branch,
3137 categorycode => $patron->categorycode,
3138 item_type => $itemtype,
3139 notification => 'CHECKOUT',
3141 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3142 SendCirculationAlert(
3145 item => $item_unblessed,
3146 borrower => $patron->unblessed,
3153 # Remove any OVERDUES related debarment if the borrower has no overdues
3155 && $patron->is_debarred
3156 && ! $patron->has_overdues
3157 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3159 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3162 # Add the renewal to stats
3165 branch => $item_object->renewal_branchcode({branch => $branch}),
3168 itemnumber => $itemnumber,
3169 itemtype => $itemtype,
3170 location => $item_object->location,
3171 borrowernumber => $borrowernumber,
3172 ccode => $item_object->ccode,
3177 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3179 Koha::Plugins->call('after_circ_action', {
3180 action => 'renewal',
3182 checkout => $issue->get_from_storage
3191 # check renewal status
3192 my ( $bornum, $itemno ) = @_;
3193 my $dbh = C4::Context->dbh;
3195 my $renewsallowed = 0;
3198 my $patron = Koha::Patrons->find( $bornum );
3199 my $item = Koha::Items->find($itemno);
3201 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3203 # Look in the issues table for this item, lent to this borrower,
3204 # and not yet returned.
3206 # FIXME - I think this function could be redone to use only one SQL call.
3207 my $sth = $dbh->prepare(
3208 "select * from issues
3209 where (borrowernumber = ?)
3210 and (itemnumber = ?)"
3212 $sth->execute( $bornum, $itemno );
3213 my $data = $sth->fetchrow_hashref;
3214 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3215 # $item and $borrower should be calculated
3216 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3218 my $rule = Koha::CirculationRules->get_effective_rule(
3220 categorycode => $patron->categorycode,
3221 itemtype => $item->effective_itemtype,
3222 branchcode => $branchcode,
3223 rule_name => 'renewalsallowed',
3227 $renewsallowed = $rule ? $rule->rule_value : 0;
3228 $renewsleft = $renewsallowed - $renewcount;
3229 if($renewsleft < 0){ $renewsleft = 0; }
3230 return ( $renewcount, $renewsallowed, $renewsleft );
3233 =head2 GetSoonestRenewDate
3235 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3237 Find out the soonest possible renew date of a borrowed item.
3239 C<$borrowernumber> is the borrower number of the patron who currently
3240 has the item on loan.
3242 C<$itemnumber> is the number of the item to renew.
3244 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3245 renew date, based on the value "No renewal before" of the applicable
3246 issuing rule. Returns the current date if the item can already be
3247 renewed, and returns undefined if the borrower, loan, or item
3252 sub GetSoonestRenewDate {
3253 my ( $borrowernumber, $itemnumber ) = @_;
3255 my $dbh = C4::Context->dbh;
3257 my $item = Koha::Items->find($itemnumber) or return;
3258 my $itemissue = $item->checkout or return;
3260 $borrowernumber ||= $itemissue->borrowernumber;
3261 my $patron = Koha::Patrons->find( $borrowernumber )
3264 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3265 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3266 { categorycode => $patron->categorycode,
3267 itemtype => $item->effective_itemtype,
3268 branchcode => $branchcode,
3276 my $now = dt_from_string;
3277 return $now unless $issuing_rule;
3279 if ( defined $issuing_rule->{norenewalbefore}
3280 and $issuing_rule->{norenewalbefore} ne "" )
3282 my $soonestrenewal =
3283 dt_from_string( $itemissue->date_due )->subtract(
3284 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3286 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3287 and $issuing_rule->{lengthunit} eq 'days' )
3289 $soonestrenewal->truncate( to => 'day' );
3291 return $soonestrenewal if $now < $soonestrenewal;
3296 =head2 GetLatestAutoRenewDate
3298 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3300 Find out the latest possible auto renew date of a borrowed item.
3302 C<$borrowernumber> is the borrower number of the patron who currently
3303 has the item on loan.
3305 C<$itemnumber> is the number of the item to renew.
3307 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3308 auto renew date, based on the value "No auto renewal after" and the "No auto
3309 renewal after (hard limit) of the applicable issuing rule.
3310 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3311 or item cannot be found.
3315 sub GetLatestAutoRenewDate {
3316 my ( $borrowernumber, $itemnumber ) = @_;
3318 my $dbh = C4::Context->dbh;
3320 my $item = Koha::Items->find($itemnumber) or return;
3321 my $itemissue = $item->checkout or return;
3323 $borrowernumber ||= $itemissue->borrowernumber;
3324 my $patron = Koha::Patrons->find( $borrowernumber )
3327 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3328 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3330 categorycode => $patron->categorycode,
3331 itemtype => $item->effective_itemtype,
3332 branchcode => $branchcode,
3334 'no_auto_renewal_after',
3335 'no_auto_renewal_after_hard_limit',
3341 return unless $circulation_rules;
3343 if ( not $circulation_rules->{no_auto_renewal_after}
3344 or $circulation_rules->{no_auto_renewal_after} eq '' )
3345 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3346 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3348 my $maximum_renewal_date;
3349 if ( $circulation_rules->{no_auto_renewal_after} ) {
3350 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3351 $maximum_renewal_date->add(
3352 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3356 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3357 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3358 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3360 return $maximum_renewal_date;
3364 =head2 GetIssuingCharges
3366 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3368 Calculate how much it would cost for a given patron to borrow a given
3369 item, including any applicable discounts.
3371 C<$itemnumber> is the item number of item the patron wishes to borrow.
3373 C<$borrowernumber> is the patron's borrower number.
3375 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3376 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3381 sub GetIssuingCharges {
3383 # calculate charges due
3384 my ( $itemnumber, $borrowernumber ) = @_;
3386 my $dbh = C4::Context->dbh;
3389 # Get the book's item type and rental charge (via its biblioitem).
3390 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3391 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3392 $charge_query .= (C4::Context->preference('item-level_itypes'))
3393 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3394 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3396 $charge_query .= ' WHERE items.itemnumber =?';
3398 my $sth = $dbh->prepare($charge_query);
3399 $sth->execute($itemnumber);
3400 if ( my $item_data = $sth->fetchrow_hashref ) {
3401 $item_type = $item_data->{itemtype};
3402 $charge = $item_data->{rentalcharge};
3403 my $branch = C4::Context::mybranch();
3404 my $patron = Koha::Patrons->find( $borrowernumber );
3405 my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3407 # We may have multiple rules so get the most specific
3408 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3411 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3415 return ( $charge, $item_type );
3418 # Select most appropriate discount rule from those returned
3419 sub _get_discount_from_rule {
3420 my ($categorycode, $branchcode, $itemtype) = @_;
3422 # Set search precedences
3425 branchcode => $branchcode,
3426 itemtype => $itemtype,
3427 categorycode => $categorycode,
3430 branchcode => undef,
3431 categorycode => $categorycode,
3432 itemtype => $itemtype,
3435 branchcode => $branchcode,
3436 categorycode => $categorycode,
3440 branchcode => undef,
3441 categorycode => $categorycode,
3446 foreach my $params (@params) {
3447 my $rule = Koha::CirculationRules->search(
3449 rule_name => 'rentaldiscount',
3454 return $rule->rule_value if $rule;
3461 =head2 AddIssuingCharge
3463 &AddIssuingCharge( $checkout, $charge, $type )
3467 sub AddIssuingCharge {
3468 my ( $checkout, $charge, $type ) = @_;
3470 # FIXME What if checkout does not exist?
3472 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3473 my $accountline = $account->add_debit(
3477 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3478 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3479 interface => C4::Context->interface,
3481 item_id => $checkout->itemnumber,
3482 issue_id => $checkout->issue_id,
3489 GetTransfers($itemnumber);
3494 my ($itemnumber) = @_;
3496 my $dbh = C4::Context->dbh;
3503 FROM branchtransfers
3504 WHERE itemnumber = ?
3505 AND datearrived IS NULL
3507 my $sth = $dbh->prepare($query);
3508 $sth->execute($itemnumber);
3509 my @row = $sth->fetchrow_array();
3513 =head2 GetTransfersFromTo
3515 @results = GetTransfersFromTo($frombranch,$tobranch);
3517 Returns the list of pending transfers between $from and $to branch
3521 sub GetTransfersFromTo {
3522 my ( $frombranch, $tobranch ) = @_;
3523 return unless ( $frombranch && $tobranch );
3524 my $dbh = C4::Context->dbh;
3526 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3527 FROM branchtransfers
3530 AND datearrived IS NULL
3532 my $sth = $dbh->prepare($query);
3533 $sth->execute( $frombranch, $tobranch );
3536 while ( my $data = $sth->fetchrow_hashref ) {
3537 push @gettransfers, $data;
3539 return (@gettransfers);
3542 =head2 DeleteTransfer
3544 &DeleteTransfer($itemnumber);
3548 sub DeleteTransfer {
3549 my ($itemnumber) = @_;
3550 return unless $itemnumber;
3551 my $dbh = C4::Context->dbh;
3552 my $sth = $dbh->prepare(
3553 "DELETE FROM branchtransfers
3555 AND datearrived IS NULL "
3557 return $sth->execute($itemnumber);
3560 =head2 SendCirculationAlert
3562 Send out a C<check-in> or C<checkout> alert using the messaging system.
3570 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3574 Hashref of information about the item being checked in or out.
3578 Hashref of information about the borrower of the item.
3582 The branchcode from where the checkout or check-in took place.
3588 SendCirculationAlert({
3591 borrower => $borrower,
3597 sub SendCirculationAlert {
3599 my ($type, $item, $borrower, $branch) =
3600 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3601 my %message_name = (
3602 CHECKIN => 'Item_Check_in',
3603 CHECKOUT => 'Item_Checkout',
3604 RENEWAL => 'Item_Checkout',
3606 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3607 borrowernumber => $borrower->{borrowernumber},
3608 message_name => $message_name{$type},
3610 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3612 my $schema = Koha::Database->new->schema;
3613 my @transports = keys %{ $borrower_preferences->{transports} };
3615 # From the MySQL doc:
3616 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3617 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3618 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3619 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3621 for my $mtt (@transports) {
3622 my $letter = C4::Letters::GetPreparedLetter (
3623 module => 'circulation',
3624 letter_code => $type,
3625 branchcode => $branch,
3626 message_transport_type => $mtt,
3627 lang => $borrower->{lang},
3629 $issues_table => $item->{itemnumber},
3630 'items' => $item->{itemnumber},
3631 'biblio' => $item->{biblionumber},
3632 'biblioitems' => $item->{biblionumber},
3633 'borrowers' => $borrower,
3634 'branches' => $branch,
3638 $schema->storage->txn_begin;
3639 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3640 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3641 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3642 unless ( $message ) {
3643 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3644 C4::Message->enqueue($letter, $borrower, $mtt);
3646 $message->append($letter);
3649 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3650 $schema->storage->txn_commit;
3656 =head2 updateWrongTransfer
3658 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3660 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
3664 sub updateWrongTransfer {
3665 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3666 my $dbh = C4::Context->dbh;
3667 # first step validate the actual line of transfert .
3670 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3672 $sth->execute($FromLibrary,$itemNumber);
3674 # second step create a new line of branchtransfer to the right location .
3675 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3677 #third step changing holdingbranch of item
3678 my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3683 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3685 this function calculates the due date given the start date and configured circulation rules,
3686 checking against the holidays calendar as per the daysmode circulation rule.
3687 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3688 C<$itemtype> = itemtype code of item in question
3689 C<$branch> = location whose calendar to use
3690 C<$borrower> = Borrower object
3691 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3696 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3700 # loanlength now a href
3702 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3704 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3710 if (ref $startdate ne 'DateTime' ) {
3711 $datedue = dt_from_string($datedue);
3713 $datedue = $startdate->clone;
3716 $datedue = dt_from_string()->truncate( to => 'minute' );
3720 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3722 categorycode => $borrower->{categorycode},
3723 itemtype => $itemtype,
3724 branchcode => $branch,
3728 # calculate the datedue as normal
3729 if ( $daysmode eq 'Days' )
3730 { # ignoring calendar
3731 if ( $loanlength->{lengthunit} eq 'hours' ) {
3732 $datedue->add( hours => $loanlength->{$length_key} );
3734 $datedue->add( days => $loanlength->{$length_key} );
3735 $datedue->set_hour(23);
3736 $datedue->set_minute(59);
3740 if ($loanlength->{lengthunit} eq 'hours') {
3741 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3744 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3746 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3747 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3748 if ($loanlength->{lengthunit} eq 'days') {
3749 $datedue->set_hour(23);
3750 $datedue->set_minute(59);
3754 # if Hard Due Dates are used, retrieve them and apply as necessary
3755 my ( $hardduedate, $hardduedatecompare ) =
3756 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3757 if ($hardduedate) { # hardduedates are currently dates
3758 $hardduedate->truncate( to => 'minute' );
3759 $hardduedate->set_hour(23);
3760 $hardduedate->set_minute(59);
3761 my $cmp = DateTime->compare( $hardduedate, $datedue );
3763 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3764 # if the calculated date is before the 'after' Hard Due Date (floor), override
3765 # if the hard due date is set to 'exactly', overrride
3766 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3767 $datedue = $hardduedate->clone;
3770 # in all other cases, keep the date due as it is
3774 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3775 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3776 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3777 if( $expiry_dt ) { #skip empty expiry date..
3778 $expiry_dt->set( hour => 23, minute => 59);
3779 my $d1= $datedue->clone->set_time_zone('floating');
3780 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3781 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3784 if ( $daysmode ne 'Days' ) {
3785 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3786 if ( $calendar->is_holiday($datedue) ) {
3787 # Don't return on a closed day
3788 $datedue = $calendar->prev_open_days( $datedue, 1 );
3797 sub CheckValidBarcode{
3799 my $dbh = C4::Context->dbh;
3800 my $query=qq|SELECT count(*)
3804 my $sth = $dbh->prepare($query);
3805 $sth->execute($barcode);
3806 my $exist=$sth->fetchrow ;
3810 =head2 IsBranchTransferAllowed
3812 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3814 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3816 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3817 Koha::Item->can_be_transferred.
3821 sub IsBranchTransferAllowed {
3822 my ( $toBranch, $fromBranch, $code ) = @_;
3824 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3826 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3827 my $dbh = C4::Context->dbh;
3829 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3830 $sth->execute( $toBranch, $fromBranch, $code );
3831 my $limit = $sth->fetchrow_hashref();
3833 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3834 if ( $limit->{'limitId'} ) {
3841 =head2 CreateBranchTransferLimit
3843 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3845 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3847 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3851 sub CreateBranchTransferLimit {
3852 my ( $toBranch, $fromBranch, $code ) = @_;
3853 return unless defined($toBranch) && defined($fromBranch);
3854 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3856 my $dbh = C4::Context->dbh;
3858 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3859 return $sth->execute( $code, $toBranch, $fromBranch );
3862 =head2 DeleteBranchTransferLimits
3864 my $result = DeleteBranchTransferLimits($frombranch);
3866 Deletes all the library transfer limits for one library. Returns the
3867 number of limits deleted, 0e0 if no limits were deleted, or undef if
3868 no arguments are supplied.
3870 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3871 fromBranch => $fromBranch
3876 sub DeleteBranchTransferLimits {
3878 return unless defined $branch;
3879 my $dbh = C4::Context->dbh;
3880 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3881 return $sth->execute($branch);
3885 my ( $borrowernumber, $itemnum ) = @_;
3886 MarkIssueReturned( $borrowernumber, $itemnum );
3891 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3893 unless ( $mark_lost_from ) {
3894 # Temporary check to avoid regressions
3895 die q|LostItem called without $mark_lost_from, check the API.|;
3899 if ( $force_mark_returned ) {
3902 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3903 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3906 my $dbh = C4::Context->dbh();
3907 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3909 JOIN items USING (itemnumber)
3910 JOIN biblio USING (biblionumber)
3911 WHERE issues.itemnumber=?");
3912 $sth->execute($itemnumber);
3913 my $issues=$sth->fetchrow_hashref();
3915 # If a borrower lost the item, add a replacement cost to the their record
3916 if ( my $borrowernumber = $issues->{borrowernumber} ){
3917 my $patron = Koha::Patrons->find( $borrowernumber );
3919 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3920 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3922 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3923 C4::Accounts::chargelostitem(
3926 $issues->{'replacementprice'},
3927 sprintf( "%s %s %s",
3928 $issues->{'title'} || q{},
3929 $issues->{'barcode'} || q{},
3930 $issues->{'itemcallnumber'} || q{},
3933 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3934 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3937 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3940 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3941 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3942 Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store;
3944 my $transferdeleted = DeleteTransfer($itemnumber);
3947 sub GetOfflineOperations {
3948 my $dbh = C4::Context->dbh;
3949 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3950 $sth->execute(C4::Context->userenv->{'branch'});
3951 my $results = $sth->fetchall_arrayref({});
3955 sub GetOfflineOperation {
3956 my $operationid = shift;
3957 return unless $operationid;
3958 my $dbh = C4::Context->dbh;
3959 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3960 $sth->execute( $operationid );
3961 return $sth->fetchrow_hashref;
3964 sub AddOfflineOperation {
3965 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3966 my $dbh = C4::Context->dbh;
3967 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3968 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3972 sub DeleteOfflineOperation {
3973 my $dbh = C4::Context->dbh;
3974 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3975 $sth->execute( shift );
3979 sub ProcessOfflineOperation {
3980 my $operation = shift;
3983 if ( $operation->{action} eq 'return' ) {
3984 $report = ProcessOfflineReturn( $operation );
3985 } elsif ( $operation->{action} eq 'issue' ) {
3986 $report = ProcessOfflineIssue( $operation );
3987 } elsif ( $operation->{action} eq 'payment' ) {
3988 $report = ProcessOfflinePayment( $operation );
3991 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3996 sub ProcessOfflineReturn {
3997 my $operation = shift;
3999 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4002 my $itemnumber = $item->itemnumber;
4003 my $issue = GetOpenIssue( $itemnumber );
4005 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4006 ModDateLastSeen( $itemnumber, $leave_item_lost );
4008 $issue->{borrowernumber},
4010 $operation->{timestamp},
4013 $item->onloan(undef);
4014 $item->store({ log_action => 0 });
4017 return "Item not issued.";
4020 return "Item not found.";
4024 sub ProcessOfflineIssue {
4025 my $operation = shift;
4027 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4030 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4032 return "Barcode not found.";
4034 my $itemnumber = $item->itemnumber;
4035 my $issue = GetOpenIssue( $itemnumber );
4037 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4039 $issue->{borrowernumber},
4041 $operation->{timestamp},
4046 $operation->{'barcode'},
4049 $operation->{timestamp},
4054 return "Borrower not found.";
4058 sub ProcessOfflinePayment {
4059 my $operation = shift;
4061 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4063 $patron->account->pay(
4065 amount => $operation->{amount},
4066 library_id => $operation->{branchcode},
4076 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4078 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4083 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4087 ? Koha::Items->find($itemnumber)
4088 : Koha::Items->find( { barcode => $barcode } );
4092 return C4::Letters::GetPreparedLetter (
4093 module => 'circulation',
4094 letter_code => 'TRANSFERSLIP',
4095 branchcode => $branch,
4097 'branches' => $to_branch,
4098 'biblio' => $item->biblionumber,
4099 'items' => $item->unblessed,
4104 =head2 CheckIfIssuedToPatron
4106 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4108 Return 1 if any record item is issued to patron, otherwise return 0
4112 sub CheckIfIssuedToPatron {
4113 my ($borrowernumber, $biblionumber) = @_;
4115 my $dbh = C4::Context->dbh;
4117 SELECT COUNT(*) FROM issues
4118 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4119 WHERE items.biblionumber = ?
4120 AND issues.borrowernumber = ?
4122 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4123 return 1 if $is_issued;
4129 IsItemIssued( $itemnumber )
4131 Return 1 if the item is on loan, otherwise return 0
4136 my $itemnumber = shift;
4137 my $dbh = C4::Context->dbh;
4138 my $sth = $dbh->prepare(q{
4141 WHERE itemnumber = ?
4143 $sth->execute($itemnumber);
4144 return $sth->fetchrow;
4147 =head2 GetAgeRestriction
4149 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4150 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4152 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4153 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4155 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4156 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4157 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4158 Negative days mean the borrower has gone past the age restriction age.
4162 sub GetAgeRestriction {
4163 my ($record_restrictions, $borrower) = @_;
4164 my $markers = C4::Context->preference('AgeRestrictionMarker');
4166 return unless $record_restrictions;
4167 # Split $record_restrictions to something like FSK 16 or PEGI 6
4168 my @values = split ' ', uc($record_restrictions);
4169 return unless @values;
4171 # Search first occurrence of one of the markers
4172 my @markers = split /\|/, uc($markers);
4173 return unless @markers;
4176 my $restriction_year = 0;
4177 for my $value (@values) {
4179 for my $marker (@markers) {
4180 $marker =~ s/^\s+//; #remove leading spaces
4181 $marker =~ s/\s+$//; #remove trailing spaces
4182 if ( $marker eq $value ) {
4183 if ( $index <= $#values ) {
4184 $restriction_year += $values[$index];
4188 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4190 # Perhaps it is something like "K16" (as in Finland)
4191 $restriction_year += $1;
4195 last if ( $restriction_year > 0 );
4198 #Check if the borrower is age restricted for this material and for how long.
4199 if ($restriction_year && $borrower) {
4200 if ( $borrower->{'dateofbirth'} ) {
4201 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4202 $alloweddate[0] += $restriction_year;
4204 #Prevent runime eror on leap year (invalid date)
4205 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4206 $alloweddate[2] = 28;
4209 #Get how many days the borrower has to reach the age restriction
4210 my @Today = split /-/, dt_from_string()->ymd();
4211 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4212 #Negative days means the borrower went past the age restriction age
4213 return ($restriction_year, $daysToAgeRestriction);
4217 return ($restriction_year);
4221 =head2 GetPendingOnSiteCheckouts
4225 sub GetPendingOnSiteCheckouts {
4226 my $dbh = C4::Context->dbh;
4227 return $dbh->selectall_arrayref(q|
4233 items.itemcallnumber,
4237 issues.date_due < NOW() AS is_overdue,
4240 borrowers.firstname,
4242 borrowers.cardnumber,
4243 borrowers.borrowernumber
4245 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4246 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4247 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4248 WHERE issues.onsite_checkout = 1
4249 |, { Slice => {} } );
4255 my ($count, $branch, $itemtype, $ccode, $newness)
4256 = @$params{qw(count branch itemtype ccode newness)};
4258 my $dbh = C4::Context->dbh;
4261 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4262 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4263 i.ccode, SUM(i.issues) AS count
4265 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4266 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4269 my (@where_strs, @where_args);
4272 push @where_strs, 'i.homebranch = ?';
4273 push @where_args, $branch;
4276 if (C4::Context->preference('item-level_itypes')){
4277 push @where_strs, 'i.itype = ?';
4278 push @where_args, $itemtype;
4280 push @where_strs, 'bi.itemtype = ?';
4281 push @where_args, $itemtype;
4285 push @where_strs, 'i.ccode = ?';
4286 push @where_args, $ccode;
4289 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4290 push @where_args, $newness;
4294 $query .= 'WHERE ' . join(' AND ', @where_strs);
4298 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4299 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4304 $query .= q{ ) xxx WHERE count > 0 };
4305 $count = int($count);
4307 $query .= "LIMIT $count";
4310 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4315 =head2 Internal methods
4319 sub _CalculateAndUpdateFine {
4322 my $borrower = $params->{borrower};
4323 my $item = $params->{item};
4324 my $issue = $params->{issue};
4325 my $return_date = $params->{return_date};
4327 unless ($borrower) { carp "No borrower passed in!" && return; }
4328 unless ($item) { carp "No item passed in!" && return; }
4329 unless ($issue) { carp "No issue passed in!" && return; }
4331 my $datedue = dt_from_string( $issue->date_due );
4333 # we only need to calculate and change the fines if we want to do that on return
4334 # Should be on for hourly loans
4335 my $control = C4::Context->preference('CircControl');
4336 my $control_branchcode =
4337 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4338 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4339 : $issue->branchcode;
4341 my $date_returned = $return_date ? $return_date : dt_from_string();
4343 my ( $amount, $unitcounttotal, $unitcount ) =
4344 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4346 if ( C4::Context->preference('finesMode') eq 'production' ) {
4347 if ( $amount > 0 ) {
4348 C4::Overdues::UpdateFine({
4349 issue_id => $issue->issue_id,
4350 itemnumber => $issue->itemnumber,
4351 borrowernumber => $issue->borrowernumber,
4353 due => output_pref($datedue),
4356 elsif ($return_date) {
4358 # Backdated returns may have fines that shouldn't exist,
4359 # so in this case, we need to drop those fines to 0
4361 C4::Overdues::UpdateFine({
4362 issue_id => $issue->issue_id,
4363 itemnumber => $issue->itemnumber,
4364 borrowernumber => $issue->borrowernumber,
4366 due => output_pref($datedue),
4372 sub _item_denied_renewal {
4375 my $item = $params->{item};
4376 return unless $item;
4378 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4379 return unless $denyingrules;
4380 foreach my $field (keys %$denyingrules) {
4381 my $val = $item->$field;
4382 if( !defined $val) {
4383 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4386 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4387 # If the results matches the values in the syspref
4388 # We return true if match found
4401 Koha Development Team <http://koha-community.org/>