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 );
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;
65 use List::MoreUtils qw( any );
66 use Scalar::Util qw( looks_like_number );
67 use Date::Calc qw( Date_to_Days );
68 our (@ISA, @EXPORT_OK);
74 # FIXME subs that should probably be elsewhere
79 GetPendingOnSiteCheckouts
90 GetLatestAutoRenewDate
93 GetBranchBorrowerCircRule
113 IsBranchTransferAllowed
114 CreateBranchTransferLimit
115 DeleteBranchTransferLimits
121 DeleteOfflineOperation
122 ProcessOfflineOperation
123 ProcessOfflinePayment
125 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
130 C4::Circulation - Koha circulation module
138 The functions in this module deal with circulation, issues, and
139 returns, as well as general information about the library.
140 Also deals with inventory.
146 $str = &barcodedecode($barcode, [$filter]);
148 Generic filter function for barcode string.
149 Called on every circ if the System Pref itemBarcodeInputFilter is set.
150 Will do some manipulation of the barcode for systems that deliver a barcode
151 to circulation.pl that differs from the barcode stored for the item.
152 For proper functioning of this filter, calling the function on the
153 correct barcode string (items.barcode) should return an unaltered barcode.
155 The optional $filter argument is to allow for testing or explicit
156 behavior that ignores the System Pref. Valid values are the same as the
161 # FIXME -- the &decode fcn below should be wrapped into this one.
162 # FIXME -- these plugins should be moved out of Circulation.pm
165 my ($barcode, $filter) = @_;
166 my $branch = C4::Context::mybranch();
167 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
168 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
169 if ($filter eq 'whitespace') {
171 } elsif ($filter eq 'cuecat') {
173 my @fields = split( /\./, $barcode );
174 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
175 ($#results == 2) and return $results[2];
176 } elsif ($filter eq 'T-prefix') {
177 if ($barcode =~ /^[Tt](\d)/) {
178 (defined($1) and $1 eq '0') and return $barcode;
179 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
181 return sprintf("T%07d", $barcode);
182 # FIXME: $barcode could be "T1", causing warning: substr outside of string
183 # Why drop the nonzero digit after the T?
184 # Why pass non-digits (or empty string) to "T%07d"?
185 } elsif ($filter eq 'libsuite8') {
186 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
187 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
188 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
190 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
193 } elsif ($filter eq 'EAN13') {
194 my $ean = CheckDigits('ean');
195 if ( $ean->is_valid($barcode) ) {
196 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
197 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
199 warn "# [$barcode] not valid EAN-13/UPC-A\n";
202 return $barcode; # return barcode, modified or not
207 $str = &_decode($chunk);
209 Decodes a segment of a string emitted by a CueCat barcode scanner and
212 FIXME: Should be replaced with Barcode::Cuecat from CPAN
213 or Javascript based decoding on the client side.
220 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
221 my @s = map { index( $seq, $_ ); } split( //, $encoded );
222 my $l = ( $#s + 1 ) % 4;
225 # warn "Error: Cuecat decode parsing failed!";
233 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
235 chr( ( $n >> 16 ) ^ 67 )
236 .chr( ( $n >> 8 & 255 ) ^ 67 )
237 .chr( ( $n & 255 ) ^ 67 );
240 $r = substr( $r, 0, length($r) - $l );
246 ($dotransfer, $messages, $iteminformation) = &transferbook({
247 from_branch => $frombranch
248 to_branch => $tobranch,
250 ignore_reserves => $ignore_reserves,
254 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
256 C<$fbr> is the code for the branch initiating the transfer.
257 C<$tbr> is the code for the branch to which the item should be transferred.
259 C<$barcode> is the barcode of the item to be transferred.
261 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
262 Otherwise, if an item is reserved, the transfer fails.
264 C<$trigger> is the enum value for what triggered the transfer.
266 Returns three values:
272 is true if the transfer was successful.
276 is a reference-to-hash which may have any of the following keys:
282 There is no item in the catalog with the given barcode. The value is C<$barcode>.
284 =item C<DestinationEqualsHolding>
286 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.
290 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.
294 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>.
296 =item C<WasTransferred>
298 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
308 my $tbr = $params->{to_branch};
309 my $fbr = $params->{from_branch};
310 my $ignoreRs = $params->{ignore_reserves};
311 my $barcode = $params->{barcode};
312 my $trigger = $params->{trigger};
315 my $item = Koha::Items->find( { barcode => $barcode } );
317 Koha::Exceptions::MissingParameter->throw(
318 "Missing mandatory parameter: from_branch")
321 Koha::Exceptions::MissingParameter->throw(
322 "Missing mandatory parameter: to_branch")
327 $messages->{'BadBarcode'} = $barcode;
329 return ( $dotransfer, $messages );
332 my $itemnumber = $item->itemnumber;
333 # get branches of book...
334 my $hbr = $item->homebranch;
336 # if using Branch Transfer Limits
337 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
338 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
339 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
340 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
341 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
344 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
345 $messages->{'NotAllowed'} = $tbr . "::" . $code;
350 # can't transfer book if is already there....
351 if ( $fbr eq $tbr ) {
352 $messages->{'DestinationEqualsHolding'} = 1;
356 # check if it is still issued to someone, return it...
357 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
359 AddReturn( $barcode, $fbr );
360 $messages->{'WasReturned'} = $issue->borrowernumber;
364 # That'll save a database query.
365 my ( $resfound, $resrec, undef ) =
366 CheckReserves( $itemnumber );
368 $resrec->{'ResFound'} = $resfound;
369 $messages->{'ResFound'} = $resrec;
370 $dotransfer = 0 unless $ignoreRs;
373 #actually do the transfer....
375 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
377 # don't need to update MARC anymore, we do it in batch now
378 $messages->{'WasTransfered'} = $tbr;
381 ModDateLastSeen( $itemnumber );
382 return ( $dotransfer, $messages );
387 my $borrower = shift;
388 my $item_object = shift;
390 my $onsite_checkout = $params->{onsite_checkout} || 0;
391 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
392 my $cat_borrower = $borrower->{'categorycode'};
393 my $dbh = C4::Context->dbh;
394 # Get which branchcode we need
395 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
396 my $type = $item_object->effective_itemtype;
398 my ($type_object, $parent_type, $parent_maxissueqty_rule);
399 $type_object = Koha::ItemTypes->find( $type );
400 $parent_type = $type_object->parent_type if $type_object;
401 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
402 # Find any children if we are a parent_type;
404 # given branch, patron category, and item type, determine
405 # applicable issuing rule
407 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
409 categorycode => $cat_borrower,
410 itemtype => $parent_type,
411 branchcode => $branch,
412 rule_name => 'maxissueqty',
415 # If the parent rule is for default type we discount it
416 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
418 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
420 categorycode => $cat_borrower,
422 branchcode => $branch,
423 rule_name => 'maxissueqty',
427 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
429 categorycode => $cat_borrower,
431 branchcode => $branch,
432 rule_name => 'maxonsiteissueqty',
437 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
438 # if a rule is found and has a loan limit set, count
439 # how many loans the patron already has that meet that
441 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
444 if ( $maxissueqty_rule->branchcode ) {
445 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
446 $checkouts = $patron->checkouts->search(
447 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
448 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
449 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
451 $checkouts = $patron->checkouts->search(
452 { 'item.homebranch' => $maxissueqty_rule->branchcode },
453 { prefetch => 'item' } );
456 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
459 my $rule_itemtype = $maxissueqty_rule->itemtype;
460 while ( my $c = $checkouts->next ) {
461 my $itemtype = $c->item->effective_itemtype;
463 unless ( $rule_itemtype ) {
464 # matching rule has the default item type, so count only
465 # those existing loans that don't fall under a more
467 @types = Koha::CirculationRules->search(
469 branchcode => $maxissueqty_rule->branchcode,
470 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
471 itemtype => { '!=' => undef },
472 rule_name => 'maxissueqty'
474 )->get_column('itemtype');
476 next if grep {$_ eq $itemtype} @types;
479 if ( $parent_maxissueqty_rule ) {
480 # if we have a parent item type then we count loans of the
481 # specific item type or its siblings or parent
482 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
483 @types = $children->get_column('itemtype');
484 push @types, $parent_type;
485 } elsif ( $child_types ) {
486 # If we are a parent type, we need to count all child types and our own type
487 @types = $child_types->get_column('itemtype');
488 push @types, $type; # And don't forget to count our own types
489 } else { push @types, $type; } # Otherwise only count the specific itemtype
491 next unless grep {$_ eq $itemtype} @types;
493 $sum_checkouts->{total}++;
494 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
495 $sum_checkouts->{itemtype}->{$itemtype}++;
498 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
499 my $checkout_count = $sum_checkouts->{total} || 0;
500 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
502 my $checkout_rules = {
503 checkout_count => $checkout_count,
504 onsite_checkout_count => $onsite_checkout_count,
505 onsite_checkout => $onsite_checkout,
506 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
507 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
508 switch_onsite_checkout => $switch_onsite_checkout,
510 # If parent rules exists
511 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
512 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
513 my $qty_over = _check_max_qty($checkout_rules);
514 return $qty_over if defined $qty_over;
516 # If the parent rule is less than or equal to the child, we only need check the parent
517 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
518 $checkout_rules->{checkout_count} = $checkout_count_type;
519 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
520 my $qty_over = _check_max_qty($checkout_rules);
521 return $qty_over if defined $qty_over;
524 my $qty_over = _check_max_qty($checkout_rules);
525 return $qty_over if defined $qty_over;
529 # Now count total loans against the limit for the branch
530 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
531 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
533 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
534 $checkouts = $patron->checkouts->search(
535 { 'me.branchcode' => $branch} );
536 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
537 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
539 $checkouts = $patron->checkouts->search(
540 { 'item.homebranch' => $branch},
541 { prefetch => 'item' } );
544 my $checkout_count = $checkouts->count;
545 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
546 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
547 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
549 my $qty_over = _check_max_qty(
551 checkout_count => $checkout_count,
552 onsite_checkout_count => $onsite_checkout_count,
553 onsite_checkout => $onsite_checkout,
554 max_checkouts_allowed => $max_checkouts_allowed,
555 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
556 switch_onsite_checkout => $switch_onsite_checkout
559 return $qty_over if defined $qty_over;
562 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
563 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
566 # OK, the patron can issue !!!
572 my $checkout_count = $params->{checkout_count};
573 my $onsite_checkout_count = $params->{onsite_checkout_count};
574 my $onsite_checkout = $params->{onsite_checkout};
575 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
576 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
577 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
579 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
580 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
581 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
583 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
584 count => $onsite_checkout_count,
585 max_allowed => $max_onsite_checkouts_allowed,
589 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
590 if ( $max_checkouts_allowed eq '' ) { return; }
591 my $delta = $switch_onsite_checkout ? 1 : 0;
592 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
594 reason => 'TOO_MANY_CHECKOUTS',
595 count => $checkout_count,
596 max_allowed => $max_checkouts_allowed,
600 elsif ( not $onsite_checkout ) {
601 if ( $max_checkouts_allowed eq '' ) { return; }
603 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
606 reason => 'TOO_MANY_CHECKOUTS',
607 count => $checkout_count - $onsite_checkout_count,
608 max_allowed => $max_checkouts_allowed,
616 =head2 CanBookBeIssued
618 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
619 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
621 Check if a book can be issued.
623 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
625 IMPORTANT: The assumption by users of this routine is that causes blocking
626 the issue are keyed by uppercase labels and other returned
627 data is keyed in lower case!
631 =item C<$patron> is a Koha::Patron
633 =item C<$barcode> is the bar code of the book being issued.
635 =item C<$duedates> is a DateTime object.
637 =item C<$inprocess> boolean switch
639 =item C<$ignore_reserves> boolean switch
641 =item C<$params> Hashref of additional parameters
644 override_high_holds - Ignore high holds
645 onsite_checkout - Checkout is an onsite checkout that will not leave the library
653 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
654 Possible values are :
660 sticky due date is invalid
664 borrower gone with no address
668 borrower declared it's card lost
674 =head3 UNKNOWN_BARCODE
688 item is restricted (set by ??)
690 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
691 could be prevented, but ones that can be overriden by the operator.
693 Possible values are :
701 renewing, not issuing
703 =head3 ISSUED_TO_ANOTHER
705 issued to someone else.
709 reserved for someone else.
713 reserved and being transferred for someone else.
717 sticky due date is invalid or due date in the past
721 if the borrower borrows to much things
725 sub CanBookBeIssued {
726 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
727 my %needsconfirmation; # filled with problems that needs confirmations
728 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
729 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
730 my %messages; # filled with information messages that should be displayed.
732 my $onsite_checkout = $params->{onsite_checkout} || 0;
733 my $override_high_holds = $params->{override_high_holds} || 0;
735 my $item_object = Koha::Items->find({barcode => $barcode });
737 # MANDATORY CHECKS - unless item exists, nothing else matters
738 unless ( $item_object ) {
739 $issuingimpossible{UNKNOWN_BARCODE} = 1;
741 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
743 my $item_unblessed = $item_object->unblessed; # Transition...
744 my $issue = $item_object->checkout;
745 my $biblio = $item_object->biblio;
747 my $biblioitem = $biblio->biblioitem;
748 my $effective_itemtype = $item_object->effective_itemtype;
749 my $dbh = C4::Context->dbh;
750 my $patron_unblessed = $patron->unblessed;
752 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
754 # DUE DATE is OK ? -- should already have checked.
756 if ($duedate && ref $duedate ne 'DateTime') {
757 $duedate = dt_from_string($duedate);
759 my $now = dt_from_string();
760 unless ( $duedate ) {
761 my $issuedate = $now->clone();
763 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
765 # Offline circ calls AddIssue directly, doesn't run through here
766 # So issuingimpossible should be ok.
769 my $fees = Koha::Charges::Fees->new(
772 library => $circ_library,
773 item => $item_object,
779 my $today = $now->clone();
780 $today->truncate( to => 'minute');
781 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
782 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
785 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
791 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
792 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
793 C4::Stats::UpdateStats({
794 branch => C4::Context->userenv->{'branch'},
796 itemnumber => $item_object->itemnumber,
797 itemtype => $effective_itemtype,
798 borrowernumber => $patron->borrowernumber,
799 ccode => $item_object->ccode}
801 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
802 return( { STATS => 1 }, {});
805 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
806 $issuingimpossible{GNA} = 1;
809 if ( $patron->lost && $patron->lost == 1 ) {
810 $issuingimpossible{CARD_LOST} = 1;
812 if ( $patron->is_debarred ) {
813 $issuingimpossible{DEBARRED} = 1;
816 if ( $patron->is_expired ) {
817 $issuingimpossible{EXPIRED} = 1;
825 my $account = $patron->account;
826 my $balance = $account->balance;
827 my $non_issues_charges = $account->non_issues_charges;
828 my $other_charges = $balance - $non_issues_charges;
830 my $amountlimit = C4::Context->preference("noissuescharge");
831 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
832 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
834 # Check the debt of this patrons guarantees
835 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
836 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
837 if ( defined $no_issues_charge_guarantees ) {
838 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
839 my $guarantees_non_issues_charges = 0;
840 foreach my $g ( @guarantees ) {
841 $guarantees_non_issues_charges += $g->account->non_issues_charges;
844 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
845 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
846 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
847 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
848 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
849 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
853 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
854 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
855 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
856 if ( defined $no_issues_charge_guarantors ) {
857 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
859 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
860 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
861 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
862 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
863 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
864 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
868 if ( C4::Context->preference("IssuingInProcess") ) {
869 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
870 $issuingimpossible{DEBT} = $non_issues_charges;
871 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
872 $needsconfirmation{DEBT} = $non_issues_charges;
873 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
874 $needsconfirmation{DEBT} = $non_issues_charges;
878 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
879 $needsconfirmation{DEBT} = $non_issues_charges;
880 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
881 $issuingimpossible{DEBT} = $non_issues_charges;
882 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
883 $needsconfirmation{DEBT} = $non_issues_charges;
887 if ($balance > 0 && $other_charges > 0) {
888 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
891 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
892 $patron_unblessed = $patron->unblessed;
894 if ( my $debarred_date = $patron->is_debarred ) {
895 # patron has accrued fine days or has a restriction. $count is a date
896 if ($debarred_date eq '9999-12-31') {
897 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
900 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
902 } elsif ( my $num_overdues = $patron->has_overdues ) {
903 ## patron has outstanding overdue loans
904 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
905 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
907 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
908 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
912 # Additional Materials Check
913 if ( C4::Context->preference("CircConfirmItemParts")
914 && $item_object->materials )
916 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
920 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
922 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
924 # Already issued to current borrower.
925 # If it is an on-site checkout if it can be switched to a normal checkout
926 # or ask whether the loan should be renewed
928 if ( $issue->onsite_checkout
929 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
930 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
932 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
933 $patron->borrowernumber,
934 $item_object->itemnumber,
936 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
937 if ( $renewerror eq 'onsite_checkout' ) {
938 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
941 $issuingimpossible{NO_MORE_RENEWALS} = 1;
945 $needsconfirmation{RENEW_ISSUE} = 1;
951 # issued to someone else
953 my $patron = Koha::Patrons->find( $issue->borrowernumber );
955 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
957 unless ( $can_be_returned ) {
958 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
959 $issuingimpossible{branch_to_return} = $message;
961 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
962 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
964 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
965 $needsconfirmation{issued_firstname} = $patron->firstname;
966 $needsconfirmation{issued_surname} = $patron->surname;
967 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
968 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
973 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
975 my $switch_onsite_checkout = (
976 C4::Context->preference('SwitchOnSiteCheckouts')
978 and $issue->onsite_checkout
979 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
980 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
981 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
982 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
983 if ( $toomany->{max_allowed} == 0 ) {
984 $needsconfirmation{PATRON_CANT} = 1;
986 if ( C4::Context->preference("AllowTooManyOverride") ) {
987 $needsconfirmation{TOO_MANY} = $toomany->{reason};
988 $needsconfirmation{current_loan_count} = $toomany->{count};
989 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
991 $issuingimpossible{TOO_MANY} = $toomany->{reason};
992 $issuingimpossible{current_loan_count} = $toomany->{count};
993 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
998 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1000 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1001 my $wants_check = $patron->wants_check_for_previous_checkout;
1002 $needsconfirmation{PREVISSUE} = 1
1003 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1008 if ( $item_object->notforloan )
1010 if(!C4::Context->preference("AllowNotForLoanOverride")){
1011 $issuingimpossible{NOT_FOR_LOAN} = 1;
1012 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1014 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1015 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1019 # we have to check itemtypes.notforloan also
1020 if (C4::Context->preference('item-level_itypes')){
1021 # this should probably be a subroutine
1022 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1023 $sth->execute($effective_itemtype);
1024 my $notforloan=$sth->fetchrow_hashref();
1025 if ($notforloan->{'notforloan'}) {
1026 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1027 $issuingimpossible{NOT_FOR_LOAN} = 1;
1028 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1030 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1031 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1036 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1037 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1038 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1039 $issuingimpossible{NOT_FOR_LOAN} = 1;
1040 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1042 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1043 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1048 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1050 $issuingimpossible{WTHDRAWN} = 1;
1052 if ( $item_object->restricted
1053 && $item_object->restricted == 1 )
1055 $issuingimpossible{RESTRICTED} = 1;
1057 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1058 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1059 my $code = $av->count ? $av->next->lib : '';
1060 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1061 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1063 if ( C4::Context->preference("IndependentBranches") ) {
1064 my $userenv = C4::Context->userenv;
1065 unless ( C4::Context->IsSuperLibrarian() ) {
1066 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1067 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1068 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1069 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1071 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1072 if ( $patron->branchcode ne $userenv->{branch} );
1077 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1079 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1080 if ($rentalConfirmation) {
1081 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1083 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1084 if ($itemtype_object) {
1085 my $accumulate_charge = $fees->accumulate_rentalcharge();
1086 if ( $accumulate_charge > 0 ) {
1087 $rentalCharge += $accumulate_charge;
1091 if ( $rentalCharge > 0 ) {
1092 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1096 unless ( $ignore_reserves ) {
1097 # See if the item is on reserve.
1098 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1100 my $resbor = $res->{'borrowernumber'};
1101 if ( $resbor ne $patron->borrowernumber ) {
1102 my $patron = Koha::Patrons->find( $resbor );
1103 if ( $restype eq "Waiting" )
1105 # The item is on reserve and waiting, but has been
1106 # reserved by some other patron.
1107 $needsconfirmation{RESERVE_WAITING} = 1;
1108 $needsconfirmation{'resfirstname'} = $patron->firstname;
1109 $needsconfirmation{'ressurname'} = $patron->surname;
1110 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1111 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1112 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1113 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1114 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1116 elsif ( $restype eq "Reserved" ) {
1117 # The item is on reserve for someone else.
1118 $needsconfirmation{RESERVED} = 1;
1119 $needsconfirmation{'resfirstname'} = $patron->firstname;
1120 $needsconfirmation{'ressurname'} = $patron->surname;
1121 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1122 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1123 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1124 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1125 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1127 elsif ( $restype eq "Transferred" ) {
1128 # The item is determined hold being transferred for someone else.
1129 $needsconfirmation{TRANSFERRED} = 1;
1130 $needsconfirmation{'resfirstname'} = $patron->firstname;
1131 $needsconfirmation{'ressurname'} = $patron->surname;
1132 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1133 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1134 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1135 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1136 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1138 elsif ( $restype eq "Processing" ) {
1139 # The item is determined hold being processed for someone else.
1140 $needsconfirmation{PROCESSING} = 1;
1141 $needsconfirmation{'resfirstname'} = $patron->firstname;
1142 $needsconfirmation{'ressurname'} = $patron->surname;
1143 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1144 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1145 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1146 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1147 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1153 ## CHECK AGE RESTRICTION
1154 my $agerestriction = $biblioitem->agerestriction;
1155 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1156 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1157 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1158 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1161 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1165 ## check for high holds decreasing loan period
1166 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1167 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1169 if ( $check->{exceeded} ) {
1170 if ($override_high_holds) {
1171 $alerts{HIGHHOLDS} = {
1172 num_holds => $check->{outstanding},
1173 duration => $check->{duration},
1174 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1178 $needsconfirmation{HIGHHOLDS} = {
1179 num_holds => $check->{outstanding},
1180 duration => $check->{duration},
1181 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1188 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1189 # don't do the multiple loans per bib check if we've
1190 # already determined that we've got a loan on the same item
1191 !$issuingimpossible{NO_MORE_RENEWALS} &&
1192 !$needsconfirmation{RENEW_ISSUE}
1194 # Check if borrower has already issued an item from the same biblio
1195 # Only if it's not a subscription
1196 my $biblionumber = $item_object->biblionumber;
1197 require C4::Serials;
1198 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1199 unless ($is_a_subscription) {
1200 # FIXME Should be $patron->checkouts($args);
1201 my $checkouts = Koha::Checkouts->search(
1203 borrowernumber => $patron->borrowernumber,
1204 biblionumber => $biblionumber,
1210 # if we get here, we don't already have a loan on this item,
1211 # so if there are any loans on this bib, ask for confirmation
1212 if ( $checkouts->count ) {
1213 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1218 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1221 =head2 CanBookBeReturned
1223 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1225 Check whether the item can be returned to the provided branch
1229 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1231 =item C<$branch> is the branchcode where the return is taking place
1239 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1241 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1247 sub CanBookBeReturned {
1248 my ($item, $branch) = @_;
1249 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1251 # assume return is allowed to start
1255 # identify all cases where return is forbidden
1256 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1258 $message = $item->{'homebranch'};
1259 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1261 $message = $item->{'holdingbranch'};
1262 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1264 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1267 return ($allowed, $message);
1270 =head2 CheckHighHolds
1272 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1273 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1274 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1278 sub checkHighHolds {
1279 my ( $item, $borrower ) = @_;
1280 my $branchcode = _GetCircControlBranch( $item, $borrower );
1281 my $item_object = Koha::Items->find( $item->{itemnumber} );
1290 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1292 if ( $holds->count() ) {
1293 $return_data->{outstanding} = $holds->count();
1295 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1296 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1297 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1299 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1301 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1303 # static means just more than a given number of holds on the record
1305 # If the number of holds is less than the threshold, we can stop here
1306 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1307 return $return_data;
1310 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1312 # dynamic means X more than the number of holdable items on the record
1314 # let's get the items
1315 my @items = $holds->next()->biblio()->items()->as_list;
1317 # Remove any items with status defined to be ignored even if the would not make item unholdable
1318 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1319 @items = grep { !$_->$status } @items;
1322 # Remove any items that are not holdable for this patron
1323 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1325 my $items_count = scalar @items;
1327 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1329 # If the number of holds is less than the count of items we have
1330 # plus the number of holds allowed above that count, we can stop here
1331 if ( $holds->count() <= $threshold ) {
1332 return $return_data;
1336 my $issuedate = dt_from_string();
1338 my $itype = $item_object->effective_itemtype;
1339 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1341 categorycode => $borrower->{categorycode},
1343 branchcode => $branchcode,
1346 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1348 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1350 my $rule = Koha::CirculationRules->get_effective_rule(
1352 categorycode => $borrower->{categorycode},
1353 itemtype => $item_object->effective_itemtype,
1354 branchcode => $branchcode,
1355 rule_name => 'decreaseloanholds',
1360 if ( defined($rule) && $rule->rule_value ne '' ){
1361 # overrides decreaseLoanHighHoldsDuration syspref
1362 $duration = $rule->rule_value;
1364 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1366 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1367 $reduced_datedue->set_hour($orig_due->hour);
1368 $reduced_datedue->set_minute($orig_due->minute);
1369 $reduced_datedue->truncate( to => 'minute' );
1371 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1372 $return_data->{exceeded} = 1;
1373 $return_data->{duration} = $duration;
1374 $return_data->{due_date} = $reduced_datedue;
1378 return $return_data;
1383 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1385 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1389 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1391 =item C<$barcode> is the barcode of the item being issued.
1393 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1394 Calculated if empty.
1396 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1398 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1399 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1401 AddIssue does the following things :
1403 - step 01: check that there is a borrowernumber & a barcode provided
1404 - check for RENEWAL (book issued & being issued to the same patron)
1405 - renewal YES = Calculate Charge & renew
1407 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1409 - fill reserve if reserve to this patron
1410 - cancel reserve or not, otherwise
1411 * TRANSFERT PENDING ?
1412 - complete the transfert
1420 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1422 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1423 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1424 my $auto_renew = $params && $params->{auto_renew};
1425 my $dbh = C4::Context->dbh;
1426 my $barcodecheck = CheckValidBarcode($barcode);
1430 if ( $datedue && ref $datedue ne 'DateTime' ) {
1431 $datedue = dt_from_string($datedue);
1434 # $issuedate defaults to today.
1435 if ( !defined $issuedate ) {
1436 $issuedate = dt_from_string();
1439 if ( ref $issuedate ne 'DateTime' ) {
1440 $issuedate = dt_from_string($issuedate);
1445 # Stop here if the patron or barcode doesn't exist
1446 if ( $borrower && $barcode && $barcodecheck ) {
1447 # find which item we issue
1448 my $item_object = Koha::Items->find({ barcode => $barcode })
1449 or return; # if we don't get an Item, abort.
1450 my $item_unblessed = $item_object->unblessed;
1452 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1454 # get actual issuing if there is one
1455 my $actualissue = $item_object->checkout;
1457 # check if we just renew the issue.
1458 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1459 and not $switch_onsite_checkout ) {
1460 $datedue = AddRenewal(
1461 $borrower->{'borrowernumber'},
1462 $item_object->itemnumber,
1465 $issuedate, # here interpreted as the renewal date
1470 my $itype = $item_object->effective_itemtype;
1471 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1474 $datedue->truncate( to => 'minute' );
1476 my $patron = Koha::Patrons->find( $borrower );
1477 my $library = Koha::Libraries->find( $branchcode );
1478 my $fees = Koha::Charges::Fees->new(
1481 library => $library,
1482 item => $item_object,
1483 to_date => $datedue,
1487 # it's NOT a renewal
1488 if ( $actualissue and not $switch_onsite_checkout ) {
1489 # This book is currently on loan, but not to the person
1490 # who wants to borrow it now. mark it returned before issuing to the new borrower
1491 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1492 return unless $allowed;
1493 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1494 # AddReturn certainly has side-effects, like onloan => undef
1495 $item_object->discard_changes;
1498 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1500 # Starting process for transfer job (checking transfert and validate it if we have one)
1501 if ( my $transfer = $item_object->get_transfer ) {
1502 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1505 datearrived => dt_from_string,
1506 tobranch => C4::Context->userenv->{branch},
1507 comments => 'Forced branchtransfer'
1510 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1511 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1512 if ( $hold ) { # Is this really needed?
1513 $hold->set( { found => undef } )->store;
1514 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1519 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1520 unless ($auto_renew) {
1521 my $rule = Koha::CirculationRules->get_effective_rule(
1523 categorycode => $borrower->{categorycode},
1524 itemtype => $item_object->effective_itemtype,
1525 branchcode => $branchcode,
1526 rule_name => 'auto_renew'
1530 $auto_renew = $rule->rule_value if $rule;
1533 my $issue_attributes = {
1534 borrowernumber => $borrower->{'borrowernumber'},
1535 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1536 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1537 branchcode => C4::Context->userenv->{'branch'},
1538 onsite_checkout => $onsite_checkout,
1539 auto_renew => $auto_renew ? 1 : 0,
1542 # Get ID of logged in user. if called from a batch job,
1543 # no user session exists and C4::Context->userenv() returns
1544 # the scalar '0'. Only do this if the syspref says so
1545 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1546 my $userenv = C4::Context->userenv();
1547 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1549 $issue_attributes->{issuer_id} = $usernumber;
1553 # In the case that the borrower has an on-site checkout
1554 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1555 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1557 $issue->set($issue_attributes)->store;
1560 $issue = Koha::Checkout->new(
1562 itemnumber => $item_object->itemnumber,
1567 $issue->discard_changes;
1568 C4::Auth::track_login_daily( $borrower->{userid} );
1569 if ( $item_object->location && $item_object->location eq 'CART'
1570 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1571 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1572 CartToShelf( $item_object->itemnumber );
1575 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1576 UpdateTotalIssues( $item_object->biblionumber, 1 );
1579 # Record if item was lost
1580 my $was_lost = $item_object->itemlost;
1582 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1583 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1584 $item_object->itemlost(0);
1585 $item_object->onloan($datedue->ymd());
1586 $item_object->datelastborrowed( dt_from_string()->ymd() );
1587 $item_object->datelastseen( dt_from_string()->ymd() );
1588 $item_object->store({log_action => 0});
1590 # If the item was lost, it has now been found, charge the overdue if necessary
1592 if ( $item_object->{_charge} ) {
1593 $actualissue //= Koha::Old::Checkouts->search(
1594 { itemnumber => $item_unblessed->{itemnumber} },
1596 order_by => { '-desc' => 'returndate' },
1600 unless ( exists( $borrower->{branchcode} ) ) {
1601 my $patron = $actualissue->patron;
1602 $borrower = $patron->unblessed;
1604 _CalculateAndUpdateFine(
1606 issue => $actualissue,
1607 item => $item_unblessed,
1608 borrower => $borrower,
1609 return_date => $issuedate
1612 _FixOverduesOnReturn( $borrower->{borrowernumber},
1613 $item_object->itemnumber, undef, 'RENEWED' );
1617 # If it costs to borrow this book, charge it to the patron's account.
1618 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1619 if ( $charge && $charge > 0 ) {
1620 AddIssuingCharge( $issue, $charge, 'RENT' );
1623 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1624 if ( $itemtype_object ) {
1625 my $accumulate_charge = $fees->accumulate_rentalcharge();
1626 if ( $accumulate_charge > 0 ) {
1627 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1628 $charge += $accumulate_charge;
1629 $item_unblessed->{charge} = $charge;
1633 # Record the fact that this book was issued.
1634 C4::Stats::UpdateStats(
1636 branch => C4::Context->userenv->{'branch'},
1637 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1639 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1640 itemnumber => $item_object->itemnumber,
1641 itemtype => $item_object->effective_itemtype,
1642 location => $item_object->location,
1643 borrowernumber => $borrower->{'borrowernumber'},
1644 ccode => $item_object->ccode,
1648 # Send a checkout slip.
1649 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1651 branchcode => $branchcode,
1652 categorycode => $borrower->{categorycode},
1653 item_type => $item_object->effective_itemtype,
1654 notification => 'CHECKOUT',
1656 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1657 SendCirculationAlert(
1660 item => $item_object->unblessed,
1661 borrower => $borrower,
1662 branch => $branchcode,
1667 "CIRCULATION", "ISSUE",
1668 $borrower->{'borrowernumber'},
1669 $item_object->itemnumber,
1670 ) if C4::Context->preference("IssueLog");
1672 Koha::Plugins->call('after_circ_action', {
1673 action => 'checkout',
1675 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1676 checkout => $issue->get_from_storage
1684 =head2 GetLoanLength
1686 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1688 Get loan length for an itemtype, a borrower type and a branch
1693 my ( $categorycode, $itemtype, $branchcode ) = @_;
1695 # Initialize default values
1699 lengthunit => 'days',
1702 my $found = Koha::CirculationRules->get_effective_rules( {
1703 branchcode => $branchcode,
1704 categorycode => $categorycode,
1705 itemtype => $itemtype,
1714 foreach my $rule_name (keys %$found) {
1715 $rules->{$rule_name} = $found->{$rule_name};
1722 =head2 GetHardDueDate
1724 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1726 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1730 sub GetHardDueDate {
1731 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1733 my $rules = Koha::CirculationRules->get_effective_rules(
1735 categorycode => $borrowertype,
1736 itemtype => $itemtype,
1737 branchcode => $branchcode,
1738 rules => [ 'hardduedate', 'hardduedatecompare' ],
1742 if ( defined( $rules->{hardduedate} ) ) {
1743 if ( $rules->{hardduedate} ) {
1744 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1747 return ( undef, undef );
1752 =head2 GetBranchBorrowerCircRule
1754 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1756 Retrieves circulation rule attributes that apply to the given
1757 branch and patron category, regardless of item type.
1758 The return value is a hashref containing the following key:
1760 patron_maxissueqty - maximum number of loans that a
1761 patron of the given category can have at the given
1762 branch. If the value is undef, no limit.
1764 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1765 patron of the given category can have at the given
1766 branch. If the value is undef, no limit.
1768 This will check for different branch/category combinations in the following order:
1772 default branch and category
1774 If no rule has been found in the database, it will default to
1777 patron_maxissueqty - undef
1778 patron_maxonsiteissueqty - undef
1780 C<$branchcode> and C<$categorycode> should contain the
1781 literal branch code and patron category code, respectively - no
1786 sub GetBranchBorrowerCircRule {
1787 my ( $branchcode, $categorycode ) = @_;
1789 # Initialize default values
1791 patron_maxissueqty => undef,
1792 patron_maxonsiteissueqty => undef,
1796 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1797 my $rule = Koha::CirculationRules->get_effective_rule(
1799 categorycode => $categorycode,
1801 branchcode => $branchcode,
1802 rule_name => $rule_name,
1806 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1812 =head2 GetBranchItemRule
1814 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1816 Retrieves circulation rule attributes that apply to the given
1817 branch and item type, regardless of patron category.
1819 The return value is a hashref containing the following keys:
1821 holdallowed => Hold policy for this branch and itemtype. Possible values:
1822 not_allowed: No holds allowed.
1823 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1824 from_any_library: Holds allowed from any patron.
1825 from_local_hold_group: Holds allowed from libraries in hold group
1827 returnbranch => branch to which to return item. Possible values:
1828 noreturn: do not return, let item remain where checked in (floating collections)
1829 homebranch: return to item's home branch
1830 holdingbranch: return to issuer branch
1832 This searches branchitemrules in the following order:
1834 * Same branchcode and itemtype
1835 * Same branchcode, itemtype '*'
1836 * branchcode '*', same itemtype
1837 * branchcode and itemtype '*'
1839 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1843 sub GetBranchItemRule {
1844 my ( $branchcode, $itemtype ) = @_;
1847 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1849 branchcode => $branchcode,
1850 itemtype => $itemtype,
1851 rule_name => 'holdallowed',
1854 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1856 branchcode => $branchcode,
1857 itemtype => $itemtype,
1858 rule_name => 'hold_fulfillment_policy',
1861 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1863 branchcode => $branchcode,
1864 itemtype => $itemtype,
1865 rule_name => 'returnbranch',
1869 # built-in default circulation rule
1871 $rules->{holdallowed} = defined $holdallowed_rule
1872 ? $holdallowed_rule->rule_value
1873 : 'from_any_library';
1874 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1875 ? $hold_fulfillment_policy_rule->rule_value
1877 $rules->{returnbranch} = defined $returnbranch_rule
1878 ? $returnbranch_rule->rule_value
1886 ($doreturn, $messages, $iteminformation, $borrower) =
1887 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1893 =item C<$barcode> is the bar code of the book being returned.
1895 =item C<$branch> is the code of the branch where the book is being returned.
1897 =item C<$exemptfine> indicates that overdue charges for the item will be
1900 =item C<$return_date> allows the default return date to be overridden
1901 by the given return date. Optional.
1905 C<&AddReturn> returns a list of four items:
1907 C<$doreturn> is true iff the return succeeded.
1909 C<$messages> is a reference-to-hash giving feedback on the operation.
1910 The keys of the hash are:
1916 No item with this barcode exists. The value is C<$barcode>.
1920 The book is not currently on loan. The value is C<$barcode>.
1924 This book has been withdrawn/cancelled. The value should be ignored.
1926 =item C<Wrongbranch>
1928 This book has was returned to the wrong branch. The value is a hashref
1929 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1930 contain the branchcode of the incorrect and correct return library, respectively.
1934 The item was reserved. The value is a reference-to-hash whose keys are
1935 fields from the reserves table of the Koha database, and
1936 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1937 either C<Waiting>, C<Reserved>, or 0.
1939 =item C<WasReturned>
1941 Value 1 if return is successful.
1943 =item C<NeedsTransfer>
1945 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1949 C<$iteminformation> is a reference-to-hash, giving information about the
1950 returned item from the issues table.
1952 C<$borrower> is a reference-to-hash, giving information about the
1953 patron who last borrowed the book.
1958 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1960 if ($branch and not Koha::Libraries->find($branch)) {
1961 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1964 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1965 my $return_date_specified = !!$return_date;
1966 $return_date //= dt_from_string();
1970 my $validTransfer = 1;
1971 my $stat_type = 'return';
1973 # get information on item
1974 my $item = Koha::Items->find({ barcode => $barcode });
1976 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1979 my $itemnumber = $item->itemnumber;
1980 my $itemtype = $item->effective_itemtype;
1982 my $issue = $item->checkout;
1984 $patron = $issue->patron
1985 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1986 . Dumper($issue->unblessed) . "\n";
1988 $messages->{'NotIssued'} = $barcode;
1989 $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
1991 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1993 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1994 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1995 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1996 $messages->{'LocalUse'} = 1;
1997 $stat_type = 'localuse';
2001 # full item data, but no borrowernumber or checkout info (no issue)
2002 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2003 # get the proper branch to which to return the item
2004 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2005 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2006 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2008 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2009 my $patron_unblessed = $patron ? $patron->unblessed : {};
2011 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2012 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2013 if ($update_loc_rules) {
2014 if (defined $update_loc_rules->{_ALL_}) {
2015 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2016 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2018 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2019 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2021 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2022 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2026 foreach my $key ( keys %$update_loc_rules ) {
2027 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2028 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2029 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2030 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2031 $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2038 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2040 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2042 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2044 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2047 foreach my $key ( keys %$rules ) {
2048 if ( $item->notforloan eq $key ) {
2049 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2050 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2057 # check if the return is allowed at this branch
2058 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2059 unless ($returnallowed){
2060 $messages->{'Wrongbranch'} = {
2061 Wrongbranch => $branch,
2062 Rightbranch => $message
2065 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2066 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2067 return ( $doreturn, $messages, $issue, $patron_unblessed);
2070 if ( $item->withdrawn ) { # book has been cancelled
2071 $messages->{'withdrawn'} = 1;
2072 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2075 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2079 # case of a return of document (deal with issues and holdingbranch)
2081 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2082 $patron or warn "AddReturn without current borrower";
2086 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2091 C4::Context->preference('CalculateFinesOnReturn')
2092 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2097 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2100 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 );
2102 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2103 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2105 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2108 # FIXME is the "= 1" right? This could be the borrower hash.
2109 $messages->{'WasReturned'} = 1;
2112 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2116 # the holdingbranch is updated if the document is returned to another location.
2117 # this is always done regardless of whether the item was on loan or not
2118 if ($item->holdingbranch ne $branch) {
2119 $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2122 my $item_was_lost = $item->itemlost;
2123 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2124 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2126 # fix up the accounts.....
2127 if ($item_was_lost) {
2128 $messages->{'WasLost'} = 1;
2129 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2130 $messages->{'LostItemFeeRefunded'} = $updated_item->{_refunded};
2131 $messages->{'LostItemFeeRestored'} = $updated_item->{_restored};
2133 if ( $updated_item->{_charge} ) {
2134 $issue //= Koha::Old::Checkouts->search(
2135 { itemnumber => $item->itemnumber },
2136 { order_by => { '-desc' => 'returndate' }, rows => 1 } )
2138 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2139 my $patron = $issue->patron;
2140 $patron_unblessed = $patron->unblessed;
2142 _CalculateAndUpdateFine(
2145 item => $item->unblessed,
2146 borrower => $patron_unblessed,
2147 return_date => $return_date
2150 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2151 $item->itemnumber, undef, 'RETURNED' );
2152 $messages->{'LostItemFeeCharged'} = 1;
2157 # check if we have a transfer for this document
2158 my $transfer = $item->get_transfer;
2160 # if we have a transfer to complete, we update the line of transfers with the datearrived
2163 if ( $transfer->in_transit ) {
2164 if ( $transfer->tobranch eq $branch ) {
2166 $messages->{'TransferArrived'} = $transfer->frombranch;
2167 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2168 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2171 $messages->{'WrongTransfer'} = $transfer->tobranch;
2172 $messages->{'WrongTransferItem'} = $item->itemnumber;
2173 $messages->{'TransferTrigger'} = $transfer->reason;
2177 if ( $transfer->tobranch eq $branch ) {
2179 $messages->{'TransferArrived'} = $transfer->frombranch;
2180 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2181 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2184 $messages->{'WasTransfered'} = $transfer->tobranch;
2185 $messages->{'TransferTrigger'} = $transfer->reason;
2190 # fix up the overdues in accounts...
2191 if ($borrowernumber) {
2192 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2193 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2195 if ( $issue and $issue->is_overdue($return_date) ) {
2197 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2199 $messages->{'PrevDebarred'} = $debardate;
2201 $messages->{'Debarred'} = $debardate if $debardate;
2203 # there's no overdue on the item but borrower had been previously debarred
2204 } elsif ( $issue->date_due and $patron->debarred ) {
2205 if ( $patron->debarred eq "9999-12-31") {
2206 $messages->{'ForeverDebarred'} = $patron->debarred;
2208 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2209 $borrower_debar_dt->truncate(to => 'day');
2210 my $today_dt = $return_date->clone()->truncate(to => 'day');
2211 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2212 $messages->{'PrevDebarred'} = $patron->debarred;
2218 # find reserves.....
2219 # launch the Checkreserves routine to find any holds
2220 my ($resfound, $resrec);
2221 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2222 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2223 # 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)
2224 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2225 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2226 $resfound = 'Reserved';
2227 $resrec = $hold->unblessed;
2230 $resrec->{'ResFound'} = $resfound;
2231 $messages->{'ResFound'} = $resrec;
2234 # Record the fact that this book was returned.
2235 C4::Stats::UpdateStats({
2238 itemnumber => $itemnumber,
2239 itemtype => $itemtype,
2240 location => $item->location,
2241 borrowernumber => $borrowernumber,
2242 ccode => $item->ccode,
2245 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2247 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2249 branchcode => $branch,
2250 categorycode => $patron->categorycode,
2251 item_type => $itemtype,
2252 notification => 'CHECKIN',
2254 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2255 SendCirculationAlert({
2257 item => $item->unblessed,
2258 borrower => $patron->unblessed,
2263 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2264 if C4::Context->preference("ReturnLog");
2267 # Check if this item belongs to a biblio record that is attached to an
2268 # ILL request, if it is we need to update the ILL request's status
2269 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2270 my $request = Koha::Illrequests->find(
2271 { biblio_id => $item->biblio->biblionumber }
2273 $request->status('RET') if $request;
2276 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2277 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2278 && ( $doreturn or $messages->{'NotIssued'} )
2280 and ( $branch ne $returnbranch )
2281 and not $messages->{'WrongTransfer'}
2282 and not $messages->{'WasTransfered'} )
2284 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2285 if (C4::Context->preference("AutomaticItemReturn" ) or
2286 (C4::Context->preference("UseBranchTransferLimits") and
2287 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2289 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2290 $messages->{'WasTransfered'} = $returnbranch;
2291 $messages->{'TransferTrigger'} = $transfer_trigger;
2293 $messages->{'NeedsTransfer'} = $returnbranch;
2294 $messages->{'TransferTrigger'} = $transfer_trigger;
2298 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2299 my $claims = Koha::Checkouts::ReturnClaims->search(
2301 itemnumber => $item->id,
2302 resolution => undef,
2306 if ( $claims->count ) {
2307 $messages->{ReturnClaims} = $claims;
2311 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2312 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2314 if ( $doreturn and $issue ) {
2315 my $checkin = Koha::Old::Checkouts->find($issue->id);
2317 Koha::Plugins->call('after_circ_action', {
2318 action => 'checkin',
2325 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2328 =head2 MarkIssueReturned
2330 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2332 Unconditionally marks an issue as being returned by
2333 moving the C<issues> row to C<old_issues> and
2334 setting C<returndate> to the current date.
2336 if C<$returndate> is specified (in iso format), it is used as the date
2339 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2340 the old_issue is immediately anonymised
2342 Ideally, this function would be internal to C<C4::Circulation>,
2343 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2344 and offline_circ/process_koc.pl.
2346 The last optional parameter allos passing skip_record_index to the item store call.
2350 sub MarkIssueReturned {
2351 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2353 # Retrieve the issue
2354 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2356 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2358 my $issue_id = $issue->issue_id;
2360 my $anonymouspatron;
2361 if ( $privacy && $privacy == 2 ) {
2362 # The default of 0 will not work due to foreign key constraints
2363 # The anonymisation will fail if AnonymousPatron is not a valid entry
2364 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2365 # Note that a warning should appear on the about page (System information tab).
2366 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2367 die "Fatal error: the patron ($borrowernumber) has requested their circulation history be anonymized on check-in, but the AnonymousPatron system preference is empty or not set correctly."
2368 unless Koha::Patrons->find( $anonymouspatron );
2371 my $schema = Koha::Database->schema;
2373 # FIXME Improve the return value and handle it from callers
2374 $schema->txn_do(sub {
2376 my $patron = Koha::Patrons->find( $borrowernumber );
2378 # Update the returndate value
2379 if ( $returndate ) {
2380 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2383 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2386 # Create the old_issues entry
2387 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2389 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2390 if ( $privacy && $privacy == 2) {
2391 $old_checkout->borrowernumber($anonymouspatron)->store;
2394 # And finally delete the issue
2397 $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2399 if ( C4::Context->preference('StoreLastBorrower') ) {
2400 my $item = Koha::Items->find( $itemnumber );
2401 $item->last_returned_by( $patron );
2404 # Remove any OVERDUES related debarment if the borrower has no overdues
2405 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2406 && $patron->debarred
2407 && !$patron->has_overdues
2408 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2410 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2418 =head2 _debar_user_on_return
2420 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2422 C<$borrower> borrower hashref
2424 C<$item> item hashref
2426 C<$datedue> date due DateTime object
2428 C<$returndate> DateTime object representing the return time
2430 Internal function, called only by AddReturn that calculates and updates
2431 the user fine days, and debars them if necessary.
2433 Should only be called for overdue returns
2435 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2440 sub _calculate_new_debar_dt {
2441 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2443 my $branchcode = _GetCircControlBranch( $item, $borrower );
2444 my $circcontrol = C4::Context->preference('CircControl');
2445 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2446 { categorycode => $borrower->{categorycode},
2447 itemtype => $item->{itype},
2448 branchcode => $branchcode,
2453 'maxsuspensiondays',
2454 'suspension_chargeperiod',
2458 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2459 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2460 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2462 return unless $finedays;
2464 # finedays is in days, so hourly loans must multiply by 24
2465 # thus 1 hour late equals 1 day suspension * finedays rate
2466 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2468 # grace period is measured in the same units as the loan
2470 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2472 my $deltadays = DateTime::Duration->new(
2473 days => $chargeable_units
2476 if ( $deltadays->subtract($grace)->is_positive() ) {
2477 my $suspension_days = $deltadays * $finedays;
2479 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2480 # No need to / 1 and do not consider / 0
2481 $suspension_days = DateTime::Duration->new(
2482 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2486 # If the max suspension days is < than the suspension days
2487 # the suspension days is limited to this maximum period.
2488 my $max_sd = $issuing_rule->{maxsuspensiondays};
2489 if ( defined $max_sd && $max_sd ne '' ) {
2490 $max_sd = DateTime::Duration->new( days => $max_sd );
2491 $suspension_days = $max_sd
2492 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2495 my ( $has_been_extended );
2496 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2497 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2499 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2500 $has_been_extended = 1;
2505 # Use the calendar or not to calculate the debarment date
2506 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2507 my $calendar = Koha::Calendar->new(
2508 branchcode => $branchcode,
2509 days_mode => 'Calendar'
2511 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2514 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2516 return $new_debar_dt;
2521 sub _debar_user_on_return {
2522 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2524 $return_date //= dt_from_string();
2526 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2528 return unless $new_debar_dt;
2530 Koha::Patron::Debarments::AddUniqueDebarment({
2531 borrowernumber => $borrower->{borrowernumber},
2532 expiration => $new_debar_dt->ymd(),
2533 type => 'SUSPENSION',
2535 # if borrower was already debarred but does not get an extra debarment
2536 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2537 my ($new_debarment_str, $is_a_reminder);
2538 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2540 $new_debarment_str = $borrower->{debarred};
2542 $new_debarment_str = $new_debar_dt->ymd();
2544 # FIXME Should return a DateTime object
2545 return $new_debarment_str, $is_a_reminder;
2548 =head2 _FixOverduesOnReturn
2550 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2552 C<$borrowernumber> borrowernumber
2554 C<$itemnumber> itemnumber
2556 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2558 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2564 sub _FixOverduesOnReturn {
2565 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2566 unless( $borrowernumber ) {
2567 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2571 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2575 warn "_FixOverduesOnReturn() not supplied valid status";
2579 my $schema = Koha::Database->schema;
2581 my $result = $schema->txn_do(
2583 # check for overdue fine
2584 my $accountlines = Koha::Account::Lines->search(
2586 borrowernumber => $borrowernumber,
2587 itemnumber => $item,
2588 debit_type_code => 'OVERDUE',
2589 status => 'UNRETURNED'
2592 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2594 my $accountline = $accountlines->next;
2595 my $payments = $accountline->credits;
2597 my $amountoutstanding = $accountline->amountoutstanding;
2598 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2599 $accountline->delete;
2600 return 0; # no warning, we've just removed a zero value fine (backdated return)
2601 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2602 my $account = Koha::Account->new({patron_id => $borrowernumber});
2603 my $credit = $account->add_credit(
2605 amount => $amountoutstanding,
2606 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2607 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2608 interface => C4::Context->interface,
2614 $credit->apply({ debits => [ $accountline ] });
2616 if (C4::Context->preference("FinesLog")) {
2617 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2621 $accountline->status($status);
2622 return $accountline->store();
2629 =head2 _GetCircControlBranch
2631 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2635 Return the library code to be used to determine which circulation
2636 policy applies to a transaction. Looks up the CircControl and
2637 HomeOrHoldingBranch system preferences.
2639 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2641 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2645 sub _GetCircControlBranch {
2646 my ($item, $borrower) = @_;
2647 my $circcontrol = C4::Context->preference('CircControl');
2650 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2651 $branch= C4::Context->userenv->{'branch'};
2652 } elsif ($circcontrol eq 'PatronLibrary') {
2653 $branch=$borrower->{branchcode};
2655 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2656 $branch = $item->{$branchfield};
2657 # default to item home branch if holdingbranch is used
2658 # and is not defined
2659 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2660 $branch = $item->{homebranch};
2668 $issue = GetOpenIssue( $itemnumber );
2670 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2672 C<$itemnumber> is the item's itemnumber
2679 my ( $itemnumber ) = @_;
2680 return unless $itemnumber;
2681 my $dbh = C4::Context->dbh;
2682 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2683 $sth->execute( $itemnumber );
2684 return $sth->fetchrow_hashref();
2688 =head2 GetUpcomingDueIssues
2690 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2694 sub GetUpcomingDueIssues {
2697 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2698 my $dbh = C4::Context->dbh;
2701 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2703 LEFT JOIN items USING (itemnumber)
2704 LEFT JOIN branches ON branches.branchcode =
2706 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2707 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2708 my @bind_parameters = ( $params->{'days_in_advance'} );
2710 my $sth = $dbh->prepare( $statement );
2711 $sth->execute( @bind_parameters );
2712 my $upcoming_dues = $sth->fetchall_arrayref({});
2714 return $upcoming_dues;
2717 =head2 CanBookBeRenewed
2719 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2721 Find out whether a borrowed item may be renewed.
2723 C<$borrowernumber> is the borrower number of the patron who currently
2724 has the item on loan.
2726 C<$itemnumber> is the number of the item to renew.
2728 C<$override_limit>, if supplied with a true value, causes
2729 the limit on the number of times that the loan can be renewed
2730 (as controlled by the item type) to be ignored. Overriding also allows
2731 to renew sooner than "No renewal before" and to manually renew loans
2732 that are automatically renewed.
2734 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2735 item must currently be on loan to the specified borrower; renewals
2736 must be allowed for the item's type; and the borrower must not have
2737 already renewed the loan. $error will contain the reason the renewal can not proceed
2741 sub CanBookBeRenewed {
2742 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2744 my $dbh = C4::Context->dbh;
2746 my $auto_renew = "no";
2748 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2749 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2750 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2751 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2753 my $patron = $issue->patron or return;
2755 # override_limit will override anything else except on_reserve
2756 unless ( $override_limit ){
2757 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2758 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2760 categorycode => $patron->categorycode,
2761 itemtype => $item->effective_itemtype,
2762 branchcode => $branchcode,
2765 'no_auto_renewal_after',
2766 'no_auto_renewal_after_hard_limit',
2769 'unseen_renewals_allowed'
2774 return ( 0, "too_many" )
2775 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2777 return ( 0, "too_unseen" )
2778 if C4::Context->preference('UnseenRenewals') &&
2779 $issuing_rule->{unseen_renewals_allowed} &&
2780 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2782 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2783 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2784 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2785 my $restricted = $patron->is_debarred;
2786 my $hasoverdues = $patron->has_overdues;
2788 if ( $restricted and $restrictionblockrenewing ) {
2789 return ( 0, 'restriction');
2790 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2791 return ( 0, 'overdue');
2794 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2796 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2797 return ( 0, 'auto_account_expired' );
2800 if ( defined $issuing_rule->{no_auto_renewal_after}
2801 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2802 # Get issue_date and add no_auto_renewal_after
2803 # If this is greater than today, it's too late for renewal.
2804 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2805 $maximum_renewal_date->add(
2806 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2808 my $now = dt_from_string;
2809 if ( $now >= $maximum_renewal_date ) {
2810 return ( 0, "auto_too_late" );
2813 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2814 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2815 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2816 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2817 return ( 0, "auto_too_late" );
2821 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2822 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2823 my $amountoutstanding =
2824 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2825 ? $patron->account->balance
2826 : $patron->account->outstanding_debits->total_outstanding;
2827 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2828 return ( 0, "auto_too_much_oweing" );
2833 if ( defined $issuing_rule->{norenewalbefore}
2834 and $issuing_rule->{norenewalbefore} ne "" )
2837 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2838 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2839 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2841 # Depending on syspref reset the exact time, only check the date
2842 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2843 and $issuing_rule->{lengthunit} eq 'days' )
2845 $soonestrenewal->truncate( to => 'day' );
2848 if ( $soonestrenewal > dt_from_string() )
2850 $auto_renew = ($issue->auto_renew && $patron->autorenew_checkouts) ? "auto_too_soon" : "too_soon";
2852 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2857 # Fallback for automatic renewals:
2858 # If norenewalbefore is undef, don't renew before due date.
2859 if ( $issue->auto_renew && $auto_renew eq "no" && $patron->autorenew_checkouts ) {
2860 my $now = dt_from_string;
2861 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2864 $auto_renew = "auto_too_soon";
2869 my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2871 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2872 if ( $resfound && $resrec->{non_priority} ) {
2873 $resfound = Koha::Holds->search(
2874 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2880 # This item can fill one or more unfilled reserve, can those unfilled reserves
2881 # all be filled by other available items?
2883 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2885 my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2887 # There is an item level hold on this item, no other item can fill the hold
2892 # Get all other items that could possibly fill reserves
2893 my $items = Koha::Items->search({
2894 biblionumber => $resrec->{biblionumber},
2897 -not => { itemnumber => $itemnumber }
2900 # Get all other reserves that could have been filled by this item
2901 my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2902 my $patrons = Koha::Patrons->search({
2903 borrowernumber => { -in => \@borrowernumbers }
2906 # If the count of the union of the lists of reservable items for each borrower
2907 # is equal or greater than the number of borrowers, we know that all reserves
2908 # can be filled with available items. We can get the union of the sets simply
2909 # by pushing all the elements onto an array and removing the duplicates.
2911 ITEM: while ( my $item = $items->next ) {
2912 next if IsItemOnHoldAndFound( $item->itemnumber );
2913 while ( my $patron = $patrons->next ) {
2914 next unless IsAvailableForItemLevelRequest($item, $patron);
2915 next unless CanItemBeReserved($patron->borrowernumber,$item->itemnumber,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2916 push @reservable, $item->itemnumber;
2917 if (@reservable >= @borrowernumbers) {
2927 if( $cron ) { #The cron wants to return 'too_soon' over 'on_reserve'
2928 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2929 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2930 } else { # For other purposes we want 'on_reserve' before 'too_soon'
2931 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2932 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2935 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2937 return ( 1, undef );
2942 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2946 C<$borrowernumber> is the borrower number of the patron who currently
2949 C<$itemnumber> is the number of the item to renew.
2951 C<$branch> is the library where the renewal took place (if any).
2952 The library that controls the circ policies for the renewal is retrieved from the issues record.
2954 C<$datedue> can be a DateTime object used to set the due date.
2956 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2957 this parameter is not supplied, lastreneweddate is set to the current date.
2959 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2960 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2961 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2964 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2965 from the book's item type.
2967 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
2968 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
2969 fallback to a true value
2974 my $borrowernumber = shift;
2975 my $itemnumber = shift or return;
2977 my $datedue = shift;
2978 my $lastreneweddate = shift || dt_from_string();
2979 my $skipfinecalc = shift;
2982 # Fallback on a 'seen' renewal
2983 $seen = defined $seen && $seen == 0 ? 0 : 1;
2985 my $item_object = Koha::Items->find($itemnumber) or return;
2986 my $biblio = $item_object->biblio;
2987 my $issue = $item_object->checkout;
2988 my $item_unblessed = $item_object->unblessed;
2990 my $dbh = C4::Context->dbh;
2992 return unless $issue;
2994 $borrowernumber ||= $issue->borrowernumber;
2996 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2997 carp 'Invalid date passed to AddRenewal.';
3001 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3002 my $patron_unblessed = $patron->unblessed;
3004 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3006 my $schema = Koha::Database->schema;
3007 $schema->txn_do(sub{
3009 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3010 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3012 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3014 # If the due date wasn't specified, calculate it by adding the
3015 # book's loan length to today's date or the current due date
3016 # based on the value of the RenewalPeriodBase syspref.
3017 my $itemtype = $item_object->effective_itemtype;
3020 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3021 dt_from_string( $issue->date_due, 'sql' ) :
3023 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3026 my $fees = Koha::Charges::Fees->new(
3029 library => $circ_library,
3030 item => $item_object,
3031 from_date => dt_from_string( $issue->date_due, 'sql' ),
3032 to_date => dt_from_string($datedue),
3036 # Increment the unseen renewals, if appropriate
3037 # We only do so if the syspref is enabled and
3038 # a maximum value has been set in the circ rules
3039 my $unseen_renewals = $issue->unseen_renewals;
3040 if (C4::Context->preference('UnseenRenewals')) {
3041 my $rule = Koha::CirculationRules->get_effective_rule(
3042 { categorycode => $patron->categorycode,
3043 itemtype => $item_object->effective_itemtype,
3044 branchcode => $circ_library->branchcode,
3045 rule_name => 'unseen_renewals_allowed'
3048 if (!$seen && $rule && $rule->rule_value) {
3051 # If the renewal is seen, unseen should revert to 0
3052 $unseen_renewals = 0;
3056 # Update the issues record to have the new due date, and a new count
3057 # of how many times it has been renewed.
3058 my $renews = ( $issue->renewals || 0 ) + 1;
3059 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3062 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3065 Koha::Exceptions::Checkout::FailedRenewal->throw(
3066 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3070 # Update the renewal count on the item, and tell zebra to reindex
3071 $renews = ( $item_object->renewals || 0 ) + 1;
3072 $item_object->renewals($renews);
3073 $item_object->onloan($datedue);
3074 $item_object->store({ log_action => 0 });
3076 # Charge a new rental fee, if applicable
3077 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3078 if ( $charge > 0 ) {
3079 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3082 # Charge a new accumulate rental fee, if applicable
3083 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3084 if ( $itemtype_object ) {
3085 my $accumulate_charge = $fees->accumulate_rentalcharge();
3086 if ( $accumulate_charge > 0 ) {
3087 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3089 $charge += $accumulate_charge;
3092 # Send a renewal slip according to checkout alert preferencei
3093 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3094 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3096 branchcode => $branch,
3097 categorycode => $patron->categorycode,
3098 item_type => $itemtype,
3099 notification => 'CHECKOUT',
3101 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3102 SendCirculationAlert(
3105 item => $item_unblessed,
3106 borrower => $patron->unblessed,
3113 # Remove any OVERDUES related debarment if the borrower has no overdues
3115 && $patron->is_debarred
3116 && ! $patron->has_overdues
3117 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3119 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3122 # Add the renewal to stats
3123 C4::Stats::UpdateStats(
3125 branch => $item_object->renewal_branchcode({branch => $branch}),
3128 itemnumber => $itemnumber,
3129 itemtype => $itemtype,
3130 location => $item_object->location,
3131 borrowernumber => $borrowernumber,
3132 ccode => $item_object->ccode,
3137 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3139 Koha::Plugins->call('after_circ_action', {
3140 action => 'renewal',
3142 checkout => $issue->get_from_storage
3151 # check renewal status
3152 my ( $bornum, $itemno ) = @_;
3153 my $dbh = C4::Context->dbh;
3155 my $unseencount = 0;
3156 my $renewsallowed = 0;
3157 my $unseenallowed = 0;
3161 my $patron = Koha::Patrons->find( $bornum );
3162 my $item = Koha::Items->find($itemno);
3164 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3166 # Look in the issues table for this item, lent to this borrower,
3167 # and not yet returned.
3169 # FIXME - I think this function could be redone to use only one SQL call.
3170 my $sth = $dbh->prepare(
3171 "select * from issues
3172 where (borrowernumber = ?)
3173 and (itemnumber = ?)"
3175 $sth->execute( $bornum, $itemno );
3176 my $data = $sth->fetchrow_hashref;
3177 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3178 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3179 # $item and $borrower should be calculated
3180 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3182 my $rules = Koha::CirculationRules->get_effective_rules(
3184 categorycode => $patron->categorycode,
3185 itemtype => $item->effective_itemtype,
3186 branchcode => $branchcode,
3187 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3190 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3191 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3192 $rules->{unseen_renewals_allowed} :
3194 $renewsleft = $renewsallowed - $renewcount;
3195 $unseenleft = $unseenallowed - $unseencount;
3196 if($renewsleft < 0){ $renewsleft = 0; }
3197 if($unseenleft < 0){ $unseenleft = 0; }
3208 =head2 GetSoonestRenewDate
3210 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3212 Find out the soonest possible renew date of a borrowed item.
3214 C<$borrowernumber> is the borrower number of the patron who currently
3215 has the item on loan.
3217 C<$itemnumber> is the number of the item to renew.
3219 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3220 renew date, based on the value "No renewal before" of the applicable
3221 issuing rule. Returns the current date if the item can already be
3222 renewed, and returns undefined if the borrower, loan, or item
3227 sub GetSoonestRenewDate {
3228 my ( $borrowernumber, $itemnumber ) = @_;
3230 my $dbh = C4::Context->dbh;
3232 my $item = Koha::Items->find($itemnumber) or return;
3233 my $itemissue = $item->checkout or return;
3235 $borrowernumber ||= $itemissue->borrowernumber;
3236 my $patron = Koha::Patrons->find( $borrowernumber )
3239 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3240 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3241 { categorycode => $patron->categorycode,
3242 itemtype => $item->effective_itemtype,
3243 branchcode => $branchcode,
3251 my $now = dt_from_string;
3252 return $now unless $issuing_rule;
3254 if ( defined $issuing_rule->{norenewalbefore}
3255 and $issuing_rule->{norenewalbefore} ne "" )
3257 my $soonestrenewal =
3258 dt_from_string( $itemissue->date_due )->subtract(
3259 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3261 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3262 and $issuing_rule->{lengthunit} eq 'days' )
3264 $soonestrenewal->truncate( to => 'day' );
3266 return $soonestrenewal if $now < $soonestrenewal;
3271 =head2 GetLatestAutoRenewDate
3273 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3275 Find out the latest possible auto renew date of a borrowed item.
3277 C<$borrowernumber> is the borrower number of the patron who currently
3278 has the item on loan.
3280 C<$itemnumber> is the number of the item to renew.
3282 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3283 auto renew date, based on the value "No auto renewal after" and the "No auto
3284 renewal after (hard limit) of the applicable issuing rule.
3285 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3286 or item cannot be found.
3290 sub GetLatestAutoRenewDate {
3291 my ( $borrowernumber, $itemnumber ) = @_;
3293 my $dbh = C4::Context->dbh;
3295 my $item = Koha::Items->find($itemnumber) or return;
3296 my $itemissue = $item->checkout or return;
3298 $borrowernumber ||= $itemissue->borrowernumber;
3299 my $patron = Koha::Patrons->find( $borrowernumber )
3302 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3303 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3305 categorycode => $patron->categorycode,
3306 itemtype => $item->effective_itemtype,
3307 branchcode => $branchcode,
3309 'no_auto_renewal_after',
3310 'no_auto_renewal_after_hard_limit',
3316 return unless $circulation_rules;
3318 if ( not $circulation_rules->{no_auto_renewal_after}
3319 or $circulation_rules->{no_auto_renewal_after} eq '' )
3320 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3321 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3323 my $maximum_renewal_date;
3324 if ( $circulation_rules->{no_auto_renewal_after} ) {
3325 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3326 $maximum_renewal_date->add(
3327 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3331 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3332 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3333 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3335 return $maximum_renewal_date;
3339 =head2 GetIssuingCharges
3341 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3343 Calculate how much it would cost for a given patron to borrow a given
3344 item, including any applicable discounts.
3346 C<$itemnumber> is the item number of item the patron wishes to borrow.
3348 C<$borrowernumber> is the patron's borrower number.
3350 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3351 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3356 sub GetIssuingCharges {
3358 # calculate charges due
3359 my ( $itemnumber, $borrowernumber ) = @_;
3361 my $dbh = C4::Context->dbh;
3364 # Get the book's item type and rental charge (via its biblioitem).
3365 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3366 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3367 $charge_query .= (C4::Context->preference('item-level_itypes'))
3368 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3369 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3371 $charge_query .= ' WHERE items.itemnumber =?';
3373 my $sth = $dbh->prepare($charge_query);
3374 $sth->execute($itemnumber);
3375 if ( my $item_data = $sth->fetchrow_hashref ) {
3376 $item_type = $item_data->{itemtype};
3377 $charge = $item_data->{rentalcharge};
3379 # FIXME This should follow CircControl
3380 my $branch = C4::Context::mybranch();
3381 my $patron = Koha::Patrons->find( $borrowernumber );
3382 my $discount = Koha::CirculationRules->get_effective_rule({
3383 categorycode => $patron->categorycode,
3384 branchcode => $branch,
3385 itemtype => $item_type,
3386 rule_name => 'rentaldiscount'
3389 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3391 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3395 return ( $charge, $item_type );
3398 =head2 AddIssuingCharge
3400 &AddIssuingCharge( $checkout, $charge, $type )
3404 sub AddIssuingCharge {
3405 my ( $checkout, $charge, $type ) = @_;
3407 # FIXME What if checkout does not exist?
3409 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3410 my $accountline = $account->add_debit(
3414 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3415 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3416 interface => C4::Context->interface,
3418 item_id => $checkout->itemnumber,
3419 issue_id => $checkout->issue_id,
3426 GetTransfers($itemnumber);
3431 my ($itemnumber) = @_;
3433 my $dbh = C4::Context->dbh;
3442 FROM branchtransfers
3443 WHERE itemnumber = ?
3444 AND datearrived IS NULL
3445 AND datecancelled IS NULL
3447 my $sth = $dbh->prepare($query);
3448 $sth->execute($itemnumber);
3449 my @row = $sth->fetchrow_array();
3453 =head2 GetTransfersFromTo
3455 @results = GetTransfersFromTo($frombranch,$tobranch);
3457 Returns the list of pending transfers between $from and $to branch
3461 sub GetTransfersFromTo {
3462 my ( $frombranch, $tobranch ) = @_;
3463 return unless ( $frombranch && $tobranch );
3464 my $dbh = C4::Context->dbh;
3466 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3467 FROM branchtransfers
3470 AND datecancelled IS NULL
3471 AND datesent IS NOT NULL
3472 AND datearrived IS NULL
3474 my $sth = $dbh->prepare($query);
3475 $sth->execute( $frombranch, $tobranch );
3478 while ( my $data = $sth->fetchrow_hashref ) {
3479 push @gettransfers, $data;
3481 return (@gettransfers);
3484 =head2 SendCirculationAlert
3486 Send out a C<check-in> or C<checkout> alert using the messaging system.
3494 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3498 Hashref of information about the item being checked in or out.
3502 Hashref of information about the borrower of the item.
3506 The branchcode from where the checkout or check-in took place.
3512 SendCirculationAlert({
3515 borrower => $borrower,
3521 sub SendCirculationAlert {
3523 my ($type, $item, $borrower, $branch) =
3524 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3525 my %message_name = (
3526 CHECKIN => 'Item_Check_in',
3527 CHECKOUT => 'Item_Checkout',
3528 RENEWAL => 'Item_Checkout',
3530 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3531 borrowernumber => $borrower->{borrowernumber},
3532 message_name => $message_name{$type},
3534 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3536 my $schema = Koha::Database->new->schema;
3537 my @transports = keys %{ $borrower_preferences->{transports} };
3539 # From the MySQL doc:
3540 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3541 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3542 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3543 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3545 for my $mtt (@transports) {
3546 my $letter = C4::Letters::GetPreparedLetter (
3547 module => 'circulation',
3548 letter_code => $type,
3549 branchcode => $branch,
3550 message_transport_type => $mtt,
3551 lang => $borrower->{lang},
3553 $issues_table => $item->{itemnumber},
3554 'items' => $item->{itemnumber},
3555 'biblio' => $item->{biblionumber},
3556 'biblioitems' => $item->{biblionumber},
3557 'borrowers' => $borrower,
3558 'branches' => $branch,
3562 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3563 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3564 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3565 unless ( $message ) {
3566 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3567 C4::Message->enqueue($letter, $borrower, $mtt);
3569 $message->append($letter);
3572 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3578 =head2 updateWrongTransfer
3580 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3582 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
3586 sub updateWrongTransfer {
3587 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3589 # first step: cancel the original transfer
3590 my $item = Koha::Items->find($itemNumber);
3591 my $transfer = $item->get_transfer;
3592 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3594 # second step: create a new transfer to the right location
3595 my $new_transfer = $item->request_transfer(
3597 to => $transfer->to_library,
3598 reason => $transfer->reason,
3599 comment => $transfer->comments,
3605 return $new_transfer;
3610 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3612 this function calculates the due date given the start date and configured circulation rules,
3613 checking against the holidays calendar as per the daysmode circulation rule.
3614 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3615 C<$itemtype> = itemtype code of item in question
3616 C<$branch> = location whose calendar to use
3617 C<$borrower> = Borrower object
3618 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3623 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3627 # loanlength now a href
3629 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3631 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3637 if (ref $startdate ne 'DateTime' ) {
3638 $datedue = dt_from_string($datedue);
3640 $datedue = $startdate->clone;
3643 $datedue = dt_from_string()->truncate( to => 'minute' );
3647 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3649 categorycode => $borrower->{categorycode},
3650 itemtype => $itemtype,
3651 branchcode => $branch,
3655 # calculate the datedue as normal
3656 if ( $daysmode eq 'Days' )
3657 { # ignoring calendar
3658 if ( $loanlength->{lengthunit} eq 'hours' ) {
3659 $datedue->add( hours => $loanlength->{$length_key} );
3661 $datedue->add( days => $loanlength->{$length_key} );
3662 $datedue->set_hour(23);
3663 $datedue->set_minute(59);
3667 if ($loanlength->{lengthunit} eq 'hours') {
3668 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3671 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3673 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3674 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3675 if ($loanlength->{lengthunit} eq 'days') {
3676 $datedue->set_hour(23);
3677 $datedue->set_minute(59);
3681 # if Hard Due Dates are used, retrieve them and apply as necessary
3682 my ( $hardduedate, $hardduedatecompare ) =
3683 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3684 if ($hardduedate) { # hardduedates are currently dates
3685 $hardduedate->truncate( to => 'minute' );
3686 $hardduedate->set_hour(23);
3687 $hardduedate->set_minute(59);
3688 my $cmp = DateTime->compare( $hardduedate, $datedue );
3690 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3691 # if the calculated date is before the 'after' Hard Due Date (floor), override
3692 # if the hard due date is set to 'exactly', overrride
3693 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3694 $datedue = $hardduedate->clone;
3697 # in all other cases, keep the date due as it is
3701 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3702 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3703 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3704 if( $expiry_dt ) { #skip empty expiry date..
3705 $expiry_dt->set( hour => 23, minute => 59);
3706 my $d1= $datedue->clone->set_time_zone('floating');
3707 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3708 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3711 if ( $daysmode ne 'Days' ) {
3712 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3713 if ( $calendar->is_holiday($datedue) ) {
3714 # Don't return on a closed day
3715 $datedue = $calendar->prev_open_days( $datedue, 1 );
3724 sub CheckValidBarcode{
3726 my $dbh = C4::Context->dbh;
3727 my $query=qq|SELECT count(*)
3731 my $sth = $dbh->prepare($query);
3732 $sth->execute($barcode);
3733 my $exist=$sth->fetchrow ;
3737 =head2 IsBranchTransferAllowed
3739 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3741 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3743 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3744 Koha::Item->can_be_transferred.
3748 sub IsBranchTransferAllowed {
3749 my ( $toBranch, $fromBranch, $code ) = @_;
3751 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3753 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3754 my $dbh = C4::Context->dbh;
3756 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3757 $sth->execute( $toBranch, $fromBranch, $code );
3758 my $limit = $sth->fetchrow_hashref();
3760 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3761 if ( $limit->{'limitId'} ) {
3768 =head2 CreateBranchTransferLimit
3770 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3772 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3774 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3778 sub CreateBranchTransferLimit {
3779 my ( $toBranch, $fromBranch, $code ) = @_;
3780 return unless defined($toBranch) && defined($fromBranch);
3781 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3783 my $dbh = C4::Context->dbh;
3785 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3786 return $sth->execute( $code, $toBranch, $fromBranch );
3789 =head2 DeleteBranchTransferLimits
3791 my $result = DeleteBranchTransferLimits($frombranch);
3793 Deletes all the library transfer limits for one library. Returns the
3794 number of limits deleted, 0e0 if no limits were deleted, or undef if
3795 no arguments are supplied.
3797 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3798 fromBranch => $fromBranch
3803 sub DeleteBranchTransferLimits {
3805 return unless defined $branch;
3806 my $dbh = C4::Context->dbh;
3807 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3808 return $sth->execute($branch);
3812 my ( $borrowernumber, $itemnum ) = @_;
3813 MarkIssueReturned( $borrowernumber, $itemnum );
3818 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3820 The final optional parameter, C<$params>, expected to contain
3821 'skip_record_index' key, which relayed down to Koha::Item/store,
3822 there it prevents calling of ModZebra index_records,
3823 which takes most of the time in batch adds/deletes: index_records better
3824 to be called later in C<additem.pl> after the whole loop.
3827 skip_record_index => 1|0
3832 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3834 unless ( $mark_lost_from ) {
3835 # Temporary check to avoid regressions
3836 die q|LostItem called without $mark_lost_from, check the API.|;
3840 if ( $force_mark_returned ) {
3843 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3844 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3847 my $dbh = C4::Context->dbh();
3848 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3850 JOIN items USING (itemnumber)
3851 JOIN biblio USING (biblionumber)
3852 WHERE issues.itemnumber=?");
3853 $sth->execute($itemnumber);
3854 my $issues=$sth->fetchrow_hashref();
3856 # If a borrower lost the item, add a replacement cost to the their record
3857 if ( my $borrowernumber = $issues->{borrowernumber} ){
3858 my $patron = Koha::Patrons->find( $borrowernumber );
3860 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3861 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3863 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3864 C4::Accounts::chargelostitem(
3867 $issues->{'replacementprice'},
3868 sprintf( "%s %s %s",
3869 $issues->{'title'} || q{},
3870 $issues->{'barcode'} || q{},
3871 $issues->{'itemcallnumber'} || q{},
3874 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3875 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3878 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3881 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3882 my $item = Koha::Items->find($itemnumber);
3883 my $transfers = $item->get_transfers;
3884 while (my $transfer = $transfers->next) {
3885 $transfer->cancel({ reason => 'ItemLost', force => 1 });
3889 sub GetOfflineOperations {
3890 my $dbh = C4::Context->dbh;
3891 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3892 $sth->execute(C4::Context->userenv->{'branch'});
3893 my $results = $sth->fetchall_arrayref({});
3897 sub GetOfflineOperation {
3898 my $operationid = shift;
3899 return unless $operationid;
3900 my $dbh = C4::Context->dbh;
3901 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3902 $sth->execute( $operationid );
3903 return $sth->fetchrow_hashref;
3906 sub AddOfflineOperation {
3907 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3908 my $dbh = C4::Context->dbh;
3909 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3910 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3914 sub DeleteOfflineOperation {
3915 my $dbh = C4::Context->dbh;
3916 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3917 $sth->execute( shift );
3921 sub ProcessOfflineOperation {
3922 my $operation = shift;
3925 if ( $operation->{action} eq 'return' ) {
3926 $report = ProcessOfflineReturn( $operation );
3927 } elsif ( $operation->{action} eq 'issue' ) {
3928 $report = ProcessOfflineIssue( $operation );
3929 } elsif ( $operation->{action} eq 'payment' ) {
3930 $report = ProcessOfflinePayment( $operation );
3933 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3938 sub ProcessOfflineReturn {
3939 my $operation = shift;
3941 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3944 my $itemnumber = $item->itemnumber;
3945 my $issue = GetOpenIssue( $itemnumber );
3947 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3948 ModDateLastSeen( $itemnumber, $leave_item_lost );
3950 $issue->{borrowernumber},
3952 $operation->{timestamp},
3955 $item->onloan(undef);
3956 $item->store({ log_action => 0 });
3959 return "Item not issued.";
3962 return "Item not found.";
3966 sub ProcessOfflineIssue {
3967 my $operation = shift;
3969 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3972 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3974 return "Barcode not found.";
3976 my $itemnumber = $item->itemnumber;
3977 my $issue = GetOpenIssue( $itemnumber );
3979 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3981 $issue->{borrowernumber},
3983 $operation->{timestamp},
3988 $operation->{'barcode'},
3991 $operation->{timestamp},
3996 return "Borrower not found.";
4000 sub ProcessOfflinePayment {
4001 my $operation = shift;
4003 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4005 $patron->account->pay(
4007 amount => $operation->{amount},
4008 library_id => $operation->{branchcode},
4018 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4020 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4025 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4029 ? Koha::Items->find($itemnumber)
4030 : Koha::Items->find( { barcode => $barcode } );
4034 return C4::Letters::GetPreparedLetter (
4035 module => 'circulation',
4036 letter_code => 'TRANSFERSLIP',
4037 branchcode => $branch,
4039 'branches' => $to_branch,
4040 'biblio' => $item->biblionumber,
4041 'items' => $item->unblessed,
4046 =head2 CheckIfIssuedToPatron
4048 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4050 Return 1 if any record item is issued to patron, otherwise return 0
4054 sub CheckIfIssuedToPatron {
4055 my ($borrowernumber, $biblionumber) = @_;
4057 my $dbh = C4::Context->dbh;
4059 SELECT COUNT(*) FROM issues
4060 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4061 WHERE items.biblionumber = ?
4062 AND issues.borrowernumber = ?
4064 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4065 return 1 if $is_issued;
4071 IsItemIssued( $itemnumber )
4073 Return 1 if the item is on loan, otherwise return 0
4078 my $itemnumber = shift;
4079 my $dbh = C4::Context->dbh;
4080 my $sth = $dbh->prepare(q{
4083 WHERE itemnumber = ?
4085 $sth->execute($itemnumber);
4086 return $sth->fetchrow;
4089 =head2 GetAgeRestriction
4091 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4092 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4094 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4095 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4097 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4098 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4099 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4100 Negative days mean the borrower has gone past the age restriction age.
4104 sub GetAgeRestriction {
4105 my ($record_restrictions, $borrower) = @_;
4106 my $markers = C4::Context->preference('AgeRestrictionMarker');
4108 return unless $record_restrictions;
4109 # Split $record_restrictions to something like FSK 16 or PEGI 6
4110 my @values = split ' ', uc($record_restrictions);
4111 return unless @values;
4113 # Search first occurrence of one of the markers
4114 my @markers = split /\|/, uc($markers);
4115 return unless @markers;
4118 my $restriction_year = 0;
4119 for my $value (@values) {
4121 for my $marker (@markers) {
4122 $marker =~ s/^\s+//; #remove leading spaces
4123 $marker =~ s/\s+$//; #remove trailing spaces
4124 if ( $marker eq $value ) {
4125 if ( $index <= $#values ) {
4126 $restriction_year += $values[$index];
4130 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4132 # Perhaps it is something like "K16" (as in Finland)
4133 $restriction_year += $1;
4137 last if ( $restriction_year > 0 );
4140 #Check if the borrower is age restricted for this material and for how long.
4141 if ($restriction_year && $borrower) {
4142 if ( $borrower->{'dateofbirth'} ) {
4143 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4144 $alloweddate[0] += $restriction_year;
4146 #Prevent runime eror on leap year (invalid date)
4147 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4148 $alloweddate[2] = 28;
4151 #Get how many days the borrower has to reach the age restriction
4152 my @Today = split /-/, dt_from_string()->ymd();
4153 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4154 #Negative days means the borrower went past the age restriction age
4155 return ($restriction_year, $daysToAgeRestriction);
4159 return ($restriction_year);
4163 =head2 GetPendingOnSiteCheckouts
4167 sub GetPendingOnSiteCheckouts {
4168 my $dbh = C4::Context->dbh;
4169 return $dbh->selectall_arrayref(q|
4175 items.itemcallnumber,
4179 issues.date_due < NOW() AS is_overdue,
4182 borrowers.firstname,
4184 borrowers.cardnumber,
4185 borrowers.borrowernumber
4187 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4188 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4189 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4190 WHERE issues.onsite_checkout = 1
4191 |, { Slice => {} } );
4197 my ($count, $branch, $itemtype, $ccode, $newness)
4198 = @$params{qw(count branch itemtype ccode newness)};
4200 my $dbh = C4::Context->dbh;
4203 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4204 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4205 i.ccode, SUM(i.issues) AS count
4207 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4208 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4211 my (@where_strs, @where_args);
4214 push @where_strs, 'i.homebranch = ?';
4215 push @where_args, $branch;
4218 if (C4::Context->preference('item-level_itypes')){
4219 push @where_strs, 'i.itype = ?';
4220 push @where_args, $itemtype;
4222 push @where_strs, 'bi.itemtype = ?';
4223 push @where_args, $itemtype;
4227 push @where_strs, 'i.ccode = ?';
4228 push @where_args, $ccode;
4231 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4232 push @where_args, $newness;
4236 $query .= 'WHERE ' . join(' AND ', @where_strs);
4240 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4241 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4246 $query .= q{ ) xxx WHERE count > 0 };
4247 $count = int($count);
4249 $query .= "LIMIT $count";
4252 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4257 =head2 Internal methods
4261 sub _CalculateAndUpdateFine {
4264 my $borrower = $params->{borrower};
4265 my $item = $params->{item};
4266 my $issue = $params->{issue};
4267 my $return_date = $params->{return_date};
4269 unless ($borrower) { carp "No borrower passed in!" && return; }
4270 unless ($item) { carp "No item passed in!" && return; }
4271 unless ($issue) { carp "No issue passed in!" && return; }
4273 my $datedue = dt_from_string( $issue->date_due );
4275 # we only need to calculate and change the fines if we want to do that on return
4276 # Should be on for hourly loans
4277 my $control = C4::Context->preference('CircControl');
4278 my $control_branchcode =
4279 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4280 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4281 : $issue->branchcode;
4283 my $date_returned = $return_date ? $return_date : dt_from_string();
4285 my ( $amount, $unitcounttotal, $unitcount ) =
4286 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4288 if ( C4::Context->preference('finesMode') eq 'production' ) {
4289 if ( $amount > 0 ) {
4290 C4::Overdues::UpdateFine({
4291 issue_id => $issue->issue_id,
4292 itemnumber => $issue->itemnumber,
4293 borrowernumber => $issue->borrowernumber,
4295 due => output_pref($datedue),
4298 elsif ($return_date) {
4300 # Backdated returns may have fines that shouldn't exist,
4301 # so in this case, we need to drop those fines to 0
4303 C4::Overdues::UpdateFine({
4304 issue_id => $issue->issue_id,
4305 itemnumber => $issue->itemnumber,
4306 borrowernumber => $issue->borrowernumber,
4308 due => output_pref($datedue),
4314 sub _item_denied_renewal {
4317 my $item = $params->{item};
4318 return unless $item;
4320 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4321 return unless $denyingrules;
4322 foreach my $field (keys %$denyingrules) {
4323 my $val = $item->$field;
4324 if( !defined $val) {
4325 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4328 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4329 # If the results matches the values in the syspref
4330 # We return true if match found
4343 Koha Development Team <http://koha-community.org/>