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 );
27 use Koha::DateUtils qw( dt_from_string output_pref );
29 use C4::Stats qw( UpdateStats );
30 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest );
31 use C4::Biblio qw( UpdateTotalIssues );
32 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
34 use C4::ItemCirculationAlertPreference;
36 use C4::Log qw( logaction ); # logaction
38 use C4::RotatingCollections qw(GetCollectionItemBranches);
39 use Algorithm::CheckDigits qw( CheckDigits );
41 use Data::Dumper qw( Dumper );
43 use Koha::AuthorisedValues;
44 use Koha::Biblioitems;
45 use Koha::DateUtils qw( dt_from_string output_pref );
48 use Koha::Illrequests;
51 use Koha::Patron::Debarments qw( DelUniqueDebarment GetDebarments AddUniqueDebarment );
54 use Koha::Account::Lines;
56 use Koha::Account::Lines;
57 use Koha::Account::Offsets;
58 use Koha::Config::SysPrefs;
59 use Koha::Charges::Fees;
60 use Koha::Config::SysPref;
61 use Koha::Checkouts::ReturnClaims;
62 use Koha::SearchEngine::Indexer;
63 use Koha::Exceptions::Checkout;
66 use List::MoreUtils qw( any );
67 use Scalar::Util qw( looks_like_number );
68 use Date::Calc qw( Date_to_Days );
69 our (@ISA, @EXPORT_OK);
75 # FIXME subs that should probably be elsewhere
80 GetPendingOnSiteCheckouts
91 GetLatestAutoRenewDate
94 GetBranchBorrowerCircRule
114 IsBranchTransferAllowed
115 CreateBranchTransferLimit
116 DeleteBranchTransferLimits
122 DeleteOfflineOperation
123 ProcessOfflineOperation
124 ProcessOfflinePayment
126 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
131 C4::Circulation - Koha circulation module
139 The functions in this module deal with circulation, issues, and
140 returns, as well as general information about the library.
141 Also deals with inventory.
147 $str = &barcodedecode($barcode, [$filter]);
149 Generic filter function for barcode string.
150 Called on every circ if the System Pref itemBarcodeInputFilter is set.
151 Will do some manipulation of the barcode for systems that deliver a barcode
152 to circulation.pl that differs from the barcode stored for the item.
153 For proper functioning of this filter, calling the function on the
154 correct barcode string (items.barcode) should return an unaltered barcode.
156 The optional $filter argument is to allow for testing or explicit
157 behavior that ignores the System Pref. Valid values are the same as the
162 # FIXME -- the &decode fcn below should be wrapped into this one.
163 # FIXME -- these plugins should be moved out of Circulation.pm
166 my ($barcode, $filter) = @_;
167 my $branch = C4::Context::mybranch();
168 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
169 Koha::Plugins->call('item_barcode_transform', \$barcode );
170 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
171 if ($filter eq 'whitespace') {
173 } elsif ($filter eq 'cuecat') {
175 my @fields = split( /\./, $barcode );
176 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
177 ($#results == 2) and return $results[2];
178 } elsif ($filter eq 'T-prefix') {
179 if ($barcode =~ /^[Tt](\d)/) {
180 (defined($1) and $1 eq '0') and return $barcode;
181 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
183 return sprintf("T%07d", $barcode);
184 # FIXME: $barcode could be "T1", causing warning: substr outside of string
185 # Why drop the nonzero digit after the T?
186 # Why pass non-digits (or empty string) to "T%07d"?
187 } elsif ($filter eq 'libsuite8') {
188 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
189 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
190 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
192 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
195 } elsif ($filter eq 'EAN13') {
196 my $ean = CheckDigits('ean');
197 if ( $ean->is_valid($barcode) ) {
198 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
199 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
201 warn "# [$barcode] not valid EAN-13/UPC-A\n";
204 return $barcode; # return barcode, modified or not
209 $str = &_decode($chunk);
211 Decodes a segment of a string emitted by a CueCat barcode scanner and
214 FIXME: Should be replaced with Barcode::Cuecat from CPAN
215 or Javascript based decoding on the client side.
222 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
223 my @s = map { index( $seq, $_ ); } split( //, $encoded );
224 my $l = ( $#s + 1 ) % 4;
227 # warn "Error: Cuecat decode parsing failed!";
235 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
237 chr( ( $n >> 16 ) ^ 67 )
238 .chr( ( $n >> 8 & 255 ) ^ 67 )
239 .chr( ( $n & 255 ) ^ 67 );
242 $r = substr( $r, 0, length($r) - $l );
248 ($dotransfer, $messages, $iteminformation) = &transferbook({
249 from_branch => $frombranch
250 to_branch => $tobranch,
252 ignore_reserves => $ignore_reserves,
256 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
258 C<$fbr> is the code for the branch initiating the transfer.
259 C<$tbr> is the code for the branch to which the item should be transferred.
261 C<$barcode> is the barcode of the item to be transferred.
263 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
264 Otherwise, if an item is reserved, the transfer fails.
266 C<$trigger> is the enum value for what triggered the transfer.
268 Returns three values:
274 is true if the transfer was successful.
278 is a reference-to-hash which may have any of the following keys:
284 There is no item in the catalog with the given barcode. The value is C<$barcode>.
286 =item C<DestinationEqualsHolding>
288 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.
292 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.
296 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>.
298 =item C<WasTransferred>
300 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
310 my $tbr = $params->{to_branch};
311 my $fbr = $params->{from_branch};
312 my $ignoreRs = $params->{ignore_reserves};
313 my $barcode = $params->{barcode};
314 my $trigger = $params->{trigger};
317 my $item = Koha::Items->find( { barcode => $barcode } );
319 Koha::Exceptions::MissingParameter->throw(
320 "Missing mandatory parameter: from_branch")
323 Koha::Exceptions::MissingParameter->throw(
324 "Missing mandatory parameter: to_branch")
329 $messages->{'BadBarcode'} = $barcode;
331 return ( $dotransfer, $messages );
334 my $itemnumber = $item->itemnumber;
335 # get branches of book...
336 my $hbr = $item->homebranch;
338 # if using Branch Transfer Limits
339 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
340 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
341 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
342 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
343 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
346 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
347 $messages->{'NotAllowed'} = $tbr . "::" . $code;
352 # can't transfer book if is already there....
353 if ( $fbr eq $tbr ) {
354 $messages->{'DestinationEqualsHolding'} = 1;
358 # check if it is still issued to someone, return it...
359 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
361 AddReturn( $barcode, $fbr );
362 $messages->{'WasReturned'} = $issue->borrowernumber;
366 # That'll save a database query.
367 my ( $resfound, $resrec, undef ) =
368 CheckReserves( $itemnumber );
370 $resrec->{'ResFound'} = $resfound;
371 $messages->{'ResFound'} = $resrec;
372 $dotransfer = 0 unless $ignoreRs;
375 #actually do the transfer....
377 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
379 # don't need to update MARC anymore, we do it in batch now
380 $messages->{'WasTransfered'} = $tbr;
383 ModDateLastSeen( $itemnumber );
384 return ( $dotransfer, $messages );
389 my $borrower = shift;
390 my $item_object = shift;
392 my $onsite_checkout = $params->{onsite_checkout} || 0;
393 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
394 my $cat_borrower = $borrower->{'categorycode'};
395 my $dbh = C4::Context->dbh;
396 # Get which branchcode we need
397 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
398 my $type = $item_object->effective_itemtype;
400 my ($type_object, $parent_type, $parent_maxissueqty_rule);
401 $type_object = Koha::ItemTypes->find( $type );
402 $parent_type = $type_object->parent_type if $type_object;
403 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
404 # Find any children if we are a parent_type;
406 # given branch, patron category, and item type, determine
407 # applicable issuing rule
409 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
411 categorycode => $cat_borrower,
412 itemtype => $parent_type,
413 branchcode => $branch,
414 rule_name => 'maxissueqty',
417 # If the parent rule is for default type we discount it
418 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
420 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
422 categorycode => $cat_borrower,
424 branchcode => $branch,
425 rule_name => 'maxissueqty',
429 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
431 categorycode => $cat_borrower,
433 branchcode => $branch,
434 rule_name => 'maxonsiteissueqty',
439 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
440 # if a rule is found and has a loan limit set, count
441 # how many loans the patron already has that meet that
443 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
446 if ( $maxissueqty_rule->branchcode ) {
447 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
448 $checkouts = $patron->checkouts->search(
449 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
450 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
451 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
453 $checkouts = $patron->checkouts->search(
454 { 'item.homebranch' => $maxissueqty_rule->branchcode },
455 { prefetch => 'item' } );
458 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
461 my $rule_itemtype = $maxissueqty_rule->itemtype;
462 while ( my $c = $checkouts->next ) {
463 my $itemtype = $c->item->effective_itemtype;
465 unless ( $rule_itemtype ) {
466 # matching rule has the default item type, so count only
467 # those existing loans that don't fall under a more
469 @types = Koha::CirculationRules->search(
471 branchcode => $maxissueqty_rule->branchcode,
472 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
473 itemtype => { '!=' => undef },
474 rule_name => 'maxissueqty'
476 )->get_column('itemtype');
478 next if grep {$_ eq $itemtype} @types;
481 if ( $parent_maxissueqty_rule ) {
482 # if we have a parent item type then we count loans of the
483 # specific item type or its siblings or parent
484 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
485 @types = $children->get_column('itemtype');
486 push @types, $parent_type;
487 } elsif ( $child_types ) {
488 # If we are a parent type, we need to count all child types and our own type
489 @types = $child_types->get_column('itemtype');
490 push @types, $type; # And don't forget to count our own types
491 } else { push @types, $type; } # Otherwise only count the specific itemtype
493 next unless grep {$_ eq $itemtype} @types;
495 $sum_checkouts->{total}++;
496 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
497 $sum_checkouts->{itemtype}->{$itemtype}++;
500 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
501 my $checkout_count = $sum_checkouts->{total} || 0;
502 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
504 my $checkout_rules = {
505 checkout_count => $checkout_count,
506 onsite_checkout_count => $onsite_checkout_count,
507 onsite_checkout => $onsite_checkout,
508 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
509 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
510 switch_onsite_checkout => $switch_onsite_checkout,
512 # If parent rules exists
513 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
514 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
515 my $qty_over = _check_max_qty($checkout_rules);
516 return $qty_over if defined $qty_over;
518 # If the parent rule is less than or equal to the child, we only need check the parent
519 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
520 $checkout_rules->{checkout_count} = $checkout_count_type;
521 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
522 my $qty_over = _check_max_qty($checkout_rules);
523 return $qty_over if defined $qty_over;
526 my $qty_over = _check_max_qty($checkout_rules);
527 return $qty_over if defined $qty_over;
531 # Now count total loans against the limit for the branch
532 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
533 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
535 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
536 $checkouts = $patron->checkouts->search(
537 { 'me.branchcode' => $branch} );
538 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
539 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
541 $checkouts = $patron->checkouts->search(
542 { 'item.homebranch' => $branch},
543 { prefetch => 'item' } );
546 my $checkout_count = $checkouts->count;
547 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
548 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
549 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
551 my $qty_over = _check_max_qty(
553 checkout_count => $checkout_count,
554 onsite_checkout_count => $onsite_checkout_count,
555 onsite_checkout => $onsite_checkout,
556 max_checkouts_allowed => $max_checkouts_allowed,
557 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
558 switch_onsite_checkout => $switch_onsite_checkout
561 return $qty_over if defined $qty_over;
564 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
565 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
568 # OK, the patron can issue !!!
574 my $checkout_count = $params->{checkout_count};
575 my $onsite_checkout_count = $params->{onsite_checkout_count};
576 my $onsite_checkout = $params->{onsite_checkout};
577 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
578 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
579 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
581 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
582 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
583 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
585 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
586 count => $onsite_checkout_count,
587 max_allowed => $max_onsite_checkouts_allowed,
591 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
592 if ( $max_checkouts_allowed eq '' ) { return; }
593 my $delta = $switch_onsite_checkout ? 1 : 0;
594 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
596 reason => 'TOO_MANY_CHECKOUTS',
597 count => $checkout_count,
598 max_allowed => $max_checkouts_allowed,
602 elsif ( not $onsite_checkout ) {
603 if ( $max_checkouts_allowed eq '' ) { return; }
605 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
608 reason => 'TOO_MANY_CHECKOUTS',
609 count => $checkout_count - $onsite_checkout_count,
610 max_allowed => $max_checkouts_allowed,
618 =head2 CanBookBeIssued
620 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
621 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
623 Check if a book can be issued.
625 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
627 IMPORTANT: The assumption by users of this routine is that causes blocking
628 the issue are keyed by uppercase labels and other returned
629 data is keyed in lower case!
633 =item C<$patron> is a Koha::Patron
635 =item C<$barcode> is the bar code of the book being issued.
637 =item C<$duedates> is a DateTime object.
639 =item C<$inprocess> boolean switch
641 =item C<$ignore_reserves> boolean switch
643 =item C<$params> Hashref of additional parameters
646 override_high_holds - Ignore high holds
647 onsite_checkout - Checkout is an onsite checkout that will not leave the library
655 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
656 Possible values are :
662 sticky due date is invalid
666 borrower gone with no address
670 borrower declared it's card lost
676 =head3 UNKNOWN_BARCODE
690 item is restricted (set by ??)
692 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
693 could be prevented, but ones that can be overriden by the operator.
695 Possible values are :
703 renewing, not issuing
705 =head3 ISSUED_TO_ANOTHER
707 issued to someone else.
711 reserved for someone else.
715 reserved and being transferred for someone else.
719 sticky due date is invalid or due date in the past
723 if the borrower borrows to much things
727 sub CanBookBeIssued {
728 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
729 my %needsconfirmation; # filled with problems that needs confirmations
730 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
731 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
732 my %messages; # filled with information messages that should be displayed.
734 my $onsite_checkout = $params->{onsite_checkout} || 0;
735 my $override_high_holds = $params->{override_high_holds} || 0;
737 my $item_object = Koha::Items->find({barcode => $barcode });
739 # MANDATORY CHECKS - unless item exists, nothing else matters
740 unless ( $item_object ) {
741 $issuingimpossible{UNKNOWN_BARCODE} = 1;
743 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
745 my $item_unblessed = $item_object->unblessed; # Transition...
746 my $issue = $item_object->checkout;
747 my $biblio = $item_object->biblio;
749 my $biblioitem = $biblio->biblioitem;
750 my $effective_itemtype = $item_object->effective_itemtype;
751 my $dbh = C4::Context->dbh;
752 my $patron_unblessed = $patron->unblessed;
754 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
756 # DUE DATE is OK ? -- should already have checked.
758 if ($duedate && ref $duedate ne 'DateTime') {
759 $duedate = dt_from_string($duedate);
761 my $now = dt_from_string();
762 unless ( $duedate ) {
763 my $issuedate = $now->clone();
765 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
767 # Offline circ calls AddIssue directly, doesn't run through here
768 # So issuingimpossible should be ok.
771 my $fees = Koha::Charges::Fees->new(
774 library => $circ_library,
775 item => $item_object,
781 my $today = $now->clone();
782 $today->truncate( to => 'minute');
783 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
784 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
787 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
793 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
794 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
795 C4::Stats::UpdateStats({
796 branch => C4::Context->userenv->{'branch'},
798 itemnumber => $item_object->itemnumber,
799 itemtype => $effective_itemtype,
800 borrowernumber => $patron->borrowernumber,
801 ccode => $item_object->ccode}
803 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
804 return( { STATS => 1 }, {});
807 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
808 $issuingimpossible{GNA} = 1;
811 if ( $patron->lost && $patron->lost == 1 ) {
812 $issuingimpossible{CARD_LOST} = 1;
814 if ( $patron->is_debarred ) {
815 $issuingimpossible{DEBARRED} = 1;
818 if ( $patron->is_expired ) {
819 $issuingimpossible{EXPIRED} = 1;
827 my $account = $patron->account;
828 my $balance = $account->balance;
829 my $non_issues_charges = $account->non_issues_charges;
830 my $other_charges = $balance - $non_issues_charges;
832 my $amountlimit = C4::Context->preference("noissuescharge");
833 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
834 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
836 # Check the debt of this patrons guarantees
837 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
838 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
839 if ( defined $no_issues_charge_guarantees ) {
840 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
841 my $guarantees_non_issues_charges = 0;
842 foreach my $g ( @guarantees ) {
843 $guarantees_non_issues_charges += $g->account->non_issues_charges;
846 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
847 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
848 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
849 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
850 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
851 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
855 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
856 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
857 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
858 if ( defined $no_issues_charge_guarantors ) {
859 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
861 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
862 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
863 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
864 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
865 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
866 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
870 if ( C4::Context->preference("IssuingInProcess") ) {
871 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
872 $issuingimpossible{DEBT} = $non_issues_charges;
873 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
874 $needsconfirmation{DEBT} = $non_issues_charges;
875 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
876 $needsconfirmation{DEBT} = $non_issues_charges;
880 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
881 $needsconfirmation{DEBT} = $non_issues_charges;
882 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
883 $issuingimpossible{DEBT} = $non_issues_charges;
884 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
885 $needsconfirmation{DEBT} = $non_issues_charges;
889 if ($balance > 0 && $other_charges > 0) {
890 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
893 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
894 $patron_unblessed = $patron->unblessed;
896 if ( my $debarred_date = $patron->is_debarred ) {
897 # patron has accrued fine days or has a restriction. $count is a date
898 if ($debarred_date eq '9999-12-31') {
899 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
902 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
904 } elsif ( my $num_overdues = $patron->has_overdues ) {
905 ## patron has outstanding overdue loans
906 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
907 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
909 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
910 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
914 # Additional Materials Check
915 if ( C4::Context->preference("CircConfirmItemParts")
916 && $item_object->materials )
918 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
922 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
924 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
926 # Already issued to current borrower.
927 # If it is an on-site checkout if it can be switched to a normal checkout
928 # or ask whether the loan should be renewed
930 if ( $issue->onsite_checkout
931 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
932 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
934 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
935 $patron->borrowernumber,
936 $item_object->itemnumber,
938 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
939 if ( $renewerror eq 'onsite_checkout' ) {
940 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
943 $issuingimpossible{NO_MORE_RENEWALS} = 1;
947 $needsconfirmation{RENEW_ISSUE} = 1;
953 # issued to someone else
955 my $patron = Koha::Patrons->find( $issue->borrowernumber );
957 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
959 unless ( $can_be_returned ) {
960 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
961 $issuingimpossible{branch_to_return} = $message;
963 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
964 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
966 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
967 $needsconfirmation{issued_firstname} = $patron->firstname;
968 $needsconfirmation{issued_surname} = $patron->surname;
969 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
970 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
975 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
977 my $switch_onsite_checkout = (
978 C4::Context->preference('SwitchOnSiteCheckouts')
980 and $issue->onsite_checkout
981 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
982 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
983 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
984 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
985 if ( $toomany->{max_allowed} == 0 ) {
986 $needsconfirmation{PATRON_CANT} = 1;
988 if ( C4::Context->preference("AllowTooManyOverride") ) {
989 $needsconfirmation{TOO_MANY} = $toomany->{reason};
990 $needsconfirmation{current_loan_count} = $toomany->{count};
991 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
993 $issuingimpossible{TOO_MANY} = $toomany->{reason};
994 $issuingimpossible{current_loan_count} = $toomany->{count};
995 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1000 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1002 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1003 my $wants_check = $patron->wants_check_for_previous_checkout;
1004 $needsconfirmation{PREVISSUE} = 1
1005 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1010 if ( $item_object->notforloan )
1012 if(!C4::Context->preference("AllowNotForLoanOverride")){
1013 $issuingimpossible{NOT_FOR_LOAN} = 1;
1014 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1016 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1017 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1021 # we have to check itemtypes.notforloan also
1022 if (C4::Context->preference('item-level_itypes')){
1023 # this should probably be a subroutine
1024 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1025 $sth->execute($effective_itemtype);
1026 my $notforloan=$sth->fetchrow_hashref();
1027 if ($notforloan->{'notforloan'}) {
1028 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1029 $issuingimpossible{NOT_FOR_LOAN} = 1;
1030 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1032 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1033 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1038 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1039 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1040 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1041 $issuingimpossible{NOT_FOR_LOAN} = 1;
1042 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1044 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1045 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1050 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1052 $issuingimpossible{WTHDRAWN} = 1;
1054 if ( $item_object->restricted
1055 && $item_object->restricted == 1 )
1057 $issuingimpossible{RESTRICTED} = 1;
1059 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1060 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1061 my $code = $av->count ? $av->next->lib : '';
1062 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1063 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1065 if ( C4::Context->preference("IndependentBranches") ) {
1066 my $userenv = C4::Context->userenv;
1067 unless ( C4::Context->IsSuperLibrarian() ) {
1068 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1069 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1070 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1071 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1073 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1074 if ( $patron->branchcode ne $userenv->{branch} );
1079 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1081 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1082 if ($rentalConfirmation) {
1083 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1085 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1086 if ($itemtype_object) {
1087 my $accumulate_charge = $fees->accumulate_rentalcharge();
1088 if ( $accumulate_charge > 0 ) {
1089 $rentalCharge += $accumulate_charge;
1093 if ( $rentalCharge > 0 ) {
1094 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1098 unless ( $ignore_reserves ) {
1099 # See if the item is on reserve.
1100 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1102 my $resbor = $res->{'borrowernumber'};
1103 if ( $resbor ne $patron->borrowernumber ) {
1104 my $patron = Koha::Patrons->find( $resbor );
1105 if ( $restype eq "Waiting" )
1107 # The item is on reserve and waiting, but has been
1108 # reserved by some other patron.
1109 $needsconfirmation{RESERVE_WAITING} = 1;
1110 $needsconfirmation{'resfirstname'} = $patron->firstname;
1111 $needsconfirmation{'ressurname'} = $patron->surname;
1112 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1113 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1114 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1115 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1116 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1118 elsif ( $restype eq "Reserved" ) {
1119 # The item is on reserve for someone else.
1120 $needsconfirmation{RESERVED} = 1;
1121 $needsconfirmation{'resfirstname'} = $patron->firstname;
1122 $needsconfirmation{'ressurname'} = $patron->surname;
1123 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1124 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1125 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1126 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1127 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1129 elsif ( $restype eq "Transferred" ) {
1130 # The item is determined hold being transferred for someone else.
1131 $needsconfirmation{TRANSFERRED} = 1;
1132 $needsconfirmation{'resfirstname'} = $patron->firstname;
1133 $needsconfirmation{'ressurname'} = $patron->surname;
1134 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1135 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1136 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1137 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1138 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1140 elsif ( $restype eq "Processing" ) {
1141 # The item is determined hold being processed for someone else.
1142 $needsconfirmation{PROCESSING} = 1;
1143 $needsconfirmation{'resfirstname'} = $patron->firstname;
1144 $needsconfirmation{'ressurname'} = $patron->surname;
1145 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1146 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1147 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1148 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1149 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1155 ## CHECK AGE RESTRICTION
1156 my $agerestriction = $biblioitem->agerestriction;
1157 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1158 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1159 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1160 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1163 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1167 ## check for high holds decreasing loan period
1168 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1169 my $check = checkHighHolds( $item_object, $patron );
1171 if ( $check->{exceeded} ) {
1172 if ($override_high_holds) {
1173 $alerts{HIGHHOLDS} = {
1174 num_holds => $check->{outstanding},
1175 duration => $check->{duration},
1176 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1180 $needsconfirmation{HIGHHOLDS} = {
1181 num_holds => $check->{outstanding},
1182 duration => $check->{duration},
1183 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1190 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1191 # don't do the multiple loans per bib check if we've
1192 # already determined that we've got a loan on the same item
1193 !$issuingimpossible{NO_MORE_RENEWALS} &&
1194 !$needsconfirmation{RENEW_ISSUE}
1196 # Check if borrower has already issued an item from the same biblio
1197 # Only if it's not a subscription
1198 my $biblionumber = $item_object->biblionumber;
1199 require C4::Serials;
1200 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1201 unless ($is_a_subscription) {
1202 # FIXME Should be $patron->checkouts($args);
1203 my $checkouts = Koha::Checkouts->search(
1205 borrowernumber => $patron->borrowernumber,
1206 biblionumber => $biblionumber,
1212 # if we get here, we don't already have a loan on this item,
1213 # so if there are any loans on this bib, ask for confirmation
1214 if ( $checkouts->count ) {
1215 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1220 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1223 =head2 CanBookBeReturned
1225 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1227 Check whether the item can be returned to the provided branch
1231 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1233 =item C<$branch> is the branchcode where the return is taking place
1241 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1243 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1249 sub CanBookBeReturned {
1250 my ($item, $branch) = @_;
1251 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1253 # assume return is allowed to start
1257 # identify all cases where return is forbidden
1258 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1260 $message = $item->{'homebranch'};
1261 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1263 $message = $item->{'holdingbranch'};
1264 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1266 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1269 return ($allowed, $message);
1272 =head2 CheckHighHolds
1274 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1275 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1276 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1280 sub checkHighHolds {
1281 my ( $item, $patron ) = @_;
1282 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1291 my $holds = Koha::Holds->search( { biblionumber => $item->biblionumber } );
1293 if ( $holds->count() ) {
1294 $return_data->{outstanding} = $holds->count();
1296 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1297 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1298 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1300 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1302 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1304 # static means just more than a given number of holds on the record
1306 # If the number of holds is less than the threshold, we can stop here
1307 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1308 return $return_data;
1311 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1313 # dynamic means X more than the number of holdable items on the record
1315 # let's get the items
1316 my @items = $holds->next()->biblio()->items()->as_list;
1318 # Remove any items with status defined to be ignored even if the would not make item unholdable
1319 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1320 @items = grep { !$_->$status } @items;
1323 # Remove any items that are not holdable for this patron
1324 @items = grep { CanItemBeReserved( $patron , $_, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1326 my $items_count = scalar @items;
1328 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1330 # If the number of holds is less than the count of items we have
1331 # plus the number of holds allowed above that count, we can stop here
1332 if ( $holds->count() <= $threshold ) {
1333 return $return_data;
1337 my $issuedate = dt_from_string();
1339 my $itype = $item->effective_itemtype;
1340 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1342 categorycode => $patron->categorycode,
1344 branchcode => $branchcode,
1347 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1349 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1351 my $rule = Koha::CirculationRules->get_effective_rule(
1353 categorycode => $patron->categorycode,
1354 itemtype => $item->effective_itemtype,
1355 branchcode => $branchcode,
1356 rule_name => 'decreaseloanholds',
1361 if ( defined($rule) && $rule->rule_value ne '' ){
1362 # overrides decreaseLoanHighHoldsDuration syspref
1363 $duration = $rule->rule_value;
1365 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1367 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1368 $reduced_datedue->set_hour($orig_due->hour);
1369 $reduced_datedue->set_minute($orig_due->minute);
1370 $reduced_datedue->truncate( to => 'minute' );
1372 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1373 $return_data->{exceeded} = 1;
1374 $return_data->{duration} = $duration;
1375 $return_data->{due_date} = $reduced_datedue;
1379 return $return_data;
1384 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1386 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1390 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1392 =item C<$barcode> is the barcode of the item being issued.
1394 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1395 Calculated if empty.
1397 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1399 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1400 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1402 AddIssue does the following things :
1404 - step 01: check that there is a borrowernumber & a barcode provided
1405 - check for RENEWAL (book issued & being issued to the same patron)
1406 - renewal YES = Calculate Charge & renew
1408 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1410 - fill reserve if reserve to this patron
1411 - cancel reserve or not, otherwise
1412 * TRANSFERT PENDING ?
1413 - complete the transfert
1421 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1423 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1424 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1425 my $auto_renew = $params && $params->{auto_renew};
1426 my $dbh = C4::Context->dbh;
1427 my $barcodecheck = CheckValidBarcode($barcode);
1431 if ( $datedue && ref $datedue ne 'DateTime' ) {
1432 $datedue = dt_from_string($datedue);
1435 # $issuedate defaults to today.
1436 if ( !defined $issuedate ) {
1437 $issuedate = dt_from_string();
1440 if ( ref $issuedate ne 'DateTime' ) {
1441 $issuedate = dt_from_string($issuedate);
1446 # Stop here if the patron or barcode doesn't exist
1447 if ( $borrower && $barcode && $barcodecheck ) {
1448 # find which item we issue
1449 my $item_object = Koha::Items->find({ barcode => $barcode })
1450 or return; # if we don't get an Item, abort.
1451 my $item_unblessed = $item_object->unblessed;
1453 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1455 # get actual issuing if there is one
1456 my $actualissue = $item_object->checkout;
1458 # check if we just renew the issue.
1459 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1460 and not $switch_onsite_checkout ) {
1461 $datedue = AddRenewal(
1462 $borrower->{'borrowernumber'},
1463 $item_object->itemnumber,
1466 $issuedate, # here interpreted as the renewal date
1471 my $itype = $item_object->effective_itemtype;
1472 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1475 $datedue->truncate( to => 'minute' );
1477 my $patron = Koha::Patrons->find( $borrower );
1478 my $library = Koha::Libraries->find( $branchcode );
1479 my $fees = Koha::Charges::Fees->new(
1482 library => $library,
1483 item => $item_object,
1484 to_date => $datedue,
1488 # it's NOT a renewal
1489 if ( $actualissue and not $switch_onsite_checkout ) {
1490 # This book is currently on loan, but not to the person
1491 # who wants to borrow it now. mark it returned before issuing to the new borrower
1492 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1493 return unless $allowed;
1494 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1495 # AddReturn certainly has side-effects, like onloan => undef
1496 $item_object->discard_changes;
1499 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1501 # Starting process for transfer job (checking transfert and validate it if we have one)
1502 if ( my $transfer = $item_object->get_transfer ) {
1503 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1506 datearrived => dt_from_string,
1507 tobranch => C4::Context->userenv->{branch},
1508 comments => 'Forced branchtransfer'
1511 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1512 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1513 if ( $hold ) { # Is this really needed?
1514 $hold->set( { found => undef } )->store;
1515 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1520 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1521 unless ($auto_renew) {
1522 my $rule = Koha::CirculationRules->get_effective_rule(
1524 categorycode => $borrower->{categorycode},
1525 itemtype => $item_object->effective_itemtype,
1526 branchcode => $branchcode,
1527 rule_name => 'auto_renew'
1531 $auto_renew = $rule->rule_value if $rule;
1534 my $issue_attributes = {
1535 borrowernumber => $borrower->{'borrowernumber'},
1536 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1537 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1538 branchcode => C4::Context->userenv->{'branch'},
1539 onsite_checkout => $onsite_checkout,
1540 auto_renew => $auto_renew ? 1 : 0,
1543 # Get ID of logged in user. if called from a batch job,
1544 # no user session exists and C4::Context->userenv() returns
1545 # the scalar '0'. Only do this if the syspref says so
1546 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1547 my $userenv = C4::Context->userenv();
1548 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1550 $issue_attributes->{issuer_id} = $usernumber;
1554 # In the case that the borrower has an on-site checkout
1555 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1556 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1558 $issue->set($issue_attributes)->store;
1561 $issue = Koha::Checkout->new(
1563 itemnumber => $item_object->itemnumber,
1568 $issue->discard_changes;
1569 C4::Auth::track_login_daily( $borrower->{userid} );
1570 if ( $item_object->location && $item_object->location eq 'CART'
1571 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1572 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1573 CartToShelf( $item_object->itemnumber );
1576 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1577 UpdateTotalIssues( $item_object->biblionumber, 1 );
1580 # Record if item was lost
1581 my $was_lost = $item_object->itemlost;
1583 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1584 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1585 $item_object->itemlost(0);
1586 $item_object->onloan($datedue->ymd());
1587 $item_object->datelastborrowed( dt_from_string()->ymd() );
1588 $item_object->datelastseen( dt_from_string()->ymd() );
1589 $item_object->store({log_action => 0});
1591 # If the item was lost, it has now been found, charge the overdue if necessary
1593 if ( $item_object->{_charge} ) {
1594 $actualissue //= Koha::Old::Checkouts->search(
1595 { itemnumber => $item_unblessed->{itemnumber} },
1597 order_by => { '-desc' => 'returndate' },
1601 unless ( exists( $borrower->{branchcode} ) ) {
1602 my $patron = $actualissue->patron;
1603 $borrower = $patron->unblessed;
1605 _CalculateAndUpdateFine(
1607 issue => $actualissue,
1608 item => $item_unblessed,
1609 borrower => $borrower,
1610 return_date => $issuedate
1613 _FixOverduesOnReturn( $borrower->{borrowernumber},
1614 $item_object->itemnumber, undef, 'RENEWED' );
1618 # If it costs to borrow this book, charge it to the patron's account.
1619 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1620 if ( $charge && $charge > 0 ) {
1621 AddIssuingCharge( $issue, $charge, 'RENT' );
1624 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1625 if ( $itemtype_object ) {
1626 my $accumulate_charge = $fees->accumulate_rentalcharge();
1627 if ( $accumulate_charge > 0 ) {
1628 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1629 $charge += $accumulate_charge;
1630 $item_unblessed->{charge} = $charge;
1634 # Record the fact that this book was issued.
1635 C4::Stats::UpdateStats(
1637 branch => C4::Context->userenv->{'branch'},
1638 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1640 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1641 itemnumber => $item_object->itemnumber,
1642 itemtype => $item_object->effective_itemtype,
1643 location => $item_object->location,
1644 borrowernumber => $borrower->{'borrowernumber'},
1645 ccode => $item_object->ccode,
1649 # Send a checkout slip.
1650 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1652 branchcode => $branchcode,
1653 categorycode => $borrower->{categorycode},
1654 item_type => $item_object->effective_itemtype,
1655 notification => 'CHECKOUT',
1657 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1658 SendCirculationAlert(
1661 item => $item_object->unblessed,
1662 borrower => $borrower,
1663 branch => $branchcode,
1668 "CIRCULATION", "ISSUE",
1669 $borrower->{'borrowernumber'},
1670 $item_object->itemnumber,
1671 ) if C4::Context->preference("IssueLog");
1673 Koha::Plugins->call('after_circ_action', {
1674 action => 'checkout',
1676 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1677 checkout => $issue->get_from_storage
1685 =head2 GetLoanLength
1687 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1689 Get loan length for an itemtype, a borrower type and a branch
1694 my ( $categorycode, $itemtype, $branchcode ) = @_;
1696 # Initialize default values
1700 lengthunit => 'days',
1703 my $found = Koha::CirculationRules->get_effective_rules( {
1704 branchcode => $branchcode,
1705 categorycode => $categorycode,
1706 itemtype => $itemtype,
1715 foreach my $rule_name (keys %$found) {
1716 $rules->{$rule_name} = $found->{$rule_name};
1723 =head2 GetHardDueDate
1725 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1727 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1731 sub GetHardDueDate {
1732 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1734 my $rules = Koha::CirculationRules->get_effective_rules(
1736 categorycode => $borrowertype,
1737 itemtype => $itemtype,
1738 branchcode => $branchcode,
1739 rules => [ 'hardduedate', 'hardduedatecompare' ],
1743 if ( defined( $rules->{hardduedate} ) ) {
1744 if ( $rules->{hardduedate} ) {
1745 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1748 return ( undef, undef );
1753 =head2 GetBranchBorrowerCircRule
1755 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1757 Retrieves circulation rule attributes that apply to the given
1758 branch and patron category, regardless of item type.
1759 The return value is a hashref containing the following key:
1761 patron_maxissueqty - maximum number of loans that a
1762 patron of the given category can have at the given
1763 branch. If the value is undef, no limit.
1765 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1766 patron of the given category can have at the given
1767 branch. If the value is undef, no limit.
1769 This will check for different branch/category combinations in the following order:
1773 default branch and category
1775 If no rule has been found in the database, it will default to
1778 patron_maxissueqty - undef
1779 patron_maxonsiteissueqty - undef
1781 C<$branchcode> and C<$categorycode> should contain the
1782 literal branch code and patron category code, respectively - no
1787 sub GetBranchBorrowerCircRule {
1788 my ( $branchcode, $categorycode ) = @_;
1790 # Initialize default values
1792 patron_maxissueqty => undef,
1793 patron_maxonsiteissueqty => undef,
1797 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1798 my $rule = Koha::CirculationRules->get_effective_rule(
1800 categorycode => $categorycode,
1802 branchcode => $branchcode,
1803 rule_name => $rule_name,
1807 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1813 =head2 GetBranchItemRule
1815 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1817 Retrieves circulation rule attributes that apply to the given
1818 branch and item type, regardless of patron category.
1820 The return value is a hashref containing the following keys:
1822 holdallowed => Hold policy for this branch and itemtype. Possible values:
1823 not_allowed: No holds allowed.
1824 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1825 from_any_library: Holds allowed from any patron.
1826 from_local_hold_group: Holds allowed from libraries in hold group
1828 returnbranch => branch to which to return item. Possible values:
1829 noreturn: do not return, let item remain where checked in (floating collections)
1830 homebranch: return to item's home branch
1831 holdingbranch: return to issuer branch
1833 This searches branchitemrules in the following order:
1835 * Same branchcode and itemtype
1836 * Same branchcode, itemtype '*'
1837 * branchcode '*', same itemtype
1838 * branchcode and itemtype '*'
1840 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1844 sub GetBranchItemRule {
1845 my ( $branchcode, $itemtype ) = @_;
1848 my $rules = Koha::CirculationRules->get_effective_rules({
1849 branchcode => $branchcode,
1850 itemtype => $itemtype,
1851 rules => ['holdallowed', 'hold_fulfillment_policy', 'returnbranch']
1854 # built-in default circulation rule
1855 $rules->{holdallowed} //= 'from_any_library';
1856 $rules->{hold_fulfillment_policy} //= 'any';
1857 $rules->{returnbranch} //= 'homebranch';
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_} = ''; }
1996 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
1997 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
1999 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2000 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2004 foreach my $key ( keys %$update_loc_rules ) {
2005 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2006 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2007 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2008 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2009 $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2016 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2018 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2020 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2022 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2025 foreach my $key ( keys %$rules ) {
2026 if ( $item->notforloan eq $key ) {
2027 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2028 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2035 # check if the return is allowed at this branch
2036 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2037 unless ($returnallowed){
2038 $messages->{'Wrongbranch'} = {
2039 Wrongbranch => $branch,
2040 Rightbranch => $message
2043 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2044 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2045 return ( $doreturn, $messages, $issue, $patron_unblessed);
2048 if ( $item->withdrawn ) { # book has been cancelled
2049 $messages->{'withdrawn'} = 1;
2050 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2053 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2057 # case of a return of document (deal with issues and holdingbranch)
2059 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2060 $patron or warn "AddReturn without current borrower";
2064 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2069 C4::Context->preference('CalculateFinesOnReturn')
2070 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2075 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2078 carp "The checkin for the following issue failed, Please go to the about page and check all messages on the 'System information' to see if there are configuration / data issues ($@)" . Dumper( $issue->unblessed );
2080 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2081 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2083 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2086 # FIXME is the "= 1" right? This could be the borrower hash.
2087 $messages->{'WasReturned'} = 1;
2090 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2094 # the holdingbranch is updated if the document is returned to another location.
2095 # this is always done regardless of whether the item was on loan or not
2096 if ($item->holdingbranch ne $branch) {
2097 $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2100 my $item_was_lost = $item->itemlost;
2101 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2102 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2104 # fix up the accounts.....
2105 if ($item_was_lost) {
2106 $messages->{'WasLost'} = 1;
2107 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2108 my @object_messages = @{ $updated_item->object_messages };
2109 for my $message (@object_messages) {
2110 $messages->{'LostItemFeeRefunded'} = 1
2111 if $message->message eq 'lost_refunded';
2112 $messages->{'LostItemFeeRestored'} = 1
2113 if $message->message eq 'lost_restored';
2115 if ( $message->message eq 'lost_charge' ) {
2116 $issue //= Koha::Old::Checkouts->search(
2117 { itemnumber => $item->itemnumber },
2118 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2120 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2121 my $patron = $issue->patron;
2122 $patron_unblessed = $patron->unblessed;
2124 _CalculateAndUpdateFine(
2127 item => $item->unblessed,
2128 borrower => $patron_unblessed,
2129 return_date => $return_date
2132 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2133 $item->itemnumber, undef, 'RETURNED' );
2134 $messages->{'LostItemFeeCharged'} = 1;
2140 # check if we have a transfer for this document
2141 my $transfer = $item->get_transfer;
2143 # if we have a transfer to complete, we update the line of transfers with the datearrived
2146 if ( $transfer->in_transit ) {
2147 if ( $transfer->tobranch eq $branch ) {
2149 $messages->{'TransferArrived'} = $transfer->frombranch;
2150 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2151 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2154 $messages->{'WrongTransfer'} = $transfer->tobranch;
2155 $messages->{'WrongTransferItem'} = $item->itemnumber;
2156 $messages->{'TransferTrigger'} = $transfer->reason;
2160 if ( $transfer->tobranch eq $branch ) {
2162 $messages->{'TransferArrived'} = $transfer->frombranch;
2163 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2164 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2167 $messages->{'WasTransfered'} = $transfer->tobranch;
2168 $messages->{'TransferTrigger'} = $transfer->reason;
2173 # fix up the overdues in accounts...
2174 if ($borrowernumber) {
2175 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2176 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2178 if ( $issue and $issue->is_overdue($return_date) ) {
2180 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2182 $messages->{'PrevDebarred'} = $debardate;
2184 $messages->{'Debarred'} = $debardate if $debardate;
2186 # there's no overdue on the item but borrower had been previously debarred
2187 } elsif ( $issue->date_due and $patron->debarred ) {
2188 if ( $patron->debarred eq "9999-12-31") {
2189 $messages->{'ForeverDebarred'} = $patron->debarred;
2191 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2192 $borrower_debar_dt->truncate(to => 'day');
2193 my $today_dt = $return_date->clone()->truncate(to => 'day');
2194 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2195 $messages->{'PrevDebarred'} = $patron->debarred;
2201 # find reserves.....
2202 # launch the Checkreserves routine to find any holds
2203 my ($resfound, $resrec);
2204 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2205 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2206 # 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)
2207 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2208 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2209 $resfound = 'Reserved';
2210 $resrec = $hold->unblessed;
2213 $resrec->{'ResFound'} = $resfound;
2214 $messages->{'ResFound'} = $resrec;
2217 # Record the fact that this book was returned.
2218 C4::Stats::UpdateStats({
2221 itemnumber => $itemnumber,
2222 itemtype => $itemtype,
2223 location => $item->location,
2224 borrowernumber => $borrowernumber,
2225 ccode => $item->ccode,
2228 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2230 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2232 branchcode => $branch,
2233 categorycode => $patron->categorycode,
2234 item_type => $itemtype,
2235 notification => 'CHECKIN',
2237 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2238 SendCirculationAlert({
2240 item => $item->unblessed,
2241 borrower => $patron->unblessed,
2247 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2248 if C4::Context->preference("ReturnLog");
2251 # Check if this item belongs to a biblio record that is attached to an
2252 # ILL request, if it is we need to update the ILL request's status
2253 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2254 my $request = Koha::Illrequests->find(
2255 { biblio_id => $item->biblio->biblionumber }
2257 $request->status('RET') if $request;
2260 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2261 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2262 && ( $doreturn or $messages->{'NotIssued'} )
2264 and ( $branch ne $returnbranch )
2265 and not $messages->{'WrongTransfer'}
2266 and not $messages->{'WasTransfered'} )
2268 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2269 if (C4::Context->preference("AutomaticItemReturn" ) or
2270 (C4::Context->preference("UseBranchTransferLimits") and
2271 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2273 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2274 $messages->{'WasTransfered'} = $returnbranch;
2275 $messages->{'TransferTrigger'} = $transfer_trigger;
2277 $messages->{'NeedsTransfer'} = $returnbranch;
2278 $messages->{'TransferTrigger'} = $transfer_trigger;
2282 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2283 my $claims = Koha::Checkouts::ReturnClaims->search(
2285 itemnumber => $item->id,
2286 resolution => undef,
2290 if ( $claims->count ) {
2291 $messages->{ReturnClaims} = $claims;
2295 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2296 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2298 if ( $doreturn and $issue ) {
2299 my $checkin = Koha::Old::Checkouts->find($issue->id);
2301 Koha::Plugins->call('after_circ_action', {
2302 action => 'checkin',
2309 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2312 =head2 MarkIssueReturned
2314 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2316 Unconditionally marks an issue as being returned by
2317 moving the C<issues> row to C<old_issues> and
2318 setting C<returndate> to the current date.
2320 if C<$returndate> is specified (in iso format), it is used as the date
2323 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2324 the old_issue is immediately anonymised
2326 Ideally, this function would be internal to C<C4::Circulation>,
2327 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2328 and offline_circ/process_koc.pl.
2330 The last optional parameter allos passing skip_record_index to the item store call.
2334 sub MarkIssueReturned {
2335 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2337 # Retrieve the issue
2338 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2340 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2342 my $issue_id = $issue->issue_id;
2344 my $schema = Koha::Database->schema;
2346 # FIXME Improve the return value and handle it from callers
2347 $schema->txn_do(sub {
2349 my $patron = Koha::Patrons->find( $borrowernumber );
2351 # Update the returndate value
2352 if ( $returndate ) {
2353 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2356 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2359 # Create the old_issues entry
2360 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2362 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2363 if ( $privacy && $privacy == 2) {
2364 $old_checkout->anonymize;
2367 # And finally delete the issue
2370 $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2372 if ( C4::Context->preference('StoreLastBorrower') ) {
2373 my $item = Koha::Items->find( $itemnumber );
2374 $item->last_returned_by( $patron );
2377 # Remove any OVERDUES related debarment if the borrower has no overdues
2378 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2379 && $patron->debarred
2380 && !$patron->has_overdues
2381 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2383 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2391 =head2 _debar_user_on_return
2393 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2395 C<$borrower> borrower hashref
2397 C<$item> item hashref
2399 C<$datedue> date due DateTime object
2401 C<$returndate> DateTime object representing the return time
2403 Internal function, called only by AddReturn that calculates and updates
2404 the user fine days, and debars them if necessary.
2406 Should only be called for overdue returns
2408 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2413 sub _calculate_new_debar_dt {
2414 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2416 my $branchcode = _GetCircControlBranch( $item, $borrower );
2417 my $circcontrol = C4::Context->preference('CircControl');
2418 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2419 { categorycode => $borrower->{categorycode},
2420 itemtype => $item->{itype},
2421 branchcode => $branchcode,
2426 'maxsuspensiondays',
2427 'suspension_chargeperiod',
2431 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2432 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2433 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2435 return unless $finedays;
2437 # finedays is in days, so hourly loans must multiply by 24
2438 # thus 1 hour late equals 1 day suspension * finedays rate
2439 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2441 # grace period is measured in the same units as the loan
2443 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2445 my $deltadays = DateTime::Duration->new(
2446 days => $chargeable_units
2449 if ( $deltadays->subtract($grace)->is_positive() ) {
2450 my $suspension_days = $deltadays * $finedays;
2452 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2453 # No need to / 1 and do not consider / 0
2454 $suspension_days = DateTime::Duration->new(
2455 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2459 # If the max suspension days is < than the suspension days
2460 # the suspension days is limited to this maximum period.
2461 my $max_sd = $issuing_rule->{maxsuspensiondays};
2462 if ( defined $max_sd && $max_sd ne '' ) {
2463 $max_sd = DateTime::Duration->new( days => $max_sd );
2464 $suspension_days = $max_sd
2465 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2468 my ( $has_been_extended );
2469 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2470 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2472 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2473 $has_been_extended = 1;
2478 # Use the calendar or not to calculate the debarment date
2479 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2480 my $calendar = Koha::Calendar->new(
2481 branchcode => $branchcode,
2482 days_mode => 'Calendar'
2484 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2487 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2489 return $new_debar_dt;
2494 sub _debar_user_on_return {
2495 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2497 $return_date //= dt_from_string();
2499 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2501 return unless $new_debar_dt;
2503 Koha::Patron::Debarments::AddUniqueDebarment({
2504 borrowernumber => $borrower->{borrowernumber},
2505 expiration => $new_debar_dt->ymd(),
2506 type => 'SUSPENSION',
2508 # if borrower was already debarred but does not get an extra debarment
2509 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2510 my ($new_debarment_str, $is_a_reminder);
2511 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2513 $new_debarment_str = $borrower->{debarred};
2515 $new_debarment_str = $new_debar_dt->ymd();
2517 # FIXME Should return a DateTime object
2518 return $new_debarment_str, $is_a_reminder;
2521 =head2 _FixOverduesOnReturn
2523 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2525 C<$borrowernumber> borrowernumber
2527 C<$itemnumber> itemnumber
2529 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2531 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2537 sub _FixOverduesOnReturn {
2538 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2539 unless( $borrowernumber ) {
2540 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2544 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2548 warn "_FixOverduesOnReturn() not supplied valid status";
2552 my $schema = Koha::Database->schema;
2554 my $result = $schema->txn_do(
2556 # check for overdue fine
2557 my $accountlines = Koha::Account::Lines->search(
2559 borrowernumber => $borrowernumber,
2560 itemnumber => $item,
2561 debit_type_code => 'OVERDUE',
2562 status => 'UNRETURNED'
2565 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2567 my $accountline = $accountlines->next;
2568 my $payments = $accountline->credits;
2570 my $amountoutstanding = $accountline->amountoutstanding;
2571 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2572 $accountline->delete;
2573 return 0; # no warning, we've just removed a zero value fine (backdated return)
2574 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2575 my $account = Koha::Account->new({patron_id => $borrowernumber});
2576 my $credit = $account->add_credit(
2578 amount => $amountoutstanding,
2579 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2580 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2581 interface => C4::Context->interface,
2587 $credit->apply({ debits => [ $accountline ] });
2589 if (C4::Context->preference("FinesLog")) {
2590 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2594 $accountline->status($status);
2595 return $accountline->store();
2602 =head2 _GetCircControlBranch
2604 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2608 Return the library code to be used to determine which circulation
2609 policy applies to a transaction. Looks up the CircControl and
2610 HomeOrHoldingBranch system preferences.
2612 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2614 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2618 sub _GetCircControlBranch {
2619 my ($item, $borrower) = @_;
2620 my $circcontrol = C4::Context->preference('CircControl');
2623 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2624 $branch= C4::Context->userenv->{'branch'};
2625 } elsif ($circcontrol eq 'PatronLibrary') {
2626 $branch=$borrower->{branchcode};
2628 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2629 $branch = $item->{$branchfield};
2630 # default to item home branch if holdingbranch is used
2631 # and is not defined
2632 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2633 $branch = $item->{homebranch};
2641 $issue = GetOpenIssue( $itemnumber );
2643 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2645 C<$itemnumber> is the item's itemnumber
2652 my ( $itemnumber ) = @_;
2653 return unless $itemnumber;
2654 my $dbh = C4::Context->dbh;
2655 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2656 $sth->execute( $itemnumber );
2657 return $sth->fetchrow_hashref();
2661 =head2 GetUpcomingDueIssues
2663 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2667 sub GetUpcomingDueIssues {
2670 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2671 my $dbh = C4::Context->dbh;
2674 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2676 LEFT JOIN items USING (itemnumber)
2677 LEFT JOIN branches ON branches.branchcode =
2679 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2680 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2681 my @bind_parameters = ( $params->{'days_in_advance'} );
2683 my $sth = $dbh->prepare( $statement );
2684 $sth->execute( @bind_parameters );
2685 my $upcoming_dues = $sth->fetchall_arrayref({});
2687 return $upcoming_dues;
2690 =head2 CanBookBeRenewed
2692 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2694 Find out whether a borrowed item may be renewed.
2696 C<$borrowernumber> is the borrower number of the patron who currently
2697 has the item on loan.
2699 C<$itemnumber> is the number of the item to renew.
2701 C<$override_limit>, if supplied with a true value, causes
2702 the limit on the number of times that the loan can be renewed
2703 (as controlled by the item type) to be ignored. Overriding also allows
2704 to renew sooner than "No renewal before" and to manually renew loans
2705 that are automatically renewed.
2707 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2708 item must currently be on loan to the specified borrower; renewals
2709 must be allowed for the item's type; and the borrower must not have
2710 already renewed the loan. $error will contain the reason the renewal can not proceed
2714 sub CanBookBeRenewed {
2715 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2717 my $auto_renew = "no";
2719 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2720 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2721 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2722 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2724 my $patron = $issue->patron or return;
2726 # override_limit will override anything else except on_reserve
2727 unless ( $override_limit ){
2728 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2729 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2731 categorycode => $patron->categorycode,
2732 itemtype => $item->effective_itemtype,
2733 branchcode => $branchcode,
2737 'unseen_renewals_allowed'
2742 return ( 0, "too_many" )
2743 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2745 return ( 0, "too_unseen" )
2746 if C4::Context->preference('UnseenRenewals') &&
2747 $issuing_rule->{unseen_renewals_allowed} &&
2748 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2750 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2751 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2752 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2753 my $restricted = $patron->is_debarred;
2754 my $hasoverdues = $patron->has_overdues;
2756 if ( $restricted and $restrictionblockrenewing ) {
2757 return ( 0, 'restriction');
2758 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2759 return ( 0, 'overdue');
2762 $auto_renew = _CanBookBeAutoRenewed({
2765 branchcode => $branchcode,
2768 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_soon' && $cron;
2769 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2770 # extra notices being sent. Cron also implies no override
2771 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2772 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2773 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2776 my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2778 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2779 if ( $resfound && $resrec->{non_priority} ) {
2780 $resfound = Koha::Holds->search(
2781 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2787 # This item can fill one or more unfilled reserve, can those unfilled reserves
2788 # all be filled by other available items?
2790 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2792 my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2794 # There is an item level hold on this item, no other item can fill the hold
2799 # Get all other items that could possibly fill reserves
2800 my $items = Koha::Items->search({
2801 biblionumber => $resrec->{biblionumber},
2804 -not => { itemnumber => $itemnumber }
2807 # Get all other reserves that could have been filled by this item
2808 my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2809 my $patrons = Koha::Patrons->search({
2810 borrowernumber => { -in => \@borrowernumbers }
2813 # If the count of the union of the lists of reservable items for each borrower
2814 # is equal or greater than the number of borrowers, we know that all reserves
2815 # can be filled with available items. We can get the union of the sets simply
2816 # by pushing all the elements onto an array and removing the duplicates.
2818 ITEM: while ( my $item = $items->next ) {
2819 next if IsItemOnHoldAndFound( $item->itemnumber );
2820 while ( my $patron = $patrons->next ) {
2821 next unless IsAvailableForItemLevelRequest($item, $patron);
2822 next unless CanItemBeReserved($patron,$item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2823 push @reservable, $item->itemnumber;
2824 if (@reservable >= @borrowernumbers) {
2835 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2836 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2837 if ( GetSoonestRenewDate($borrowernumber, $itemnumber) > dt_from_string() ){
2838 return (0, "too_soon") unless $override_limit;
2841 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2843 return ( 1, undef );
2848 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2852 C<$borrowernumber> is the borrower number of the patron who currently
2855 C<$itemnumber> is the number of the item to renew.
2857 C<$branch> is the library where the renewal took place (if any).
2858 The library that controls the circ policies for the renewal is retrieved from the issues record.
2860 C<$datedue> can be a DateTime object used to set the due date.
2862 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2863 this parameter is not supplied, lastreneweddate is set to the current date.
2865 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2866 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2867 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2870 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2871 from the book's item type.
2873 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
2874 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
2875 fallback to a true value
2880 my $borrowernumber = shift;
2881 my $itemnumber = shift or return;
2883 my $datedue = shift;
2884 my $lastreneweddate = shift || dt_from_string();
2885 my $skipfinecalc = shift;
2888 # Fallback on a 'seen' renewal
2889 $seen = defined $seen && $seen == 0 ? 0 : 1;
2891 my $item_object = Koha::Items->find($itemnumber) or return;
2892 my $biblio = $item_object->biblio;
2893 my $issue = $item_object->checkout;
2894 my $item_unblessed = $item_object->unblessed;
2896 my $dbh = C4::Context->dbh;
2898 return unless $issue;
2900 $borrowernumber ||= $issue->borrowernumber;
2902 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2903 carp 'Invalid date passed to AddRenewal.';
2907 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2908 my $patron_unblessed = $patron->unblessed;
2910 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2912 my $schema = Koha::Database->schema;
2913 $schema->txn_do(sub{
2915 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
2916 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2918 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2920 # If the due date wasn't specified, calculate it by adding the
2921 # book's loan length to today's date or the current due date
2922 # based on the value of the RenewalPeriodBase syspref.
2923 my $itemtype = $item_object->effective_itemtype;
2926 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2927 dt_from_string( $issue->date_due, 'sql' ) :
2929 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2932 my $fees = Koha::Charges::Fees->new(
2935 library => $circ_library,
2936 item => $item_object,
2937 from_date => dt_from_string( $issue->date_due, 'sql' ),
2938 to_date => dt_from_string($datedue),
2942 # Increment the unseen renewals, if appropriate
2943 # We only do so if the syspref is enabled and
2944 # a maximum value has been set in the circ rules
2945 my $unseen_renewals = $issue->unseen_renewals;
2946 if (C4::Context->preference('UnseenRenewals')) {
2947 my $rule = Koha::CirculationRules->get_effective_rule(
2948 { categorycode => $patron->categorycode,
2949 itemtype => $item_object->effective_itemtype,
2950 branchcode => $circ_library->branchcode,
2951 rule_name => 'unseen_renewals_allowed'
2954 if (!$seen && $rule && $rule->rule_value) {
2957 # If the renewal is seen, unseen should revert to 0
2958 $unseen_renewals = 0;
2962 # Update the issues record to have the new due date, and a new count
2963 # of how many times it has been renewed.
2964 my $renews = ( $issue->renewals || 0 ) + 1;
2965 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
2968 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
2971 Koha::Exceptions::Checkout::FailedRenewal->throw(
2972 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
2976 # Update the renewal count on the item, and tell zebra to reindex
2977 $renews = ( $item_object->renewals || 0 ) + 1;
2978 $item_object->renewals($renews);
2979 $item_object->onloan($datedue);
2980 $item_object->store({ log_action => 0 });
2982 # Charge a new rental fee, if applicable
2983 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2984 if ( $charge > 0 ) {
2985 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
2988 # Charge a new accumulate rental fee, if applicable
2989 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2990 if ( $itemtype_object ) {
2991 my $accumulate_charge = $fees->accumulate_rentalcharge();
2992 if ( $accumulate_charge > 0 ) {
2993 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
2995 $charge += $accumulate_charge;
2998 # Send a renewal slip according to checkout alert preferencei
2999 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3000 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3002 branchcode => $branch,
3003 categorycode => $patron->categorycode,
3004 item_type => $itemtype,
3005 notification => 'CHECKOUT',
3007 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3008 SendCirculationAlert(
3011 item => $item_unblessed,
3012 borrower => $patron->unblessed,
3019 # Remove any OVERDUES related debarment if the borrower has no overdues
3021 && $patron->is_debarred
3022 && ! $patron->has_overdues
3023 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3025 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3028 # Add the renewal to stats
3029 C4::Stats::UpdateStats(
3031 branch => $item_object->renewal_branchcode({branch => $branch}),
3034 itemnumber => $itemnumber,
3035 itemtype => $itemtype,
3036 location => $item_object->location,
3037 borrowernumber => $borrowernumber,
3038 ccode => $item_object->ccode,
3043 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3045 Koha::Plugins->call('after_circ_action', {
3046 action => 'renewal',
3048 checkout => $issue->get_from_storage
3057 # check renewal status
3058 my ( $bornum, $itemno ) = @_;
3059 my $dbh = C4::Context->dbh;
3061 my $unseencount = 0;
3062 my $renewsallowed = 0;
3063 my $unseenallowed = 0;
3067 my $patron = Koha::Patrons->find( $bornum );
3068 my $item = Koha::Items->find($itemno);
3070 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3072 # Look in the issues table for this item, lent to this borrower,
3073 # and not yet returned.
3075 # FIXME - I think this function could be redone to use only one SQL call.
3076 my $sth = $dbh->prepare(
3077 "select * from issues
3078 where (borrowernumber = ?)
3079 and (itemnumber = ?)"
3081 $sth->execute( $bornum, $itemno );
3082 my $data = $sth->fetchrow_hashref;
3083 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3084 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3085 # $item and $borrower should be calculated
3086 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3088 my $rules = Koha::CirculationRules->get_effective_rules(
3090 categorycode => $patron->categorycode,
3091 itemtype => $item->effective_itemtype,
3092 branchcode => $branchcode,
3093 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3096 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3097 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3098 $rules->{unseen_renewals_allowed} :
3100 $renewsleft = $renewsallowed - $renewcount;
3101 $unseenleft = $unseenallowed - $unseencount;
3102 if($renewsleft < 0){ $renewsleft = 0; }
3103 if($unseenleft < 0){ $unseenleft = 0; }
3114 =head2 GetSoonestRenewDate
3116 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3118 Find out the soonest possible renew date of a borrowed item.
3120 C<$borrowernumber> is the borrower number of the patron who currently
3121 has the item on loan.
3123 C<$itemnumber> is the number of the item to renew.
3125 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3126 renew date, based on the value "No renewal before" of the applicable
3127 issuing rule. Returns the current date if the item can already be
3128 renewed, and returns undefined if the borrower, loan, or item
3133 sub GetSoonestRenewDate {
3134 my ( $borrowernumber, $itemnumber ) = @_;
3136 my $dbh = C4::Context->dbh;
3138 my $item = Koha::Items->find($itemnumber) or return;
3139 my $itemissue = $item->checkout or return;
3141 $borrowernumber ||= $itemissue->borrowernumber;
3142 my $patron = Koha::Patrons->find( $borrowernumber )
3145 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3146 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3147 { categorycode => $patron->categorycode,
3148 itemtype => $item->effective_itemtype,
3149 branchcode => $branchcode,
3157 my $now = dt_from_string;
3159 if ( defined $issuing_rule->{norenewalbefore}
3160 and $issuing_rule->{norenewalbefore} ne "" )
3162 my $soonestrenewal =
3163 dt_from_string( $itemissue->date_due )->subtract(
3164 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3166 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3167 and $issuing_rule->{lengthunit} eq 'days' )
3169 $soonestrenewal->truncate( to => 'day' );
3171 return $soonestrenewal if $now < $soonestrenewal;
3172 } elsif ( $itemissue->auto_renew && $patron->autorenew_checkouts ) {
3173 # Checkouts with auto-renewing fall back to due date
3174 my $soonestrenewal = dt_from_string( $itemissue->date_due );
3175 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3176 and $issuing_rule->{lengthunit} eq 'days' )
3178 $soonestrenewal->truncate( to => 'day' );
3180 return $soonestrenewal;
3185 =head2 GetLatestAutoRenewDate
3187 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3189 Find out the latest possible auto renew date of a borrowed item.
3191 C<$borrowernumber> is the borrower number of the patron who currently
3192 has the item on loan.
3194 C<$itemnumber> is the number of the item to renew.
3196 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3197 auto renew date, based on the value "No auto renewal after" and the "No auto
3198 renewal after (hard limit) of the applicable issuing rule.
3199 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3200 or item cannot be found.
3204 sub GetLatestAutoRenewDate {
3205 my ( $borrowernumber, $itemnumber ) = @_;
3207 my $dbh = C4::Context->dbh;
3209 my $item = Koha::Items->find($itemnumber) or return;
3210 my $itemissue = $item->checkout or return;
3212 $borrowernumber ||= $itemissue->borrowernumber;
3213 my $patron = Koha::Patrons->find( $borrowernumber )
3216 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3217 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3219 categorycode => $patron->categorycode,
3220 itemtype => $item->effective_itemtype,
3221 branchcode => $branchcode,
3223 'no_auto_renewal_after',
3224 'no_auto_renewal_after_hard_limit',
3230 return unless $circulation_rules;
3232 if ( not $circulation_rules->{no_auto_renewal_after}
3233 or $circulation_rules->{no_auto_renewal_after} eq '' )
3234 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3235 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3237 my $maximum_renewal_date;
3238 if ( $circulation_rules->{no_auto_renewal_after} ) {
3239 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3240 $maximum_renewal_date->add(
3241 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3245 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3246 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3247 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3249 return $maximum_renewal_date;
3253 =head2 GetIssuingCharges
3255 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3257 Calculate how much it would cost for a given patron to borrow a given
3258 item, including any applicable discounts.
3260 C<$itemnumber> is the item number of item the patron wishes to borrow.
3262 C<$borrowernumber> is the patron's borrower number.
3264 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3265 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3270 sub GetIssuingCharges {
3272 # calculate charges due
3273 my ( $itemnumber, $borrowernumber ) = @_;
3275 my $dbh = C4::Context->dbh;
3278 # Get the book's item type and rental charge (via its biblioitem).
3279 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3280 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3281 $charge_query .= (C4::Context->preference('item-level_itypes'))
3282 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3283 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3285 $charge_query .= ' WHERE items.itemnumber =?';
3287 my $sth = $dbh->prepare($charge_query);
3288 $sth->execute($itemnumber);
3289 if ( my $item_data = $sth->fetchrow_hashref ) {
3290 $item_type = $item_data->{itemtype};
3291 $charge = $item_data->{rentalcharge};
3293 # FIXME This should follow CircControl
3294 my $branch = C4::Context::mybranch();
3295 my $patron = Koha::Patrons->find( $borrowernumber );
3296 my $discount = Koha::CirculationRules->get_effective_rule({
3297 categorycode => $patron->categorycode,
3298 branchcode => $branch,
3299 itemtype => $item_type,
3300 rule_name => 'rentaldiscount'
3303 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3305 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3309 return ( $charge, $item_type );
3312 =head2 AddIssuingCharge
3314 &AddIssuingCharge( $checkout, $charge, $type )
3318 sub AddIssuingCharge {
3319 my ( $checkout, $charge, $type ) = @_;
3321 # FIXME What if checkout does not exist?
3323 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3324 my $accountline = $account->add_debit(
3328 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3329 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3330 interface => C4::Context->interface,
3332 item_id => $checkout->itemnumber,
3333 issue_id => $checkout->issue_id,
3340 GetTransfers($itemnumber);
3345 my ($itemnumber) = @_;
3347 my $dbh = C4::Context->dbh;
3356 FROM branchtransfers
3357 WHERE itemnumber = ?
3358 AND datearrived IS NULL
3359 AND datecancelled IS NULL
3361 my $sth = $dbh->prepare($query);
3362 $sth->execute($itemnumber);
3363 my @row = $sth->fetchrow_array();
3367 =head2 GetTransfersFromTo
3369 @results = GetTransfersFromTo($frombranch,$tobranch);
3371 Returns the list of pending transfers between $from and $to branch
3375 sub GetTransfersFromTo {
3376 my ( $frombranch, $tobranch ) = @_;
3377 return unless ( $frombranch && $tobranch );
3378 my $dbh = C4::Context->dbh;
3380 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3381 FROM branchtransfers
3384 AND datecancelled IS NULL
3385 AND datesent IS NOT NULL
3386 AND datearrived IS NULL
3388 my $sth = $dbh->prepare($query);
3389 $sth->execute( $frombranch, $tobranch );
3392 while ( my $data = $sth->fetchrow_hashref ) {
3393 push @gettransfers, $data;
3395 return (@gettransfers);
3398 =head2 SendCirculationAlert
3400 Send out a C<check-in> or C<checkout> alert using the messaging system.
3408 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3412 Hashref of information about the item being checked in or out.
3416 Hashref of information about the borrower of the item.
3420 The branchcode from where the checkout or check-in took place.
3426 SendCirculationAlert({
3429 borrower => $borrower,
3435 sub SendCirculationAlert {
3437 my ($type, $item, $borrower, $branch, $issue) =
3438 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3439 my %message_name = (
3440 CHECKIN => 'Item_Check_in',
3441 CHECKOUT => 'Item_Checkout',
3442 RENEWAL => 'Item_Checkout',
3444 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3445 borrowernumber => $borrower->{borrowernumber},
3446 message_name => $message_name{$type},
3451 items => $item->{itemnumber},
3452 biblio => $item->{biblionumber},
3453 biblioitems => $item->{biblionumber},
3454 borrowers => $borrower,
3455 branches => $branch,
3458 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3459 # See C4::Letters:: _parseletter_sth
3460 if( $type eq 'CHECKIN' ){
3461 $tables->{old_issues} = $issue->issue_id;
3463 $tables->{issues} = $item->{itemnumber};
3466 my $schema = Koha::Database->new->schema;
3467 my @transports = keys %{ $borrower_preferences->{transports} };
3469 # From the MySQL doc:
3470 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3471 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3472 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3473 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3475 for my $mtt (@transports) {
3476 my $letter = C4::Letters::GetPreparedLetter (
3477 module => 'circulation',
3478 letter_code => $type,
3479 branchcode => $branch,
3480 message_transport_type => $mtt,
3481 lang => $borrower->{lang},
3485 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3486 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3487 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3488 unless ( $message ) {
3489 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3490 C4::Message->enqueue($letter, $borrower, $mtt);
3492 $message->append($letter);
3495 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3501 =head2 updateWrongTransfer
3503 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3505 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
3509 sub updateWrongTransfer {
3510 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3512 # first step: cancel the original transfer
3513 my $item = Koha::Items->find($itemNumber);
3514 my $transfer = $item->get_transfer;
3515 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3517 # second step: create a new transfer to the right location
3518 my $new_transfer = $item->request_transfer(
3520 to => $transfer->to_library,
3521 reason => $transfer->reason,
3522 comment => $transfer->comments,
3528 return $new_transfer;
3533 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3535 this function calculates the due date given the start date and configured circulation rules,
3536 checking against the holidays calendar as per the daysmode circulation rule.
3537 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3538 C<$itemtype> = itemtype code of item in question
3539 C<$branch> = location whose calendar to use
3540 C<$borrower> = Borrower object
3541 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3546 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3550 # loanlength now a href
3552 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3554 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3560 if (ref $startdate ne 'DateTime' ) {
3561 $datedue = dt_from_string($datedue);
3563 $datedue = $startdate->clone;
3566 $datedue = dt_from_string()->truncate( to => 'minute' );
3570 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3572 categorycode => $borrower->{categorycode},
3573 itemtype => $itemtype,
3574 branchcode => $branch,
3578 # calculate the datedue as normal
3579 if ( $daysmode eq 'Days' )
3580 { # ignoring calendar
3581 if ( $loanlength->{lengthunit} eq 'hours' ) {
3582 $datedue->add( hours => $loanlength->{$length_key} );
3584 $datedue->add( days => $loanlength->{$length_key} );
3585 $datedue->set_hour(23);
3586 $datedue->set_minute(59);
3590 if ($loanlength->{lengthunit} eq 'hours') {
3591 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3594 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3596 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3597 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3598 if ($loanlength->{lengthunit} eq 'days') {
3599 $datedue->set_hour(23);
3600 $datedue->set_minute(59);
3604 # if Hard Due Dates are used, retrieve them and apply as necessary
3605 my ( $hardduedate, $hardduedatecompare ) =
3606 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3607 if ($hardduedate) { # hardduedates are currently dates
3608 $hardduedate->truncate( to => 'minute' );
3609 $hardduedate->set_hour(23);
3610 $hardduedate->set_minute(59);
3611 my $cmp = DateTime->compare( $hardduedate, $datedue );
3613 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3614 # if the calculated date is before the 'after' Hard Due Date (floor), override
3615 # if the hard due date is set to 'exactly', overrride
3616 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3617 $datedue = $hardduedate->clone;
3620 # in all other cases, keep the date due as it is
3624 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3625 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3626 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3627 if( $expiry_dt ) { #skip empty expiry date..
3628 $expiry_dt->set( hour => 23, minute => 59);
3629 my $d1= $datedue->clone->set_time_zone('floating');
3630 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3631 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3634 if ( $daysmode ne 'Days' ) {
3635 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3636 if ( $calendar->is_holiday($datedue) ) {
3637 # Don't return on a closed day
3638 $datedue = $calendar->prev_open_days( $datedue, 1 );
3647 sub CheckValidBarcode{
3649 my $dbh = C4::Context->dbh;
3650 my $query=qq|SELECT count(*)
3654 my $sth = $dbh->prepare($query);
3655 $sth->execute($barcode);
3656 my $exist=$sth->fetchrow ;
3660 =head2 IsBranchTransferAllowed
3662 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3664 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3666 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3667 Koha::Item->can_be_transferred.
3671 sub IsBranchTransferAllowed {
3672 my ( $toBranch, $fromBranch, $code ) = @_;
3674 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3676 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3677 my $dbh = C4::Context->dbh;
3679 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3680 $sth->execute( $toBranch, $fromBranch, $code );
3681 my $limit = $sth->fetchrow_hashref();
3683 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3684 if ( $limit->{'limitId'} ) {
3691 =head2 CreateBranchTransferLimit
3693 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3695 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3697 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3701 sub CreateBranchTransferLimit {
3702 my ( $toBranch, $fromBranch, $code ) = @_;
3703 return unless defined($toBranch) && defined($fromBranch);
3704 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3706 my $dbh = C4::Context->dbh;
3708 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3709 return $sth->execute( $code, $toBranch, $fromBranch );
3712 =head2 DeleteBranchTransferLimits
3714 my $result = DeleteBranchTransferLimits($frombranch);
3716 Deletes all the library transfer limits for one library. Returns the
3717 number of limits deleted, 0e0 if no limits were deleted, or undef if
3718 no arguments are supplied.
3720 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3721 fromBranch => $fromBranch
3726 sub DeleteBranchTransferLimits {
3728 return unless defined $branch;
3729 my $dbh = C4::Context->dbh;
3730 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3731 return $sth->execute($branch);
3735 my ( $borrowernumber, $itemnum ) = @_;
3736 MarkIssueReturned( $borrowernumber, $itemnum );
3741 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3743 The final optional parameter, C<$params>, expected to contain
3744 'skip_record_index' key, which relayed down to Koha::Item/store,
3745 there it prevents calling of ModZebra index_records,
3746 which takes most of the time in batch adds/deletes: index_records better
3747 to be called later in C<additem.pl> after the whole loop.
3750 skip_record_index => 1|0
3755 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3757 unless ( $mark_lost_from ) {
3758 # Temporary check to avoid regressions
3759 die q|LostItem called without $mark_lost_from, check the API.|;
3763 if ( $force_mark_returned ) {
3766 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3767 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3770 my $dbh = C4::Context->dbh();
3771 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3773 JOIN items USING (itemnumber)
3774 JOIN biblio USING (biblionumber)
3775 WHERE issues.itemnumber=?");
3776 $sth->execute($itemnumber);
3777 my $issues=$sth->fetchrow_hashref();
3779 # If a borrower lost the item, add a replacement cost to the their record
3780 if ( my $borrowernumber = $issues->{borrowernumber} ){
3781 my $patron = Koha::Patrons->find( $borrowernumber );
3783 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3784 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3786 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3787 C4::Accounts::chargelostitem(
3790 $issues->{'replacementprice'},
3791 sprintf( "%s %s %s",
3792 $issues->{'title'} || q{},
3793 $issues->{'barcode'} || q{},
3794 $issues->{'itemcallnumber'} || q{},
3797 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3798 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3801 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3804 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3805 my $item = Koha::Items->find($itemnumber);
3806 my $transfers = $item->get_transfers;
3807 while (my $transfer = $transfers->next) {
3808 $transfer->cancel({ reason => 'ItemLost', force => 1 });
3812 sub GetOfflineOperations {
3813 my $dbh = C4::Context->dbh;
3814 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3815 $sth->execute(C4::Context->userenv->{'branch'});
3816 my $results = $sth->fetchall_arrayref({});
3820 sub GetOfflineOperation {
3821 my $operationid = shift;
3822 return unless $operationid;
3823 my $dbh = C4::Context->dbh;
3824 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3825 $sth->execute( $operationid );
3826 return $sth->fetchrow_hashref;
3829 sub AddOfflineOperation {
3830 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3831 my $dbh = C4::Context->dbh;
3832 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3833 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3837 sub DeleteOfflineOperation {
3838 my $dbh = C4::Context->dbh;
3839 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3840 $sth->execute( shift );
3844 sub ProcessOfflineOperation {
3845 my $operation = shift;
3848 if ( $operation->{action} eq 'return' ) {
3849 $report = ProcessOfflineReturn( $operation );
3850 } elsif ( $operation->{action} eq 'issue' ) {
3851 $report = ProcessOfflineIssue( $operation );
3852 } elsif ( $operation->{action} eq 'payment' ) {
3853 $report = ProcessOfflinePayment( $operation );
3856 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3861 sub ProcessOfflineReturn {
3862 my $operation = shift;
3864 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3867 my $itemnumber = $item->itemnumber;
3868 my $issue = GetOpenIssue( $itemnumber );
3870 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3871 ModDateLastSeen( $itemnumber, $leave_item_lost );
3873 $issue->{borrowernumber},
3875 $operation->{timestamp},
3878 $item->onloan(undef);
3879 $item->store({ log_action => 0 });
3882 return "Item not issued.";
3885 return "Item not found.";
3889 sub ProcessOfflineIssue {
3890 my $operation = shift;
3892 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3895 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3897 return "Barcode not found.";
3899 my $itemnumber = $item->itemnumber;
3900 my $issue = GetOpenIssue( $itemnumber );
3902 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3904 $issue->{borrowernumber},
3906 $operation->{timestamp},
3911 $operation->{'barcode'},
3914 $operation->{timestamp},
3919 return "Borrower not found.";
3923 sub ProcessOfflinePayment {
3924 my $operation = shift;
3926 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3928 $patron->account->pay(
3930 amount => $operation->{amount},
3931 library_id => $operation->{branchcode},
3941 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3943 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3948 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3952 ? Koha::Items->find($itemnumber)
3953 : Koha::Items->find( { barcode => $barcode } );
3957 return C4::Letters::GetPreparedLetter (
3958 module => 'circulation',
3959 letter_code => 'TRANSFERSLIP',
3960 branchcode => $branch,
3962 'branches' => $to_branch,
3963 'biblio' => $item->biblionumber,
3964 'items' => $item->unblessed,
3969 =head2 CheckIfIssuedToPatron
3971 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3973 Return 1 if any record item is issued to patron, otherwise return 0
3977 sub CheckIfIssuedToPatron {
3978 my ($borrowernumber, $biblionumber) = @_;
3980 my $dbh = C4::Context->dbh;
3982 SELECT COUNT(*) FROM issues
3983 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3984 WHERE items.biblionumber = ?
3985 AND issues.borrowernumber = ?
3987 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3988 return 1 if $is_issued;
3994 IsItemIssued( $itemnumber )
3996 Return 1 if the item is on loan, otherwise return 0
4001 my $itemnumber = shift;
4002 my $dbh = C4::Context->dbh;
4003 my $sth = $dbh->prepare(q{
4006 WHERE itemnumber = ?
4008 $sth->execute($itemnumber);
4009 return $sth->fetchrow;
4012 =head2 GetAgeRestriction
4014 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4015 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4017 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4018 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4020 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4021 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4022 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4023 Negative days mean the borrower has gone past the age restriction age.
4027 sub GetAgeRestriction {
4028 my ($record_restrictions, $borrower) = @_;
4029 my $markers = C4::Context->preference('AgeRestrictionMarker');
4031 return unless $record_restrictions;
4032 # Split $record_restrictions to something like FSK 16 or PEGI 6
4033 my @values = split ' ', uc($record_restrictions);
4034 return unless @values;
4036 # Search first occurrence of one of the markers
4037 my @markers = split /\|/, uc($markers);
4038 return unless @markers;
4041 my $restriction_year = 0;
4042 for my $value (@values) {
4044 for my $marker (@markers) {
4045 $marker =~ s/^\s+//; #remove leading spaces
4046 $marker =~ s/\s+$//; #remove trailing spaces
4047 if ( $marker eq $value ) {
4048 if ( $index <= $#values ) {
4049 $restriction_year += $values[$index];
4053 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4055 # Perhaps it is something like "K16" (as in Finland)
4056 $restriction_year += $1;
4060 last if ( $restriction_year > 0 );
4063 #Check if the borrower is age restricted for this material and for how long.
4064 if ($restriction_year && $borrower) {
4065 if ( $borrower->{'dateofbirth'} ) {
4066 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4067 $alloweddate[0] += $restriction_year;
4069 #Prevent runime eror on leap year (invalid date)
4070 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4071 $alloweddate[2] = 28;
4074 #Get how many days the borrower has to reach the age restriction
4075 my @Today = split /-/, dt_from_string()->ymd();
4076 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4077 #Negative days means the borrower went past the age restriction age
4078 return ($restriction_year, $daysToAgeRestriction);
4082 return ($restriction_year);
4086 =head2 GetPendingOnSiteCheckouts
4090 sub GetPendingOnSiteCheckouts {
4091 my $dbh = C4::Context->dbh;
4092 return $dbh->selectall_arrayref(q|
4098 items.itemcallnumber,
4102 issues.date_due < NOW() AS is_overdue,
4105 borrowers.firstname,
4107 borrowers.cardnumber,
4108 borrowers.borrowernumber
4110 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4111 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4112 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4113 WHERE issues.onsite_checkout = 1
4114 |, { Slice => {} } );
4120 my ($count, $branch, $itemtype, $ccode, $newness)
4121 = @$params{qw(count branch itemtype ccode newness)};
4123 my $dbh = C4::Context->dbh;
4126 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4127 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4128 i.ccode, SUM(i.issues) AS count
4130 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4131 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4134 my (@where_strs, @where_args);
4137 push @where_strs, 'i.homebranch = ?';
4138 push @where_args, $branch;
4141 if (C4::Context->preference('item-level_itypes')){
4142 push @where_strs, 'i.itype = ?';
4143 push @where_args, $itemtype;
4145 push @where_strs, 'bi.itemtype = ?';
4146 push @where_args, $itemtype;
4150 push @where_strs, 'i.ccode = ?';
4151 push @where_args, $ccode;
4154 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4155 push @where_args, $newness;
4159 $query .= 'WHERE ' . join(' AND ', @where_strs);
4163 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4164 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4169 $query .= q{ ) xxx WHERE count > 0 };
4170 $count = int($count);
4172 $query .= "LIMIT $count";
4175 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4180 =head2 Internal methods
4184 sub _CalculateAndUpdateFine {
4187 my $borrower = $params->{borrower};
4188 my $item = $params->{item};
4189 my $issue = $params->{issue};
4190 my $return_date = $params->{return_date};
4192 unless ($borrower) { carp "No borrower passed in!" && return; }
4193 unless ($item) { carp "No item passed in!" && return; }
4194 unless ($issue) { carp "No issue passed in!" && return; }
4196 my $datedue = dt_from_string( $issue->date_due );
4198 # we only need to calculate and change the fines if we want to do that on return
4199 # Should be on for hourly loans
4200 my $control = C4::Context->preference('CircControl');
4201 my $control_branchcode =
4202 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4203 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4204 : $issue->branchcode;
4206 my $date_returned = $return_date ? $return_date : dt_from_string();
4208 my ( $amount, $unitcounttotal, $unitcount ) =
4209 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4211 if ( C4::Context->preference('finesMode') eq 'production' ) {
4212 if ( $amount > 0 ) {
4213 C4::Overdues::UpdateFine({
4214 issue_id => $issue->issue_id,
4215 itemnumber => $issue->itemnumber,
4216 borrowernumber => $issue->borrowernumber,
4218 due => output_pref($datedue),
4221 elsif ($return_date) {
4223 # Backdated returns may have fines that shouldn't exist,
4224 # so in this case, we need to drop those fines to 0
4226 C4::Overdues::UpdateFine({
4227 issue_id => $issue->issue_id,
4228 itemnumber => $issue->itemnumber,
4229 borrowernumber => $issue->borrowernumber,
4231 due => output_pref($datedue),
4237 sub _CanBookBeAutoRenewed {
4238 my ( $params ) = @_;
4239 my $patron = $params->{patron};
4240 my $item = $params->{item};
4241 my $branchcode = $params->{branchcode};
4242 my $issue = $params->{issue};
4244 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4246 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4248 categorycode => $patron->categorycode,
4249 itemtype => $item->effective_itemtype,
4250 branchcode => $branchcode,
4252 'no_auto_renewal_after',
4253 'no_auto_renewal_after_hard_limit',
4260 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4261 return 'auto_account_expired';
4264 if ( defined $issuing_rule->{no_auto_renewal_after}
4265 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4266 # Get issue_date and add no_auto_renewal_after
4267 # If this is greater than today, it's too late for renewal.
4268 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4269 $maximum_renewal_date->add(
4270 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4272 my $now = dt_from_string;
4273 if ( $now >= $maximum_renewal_date ) {
4274 return "auto_too_late";
4277 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4278 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4279 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4280 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4281 return "auto_too_late";
4285 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4286 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4287 my $amountoutstanding =
4288 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4289 ? $patron->account->balance
4290 : $patron->account->outstanding_debits->total_outstanding;
4291 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4292 return "auto_too_much_oweing";
4296 if ( defined $issuing_rule->{norenewalbefore}
4297 and $issuing_rule->{norenewalbefore} ne "" ) {
4298 if ( GetSoonestRenewDate($patron->id, $item->id) > dt_from_string()) {
4299 return "auto_too_soon";
4305 # Fallback for automatic renewals:
4306 # If norenewalbefore is undef, don't renew before due date.
4307 my $now = dt_from_string;
4308 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
4311 return "auto_too_soon";
4315 sub _item_denied_renewal {
4318 my $item = $params->{item};
4319 return unless $item;
4321 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4322 return unless $denyingrules;
4323 foreach my $field (keys %$denyingrules) {
4324 my $val = $item->$field;
4325 if( !defined $val) {
4326 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4329 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4330 # If the results matches the values in the syspref
4331 # We return true if match found
4344 Koha Development Team <http://koha-community.org/>