1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX qw( floor );
32 use C4::ItemCirculationAlertPreference;
35 use C4::Log; # logaction
36 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits;
42 use Koha::AuthorisedValues;
43 use Koha::Biblioitems;
47 use Koha::Illrequests;
50 use Koha::Patron::Debarments;
53 use Koha::Account::Lines;
55 use Koha::Account::Lines;
56 use Koha::Account::Offsets;
57 use Koha::Config::SysPrefs;
58 use Koha::Charges::Fees;
59 use Koha::Config::SysPref;
60 use Koha::Checkouts::ReturnClaims;
61 use Koha::SearchEngine::Indexer;
63 use List::MoreUtils qw( uniq any );
64 use Scalar::Util qw( looks_like_number );
75 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
81 # FIXME subs that should probably be elsewhere
86 &GetPendingOnSiteCheckouts
89 # subs to deal with issuing a book
97 &GetLatestAutoRenewDate
99 &GetBranchBorrowerCircRule
102 &CheckIfIssuedToPatron
107 # subs to deal with returns
113 # subs to deal with transfers
120 &IsBranchTransferAllowed
121 &CreateBranchTransferLimit
122 &DeleteBranchTransferLimits
126 # subs to deal with offline circulation
128 &GetOfflineOperations
131 &DeleteOfflineOperation
132 &ProcessOfflineOperation
138 C4::Circulation - Koha circulation module
146 The functions in this module deal with circulation, issues, and
147 returns, as well as general information about the library.
148 Also deals with inventory.
154 $str = &barcodedecode($barcode, [$filter]);
156 Generic filter function for barcode string.
157 Called on every circ if the System Pref itemBarcodeInputFilter is set.
158 Will do some manipulation of the barcode for systems that deliver a barcode
159 to circulation.pl that differs from the barcode stored for the item.
160 For proper functioning of this filter, calling the function on the
161 correct barcode string (items.barcode) should return an unaltered barcode.
163 The optional $filter argument is to allow for testing or explicit
164 behavior that ignores the System Pref. Valid values are the same as the
169 # FIXME -- the &decode fcn below should be wrapped into this one.
170 # FIXME -- these plugins should be moved out of Circulation.pm
173 my ($barcode, $filter) = @_;
174 my $branch = C4::Context::mybranch();
175 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
176 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
177 if ($filter eq 'whitespace') {
179 } elsif ($filter eq 'cuecat') {
181 my @fields = split( /\./, $barcode );
182 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
183 ($#results == 2) and return $results[2];
184 } elsif ($filter eq 'T-prefix') {
185 if ($barcode =~ /^[Tt](\d)/) {
186 (defined($1) and $1 eq '0') and return $barcode;
187 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
189 return sprintf("T%07d", $barcode);
190 # FIXME: $barcode could be "T1", causing warning: substr outside of string
191 # Why drop the nonzero digit after the T?
192 # Why pass non-digits (or empty string) to "T%07d"?
193 } elsif ($filter eq 'libsuite8') {
194 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
195 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
196 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
198 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
201 } elsif ($filter eq 'EAN13') {
202 my $ean = CheckDigits('ean');
203 if ( $ean->is_valid($barcode) ) {
204 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
205 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
207 warn "# [$barcode] not valid EAN-13/UPC-A\n";
210 return $barcode; # return barcode, modified or not
215 $str = &decode($chunk);
217 Decodes a segment of a string emitted by a CueCat barcode scanner and
220 FIXME: Should be replaced with Barcode::Cuecat from CPAN
221 or Javascript based decoding on the client side.
228 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
229 my @s = map { index( $seq, $_ ); } split( //, $encoded );
230 my $l = ( $#s + 1 ) % 4;
233 # warn "Error: Cuecat decode parsing failed!";
241 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
243 chr( ( $n >> 16 ) ^ 67 )
244 .chr( ( $n >> 8 & 255 ) ^ 67 )
245 .chr( ( $n & 255 ) ^ 67 );
248 $r = substr( $r, 0, length($r) - $l );
254 ($dotransfer, $messages, $iteminformation) = &transferbook({
255 from_branch => $frombranch
256 to_branch => $tobranch,
258 ignore_reserves => $ignore_reserves,
262 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
264 C<$fbr> is the code for the branch initiating the transfer.
265 C<$tbr> is the code for the branch to which the item should be transferred.
267 C<$barcode> is the barcode of the item to be transferred.
269 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
270 Otherwise, if an item is reserved, the transfer fails.
272 C<$trigger> is the enum value for what triggered the transfer.
274 Returns three values:
280 is true if the transfer was successful.
284 is a reference-to-hash which may have any of the following keys:
290 There is no item in the catalog with the given barcode. The value is C<$barcode>.
292 =item C<DestinationEqualsHolding>
294 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
298 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
302 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
304 =item C<WasTransferred>
306 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
316 my $tbr = $params->{to_branch};
317 my $fbr = $params->{from_branch};
318 my $ignoreRs = $params->{ignore_reserves};
319 my $barcode = $params->{barcode};
320 my $trigger = $params->{trigger};
323 my $item = Koha::Items->find( { barcode => $barcode } );
325 Koha::Exceptions::MissingParameter->throw(
326 "Missing mandatory parameter: from_branch")
329 Koha::Exceptions::MissingParameter->throw(
330 "Missing mandatory parameter: to_branch")
335 $messages->{'BadBarcode'} = $barcode;
337 return ( $dotransfer, $messages );
340 my $itemnumber = $item->itemnumber;
341 # get branches of book...
342 my $hbr = $item->homebranch;
344 # if using Branch Transfer Limits
345 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
346 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
347 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
348 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
349 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
352 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
353 $messages->{'NotAllowed'} = $tbr . "::" . $code;
358 # can't transfer book if is already there....
359 if ( $fbr eq $tbr ) {
360 $messages->{'DestinationEqualsHolding'} = 1;
364 # check if it is still issued to someone, return it...
365 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
367 AddReturn( $barcode, $fbr );
368 $messages->{'WasReturned'} = $issue->borrowernumber;
372 # That'll save a database query.
373 my ( $resfound, $resrec, undef ) =
374 CheckReserves( $itemnumber );
375 if ( $resfound and not $ignoreRs ) {
376 $resrec->{'ResFound'} = $resfound;
377 $messages->{'ResFound'} = $resrec;
381 #actually do the transfer....
383 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
385 # don't need to update MARC anymore, we do it in batch now
386 $messages->{'WasTransfered'} = 1;
389 ModDateLastSeen( $itemnumber );
390 return ( $dotransfer, $messages );
395 my $borrower = shift;
396 my $item_object = shift;
398 my $onsite_checkout = $params->{onsite_checkout} || 0;
399 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
400 my $cat_borrower = $borrower->{'categorycode'};
401 my $dbh = C4::Context->dbh;
402 # Get which branchcode we need
403 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
404 my $type = $item_object->effective_itemtype;
406 my ($type_object, $parent_type, $parent_maxissueqty_rule);
407 $type_object = Koha::ItemTypes->find( $type );
408 $parent_type = $type_object->parent_type if $type_object;
409 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
410 # Find any children if we are a parent_type;
412 # given branch, patron category, and item type, determine
413 # applicable issuing rule
415 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
417 categorycode => $cat_borrower,
418 itemtype => $parent_type,
419 branchcode => $branch,
420 rule_name => 'maxissueqty',
423 # If the parent rule is for default type we discount it
424 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
426 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
428 categorycode => $cat_borrower,
430 branchcode => $branch,
431 rule_name => 'maxissueqty',
435 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
437 categorycode => $cat_borrower,
439 branchcode => $branch,
440 rule_name => 'maxonsiteissueqty',
445 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
446 # if a rule is found and has a loan limit set, count
447 # how many loans the patron already has that meet that
449 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
452 if ( $maxissueqty_rule->branchcode ) {
453 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
454 $checkouts = $patron->checkouts->search(
455 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
456 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
457 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
459 $checkouts = $patron->checkouts->search(
460 { 'item.homebranch' => $maxissueqty_rule->branchcode },
461 { prefetch => 'item' } );
464 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
467 my $rule_itemtype = $maxissueqty_rule->itemtype;
468 while ( my $c = $checkouts->next ) {
469 my $itemtype = $c->item->effective_itemtype;
471 unless ( $rule_itemtype ) {
472 # matching rule has the default item type, so count only
473 # those existing loans that don't fall under a more
475 @types = Koha::CirculationRules->search(
477 branchcode => $maxissueqty_rule->branchcode,
478 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
479 itemtype => { '!=' => undef },
480 rule_name => 'maxissueqty'
482 )->get_column('itemtype');
484 next if grep {$_ eq $itemtype} @types;
487 if ( $parent_maxissueqty_rule ) {
488 # if we have a parent item type then we count loans of the
489 # specific item type or its siblings or parent
490 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
491 @types = $children->get_column('itemtype');
492 push @types, $parent_type;
493 } elsif ( $child_types ) {
494 # If we are a parent type, we need to count all child types and our own type
495 @types = $child_types->get_column('itemtype');
496 push @types, $type; # And don't forget to count our own types
497 } else { push @types, $type; } # Otherwise only count the specific itemtype
499 next unless grep {$_ eq $itemtype} @types;
501 $sum_checkouts->{total}++;
502 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
503 $sum_checkouts->{itemtype}->{$itemtype}++;
506 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
507 my $checkout_count = $sum_checkouts->{total} || 0;
508 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
510 my $checkout_rules = {
511 checkout_count => $checkout_count,
512 onsite_checkout_count => $onsite_checkout_count,
513 onsite_checkout => $onsite_checkout,
514 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
515 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
516 switch_onsite_checkout => $switch_onsite_checkout,
518 # If parent rules exists
519 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
520 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
521 my $qty_over = _check_max_qty($checkout_rules);
522 return $qty_over if defined $qty_over;
524 # If the parent rule is less than or equal to the child, we only need check the parent
525 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
526 $checkout_rules->{checkout_count} = $checkout_count_type;
527 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
528 my $qty_over = _check_max_qty($checkout_rules);
529 return $qty_over if defined $qty_over;
532 my $qty_over = _check_max_qty($checkout_rules);
533 return $qty_over if defined $qty_over;
537 # Now count total loans against the limit for the branch
538 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
539 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
541 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
542 $checkouts = $patron->checkouts->search(
543 { 'me.branchcode' => $branch} );
544 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
545 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
547 $checkouts = $patron->checkouts->search(
548 { 'item.homebranch' => $branch},
549 { prefetch => 'item' } );
552 my $checkout_count = $checkouts->count;
553 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
554 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
555 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
557 my $qty_over = _check_max_qty(
559 checkout_count => $checkout_count,
560 onsite_checkout_count => $onsite_checkout_count,
561 onsite_checkout => $onsite_checkout,
562 max_checkouts_allowed => $max_checkouts_allowed,
563 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
564 switch_onsite_checkout => $switch_onsite_checkout
567 return $qty_over if defined $qty_over;
570 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
571 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
574 # OK, the patron can issue !!!
580 my $checkout_count = $params->{checkout_count};
581 my $onsite_checkout_count = $params->{onsite_checkout_count};
582 my $onsite_checkout = $params->{onsite_checkout};
583 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
584 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
585 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
587 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
588 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
589 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
591 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
592 count => $onsite_checkout_count,
593 max_allowed => $max_onsite_checkouts_allowed,
597 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
598 if ( $max_checkouts_allowed eq '' ) { return; }
599 my $delta = $switch_onsite_checkout ? 1 : 0;
600 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
602 reason => 'TOO_MANY_CHECKOUTS',
603 count => $checkout_count,
604 max_allowed => $max_checkouts_allowed,
608 elsif ( not $onsite_checkout ) {
609 if ( $max_checkouts_allowed eq '' ) { return; }
611 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
614 reason => 'TOO_MANY_CHECKOUTS',
615 count => $checkout_count - $onsite_checkout_count,
616 max_allowed => $max_checkouts_allowed,
624 =head2 CanBookBeIssued
626 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
627 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
629 Check if a book can be issued.
631 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
633 IMPORTANT: The assumption by users of this routine is that causes blocking
634 the issue are keyed by uppercase labels and other returned
635 data is keyed in lower case!
639 =item C<$patron> is a Koha::Patron
641 =item C<$barcode> is the bar code of the book being issued.
643 =item C<$duedates> is a DateTime object.
645 =item C<$inprocess> boolean switch
647 =item C<$ignore_reserves> boolean switch
649 =item C<$params> Hashref of additional parameters
652 override_high_holds - Ignore high holds
653 onsite_checkout - Checkout is an onsite checkout that will not leave the library
661 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
662 Possible values are :
668 sticky due date is invalid
672 borrower gone with no address
676 borrower declared it's card lost
682 =head3 UNKNOWN_BARCODE
696 item is restricted (set by ??)
698 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
699 could be prevented, but ones that can be overriden by the operator.
701 Possible values are :
709 renewing, not issuing
711 =head3 ISSUED_TO_ANOTHER
713 issued to someone else.
717 reserved for someone else.
721 sticky due date is invalid or due date in the past
725 if the borrower borrows to much things
729 sub CanBookBeIssued {
730 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
731 my %needsconfirmation; # filled with problems that needs confirmations
732 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
733 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
734 my %messages; # filled with information messages that should be displayed.
736 my $onsite_checkout = $params->{onsite_checkout} || 0;
737 my $override_high_holds = $params->{override_high_holds} || 0;
739 my $item_object = Koha::Items->find({barcode => $barcode });
741 # MANDATORY CHECKS - unless item exists, nothing else matters
742 unless ( $item_object ) {
743 $issuingimpossible{UNKNOWN_BARCODE} = 1;
745 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
747 my $item_unblessed = $item_object->unblessed; # Transition...
748 my $issue = $item_object->checkout;
749 my $biblio = $item_object->biblio;
751 my $biblioitem = $biblio->biblioitem;
752 my $effective_itemtype = $item_object->effective_itemtype;
753 my $dbh = C4::Context->dbh;
754 my $patron_unblessed = $patron->unblessed;
756 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
758 # DUE DATE is OK ? -- should already have checked.
760 if ($duedate && ref $duedate ne 'DateTime') {
761 $duedate = dt_from_string($duedate);
763 my $now = dt_from_string();
764 unless ( $duedate ) {
765 my $issuedate = $now->clone();
767 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
769 # Offline circ calls AddIssue directly, doesn't run through here
770 # So issuingimpossible should be ok.
773 my $fees = Koha::Charges::Fees->new(
776 library => $circ_library,
777 item => $item_object,
783 my $today = $now->clone();
784 $today->truncate( to => 'minute');
785 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
786 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
789 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
795 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
796 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
798 branch => C4::Context->userenv->{'branch'},
800 itemnumber => $item_object->itemnumber,
801 itemtype => $effective_itemtype,
802 borrowernumber => $patron->borrowernumber,
803 ccode => $item_object->ccode}
805 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
806 return( { STATS => 1 }, {});
809 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
810 $issuingimpossible{GNA} = 1;
813 if ( $patron->lost && $patron->lost == 1 ) {
814 $issuingimpossible{CARD_LOST} = 1;
816 if ( $patron->is_debarred ) {
817 $issuingimpossible{DEBARRED} = 1;
820 if ( $patron->is_expired ) {
821 $issuingimpossible{EXPIRED} = 1;
829 my $account = $patron->account;
830 my $balance = $account->balance;
831 my $non_issues_charges = $account->non_issues_charges;
832 my $other_charges = $balance - $non_issues_charges;
834 my $amountlimit = C4::Context->preference("noissuescharge");
835 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
836 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
838 # Check the debt of this patrons guarantees
839 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
840 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
841 if ( defined $no_issues_charge_guarantees ) {
842 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
843 my $guarantees_non_issues_charges;
844 foreach my $g ( @guarantees ) {
845 $guarantees_non_issues_charges += $g->account->non_issues_charges;
848 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
849 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
850 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
851 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
852 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
853 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
857 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
858 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
859 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
860 if ( defined $no_issues_charge_guarantors ) {
861 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
863 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
864 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
865 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
866 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
867 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
868 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
872 if ( C4::Context->preference("IssuingInProcess") ) {
873 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
874 $issuingimpossible{DEBT} = $non_issues_charges;
875 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
876 $needsconfirmation{DEBT} = $non_issues_charges;
877 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
878 $needsconfirmation{DEBT} = $non_issues_charges;
882 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
883 $needsconfirmation{DEBT} = $non_issues_charges;
884 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
885 $issuingimpossible{DEBT} = $non_issues_charges;
886 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
887 $needsconfirmation{DEBT} = $non_issues_charges;
891 if ($balance > 0 && $other_charges > 0) {
892 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
895 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
896 $patron_unblessed = $patron->unblessed;
898 if ( my $debarred_date = $patron->is_debarred ) {
899 # patron has accrued fine days or has a restriction. $count is a date
900 if ($debarred_date eq '9999-12-31') {
901 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
904 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
906 } elsif ( my $num_overdues = $patron->has_overdues ) {
907 ## patron has outstanding overdue loans
908 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
909 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
911 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
912 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
916 # Additional Materials Check
917 if ( C4::Context->preference("CircConfirmItemParts")
918 && $item_object->materials )
920 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
924 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
926 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
928 # Already issued to current borrower.
929 # If it is an on-site checkout if it can be switched to a normal checkout
930 # or ask whether the loan should be renewed
932 if ( $issue->onsite_checkout
933 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
934 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
936 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
937 $patron->borrowernumber,
938 $item_object->itemnumber,
940 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
941 if ( $renewerror eq 'onsite_checkout' ) {
942 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
945 $issuingimpossible{NO_MORE_RENEWALS} = 1;
949 $needsconfirmation{RENEW_ISSUE} = 1;
955 # issued to someone else
957 my $patron = Koha::Patrons->find( $issue->borrowernumber );
959 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
961 unless ( $can_be_returned ) {
962 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
963 $issuingimpossible{branch_to_return} = $message;
965 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
966 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
968 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
969 $needsconfirmation{issued_firstname} = $patron->firstname;
970 $needsconfirmation{issued_surname} = $patron->surname;
971 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
972 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
977 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
979 my $switch_onsite_checkout = (
980 C4::Context->preference('SwitchOnSiteCheckouts')
982 and $issue->onsite_checkout
983 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
984 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
985 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
986 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
987 if ( $toomany->{max_allowed} == 0 ) {
988 $needsconfirmation{PATRON_CANT} = 1;
990 if ( C4::Context->preference("AllowTooManyOverride") ) {
991 $needsconfirmation{TOO_MANY} = $toomany->{reason};
992 $needsconfirmation{current_loan_count} = $toomany->{count};
993 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
995 $issuingimpossible{TOO_MANY} = $toomany->{reason};
996 $issuingimpossible{current_loan_count} = $toomany->{count};
997 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1002 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1004 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1005 my $wants_check = $patron->wants_check_for_previous_checkout;
1006 $needsconfirmation{PREVISSUE} = 1
1007 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1012 if ( $item_object->notforloan )
1014 if(!C4::Context->preference("AllowNotForLoanOverride")){
1015 $issuingimpossible{NOT_FOR_LOAN} = 1;
1016 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1018 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1019 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1023 # we have to check itemtypes.notforloan also
1024 if (C4::Context->preference('item-level_itypes')){
1025 # this should probably be a subroutine
1026 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1027 $sth->execute($effective_itemtype);
1028 my $notforloan=$sth->fetchrow_hashref();
1029 if ($notforloan->{'notforloan'}) {
1030 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1031 $issuingimpossible{NOT_FOR_LOAN} = 1;
1032 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1034 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1035 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1040 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1041 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1042 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1043 $issuingimpossible{NOT_FOR_LOAN} = 1;
1044 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1046 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1047 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1052 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1054 $issuingimpossible{WTHDRAWN} = 1;
1056 if ( $item_object->restricted
1057 && $item_object->restricted == 1 )
1059 $issuingimpossible{RESTRICTED} = 1;
1061 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1062 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1063 my $code = $av->count ? $av->next->lib : '';
1064 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1065 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1067 if ( C4::Context->preference("IndependentBranches") ) {
1068 my $userenv = C4::Context->userenv;
1069 unless ( C4::Context->IsSuperLibrarian() ) {
1070 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1071 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1072 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1073 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1075 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1076 if ( $patron->branchcode ne $userenv->{branch} );
1081 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1083 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1084 if ($rentalConfirmation) {
1085 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1087 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1088 if ($itemtype_object) {
1089 my $accumulate_charge = $fees->accumulate_rentalcharge();
1090 if ( $accumulate_charge > 0 ) {
1091 $rentalCharge += $accumulate_charge;
1095 if ( $rentalCharge > 0 ) {
1096 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1100 unless ( $ignore_reserves ) {
1101 # See if the item is on reserve.
1102 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1104 my $resbor = $res->{'borrowernumber'};
1105 if ( $resbor ne $patron->borrowernumber ) {
1106 my $patron = Koha::Patrons->find( $resbor );
1107 if ( $restype eq "Waiting" )
1109 # The item is on reserve and waiting, but has been
1110 # reserved by some other patron.
1111 $needsconfirmation{RESERVE_WAITING} = 1;
1112 $needsconfirmation{'resfirstname'} = $patron->firstname;
1113 $needsconfirmation{'ressurname'} = $patron->surname;
1114 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1115 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1116 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1117 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1118 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1120 elsif ( $restype eq "Reserved" ) {
1121 # The item is on reserve for someone else.
1122 $needsconfirmation{RESERVED} = 1;
1123 $needsconfirmation{'resfirstname'} = $patron->firstname;
1124 $needsconfirmation{'ressurname'} = $patron->surname;
1125 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1126 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1127 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1128 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1129 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1135 ## CHECK AGE RESTRICTION
1136 my $agerestriction = $biblioitem->agerestriction;
1137 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1138 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1139 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1140 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1143 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1147 ## check for high holds decreasing loan period
1148 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1149 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1151 if ( $check->{exceeded} ) {
1152 if ($override_high_holds) {
1153 $alerts{HIGHHOLDS} = {
1154 num_holds => $check->{outstanding},
1155 duration => $check->{duration},
1156 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1160 $needsconfirmation{HIGHHOLDS} = {
1161 num_holds => $check->{outstanding},
1162 duration => $check->{duration},
1163 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1170 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1171 # don't do the multiple loans per bib check if we've
1172 # already determined that we've got a loan on the same item
1173 !$issuingimpossible{NO_MORE_RENEWALS} &&
1174 !$needsconfirmation{RENEW_ISSUE}
1176 # Check if borrower has already issued an item from the same biblio
1177 # Only if it's not a subscription
1178 my $biblionumber = $item_object->biblionumber;
1179 require C4::Serials;
1180 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1181 unless ($is_a_subscription) {
1182 # FIXME Should be $patron->checkouts($args);
1183 my $checkouts = Koha::Checkouts->search(
1185 borrowernumber => $patron->borrowernumber,
1186 biblionumber => $biblionumber,
1192 # if we get here, we don't already have a loan on this item,
1193 # so if there are any loans on this bib, ask for confirmation
1194 if ( $checkouts->count ) {
1195 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1200 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1203 =head2 CanBookBeReturned
1205 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1207 Check whether the item can be returned to the provided branch
1211 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1213 =item C<$branch> is the branchcode where the return is taking place
1221 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1223 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1229 sub CanBookBeReturned {
1230 my ($item, $branch) = @_;
1231 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1233 # assume return is allowed to start
1237 # identify all cases where return is forbidden
1238 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1240 $message = $item->{'homebranch'};
1241 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1243 $message = $item->{'holdingbranch'};
1244 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1246 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1249 return ($allowed, $message);
1252 =head2 CheckHighHolds
1254 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1255 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1256 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1260 sub checkHighHolds {
1261 my ( $item, $borrower ) = @_;
1262 my $branchcode = _GetCircControlBranch( $item, $borrower );
1263 my $item_object = Koha::Items->find( $item->{itemnumber} );
1272 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1274 if ( $holds->count() ) {
1275 $return_data->{outstanding} = $holds->count();
1277 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1278 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1279 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1281 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1283 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1285 # static means just more than a given number of holds on the record
1287 # If the number of holds is less than the threshold, we can stop here
1288 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1289 return $return_data;
1292 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1294 # dynamic means X more than the number of holdable items on the record
1296 # let's get the items
1297 my @items = $holds->next()->biblio()->items()->as_list;
1299 # Remove any items with status defined to be ignored even if the would not make item unholdable
1300 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1301 @items = grep { !$_->$status } @items;
1304 # Remove any items that are not holdable for this patron
1305 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1307 my $items_count = scalar @items;
1309 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1311 # If the number of holds is less than the count of items we have
1312 # plus the number of holds allowed above that count, we can stop here
1313 if ( $holds->count() <= $threshold ) {
1314 return $return_data;
1318 my $issuedate = dt_from_string();
1320 my $itype = $item_object->effective_itemtype;
1321 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1323 categorycode => $borrower->{categorycode},
1325 branchcode => $branchcode,
1328 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1330 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1332 my $rule = Koha::CirculationRules->get_effective_rule(
1334 categorycode => $borrower->{categorycode},
1335 itemtype => $item_object->effective_itemtype,
1336 branchcode => $branchcode,
1337 rule_name => 'decreaseloanholds',
1342 if ( defined($rule) && $rule->rule_value ne '' ){
1343 # overrides decreaseLoanHighHoldsDuration syspref
1344 $duration = $rule->rule_value;
1346 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1348 my $reduced_datedue = $calendar->addDate( $issuedate, $duration );
1349 $reduced_datedue->set_hour($orig_due->hour);
1350 $reduced_datedue->set_minute($orig_due->minute);
1351 $reduced_datedue->truncate( to => 'minute' );
1353 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1354 $return_data->{exceeded} = 1;
1355 $return_data->{duration} = $duration;
1356 $return_data->{due_date} = $reduced_datedue;
1360 return $return_data;
1365 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1367 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1371 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1373 =item C<$barcode> is the barcode of the item being issued.
1375 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1376 Calculated if empty.
1378 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1380 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1381 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1383 AddIssue does the following things :
1385 - step 01: check that there is a borrowernumber & a barcode provided
1386 - check for RENEWAL (book issued & being issued to the same patron)
1387 - renewal YES = Calculate Charge & renew
1389 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1391 - fill reserve if reserve to this patron
1392 - cancel reserve or not, otherwise
1393 * TRANSFERT PENDING ?
1394 - complete the transfert
1402 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1404 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1405 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1406 my $auto_renew = $params && $params->{auto_renew};
1407 my $dbh = C4::Context->dbh;
1408 my $barcodecheck = CheckValidBarcode($barcode);
1412 if ( $datedue && ref $datedue ne 'DateTime' ) {
1413 $datedue = dt_from_string($datedue);
1416 # $issuedate defaults to today.
1417 if ( !defined $issuedate ) {
1418 $issuedate = dt_from_string();
1421 if ( ref $issuedate ne 'DateTime' ) {
1422 $issuedate = dt_from_string($issuedate);
1427 # Stop here if the patron or barcode doesn't exist
1428 if ( $borrower && $barcode && $barcodecheck ) {
1429 # find which item we issue
1430 my $item_object = Koha::Items->find({ barcode => $barcode })
1431 or return; # if we don't get an Item, abort.
1432 my $item_unblessed = $item_object->unblessed;
1434 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1436 # get actual issuing if there is one
1437 my $actualissue = $item_object->checkout;
1439 # check if we just renew the issue.
1440 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1441 and not $switch_onsite_checkout ) {
1442 $datedue = AddRenewal(
1443 $borrower->{'borrowernumber'},
1444 $item_object->itemnumber,
1447 $issuedate, # here interpreted as the renewal date
1452 my $itype = $item_object->effective_itemtype;
1453 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1456 $datedue->truncate( to => 'minute' );
1458 my $patron = Koha::Patrons->find( $borrower );
1459 my $library = Koha::Libraries->find( $branchcode );
1460 my $fees = Koha::Charges::Fees->new(
1463 library => $library,
1464 item => $item_object,
1465 to_date => $datedue,
1469 # it's NOT a renewal
1470 if ( $actualissue and not $switch_onsite_checkout ) {
1471 # This book is currently on loan, but not to the person
1472 # who wants to borrow it now. mark it returned before issuing to the new borrower
1473 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1474 return unless $allowed;
1475 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1478 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1480 # Starting process for transfer job (checking transfert and validate it if we have one)
1481 if ( my $transfer = $item_object->get_transfer ) {
1482 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1485 datearrived => dt_from_string,
1486 tobranch => C4::Context->userenv->{branch},
1487 comments => 'Forced branchtransfer'
1490 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1491 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1492 if ( $hold ) { # Is this really needed?
1493 $hold->set( { found => undef } )->store;
1494 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1499 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1500 unless ($auto_renew) {
1501 my $rule = Koha::CirculationRules->get_effective_rule(
1503 categorycode => $borrower->{categorycode},
1504 itemtype => $item_object->effective_itemtype,
1505 branchcode => $branchcode,
1506 rule_name => 'auto_renew'
1510 $auto_renew = $rule->rule_value if $rule;
1513 my $issue_attributes = {
1514 borrowernumber => $borrower->{'borrowernumber'},
1515 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1516 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1517 branchcode => C4::Context->userenv->{'branch'},
1518 onsite_checkout => $onsite_checkout,
1519 auto_renew => $auto_renew ? 1 : 0,
1522 # Get ID of logged in user. if called from a batch job,
1523 # no user session exists and C4::Context->userenv() returns
1524 # the scalar '0'. Only do this if the syspref says so
1525 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1526 my $userenv = C4::Context->userenv();
1527 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1529 $issue_attributes->{issuer_id} = $usernumber;
1533 # In the case that the borrower has an on-site checkout
1534 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1535 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1537 $issue->set($issue_attributes)->store;
1540 $issue = Koha::Checkout->new(
1542 itemnumber => $item_object->itemnumber,
1547 $issue->discard_changes;
1548 if ( $item_object->location && $item_object->location eq 'CART'
1549 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1550 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1551 CartToShelf( $item_object->itemnumber );
1554 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1555 UpdateTotalIssues( $item_object->biblionumber, 1 );
1558 # Record if item was lost
1559 my $was_lost = $item_object->itemlost;
1561 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1562 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1563 $item_object->itemlost(0);
1564 $item_object->onloan($datedue->ymd());
1565 $item_object->datelastborrowed( dt_from_string()->ymd() );
1566 $item_object->datelastseen( dt_from_string()->ymd() );
1567 $item_object->store({log_action => 0});
1569 # If the item was lost, it has now been found, charge the overdue if necessary
1571 if ( $item_object->{_charge} ) {
1572 $actualissue //= Koha::Old::Checkouts->search(
1573 { itemnumber => $item_unblessed->{itemnumber} },
1575 order_by => { '-desc' => 'returndate' },
1579 unless ( exists( $borrower->{branchcode} ) ) {
1580 my $patron = $actualissue->patron;
1581 $borrower = $patron->unblessed;
1583 _CalculateAndUpdateFine(
1585 issue => $actualissue,
1586 item => $item_unblessed,
1587 borrower => $borrower,
1588 return_date => $issuedate
1591 _FixOverduesOnReturn( $borrower->{borrowernumber},
1592 $item_object->itemnumber, undef, 'RENEWED' );
1596 # If it costs to borrow this book, charge it to the patron's account.
1597 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1598 if ( $charge && $charge > 0 ) {
1599 AddIssuingCharge( $issue, $charge, 'RENT' );
1602 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1603 if ( $itemtype_object ) {
1604 my $accumulate_charge = $fees->accumulate_rentalcharge();
1605 if ( $accumulate_charge > 0 ) {
1606 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1607 $charge += $accumulate_charge;
1608 $item_unblessed->{charge} = $charge;
1612 # Record the fact that this book was issued.
1615 branch => C4::Context->userenv->{'branch'},
1616 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1618 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1619 itemnumber => $item_object->itemnumber,
1620 itemtype => $item_object->effective_itemtype,
1621 location => $item_object->location,
1622 borrowernumber => $borrower->{'borrowernumber'},
1623 ccode => $item_object->ccode,
1627 # Send a checkout slip.
1628 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1630 branchcode => $branchcode,
1631 categorycode => $borrower->{categorycode},
1632 item_type => $item_object->effective_itemtype,
1633 notification => 'CHECKOUT',
1635 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1636 SendCirculationAlert(
1639 item => $item_object->unblessed,
1640 borrower => $borrower,
1641 branch => $branchcode,
1646 "CIRCULATION", "ISSUE",
1647 $borrower->{'borrowernumber'},
1648 $item_object->itemnumber,
1649 ) if C4::Context->preference("IssueLog");
1651 Koha::Plugins->call('after_circ_action', {
1652 action => 'checkout',
1654 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1655 checkout => $issue->get_from_storage
1663 =head2 GetLoanLength
1665 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1667 Get loan length for an itemtype, a borrower type and a branch
1672 my ( $categorycode, $itemtype, $branchcode ) = @_;
1674 # Initialize default values
1678 lengthunit => 'days',
1681 my $found = Koha::CirculationRules->get_effective_rules( {
1682 branchcode => $branchcode,
1683 categorycode => $categorycode,
1684 itemtype => $itemtype,
1693 foreach my $rule_name (keys %$found) {
1694 $rules->{$rule_name} = $found->{$rule_name};
1701 =head2 GetHardDueDate
1703 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1705 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1709 sub GetHardDueDate {
1710 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1712 my $rules = Koha::CirculationRules->get_effective_rules(
1714 categorycode => $borrowertype,
1715 itemtype => $itemtype,
1716 branchcode => $branchcode,
1717 rules => [ 'hardduedate', 'hardduedatecompare' ],
1721 if ( defined( $rules->{hardduedate} ) ) {
1722 if ( $rules->{hardduedate} ) {
1723 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1726 return ( undef, undef );
1731 =head2 GetBranchBorrowerCircRule
1733 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1735 Retrieves circulation rule attributes that apply to the given
1736 branch and patron category, regardless of item type.
1737 The return value is a hashref containing the following key:
1739 patron_maxissueqty - maximum number of loans that a
1740 patron of the given category can have at the given
1741 branch. If the value is undef, no limit.
1743 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1744 patron of the given category can have at the given
1745 branch. If the value is undef, no limit.
1747 This will check for different branch/category combinations in the following order:
1751 default branch and category
1753 If no rule has been found in the database, it will default to
1756 patron_maxissueqty - undef
1757 patron_maxonsiteissueqty - undef
1759 C<$branchcode> and C<$categorycode> should contain the
1760 literal branch code and patron category code, respectively - no
1765 sub GetBranchBorrowerCircRule {
1766 my ( $branchcode, $categorycode ) = @_;
1768 # Initialize default values
1770 patron_maxissueqty => undef,
1771 patron_maxonsiteissueqty => undef,
1775 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1776 my $rule = Koha::CirculationRules->get_effective_rule(
1778 categorycode => $categorycode,
1780 branchcode => $branchcode,
1781 rule_name => $rule_name,
1785 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1791 =head2 GetBranchItemRule
1793 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1795 Retrieves circulation rule attributes that apply to the given
1796 branch and item type, regardless of patron category.
1798 The return value is a hashref containing the following keys:
1800 holdallowed => Hold policy for this branch and itemtype. Possible values:
1801 0: No holds allowed.
1802 1: Holds allowed only by patrons that have the same homebranch as the item.
1803 2: Holds allowed from any patron.
1805 returnbranch => branch to which to return item. Possible values:
1806 noreturn: do not return, let item remain where checked in (floating collections)
1807 homebranch: return to item's home branch
1808 holdingbranch: return to issuer branch
1810 This searches branchitemrules in the following order:
1812 * Same branchcode and itemtype
1813 * Same branchcode, itemtype '*'
1814 * branchcode '*', same itemtype
1815 * branchcode and itemtype '*'
1817 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1821 sub GetBranchItemRule {
1822 my ( $branchcode, $itemtype ) = @_;
1825 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1827 branchcode => $branchcode,
1828 itemtype => $itemtype,
1829 rule_name => 'holdallowed',
1832 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1834 branchcode => $branchcode,
1835 itemtype => $itemtype,
1836 rule_name => 'hold_fulfillment_policy',
1839 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1841 branchcode => $branchcode,
1842 itemtype => $itemtype,
1843 rule_name => 'returnbranch',
1847 # built-in default circulation rule
1849 $rules->{holdallowed} = defined $holdallowed_rule
1850 ? $holdallowed_rule->rule_value
1852 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1853 ? $hold_fulfillment_policy_rule->rule_value
1855 $rules->{returnbranch} = defined $returnbranch_rule
1856 ? $returnbranch_rule->rule_value
1864 ($doreturn, $messages, $iteminformation, $borrower) =
1865 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1871 =item C<$barcode> is the bar code of the book being returned.
1873 =item C<$branch> is the code of the branch where the book is being returned.
1875 =item C<$exemptfine> indicates that overdue charges for the item will be
1878 =item C<$return_date> allows the default return date to be overridden
1879 by the given return date. Optional.
1883 C<&AddReturn> returns a list of four items:
1885 C<$doreturn> is true iff the return succeeded.
1887 C<$messages> is a reference-to-hash giving feedback on the operation.
1888 The keys of the hash are:
1894 No item with this barcode exists. The value is C<$barcode>.
1898 The book is not currently on loan. The value is C<$barcode>.
1902 This book has been withdrawn/cancelled. The value should be ignored.
1904 =item C<Wrongbranch>
1906 This book has was returned to the wrong branch. The value is a hashref
1907 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1908 contain the branchcode of the incorrect and correct return library, respectively.
1912 The item was reserved. The value is a reference-to-hash whose keys are
1913 fields from the reserves table of the Koha database, and
1914 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1915 either C<Waiting>, C<Reserved>, or 0.
1917 =item C<WasReturned>
1919 Value 1 if return is successful.
1921 =item C<NeedsTransfer>
1923 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1927 C<$iteminformation> is a reference-to-hash, giving information about the
1928 returned item from the issues table.
1930 C<$borrower> is a reference-to-hash, giving information about the
1931 patron who last borrowed the book.
1936 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1938 if ($branch and not Koha::Libraries->find($branch)) {
1939 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1942 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1943 my $return_date_specified = !!$return_date;
1944 $return_date //= dt_from_string();
1948 my $validTransfer = 1;
1949 my $stat_type = 'return';
1951 # get information on item
1952 my $item = Koha::Items->find({ barcode => $barcode });
1954 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1957 my $itemnumber = $item->itemnumber;
1958 my $itemtype = $item->effective_itemtype;
1960 my $issue = $item->checkout;
1962 $patron = $issue->patron
1963 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1964 . Dumper($issue->unblessed) . "\n";
1966 $messages->{'NotIssued'} = $barcode;
1967 $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
1969 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1971 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1972 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1973 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1974 $messages->{'LocalUse'} = 1;
1975 $stat_type = 'localuse';
1979 # full item data, but no borrowernumber or checkout info (no issue)
1980 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1981 # get the proper branch to which to return the item
1982 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1983 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1984 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1986 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1987 my $patron_unblessed = $patron ? $patron->unblessed : {};
1989 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
1990 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1991 if ($update_loc_rules) {
1992 if (defined $update_loc_rules->{_ALL_}) {
1993 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1994 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1995 if ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) {
1996 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1997 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2001 foreach my $key ( keys %$update_loc_rules ) {
2002 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2003 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2004 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2005 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2006 $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2013 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2015 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2017 eval { $rules = YAML::Load($yaml); };
2019 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2022 foreach my $key ( keys %$rules ) {
2023 if ( $item->notforloan eq $key ) {
2024 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2025 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2032 # check if the return is allowed at this branch
2033 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2034 unless ($returnallowed){
2035 $messages->{'Wrongbranch'} = {
2036 Wrongbranch => $branch,
2037 Rightbranch => $message
2040 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2041 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2042 return ( $doreturn, $messages, $issue, $patron_unblessed);
2045 if ( $item->withdrawn ) { # book has been cancelled
2046 $messages->{'withdrawn'} = 1;
2047 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2050 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2054 # case of a return of document (deal with issues and holdingbranch)
2056 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2057 $patron or warn "AddReturn without current borrower";
2061 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2066 C4::Context->preference('CalculateFinesOnReturn')
2067 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2072 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2075 carp "The checkin for the following issue failed, Please go to the about page, section 'data corrupted' to know how to fix this problem ($@)" . Dumper( $issue->unblessed );
2077 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2078 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2080 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2083 # FIXME is the "= 1" right? This could be the borrower hash.
2084 $messages->{'WasReturned'} = 1;
2087 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2091 # the holdingbranch is updated if the document is returned to another location.
2092 # this is always done regardless of whether the item was on loan or not
2093 if ($item->holdingbranch ne $branch) {
2094 $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2097 my $item_was_lost = $item->itemlost;
2098 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2099 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2101 # fix up the accounts.....
2102 if ($item_was_lost) {
2103 $messages->{'WasLost'} = 1;
2104 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2105 $messages->{'LostItemFeeRefunded'} = $updated_item->{_refunded};
2106 $messages->{'LostItemFeeRestored'} = $updated_item->{_restored};
2108 if ( $updated_item->{_charge} ) {
2109 $issue //= Koha::Old::Checkouts->search(
2110 { itemnumber => $item->itemnumber },
2111 { order_by => { '-desc' => 'returndate' }, rows => 1 } )
2113 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2114 my $patron = $issue->patron;
2115 $patron_unblessed = $patron->unblessed;
2117 _CalculateAndUpdateFine(
2120 item => $item->unblessed,
2121 borrower => $patron_unblessed,
2122 return_date => $return_date
2125 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2126 $item->itemnumber, undef, 'RETURNED' );
2127 $messages->{'LostItemFeeCharged'} = 1;
2132 # check if we have a transfer for this document
2133 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2135 # if we have a transfer to complete, we update the line of transfers with the datearrived
2136 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2138 # At this point we will either fill the transfer or it is a wrong transfer
2139 # either way we should not now generate a new transfer
2141 if ( $tobranch eq $branch ) {
2142 my $sth = C4::Context->dbh->prepare(
2143 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2145 $sth->execute( $item->itemnumber );
2146 $messages->{'TransferArrived'} = $frombranch;
2148 $messages->{'WrongTransfer'} = $tobranch;
2149 $messages->{'WrongTransferItem'} = $item->itemnumber;
2153 # fix up the overdues in accounts...
2154 if ($borrowernumber) {
2155 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2156 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2158 if ( $issue and $issue->is_overdue($return_date) ) {
2160 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2162 $messages->{'PrevDebarred'} = $debardate;
2164 $messages->{'Debarred'} = $debardate if $debardate;
2166 # there's no overdue on the item but borrower had been previously debarred
2167 } elsif ( $issue->date_due and $patron->debarred ) {
2168 if ( $patron->debarred eq "9999-12-31") {
2169 $messages->{'ForeverDebarred'} = $patron->debarred;
2171 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2172 $borrower_debar_dt->truncate(to => 'day');
2173 my $today_dt = $return_date->clone()->truncate(to => 'day');
2174 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2175 $messages->{'PrevDebarred'} = $patron->debarred;
2181 # find reserves.....
2182 # launch the Checkreserves routine to find any holds
2183 my ($resfound, $resrec);
2184 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2185 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2186 # 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)
2187 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2188 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2189 $resfound = 'Reserved';
2190 $resrec = $hold->unblessed;
2193 $resrec->{'ResFound'} = $resfound;
2194 $messages->{'ResFound'} = $resrec;
2197 # Record the fact that this book was returned.
2201 itemnumber => $itemnumber,
2202 itemtype => $itemtype,
2203 location => $item->location,
2204 borrowernumber => $borrowernumber,
2205 ccode => $item->ccode,
2208 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2210 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2212 branchcode => $branch,
2213 categorycode => $patron->categorycode,
2214 item_type => $itemtype,
2215 notification => 'CHECKIN',
2217 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2218 SendCirculationAlert({
2220 item => $item->unblessed,
2221 borrower => $patron->unblessed,
2226 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2227 if C4::Context->preference("ReturnLog");
2230 # Check if this item belongs to a biblio record that is attached to an
2231 # ILL request, if it is we need to update the ILL request's status
2232 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2233 my $request = Koha::Illrequests->find(
2234 { biblio_id => $item->biblio->biblionumber }
2236 $request->status('RET') if $request;
2239 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2240 if ($validTransfer && !$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) ){
2241 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2242 if (C4::Context->preference("AutomaticItemReturn" ) or
2243 (C4::Context->preference("UseBranchTransferLimits") and
2244 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2246 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2247 $debug and warn "item: " . Dumper($item->unblessed);
2248 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2249 $messages->{'WasTransfered'} = 1;
2251 $messages->{'NeedsTransfer'} = $returnbranch;
2252 $messages->{'TransferTrigger'} = $transfer_trigger;
2256 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2257 my $claims = Koha::Checkouts::ReturnClaims->search(
2259 itemnumber => $item->id,
2260 resolution => undef,
2264 if ( $claims->count ) {
2265 $messages->{ReturnClaims} = $claims;
2269 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2270 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2272 if ( $doreturn and $issue ) {
2273 my $checkin = Koha::Old::Checkouts->find($issue->id);
2275 Koha::Plugins->call('after_circ_action', {
2276 action => 'checkin',
2283 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2286 =head2 MarkIssueReturned
2288 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2290 Unconditionally marks an issue as being returned by
2291 moving the C<issues> row to C<old_issues> and
2292 setting C<returndate> to the current date.
2294 if C<$returndate> is specified (in iso format), it is used as the date
2297 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2298 the old_issue is immediately anonymised
2300 Ideally, this function would be internal to C<C4::Circulation>,
2301 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2302 and offline_circ/process_koc.pl.
2304 The last optional parameter allos passing skip_record_index to the item store call.
2308 sub MarkIssueReturned {
2309 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2311 # Retrieve the issue
2312 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2314 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2316 my $issue_id = $issue->issue_id;
2318 my $anonymouspatron;
2319 if ( $privacy && $privacy == 2 ) {
2320 # The default of 0 will not work due to foreign key constraints
2321 # The anonymisation will fail if AnonymousPatron is not a valid entry
2322 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2323 # Note that a warning should appear on the about page (System information tab).
2324 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2325 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."
2326 unless Koha::Patrons->find( $anonymouspatron );
2329 my $schema = Koha::Database->schema;
2331 # FIXME Improve the return value and handle it from callers
2332 $schema->txn_do(sub {
2334 my $patron = Koha::Patrons->find( $borrowernumber );
2336 # Update the returndate value
2337 if ( $returndate ) {
2338 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2341 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2344 # Create the old_issues entry
2345 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2347 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2348 if ( $privacy && $privacy == 2) {
2349 $old_checkout->borrowernumber($anonymouspatron)->store;
2352 # And finally delete the issue
2355 $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2357 if ( C4::Context->preference('StoreLastBorrower') ) {
2358 my $item = Koha::Items->find( $itemnumber );
2359 $item->last_returned_by( $patron );
2362 # Remove any OVERDUES related debarment if the borrower has no overdues
2363 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2364 && $patron->debarred
2365 && !$patron->has_overdues
2366 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2368 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2376 =head2 _debar_user_on_return
2378 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2380 C<$borrower> borrower hashref
2382 C<$item> item hashref
2384 C<$datedue> date due DateTime object
2386 C<$returndate> DateTime object representing the return time
2388 Internal function, called only by AddReturn that calculates and updates
2389 the user fine days, and debars them if necessary.
2391 Should only be called for overdue returns
2393 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2398 sub _calculate_new_debar_dt {
2399 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2401 my $branchcode = _GetCircControlBranch( $item, $borrower );
2402 my $circcontrol = C4::Context->preference('CircControl');
2403 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2404 { categorycode => $borrower->{categorycode},
2405 itemtype => $item->{itype},
2406 branchcode => $branchcode,
2411 'maxsuspensiondays',
2412 'suspension_chargeperiod',
2416 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2417 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2418 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2420 return unless $finedays;
2422 # finedays is in days, so hourly loans must multiply by 24
2423 # thus 1 hour late equals 1 day suspension * finedays rate
2424 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2426 # grace period is measured in the same units as the loan
2428 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2430 my $deltadays = DateTime::Duration->new(
2431 days => $chargeable_units
2434 if ( $deltadays->subtract($grace)->is_positive() ) {
2435 my $suspension_days = $deltadays * $finedays;
2437 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2438 # No need to / 1 and do not consider / 0
2439 $suspension_days = DateTime::Duration->new(
2440 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2444 # If the max suspension days is < than the suspension days
2445 # the suspension days is limited to this maximum period.
2446 my $max_sd = $issuing_rule->{maxsuspensiondays};
2447 if ( defined $max_sd && $max_sd ne '' ) {
2448 $max_sd = DateTime::Duration->new( days => $max_sd );
2449 $suspension_days = $max_sd
2450 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2453 my ( $has_been_extended );
2454 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2455 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2457 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2458 $has_been_extended = 1;
2463 # Use the calendar or not to calculate the debarment date
2464 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2465 my $calendar = Koha::Calendar->new(
2466 branchcode => $branchcode,
2467 days_mode => 'Calendar'
2469 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2472 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2474 return $new_debar_dt;
2479 sub _debar_user_on_return {
2480 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2482 $return_date //= dt_from_string();
2484 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2486 return unless $new_debar_dt;
2488 Koha::Patron::Debarments::AddUniqueDebarment({
2489 borrowernumber => $borrower->{borrowernumber},
2490 expiration => $new_debar_dt->ymd(),
2491 type => 'SUSPENSION',
2493 # if borrower was already debarred but does not get an extra debarment
2494 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2495 my ($new_debarment_str, $is_a_reminder);
2496 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2498 $new_debarment_str = $borrower->{debarred};
2500 $new_debarment_str = $new_debar_dt->ymd();
2502 # FIXME Should return a DateTime object
2503 return $new_debarment_str, $is_a_reminder;
2506 =head2 _FixOverduesOnReturn
2508 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2510 C<$borrowernumber> borrowernumber
2512 C<$itemnumber> itemnumber
2514 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2516 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2522 sub _FixOverduesOnReturn {
2523 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2524 unless( $borrowernumber ) {
2525 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2529 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2533 warn "_FixOverduesOnReturn() not supplied valid status";
2537 my $schema = Koha::Database->schema;
2539 my $result = $schema->txn_do(
2541 # check for overdue fine
2542 my $accountlines = Koha::Account::Lines->search(
2544 borrowernumber => $borrowernumber,
2545 itemnumber => $item,
2546 debit_type_code => 'OVERDUE',
2547 status => 'UNRETURNED'
2550 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2552 my $accountline = $accountlines->next;
2553 my $payments = $accountline->credits;
2555 my $amountoutstanding = $accountline->amountoutstanding;
2556 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2557 $accountline->delete;
2558 return 0; # no warning, we've just removed a zero value fine (backdated return)
2559 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2560 my $account = Koha::Account->new({patron_id => $borrowernumber});
2561 my $credit = $account->add_credit(
2563 amount => $amountoutstanding,
2564 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2565 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2566 interface => C4::Context->interface,
2572 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2574 if (C4::Context->preference("FinesLog")) {
2575 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2579 $accountline->status($status);
2580 return $accountline->store();
2587 =head2 _GetCircControlBranch
2589 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2593 Return the library code to be used to determine which circulation
2594 policy applies to a transaction. Looks up the CircControl and
2595 HomeOrHoldingBranch system preferences.
2597 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2599 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2603 sub _GetCircControlBranch {
2604 my ($item, $borrower) = @_;
2605 my $circcontrol = C4::Context->preference('CircControl');
2608 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2609 $branch= C4::Context->userenv->{'branch'};
2610 } elsif ($circcontrol eq 'PatronLibrary') {
2611 $branch=$borrower->{branchcode};
2613 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2614 $branch = $item->{$branchfield};
2615 # default to item home branch if holdingbranch is used
2616 # and is not defined
2617 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2618 $branch = $item->{homebranch};
2626 $issue = GetOpenIssue( $itemnumber );
2628 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2630 C<$itemnumber> is the item's itemnumber
2637 my ( $itemnumber ) = @_;
2638 return unless $itemnumber;
2639 my $dbh = C4::Context->dbh;
2640 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2641 $sth->execute( $itemnumber );
2642 return $sth->fetchrow_hashref();
2646 =head2 GetUpcomingDueIssues
2648 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2652 sub GetUpcomingDueIssues {
2655 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2656 my $dbh = C4::Context->dbh;
2658 my $statement = <<END_SQL;
2661 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2663 LEFT JOIN items USING (itemnumber)
2664 LEFT OUTER JOIN branches USING (branchcode)
2665 WHERE returndate is NULL
2667 WHERE days_until_due >= 0 AND days_until_due <= ?
2670 my @bind_parameters = ( $params->{'days_in_advance'} );
2672 my $sth = $dbh->prepare( $statement );
2673 $sth->execute( @bind_parameters );
2674 my $upcoming_dues = $sth->fetchall_arrayref({});
2676 return $upcoming_dues;
2679 =head2 CanBookBeRenewed
2681 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2683 Find out whether a borrowed item may be renewed.
2685 C<$borrowernumber> is the borrower number of the patron who currently
2686 has the item on loan.
2688 C<$itemnumber> is the number of the item to renew.
2690 C<$override_limit>, if supplied with a true value, causes
2691 the limit on the number of times that the loan can be renewed
2692 (as controlled by the item type) to be ignored. Overriding also allows
2693 to renew sooner than "No renewal before" and to manually renew loans
2694 that are automatically renewed.
2696 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2697 item must currently be on loan to the specified borrower; renewals
2698 must be allowed for the item's type; and the borrower must not have
2699 already renewed the loan. $error will contain the reason the renewal can not proceed
2703 sub CanBookBeRenewed {
2704 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2706 my $dbh = C4::Context->dbh;
2708 my $auto_renew = "no";
2710 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2711 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2712 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2713 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2715 my $patron = $issue->patron or return;
2717 # override_limit will override anything else except on_reserve
2718 unless ( $override_limit ){
2719 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2720 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2722 categorycode => $patron->categorycode,
2723 itemtype => $item->effective_itemtype,
2724 branchcode => $branchcode,
2727 'no_auto_renewal_after',
2728 'no_auto_renewal_after_hard_limit',
2731 'unseen_renewals_allowed'
2736 return ( 0, "too_many" )
2737 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2739 return ( 0, "too_unseen" )
2740 if C4::Context->preference('UnseenRenewals') &&
2741 $issuing_rule->{unseen_renewals_allowed} &&
2742 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2744 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2745 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2746 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2747 my $restricted = $patron->is_debarred;
2748 my $hasoverdues = $patron->has_overdues;
2750 if ( $restricted and $restrictionblockrenewing ) {
2751 return ( 0, 'restriction');
2752 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2753 return ( 0, 'overdue');
2756 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2758 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2759 return ( 0, 'auto_account_expired' );
2762 if ( defined $issuing_rule->{no_auto_renewal_after}
2763 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2764 # Get issue_date and add no_auto_renewal_after
2765 # If this is greater than today, it's too late for renewal.
2766 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2767 $maximum_renewal_date->add(
2768 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2770 my $now = dt_from_string;
2771 if ( $now >= $maximum_renewal_date ) {
2772 return ( 0, "auto_too_late" );
2775 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2776 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2777 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2778 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2779 return ( 0, "auto_too_late" );
2783 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2784 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2785 my $amountoutstanding =
2786 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2787 ? $patron->account->balance
2788 : $patron->account->outstanding_debits->total_outstanding;
2789 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2790 return ( 0, "auto_too_much_oweing" );
2795 if ( defined $issuing_rule->{norenewalbefore}
2796 and $issuing_rule->{norenewalbefore} ne "" )
2799 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2800 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2801 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2803 # Depending on syspref reset the exact time, only check the date
2804 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2805 and $issuing_rule->{lengthunit} eq 'days' )
2807 $soonestrenewal->truncate( to => 'day' );
2810 if ( $soonestrenewal > dt_from_string() )
2812 $auto_renew = ($issue->auto_renew && $patron->autorenew_checkouts) ? "auto_too_soon" : "too_soon";
2814 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2819 # Fallback for automatic renewals:
2820 # If norenewalbefore is undef, don't renew before due date.
2821 if ( $issue->auto_renew && $auto_renew eq "no" && $patron->autorenew_checkouts ) {
2822 my $now = dt_from_string;
2823 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2826 $auto_renew = "auto_too_soon";
2831 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2833 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2834 if ( $resfound && $resrec->{non_priority} ) {
2835 $resfound = Koha::Holds->search(
2836 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2842 # This item can fill one or more unfilled reserve, can those unfilled reserves
2843 # all be filled by other available items?
2845 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2847 my $schema = Koha::Database->new()->schema();
2849 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2851 # There is an item level hold on this item, no other item can fill the hold
2856 # Get all other items that could possibly fill reserves
2857 my @itemnumbers = $schema->resultset('Item')->search(
2859 biblionumber => $resrec->{biblionumber},
2862 -not => { itemnumber => $itemnumber }
2864 { columns => 'itemnumber' }
2865 )->get_column('itemnumber')->all();
2867 # Get all other reserves that could have been filled by this item
2868 my @borrowernumbers;
2870 my ( $reserve_found, $reserve, undef ) =
2871 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2873 if ($reserve_found) {
2874 push( @borrowernumbers, $reserve->{borrowernumber} );
2881 # If the count of the union of the lists of reservable items for each borrower
2882 # is equal or greater than the number of borrowers, we know that all reserves
2883 # can be filled with available items. We can get the union of the sets simply
2884 # by pushing all the elements onto an array and removing the duplicates.
2887 ITEM: foreach my $itemnumber (@itemnumbers) {
2888 my $item = Koha::Items->find( $itemnumber );
2889 next if IsItemOnHoldAndFound( $itemnumber );
2890 for my $borrowernumber (@borrowernumbers) {
2891 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2892 next unless IsAvailableForItemLevelRequest($item, $patron);
2893 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2895 push @reservable, $itemnumber;
2896 if (@reservable >= @borrowernumbers) {
2905 if( $cron ) { #The cron wants to return 'too_soon' over 'on_reserve'
2906 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2907 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2908 } else { # For other purposes we want 'on_reserve' before 'too_soon'
2909 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2910 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2913 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2915 return ( 1, undef );
2920 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2924 C<$borrowernumber> is the borrower number of the patron who currently
2927 C<$itemnumber> is the number of the item to renew.
2929 C<$branch> is the library where the renewal took place (if any).
2930 The library that controls the circ policies for the renewal is retrieved from the issues record.
2932 C<$datedue> can be a DateTime object used to set the due date.
2934 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2935 this parameter is not supplied, lastreneweddate is set to the current date.
2937 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2938 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2939 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2942 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2943 from the book's item type.
2945 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
2946 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
2947 fallback to a true value
2952 my $borrowernumber = shift;
2953 my $itemnumber = shift or return;
2955 my $datedue = shift;
2956 my $lastreneweddate = shift || dt_from_string();
2957 my $skipfinecalc = shift;
2960 # Fallback on a 'seen' renewal
2961 $seen = defined $seen && $seen == 0 ? 0 : 1;
2963 my $item_object = Koha::Items->find($itemnumber) or return;
2964 my $biblio = $item_object->biblio;
2965 my $issue = $item_object->checkout;
2966 my $item_unblessed = $item_object->unblessed;
2968 my $dbh = C4::Context->dbh;
2970 return unless $issue;
2972 $borrowernumber ||= $issue->borrowernumber;
2974 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2975 carp 'Invalid date passed to AddRenewal.';
2979 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2980 my $patron_unblessed = $patron->unblessed;
2982 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2984 my $schema = Koha::Database->schema;
2985 $schema->txn_do(sub{
2987 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
2988 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2990 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2992 # If the due date wasn't specified, calculate it by adding the
2993 # book's loan length to today's date or the current due date
2994 # based on the value of the RenewalPeriodBase syspref.
2995 my $itemtype = $item_object->effective_itemtype;
2998 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2999 dt_from_string( $issue->date_due, 'sql' ) :
3001 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3004 my $fees = Koha::Charges::Fees->new(
3007 library => $circ_library,
3008 item => $item_object,
3009 from_date => dt_from_string( $issue->date_due, 'sql' ),
3010 to_date => dt_from_string($datedue),
3014 # Increment the unseen renewals, if appropriate
3015 # We only do so if the syspref is enabled and
3016 # a maximum value has been set in the circ rules
3017 my $unseen_renewals = $issue->unseen_renewals;
3018 if (C4::Context->preference('UnseenRenewals')) {
3019 my $rule = Koha::CirculationRules->get_effective_rule(
3020 { categorycode => $patron->categorycode,
3021 itemtype => $item_object->effective_itemtype,
3022 branchcode => $circ_library->branchcode,
3023 rule_name => 'unseen_renewals_allowed'
3026 if (!$seen && $rule && $rule->rule_value) {
3029 # If the renewal is seen, unseen should revert to 0
3030 $unseen_renewals = 0;
3034 # Update the issues record to have the new due date, and a new count
3035 # of how many times it has been renewed.
3036 my $renews = ( $issue->renewals || 0 ) + 1;
3037 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ?
3038 WHERE borrowernumber=?
3042 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $borrowernumber, $itemnumber );
3044 # Update the renewal count on the item, and tell zebra to reindex
3045 $renews = ( $item_object->renewals || 0 ) + 1;
3046 $item_object->renewals($renews);
3047 $item_object->onloan($datedue);
3048 $item_object->store({ log_action => 0 });
3050 # Charge a new rental fee, if applicable
3051 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3052 if ( $charge > 0 ) {
3053 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3056 # Charge a new accumulate rental fee, if applicable
3057 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3058 if ( $itemtype_object ) {
3059 my $accumulate_charge = $fees->accumulate_rentalcharge();
3060 if ( $accumulate_charge > 0 ) {
3061 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3063 $charge += $accumulate_charge;
3066 # Send a renewal slip according to checkout alert preferencei
3067 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3068 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3070 branchcode => $branch,
3071 categorycode => $patron->categorycode,
3072 item_type => $itemtype,
3073 notification => 'CHECKOUT',
3075 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3076 SendCirculationAlert(
3079 item => $item_unblessed,
3080 borrower => $patron->unblessed,
3087 # Remove any OVERDUES related debarment if the borrower has no overdues
3089 && $patron->is_debarred
3090 && ! $patron->has_overdues
3091 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3093 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3096 # Add the renewal to stats
3099 branch => $item_object->renewal_branchcode({branch => $branch}),
3102 itemnumber => $itemnumber,
3103 itemtype => $itemtype,
3104 location => $item_object->location,
3105 borrowernumber => $borrowernumber,
3106 ccode => $item_object->ccode,
3111 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3113 Koha::Plugins->call('after_circ_action', {
3114 action => 'renewal',
3116 checkout => $issue->get_from_storage
3125 # check renewal status
3126 my ( $bornum, $itemno ) = @_;
3127 my $dbh = C4::Context->dbh;
3129 my $unseencount = 0;
3130 my $renewsallowed = 0;
3131 my $unseenallowed = 0;
3135 my $patron = Koha::Patrons->find( $bornum );
3136 my $item = Koha::Items->find($itemno);
3138 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3140 # Look in the issues table for this item, lent to this borrower,
3141 # and not yet returned.
3143 # FIXME - I think this function could be redone to use only one SQL call.
3144 my $sth = $dbh->prepare(
3145 "select * from issues
3146 where (borrowernumber = ?)
3147 and (itemnumber = ?)"
3149 $sth->execute( $bornum, $itemno );
3150 my $data = $sth->fetchrow_hashref;
3151 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3152 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3153 # $item and $borrower should be calculated
3154 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3156 my $rules = Koha::CirculationRules->get_effective_rules(
3158 categorycode => $patron->categorycode,
3159 itemtype => $item->effective_itemtype,
3160 branchcode => $branchcode,
3161 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3164 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3165 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3166 $rules->{unseen_renewals_allowed} :
3168 $renewsleft = $renewsallowed - $renewcount;
3169 $unseenleft = $unseenallowed - $unseencount;
3170 if($renewsleft < 0){ $renewsleft = 0; }
3171 if($unseenleft < 0){ $unseenleft = 0; }
3182 =head2 GetSoonestRenewDate
3184 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3186 Find out the soonest possible renew date of a borrowed item.
3188 C<$borrowernumber> is the borrower number of the patron who currently
3189 has the item on loan.
3191 C<$itemnumber> is the number of the item to renew.
3193 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3194 renew date, based on the value "No renewal before" of the applicable
3195 issuing rule. Returns the current date if the item can already be
3196 renewed, and returns undefined if the borrower, loan, or item
3201 sub GetSoonestRenewDate {
3202 my ( $borrowernumber, $itemnumber ) = @_;
3204 my $dbh = C4::Context->dbh;
3206 my $item = Koha::Items->find($itemnumber) or return;
3207 my $itemissue = $item->checkout or return;
3209 $borrowernumber ||= $itemissue->borrowernumber;
3210 my $patron = Koha::Patrons->find( $borrowernumber )
3213 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3214 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3215 { categorycode => $patron->categorycode,
3216 itemtype => $item->effective_itemtype,
3217 branchcode => $branchcode,
3225 my $now = dt_from_string;
3226 return $now unless $issuing_rule;
3228 if ( defined $issuing_rule->{norenewalbefore}
3229 and $issuing_rule->{norenewalbefore} ne "" )
3231 my $soonestrenewal =
3232 dt_from_string( $itemissue->date_due )->subtract(
3233 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3235 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3236 and $issuing_rule->{lengthunit} eq 'days' )
3238 $soonestrenewal->truncate( to => 'day' );
3240 return $soonestrenewal if $now < $soonestrenewal;
3245 =head2 GetLatestAutoRenewDate
3247 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3249 Find out the latest possible auto renew date of a borrowed item.
3251 C<$borrowernumber> is the borrower number of the patron who currently
3252 has the item on loan.
3254 C<$itemnumber> is the number of the item to renew.
3256 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3257 auto renew date, based on the value "No auto renewal after" and the "No auto
3258 renewal after (hard limit) of the applicable issuing rule.
3259 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3260 or item cannot be found.
3264 sub GetLatestAutoRenewDate {
3265 my ( $borrowernumber, $itemnumber ) = @_;
3267 my $dbh = C4::Context->dbh;
3269 my $item = Koha::Items->find($itemnumber) or return;
3270 my $itemissue = $item->checkout or return;
3272 $borrowernumber ||= $itemissue->borrowernumber;
3273 my $patron = Koha::Patrons->find( $borrowernumber )
3276 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3277 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3279 categorycode => $patron->categorycode,
3280 itemtype => $item->effective_itemtype,
3281 branchcode => $branchcode,
3283 'no_auto_renewal_after',
3284 'no_auto_renewal_after_hard_limit',
3290 return unless $circulation_rules;
3292 if ( not $circulation_rules->{no_auto_renewal_after}
3293 or $circulation_rules->{no_auto_renewal_after} eq '' )
3294 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3295 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3297 my $maximum_renewal_date;
3298 if ( $circulation_rules->{no_auto_renewal_after} ) {
3299 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3300 $maximum_renewal_date->add(
3301 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3305 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3306 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3307 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3309 return $maximum_renewal_date;
3313 =head2 GetIssuingCharges
3315 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3317 Calculate how much it would cost for a given patron to borrow a given
3318 item, including any applicable discounts.
3320 C<$itemnumber> is the item number of item the patron wishes to borrow.
3322 C<$borrowernumber> is the patron's borrower number.
3324 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3325 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3330 sub GetIssuingCharges {
3332 # calculate charges due
3333 my ( $itemnumber, $borrowernumber ) = @_;
3335 my $dbh = C4::Context->dbh;
3338 # Get the book's item type and rental charge (via its biblioitem).
3339 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3340 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3341 $charge_query .= (C4::Context->preference('item-level_itypes'))
3342 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3343 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3345 $charge_query .= ' WHERE items.itemnumber =?';
3347 my $sth = $dbh->prepare($charge_query);
3348 $sth->execute($itemnumber);
3349 if ( my $item_data = $sth->fetchrow_hashref ) {
3350 $item_type = $item_data->{itemtype};
3351 $charge = $item_data->{rentalcharge};
3352 # FIXME This should follow CircControl
3353 my $branch = C4::Context::mybranch();
3354 my $patron = Koha::Patrons->find( $borrowernumber );
3355 my $discount = Koha::CirculationRules->get_effective_rule({
3356 categorycode => $patron->categorycode,
3357 branchcode => $branch,
3358 itemtype => $item_type,
3359 rule_name => 'rentaldiscount'
3362 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3365 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3369 return ( $charge, $item_type );
3372 =head2 AddIssuingCharge
3374 &AddIssuingCharge( $checkout, $charge, $type )
3378 sub AddIssuingCharge {
3379 my ( $checkout, $charge, $type ) = @_;
3381 # FIXME What if checkout does not exist?
3383 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3384 my $accountline = $account->add_debit(
3388 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3389 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3390 interface => C4::Context->interface,
3392 item_id => $checkout->itemnumber,
3393 issue_id => $checkout->issue_id,
3400 GetTransfers($itemnumber);
3405 my ($itemnumber) = @_;
3407 my $dbh = C4::Context->dbh;
3414 FROM branchtransfers
3415 WHERE itemnumber = ?
3416 AND datearrived IS NULL
3418 my $sth = $dbh->prepare($query);
3419 $sth->execute($itemnumber);
3420 my @row = $sth->fetchrow_array();
3424 =head2 GetTransfersFromTo
3426 @results = GetTransfersFromTo($frombranch,$tobranch);
3428 Returns the list of pending transfers between $from and $to branch
3432 sub GetTransfersFromTo {
3433 my ( $frombranch, $tobranch ) = @_;
3434 return unless ( $frombranch && $tobranch );
3435 my $dbh = C4::Context->dbh;
3437 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3438 FROM branchtransfers
3441 AND datearrived IS NULL
3443 my $sth = $dbh->prepare($query);
3444 $sth->execute( $frombranch, $tobranch );
3447 while ( my $data = $sth->fetchrow_hashref ) {
3448 push @gettransfers, $data;
3450 return (@gettransfers);
3453 =head2 DeleteTransfer
3455 &DeleteTransfer($itemnumber);
3459 sub DeleteTransfer {
3460 my ($itemnumber) = @_;
3461 return unless $itemnumber;
3462 my $dbh = C4::Context->dbh;
3463 my $sth = $dbh->prepare(
3464 "DELETE FROM branchtransfers
3466 AND datearrived IS NULL "
3468 return $sth->execute($itemnumber);
3471 =head2 SendCirculationAlert
3473 Send out a C<check-in> or C<checkout> alert using the messaging system.
3481 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3485 Hashref of information about the item being checked in or out.
3489 Hashref of information about the borrower of the item.
3493 The branchcode from where the checkout or check-in took place.
3499 SendCirculationAlert({
3502 borrower => $borrower,
3508 sub SendCirculationAlert {
3510 my ($type, $item, $borrower, $branch) =
3511 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3512 my %message_name = (
3513 CHECKIN => 'Item_Check_in',
3514 CHECKOUT => 'Item_Checkout',
3515 RENEWAL => 'Item_Checkout',
3517 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3518 borrowernumber => $borrower->{borrowernumber},
3519 message_name => $message_name{$type},
3521 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3523 my $schema = Koha::Database->new->schema;
3524 my @transports = keys %{ $borrower_preferences->{transports} };
3526 # From the MySQL doc:
3527 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3528 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3529 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3530 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3532 for my $mtt (@transports) {
3533 my $letter = C4::Letters::GetPreparedLetter (
3534 module => 'circulation',
3535 letter_code => $type,
3536 branchcode => $branch,
3537 message_transport_type => $mtt,
3538 lang => $borrower->{lang},
3540 $issues_table => $item->{itemnumber},
3541 'items' => $item->{itemnumber},
3542 'biblio' => $item->{biblionumber},
3543 'biblioitems' => $item->{biblionumber},
3544 'borrowers' => $borrower,
3545 'branches' => $branch,
3549 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3550 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3551 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3552 unless ( $message ) {
3553 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3554 C4::Message->enqueue($letter, $borrower, $mtt);
3556 $message->append($letter);
3559 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3565 =head2 updateWrongTransfer
3567 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3569 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
3573 sub updateWrongTransfer {
3574 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3575 my $dbh = C4::Context->dbh;
3576 # first step validate the actual line of transfert .
3579 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3581 $sth->execute($FromLibrary,$itemNumber);
3583 # second step create a new line of branchtransfer to the right location .
3584 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3586 #third step changing holdingbranch of item
3587 my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3592 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3594 this function calculates the due date given the start date and configured circulation rules,
3595 checking against the holidays calendar as per the daysmode circulation rule.
3596 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3597 C<$itemtype> = itemtype code of item in question
3598 C<$branch> = location whose calendar to use
3599 C<$borrower> = Borrower object
3600 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3605 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3609 # loanlength now a href
3611 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3613 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3619 if (ref $startdate ne 'DateTime' ) {
3620 $datedue = dt_from_string($datedue);
3622 $datedue = $startdate->clone;
3625 $datedue = dt_from_string()->truncate( to => 'minute' );
3629 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3631 categorycode => $borrower->{categorycode},
3632 itemtype => $itemtype,
3633 branchcode => $branch,
3637 # calculate the datedue as normal
3638 if ( $daysmode eq 'Days' )
3639 { # ignoring calendar
3640 if ( $loanlength->{lengthunit} eq 'hours' ) {
3641 $datedue->add( hours => $loanlength->{$length_key} );
3643 $datedue->add( days => $loanlength->{$length_key} );
3644 $datedue->set_hour(23);
3645 $datedue->set_minute(59);
3649 if ($loanlength->{lengthunit} eq 'hours') {
3650 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3653 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3655 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3656 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3657 if ($loanlength->{lengthunit} eq 'days') {
3658 $datedue->set_hour(23);
3659 $datedue->set_minute(59);
3663 # if Hard Due Dates are used, retrieve them and apply as necessary
3664 my ( $hardduedate, $hardduedatecompare ) =
3665 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3666 if ($hardduedate) { # hardduedates are currently dates
3667 $hardduedate->truncate( to => 'minute' );
3668 $hardduedate->set_hour(23);
3669 $hardduedate->set_minute(59);
3670 my $cmp = DateTime->compare( $hardduedate, $datedue );
3672 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3673 # if the calculated date is before the 'after' Hard Due Date (floor), override
3674 # if the hard due date is set to 'exactly', overrride
3675 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3676 $datedue = $hardduedate->clone;
3679 # in all other cases, keep the date due as it is
3683 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3684 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3685 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3686 if( $expiry_dt ) { #skip empty expiry date..
3687 $expiry_dt->set( hour => 23, minute => 59);
3688 my $d1= $datedue->clone->set_time_zone('floating');
3689 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3690 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3693 if ( $daysmode ne 'Days' ) {
3694 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3695 if ( $calendar->is_holiday($datedue) ) {
3696 # Don't return on a closed day
3697 $datedue = $calendar->prev_open_days( $datedue, 1 );
3706 sub CheckValidBarcode{
3708 my $dbh = C4::Context->dbh;
3709 my $query=qq|SELECT count(*)
3713 my $sth = $dbh->prepare($query);
3714 $sth->execute($barcode);
3715 my $exist=$sth->fetchrow ;
3719 =head2 IsBranchTransferAllowed
3721 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3723 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3725 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3726 Koha::Item->can_be_transferred.
3730 sub IsBranchTransferAllowed {
3731 my ( $toBranch, $fromBranch, $code ) = @_;
3733 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3735 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3736 my $dbh = C4::Context->dbh;
3738 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3739 $sth->execute( $toBranch, $fromBranch, $code );
3740 my $limit = $sth->fetchrow_hashref();
3742 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3743 if ( $limit->{'limitId'} ) {
3750 =head2 CreateBranchTransferLimit
3752 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3754 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3756 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3760 sub CreateBranchTransferLimit {
3761 my ( $toBranch, $fromBranch, $code ) = @_;
3762 return unless defined($toBranch) && defined($fromBranch);
3763 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3765 my $dbh = C4::Context->dbh;
3767 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3768 return $sth->execute( $code, $toBranch, $fromBranch );
3771 =head2 DeleteBranchTransferLimits
3773 my $result = DeleteBranchTransferLimits($frombranch);
3775 Deletes all the library transfer limits for one library. Returns the
3776 number of limits deleted, 0e0 if no limits were deleted, or undef if
3777 no arguments are supplied.
3779 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3780 fromBranch => $fromBranch
3785 sub DeleteBranchTransferLimits {
3787 return unless defined $branch;
3788 my $dbh = C4::Context->dbh;
3789 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3790 return $sth->execute($branch);
3794 my ( $borrowernumber, $itemnum ) = @_;
3795 MarkIssueReturned( $borrowernumber, $itemnum );
3800 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3802 The final optional parameter, C<$params>, expected to contain
3803 'skip_record_index' key, which relayed down to Koha::Item/store,
3804 there it prevents calling of ModZebra index_records,
3805 which takes most of the time in batch adds/deletes: index_records better
3806 to be called later in C<additem.pl> after the whole loop.
3809 skip_record_index => 1|0
3814 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3816 unless ( $mark_lost_from ) {
3817 # Temporary check to avoid regressions
3818 die q|LostItem called without $mark_lost_from, check the API.|;
3822 if ( $force_mark_returned ) {
3825 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3826 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3829 my $dbh = C4::Context->dbh();
3830 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3832 JOIN items USING (itemnumber)
3833 JOIN biblio USING (biblionumber)
3834 WHERE issues.itemnumber=?");
3835 $sth->execute($itemnumber);
3836 my $issues=$sth->fetchrow_hashref();
3838 # If a borrower lost the item, add a replacement cost to the their record
3839 if ( my $borrowernumber = $issues->{borrowernumber} ){
3840 my $patron = Koha::Patrons->find( $borrowernumber );
3842 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3843 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3845 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3846 C4::Accounts::chargelostitem(
3849 $issues->{'replacementprice'},
3850 sprintf( "%s %s %s",
3851 $issues->{'title'} || q{},
3852 $issues->{'barcode'} || q{},
3853 $issues->{'itemcallnumber'} || q{},
3856 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3857 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3860 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3863 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3864 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3865 Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store({ skip_record_index => $params->{skip_record_index} });
3867 my $transferdeleted = DeleteTransfer($itemnumber);
3870 sub GetOfflineOperations {
3871 my $dbh = C4::Context->dbh;
3872 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3873 $sth->execute(C4::Context->userenv->{'branch'});
3874 my $results = $sth->fetchall_arrayref({});
3878 sub GetOfflineOperation {
3879 my $operationid = shift;
3880 return unless $operationid;
3881 my $dbh = C4::Context->dbh;
3882 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3883 $sth->execute( $operationid );
3884 return $sth->fetchrow_hashref;
3887 sub AddOfflineOperation {
3888 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3889 my $dbh = C4::Context->dbh;
3890 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3891 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3895 sub DeleteOfflineOperation {
3896 my $dbh = C4::Context->dbh;
3897 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3898 $sth->execute( shift );
3902 sub ProcessOfflineOperation {
3903 my $operation = shift;
3906 if ( $operation->{action} eq 'return' ) {
3907 $report = ProcessOfflineReturn( $operation );
3908 } elsif ( $operation->{action} eq 'issue' ) {
3909 $report = ProcessOfflineIssue( $operation );
3910 } elsif ( $operation->{action} eq 'payment' ) {
3911 $report = ProcessOfflinePayment( $operation );
3914 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3919 sub ProcessOfflineReturn {
3920 my $operation = shift;
3922 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3925 my $itemnumber = $item->itemnumber;
3926 my $issue = GetOpenIssue( $itemnumber );
3928 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3929 ModDateLastSeen( $itemnumber, $leave_item_lost );
3931 $issue->{borrowernumber},
3933 $operation->{timestamp},
3936 $item->onloan(undef);
3937 $item->store({ log_action => 0 });
3940 return "Item not issued.";
3943 return "Item not found.";
3947 sub ProcessOfflineIssue {
3948 my $operation = shift;
3950 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3953 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3955 return "Barcode not found.";
3957 my $itemnumber = $item->itemnumber;
3958 my $issue = GetOpenIssue( $itemnumber );
3960 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3962 $issue->{borrowernumber},
3964 $operation->{timestamp},
3969 $operation->{'barcode'},
3972 $operation->{timestamp},
3977 return "Borrower not found.";
3981 sub ProcessOfflinePayment {
3982 my $operation = shift;
3984 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3986 $patron->account->pay(
3988 amount => $operation->{amount},
3989 library_id => $operation->{branchcode},
3999 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4001 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4006 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4010 ? Koha::Items->find($itemnumber)
4011 : Koha::Items->find( { barcode => $barcode } );
4015 return C4::Letters::GetPreparedLetter (
4016 module => 'circulation',
4017 letter_code => 'TRANSFERSLIP',
4018 branchcode => $branch,
4020 'branches' => $to_branch,
4021 'biblio' => $item->biblionumber,
4022 'items' => $item->unblessed,
4027 =head2 CheckIfIssuedToPatron
4029 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4031 Return 1 if any record item is issued to patron, otherwise return 0
4035 sub CheckIfIssuedToPatron {
4036 my ($borrowernumber, $biblionumber) = @_;
4038 my $dbh = C4::Context->dbh;
4040 SELECT COUNT(*) FROM issues
4041 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4042 WHERE items.biblionumber = ?
4043 AND issues.borrowernumber = ?
4045 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4046 return 1 if $is_issued;
4052 IsItemIssued( $itemnumber )
4054 Return 1 if the item is on loan, otherwise return 0
4059 my $itemnumber = shift;
4060 my $dbh = C4::Context->dbh;
4061 my $sth = $dbh->prepare(q{
4064 WHERE itemnumber = ?
4066 $sth->execute($itemnumber);
4067 return $sth->fetchrow;
4070 =head2 GetAgeRestriction
4072 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4073 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4075 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4076 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4078 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4079 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4080 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4081 Negative days mean the borrower has gone past the age restriction age.
4085 sub GetAgeRestriction {
4086 my ($record_restrictions, $borrower) = @_;
4087 my $markers = C4::Context->preference('AgeRestrictionMarker');
4089 return unless $record_restrictions;
4090 # Split $record_restrictions to something like FSK 16 or PEGI 6
4091 my @values = split ' ', uc($record_restrictions);
4092 return unless @values;
4094 # Search first occurrence of one of the markers
4095 my @markers = split /\|/, uc($markers);
4096 return unless @markers;
4099 my $restriction_year = 0;
4100 for my $value (@values) {
4102 for my $marker (@markers) {
4103 $marker =~ s/^\s+//; #remove leading spaces
4104 $marker =~ s/\s+$//; #remove trailing spaces
4105 if ( $marker eq $value ) {
4106 if ( $index <= $#values ) {
4107 $restriction_year += $values[$index];
4111 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4113 # Perhaps it is something like "K16" (as in Finland)
4114 $restriction_year += $1;
4118 last if ( $restriction_year > 0 );
4121 #Check if the borrower is age restricted for this material and for how long.
4122 if ($restriction_year && $borrower) {
4123 if ( $borrower->{'dateofbirth'} ) {
4124 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4125 $alloweddate[0] += $restriction_year;
4127 #Prevent runime eror on leap year (invalid date)
4128 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4129 $alloweddate[2] = 28;
4132 #Get how many days the borrower has to reach the age restriction
4133 my @Today = split /-/, dt_from_string()->ymd();
4134 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4135 #Negative days means the borrower went past the age restriction age
4136 return ($restriction_year, $daysToAgeRestriction);
4140 return ($restriction_year);
4144 =head2 GetPendingOnSiteCheckouts
4148 sub GetPendingOnSiteCheckouts {
4149 my $dbh = C4::Context->dbh;
4150 return $dbh->selectall_arrayref(q|
4156 items.itemcallnumber,
4160 issues.date_due < NOW() AS is_overdue,
4163 borrowers.firstname,
4165 borrowers.cardnumber,
4166 borrowers.borrowernumber
4168 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4169 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4170 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4171 WHERE issues.onsite_checkout = 1
4172 |, { Slice => {} } );
4178 my ($count, $branch, $itemtype, $ccode, $newness)
4179 = @$params{qw(count branch itemtype ccode newness)};
4181 my $dbh = C4::Context->dbh;
4184 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4185 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4186 i.ccode, SUM(i.issues) AS count
4188 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4189 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4192 my (@where_strs, @where_args);
4195 push @where_strs, 'i.homebranch = ?';
4196 push @where_args, $branch;
4199 if (C4::Context->preference('item-level_itypes')){
4200 push @where_strs, 'i.itype = ?';
4201 push @where_args, $itemtype;
4203 push @where_strs, 'bi.itemtype = ?';
4204 push @where_args, $itemtype;
4208 push @where_strs, 'i.ccode = ?';
4209 push @where_args, $ccode;
4212 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4213 push @where_args, $newness;
4217 $query .= 'WHERE ' . join(' AND ', @where_strs);
4221 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4222 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4227 $query .= q{ ) xxx WHERE count > 0 };
4228 $count = int($count);
4230 $query .= "LIMIT $count";
4233 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4238 =head2 Internal methods
4242 sub _CalculateAndUpdateFine {
4245 my $borrower = $params->{borrower};
4246 my $item = $params->{item};
4247 my $issue = $params->{issue};
4248 my $return_date = $params->{return_date};
4250 unless ($borrower) { carp "No borrower passed in!" && return; }
4251 unless ($item) { carp "No item passed in!" && return; }
4252 unless ($issue) { carp "No issue passed in!" && return; }
4254 my $datedue = dt_from_string( $issue->date_due );
4256 # we only need to calculate and change the fines if we want to do that on return
4257 # Should be on for hourly loans
4258 my $control = C4::Context->preference('CircControl');
4259 my $control_branchcode =
4260 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4261 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4262 : $issue->branchcode;
4264 my $date_returned = $return_date ? $return_date : dt_from_string();
4266 my ( $amount, $unitcounttotal, $unitcount ) =
4267 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4269 if ( C4::Context->preference('finesMode') eq 'production' ) {
4270 if ( $amount > 0 ) {
4271 C4::Overdues::UpdateFine({
4272 issue_id => $issue->issue_id,
4273 itemnumber => $issue->itemnumber,
4274 borrowernumber => $issue->borrowernumber,
4276 due => output_pref($datedue),
4279 elsif ($return_date) {
4281 # Backdated returns may have fines that shouldn't exist,
4282 # so in this case, we need to drop those fines to 0
4284 C4::Overdues::UpdateFine({
4285 issue_id => $issue->issue_id,
4286 itemnumber => $issue->itemnumber,
4287 borrowernumber => $issue->borrowernumber,
4289 due => output_pref($datedue),
4295 sub _item_denied_renewal {
4298 my $item = $params->{item};
4299 return unless $item;
4301 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4302 return unless $denyingrules;
4303 foreach my $field (keys %$denyingrules) {
4304 my $val = $item->$field;
4305 if( !defined $val) {
4306 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4309 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4310 # If the results matches the values in the syspref
4311 # We return true if match found
4324 Koha Development Team <http://koha-community.org/>