1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX qw( floor );
35 use C4::ItemCirculationAlertPreference;
37 use C4::Log; # logaction
38 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
39 use C4::RotatingCollections qw(GetCollectionItemBranches);
40 use Algorithm::CheckDigits;
44 use Koha::AuthorisedValues;
45 use Koha::Biblioitems;
49 use Koha::Illrequests;
52 use Koha::Patron::Debarments;
55 use Koha::Account::Lines;
57 use Koha::Account::Lines;
58 use Koha::Account::Offsets;
59 use Koha::Config::SysPrefs;
60 use Koha::Charges::Fees;
61 use Koha::Config::SysPref;
62 use Koha::Checkouts::ReturnClaims;
63 use Koha::SearchEngine::Indexer;
64 use Koha::Exceptions::Checkout;
66 use List::MoreUtils qw( uniq any );
67 use Scalar::Util qw( looks_like_number );
78 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
84 # FIXME subs that should probably be elsewhere
89 &GetPendingOnSiteCheckouts
92 # subs to deal with issuing a book
100 &GetLatestAutoRenewDate
102 &GetBranchBorrowerCircRule
105 &CheckIfIssuedToPatron
110 # subs to deal with returns
116 # subs to deal with transfers
122 &IsBranchTransferAllowed
123 &CreateBranchTransferLimit
124 &DeleteBranchTransferLimits
128 # subs to deal with offline circulation
130 &GetOfflineOperations
133 &DeleteOfflineOperation
134 &ProcessOfflineOperation
140 C4::Circulation - Koha circulation module
148 The functions in this module deal with circulation, issues, and
149 returns, as well as general information about the library.
150 Also deals with inventory.
156 $str = &barcodedecode($barcode, [$filter]);
158 Generic filter function for barcode string.
159 Called on every circ if the System Pref itemBarcodeInputFilter is set.
160 Will do some manipulation of the barcode for systems that deliver a barcode
161 to circulation.pl that differs from the barcode stored for the item.
162 For proper functioning of this filter, calling the function on the
163 correct barcode string (items.barcode) should return an unaltered barcode.
165 The optional $filter argument is to allow for testing or explicit
166 behavior that ignores the System Pref. Valid values are the same as the
171 # FIXME -- the &decode fcn below should be wrapped into this one.
172 # FIXME -- these plugins should be moved out of Circulation.pm
175 my ($barcode, $filter) = @_;
176 my $branch = C4::Context::mybranch();
177 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
178 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
179 if ($filter eq 'whitespace') {
181 } elsif ($filter eq 'cuecat') {
183 my @fields = split( /\./, $barcode );
184 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
185 ($#results == 2) and return $results[2];
186 } elsif ($filter eq 'T-prefix') {
187 if ($barcode =~ /^[Tt](\d)/) {
188 (defined($1) and $1 eq '0') and return $barcode;
189 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
191 return sprintf("T%07d", $barcode);
192 # FIXME: $barcode could be "T1", causing warning: substr outside of string
193 # Why drop the nonzero digit after the T?
194 # Why pass non-digits (or empty string) to "T%07d"?
195 } elsif ($filter eq 'libsuite8') {
196 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
197 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
198 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
200 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
203 } elsif ($filter eq 'EAN13') {
204 my $ean = CheckDigits('ean');
205 if ( $ean->is_valid($barcode) ) {
206 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
207 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
209 warn "# [$barcode] not valid EAN-13/UPC-A\n";
212 return $barcode; # return barcode, modified or not
217 $str = &_decode($chunk);
219 Decodes a segment of a string emitted by a CueCat barcode scanner and
222 FIXME: Should be replaced with Barcode::Cuecat from CPAN
223 or Javascript based decoding on the client side.
230 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
231 my @s = map { index( $seq, $_ ); } split( //, $encoded );
232 my $l = ( $#s + 1 ) % 4;
235 # warn "Error: Cuecat decode parsing failed!";
243 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
245 chr( ( $n >> 16 ) ^ 67 )
246 .chr( ( $n >> 8 & 255 ) ^ 67 )
247 .chr( ( $n & 255 ) ^ 67 );
250 $r = substr( $r, 0, length($r) - $l );
256 ($dotransfer, $messages, $iteminformation) = &transferbook({
257 from_branch => $frombranch
258 to_branch => $tobranch,
260 ignore_reserves => $ignore_reserves,
264 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
266 C<$fbr> is the code for the branch initiating the transfer.
267 C<$tbr> is the code for the branch to which the item should be transferred.
269 C<$barcode> is the barcode of the item to be transferred.
271 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
272 Otherwise, if an item is reserved, the transfer fails.
274 C<$trigger> is the enum value for what triggered the transfer.
276 Returns three values:
282 is true if the transfer was successful.
286 is a reference-to-hash which may have any of the following keys:
292 There is no item in the catalog with the given barcode. The value is C<$barcode>.
294 =item C<DestinationEqualsHolding>
296 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
300 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
304 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
306 =item C<WasTransferred>
308 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
318 my $tbr = $params->{to_branch};
319 my $fbr = $params->{from_branch};
320 my $ignoreRs = $params->{ignore_reserves};
321 my $barcode = $params->{barcode};
322 my $trigger = $params->{trigger};
325 my $item = Koha::Items->find( { barcode => $barcode } );
327 Koha::Exceptions::MissingParameter->throw(
328 "Missing mandatory parameter: from_branch")
331 Koha::Exceptions::MissingParameter->throw(
332 "Missing mandatory parameter: to_branch")
337 $messages->{'BadBarcode'} = $barcode;
339 return ( $dotransfer, $messages );
342 my $itemnumber = $item->itemnumber;
343 # get branches of book...
344 my $hbr = $item->homebranch;
346 # if using Branch Transfer Limits
347 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
348 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
349 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
350 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
351 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
354 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
355 $messages->{'NotAllowed'} = $tbr . "::" . $code;
360 # can't transfer book if is already there....
361 if ( $fbr eq $tbr ) {
362 $messages->{'DestinationEqualsHolding'} = 1;
366 # check if it is still issued to someone, return it...
367 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
369 AddReturn( $barcode, $fbr );
370 $messages->{'WasReturned'} = $issue->borrowernumber;
374 # That'll save a database query.
375 my ( $resfound, $resrec, undef ) =
376 CheckReserves( $itemnumber );
378 $resrec->{'ResFound'} = $resfound;
379 $messages->{'ResFound'} = $resrec;
380 $dotransfer = 0 unless $ignoreRs;
383 #actually do the transfer....
385 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
387 # don't need to update MARC anymore, we do it in batch now
388 $messages->{'WasTransfered'} = $tbr;
391 ModDateLastSeen( $itemnumber );
392 return ( $dotransfer, $messages );
397 my $borrower = shift;
398 my $item_object = shift;
400 my $onsite_checkout = $params->{onsite_checkout} || 0;
401 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
402 my $cat_borrower = $borrower->{'categorycode'};
403 my $dbh = C4::Context->dbh;
404 # Get which branchcode we need
405 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
406 my $type = $item_object->effective_itemtype;
408 my ($type_object, $parent_type, $parent_maxissueqty_rule);
409 $type_object = Koha::ItemTypes->find( $type );
410 $parent_type = $type_object->parent_type if $type_object;
411 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
412 # Find any children if we are a parent_type;
414 # given branch, patron category, and item type, determine
415 # applicable issuing rule
417 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
419 categorycode => $cat_borrower,
420 itemtype => $parent_type,
421 branchcode => $branch,
422 rule_name => 'maxissueqty',
425 # If the parent rule is for default type we discount it
426 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
428 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
430 categorycode => $cat_borrower,
432 branchcode => $branch,
433 rule_name => 'maxissueqty',
437 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
439 categorycode => $cat_borrower,
441 branchcode => $branch,
442 rule_name => 'maxonsiteissueqty',
447 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
448 # if a rule is found and has a loan limit set, count
449 # how many loans the patron already has that meet that
451 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
454 if ( $maxissueqty_rule->branchcode ) {
455 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
456 $checkouts = $patron->checkouts->search(
457 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
458 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
459 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
461 $checkouts = $patron->checkouts->search(
462 { 'item.homebranch' => $maxissueqty_rule->branchcode },
463 { prefetch => 'item' } );
466 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
469 my $rule_itemtype = $maxissueqty_rule->itemtype;
470 while ( my $c = $checkouts->next ) {
471 my $itemtype = $c->item->effective_itemtype;
473 unless ( $rule_itemtype ) {
474 # matching rule has the default item type, so count only
475 # those existing loans that don't fall under a more
477 @types = Koha::CirculationRules->search(
479 branchcode => $maxissueqty_rule->branchcode,
480 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
481 itemtype => { '!=' => undef },
482 rule_name => 'maxissueqty'
484 )->get_column('itemtype');
486 next if grep {$_ eq $itemtype} @types;
489 if ( $parent_maxissueqty_rule ) {
490 # if we have a parent item type then we count loans of the
491 # specific item type or its siblings or parent
492 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
493 @types = $children->get_column('itemtype');
494 push @types, $parent_type;
495 } elsif ( $child_types ) {
496 # If we are a parent type, we need to count all child types and our own type
497 @types = $child_types->get_column('itemtype');
498 push @types, $type; # And don't forget to count our own types
499 } else { push @types, $type; } # Otherwise only count the specific itemtype
501 next unless grep {$_ eq $itemtype} @types;
503 $sum_checkouts->{total}++;
504 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
505 $sum_checkouts->{itemtype}->{$itemtype}++;
508 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
509 my $checkout_count = $sum_checkouts->{total} || 0;
510 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
512 my $checkout_rules = {
513 checkout_count => $checkout_count,
514 onsite_checkout_count => $onsite_checkout_count,
515 onsite_checkout => $onsite_checkout,
516 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
517 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
518 switch_onsite_checkout => $switch_onsite_checkout,
520 # If parent rules exists
521 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
522 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
523 my $qty_over = _check_max_qty($checkout_rules);
524 return $qty_over if defined $qty_over;
526 # If the parent rule is less than or equal to the child, we only need check the parent
527 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
528 $checkout_rules->{checkout_count} = $checkout_count_type;
529 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
530 my $qty_over = _check_max_qty($checkout_rules);
531 return $qty_over if defined $qty_over;
534 my $qty_over = _check_max_qty($checkout_rules);
535 return $qty_over if defined $qty_over;
539 # Now count total loans against the limit for the branch
540 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
541 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
543 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
544 $checkouts = $patron->checkouts->search(
545 { 'me.branchcode' => $branch} );
546 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
547 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
549 $checkouts = $patron->checkouts->search(
550 { 'item.homebranch' => $branch},
551 { prefetch => 'item' } );
554 my $checkout_count = $checkouts->count;
555 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
556 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
557 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
559 my $qty_over = _check_max_qty(
561 checkout_count => $checkout_count,
562 onsite_checkout_count => $onsite_checkout_count,
563 onsite_checkout => $onsite_checkout,
564 max_checkouts_allowed => $max_checkouts_allowed,
565 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
566 switch_onsite_checkout => $switch_onsite_checkout
569 return $qty_over if defined $qty_over;
572 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
573 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
576 # OK, the patron can issue !!!
582 my $checkout_count = $params->{checkout_count};
583 my $onsite_checkout_count = $params->{onsite_checkout_count};
584 my $onsite_checkout = $params->{onsite_checkout};
585 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
586 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
587 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
589 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
590 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
591 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
593 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
594 count => $onsite_checkout_count,
595 max_allowed => $max_onsite_checkouts_allowed,
599 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
600 if ( $max_checkouts_allowed eq '' ) { return; }
601 my $delta = $switch_onsite_checkout ? 1 : 0;
602 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
604 reason => 'TOO_MANY_CHECKOUTS',
605 count => $checkout_count,
606 max_allowed => $max_checkouts_allowed,
610 elsif ( not $onsite_checkout ) {
611 if ( $max_checkouts_allowed eq '' ) { return; }
613 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
616 reason => 'TOO_MANY_CHECKOUTS',
617 count => $checkout_count - $onsite_checkout_count,
618 max_allowed => $max_checkouts_allowed,
626 =head2 CanBookBeIssued
628 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
629 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
631 Check if a book can be issued.
633 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
635 IMPORTANT: The assumption by users of this routine is that causes blocking
636 the issue are keyed by uppercase labels and other returned
637 data is keyed in lower case!
641 =item C<$patron> is a Koha::Patron
643 =item C<$barcode> is the bar code of the book being issued.
645 =item C<$duedates> is a DateTime object.
647 =item C<$inprocess> boolean switch
649 =item C<$ignore_reserves> boolean switch
651 =item C<$params> Hashref of additional parameters
654 override_high_holds - Ignore high holds
655 onsite_checkout - Checkout is an onsite checkout that will not leave the library
663 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
664 Possible values are :
670 sticky due date is invalid
674 borrower gone with no address
678 borrower declared it's card lost
684 =head3 UNKNOWN_BARCODE
698 item is restricted (set by ??)
700 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
701 could be prevented, but ones that can be overriden by the operator.
703 Possible values are :
711 renewing, not issuing
713 =head3 ISSUED_TO_ANOTHER
715 issued to someone else.
719 reserved for someone else.
723 reserved and being transferred for someone else.
727 sticky due date is invalid or due date in the past
731 if the borrower borrows to much things
735 sub CanBookBeIssued {
736 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
737 my %needsconfirmation; # filled with problems that needs confirmations
738 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
739 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
740 my %messages; # filled with information messages that should be displayed.
742 my $onsite_checkout = $params->{onsite_checkout} || 0;
743 my $override_high_holds = $params->{override_high_holds} || 0;
745 my $item_object = Koha::Items->find({barcode => $barcode });
747 # MANDATORY CHECKS - unless item exists, nothing else matters
748 unless ( $item_object ) {
749 $issuingimpossible{UNKNOWN_BARCODE} = 1;
751 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
753 my $item_unblessed = $item_object->unblessed; # Transition...
754 my $issue = $item_object->checkout;
755 my $biblio = $item_object->biblio;
757 my $biblioitem = $biblio->biblioitem;
758 my $effective_itemtype = $item_object->effective_itemtype;
759 my $dbh = C4::Context->dbh;
760 my $patron_unblessed = $patron->unblessed;
762 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
764 # DUE DATE is OK ? -- should already have checked.
766 if ($duedate && ref $duedate ne 'DateTime') {
767 $duedate = dt_from_string($duedate);
769 my $now = dt_from_string();
770 unless ( $duedate ) {
771 my $issuedate = $now->clone();
773 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
775 # Offline circ calls AddIssue directly, doesn't run through here
776 # So issuingimpossible should be ok.
779 my $fees = Koha::Charges::Fees->new(
782 library => $circ_library,
783 item => $item_object,
789 my $today = $now->clone();
790 $today->truncate( to => 'minute');
791 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
792 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
795 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
801 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
802 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
804 branch => C4::Context->userenv->{'branch'},
806 itemnumber => $item_object->itemnumber,
807 itemtype => $effective_itemtype,
808 borrowernumber => $patron->borrowernumber,
809 ccode => $item_object->ccode}
811 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
812 return( { STATS => 1 }, {});
815 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
816 $issuingimpossible{GNA} = 1;
819 if ( $patron->lost && $patron->lost == 1 ) {
820 $issuingimpossible{CARD_LOST} = 1;
822 if ( $patron->is_debarred ) {
823 $issuingimpossible{DEBARRED} = 1;
826 if ( $patron->is_expired ) {
827 $issuingimpossible{EXPIRED} = 1;
835 my $account = $patron->account;
836 my $balance = $account->balance;
837 my $non_issues_charges = $account->non_issues_charges;
838 my $other_charges = $balance - $non_issues_charges;
840 my $amountlimit = C4::Context->preference("noissuescharge");
841 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
842 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
844 # Check the debt of this patrons guarantees
845 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
846 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
847 if ( defined $no_issues_charge_guarantees ) {
848 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
849 my $guarantees_non_issues_charges = 0;
850 foreach my $g ( @guarantees ) {
851 $guarantees_non_issues_charges += $g->account->non_issues_charges;
854 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
855 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
856 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
857 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
858 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
859 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
863 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
864 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
865 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
866 if ( defined $no_issues_charge_guarantors ) {
867 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
869 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
870 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
871 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
872 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
873 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
874 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
878 if ( C4::Context->preference("IssuingInProcess") ) {
879 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
880 $issuingimpossible{DEBT} = $non_issues_charges;
881 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
882 $needsconfirmation{DEBT} = $non_issues_charges;
883 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
884 $needsconfirmation{DEBT} = $non_issues_charges;
888 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
889 $needsconfirmation{DEBT} = $non_issues_charges;
890 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
891 $issuingimpossible{DEBT} = $non_issues_charges;
892 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
893 $needsconfirmation{DEBT} = $non_issues_charges;
897 if ($balance > 0 && $other_charges > 0) {
898 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
901 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
902 $patron_unblessed = $patron->unblessed;
904 if ( my $debarred_date = $patron->is_debarred ) {
905 # patron has accrued fine days or has a restriction. $count is a date
906 if ($debarred_date eq '9999-12-31') {
907 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
910 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
912 } elsif ( my $num_overdues = $patron->has_overdues ) {
913 ## patron has outstanding overdue loans
914 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
915 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
917 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
918 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
922 # Additional Materials Check
923 if ( C4::Context->preference("CircConfirmItemParts")
924 && $item_object->materials )
926 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
930 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
932 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
934 # Already issued to current borrower.
935 # If it is an on-site checkout if it can be switched to a normal checkout
936 # or ask whether the loan should be renewed
938 if ( $issue->onsite_checkout
939 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
940 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
942 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
943 $patron->borrowernumber,
944 $item_object->itemnumber,
946 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
947 if ( $renewerror eq 'onsite_checkout' ) {
948 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
951 $issuingimpossible{NO_MORE_RENEWALS} = 1;
955 $needsconfirmation{RENEW_ISSUE} = 1;
961 # issued to someone else
963 my $patron = Koha::Patrons->find( $issue->borrowernumber );
965 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
967 unless ( $can_be_returned ) {
968 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
969 $issuingimpossible{branch_to_return} = $message;
971 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
972 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
974 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
975 $needsconfirmation{issued_firstname} = $patron->firstname;
976 $needsconfirmation{issued_surname} = $patron->surname;
977 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
978 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
983 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
985 my $switch_onsite_checkout = (
986 C4::Context->preference('SwitchOnSiteCheckouts')
988 and $issue->onsite_checkout
989 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
990 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
991 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
992 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
993 if ( $toomany->{max_allowed} == 0 ) {
994 $needsconfirmation{PATRON_CANT} = 1;
996 if ( C4::Context->preference("AllowTooManyOverride") ) {
997 $needsconfirmation{TOO_MANY} = $toomany->{reason};
998 $needsconfirmation{current_loan_count} = $toomany->{count};
999 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1001 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1002 $issuingimpossible{current_loan_count} = $toomany->{count};
1003 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1008 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1010 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1011 my $wants_check = $patron->wants_check_for_previous_checkout;
1012 $needsconfirmation{PREVISSUE} = 1
1013 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1018 if ( $item_object->notforloan )
1020 if(!C4::Context->preference("AllowNotForLoanOverride")){
1021 $issuingimpossible{NOT_FOR_LOAN} = 1;
1022 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1024 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1025 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1029 # we have to check itemtypes.notforloan also
1030 if (C4::Context->preference('item-level_itypes')){
1031 # this should probably be a subroutine
1032 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1033 $sth->execute($effective_itemtype);
1034 my $notforloan=$sth->fetchrow_hashref();
1035 if ($notforloan->{'notforloan'}) {
1036 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1037 $issuingimpossible{NOT_FOR_LOAN} = 1;
1038 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1040 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1041 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1046 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1047 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1048 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1049 $issuingimpossible{NOT_FOR_LOAN} = 1;
1050 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1052 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1053 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1058 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1060 $issuingimpossible{WTHDRAWN} = 1;
1062 if ( $item_object->restricted
1063 && $item_object->restricted == 1 )
1065 $issuingimpossible{RESTRICTED} = 1;
1067 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1068 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1069 my $code = $av->count ? $av->next->lib : '';
1070 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1071 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1073 if ( C4::Context->preference("IndependentBranches") ) {
1074 my $userenv = C4::Context->userenv;
1075 unless ( C4::Context->IsSuperLibrarian() ) {
1076 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1077 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1078 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1079 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1081 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1082 if ( $patron->branchcode ne $userenv->{branch} );
1087 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1089 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1090 if ($rentalConfirmation) {
1091 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1093 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1094 if ($itemtype_object) {
1095 my $accumulate_charge = $fees->accumulate_rentalcharge();
1096 if ( $accumulate_charge > 0 ) {
1097 $rentalCharge += $accumulate_charge;
1101 if ( $rentalCharge > 0 ) {
1102 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1106 unless ( $ignore_reserves ) {
1107 # See if the item is on reserve.
1108 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1110 my $resbor = $res->{'borrowernumber'};
1111 if ( $resbor ne $patron->borrowernumber ) {
1112 my $patron = Koha::Patrons->find( $resbor );
1113 if ( $restype eq "Waiting" )
1115 # The item is on reserve and waiting, but has been
1116 # reserved by some other patron.
1117 $needsconfirmation{RESERVE_WAITING} = 1;
1118 $needsconfirmation{'resfirstname'} = $patron->firstname;
1119 $needsconfirmation{'ressurname'} = $patron->surname;
1120 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1121 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1122 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1123 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1124 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1126 elsif ( $restype eq "Reserved" ) {
1127 # The item is on reserve for someone else.
1128 $needsconfirmation{RESERVED} = 1;
1129 $needsconfirmation{'resfirstname'} = $patron->firstname;
1130 $needsconfirmation{'ressurname'} = $patron->surname;
1131 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1132 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1133 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1134 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1135 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1137 elsif ( $restype eq "Transferred" ) {
1138 # The item is determined hold being transferred for someone else.
1139 $needsconfirmation{TRANSFERRED} = 1;
1140 $needsconfirmation{'resfirstname'} = $patron->firstname;
1141 $needsconfirmation{'ressurname'} = $patron->surname;
1142 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1143 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1144 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1145 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1146 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1148 elsif ( $restype eq "Processing" ) {
1149 # The item is determined hold being processed for someone else.
1150 $needsconfirmation{PROCESSING} = 1;
1151 $needsconfirmation{'resfirstname'} = $patron->firstname;
1152 $needsconfirmation{'ressurname'} = $patron->surname;
1153 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1154 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1155 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1156 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1157 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1163 ## CHECK AGE RESTRICTION
1164 my $agerestriction = $biblioitem->agerestriction;
1165 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1166 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1167 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1168 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1171 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1175 ## check for high holds decreasing loan period
1176 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1177 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1179 if ( $check->{exceeded} ) {
1180 if ($override_high_holds) {
1181 $alerts{HIGHHOLDS} = {
1182 num_holds => $check->{outstanding},
1183 duration => $check->{duration},
1184 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1188 $needsconfirmation{HIGHHOLDS} = {
1189 num_holds => $check->{outstanding},
1190 duration => $check->{duration},
1191 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1198 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1199 # don't do the multiple loans per bib check if we've
1200 # already determined that we've got a loan on the same item
1201 !$issuingimpossible{NO_MORE_RENEWALS} &&
1202 !$needsconfirmation{RENEW_ISSUE}
1204 # Check if borrower has already issued an item from the same biblio
1205 # Only if it's not a subscription
1206 my $biblionumber = $item_object->biblionumber;
1207 require C4::Serials;
1208 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1209 unless ($is_a_subscription) {
1210 # FIXME Should be $patron->checkouts($args);
1211 my $checkouts = Koha::Checkouts->search(
1213 borrowernumber => $patron->borrowernumber,
1214 biblionumber => $biblionumber,
1220 # if we get here, we don't already have a loan on this item,
1221 # so if there are any loans on this bib, ask for confirmation
1222 if ( $checkouts->count ) {
1223 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1228 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1231 =head2 CanBookBeReturned
1233 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1235 Check whether the item can be returned to the provided branch
1239 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1241 =item C<$branch> is the branchcode where the return is taking place
1249 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1251 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1257 sub CanBookBeReturned {
1258 my ($item, $branch) = @_;
1259 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1261 # assume return is allowed to start
1265 # identify all cases where return is forbidden
1266 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1268 $message = $item->{'homebranch'};
1269 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1271 $message = $item->{'holdingbranch'};
1272 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1274 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1277 return ($allowed, $message);
1280 =head2 CheckHighHolds
1282 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1283 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1284 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1288 sub checkHighHolds {
1289 my ( $item, $borrower ) = @_;
1290 my $branchcode = _GetCircControlBranch( $item, $borrower );
1291 my $item_object = Koha::Items->find( $item->{itemnumber} );
1300 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1302 if ( $holds->count() ) {
1303 $return_data->{outstanding} = $holds->count();
1305 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1306 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1307 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1309 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1311 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1313 # static means just more than a given number of holds on the record
1315 # If the number of holds is less than the threshold, we can stop here
1316 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1317 return $return_data;
1320 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1322 # dynamic means X more than the number of holdable items on the record
1324 # let's get the items
1325 my @items = $holds->next()->biblio()->items()->as_list;
1327 # Remove any items with status defined to be ignored even if the would not make item unholdable
1328 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1329 @items = grep { !$_->$status } @items;
1332 # Remove any items that are not holdable for this patron
1333 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1335 my $items_count = scalar @items;
1337 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1339 # If the number of holds is less than the count of items we have
1340 # plus the number of holds allowed above that count, we can stop here
1341 if ( $holds->count() <= $threshold ) {
1342 return $return_data;
1346 my $issuedate = dt_from_string();
1348 my $itype = $item_object->effective_itemtype;
1349 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1351 categorycode => $borrower->{categorycode},
1353 branchcode => $branchcode,
1356 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1358 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1360 my $rule = Koha::CirculationRules->get_effective_rule(
1362 categorycode => $borrower->{categorycode},
1363 itemtype => $item_object->effective_itemtype,
1364 branchcode => $branchcode,
1365 rule_name => 'decreaseloanholds',
1370 if ( defined($rule) && $rule->rule_value ne '' ){
1371 # overrides decreaseLoanHighHoldsDuration syspref
1372 $duration = $rule->rule_value;
1374 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1376 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1377 $reduced_datedue->set_hour($orig_due->hour);
1378 $reduced_datedue->set_minute($orig_due->minute);
1379 $reduced_datedue->truncate( to => 'minute' );
1381 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1382 $return_data->{exceeded} = 1;
1383 $return_data->{duration} = $duration;
1384 $return_data->{due_date} = $reduced_datedue;
1388 return $return_data;
1393 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1395 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1399 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1401 =item C<$barcode> is the barcode of the item being issued.
1403 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1404 Calculated if empty.
1406 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1408 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1409 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1411 AddIssue does the following things :
1413 - step 01: check that there is a borrowernumber & a barcode provided
1414 - check for RENEWAL (book issued & being issued to the same patron)
1415 - renewal YES = Calculate Charge & renew
1417 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1419 - fill reserve if reserve to this patron
1420 - cancel reserve or not, otherwise
1421 * TRANSFERT PENDING ?
1422 - complete the transfert
1430 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1432 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1433 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1434 my $auto_renew = $params && $params->{auto_renew};
1435 my $dbh = C4::Context->dbh;
1436 my $barcodecheck = CheckValidBarcode($barcode);
1440 if ( $datedue && ref $datedue ne 'DateTime' ) {
1441 $datedue = dt_from_string($datedue);
1444 # $issuedate defaults to today.
1445 if ( !defined $issuedate ) {
1446 $issuedate = dt_from_string();
1449 if ( ref $issuedate ne 'DateTime' ) {
1450 $issuedate = dt_from_string($issuedate);
1455 # Stop here if the patron or barcode doesn't exist
1456 if ( $borrower && $barcode && $barcodecheck ) {
1457 # find which item we issue
1458 my $item_object = Koha::Items->find({ barcode => $barcode })
1459 or return; # if we don't get an Item, abort.
1460 my $item_unblessed = $item_object->unblessed;
1462 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1464 # get actual issuing if there is one
1465 my $actualissue = $item_object->checkout;
1467 # check if we just renew the issue.
1468 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1469 and not $switch_onsite_checkout ) {
1470 $datedue = AddRenewal(
1471 $borrower->{'borrowernumber'},
1472 $item_object->itemnumber,
1475 $issuedate, # here interpreted as the renewal date
1480 my $itype = $item_object->effective_itemtype;
1481 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1484 $datedue->truncate( to => 'minute' );
1486 my $patron = Koha::Patrons->find( $borrower );
1487 my $library = Koha::Libraries->find( $branchcode );
1488 my $fees = Koha::Charges::Fees->new(
1491 library => $library,
1492 item => $item_object,
1493 to_date => $datedue,
1497 # it's NOT a renewal
1498 if ( $actualissue and not $switch_onsite_checkout ) {
1499 # This book is currently on loan, but not to the person
1500 # who wants to borrow it now. mark it returned before issuing to the new borrower
1501 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1502 return unless $allowed;
1503 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1504 # AddReturn certainly has side-effects, like onloan => undef
1505 $item_object->discard_changes;
1508 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1510 # Starting process for transfer job (checking transfert and validate it if we have one)
1511 if ( my $transfer = $item_object->get_transfer ) {
1512 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1515 datearrived => dt_from_string,
1516 tobranch => C4::Context->userenv->{branch},
1517 comments => 'Forced branchtransfer'
1520 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1521 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1522 if ( $hold ) { # Is this really needed?
1523 $hold->set( { found => undef } )->store;
1524 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1529 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1530 unless ($auto_renew) {
1531 my $rule = Koha::CirculationRules->get_effective_rule(
1533 categorycode => $borrower->{categorycode},
1534 itemtype => $item_object->effective_itemtype,
1535 branchcode => $branchcode,
1536 rule_name => 'auto_renew'
1540 $auto_renew = $rule->rule_value if $rule;
1543 my $issue_attributes = {
1544 borrowernumber => $borrower->{'borrowernumber'},
1545 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1546 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1547 branchcode => C4::Context->userenv->{'branch'},
1548 onsite_checkout => $onsite_checkout,
1549 auto_renew => $auto_renew ? 1 : 0,
1552 # Get ID of logged in user. if called from a batch job,
1553 # no user session exists and C4::Context->userenv() returns
1554 # the scalar '0'. Only do this if the syspref says so
1555 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1556 my $userenv = C4::Context->userenv();
1557 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1559 $issue_attributes->{issuer_id} = $usernumber;
1563 # In the case that the borrower has an on-site checkout
1564 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1565 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1567 $issue->set($issue_attributes)->store;
1570 $issue = Koha::Checkout->new(
1572 itemnumber => $item_object->itemnumber,
1577 $issue->discard_changes;
1578 C4::Auth::track_login_daily( $borrower->{userid} );
1579 if ( $item_object->location && $item_object->location eq 'CART'
1580 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1581 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1582 CartToShelf( $item_object->itemnumber );
1585 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1586 UpdateTotalIssues( $item_object->biblionumber, 1 );
1589 # Record if item was lost
1590 my $was_lost = $item_object->itemlost;
1592 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1593 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1594 $item_object->itemlost(0);
1595 $item_object->onloan($datedue->ymd());
1596 $item_object->datelastborrowed( dt_from_string()->ymd() );
1597 $item_object->datelastseen( dt_from_string()->ymd() );
1598 $item_object->store({log_action => 0});
1600 # If the item was lost, it has now been found, charge the overdue if necessary
1602 if ( $item_object->{_charge} ) {
1603 $actualissue //= Koha::Old::Checkouts->search(
1604 { itemnumber => $item_unblessed->{itemnumber} },
1606 order_by => { '-desc' => 'returndate' },
1610 unless ( exists( $borrower->{branchcode} ) ) {
1611 my $patron = $actualissue->patron;
1612 $borrower = $patron->unblessed;
1614 _CalculateAndUpdateFine(
1616 issue => $actualissue,
1617 item => $item_unblessed,
1618 borrower => $borrower,
1619 return_date => $issuedate
1622 _FixOverduesOnReturn( $borrower->{borrowernumber},
1623 $item_object->itemnumber, undef, 'RENEWED' );
1627 # If it costs to borrow this book, charge it to the patron's account.
1628 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1629 if ( $charge && $charge > 0 ) {
1630 AddIssuingCharge( $issue, $charge, 'RENT' );
1633 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1634 if ( $itemtype_object ) {
1635 my $accumulate_charge = $fees->accumulate_rentalcharge();
1636 if ( $accumulate_charge > 0 ) {
1637 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1638 $charge += $accumulate_charge;
1639 $item_unblessed->{charge} = $charge;
1643 # Record the fact that this book was issued.
1646 branch => C4::Context->userenv->{'branch'},
1647 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1649 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1650 itemnumber => $item_object->itemnumber,
1651 itemtype => $item_object->effective_itemtype,
1652 location => $item_object->location,
1653 borrowernumber => $borrower->{'borrowernumber'},
1654 ccode => $item_object->ccode,
1658 # Send a checkout slip.
1659 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1661 branchcode => $branchcode,
1662 categorycode => $borrower->{categorycode},
1663 item_type => $item_object->effective_itemtype,
1664 notification => 'CHECKOUT',
1666 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1667 SendCirculationAlert(
1670 item => $item_object->unblessed,
1671 borrower => $borrower,
1672 branch => $branchcode,
1677 "CIRCULATION", "ISSUE",
1678 $borrower->{'borrowernumber'},
1679 $item_object->itemnumber,
1680 ) if C4::Context->preference("IssueLog");
1682 Koha::Plugins->call('after_circ_action', {
1683 action => 'checkout',
1685 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1686 checkout => $issue->get_from_storage
1694 =head2 GetLoanLength
1696 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1698 Get loan length for an itemtype, a borrower type and a branch
1703 my ( $categorycode, $itemtype, $branchcode ) = @_;
1705 # Initialize default values
1709 lengthunit => 'days',
1712 my $found = Koha::CirculationRules->get_effective_rules( {
1713 branchcode => $branchcode,
1714 categorycode => $categorycode,
1715 itemtype => $itemtype,
1724 foreach my $rule_name (keys %$found) {
1725 $rules->{$rule_name} = $found->{$rule_name};
1732 =head2 GetHardDueDate
1734 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1736 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1740 sub GetHardDueDate {
1741 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1743 my $rules = Koha::CirculationRules->get_effective_rules(
1745 categorycode => $borrowertype,
1746 itemtype => $itemtype,
1747 branchcode => $branchcode,
1748 rules => [ 'hardduedate', 'hardduedatecompare' ],
1752 if ( defined( $rules->{hardduedate} ) ) {
1753 if ( $rules->{hardduedate} ) {
1754 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1757 return ( undef, undef );
1762 =head2 GetBranchBorrowerCircRule
1764 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1766 Retrieves circulation rule attributes that apply to the given
1767 branch and patron category, regardless of item type.
1768 The return value is a hashref containing the following key:
1770 patron_maxissueqty - maximum number of loans that a
1771 patron of the given category can have at the given
1772 branch. If the value is undef, no limit.
1774 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1775 patron of the given category can have at the given
1776 branch. If the value is undef, no limit.
1778 This will check for different branch/category combinations in the following order:
1782 default branch and category
1784 If no rule has been found in the database, it will default to
1787 patron_maxissueqty - undef
1788 patron_maxonsiteissueqty - undef
1790 C<$branchcode> and C<$categorycode> should contain the
1791 literal branch code and patron category code, respectively - no
1796 sub GetBranchBorrowerCircRule {
1797 my ( $branchcode, $categorycode ) = @_;
1799 # Initialize default values
1801 patron_maxissueqty => undef,
1802 patron_maxonsiteissueqty => undef,
1806 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1807 my $rule = Koha::CirculationRules->get_effective_rule(
1809 categorycode => $categorycode,
1811 branchcode => $branchcode,
1812 rule_name => $rule_name,
1816 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1822 =head2 GetBranchItemRule
1824 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1826 Retrieves circulation rule attributes that apply to the given
1827 branch and item type, regardless of patron category.
1829 The return value is a hashref containing the following keys:
1831 holdallowed => Hold policy for this branch and itemtype. Possible values:
1832 not_allowed: No holds allowed.
1833 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1834 from_any_library: Holds allowed from any patron.
1835 from_local_hold_group: Holds allowed from libraries in hold group
1837 returnbranch => branch to which to return item. Possible values:
1838 noreturn: do not return, let item remain where checked in (floating collections)
1839 homebranch: return to item's home branch
1840 holdingbranch: return to issuer branch
1842 This searches branchitemrules in the following order:
1844 * Same branchcode and itemtype
1845 * Same branchcode, itemtype '*'
1846 * branchcode '*', same itemtype
1847 * branchcode and itemtype '*'
1849 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1853 sub GetBranchItemRule {
1854 my ( $branchcode, $itemtype ) = @_;
1857 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1859 branchcode => $branchcode,
1860 itemtype => $itemtype,
1861 rule_name => 'holdallowed',
1864 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1866 branchcode => $branchcode,
1867 itemtype => $itemtype,
1868 rule_name => 'hold_fulfillment_policy',
1871 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1873 branchcode => $branchcode,
1874 itemtype => $itemtype,
1875 rule_name => 'returnbranch',
1879 # built-in default circulation rule
1881 $rules->{holdallowed} = defined $holdallowed_rule
1882 ? $holdallowed_rule->rule_value
1883 : 'from_any_library';
1884 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1885 ? $hold_fulfillment_policy_rule->rule_value
1887 $rules->{returnbranch} = defined $returnbranch_rule
1888 ? $returnbranch_rule->rule_value
1896 ($doreturn, $messages, $iteminformation, $borrower) =
1897 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1903 =item C<$barcode> is the bar code of the book being returned.
1905 =item C<$branch> is the code of the branch where the book is being returned.
1907 =item C<$exemptfine> indicates that overdue charges for the item will be
1910 =item C<$return_date> allows the default return date to be overridden
1911 by the given return date. Optional.
1915 C<&AddReturn> returns a list of four items:
1917 C<$doreturn> is true iff the return succeeded.
1919 C<$messages> is a reference-to-hash giving feedback on the operation.
1920 The keys of the hash are:
1926 No item with this barcode exists. The value is C<$barcode>.
1930 The book is not currently on loan. The value is C<$barcode>.
1934 This book has been withdrawn/cancelled. The value should be ignored.
1936 =item C<Wrongbranch>
1938 This book has was returned to the wrong branch. The value is a hashref
1939 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1940 contain the branchcode of the incorrect and correct return library, respectively.
1944 The item was reserved. The value is a reference-to-hash whose keys are
1945 fields from the reserves table of the Koha database, and
1946 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1947 either C<Waiting>, C<Reserved>, or 0.
1949 =item C<WasReturned>
1951 Value 1 if return is successful.
1953 =item C<NeedsTransfer>
1955 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1959 C<$iteminformation> is a reference-to-hash, giving information about the
1960 returned item from the issues table.
1962 C<$borrower> is a reference-to-hash, giving information about the
1963 patron who last borrowed the book.
1968 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1970 if ($branch and not Koha::Libraries->find($branch)) {
1971 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1974 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1975 my $return_date_specified = !!$return_date;
1976 $return_date //= dt_from_string();
1980 my $validTransfer = 1;
1981 my $stat_type = 'return';
1983 # get information on item
1984 my $item = Koha::Items->find({ barcode => $barcode });
1986 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1989 my $itemnumber = $item->itemnumber;
1990 my $itemtype = $item->effective_itemtype;
1992 my $issue = $item->checkout;
1994 $patron = $issue->patron
1995 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1996 . Dumper($issue->unblessed) . "\n";
1998 $messages->{'NotIssued'} = $barcode;
1999 $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
2001 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2003 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2004 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2005 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2006 $messages->{'LocalUse'} = 1;
2007 $stat_type = 'localuse';
2011 # full item data, but no borrowernumber or checkout info (no issue)
2012 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2013 # get the proper branch to which to return the item
2014 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2015 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2016 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2018 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2019 my $patron_unblessed = $patron ? $patron->unblessed : {};
2021 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2022 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2023 if ($update_loc_rules) {
2024 if (defined $update_loc_rules->{_ALL_}) {
2025 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2026 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2027 if ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) {
2028 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2029 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2033 foreach my $key ( keys %$update_loc_rules ) {
2034 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2035 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2036 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2037 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2038 $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2045 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2047 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2049 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2051 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2054 foreach my $key ( keys %$rules ) {
2055 if ( $item->notforloan eq $key ) {
2056 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2057 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2064 # check if the return is allowed at this branch
2065 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2066 unless ($returnallowed){
2067 $messages->{'Wrongbranch'} = {
2068 Wrongbranch => $branch,
2069 Rightbranch => $message
2072 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2073 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2074 return ( $doreturn, $messages, $issue, $patron_unblessed);
2077 if ( $item->withdrawn ) { # book has been cancelled
2078 $messages->{'withdrawn'} = 1;
2079 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2082 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2086 # case of a return of document (deal with issues and holdingbranch)
2088 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2089 $patron or warn "AddReturn without current borrower";
2093 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2098 C4::Context->preference('CalculateFinesOnReturn')
2099 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2104 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2107 carp "The checkin for the following issue failed, Please go to the about page and check all messages on the 'System information' to see if there are configuration / data issues ($@)" . Dumper( $issue->unblessed );
2109 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2110 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2112 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2115 # FIXME is the "= 1" right? This could be the borrower hash.
2116 $messages->{'WasReturned'} = 1;
2119 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2123 # the holdingbranch is updated if the document is returned to another location.
2124 # this is always done regardless of whether the item was on loan or not
2125 if ($item->holdingbranch ne $branch) {
2126 $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2129 my $item_was_lost = $item->itemlost;
2130 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2131 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2133 # fix up the accounts.....
2134 if ($item_was_lost) {
2135 $messages->{'WasLost'} = 1;
2136 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2137 $messages->{'LostItemFeeRefunded'} = $updated_item->{_refunded};
2138 $messages->{'LostItemFeeRestored'} = $updated_item->{_restored};
2140 if ( $updated_item->{_charge} ) {
2141 $issue //= Koha::Old::Checkouts->search(
2142 { itemnumber => $item->itemnumber },
2143 { order_by => { '-desc' => 'returndate' }, rows => 1 } )
2145 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2146 my $patron = $issue->patron;
2147 $patron_unblessed = $patron->unblessed;
2149 _CalculateAndUpdateFine(
2152 item => $item->unblessed,
2153 borrower => $patron_unblessed,
2154 return_date => $return_date
2157 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2158 $item->itemnumber, undef, 'RETURNED' );
2159 $messages->{'LostItemFeeCharged'} = 1;
2164 # check if we have a transfer for this document
2165 my $transfer = $item->get_transfer;
2167 # if we have a transfer to complete, we update the line of transfers with the datearrived
2170 if ( $transfer->in_transit ) {
2171 if ( $transfer->tobranch eq $branch ) {
2173 $messages->{'TransferArrived'} = $transfer->frombranch;
2174 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2175 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2178 $messages->{'WrongTransfer'} = $transfer->tobranch;
2179 $messages->{'WrongTransferItem'} = $item->itemnumber;
2180 $messages->{'TransferTrigger'} = $transfer->reason;
2184 if ( $transfer->tobranch eq $branch ) {
2186 $messages->{'TransferArrived'} = $transfer->frombranch;
2187 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2188 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2191 $messages->{'WasTransfered'} = $transfer->tobranch;
2192 $messages->{'TransferTrigger'} = $transfer->reason;
2197 # fix up the overdues in accounts...
2198 if ($borrowernumber) {
2199 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2200 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2202 if ( $issue and $issue->is_overdue($return_date) ) {
2204 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2206 $messages->{'PrevDebarred'} = $debardate;
2208 $messages->{'Debarred'} = $debardate if $debardate;
2210 # there's no overdue on the item but borrower had been previously debarred
2211 } elsif ( $issue->date_due and $patron->debarred ) {
2212 if ( $patron->debarred eq "9999-12-31") {
2213 $messages->{'ForeverDebarred'} = $patron->debarred;
2215 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2216 $borrower_debar_dt->truncate(to => 'day');
2217 my $today_dt = $return_date->clone()->truncate(to => 'day');
2218 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2219 $messages->{'PrevDebarred'} = $patron->debarred;
2225 # find reserves.....
2226 # launch the Checkreserves routine to find any holds
2227 my ($resfound, $resrec);
2228 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2229 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2230 # 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)
2231 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2232 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2233 $resfound = 'Reserved';
2234 $resrec = $hold->unblessed;
2237 $resrec->{'ResFound'} = $resfound;
2238 $messages->{'ResFound'} = $resrec;
2241 # Record the fact that this book was returned.
2245 itemnumber => $itemnumber,
2246 itemtype => $itemtype,
2247 location => $item->location,
2248 borrowernumber => $borrowernumber,
2249 ccode => $item->ccode,
2252 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2254 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2256 branchcode => $branch,
2257 categorycode => $patron->categorycode,
2258 item_type => $itemtype,
2259 notification => 'CHECKIN',
2261 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2262 SendCirculationAlert({
2264 item => $item->unblessed,
2265 borrower => $patron->unblessed,
2270 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2271 if C4::Context->preference("ReturnLog");
2274 # Check if this item belongs to a biblio record that is attached to an
2275 # ILL request, if it is we need to update the ILL request's status
2276 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2277 my $request = Koha::Illrequests->find(
2278 { biblio_id => $item->biblio->biblionumber }
2280 $request->status('RET') if $request;
2283 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2284 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2285 && ( $doreturn or $messages->{'NotIssued'} )
2287 and ( $branch ne $returnbranch )
2288 and not $messages->{'WrongTransfer'}
2289 and not $messages->{'WasTransfered'} )
2291 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2292 if (C4::Context->preference("AutomaticItemReturn" ) or
2293 (C4::Context->preference("UseBranchTransferLimits") and
2294 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2296 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2297 $messages->{'WasTransfered'} = $returnbranch;
2298 $messages->{'TransferTrigger'} = $transfer_trigger;
2300 $messages->{'NeedsTransfer'} = $returnbranch;
2301 $messages->{'TransferTrigger'} = $transfer_trigger;
2305 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2306 my $claims = Koha::Checkouts::ReturnClaims->search(
2308 itemnumber => $item->id,
2309 resolution => undef,
2313 if ( $claims->count ) {
2314 $messages->{ReturnClaims} = $claims;
2318 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2319 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2321 if ( $doreturn and $issue ) {
2322 my $checkin = Koha::Old::Checkouts->find($issue->id);
2324 Koha::Plugins->call('after_circ_action', {
2325 action => 'checkin',
2332 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2335 =head2 MarkIssueReturned
2337 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2339 Unconditionally marks an issue as being returned by
2340 moving the C<issues> row to C<old_issues> and
2341 setting C<returndate> to the current date.
2343 if C<$returndate> is specified (in iso format), it is used as the date
2346 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2347 the old_issue is immediately anonymised
2349 Ideally, this function would be internal to C<C4::Circulation>,
2350 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2351 and offline_circ/process_koc.pl.
2353 The last optional parameter allos passing skip_record_index to the item store call.
2357 sub MarkIssueReturned {
2358 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2360 # Retrieve the issue
2361 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2363 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2365 my $issue_id = $issue->issue_id;
2367 my $anonymouspatron;
2368 if ( $privacy && $privacy == 2 ) {
2369 # The default of 0 will not work due to foreign key constraints
2370 # The anonymisation will fail if AnonymousPatron is not a valid entry
2371 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2372 # Note that a warning should appear on the about page (System information tab).
2373 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2374 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."
2375 unless Koha::Patrons->find( $anonymouspatron );
2378 my $schema = Koha::Database->schema;
2380 # FIXME Improve the return value and handle it from callers
2381 $schema->txn_do(sub {
2383 my $patron = Koha::Patrons->find( $borrowernumber );
2385 # Update the returndate value
2386 if ( $returndate ) {
2387 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2390 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2393 # Create the old_issues entry
2394 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2396 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2397 if ( $privacy && $privacy == 2) {
2398 $old_checkout->borrowernumber($anonymouspatron)->store;
2401 # And finally delete the issue
2404 $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2406 if ( C4::Context->preference('StoreLastBorrower') ) {
2407 my $item = Koha::Items->find( $itemnumber );
2408 $item->last_returned_by( $patron );
2411 # Remove any OVERDUES related debarment if the borrower has no overdues
2412 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2413 && $patron->debarred
2414 && !$patron->has_overdues
2415 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2417 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2425 =head2 _debar_user_on_return
2427 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2429 C<$borrower> borrower hashref
2431 C<$item> item hashref
2433 C<$datedue> date due DateTime object
2435 C<$returndate> DateTime object representing the return time
2437 Internal function, called only by AddReturn that calculates and updates
2438 the user fine days, and debars them if necessary.
2440 Should only be called for overdue returns
2442 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2447 sub _calculate_new_debar_dt {
2448 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2450 my $branchcode = _GetCircControlBranch( $item, $borrower );
2451 my $circcontrol = C4::Context->preference('CircControl');
2452 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2453 { categorycode => $borrower->{categorycode},
2454 itemtype => $item->{itype},
2455 branchcode => $branchcode,
2460 'maxsuspensiondays',
2461 'suspension_chargeperiod',
2465 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2466 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2467 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2469 return unless $finedays;
2471 # finedays is in days, so hourly loans must multiply by 24
2472 # thus 1 hour late equals 1 day suspension * finedays rate
2473 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2475 # grace period is measured in the same units as the loan
2477 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2479 my $deltadays = DateTime::Duration->new(
2480 days => $chargeable_units
2483 if ( $deltadays->subtract($grace)->is_positive() ) {
2484 my $suspension_days = $deltadays * $finedays;
2486 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2487 # No need to / 1 and do not consider / 0
2488 $suspension_days = DateTime::Duration->new(
2489 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2493 # If the max suspension days is < than the suspension days
2494 # the suspension days is limited to this maximum period.
2495 my $max_sd = $issuing_rule->{maxsuspensiondays};
2496 if ( defined $max_sd && $max_sd ne '' ) {
2497 $max_sd = DateTime::Duration->new( days => $max_sd );
2498 $suspension_days = $max_sd
2499 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2502 my ( $has_been_extended );
2503 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2504 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2506 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2507 $has_been_extended = 1;
2512 # Use the calendar or not to calculate the debarment date
2513 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2514 my $calendar = Koha::Calendar->new(
2515 branchcode => $branchcode,
2516 days_mode => 'Calendar'
2518 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2521 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2523 return $new_debar_dt;
2528 sub _debar_user_on_return {
2529 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2531 $return_date //= dt_from_string();
2533 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2535 return unless $new_debar_dt;
2537 Koha::Patron::Debarments::AddUniqueDebarment({
2538 borrowernumber => $borrower->{borrowernumber},
2539 expiration => $new_debar_dt->ymd(),
2540 type => 'SUSPENSION',
2542 # if borrower was already debarred but does not get an extra debarment
2543 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2544 my ($new_debarment_str, $is_a_reminder);
2545 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2547 $new_debarment_str = $borrower->{debarred};
2549 $new_debarment_str = $new_debar_dt->ymd();
2551 # FIXME Should return a DateTime object
2552 return $new_debarment_str, $is_a_reminder;
2555 =head2 _FixOverduesOnReturn
2557 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2559 C<$borrowernumber> borrowernumber
2561 C<$itemnumber> itemnumber
2563 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2565 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2571 sub _FixOverduesOnReturn {
2572 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2573 unless( $borrowernumber ) {
2574 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2578 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2582 warn "_FixOverduesOnReturn() not supplied valid status";
2586 my $schema = Koha::Database->schema;
2588 my $result = $schema->txn_do(
2590 # check for overdue fine
2591 my $accountlines = Koha::Account::Lines->search(
2593 borrowernumber => $borrowernumber,
2594 itemnumber => $item,
2595 debit_type_code => 'OVERDUE',
2596 status => 'UNRETURNED'
2599 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2601 my $accountline = $accountlines->next;
2602 my $payments = $accountline->credits;
2604 my $amountoutstanding = $accountline->amountoutstanding;
2605 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2606 $accountline->delete;
2607 return 0; # no warning, we've just removed a zero value fine (backdated return)
2608 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2609 my $account = Koha::Account->new({patron_id => $borrowernumber});
2610 my $credit = $account->add_credit(
2612 amount => $amountoutstanding,
2613 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2614 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2615 interface => C4::Context->interface,
2621 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2623 if (C4::Context->preference("FinesLog")) {
2624 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2628 $accountline->status($status);
2629 return $accountline->store();
2636 =head2 _GetCircControlBranch
2638 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2642 Return the library code to be used to determine which circulation
2643 policy applies to a transaction. Looks up the CircControl and
2644 HomeOrHoldingBranch system preferences.
2646 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2648 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2652 sub _GetCircControlBranch {
2653 my ($item, $borrower) = @_;
2654 my $circcontrol = C4::Context->preference('CircControl');
2657 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2658 $branch= C4::Context->userenv->{'branch'};
2659 } elsif ($circcontrol eq 'PatronLibrary') {
2660 $branch=$borrower->{branchcode};
2662 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2663 $branch = $item->{$branchfield};
2664 # default to item home branch if holdingbranch is used
2665 # and is not defined
2666 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2667 $branch = $item->{homebranch};
2675 $issue = GetOpenIssue( $itemnumber );
2677 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2679 C<$itemnumber> is the item's itemnumber
2686 my ( $itemnumber ) = @_;
2687 return unless $itemnumber;
2688 my $dbh = C4::Context->dbh;
2689 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2690 $sth->execute( $itemnumber );
2691 return $sth->fetchrow_hashref();
2695 =head2 GetUpcomingDueIssues
2697 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2701 sub GetUpcomingDueIssues {
2704 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2705 my $dbh = C4::Context->dbh;
2708 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2710 LEFT JOIN items USING (itemnumber)
2711 LEFT JOIN branches ON branches.branchcode =
2713 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2714 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2715 my @bind_parameters = ( $params->{'days_in_advance'} );
2717 my $sth = $dbh->prepare( $statement );
2718 $sth->execute( @bind_parameters );
2719 my $upcoming_dues = $sth->fetchall_arrayref({});
2721 return $upcoming_dues;
2724 =head2 CanBookBeRenewed
2726 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2728 Find out whether a borrowed item may be renewed.
2730 C<$borrowernumber> is the borrower number of the patron who currently
2731 has the item on loan.
2733 C<$itemnumber> is the number of the item to renew.
2735 C<$override_limit>, if supplied with a true value, causes
2736 the limit on the number of times that the loan can be renewed
2737 (as controlled by the item type) to be ignored. Overriding also allows
2738 to renew sooner than "No renewal before" and to manually renew loans
2739 that are automatically renewed.
2741 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2742 item must currently be on loan to the specified borrower; renewals
2743 must be allowed for the item's type; and the borrower must not have
2744 already renewed the loan. $error will contain the reason the renewal can not proceed
2748 sub CanBookBeRenewed {
2749 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2751 my $dbh = C4::Context->dbh;
2753 my $auto_renew = "no";
2755 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2756 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2757 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2758 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2760 my $patron = $issue->patron or return;
2762 # override_limit will override anything else except on_reserve
2763 unless ( $override_limit ){
2764 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2765 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2767 categorycode => $patron->categorycode,
2768 itemtype => $item->effective_itemtype,
2769 branchcode => $branchcode,
2772 'no_auto_renewal_after',
2773 'no_auto_renewal_after_hard_limit',
2776 'unseen_renewals_allowed'
2781 return ( 0, "too_many" )
2782 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2784 return ( 0, "too_unseen" )
2785 if C4::Context->preference('UnseenRenewals') &&
2786 $issuing_rule->{unseen_renewals_allowed} &&
2787 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2789 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2790 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2791 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2792 my $restricted = $patron->is_debarred;
2793 my $hasoverdues = $patron->has_overdues;
2795 if ( $restricted and $restrictionblockrenewing ) {
2796 return ( 0, 'restriction');
2797 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2798 return ( 0, 'overdue');
2801 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2803 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2804 return ( 0, 'auto_account_expired' );
2807 if ( defined $issuing_rule->{no_auto_renewal_after}
2808 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2809 # Get issue_date and add no_auto_renewal_after
2810 # If this is greater than today, it's too late for renewal.
2811 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2812 $maximum_renewal_date->add(
2813 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2815 my $now = dt_from_string;
2816 if ( $now >= $maximum_renewal_date ) {
2817 return ( 0, "auto_too_late" );
2820 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2821 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2822 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2823 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2824 return ( 0, "auto_too_late" );
2828 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2829 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2830 my $amountoutstanding =
2831 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2832 ? $patron->account->balance
2833 : $patron->account->outstanding_debits->total_outstanding;
2834 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2835 return ( 0, "auto_too_much_oweing" );
2840 if ( defined $issuing_rule->{norenewalbefore}
2841 and $issuing_rule->{norenewalbefore} ne "" )
2844 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2845 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2846 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2848 # Depending on syspref reset the exact time, only check the date
2849 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2850 and $issuing_rule->{lengthunit} eq 'days' )
2852 $soonestrenewal->truncate( to => 'day' );
2855 if ( $soonestrenewal > dt_from_string() )
2857 $auto_renew = ($issue->auto_renew && $patron->autorenew_checkouts) ? "auto_too_soon" : "too_soon";
2859 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2864 # Fallback for automatic renewals:
2865 # If norenewalbefore is undef, don't renew before due date.
2866 if ( $issue->auto_renew && $auto_renew eq "no" && $patron->autorenew_checkouts ) {
2867 my $now = dt_from_string;
2868 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2871 $auto_renew = "auto_too_soon";
2876 my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2878 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2879 if ( $resfound && $resrec->{non_priority} ) {
2880 $resfound = Koha::Holds->search(
2881 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2887 # This item can fill one or more unfilled reserve, can those unfilled reserves
2888 # all be filled by other available items?
2890 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2892 my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2894 # There is an item level hold on this item, no other item can fill the hold
2899 # Get all other items that could possibly fill reserves
2900 my $items = Koha::Items->search({
2901 biblionumber => $resrec->{biblionumber},
2904 -not => { itemnumber => $itemnumber }
2907 # Get all other reserves that could have been filled by this item
2908 my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2909 my $patrons = Koha::Patrons->search({
2910 borrowernumber => { -in => \@borrowernumbers }
2913 # If the count of the union of the lists of reservable items for each borrower
2914 # is equal or greater than the number of borrowers, we know that all reserves
2915 # can be filled with available items. We can get the union of the sets simply
2916 # by pushing all the elements onto an array and removing the duplicates.
2918 ITEM: while ( my $item = $items->next ) {
2919 next if IsItemOnHoldAndFound( $item->itemnumber );
2920 while ( my $patron = $patrons->next ) {
2921 next unless IsAvailableForItemLevelRequest($item, $patron);
2922 next unless CanItemBeReserved($patron->borrowernumber,$item->itemnumber,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2923 push @reservable, $item->itemnumber;
2924 if (@reservable >= @borrowernumbers) {
2934 if( $cron ) { #The cron wants to return 'too_soon' over 'on_reserve'
2935 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2936 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2937 } else { # For other purposes we want 'on_reserve' before 'too_soon'
2938 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2939 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2942 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2944 return ( 1, undef );
2949 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2953 C<$borrowernumber> is the borrower number of the patron who currently
2956 C<$itemnumber> is the number of the item to renew.
2958 C<$branch> is the library where the renewal took place (if any).
2959 The library that controls the circ policies for the renewal is retrieved from the issues record.
2961 C<$datedue> can be a DateTime object used to set the due date.
2963 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2964 this parameter is not supplied, lastreneweddate is set to the current date.
2966 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2967 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2968 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2971 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2972 from the book's item type.
2974 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
2975 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
2976 fallback to a true value
2981 my $borrowernumber = shift;
2982 my $itemnumber = shift or return;
2984 my $datedue = shift;
2985 my $lastreneweddate = shift || dt_from_string();
2986 my $skipfinecalc = shift;
2989 # Fallback on a 'seen' renewal
2990 $seen = defined $seen && $seen == 0 ? 0 : 1;
2992 my $item_object = Koha::Items->find($itemnumber) or return;
2993 my $biblio = $item_object->biblio;
2994 my $issue = $item_object->checkout;
2995 my $item_unblessed = $item_object->unblessed;
2997 my $dbh = C4::Context->dbh;
2999 return unless $issue;
3001 $borrowernumber ||= $issue->borrowernumber;
3003 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3004 carp 'Invalid date passed to AddRenewal.';
3008 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3009 my $patron_unblessed = $patron->unblessed;
3011 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3013 my $schema = Koha::Database->schema;
3014 $schema->txn_do(sub{
3016 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3017 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3019 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3021 # If the due date wasn't specified, calculate it by adding the
3022 # book's loan length to today's date or the current due date
3023 # based on the value of the RenewalPeriodBase syspref.
3024 my $itemtype = $item_object->effective_itemtype;
3027 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3028 dt_from_string( $issue->date_due, 'sql' ) :
3030 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3033 my $fees = Koha::Charges::Fees->new(
3036 library => $circ_library,
3037 item => $item_object,
3038 from_date => dt_from_string( $issue->date_due, 'sql' ),
3039 to_date => dt_from_string($datedue),
3043 # Increment the unseen renewals, if appropriate
3044 # We only do so if the syspref is enabled and
3045 # a maximum value has been set in the circ rules
3046 my $unseen_renewals = $issue->unseen_renewals;
3047 if (C4::Context->preference('UnseenRenewals')) {
3048 my $rule = Koha::CirculationRules->get_effective_rule(
3049 { categorycode => $patron->categorycode,
3050 itemtype => $item_object->effective_itemtype,
3051 branchcode => $circ_library->branchcode,
3052 rule_name => 'unseen_renewals_allowed'
3055 if (!$seen && $rule && $rule->rule_value) {
3058 # If the renewal is seen, unseen should revert to 0
3059 $unseen_renewals = 0;
3063 # Update the issues record to have the new due date, and a new count
3064 # of how many times it has been renewed.
3065 my $renews = ( $issue->renewals || 0 ) + 1;
3066 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3069 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3072 Koha::Exceptions::Checkout::FailedRenewal->throw(
3073 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3077 # Update the renewal count on the item, and tell zebra to reindex
3078 $renews = ( $item_object->renewals || 0 ) + 1;
3079 $item_object->renewals($renews);
3080 $item_object->onloan($datedue);
3081 $item_object->store({ log_action => 0 });
3083 # Charge a new rental fee, if applicable
3084 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3085 if ( $charge > 0 ) {
3086 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3089 # Charge a new accumulate rental fee, if applicable
3090 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3091 if ( $itemtype_object ) {
3092 my $accumulate_charge = $fees->accumulate_rentalcharge();
3093 if ( $accumulate_charge > 0 ) {
3094 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3096 $charge += $accumulate_charge;
3099 # Send a renewal slip according to checkout alert preferencei
3100 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3101 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3103 branchcode => $branch,
3104 categorycode => $patron->categorycode,
3105 item_type => $itemtype,
3106 notification => 'CHECKOUT',
3108 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3109 SendCirculationAlert(
3112 item => $item_unblessed,
3113 borrower => $patron->unblessed,
3120 # Remove any OVERDUES related debarment if the borrower has no overdues
3122 && $patron->is_debarred
3123 && ! $patron->has_overdues
3124 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3126 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3129 # Add the renewal to stats
3132 branch => $item_object->renewal_branchcode({branch => $branch}),
3135 itemnumber => $itemnumber,
3136 itemtype => $itemtype,
3137 location => $item_object->location,
3138 borrowernumber => $borrowernumber,
3139 ccode => $item_object->ccode,
3144 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3146 Koha::Plugins->call('after_circ_action', {
3147 action => 'renewal',
3149 checkout => $issue->get_from_storage
3158 # check renewal status
3159 my ( $bornum, $itemno ) = @_;
3160 my $dbh = C4::Context->dbh;
3162 my $unseencount = 0;
3163 my $renewsallowed = 0;
3164 my $unseenallowed = 0;
3168 my $patron = Koha::Patrons->find( $bornum );
3169 my $item = Koha::Items->find($itemno);
3171 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3173 # Look in the issues table for this item, lent to this borrower,
3174 # and not yet returned.
3176 # FIXME - I think this function could be redone to use only one SQL call.
3177 my $sth = $dbh->prepare(
3178 "select * from issues
3179 where (borrowernumber = ?)
3180 and (itemnumber = ?)"
3182 $sth->execute( $bornum, $itemno );
3183 my $data = $sth->fetchrow_hashref;
3184 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3185 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3186 # $item and $borrower should be calculated
3187 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3189 my $rules = Koha::CirculationRules->get_effective_rules(
3191 categorycode => $patron->categorycode,
3192 itemtype => $item->effective_itemtype,
3193 branchcode => $branchcode,
3194 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3197 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3198 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3199 $rules->{unseen_renewals_allowed} :
3201 $renewsleft = $renewsallowed - $renewcount;
3202 $unseenleft = $unseenallowed - $unseencount;
3203 if($renewsleft < 0){ $renewsleft = 0; }
3204 if($unseenleft < 0){ $unseenleft = 0; }
3215 =head2 GetSoonestRenewDate
3217 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3219 Find out the soonest possible renew date of a borrowed item.
3221 C<$borrowernumber> is the borrower number of the patron who currently
3222 has the item on loan.
3224 C<$itemnumber> is the number of the item to renew.
3226 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3227 renew date, based on the value "No renewal before" of the applicable
3228 issuing rule. Returns the current date if the item can already be
3229 renewed, and returns undefined if the borrower, loan, or item
3234 sub GetSoonestRenewDate {
3235 my ( $borrowernumber, $itemnumber ) = @_;
3237 my $dbh = C4::Context->dbh;
3239 my $item = Koha::Items->find($itemnumber) or return;
3240 my $itemissue = $item->checkout or return;
3242 $borrowernumber ||= $itemissue->borrowernumber;
3243 my $patron = Koha::Patrons->find( $borrowernumber )
3246 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3247 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3248 { categorycode => $patron->categorycode,
3249 itemtype => $item->effective_itemtype,
3250 branchcode => $branchcode,
3258 my $now = dt_from_string;
3259 return $now unless $issuing_rule;
3261 if ( defined $issuing_rule->{norenewalbefore}
3262 and $issuing_rule->{norenewalbefore} ne "" )
3264 my $soonestrenewal =
3265 dt_from_string( $itemissue->date_due )->subtract(
3266 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3268 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3269 and $issuing_rule->{lengthunit} eq 'days' )
3271 $soonestrenewal->truncate( to => 'day' );
3273 return $soonestrenewal if $now < $soonestrenewal;
3278 =head2 GetLatestAutoRenewDate
3280 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3282 Find out the latest possible auto renew date of a borrowed item.
3284 C<$borrowernumber> is the borrower number of the patron who currently
3285 has the item on loan.
3287 C<$itemnumber> is the number of the item to renew.
3289 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3290 auto renew date, based on the value "No auto renewal after" and the "No auto
3291 renewal after (hard limit) of the applicable issuing rule.
3292 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3293 or item cannot be found.
3297 sub GetLatestAutoRenewDate {
3298 my ( $borrowernumber, $itemnumber ) = @_;
3300 my $dbh = C4::Context->dbh;
3302 my $item = Koha::Items->find($itemnumber) or return;
3303 my $itemissue = $item->checkout or return;
3305 $borrowernumber ||= $itemissue->borrowernumber;
3306 my $patron = Koha::Patrons->find( $borrowernumber )
3309 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3310 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3312 categorycode => $patron->categorycode,
3313 itemtype => $item->effective_itemtype,
3314 branchcode => $branchcode,
3316 'no_auto_renewal_after',
3317 'no_auto_renewal_after_hard_limit',
3323 return unless $circulation_rules;
3325 if ( not $circulation_rules->{no_auto_renewal_after}
3326 or $circulation_rules->{no_auto_renewal_after} eq '' )
3327 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3328 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3330 my $maximum_renewal_date;
3331 if ( $circulation_rules->{no_auto_renewal_after} ) {
3332 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3333 $maximum_renewal_date->add(
3334 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3338 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3339 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3340 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3342 return $maximum_renewal_date;
3346 =head2 GetIssuingCharges
3348 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3350 Calculate how much it would cost for a given patron to borrow a given
3351 item, including any applicable discounts.
3353 C<$itemnumber> is the item number of item the patron wishes to borrow.
3355 C<$borrowernumber> is the patron's borrower number.
3357 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3358 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3363 sub GetIssuingCharges {
3365 # calculate charges due
3366 my ( $itemnumber, $borrowernumber ) = @_;
3368 my $dbh = C4::Context->dbh;
3371 # Get the book's item type and rental charge (via its biblioitem).
3372 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3373 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3374 $charge_query .= (C4::Context->preference('item-level_itypes'))
3375 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3376 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3378 $charge_query .= ' WHERE items.itemnumber =?';
3380 my $sth = $dbh->prepare($charge_query);
3381 $sth->execute($itemnumber);
3382 if ( my $item_data = $sth->fetchrow_hashref ) {
3383 $item_type = $item_data->{itemtype};
3384 $charge = $item_data->{rentalcharge};
3385 # FIXME This should follow CircControl
3386 my $branch = C4::Context::mybranch();
3387 my $patron = Koha::Patrons->find( $borrowernumber );
3388 my $discount = Koha::CirculationRules->get_effective_rule({
3389 categorycode => $patron->categorycode,
3390 branchcode => $branch,
3391 itemtype => $item_type,
3392 rule_name => 'rentaldiscount'
3395 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3398 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3402 return ( $charge, $item_type );
3405 =head2 AddIssuingCharge
3407 &AddIssuingCharge( $checkout, $charge, $type )
3411 sub AddIssuingCharge {
3412 my ( $checkout, $charge, $type ) = @_;
3414 # FIXME What if checkout does not exist?
3416 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3417 my $accountline = $account->add_debit(
3421 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3422 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3423 interface => C4::Context->interface,
3425 item_id => $checkout->itemnumber,
3426 issue_id => $checkout->issue_id,
3433 GetTransfers($itemnumber);
3438 my ($itemnumber) = @_;
3440 my $dbh = C4::Context->dbh;
3449 FROM branchtransfers
3450 WHERE itemnumber = ?
3451 AND datearrived IS NULL
3452 AND datecancelled IS NULL
3454 my $sth = $dbh->prepare($query);
3455 $sth->execute($itemnumber);
3456 my @row = $sth->fetchrow_array();
3460 =head2 GetTransfersFromTo
3462 @results = GetTransfersFromTo($frombranch,$tobranch);
3464 Returns the list of pending transfers between $from and $to branch
3468 sub GetTransfersFromTo {
3469 my ( $frombranch, $tobranch ) = @_;
3470 return unless ( $frombranch && $tobranch );
3471 my $dbh = C4::Context->dbh;
3473 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3474 FROM branchtransfers
3477 AND datecancelled IS NULL
3478 AND datesent IS NOT NULL
3479 AND datearrived IS NULL
3481 my $sth = $dbh->prepare($query);
3482 $sth->execute( $frombranch, $tobranch );
3485 while ( my $data = $sth->fetchrow_hashref ) {
3486 push @gettransfers, $data;
3488 return (@gettransfers);
3491 =head2 SendCirculationAlert
3493 Send out a C<check-in> or C<checkout> alert using the messaging system.
3501 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3505 Hashref of information about the item being checked in or out.
3509 Hashref of information about the borrower of the item.
3513 The branchcode from where the checkout or check-in took place.
3519 SendCirculationAlert({
3522 borrower => $borrower,
3528 sub SendCirculationAlert {
3530 my ($type, $item, $borrower, $branch) =
3531 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3532 my %message_name = (
3533 CHECKIN => 'Item_Check_in',
3534 CHECKOUT => 'Item_Checkout',
3535 RENEWAL => 'Item_Checkout',
3537 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3538 borrowernumber => $borrower->{borrowernumber},
3539 message_name => $message_name{$type},
3541 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3543 my $schema = Koha::Database->new->schema;
3544 my @transports = keys %{ $borrower_preferences->{transports} };
3546 # From the MySQL doc:
3547 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3548 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3549 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3550 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3552 for my $mtt (@transports) {
3553 my $letter = C4::Letters::GetPreparedLetter (
3554 module => 'circulation',
3555 letter_code => $type,
3556 branchcode => $branch,
3557 message_transport_type => $mtt,
3558 lang => $borrower->{lang},
3560 $issues_table => $item->{itemnumber},
3561 'items' => $item->{itemnumber},
3562 'biblio' => $item->{biblionumber},
3563 'biblioitems' => $item->{biblionumber},
3564 'borrowers' => $borrower,
3565 'branches' => $branch,
3569 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3570 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3571 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3572 unless ( $message ) {
3573 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3574 C4::Message->enqueue($letter, $borrower, $mtt);
3576 $message->append($letter);
3579 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3585 =head2 updateWrongTransfer
3587 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3589 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
3593 sub updateWrongTransfer {
3594 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3596 # first step: cancel the original transfer
3597 my $item = Koha::Items->find($itemNumber);
3598 my $transfer = $item->get_transfer;
3599 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3601 # second step: create a new transfer to the right location
3602 my $new_transfer = $item->request_transfer(
3604 to => $transfer->to_library,
3605 reason => $transfer->reason,
3606 comment => $transfer->comments,
3612 return $new_transfer;
3617 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3619 this function calculates the due date given the start date and configured circulation rules,
3620 checking against the holidays calendar as per the daysmode circulation rule.
3621 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3622 C<$itemtype> = itemtype code of item in question
3623 C<$branch> = location whose calendar to use
3624 C<$borrower> = Borrower object
3625 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3630 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3634 # loanlength now a href
3636 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3638 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3644 if (ref $startdate ne 'DateTime' ) {
3645 $datedue = dt_from_string($datedue);
3647 $datedue = $startdate->clone;
3650 $datedue = dt_from_string()->truncate( to => 'minute' );
3654 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3656 categorycode => $borrower->{categorycode},
3657 itemtype => $itemtype,
3658 branchcode => $branch,
3662 # calculate the datedue as normal
3663 if ( $daysmode eq 'Days' )
3664 { # ignoring calendar
3665 if ( $loanlength->{lengthunit} eq 'hours' ) {
3666 $datedue->add( hours => $loanlength->{$length_key} );
3668 $datedue->add( days => $loanlength->{$length_key} );
3669 $datedue->set_hour(23);
3670 $datedue->set_minute(59);
3674 if ($loanlength->{lengthunit} eq 'hours') {
3675 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3678 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3680 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3681 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3682 if ($loanlength->{lengthunit} eq 'days') {
3683 $datedue->set_hour(23);
3684 $datedue->set_minute(59);
3688 # if Hard Due Dates are used, retrieve them and apply as necessary
3689 my ( $hardduedate, $hardduedatecompare ) =
3690 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3691 if ($hardduedate) { # hardduedates are currently dates
3692 $hardduedate->truncate( to => 'minute' );
3693 $hardduedate->set_hour(23);
3694 $hardduedate->set_minute(59);
3695 my $cmp = DateTime->compare( $hardduedate, $datedue );
3697 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3698 # if the calculated date is before the 'after' Hard Due Date (floor), override
3699 # if the hard due date is set to 'exactly', overrride
3700 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3701 $datedue = $hardduedate->clone;
3704 # in all other cases, keep the date due as it is
3708 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3709 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3710 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3711 if( $expiry_dt ) { #skip empty expiry date..
3712 $expiry_dt->set( hour => 23, minute => 59);
3713 my $d1= $datedue->clone->set_time_zone('floating');
3714 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3715 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3718 if ( $daysmode ne 'Days' ) {
3719 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3720 if ( $calendar->is_holiday($datedue) ) {
3721 # Don't return on a closed day
3722 $datedue = $calendar->prev_open_days( $datedue, 1 );
3731 sub CheckValidBarcode{
3733 my $dbh = C4::Context->dbh;
3734 my $query=qq|SELECT count(*)
3738 my $sth = $dbh->prepare($query);
3739 $sth->execute($barcode);
3740 my $exist=$sth->fetchrow ;
3744 =head2 IsBranchTransferAllowed
3746 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3748 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3750 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3751 Koha::Item->can_be_transferred.
3755 sub IsBranchTransferAllowed {
3756 my ( $toBranch, $fromBranch, $code ) = @_;
3758 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3760 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3761 my $dbh = C4::Context->dbh;
3763 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3764 $sth->execute( $toBranch, $fromBranch, $code );
3765 my $limit = $sth->fetchrow_hashref();
3767 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3768 if ( $limit->{'limitId'} ) {
3775 =head2 CreateBranchTransferLimit
3777 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3779 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3781 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3785 sub CreateBranchTransferLimit {
3786 my ( $toBranch, $fromBranch, $code ) = @_;
3787 return unless defined($toBranch) && defined($fromBranch);
3788 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3790 my $dbh = C4::Context->dbh;
3792 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3793 return $sth->execute( $code, $toBranch, $fromBranch );
3796 =head2 DeleteBranchTransferLimits
3798 my $result = DeleteBranchTransferLimits($frombranch);
3800 Deletes all the library transfer limits for one library. Returns the
3801 number of limits deleted, 0e0 if no limits were deleted, or undef if
3802 no arguments are supplied.
3804 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3805 fromBranch => $fromBranch
3810 sub DeleteBranchTransferLimits {
3812 return unless defined $branch;
3813 my $dbh = C4::Context->dbh;
3814 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3815 return $sth->execute($branch);
3819 my ( $borrowernumber, $itemnum ) = @_;
3820 MarkIssueReturned( $borrowernumber, $itemnum );
3825 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3827 The final optional parameter, C<$params>, expected to contain
3828 'skip_record_index' key, which relayed down to Koha::Item/store,
3829 there it prevents calling of ModZebra index_records,
3830 which takes most of the time in batch adds/deletes: index_records better
3831 to be called later in C<additem.pl> after the whole loop.
3834 skip_record_index => 1|0
3839 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3841 unless ( $mark_lost_from ) {
3842 # Temporary check to avoid regressions
3843 die q|LostItem called without $mark_lost_from, check the API.|;
3847 if ( $force_mark_returned ) {
3850 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3851 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3854 my $dbh = C4::Context->dbh();
3855 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3857 JOIN items USING (itemnumber)
3858 JOIN biblio USING (biblionumber)
3859 WHERE issues.itemnumber=?");
3860 $sth->execute($itemnumber);
3861 my $issues=$sth->fetchrow_hashref();
3863 # If a borrower lost the item, add a replacement cost to the their record
3864 if ( my $borrowernumber = $issues->{borrowernumber} ){
3865 my $patron = Koha::Patrons->find( $borrowernumber );
3867 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3868 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3870 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3871 C4::Accounts::chargelostitem(
3874 $issues->{'replacementprice'},
3875 sprintf( "%s %s %s",
3876 $issues->{'title'} || q{},
3877 $issues->{'barcode'} || q{},
3878 $issues->{'itemcallnumber'} || q{},
3881 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3882 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3885 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3888 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3889 my $item = Koha::Items->find($itemnumber);
3890 my $transfers = $item->get_transfers;
3891 while (my $transfer = $transfers->next) {
3892 $transfer->cancel({ reason => 'ItemLost', force => 1 });
3896 sub GetOfflineOperations {
3897 my $dbh = C4::Context->dbh;
3898 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3899 $sth->execute(C4::Context->userenv->{'branch'});
3900 my $results = $sth->fetchall_arrayref({});
3904 sub GetOfflineOperation {
3905 my $operationid = shift;
3906 return unless $operationid;
3907 my $dbh = C4::Context->dbh;
3908 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3909 $sth->execute( $operationid );
3910 return $sth->fetchrow_hashref;
3913 sub AddOfflineOperation {
3914 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3915 my $dbh = C4::Context->dbh;
3916 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3917 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3921 sub DeleteOfflineOperation {
3922 my $dbh = C4::Context->dbh;
3923 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3924 $sth->execute( shift );
3928 sub ProcessOfflineOperation {
3929 my $operation = shift;
3932 if ( $operation->{action} eq 'return' ) {
3933 $report = ProcessOfflineReturn( $operation );
3934 } elsif ( $operation->{action} eq 'issue' ) {
3935 $report = ProcessOfflineIssue( $operation );
3936 } elsif ( $operation->{action} eq 'payment' ) {
3937 $report = ProcessOfflinePayment( $operation );
3940 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3945 sub ProcessOfflineReturn {
3946 my $operation = shift;
3948 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3951 my $itemnumber = $item->itemnumber;
3952 my $issue = GetOpenIssue( $itemnumber );
3954 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3955 ModDateLastSeen( $itemnumber, $leave_item_lost );
3957 $issue->{borrowernumber},
3959 $operation->{timestamp},
3962 $item->onloan(undef);
3963 $item->store({ log_action => 0 });
3966 return "Item not issued.";
3969 return "Item not found.";
3973 sub ProcessOfflineIssue {
3974 my $operation = shift;
3976 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3979 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3981 return "Barcode not found.";
3983 my $itemnumber = $item->itemnumber;
3984 my $issue = GetOpenIssue( $itemnumber );
3986 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3988 $issue->{borrowernumber},
3990 $operation->{timestamp},
3995 $operation->{'barcode'},
3998 $operation->{timestamp},
4003 return "Borrower not found.";
4007 sub ProcessOfflinePayment {
4008 my $operation = shift;
4010 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4012 $patron->account->pay(
4014 amount => $operation->{amount},
4015 library_id => $operation->{branchcode},
4025 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4027 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4032 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4036 ? Koha::Items->find($itemnumber)
4037 : Koha::Items->find( { barcode => $barcode } );
4041 return C4::Letters::GetPreparedLetter (
4042 module => 'circulation',
4043 letter_code => 'TRANSFERSLIP',
4044 branchcode => $branch,
4046 'branches' => $to_branch,
4047 'biblio' => $item->biblionumber,
4048 'items' => $item->unblessed,
4053 =head2 CheckIfIssuedToPatron
4055 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4057 Return 1 if any record item is issued to patron, otherwise return 0
4061 sub CheckIfIssuedToPatron {
4062 my ($borrowernumber, $biblionumber) = @_;
4064 my $dbh = C4::Context->dbh;
4066 SELECT COUNT(*) FROM issues
4067 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4068 WHERE items.biblionumber = ?
4069 AND issues.borrowernumber = ?
4071 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4072 return 1 if $is_issued;
4078 IsItemIssued( $itemnumber )
4080 Return 1 if the item is on loan, otherwise return 0
4085 my $itemnumber = shift;
4086 my $dbh = C4::Context->dbh;
4087 my $sth = $dbh->prepare(q{
4090 WHERE itemnumber = ?
4092 $sth->execute($itemnumber);
4093 return $sth->fetchrow;
4096 =head2 GetAgeRestriction
4098 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4099 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4101 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4102 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4104 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4105 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4106 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4107 Negative days mean the borrower has gone past the age restriction age.
4111 sub GetAgeRestriction {
4112 my ($record_restrictions, $borrower) = @_;
4113 my $markers = C4::Context->preference('AgeRestrictionMarker');
4115 return unless $record_restrictions;
4116 # Split $record_restrictions to something like FSK 16 or PEGI 6
4117 my @values = split ' ', uc($record_restrictions);
4118 return unless @values;
4120 # Search first occurrence of one of the markers
4121 my @markers = split /\|/, uc($markers);
4122 return unless @markers;
4125 my $restriction_year = 0;
4126 for my $value (@values) {
4128 for my $marker (@markers) {
4129 $marker =~ s/^\s+//; #remove leading spaces
4130 $marker =~ s/\s+$//; #remove trailing spaces
4131 if ( $marker eq $value ) {
4132 if ( $index <= $#values ) {
4133 $restriction_year += $values[$index];
4137 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4139 # Perhaps it is something like "K16" (as in Finland)
4140 $restriction_year += $1;
4144 last if ( $restriction_year > 0 );
4147 #Check if the borrower is age restricted for this material and for how long.
4148 if ($restriction_year && $borrower) {
4149 if ( $borrower->{'dateofbirth'} ) {
4150 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4151 $alloweddate[0] += $restriction_year;
4153 #Prevent runime eror on leap year (invalid date)
4154 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4155 $alloweddate[2] = 28;
4158 #Get how many days the borrower has to reach the age restriction
4159 my @Today = split /-/, dt_from_string()->ymd();
4160 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4161 #Negative days means the borrower went past the age restriction age
4162 return ($restriction_year, $daysToAgeRestriction);
4166 return ($restriction_year);
4170 =head2 GetPendingOnSiteCheckouts
4174 sub GetPendingOnSiteCheckouts {
4175 my $dbh = C4::Context->dbh;
4176 return $dbh->selectall_arrayref(q|
4182 items.itemcallnumber,
4186 issues.date_due < NOW() AS is_overdue,
4189 borrowers.firstname,
4191 borrowers.cardnumber,
4192 borrowers.borrowernumber
4194 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4195 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4196 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4197 WHERE issues.onsite_checkout = 1
4198 |, { Slice => {} } );
4204 my ($count, $branch, $itemtype, $ccode, $newness)
4205 = @$params{qw(count branch itemtype ccode newness)};
4207 my $dbh = C4::Context->dbh;
4210 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4211 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4212 i.ccode, SUM(i.issues) AS count
4214 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4215 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4218 my (@where_strs, @where_args);
4221 push @where_strs, 'i.homebranch = ?';
4222 push @where_args, $branch;
4225 if (C4::Context->preference('item-level_itypes')){
4226 push @where_strs, 'i.itype = ?';
4227 push @where_args, $itemtype;
4229 push @where_strs, 'bi.itemtype = ?';
4230 push @where_args, $itemtype;
4234 push @where_strs, 'i.ccode = ?';
4235 push @where_args, $ccode;
4238 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4239 push @where_args, $newness;
4243 $query .= 'WHERE ' . join(' AND ', @where_strs);
4247 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4248 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4253 $query .= q{ ) xxx WHERE count > 0 };
4254 $count = int($count);
4256 $query .= "LIMIT $count";
4259 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4264 =head2 Internal methods
4268 sub _CalculateAndUpdateFine {
4271 my $borrower = $params->{borrower};
4272 my $item = $params->{item};
4273 my $issue = $params->{issue};
4274 my $return_date = $params->{return_date};
4276 unless ($borrower) { carp "No borrower passed in!" && return; }
4277 unless ($item) { carp "No item passed in!" && return; }
4278 unless ($issue) { carp "No issue passed in!" && return; }
4280 my $datedue = dt_from_string( $issue->date_due );
4282 # we only need to calculate and change the fines if we want to do that on return
4283 # Should be on for hourly loans
4284 my $control = C4::Context->preference('CircControl');
4285 my $control_branchcode =
4286 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4287 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4288 : $issue->branchcode;
4290 my $date_returned = $return_date ? $return_date : dt_from_string();
4292 my ( $amount, $unitcounttotal, $unitcount ) =
4293 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4295 if ( C4::Context->preference('finesMode') eq 'production' ) {
4296 if ( $amount > 0 ) {
4297 C4::Overdues::UpdateFine({
4298 issue_id => $issue->issue_id,
4299 itemnumber => $issue->itemnumber,
4300 borrowernumber => $issue->borrowernumber,
4302 due => output_pref($datedue),
4305 elsif ($return_date) {
4307 # Backdated returns may have fines that shouldn't exist,
4308 # so in this case, we need to drop those fines to 0
4310 C4::Overdues::UpdateFine({
4311 issue_id => $issue->issue_id,
4312 itemnumber => $issue->itemnumber,
4313 borrowernumber => $issue->borrowernumber,
4315 due => output_pref($datedue),
4321 sub _item_denied_renewal {
4324 my $item = $params->{item};
4325 return unless $item;
4327 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4328 return unless $denyingrules;
4329 foreach my $field (keys %$denyingrules) {
4330 my $val = $item->$field;
4331 if( !defined $val) {
4332 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4335 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4336 # If the results matches the values in the syspref
4337 # We return true if match found
4350 Koha Development Team <http://koha-community.org/>