1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX qw( floor );
27 use Koha::DateUtils qw( dt_from_string output_pref );
29 use C4::Stats qw( UpdateStats );
30 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest ItemsAnyAvailableAndNotRestricted );
31 use C4::Biblio qw( UpdateTotalIssues );
32 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
34 use C4::ItemCirculationAlertPreference;
36 use C4::Log qw( logaction ); # logaction
38 use C4::RotatingCollections qw(GetCollectionItemBranches);
39 use Algorithm::CheckDigits qw( CheckDigits );
41 use Data::Dumper qw( Dumper );
43 use Koha::AuthorisedValues;
44 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
45 use Koha::Biblioitems;
46 use Koha::DateUtils qw( dt_from_string output_pref );
49 use Koha::Illrequests;
52 use Koha::Patron::Debarments qw( DelUniqueDebarment GetDebarments AddUniqueDebarment );
55 use Koha::Account::Lines;
57 use Koha::Account::Lines;
58 use Koha::Account::Offsets;
59 use Koha::Config::SysPrefs;
60 use Koha::Charges::Fees;
61 use Koha::Config::SysPref;
62 use Koha::Checkouts::ReturnClaims;
63 use Koha::SearchEngine::Indexer;
64 use Koha::Exceptions::Checkout;
68 use List::MoreUtils qw( any );
69 use Scalar::Util qw( looks_like_number );
70 use Date::Calc qw( Date_to_Days );
71 our (@ISA, @EXPORT_OK);
77 # FIXME subs that should probably be elsewhere
82 GetPendingOnSiteCheckouts
93 GetLatestAutoRenewDate
96 GetBranchBorrowerCircRule
101 CheckIfIssuedToPatron
116 IsBranchTransferAllowed
117 CreateBranchTransferLimit
118 DeleteBranchTransferLimits
124 DeleteOfflineOperation
125 ProcessOfflineOperation
126 ProcessOfflinePayment
128 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
133 C4::Circulation - Koha circulation module
141 The functions in this module deal with circulation, issues, and
142 returns, as well as general information about the library.
143 Also deals with inventory.
149 $str = &barcodedecode($barcode, [$filter]);
151 Generic filter function for barcode string.
152 Called on every circ if the System Pref itemBarcodeInputFilter is set.
153 Will do some manipulation of the barcode for systems that deliver a barcode
154 to circulation.pl that differs from the barcode stored for the item.
155 For proper functioning of this filter, calling the function on the
156 correct barcode string (items.barcode) should return an unaltered barcode.
157 Barcode is going to be automatically trimmed of leading/trailing whitespaces.
159 The optional $filter argument is to allow for testing or explicit
160 behavior that ignores the System Pref. Valid values are the same as the
165 # FIXME -- the &decode fcn below should be wrapped into this one.
166 # FIXME -- these plugins should be moved out of Circulation.pm
169 my ($barcode, $filter) = @_;
171 return unless defined $barcode;
173 my $branch = C4::Context::mybranch();
174 $barcode =~ s/^\s+|\s+$//g;
175 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
176 Koha::Plugins->call('item_barcode_transform', \$barcode );
177 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
178 if ($filter eq 'whitespace') {
180 } elsif ($filter eq 'cuecat') {
182 my @fields = split( /\./, $barcode );
183 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
184 ($#results == 2) and return $results[2];
185 } elsif ($filter eq 'T-prefix') {
186 if ($barcode =~ /^[Tt](\d)/) {
187 (defined($1) and $1 eq '0') and return $barcode;
188 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
190 return sprintf("T%07d", $barcode);
191 # FIXME: $barcode could be "T1", causing warning: substr outside of string
192 # Why drop the nonzero digit after the T?
193 # Why pass non-digits (or empty string) to "T%07d"?
194 } elsif ($filter eq 'libsuite8') {
195 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
196 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
197 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
199 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
202 } elsif ($filter eq 'EAN13') {
203 my $ean = CheckDigits('ean');
204 if ( $ean->is_valid($barcode) ) {
205 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
206 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
208 warn "# [$barcode] not valid EAN-13/UPC-A\n";
211 return $barcode; # return barcode, modified or not
216 $str = &_decode($chunk);
218 Decodes a segment of a string emitted by a CueCat barcode scanner and
221 FIXME: Should be replaced with Barcode::Cuecat from CPAN
222 or Javascript based decoding on the client side.
229 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
230 my @s = map { index( $seq, $_ ); } split( //, $encoded );
231 my $l = ( $#s + 1 ) % 4;
234 # warn "Error: Cuecat decode parsing failed!";
242 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
244 chr( ( $n >> 16 ) ^ 67 )
245 .chr( ( $n >> 8 & 255 ) ^ 67 )
246 .chr( ( $n & 255 ) ^ 67 );
249 $r = substr( $r, 0, length($r) - $l );
255 ($dotransfer, $messages, $iteminformation) = &transferbook({
256 from_branch => $frombranch
257 to_branch => $tobranch,
259 ignore_reserves => $ignore_reserves,
263 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
265 C<$fbr> is the code for the branch initiating the transfer.
266 C<$tbr> is the code for the branch to which the item should be transferred.
268 C<$barcode> is the barcode of the item to be transferred.
270 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
271 Otherwise, if an item is reserved, the transfer fails.
273 C<$trigger> is the enum value for what triggered the transfer.
275 Returns three values:
281 is true if the transfer was successful.
285 is a reference-to-hash which may have any of the following keys:
291 There is no item in the catalog with the given barcode. The value is C<$barcode>.
293 =item C<DestinationEqualsHolding>
295 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.
299 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.
303 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>.
305 =item C<WasTransferred>
307 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
309 =item C<RecallPlacedAtHoldingBranch>
311 A recall for this item was found, and the transfer has already been completed as the item's branch matches the recall's pickup branch.
315 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
325 my $tbr = $params->{to_branch};
326 my $fbr = $params->{from_branch};
327 my $ignoreRs = $params->{ignore_reserves};
328 my $barcode = $params->{barcode};
329 my $trigger = $params->{trigger};
332 my $item = Koha::Items->find( { barcode => $barcode } );
334 Koha::Exceptions::MissingParameter->throw(
335 "Missing mandatory parameter: from_branch")
338 Koha::Exceptions::MissingParameter->throw(
339 "Missing mandatory parameter: to_branch")
344 $messages->{'BadBarcode'} = $barcode;
346 return ( $dotransfer, $messages );
349 my $itemnumber = $item->itemnumber;
350 # get branches of book...
351 my $hbr = $item->homebranch;
353 # if using Branch Transfer Limits
354 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
355 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
356 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
357 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
358 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
361 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
362 $messages->{'NotAllowed'} = $tbr . "::" . $code;
367 # can't transfer book if is already there....
368 if ( $fbr eq $tbr ) {
369 $messages->{'DestinationEqualsHolding'} = 1;
373 # check if it is still issued to someone, return it...
374 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
376 AddReturn( $barcode, $fbr );
377 $messages->{'WasReturned'} = $issue->borrowernumber;
381 # That'll save a database query.
382 my ( $resfound, $resrec, undef ) =
383 CheckReserves( $itemnumber );
385 $resrec->{'ResFound'} = $resfound;
386 $messages->{'ResFound'} = $resrec;
387 $dotransfer = 0 unless $ignoreRs;
391 if ( C4::Context->preference('UseRecalls') ) {
392 my $recall = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
393 if ( defined $recall ) {
394 # do a transfer if the recall branch is different to the item holding branch
395 if ( $recall->pickup_library_id eq $fbr ) {
397 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
400 $messages->{'RecallFound'} = $recall;
405 #actually do the transfer....
407 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
409 # don't need to update MARC anymore, we do it in batch now
410 $messages->{'WasTransfered'} = $tbr;
413 ModDateLastSeen( $itemnumber );
414 return ( $dotransfer, $messages );
419 my $borrower = shift;
420 my $item_object = shift;
422 my $onsite_checkout = $params->{onsite_checkout} || 0;
423 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
424 my $cat_borrower = $borrower->{'categorycode'};
425 my $dbh = C4::Context->dbh;
426 # Get which branchcode we need
427 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
428 my $type = $item_object->effective_itemtype;
430 my ($type_object, $parent_type, $parent_maxissueqty_rule);
431 $type_object = Koha::ItemTypes->find( $type );
432 $parent_type = $type_object->parent_type if $type_object;
433 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
434 # Find any children if we are a parent_type;
436 # given branch, patron category, and item type, determine
437 # applicable issuing rule
439 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
441 categorycode => $cat_borrower,
442 itemtype => $parent_type,
443 branchcode => $branch,
444 rule_name => 'maxissueqty',
447 # If the parent rule is for default type we discount it
448 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
450 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
452 categorycode => $cat_borrower,
454 branchcode => $branch,
455 rule_name => 'maxissueqty',
459 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
461 categorycode => $cat_borrower,
463 branchcode => $branch,
464 rule_name => 'maxonsiteissueqty',
469 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
470 # if a rule is found and has a loan limit set, count
471 # how many loans the patron already has that meet that
473 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
476 if ( $maxissueqty_rule->branchcode ) {
477 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
478 $checkouts = $patron->checkouts->search(
479 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
480 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
481 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
483 $checkouts = $patron->checkouts->search(
484 { 'item.homebranch' => $maxissueqty_rule->branchcode } );
487 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
489 $checkouts = $checkouts->search(undef, { prefetch => 'item' });
492 my $rule_itemtype = $maxissueqty_rule->itemtype;
495 unless ( $rule_itemtype ) {
496 # matching rule has the default item type, so count only
497 # those existing loans that don't fall under a more
499 @types = Koha::CirculationRules->search(
501 branchcode => $maxissueqty_rule->branchcode,
502 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
503 itemtype => { '!=' => undef },
504 rule_name => 'maxissueqty'
506 )->get_column('itemtype');
508 if ( $parent_maxissueqty_rule ) {
509 # if we have a parent item type then we count loans of the
510 # specific item type or its siblings or parent
511 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
512 @types = $children->get_column('itemtype');
513 push @types, $parent_type;
514 } elsif ( $child_types ) {
515 # If we are a parent type, we need to count all child types and our own type
516 @types = $child_types->get_column('itemtype');
517 push @types, $type; # And don't forget to count our own types
519 # Otherwise only count the specific itemtype
524 while ( my $c = $checkouts->next ) {
525 my $itemtype = $c->item->effective_itemtype;
527 unless ( $rule_itemtype ) {
528 next if grep {$_ eq $itemtype} @types;
530 next unless grep {$_ eq $itemtype} @types;
533 $sum_checkouts->{total}++;
534 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
535 $sum_checkouts->{itemtype}->{$itemtype}++;
538 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
539 my $checkout_count = $sum_checkouts->{total} || 0;
540 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
542 my $checkout_rules = {
543 checkout_count => $checkout_count,
544 onsite_checkout_count => $onsite_checkout_count,
545 onsite_checkout => $onsite_checkout,
546 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
547 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
548 switch_onsite_checkout => $switch_onsite_checkout,
550 # If parent rules exists
551 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
552 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
553 my $qty_over = _check_max_qty($checkout_rules);
554 return $qty_over if defined $qty_over;
556 # If the parent rule is less than or equal to the child, we only need check the parent
557 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
558 $checkout_rules->{checkout_count} = $checkout_count_type;
559 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
560 my $qty_over = _check_max_qty($checkout_rules);
561 return $qty_over if defined $qty_over;
564 my $qty_over = _check_max_qty($checkout_rules);
565 return $qty_over if defined $qty_over;
569 # Now count total loans against the limit for the branch
570 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
571 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
573 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
574 $checkouts = $patron->checkouts->search(
575 { 'me.branchcode' => $branch} );
576 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
577 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
579 $checkouts = $patron->checkouts->search(
580 { 'item.homebranch' => $branch},
581 { prefetch => 'item' } );
584 my $checkout_count = $checkouts->count;
585 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
586 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
587 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
589 my $qty_over = _check_max_qty(
591 checkout_count => $checkout_count,
592 onsite_checkout_count => $onsite_checkout_count,
593 onsite_checkout => $onsite_checkout,
594 max_checkouts_allowed => $max_checkouts_allowed,
595 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
596 switch_onsite_checkout => $switch_onsite_checkout
599 return $qty_over if defined $qty_over;
602 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
603 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
606 # OK, the patron can issue !!!
612 my $checkout_count = $params->{checkout_count};
613 my $onsite_checkout_count = $params->{onsite_checkout_count};
614 my $onsite_checkout = $params->{onsite_checkout};
615 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
616 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
617 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
619 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
620 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
621 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
623 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
624 count => $onsite_checkout_count,
625 max_allowed => $max_onsite_checkouts_allowed,
629 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
630 if ( $max_checkouts_allowed eq '' ) { return; }
631 my $delta = $switch_onsite_checkout ? 1 : 0;
632 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
634 reason => 'TOO_MANY_CHECKOUTS',
635 count => $checkout_count,
636 max_allowed => $max_checkouts_allowed,
640 elsif ( not $onsite_checkout ) {
641 if ( $max_checkouts_allowed eq '' ) { return; }
643 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
646 reason => 'TOO_MANY_CHECKOUTS',
647 count => $checkout_count - $onsite_checkout_count,
648 max_allowed => $max_checkouts_allowed,
656 =head2 CanBookBeIssued
658 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
659 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
661 Check if a book can be issued.
663 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
665 IMPORTANT: The assumption by users of this routine is that causes blocking
666 the issue are keyed by uppercase labels and other returned
667 data is keyed in lower case!
671 =item C<$patron> is a Koha::Patron
673 =item C<$barcode> is the bar code of the book being issued.
675 =item C<$duedates> is a DateTime object.
677 =item C<$inprocess> boolean switch
679 =item C<$ignore_reserves> boolean switch
681 =item C<$params> Hashref of additional parameters
684 override_high_holds - Ignore high holds
685 onsite_checkout - Checkout is an onsite checkout that will not leave the library
693 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
694 Possible values are :
700 sticky due date is invalid
704 borrower gone with no address
708 borrower declared it's card lost
714 =head3 UNKNOWN_BARCODE
728 item is restricted (set by ??)
730 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
731 could be prevented, but ones that can be overriden by the operator.
733 Possible values are :
741 renewing, not issuing
743 =head3 ISSUED_TO_ANOTHER
745 issued to someone else.
749 reserved for someone else.
753 reserved and being transferred for someone else.
757 sticky due date is invalid or due date in the past
761 if the borrower borrows to much things
765 recalled by someone else
769 sub CanBookBeIssued {
770 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
771 my %needsconfirmation; # filled with problems that needs confirmations
772 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
773 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
774 my %messages; # filled with information messages that should be displayed.
776 my $onsite_checkout = $params->{onsite_checkout} || 0;
777 my $override_high_holds = $params->{override_high_holds} || 0;
779 my $item_object = Koha::Items->find({barcode => $barcode });
781 # MANDATORY CHECKS - unless item exists, nothing else matters
782 unless ( $item_object ) {
783 $issuingimpossible{UNKNOWN_BARCODE} = 1;
785 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
787 my $item_unblessed = $item_object->unblessed; # Transition...
788 my $issue = $item_object->checkout;
789 my $biblio = $item_object->biblio;
791 my $biblioitem = $biblio->biblioitem;
792 my $effective_itemtype = $item_object->effective_itemtype;
793 my $dbh = C4::Context->dbh;
794 my $patron_unblessed = $patron->unblessed;
796 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
798 my $now = dt_from_string();
799 $duedate ||= CalcDateDue( $now, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
800 if (DateTime->compare($duedate,$now) == -1 ) { # duedate cannot be before now
801 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
804 my $fees = Koha::Charges::Fees->new(
807 library => $circ_library,
808 item => $item_object,
816 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
817 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
818 C4::Stats::UpdateStats({
819 branch => C4::Context->userenv->{'branch'},
821 itemnumber => $item_object->itemnumber,
822 itemtype => $effective_itemtype,
823 borrowernumber => $patron->borrowernumber,
824 ccode => $item_object->ccode}
826 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
827 return( { STATS => 1 }, {});
830 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
831 $issuingimpossible{GNA} = 1;
834 if ( $patron->lost && $patron->lost == 1 ) {
835 $issuingimpossible{CARD_LOST} = 1;
837 if ( $patron->is_debarred ) {
838 $issuingimpossible{DEBARRED} = 1;
841 if ( $patron->is_expired ) {
842 $issuingimpossible{EXPIRED} = 1;
850 my $account = $patron->account;
851 my $balance = $account->balance;
852 my $non_issues_charges = $account->non_issues_charges;
853 my $other_charges = $balance - $non_issues_charges;
855 my $amountlimit = C4::Context->preference("noissuescharge");
856 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
857 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
859 # Check the debt of this patrons guarantees
860 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
861 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
862 if ( defined $no_issues_charge_guarantees ) {
863 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
864 my $guarantees_non_issues_charges = 0;
865 foreach my $g ( @guarantees ) {
866 $guarantees_non_issues_charges += $g->account->non_issues_charges;
869 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
870 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
871 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
872 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
873 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
874 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
878 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
879 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
880 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
881 if ( defined $no_issues_charge_guarantors ) {
882 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
884 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
885 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
886 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
887 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
888 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
889 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
893 if ( C4::Context->preference("IssuingInProcess") ) {
894 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
895 $issuingimpossible{DEBT} = $non_issues_charges;
896 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
897 $needsconfirmation{DEBT} = $non_issues_charges;
898 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
899 $needsconfirmation{DEBT} = $non_issues_charges;
903 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
904 $needsconfirmation{DEBT} = $non_issues_charges;
905 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
906 $issuingimpossible{DEBT} = $non_issues_charges;
907 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
908 $needsconfirmation{DEBT} = $non_issues_charges;
912 if ($balance > 0 && $other_charges > 0) {
913 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
916 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
917 $patron_unblessed = $patron->unblessed;
919 if ( my $debarred_date = $patron->is_debarred ) {
920 # patron has accrued fine days or has a restriction. $count is a date
921 if ($debarred_date eq '9999-12-31') {
922 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
925 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
927 } elsif ( my $num_overdues = $patron->has_overdues ) {
928 ## patron has outstanding overdue loans
929 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
930 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
932 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
933 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
937 # Additional Materials Check
938 if ( C4::Context->preference("CircConfirmItemParts")
939 && $item_object->materials )
941 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
945 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
947 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
949 # Already issued to current borrower.
950 # If it is an on-site checkout if it can be switched to a normal checkout
951 # or ask whether the loan should be renewed
953 if ( $issue->onsite_checkout
954 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
955 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
957 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
958 $patron->borrowernumber,
959 $item_object->itemnumber,
961 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
962 if ( $renewerror eq 'onsite_checkout' ) {
963 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
966 $issuingimpossible{NO_MORE_RENEWALS} = 1;
970 $needsconfirmation{RENEW_ISSUE} = 1;
976 # issued to someone else
978 my $patron = Koha::Patrons->find( $issue->borrowernumber );
980 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
982 unless ( $can_be_returned ) {
983 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
984 $issuingimpossible{branch_to_return} = $message;
986 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
987 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
989 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
990 $needsconfirmation{issued_firstname} = $patron->firstname;
991 $needsconfirmation{issued_surname} = $patron->surname;
992 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
993 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
998 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1000 my $switch_onsite_checkout = (
1001 C4::Context->preference('SwitchOnSiteCheckouts')
1003 and $issue->onsite_checkout
1004 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1005 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1006 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1007 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1008 if ( $toomany->{max_allowed} == 0 ) {
1009 $needsconfirmation{PATRON_CANT} = 1;
1011 if ( C4::Context->preference("AllowTooManyOverride") ) {
1012 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1013 $needsconfirmation{current_loan_count} = $toomany->{count};
1014 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1016 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1017 $issuingimpossible{current_loan_count} = $toomany->{count};
1018 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1023 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1025 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1026 my $wants_check = $patron->wants_check_for_previous_checkout;
1027 $needsconfirmation{PREVISSUE} = 1
1028 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1033 if ( $item_object->notforloan )
1035 if(!C4::Context->preference("AllowNotForLoanOverride")){
1036 $issuingimpossible{NOT_FOR_LOAN} = 1;
1037 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1039 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1040 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1044 # we have to check itemtypes.notforloan also
1045 if (C4::Context->preference('item-level_itypes')){
1046 # this should probably be a subroutine
1047 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1048 $sth->execute($effective_itemtype);
1049 my $notforloan=$sth->fetchrow_hashref();
1050 if ($notforloan->{'notforloan'}) {
1051 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1052 $issuingimpossible{NOT_FOR_LOAN} = 1;
1053 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1055 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1056 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1061 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1062 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1063 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1064 $issuingimpossible{NOT_FOR_LOAN} = 1;
1065 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1067 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1068 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1073 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1075 $issuingimpossible{WTHDRAWN} = 1;
1077 if ( $item_object->restricted
1078 && $item_object->restricted == 1 )
1080 $issuingimpossible{RESTRICTED} = 1;
1082 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1083 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1084 my $code = $av->count ? $av->next->lib : '';
1085 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1086 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1088 if ( C4::Context->preference("IndependentBranches") ) {
1089 my $userenv = C4::Context->userenv;
1090 unless ( C4::Context->IsSuperLibrarian() ) {
1091 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1092 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1093 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1094 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1096 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1097 if ( $patron->branchcode ne $userenv->{branch} );
1102 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1104 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1105 if ($rentalConfirmation) {
1106 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1108 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1109 if ($itemtype_object) {
1110 my $accumulate_charge = $fees->accumulate_rentalcharge();
1111 if ( $accumulate_charge > 0 ) {
1112 $rentalCharge += $accumulate_charge;
1116 if ( $rentalCharge > 0 ) {
1117 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1122 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1123 # Only bother doing this if UseRecalls is enabled and the item is recallable
1124 # Don't look at recalls that are in transit
1125 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1126 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1128 foreach my $r ( @recalls ) {
1129 if ( $r->item_id and
1130 $r->item_id == $item_object->itemnumber and
1131 $r->patron_id == $patron->borrowernumber and
1132 ( $r->waiting or $r->requested ) ) {
1133 $messages{RECALLED} = $r->id;
1135 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1138 elsif ( $r->item_id and
1139 $r->item_id == $item_object->itemnumber and
1141 # recalled item is in transit
1142 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1144 elsif ( $r->item_level and
1145 $r->item_id == $item_object->itemnumber and
1146 $r->patron_id != $patron->borrowernumber and
1148 # this specific item has been recalled by a different patron
1149 $needsconfirmation{RECALLED} = $r;
1153 elsif ( !$r->item_level and
1154 $r->patron_id != $patron->borrowernumber and
1156 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1157 $needsconfirmation{RECALLED} = $r;
1164 unless ( $ignore_reserves and defined $recall ) {
1165 # See if the item is on reserve.
1166 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1168 my $resbor = $res->{'borrowernumber'};
1169 if ( $resbor ne $patron->borrowernumber ) {
1170 my $patron = Koha::Patrons->find( $resbor );
1171 if ( $restype eq "Waiting" )
1173 # The item is on reserve and waiting, but has been
1174 # reserved by some other patron.
1175 $needsconfirmation{RESERVE_WAITING} = 1;
1176 $needsconfirmation{'resfirstname'} = $patron->firstname;
1177 $needsconfirmation{'ressurname'} = $patron->surname;
1178 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1179 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1180 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1181 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1182 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1184 elsif ( $restype eq "Reserved" ) {
1185 # The item is on reserve for someone else.
1186 $needsconfirmation{RESERVED} = 1;
1187 $needsconfirmation{'resfirstname'} = $patron->firstname;
1188 $needsconfirmation{'ressurname'} = $patron->surname;
1189 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1190 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1191 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1192 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1193 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1195 elsif ( $restype eq "Transferred" ) {
1196 # The item is determined hold being transferred for someone else.
1197 $needsconfirmation{TRANSFERRED} = 1;
1198 $needsconfirmation{'resfirstname'} = $patron->firstname;
1199 $needsconfirmation{'ressurname'} = $patron->surname;
1200 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1201 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1202 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1203 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1204 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1206 elsif ( $restype eq "Processing" ) {
1207 # The item is determined hold being processed for someone else.
1208 $needsconfirmation{PROCESSING} = 1;
1209 $needsconfirmation{'resfirstname'} = $patron->firstname;
1210 $needsconfirmation{'ressurname'} = $patron->surname;
1211 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1212 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1213 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1214 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1215 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1221 ## CHECK AGE RESTRICTION
1222 my $agerestriction = $biblioitem->agerestriction;
1223 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1224 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1225 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1226 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1229 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1233 ## check for high holds decreasing loan period
1234 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1235 my $check = checkHighHolds( $item_object, $patron );
1237 if ( $check->{exceeded} ) {
1238 if ($override_high_holds) {
1239 $alerts{HIGHHOLDS} = {
1240 num_holds => $check->{outstanding},
1241 duration => $check->{duration},
1242 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1246 $needsconfirmation{HIGHHOLDS} = {
1247 num_holds => $check->{outstanding},
1248 duration => $check->{duration},
1249 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1256 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1257 # don't do the multiple loans per bib check if we've
1258 # already determined that we've got a loan on the same item
1259 !$issuingimpossible{NO_MORE_RENEWALS} &&
1260 !$needsconfirmation{RENEW_ISSUE}
1262 # Check if borrower has already issued an item from the same biblio
1263 # Only if it's not a subscription
1264 my $biblionumber = $item_object->biblionumber;
1265 require C4::Serials;
1266 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1267 unless ($is_a_subscription) {
1268 # FIXME Should be $patron->checkouts($args);
1269 my $checkouts = Koha::Checkouts->search(
1271 borrowernumber => $patron->borrowernumber,
1272 biblionumber => $biblionumber,
1278 # if we get here, we don't already have a loan on this item,
1279 # so if there are any loans on this bib, ask for confirmation
1280 if ( $checkouts->count ) {
1281 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1286 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1289 =head2 CanBookBeReturned
1291 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1293 Check whether the item can be returned to the provided branch
1297 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1299 =item C<$branch> is the branchcode where the return is taking place
1307 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1309 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1315 sub CanBookBeReturned {
1316 my ($item, $branch) = @_;
1317 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1319 # assume return is allowed to start
1323 # identify all cases where return is forbidden
1324 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1326 $message = $item->{'homebranch'};
1327 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1329 $message = $item->{'holdingbranch'};
1330 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1332 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1335 return ($allowed, $message);
1338 =head2 CheckHighHolds
1340 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1341 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1342 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1346 sub checkHighHolds {
1347 my ( $item, $patron ) = @_;
1348 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1357 my $holds = Koha::Holds->search( { biblionumber => $item->biblionumber } );
1359 if ( $holds->count() ) {
1360 $return_data->{outstanding} = $holds->count();
1362 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1363 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1364 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1366 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1368 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1370 # static means just more than a given number of holds on the record
1372 # If the number of holds is less than the threshold, we can stop here
1373 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1374 return $return_data;
1377 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1379 # dynamic means X more than the number of holdable items on the record
1381 # let's get the items
1382 my @items = $holds->next()->biblio()->items()->as_list;
1384 # Remove any items with status defined to be ignored even if the would not make item unholdable
1385 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1386 @items = grep { !$_->$status } @items;
1389 # Remove any items that are not holdable for this patron
1390 @items = grep { CanItemBeReserved( $patron , $_, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1392 my $items_count = scalar @items;
1394 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1396 # If the number of holds is less than the count of items we have
1397 # plus the number of holds allowed above that count, we can stop here
1398 if ( $holds->count() <= $threshold ) {
1399 return $return_data;
1403 my $issuedate = dt_from_string();
1405 my $itype = $item->effective_itemtype;
1406 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1408 categorycode => $patron->categorycode,
1410 branchcode => $branchcode,
1413 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1415 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1417 my $rule = Koha::CirculationRules->get_effective_rule_value(
1419 categorycode => $patron->categorycode,
1420 itemtype => $item->effective_itemtype,
1421 branchcode => $branchcode,
1422 rule_name => 'decreaseloanholds',
1427 if ( defined($rule) && $rule ne '' ){
1428 # overrides decreaseLoanHighHoldsDuration syspref
1431 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1433 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1434 $reduced_datedue->set_hour($orig_due->hour);
1435 $reduced_datedue->set_minute($orig_due->minute);
1436 $reduced_datedue->truncate( to => 'minute' );
1438 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1439 $return_data->{exceeded} = 1;
1440 $return_data->{duration} = $duration;
1441 $return_data->{due_date} = $reduced_datedue;
1445 return $return_data;
1450 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1452 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1456 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1458 =item C<$barcode> is the barcode of the item being issued.
1460 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1461 Calculated if empty.
1463 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1465 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1466 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1468 AddIssue does the following things :
1470 - step 01: check that there is a borrowernumber & a barcode provided
1471 - check for RENEWAL (book issued & being issued to the same patron)
1472 - renewal YES = Calculate Charge & renew
1474 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1476 - fill reserve if reserve to this patron
1477 - cancel reserve or not, otherwise
1479 - fill recall if recall to this patron
1480 - cancel recall or not
1481 - revert recall's waiting status or not
1482 * TRANSFERT PENDING ?
1483 - complete the transfert
1491 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1493 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1494 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1495 my $auto_renew = $params && $params->{auto_renew};
1496 my $cancel_recall = $params && $params->{cancel_recall};
1497 my $recall_id = $params && $params->{recall_id};
1498 my $dbh = C4::Context->dbh;
1499 my $barcodecheck = CheckValidBarcode($barcode);
1503 if ( $datedue && ref $datedue ne 'DateTime' ) {
1504 $datedue = dt_from_string($datedue);
1507 # $issuedate defaults to today.
1508 if ( !defined $issuedate ) {
1509 $issuedate = dt_from_string();
1512 if ( ref $issuedate ne 'DateTime' ) {
1513 $issuedate = dt_from_string($issuedate);
1518 # Stop here if the patron or barcode doesn't exist
1519 if ( $borrower && $barcode && $barcodecheck ) {
1520 # find which item we issue
1521 my $item_object = Koha::Items->find({ barcode => $barcode })
1522 or return; # if we don't get an Item, abort.
1523 my $item_unblessed = $item_object->unblessed;
1525 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1527 # get actual issuing if there is one
1528 my $actualissue = $item_object->checkout;
1530 # check if we just renew the issue.
1531 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1532 and not $switch_onsite_checkout ) {
1533 $datedue = AddRenewal(
1534 $borrower->{'borrowernumber'},
1535 $item_object->itemnumber,
1538 $issuedate, # here interpreted as the renewal date
1543 my $itype = $item_object->effective_itemtype;
1544 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1548 # Check if we need to use an exact due date set by the ILL module
1549 if ( C4::Context->preference('ILLModule') ) {
1550 # Check if there is an ILL connected with the biblio of the item we are issuing
1551 my $ill_request = Koha::Illrequests->search({
1552 biblio_id => $item_object->biblionumber,
1553 borrowernumber => $borrower->{'borrowernumber'},
1555 due_date => { '!=', undef },
1558 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1559 my $ill_dt = dt_from_string( $ill_request->due_date );
1560 $ill_dt->set_hour(23);
1561 $ill_dt->set_minute(59);
1566 $datedue->truncate( to => 'minute' );
1568 my $patron = Koha::Patrons->find( $borrower );
1569 my $library = Koha::Libraries->find( $branchcode );
1570 my $fees = Koha::Charges::Fees->new(
1573 library => $library,
1574 item => $item_object,
1575 to_date => $datedue,
1579 # it's NOT a renewal
1580 if ( $actualissue and not $switch_onsite_checkout ) {
1581 # This book is currently on loan, but not to the person
1582 # who wants to borrow it now. mark it returned before issuing to the new borrower
1583 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1584 return unless $allowed;
1585 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1586 # AddReturn certainly has side-effects, like onloan => undef
1587 $item_object->discard_changes;
1590 if ( C4::Context->preference('UseRecalls') ) {
1591 Koha::Recalls->move_recall(
1593 action => $cancel_recall,
1594 recall_id => $recall_id,
1595 item => $item_object,
1596 borrowernumber => $borrower->{borrowernumber},
1601 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1603 # Starting process for transfer job (checking transfert and validate it if we have one)
1604 if ( my $transfer = $item_object->get_transfer ) {
1605 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1608 datearrived => dt_from_string,
1609 tobranch => C4::Context->userenv->{branch},
1610 comments => 'Forced branchtransfer'
1613 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1614 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1615 if ( $hold ) { # Is this really needed?
1616 $hold->set( { found => undef } )->store;
1617 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1622 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1623 unless ($auto_renew) {
1624 my $rule = Koha::CirculationRules->get_effective_rule_value(
1626 categorycode => $borrower->{categorycode},
1627 itemtype => $item_object->effective_itemtype,
1628 branchcode => $branchcode,
1629 rule_name => 'auto_renew'
1633 $auto_renew = $rule if defined $rule && $rule ne '';
1636 my $issue_attributes = {
1637 borrowernumber => $borrower->{'borrowernumber'},
1638 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1639 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1640 branchcode => C4::Context->userenv->{'branch'},
1641 onsite_checkout => $onsite_checkout,
1642 auto_renew => $auto_renew ? 1 : 0,
1645 # Get ID of logged in user. if called from a batch job,
1646 # no user session exists and C4::Context->userenv() returns
1647 # the scalar '0'. Only do this if the syspref says so
1648 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1649 my $userenv = C4::Context->userenv();
1650 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1652 $issue_attributes->{issuer_id} = $usernumber;
1656 # In the case that the borrower has an on-site checkout
1657 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1658 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1660 $issue->set($issue_attributes)->store;
1663 $issue = Koha::Checkout->new(
1665 itemnumber => $item_object->itemnumber,
1670 $issue->discard_changes;
1671 C4::Auth::track_login_daily( $borrower->{userid} );
1672 if ( $item_object->location && $item_object->location eq 'CART'
1673 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1674 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1675 CartToShelf( $item_object->itemnumber );
1678 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1679 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1682 # Record if item was lost
1683 my $was_lost = $item_object->itemlost;
1685 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1686 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1687 $item_object->itemlost(0);
1688 $item_object->onloan($datedue->ymd());
1689 $item_object->datelastborrowed( dt_from_string()->ymd() );
1690 $item_object->datelastseen( dt_from_string()->ymd() );
1691 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1693 # If the item was lost, it has now been found, charge the overdue if necessary
1695 if ( $item_object->{_charge} ) {
1696 $actualissue //= Koha::Old::Checkouts->search(
1697 { itemnumber => $item_unblessed->{itemnumber} },
1699 order_by => { '-desc' => 'returndate' },
1703 unless ( exists( $borrower->{branchcode} ) ) {
1704 my $patron = $actualissue->patron;
1705 $borrower = $patron->unblessed;
1707 _CalculateAndUpdateFine(
1709 issue => $actualissue,
1710 item => $item_unblessed,
1711 borrower => $borrower,
1712 return_date => $issuedate
1715 _FixOverduesOnReturn( $borrower->{borrowernumber},
1716 $item_object->itemnumber, undef, 'RENEWED' );
1720 # If it costs to borrow this book, charge it to the patron's account.
1721 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1722 if ( $charge && $charge > 0 ) {
1723 AddIssuingCharge( $issue, $charge, 'RENT' );
1726 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1727 if ( $itemtype_object ) {
1728 my $accumulate_charge = $fees->accumulate_rentalcharge();
1729 if ( $accumulate_charge > 0 ) {
1730 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1731 $charge += $accumulate_charge;
1732 $item_unblessed->{charge} = $charge;
1736 # Record the fact that this book was issued.
1737 C4::Stats::UpdateStats(
1739 branch => C4::Context->userenv->{'branch'},
1740 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1742 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1743 itemnumber => $item_object->itemnumber,
1744 itemtype => $item_object->effective_itemtype,
1745 location => $item_object->location,
1746 borrowernumber => $borrower->{'borrowernumber'},
1747 ccode => $item_object->ccode,
1751 # Send a checkout slip.
1752 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1754 branchcode => $branchcode,
1755 categorycode => $borrower->{categorycode},
1756 item_type => $item_object->effective_itemtype,
1757 notification => 'CHECKOUT',
1759 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1760 SendCirculationAlert(
1763 item => $item_object->unblessed,
1764 borrower => $borrower,
1765 branch => $branchcode,
1770 "CIRCULATION", "ISSUE",
1771 $borrower->{'borrowernumber'},
1772 $item_object->itemnumber,
1773 ) if C4::Context->preference("IssueLog");
1775 Koha::Plugins->call('after_circ_action', {
1776 action => 'checkout',
1778 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1779 checkout => $issue->get_from_storage
1783 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1785 biblio_ids => [ $item_object->biblionumber ]
1787 ) if C4::Context->preference('RealTimeHoldsQueue');
1793 =head2 GetLoanLength
1795 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1797 Get loan length for an itemtype, a borrower type and a branch
1802 my ( $categorycode, $itemtype, $branchcode ) = @_;
1804 # Initialize default values
1808 lengthunit => 'days',
1811 my $found = Koha::CirculationRules->get_effective_rules( {
1812 branchcode => $branchcode,
1813 categorycode => $categorycode,
1814 itemtype => $itemtype,
1823 foreach my $rule_name (keys %$found) {
1824 $rules->{$rule_name} = $found->{$rule_name};
1831 =head2 GetHardDueDate
1833 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1835 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1839 sub GetHardDueDate {
1840 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1842 my $rules = Koha::CirculationRules->get_effective_rules(
1844 categorycode => $borrowertype,
1845 itemtype => $itemtype,
1846 branchcode => $branchcode,
1847 rules => [ 'hardduedate', 'hardduedatecompare' ],
1851 if ( defined( $rules->{hardduedate} ) ) {
1852 if ( $rules->{hardduedate} ) {
1853 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1856 return ( undef, undef );
1861 =head2 GetBranchBorrowerCircRule
1863 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1865 Retrieves circulation rule attributes that apply to the given
1866 branch and patron category, regardless of item type.
1867 The return value is a hashref containing the following key:
1869 patron_maxissueqty - maximum number of loans that a
1870 patron of the given category can have at the given
1871 branch. If the value is undef, no limit.
1873 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1874 patron of the given category can have at the given
1875 branch. If the value is undef, no limit.
1877 This will check for different branch/category combinations in the following order:
1881 default branch and category
1883 If no rule has been found in the database, it will default to
1886 patron_maxissueqty - undef
1887 patron_maxonsiteissueqty - undef
1889 C<$branchcode> and C<$categorycode> should contain the
1890 literal branch code and patron category code, respectively - no
1895 sub GetBranchBorrowerCircRule {
1896 my ( $branchcode, $categorycode ) = @_;
1898 # Initialize default values
1900 patron_maxissueqty => undef,
1901 patron_maxonsiteissueqty => undef,
1905 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1906 my $rule = Koha::CirculationRules->get_effective_rule(
1908 categorycode => $categorycode,
1910 branchcode => $branchcode,
1911 rule_name => $rule_name,
1915 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1921 =head2 GetBranchItemRule
1923 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1925 Retrieves circulation rule attributes that apply to the given
1926 branch and item type, regardless of patron category.
1928 The return value is a hashref containing the following keys:
1930 holdallowed => Hold policy for this branch and itemtype. Possible values:
1931 not_allowed: No holds allowed.
1932 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1933 from_any_library: Holds allowed from any patron.
1934 from_local_hold_group: Holds allowed from libraries in hold group
1936 returnbranch => branch to which to return item. Possible values:
1937 noreturn: do not return, let item remain where checked in (floating collections)
1938 homebranch: return to item's home branch
1939 holdingbranch: return to issuer branch
1941 This searches branchitemrules in the following order:
1943 * Same branchcode and itemtype
1944 * Same branchcode, itemtype '*'
1945 * branchcode '*', same itemtype
1946 * branchcode and itemtype '*'
1948 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1952 sub GetBranchItemRule {
1953 my ( $branchcode, $itemtype ) = @_;
1956 my $rules = Koha::CirculationRules->get_effective_rules({
1957 branchcode => $branchcode,
1958 itemtype => $itemtype,
1959 rules => ['holdallowed', 'hold_fulfillment_policy', 'returnbranch']
1962 # built-in default circulation rule
1963 $rules->{holdallowed} //= 'from_any_library';
1964 $rules->{hold_fulfillment_policy} //= 'any';
1965 $rules->{returnbranch} //= 'homebranch';
1972 ($doreturn, $messages, $iteminformation, $borrower) =
1973 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1979 =item C<$barcode> is the bar code of the book being returned.
1981 =item C<$branch> is the code of the branch where the book is being returned.
1983 =item C<$exemptfine> indicates that overdue charges for the item will be
1986 =item C<$return_date> allows the default return date to be overridden
1987 by the given return date. Optional.
1991 C<&AddReturn> returns a list of four items:
1993 C<$doreturn> is true iff the return succeeded.
1995 C<$messages> is a reference-to-hash giving feedback on the operation.
1996 The keys of the hash are:
2002 No item with this barcode exists. The value is C<$barcode>.
2006 The book is not currently on loan. The value is C<$barcode>.
2010 This book has been withdrawn/cancelled. The value should be ignored.
2012 =item C<Wrongbranch>
2014 This book has was returned to the wrong branch. The value is a hashref
2015 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2016 contain the branchcode of the incorrect and correct return library, respectively.
2020 The item was reserved. The value is a reference-to-hash whose keys are
2021 fields from the reserves table of the Koha database, and
2022 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2023 either C<Waiting>, C<Reserved>, or 0.
2025 =item C<WasReturned>
2027 Value 1 if return is successful.
2029 =item C<NeedsTransfer>
2031 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2033 =item C<RecallFound>
2035 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2036 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2039 =item C<TransferredRecall>
2041 This item has been transferred to this branch to fill a recall. The recall object is returned.
2045 C<$iteminformation> is a reference-to-hash, giving information about the
2046 returned item from the issues table.
2048 C<$borrower> is a reference-to-hash, giving information about the
2049 patron who last borrowed the book.
2054 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2056 if ($branch and not Koha::Libraries->find($branch)) {
2057 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2060 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2061 my $return_date_specified = !!$return_date;
2062 $return_date //= dt_from_string();
2066 my $validTransfer = 1;
2067 my $stat_type = 'return';
2069 # get information on item
2070 my $item = Koha::Items->find({ barcode => $barcode });
2072 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2075 my $itemnumber = $item->itemnumber;
2076 my $itemtype = $item->effective_itemtype;
2078 my $issue = $item->checkout;
2080 $patron = $issue->patron
2081 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2082 . Dumper($issue->unblessed) . "\n";
2084 $messages->{'NotIssued'} = $barcode;
2085 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2087 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2089 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2090 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2091 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2092 $messages->{'LocalUse'} = 1;
2093 $stat_type = 'localuse';
2097 # full item data, but no borrowernumber or checkout info (no issue)
2098 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2099 # get the proper branch to which to return the item
2100 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2101 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2102 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2104 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2105 my $patron_unblessed = $patron ? $patron->unblessed : {};
2107 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2108 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2109 if ($update_loc_rules) {
2110 if (defined $update_loc_rules->{_ALL_}) {
2111 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2112 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2114 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2115 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2117 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2118 $item->location($update_loc_rules->{_ALL_})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2122 foreach my $key ( keys %$update_loc_rules ) {
2123 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2124 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2125 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2126 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2127 $item->location($update_loc_rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2134 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2136 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2138 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2140 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2143 foreach my $key ( keys %$rules ) {
2144 if ( $item->notforloan eq $key ) {
2145 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2146 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2153 # check if the return is allowed at this branch
2154 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2155 unless ($returnallowed){
2156 $messages->{'Wrongbranch'} = {
2157 Wrongbranch => $branch,
2158 Rightbranch => $message
2161 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2162 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2163 return ( $doreturn, $messages, $issue, $patron_unblessed);
2166 if ( $item->withdrawn ) { # book has been cancelled
2167 $messages->{'withdrawn'} = 1;
2168 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2171 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2175 # case of a return of document (deal with issues and holdingbranch)
2177 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2178 $patron or warn "AddReturn without current borrower";
2182 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2187 C4::Context->preference('CalculateFinesOnReturn')
2188 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2193 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2196 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 );
2198 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2199 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2201 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2204 # FIXME is the "= 1" right? This could be the borrower hash.
2205 $messages->{'WasReturned'} = 1;
2208 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2212 # the holdingbranch is updated if the document is returned to another location.
2213 # this is always done regardless of whether the item was on loan or not
2214 if ($item->holdingbranch ne $branch) {
2215 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2218 my $item_was_lost = $item->itemlost;
2219 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2220 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2222 # fix up the accounts.....
2223 if ($item_was_lost) {
2224 $messages->{'WasLost'} = 1;
2225 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2226 my @object_messages = @{ $updated_item->object_messages };
2227 for my $message (@object_messages) {
2228 $messages->{'LostItemFeeRefunded'} = 1
2229 if $message->message eq 'lost_refunded';
2230 $messages->{'LostItemFeeRestored'} = 1
2231 if $message->message eq 'lost_restored';
2233 if ( $message->message eq 'lost_charge' ) {
2234 $issue //= Koha::Old::Checkouts->search(
2235 { itemnumber => $item->itemnumber },
2236 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2238 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2239 my $patron = $issue->patron;
2240 $patron_unblessed = $patron->unblessed;
2242 _CalculateAndUpdateFine(
2245 item => $item->unblessed,
2246 borrower => $patron_unblessed,
2247 return_date => $return_date
2250 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2251 $item->itemnumber, undef, 'RETURNED' );
2252 $messages->{'LostItemFeeCharged'} = 1;
2258 # check if we have a transfer for this document
2259 my $transfer = $item->get_transfer;
2261 # if we have a transfer to complete, we update the line of transfers with the datearrived
2264 if ( $transfer->in_transit ) {
2265 if ( $transfer->tobranch eq $branch ) {
2267 $messages->{'TransferArrived'} = $transfer->frombranch;
2268 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2269 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2272 $messages->{'WrongTransfer'} = $transfer->tobranch;
2273 $messages->{'WrongTransferItem'} = $item->itemnumber;
2274 $messages->{'TransferTrigger'} = $transfer->reason;
2278 if ( $transfer->tobranch eq $branch ) {
2280 $messages->{'TransferArrived'} = $transfer->frombranch;
2281 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2282 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2285 $messages->{'WasTransfered'} = $transfer->tobranch;
2286 $messages->{'TransferTrigger'} = $transfer->reason;
2291 # fix up the overdues in accounts...
2292 if ($borrowernumber) {
2293 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2294 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2296 if ( $issue and $issue->is_overdue($return_date) ) {
2298 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2300 $messages->{'PrevDebarred'} = $debardate;
2302 $messages->{'Debarred'} = $debardate if $debardate;
2304 # there's no overdue on the item but borrower had been previously debarred
2305 } elsif ( $issue->date_due and $patron->debarred ) {
2306 if ( $patron->debarred eq "9999-12-31") {
2307 $messages->{'ForeverDebarred'} = $patron->debarred;
2309 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2310 $borrower_debar_dt->truncate(to => 'day');
2311 my $today_dt = $return_date->clone()->truncate(to => 'day');
2312 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2313 $messages->{'PrevDebarred'} = $patron->debarred;
2320 if ( C4::Context->preference('UseRecalls') ) {
2321 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2323 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2324 if ( defined $recall ) {
2325 $messages->{RecallFound} = $recall;
2326 if ( $recall->pickup_library_id ne $branch ) {
2327 $messages->{RecallNeedsTransfer} = $branch;
2332 # find reserves.....
2333 # launch the Checkreserves routine to find any holds
2334 my ($resfound, $resrec);
2335 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2336 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2337 # 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)
2338 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2339 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2340 $resfound = 'Reserved';
2341 $resrec = $hold->unblessed;
2344 $resrec->{'ResFound'} = $resfound;
2345 $messages->{'ResFound'} = $resrec;
2348 # Record the fact that this book was returned.
2349 C4::Stats::UpdateStats({
2352 itemnumber => $itemnumber,
2353 itemtype => $itemtype,
2354 location => $item->location,
2355 borrowernumber => $borrowernumber,
2356 ccode => $item->ccode,
2359 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2361 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2363 branchcode => $branch,
2364 categorycode => $patron->categorycode,
2365 item_type => $itemtype,
2366 notification => 'CHECKIN',
2368 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2369 SendCirculationAlert({
2371 item => $item->unblessed,
2372 borrower => $patron->unblessed,
2378 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2379 if C4::Context->preference("ReturnLog");
2382 # Check if this item belongs to a biblio record that is attached to an
2383 # ILL request, if it is we need to update the ILL request's status
2384 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2385 my $request = Koha::Illrequests->find(
2386 { biblio_id => $item->biblio->biblionumber }
2388 $request->status('RET') if $request;
2391 if ( C4::Context->preference('UseRecalls') ) {
2392 # all recalls that have triggered a transfer will have an allocated itemnumber
2393 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2394 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2395 $messages->{TransferredRecall} = $transfer_recall;
2399 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2400 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2401 && ( $doreturn or $messages->{'NotIssued'} )
2403 and ( $branch ne $returnbranch )
2404 and not $messages->{'WrongTransfer'}
2405 and not $messages->{'WasTransfered'}
2406 and not $messages->{TransferredRecall}
2407 and not $messages->{RecallNeedsTransfer} )
2409 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2410 if (C4::Context->preference("AutomaticItemReturn" ) or
2411 (C4::Context->preference("UseBranchTransferLimits") and
2412 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2414 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2415 $messages->{'WasTransfered'} = $returnbranch;
2416 $messages->{'TransferTrigger'} = $transfer_trigger;
2418 $messages->{'NeedsTransfer'} = $returnbranch;
2419 $messages->{'TransferTrigger'} = $transfer_trigger;
2423 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2424 my $claims = Koha::Checkouts::ReturnClaims->search(
2426 itemnumber => $item->id,
2427 resolution => undef,
2431 if ( $claims->count ) {
2432 $messages->{ReturnClaims} = $claims;
2436 # Check for bundle status
2437 if ( $item->in_bundle ) {
2438 my $host = $item->bundle_host;
2439 $messages->{InBundle} = $host;
2442 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2443 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2445 if ( $doreturn and $issue ) {
2446 my $checkin = Koha::Old::Checkouts->find($issue->id);
2448 Koha::Plugins->call('after_circ_action', {
2449 action => 'checkin',
2455 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2457 biblio_ids => [ $item->biblionumber ]
2459 ) if C4::Context->preference('RealTimeHoldsQueue');
2462 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2465 =head2 MarkIssueReturned
2467 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2469 Unconditionally marks an issue as being returned by
2470 moving the C<issues> row to C<old_issues> and
2471 setting C<returndate> to the current date.
2473 if C<$returndate> is specified (in iso format), it is used as the date
2476 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2477 the old_issue is immediately anonymised
2479 Ideally, this function would be internal to C<C4::Circulation>,
2480 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2481 and offline_circ/process_koc.pl.
2483 The last optional parameter allos passing skip_record_index to the item store call.
2487 sub MarkIssueReturned {
2488 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2490 # Retrieve the issue
2491 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2493 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2495 my $issue_id = $issue->issue_id;
2497 my $schema = Koha::Database->schema;
2499 # FIXME Improve the return value and handle it from callers
2500 $schema->txn_do(sub {
2502 my $patron = Koha::Patrons->find( $borrowernumber );
2504 # Update the returndate value
2505 if ( $returndate ) {
2506 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2509 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2512 # Create the old_issues entry
2513 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2515 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2516 if ( $privacy && $privacy == 2) {
2517 $old_checkout->anonymize;
2520 # And finally delete the issue
2523 $issue->item->onloan(undef)->store(
2525 skip_record_index => $params->{skip_record_index},
2526 skip_holds_queue => $params->{skip_holds_queue}
2530 if ( C4::Context->preference('StoreLastBorrower') ) {
2531 my $item = Koha::Items->find( $itemnumber );
2532 $item->last_returned_by( $patron );
2535 # Remove any OVERDUES related debarment if the borrower has no overdues
2536 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2537 && $patron->debarred
2538 && !$patron->has_overdues
2539 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2541 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2549 =head2 _debar_user_on_return
2551 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2553 C<$borrower> borrower hashref
2555 C<$item> item hashref
2557 C<$datedue> date due DateTime object
2559 C<$returndate> DateTime object representing the return time
2561 Internal function, called only by AddReturn that calculates and updates
2562 the user fine days, and debars them if necessary.
2564 Should only be called for overdue returns
2566 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2571 sub _calculate_new_debar_dt {
2572 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2574 my $branchcode = _GetCircControlBranch( $item, $borrower );
2575 my $circcontrol = C4::Context->preference('CircControl');
2576 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2577 { categorycode => $borrower->{categorycode},
2578 itemtype => $item->{itype},
2579 branchcode => $branchcode,
2584 'maxsuspensiondays',
2585 'suspension_chargeperiod',
2589 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2590 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2591 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2593 return unless $finedays;
2595 # finedays is in days, so hourly loans must multiply by 24
2596 # thus 1 hour late equals 1 day suspension * finedays rate
2597 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2599 # grace period is measured in the same units as the loan
2601 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2603 my $deltadays = DateTime::Duration->new(
2604 days => $chargeable_units
2607 if ( $deltadays->subtract($grace)->is_positive() ) {
2608 my $suspension_days = $deltadays * $finedays;
2610 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2611 # No need to / 1 and do not consider / 0
2612 $suspension_days = DateTime::Duration->new(
2613 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2617 # If the max suspension days is < than the suspension days
2618 # the suspension days is limited to this maximum period.
2619 my $max_sd = $issuing_rule->{maxsuspensiondays};
2620 if ( defined $max_sd && $max_sd ne '' ) {
2621 $max_sd = DateTime::Duration->new( days => $max_sd );
2622 $suspension_days = $max_sd
2623 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2626 my ( $has_been_extended );
2627 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2628 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2630 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2631 $has_been_extended = 1;
2636 # Use the calendar or not to calculate the debarment date
2637 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2638 my $calendar = Koha::Calendar->new(
2639 branchcode => $branchcode,
2640 days_mode => 'Calendar'
2642 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2645 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2647 return $new_debar_dt;
2652 sub _debar_user_on_return {
2653 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2655 $return_date //= dt_from_string();
2657 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2659 return unless $new_debar_dt;
2661 Koha::Patron::Debarments::AddUniqueDebarment({
2662 borrowernumber => $borrower->{borrowernumber},
2663 expiration => $new_debar_dt->ymd(),
2664 type => 'SUSPENSION',
2666 # if borrower was already debarred but does not get an extra debarment
2667 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2668 my ($new_debarment_str, $is_a_reminder);
2669 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2671 $new_debarment_str = $borrower->{debarred};
2673 $new_debarment_str = $new_debar_dt->ymd();
2675 # FIXME Should return a DateTime object
2676 return $new_debarment_str, $is_a_reminder;
2679 =head2 _FixOverduesOnReturn
2681 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2683 C<$borrowernumber> borrowernumber
2685 C<$itemnumber> itemnumber
2687 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2689 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2695 sub _FixOverduesOnReturn {
2696 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2697 unless( $borrowernumber ) {
2698 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2702 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2706 warn "_FixOverduesOnReturn() not supplied valid status";
2710 my $schema = Koha::Database->schema;
2712 my $result = $schema->txn_do(
2714 # check for overdue fine
2715 my $accountlines = Koha::Account::Lines->search(
2717 borrowernumber => $borrowernumber,
2718 itemnumber => $item,
2719 debit_type_code => 'OVERDUE',
2720 status => 'UNRETURNED'
2723 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2725 my $accountline = $accountlines->next;
2726 my $payments = $accountline->credits;
2728 my $amountoutstanding = $accountline->amountoutstanding;
2729 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2730 $accountline->delete;
2731 return 0; # no warning, we've just removed a zero value fine (backdated return)
2732 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2733 my $account = Koha::Account->new({patron_id => $borrowernumber});
2734 my $credit = $account->add_credit(
2736 amount => $amountoutstanding,
2737 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2738 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2739 interface => C4::Context->interface,
2745 $credit->apply({ debits => [ $accountline ] });
2747 if (C4::Context->preference("FinesLog")) {
2748 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2752 $accountline->status($status);
2753 return $accountline->store();
2760 =head2 _GetCircControlBranch
2762 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2766 Return the library code to be used to determine which circulation
2767 policy applies to a transaction. Looks up the CircControl and
2768 HomeOrHoldingBranch system preferences.
2770 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2772 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2776 sub _GetCircControlBranch {
2777 my ($item, $borrower) = @_;
2778 my $circcontrol = C4::Context->preference('CircControl');
2781 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2782 $branch= C4::Context->userenv->{'branch'};
2783 } elsif ($circcontrol eq 'PatronLibrary') {
2784 $branch=$borrower->{branchcode};
2786 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2787 $branch = $item->{$branchfield};
2788 # default to item home branch if holdingbranch is used
2789 # and is not defined
2790 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2791 $branch = $item->{homebranch};
2799 $issue = GetOpenIssue( $itemnumber );
2801 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2803 C<$itemnumber> is the item's itemnumber
2810 my ( $itemnumber ) = @_;
2811 return unless $itemnumber;
2812 my $dbh = C4::Context->dbh;
2813 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2814 $sth->execute( $itemnumber );
2815 return $sth->fetchrow_hashref();
2819 =head2 GetUpcomingDueIssues
2821 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2825 sub GetUpcomingDueIssues {
2828 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2829 my $dbh = C4::Context->dbh;
2832 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2834 LEFT JOIN items USING (itemnumber)
2835 LEFT JOIN branches ON branches.branchcode =
2837 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2838 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2839 my @bind_parameters = ( $params->{'days_in_advance'} );
2841 my $sth = $dbh->prepare( $statement );
2842 $sth->execute( @bind_parameters );
2843 my $upcoming_dues = $sth->fetchall_arrayref({});
2845 return $upcoming_dues;
2848 =head2 CanBookBeRenewed
2850 ($ok,$error,$info) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2852 Find out whether a borrowed item may be renewed.
2854 C<$borrowernumber> is the borrower number of the patron who currently
2855 has the item on loan.
2857 C<$itemnumber> is the number of the item to renew.
2859 C<$override_limit>, if supplied with a true value, causes
2860 the limit on the number of times that the loan can be renewed
2861 (as controlled by the item type) to be ignored. Overriding also allows
2862 to renew sooner than "No renewal before" and to manually renew loans
2863 that are automatically renewed.
2865 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2866 item must currently be on loan to the specified borrower; renewals
2867 must be allowed for the item's type; and the borrower must not have
2868 already renewed the loan.
2869 $error will contain the reason the renewal can not proceed
2870 $info will contain a hash of additional info
2871 currently 'soonest_renew_date' if error is 'too soon'
2875 sub CanBookBeRenewed {
2876 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2878 my $auto_renew = "no";
2881 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2882 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2883 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2884 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2886 my $patron = $issue->patron or return;
2888 # override_limit will override anything else except on_reserve
2889 unless ( $override_limit ){
2890 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2891 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2893 categorycode => $patron->categorycode,
2894 itemtype => $item->effective_itemtype,
2895 branchcode => $branchcode,
2899 'unseen_renewals_allowed'
2904 return ( 0, "too_many" )
2905 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2907 return ( 0, "too_unseen" )
2908 if C4::Context->preference('UnseenRenewals') &&
2909 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2910 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2912 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2913 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2914 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2915 my $restricted = $patron->is_debarred;
2916 my $hasoverdues = $patron->has_overdues;
2918 if ( $restricted and $restrictionblockrenewing ) {
2919 return ( 0, 'restriction');
2920 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2921 return ( 0, 'overdue');
2924 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2927 branchcode => $branchcode,
2930 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2931 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2932 # extra notices being sent. Cron also implies no override
2933 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2934 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2935 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2938 if ( C4::Context->preference('UseRecalls') ) {
2940 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2941 if ( defined $recall ) {
2942 if ( $recall->item_level ) {
2943 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2944 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
2946 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2947 return ( 0, 'recalled' ) unless ( $recall->waiting );
2952 # Note: possible_reserves will contain all title level holds on this bib and item level
2953 # holds on the checked out item
2954 my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2956 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2957 if ( $resfound && $resrec->{non_priority} ) {
2958 $resfound = Koha::Holds->search(
2959 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2965 # This item can fill one or more unfilled reserve, can those unfilled reserves
2966 # all be filled by other available items?
2968 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2970 my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2972 # There is an item level hold on this item, no other item can fill the hold
2977 # Get all other items that could possibly fill reserves
2978 # FIXME We could join reserves (or more tables) here to eliminate some checks later
2979 my $items = Koha::Items->search({
2980 biblionumber => $resrec->{biblionumber},
2983 -not => { itemnumber => $itemnumber }
2985 my $item_count = $items->count();
2987 # Get all other reserves that could have been filled by this item
2988 my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2989 # Note: fetching the patrons in this manner means that a patron with 2 holds will
2990 # not block renewal if one reserve can be satisfied i.e. each patron is checked once
2991 my $patrons = Koha::Patrons->search({
2992 borrowernumber => { -in => \@borrowernumbers }
2994 my $patron_count = $patrons->count();
2996 return ( 0, "on_reserve" ) if ($patron_count > $item_count);
2997 # We cannot possibly fill all reserves if we don't have enough items
2999 # If we can fill each hold that has been found with the available items on the record
3000 # then the patron can renew. If we cannot, they cannot renew.
3001 # FIXME This code does not check whether the item we are renewing can fill
3002 # any of the existing reserves.
3006 PATRON: while ( my $patron = $patrons->next ) {
3007 # If there is a reserve that cannot be filled we are done
3008 return ( 0, "on_reserve" ) if ( $seen > $reservable );
3009 my $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron });
3010 while ( my $other_item = $items->next ) {
3011 next if defined $matched_items{$other_item->itemnumber};
3012 next if IsItemOnHoldAndFound( $other_item->itemnumber );
3013 next unless IsAvailableForItemLevelRequest($other_item, $patron, undef, $items_any_available);
3014 next unless CanItemBeReserved($patron,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3015 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3016 # CanItemBeReserved checks 'rules' and 'policies' which means
3017 # items will fill holds at checkin that are rejected here
3019 if ($reservable >= $patron_count) {
3023 $matched_items{$other_item->itemnumber} = 1;
3032 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
3033 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3034 $soonest = GetSoonestRenewDate($borrowernumber, $itemnumber);
3035 if ( $soonest > dt_from_string() ){
3036 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3039 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3041 return ( 1, undef );
3046 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
3050 C<$borrowernumber> is the borrower number of the patron who currently
3053 C<$itemnumber> is the number of the item to renew.
3055 C<$branch> is the library where the renewal took place (if any).
3056 The library that controls the circ policies for the renewal is retrieved from the issues record.
3058 C<$datedue> can be a DateTime object used to set the due date.
3060 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3061 this parameter is not supplied, lastreneweddate is set to the current date.
3063 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3064 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3065 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3068 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3069 from the book's item type.
3071 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3072 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3073 fallback to a true value
3078 my $borrowernumber = shift;
3079 my $itemnumber = shift or return;
3081 my $datedue = shift;
3082 my $lastreneweddate = shift || dt_from_string();
3083 my $skipfinecalc = shift;
3086 # Fallback on a 'seen' renewal
3087 $seen = defined $seen && $seen == 0 ? 0 : 1;
3089 my $item_object = Koha::Items->find($itemnumber) or return;
3090 my $biblio = $item_object->biblio;
3091 my $issue = $item_object->checkout;
3092 my $item_unblessed = $item_object->unblessed;
3094 my $dbh = C4::Context->dbh;
3096 return unless $issue;
3098 $borrowernumber ||= $issue->borrowernumber;
3100 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3101 carp 'Invalid date passed to AddRenewal.';
3105 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3106 my $patron_unblessed = $patron->unblessed;
3108 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3110 my $schema = Koha::Database->schema;
3111 $schema->txn_do(sub{
3113 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3114 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3116 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3118 # If the due date wasn't specified, calculate it by adding the
3119 # book's loan length to today's date or the current due date
3120 # based on the value of the RenewalPeriodBase syspref.
3121 my $itemtype = $item_object->effective_itemtype;
3124 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3125 dt_from_string( $issue->date_due, 'sql' ) :
3127 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3130 my $fees = Koha::Charges::Fees->new(
3133 library => $circ_library,
3134 item => $item_object,
3135 from_date => dt_from_string( $issue->date_due, 'sql' ),
3136 to_date => dt_from_string($datedue),
3140 # Increment the unseen renewals, if appropriate
3141 # We only do so if the syspref is enabled and
3142 # a maximum value has been set in the circ rules
3143 my $unseen_renewals = $issue->unseen_renewals;
3144 if (C4::Context->preference('UnseenRenewals')) {
3145 my $rule = Koha::CirculationRules->get_effective_rule(
3146 { categorycode => $patron->categorycode,
3147 itemtype => $item_object->effective_itemtype,
3148 branchcode => $circ_library->branchcode,
3149 rule_name => 'unseen_renewals_allowed'
3152 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3155 # If the renewal is seen, unseen should revert to 0
3156 $unseen_renewals = 0;
3160 # Update the issues record to have the new due date, and a new count
3161 # of how many times it has been renewed.
3162 my $renews = ( $issue->renewals_count || 0 ) + 1;
3163 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3166 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3169 Koha::Exceptions::Checkout::FailedRenewal->throw(
3170 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3174 # Update the renewal count on the item, and tell zebra to reindex
3175 $renews = ( $item_object->renewals || 0 ) + 1;
3176 $item_object->renewals($renews);
3177 $item_object->onloan($datedue);
3178 $item_object->store({ log_action => 0 });
3180 # Charge a new rental fee, if applicable
3181 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3182 if ( $charge > 0 ) {
3183 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3186 # Charge a new accumulate rental fee, if applicable
3187 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3188 if ( $itemtype_object ) {
3189 my $accumulate_charge = $fees->accumulate_rentalcharge();
3190 if ( $accumulate_charge > 0 ) {
3191 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3193 $charge += $accumulate_charge;
3196 # Send a renewal slip according to checkout alert preferencei
3197 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3198 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3200 branchcode => $branch,
3201 categorycode => $patron->categorycode,
3202 item_type => $itemtype,
3203 notification => 'CHECKOUT',
3205 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3206 SendCirculationAlert(
3209 item => $item_unblessed,
3210 borrower => $patron->unblessed,
3217 # Remove any OVERDUES related debarment if the borrower has no overdues
3219 && $patron->is_debarred
3220 && ! $patron->has_overdues
3221 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3223 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3226 # Add renewal record
3227 my $renewal = Koha::Checkouts::Renewal->new(
3229 checkout_id => $issue->issue_id,
3230 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3232 interface => C4::Context->interface
3236 # Add the renewal to stats
3237 C4::Stats::UpdateStats(
3239 branch => $item_object->renewal_branchcode({branch => $branch}),
3242 itemnumber => $itemnumber,
3243 itemtype => $itemtype,
3244 location => $item_object->location,
3245 borrowernumber => $borrowernumber,
3246 ccode => $item_object->ccode,
3251 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3253 Koha::Plugins->call('after_circ_action', {
3254 action => 'renewal',
3256 checkout => $issue->get_from_storage
3265 # check renewal status
3266 my ( $bornum, $itemno ) = @_;
3267 my $dbh = C4::Context->dbh;
3269 my $unseencount = 0;
3270 my $renewsallowed = 0;
3271 my $unseenallowed = 0;
3275 my $patron = Koha::Patrons->find( $bornum );
3276 my $item = Koha::Items->find($itemno);
3278 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3280 # Look in the issues table for this item, lent to this borrower,
3281 # and not yet returned.
3283 # FIXME - I think this function could be redone to use only one SQL call.
3284 my $sth = $dbh->prepare(
3285 "select * from issues
3286 where (borrowernumber = ?)
3287 and (itemnumber = ?)"
3289 $sth->execute( $bornum, $itemno );
3290 my $data = $sth->fetchrow_hashref;
3291 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3292 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3293 # $item and $borrower should be calculated
3294 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3296 my $rules = Koha::CirculationRules->get_effective_rules(
3298 categorycode => $patron->categorycode,
3299 itemtype => $item->effective_itemtype,
3300 branchcode => $branchcode,
3301 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3304 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3305 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3306 $rules->{unseen_renewals_allowed} :
3308 $renewsleft = $renewsallowed - $renewcount;
3309 $unseenleft = $unseenallowed - $unseencount;
3310 if($renewsleft < 0){ $renewsleft = 0; }
3311 if($unseenleft < 0){ $unseenleft = 0; }
3322 =head2 GetSoonestRenewDate
3324 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3326 Find out the soonest possible renew date of a borrowed item.
3328 C<$borrowernumber> is the borrower number of the patron who currently
3329 has the item on loan.
3331 C<$itemnumber> is the number of the item to renew.
3333 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3334 renew date, based on the value "No renewal before" of the applicable
3335 issuing rule. Returns the current date if the item can already be
3336 renewed, and returns undefined if the borrower, loan, or item
3341 sub GetSoonestRenewDate {
3342 my ( $borrowernumber, $itemnumber ) = @_;
3344 my $dbh = C4::Context->dbh;
3346 my $item = Koha::Items->find($itemnumber) or return;
3347 my $itemissue = $item->checkout or return;
3349 $borrowernumber ||= $itemissue->borrowernumber;
3350 my $patron = Koha::Patrons->find( $borrowernumber )
3353 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3354 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3355 { categorycode => $patron->categorycode,
3356 itemtype => $item->effective_itemtype,
3357 branchcode => $branchcode,
3365 my $now = dt_from_string;
3367 if ( defined $issuing_rule->{norenewalbefore}
3368 and $issuing_rule->{norenewalbefore} ne "" )
3370 my $soonestrenewal =
3371 dt_from_string( $itemissue->date_due )->subtract(
3372 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3374 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3375 and $issuing_rule->{lengthunit} eq 'days' )
3377 $soonestrenewal->truncate( to => 'day' );
3379 return $soonestrenewal if $now < $soonestrenewal;
3380 } elsif ( $itemissue->auto_renew && $patron->autorenew_checkouts ) {
3381 # Checkouts with auto-renewing fall back to due date
3382 my $soonestrenewal = dt_from_string( $itemissue->date_due );
3383 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3384 and $issuing_rule->{lengthunit} eq 'days' )
3386 $soonestrenewal->truncate( to => 'day' );
3388 return $soonestrenewal;
3393 =head2 GetLatestAutoRenewDate
3395 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3397 Find out the latest possible auto renew date of a borrowed item.
3399 C<$borrowernumber> is the borrower number of the patron who currently
3400 has the item on loan.
3402 C<$itemnumber> is the number of the item to renew.
3404 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3405 auto renew date, based on the value "No auto renewal after" and the "No auto
3406 renewal after (hard limit) of the applicable issuing rule.
3407 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3408 or item cannot be found.
3412 sub GetLatestAutoRenewDate {
3413 my ( $borrowernumber, $itemnumber ) = @_;
3415 my $dbh = C4::Context->dbh;
3417 my $item = Koha::Items->find($itemnumber) or return;
3418 my $itemissue = $item->checkout or return;
3420 $borrowernumber ||= $itemissue->borrowernumber;
3421 my $patron = Koha::Patrons->find( $borrowernumber )
3424 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3425 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3427 categorycode => $patron->categorycode,
3428 itemtype => $item->effective_itemtype,
3429 branchcode => $branchcode,
3431 'no_auto_renewal_after',
3432 'no_auto_renewal_after_hard_limit',
3438 return unless $circulation_rules;
3440 if ( not $circulation_rules->{no_auto_renewal_after}
3441 or $circulation_rules->{no_auto_renewal_after} eq '' )
3442 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3443 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3445 my $maximum_renewal_date;
3446 if ( $circulation_rules->{no_auto_renewal_after} ) {
3447 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3448 $maximum_renewal_date->add(
3449 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3453 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3454 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3455 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3457 return $maximum_renewal_date;
3461 =head2 GetIssuingCharges
3463 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3465 Calculate how much it would cost for a given patron to borrow a given
3466 item, including any applicable discounts.
3468 C<$itemnumber> is the item number of item the patron wishes to borrow.
3470 C<$borrowernumber> is the patron's borrower number.
3472 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3473 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3478 sub GetIssuingCharges {
3480 # calculate charges due
3481 my ( $itemnumber, $borrowernumber ) = @_;
3483 my $dbh = C4::Context->dbh;
3486 # Get the book's item type and rental charge (via its biblioitem).
3487 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3488 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3489 $charge_query .= (C4::Context->preference('item-level_itypes'))
3490 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3491 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3493 $charge_query .= ' WHERE items.itemnumber =?';
3495 my $sth = $dbh->prepare($charge_query);
3496 $sth->execute($itemnumber);
3497 if ( my $item_data = $sth->fetchrow_hashref ) {
3498 $item_type = $item_data->{itemtype};
3499 $charge = $item_data->{rentalcharge};
3501 # FIXME This should follow CircControl
3502 my $branch = C4::Context::mybranch();
3503 my $patron = Koha::Patrons->find( $borrowernumber );
3504 my $discount = Koha::CirculationRules->get_effective_rule({
3505 categorycode => $patron->categorycode,
3506 branchcode => $branch,
3507 itemtype => $item_type,
3508 rule_name => 'rentaldiscount'
3511 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3513 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3517 return ( $charge, $item_type );
3520 =head2 AddIssuingCharge
3522 &AddIssuingCharge( $checkout, $charge, $type )
3526 sub AddIssuingCharge {
3527 my ( $checkout, $charge, $type ) = @_;
3529 # FIXME What if checkout does not exist?
3531 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3532 my $accountline = $account->add_debit(
3536 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3537 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3538 interface => C4::Context->interface,
3540 item_id => $checkout->itemnumber,
3541 issue_id => $checkout->issue_id,
3548 GetTransfers($itemnumber);
3553 my ($itemnumber) = @_;
3555 my $dbh = C4::Context->dbh;
3564 FROM branchtransfers
3565 WHERE itemnumber = ?
3566 AND datearrived IS NULL
3567 AND datecancelled IS NULL
3569 my $sth = $dbh->prepare($query);
3570 $sth->execute($itemnumber);
3571 my @row = $sth->fetchrow_array();
3575 =head2 GetTransfersFromTo
3577 @results = GetTransfersFromTo($frombranch,$tobranch);
3579 Returns the list of pending transfers between $from and $to branch
3583 sub GetTransfersFromTo {
3584 my ( $frombranch, $tobranch ) = @_;
3585 return unless ( $frombranch && $tobranch );
3586 my $dbh = C4::Context->dbh;
3588 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3589 FROM branchtransfers
3592 AND datecancelled IS NULL
3593 AND datesent IS NOT NULL
3594 AND datearrived IS NULL
3596 my $sth = $dbh->prepare($query);
3597 $sth->execute( $frombranch, $tobranch );
3600 while ( my $data = $sth->fetchrow_hashref ) {
3601 push @gettransfers, $data;
3603 return (@gettransfers);
3606 =head2 SendCirculationAlert
3608 Send out a C<check-in> or C<checkout> alert using the messaging system.
3616 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3620 Hashref of information about the item being checked in or out.
3624 Hashref of information about the borrower of the item.
3628 The branchcode from where the checkout or check-in took place.
3634 SendCirculationAlert({
3637 borrower => $borrower,
3643 sub SendCirculationAlert {
3645 my ($type, $item, $borrower, $branch, $issue) =
3646 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3647 my %message_name = (
3648 CHECKIN => 'Item_Check_in',
3649 CHECKOUT => 'Item_Checkout',
3650 RENEWAL => 'Item_Checkout',
3652 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3653 borrowernumber => $borrower->{borrowernumber},
3654 message_name => $message_name{$type},
3659 items => $item->{itemnumber},
3660 biblio => $item->{biblionumber},
3661 biblioitems => $item->{biblionumber},
3662 borrowers => $borrower,
3663 branches => $branch,
3666 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3667 # See C4::Letters:: _parseletter_sth
3668 if( $type eq 'CHECKIN' ){
3669 $tables->{old_issues} = $issue->issue_id;
3671 $tables->{issues} = $item->{itemnumber};
3674 my $schema = Koha::Database->new->schema;
3675 my @transports = keys %{ $borrower_preferences->{transports} };
3677 # From the MySQL doc:
3678 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3679 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3680 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3681 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3683 for my $mtt (@transports) {
3684 my $letter = C4::Letters::GetPreparedLetter (
3685 module => 'circulation',
3686 letter_code => $type,
3687 branchcode => $branch,
3688 message_transport_type => $mtt,
3689 lang => $borrower->{lang},
3693 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3694 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3695 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3696 unless ( $message ) {
3697 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3698 C4::Message->enqueue($letter, $borrower, $mtt);
3700 $message->append($letter);
3703 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3709 =head2 updateWrongTransfer
3711 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3713 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
3717 sub updateWrongTransfer {
3718 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3720 # first step: cancel the original transfer
3721 my $item = Koha::Items->find($itemNumber);
3722 my $transfer = $item->get_transfer;
3723 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3725 # second step: create a new transfer to the right location
3726 my $new_transfer = $item->request_transfer(
3728 to => $transfer->to_library,
3729 reason => $transfer->reason,
3730 comment => $transfer->comments,
3736 return $new_transfer;
3741 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3743 this function calculates the due date given the start date and configured circulation rules,
3744 checking against the holidays calendar as per the daysmode circulation rule.
3745 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3746 C<$itemtype> = itemtype code of item in question
3747 C<$branch> = location whose calendar to use
3748 C<$borrower> = Borrower object
3749 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3754 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3758 # loanlength now a href
3760 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3762 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3768 if (ref $startdate ne 'DateTime' ) {
3769 $datedue = dt_from_string($datedue);
3771 $datedue = $startdate->clone;
3774 $datedue = dt_from_string()->truncate( to => 'minute' );
3778 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3780 categorycode => $borrower->{categorycode},
3781 itemtype => $itemtype,
3782 branchcode => $branch,
3786 # calculate the datedue as normal
3787 if ( $daysmode eq 'Days' )
3788 { # ignoring calendar
3789 if ( $loanlength->{lengthunit} eq 'hours' ) {
3790 $datedue->add( hours => $loanlength->{$length_key} );
3792 $datedue->add( days => $loanlength->{$length_key} );
3793 $datedue->set_hour(23);
3794 $datedue->set_minute(59);
3798 if ($loanlength->{lengthunit} eq 'hours') {
3799 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3802 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3804 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3805 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3806 if ($loanlength->{lengthunit} eq 'days') {
3807 $datedue->set_hour(23);
3808 $datedue->set_minute(59);
3812 # if Hard Due Dates are used, retrieve them and apply as necessary
3813 my ( $hardduedate, $hardduedatecompare ) =
3814 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3815 if ($hardduedate) { # hardduedates are currently dates
3816 $hardduedate->truncate( to => 'minute' );
3817 $hardduedate->set_hour(23);
3818 $hardduedate->set_minute(59);
3819 my $cmp = DateTime->compare( $hardduedate, $datedue );
3821 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3822 # if the calculated date is before the 'after' Hard Due Date (floor), override
3823 # if the hard due date is set to 'exactly', overrride
3824 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3825 $datedue = $hardduedate->clone;
3828 # in all other cases, keep the date due as it is
3832 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3833 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3834 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3835 if( $expiry_dt ) { #skip empty expiry date..
3836 $expiry_dt->set( hour => 23, minute => 59);
3837 my $d1= $datedue->clone->set_time_zone('floating');
3838 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3839 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3842 if ( $daysmode ne 'Days' ) {
3843 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3844 if ( $calendar->is_holiday($datedue) ) {
3845 # Don't return on a closed day
3846 $datedue = $calendar->prev_open_days( $datedue, 1 );
3855 sub CheckValidBarcode{
3857 my $dbh = C4::Context->dbh;
3858 my $query=qq|SELECT count(*)
3862 my $sth = $dbh->prepare($query);
3863 $sth->execute($barcode);
3864 my $exist=$sth->fetchrow ;
3868 =head2 IsBranchTransferAllowed
3870 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3872 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3874 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3875 Koha::Item->can_be_transferred.
3879 sub IsBranchTransferAllowed {
3880 my ( $toBranch, $fromBranch, $code ) = @_;
3882 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3884 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3885 my $dbh = C4::Context->dbh;
3887 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3888 $sth->execute( $toBranch, $fromBranch, $code );
3889 my $limit = $sth->fetchrow_hashref();
3891 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3892 if ( $limit->{'limitId'} ) {
3899 =head2 CreateBranchTransferLimit
3901 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3903 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3905 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3909 sub CreateBranchTransferLimit {
3910 my ( $toBranch, $fromBranch, $code ) = @_;
3911 return unless defined($toBranch) && defined($fromBranch);
3912 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3914 my $dbh = C4::Context->dbh;
3916 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3917 return $sth->execute( $code, $toBranch, $fromBranch );
3920 =head2 DeleteBranchTransferLimits
3922 my $result = DeleteBranchTransferLimits($frombranch);
3924 Deletes all the library transfer limits for one library. Returns the
3925 number of limits deleted, 0e0 if no limits were deleted, or undef if
3926 no arguments are supplied.
3928 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3929 fromBranch => $fromBranch
3934 sub DeleteBranchTransferLimits {
3936 return unless defined $branch;
3937 my $dbh = C4::Context->dbh;
3938 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3939 return $sth->execute($branch);
3943 my ( $borrowernumber, $itemnum ) = @_;
3944 MarkIssueReturned( $borrowernumber, $itemnum );
3949 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3951 The final optional parameter, C<$params>, expected to contain
3952 'skip_record_index' key, which relayed down to Koha::Item/store,
3953 there it prevents calling of ModZebra index_records,
3954 which takes most of the time in batch adds/deletes: index_records better
3955 to be called later in C<additem.pl> after the whole loop.
3958 skip_record_index => 1|0
3963 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3965 unless ( $mark_lost_from ) {
3966 # Temporary check to avoid regressions
3967 die q|LostItem called without $mark_lost_from, check the API.|;
3971 if ( $force_mark_returned ) {
3974 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3975 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3978 my $dbh = C4::Context->dbh();
3979 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3981 JOIN items USING (itemnumber)
3982 JOIN biblio USING (biblionumber)
3983 WHERE issues.itemnumber=?");
3984 $sth->execute($itemnumber);
3985 my $issues=$sth->fetchrow_hashref();
3987 # If a borrower lost the item, add a replacement cost to the their record
3988 if ( my $borrowernumber = $issues->{borrowernumber} ){
3989 my $patron = Koha::Patrons->find( $borrowernumber );
3991 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3992 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3994 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3995 C4::Accounts::chargelostitem(
3998 $issues->{'replacementprice'},
3999 sprintf( "%s %s %s",
4000 $issues->{'title'} || q{},
4001 $issues->{'barcode'} || q{},
4002 $issues->{'itemcallnumber'} || q{},
4005 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4006 #warn " $issues->{'borrowernumber'} / $itemnumber ";
4009 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4012 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4013 my $item = Koha::Items->find($itemnumber);
4014 my $transfers = $item->get_transfers;
4015 while (my $transfer = $transfers->next) {
4016 $transfer->cancel({ reason => 'ItemLost', force => 1 });
4020 sub GetOfflineOperations {
4021 my $dbh = C4::Context->dbh;
4022 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4023 $sth->execute(C4::Context->userenv->{'branch'});
4024 my $results = $sth->fetchall_arrayref({});
4028 sub GetOfflineOperation {
4029 my $operationid = shift;
4030 return unless $operationid;
4031 my $dbh = C4::Context->dbh;
4032 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4033 $sth->execute( $operationid );
4034 return $sth->fetchrow_hashref;
4037 sub AddOfflineOperation {
4038 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4039 my $dbh = C4::Context->dbh;
4040 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4041 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4045 sub DeleteOfflineOperation {
4046 my $dbh = C4::Context->dbh;
4047 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4048 $sth->execute( shift );
4052 sub ProcessOfflineOperation {
4053 my $operation = shift;
4056 if ( $operation->{action} eq 'return' ) {
4057 $report = ProcessOfflineReturn( $operation );
4058 } elsif ( $operation->{action} eq 'issue' ) {
4059 $report = ProcessOfflineIssue( $operation );
4060 } elsif ( $operation->{action} eq 'payment' ) {
4061 $report = ProcessOfflinePayment( $operation );
4064 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4069 sub ProcessOfflineReturn {
4070 my $operation = shift;
4072 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4075 my $itemnumber = $item->itemnumber;
4076 my $issue = GetOpenIssue( $itemnumber );
4078 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4079 ModDateLastSeen( $itemnumber, $leave_item_lost );
4081 $issue->{borrowernumber},
4083 $operation->{timestamp},
4085 $item->renewals_count(0);
4086 $item->onloan(undef);
4087 $item->store({ log_action => 0 });
4090 return "Item not issued.";
4093 return "Item not found.";
4097 sub ProcessOfflineIssue {
4098 my $operation = shift;
4100 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4103 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4105 return "Barcode not found.";
4107 my $itemnumber = $item->itemnumber;
4108 my $issue = GetOpenIssue( $itemnumber );
4110 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4112 $issue->{borrowernumber},
4114 $operation->{timestamp},
4119 $operation->{'barcode'},
4122 $operation->{timestamp},
4127 return "Borrower not found.";
4131 sub ProcessOfflinePayment {
4132 my $operation = shift;
4134 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4136 $patron->account->pay(
4138 amount => $operation->{amount},
4139 library_id => $operation->{branchcode},
4149 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4151 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4156 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4160 ? Koha::Items->find($itemnumber)
4161 : Koha::Items->find( { barcode => $barcode } );
4165 return C4::Letters::GetPreparedLetter (
4166 module => 'circulation',
4167 letter_code => 'TRANSFERSLIP',
4168 branchcode => $branch,
4170 'branches' => $to_branch,
4171 'biblio' => $item->biblionumber,
4172 'items' => $item->unblessed,
4177 =head2 CheckIfIssuedToPatron
4179 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4181 Return 1 if any record item is issued to patron, otherwise return 0
4185 sub CheckIfIssuedToPatron {
4186 my ($borrowernumber, $biblionumber) = @_;
4188 my $dbh = C4::Context->dbh;
4190 SELECT COUNT(*) FROM issues
4191 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4192 WHERE items.biblionumber = ?
4193 AND issues.borrowernumber = ?
4195 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4196 return 1 if $is_issued;
4202 IsItemIssued( $itemnumber )
4204 Return 1 if the item is on loan, otherwise return 0
4209 my $itemnumber = shift;
4210 my $dbh = C4::Context->dbh;
4211 my $sth = $dbh->prepare(q{
4214 WHERE itemnumber = ?
4216 $sth->execute($itemnumber);
4217 return $sth->fetchrow;
4220 =head2 GetAgeRestriction
4222 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4223 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4225 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4226 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4228 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4229 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4230 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4231 Negative days mean the borrower has gone past the age restriction age.
4235 sub GetAgeRestriction {
4236 my ($record_restrictions, $borrower) = @_;
4237 my $markers = C4::Context->preference('AgeRestrictionMarker');
4239 return unless $record_restrictions;
4240 # Split $record_restrictions to something like FSK 16 or PEGI 6
4241 my @values = split ' ', uc($record_restrictions);
4242 return unless @values;
4244 # Search first occurrence of one of the markers
4245 my @markers = split /\|/, uc($markers);
4246 return unless @markers;
4249 my $restriction_year = 0;
4250 for my $value (@values) {
4252 for my $marker (@markers) {
4253 $marker =~ s/^\s+//; #remove leading spaces
4254 $marker =~ s/\s+$//; #remove trailing spaces
4255 if ( $marker eq $value ) {
4256 if ( $index <= $#values ) {
4257 $restriction_year += $values[$index];
4261 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4263 # Perhaps it is something like "K16" (as in Finland)
4264 $restriction_year += $1;
4268 last if ( $restriction_year > 0 );
4271 #Check if the borrower is age restricted for this material and for how long.
4272 if ($restriction_year && $borrower) {
4273 if ( $borrower->{'dateofbirth'} ) {
4274 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4275 $alloweddate[0] += $restriction_year;
4277 #Prevent runime eror on leap year (invalid date)
4278 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4279 $alloweddate[2] = 28;
4282 #Get how many days the borrower has to reach the age restriction
4283 my @Today = split /-/, dt_from_string()->ymd();
4284 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4285 #Negative days means the borrower went past the age restriction age
4286 return ($restriction_year, $daysToAgeRestriction);
4290 return ($restriction_year);
4294 =head2 GetPendingOnSiteCheckouts
4298 sub GetPendingOnSiteCheckouts {
4299 my $dbh = C4::Context->dbh;
4300 return $dbh->selectall_arrayref(q|
4306 items.itemcallnumber,
4310 issues.date_due < NOW() AS is_overdue,
4313 borrowers.firstname,
4315 borrowers.cardnumber,
4316 borrowers.borrowernumber
4318 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4319 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4320 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4321 WHERE issues.onsite_checkout = 1
4322 |, { Slice => {} } );
4328 my ($count, $branch, $itemtype, $ccode, $newness)
4329 = @$params{qw(count branch itemtype ccode newness)};
4331 my $dbh = C4::Context->dbh;
4334 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4335 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4336 i.ccode, SUM(i.issues) AS count
4338 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4339 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4342 my (@where_strs, @where_args);
4345 push @where_strs, 'i.homebranch = ?';
4346 push @where_args, $branch;
4349 if (C4::Context->preference('item-level_itypes')){
4350 push @where_strs, 'i.itype = ?';
4351 push @where_args, $itemtype;
4353 push @where_strs, 'bi.itemtype = ?';
4354 push @where_args, $itemtype;
4358 push @where_strs, 'i.ccode = ?';
4359 push @where_args, $ccode;
4362 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4363 push @where_args, $newness;
4367 $query .= 'WHERE ' . join(' AND ', @where_strs);
4371 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4372 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4377 $query .= q{ ) xxx WHERE count > 0 };
4378 $count = int($count);
4380 $query .= "LIMIT $count";
4383 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4388 =head2 Internal methods
4392 sub _CalculateAndUpdateFine {
4395 my $borrower = $params->{borrower};
4396 my $item = $params->{item};
4397 my $issue = $params->{issue};
4398 my $return_date = $params->{return_date};
4400 unless ($borrower) { carp "No borrower passed in!" && return; }
4401 unless ($item) { carp "No item passed in!" && return; }
4402 unless ($issue) { carp "No issue passed in!" && return; }
4404 my $datedue = dt_from_string( $issue->date_due );
4406 # we only need to calculate and change the fines if we want to do that on return
4407 # Should be on for hourly loans
4408 my $control = C4::Context->preference('CircControl');
4409 my $control_branchcode =
4410 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4411 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4412 : $issue->branchcode;
4414 my $date_returned = $return_date ? $return_date : dt_from_string();
4416 my ( $amount, $unitcounttotal, $unitcount ) =
4417 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4419 if ( C4::Context->preference('finesMode') eq 'production' ) {
4420 if ( $amount > 0 ) {
4421 C4::Overdues::UpdateFine({
4422 issue_id => $issue->issue_id,
4423 itemnumber => $issue->itemnumber,
4424 borrowernumber => $issue->borrowernumber,
4426 due => output_pref($datedue),
4429 elsif ($return_date) {
4431 # Backdated returns may have fines that shouldn't exist,
4432 # so in this case, we need to drop those fines to 0
4434 C4::Overdues::UpdateFine({
4435 issue_id => $issue->issue_id,
4436 itemnumber => $issue->itemnumber,
4437 borrowernumber => $issue->borrowernumber,
4439 due => output_pref($datedue),
4445 sub _CanBookBeAutoRenewed {
4446 my ( $params ) = @_;
4447 my $patron = $params->{patron};
4448 my $item = $params->{item};
4449 my $branchcode = $params->{branchcode};
4450 my $issue = $params->{issue};
4452 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4454 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4456 categorycode => $patron->categorycode,
4457 itemtype => $item->effective_itemtype,
4458 branchcode => $branchcode,
4460 'no_auto_renewal_after',
4461 'no_auto_renewal_after_hard_limit',
4468 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4469 return 'auto_account_expired';
4472 if ( defined $issuing_rule->{no_auto_renewal_after}
4473 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4474 # Get issue_date and add no_auto_renewal_after
4475 # If this is greater than today, it's too late for renewal.
4476 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4477 $maximum_renewal_date->add(
4478 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4480 my $now = dt_from_string;
4481 if ( $now >= $maximum_renewal_date ) {
4482 return "auto_too_late";
4485 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4486 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4487 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4488 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4489 return "auto_too_late";
4493 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4494 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4495 my $amountoutstanding =
4496 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4497 ? $patron->account->balance
4498 : $patron->account->outstanding_debits->total_outstanding;
4499 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4500 return "auto_too_much_oweing";
4504 my $soonest = GetSoonestRenewDate($patron->id, $item->id);
4505 if ( $soonest > dt_from_string() )
4507 return ( "auto_too_soon", $soonest );
4513 sub _item_denied_renewal {
4516 my $item = $params->{item};
4517 return unless $item;
4519 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4520 return unless $denyingrules;
4521 foreach my $field (keys %$denyingrules) {
4522 my $val = $item->$field;
4523 if( !defined $val) {
4524 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4527 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4528 # If the results matches the values in the syspref
4529 # We return true if match found
4542 Koha Development Team <http://koha-community.org/>