1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX qw( floor );
35 use C4::ItemCirculationAlertPreference;
38 use C4::Log; # logaction
39 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
40 use C4::RotatingCollections qw(GetCollectionItemBranches);
41 use Algorithm::CheckDigits;
45 use Koha::AuthorisedValues;
46 use Koha::Biblioitems;
50 use Koha::Illrequests;
53 use Koha::Patron::Debarments;
56 use Koha::Account::Lines;
58 use Koha::Account::Lines;
59 use Koha::Account::Offsets;
60 use Koha::Config::SysPrefs;
61 use Koha::Charges::Fees;
62 use Koha::Config::SysPref;
63 use Koha::Checkouts::ReturnClaims;
64 use Koha::SearchEngine::Indexer;
65 use Koha::Exceptions::Checkout;
67 use List::MoreUtils qw( uniq any );
68 use Scalar::Util qw( looks_like_number );
79 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
85 # FIXME subs that should probably be elsewhere
90 &GetPendingOnSiteCheckouts
93 # subs to deal with issuing a book
101 &GetLatestAutoRenewDate
103 &GetBranchBorrowerCircRule
106 &CheckIfIssuedToPatron
111 # subs to deal with returns
117 # subs to deal with transfers
124 &IsBranchTransferAllowed
125 &CreateBranchTransferLimit
126 &DeleteBranchTransferLimits
130 # subs to deal with offline circulation
132 &GetOfflineOperations
135 &DeleteOfflineOperation
136 &ProcessOfflineOperation
142 C4::Circulation - Koha circulation module
150 The functions in this module deal with circulation, issues, and
151 returns, as well as general information about the library.
152 Also deals with inventory.
158 $str = &barcodedecode($barcode, [$filter]);
160 Generic filter function for barcode string.
161 Called on every circ if the System Pref itemBarcodeInputFilter is set.
162 Will do some manipulation of the barcode for systems that deliver a barcode
163 to circulation.pl that differs from the barcode stored for the item.
164 For proper functioning of this filter, calling the function on the
165 correct barcode string (items.barcode) should return an unaltered barcode.
167 The optional $filter argument is to allow for testing or explicit
168 behavior that ignores the System Pref. Valid values are the same as the
173 # FIXME -- the &decode fcn below should be wrapped into this one.
174 # FIXME -- these plugins should be moved out of Circulation.pm
177 my ($barcode, $filter) = @_;
178 my $branch = C4::Context::mybranch();
179 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
180 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
181 if ($filter eq 'whitespace') {
183 } elsif ($filter eq 'cuecat') {
185 my @fields = split( /\./, $barcode );
186 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
187 ($#results == 2) and return $results[2];
188 } elsif ($filter eq 'T-prefix') {
189 if ($barcode =~ /^[Tt](\d)/) {
190 (defined($1) and $1 eq '0') and return $barcode;
191 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
193 return sprintf("T%07d", $barcode);
194 # FIXME: $barcode could be "T1", causing warning: substr outside of string
195 # Why drop the nonzero digit after the T?
196 # Why pass non-digits (or empty string) to "T%07d"?
197 } elsif ($filter eq 'libsuite8') {
198 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
199 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
200 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
202 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
205 } elsif ($filter eq 'EAN13') {
206 my $ean = CheckDigits('ean');
207 if ( $ean->is_valid($barcode) ) {
208 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
209 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
211 warn "# [$barcode] not valid EAN-13/UPC-A\n";
214 return $barcode; # return barcode, modified or not
219 $str = &_decode($chunk);
221 Decodes a segment of a string emitted by a CueCat barcode scanner and
224 FIXME: Should be replaced with Barcode::Cuecat from CPAN
225 or Javascript based decoding on the client side.
232 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
233 my @s = map { index( $seq, $_ ); } split( //, $encoded );
234 my $l = ( $#s + 1 ) % 4;
237 # warn "Error: Cuecat decode parsing failed!";
245 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
247 chr( ( $n >> 16 ) ^ 67 )
248 .chr( ( $n >> 8 & 255 ) ^ 67 )
249 .chr( ( $n & 255 ) ^ 67 );
252 $r = substr( $r, 0, length($r) - $l );
258 ($dotransfer, $messages, $iteminformation) = &transferbook({
259 from_branch => $frombranch
260 to_branch => $tobranch,
262 ignore_reserves => $ignore_reserves,
266 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
268 C<$fbr> is the code for the branch initiating the transfer.
269 C<$tbr> is the code for the branch to which the item should be transferred.
271 C<$barcode> is the barcode of the item to be transferred.
273 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
274 Otherwise, if an item is reserved, the transfer fails.
276 C<$trigger> is the enum value for what triggered the transfer.
278 Returns three values:
284 is true if the transfer was successful.
288 is a reference-to-hash which may have any of the following keys:
294 There is no item in the catalog with the given barcode. The value is C<$barcode>.
296 =item C<DestinationEqualsHolding>
298 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.
302 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.
306 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>.
308 =item C<WasTransferred>
310 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
320 my $tbr = $params->{to_branch};
321 my $fbr = $params->{from_branch};
322 my $ignoreRs = $params->{ignore_reserves};
323 my $barcode = $params->{barcode};
324 my $trigger = $params->{trigger};
327 my $item = Koha::Items->find( { barcode => $barcode } );
329 Koha::Exceptions::MissingParameter->throw(
330 "Missing mandatory parameter: from_branch")
333 Koha::Exceptions::MissingParameter->throw(
334 "Missing mandatory parameter: to_branch")
339 $messages->{'BadBarcode'} = $barcode;
341 return ( $dotransfer, $messages );
344 my $itemnumber = $item->itemnumber;
345 # get branches of book...
346 my $hbr = $item->homebranch;
348 # if using Branch Transfer Limits
349 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
350 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
351 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
352 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
353 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
356 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
357 $messages->{'NotAllowed'} = $tbr . "::" . $code;
362 # can't transfer book if is already there....
363 if ( $fbr eq $tbr ) {
364 $messages->{'DestinationEqualsHolding'} = 1;
368 # check if it is still issued to someone, return it...
369 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
371 AddReturn( $barcode, $fbr );
372 $messages->{'WasReturned'} = $issue->borrowernumber;
376 # That'll save a database query.
377 my ( $resfound, $resrec, undef ) =
378 CheckReserves( $itemnumber );
379 if ( $resfound and not $ignoreRs ) {
380 $resrec->{'ResFound'} = $resfound;
381 $messages->{'ResFound'} = $resrec;
385 #actually do the transfer....
387 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
389 # don't need to update MARC anymore, we do it in batch now
390 $messages->{'WasTransfered'} = $tbr;
393 ModDateLastSeen( $itemnumber );
394 return ( $dotransfer, $messages );
399 my $borrower = shift;
400 my $item_object = shift;
402 my $onsite_checkout = $params->{onsite_checkout} || 0;
403 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
404 my $cat_borrower = $borrower->{'categorycode'};
405 my $dbh = C4::Context->dbh;
406 # Get which branchcode we need
407 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
408 my $type = $item_object->effective_itemtype;
410 my ($type_object, $parent_type, $parent_maxissueqty_rule);
411 $type_object = Koha::ItemTypes->find( $type );
412 $parent_type = $type_object->parent_type if $type_object;
413 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
414 # Find any children if we are a parent_type;
416 # given branch, patron category, and item type, determine
417 # applicable issuing rule
419 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
421 categorycode => $cat_borrower,
422 itemtype => $parent_type,
423 branchcode => $branch,
424 rule_name => 'maxissueqty',
427 # If the parent rule is for default type we discount it
428 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
430 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
432 categorycode => $cat_borrower,
434 branchcode => $branch,
435 rule_name => 'maxissueqty',
439 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
441 categorycode => $cat_borrower,
443 branchcode => $branch,
444 rule_name => 'maxonsiteissueqty',
449 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
450 # if a rule is found and has a loan limit set, count
451 # how many loans the patron already has that meet that
453 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
456 if ( $maxissueqty_rule->branchcode ) {
457 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
458 $checkouts = $patron->checkouts->search(
459 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
460 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
461 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
463 $checkouts = $patron->checkouts->search(
464 { 'item.homebranch' => $maxissueqty_rule->branchcode },
465 { prefetch => 'item' } );
468 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
471 my $rule_itemtype = $maxissueqty_rule->itemtype;
472 while ( my $c = $checkouts->next ) {
473 my $itemtype = $c->item->effective_itemtype;
475 unless ( $rule_itemtype ) {
476 # matching rule has the default item type, so count only
477 # those existing loans that don't fall under a more
479 @types = Koha::CirculationRules->search(
481 branchcode => $maxissueqty_rule->branchcode,
482 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
483 itemtype => { '!=' => undef },
484 rule_name => 'maxissueqty'
486 )->get_column('itemtype');
488 next if grep {$_ eq $itemtype} @types;
491 if ( $parent_maxissueqty_rule ) {
492 # if we have a parent item type then we count loans of the
493 # specific item type or its siblings or parent
494 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
495 @types = $children->get_column('itemtype');
496 push @types, $parent_type;
497 } elsif ( $child_types ) {
498 # If we are a parent type, we need to count all child types and our own type
499 @types = $child_types->get_column('itemtype');
500 push @types, $type; # And don't forget to count our own types
501 } else { push @types, $type; } # Otherwise only count the specific itemtype
503 next unless grep {$_ eq $itemtype} @types;
505 $sum_checkouts->{total}++;
506 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
507 $sum_checkouts->{itemtype}->{$itemtype}++;
510 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
511 my $checkout_count = $sum_checkouts->{total} || 0;
512 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
514 my $checkout_rules = {
515 checkout_count => $checkout_count,
516 onsite_checkout_count => $onsite_checkout_count,
517 onsite_checkout => $onsite_checkout,
518 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
519 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
520 switch_onsite_checkout => $switch_onsite_checkout,
522 # If parent rules exists
523 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
524 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
525 my $qty_over = _check_max_qty($checkout_rules);
526 return $qty_over if defined $qty_over;
528 # If the parent rule is less than or equal to the child, we only need check the parent
529 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
530 $checkout_rules->{checkout_count} = $checkout_count_type;
531 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
532 my $qty_over = _check_max_qty($checkout_rules);
533 return $qty_over if defined $qty_over;
536 my $qty_over = _check_max_qty($checkout_rules);
537 return $qty_over if defined $qty_over;
541 # Now count total loans against the limit for the branch
542 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
543 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
545 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
546 $checkouts = $patron->checkouts->search(
547 { 'me.branchcode' => $branch} );
548 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
549 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
551 $checkouts = $patron->checkouts->search(
552 { 'item.homebranch' => $branch},
553 { prefetch => 'item' } );
556 my $checkout_count = $checkouts->count;
557 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
558 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
559 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
561 my $qty_over = _check_max_qty(
563 checkout_count => $checkout_count,
564 onsite_checkout_count => $onsite_checkout_count,
565 onsite_checkout => $onsite_checkout,
566 max_checkouts_allowed => $max_checkouts_allowed,
567 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
568 switch_onsite_checkout => $switch_onsite_checkout
571 return $qty_over if defined $qty_over;
574 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
575 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
578 # OK, the patron can issue !!!
584 my $checkout_count = $params->{checkout_count};
585 my $onsite_checkout_count = $params->{onsite_checkout_count};
586 my $onsite_checkout = $params->{onsite_checkout};
587 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
588 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
589 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
591 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
592 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
593 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
595 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
596 count => $onsite_checkout_count,
597 max_allowed => $max_onsite_checkouts_allowed,
601 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
602 if ( $max_checkouts_allowed eq '' ) { return; }
603 my $delta = $switch_onsite_checkout ? 1 : 0;
604 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
606 reason => 'TOO_MANY_CHECKOUTS',
607 count => $checkout_count,
608 max_allowed => $max_checkouts_allowed,
612 elsif ( not $onsite_checkout ) {
613 if ( $max_checkouts_allowed eq '' ) { return; }
615 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
618 reason => 'TOO_MANY_CHECKOUTS',
619 count => $checkout_count - $onsite_checkout_count,
620 max_allowed => $max_checkouts_allowed,
628 =head2 CanBookBeIssued
630 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
631 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
633 Check if a book can be issued.
635 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
637 IMPORTANT: The assumption by users of this routine is that causes blocking
638 the issue are keyed by uppercase labels and other returned
639 data is keyed in lower case!
643 =item C<$patron> is a Koha::Patron
645 =item C<$barcode> is the bar code of the book being issued.
647 =item C<$duedates> is a DateTime object.
649 =item C<$inprocess> boolean switch
651 =item C<$ignore_reserves> boolean switch
653 =item C<$params> Hashref of additional parameters
656 override_high_holds - Ignore high holds
657 onsite_checkout - Checkout is an onsite checkout that will not leave the library
665 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
666 Possible values are :
672 sticky due date is invalid
676 borrower gone with no address
680 borrower declared it's card lost
686 =head3 UNKNOWN_BARCODE
700 item is restricted (set by ??)
702 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
703 could be prevented, but ones that can be overriden by the operator.
705 Possible values are :
713 renewing, not issuing
715 =head3 ISSUED_TO_ANOTHER
717 issued to someone else.
721 reserved for someone else.
725 reserved and being transferred for someone else.
729 sticky due date is invalid or due date in the past
733 if the borrower borrows to much things
737 sub CanBookBeIssued {
738 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
739 my %needsconfirmation; # filled with problems that needs confirmations
740 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
741 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
742 my %messages; # filled with information messages that should be displayed.
744 my $onsite_checkout = $params->{onsite_checkout} || 0;
745 my $override_high_holds = $params->{override_high_holds} || 0;
747 my $item_object = Koha::Items->find({barcode => $barcode });
749 # MANDATORY CHECKS - unless item exists, nothing else matters
750 unless ( $item_object ) {
751 $issuingimpossible{UNKNOWN_BARCODE} = 1;
753 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
755 my $item_unblessed = $item_object->unblessed; # Transition...
756 my $issue = $item_object->checkout;
757 my $biblio = $item_object->biblio;
759 my $biblioitem = $biblio->biblioitem;
760 my $effective_itemtype = $item_object->effective_itemtype;
761 my $dbh = C4::Context->dbh;
762 my $patron_unblessed = $patron->unblessed;
764 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
766 # DUE DATE is OK ? -- should already have checked.
768 if ($duedate && ref $duedate ne 'DateTime') {
769 $duedate = dt_from_string($duedate);
771 my $now = dt_from_string();
772 unless ( $duedate ) {
773 my $issuedate = $now->clone();
775 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
777 # Offline circ calls AddIssue directly, doesn't run through here
778 # So issuingimpossible should be ok.
781 my $fees = Koha::Charges::Fees->new(
784 library => $circ_library,
785 item => $item_object,
791 my $today = $now->clone();
792 $today->truncate( to => 'minute');
793 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
794 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
797 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
803 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
804 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
806 branch => C4::Context->userenv->{'branch'},
808 itemnumber => $item_object->itemnumber,
809 itemtype => $effective_itemtype,
810 borrowernumber => $patron->borrowernumber,
811 ccode => $item_object->ccode}
813 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
814 return( { STATS => 1 }, {});
817 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
818 $issuingimpossible{GNA} = 1;
821 if ( $patron->lost && $patron->lost == 1 ) {
822 $issuingimpossible{CARD_LOST} = 1;
824 if ( $patron->is_debarred ) {
825 $issuingimpossible{DEBARRED} = 1;
828 if ( $patron->is_expired ) {
829 $issuingimpossible{EXPIRED} = 1;
837 my $account = $patron->account;
838 my $balance = $account->balance;
839 my $non_issues_charges = $account->non_issues_charges;
840 my $other_charges = $balance - $non_issues_charges;
842 my $amountlimit = C4::Context->preference("noissuescharge");
843 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
844 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
846 # Check the debt of this patrons guarantees
847 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
848 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
849 if ( defined $no_issues_charge_guarantees ) {
850 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
851 my $guarantees_non_issues_charges = 0;
852 foreach my $g ( @guarantees ) {
853 $guarantees_non_issues_charges += $g->account->non_issues_charges;
856 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
857 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
858 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
859 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
860 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
861 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
865 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
866 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
867 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
868 if ( defined $no_issues_charge_guarantors ) {
869 my $guarantors_non_issues_charges += $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
871 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
872 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
873 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
874 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
875 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
876 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
880 if ( C4::Context->preference("IssuingInProcess") ) {
881 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
882 $issuingimpossible{DEBT} = $non_issues_charges;
883 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
884 $needsconfirmation{DEBT} = $non_issues_charges;
885 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
886 $needsconfirmation{DEBT} = $non_issues_charges;
890 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
891 $needsconfirmation{DEBT} = $non_issues_charges;
892 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
893 $issuingimpossible{DEBT} = $non_issues_charges;
894 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
895 $needsconfirmation{DEBT} = $non_issues_charges;
899 if ($balance > 0 && $other_charges > 0) {
900 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
903 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
904 $patron_unblessed = $patron->unblessed;
906 if ( my $debarred_date = $patron->is_debarred ) {
907 # patron has accrued fine days or has a restriction. $count is a date
908 if ($debarred_date eq '9999-12-31') {
909 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
912 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
914 } elsif ( my $num_overdues = $patron->has_overdues ) {
915 ## patron has outstanding overdue loans
916 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
917 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
919 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
920 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
924 # Additional Materials Check
925 if ( C4::Context->preference("CircConfirmItemParts")
926 && $item_object->materials )
928 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
932 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
934 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
936 # Already issued to current borrower.
937 # If it is an on-site checkout if it can be switched to a normal checkout
938 # or ask whether the loan should be renewed
940 if ( $issue->onsite_checkout
941 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
942 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
944 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
945 $patron->borrowernumber,
946 $item_object->itemnumber,
948 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
949 if ( $renewerror eq 'onsite_checkout' ) {
950 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
953 $issuingimpossible{NO_MORE_RENEWALS} = 1;
957 $needsconfirmation{RENEW_ISSUE} = 1;
963 # issued to someone else
965 my $patron = Koha::Patrons->find( $issue->borrowernumber );
967 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
969 unless ( $can_be_returned ) {
970 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
971 $issuingimpossible{branch_to_return} = $message;
973 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
974 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
976 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
977 $needsconfirmation{issued_firstname} = $patron->firstname;
978 $needsconfirmation{issued_surname} = $patron->surname;
979 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
980 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
985 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
987 my $switch_onsite_checkout = (
988 C4::Context->preference('SwitchOnSiteCheckouts')
990 and $issue->onsite_checkout
991 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
992 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
993 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
994 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
995 if ( $toomany->{max_allowed} == 0 ) {
996 $needsconfirmation{PATRON_CANT} = 1;
998 if ( C4::Context->preference("AllowTooManyOverride") ) {
999 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1000 $needsconfirmation{current_loan_count} = $toomany->{count};
1001 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1003 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1004 $issuingimpossible{current_loan_count} = $toomany->{count};
1005 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1010 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1012 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1013 my $wants_check = $patron->wants_check_for_previous_checkout;
1014 $needsconfirmation{PREVISSUE} = 1
1015 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1020 if ( $item_object->notforloan )
1022 if(!C4::Context->preference("AllowNotForLoanOverride")){
1023 $issuingimpossible{NOT_FOR_LOAN} = 1;
1024 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1026 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1027 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1031 # we have to check itemtypes.notforloan also
1032 if (C4::Context->preference('item-level_itypes')){
1033 # this should probably be a subroutine
1034 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1035 $sth->execute($effective_itemtype);
1036 my $notforloan=$sth->fetchrow_hashref();
1037 if ($notforloan->{'notforloan'}) {
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 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1049 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1050 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1051 $issuingimpossible{NOT_FOR_LOAN} = 1;
1052 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1054 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1055 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1060 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1062 $issuingimpossible{WTHDRAWN} = 1;
1064 if ( $item_object->restricted
1065 && $item_object->restricted == 1 )
1067 $issuingimpossible{RESTRICTED} = 1;
1069 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1070 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1071 my $code = $av->count ? $av->next->lib : '';
1072 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1073 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1075 if ( C4::Context->preference("IndependentBranches") ) {
1076 my $userenv = C4::Context->userenv;
1077 unless ( C4::Context->IsSuperLibrarian() ) {
1078 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1079 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1080 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1081 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1083 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1084 if ( $patron->branchcode ne $userenv->{branch} );
1089 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1091 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1092 if ($rentalConfirmation) {
1093 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1095 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1096 if ($itemtype_object) {
1097 my $accumulate_charge = $fees->accumulate_rentalcharge();
1098 if ( $accumulate_charge > 0 ) {
1099 $rentalCharge += $accumulate_charge;
1103 if ( $rentalCharge > 0 ) {
1104 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1108 unless ( $ignore_reserves ) {
1109 # See if the item is on reserve.
1110 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1112 my $resbor = $res->{'borrowernumber'};
1113 if ( $resbor ne $patron->borrowernumber ) {
1114 my $patron = Koha::Patrons->find( $resbor );
1115 if ( $restype eq "Waiting" )
1117 # The item is on reserve and waiting, but has been
1118 # reserved by some other patron.
1119 $needsconfirmation{RESERVE_WAITING} = 1;
1120 $needsconfirmation{'resfirstname'} = $patron->firstname;
1121 $needsconfirmation{'ressurname'} = $patron->surname;
1122 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1123 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1124 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1125 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1126 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1128 elsif ( $restype eq "Reserved" ) {
1129 # The item is on reserve for someone else.
1130 $needsconfirmation{RESERVED} = 1;
1131 $needsconfirmation{'resfirstname'} = $patron->firstname;
1132 $needsconfirmation{'ressurname'} = $patron->surname;
1133 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1134 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1135 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1136 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1137 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1139 elsif ( $restype eq "Transferred" ) {
1140 # The item is determined hold being transferred for someone else.
1141 $needsconfirmation{TRANSFERRED} = 1;
1142 $needsconfirmation{'resfirstname'} = $patron->firstname;
1143 $needsconfirmation{'ressurname'} = $patron->surname;
1144 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1145 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1146 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1147 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1148 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1150 elsif ( $restype eq "Processing" ) {
1151 # The item is determined hold being processed for someone else.
1152 $needsconfirmation{PROCESSING} = 1;
1153 $needsconfirmation{'resfirstname'} = $patron->firstname;
1154 $needsconfirmation{'ressurname'} = $patron->surname;
1155 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1156 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1157 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1158 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1159 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1165 ## CHECK AGE RESTRICTION
1166 my $agerestriction = $biblioitem->agerestriction;
1167 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1168 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1169 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1170 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1173 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1177 ## check for high holds decreasing loan period
1178 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1179 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1181 if ( $check->{exceeded} ) {
1182 if ($override_high_holds) {
1183 $alerts{HIGHHOLDS} = {
1184 num_holds => $check->{outstanding},
1185 duration => $check->{duration},
1186 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1190 $needsconfirmation{HIGHHOLDS} = {
1191 num_holds => $check->{outstanding},
1192 duration => $check->{duration},
1193 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1200 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1201 # don't do the multiple loans per bib check if we've
1202 # already determined that we've got a loan on the same item
1203 !$issuingimpossible{NO_MORE_RENEWALS} &&
1204 !$needsconfirmation{RENEW_ISSUE}
1206 # Check if borrower has already issued an item from the same biblio
1207 # Only if it's not a subscription
1208 my $biblionumber = $item_object->biblionumber;
1209 require C4::Serials;
1210 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1211 unless ($is_a_subscription) {
1212 # FIXME Should be $patron->checkouts($args);
1213 my $checkouts = Koha::Checkouts->search(
1215 borrowernumber => $patron->borrowernumber,
1216 biblionumber => $biblionumber,
1222 # if we get here, we don't already have a loan on this item,
1223 # so if there are any loans on this bib, ask for confirmation
1224 if ( $checkouts->count ) {
1225 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1230 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1233 =head2 CanBookBeReturned
1235 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1237 Check whether the item can be returned to the provided branch
1241 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1243 =item C<$branch> is the branchcode where the return is taking place
1251 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1253 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1259 sub CanBookBeReturned {
1260 my ($item, $branch) = @_;
1261 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1263 # assume return is allowed to start
1267 # identify all cases where return is forbidden
1268 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1270 $message = $item->{'homebranch'};
1271 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1273 $message = $item->{'holdingbranch'};
1274 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1276 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1279 return ($allowed, $message);
1282 =head2 CheckHighHolds
1284 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1285 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1286 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1290 sub checkHighHolds {
1291 my ( $item, $borrower ) = @_;
1292 my $branchcode = _GetCircControlBranch( $item, $borrower );
1293 my $item_object = Koha::Items->find( $item->{itemnumber} );
1302 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1304 if ( $holds->count() ) {
1305 $return_data->{outstanding} = $holds->count();
1307 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1308 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1309 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1311 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1313 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1315 # static means just more than a given number of holds on the record
1317 # If the number of holds is less than the threshold, we can stop here
1318 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1319 return $return_data;
1322 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1324 # dynamic means X more than the number of holdable items on the record
1326 # let's get the items
1327 my @items = $holds->next()->biblio()->items()->as_list;
1329 # Remove any items with status defined to be ignored even if the would not make item unholdable
1330 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1331 @items = grep { !$_->$status } @items;
1334 # Remove any items that are not holdable for this patron
1335 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1337 my $items_count = scalar @items;
1339 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1341 # If the number of holds is less than the count of items we have
1342 # plus the number of holds allowed above that count, we can stop here
1343 if ( $holds->count() <= $threshold ) {
1344 return $return_data;
1348 my $issuedate = dt_from_string();
1350 my $itype = $item_object->effective_itemtype;
1351 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1353 categorycode => $borrower->{categorycode},
1355 branchcode => $branchcode,
1358 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1360 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1362 my $rule = Koha::CirculationRules->get_effective_rule(
1364 categorycode => $borrower->{categorycode},
1365 itemtype => $item_object->effective_itemtype,
1366 branchcode => $branchcode,
1367 rule_name => 'decreaseloanholds',
1372 if ( defined($rule) && $rule->rule_value ne '' ){
1373 # overrides decreaseLoanHighHoldsDuration syspref
1374 $duration = $rule->rule_value;
1376 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1378 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1379 $reduced_datedue->set_hour($orig_due->hour);
1380 $reduced_datedue->set_minute($orig_due->minute);
1381 $reduced_datedue->truncate( to => 'minute' );
1383 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1384 $return_data->{exceeded} = 1;
1385 $return_data->{duration} = $duration;
1386 $return_data->{due_date} = $reduced_datedue;
1390 return $return_data;
1395 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1397 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1401 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1403 =item C<$barcode> is the barcode of the item being issued.
1405 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1406 Calculated if empty.
1408 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1410 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1411 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1413 AddIssue does the following things :
1415 - step 01: check that there is a borrowernumber & a barcode provided
1416 - check for RENEWAL (book issued & being issued to the same patron)
1417 - renewal YES = Calculate Charge & renew
1419 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1421 - fill reserve if reserve to this patron
1422 - cancel reserve or not, otherwise
1423 * TRANSFERT PENDING ?
1424 - complete the transfert
1432 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1434 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1435 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1436 my $auto_renew = $params && $params->{auto_renew};
1437 my $dbh = C4::Context->dbh;
1438 my $barcodecheck = CheckValidBarcode($barcode);
1442 if ( $datedue && ref $datedue ne 'DateTime' ) {
1443 $datedue = dt_from_string($datedue);
1446 # $issuedate defaults to today.
1447 if ( !defined $issuedate ) {
1448 $issuedate = dt_from_string();
1451 if ( ref $issuedate ne 'DateTime' ) {
1452 $issuedate = dt_from_string($issuedate);
1457 # Stop here if the patron or barcode doesn't exist
1458 if ( $borrower && $barcode && $barcodecheck ) {
1459 # find which item we issue
1460 my $item_object = Koha::Items->find({ barcode => $barcode })
1461 or return; # if we don't get an Item, abort.
1462 my $item_unblessed = $item_object->unblessed;
1464 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1466 # get actual issuing if there is one
1467 my $actualissue = $item_object->checkout;
1469 # check if we just renew the issue.
1470 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1471 and not $switch_onsite_checkout ) {
1472 $datedue = AddRenewal(
1473 $borrower->{'borrowernumber'},
1474 $item_object->itemnumber,
1477 $issuedate, # here interpreted as the renewal date
1482 my $itype = $item_object->effective_itemtype;
1483 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1486 $datedue->truncate( to => 'minute' );
1488 my $patron = Koha::Patrons->find( $borrower );
1489 my $library = Koha::Libraries->find( $branchcode );
1490 my $fees = Koha::Charges::Fees->new(
1493 library => $library,
1494 item => $item_object,
1495 to_date => $datedue,
1499 # it's NOT a renewal
1500 if ( $actualissue and not $switch_onsite_checkout ) {
1501 # This book is currently on loan, but not to the person
1502 # who wants to borrow it now. mark it returned before issuing to the new borrower
1503 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1504 return unless $allowed;
1505 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1506 # AddReturn certainly has side-effects, like onloan => undef
1507 $item_object->discard_changes;
1510 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1512 # Starting process for transfer job (checking transfert and validate it if we have one)
1513 if ( my $transfer = $item_object->get_transfer ) {
1514 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1517 datearrived => dt_from_string,
1518 tobranch => C4::Context->userenv->{branch},
1519 comments => 'Forced branchtransfer'
1522 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1523 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1524 if ( $hold ) { # Is this really needed?
1525 $hold->set( { found => undef } )->store;
1526 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1531 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1532 unless ($auto_renew) {
1533 my $rule = Koha::CirculationRules->get_effective_rule(
1535 categorycode => $borrower->{categorycode},
1536 itemtype => $item_object->effective_itemtype,
1537 branchcode => $branchcode,
1538 rule_name => 'auto_renew'
1542 $auto_renew = $rule->rule_value if $rule;
1545 my $issue_attributes = {
1546 borrowernumber => $borrower->{'borrowernumber'},
1547 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1548 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1549 branchcode => C4::Context->userenv->{'branch'},
1550 onsite_checkout => $onsite_checkout,
1551 auto_renew => $auto_renew ? 1 : 0,
1554 # Get ID of logged in user. if called from a batch job,
1555 # no user session exists and C4::Context->userenv() returns
1556 # the scalar '0'. Only do this if the syspref says so
1557 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1558 my $userenv = C4::Context->userenv();
1559 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1561 $issue_attributes->{issuer_id} = $usernumber;
1565 # In the case that the borrower has an on-site checkout
1566 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1567 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1569 $issue->set($issue_attributes)->store;
1572 $issue = Koha::Checkout->new(
1574 itemnumber => $item_object->itemnumber,
1579 $issue->discard_changes;
1580 if ( $item_object->location && $item_object->location eq 'CART'
1581 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1582 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1583 CartToShelf( $item_object->itemnumber );
1586 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1587 UpdateTotalIssues( $item_object->biblionumber, 1 );
1590 # Record if item was lost
1591 my $was_lost = $item_object->itemlost;
1593 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1594 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1595 $item_object->itemlost(0);
1596 $item_object->onloan($datedue->ymd());
1597 $item_object->datelastborrowed( dt_from_string()->ymd() );
1598 $item_object->datelastseen( dt_from_string()->ymd() );
1599 $item_object->store({log_action => 0});
1601 # If the item was lost, it has now been found, charge the overdue if necessary
1603 if ( $item_object->{_charge} ) {
1604 $actualissue //= Koha::Old::Checkouts->search(
1605 { itemnumber => $item_unblessed->{itemnumber} },
1607 order_by => { '-desc' => 'returndate' },
1611 unless ( exists( $borrower->{branchcode} ) ) {
1612 my $patron = $actualissue->patron;
1613 $borrower = $patron->unblessed;
1615 _CalculateAndUpdateFine(
1617 issue => $actualissue,
1618 item => $item_unblessed,
1619 borrower => $borrower,
1620 return_date => $issuedate
1623 _FixOverduesOnReturn( $borrower->{borrowernumber},
1624 $item_object->itemnumber, undef, 'RENEWED' );
1628 # If it costs to borrow this book, charge it to the patron's account.
1629 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1630 if ( $charge && $charge > 0 ) {
1631 AddIssuingCharge( $issue, $charge, 'RENT' );
1634 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1635 if ( $itemtype_object ) {
1636 my $accumulate_charge = $fees->accumulate_rentalcharge();
1637 if ( $accumulate_charge > 0 ) {
1638 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1639 $charge += $accumulate_charge;
1640 $item_unblessed->{charge} = $charge;
1644 # Record the fact that this book was issued.
1647 branch => C4::Context->userenv->{'branch'},
1648 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1650 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1651 itemnumber => $item_object->itemnumber,
1652 itemtype => $item_object->effective_itemtype,
1653 location => $item_object->location,
1654 borrowernumber => $borrower->{'borrowernumber'},
1655 ccode => $item_object->ccode,
1659 # Send a checkout slip.
1660 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1662 branchcode => $branchcode,
1663 categorycode => $borrower->{categorycode},
1664 item_type => $item_object->effective_itemtype,
1665 notification => 'CHECKOUT',
1667 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1668 SendCirculationAlert(
1671 item => $item_object->unblessed,
1672 borrower => $borrower,
1673 branch => $branchcode,
1678 "CIRCULATION", "ISSUE",
1679 $borrower->{'borrowernumber'},
1680 $item_object->itemnumber,
1681 ) if C4::Context->preference("IssueLog");
1683 Koha::Plugins->call('after_circ_action', {
1684 action => 'checkout',
1686 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1687 checkout => $issue->get_from_storage
1695 =head2 GetLoanLength
1697 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1699 Get loan length for an itemtype, a borrower type and a branch
1704 my ( $categorycode, $itemtype, $branchcode ) = @_;
1706 # Initialize default values
1710 lengthunit => 'days',
1713 my $found = Koha::CirculationRules->get_effective_rules( {
1714 branchcode => $branchcode,
1715 categorycode => $categorycode,
1716 itemtype => $itemtype,
1725 foreach my $rule_name (keys %$found) {
1726 $rules->{$rule_name} = $found->{$rule_name};
1733 =head2 GetHardDueDate
1735 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1737 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1741 sub GetHardDueDate {
1742 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1744 my $rules = Koha::CirculationRules->get_effective_rules(
1746 categorycode => $borrowertype,
1747 itemtype => $itemtype,
1748 branchcode => $branchcode,
1749 rules => [ 'hardduedate', 'hardduedatecompare' ],
1753 if ( defined( $rules->{hardduedate} ) ) {
1754 if ( $rules->{hardduedate} ) {
1755 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1758 return ( undef, undef );
1763 =head2 GetBranchBorrowerCircRule
1765 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1767 Retrieves circulation rule attributes that apply to the given
1768 branch and patron category, regardless of item type.
1769 The return value is a hashref containing the following key:
1771 patron_maxissueqty - maximum number of loans that a
1772 patron of the given category can have at the given
1773 branch. If the value is undef, no limit.
1775 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1776 patron of the given category can have at the given
1777 branch. If the value is undef, no limit.
1779 This will check for different branch/category combinations in the following order:
1783 default branch and category
1785 If no rule has been found in the database, it will default to
1788 patron_maxissueqty - undef
1789 patron_maxonsiteissueqty - undef
1791 C<$branchcode> and C<$categorycode> should contain the
1792 literal branch code and patron category code, respectively - no
1797 sub GetBranchBorrowerCircRule {
1798 my ( $branchcode, $categorycode ) = @_;
1800 # Initialize default values
1802 patron_maxissueqty => undef,
1803 patron_maxonsiteissueqty => undef,
1807 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1808 my $rule = Koha::CirculationRules->get_effective_rule(
1810 categorycode => $categorycode,
1812 branchcode => $branchcode,
1813 rule_name => $rule_name,
1817 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1823 =head2 GetBranchItemRule
1825 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1827 Retrieves circulation rule attributes that apply to the given
1828 branch and item type, regardless of patron category.
1830 The return value is a hashref containing the following keys:
1832 holdallowed => Hold policy for this branch and itemtype. Possible values:
1833 not_allowed: No holds allowed.
1834 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1835 from_any_library: Holds allowed from any patron.
1836 from_local_hold_group: Holds allowed from libraries in hold group
1838 returnbranch => branch to which to return item. Possible values:
1839 noreturn: do not return, let item remain where checked in (floating collections)
1840 homebranch: return to item's home branch
1841 holdingbranch: return to issuer branch
1843 This searches branchitemrules in the following order:
1845 * Same branchcode and itemtype
1846 * Same branchcode, itemtype '*'
1847 * branchcode '*', same itemtype
1848 * branchcode and itemtype '*'
1850 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1854 sub GetBranchItemRule {
1855 my ( $branchcode, $itemtype ) = @_;
1858 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1860 branchcode => $branchcode,
1861 itemtype => $itemtype,
1862 rule_name => 'holdallowed',
1865 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1867 branchcode => $branchcode,
1868 itemtype => $itemtype,
1869 rule_name => 'hold_fulfillment_policy',
1872 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1874 branchcode => $branchcode,
1875 itemtype => $itemtype,
1876 rule_name => 'returnbranch',
1880 # built-in default circulation rule
1882 $rules->{holdallowed} = defined $holdallowed_rule
1883 ? $holdallowed_rule->rule_value
1884 : 'from_any_library';
1885 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1886 ? $hold_fulfillment_policy_rule->rule_value
1888 $rules->{returnbranch} = defined $returnbranch_rule
1889 ? $returnbranch_rule->rule_value
1897 ($doreturn, $messages, $iteminformation, $borrower) =
1898 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1904 =item C<$barcode> is the bar code of the book being returned.
1906 =item C<$branch> is the code of the branch where the book is being returned.
1908 =item C<$exemptfine> indicates that overdue charges for the item will be
1911 =item C<$return_date> allows the default return date to be overridden
1912 by the given return date. Optional.
1916 C<&AddReturn> returns a list of four items:
1918 C<$doreturn> is true iff the return succeeded.
1920 C<$messages> is a reference-to-hash giving feedback on the operation.
1921 The keys of the hash are:
1927 No item with this barcode exists. The value is C<$barcode>.
1931 The book is not currently on loan. The value is C<$barcode>.
1935 This book has been withdrawn/cancelled. The value should be ignored.
1937 =item C<Wrongbranch>
1939 This book has was returned to the wrong branch. The value is a hashref
1940 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1941 contain the branchcode of the incorrect and correct return library, respectively.
1945 The item was reserved. The value is a reference-to-hash whose keys are
1946 fields from the reserves table of the Koha database, and
1947 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1948 either C<Waiting>, C<Reserved>, or 0.
1950 =item C<WasReturned>
1952 Value 1 if return is successful.
1954 =item C<NeedsTransfer>
1956 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1960 C<$iteminformation> is a reference-to-hash, giving information about the
1961 returned item from the issues table.
1963 C<$borrower> is a reference-to-hash, giving information about the
1964 patron who last borrowed the book.
1969 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1971 if ($branch and not Koha::Libraries->find($branch)) {
1972 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1975 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1976 my $return_date_specified = !!$return_date;
1977 $return_date //= dt_from_string();
1981 my $validTransfer = 1;
1982 my $stat_type = 'return';
1984 # get information on item
1985 my $item = Koha::Items->find({ barcode => $barcode });
1987 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1990 my $itemnumber = $item->itemnumber;
1991 my $itemtype = $item->effective_itemtype;
1993 my $issue = $item->checkout;
1995 $patron = $issue->patron
1996 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1997 . Dumper($issue->unblessed) . "\n";
1999 $messages->{'NotIssued'} = $barcode;
2000 $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
2002 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2004 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2005 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2006 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2007 $messages->{'LocalUse'} = 1;
2008 $stat_type = 'localuse';
2012 # full item data, but no borrowernumber or checkout info (no issue)
2013 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2014 # get the proper branch to which to return the item
2015 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2016 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2017 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2019 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2020 my $patron_unblessed = $patron ? $patron->unblessed : {};
2022 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2023 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2024 if ($update_loc_rules) {
2025 if (defined $update_loc_rules->{_ALL_}) {
2026 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2027 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2028 if ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) {
2029 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2030 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2034 foreach my $key ( keys %$update_loc_rules ) {
2035 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2036 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2037 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2038 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2039 $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2046 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2048 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2050 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2052 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2055 foreach my $key ( keys %$rules ) {
2056 if ( $item->notforloan eq $key ) {
2057 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2058 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2065 # check if the return is allowed at this branch
2066 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2067 unless ($returnallowed){
2068 $messages->{'Wrongbranch'} = {
2069 Wrongbranch => $branch,
2070 Rightbranch => $message
2073 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2074 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2075 return ( $doreturn, $messages, $issue, $patron_unblessed);
2078 if ( $item->withdrawn ) { # book has been cancelled
2079 $messages->{'withdrawn'} = 1;
2080 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2083 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2087 # case of a return of document (deal with issues and holdingbranch)
2089 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2090 $patron or warn "AddReturn without current borrower";
2094 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2099 C4::Context->preference('CalculateFinesOnReturn')
2100 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2105 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2108 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 );
2110 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2111 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2113 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2116 # FIXME is the "= 1" right? This could be the borrower hash.
2117 $messages->{'WasReturned'} = 1;
2120 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2124 # the holdingbranch is updated if the document is returned to another location.
2125 # this is always done regardless of whether the item was on loan or not
2126 if ($item->holdingbranch ne $branch) {
2127 $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2130 my $item_was_lost = $item->itemlost;
2131 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2132 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2134 # fix up the accounts.....
2135 if ($item_was_lost) {
2136 $messages->{'WasLost'} = 1;
2137 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2138 $messages->{'LostItemFeeRefunded'} = $updated_item->{_refunded};
2139 $messages->{'LostItemFeeRestored'} = $updated_item->{_restored};
2141 if ( $updated_item->{_charge} ) {
2142 $issue //= Koha::Old::Checkouts->search(
2143 { itemnumber => $item->itemnumber },
2144 { order_by => { '-desc' => 'returndate' }, rows => 1 } )
2146 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2147 my $patron = $issue->patron;
2148 $patron_unblessed = $patron->unblessed;
2150 _CalculateAndUpdateFine(
2153 item => $item->unblessed,
2154 borrower => $patron_unblessed,
2155 return_date => $return_date
2158 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2159 $item->itemnumber, undef, 'RETURNED' );
2160 $messages->{'LostItemFeeCharged'} = 1;
2165 # check if we have a transfer for this document
2166 my $transfer = $item->get_transfer;
2168 # if we have a transfer to complete, we update the line of transfers with the datearrived
2169 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2172 if ( $transfer->in_transit ) {
2173 if ( $transfer->tobranch eq $branch ) {
2175 $messages->{'TransferArrived'} = $transfer->frombranch;
2178 $messages->{'WrongTransfer'} = $transfer->tobranch;
2179 $messages->{'WrongTransferItem'} = $item->itemnumber;
2183 if ( $transfer->tobranch eq $branch ) {
2185 $messages->{'TransferArrived'} = $transfer->frombranch;
2188 $messages->{'WasTransfered'} = $transfer->tobranch;
2189 $messages->{'TransferTrigger'} = $transfer->reason;
2194 # fix up the overdues in accounts...
2195 if ($borrowernumber) {
2196 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2197 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2199 if ( $issue and $issue->is_overdue($return_date) ) {
2201 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2203 $messages->{'PrevDebarred'} = $debardate;
2205 $messages->{'Debarred'} = $debardate if $debardate;
2207 # there's no overdue on the item but borrower had been previously debarred
2208 } elsif ( $issue->date_due and $patron->debarred ) {
2209 if ( $patron->debarred eq "9999-12-31") {
2210 $messages->{'ForeverDebarred'} = $patron->debarred;
2212 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2213 $borrower_debar_dt->truncate(to => 'day');
2214 my $today_dt = $return_date->clone()->truncate(to => 'day');
2215 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2216 $messages->{'PrevDebarred'} = $patron->debarred;
2222 # find reserves.....
2223 # launch the Checkreserves routine to find any holds
2224 my ($resfound, $resrec);
2225 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2226 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2227 # 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)
2228 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2229 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2230 $resfound = 'Reserved';
2231 $resrec = $hold->unblessed;
2234 $resrec->{'ResFound'} = $resfound;
2235 $messages->{'ResFound'} = $resrec;
2238 # Record the fact that this book was returned.
2242 itemnumber => $itemnumber,
2243 itemtype => $itemtype,
2244 location => $item->location,
2245 borrowernumber => $borrowernumber,
2246 ccode => $item->ccode,
2249 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2251 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2253 branchcode => $branch,
2254 categorycode => $patron->categorycode,
2255 item_type => $itemtype,
2256 notification => 'CHECKIN',
2258 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2259 SendCirculationAlert({
2261 item => $item->unblessed,
2262 borrower => $patron->unblessed,
2267 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2268 if C4::Context->preference("ReturnLog");
2271 # Check if this item belongs to a biblio record that is attached to an
2272 # ILL request, if it is we need to update the ILL request's status
2273 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2274 my $request = Koha::Illrequests->find(
2275 { biblio_id => $item->biblio->biblionumber }
2277 $request->status('RET') if $request;
2280 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2281 if ( $validTransfer && !$is_in_rotating_collection
2282 && ( $doreturn or $messages->{'NotIssued'} )
2284 and ( $branch ne $returnbranch )
2285 and not $messages->{'WrongTransfer'}
2286 and not $messages->{'WasTransfered'} )
2288 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2289 if (C4::Context->preference("AutomaticItemReturn" ) or
2290 (C4::Context->preference("UseBranchTransferLimits") and
2291 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2293 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2294 $debug and warn "item: " . Dumper($item->unblessed);
2295 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2296 $messages->{'WasTransfered'} = $returnbranch;
2297 $messages->{'TransferTrigger'} = $transfer_trigger;
2299 $messages->{'NeedsTransfer'} = $returnbranch;
2300 $messages->{'TransferTrigger'} = $transfer_trigger;
2304 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2305 my $claims = Koha::Checkouts::ReturnClaims->search(
2307 itemnumber => $item->id,
2308 resolution => undef,
2312 if ( $claims->count ) {
2313 $messages->{ReturnClaims} = $claims;
2317 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2318 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2320 if ( $doreturn and $issue ) {
2321 my $checkin = Koha::Old::Checkouts->find($issue->id);
2323 Koha::Plugins->call('after_circ_action', {
2324 action => 'checkin',
2331 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2334 =head2 MarkIssueReturned
2336 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2338 Unconditionally marks an issue as being returned by
2339 moving the C<issues> row to C<old_issues> and
2340 setting C<returndate> to the current date.
2342 if C<$returndate> is specified (in iso format), it is used as the date
2345 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2346 the old_issue is immediately anonymised
2348 Ideally, this function would be internal to C<C4::Circulation>,
2349 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2350 and offline_circ/process_koc.pl.
2352 The last optional parameter allos passing skip_record_index to the item store call.
2356 sub MarkIssueReturned {
2357 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2359 # Retrieve the issue
2360 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2362 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2364 my $issue_id = $issue->issue_id;
2366 my $anonymouspatron;
2367 if ( $privacy && $privacy == 2 ) {
2368 # The default of 0 will not work due to foreign key constraints
2369 # The anonymisation will fail if AnonymousPatron is not a valid entry
2370 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2371 # Note that a warning should appear on the about page (System information tab).
2372 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2373 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."
2374 unless Koha::Patrons->find( $anonymouspatron );
2377 my $schema = Koha::Database->schema;
2379 # FIXME Improve the return value and handle it from callers
2380 $schema->txn_do(sub {
2382 my $patron = Koha::Patrons->find( $borrowernumber );
2384 # Update the returndate value
2385 if ( $returndate ) {
2386 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2389 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2392 # Create the old_issues entry
2393 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2395 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2396 if ( $privacy && $privacy == 2) {
2397 $old_checkout->borrowernumber($anonymouspatron)->store;
2400 # And finally delete the issue
2403 $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2405 if ( C4::Context->preference('StoreLastBorrower') ) {
2406 my $item = Koha::Items->find( $itemnumber );
2407 $item->last_returned_by( $patron );
2410 # Remove any OVERDUES related debarment if the borrower has no overdues
2411 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2412 && $patron->debarred
2413 && !$patron->has_overdues
2414 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2416 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2424 =head2 _debar_user_on_return
2426 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2428 C<$borrower> borrower hashref
2430 C<$item> item hashref
2432 C<$datedue> date due DateTime object
2434 C<$returndate> DateTime object representing the return time
2436 Internal function, called only by AddReturn that calculates and updates
2437 the user fine days, and debars them if necessary.
2439 Should only be called for overdue returns
2441 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2446 sub _calculate_new_debar_dt {
2447 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2449 my $branchcode = _GetCircControlBranch( $item, $borrower );
2450 my $circcontrol = C4::Context->preference('CircControl');
2451 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2452 { categorycode => $borrower->{categorycode},
2453 itemtype => $item->{itype},
2454 branchcode => $branchcode,
2459 'maxsuspensiondays',
2460 'suspension_chargeperiod',
2464 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2465 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2466 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2468 return unless $finedays;
2470 # finedays is in days, so hourly loans must multiply by 24
2471 # thus 1 hour late equals 1 day suspension * finedays rate
2472 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2474 # grace period is measured in the same units as the loan
2476 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2478 my $deltadays = DateTime::Duration->new(
2479 days => $chargeable_units
2482 if ( $deltadays->subtract($grace)->is_positive() ) {
2483 my $suspension_days = $deltadays * $finedays;
2485 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2486 # No need to / 1 and do not consider / 0
2487 $suspension_days = DateTime::Duration->new(
2488 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2492 # If the max suspension days is < than the suspension days
2493 # the suspension days is limited to this maximum period.
2494 my $max_sd = $issuing_rule->{maxsuspensiondays};
2495 if ( defined $max_sd && $max_sd ne '' ) {
2496 $max_sd = DateTime::Duration->new( days => $max_sd );
2497 $suspension_days = $max_sd
2498 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2501 my ( $has_been_extended );
2502 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2503 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2505 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2506 $has_been_extended = 1;
2511 # Use the calendar or not to calculate the debarment date
2512 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2513 my $calendar = Koha::Calendar->new(
2514 branchcode => $branchcode,
2515 days_mode => 'Calendar'
2517 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2520 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2522 return $new_debar_dt;
2527 sub _debar_user_on_return {
2528 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2530 $return_date //= dt_from_string();
2532 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2534 return unless $new_debar_dt;
2536 Koha::Patron::Debarments::AddUniqueDebarment({
2537 borrowernumber => $borrower->{borrowernumber},
2538 expiration => $new_debar_dt->ymd(),
2539 type => 'SUSPENSION',
2541 # if borrower was already debarred but does not get an extra debarment
2542 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2543 my ($new_debarment_str, $is_a_reminder);
2544 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2546 $new_debarment_str = $borrower->{debarred};
2548 $new_debarment_str = $new_debar_dt->ymd();
2550 # FIXME Should return a DateTime object
2551 return $new_debarment_str, $is_a_reminder;
2554 =head2 _FixOverduesOnReturn
2556 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2558 C<$borrowernumber> borrowernumber
2560 C<$itemnumber> itemnumber
2562 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2564 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2570 sub _FixOverduesOnReturn {
2571 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2572 unless( $borrowernumber ) {
2573 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2577 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2581 warn "_FixOverduesOnReturn() not supplied valid status";
2585 my $schema = Koha::Database->schema;
2587 my $result = $schema->txn_do(
2589 # check for overdue fine
2590 my $accountlines = Koha::Account::Lines->search(
2592 borrowernumber => $borrowernumber,
2593 itemnumber => $item,
2594 debit_type_code => 'OVERDUE',
2595 status => 'UNRETURNED'
2598 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2600 my $accountline = $accountlines->next;
2601 my $payments = $accountline->credits;
2603 my $amountoutstanding = $accountline->amountoutstanding;
2604 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2605 $accountline->delete;
2606 return 0; # no warning, we've just removed a zero value fine (backdated return)
2607 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2608 my $account = Koha::Account->new({patron_id => $borrowernumber});
2609 my $credit = $account->add_credit(
2611 amount => $amountoutstanding,
2612 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2613 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2614 interface => C4::Context->interface,
2620 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2622 if (C4::Context->preference("FinesLog")) {
2623 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2627 $accountline->status($status);
2628 return $accountline->store();
2635 =head2 _GetCircControlBranch
2637 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2641 Return the library code to be used to determine which circulation
2642 policy applies to a transaction. Looks up the CircControl and
2643 HomeOrHoldingBranch system preferences.
2645 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2647 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2651 sub _GetCircControlBranch {
2652 my ($item, $borrower) = @_;
2653 my $circcontrol = C4::Context->preference('CircControl');
2656 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2657 $branch= C4::Context->userenv->{'branch'};
2658 } elsif ($circcontrol eq 'PatronLibrary') {
2659 $branch=$borrower->{branchcode};
2661 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2662 $branch = $item->{$branchfield};
2663 # default to item home branch if holdingbranch is used
2664 # and is not defined
2665 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2666 $branch = $item->{homebranch};
2674 $issue = GetOpenIssue( $itemnumber );
2676 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2678 C<$itemnumber> is the item's itemnumber
2685 my ( $itemnumber ) = @_;
2686 return unless $itemnumber;
2687 my $dbh = C4::Context->dbh;
2688 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2689 $sth->execute( $itemnumber );
2690 return $sth->fetchrow_hashref();
2694 =head2 GetUpcomingDueIssues
2696 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2700 sub GetUpcomingDueIssues {
2703 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2704 my $dbh = C4::Context->dbh;
2707 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2709 LEFT JOIN items USING (itemnumber)
2710 LEFT JOIN branches ON branches.branchcode =
2712 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2713 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2714 my @bind_parameters = ( $params->{'days_in_advance'} );
2716 my $sth = $dbh->prepare( $statement );
2717 $sth->execute( @bind_parameters );
2718 my $upcoming_dues = $sth->fetchall_arrayref({});
2720 return $upcoming_dues;
2723 =head2 CanBookBeRenewed
2725 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2727 Find out whether a borrowed item may be renewed.
2729 C<$borrowernumber> is the borrower number of the patron who currently
2730 has the item on loan.
2732 C<$itemnumber> is the number of the item to renew.
2734 C<$override_limit>, if supplied with a true value, causes
2735 the limit on the number of times that the loan can be renewed
2736 (as controlled by the item type) to be ignored. Overriding also allows
2737 to renew sooner than "No renewal before" and to manually renew loans
2738 that are automatically renewed.
2740 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2741 item must currently be on loan to the specified borrower; renewals
2742 must be allowed for the item's type; and the borrower must not have
2743 already renewed the loan. $error will contain the reason the renewal can not proceed
2747 sub CanBookBeRenewed {
2748 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2750 my $dbh = C4::Context->dbh;
2752 my $auto_renew = "no";
2754 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2755 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2756 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2757 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2759 my $patron = $issue->patron or return;
2761 # override_limit will override anything else except on_reserve
2762 unless ( $override_limit ){
2763 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2764 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2766 categorycode => $patron->categorycode,
2767 itemtype => $item->effective_itemtype,
2768 branchcode => $branchcode,
2771 'no_auto_renewal_after',
2772 'no_auto_renewal_after_hard_limit',
2775 'unseen_renewals_allowed'
2780 return ( 0, "too_many" )
2781 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2783 return ( 0, "too_unseen" )
2784 if C4::Context->preference('UnseenRenewals') &&
2785 $issuing_rule->{unseen_renewals_allowed} &&
2786 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2788 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2789 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2790 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2791 my $restricted = $patron->is_debarred;
2792 my $hasoverdues = $patron->has_overdues;
2794 if ( $restricted and $restrictionblockrenewing ) {
2795 return ( 0, 'restriction');
2796 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2797 return ( 0, 'overdue');
2800 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2802 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2803 return ( 0, 'auto_account_expired' );
2806 if ( defined $issuing_rule->{no_auto_renewal_after}
2807 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2808 # Get issue_date and add no_auto_renewal_after
2809 # If this is greater than today, it's too late for renewal.
2810 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2811 $maximum_renewal_date->add(
2812 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2814 my $now = dt_from_string;
2815 if ( $now >= $maximum_renewal_date ) {
2816 return ( 0, "auto_too_late" );
2819 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2820 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2821 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2822 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2823 return ( 0, "auto_too_late" );
2827 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2828 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2829 my $amountoutstanding =
2830 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2831 ? $patron->account->balance
2832 : $patron->account->outstanding_debits->total_outstanding;
2833 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2834 return ( 0, "auto_too_much_oweing" );
2839 if ( defined $issuing_rule->{norenewalbefore}
2840 and $issuing_rule->{norenewalbefore} ne "" )
2843 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2844 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2845 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2847 # Depending on syspref reset the exact time, only check the date
2848 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2849 and $issuing_rule->{lengthunit} eq 'days' )
2851 $soonestrenewal->truncate( to => 'day' );
2854 if ( $soonestrenewal > dt_from_string() )
2856 $auto_renew = ($issue->auto_renew && $patron->autorenew_checkouts) ? "auto_too_soon" : "too_soon";
2858 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2863 # Fallback for automatic renewals:
2864 # If norenewalbefore is undef, don't renew before due date.
2865 if ( $issue->auto_renew && $auto_renew eq "no" && $patron->autorenew_checkouts ) {
2866 my $now = dt_from_string;
2867 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2870 $auto_renew = "auto_too_soon";
2875 my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2877 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2878 if ( $resfound && $resrec->{non_priority} ) {
2879 $resfound = Koha::Holds->search(
2880 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2886 # This item can fill one or more unfilled reserve, can those unfilled reserves
2887 # all be filled by other available items?
2889 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2891 my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2893 # There is an item level hold on this item, no other item can fill the hold
2898 # Get all other items that could possibly fill reserves
2899 my $items = Koha::Items->search({
2900 biblionumber => $resrec->{biblionumber},
2903 -not => { itemnumber => $itemnumber }
2906 # Get all other reserves that could have been filled by this item
2907 my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2908 my $patrons = Koha::Patrons->search({
2909 borrowernumber => { -in => \@borrowernumbers }
2912 # If the count of the union of the lists of reservable items for each borrower
2913 # is equal or greater than the number of borrowers, we know that all reserves
2914 # can be filled with available items. We can get the union of the sets simply
2915 # by pushing all the elements onto an array and removing the duplicates.
2917 ITEM: while ( my $item = $items->next ) {
2918 next if IsItemOnHoldAndFound( $item->itemnumber );
2919 while ( my $patron = $patrons->next ) {
2920 next unless IsAvailableForItemLevelRequest($item, $patron);
2921 next unless CanItemBeReserved($patron->borrowernumber,$item->itemnumber);
2922 push @reservable, $item->itemnumber;
2923 if (@reservable >= @borrowernumbers) {
2932 if( $cron ) { #The cron wants to return 'too_soon' over 'on_reserve'
2933 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2934 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2935 } else { # For other purposes we want 'on_reserve' before 'too_soon'
2936 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2937 return ( 0, $auto_renew ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2940 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2942 return ( 1, undef );
2947 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2951 C<$borrowernumber> is the borrower number of the patron who currently
2954 C<$itemnumber> is the number of the item to renew.
2956 C<$branch> is the library where the renewal took place (if any).
2957 The library that controls the circ policies for the renewal is retrieved from the issues record.
2959 C<$datedue> can be a DateTime object used to set the due date.
2961 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2962 this parameter is not supplied, lastreneweddate is set to the current date.
2964 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2965 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2966 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2969 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2970 from the book's item type.
2972 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
2973 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
2974 fallback to a true value
2979 my $borrowernumber = shift;
2980 my $itemnumber = shift or return;
2982 my $datedue = shift;
2983 my $lastreneweddate = shift || dt_from_string();
2984 my $skipfinecalc = shift;
2987 # Fallback on a 'seen' renewal
2988 $seen = defined $seen && $seen == 0 ? 0 : 1;
2990 my $item_object = Koha::Items->find($itemnumber) or return;
2991 my $biblio = $item_object->biblio;
2992 my $issue = $item_object->checkout;
2993 my $item_unblessed = $item_object->unblessed;
2995 my $dbh = C4::Context->dbh;
2997 return unless $issue;
2999 $borrowernumber ||= $issue->borrowernumber;
3001 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3002 carp 'Invalid date passed to AddRenewal.';
3006 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3007 my $patron_unblessed = $patron->unblessed;
3009 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3011 my $schema = Koha::Database->schema;
3012 $schema->txn_do(sub{
3014 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3015 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3017 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3019 # If the due date wasn't specified, calculate it by adding the
3020 # book's loan length to today's date or the current due date
3021 # based on the value of the RenewalPeriodBase syspref.
3022 my $itemtype = $item_object->effective_itemtype;
3025 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3026 dt_from_string( $issue->date_due, 'sql' ) :
3028 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3031 my $fees = Koha::Charges::Fees->new(
3034 library => $circ_library,
3035 item => $item_object,
3036 from_date => dt_from_string( $issue->date_due, 'sql' ),
3037 to_date => dt_from_string($datedue),
3041 # Increment the unseen renewals, if appropriate
3042 # We only do so if the syspref is enabled and
3043 # a maximum value has been set in the circ rules
3044 my $unseen_renewals = $issue->unseen_renewals;
3045 if (C4::Context->preference('UnseenRenewals')) {
3046 my $rule = Koha::CirculationRules->get_effective_rule(
3047 { categorycode => $patron->categorycode,
3048 itemtype => $item_object->effective_itemtype,
3049 branchcode => $circ_library->branchcode,
3050 rule_name => 'unseen_renewals_allowed'
3053 if (!$seen && $rule && $rule->rule_value) {
3056 # If the renewal is seen, unseen should revert to 0
3057 $unseen_renewals = 0;
3061 # Update the issues record to have the new due date, and a new count
3062 # of how many times it has been renewed.
3063 my $renews = ( $issue->renewals || 0 ) + 1;
3064 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3067 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3070 Koha::Exceptions::Checkout::FailedRenewal->throw(
3071 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3075 # Update the renewal count on the item, and tell zebra to reindex
3076 $renews = ( $item_object->renewals || 0 ) + 1;
3077 $item_object->renewals($renews);
3078 $item_object->onloan($datedue);
3079 $item_object->store({ log_action => 0 });
3081 # Charge a new rental fee, if applicable
3082 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3083 if ( $charge > 0 ) {
3084 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3087 # Charge a new accumulate rental fee, if applicable
3088 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3089 if ( $itemtype_object ) {
3090 my $accumulate_charge = $fees->accumulate_rentalcharge();
3091 if ( $accumulate_charge > 0 ) {
3092 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3094 $charge += $accumulate_charge;
3097 # Send a renewal slip according to checkout alert preferencei
3098 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3099 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3101 branchcode => $branch,
3102 categorycode => $patron->categorycode,
3103 item_type => $itemtype,
3104 notification => 'CHECKOUT',
3106 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3107 SendCirculationAlert(
3110 item => $item_unblessed,
3111 borrower => $patron->unblessed,
3118 # Remove any OVERDUES related debarment if the borrower has no overdues
3120 && $patron->is_debarred
3121 && ! $patron->has_overdues
3122 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3124 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3127 # Add the renewal to stats
3130 branch => $item_object->renewal_branchcode({branch => $branch}),
3133 itemnumber => $itemnumber,
3134 itemtype => $itemtype,
3135 location => $item_object->location,
3136 borrowernumber => $borrowernumber,
3137 ccode => $item_object->ccode,
3142 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3144 Koha::Plugins->call('after_circ_action', {
3145 action => 'renewal',
3147 checkout => $issue->get_from_storage
3156 # check renewal status
3157 my ( $bornum, $itemno ) = @_;
3158 my $dbh = C4::Context->dbh;
3160 my $unseencount = 0;
3161 my $renewsallowed = 0;
3162 my $unseenallowed = 0;
3166 my $patron = Koha::Patrons->find( $bornum );
3167 my $item = Koha::Items->find($itemno);
3169 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3171 # Look in the issues table for this item, lent to this borrower,
3172 # and not yet returned.
3174 # FIXME - I think this function could be redone to use only one SQL call.
3175 my $sth = $dbh->prepare(
3176 "select * from issues
3177 where (borrowernumber = ?)
3178 and (itemnumber = ?)"
3180 $sth->execute( $bornum, $itemno );
3181 my $data = $sth->fetchrow_hashref;
3182 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3183 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3184 # $item and $borrower should be calculated
3185 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3187 my $rules = Koha::CirculationRules->get_effective_rules(
3189 categorycode => $patron->categorycode,
3190 itemtype => $item->effective_itemtype,
3191 branchcode => $branchcode,
3192 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3195 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3196 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3197 $rules->{unseen_renewals_allowed} :
3199 $renewsleft = $renewsallowed - $renewcount;
3200 $unseenleft = $unseenallowed - $unseencount;
3201 if($renewsleft < 0){ $renewsleft = 0; }
3202 if($unseenleft < 0){ $unseenleft = 0; }
3213 =head2 GetSoonestRenewDate
3215 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3217 Find out the soonest possible renew date of a borrowed item.
3219 C<$borrowernumber> is the borrower number of the patron who currently
3220 has the item on loan.
3222 C<$itemnumber> is the number of the item to renew.
3224 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3225 renew date, based on the value "No renewal before" of the applicable
3226 issuing rule. Returns the current date if the item can already be
3227 renewed, and returns undefined if the borrower, loan, or item
3232 sub GetSoonestRenewDate {
3233 my ( $borrowernumber, $itemnumber ) = @_;
3235 my $dbh = C4::Context->dbh;
3237 my $item = Koha::Items->find($itemnumber) or return;
3238 my $itemissue = $item->checkout or return;
3240 $borrowernumber ||= $itemissue->borrowernumber;
3241 my $patron = Koha::Patrons->find( $borrowernumber )
3244 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3245 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3246 { categorycode => $patron->categorycode,
3247 itemtype => $item->effective_itemtype,
3248 branchcode => $branchcode,
3256 my $now = dt_from_string;
3257 return $now unless $issuing_rule;
3259 if ( defined $issuing_rule->{norenewalbefore}
3260 and $issuing_rule->{norenewalbefore} ne "" )
3262 my $soonestrenewal =
3263 dt_from_string( $itemissue->date_due )->subtract(
3264 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3266 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3267 and $issuing_rule->{lengthunit} eq 'days' )
3269 $soonestrenewal->truncate( to => 'day' );
3271 return $soonestrenewal if $now < $soonestrenewal;
3276 =head2 GetLatestAutoRenewDate
3278 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3280 Find out the latest possible auto renew date of a borrowed item.
3282 C<$borrowernumber> is the borrower number of the patron who currently
3283 has the item on loan.
3285 C<$itemnumber> is the number of the item to renew.
3287 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3288 auto renew date, based on the value "No auto renewal after" and the "No auto
3289 renewal after (hard limit) of the applicable issuing rule.
3290 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3291 or item cannot be found.
3295 sub GetLatestAutoRenewDate {
3296 my ( $borrowernumber, $itemnumber ) = @_;
3298 my $dbh = C4::Context->dbh;
3300 my $item = Koha::Items->find($itemnumber) or return;
3301 my $itemissue = $item->checkout or return;
3303 $borrowernumber ||= $itemissue->borrowernumber;
3304 my $patron = Koha::Patrons->find( $borrowernumber )
3307 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3308 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3310 categorycode => $patron->categorycode,
3311 itemtype => $item->effective_itemtype,
3312 branchcode => $branchcode,
3314 'no_auto_renewal_after',
3315 'no_auto_renewal_after_hard_limit',
3321 return unless $circulation_rules;
3323 if ( not $circulation_rules->{no_auto_renewal_after}
3324 or $circulation_rules->{no_auto_renewal_after} eq '' )
3325 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3326 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3328 my $maximum_renewal_date;
3329 if ( $circulation_rules->{no_auto_renewal_after} ) {
3330 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3331 $maximum_renewal_date->add(
3332 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3336 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3337 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3338 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3340 return $maximum_renewal_date;
3344 =head2 GetIssuingCharges
3346 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3348 Calculate how much it would cost for a given patron to borrow a given
3349 item, including any applicable discounts.
3351 C<$itemnumber> is the item number of item the patron wishes to borrow.
3353 C<$borrowernumber> is the patron's borrower number.
3355 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3356 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3361 sub GetIssuingCharges {
3363 # calculate charges due
3364 my ( $itemnumber, $borrowernumber ) = @_;
3366 my $dbh = C4::Context->dbh;
3369 # Get the book's item type and rental charge (via its biblioitem).
3370 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3371 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3372 $charge_query .= (C4::Context->preference('item-level_itypes'))
3373 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3374 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3376 $charge_query .= ' WHERE items.itemnumber =?';
3378 my $sth = $dbh->prepare($charge_query);
3379 $sth->execute($itemnumber);
3380 if ( my $item_data = $sth->fetchrow_hashref ) {
3381 $item_type = $item_data->{itemtype};
3382 $charge = $item_data->{rentalcharge};
3383 # FIXME This should follow CircControl
3384 my $branch = C4::Context::mybranch();
3385 my $patron = Koha::Patrons->find( $borrowernumber );
3386 my $discount = Koha::CirculationRules->get_effective_rule({
3387 categorycode => $patron->categorycode,
3388 branchcode => $branch,
3389 itemtype => $item_type,
3390 rule_name => 'rentaldiscount'
3393 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3396 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3400 return ( $charge, $item_type );
3403 =head2 AddIssuingCharge
3405 &AddIssuingCharge( $checkout, $charge, $type )
3409 sub AddIssuingCharge {
3410 my ( $checkout, $charge, $type ) = @_;
3412 # FIXME What if checkout does not exist?
3414 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3415 my $accountline = $account->add_debit(
3419 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3420 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3421 interface => C4::Context->interface,
3423 item_id => $checkout->itemnumber,
3424 issue_id => $checkout->issue_id,
3431 GetTransfers($itemnumber);
3436 my ($itemnumber) = @_;
3438 my $dbh = C4::Context->dbh;
3447 FROM branchtransfers
3448 WHERE itemnumber = ?
3449 AND datearrived IS NULL
3450 AND datecancelled IS NULL
3452 my $sth = $dbh->prepare($query);
3453 $sth->execute($itemnumber);
3454 my @row = $sth->fetchrow_array();
3458 =head2 GetTransfersFromTo
3460 @results = GetTransfersFromTo($frombranch,$tobranch);
3462 Returns the list of pending transfers between $from and $to branch
3466 sub GetTransfersFromTo {
3467 my ( $frombranch, $tobranch ) = @_;
3468 return unless ( $frombranch && $tobranch );
3469 my $dbh = C4::Context->dbh;
3471 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3472 FROM branchtransfers
3475 AND datecancelled IS NULL
3476 AND datesent IS NOT NULL
3477 AND datearrived IS NULL
3479 my $sth = $dbh->prepare($query);
3480 $sth->execute( $frombranch, $tobranch );
3483 while ( my $data = $sth->fetchrow_hashref ) {
3484 push @gettransfers, $data;
3486 return (@gettransfers);
3489 =head2 DeleteTransfer
3491 &DeleteTransfer($itemnumber);
3495 sub DeleteTransfer {
3496 my ($itemnumber) = @_;
3497 return unless $itemnumber;
3498 my $dbh = C4::Context->dbh;
3499 my $sth = $dbh->prepare(
3500 "DELETE FROM branchtransfers
3502 AND datearrived IS NULL "
3504 return $sth->execute($itemnumber);
3507 =head2 SendCirculationAlert
3509 Send out a C<check-in> or C<checkout> alert using the messaging system.
3517 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3521 Hashref of information about the item being checked in or out.
3525 Hashref of information about the borrower of the item.
3529 The branchcode from where the checkout or check-in took place.
3535 SendCirculationAlert({
3538 borrower => $borrower,
3544 sub SendCirculationAlert {
3546 my ($type, $item, $borrower, $branch) =
3547 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3548 my %message_name = (
3549 CHECKIN => 'Item_Check_in',
3550 CHECKOUT => 'Item_Checkout',
3551 RENEWAL => 'Item_Checkout',
3553 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3554 borrowernumber => $borrower->{borrowernumber},
3555 message_name => $message_name{$type},
3557 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3559 my $schema = Koha::Database->new->schema;
3560 my @transports = keys %{ $borrower_preferences->{transports} };
3562 # From the MySQL doc:
3563 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3564 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3565 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3566 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3568 for my $mtt (@transports) {
3569 my $letter = C4::Letters::GetPreparedLetter (
3570 module => 'circulation',
3571 letter_code => $type,
3572 branchcode => $branch,
3573 message_transport_type => $mtt,
3574 lang => $borrower->{lang},
3576 $issues_table => $item->{itemnumber},
3577 'items' => $item->{itemnumber},
3578 'biblio' => $item->{biblionumber},
3579 'biblioitems' => $item->{biblionumber},
3580 'borrowers' => $borrower,
3581 'branches' => $branch,
3585 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3586 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3587 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3588 unless ( $message ) {
3589 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3590 C4::Message->enqueue($letter, $borrower, $mtt);
3592 $message->append($letter);
3595 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3601 =head2 updateWrongTransfer
3603 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3605 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
3609 sub updateWrongTransfer {
3610 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3611 my $dbh = C4::Context->dbh;
3612 # first step validate the actual line of transfert .
3615 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3617 $sth->execute($FromLibrary,$itemNumber);
3619 # second step create a new line of branchtransfer to the right location .
3620 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3622 #third step changing holdingbranch of item
3623 my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3628 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3630 this function calculates the due date given the start date and configured circulation rules,
3631 checking against the holidays calendar as per the daysmode circulation rule.
3632 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3633 C<$itemtype> = itemtype code of item in question
3634 C<$branch> = location whose calendar to use
3635 C<$borrower> = Borrower object
3636 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3641 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3645 # loanlength now a href
3647 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3649 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3655 if (ref $startdate ne 'DateTime' ) {
3656 $datedue = dt_from_string($datedue);
3658 $datedue = $startdate->clone;
3661 $datedue = dt_from_string()->truncate( to => 'minute' );
3665 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3667 categorycode => $borrower->{categorycode},
3668 itemtype => $itemtype,
3669 branchcode => $branch,
3673 # calculate the datedue as normal
3674 if ( $daysmode eq 'Days' )
3675 { # ignoring calendar
3676 if ( $loanlength->{lengthunit} eq 'hours' ) {
3677 $datedue->add( hours => $loanlength->{$length_key} );
3679 $datedue->add( days => $loanlength->{$length_key} );
3680 $datedue->set_hour(23);
3681 $datedue->set_minute(59);
3685 if ($loanlength->{lengthunit} eq 'hours') {
3686 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3689 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3691 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3692 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3693 if ($loanlength->{lengthunit} eq 'days') {
3694 $datedue->set_hour(23);
3695 $datedue->set_minute(59);
3699 # if Hard Due Dates are used, retrieve them and apply as necessary
3700 my ( $hardduedate, $hardduedatecompare ) =
3701 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3702 if ($hardduedate) { # hardduedates are currently dates
3703 $hardduedate->truncate( to => 'minute' );
3704 $hardduedate->set_hour(23);
3705 $hardduedate->set_minute(59);
3706 my $cmp = DateTime->compare( $hardduedate, $datedue );
3708 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3709 # if the calculated date is before the 'after' Hard Due Date (floor), override
3710 # if the hard due date is set to 'exactly', overrride
3711 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3712 $datedue = $hardduedate->clone;
3715 # in all other cases, keep the date due as it is
3719 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3720 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3721 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3722 if( $expiry_dt ) { #skip empty expiry date..
3723 $expiry_dt->set( hour => 23, minute => 59);
3724 my $d1= $datedue->clone->set_time_zone('floating');
3725 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3726 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3729 if ( $daysmode ne 'Days' ) {
3730 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3731 if ( $calendar->is_holiday($datedue) ) {
3732 # Don't return on a closed day
3733 $datedue = $calendar->prev_open_days( $datedue, 1 );
3742 sub CheckValidBarcode{
3744 my $dbh = C4::Context->dbh;
3745 my $query=qq|SELECT count(*)
3749 my $sth = $dbh->prepare($query);
3750 $sth->execute($barcode);
3751 my $exist=$sth->fetchrow ;
3755 =head2 IsBranchTransferAllowed
3757 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3759 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3761 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3762 Koha::Item->can_be_transferred.
3766 sub IsBranchTransferAllowed {
3767 my ( $toBranch, $fromBranch, $code ) = @_;
3769 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3771 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3772 my $dbh = C4::Context->dbh;
3774 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3775 $sth->execute( $toBranch, $fromBranch, $code );
3776 my $limit = $sth->fetchrow_hashref();
3778 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3779 if ( $limit->{'limitId'} ) {
3786 =head2 CreateBranchTransferLimit
3788 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3790 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3792 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3796 sub CreateBranchTransferLimit {
3797 my ( $toBranch, $fromBranch, $code ) = @_;
3798 return unless defined($toBranch) && defined($fromBranch);
3799 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3801 my $dbh = C4::Context->dbh;
3803 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3804 return $sth->execute( $code, $toBranch, $fromBranch );
3807 =head2 DeleteBranchTransferLimits
3809 my $result = DeleteBranchTransferLimits($frombranch);
3811 Deletes all the library transfer limits for one library. Returns the
3812 number of limits deleted, 0e0 if no limits were deleted, or undef if
3813 no arguments are supplied.
3815 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3816 fromBranch => $fromBranch
3821 sub DeleteBranchTransferLimits {
3823 return unless defined $branch;
3824 my $dbh = C4::Context->dbh;
3825 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3826 return $sth->execute($branch);
3830 my ( $borrowernumber, $itemnum ) = @_;
3831 MarkIssueReturned( $borrowernumber, $itemnum );
3836 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3838 The final optional parameter, C<$params>, expected to contain
3839 'skip_record_index' key, which relayed down to Koha::Item/store,
3840 there it prevents calling of ModZebra index_records,
3841 which takes most of the time in batch adds/deletes: index_records better
3842 to be called later in C<additem.pl> after the whole loop.
3845 skip_record_index => 1|0
3850 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3852 unless ( $mark_lost_from ) {
3853 # Temporary check to avoid regressions
3854 die q|LostItem called without $mark_lost_from, check the API.|;
3858 if ( $force_mark_returned ) {
3861 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3862 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3865 my $dbh = C4::Context->dbh();
3866 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3868 JOIN items USING (itemnumber)
3869 JOIN biblio USING (biblionumber)
3870 WHERE issues.itemnumber=?");
3871 $sth->execute($itemnumber);
3872 my $issues=$sth->fetchrow_hashref();
3874 # If a borrower lost the item, add a replacement cost to the their record
3875 if ( my $borrowernumber = $issues->{borrowernumber} ){
3876 my $patron = Koha::Patrons->find( $borrowernumber );
3878 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3879 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3881 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3882 C4::Accounts::chargelostitem(
3885 $issues->{'replacementprice'},
3886 sprintf( "%s %s %s",
3887 $issues->{'title'} || q{},
3888 $issues->{'barcode'} || q{},
3889 $issues->{'itemcallnumber'} || q{},
3892 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3893 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3896 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3899 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3900 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3901 Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store({ skip_record_index => $params->{skip_record_index} });
3903 my $transferdeleted = DeleteTransfer($itemnumber);
3906 sub GetOfflineOperations {
3907 my $dbh = C4::Context->dbh;
3908 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3909 $sth->execute(C4::Context->userenv->{'branch'});
3910 my $results = $sth->fetchall_arrayref({});
3914 sub GetOfflineOperation {
3915 my $operationid = shift;
3916 return unless $operationid;
3917 my $dbh = C4::Context->dbh;
3918 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3919 $sth->execute( $operationid );
3920 return $sth->fetchrow_hashref;
3923 sub AddOfflineOperation {
3924 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3925 my $dbh = C4::Context->dbh;
3926 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3927 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3931 sub DeleteOfflineOperation {
3932 my $dbh = C4::Context->dbh;
3933 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3934 $sth->execute( shift );
3938 sub ProcessOfflineOperation {
3939 my $operation = shift;
3942 if ( $operation->{action} eq 'return' ) {
3943 $report = ProcessOfflineReturn( $operation );
3944 } elsif ( $operation->{action} eq 'issue' ) {
3945 $report = ProcessOfflineIssue( $operation );
3946 } elsif ( $operation->{action} eq 'payment' ) {
3947 $report = ProcessOfflinePayment( $operation );
3950 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3955 sub ProcessOfflineReturn {
3956 my $operation = shift;
3958 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3961 my $itemnumber = $item->itemnumber;
3962 my $issue = GetOpenIssue( $itemnumber );
3964 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3965 ModDateLastSeen( $itemnumber, $leave_item_lost );
3967 $issue->{borrowernumber},
3969 $operation->{timestamp},
3972 $item->onloan(undef);
3973 $item->store({ log_action => 0 });
3976 return "Item not issued.";
3979 return "Item not found.";
3983 sub ProcessOfflineIssue {
3984 my $operation = shift;
3986 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3989 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3991 return "Barcode not found.";
3993 my $itemnumber = $item->itemnumber;
3994 my $issue = GetOpenIssue( $itemnumber );
3996 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3998 $issue->{borrowernumber},
4000 $operation->{timestamp},
4005 $operation->{'barcode'},
4008 $operation->{timestamp},
4013 return "Borrower not found.";
4017 sub ProcessOfflinePayment {
4018 my $operation = shift;
4020 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4022 $patron->account->pay(
4024 amount => $operation->{amount},
4025 library_id => $operation->{branchcode},
4035 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4037 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4042 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4046 ? Koha::Items->find($itemnumber)
4047 : Koha::Items->find( { barcode => $barcode } );
4051 return C4::Letters::GetPreparedLetter (
4052 module => 'circulation',
4053 letter_code => 'TRANSFERSLIP',
4054 branchcode => $branch,
4056 'branches' => $to_branch,
4057 'biblio' => $item->biblionumber,
4058 'items' => $item->unblessed,
4063 =head2 CheckIfIssuedToPatron
4065 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4067 Return 1 if any record item is issued to patron, otherwise return 0
4071 sub CheckIfIssuedToPatron {
4072 my ($borrowernumber, $biblionumber) = @_;
4074 my $dbh = C4::Context->dbh;
4076 SELECT COUNT(*) FROM issues
4077 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4078 WHERE items.biblionumber = ?
4079 AND issues.borrowernumber = ?
4081 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4082 return 1 if $is_issued;
4088 IsItemIssued( $itemnumber )
4090 Return 1 if the item is on loan, otherwise return 0
4095 my $itemnumber = shift;
4096 my $dbh = C4::Context->dbh;
4097 my $sth = $dbh->prepare(q{
4100 WHERE itemnumber = ?
4102 $sth->execute($itemnumber);
4103 return $sth->fetchrow;
4106 =head2 GetAgeRestriction
4108 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4109 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4111 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4112 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4114 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4115 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4116 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4117 Negative days mean the borrower has gone past the age restriction age.
4121 sub GetAgeRestriction {
4122 my ($record_restrictions, $borrower) = @_;
4123 my $markers = C4::Context->preference('AgeRestrictionMarker');
4125 return unless $record_restrictions;
4126 # Split $record_restrictions to something like FSK 16 or PEGI 6
4127 my @values = split ' ', uc($record_restrictions);
4128 return unless @values;
4130 # Search first occurrence of one of the markers
4131 my @markers = split /\|/, uc($markers);
4132 return unless @markers;
4135 my $restriction_year = 0;
4136 for my $value (@values) {
4138 for my $marker (@markers) {
4139 $marker =~ s/^\s+//; #remove leading spaces
4140 $marker =~ s/\s+$//; #remove trailing spaces
4141 if ( $marker eq $value ) {
4142 if ( $index <= $#values ) {
4143 $restriction_year += $values[$index];
4147 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4149 # Perhaps it is something like "K16" (as in Finland)
4150 $restriction_year += $1;
4154 last if ( $restriction_year > 0 );
4157 #Check if the borrower is age restricted for this material and for how long.
4158 if ($restriction_year && $borrower) {
4159 if ( $borrower->{'dateofbirth'} ) {
4160 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4161 $alloweddate[0] += $restriction_year;
4163 #Prevent runime eror on leap year (invalid date)
4164 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4165 $alloweddate[2] = 28;
4168 #Get how many days the borrower has to reach the age restriction
4169 my @Today = split /-/, dt_from_string()->ymd();
4170 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4171 #Negative days means the borrower went past the age restriction age
4172 return ($restriction_year, $daysToAgeRestriction);
4176 return ($restriction_year);
4180 =head2 GetPendingOnSiteCheckouts
4184 sub GetPendingOnSiteCheckouts {
4185 my $dbh = C4::Context->dbh;
4186 return $dbh->selectall_arrayref(q|
4192 items.itemcallnumber,
4196 issues.date_due < NOW() AS is_overdue,
4199 borrowers.firstname,
4201 borrowers.cardnumber,
4202 borrowers.borrowernumber
4204 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4205 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4206 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4207 WHERE issues.onsite_checkout = 1
4208 |, { Slice => {} } );
4214 my ($count, $branch, $itemtype, $ccode, $newness)
4215 = @$params{qw(count branch itemtype ccode newness)};
4217 my $dbh = C4::Context->dbh;
4220 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4221 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4222 i.ccode, SUM(i.issues) AS count
4224 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4225 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4228 my (@where_strs, @where_args);
4231 push @where_strs, 'i.homebranch = ?';
4232 push @where_args, $branch;
4235 if (C4::Context->preference('item-level_itypes')){
4236 push @where_strs, 'i.itype = ?';
4237 push @where_args, $itemtype;
4239 push @where_strs, 'bi.itemtype = ?';
4240 push @where_args, $itemtype;
4244 push @where_strs, 'i.ccode = ?';
4245 push @where_args, $ccode;
4248 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4249 push @where_args, $newness;
4253 $query .= 'WHERE ' . join(' AND ', @where_strs);
4257 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4258 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4263 $query .= q{ ) xxx WHERE count > 0 };
4264 $count = int($count);
4266 $query .= "LIMIT $count";
4269 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4274 =head2 Internal methods
4278 sub _CalculateAndUpdateFine {
4281 my $borrower = $params->{borrower};
4282 my $item = $params->{item};
4283 my $issue = $params->{issue};
4284 my $return_date = $params->{return_date};
4286 unless ($borrower) { carp "No borrower passed in!" && return; }
4287 unless ($item) { carp "No item passed in!" && return; }
4288 unless ($issue) { carp "No issue passed in!" && return; }
4290 my $datedue = dt_from_string( $issue->date_due );
4292 # we only need to calculate and change the fines if we want to do that on return
4293 # Should be on for hourly loans
4294 my $control = C4::Context->preference('CircControl');
4295 my $control_branchcode =
4296 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4297 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4298 : $issue->branchcode;
4300 my $date_returned = $return_date ? $return_date : dt_from_string();
4302 my ( $amount, $unitcounttotal, $unitcount ) =
4303 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4305 if ( C4::Context->preference('finesMode') eq 'production' ) {
4306 if ( $amount > 0 ) {
4307 C4::Overdues::UpdateFine({
4308 issue_id => $issue->issue_id,
4309 itemnumber => $issue->itemnumber,
4310 borrowernumber => $issue->borrowernumber,
4312 due => output_pref($datedue),
4315 elsif ($return_date) {
4317 # Backdated returns may have fines that shouldn't exist,
4318 # so in this case, we need to drop those fines to 0
4320 C4::Overdues::UpdateFine({
4321 issue_id => $issue->issue_id,
4322 itemnumber => $issue->itemnumber,
4323 borrowernumber => $issue->borrowernumber,
4325 due => output_pref($datedue),
4331 sub _item_denied_renewal {
4334 my $item = $params->{item};
4335 return unless $item;
4337 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4338 return unless $denyingrules;
4339 foreach my $field (keys %$denyingrules) {
4340 my $val = $item->$field;
4341 if( !defined $val) {
4342 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4345 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4346 # If the results matches the values in the syspref
4347 # We return true if match found
4360 Koha Development Team <http://koha-community.org/>